Fix documentation version numbers
[users/jgh/exim.git] / doc / doc-docbook / spec.xfpt
1 . $Cambridge: exim/doc/doc-docbook/spec.xfpt,v 1.74 2010/05/29 19:26:31 nm4 Exp $
2 .
3 . /////////////////////////////////////////////////////////////////////////////
4 . This is the primary source of the Exim Manual. It is an xfpt document that is
5 . converted into DocBook XML for subsequent conversion into printing and online
6 . formats. The markup used herein is "standard" xfpt markup, with some extras.
7 . The markup is summarized in a file called Markup.txt.
8 .
9 . WARNING: When you use the .new macro, make sure it appears *before* any
10 . adjacent index items; otherwise you get an empty "paragraph" which causes
11 . unwanted vertical space.
12 . /////////////////////////////////////////////////////////////////////////////
13
14 .include stdflags
15 .include stdmacs
16
17 . /////////////////////////////////////////////////////////////////////////////
18 . This outputs the standard DocBook boilerplate.
19 . /////////////////////////////////////////////////////////////////////////////
20
21 .docbook
22
23 . /////////////////////////////////////////////////////////////////////////////
24 . These lines are processing instructions for the Simple DocBook Processor that
25 . Philip Hazel has developed as a less cumbersome way of making PostScript and
26 . PDFs than using xmlto and fop. They will be ignored by all other XML
27 . processors.
28 . /////////////////////////////////////////////////////////////////////////////
29
30 .literal xml
31 <?sdop
32   foot_right_recto="&chaptertitle; (&chapternumber;)"
33   foot_right_verso="&chaptertitle; (&chapternumber;)"
34   toc_chapter_blanks="yes,yes"
35   table_warn_overflow="overprint"
36 ?>
37 .literal off
38
39 . /////////////////////////////////////////////////////////////////////////////
40 . This generate the outermost <book> element that wraps then entire document.
41 . /////////////////////////////////////////////////////////////////////////////
42
43 .book
44
45 . /////////////////////////////////////////////////////////////////////////////
46 . These definitions set some parameters and save some typing. Remember that
47 . the <bookinfo> element must also be updated for each new edition.
48 . /////////////////////////////////////////////////////////////////////////////
49
50 .set previousversion "4.71"
51 .set version "4.72"
52
53 .set ACL "access control lists (ACLs)"
54 .set I   "&nbsp;&nbsp;&nbsp;&nbsp;"
55
56
57 . /////////////////////////////////////////////////////////////////////////////
58 . Additional xfpt markup used by this document, over and above the default
59 . provided in the xfpt library.
60 . /////////////////////////////////////////////////////////////////////////////
61
62 . --- Override the &$ flag to automatically insert a $ with the variable name
63
64 .flag &$  $&   "<varname>$"  "</varname>"
65
66 . --- Short flags for daggers in option headings. They will always be inside
67 . --- an italic string, but we want the daggers to be roman.
68
69 .flag &!!      "</emphasis>&dagger;<emphasis>"
70 .flag &!?      "</emphasis>&Dagger;<emphasis>"
71
72 . --- A macro for an Exim option definition heading, generating a one-line
73 . --- table with four columns. For cases when the option name is given with
74 . --- a space, so that it can be split, a fifth argument is used for the
75 . --- index entry.
76
77 .macro option
78 .arg 5
79 .oindex "&%$5%&"
80 .endarg
81 .arg -5
82 .oindex "&%$1%&"
83 .endarg
84 .itable all 0 0 4 8* left 6* center 6* center 6* right
85 .row "&%$1%&" "Use: &'$2'&" "Type: &'$3'&" "Default: &'$4'&"
86 .endtable
87 .endmacro
88
89 . --- A macro for the common 2-column tables. The width of the first column
90 . --- is suitable for the many tables at the start of the main options chapter;
91 . --- the small number of other 2-column tables override it.
92
93 .macro table2 196pt 254pt
94 .itable none 0 0 2 $1 left $2 left
95 .endmacro
96
97 . --- A macro that generates .row, but puts &I; at the start of the first
98 . --- argument, thus indenting it. Assume a minimum of two arguments, and
99 . --- allow up to four arguments, which is as many as we'll ever need.
100
101 .macro irow
102 .arg 4
103 .row "&I;$1" "$2" "$3" "$4"
104 .endarg
105 .arg -4
106 .arg 3
107 .row "&I;$1" "$2" "$3"
108 .endarg
109 .arg -3
110 .row "&I;$1" "$2"
111 .endarg
112 .endarg
113 .endmacro
114
115 . --- Macros for option, variable, and concept index entries. For a "range"
116 . --- style of entry, use .scindex for the start and .ecindex for the end. The
117 . --- first argument of .scindex and the only argument of .ecindex must be the
118 . --- ID that ties them together.
119
120 .macro cindex
121 &<indexterm role="concept">&
122 &<primary>&$1&</primary>&
123 .arg 2
124 &<secondary>&$2&</secondary>&
125 .endarg
126 &</indexterm>&
127 .endmacro
128
129 .macro scindex
130 &<indexterm role="concept" id="$1" class="startofrange">&
131 &<primary>&$2&</primary>&
132 .arg 3
133 &<secondary>&$3&</secondary>&
134 .endarg
135 &</indexterm>&
136 .endmacro
137
138 .macro ecindex
139 &<indexterm role="concept" startref="$1" class="endofrange"/>&
140 .endmacro
141
142 .macro oindex
143 &<indexterm role="option">&
144 &<primary>&$1&</primary>&
145 .arg 2
146 &<secondary>&$2&</secondary>&
147 .endarg
148 &</indexterm>&
149 .endmacro
150
151 .macro vindex
152 &<indexterm role="variable">&
153 &<primary>&$1&</primary>&
154 .arg 2
155 &<secondary>&$2&</secondary>&
156 .endarg
157 &</indexterm>&
158 .endmacro
159
160 .macro index
161 .echo "** Don't use .index; use .cindex or .oindex or .vindex"
162 .endmacro
163 . ////////////////////////////////////////////////////////////////////////////
164
165
166 . ////////////////////////////////////////////////////////////////////////////
167 . The <bookinfo> element is removed from the XML before processing for Ascii
168 . output formats.
169 . ////////////////////////////////////////////////////////////////////////////
170
171 .literal xml
172 <bookinfo>
173 <title>Specification of the Exim Mail Transfer Agent</title>
174 <titleabbrev>The Exim MTA</titleabbrev>
175 <date>29 May 2010</date>
176 <author><firstname>Exim</firstname><surname>Maintainers</surname></author>
177 <authorinitials>EM</authorinitials>
178 <revhistory><revision>
179   <revnumber>4.72</revnumber>
180   <date>29 May 2010</date>
181   <authorinitials>EM</authorinitials>
182 </revision></revhistory>
183 <copyright><year>2009</year><holder>University of Cambridge</holder></copyright>
184 </bookinfo>
185 .literal off
186
187
188 . /////////////////////////////////////////////////////////////////////////////
189 . This chunk of literal XML implements index entries of the form "x, see y" and
190 . "x, see also y". However, the DocBook DTD doesn't allow <indexterm> entries
191 . at the top level, so we have to put the .chapter directive first.
192 . /////////////////////////////////////////////////////////////////////////////
193
194 .chapter "Introduction" "CHID1"
195 .literal xml
196
197 <indexterm role="variable">
198   <primary>$1, $2, etc.</primary>
199   <see><emphasis>numerical variables</emphasis></see>
200 </indexterm>
201 <indexterm role="concept">
202   <primary>address</primary>
203   <secondary>rewriting</secondary>
204   <see><emphasis>rewriting</emphasis></see>
205 </indexterm>
206 <indexterm role="concept">
207   <primary>Bounce Address Tag Validation</primary>
208   <see><emphasis>BATV</emphasis></see>
209 </indexterm>
210 <indexterm role="concept">
211   <primary>Client SMTP Authorization</primary>
212   <see><emphasis>CSA</emphasis></see>
213 </indexterm>
214 <indexterm role="concept">
215   <primary>CR character</primary>
216   <see><emphasis>carriage return</emphasis></see>
217 </indexterm>
218 <indexterm role="concept">
219   <primary>CRL</primary>
220   <see><emphasis>certificate revocation list</emphasis></see>
221 </indexterm>
222 <indexterm role="concept">
223   <primary>delivery</primary>
224   <secondary>failure report</secondary>
225   <see><emphasis>bounce message</emphasis></see>
226 </indexterm>
227 <indexterm role="concept">
228   <primary>dialup</primary>
229   <see><emphasis>intermittently connected hosts</emphasis></see>
230 </indexterm>
231 <indexterm role="concept">
232   <primary>exiscan</primary>
233   <see><emphasis>content scanning</emphasis></see>
234 </indexterm>
235 <indexterm role="concept">
236   <primary>failover</primary>
237   <see><emphasis>fallback</emphasis></see>
238 </indexterm>
239 <indexterm role="concept">
240   <primary>fallover</primary>
241   <see><emphasis>fallback</emphasis></see>
242 </indexterm>
243 <indexterm role="concept">
244   <primary>filter</primary>
245   <secondary>Sieve</secondary>
246   <see><emphasis>Sieve filter</emphasis></see>
247 </indexterm>
248 <indexterm role="concept">
249   <primary>ident</primary>
250   <see><emphasis>RFC 1413</emphasis></see>
251 </indexterm>
252 <indexterm role="concept">
253   <primary>LF character</primary>
254   <see><emphasis>linefeed</emphasis></see>
255 </indexterm>
256 <indexterm role="concept">
257   <primary>maximum</primary>
258   <seealso><emphasis>limit</emphasis></seealso>
259 </indexterm>
260 <indexterm role="concept">
261   <primary>monitor</primary>
262   <see><emphasis>Exim monitor</emphasis></see>
263 </indexterm>
264 <indexterm role="concept">
265   <primary>no_<emphasis>xxx</emphasis></primary>
266   <see>entry for xxx</see>
267 </indexterm>
268 <indexterm role="concept">
269   <primary>NUL</primary>
270   <see><emphasis>binary zero</emphasis></see>
271 </indexterm>
272 <indexterm role="concept">
273   <primary>passwd file</primary>
274   <see><emphasis>/etc/passwd</emphasis></see>
275 </indexterm>
276 <indexterm role="concept">
277   <primary>process id</primary>
278   <see><emphasis>pid</emphasis></see>
279 </indexterm>
280 <indexterm role="concept">
281   <primary>RBL</primary>
282   <see><emphasis>DNS list</emphasis></see>
283 </indexterm>
284 <indexterm role="concept">
285   <primary>redirection</primary>
286   <see><emphasis>address redirection</emphasis></see>
287 </indexterm>
288 <indexterm role="concept">
289   <primary>return path</primary>
290   <seealso><emphasis>envelope sender</emphasis></seealso>
291 </indexterm>
292 <indexterm role="concept">
293   <primary>scanning</primary>
294   <see><emphasis>content scanning</emphasis></see>
295 </indexterm>
296 <indexterm role="concept">
297   <primary>SSL</primary>
298   <see><emphasis>TLS</emphasis></see>
299 </indexterm>
300 <indexterm role="concept">
301   <primary>string</primary>
302   <secondary>expansion</secondary>
303   <see><emphasis>expansion</emphasis></see>
304 </indexterm>
305 <indexterm role="concept">
306   <primary>top bit</primary>
307   <see><emphasis>8-bit characters</emphasis></see>
308 </indexterm>
309 <indexterm role="concept">
310   <primary>variables</primary>
311   <see><emphasis>expansion, variables</emphasis></see>
312 </indexterm>
313 <indexterm role="concept">
314   <primary>zero, binary</primary>
315   <see><emphasis>binary zero</emphasis></see>
316 </indexterm>
317
318 .literal off
319
320
321 . /////////////////////////////////////////////////////////////////////////////
322 . This is the real start of the first chapter. See the comment above as to why
323 . we can't have the .chapter line here.
324 . chapter "Introduction"
325 . /////////////////////////////////////////////////////////////////////////////
326
327 Exim is a mail transfer agent (MTA) for hosts that are running Unix or
328 Unix-like operating systems. It was designed on the assumption that it would be
329 run on hosts that are permanently connected to the Internet. However, it can be
330 used on intermittently connected hosts with suitable configuration adjustments.
331
332 Configuration files currently exist for the following operating systems: AIX,
333 BSD/OS (aka BSDI), Darwin (Mac OS X), DGUX, Dragonfly, FreeBSD, GNU/Hurd,
334 GNU/Linux, HI-OSF (Hitachi), HI-UX, HP-UX, IRIX, MIPS RISCOS, NetBSD, OpenBSD,
335 OpenUNIX, QNX, SCO, SCO SVR4.2 (aka UNIX-SV), Solaris (aka SunOS5), SunOS4,
336 Tru64-Unix (formerly Digital UNIX, formerly DEC-OSF1), Ultrix, and Unixware.
337 Some of these operating systems are no longer current and cannot easily be
338 tested, so the configuration files may no longer work in practice.
339
340 There are also configuration files for compiling Exim in the Cygwin environment
341 that can be installed on systems running Windows. However, this document does
342 not contain any information about running Exim in the Cygwin environment.
343
344 The terms and conditions for the use and distribution of Exim are contained in
345 the file &_NOTICE_&. Exim is distributed under the terms of the GNU General
346 Public Licence, a copy of which may be found in the file &_LICENCE_&.
347
348 The use, supply or promotion of Exim for the purpose of sending bulk,
349 unsolicited electronic mail is incompatible with the basic aims of the program,
350 which revolve around the free provision of a service that enhances the quality
351 of personal communications. The author of Exim regards indiscriminate
352 mass-mailing as an antisocial, irresponsible abuse of the Internet.
353
354 Exim owes a great deal to Smail 3 and its author, Ron Karr. Without the
355 experience of running and working on the Smail 3 code, I could never have
356 contemplated starting to write a new MTA. Many of the ideas and user interfaces
357 were originally taken from Smail 3, though the actual code of Exim is entirely
358 new, and has developed far beyond the initial concept.
359
360 Many people, both in Cambridge and around the world, have contributed to the
361 development and the testing of Exim, and to porting it to various operating
362 systems. I am grateful to them all. The distribution now contains a file called
363 &_ACKNOWLEDGMENTS_&, in which I have started recording the names of
364 contributors.
365
366
367 .section "Exim documentation" "SECID1"
368 . Keep this example change bar when updating the documentation!
369 .new
370 .cindex "documentation"
371 This edition of the Exim specification applies to version &version; of Exim.
372 Substantive changes from the &previousversion; edition are marked in some
373 renditions of the document; this paragraph is so marked if the rendition is
374 capable of showing a change indicator.
375 .wen
376
377 This document is very much a reference manual; it is not a tutorial. The reader
378 is expected to have some familiarity with the SMTP mail transfer protocol and
379 with general Unix system administration. Although there are some discussions
380 and examples in places, the information is mostly organized in a way that makes
381 it easy to look up, rather than in a natural order for sequential reading.
382 Furthermore, the manual aims to cover every aspect of Exim in detail, including
383 a number of rarely-used, special-purpose features that are unlikely to be of
384 very wide interest.
385
386 .cindex "books about Exim"
387 An &"easier"& discussion of Exim which provides more in-depth explanatory,
388 introductory, and tutorial material can be found in a book entitled &'The Exim
389 SMTP Mail Server'& (second edition, 2007), published by UIT Cambridge
390 (&url(http://www.uit.co.uk/exim-book/)).
391
392 This book also contains a chapter that gives a general introduction to SMTP and
393 Internet mail. Inevitably, however, the book is unlikely to be fully up-to-date
394 with the latest release of Exim. (Note that the earlier book about Exim,
395 published by O'Reilly, covers Exim 3, and many things have changed in Exim 4.)
396
397 .cindex "Debian" "information sources"
398 If you are using a Debian distribution of Exim, you will find information about
399 Debian-specific features in the file
400 &_/usr/share/doc/exim4-base/README.Debian_&.
401 The command &(man update-exim.conf)& is another source of Debian-specific
402 information.
403
404 .cindex "&_doc/NewStuff_&"
405 .cindex "&_doc/ChangeLog_&"
406 .cindex "change log"
407 As the program develops, there may be features in newer versions that have not
408 yet made it into this document, which is updated only when the most significant
409 digit of the fractional part of the version number changes. Specifications of
410 new features that are not yet in this manual are placed in the file
411 &_doc/NewStuff_& in the Exim distribution.
412
413 Some features may be classified as &"experimental"&. These may change
414 incompatibly while they are developing, or even be withdrawn. For this reason,
415 they are not documented in this manual. Information about experimental features
416 can be found in the file &_doc/experimental.txt_&.
417
418 All changes to the program (whether new features, bug fixes, or other kinds of
419 change) are noted briefly in the file called &_doc/ChangeLog_&.
420
421 .cindex "&_doc/spec.txt_&"
422 This specification itself is available as an ASCII file in &_doc/spec.txt_& so
423 that it can easily be searched with a text editor. Other files in the &_doc_&
424 directory are:
425
426 .table2 100pt
427 .row &_OptionLists.txt_&     "list of all options in alphabetical order"
428 .row &_dbm.discuss.txt_&     "discussion about DBM libraries"
429 .row &_exim.8_&              "a man page of Exim's command line options"
430 .row &_experimental.txt_&    "documentation of experimental features"
431 .row &_filter.txt_&          "specification of the filter language"
432 .row &_Exim3.upgrade_&       "upgrade notes from release 2 to release 3"
433 .row &_Exim4.upgrade_&       "upgrade notes from release 3 to release 4"
434 .endtable
435
436 The main specification and the specification of the filtering language are also
437 available in other formats (HTML, PostScript, PDF, and Texinfo). Section
438 &<<SECTavail>>& below tells you how to get hold of these.
439
440
441
442 .section "FTP and web sites" "SECID2"
443 .cindex "web site"
444 .cindex "FTP site"
445 The primary site for Exim source distributions is currently the University of
446 Cambridge's FTP site, whose contents are described in &'Where to find the Exim
447 distribution'& below. In addition, there is a web site and an FTP site at
448 &%exim.org%&. These are now also hosted at the University of Cambridge. The
449 &%exim.org%& site was previously hosted for a number of years by Energis
450 Squared, formerly Planet Online Ltd, whose support I gratefully acknowledge.
451
452 .cindex "wiki"
453 .cindex "FAQ"
454 As well as Exim distribution tar files, the Exim web site contains a number of
455 differently formatted versions of the documentation. A recent addition to the
456 online information is the Exim wiki (&url(http://wiki.exim.org)),
457 which contains what used to be a separate FAQ, as well as various other
458 examples, tips, and know-how that have been contributed by Exim users.
459
460 .cindex Bugzilla
461 An Exim Bugzilla exists at &url(http://bugs.exim.org). You can use
462 this to report bugs, and also to add items to the wish list. Please search
463 first to check that you are not duplicating a previous entry.
464
465
466
467 .section "Mailing lists" "SECID3"
468 .cindex "mailing lists" "for Exim users"
469 The following Exim mailing lists exist:
470
471 .table2 140pt
472 .row &'exim-users@exim.org'&      "General discussion list"
473 .row &'exim-dev@exim.org'&        "Discussion of bugs, enhancements, etc."
474 .row &'exim-announce@exim.org'&   "Moderated, low volume announcements list"
475 .row &'exim-future@exim.org'&     "Discussion of long-term development"
476 .endtable
477
478 You can subscribe to these lists, change your existing subscriptions, and view
479 or search the archives via the mailing lists link on the Exim home page.
480 .cindex "Debian" "mailing list for"
481 If you are using a Debian distribution of Exim, you may wish to subscribe to
482 the Debian-specific mailing list &'pkg-exim4-users@lists.alioth.debian.org'&
483 via this web page:
484 .display
485 &url(http://lists.alioth.debian.org/mailman/listinfo/pkg-exim4-users)
486 .endd
487 Please ask Debian-specific questions on this list and not on the general Exim
488 lists.
489
490 .section "Exim training" "SECID4"
491 .cindex "training courses"
492 Training courses in Cambridge (UK) used to be run annually by the author of
493 Exim, before he retired. At the time of writing, there are no plans to run
494 further Exim courses in Cambridge. However, if that changes, relevant
495 information will be posted at &url(http://www-tus.csx.cam.ac.uk/courses/exim/).
496
497 .section "Bug reports" "SECID5"
498 .cindex "bug reports"
499 .cindex "reporting bugs"
500 Reports of obvious bugs can be emailed to &'bugs@exim.org'& or reported
501 via the Bugzilla (&url(http://bugs.exim.org)). However, if you are unsure
502 whether some behaviour is a bug or not, the best thing to do is to post a
503 message to the &'exim-dev'& mailing list and have it discussed.
504
505
506
507 .section "Where to find the Exim distribution" "SECTavail"
508 .cindex "FTP site"
509 .cindex "distribution" "ftp site"
510 The master ftp site for the Exim distribution is
511 .display
512 &*ftp://ftp.csx.cam.ac.uk/pub/software/email/exim*&
513 .endd
514 This is mirrored by
515 .display
516 &*ftp://ftp.exim.org/pub/exim*&
517 .endd
518 The file references that follow are relative to the &_exim_& directories at
519 these sites. There are now quite a number of independent mirror sites around
520 the world. Those that I know about are listed in the file called &_Mirrors_&.
521
522 Within the &_exim_& directory there are subdirectories called &_exim3_& (for
523 previous Exim 3 distributions), &_exim4_& (for the latest Exim 4
524 distributions), and &_Testing_& for testing versions. In the &_exim4_&
525 subdirectory, the current release can always be found in files called
526 .display
527 &_exim-n.nn.tar.gz_&
528 &_exim-n.nn.tar.bz2_&
529 .endd
530 where &'n.nn'& is the highest such version number in the directory. The two
531 files contain identical data; the only difference is the type of compression.
532 The &_.bz2_& file is usually a lot smaller than the &_.gz_& file.
533
534 .cindex "distribution" "signing details"
535 .cindex "distribution" "public key"
536 .cindex "public key for signed distribution"
537 The distributions are currently signed with Nigel Metheringham's GPG key. The
538 corresponding public key is available from a number of keyservers, and there is
539 also a copy in the file &_nigel-pubkey.asc_&. The signatures for the tar bundles are
540 in:
541 .display
542 &_exim-n.nn.tar.gz.asc_&
543 &_exim-n.nn.tar.bz2.asc_&
544 .endd
545 For each released version, the log of changes is made separately available in a
546 separate file in the directory &_ChangeLogs_& so that it is possible to
547 find out what has changed without having to download the entire distribution.
548
549 .cindex "documentation" "available formats"
550 The main distribution contains ASCII versions of this specification and other
551 documentation; other formats of the documents are available in separate files
552 inside the &_exim4_& directory of the FTP site:
553 .display
554 &_exim-html-n.nn.tar.gz_&
555 &_exim-pdf-n.nn.tar.gz_&
556 &_exim-postscript-n.nn.tar.gz_&
557 &_exim-texinfo-n.nn.tar.gz_&
558 .endd
559 These tar files contain only the &_doc_& directory, not the complete
560 distribution, and are also available in &_.bz2_& as well as &_.gz_& forms.
561
562
563 .section "Limitations" "SECID6"
564 .ilist
565 .cindex "limitations of Exim"
566 .cindex "bang paths" "not handled by Exim"
567 Exim is designed for use as an Internet MTA, and therefore handles addresses in
568 RFC 2822 domain format only. It cannot handle UUCP &"bang paths"&, though
569 simple two-component bang paths can be converted by a straightforward rewriting
570 configuration. This restriction does not prevent Exim from being interfaced to
571 UUCP as a transport mechanism, provided that domain addresses are used.
572 .next
573 .cindex "domainless addresses"
574 .cindex "address" "without domain"
575 Exim insists that every address it handles has a domain attached. For incoming
576 local messages, domainless addresses are automatically qualified with a
577 configured domain value. Configuration options specify from which remote
578 systems unqualified addresses are acceptable. These are then qualified on
579 arrival.
580 .next
581 .cindex "transport" "external"
582 .cindex "external transports"
583 The only external transport mechanisms that are currently implemented are SMTP
584 and LMTP over a TCP/IP network (including support for IPv6). However, a pipe
585 transport is available, and there are facilities for writing messages to files
586 and pipes, optionally in &'batched SMTP'& format; these facilities can be used
587 to send messages to other transport mechanisms such as UUCP, provided they can
588 handle domain-style addresses. Batched SMTP input is also catered for.
589 .next
590 Exim is not designed for storing mail for dial-in hosts. When the volumes of
591 such mail are large, it is better to get the messages &"delivered"& into files
592 (that is, off Exim's queue) and subsequently passed on to the dial-in hosts by
593 other means.
594 .next
595 Although Exim does have basic facilities for scanning incoming messages, these
596 are not comprehensive enough to do full virus or spam scanning. Such operations
597 are best carried out using additional specialized software packages. If you
598 compile Exim with the content-scanning extension, straightforward interfaces to
599 a number of common scanners are provided.
600 .endlist
601
602
603 .section "Run time configuration" "SECID7"
604 Exim's run time configuration is held in a single text file that is divided
605 into a number of sections. The entries in this file consist of keywords and
606 values, in the style of Smail 3 configuration files. A default configuration
607 file which is suitable for simple online installations is provided in the
608 distribution, and is described in chapter &<<CHAPdefconfil>>& below.
609
610
611 .section "Calling interface" "SECID8"
612 .cindex "Sendmail compatibility" "command line interface"
613 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
614 can be a straight replacement for &_/usr/lib/sendmail_& or
615 &_/usr/sbin/sendmail_& when sending mail, but you do not need to know anything
616 about Sendmail in order to run Exim. For actions other than sending messages,
617 Sendmail-compatible options also exist, but those that produce output (for
618 example, &%-bp%&, which lists the messages on the queue) do so in Exim's own
619 format. There are also some additional options that are compatible with Smail
620 3, and some further options that are new to Exim. Chapter &<<CHAPcommandline>>&
621 documents all Exim's command line options. This information is automatically
622 made into the man page that forms part of the Exim distribution.
623
624 Control of messages on the queue can be done via certain privileged command
625 line options. There is also an optional monitor program called &'eximon'&,
626 which displays current information in an X window, and which contains a menu
627 interface to Exim's command line administration options.
628
629
630
631 .section "Terminology" "SECID9"
632 .cindex "terminology definitions"
633 .cindex "body of message" "definition of"
634 The &'body'& of a message is the actual data that the sender wants to transmit.
635 It is the last part of a message, and is separated from the &'header'& (see
636 below) by a blank line.
637
638 .cindex "bounce message" "definition of"
639 When a message cannot be delivered, it is normally returned to the sender in a
640 delivery failure message or a &"non-delivery report"& (NDR). The term
641 &'bounce'& is commonly used for this action, and the error reports are often
642 called &'bounce messages'&. This is a convenient shorthand for &"delivery
643 failure error report"&. Such messages have an empty sender address in the
644 message's &'envelope'& (see below) to ensure that they cannot themselves give
645 rise to further bounce messages.
646
647 The term &'default'& appears frequently in this manual. It is used to qualify a
648 value which is used in the absence of any setting in the configuration. It may
649 also qualify an action which is taken unless a configuration setting specifies
650 otherwise.
651
652 The term &'defer'& is used when the delivery of a message to a specific
653 destination cannot immediately take place for some reason (a remote host may be
654 down, or a user's local mailbox may be full). Such deliveries are &'deferred'&
655 until a later time.
656
657 The word &'domain'& is sometimes used to mean all but the first component of a
658 host's name. It is &'not'& used in that sense here, where it normally refers to
659 the part of an email address following the @ sign.
660
661 .cindex "envelope, definition of"
662 .cindex "sender" "definition of"
663 A message in transit has an associated &'envelope'&, as well as a header and a
664 body. The envelope contains a sender address (to which bounce messages should
665 be delivered), and any number of recipient addresses. References to the
666 sender or the recipients of a message usually mean the addresses in the
667 envelope. An MTA uses these addresses for delivery, and for returning bounce
668 messages, not the addresses that appear in the header lines.
669
670 .cindex "message" "header, definition of"
671 .cindex "header section" "definition of"
672 The &'header'& of a message is the first part of a message's text, consisting
673 of a number of lines, each of which has a name such as &'From:'&, &'To:'&,
674 &'Subject:'&, etc. Long header lines can be split over several text lines by
675 indenting the continuations. The header is separated from the body by a blank
676 line.
677
678 .cindex "local part" "definition of"
679 .cindex "domain" "definition of"
680 The term &'local part'&, which is taken from RFC 2822, is used to refer to that
681 part of an email address that precedes the @ sign. The part that follows the
682 @ sign is called the &'domain'& or &'mail domain'&.
683
684 .cindex "local delivery" "definition of"
685 .cindex "remote delivery, definition of"
686 The terms &'local delivery'& and &'remote delivery'& are used to distinguish
687 delivery to a file or a pipe on the local host from delivery by SMTP over
688 TCP/IP to another host. As far as Exim is concerned, all hosts other than the
689 host it is running on are &'remote'&.
690
691 .cindex "return path" "definition of"
692 &'Return path'& is another name that is used for the sender address in a
693 message's envelope.
694
695 .cindex "queue" "definition of"
696 The term &'queue'& is used to refer to the set of messages awaiting delivery,
697 because this term is in widespread use in the context of MTAs. However, in
698 Exim's case the reality is more like a pool than a queue, because there is
699 normally no ordering of waiting messages.
700
701 .cindex "queue runner" "definition of"
702 The term &'queue runner'& is used to describe a process that scans the queue
703 and attempts to deliver those messages whose retry times have come. This term
704 is used by other MTAs, and also relates to the command &%runq%&, but in Exim
705 the waiting messages are normally processed in an unpredictable order.
706
707 .cindex "spool directory" "definition of"
708 The term &'spool directory'& is used for a directory in which Exim keeps the
709 messages on its queue &-- that is, those that it is in the process of
710 delivering. This should not be confused with the directory in which local
711 mailboxes are stored, which is called a &"spool directory"& by some people. In
712 the Exim documentation, &"spool"& is always used in the first sense.
713
714
715
716
717
718
719 . ////////////////////////////////////////////////////////////////////////////
720 . ////////////////////////////////////////////////////////////////////////////
721
722 .chapter "Incorporated code" "CHID2"
723 .cindex "incorporated code"
724 .cindex "regular expressions" "library"
725 .cindex "PCRE"
726 A number of pieces of external code are included in the Exim distribution.
727
728 .ilist
729 Regular expressions are supported in the main Exim program and in the
730 Exim monitor using the freely-distributable PCRE library, copyright
731 &copy; University of Cambridge. The source to PCRE is no longer shipped with
732 Exim, so you will need to use the version of PCRE shipped with your system,
733 or obtain and install the full version of the library from
734 &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre).
735 .next
736 .cindex "cdb" "acknowledgment"
737 Support for the cdb (Constant DataBase) lookup method is provided by code
738 contributed by Nigel Metheringham of (at the time he contributed it) Planet
739 Online Ltd. The implementation is completely contained within the code of Exim.
740 It does not link against an external cdb library. The code contains the
741 following statements:
742
743 .blockquote
744 Copyright &copy; 1998 Nigel Metheringham, Planet Online Ltd
745
746 This program is free software; you can redistribute it and/or modify it under
747 the terms of the GNU General Public License as published by the Free Software
748 Foundation; either version 2 of the License, or (at your option) any later
749 version.
750 This code implements Dan Bernstein's Constant DataBase (cdb) spec. Information,
751 the spec and sample code for cdb can be obtained from
752 &url(http://www.pobox.com/~djb/cdb.html). This implementation borrows
753 some code from Dan Bernstein's implementation (which has no license
754 restrictions applied to it).
755 .endblockquote
756 .next
757 .cindex "SPA authentication"
758 .cindex "Samba project"
759 .cindex "Microsoft Secure Password Authentication"
760 Client support for Microsoft's &'Secure Password Authentication'& is provided
761 by code contributed by Marc Prud'hommeaux. Server support was contributed by
762 Tom Kistner. This includes code taken from the Samba project, which is released
763 under the Gnu GPL.
764 .next
765 .cindex "Cyrus"
766 .cindex "&'pwcheck'& daemon"
767 .cindex "&'pwauthd'& daemon"
768 Support for calling the Cyrus &'pwcheck'& and &'saslauthd'& daemons is provided
769 by code taken from the Cyrus-SASL library and adapted by Alexander S.
770 Sabourenkov. The permission notice appears below, in accordance with the
771 conditions expressed therein.
772
773 .blockquote
774 Copyright &copy; 2001 Carnegie Mellon University.  All rights reserved.
775
776 Redistribution and use in source and binary forms, with or without
777 modification, are permitted provided that the following conditions
778 are met:
779
780 .olist
781 Redistributions of source code must retain the above copyright
782 notice, this list of conditions and the following disclaimer.
783 .next
784 Redistributions in binary form must reproduce the above copyright
785 notice, this list of conditions and the following disclaimer in
786 the documentation and/or other materials provided with the
787 distribution.
788 .next
789 The name &"Carnegie Mellon University"& must not be used to
790 endorse or promote products derived from this software without
791 prior written permission. For permission or any other legal
792 details, please contact
793 .display
794               Office of Technology Transfer
795               Carnegie Mellon University
796               5000 Forbes Avenue
797               Pittsburgh, PA  15213-3890
798               (412) 268-4387, fax: (412) 268-7395
799               tech-transfer@andrew.cmu.edu
800 .endd
801 .next
802 Redistributions of any form whatsoever must retain the following
803 acknowledgment:
804
805 &"This product includes software developed by Computing Services
806 at Carnegie Mellon University (&url(http://www.cmu.edu/computing/)."&
807
808 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
809 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
810 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
811 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
812 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
813 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
814 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
815 .endlist
816 .endblockquote
817
818 .next
819 .cindex "Exim monitor" "acknowledgment"
820 .cindex "X-windows"
821 .cindex "Athena"
822 The Exim Monitor program, which is an X-Window application, includes
823 modified versions of the Athena StripChart and TextPop widgets.
824 This code is copyright by DEC and MIT, and their permission notice appears
825 below, in accordance with the conditions expressed therein.
826
827 .blockquote
828 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
829 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
830
831 All Rights Reserved
832
833 Permission to use, copy, modify, and distribute this software and its
834 documentation for any purpose and without fee is hereby granted,
835 provided that the above copyright notice appear in all copies and that
836 both that copyright notice and this permission notice appear in
837 supporting documentation, and that the names of Digital or MIT not be
838 used in advertising or publicity pertaining to distribution of the
839 software without specific, written prior permission.
840
841 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
842 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
843 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
844 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
845 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
846 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
847 SOFTWARE.
848 .endblockquote
849
850 .next
851 Many people have contributed code fragments, some large, some small, that were
852 not covered by any specific licence requirements. It is assumed that the
853 contributors are happy to see their code incorporated into Exim under the GPL.
854 .endlist
855
856
857
858
859
860 . ////////////////////////////////////////////////////////////////////////////
861 . ////////////////////////////////////////////////////////////////////////////
862
863 .chapter "How Exim receives and delivers mail" "CHID11" &&&
864          "Receiving and delivering mail"
865
866
867 .section "Overall philosophy" "SECID10"
868 .cindex "design philosophy"
869 Exim is designed to work efficiently on systems that are permanently connected
870 to the Internet and are handling a general mix of mail. In such circumstances,
871 most messages can be delivered immediately. Consequently, Exim does not
872 maintain independent queues of messages for specific domains or hosts, though
873 it does try to send several messages in a single SMTP connection after a host
874 has been down, and it also maintains per-host retry information.
875
876
877 .section "Policy control" "SECID11"
878 .cindex "policy control" "overview"
879 Policy controls are now an important feature of MTAs that are connected to the
880 Internet. Perhaps their most important job is to stop MTAs being abused as
881 &"open relays"& by misguided individuals who send out vast amounts of
882 unsolicited junk, and want to disguise its source. Exim provides flexible
883 facilities for specifying policy controls on incoming mail:
884
885 .ilist
886 .cindex "&ACL;" "introduction"
887 Exim 4 (unlike previous versions of Exim) implements policy controls on
888 incoming mail by means of &'Access Control Lists'& (ACLs). Each list is a
889 series of statements that may either grant or deny access. ACLs can be used at
890 several places in the SMTP dialogue while receiving a message from a remote
891 host. However, the most common places are after each RCPT command, and at the
892 very end of the message. The sysadmin can specify conditions for accepting or
893 rejecting individual recipients or the entire message, respectively, at these
894 two points (see chapter &<<CHAPACL>>&). Denial of access results in an SMTP
895 error code.
896 .next
897 An ACL is also available for locally generated, non-SMTP messages. In this
898 case, the only available actions are to accept or deny the entire message.
899 .next
900 When Exim is compiled with the content-scanning extension, facilities are
901 provided in the ACL mechanism for passing the message to external virus and/or
902 spam scanning software. The result of such a scan is passed back to the ACL,
903 which can then use it to decide what to do with the message.
904 .next
905 When a message has been received, either from a remote host or from the local
906 host, but before the final acknowledgment has been sent, a locally supplied C
907 function called &[local_scan()]& can be run to inspect the message and decide
908 whether to accept it or not (see chapter &<<CHAPlocalscan>>&). If the message
909 is accepted, the list of recipients can be modified by the function.
910 .next
911 Using the &[local_scan()]& mechanism is another way of calling external scanner
912 software. The &%SA-Exim%& add-on package works this way. It does not require
913 Exim to be compiled with the content-scanning extension.
914 .next
915 After a message has been accepted, a further checking mechanism is available in
916 the form of the &'system filter'& (see chapter &<<CHAPsystemfilter>>&). This
917 runs at the start of every delivery process.
918 .endlist
919
920
921
922 .section "User filters" "SECID12"
923 .cindex "filter" "introduction"
924 .cindex "Sieve filter"
925 In a conventional Exim configuration, users are able to run private filters by
926 setting up appropriate &_.forward_& files in their home directories. See
927 chapter &<<CHAPredirect>>& (about the &(redirect)& router) for the
928 configuration needed to support this, and the separate document entitled
929 &'Exim's interfaces to mail filtering'& for user details. Two different kinds
930 of filtering are available:
931
932 .ilist
933 Sieve filters are written in the standard filtering language that is defined
934 by RFC 3028.
935 .next
936 Exim filters are written in a syntax that is unique to Exim, but which is more
937 powerful than Sieve, which it pre-dates.
938 .endlist
939
940 User filters are run as part of the routing process, described below.
941
942
943
944 .section "Message identification" "SECTmessiden"
945 .cindex "message ids" "details of format"
946 .cindex "format" "of message id"
947 .cindex "id of message"
948 .cindex "base62"
949 .cindex "base36"
950 .cindex "Darwin"
951 .cindex "Cygwin"
952 Every message handled by Exim is given a &'message id'& which is sixteen
953 characters long. It is divided into three parts, separated by hyphens, for
954 example &`16VDhn-0001bo-D3`&. Each part is a sequence of letters and digits,
955 normally encoding numbers in base 62. However, in the Darwin operating
956 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
957 (avoiding the use of lower case letters) is used instead, because the message
958 id is used to construct file names, and the names of files in those systems are
959 not always case-sensitive.
960
961 .cindex "pid (process id)" "re-use of"
962 The detail of the contents of the message id have changed as Exim has evolved.
963 Earlier versions relied on the operating system not re-using a process id (pid)
964 within one second. On modern operating systems, this assumption can no longer
965 be made, so the algorithm had to be changed. To retain backward compatibility,
966 the format of the message id was retained, which is why the following rules are
967 somewhat eccentric:
968
969 .ilist
970 The first six characters of the message id are the time at which the message
971 started to be received, to a granularity of one second. That is, this field
972 contains the number of seconds since the start of the epoch (the normal Unix
973 way of representing the date and time of day).
974 .next
975 After the first hyphen, the next six characters are the id of the process that
976 received the message.
977 .next
978 There are two different possibilities for the final two characters:
979 .olist
980 .oindex "&%localhost_number%&"
981 If &%localhost_number%& is not set, this value is the fractional part of the
982 time of reception, normally in units of 1/2000 of a second, but for systems
983 that must use base 36 instead of base 62 (because of case-insensitive file
984 systems), the units are 1/1000 of a second.
985 .next
986 If &%localhost_number%& is set, it is multiplied by 200 (100) and added to
987 the fractional part of the time, which in this case is in units of 1/200
988 (1/100) of a second.
989 .endlist
990 .endlist
991
992 After a message has been received, Exim waits for the clock to tick at the
993 appropriate resolution before proceeding, so that if another message is
994 received by the same process, or by another process with the same (re-used)
995 pid, it is guaranteed that the time will be different. In most cases, the clock
996 will already have ticked while the message was being received.
997
998
999 .section "Receiving mail" "SECID13"
1000 .cindex "receiving mail"
1001 .cindex "message" "reception"
1002 The only way Exim can receive mail from another host is using SMTP over
1003 TCP/IP, in which case the sender and recipient addresses are transferred using
1004 SMTP commands. However, from a locally running process (such as a user's MUA),
1005 there are several possibilities:
1006
1007 .ilist
1008 If the process runs Exim with the &%-bm%& option, the message is read
1009 non-interactively (usually via a pipe), with the recipients taken from the
1010 command line, or from the body of the message if &%-t%& is also used.
1011 .next
1012 If the process runs Exim with the &%-bS%& option, the message is also read
1013 non-interactively, but in this case the recipients are listed at the start of
1014 the message in a series of SMTP RCPT commands, terminated by a DATA
1015 command. This is so-called &"batch SMTP"& format,
1016 but it isn't really SMTP. The SMTP commands are just another way of passing
1017 envelope addresses in a non-interactive submission.
1018 .next
1019 If the process runs Exim with the &%-bs%& option, the message is read
1020 interactively, using the SMTP protocol. A two-way pipe is normally used for
1021 passing data between the local process and the Exim process.
1022 This is &"real"& SMTP and is handled in the same way as SMTP over TCP/IP. For
1023 example, the ACLs for SMTP commands are used for this form of submission.
1024 .next
1025 A local process may also make a TCP/IP call to the host's loopback address
1026 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1027 does not treat the loopback address specially. It treats all such connections
1028 in the same way as connections from other hosts.
1029 .endlist
1030
1031
1032 .cindex "message sender, constructed by Exim"
1033 .cindex "sender" "constructed by Exim"
1034 In the three cases that do not involve TCP/IP, the sender address is
1035 constructed from the login name of the user that called Exim and a default
1036 qualification domain (which can be set by the &%qualify_domain%& configuration
1037 option). For local or batch SMTP, a sender address that is passed using the
1038 SMTP MAIL command is ignored. However, the system administrator may allow
1039 certain users (&"trusted users"&) to specify a different sender address
1040 unconditionally, or all users to specify certain forms of different sender
1041 address. The &%-f%& option or the SMTP MAIL command is used to specify these
1042 different addresses. See section &<<SECTtrustedadmin>>& for details of trusted
1043 users, and the &%untrusted_set_sender%& option for a way of allowing untrusted
1044 users to change sender addresses.
1045
1046 Messages received by either of the non-interactive mechanisms are subject to
1047 checking by the non-SMTP ACL, if one is defined. Messages received using SMTP
1048 (either over TCP/IP, or interacting with a local process) can be checked by a
1049 number of ACLs that operate at different times during the SMTP session. Either
1050 individual recipients, or the entire message, can be rejected if local policy
1051 requirements are not met. The &[local_scan()]& function (see chapter
1052 &<<CHAPlocalscan>>&) is run for all incoming messages.
1053
1054 Exim can be configured not to start a delivery process when a message is
1055 received; this can be unconditional, or depend on the number of incoming SMTP
1056 connections or the system load. In these situations, new messages wait on the
1057 queue until a queue runner process picks them up. However, in standard
1058 configurations under normal conditions, delivery is started as soon as a
1059 message is received.
1060
1061
1062
1063
1064
1065 .section "Handling an incoming message" "SECID14"
1066 .cindex "spool directory" "files that hold a message"
1067 .cindex "file" "how a message is held"
1068 When Exim accepts a message, it writes two files in its spool directory. The
1069 first contains the envelope information, the current status of the message, and
1070 the header lines, and the second contains the body of the message. The names of
1071 the two spool files consist of the message id, followed by &`-H`& for the
1072 file containing the envelope and header, and &`-D`& for the data file.
1073
1074 .cindex "spool directory" "&_input_& sub-directory"
1075 By default all these message files are held in a single directory called
1076 &_input_& inside the general Exim spool directory. Some operating systems do
1077 not perform very well if the number of files in a directory gets large; to
1078 improve performance in such cases, the &%split_spool_directory%& option can be
1079 used. This causes Exim to split up the input files into 62 sub-directories
1080 whose names are single letters or digits. When this is done, the queue is
1081 processed one sub-directory at a time instead of all at once, which can improve
1082 overall performance even when there are not enough files in each directory to
1083 affect file system performance.
1084
1085 The envelope information consists of the address of the message's sender and
1086 the addresses of the recipients. This information is entirely separate from
1087 any addresses contained in the header lines. The status of the message includes
1088 a list of recipients who have already received the message. The format of the
1089 first spool file is described in chapter &<<CHAPspool>>&.
1090
1091 .cindex "rewriting" "addresses"
1092 Address rewriting that is specified in the rewrite section of the configuration
1093 (see chapter &<<CHAPrewrite>>&) is done once and for all on incoming addresses,
1094 both in the header lines and the envelope, at the time the message is accepted.
1095 If during the course of delivery additional addresses are generated (for
1096 example, via aliasing), these new addresses are rewritten as soon as they are
1097 generated. At the time a message is actually delivered (transported) further
1098 rewriting can take place; because this is a transport option, it can be
1099 different for different forms of delivery. It is also possible to specify the
1100 addition or removal of certain header lines at the time the message is
1101 delivered (see chapters &<<CHAProutergeneric>>& and
1102 &<<CHAPtransportgeneric>>&).
1103
1104
1105
1106 .section "Life of a message" "SECID15"
1107 .cindex "message" "life of"
1108 .cindex "message" "frozen"
1109 A message remains in the spool directory until it is completely delivered to
1110 its recipients or to an error address, or until it is deleted by an
1111 administrator or by the user who originally created it. In cases when delivery
1112 cannot proceed &-- for example, when a message can neither be delivered to its
1113 recipients nor returned to its sender, the message is marked &"frozen"& on the
1114 spool, and no more deliveries are attempted.
1115
1116 .cindex "frozen messages" "thawing"
1117 .cindex "message" "thawing frozen"
1118 An administrator can &"thaw"& such messages when the problem has been
1119 corrected, and can also freeze individual messages by hand if necessary. In
1120 addition, an administrator can force a delivery error, causing a bounce message
1121 to be sent.
1122
1123 .oindex "&%timeout_frozen_after%&"
1124 .oindex "&%ignore_bounce_errors_after%&"
1125 There are options called &%ignore_bounce_errors_after%& and
1126 &%timeout_frozen_after%&, which discard frozen messages after a certain time.
1127 The first applies only to frozen bounces, the second to any frozen messages.
1128
1129 .cindex "message" "log file for"
1130 .cindex "log" "file for each message"
1131 While Exim is working on a message, it writes information about each delivery
1132 attempt to its main log file. This includes successful, unsuccessful, and
1133 delayed deliveries for each recipient (see chapter &<<CHAPlog>>&). The log
1134 lines are also written to a separate &'message log'& file for each message.
1135 These logs are solely for the benefit of the administrator, and are normally
1136 deleted along with the spool files when processing of a message is complete.
1137 The use of individual message logs can be disabled by setting
1138 &%no_message_logs%&; this might give an improvement in performance on very busy
1139 systems.
1140
1141 .cindex "journal file"
1142 .cindex "file" "journal"
1143 All the information Exim itself needs to set up a delivery is kept in the first
1144 spool file, along with the header lines. When a successful delivery occurs, the
1145 address is immediately written at the end of a journal file, whose name is the
1146 message id followed by &`-J`&. At the end of a delivery run, if there are some
1147 addresses left to be tried again later, the first spool file (the &`-H`& file)
1148 is updated to indicate which these are, and the journal file is then deleted.
1149 Updating the spool file is done by writing a new file and renaming it, to
1150 minimize the possibility of data loss.
1151
1152 Should the system or the program crash after a successful delivery but before
1153 the spool file has been updated, the journal is left lying around. The next
1154 time Exim attempts to deliver the message, it reads the journal file and
1155 updates the spool file before proceeding. This minimizes the chances of double
1156 deliveries caused by crashes.
1157
1158
1159
1160 .section "Processing an address for delivery" "SECTprocaddress"
1161 .cindex "drivers" "definition of"
1162 .cindex "router" "definition of"
1163 .cindex "transport" "definition of"
1164 The main delivery processing elements of Exim are called &'routers'& and
1165 &'transports'&, and collectively these are known as &'drivers'&. Code for a
1166 number of them is provided in the source distribution, and compile-time options
1167 specify which ones are included in the binary. Run time options specify which
1168 ones are actually used for delivering messages.
1169
1170 .cindex "drivers" "instance definition"
1171 Each driver that is specified in the run time configuration is an &'instance'&
1172 of that particular driver type. Multiple instances are allowed; for example,
1173 you can set up several different &(smtp)& transports, each with different
1174 option values that might specify different ports or different timeouts. Each
1175 instance has its own identifying name. In what follows we will normally use the
1176 instance name when discussing one particular instance (that is, one specific
1177 configuration of the driver), and the generic driver name when discussing
1178 the driver's features in general.
1179
1180 A &'router'& is a driver that operates on an address, either determining how
1181 its delivery should happen, by assigning it to a specific transport, or
1182 converting the address into one or more new addresses (for example, via an
1183 alias file). A router may also explicitly choose to fail an address, causing it
1184 to be bounced.
1185
1186 A &'transport'& is a driver that transmits a copy of the message from Exim's
1187 spool to some destination. There are two kinds of transport: for a &'local'&
1188 transport, the destination is a file or a pipe on the local host, whereas for a
1189 &'remote'& transport the destination is some other host. A message is passed
1190 to a specific transport as a result of successful routing. If a message has
1191 several recipients, it may be passed to a number of different transports.
1192
1193 .cindex "preconditions" "definition of"
1194 An address is processed by passing it to each configured router instance in
1195 turn, subject to certain preconditions, until a router accepts the address or
1196 specifies that it should be bounced. We will describe this process in more
1197 detail shortly. First, as a simple example, we consider how each recipient
1198 address in a message is processed in a small configuration of three routers.
1199
1200 To make this a more concrete example, it is described in terms of some actual
1201 routers, but remember, this is only an example. You can configure Exim's
1202 routers in many different ways, and there may be any number of routers in a
1203 configuration.
1204
1205 The first router that is specified in a configuration is often one that handles
1206 addresses in domains that are not recognized specially by the local host. These
1207 are typically addresses for arbitrary domains on the Internet. A precondition
1208 is set up which looks for the special domains known to the host (for example,
1209 its own domain name), and the router is run for addresses that do &'not'&
1210 match. Typically, this is a router that looks up domains in the DNS in order to
1211 find the hosts to which this address routes. If it succeeds, the address is
1212 assigned to a suitable SMTP transport; if it does not succeed, the router is
1213 configured to fail the address.
1214
1215 The second router is reached only when the domain is recognized as one that
1216 &"belongs"& to the local host. This router does redirection &-- also known as
1217 aliasing and forwarding. When it generates one or more new addresses from the
1218 original, each of them is routed independently from the start. Otherwise, the
1219 router may cause an address to fail, or it may simply decline to handle the
1220 address, in which case the address is passed to the next router.
1221
1222 The final router in many configurations is one that checks to see if the
1223 address belongs to a local mailbox. The precondition may involve a check to
1224 see if the local part is the name of a login account, or it may look up the
1225 local part in a file or a database. If its preconditions are not met, or if
1226 the router declines, we have reached the end of the routers. When this happens,
1227 the address is bounced.
1228
1229
1230
1231 .section "Processing an address for verification" "SECID16"
1232 .cindex "router" "for verification"
1233 .cindex "verifying address" "overview"
1234 As well as being used to decide how to deliver to an address, Exim's routers
1235 are also used for &'address verification'&. Verification can be requested as
1236 one of the checks to be performed in an ACL for incoming messages, on both
1237 sender and recipient addresses, and it can be tested using the &%-bv%& and
1238 &%-bvs%& command line options.
1239
1240 When an address is being verified, the routers are run in &"verify mode"&. This
1241 does not affect the way the routers work, but it is a state that can be
1242 detected. By this means, a router can be skipped or made to behave differently
1243 when verifying. A common example is a configuration in which the first router
1244 sends all messages to a message-scanning program, unless they have been
1245 previously scanned. Thus, the first router accepts all addresses without any
1246 checking, making it useless for verifying. Normally, the &%no_verify%& option
1247 would be set for such a router, causing it to be skipped in verify mode.
1248
1249
1250
1251
1252 .section "Running an individual router" "SECTrunindrou"
1253 .cindex "router" "running details"
1254 .cindex "preconditions" "checking"
1255 .cindex "router" "result of running"
1256 As explained in the example above, a number of preconditions are checked before
1257 running a router. If any are not met, the router is skipped, and the address is
1258 passed to the next router. When all the preconditions on a router &'are'& met,
1259 the router is run. What happens next depends on the outcome, which is one of
1260 the following:
1261
1262 .ilist
1263 &'accept'&: The router accepts the address, and either assigns it to a
1264 transport, or generates one or more &"child"& addresses. Processing the
1265 original address ceases,
1266 .oindex "&%unseen%&"
1267 unless the &%unseen%& option is set on the router. This option
1268 can be used to set up multiple deliveries with different routing (for example,
1269 for keeping archive copies of messages). When &%unseen%& is set, the address is
1270 passed to the next router. Normally, however, an &'accept'& return marks the
1271 end of routing.
1272
1273 Any child addresses generated by the router are processed independently,
1274 starting with the first router by default. It is possible to change this by
1275 setting the &%redirect_router%& option to specify which router to start at for
1276 child addresses. Unlike &%pass_router%& (see below) the router specified by
1277 &%redirect_router%& may be anywhere in the router configuration.
1278 .next
1279 &'pass'&: The router recognizes the address, but cannot handle it itself. It
1280 requests that the address be passed to another router. By default the address
1281 is passed to the next router, but this can be changed by setting the
1282 &%pass_router%& option. However, (unlike &%redirect_router%&) the named router
1283 must be below the current router (to avoid loops).
1284 .next
1285 &'decline'&: The router declines to accept the address because it does not
1286 recognize it at all. By default, the address is passed to the next router, but
1287 this can be prevented by setting the &%no_more%& option. When &%no_more%& is
1288 set, all the remaining routers are skipped. In effect, &%no_more%& converts
1289 &'decline'& into &'fail'&.
1290 .next
1291 &'fail'&: The router determines that the address should fail, and queues it for
1292 the generation of a bounce message. There is no further processing of the
1293 original address unless &%unseen%& is set on the router.
1294 .next
1295 &'defer'&: The router cannot handle the address at the present time. (A
1296 database may be offline, or a DNS lookup may have timed out.) No further
1297 processing of the address happens in this delivery attempt. It is tried again
1298 next time the message is considered for delivery.
1299 .next
1300 &'error'&: There is some error in the router (for example, a syntax error in
1301 its configuration). The action is as for defer.
1302 .endlist
1303
1304 If an address reaches the end of the routers without having been accepted by
1305 any of them, it is bounced as unrouteable. The default error message in this
1306 situation is &"unrouteable address"&, but you can set your own message by
1307 making use of the &%cannot_route_message%& option. This can be set for any
1308 router; the value from the last router that &"saw"& the address is used.
1309
1310 Sometimes while routing you want to fail a delivery when some conditions are
1311 met but others are not, instead of passing the address on for further routing.
1312 You can do this by having a second router that explicitly fails the delivery
1313 when the relevant conditions are met. The &(redirect)& router has a &"fail"&
1314 facility for this purpose.
1315
1316
1317 .section "Duplicate addresses" "SECID17"
1318 .cindex "case of local parts"
1319 .cindex "address duplicate, discarding"
1320 .cindex "duplicate addresses"
1321 Once routing is complete, Exim scans the addresses that are assigned to local
1322 and remote transports, and discards any duplicates that it finds. During this
1323 check, local parts are treated as case-sensitive. This happens only when
1324 actually delivering a message; when testing routers with &%-bt%&, all the
1325 routed addresses are shown.
1326
1327
1328
1329 .section "Router preconditions" "SECTrouprecon"
1330 .cindex "router" "preconditions, order of processing"
1331 .cindex "preconditions" "order of processing"
1332 The preconditions that are tested for each router are listed below, in the
1333 order in which they are tested. The individual configuration options are
1334 described in more detail in chapter &<<CHAProutergeneric>>&.
1335
1336 .ilist
1337 The &%local_part_prefix%& and &%local_part_suffix%& options can specify that
1338 the local parts handled by the router may or must have certain prefixes and/or
1339 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1340 skipped. These conditions are tested first. When an affix is present, it is
1341 removed from the local part before further processing, including the evaluation
1342 of any other conditions.
1343 .next
1344 Routers can be designated for use only when not verifying an address, that is,
1345 only when routing it for delivery (or testing its delivery routing). If the
1346 &%verify%& option is set false, the router is skipped when Exim is verifying an
1347 address.
1348 Setting the &%verify%& option actually sets two options, &%verify_sender%& and
1349 &%verify_recipient%&, which independently control the use of the router for
1350 sender and recipient verification. You can set these options directly if
1351 you want a router to be used for only one type of verification.
1352 .next
1353 If the &%address_test%& option is set false, the router is skipped when Exim is
1354 run with the &%-bt%& option to test an address routing. This can be helpful
1355 when the first router sends all new messages to a scanner of some sort; it
1356 makes it possible to use &%-bt%& to test subsequent delivery routing without
1357 having to simulate the effect of the scanner.
1358 .next
1359 Routers can be designated for use only when verifying an address, as
1360 opposed to routing it for delivery. The &%verify_only%& option controls this.
1361 .next
1362 Individual routers can be explicitly skipped when running the routers to
1363 check an address given in the SMTP EXPN command (see the &%expn%& option).
1364 .next
1365 If the &%domains%& option is set, the domain of the address must be in the set
1366 of domains that it defines.
1367 .next
1368 .vindex "&$local_part_prefix$&"
1369 .vindex "&$local_part$&"
1370 .vindex "&$local_part_suffix$&"
1371 If the &%local_parts%& option is set, the local part of the address must be in
1372 the set of local parts that it defines. If &%local_part_prefix%& or
1373 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1374 part before this check. If you want to do precondition tests on local parts
1375 that include affixes, you can do so by using a &%condition%& option (see below)
1376 that uses the variables &$local_part$&, &$local_part_prefix$&, and
1377 &$local_part_suffix$& as necessary.
1378 .next
1379 .vindex "&$local_user_uid$&"
1380 .vindex "&$local_user_gid$&"
1381 .vindex "&$home$&"
1382 If the &%check_local_user%& option is set, the local part must be the name of
1383 an account on the local host. If this check succeeds, the uid and gid of the
1384 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1385 user's home directory is placed in &$home$&; these values can be used in the
1386 remaining preconditions.
1387 .next
1388 If the &%router_home_directory%& option is set, it is expanded at this point,
1389 because it overrides the value of &$home$&. If this expansion were left till
1390 later, the value of &$home$& as set by &%check_local_user%& would be used in
1391 subsequent tests. Having two different values of &$home$& in the same router
1392 could lead to confusion.
1393 .next
1394 If the &%senders%& option is set, the envelope sender address must be in the
1395 set of addresses that it defines.
1396 .next
1397 If the &%require_files%& option is set, the existence or non-existence of
1398 specified files is tested.
1399 .next
1400 .cindex "customizing" "precondition"
1401 If the &%condition%& option is set, it is evaluated and tested. This option
1402 uses an expanded string to allow you to set up your own custom preconditions.
1403 Expanded strings are described in chapter &<<CHAPexpand>>&.
1404 .endlist
1405
1406
1407 Note that &%require_files%& comes near the end of the list, so you cannot use
1408 it to check for the existence of a file in which to lookup up a domain, local
1409 part, or sender. However, as these options are all expanded, you can use the
1410 &%exists%& expansion condition to make such tests within each condition. The
1411 &%require_files%& option is intended for checking files that the router may be
1412 going to use internally, or which are needed by a specific transport (for
1413 example, &_.procmailrc_&).
1414
1415
1416
1417 .section "Delivery in detail" "SECID18"
1418 .cindex "delivery" "in detail"
1419 When a message is to be delivered, the sequence of events is as follows:
1420
1421 .ilist
1422 If a system-wide filter file is specified, the message is passed to it. The
1423 filter may add recipients to the message, replace the recipients, discard the
1424 message, cause a new message to be generated, or cause the message delivery to
1425 fail. The format of the system filter file is the same as for Exim user filter
1426 files, described in the separate document entitled &'Exim's interfaces to mail
1427 filtering'&.
1428 .cindex "Sieve filter" "not available for system filter"
1429 (&*Note*&: Sieve cannot be used for system filter files.)
1430
1431 Some additional features are available in system filters &-- see chapter
1432 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1433 filter only once per delivery attempt, however many recipients it has. However,
1434 if there are several delivery attempts because one or more addresses could not
1435 be immediately delivered, the system filter is run each time. The filter
1436 condition &%first_delivery%& can be used to detect the first run of the system
1437 filter.
1438 .next
1439 Each recipient address is offered to each configured router in turn, subject to
1440 its preconditions, until one is able to handle it. If no router can handle the
1441 address, that is, if they all decline, the address is failed. Because routers
1442 can be targeted at particular domains, several locally handled domains can be
1443 processed entirely independently of each other.
1444 .next
1445 .cindex "routing" "loops in"
1446 .cindex "loop" "while routing"
1447 A router that accepts an address may assign it to a local or a remote
1448 transport. However, the transport is not run at this time. Instead, the address
1449 is placed on a list for the particular transport, which will be run later.
1450 Alternatively, the router may generate one or more new addresses (typically
1451 from alias, forward, or filter files). New addresses are fed back into this
1452 process from the top, but in order to avoid loops, a router ignores any address
1453 which has an identically-named ancestor that was processed by itself.
1454 .next
1455 When all the routing has been done, addresses that have been successfully
1456 handled are passed to their assigned transports. When local transports are
1457 doing real local deliveries, they handle only one address at a time, but if a
1458 local transport is being used as a pseudo-remote transport (for example, to
1459 collect batched SMTP messages for transmission by some other means) multiple
1460 addresses can be handled. Remote transports can always handle more than one
1461 address at a time, but can be configured not to do so, or to restrict multiple
1462 addresses to the same domain.
1463 .next
1464 Each local delivery to a file or a pipe runs in a separate process under a
1465 non-privileged uid, and these deliveries are run one at a time. Remote
1466 deliveries also run in separate processes, normally under a uid that is private
1467 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1468 run in parallel. The maximum number of simultaneous remote deliveries for any
1469 one message is set by the &%remote_max_parallel%& option.
1470 The order in which deliveries are done is not defined, except that all local
1471 deliveries happen before any remote deliveries.
1472 .next
1473 .cindex "queue runner"
1474 When it encounters a local delivery during a queue run, Exim checks its retry
1475 database to see if there has been a previous temporary delivery failure for the
1476 address before running the local transport. If there was a previous failure,
1477 Exim does not attempt a new delivery until the retry time for the address is
1478 reached. However, this happens only for delivery attempts that are part of a
1479 queue run. Local deliveries are always attempted when delivery immediately
1480 follows message reception, even if retry times are set for them. This makes for
1481 better behaviour if one particular message is causing problems (for example,
1482 causing quota overflow, or provoking an error in a filter file).
1483 .next
1484 .cindex "delivery" "retry in remote transports"
1485 Remote transports do their own retry handling, since an address may be
1486 deliverable to one of a number of hosts, each of which may have a different
1487 retry time. If there have been previous temporary failures and no host has
1488 reached its retry time, no delivery is attempted, whether in a queue run or
1489 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1490 .next
1491 If there were any permanent errors, a bounce message is returned to an
1492 appropriate address (the sender in the common case), with details of the error
1493 for each failing address. Exim can be configured to send copies of bounce
1494 messages to other addresses.
1495 .next
1496 .cindex "delivery" "deferral"
1497 If one or more addresses suffered a temporary failure, the message is left on
1498 the queue, to be tried again later. Delivery of these addresses is said to be
1499 &'deferred'&.
1500 .next
1501 When all the recipient addresses have either been delivered or bounced,
1502 handling of the message is complete. The spool files and message log are
1503 deleted, though the message log can optionally be preserved if required.
1504 .endlist
1505
1506
1507
1508
1509 .section "Retry mechanism" "SECID19"
1510 .cindex "delivery" "retry mechanism"
1511 .cindex "retry" "description of mechanism"
1512 .cindex "queue runner"
1513 Exim's mechanism for retrying messages that fail to get delivered at the first
1514 attempt is the queue runner process. You must either run an Exim daemon that
1515 uses the &%-q%& option with a time interval to start queue runners at regular
1516 intervals, or use some other means (such as &'cron'&) to start them. If you do
1517 not arrange for queue runners to be run, messages that fail temporarily at the
1518 first attempt will remain on your queue for ever. A queue runner process works
1519 its way through the queue, one message at a time, trying each delivery that has
1520 passed its retry time.
1521 You can run several queue runners at once.
1522
1523 Exim uses a set of configured rules to determine when next to retry the failing
1524 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1525 should give up trying to deliver to the address, at which point it generates a
1526 bounce message. If no retry rules are set for a particular host, address, and
1527 error combination, no retries are attempted, and temporary errors are treated
1528 as permanent.
1529
1530
1531
1532 .section "Temporary delivery failure" "SECID20"
1533 .cindex "delivery" "temporary failure"
1534 There are many reasons why a message may not be immediately deliverable to a
1535 particular address. Failure to connect to a remote machine (because it, or the
1536 connection to it, is down) is one of the most common. Temporary failures may be
1537 detected during routing as well as during the transport stage of delivery.
1538 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1539 is on a file system where the user is over quota. Exim can be configured to
1540 impose its own quotas on local mailboxes; where system quotas are set they will
1541 also apply.
1542
1543 If a host is unreachable for a period of time, a number of messages may be
1544 waiting for it by the time it recovers, and sending them in a single SMTP
1545 connection is clearly beneficial. Whenever a delivery to a remote host is
1546 deferred,
1547
1548 .cindex "hints database"
1549 Exim makes a note in its hints database, and whenever a successful
1550 SMTP delivery has happened, it looks to see if any other messages are waiting
1551 for the same host. If any are found, they are sent over the same SMTP
1552 connection, subject to a configuration limit as to the maximum number in any
1553 one connection.
1554
1555
1556
1557
1558 .section "Permanent delivery failure" "SECID21"
1559 .cindex "delivery" "permanent failure"
1560 .cindex "bounce message" "when generated"
1561 When a message cannot be delivered to some or all of its intended recipients, a
1562 bounce message is generated. Temporary delivery failures turn into permanent
1563 errors when their timeout expires. All the addresses that fail in a given
1564 delivery attempt are listed in a single message. If the original message has
1565 many recipients, it is possible for some addresses to fail in one delivery
1566 attempt and others to fail subsequently, giving rise to more than one bounce
1567 message. The wording of bounce messages can be customized by the administrator.
1568 See chapter &<<CHAPemsgcust>>& for details.
1569
1570 .cindex "&'X-Failed-Recipients:'& header line"
1571 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1572 failed addresses, for the benefit of programs that try to analyse such messages
1573 automatically.
1574
1575 .cindex "bounce message" "recipient of"
1576 A bounce message is normally sent to the sender of the original message, as
1577 obtained from the message's envelope. For incoming SMTP messages, this is the
1578 address given in the MAIL command. However, when an address is expanded via a
1579 forward or alias file, an alternative address can be specified for delivery
1580 failures of the generated addresses. For a mailing list expansion (see section
1581 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1582 of the list.
1583
1584
1585
1586 .section "Failures to deliver bounce messages" "SECID22"
1587 .cindex "bounce message" "failure to deliver"
1588 If a bounce message (either locally generated or received from a remote host)
1589 itself suffers a permanent delivery failure, the message is left on the queue,
1590 but it is frozen, awaiting the attention of an administrator. There are options
1591 that can be used to make Exim discard such failed messages, or to keep them
1592 for only a short time (see &%timeout_frozen_after%& and
1593 &%ignore_bounce_errors_after%&).
1594
1595
1596
1597
1598
1599 . ////////////////////////////////////////////////////////////////////////////
1600 . ////////////////////////////////////////////////////////////////////////////
1601
1602 .chapter "Building and installing Exim" "CHID3"
1603 .scindex IIDbuex "building Exim"
1604
1605 .section "Unpacking" "SECID23"
1606 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1607 creates a directory with the name of the current release (for example,
1608 &_exim-&version;_&) into which the following files are placed:
1609
1610 .table2 140pt
1611 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1612 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1613   documented"
1614 .irow &_LICENCE_&         "the GNU General Public Licence"
1615 .irow &_Makefile_&        "top-level make file"
1616 .irow &_NOTICE_&          "conditions for the use of Exim"
1617 .irow &_README_&          "list of files, directories and simple build &&&
1618   instructions"
1619 .endtable
1620
1621 Other files whose names begin with &_README_& may also be present. The
1622 following subdirectories are created:
1623
1624 .table2 140pt
1625 .irow &_Local_&           "an empty directory for local configuration files"
1626 .irow &_OS_&              "OS-specific files"
1627 .irow &_doc_&             "documentation files"
1628 .irow &_exim_monitor_&    "source files for the Exim monitor"
1629 .irow &_scripts_&         "scripts used in the build process"
1630 .irow &_src_&             "remaining source files"
1631 .irow &_util_&            "independent utilities"
1632 .endtable
1633
1634 The main utility programs are contained in the &_src_& directory, and are built
1635 with the Exim binary. The &_util_& directory contains a few optional scripts
1636 that may be useful to some sites.
1637
1638
1639 .section "Multiple machine architectures and operating systems" "SECID24"
1640 .cindex "building Exim" "multiple OS/architectures"
1641 The building process for Exim is arranged to make it easy to build binaries for
1642 a number of different architectures and operating systems from the same set of
1643 source files. Compilation does not take place in the &_src_& directory.
1644 Instead, a &'build directory'& is created for each architecture and operating
1645 system.
1646 .cindex "symbolic link" "to build directory"
1647 Symbolic links to the sources are installed in this directory, which is where
1648 the actual building takes place. In most cases, Exim can discover the machine
1649 architecture and operating system for itself, but the defaults can be
1650 overridden if necessary.
1651
1652
1653 .section "PCRE library" "SECTpcre"
1654 .cindex "PCRE library"
1655 Exim no longer has an embedded PCRE library as the vast majority of
1656 modern systems include PCRE as a system library, although you may need
1657 to install the PCRE or PCRE development package for your operating
1658 system. If your system has a normal PCRE installation the Exim build
1659 process will need no further configuration. If the library or the
1660 headers are in an unusual location you will need to set the PCRE_LIBS
1661 and INCLUDE directives appropriately. If your operating system has no
1662 PCRE support then you will need to obtain and build the current PCRE
1663 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1664
1665 .section "DBM libraries" "SECTdb"
1666 .cindex "DBM libraries" "discussion of"
1667 .cindex "hints database" "DBM files used for"
1668 Even if you do not use any DBM files in your configuration, Exim still needs a
1669 DBM library in order to operate, because it uses indexed files for its hints
1670 databases. Unfortunately, there are a number of DBM libraries in existence, and
1671 different operating systems often have different ones installed.
1672
1673 .cindex "Solaris" "DBM library for"
1674 .cindex "IRIX, DBM library for"
1675 .cindex "BSD, DBM library for"
1676 .cindex "Linux, DBM library for"
1677 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1678 Linux distribution, the DBM configuration should happen automatically, and you
1679 may be able to ignore this section. Otherwise, you may have to learn more than
1680 you would like about DBM libraries from what follows.
1681
1682 .cindex "&'ndbm'& DBM library"
1683 Licensed versions of Unix normally contain a library of DBM functions operating
1684 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1685 versions of Unix seem to vary in what they contain as standard. In particular,
1686 some early versions of Linux have no default DBM library, and different
1687 distributors have chosen to bundle different libraries with their packaged
1688 versions. However, the more recent releases seem to have standardized on the
1689 Berkeley DB library.
1690
1691 Different DBM libraries have different conventions for naming the files they
1692 use. When a program opens a file called &_dbmfile_&, there are several
1693 possibilities:
1694
1695 .olist
1696 A traditional &'ndbm'& implementation, such as that supplied as part of
1697 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1698 .next
1699 .cindex "&'gdbm'& DBM library"
1700 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1701 compatibility interface it makes two different hard links to it with names
1702 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1703 file name is used unmodified.
1704 .next
1705 .cindex "Berkeley DB library"
1706 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1707 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1708 programmer exactly the same as the traditional &'ndbm'& implementation.
1709 .next
1710 If the Berkeley package is used in its native mode, it operates on a single
1711 file called &_dbmfile_&; the programmer's interface is somewhat different to
1712 the traditional &'ndbm'& interface.
1713 .next
1714 To complicate things further, there are several very different versions of the
1715 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1716 2.&'x'& and 3.&'x'& were current for a while, but the latest versions are now
1717 numbered 4.&'x'&. Maintenance of some of the earlier releases has ceased. All
1718 versions of Berkeley DB can be obtained from
1719 &url(http://www.sleepycat.com/).
1720 .next
1721 .cindex "&'tdb'& DBM library"
1722 Yet another DBM library, called &'tdb'&, is available from
1723 &url(http://download.sourceforge.net/tdb). It has its own interface, and also
1724 operates on a single file.
1725 .endlist
1726
1727 .cindex "USE_DB"
1728 .cindex "DBM libraries" "configuration for building"
1729 Exim and its utilities can be compiled to use any of these interfaces. In order
1730 to use any version of the Berkeley DB package in native mode, you must set
1731 USE_DB in an appropriate configuration file (typically
1732 &_Local/Makefile_&). For example:
1733 .code
1734 USE_DB=yes
1735 .endd
1736 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1737 error is diagnosed if you set more than one of these.
1738
1739 At the lowest level, the build-time configuration sets none of these options,
1740 thereby assuming an interface of type (1). However, some operating system
1741 configuration files (for example, those for the BSD operating systems and
1742 Linux) assume type (4) by setting USE_DB as their default, and the
1743 configuration files for Cygwin set USE_GDBM. Anything you set in
1744 &_Local/Makefile_&, however, overrides these system defaults.
1745
1746 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1747 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1748 in one of these lines:
1749 .code
1750 DBMLIB = -ldb
1751 DBMLIB = -ltdb
1752 .endd
1753 Settings like that will work if the DBM library is installed in the standard
1754 place. Sometimes it is not, and the library's header file may also not be in
1755 the default path. You may need to set INCLUDE to specify where the header
1756 file is, and to specify the path to the library more fully in DBMLIB, as in
1757 this example:
1758 .code
1759 INCLUDE=-I/usr/local/include/db-4.1
1760 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1761 .endd
1762 There is further detailed discussion about the various DBM libraries in the
1763 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1764
1765
1766
1767 .section "Pre-building configuration" "SECID25"
1768 .cindex "building Exim" "pre-building configuration"
1769 .cindex "configuration for building Exim"
1770 .cindex "&_Local/Makefile_&"
1771 .cindex "&_src/EDITME_&"
1772 Before building Exim, a local configuration file that specifies options
1773 independent of any operating system has to be created with the name
1774 &_Local/Makefile_&. A template for this file is supplied as the file
1775 &_src/EDITME_&, and it contains full descriptions of all the option settings
1776 therein. These descriptions are therefore not repeated here. If you are
1777 building Exim for the first time, the simplest thing to do is to copy
1778 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1779
1780 There are three settings that you must supply, because Exim will not build
1781 without them. They are the location of the run time configuration file
1782 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1783 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1784 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1785 a colon-separated list of file names; Exim uses the first of them that exists.
1786
1787 There are a few other parameters that can be specified either at build time or
1788 at run time, to enable the same binary to be used on a number of different
1789 machines. However, if the locations of Exim's spool directory and log file
1790 directory (if not within the spool directory) are fixed, it is recommended that
1791 you specify them in &_Local/Makefile_& instead of at run time, so that errors
1792 detected early in Exim's execution (such as a malformed configuration file) can
1793 be logged.
1794
1795 .cindex "content scanning" "specifying at build time"
1796 Exim's interfaces for calling virus and spam scanning software directly from
1797 access control lists are not compiled by default. If you want to include these
1798 facilities, you need to set
1799 .code
1800 WITH_CONTENT_SCAN=yes
1801 .endd
1802 in your &_Local/Makefile_&. For details of the facilities themselves, see
1803 chapter &<<CHAPexiscan>>&.
1804
1805
1806 .cindex "&_Local/eximon.conf_&"
1807 .cindex "&_exim_monitor/EDITME_&"
1808 If you are going to build the Exim monitor, a similar configuration process is
1809 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1810 your installation and saved under the name &_Local/eximon.conf_&. If you are
1811 happy with the default settings described in &_exim_monitor/EDITME_&,
1812 &_Local/eximon.conf_& can be empty, but it must exist.
1813
1814 This is all the configuration that is needed in straightforward cases for known
1815 operating systems. However, the building process is set up so that it is easy
1816 to override options that are set by default or by operating-system-specific
1817 configuration files, for example to change the name of the C compiler, which
1818 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1819 do this.
1820
1821
1822
1823 .section "Support for iconv()" "SECID26"
1824 .cindex "&[iconv()]& support"
1825 .cindex "RFC 2047"
1826 The contents of header lines in messages may be encoded according to the rules
1827 described RFC 2047. This makes it possible to transmit characters that are not
1828 in the ASCII character set, and to label them as being in a particular
1829 character set. When Exim is inspecting header lines by means of the &%$h_%&
1830 mechanism, it decodes them, and translates them into a specified character set
1831 (default ISO-8859-1). The translation is possible only if the operating system
1832 supports the &[iconv()]& function.
1833
1834 However, some of the operating systems that supply &[iconv()]& do not support
1835 very many conversions. The GNU &%libiconv%& library (available from
1836 &url(http://www.gnu.org/software/libiconv/)) can be installed on such
1837 systems to remedy this deficiency, as well as on systems that do not supply
1838 &[iconv()]& at all. After installing &%libiconv%&, you should add
1839 .code
1840 HAVE_ICONV=yes
1841 .endd
1842 to your &_Local/Makefile_& and rebuild Exim.
1843
1844
1845
1846 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1847 .cindex "TLS" "including support for TLS"
1848 .cindex "encryption" "including support for"
1849 .cindex "SUPPORT_TLS"
1850 .cindex "OpenSSL" "building Exim with"
1851 .cindex "GnuTLS" "building Exim with"
1852 Exim can be built to support encrypted SMTP connections, using the STARTTLS
1853 command as per RFC 2487. It can also support legacy clients that expect to
1854 start a TLS session immediately on connection to a non-standard port (see the
1855 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1856 line option).
1857
1858 If you want to build Exim with TLS support, you must first install either the
1859 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1860 implementing SSL.
1861
1862 If OpenSSL is installed, you should set
1863 .code
1864 SUPPORT_TLS=yes
1865 TLS_LIBS=-lssl -lcrypto
1866 .endd
1867 in &_Local/Makefile_&. You may also need to specify the locations of the
1868 OpenSSL library and include files. For example:
1869 .code
1870 SUPPORT_TLS=yes
1871 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1872 TLS_INCLUDE=-I/usr/local/openssl/include/
1873 .endd
1874 .cindex "USE_GNUTLS"
1875 If GnuTLS is installed, you should set
1876 .code
1877 SUPPORT_TLS=yes
1878 USE_GNUTLS=yes
1879 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1880 .endd
1881 in &_Local/Makefile_&, and again you may need to specify the locations of the
1882 library and include files. For example:
1883 .code
1884 SUPPORT_TLS=yes
1885 USE_GNUTLS=yes
1886 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1887 TLS_INCLUDE=-I/usr/gnu/include
1888 .endd
1889 You do not need to set TLS_INCLUDE if the relevant directory is already
1890 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1891 given in chapter &<<CHAPTLS>>&.
1892
1893
1894
1895
1896 .section "Use of tcpwrappers" "SECID27"
1897 .cindex "tcpwrappers, building Exim to support"
1898 .cindex "USE_TCP_WRAPPERS"
1899 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1900 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1901 alternative to Exim's own checking facilities for installations that are
1902 already making use of &'tcpwrappers'& for other purposes. To do this, you
1903 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1904 &_tcpd.h_& to be available at compile time, and also ensure that the library
1905 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1906 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1907 you might have
1908 .code
1909 USE_TCP_WRAPPERS=yes
1910 CFLAGS=-O -I/usr/local/include
1911 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1912 .endd
1913 in &_Local/Makefile_&. The name to use in the &'tcpwrappers'& control files is
1914 &"exim"&. For example, the line
1915 .code
1916 exim : LOCAL  192.168.1.  .friendly.domain.example
1917 .endd
1918 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1919 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1920 All other connections are denied. Consult the &'tcpwrappers'& documentation for
1921 further details.
1922
1923
1924
1925 .section "Including support for IPv6" "SECID28"
1926 .cindex "IPv6" "including support for"
1927 Exim contains code for use on systems that have IPv6 support. Setting
1928 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
1929 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
1930 where the IPv6 support is not fully integrated into the normal include and
1931 library files.
1932
1933 Two different types of DNS record for handling IPv6 addresses have been
1934 defined. AAAA records (analogous to A records for IPv4) are in use, and are
1935 currently seen as the mainstream. Another record type called A6 was proposed
1936 as better than AAAA because it had more flexibility. However, it was felt to be
1937 over-complex, and its status was reduced to &"experimental"&. It is not known
1938 if anyone is actually using A6 records. Exim has support for A6 records, but
1939 this is included only if you set &`SUPPORT_A6=YES`& in &_Local/Makefile_&. The
1940 support has not been tested for some time.
1941
1942
1943
1944 .section "The building process" "SECID29"
1945 .cindex "build directory"
1946 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
1947 created, run &'make'& at the top level. It determines the architecture and
1948 operating system types, and creates a build directory if one does not exist.
1949 For example, on a Sun system running Solaris 8, the directory
1950 &_build-SunOS5-5.8-sparc_& is created.
1951 .cindex "symbolic link" "to source files"
1952 Symbolic links to relevant source files are installed in the build directory.
1953
1954 &*Warning*&: The &%-j%& (parallel) flag must not be used with &'make'&; the
1955 building process fails if it is set.
1956
1957 If this is the first time &'make'& has been run, it calls a script that builds
1958 a make file inside the build directory, using the configuration files from the
1959 &_Local_& directory. The new make file is then passed to another instance of
1960 &'make'&. This does the real work, building a number of utility scripts, and
1961 then compiling and linking the binaries for the Exim monitor (if configured), a
1962 number of utility programs, and finally Exim itself. The command &`make
1963 makefile`& can be used to force a rebuild of the make file in the build
1964 directory, should this ever be necessary.
1965
1966 If you have problems building Exim, check for any comments there may be in the
1967 &_README_& file concerning your operating system, and also take a look at the
1968 FAQ, where some common problems are covered.
1969
1970
1971
1972 .section 'Output from &"make"&' "SECID283"
1973 The output produced by the &'make'& process for compile lines is often very
1974 unreadable, because these lines can be very long. For this reason, the normal
1975 output is suppressed by default, and instead output similar to that which
1976 appears when compiling the 2.6 Linux kernel is generated: just a short line for
1977 each module that is being compiled or linked. However, it is still possible to
1978 get the full output, by calling &'make'& like this:
1979 .code
1980 FULLECHO='' make -e
1981 .endd
1982 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
1983 command reflection in &'make'&. When you ask for the full output, it is
1984 given in addition to the short output.
1985
1986
1987
1988 .section "Overriding build-time options for Exim" "SECToverride"
1989 .cindex "build-time options, overriding"
1990 The main make file that is created at the beginning of the building process
1991 consists of the concatenation of a number of files which set configuration
1992 values, followed by a fixed set of &'make'& instructions. If a value is set
1993 more than once, the last setting overrides any previous ones. This provides a
1994 convenient way of overriding defaults. The files that are concatenated are, in
1995 order:
1996 .display
1997 &_OS/Makefile-Default_&
1998 &_OS/Makefile-_&<&'ostype'&>
1999 &_Local/Makefile_&
2000 &_Local/Makefile-_&<&'ostype'&>
2001 &_Local/Makefile-_&<&'archtype'&>
2002 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2003 &_OS/Makefile-Base_&
2004 .endd
2005 .cindex "&_Local/Makefile_&"
2006 .cindex "building Exim" "operating system type"
2007 .cindex "building Exim" "architecture type"
2008 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2009 architecture type. &_Local/Makefile_& is required to exist, and the building
2010 process fails if it is absent. The other three &_Local_& files are optional,
2011 and are often not needed.
2012
2013 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2014 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2015 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2016 values are used, thereby providing a means of forcing particular settings.
2017 Otherwise, the scripts try to get values from the &%uname%& command. If this
2018 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2019 of &'ad hoc'& transformations are then applied, to produce the standard names
2020 that Exim expects. You can run these scripts directly from the shell in order
2021 to find out what values are being used on your system.
2022
2023
2024 &_OS/Makefile-Default_& contains comments about the variables that are set
2025 therein. Some (but not all) are mentioned below. If there is something that
2026 needs changing, review the contents of this file and the contents of the make
2027 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2028 default values are.
2029
2030
2031 .cindex "building Exim" "overriding default settings"
2032 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2033 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2034 need to change the original files. Instead, you should make the changes by
2035 putting the new values in an appropriate &_Local_& file. For example,
2036 .cindex "Tru64-Unix build-time settings"
2037 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2038 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2039 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2040 called with the option &%-std1%&, to make it recognize some of the features of
2041 Standard C that Exim uses. (Most other compilers recognize Standard C by
2042 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2043 containing the lines
2044 .code
2045 CC=cc
2046 CFLAGS=-std1
2047 .endd
2048 If you are compiling for just one operating system, it may be easier to put
2049 these lines directly into &_Local/Makefile_&.
2050
2051 Keeping all your local configuration settings separate from the distributed
2052 files makes it easy to transfer them to new versions of Exim simply by copying
2053 the contents of the &_Local_& directory.
2054
2055
2056 .cindex "NIS lookup type" "including support for"
2057 .cindex "NIS+ lookup type" "including support for"
2058 .cindex "LDAP" "including support for"
2059 .cindex "lookup" "inclusion in binary"
2060 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2061 lookup, but not all systems have these components installed, so the default is
2062 not to include the relevant code in the binary. All the different kinds of file
2063 and database lookup that Exim supports are implemented as separate code modules
2064 which are included only if the relevant compile-time options are set. In the
2065 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2066 .code
2067 LOOKUP_LDAP=yes
2068 LOOKUP_NIS=yes
2069 LOOKUP_NISPLUS=yes
2070 .endd
2071 and similar settings apply to the other lookup types. They are all listed in
2072 &_src/EDITME_&. In many cases the relevant include files and interface
2073 libraries need to be installed before compiling Exim.
2074 .cindex "cdb" "including support for"
2075 However, there are some optional lookup types (such as cdb) for which
2076 the code is entirely contained within Exim, and no external include
2077 files or libraries are required. When a lookup type is not included in the
2078 binary, attempts to configure Exim to use it cause run time configuration
2079 errors.
2080
2081 .cindex "Perl" "including support for"
2082 Exim can be linked with an embedded Perl interpreter, allowing Perl
2083 subroutines to be called during string expansion. To enable this facility,
2084 .code
2085 EXIM_PERL=perl.o
2086 .endd
2087 must be defined in &_Local/Makefile_&. Details of this facility are given in
2088 chapter &<<CHAPperl>>&.
2089
2090 .cindex "X11 libraries, location of"
2091 The location of the X11 libraries is something that varies a lot between
2092 operating systems, and there may be different versions of X11 to cope
2093 with. Exim itself makes no use of X11, but if you are compiling the Exim
2094 monitor, the X11 libraries must be available.
2095 The following three variables are set in &_OS/Makefile-Default_&:
2096 .code
2097 X11=/usr/X11R6
2098 XINCLUDE=-I$(X11)/include
2099 XLFLAGS=-L$(X11)/lib
2100 .endd
2101 These are overridden in some of the operating-system configuration files. For
2102 example, in &_OS/Makefile-SunOS5_& there is
2103 .code
2104 X11=/usr/openwin
2105 XINCLUDE=-I$(X11)/include
2106 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2107 .endd
2108 If you need to override the default setting for your operating system, place a
2109 definition of all three of these variables into your
2110 &_Local/Makefile-<ostype>_& file.
2111
2112 .cindex "EXTRALIBS"
2113 If you need to add any extra libraries to the link steps, these can be put in a
2114 variable called EXTRALIBS, which appears in all the link commands, but by
2115 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2116 command for linking the main Exim binary, and not for any associated utilities.
2117
2118 .cindex "DBM libraries" "configuration for building"
2119 There is also DBMLIB, which appears in the link commands for binaries that
2120 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2121 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2122 binary, and which can be used, for example, to include additional X11
2123 libraries.
2124
2125 .cindex "configuration file" "editing"
2126 The make file copes with rebuilding Exim correctly if any of the configuration
2127 files are edited. However, if an optional configuration file is deleted, it is
2128 necessary to touch the associated non-optional file (that is,
2129 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2130
2131
2132 .section "OS-specific header files" "SECID30"
2133 .cindex "&_os.h_&"
2134 .cindex "building Exim" "OS-specific C header files"
2135 The &_OS_& directory contains a number of files with names of the form
2136 &_os.h-<ostype>_&. These are system-specific C header files that should not
2137 normally need to be changed. There is a list of macro settings that are
2138 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2139 are porting Exim to a new operating system.
2140
2141
2142
2143 .section "Overriding build-time options for the monitor" "SECID31"
2144 .cindex "building Eximon"
2145 A similar process is used for overriding things when building the Exim monitor,
2146 where the files that are involved are
2147 .display
2148 &_OS/eximon.conf-Default_&
2149 &_OS/eximon.conf-_&<&'ostype'&>
2150 &_Local/eximon.conf_&
2151 &_Local/eximon.conf-_&<&'ostype'&>
2152 &_Local/eximon.conf-_&<&'archtype'&>
2153 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2154 .endd
2155 .cindex "&_Local/eximon.conf_&"
2156 As with Exim itself, the final three files need not exist, and in this case the
2157 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2158 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2159 variables of the same name, preceded by EXIMON_. For example, setting
2160 EXIMON_LOG_DEPTH in the environment overrides the value of
2161 LOG_DEPTH at run time.
2162 .ecindex IIDbuex
2163
2164
2165 .section "Installing Exim binaries and scripts" "SECID32"
2166 .cindex "installing Exim"
2167 .cindex "BIN_DIRECTORY"
2168 The command &`make install`& runs the &(exim_install)& script with no
2169 arguments. The script copies binaries and utility scripts into the directory
2170 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2171 .cindex "setuid" "installing Exim with"
2172 The install script copies files only if they are newer than the files they are
2173 going to replace. The Exim binary is required to be owned by root and have the
2174 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2175 install`& as root so that it can set up the Exim binary in this way. However, in
2176 some special situations (for example, if a host is doing no local deliveries)
2177 it may be possible to run Exim without making the binary setuid root (see
2178 chapter &<<CHAPsecurity>>& for details).
2179
2180 .cindex "CONFIGURE_FILE"
2181 Exim's run time configuration file is named by the CONFIGURE_FILE setting
2182 in &_Local/Makefile_&. If this names a single file, and the file does not
2183 exist, the default configuration file &_src/configure.default_& is copied there
2184 by the installation script. If a run time configuration file already exists, it
2185 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2186 alternative files, no default is installed.
2187
2188 .cindex "system aliases file"
2189 .cindex "&_/etc/aliases_&"
2190 One change is made to the default configuration file when it is installed: the
2191 default configuration contains a router that references a system aliases file.
2192 The path to this file is set to the value specified by
2193 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2194 If the system aliases file does not exist, the installation script creates it,
2195 and outputs a comment to the user.
2196
2197 The created file contains no aliases, but it does contain comments about the
2198 aliases a site should normally have. Mail aliases have traditionally been
2199 kept in &_/etc/aliases_&. However, some operating systems are now using
2200 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2201 Exim's configuration if necessary.
2202
2203 The default configuration uses the local host's name as the only local domain,
2204 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2205 running as the local user. System aliases and &_.forward_& files in users' home
2206 directories are supported, but no NIS or NIS+ support is configured. Domains
2207 other than the name of the local host are routed using the DNS, with delivery
2208 over SMTP.
2209
2210 It is possible to install Exim for special purposes (such as building a binary
2211 distribution) in a private part of the file system. You can do this by a
2212 command such as
2213 .code
2214 make DESTDIR=/some/directory/ install
2215 .endd
2216 This has the effect of pre-pending the specified directory to all the file
2217 paths, except the name of the system aliases file that appears in the default
2218 configuration. (If a default alias file is created, its name &'is'& modified.)
2219 For backwards compatibility, ROOT is used if DESTDIR is not set,
2220 but this usage is deprecated.
2221
2222 .cindex "installing Exim" "what is not installed"
2223 Running &'make install'& does not copy the Exim 4 conversion script
2224 &'convert4r4'&. You will probably run this only once if you are
2225 upgrading from Exim 3. None of the documentation files in the &_doc_&
2226 directory are copied, except for the info files when you have set
2227 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2228
2229 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2230 to their names. The Exim binary itself, however, is handled differently. It is
2231 installed under a name that includes the version number and the compile number,
2232 for example &_exim-&version;-1_&. The script then arranges for a symbolic link
2233 called &_exim_& to point to the binary. If you are updating a previous version
2234 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2235 from the directory (as seen by other processes).
2236
2237 .cindex "installing Exim" "testing the script"
2238 If you want to see what the &'make install'& will do before running it for
2239 real, you can pass the &%-n%& option to the installation script by this
2240 command:
2241 .code
2242 make INSTALL_ARG=-n install
2243 .endd
2244 The contents of the variable INSTALL_ARG are passed to the installation
2245 script. You do not need to be root to run this test. Alternatively, you can run
2246 the installation script directly, but this must be from within the build
2247 directory. For example, from the top-level Exim directory you could use this
2248 command:
2249 .code
2250 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2251 .endd
2252 .cindex "installing Exim" "install script options"
2253 There are two other options that can be supplied to the installation script.
2254
2255 .ilist
2256 &%-no_chown%& bypasses the call to change the owner of the installed binary
2257 to root, and the call to make it a setuid binary.
2258 .next
2259 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2260 installed binary.
2261 .endlist
2262
2263 INSTALL_ARG can be used to pass these options to the script. For example:
2264 .code
2265 make INSTALL_ARG=-no_symlink install
2266 .endd
2267 The installation script can also be given arguments specifying which files are
2268 to be copied. For example, to install just the Exim binary, and nothing else,
2269 without creating the symbolic link, you could use:
2270 .code
2271 make INSTALL_ARG='-no_symlink exim' install
2272 .endd
2273
2274
2275
2276 .section "Installing info documentation" "SECTinsinfdoc"
2277 .cindex "installing Exim" "&'info'& documentation"
2278 Not all systems use the GNU &'info'& system for documentation, and for this
2279 reason, the Texinfo source of Exim's documentation is not included in the main
2280 distribution. Instead it is available separately from the ftp site (see section
2281 &<<SECTavail>>&).
2282
2283 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2284 source of the documentation is found in the source tree, running &`make
2285 install`& automatically builds the info files and installs them.
2286
2287
2288
2289 .section "Setting up the spool directory" "SECID33"
2290 .cindex "spool directory" "creating"
2291 When it starts up, Exim tries to create its spool directory if it does not
2292 exist. The Exim uid and gid are used for the owner and group of the spool
2293 directory. Sub-directories are automatically created in the spool directory as
2294 necessary.
2295
2296
2297
2298
2299 .section "Testing" "SECID34"
2300 .cindex "testing" "installation"
2301 Having installed Exim, you can check that the run time configuration file is
2302 syntactically valid by running the following command, which assumes that the
2303 Exim binary directory is within your PATH environment variable:
2304 .code
2305 exim -bV
2306 .endd
2307 If there are any errors in the configuration file, Exim outputs error messages.
2308 Otherwise it outputs the version number and build date,
2309 the DBM library that is being used, and information about which drivers and
2310 other optional code modules are included in the binary.
2311 Some simple routing tests can be done by using the address testing option. For
2312 example,
2313 .display
2314 &`exim -bt`& <&'local username'&>
2315 .endd
2316 should verify that it recognizes a local mailbox, and
2317 .display
2318 &`exim -bt`& <&'remote address'&>
2319 .endd
2320 a remote one. Then try getting it to deliver mail, both locally and remotely.
2321 This can be done by passing messages directly to Exim, without going through a
2322 user agent. For example:
2323 .code
2324 exim -v postmaster@your.domain.example
2325 From: user@your.domain.example
2326 To: postmaster@your.domain.example
2327 Subject: Testing Exim
2328
2329 This is a test message.
2330 ^D
2331 .endd
2332 The &%-v%& option causes Exim to output some verification of what it is doing.
2333 In this case you should see copies of three log lines, one for the message's
2334 arrival, one for its delivery, and one containing &"Completed"&.
2335
2336 .cindex "delivery" "problems with"
2337 If you encounter problems, look at Exim's log files (&'mainlog'& and
2338 &'paniclog'&) to see if there is any relevant information there. Another source
2339 of information is running Exim with debugging turned on, by specifying the
2340 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2341 with debugging turned on by a command of the form
2342 .display
2343 &`exim -d -M`& <&'exim-message-id'&>
2344 .endd
2345 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2346 produces rather a lot of output, but you can cut this down to specific areas.
2347 For example, if you use &%-d-all+route%& only the debugging information
2348 relevant to routing is included. (See the &%-d%& option in chapter
2349 &<<CHAPcommandline>>& for more details.)
2350
2351 .cindex '&"sticky"& bit'
2352 .cindex "lock files"
2353 One specific problem that has shown up on some sites is the inability to do
2354 local deliveries into a shared mailbox directory, because it does not have the
2355 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2356 writing to a mailbox file, and if it cannot create the lock file, the delivery
2357 is deferred. You can get round this either by setting the &"sticky bit"& on the
2358 directory, or by setting a specific group for local deliveries and allowing
2359 that group to create files in the directory (see the comments above the
2360 &(local_delivery)& transport in the default configuration file). Another
2361 approach is to configure Exim not to use lock files, but just to rely on
2362 &[fcntl()]& locking instead. However, you should do this only if all user
2363 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2364 see chapter &<<CHAPappendfile>>&.
2365
2366 One thing that cannot be tested on a system that is already running an MTA is
2367 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2368 &%-oX%& option can be used to run an Exim daemon that listens on some other
2369 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2370 &'exim_checkaccess'& utility can be used to check out policy controls on
2371 incoming SMTP mail.
2372
2373 Testing a new version on a system that is already running Exim can most easily
2374 be done by building a binary with a different CONFIGURE_FILE setting. From
2375 within the run time configuration, all other file and directory names
2376 that Exim uses can be altered, in order to keep it entirely clear of the
2377 production version.
2378
2379
2380 .section "Replacing another MTA with Exim" "SECID35"
2381 .cindex "replacing another MTA"
2382 Building and installing Exim for the first time does not of itself put it in
2383 general use. The name by which the system's MTA is called by mail user agents
2384 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2385 operating system), and it is necessary to make this name point to the &'exim'&
2386 binary in order to get the user agents to pass messages to Exim. This is
2387 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2388 or &_/usr/lib/sendmail_&
2389 .cindex "symbolic link" "to &'exim'& binary"
2390 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2391 privilege and executable status from the old MTA. It is then necessary to stop
2392 and restart the mailer daemon, if one is running.
2393
2394 .cindex "FreeBSD, MTA indirection"
2395 .cindex "&_/etc/mail/mailer.conf_&"
2396 Some operating systems have introduced alternative ways of switching MTAs. For
2397 example, if you are running FreeBSD, you need to edit the file
2398 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2399 described. A typical example of the contents of this file for running Exim is
2400 as follows:
2401 .code
2402 sendmail            /usr/exim/bin/exim
2403 send-mail           /usr/exim/bin/exim
2404 mailq               /usr/exim/bin/exim -bp
2405 newaliases          /usr/bin/true
2406 .endd
2407 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2408 your Exim installation is &"live"&. Check it by sending a message from your
2409 favourite user agent.
2410
2411 You should consider what to tell your users about the change of MTA. Exim may
2412 have different capabilities to what was previously running, and there are
2413 various operational differences such as the text of messages produced by
2414 command line options and in bounce messages. If you allow your users to make
2415 use of Exim's filtering capabilities, you should make the document entitled
2416 &'Exim's interface to mail filtering'& available to them.
2417
2418
2419
2420 .section "Upgrading Exim" "SECID36"
2421 .cindex "upgrading Exim"
2422 If you are already running Exim on your host, building and installing a new
2423 version automatically makes it available to MUAs, or any other programs that
2424 call the MTA directly. However, if you are running an Exim daemon, you do need
2425 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2426 new binary. You do not need to stop processing mail in order to install a new
2427 version of Exim. The install script does not modify an existing runtime
2428 configuration file.
2429
2430
2431
2432
2433 .section "Stopping the Exim daemon on Solaris" "SECID37"
2434 .cindex "Solaris" "stopping Exim on"
2435 The standard command for stopping the mailer daemon on Solaris is
2436 .code
2437 /etc/init.d/sendmail stop
2438 .endd
2439 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2440 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2441 for the text &"sendmail"&; this is not present because the actual program name
2442 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2443 solution is to replace the line that finds the process id with something like
2444 .code
2445 pid=`cat /var/spool/exim/exim-daemon.pid`
2446 .endd
2447 to obtain the daemon's pid directly from the file that Exim saves it in.
2448
2449 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2450 still be received from local processes, and if automatic delivery is configured
2451 (the normal case), deliveries will still occur.
2452
2453
2454
2455
2456 . ////////////////////////////////////////////////////////////////////////////
2457 . ////////////////////////////////////////////////////////////////////////////
2458
2459 .chapter "The Exim command line" "CHAPcommandline"
2460 .scindex IIDclo1 "command line" "options"
2461 .scindex IIDclo2 "options" "command line"
2462 Exim's command line takes the standard Unix form of a sequence of options,
2463 each starting with a hyphen character, followed by a number of arguments. The
2464 options are compatible with the main options of Sendmail, and there are also
2465 some additional options, some of which are compatible with Smail 3. Certain
2466 combinations of options do not make sense, and provoke an error if used.
2467 The form of the arguments depends on which options are set.
2468
2469
2470 .section "Setting options by program name" "SECID38"
2471 .cindex "&'mailq'&"
2472 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2473 were present before any other options.
2474 The &%-bp%& option requests a listing of the contents of the mail queue on the
2475 standard output.
2476 This feature is for compatibility with some systems that contain a command of
2477 that name in one of the standard libraries, symbolically linked to
2478 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2479
2480 .cindex "&'rsmtp'&"
2481 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2482 were present before any other options, for compatibility with Smail. The
2483 &%-bS%& option is used for reading in a number of messages in batched SMTP
2484 format.
2485
2486 .cindex "&'rmail'&"
2487 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2488 &%-oee%& options were present before any other options, for compatibility with
2489 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2490
2491 .cindex "&'runq'&"
2492 .cindex "queue runner"
2493 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2494 were present before any other options, for compatibility with Smail. The &%-q%&
2495 option causes a single queue runner process to be started.
2496
2497 .cindex "&'newaliases'&"
2498 .cindex "alias file" "building"
2499 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2500 If Exim is called under the name &'newaliases'& it behaves as if the option
2501 &%-bi%& were present before any other options, for compatibility with Sendmail.
2502 This option is used for rebuilding Sendmail's alias file. Exim does not have
2503 the concept of a single alias file, but can be configured to run a given
2504 command if called with the &%-bi%& option.
2505
2506
2507 .section "Trusted and admin users" "SECTtrustedadmin"
2508 Some Exim options are available only to &'trusted users'& and others are
2509 available only to &'admin users'&. In the description below, the phrases &"Exim
2510 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2511 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2512 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2513
2514 .ilist
2515 .cindex "trusted users" "definition of"
2516 .cindex "user" "trusted definition of"
2517 The trusted users are root, the Exim user, any user listed in the
2518 &%trusted_users%& configuration option, and any user whose current group or any
2519 supplementary group is one of those listed in the &%trusted_groups%&
2520 configuration option. Note that the Exim group is not automatically trusted.
2521
2522 .cindex '&"From"& line'
2523 .cindex "envelope sender"
2524 Trusted users are always permitted to use the &%-f%& option or a leading
2525 &"From&~"& line to specify the envelope sender of a message that is passed to
2526 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2527 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2528 users to set envelope senders.
2529
2530 .cindex "&'From:'& header line"
2531 .cindex "&'Sender:'& header line"
2532 For a trusted user, there is never any check on the contents of the &'From:'&
2533 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2534 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2535
2536 Trusted users may also specify a host name, host address, interface address,
2537 protocol name, ident value, and authentication data when submitting a message
2538 locally. Thus, they are able to insert messages into Exim's queue locally that
2539 have the characteristics of messages received from a remote host. Untrusted
2540 users may in some circumstances use &%-f%&, but can never set the other values
2541 that are available to trusted users.
2542 .next
2543 .cindex "user" "admin definition of"
2544 .cindex "admin user" "definition of"
2545 The admin users are root, the Exim user, and any user that is a member of the
2546 Exim group or of any group listed in the &%admin_groups%& configuration option.
2547 The current group does not have to be one of these groups.
2548
2549 Admin users are permitted to list the queue, and to carry out certain
2550 operations on messages, for example, to force delivery failures. It is also
2551 necessary to be an admin user in order to see the full information provided by
2552 the Exim monitor, and full debugging output.
2553
2554 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2555 Exim to attempt delivery of messages on its queue is restricted to admin users.
2556 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2557 option false (that is, specifying &%no_prod_requires_admin%&).
2558
2559 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2560 is restricted to admin users unless &%queue_list_requires_admin%& is set
2561 false.
2562 .endlist
2563
2564
2565 &*Warning*&: If you configure your system so that admin users are able to
2566 edit Exim's configuration file, you are giving those users an easy way of
2567 getting root. There is further discussion of this issue at the start of chapter
2568 &<<CHAPconf>>&.
2569
2570
2571
2572
2573 .section "Command line options" "SECID39"
2574 Exim's command line options are described in alphabetical order below. If none
2575 of the options that specifies a specific action (such as starting the daemon or
2576 a queue runner, or testing an address, or receiving a message in a specific
2577 format, or listing the queue) are present, and there is at least one argument
2578 on the command line, &%-bm%& (accept a local message on the standard input,
2579 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2580 outputs a brief message about itself and exits.
2581
2582 . ////////////////////////////////////////////////////////////////////////////
2583 . Insert a stylized XML comment here, to identify the start of the command line
2584 . options. This is for the benefit of the Perl script that automatically
2585 . creates a man page for the options.
2586 . ////////////////////////////////////////////////////////////////////////////
2587
2588 .literal xml
2589 <!-- === Start of command line options === -->
2590 .literal off
2591
2592
2593 .vlist
2594 .vitem &%--%&
2595 .oindex "--"
2596 .cindex "options" "command line; terminating"
2597 This is a pseudo-option whose only purpose is to terminate the options and
2598 therefore to cause subsequent command line items to be treated as arguments
2599 rather than options, even if they begin with hyphens.
2600
2601 .vitem &%--help%&
2602 .oindex "&%--help%&"
2603 This option causes Exim to output a few sentences stating what it is.
2604 The same output is generated if the Exim binary is called with no options and
2605 no arguments.
2606
2607 .vitem &%-B%&<&'type'&>
2608 .oindex "&%-B%&"
2609 .cindex "8-bit characters"
2610 .cindex "Sendmail compatibility" "8-bit characters"
2611 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2612 clean; it ignores this option.
2613
2614 .vitem &%-bd%&
2615 .oindex "&%-bd%&"
2616 .cindex "daemon"
2617 .cindex "SMTP" "listener"
2618 .cindex "queue runner"
2619 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2620 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2621 that the daemon should also initiate periodic queue runs.
2622
2623 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2624 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2625 disconnect from the controlling terminal. When running this way, it can be
2626 stopped by pressing ctrl-C.
2627
2628 By default, Exim listens for incoming connections to the standard SMTP port on
2629 all the host's running interfaces. However, it is possible to listen on other
2630 ports, on multiple ports, and only on specific interfaces. Chapter
2631 &<<CHAPinterfaces>>& contains a description of the options that control this.
2632
2633 When a listening daemon
2634 .cindex "daemon" "process id (pid)"
2635 .cindex "pid (process id)" "of daemon"
2636 is started without the use of &%-oX%& (that is, without overriding the normal
2637 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2638 in Exim's spool directory. This location can be overridden by setting
2639 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2640 running as root.
2641
2642 When &%-oX%& is used on the command line to start a listening daemon, the
2643 process id is not written to the normal pid file path. However, &%-oP%& can be
2644 used to specify a path on the command line if a pid file is required.
2645
2646 The SIGHUP signal
2647 .cindex "SIGHUP"
2648 .cindex "daemon" "restarting"
2649 can be used to cause the daemon to re-execute itself. This should be done
2650 whenever Exim's configuration file, or any file that is incorporated into it by
2651 means of the &%.include%& facility, is changed, and also whenever a new version
2652 of Exim is installed. It is not necessary to do this when other files that are
2653 referenced from the configuration (for example, alias files) are changed,
2654 because these are reread each time they are used.
2655
2656 .vitem &%-bdf%&
2657 .oindex "&%-bdf%&"
2658 This option has the same effect as &%-bd%& except that it never disconnects
2659 from the controlling terminal, even when no debugging is specified.
2660
2661 .vitem &%-be%&
2662 .oindex "&%-be%&"
2663 .cindex "testing" "string expansion"
2664 .cindex "expansion" "testing"
2665 Run Exim in expansion testing mode. Exim discards its root privilege, to
2666 prevent ordinary users from using this mode to read otherwise inaccessible
2667 files. If no arguments are given, Exim runs interactively, prompting for lines
2668 of data. Otherwise, it processes each argument in turn.
2669
2670 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2671 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2672 used without command line arguments. If successful, it uses the &[readline()]&
2673 function, which provides extensive line-editing facilities, for reading the
2674 test data. A line history is supported.
2675
2676 Long expansion expressions can be split over several lines by using backslash
2677 continuations. As in Exim's run time configuration, white space at the start of
2678 continuation lines is ignored. Each argument or data line is passed through the
2679 string expansion mechanism, and the result is output. Variable values from the
2680 configuration file (for example, &$qualify_domain$&) are available, but no
2681 message-specific values (such as &$sender_domain$&) are set, because no message
2682 is being processed (but see &%-bem%& and &%-Mset%&).
2683
2684 &*Note*&: If you use this mechanism to test lookups, and you change the data
2685 files or databases you are using, you must exit and restart Exim before trying
2686 the same lookup again. Otherwise, because each Exim process caches the results
2687 of lookups, you will just get the same result as before.
2688
2689 .vitem &%-bem%&&~<&'filename'&>
2690 .oindex "&%-bem%&"
2691 .cindex "testing" "string expansion"
2692 .cindex "expansion" "testing"
2693 This option operates like &%-be%& except that it must be followed by the name
2694 of a file. For example:
2695 .code
2696 exim -bem /tmp/testmessage
2697 .endd
2698 The file is read as a message (as if receiving a locally-submitted non-SMTP
2699 message) before any of the test expansions are done. Thus, message-specific
2700 variables such as &$message_size$& and &$header_from:$& are available. However,
2701 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2702 recipients are read from the headers in the normal way, and are shown in the
2703 &$recipients$& variable. Note that recipients cannot be given on the command
2704 line, because further arguments are taken as strings to expand (just like
2705 &%-be%&).
2706
2707 .vitem &%-bF%&&~<&'filename'&>
2708 .oindex "&%-bF%&"
2709 .cindex "system filter" "testing"
2710 .cindex "testing" "system filter"
2711 This option is the same as &%-bf%& except that it assumes that the filter being
2712 tested is a system filter. The additional commands that are available only in
2713 system filters are recognized.
2714
2715 .vitem &%-bf%&&~<&'filename'&>
2716 .oindex "&%-bf%&"
2717 .cindex "filter" "testing"
2718 .cindex "testing" "filter file"
2719 .cindex "forward file" "testing"
2720 .cindex "testing" "forward file"
2721 .cindex "Sieve filter" "testing"
2722 This option runs Exim in user filter testing mode; the file is the filter file
2723 to be tested, and a test message must be supplied on the standard input. If
2724 there are no message-dependent tests in the filter, an empty file can be
2725 supplied.
2726
2727 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2728 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2729 filter and a user filter in the same run. For example:
2730 .code
2731 exim -bF /system/filter -bf /user/filter </test/message
2732 .endd
2733 This is helpful when the system filter adds header lines or sets filter
2734 variables that are used by the user filter.
2735
2736 If the test filter file does not begin with one of the special lines
2737 .code
2738 # Exim filter
2739 # Sieve filter
2740 .endd
2741 it is taken to be a normal &_.forward_& file, and is tested for validity under
2742 that interpretation. See sections &<<SECTitenonfilred>>& to
2743 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2744 redirection lists.
2745
2746 The result of an Exim command that uses &%-bf%&, provided no errors are
2747 detected, is a list of the actions that Exim would try to take if presented
2748 with the message for real. More details of filter testing are given in the
2749 separate document entitled &'Exim's interfaces to mail filtering'&.
2750
2751 When testing a filter file,
2752 .cindex "&""From""& line"
2753 .cindex "envelope sender"
2754 .oindex "&%-f%&" "for filter testing"
2755 the envelope sender can be set by the &%-f%& option,
2756 or by a &"From&~"& line at the start of the test message. Various parameters
2757 that would normally be taken from the envelope recipient address of the message
2758 can be set by means of additional command line options (see the next four
2759 options).
2760
2761 .vitem &%-bfd%&&~<&'domain'&>
2762 .oindex "&%-bfd%&"
2763 .vindex "&$qualify_domain$&"
2764 This sets the domain of the recipient address when a filter file is being
2765 tested by means of the &%-bf%& option. The default is the value of
2766 &$qualify_domain$&.
2767
2768 .vitem &%-bfl%&&~<&'local&~part'&>
2769 .oindex "&%-bfl%&"
2770 This sets the local part of the recipient address when a filter file is being
2771 tested by means of the &%-bf%& option. The default is the username of the
2772 process that calls Exim. A local part should be specified with any prefix or
2773 suffix stripped, because that is how it appears to the filter when a message is
2774 actually being delivered.
2775
2776 .vitem &%-bfp%&&~<&'prefix'&>
2777 .oindex "&%-bfp%&"
2778 This sets the prefix of the local part of the recipient address when a filter
2779 file is being tested by means of the &%-bf%& option. The default is an empty
2780 prefix.
2781
2782 .vitem &%-bfs%&&~<&'suffix'&>
2783 .oindex "&%-bfs%&"
2784 This sets the suffix of the local part of the recipient address when a filter
2785 file is being tested by means of the &%-bf%& option. The default is an empty
2786 suffix.
2787
2788 .vitem &%-bh%&&~<&'IP&~address'&>
2789 .oindex "&%-bh%&"
2790 .cindex "testing" "incoming SMTP"
2791 .cindex "SMTP" "testing incoming"
2792 .cindex "testing" "relay control"
2793 .cindex "relaying" "testing configuration"
2794 .cindex "policy control" "testing"
2795 .cindex "debugging" "&%-bh%& option"
2796 This option runs a fake SMTP session as if from the given IP address, using the
2797 standard input and output. The IP address may include a port number at the end,
2798 after a full stop. For example:
2799 .code
2800 exim -bh 10.9.8.7.1234
2801 exim -bh fe80::a00:20ff:fe86:a061.5678
2802 .endd
2803 When an IPv6 address is given, it is converted into canonical form. In the case
2804 of the second example above, the value of &$sender_host_address$& after
2805 conversion to the canonical form is
2806 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2807
2808 Comments as to what is going on are written to the standard error file. These
2809 include lines beginning with &"LOG"& for anything that would have been logged.
2810 This facility is provided for testing configuration options for incoming
2811 messages, to make sure they implement the required policy. For example, you can
2812 test your relay controls using &%-bh%&.
2813
2814 &*Warning 1*&:
2815 .cindex "RFC 1413"
2816 You can test features of the configuration that rely on ident (RFC 1413)
2817 information by using the &%-oMt%& option. However, Exim cannot actually perform
2818 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2819 connection.
2820
2821 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2822 are also skipped when testing using &%-bh%&. If you want these callouts to
2823 occur, use &%-bhc%& instead.
2824
2825 Messages supplied during the testing session are discarded, and nothing is
2826 written to any of the real log files. There may be pauses when DNS (and other)
2827 lookups are taking place, and of course these may time out. The &%-oMi%& option
2828 can be used to specify a specific IP interface and port if this is important,
2829 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2830 session were authenticated.
2831
2832 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2833 output just states whether a given recipient address from a given host is
2834 acceptable or not. See section &<<SECTcheckaccess>>&.
2835
2836 Features such as authentication and encryption, where the client input is not
2837 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2838 specialized SMTP test program such as
2839 &url(http://jetmore.org/john/code/#swaks,swaks).
2840
2841 .vitem &%-bhc%&&~<&'IP&~address'&>
2842 .oindex "&%-bhc%&"
2843 This option operates in the same way as &%-bh%&, except that address
2844 verification callouts are performed if required. This includes consulting and
2845 updating the callout cache database.
2846
2847 .vitem &%-bi%&
2848 .oindex "&%-bi%&"
2849 .cindex "alias file" "building"
2850 .cindex "building alias file"
2851 .cindex "Sendmail compatibility" "&%-bi%& option"
2852 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2853 Exim does not have the concept of a single alias file, and so it cannot mimic
2854 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2855 tend to appear in various scripts such as NIS make files, so the option must be
2856 recognized.
2857
2858 If &%-bi%& is encountered, the command specified by the &%bi_command%&
2859 configuration option is run, under the uid and gid of the caller of Exim. If
2860 the &%-oA%& option is used, its value is passed to the command as an argument.
2861 The command set by &%bi_command%& may not contain arguments. The command can
2862 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
2863 if this is required. If the &%bi_command%& option is not set, calling Exim with
2864 &%-bi%& is a no-op.
2865
2866 .vitem &%-bm%&
2867 .oindex "&%-bm%&"
2868 .cindex "local message reception"
2869 This option runs an Exim receiving process that accepts an incoming,
2870 locally-generated message on the current input. The recipients are given as the
2871 command arguments (except when &%-t%& is also present &-- see below). Each
2872 argument can be a comma-separated list of RFC 2822 addresses. This is the
2873 default option for selecting the overall action of an Exim call; it is assumed
2874 if no other conflicting option is present.
2875
2876 If any addresses in the message are unqualified (have no domain), they are
2877 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
2878 options, as appropriate. The &%-bnq%& option (see below) provides a way of
2879 suppressing this for special cases.
2880
2881 Policy checks on the contents of local messages can be enforced by means of
2882 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
2883
2884 .cindex "return code" "for &%-bm%&"
2885 The return code is zero if the message is successfully accepted. Otherwise, the
2886 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
2887
2888 The format
2889 .cindex "message" "format"
2890 .cindex "format" "message"
2891 .cindex "&""From""& line"
2892 .cindex "UUCP" "&""From""& line"
2893 .cindex "Sendmail compatibility" "&""From""& line"
2894 of the message must be as defined in RFC 2822, except that, for
2895 compatibility with Sendmail and Smail, a line in one of the forms
2896 .code
2897 From sender Fri Jan  5 12:55 GMT 1997
2898 From sender Fri, 5 Jan 97 12:55:01
2899 .endd
2900 (with the weekday optional, and possibly with additional text after the date)
2901 is permitted to appear at the start of the message. There appears to be no
2902 authoritative specification of the format of this line. Exim recognizes it by
2903 matching against the regular expression defined by the &%uucp_from_pattern%&
2904 option, which can be changed if necessary.
2905
2906 .oindex "&%-f%&" "overriding &""From""& line"
2907 The specified sender is treated as if it were given as the argument to the
2908 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
2909 preference to the address taken from the message. The caller of Exim must be a
2910 trusted user for the sender of a message to be set in this way.
2911
2912 .vitem &%-bnq%&
2913 .oindex "&%-bnq%&"
2914 .cindex "address qualification, suppressing"
2915 By default, Exim automatically qualifies unqualified addresses (those
2916 without domains) that appear in messages that are submitted locally (that
2917 is, not over TCP/IP). This qualification applies both to addresses in
2918 envelopes, and addresses in header lines. Sender addresses are qualified using
2919 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
2920 defaults to the value of &%qualify_domain%&).
2921
2922 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
2923 being used to re-submit messages that originally came from remote hosts after
2924 content scanning, you probably do not want to qualify unqualified addresses in
2925 header lines. (Such lines will be present only if you have not enabled a header
2926 syntax check in the appropriate ACL.)
2927
2928 The &%-bnq%& option suppresses all qualification of unqualified addresses in
2929 messages that originate on the local host. When this is used, unqualified
2930 addresses in the envelope provoke errors (causing message rejection) and
2931 unqualified addresses in header lines are left alone.
2932
2933
2934 .vitem &%-bP%&
2935 .oindex "&%-bP%&"
2936 .cindex "configuration options" "extracting"
2937 .cindex "options" "configuration &-- extracting"
2938 If this option is given with no arguments, it causes the values of all Exim's
2939 main configuration options to be written to the standard output. The values
2940 of one or more specific options can be requested by giving their names as
2941 arguments, for example:
2942 .code
2943 exim -bP qualify_domain hold_domains
2944 .endd
2945 .cindex "hiding configuration option values"
2946 .cindex "configuration options" "hiding value of"
2947 .cindex "options" "hiding value of"
2948 However, any option setting that is preceded by the word &"hide"& in the
2949 configuration file is not shown in full, except to an admin user. For other
2950 users, the output is as in this example:
2951 .code
2952 mysql_servers = <value not displayable>
2953 .endd
2954 If &%configure_file%& is given as an argument, the name of the run time
2955 configuration file is output.
2956 If a list of configuration files was supplied, the value that is output here
2957 is the name of the file that was actually used.
2958
2959 .cindex "daemon" "process id (pid)"
2960 .cindex "pid (process id)" "of daemon"
2961 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
2962 directories where log files and daemon pid files are written are output,
2963 respectively. If these values are unset, log files are written in a
2964 sub-directory of the spool directory called &%log%&, and the pid file is
2965 written directly into the spool directory.
2966
2967 If &%-bP%& is followed by a name preceded by &`+`&, for example,
2968 .code
2969 exim -bP +local_domains
2970 .endd
2971 it searches for a matching named list of any type (domain, host, address, or
2972 local part) and outputs what it finds.
2973
2974 .cindex "options" "router &-- extracting"
2975 .cindex "options" "transport &-- extracting"
2976 .cindex "options" "authenticator &-- extracting"
2977 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
2978 followed by the name of an appropriate driver instance, the option settings for
2979 that driver are output. For example:
2980 .code
2981 exim -bP transport local_delivery
2982 .endd
2983 The generic driver options are output first, followed by the driver's private
2984 options. A list of the names of drivers of a particular type can be obtained by
2985 using one of the words &%router_list%&, &%transport_list%&, or
2986 &%authenticator_list%&, and a complete list of all drivers with their option
2987 settings can be obtained by using &%routers%&, &%transports%&, or
2988 &%authenticators%&.
2989
2990 .cindex "options" "macro &-- extracting"
2991 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
2992 are available, similarly to the drivers.  Because macros are sometimes used
2993 for storing passwords, this option is restricted.
2994 The output format is one item per line.
2995
2996 .vitem &%-bp%&
2997 .oindex "&%-bp%&"
2998 .cindex "queue" "listing messages on"
2999 .cindex "listing" "messages on the queue"
3000 This option requests a listing of the contents of the mail queue on the
3001 standard output. If the &%-bp%& option is followed by a list of message ids,
3002 just those messages are listed. By default, this option can be used only by an
3003 admin user. However, the &%queue_list_requires_admin%& option can be set false
3004 to allow any user to see the queue.
3005
3006 Each message on the queue is displayed as in the following example:
3007 .code
3008 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3009           red.king@looking-glass.fict.example
3010           <other addresses>
3011 .endd
3012 .cindex "message" "size in queue listing"
3013 .cindex "size" "of message"
3014 The first line contains the length of time the message has been on the queue
3015 (in this case 25 minutes), the size of the message (2.9K), the unique local
3016 identifier for the message, and the message sender, as contained in the
3017 envelope. For bounce messages, the sender address is empty, and appears as
3018 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3019 the default sender address, the user's login name is shown in parentheses
3020 before the sender address.
3021
3022 .cindex "frozen messages" "in queue listing"
3023 If the message is frozen (attempts to deliver it are suspended) then the text
3024 &"*** frozen ***"& is displayed at the end of this line.
3025
3026 The recipients of the message (taken from the envelope, not the headers) are
3027 displayed on subsequent lines. Those addresses to which the message has already
3028 been delivered are marked with the letter D. If an original address gets
3029 expanded into several addresses via an alias or forward file, the original is
3030 displayed with a D only when deliveries for all of its child addresses are
3031 complete.
3032
3033
3034 .vitem &%-bpa%&
3035 .oindex "&%-bpa%&"
3036 This option operates like &%-bp%&, but in addition it shows delivered addresses
3037 that were generated from the original top level address(es) in each message by
3038 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3039 of just &"D"&.
3040
3041
3042 .vitem &%-bpc%&
3043 .oindex "&%-bpc%&"
3044 .cindex "queue" "count of messages on"
3045 This option counts the number of messages on the queue, and writes the total
3046 to the standard output. It is restricted to admin users, unless
3047 &%queue_list_requires_admin%& is set false.
3048
3049
3050 .vitem &%-bpr%&
3051 .oindex "&%-bpr%&"
3052 This option operates like &%-bp%&, but the output is not sorted into
3053 chronological order of message arrival. This can speed it up when there are
3054 lots of messages on the queue, and is particularly useful if the output is
3055 going to be post-processed in a way that doesn't need the sorting.
3056
3057 .vitem &%-bpra%&
3058 .oindex "&%-bpra%&"
3059 This option is a combination of &%-bpr%& and &%-bpa%&.
3060
3061 .vitem &%-bpru%&
3062 .oindex "&%-bpru%&"
3063 This option is a combination of &%-bpr%& and &%-bpu%&.
3064
3065
3066 .vitem &%-bpu%&
3067 .oindex "&%-bpu%&"
3068 This option operates like &%-bp%& but shows only undelivered top-level
3069 addresses for each message displayed. Addresses generated by aliasing or
3070 forwarding are not shown, unless the message was deferred after processing by a
3071 router with the &%one_time%& option set.
3072
3073
3074 .vitem &%-brt%&
3075 .oindex "&%-brt%&"
3076 .cindex "testing" "retry configuration"
3077 .cindex "retry" "configuration testing"
3078 This option is for testing retry rules, and it must be followed by up to three
3079 arguments. It causes Exim to look for a retry rule that matches the values
3080 and to write it to the standard output. For example:
3081 .code
3082 exim -brt bach.comp.mus.example
3083 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3084 .endd
3085 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3086 argument, which is required, can be a complete address in the form
3087 &'local_part@domain'&, or it can be just a domain name. If the second argument
3088 contains a dot, it is interpreted as an optional second domain name; if no
3089 retry rule is found for the first argument, the second is tried. This ties in
3090 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3091 rule is found that matches the host, one that matches the mail domain is
3092 sought. Finally, an argument that is the name of a specific delivery error, as
3093 used in setting up retry rules, can be given. For example:
3094 .code
3095 exim -brt haydn.comp.mus.example quota_3d
3096 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3097 .endd
3098
3099 .vitem &%-brw%&
3100 .oindex "&%-brw%&"
3101 .cindex "testing" "rewriting"
3102 .cindex "rewriting" "testing"
3103 This option is for testing address rewriting rules, and it must be followed by
3104 a single argument, consisting of either a local part without a domain, or a
3105 complete address with a fully qualified domain. Exim outputs how this address
3106 would be rewritten for each possible place it might appear. See chapter
3107 &<<CHAPrewrite>>& for further details.
3108
3109 .vitem &%-bS%&
3110 .oindex "&%-bS%&"
3111 .cindex "SMTP" "batched incoming"
3112 .cindex "batched SMTP input"
3113 This option is used for batched SMTP input, which is an alternative interface
3114 for non-interactive local message submission. A number of messages can be
3115 submitted in a single run. However, despite its name, this is not really SMTP
3116 input. Exim reads each message's envelope from SMTP commands on the standard
3117 input, but generates no responses. If the caller is trusted, or
3118 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3119 believed; otherwise the sender is always the caller of Exim.
3120
3121 The message itself is read from the standard input, in SMTP format (leading
3122 dots doubled), terminated by a line containing just a single dot. An error is
3123 provoked if the terminating dot is missing. A further message may then follow.
3124
3125 As for other local message submissions, the contents of incoming batch SMTP
3126 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3127 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3128 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3129
3130 Some other SMTP commands are recognized in the input. HELO and EHLO act
3131 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3132 QUIT quits, ignoring the rest of the standard input.
3133
3134 .cindex "return code" "for &%-bS%&"
3135 If any error is encountered, reports are written to the standard output and
3136 error streams, and Exim gives up immediately. The return code is 0 if no error
3137 was detected; it is 1 if one or more messages were accepted before the error
3138 was detected; otherwise it is 2.
3139
3140 More details of input using batched SMTP are given in section
3141 &<<SECTincomingbatchedSMTP>>&.
3142
3143 .vitem &%-bs%&
3144 .oindex "&%-bs%&"
3145 .cindex "SMTP" "local input"
3146 .cindex "local SMTP input"
3147 This option causes Exim to accept one or more messages by reading SMTP commands
3148 on the standard input, and producing SMTP replies on the standard output. SMTP
3149 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3150 Some user agents use this interface as a way of passing locally-generated
3151 messages to the MTA.
3152
3153 In
3154 .cindex "sender" "source of"
3155 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3156 set, the senders of messages are taken from the SMTP MAIL commands.
3157 Otherwise the content of these commands is ignored and the sender is set up as
3158 the calling user. Unqualified addresses are automatically qualified using
3159 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3160 &%-bnq%& option is used.
3161
3162 .cindex "inetd"
3163 The
3164 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3165 using a listening daemon. Exim can distinguish the two cases by checking
3166 whether the standard input is a TCP/IP socket. When Exim is called from
3167 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3168 above concerning senders and qualification do not apply. In this situation,
3169 Exim behaves in exactly the same way as it does when receiving a message via
3170 the listening daemon.
3171
3172 .vitem &%-bt%&
3173 .oindex "&%-bt%&"
3174 .cindex "testing" "addresses"
3175 .cindex "address" "testing"
3176 This option runs Exim in address testing mode, in which each argument is taken
3177 as a recipient address to be tested for deliverability. The results are
3178 written to the standard output. If a test fails, and the caller is not an admin
3179 user, no details of the failure are output, because these might contain
3180 sensitive information such as usernames and passwords for database lookups.
3181
3182 If no arguments are given, Exim runs in an interactive manner, prompting with a
3183 right angle bracket for addresses to be tested.
3184
3185 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3186 &[readline()]& function, because it is running as &'root'& and there are
3187 security issues.
3188
3189 Each address is handled as if it were the recipient address of a message
3190 (compare the &%-bv%& option). It is passed to the routers and the result is
3191 written to the standard output. However, any router that has
3192 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3193 genuine routing tests if your first router passes everything to a scanner
3194 program.
3195
3196 .cindex "return code" "for &%-bt%&"
3197 The return code is 2 if any address failed outright; it is 1 if no address
3198 failed outright but at least one could not be resolved for some reason. Return
3199 code 0 is given only when all addresses succeed.
3200
3201 .cindex "duplicate addresses"
3202 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3203 addresses after routing is complete, so that only one delivery takes place.
3204 This does not happen when testing with &%-bt%&; the full results of routing are
3205 always shown.
3206
3207 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3208 routers in the configuration makes any tests on the sender address of a
3209 message,
3210 .oindex "&%-f%&" "for address testing"
3211 you can use the &%-f%& option to set an appropriate sender when running
3212 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3213 default qualifying domain. However, if you have set up (for example) routers
3214 whose behaviour depends on the contents of an incoming message, you cannot test
3215 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3216 doing such tests.
3217
3218 .vitem &%-bV%&
3219 .oindex "&%-bV%&"
3220 .cindex "version number of Exim"
3221 This option causes Exim to write the current version number, compilation
3222 number, and compilation date of the &'exim'& binary to the standard output.
3223 It also lists the DBM library this is being used, the optional modules (such as
3224 specific lookup types), the drivers that are included in the binary, and the
3225 name of the run time configuration file that is in use.
3226
3227 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3228 configuration file. However, this is a static check only. It cannot check
3229 values that are to be expanded. For example, although a misspelt ACL verb is
3230 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3231 alone to discover (for example) all the typos in the configuration; some
3232 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3233 dynamic testing facilities.
3234
3235 .vitem &%-bv%&
3236 .oindex "&%-bv%&"
3237 .cindex "verifying address" "using &%-bv%&"
3238 .cindex "address" "verification"
3239 This option runs Exim in address verification mode, in which each argument is
3240 taken as a recipient address to be verified by the routers. (This does
3241 not involve any verification callouts). During normal operation, verification
3242 happens mostly as a consequence processing a &%verify%& condition in an ACL
3243 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3244 including callouts, see the &%-bh%& and &%-bhc%& options.
3245
3246 If verification fails, and the caller is not an admin user, no details of the
3247 failure are output, because these might contain sensitive information such as
3248 usernames and passwords for database lookups.
3249
3250 If no arguments are given, Exim runs in an interactive manner, prompting with a
3251 right angle bracket for addresses to be verified.
3252
3253 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3254 &[readline()]& function, because it is running as &'exim'& and there are
3255 security issues.
3256
3257 Verification differs from address testing (the &%-bt%& option) in that routers
3258 that have &%no_verify%& set are skipped, and if the address is accepted by a
3259 router that has &%fail_verify%& set, verification fails. The address is
3260 verified as a recipient if &%-bv%& is used; to test verification for a sender
3261 address, &%-bvs%& should be used.
3262
3263 If the &%-v%& option is not set, the output consists of a single line for each
3264 address, stating whether it was verified or not, and giving a reason in the
3265 latter case. Without &%-v%&, generating more than one address by redirection
3266 causes verification to end successfully, without considering the generated
3267 addresses. However, if just one address is generated, processing continues,
3268 and the generated address must verify successfully for the overall verification
3269 to succeed.
3270
3271 When &%-v%& is set, more details are given of how the address has been handled,
3272 and in the case of address redirection, all the generated addresses are also
3273 considered. Verification may succeed for some and fail for others.
3274
3275 The
3276 .cindex "return code" "for &%-bv%&"
3277 return code is 2 if any address failed outright; it is 1 if no address
3278 failed outright but at least one could not be resolved for some reason. Return
3279 code 0 is given only when all addresses succeed.
3280
3281 If any of the routers in the configuration makes any tests on the sender
3282 address of a message, you should use the &%-f%& option to set an appropriate
3283 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3284 calling user at the default qualifying domain.
3285
3286 .vitem &%-bvs%&
3287 .oindex "&%-bvs%&"
3288 This option acts like &%-bv%&, but verifies the address as a sender rather
3289 than a recipient address. This affects any rewriting and qualification that
3290 might happen.
3291
3292 .vitem &%-C%&&~<&'filelist'&>
3293 .oindex "&%-C%&"
3294 .cindex "configuration file" "alternate"
3295 .cindex "CONFIGURE_FILE"
3296 .cindex "alternate configuration file"
3297 This option causes Exim to find the run time configuration file from the given
3298 list instead of from the list specified by the CONFIGURE_FILE
3299 compile-time setting. Usually, the list will consist of just a single file
3300 name, but it can be a colon-separated list of names. In this case, the first
3301 file that exists is used. Failure to open an existing file stops Exim from
3302 proceeding any further along the list, and an error is generated.
3303
3304 When this option is used by a caller other than root or the Exim user, and the
3305 list is different from the compiled-in list, Exim gives up its root privilege
3306 immediately, and runs with the real and effective uid and gid set to those of
3307 the caller. However, if ALT_CONFIG_ROOT_ONLY is defined in
3308 &_Local/Makefile_&, root privilege is retained for &%-C%& only if the caller of
3309 Exim is root.
3310
3311 That is, the Exim user is no longer privileged in this regard. This build-time
3312 option is not set by default in the Exim source distribution tarbundle.
3313 However, if you are using a &"packaged"& version of Exim (source or binary),
3314 the packagers might have enabled it.
3315
3316 Setting ALT_CONFIG_ROOT_ONLY locks out the possibility of testing a
3317 configuration using &%-C%& right through message reception and delivery, even
3318 if the caller is root. The reception works, but by that time, Exim is running
3319 as the Exim user, so when it re-executes to regain privilege for the delivery,
3320 the use of &%-C%& causes privilege to be lost. However, root can test reception
3321 and delivery using two separate commands (one to put a message on the queue,
3322 using &%-odq%&, and another to do the delivery, using &%-M%&).
3323
3324 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3325 prefix string with which any file named in a &%-C%& command line option
3326 must start. In addition, the file name must not contain the sequence &`/../`&.
3327 However, if the value of the &%-C%& option is identical to the value of
3328 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3329 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3330 unset, any file name can be used with &%-C%&.
3331
3332 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3333 to a directory to which only root has access. This prevents someone who has
3334 broken into the Exim account from running a privileged Exim with an arbitrary
3335 configuration file.
3336
3337 The &%-C%& facility is useful for ensuring that configuration files are
3338 syntactically correct, but cannot be used for test deliveries, unless the
3339 caller is privileged, or unless it is an exotic configuration that does not
3340 require privilege. No check is made on the owner or group of the files
3341 specified by this option.
3342
3343 .vitem &%-D%&<&'macro'&>=<&'value'&>
3344 .oindex "&%-D%&"
3345 .cindex "macro" "setting on command line"
3346 This option can be used to override macro definitions in the configuration file
3347 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3348 unprivileged caller, it causes Exim to give up its root privilege.
3349 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3350 completely disabled, and its use causes an immediate error exit.
3351
3352 The entire option (including equals sign if present) must all be within one
3353 command line item. &%-D%& can be used to set the value of a macro to the empty
3354 string, in which case the equals sign is optional. These two commands are
3355 synonymous:
3356 .code
3357 exim -DABC  ...
3358 exim -DABC= ...
3359 .endd
3360 To include spaces in a macro definition item, quotes must be used. If you use
3361 quotes, spaces are permitted around the macro name and the equals sign. For
3362 example:
3363 .code
3364 exim '-D ABC = something' ...
3365 .endd
3366 &%-D%& may be repeated up to 10 times on a command line.
3367
3368 .vitem &%-d%&<&'debug&~options'&>
3369 .oindex "&%-d%&"
3370 .cindex "debugging" "list of selectors"
3371 .cindex "debugging" "&%-d%& option"
3372 This option causes debugging information to be written to the standard
3373 error stream. It is restricted to admin users because debugging output may show
3374 database queries that contain password information. Also, the details of users'
3375 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3376 writes an error message to the standard error stream and exits with a non-zero
3377 return code.
3378
3379 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3380 standard debugging data is output. This can be reduced, or increased to include
3381 some more rarely needed information, by directly following &%-d%& with a string
3382 made up of names preceded by plus or minus characters. These add or remove sets
3383 of debugging data, respectively. For example, &%-d+filter%& adds filter
3384 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3385 no spaces are allowed in the debug setting. The available debugging categories
3386 are:
3387 .display
3388 &`acl            `& ACL interpretation
3389 &`auth           `& authenticators
3390 &`deliver        `& general delivery logic
3391 &`dns            `& DNS lookups (see also resolver)
3392 &`dnsbl          `& DNS black list (aka RBL) code
3393 &`exec           `& arguments for &[execv()]& calls
3394 &`expand         `& detailed debugging for string expansions
3395 &`filter         `& filter handling
3396 &`hints_lookup   `& hints data lookups
3397 &`host_lookup    `& all types of name-to-IP address handling
3398 &`ident          `& ident lookup
3399 &`interface      `& lists of local interfaces
3400 &`lists          `& matching things in lists
3401 &`load           `& system load checks
3402 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3403                     &<<CHAPlocalscan>>&)
3404 &`lookup         `& general lookup code and all lookups
3405 &`memory         `& memory handling
3406 &`pid            `& add pid to debug output lines
3407 &`process_info   `& setting info for the process log
3408 &`queue_run      `& queue runs
3409 &`receive        `& general message reception logic
3410 &`resolver       `& turn on the DNS resolver's debugging output
3411 &`retry          `& retry handling
3412 &`rewrite        `& address rewriting
3413 &`route          `& address routing
3414 &`timestamp      `& add timestamp to debug output lines
3415 &`tls            `& TLS logic
3416 &`transport      `& transports
3417 &`uid            `& changes of uid/gid and looking up uid/gid
3418 &`verify         `& address verification logic
3419 &`all            `& almost all of the above (see below), and also &%-v%&
3420 .endd
3421 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3422 for &`-all`&. The reason for this is that &`+all`& is something that people
3423 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3424 is included, an awful lot of output that is very rarely of interest is
3425 generated, so it now has to be explicitly requested. However, &`-all`& does
3426 turn everything off.
3427
3428 .cindex "resolver, debugging output"
3429 .cindex "DNS resolver, debugging output"
3430 The &`resolver`& option produces output only if the DNS resolver was compiled
3431 with DEBUG enabled. This is not the case in some operating systems. Also,
3432 unfortunately, debugging output from the DNS resolver is written to stdout
3433 rather than stderr.
3434
3435 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3436 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3437 However, the &`pid`& selector is forced when debugging is turned on for a
3438 daemon, which then passes it on to any re-executed Exims. Exim also
3439 automatically adds the pid to debug lines when several remote deliveries are
3440 run in parallel.
3441
3442 The &`timestamp`& selector causes the current time to be inserted at the start
3443 of all debug output lines. This can be useful when trying to track down delays
3444 in processing.
3445
3446 If the &%debug_print%& option is set in any driver, it produces output whenever
3447 any debugging is selected, or if &%-v%& is used.
3448
3449 .vitem &%-dd%&<&'debug&~options'&>
3450 .oindex "&%-dd%&"
3451 This option behaves exactly like &%-d%& except when used on a command that
3452 starts a daemon process. In that case, debugging is turned off for the
3453 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3454 behaviour of the daemon without creating as much output as full debugging does.
3455
3456 .vitem &%-dropcr%&
3457 .oindex "&%-dropcr%&"
3458 This is an obsolete option that is now a no-op. It used to affect the way Exim
3459 handled CR and LF characters in incoming messages. What happens now is
3460 described in section &<<SECTlineendings>>&.
3461
3462 .vitem &%-E%&
3463 .oindex "&%-E%&"
3464 .cindex "bounce message" "generating"
3465 This option specifies that an incoming message is a locally-generated delivery
3466 failure report. It is used internally by Exim when handling delivery failures
3467 and is not intended for external use. Its only effect is to stop Exim
3468 generating certain messages to the postmaster, as otherwise message cascades
3469 could occur in some situations. As part of the same option, a message id may
3470 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3471 new message contains the id, following &"R="&, as a cross-reference.
3472
3473 .vitem &%-e%&&'x'&
3474 .oindex "&%-e%&&'x'&"
3475 There are a number of Sendmail options starting with &%-oe%& which seem to be
3476 called by various programs without the leading &%o%& in the option. For
3477 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3478 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3479
3480 .vitem &%-F%&&~<&'string'&>
3481 .oindex "&%-F%&"
3482 .cindex "sender" "name"
3483 .cindex "name" "of sender"
3484 This option sets the sender's full name for use when a locally-generated
3485 message is being accepted. In the absence of this option, the user's &'gecos'&
3486 entry from the password data is used. As users are generally permitted to alter
3487 their &'gecos'& entries, no security considerations are involved. White space
3488 between &%-F%& and the <&'string'&> is optional.
3489
3490 .vitem &%-f%&&~<&'address'&>
3491 .oindex "&%-f%&"
3492 .cindex "sender" "address"
3493 .cindex "address" "sender"
3494 .cindex "trusted users"
3495 .cindex "envelope sender"
3496 .cindex "user" "trusted"
3497 This option sets the address of the envelope sender of a locally-generated
3498 message (also known as the return path). The option can normally be used only
3499 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3500 users to use it.
3501
3502 Processes running as root or the Exim user are always trusted. Other
3503 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3504 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3505 of a local message is set to the caller's login name at the default qualify
3506 domain.
3507
3508 There is one exception to the restriction on the use of &%-f%&: an empty sender
3509 can be specified by any user, trusted or not, to create a message that can
3510 never provoke a bounce. An empty sender can be specified either as an empty
3511 string, or as a pair of angle brackets with nothing between them, as in these
3512 examples of shell commands:
3513 .code
3514 exim -f '<>' user@domain
3515 exim -f "" user@domain
3516 .endd
3517 In addition, the use of &%-f%& is not restricted when testing a filter file
3518 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3519 &%-bv%& options.
3520
3521 Allowing untrusted users to change the sender address does not of itself make
3522 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3523 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3524 though this can be overridden by setting &%no_local_from_check%&.
3525
3526 White
3527 .cindex "&""From""& line"
3528 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3529 given as two arguments or one combined argument). The sender of a
3530 locally-generated message can also be set (when permitted) by an initial
3531 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3532 if &%-f%& is also present, it overrides &"From&~"&.
3533
3534 .vitem &%-G%&
3535 .oindex "&%-G%&"
3536 .cindex "Sendmail compatibility" "&%-G%& option ignored"
3537 This is a Sendmail option which is ignored by Exim.
3538
3539 .vitem &%-h%&&~<&'number'&>
3540 .oindex "&%-h%&"
3541 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3542 This option is accepted for compatibility with Sendmail, but has no effect. (In
3543 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3544 headers.)
3545
3546 .vitem &%-i%&
3547 .oindex "&%-i%&"
3548 .cindex "Solaris" "&'mail'& command"
3549 .cindex "dot" "in incoming non-SMTP message"
3550 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3551 line by itself should not terminate an incoming, non-SMTP message. I can find
3552 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3553 command in Solaris 2.4 uses it. See also &%-ti%&.
3554
3555 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3556 .oindex "&%-M%&"
3557 .cindex "forcing delivery"
3558 .cindex "delivery" "forcing attempt"
3559 .cindex "frozen messages" "forcing delivery"
3560 This option requests Exim to run a delivery attempt on each message in turn. If
3561 any of the messages are frozen, they are automatically thawed before the
3562 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3563 and &%hold_domains%& are ignored.
3564
3565 Retry
3566 .cindex "hints database" "overriding retry hints"
3567 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3568 the normal retry time has not yet been reached. This option requires the caller
3569 to be an admin user. However, there is an option called &%prod_requires_admin%&
3570 which can be set false to relax this restriction (and also the same requirement
3571 for the &%-q%&, &%-R%&, and &%-S%& options).
3572
3573 The deliveries happen synchronously, that is, the original Exim process does
3574 not terminate until all the delivery attempts have finished. No output is
3575 produced unless there is a serious error. If you want to see what is happening,
3576 use the &%-v%& option as well, or inspect Exim's main log.
3577
3578 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3579 .oindex "&%-Mar%&"
3580 .cindex "message" "adding recipients"
3581 .cindex "recipient" "adding"
3582 This option requests Exim to add the addresses to the list of recipients of the
3583 message (&"ar"& for &"add recipients"&). The first argument must be a message
3584 id, and the remaining ones must be email addresses. However, if the message is
3585 active (in the middle of a delivery attempt), it is not altered. This option
3586 can be used only by an admin user.
3587
3588 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3589         &~<&'message&~id'&>"
3590 .oindex "&%-MC%&"
3591 .cindex "SMTP" "passed connection"
3592 .cindex "SMTP" "multiple deliveries"
3593 .cindex "multiple SMTP deliveries"
3594 This option is not intended for use by external callers. It is used internally
3595 by Exim to invoke another instance of itself to deliver a waiting message using
3596 an existing SMTP connection, which is passed as the standard input. Details are
3597 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3598 must be root or the Exim user in order to use it.
3599
3600 .vitem &%-MCA%&
3601 .oindex "&%-MCA%&"
3602 This option is not intended for use by external callers. It is used internally
3603 by Exim in conjunction with the &%-MC%& option. It signifies that the
3604 connection to the remote host has been authenticated.
3605
3606 .vitem &%-MCP%&
3607 .oindex "&%-MCP%&"
3608 This option is not intended for use by external callers. It is used internally
3609 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3610 which Exim is connected supports pipelining.
3611
3612 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3613 .oindex "&%-MCQ%&"
3614 This option is not intended for use by external callers. It is used internally
3615 by Exim in conjunction with the &%-MC%& option when the original delivery was
3616 started by a queue runner. It passes on the process id of the queue runner,
3617 together with the file descriptor number of an open pipe. Closure of the pipe
3618 signals the final completion of the sequence of processes that are passing
3619 messages through the same SMTP connection.
3620
3621 .vitem &%-MCS%&
3622 .oindex "&%-MCS%&"
3623 This option is not intended for use by external callers. It is used internally
3624 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3625 SMTP SIZE option should be used on messages delivered down the existing
3626 connection.
3627
3628 .vitem &%-MCT%&
3629 .oindex "&%-MCT%&"
3630 This option is not intended for use by external callers. It is used internally
3631 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3632 host to which Exim is connected supports TLS encryption.
3633
3634 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3635 .oindex "&%-Mc%&"
3636 .cindex "hints database" "not overridden by &%-Mc%&"
3637 .cindex "delivery" "manually started &-- not forced"
3638 This option requests Exim to run a delivery attempt on each message in turn,
3639 but unlike the &%-M%& option, it does check for retry hints, and respects any
3640 that are found. This option is not very useful to external callers. It is
3641 provided mainly for internal use by Exim when it needs to re-invoke itself in
3642 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3643 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3644 respects retry times and other options such as &%hold_domains%& that are
3645 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3646 If you want to run a specific delivery as if in a queue run, you should use
3647 &%-q%& with a message id argument. A distinction between queue run deliveries
3648 and other deliveries is made in one or two places.
3649
3650 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3651 .oindex "&%-Mes%&"
3652 .cindex "message" "changing sender"
3653 .cindex "sender" "changing"
3654 This option requests Exim to change the sender address in the message to the
3655 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3656 &"edit sender"&). There must be exactly two arguments. The first argument must
3657 be a message id, and the second one an email address. However, if the message
3658 is active (in the middle of a delivery attempt), its status is not altered.
3659 This option can be used only by an admin user.
3660
3661 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3662 .oindex "&%-Mf%&"
3663 .cindex "freezing messages"
3664 .cindex "message" "manually freezing"
3665 This option requests Exim to mark each listed message as &"frozen"&. This
3666 prevents any delivery attempts taking place until the message is &"thawed"&,
3667 either manually or as a result of the &%auto_thaw%& configuration option.
3668 However, if any of the messages are active (in the middle of a delivery
3669 attempt), their status is not altered. This option can be used only by an admin
3670 user.
3671
3672 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3673 .oindex "&%-Mg%&"
3674 .cindex "giving up on messages"
3675 .cindex "message" "abandoning delivery attempts"
3676 .cindex "delivery" "abandoning further attempts"
3677 This option requests Exim to give up trying to deliver the listed messages,
3678 including any that are frozen. However, if any of the messages are active,
3679 their status is not altered. For non-bounce messages, a delivery error message
3680 is sent to the sender, containing the text &"cancelled by administrator"&.
3681 Bounce messages are just discarded. This option can be used only by an admin
3682 user.
3683
3684 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3685 .oindex "&%-Mmad%&"
3686 .cindex "delivery" "cancelling all"
3687 This option requests Exim to mark all the recipient addresses in the messages
3688 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3689 message is active (in the middle of a delivery attempt), its status is not
3690 altered. This option can be used only by an admin user.
3691
3692 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3693 .oindex "&%-Mmd%&"
3694 .cindex "delivery" "cancelling by address"
3695 .cindex "recipient" "removing"
3696 .cindex "removing recipients"
3697 This option requests Exim to mark the given addresses as already delivered
3698 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3699 the remaining ones must be email addresses. These are matched to recipient
3700 addresses in the message in a case-sensitive manner. If the message is active
3701 (in the middle of a delivery attempt), its status is not altered. This option
3702 can be used only by an admin user.
3703
3704 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3705 .oindex "&%-Mrm%&"
3706 .cindex "removing messages"
3707 .cindex "abandoning mail"
3708 .cindex "message" "manually discarding"
3709 This option requests Exim to remove the given messages from the queue. No
3710 bounce messages are sent; each message is simply forgotten. However, if any of
3711 the messages are active, their status is not altered. This option can be used
3712 only by an admin user or by the user who originally caused the message to be
3713 placed on the queue.
3714
3715 .vitem &%-Mset%&&~<&'message&~id'&>
3716 .oindex "&%-Mset%&
3717 .cindex "testing" "string expansion"
3718 .cindex "expansion" "testing"
3719 This option is useful only in conjunction with &%-be%& (that is, when testing
3720 string expansions). Exim loads the given message from its spool before doing
3721 the test expansions, thus setting message-specific variables such as
3722 &$message_size$& and the header variables. The &$recipients$& variable is made
3723 available. This feature is provided to make it easier to test expansions that
3724 make use of these variables. However, this option can be used only by an admin
3725 user. See also &%-bem%&.
3726
3727 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3728 .oindex "&%-Mt%&"
3729 .cindex "thawing messages"
3730 .cindex "unfreezing messages"
3731 .cindex "frozen messages" "thawing"
3732 .cindex "message" "thawing frozen"
3733 This option requests Exim to &"thaw"& any of the listed messages that are
3734 &"frozen"&, so that delivery attempts can resume. However, if any of the
3735 messages are active, their status is not altered. This option can be used only
3736 by an admin user.
3737
3738 .vitem &%-Mvb%&&~<&'message&~id'&>
3739 .oindex "&%-Mvb%&"
3740 .cindex "listing" "message body"
3741 .cindex "message" "listing body of"
3742 This option causes the contents of the message body (-D) spool file to be
3743 written to the standard output. This option can be used only by an admin user.
3744
3745 .vitem &%-Mvc%&&~<&'message&~id'&>
3746 .oindex "&%-Mvc%&"
3747 .cindex "message" "listing in RFC 2822 format"
3748 .cindex "listing" "message in RFC 2922 format"
3749 This option causes a copy of the complete message (header lines plus body) to
3750 be written to the standard output in RFC 2822 format. This option can be used
3751 only by an admin user.
3752
3753 .vitem &%-Mvh%&&~<&'message&~id'&>
3754 .oindex "&%-Mvh%&"
3755 .cindex "listing" "message headers"
3756 .cindex "header lines" "listing"
3757 .cindex "message" "listing header lines"
3758 This option causes the contents of the message headers (-H) spool file to be
3759 written to the standard output. This option can be used only by an admin user.
3760
3761 .vitem &%-Mvl%&&~<&'message&~id'&>
3762 .oindex "&%-Mvl%&"
3763 .cindex "listing" "message log"
3764 .cindex "message" "listing message log"
3765 This option causes the contents of the message log spool file to be written to
3766 the standard output. This option can be used only by an admin user.
3767
3768 .vitem &%-m%&
3769 .oindex "&%-m%&"
3770 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
3771 treats it that way too.
3772
3773 .vitem &%-N%&
3774 .oindex "&%-N%&"
3775 .cindex "debugging" "&%-N%& option"
3776 .cindex "debugging" "suppressing delivery"
3777 This is a debugging option that inhibits delivery of a message at the transport
3778 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
3779 it just doesn't actually transport the message, but instead behaves as if it
3780 had successfully done so. However, it does not make any updates to the retry
3781 database, and the log entries for deliveries are flagged with &"*>"& rather
3782 than &"=>"&.
3783
3784 Because &%-N%& discards any message to which it applies, only root or the Exim
3785 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
3786 words, an ordinary user can use it only when supplying an incoming message to
3787 which it will apply. Although transportation never fails when &%-N%& is set, an
3788 address may be deferred because of a configuration problem on a transport, or a
3789 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
3790 the message, and applies to any subsequent delivery attempts that may happen
3791 for that message.
3792
3793 .vitem &%-n%&
3794 .oindex "&%-n%&"
3795 .cindex "Sendmail compatibility" "&%-n%& option ignored"
3796 This option is interpreted by Sendmail to mean &"no aliasing"&. It is ignored
3797 by Exim.
3798
3799 .vitem &%-O%&&~<&'data'&>
3800 .oindex "&%-O%&"
3801 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
3802 Exim.
3803
3804 .vitem &%-oA%&&~<&'file&~name'&>
3805 .oindex "&%-oA%&"
3806 .cindex "Sendmail compatibility" "&%-oA%& option"
3807 This option is used by Sendmail in conjunction with &%-bi%& to specify an
3808 alternative alias file name. Exim handles &%-bi%& differently; see the
3809 description above.
3810
3811 .vitem &%-oB%&&~<&'n'&>
3812 .oindex "&%-oB%&"
3813 .cindex "SMTP" "passed connection"
3814 .cindex "SMTP" "multiple deliveries"
3815 .cindex "multiple SMTP deliveries"
3816 This is a debugging option which limits the maximum number of messages that can
3817 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
3818 transport. If <&'n'&> is omitted, the limit is set to 1.
3819
3820 .vitem &%-odb%&
3821 .oindex "&%-odb%&"
3822 .cindex "background delivery"
3823 .cindex "delivery" "in the background"
3824 This option applies to all modes in which Exim accepts incoming messages,
3825 including the listening daemon. It requests &"background"& delivery of such
3826 messages, which means that the accepting process automatically starts a
3827 delivery process for each message received, but does not wait for the delivery
3828 processes to finish.
3829
3830 When all the messages have been received, the reception process exits,
3831 leaving the delivery processes to finish in their own time. The standard output
3832 and error streams are closed at the start of each delivery process.
3833 This is the default action if none of the &%-od%& options are present.
3834
3835 If one of the queueing options in the configuration file
3836 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
3837 overrides it if &%queue_only_override%& is set true, which is the default
3838 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
3839
3840 .vitem &%-odf%&
3841 .oindex "&%-odf%&"
3842 .cindex "foreground delivery"
3843 .cindex "delivery" "in the foreground"
3844 This option requests &"foreground"& (synchronous) delivery when Exim has
3845 accepted a locally-generated message. (For the daemon it is exactly the same as
3846 &%-odb%&.) A delivery process is automatically started to deliver the message,
3847 and Exim waits for it to complete before proceeding.
3848
3849 The original Exim reception process does not finish until the delivery
3850 process for the final message has ended. The standard error stream is left open
3851 during deliveries.
3852
3853 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
3854 false and one of the queueing options in the configuration file is in effect.
3855
3856 If there is a temporary delivery error during foreground delivery, the
3857 message is left on the queue for later delivery, and the original reception
3858 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
3859 restricted configuration that never queues messages.
3860
3861
3862 .vitem &%-odi%&
3863 .oindex "&%-odi%&"
3864 This option is synonymous with &%-odf%&. It is provided for compatibility with
3865 Sendmail.
3866
3867 .vitem &%-odq%&
3868 .oindex "&%-odq%&"
3869 .cindex "non-immediate delivery"
3870 .cindex "delivery" "suppressing immediate"
3871 .cindex "queueing incoming messages"
3872 This option applies to all modes in which Exim accepts incoming messages,
3873 including the listening daemon. It specifies that the accepting process should
3874 not automatically start a delivery process for each message received. Messages
3875 are placed on the queue, and remain there until a subsequent queue runner
3876 process encounters them. There are several configuration options (such as
3877 &%queue_only%&) that can be used to queue incoming messages under certain
3878 conditions. This option overrides all of them and also &%-odqs%&. It always
3879 forces queueing.
3880
3881 .vitem &%-odqs%&
3882 .oindex "&%-odqs%&"
3883 .cindex "SMTP" "delaying delivery"
3884 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
3885 However, like &%-odb%& and &%-odi%&, this option has no effect if
3886 &%queue_only_override%& is false and one of the queueing options in the
3887 configuration file is in effect.
3888
3889 When &%-odqs%& does operate, a delivery process is started for each incoming
3890 message, in the background by default, but in the foreground if &%-odi%& is
3891 also present. The recipient addresses are routed, and local deliveries are done
3892 in the normal way. However, if any SMTP deliveries are required, they are not
3893 done at this time, so the message remains on the queue until a subsequent queue
3894 runner process encounters it. Because routing was done, Exim knows which
3895 messages are waiting for which hosts, and so a number of messages for the same
3896 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
3897 configuration option has the same effect for specific domains. See also the
3898 &%-qq%& option.
3899
3900 .vitem &%-oee%&
3901 .oindex "&%-oee%&"
3902 .cindex "error" "reporting"
3903 If an error is detected while a non-SMTP message is being received (for
3904 example, a malformed address), the error is reported to the sender in a mail
3905 message.
3906
3907 .cindex "return code" "for &%-oee%&"
3908 Provided
3909 this error message is successfully sent, the Exim receiving process
3910 exits with a return code of zero. If not, the return code is 2 if the problem
3911 is that the original message has no recipients, or 1 any other error. This is
3912 the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
3913
3914 .vitem &%-oem%&
3915 .oindex "&%-oem%&"
3916 .cindex "error" "reporting"
3917 .cindex "return code" "for &%-oem%&"
3918 This is the same as &%-oee%&, except that Exim always exits with a non-zero
3919 return code, whether or not the error message was successfully sent.
3920 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
3921
3922 .vitem &%-oep%&
3923 .oindex "&%-oep%&"
3924 .cindex "error" "reporting"
3925 If an error is detected while a non-SMTP message is being received, the
3926 error is reported by writing a message to the standard error file (stderr).
3927 .cindex "return code" "for &%-oep%&"
3928 The return code is 1 for all errors.
3929
3930 .vitem &%-oeq%&
3931 .oindex "&%-oeq%&"
3932 .cindex "error" "reporting"
3933 This option is supported for compatibility with Sendmail, but has the same
3934 effect as &%-oep%&.
3935
3936 .vitem &%-oew%&
3937 .oindex "&%-oew%&"
3938 .cindex "error" "reporting"
3939 This option is supported for compatibility with Sendmail, but has the same
3940 effect as &%-oem%&.
3941
3942 .vitem &%-oi%&
3943 .oindex "&%-oi%&"
3944 .cindex "dot" "in incoming non-SMTP message"
3945 This option, which has the same effect as &%-i%&, specifies that a dot on a
3946 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
3947 single dot does terminate, though Exim does no special processing for other
3948 lines that start with a dot. This option is set by default if Exim is called as
3949 &'rmail'&. See also &%-ti%&.
3950
3951 .vitem &%-oitrue%&
3952 .oindex "&%-oitrue%&"
3953 This option is treated as synonymous with &%-oi%&.
3954
3955 .vitem &%-oMa%&&~<&'host&~address'&>
3956 .oindex "&%-oMa%&"
3957 .cindex "sender" "host address, specifying for local message"
3958 A number of options starting with &%-oM%& can be used to set values associated
3959 with remote hosts on locally-submitted messages (that is, messages not received
3960 over TCP/IP). These options can be used by any caller in conjunction with the
3961 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
3962 other circumstances, they are ignored unless the caller is trusted.
3963
3964 The &%-oMa%& option sets the sender host address. This may include a port
3965 number at the end, after a full stop (period). For example:
3966 .code
3967 exim -bs -oMa 10.9.8.7.1234
3968 .endd
3969 An alternative syntax is to enclose the IP address in square brackets,
3970 followed by a colon and the port number:
3971 .code
3972 exim -bs -oMa [10.9.8.7]:1234
3973 .endd
3974 The IP address is placed in the &$sender_host_address$& variable, and the
3975 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
3976 are present on the command line, the sender host IP address is taken from
3977 whichever one is last.
3978
3979 .vitem &%-oMaa%&&~<&'name'&>
3980 .oindex "&%-oMaa%&"
3981 .cindex "authentication" "name, specifying for local message"
3982 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
3983 option sets the value of &$sender_host_authenticated$& (the authenticator
3984 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
3985 This option can be used with &%-bh%& and &%-bs%& to set up an
3986 authenticated SMTP session without actually using the SMTP AUTH command.
3987
3988 .vitem &%-oMai%&&~<&'string'&>
3989 .oindex "&%-oMai%&"
3990 .cindex "authentication" "id, specifying for local message"
3991 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
3992 option sets the value of &$authenticated_id$& (the id that was authenticated).
3993 This overrides the default value (the caller's login id, except with &%-bh%&,
3994 where there is no default) for messages from local sources. See chapter
3995 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
3996
3997 .vitem &%-oMas%&&~<&'address'&>
3998 .oindex "&%-oMas%&"
3999 .cindex "authentication" "sender, specifying for local message"
4000 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4001 option sets the authenticated sender value in &$authenticated_sender$&. It
4002 overrides the sender address that is created from the caller's login id for
4003 messages from local sources, except when &%-bh%& is used, when there is no
4004 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4005 specified on a MAIL command overrides this value. See chapter
4006 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4007
4008 .vitem &%-oMi%&&~<&'interface&~address'&>
4009 .oindex "&%-oMi%&"
4010 .cindex "interface" "address, specifying for local message"
4011 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4012 option sets the IP interface address value. A port number may be included,
4013 using the same syntax as for &%-oMa%&. The interface address is placed in
4014 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4015
4016 .vitem &%-oMr%&&~<&'protocol&~name'&>
4017 .oindex "&%-oMr%&"
4018 .cindex "protocol, specifying for local message"
4019 .vindex "&$received_protocol$&"
4020 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4021 option sets the received protocol value that is stored in
4022 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4023 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4024 SMTP protocol names (see the description of &$received_protocol$& in section
4025 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4026 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4027 be set by &%-oMr%&.
4028
4029 .vitem &%-oMs%&&~<&'host&~name'&>
4030 .oindex "&%-oMs%&"
4031 .cindex "sender" "host name, specifying for local message"
4032 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4033 option sets the sender host name in &$sender_host_name$&. When this option is
4034 present, Exim does not attempt to look up a host name from an IP address; it
4035 uses the name it is given.
4036
4037 .vitem &%-oMt%&&~<&'ident&~string'&>
4038 .oindex "&%-oMt%&"
4039 .cindex "sender" "ident string, specifying for local message"
4040 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4041 option sets the sender ident value in &$sender_ident$&. The default setting for
4042 local callers is the login id of the calling process, except when &%-bh%& is
4043 used, when there is no default.
4044
4045 .vitem &%-om%&
4046 .oindex "&%-om%&"
4047 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4048 In Sendmail, this option means &"me too"&, indicating that the sender of a
4049 message should receive a copy of the message if the sender appears in an alias
4050 expansion. Exim always does this, so the option does nothing.
4051
4052 .vitem &%-oo%&
4053 .oindex "&%-oo%&"
4054 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4055 This option is ignored. In Sendmail it specifies &"old style headers"&,
4056 whatever that means.
4057
4058 .vitem &%-oP%&&~<&'path'&>
4059 .oindex "&%-oP%&"
4060 .cindex "pid (process id)" "of daemon"
4061 .cindex "daemon" "process id (pid)"
4062 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4063 value. The option specifies the file to which the process id of the daemon is
4064 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4065 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4066 because in those cases, the normal pid file is not used.
4067
4068 .vitem &%-or%&&~<&'time'&>
4069 .oindex "&%-or%&"
4070 .cindex "timeout" "for non-SMTP input"
4071 This option sets a timeout value for incoming non-SMTP messages. If it is not
4072 set, Exim will wait forever for the standard input. The value can also be set
4073 by the &%receive_timeout%& option. The format used for specifying times is
4074 described in section &<<SECTtimeformat>>&.
4075
4076 .vitem &%-os%&&~<&'time'&>
4077 .oindex "&%-os%&"
4078 .cindex "timeout" "for SMTP input"
4079 .cindex "SMTP" "input timeout"
4080 This option sets a timeout value for incoming SMTP messages. The timeout
4081 applies to each SMTP command and block of data. The value can also be set by
4082 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4083 for specifying times is described in section &<<SECTtimeformat>>&.
4084
4085 .vitem &%-ov%&
4086 .oindex "&%-ov%&"
4087 This option has exactly the same effect as &%-v%&.
4088
4089 .vitem &%-oX%&&~<&'number&~or&~string'&>
4090 .oindex "&%-oX%&"
4091 .cindex "TCP/IP" "setting listening ports"
4092 .cindex "TCP/IP" "setting listening interfaces"
4093 .cindex "port" "receiving TCP/IP"
4094 This option is relevant only when the &%-bd%& (start listening daemon) option
4095 is also given. It controls which ports and interfaces the daemon uses. Details
4096 of the syntax, and how it interacts with configuration file options, are given
4097 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4098 file is written unless &%-oP%& is also present to specify a pid file name.
4099
4100 .vitem &%-pd%&
4101 .oindex "&%-pd%&"
4102 .cindex "Perl" "starting the interpreter"
4103 This option applies when an embedded Perl interpreter is linked with Exim (see
4104 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4105 option, forcing the starting of the interpreter to be delayed until it is
4106 needed.
4107
4108 .vitem &%-ps%&
4109 .oindex "&%-ps%&"
4110 .cindex "Perl" "starting the interpreter"
4111 This option applies when an embedded Perl interpreter is linked with Exim (see
4112 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4113 option, forcing the starting of the interpreter to occur as soon as Exim is
4114 started.
4115
4116 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4117 .oindex "&%-p%&"
4118 For compatibility with Sendmail, this option is equivalent to
4119 .display
4120 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4121 .endd
4122 It sets the incoming protocol and host name (for trusted callers). The
4123 host name and its colon can be omitted when only the protocol is to be set.
4124 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4125 to embedded Perl. It is therefore impossible to set a protocol value of &`p`&
4126 or &`s`& using this option (but that does not seem a real limitation).
4127
4128 .vitem &%-q%&
4129 .oindex "&%-q%&"
4130 .cindex "queue runner" "starting manually"
4131 This option is normally restricted to admin users. However, there is a
4132 configuration option called &%prod_requires_admin%& which can be set false to
4133 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4134 and &%-S%& options).
4135
4136 .cindex "queue runner" "description of operation"
4137 The &%-q%& option starts one queue runner process. This scans the queue of
4138 waiting messages, and runs a delivery process for each one in turn. It waits
4139 for each delivery process to finish before starting the next one. A delivery
4140 process may not actually do any deliveries if the retry times for the addresses
4141 have not been reached. Use &%-qf%& (see below) if you want to override this.
4142
4143 If
4144 .cindex "SMTP" "passed connection"
4145 .cindex "SMTP" "multiple deliveries"
4146 .cindex "multiple SMTP deliveries"
4147 the delivery process spawns other processes to deliver other messages down
4148 passed SMTP connections, the queue runner waits for these to finish before
4149 proceeding.
4150
4151 When all the queued messages have been considered, the original queue runner
4152 process terminates. In other words, a single pass is made over the waiting
4153 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4154 this to be repeated periodically.
4155
4156 Exim processes the waiting messages in an unpredictable order. It isn't very
4157 random, but it is likely to be different each time, which is all that matters.
4158 If one particular message screws up a remote MTA, other messages to the same
4159 MTA have a chance of getting through if they get tried first.
4160
4161 It is possible to cause the messages to be processed in lexical message id
4162 order, which is essentially the order in which they arrived, by setting the
4163 &%queue_run_in_order%& option, but this is not recommended for normal use.
4164
4165 .vitem &%-q%&<&'qflags'&>
4166 The &%-q%& option may be followed by one or more flag letters that change its
4167 behaviour. They are all optional, but if more than one is present, they must
4168 appear in the correct order. Each flag is described in a separate item below.
4169
4170 .vitem &%-qq...%&
4171 .oindex "&%-qq%&"
4172 .cindex "queue" "double scanning"
4173 .cindex "queue" "routing"
4174 .cindex "routing" "whole queue before delivery"
4175 An option starting with &%-qq%& requests a two-stage queue run. In the first
4176 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4177 every domain. Addresses are routed, local deliveries happen, but no remote
4178 transports are run.
4179
4180 .cindex "hints database" "remembering routing"
4181 The hints database that remembers which messages are waiting for specific hosts
4182 is updated, as if delivery to those hosts had been deferred. After this is
4183 complete, a second, normal queue scan happens, with routing and delivery taking
4184 place as normal. Messages that are routed to the same host should mostly be
4185 delivered down a single SMTP
4186 .cindex "SMTP" "passed connection"
4187 .cindex "SMTP" "multiple deliveries"
4188 .cindex "multiple SMTP deliveries"
4189 connection because of the hints that were set up during the first queue scan.
4190 This option may be useful for hosts that are connected to the Internet
4191 intermittently.
4192
4193 .vitem &%-q[q]i...%&
4194 .oindex "&%-qi%&"
4195 .cindex "queue" "initial delivery"
4196 If the &'i'& flag is present, the queue runner runs delivery processes only for
4197 those messages that haven't previously been tried. (&'i'& stands for &"initial
4198 delivery"&.) This can be helpful if you are putting messages on the queue using
4199 &%-odq%& and want a queue runner just to process the new messages.
4200
4201 .vitem &%-q[q][i]f...%&
4202 .oindex "&%-qf%&"
4203 .cindex "queue" "forcing delivery"
4204 .cindex "delivery" "forcing in queue run"
4205 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4206 message, whereas without &'f'& only those non-frozen addresses that have passed
4207 their retry times are tried.
4208
4209 .vitem &%-q[q][i]ff...%&
4210 .oindex "&%-qff%&"
4211 .cindex "frozen messages" "forcing delivery"
4212 If &'ff'& is present, a delivery attempt is forced for every message, whether
4213 frozen or not.
4214
4215 .vitem &%-q[q][i][f[f]]l%&
4216 .oindex "&%-ql%&"
4217 .cindex "queue" "local deliveries only"
4218 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4219 be done. If a message requires any remote deliveries, it remains on the queue
4220 for later delivery.
4221
4222 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4223 .cindex "queue" "delivering specific messages"
4224 When scanning the queue, Exim can be made to skip over messages whose ids are
4225 lexically less than a given value by following the &%-q%& option with a
4226 starting message id. For example:
4227 .code
4228 exim -q 0t5C6f-0000c8-00
4229 .endd
4230 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4231 second message id is given, messages whose ids are lexically greater than it
4232 are also skipped. If the same id is given twice, for example,
4233 .code
4234 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4235 .endd
4236 just one delivery process is started, for that message. This differs from
4237 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4238 that it counts as a delivery from a queue run. Note that the selection
4239 mechanism does not affect the order in which the messages are scanned. There
4240 are also other ways of selecting specific sets of messages for delivery in a
4241 queue run &-- see &%-R%& and &%-S%&.
4242
4243 .vitem &%-q%&<&'qflags'&><&'time'&>
4244 .cindex "queue runner" "starting periodically"
4245 .cindex "periodic queue running"
4246 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4247 starting a queue runner process at intervals specified by the given time value
4248 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4249 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4250 single daemon process handles both functions. A common way of starting up a
4251 combined daemon at system boot time is to use a command such as
4252 .code
4253 /usr/exim/bin/exim -bd -q30m
4254 .endd
4255 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4256 process every 30 minutes.
4257
4258 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4259 pid file is written unless one is explicitly requested by the &%-oP%& option.
4260
4261 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4262 .oindex "&%-qR%&"
4263 This option is synonymous with &%-R%&. It is provided for Sendmail
4264 compatibility.
4265
4266 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4267 .oindex "&%-qS%&"
4268 This option is synonymous with &%-S%&.
4269
4270 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4271 .oindex "&%-R%&"
4272 .cindex "queue runner" "for specific recipients"
4273 .cindex "delivery" "to given domain"
4274 .cindex "domain" "delivery to"
4275 The <&'rsflags'&> may be empty, in which case the white space before the string
4276 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4277 which are the possible values for <&'rsflags'&>. White space is required if
4278 <&'rsflags'&> is not empty.
4279
4280 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4281 perform a single queue run, except that, when scanning the messages on the
4282 queue, Exim processes only those that have at least one undelivered recipient
4283 address containing the given string, which is checked in a case-independent
4284 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4285 regular expression; otherwise it is a literal string.
4286
4287 If you want to do periodic queue runs for messages with specific recipients,
4288 you can combine &%-R%& with &%-q%& and a time value. For example:
4289 .code
4290 exim -q25m -R @special.domain.example
4291 .endd
4292 This example does a queue run for messages with recipients in the given domain
4293 every 25 minutes. Any additional flags that are specified with &%-q%& are
4294 applied to each queue run.
4295
4296 Once a message is selected for delivery by this mechanism, all its addresses
4297 are processed. For the first selected message, Exim overrides any retry
4298 information and forces a delivery attempt for each undelivered address. This
4299 means that if delivery of any address in the first message is successful, any
4300 existing retry information is deleted, and so delivery attempts for that
4301 address in subsequently selected messages (which are processed without forcing)
4302 will run. However, if delivery of any address does not succeed, the retry
4303 information is updated, and in subsequently selected messages, the failing
4304 address will be skipped.
4305
4306 .cindex "frozen messages" "forcing delivery"
4307 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4308 all selected messages, not just the first; frozen messages are included when
4309 &'ff'& is present.
4310
4311 The &%-R%& option makes it straightforward to initiate delivery of all messages
4312 to a given domain after a host has been down for some time. When the SMTP
4313 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4314 effect is to run Exim with the &%-R%& option, but it can be configured to run
4315 an arbitrary command instead.
4316
4317 .vitem &%-r%&
4318 .oindex "&%-r%&"
4319 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4320
4321 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4322 .oindex "&%-S%&"
4323 .cindex "delivery" "from given sender"
4324 .cindex "queue runner" "for specific senders"
4325 This option acts like &%-R%& except that it checks the string against each
4326 message's sender instead of against the recipients. If &%-R%& is also set, both
4327 conditions must be met for a message to be selected. If either of the options
4328 has &'f'& or &'ff'& in its flags, the associated action is taken.
4329
4330 .vitem &%-Tqt%&&~<&'times'&>
4331 .oindex "&%-Tqt%&"
4332 This an option that is exclusively for use by the Exim testing suite. It is not
4333 recognized when Exim is run normally. It allows for the setting up of explicit
4334 &"queue times"& so that various warning/retry features can be tested.
4335
4336 .vitem &%-t%&
4337 .oindex "&%-t%&"
4338 .cindex "recipient" "extracting from header lines"
4339 .cindex "&'Bcc:'& header line"
4340 .cindex "&'Cc:'& header line"
4341 .cindex "&'To:'& header line"
4342 When Exim is receiving a locally-generated, non-SMTP message on its standard
4343 input, the &%-t%& option causes the recipients of the message to be obtained
4344 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4345 from the command arguments. The addresses are extracted before any rewriting
4346 takes place and the &'Bcc:'& header line, if present, is then removed.
4347
4348 .cindex "Sendmail compatibility" "&%-t%& option"
4349 If the command has any arguments, they specify addresses to which the message
4350 is &'not'& to be delivered. That is, the argument addresses are removed from
4351 the recipients list obtained from the headers. This is compatible with Smail 3
4352 and in accordance with the documented behaviour of several versions of
4353 Sendmail, as described in man pages on a number of operating systems (e.g.
4354 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4355 argument addresses to those obtained from the headers, and the O'Reilly
4356 Sendmail book documents it that way. Exim can be made to add argument addresses
4357 instead of subtracting them by setting the option
4358 &%extract_addresses_remove_arguments%& false.
4359
4360 .cindex "&%Resent-%& header lines" "with &%-t%&"
4361 If there are any &%Resent-%& header lines in the message, Exim extracts
4362 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4363 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4364 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4365 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4366
4367 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4368 message is resent several times). The RFC also specifies that they should be
4369 added at the front of the message, and separated by &'Received:'& lines. It is
4370 not at all clear how &%-t%& should operate in the present of multiple sets,
4371 nor indeed exactly what constitutes a &"set"&.
4372 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4373 are often added at the end of the header, and if a message is resent more than
4374 once, it is common for the original set of &%Resent-%& headers to be renamed as
4375 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4376
4377 .vitem &%-ti%&
4378 .oindex "&%-ti%&"
4379 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4380 compatibility with Sendmail.
4381
4382 .vitem &%-tls-on-connect%&
4383 .oindex "&%-tls-on-connect%&"
4384 .cindex "TLS" "use without STARTTLS"
4385 .cindex "TLS" "automatic start"
4386 This option is available when Exim is compiled with TLS support. It forces all
4387 incoming SMTP connections to behave as if the incoming port is listed in the
4388 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4389 &<<CHAPTLS>>& for further details.
4390
4391
4392 .vitem &%-U%&
4393 .oindex "&%-U%&"
4394 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4395 Sendmail uses this option for &"initial message submission"&, and its
4396 documentation states that in future releases, it may complain about
4397 syntactically invalid messages rather than fixing them when this flag is not
4398 set. Exim ignores this option.
4399
4400 .vitem &%-v%&
4401 .oindex "&%-v%&"
4402 This option causes Exim to write information to the standard error stream,
4403 describing what it is doing. In particular, it shows the log lines for
4404 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4405 dialogue is shown. Some of the log lines shown may not actually be written to
4406 the log if the setting of &%log_selector%& discards them. Any relevant
4407 selectors are shown with each log line. If none are shown, the logging is
4408 unconditional.
4409
4410 .vitem &%-x%&
4411 .oindex "&%-x%&"
4412 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4413 National Language Support extended characters in the body of the mail item"&).
4414 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4415 this option.
4416 .endlist
4417
4418 .ecindex IIDclo1
4419 .ecindex IIDclo2
4420
4421
4422 . ////////////////////////////////////////////////////////////////////////////
4423 . Insert a stylized DocBook comment here, to identify the end of the command
4424 . line options. This is for the benefit of the Perl script that automatically
4425 . creates a man page for the options.
4426 . ////////////////////////////////////////////////////////////////////////////
4427
4428 .literal xml
4429 <!-- === End of command line options === -->
4430 .literal off
4431
4432
4433
4434
4435
4436 . ////////////////////////////////////////////////////////////////////////////
4437 . ////////////////////////////////////////////////////////////////////////////
4438
4439
4440 .chapter "The Exim run time configuration file" "CHAPconf" &&&
4441          "The runtime configuration file"
4442
4443 .cindex "run time configuration"
4444 .cindex "configuration file" "general description"
4445 .cindex "CONFIGURE_FILE"
4446 .cindex "configuration file" "errors in"
4447 .cindex "error" "in configuration file"
4448 .cindex "return code" "for bad configuration"
4449 Exim uses a single run time configuration file that is read whenever an Exim
4450 binary is executed. Note that in normal operation, this happens frequently,
4451 because Exim is designed to operate in a distributed manner, without central
4452 control.
4453
4454 If a syntax error is detected while reading the configuration file, Exim
4455 writes a message on the standard error, and exits with a non-zero return code.
4456 The message is also written to the panic log. &*Note*&: Only simple syntax
4457 errors can be detected at this time. The values of any expanded options are
4458 not checked until the expansion happens, even when the expansion does not
4459 actually alter the string.
4460
4461 The name of the configuration file is compiled into the binary for security
4462 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4463 most configurations, this specifies a single file. However, it is permitted to
4464 give a colon-separated list of file names, in which case Exim uses the first
4465 existing file in the list.
4466
4467 .cindex "EXIM_USER"
4468 .cindex "EXIM_GROUP"
4469 .cindex "CONFIGURE_OWNER"
4470 .cindex "CONFIGURE_GROUP"
4471 .cindex "configuration file" "ownership"
4472 .cindex "ownership" "configuration file"
4473 The run time configuration file must be owned by root or by the user that is
4474 specified at compile time by the EXIM_USER option, or by the user that is
4475 specified at compile time by the CONFIGURE_OWNER option (if set). The
4476 configuration file must not be world-writeable or group-writeable, unless its
4477 group is the one specified at compile time by the EXIM_GROUP option or by the
4478 CONFIGURE_GROUP option.
4479
4480 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4481 to root, anybody who is able to edit the run time configuration file has an
4482 easy way to run commands as root. If you make your mail administrators members
4483 of the Exim group, but do not trust them with root, make sure that the run time
4484 configuration is not group writeable.
4485
4486 A default configuration file, which will work correctly in simple situations,
4487 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4488 defines just one file name, the installation process copies the default
4489 configuration to a new file of that name if it did not previously exist. If
4490 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4491 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4492 configuration.
4493
4494
4495
4496 .section "Using a different configuration file" "SECID40"
4497 .cindex "configuration file" "alternate"
4498 A one-off alternate configuration can be specified by the &%-C%& command line
4499 option, which may specify a single file or a list of files. However, when
4500 &%-C%& is used, Exim gives up its root privilege, unless called by root or the
4501 Exim user (or unless the argument for &%-C%& is identical to the built-in value
4502 from CONFIGURE_FILE). &%-C%& is useful mainly for checking the syntax of
4503 configuration files before installing them. No owner or group checks are done
4504 on a configuration file specified by &%-C%&.
4505
4506 The privileged use of &%-C%& by the Exim user can be locked out by setting
4507 ALT_CONFIG_ROOT_ONLY in &_Local/Makefile_& when building Exim. However,
4508 if you do this, you also lock out the possibility of testing a
4509 configuration using &%-C%& right through message reception and delivery, even
4510 if the caller is root. The reception works, but by that time, Exim is running
4511 as the Exim user, so when it re-execs to regain privilege for the delivery, the
4512 use of &%-C%& causes privilege to be lost. However, root can test reception and
4513 delivery using two separate commands (one to put a message on the queue, using
4514 &%-odq%&, and another to do the delivery, using &%-M%&).
4515
4516 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4517 prefix string with which any file named in a &%-C%& command line option must
4518 start. In addition, the file name must not contain the sequence &"&`/../`&"&.
4519 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any file
4520 name can be used with &%-C%&.
4521
4522 One-off changes to a configuration can be specified by the &%-D%& command line
4523 option, which defines and overrides values for macros used inside the
4524 configuration file. However, like &%-C%&, the use of this option by a
4525 non-privileged user causes Exim to discard its root privilege.
4526 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4527 completely disabled, and its use causes an immediate error exit.
4528
4529 Some sites may wish to use the same Exim binary on different machines that
4530 share a file system, but to use different configuration files on each machine.
4531 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4532 looks for a file whose name is the configuration file name followed by a dot
4533 and the machine's node name, as obtained from the &[uname()]& function. If this
4534 file does not exist, the standard name is tried. This processing occurs for
4535 each file name in the list given by CONFIGURE_FILE or &%-C%&.
4536
4537 In some esoteric situations different versions of Exim may be run under
4538 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4539 help with this. See the comments in &_src/EDITME_& for details.
4540
4541
4542
4543 .section "Configuration file format" "SECTconffilfor"
4544 .cindex "configuration file" "format of"
4545 .cindex "format" "configuration file"
4546 Exim's configuration file is divided into a number of different parts. General
4547 option settings must always appear at the start of the file. The other parts
4548 are all optional, and may appear in any order. Each part other than the first
4549 is introduced by the word &"begin"& followed by the name of the part. The
4550 optional parts are:
4551
4552 .ilist
4553 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4554 &<<CHAPACL>>&).
4555 .next
4556 .cindex "AUTH" "configuration"
4557 &'authenticators'&: Configuration settings for the authenticator drivers. These
4558 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4559 .next
4560 &'routers'&: Configuration settings for the router drivers. Routers process
4561 addresses and determine how the message is to be delivered (see chapters
4562 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4563 .next
4564 &'transports'&: Configuration settings for the transport drivers. Transports
4565 define mechanisms for copying messages to destinations (see chapters
4566 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4567 .next
4568 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4569 If there is no retry section, or if it is empty (that is, no retry rules are
4570 defined), Exim will not retry deliveries. In this situation, temporary errors
4571 are treated the same as permanent errors. Retry rules are discussed in chapter
4572 &<<CHAPretry>>&.
4573 .next
4574 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4575 when new addresses are generated during delivery. Rewriting is discussed in
4576 chapter &<<CHAPrewrite>>&.
4577 .next
4578 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4579 want to use this feature, you must set
4580 .code
4581 LOCAL_SCAN_HAS_OPTIONS=yes
4582 .endd
4583 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4584 facility are given in chapter &<<CHAPlocalscan>>&.
4585 .endlist
4586
4587 .cindex "configuration file" "leading white space in"
4588 .cindex "configuration file" "trailing white space in"
4589 .cindex "white space" "in configuration file"
4590 Leading and trailing white space in configuration lines is always ignored.
4591
4592 Blank lines in the file, and lines starting with a # character (ignoring
4593 leading white space) are treated as comments and are ignored. &*Note*&: A
4594 # character other than at the beginning of a line is not treated specially,
4595 and does not introduce a comment.
4596
4597 Any non-comment line can be continued by ending it with a backslash. Note that
4598 the general rule for white space means that trailing white space after the
4599 backslash and leading white space at the start of continuation
4600 lines is ignored. Comment lines beginning with # (but not empty lines) may
4601 appear in the middle of a sequence of continuation lines.
4602
4603 A convenient way to create a configuration file is to start from the
4604 default, which is supplied in &_src/configure.default_&, and add, delete, or
4605 change settings as required.
4606
4607 The ACLs, retry rules, and rewriting rules have their own syntax which is
4608 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4609 respectively. The other parts of the configuration file have some syntactic
4610 items in common, and these are described below, from section &<<SECTcos>>&
4611 onwards. Before that, the inclusion, macro, and conditional facilities are
4612 described.
4613
4614
4615
4616 .section "File inclusions in the configuration file" "SECID41"
4617 .cindex "inclusions in configuration file"
4618 .cindex "configuration file" "including other files"
4619 .cindex "&`.include`& in configuration file"
4620 .cindex "&`.include_if_exists`& in configuration file"
4621 You can include other files inside Exim's run time configuration file by
4622 using this syntax:
4623 .display
4624 &`.include`& <&'file name'&>
4625 &`.include_if_exists`& <&'file name'&>
4626 .endd
4627 on a line by itself. Double quotes round the file name are optional. If you use
4628 the first form, a configuration error occurs if the file does not exist; the
4629 second form does nothing for non-existent files. In all cases, an absolute file
4630 name is required.
4631
4632 Includes may be nested to any depth, but remember that Exim reads its
4633 configuration file often, so it is a good idea to keep them to a minimum.
4634 If you change the contents of an included file, you must HUP the daemon,
4635 because an included file is read only when the configuration itself is read.
4636
4637 The processing of inclusions happens early, at a physical line level, so, like
4638 comment lines, an inclusion can be used in the middle of an option setting,
4639 for example:
4640 .code
4641 hosts_lookup = a.b.c \
4642                .include /some/file
4643 .endd
4644 Include processing happens after macro processing (see below). Its effect is to
4645 process the lines of the included file as if they occurred inline where the
4646 inclusion appears.
4647
4648
4649
4650 .section "Macros in the configuration file" "SECTmacrodefs"
4651 .cindex "macro" "description of"
4652 .cindex "configuration file" "macros"
4653 If a line in the main part of the configuration (that is, before the first
4654 &"begin"& line) begins with an upper case letter, it is taken as a macro
4655 definition, and must be of the form
4656 .display
4657 <&'name'&> = <&'rest of line'&>
4658 .endd
4659 The name must consist of letters, digits, and underscores, and need not all be
4660 in upper case, though that is recommended. The rest of the line, including any
4661 continuations, is the replacement text, and has leading and trailing white
4662 space removed. Quotes are not removed. The replacement text can never end with
4663 a backslash character, but this doesn't seem to be a serious limitation.
4664
4665 Macros may also be defined between router, transport, authenticator, or ACL
4666 definitions. They may not, however, be defined within an individual driver or
4667 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
4668
4669 .section "Macro substitution" "SECID42"
4670 Once a macro is defined, all subsequent lines in the file (and any included
4671 files) are scanned for the macro name; if there are several macros, the line is
4672 scanned for each in turn, in the order in which the macros are defined. The
4673 replacement text is not re-scanned for the current macro, though it is scanned
4674 for subsequently defined macros. For this reason, a macro name may not contain
4675 the name of a previously defined macro as a substring. You could, for example,
4676 define
4677 .display
4678 &`ABCD_XYZ = `&<&'something'&>
4679 &`ABCD = `&<&'something else'&>
4680 .endd
4681 but putting the definitions in the opposite order would provoke a configuration
4682 error. Macro expansion is applied to individual physical lines from the file,
4683 before checking for line continuation or file inclusion (see above). If a line
4684 consists solely of a macro name, and the expansion of the macro is empty, the
4685 line is ignored. A macro at the start of a line may turn the line into a
4686 comment line or a &`.include`& line.
4687
4688
4689 .section "Redefining macros" "SECID43"
4690 Once defined, the value of a macro can be redefined later in the configuration
4691 (or in an included file). Redefinition is specified by using &'=='& instead of
4692 &'='&. For example:
4693 .code
4694 MAC =  initial value
4695 ...
4696 MAC == updated value
4697 .endd
4698 Redefinition does not alter the order in which the macros are applied to the
4699 subsequent lines of the configuration file. It is still the same order in which
4700 the macros were originally defined. All that changes is the macro's value.
4701 Redefinition makes it possible to accumulate values. For example:
4702 .code
4703 MAC =  initial value
4704 ...
4705 MAC == MAC and something added
4706 .endd
4707 This can be helpful in situations where the configuration file is built
4708 from a number of other files.
4709
4710 .section "Overriding macro values" "SECID44"
4711 The values set for macros in the configuration file can be overridden by the
4712 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
4713 used, unless called by root or the Exim user. A definition on the command line
4714 using the &%-D%& option causes all definitions and redefinitions within the
4715 file to be ignored.
4716
4717
4718
4719 .section "Example of macro usage" "SECID45"
4720 As an example of macro usage, consider a configuration where aliases are looked
4721 up in a MySQL database. It helps to keep the file less cluttered if long
4722 strings such as SQL statements are defined separately as macros, for example:
4723 .code
4724 ALIAS_QUERY = select mailbox from user where \
4725               login='${quote_mysql:$local_part}';
4726 .endd
4727 This can then be used in a &(redirect)& router setting like this:
4728 .code
4729 data = ${lookup mysql{ALIAS_QUERY}}
4730 .endd
4731 In earlier versions of Exim macros were sometimes used for domain, host, or
4732 address lists. In Exim 4 these are handled better by named lists &-- see
4733 section &<<SECTnamedlists>>&.
4734
4735
4736 .section "Conditional skips in the configuration file" "SECID46"
4737 .cindex "configuration file" "conditional skips"
4738 .cindex "&`.ifdef`&"
4739 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
4740 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
4741 portions of the configuration file. The processing happens whenever the file is
4742 read (that is, when an Exim binary starts to run).
4743
4744 The implementation is very simple. Instances of the first four directives must
4745 be followed by text that includes the names of one or macros. The condition
4746 that is tested is whether or not any macro substitution has taken place in the
4747 line. Thus:
4748 .code
4749 .ifdef AAA
4750 message_size_limit = 50M
4751 .else
4752 message_size_limit = 100M
4753 .endif
4754 .endd
4755 sets a message size limit of 50M if the macro &`AAA`& is defined, and 100M
4756 otherwise. If there is more than one macro named on the line, the condition
4757 is true if any of them are defined. That is, it is an &"or"& condition. To
4758 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
4759
4760 Although you can use a macro expansion to generate one of these directives,
4761 it is not very useful, because the condition &"there was a macro substitution
4762 in this line"& will always be true.
4763
4764 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
4765 to clarify complicated nestings.
4766
4767
4768
4769 .section "Common option syntax" "SECTcos"
4770 .cindex "common option syntax"
4771 .cindex "syntax of common options"
4772 .cindex "configuration file" "common option syntax"
4773 For the main set of options, driver options, and &[local_scan()]& options,
4774 each setting is on a line by itself, and starts with a name consisting of
4775 lower-case letters and underscores. Many options require a data value, and in
4776 these cases the name must be followed by an equals sign (with optional white
4777 space) and then the value. For example:
4778 .code
4779 qualify_domain = mydomain.example.com
4780 .endd
4781 .cindex "hiding configuration option values"
4782 .cindex "configuration options" "hiding value of"
4783 .cindex "options" "hiding value of"
4784 Some option settings may contain sensitive data, for example, passwords for
4785 accessing databases. To stop non-admin users from using the &%-bP%& command
4786 line option to read these values, you can precede the option settings with the
4787 word &"hide"&. For example:
4788 .code
4789 hide mysql_servers = localhost/users/admin/secret-password
4790 .endd
4791 For non-admin users, such options are displayed like this:
4792 .code
4793 mysql_servers = <value not displayable>
4794 .endd
4795 If &"hide"& is used on a driver option, it hides the value of that option on
4796 all instances of the same driver.
4797
4798 The following sections describe the syntax used for the different data types
4799 that are found in option settings.
4800
4801
4802 .section "Boolean options" "SECID47"
4803 .cindex "format" "boolean"
4804 .cindex "boolean configuration values"
4805 .oindex "&%no_%&&'xxx'&"
4806 .oindex "&%not_%&&'xxx'&"
4807 Options whose type is given as boolean are on/off switches. There are two
4808 different ways of specifying such options: with and without a data value. If
4809 the option name is specified on its own without data, the switch is turned on;
4810 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
4811 boolean options may be followed by an equals sign and one of the words
4812 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
4813 the following two settings have exactly the same effect:
4814 .code
4815 queue_only
4816 queue_only = true
4817 .endd
4818 The following two lines also have the same (opposite) effect:
4819 .code
4820 no_queue_only
4821 queue_only = false
4822 .endd
4823 You can use whichever syntax you prefer.
4824
4825
4826
4827
4828 .section "Integer values" "SECID48"
4829 .cindex "integer configuration values"
4830 .cindex "format" "integer"
4831 If an option's type is given as &"integer"&, the value can be given in decimal,
4832 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
4833 number is assumed. Otherwise, it is treated as an octal number unless it starts
4834 with the characters &"0x"&, in which case the remainder is interpreted as a
4835 hexadecimal number.
4836
4837 If an integer value is followed by the letter K, it is multiplied by 1024; if
4838 it is followed by the letter M, it is multiplied by 1024x1024. When the values
4839 of integer option settings are output, values which are an exact multiple of
4840 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
4841 and M. The printing style is independent of the actual input format that was
4842 used.
4843
4844
4845 .section "Octal integer values" "SECID49"
4846 .cindex "integer format"
4847 .cindex "format" "octal integer"
4848 If an option's type is given as &"octal integer"&, its value is always
4849 interpreted as an octal number, whether or not it starts with the digit zero.
4850 Such options are always output in octal.
4851
4852
4853 .section "Fixed point numbers" "SECID50"
4854 .cindex "fixed point configuration values"
4855 .cindex "format" "fixed point"
4856 If an option's type is given as &"fixed-point"&, its value must be a decimal
4857 integer, optionally followed by a decimal point and up to three further digits.
4858
4859
4860
4861 .section "Time intervals" "SECTtimeformat"
4862 .cindex "time interval" "specifying in configuration"
4863 .cindex "format" "time interval"
4864 A time interval is specified as a sequence of numbers, each followed by one of
4865 the following letters, with no intervening white space:
4866
4867 .table2 30pt
4868 .irow &%s%& seconds
4869 .irow &%m%& minutes
4870 .irow &%h%& hours
4871 .irow &%d%& days
4872 .irow &%w%& weeks
4873 .endtable
4874
4875 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
4876 intervals are output in the same format. Exim does not restrict the values; it
4877 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
4878
4879
4880
4881 .section "String values" "SECTstrings"
4882 .cindex "string" "format of configuration values"
4883 .cindex "format" "string"
4884 If an option's type is specified as &"string"&, the value can be specified with
4885 or without double-quotes. If it does not start with a double-quote, the value
4886 consists of the remainder of the line plus any continuation lines, starting at
4887 the first character after any leading white space, with trailing white space
4888 removed, and with no interpretation of the characters in the string. Because
4889 Exim removes comment lines (those beginning with #) at an early stage, they can
4890 appear in the middle of a multi-line string. The following two settings are
4891 therefore equivalent:
4892 .code
4893 trusted_users = uucp:mail
4894 trusted_users = uucp:\
4895                 # This comment line is ignored
4896                 mail
4897 .endd
4898 .cindex "string" "quoted"
4899 .cindex "escape characters in quoted strings"
4900 If a string does start with a double-quote, it must end with a closing
4901 double-quote, and any backslash characters other than those used for line
4902 continuation are interpreted as escape characters, as follows:
4903
4904 .table2 100pt
4905 .irow &`\\`&                     "single backslash"
4906 .irow &`\n`&                     "newline"
4907 .irow &`\r`&                     "carriage return"
4908 .irow &`\t`&                     "tab"
4909 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
4910 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
4911                                    character"
4912 .endtable
4913
4914 If a backslash is followed by some other character, including a double-quote
4915 character, that character replaces the pair.
4916
4917 Quoting is necessary only if you want to make use of the backslash escapes to
4918 insert special characters, or if you need to specify a value with leading or
4919 trailing spaces. These cases are rare, so quoting is almost never needed in
4920 current versions of Exim. In versions of Exim before 3.14, quoting was required
4921 in order to continue lines, so you may come across older configuration files
4922 and examples that apparently quote unnecessarily.
4923
4924
4925 .section "Expanded strings" "SECID51"
4926 .cindex "expansion" "definition of"
4927 Some strings in the configuration file are subjected to &'string expansion'&,
4928 by which means various parts of the string may be changed according to the
4929 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
4930 is as just described; in particular, the handling of backslashes in quoted
4931 strings is done as part of the input process, before expansion takes place.
4932 However, backslash is also an escape character for the expander, so any
4933 backslashes that are required for that reason must be doubled if they are
4934 within a quoted configuration string.
4935
4936
4937 .section "User and group names" "SECID52"
4938 .cindex "user name" "format of"
4939 .cindex "format" "user name"
4940 .cindex "groups" "name format"
4941 .cindex "format" "group name"
4942 User and group names are specified as strings, using the syntax described
4943 above, but the strings are interpreted specially. A user or group name must
4944 either consist entirely of digits, or be a name that can be looked up using the
4945 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
4946
4947
4948 .section "List construction" "SECTlistconstruct"
4949 .cindex "list" "syntax of in configuration"
4950 .cindex "format" "list item in configuration"
4951 .cindex "string" "list, definition of"
4952 The data for some configuration options is a list of items, with colon as the
4953 default separator. Many of these options are shown with type &"string list"& in
4954 the descriptions later in this document. Others are listed as &"domain list"&,
4955 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
4956 are all the same; however, those other than &"string list"& are subject to
4957 particular kinds of interpretation, as described in chapter
4958 &<<CHAPdomhosaddlists>>&.
4959
4960 In all these cases, the entire list is treated as a single string as far as the
4961 input syntax is concerned. The &%trusted_users%& setting in section
4962 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
4963 in a list, it must be entered as two colons. Leading and trailing white space
4964 on each item in a list is ignored. This makes it possible to include items that
4965 start with a colon, and in particular, certain forms of IPv6 address. For
4966 example, the list
4967 .code
4968 local_interfaces = 127.0.0.1 : ::::1
4969 .endd
4970 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
4971
4972 &*Note*&: Although leading and trailing white space is ignored in individual
4973 list items, it is not ignored when parsing the list. The space after the first
4974 colon in the example above is necessary. If it were not there, the list would
4975 be interpreted as the two items 127.0.0.1:: and 1.
4976
4977 .section "Changing list separators" "SECID53"
4978 .cindex "list separator" "changing"
4979 .cindex "IPv6" "addresses in lists"
4980 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
4981 introduced to allow the separator character to be changed. If a list begins
4982 with a left angle bracket, followed by any punctuation character, that
4983 character is used instead of colon as the list separator. For example, the list
4984 above can be rewritten to use a semicolon separator like this:
4985 .code
4986 local_interfaces = <; 127.0.0.1 ; ::1
4987 .endd
4988 This facility applies to all lists, with the exception of the list in
4989 &%log_file_path%&. It is recommended that the use of non-colon separators be
4990 confined to circumstances where they really are needed.
4991
4992 .cindex "list separator" "newline as"
4993 .cindex "newline" "as list separator"
4994 It is also possible to use newline and other control characters (those with
4995 code values less than 32, plus DEL) as separators in lists. Such separators
4996 must be provided literally at the time the list is processed. For options that
4997 are string-expanded, you can write the separator using a normal escape
4998 sequence. This will be processed by the expander before the string is
4999 interpreted as a list. For example, if a newline-separated list of domains is
5000 generated by a lookup, you can process it directly by a line such as this:
5001 .code
5002 domains = <\n ${lookup mysql{.....}}
5003 .endd
5004 This avoids having to change the list separator in such data. You are unlikely
5005 to want to use a control character as a separator in an option that is not
5006 expanded, because the value is literal text. However, it can be done by giving
5007 the value in quotes. For example:
5008 .code
5009 local_interfaces = "<\n 127.0.0.1 \n ::1"
5010 .endd
5011 Unlike printing character separators, which can be included in list items by
5012 doubling, it is not possible to include a control character as data when it is
5013 set as the separator. Two such characters in succession are interpreted as
5014 enclosing an empty list item.
5015
5016
5017
5018 .section "Empty items in lists" "SECTempitelis"
5019 .cindex "list" "empty item in"
5020 An empty item at the end of a list is always ignored. In other words, trailing
5021 separator characters are ignored. Thus, the list in
5022 .code
5023 senders = user@domain :
5024 .endd
5025 contains only a single item. If you want to include an empty string as one item
5026 in a list, it must not be the last item. For example, this list contains three
5027 items, the second of which is empty:
5028 .code
5029 senders = user1@domain : : user2@domain
5030 .endd
5031 &*Note*&: There must be white space between the two colons, as otherwise they
5032 are interpreted as representing a single colon data character (and the list
5033 would then contain just one item). If you want to specify a list that contains
5034 just one, empty item, you can do it as in this example:
5035 .code
5036 senders = :
5037 .endd
5038 In this case, the first item is empty, and the second is discarded because it
5039 is at the end of the list.
5040
5041
5042
5043
5044 .section "Format of driver configurations" "SECTfordricon"
5045 .cindex "drivers" "configuration format"
5046 There are separate parts in the configuration for defining routers, transports,
5047 and authenticators. In each part, you are defining a number of driver
5048 instances, each with its own set of options. Each driver instance is defined by
5049 a sequence of lines like this:
5050 .display
5051 <&'instance name'&>:
5052   <&'option'&>
5053   ...
5054   <&'option'&>
5055 .endd
5056 In the following example, the instance name is &(localuser)&, and it is
5057 followed by three options settings:
5058 .code
5059 localuser:
5060   driver = accept
5061   check_local_user
5062   transport = local_delivery
5063 .endd
5064 For each driver instance, you specify which Exim code module it uses &-- by the
5065 setting of the &%driver%& option &-- and (optionally) some configuration
5066 settings. For example, in the case of transports, if you want a transport to
5067 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5068 a local file you would use the &(appendfile)& driver. Each of the drivers is
5069 described in detail in its own separate chapter later in this manual.
5070
5071 You can have several routers, transports, or authenticators that are based on
5072 the same underlying driver (each must have a different instance name).
5073
5074 The order in which routers are defined is important, because addresses are
5075 passed to individual routers one by one, in order. The order in which
5076 transports are defined does not matter at all. The order in which
5077 authenticators are defined is used only when Exim, as a client, is searching
5078 them to find one that matches an authentication mechanism offered by the
5079 server.
5080
5081 .cindex "generic options"
5082 .cindex "options" "generic &-- definition of"
5083 Within a driver instance definition, there are two kinds of option: &'generic'&
5084 and &'private'&. The generic options are those that apply to all drivers of the
5085 same type (that is, all routers, all transports or all authenticators). The
5086 &%driver%& option is a generic option that must appear in every definition.
5087 .cindex "private options"
5088 The private options are special for each driver, and none need appear, because
5089 they all have default values.
5090
5091 The options may appear in any order, except that the &%driver%& option must
5092 precede any private options, since these depend on the particular driver. For
5093 this reason, it is recommended that &%driver%& always be the first option.
5094
5095 Driver instance names, which are used for reference in log entries and
5096 elsewhere, can be any sequence of letters, digits, and underscores (starting
5097 with a letter) and must be unique among drivers of the same type. A router and
5098 a transport (for example) can each have the same name, but no two router
5099 instances can have the same name. The name of a driver instance should not be
5100 confused with the name of the underlying driver module. For example, the
5101 configuration lines:
5102 .code
5103 remote_smtp:
5104   driver = smtp
5105 .endd
5106 create an instance of the &(smtp)& transport driver whose name is
5107 &(remote_smtp)&. The same driver code can be used more than once, with
5108 different instance names and different option settings each time. A second
5109 instance of the &(smtp)& transport, with different options, might be defined
5110 thus:
5111 .code
5112 special_smtp:
5113   driver = smtp
5114   port = 1234
5115   command_timeout = 10s
5116 .endd
5117 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5118 these transport instances from routers, and these names would appear in log
5119 lines.
5120
5121 Comment lines may be present in the middle of driver specifications. The full
5122 list of option settings for any particular driver instance, including all the
5123 defaulted values, can be extracted by making use of the &%-bP%& command line
5124 option.
5125
5126
5127
5128
5129
5130
5131 . ////////////////////////////////////////////////////////////////////////////
5132 . ////////////////////////////////////////////////////////////////////////////
5133
5134 .chapter "The default configuration file" "CHAPdefconfil"
5135 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5136 .cindex "default" "configuration file &""walk through""&"
5137 The default configuration file supplied with Exim as &_src/configure.default_&
5138 is sufficient for a host with simple mail requirements. As an introduction to
5139 the way Exim is configured, this chapter &"walks through"& the default
5140 configuration, giving brief explanations of the settings. Detailed descriptions
5141 of the options are given in subsequent chapters. The default configuration file
5142 itself contains extensive comments about ways you might want to modify the
5143 initial settings. However, note that there are many options that are not
5144 mentioned at all in the default configuration.
5145
5146
5147
5148 .section "Main configuration settings" "SECTdefconfmain"
5149 The main (global) configuration option settings must always come first in the
5150 file. The first thing you'll see in the file, after some initial comments, is
5151 the line
5152 .code
5153 # primary_hostname =
5154 .endd
5155 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5156 to know the official, fully qualified name of your host, and this is where you
5157 can specify it. However, in most cases you do not need to set this option. When
5158 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5159
5160 The first three non-comment configuration lines are as follows:
5161 .code
5162 domainlist local_domains = @
5163 domainlist relay_to_domains =
5164 hostlist   relay_from_hosts = 127.0.0.1
5165 .endd
5166 These are not, in fact, option settings. They are definitions of two named
5167 domain lists and one named host list. Exim allows you to give names to lists of
5168 domains, hosts, and email addresses, in order to make it easier to manage the
5169 configuration file (see section &<<SECTnamedlists>>&).
5170
5171 The first line defines a domain list called &'local_domains'&; this is used
5172 later in the configuration to identify domains that are to be delivered
5173 on the local host.
5174
5175 .cindex "@ in a domain list"
5176 There is just one item in this list, the string &"@"&. This is a special form
5177 of entry which means &"the name of the local host"&. Thus, if the local host is
5178 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5179 be delivered locally. Because the local host's name is referenced indirectly,
5180 the same configuration file can be used on different hosts.
5181
5182 The second line defines a domain list called &'relay_to_domains'&, but the
5183 list itself is empty. Later in the configuration we will come to the part that
5184 controls mail relaying through the local host; it allows relaying to any
5185 domains in this list. By default, therefore, no relaying on the basis of a mail
5186 domain is permitted.
5187
5188 The third line defines a host list called &'relay_from_hosts'&. This list is
5189 used later in the configuration to permit relaying from any host or IP address
5190 that matches the list. The default contains just the IP address of the IPv4
5191 loopback interface, which means that processes on the local host are able to
5192 submit mail for relaying by sending it over TCP/IP to that interface. No other
5193 hosts are permitted to submit messages for relaying.
5194
5195 Just to be sure there's no misunderstanding: at this point in the configuration
5196 we aren't actually setting up any controls. We are just defining some domains
5197 and hosts that will be used in the controls that are specified later.
5198
5199 The next two configuration lines are genuine option settings:
5200 .code
5201 acl_smtp_rcpt = acl_check_rcpt
5202 acl_smtp_data = acl_check_data
5203 .endd
5204 These options specify &'Access Control Lists'& (ACLs) that are to be used
5205 during an incoming SMTP session for every recipient of a message (every RCPT
5206 command), and after the contents of the message have been received,
5207 respectively. The names of the lists are &'acl_check_rcpt'& and
5208 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5209 section of the configuration. The RCPT ACL controls which recipients are
5210 accepted for an incoming message &-- if a configuration does not provide an ACL
5211 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5212 contents of a message to be checked.
5213
5214 Two commented-out option settings are next:
5215 .code
5216 # av_scanner = clamd:/tmp/clamd
5217 # spamd_address = 127.0.0.1 783
5218 .endd
5219 These are example settings that can be used when Exim is compiled with the
5220 content-scanning extension. The first specifies the interface to the virus
5221 scanner, and the second specifies the interface to SpamAssassin. Further
5222 details are given in chapter &<<CHAPexiscan>>&.
5223
5224 Three more commented-out option settings follow:
5225 .code
5226 # tls_advertise_hosts = *
5227 # tls_certificate = /etc/ssl/exim.crt
5228 # tls_privatekey = /etc/ssl/exim.pem
5229 .endd
5230 These are example settings that can be used when Exim is compiled with
5231 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5232 first one specifies the list of clients that are allowed to use TLS when
5233 connecting to this server; in this case the wildcard means all clients. The
5234 other options specify where Exim should find its TLS certificate and private
5235 key, which together prove the server's identity to any clients that connect.
5236 More details are given in chapter &<<CHAPTLS>>&.
5237
5238 Another two commented-out option settings follow:
5239 .code
5240 # daemon_smtp_ports = 25 : 465 : 587
5241 # tls_on_connect_ports = 465
5242 .endd
5243 .cindex "port" "465 and 587"
5244 .cindex "port" "for message submission"
5245 .cindex "message" "submission, ports for"
5246 .cindex "ssmtp protocol"
5247 .cindex "smtps protocol"
5248 .cindex "SMTP" "ssmtp protocol"
5249 .cindex "SMTP" "smtps protocol"
5250 These options provide better support for roaming users who wish to use this
5251 server for message submission. They are not much use unless you have turned on
5252 TLS (as described in the previous paragraph) and authentication (about which
5253 more in section &<<SECTdefconfauth>>&). The usual SMTP port 25 is often blocked
5254 on end-user networks, so RFC 4409 specifies that message submission should use
5255 port 587 instead. However some software (notably Microsoft Outlook) cannot be
5256 configured to use port 587 correctly, so these settings also enable the
5257 non-standard &"smtps"& (aka &"ssmtp"&) port 465 (see section
5258 &<<SECTsupobssmt>>&).
5259
5260 Two more commented-out options settings follow:
5261 .code
5262 # qualify_domain =
5263 # qualify_recipient =
5264 .endd
5265 The first of these specifies a domain that Exim uses when it constructs a
5266 complete email address from a local login name. This is often needed when Exim
5267 receives a message from a local process. If you do not set &%qualify_domain%&,
5268 the value of &%primary_hostname%& is used. If you set both of these options,
5269 you can have different qualification domains for sender and recipient
5270 addresses. If you set only the first one, its value is used in both cases.
5271
5272 .cindex "domain literal" "recognizing format"
5273 The following line must be uncommented if you want Exim to recognize
5274 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5275 (an IP address within square brackets) instead of a named domain.
5276 .code
5277 # allow_domain_literals
5278 .endd
5279 The RFCs still require this form, but many people think that in the modern
5280 Internet it makes little sense to permit mail to be sent to specific hosts by
5281 quoting their IP addresses. This ancient format has been used by people who
5282 try to abuse hosts by using them for unwanted relaying. However, some
5283 people believe there are circumstances (for example, messages addressed to
5284 &'postmaster'&) where domain literals are still useful.
5285
5286 The next configuration line is a kind of trigger guard:
5287 .code
5288 never_users = root
5289 .endd
5290 It specifies that no delivery must ever be run as the root user. The normal
5291 convention is to set up &'root'& as an alias for the system administrator. This
5292 setting is a guard against slips in the configuration.
5293 The list of users specified by &%never_users%& is not, however, the complete
5294 list; the build-time configuration in &_Local/Makefile_& has an option called
5295 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5296 contents of &%never_users%& are added to this list. By default
5297 FIXED_NEVER_USERS also specifies root.
5298
5299 When a remote host connects to Exim in order to send mail, the only information
5300 Exim has about the host's identity is its IP address. The next configuration
5301 line,
5302 .code
5303 host_lookup = *
5304 .endd
5305 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5306 in order to get a host name. This improves the quality of the logging
5307 information, but if you feel it is too expensive, you can remove it entirely,
5308 or restrict the lookup to hosts on &"nearby"& networks.
5309 Note that it is not always possible to find a host name from an IP address,
5310 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5311 unreachable.
5312
5313 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5314 1413 (hence their names):
5315 .code
5316 rfc1413_hosts = *
5317 rfc1413_query_timeout = 5s
5318 .endd
5319 These settings cause Exim to make ident callbacks for all incoming SMTP calls.
5320 You can limit the hosts to which these calls are made, or change the timeout
5321 that is used. If you set the timeout to zero, all ident calls are disabled.
5322 Although they are cheap and can provide useful information for tracing problem
5323 messages, some hosts and firewalls have problems with ident calls. This can
5324 result in a timeout instead of an immediate refused connection, leading to
5325 delays on starting up an incoming SMTP session.
5326
5327 When Exim receives messages over SMTP connections, it expects all addresses to
5328 be fully qualified with a domain, as required by the SMTP definition. However,
5329 if you are running a server to which simple clients submit messages, you may
5330 find that they send unqualified addresses. The two commented-out options:
5331 .code
5332 # sender_unqualified_hosts =
5333 # recipient_unqualified_hosts =
5334 .endd
5335 show how you can specify hosts that are permitted to send unqualified sender
5336 and recipient addresses, respectively.
5337
5338 The &%percent_hack_domains%& option is also commented out:
5339 .code
5340 # percent_hack_domains =
5341 .endd
5342 It provides a list of domains for which the &"percent hack"& is to operate.
5343 This is an almost obsolete form of explicit email routing. If you do not know
5344 anything about it, you can safely ignore this topic.
5345
5346 The last two settings in the main part of the default configuration are
5347 concerned with messages that have been &"frozen"& on Exim's queue. When a
5348 message is frozen, Exim no longer continues to try to deliver it. Freezing
5349 occurs when a bounce message encounters a permanent failure because the sender
5350 address of the original message that caused the bounce is invalid, so the
5351 bounce cannot be delivered. This is probably the most common case, but there
5352 are also other conditions that cause freezing, and frozen messages are not
5353 always bounce messages.
5354 .code
5355 ignore_bounce_errors_after = 2d
5356 timeout_frozen_after = 7d
5357 .endd
5358 The first of these options specifies that failing bounce messages are to be
5359 discarded after 2 days on the queue. The second specifies that any frozen
5360 message (whether a bounce message or not) is to be timed out (and discarded)
5361 after a week. In this configuration, the first setting ensures that no failing
5362 bounce message ever lasts a week.
5363
5364
5365
5366 .section "ACL configuration" "SECID54"
5367 .cindex "default" "ACLs"
5368 .cindex "&ACL;" "default configuration"
5369 In the default configuration, the ACL section follows the main configuration.
5370 It starts with the line
5371 .code
5372 begin acl
5373 .endd
5374 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5375 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5376 and &%acl_smtp_data%& above.
5377
5378 .cindex "RCPT" "ACL for"
5379 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5380 RCPT command specifies one of the message's recipients. The ACL statements
5381 are considered in order, until the recipient address is either accepted or
5382 rejected. The RCPT command is then accepted or rejected, according to the
5383 result of the ACL processing.
5384 .code
5385 acl_check_rcpt:
5386 .endd
5387 This line, consisting of a name terminated by a colon, marks the start of the
5388 ACL, and names it.
5389 .code
5390 accept  hosts = :
5391 .endd
5392 This ACL statement accepts the recipient if the sending host matches the list.
5393 But what does that strange list mean? It doesn't actually contain any host
5394 names or IP addresses. The presence of the colon puts an empty item in the
5395 list; Exim matches this only if the incoming message did not come from a remote
5396 host, because in that case, the remote hostname is empty. The colon is
5397 important. Without it, the list itself is empty, and can never match anything.
5398
5399 What this statement is doing is to accept unconditionally all recipients in
5400 messages that are submitted by SMTP from local processes using the standard
5401 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5402 manner.
5403 .code
5404 deny    message       = Restricted characters in address
5405         domains       = +local_domains
5406         local_parts   = ^[.] : ^.*[@%!/|]
5407
5408 deny    message       = Restricted characters in address
5409         domains       = !+local_domains
5410         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5411 .endd
5412 These statements are concerned with local parts that contain any of the
5413 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5414 Although these characters are entirely legal in local parts (in the case of
5415 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5416 in Internet mail addresses.
5417
5418 The first three have in the past been associated with explicitly routed
5419 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5420 option). Addresses containing these characters are regularly tried by spammers
5421 in an attempt to bypass relaying restrictions, and also by open relay testing
5422 programs. Unless you really need them it is safest to reject these characters
5423 at this early stage. This configuration is heavy-handed in rejecting these
5424 characters for all messages it accepts from remote hosts. This is a deliberate
5425 policy of being as safe as possible.
5426
5427 The first rule above is stricter, and is applied to messages that are addressed
5428 to one of the local domains handled by this host. This is implemented by the
5429 first condition, which restricts it to domains that are listed in the
5430 &'local_domains'& domain list. The &"+"& character is used to indicate a
5431 reference to a named list. In this configuration, there is just one domain in
5432 &'local_domains'&, but in general there may be many.
5433
5434 The second condition on the first statement uses two regular expressions to
5435 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5436 or &"|"&. If you have local accounts that include these characters, you will
5437 have to modify this rule.
5438
5439 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5440 allows them because they have been encountered in practice. (Consider the
5441 common convention of local parts constructed as
5442 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5443 the author of Exim, who has no second initial.) However, a local part starting
5444 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5445 file name (for example, for a mailing list). This is also true for local parts
5446 that contain slashes. A pipe symbol can also be troublesome if the local part
5447 is incorporated unthinkingly into a shell command line.
5448
5449 The second rule above applies to all other domains, and is less strict. This
5450 allows your own users to send outgoing messages to sites that use slashes
5451 and vertical bars in their local parts. It blocks local parts that begin
5452 with a dot, slash, or vertical bar, but allows these characters within the
5453 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5454 and &"!"& is blocked, as before. The motivation here is to prevent your users
5455 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5456 .code
5457 accept  local_parts   = postmaster
5458         domains       = +local_domains
5459 .endd
5460 This statement, which has two conditions, accepts an incoming address if the
5461 local part is &'postmaster'& and the domain is one of those listed in the
5462 &'local_domains'& domain list. The &"+"& character is used to indicate a
5463 reference to a named list. In this configuration, there is just one domain in
5464 &'local_domains'&, but in general there may be many.
5465
5466 The presence of this statement means that mail to postmaster is never blocked
5467 by any of the subsequent tests. This can be helpful while sorting out problems
5468 in cases where the subsequent tests are incorrectly denying access.
5469 .code
5470 require verify        = sender
5471 .endd
5472 This statement requires the sender address to be verified before any subsequent
5473 ACL statement can be used. If verification fails, the incoming recipient
5474 address is refused. Verification consists of trying to route the address, to
5475 see if a bounce message could be delivered to it. In the case of remote
5476 addresses, basic verification checks only the domain, but &'callouts'& can be
5477 used for more verification if required. Section &<<SECTaddressverification>>&
5478 discusses the details of address verification.
5479 .code
5480 accept  hosts         = +relay_from_hosts
5481         control       = submission
5482 .endd
5483 This statement accepts the address if the message is coming from one of the
5484 hosts that are defined as being allowed to relay through this host. Recipient
5485 verification is omitted here, because in many cases the clients are dumb MUAs
5486 that do not cope well with SMTP error responses. For the same reason, the
5487 second line specifies &"submission mode"& for messages that are accepted. This
5488 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5489 messages that are deficient in some way, for example, because they lack a
5490 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5491 probably add recipient verification here, and disable submission mode.
5492 .code
5493 accept  authenticated = *
5494         control       = submission
5495 .endd
5496 This statement accepts the address if the client host has authenticated itself.
5497 Submission mode is again specified, on the grounds that such messages are most
5498 likely to come from MUAs. The default configuration does not define any
5499 authenticators, though it does include some nearly complete commented-out
5500 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5501 fact authenticate until you complete the authenticator definitions.
5502 .code
5503 require message = relay not permitted
5504         domains = +local_domains : +relay_domains
5505 .endd
5506 This statement rejects the address if its domain is neither a local domain nor
5507 one of the domains for which this host is a relay.
5508 .code
5509 require verify = recipient
5510 .endd
5511 This statement requires the recipient address to be verified; if verification
5512 fails, the address is rejected.
5513 .code
5514 # deny    message     = rejected because $sender_host_address \
5515 #                       is in a black list at $dnslist_domain\n\
5516 #                       $dnslist_text
5517 #         dnslists    = black.list.example
5518 #
5519 # warn    dnslists    = black.list.example
5520 #         add_header  = X-Warning: $sender_host_address is in \
5521 #                       a black list at $dnslist_domain
5522 #         log_message = found in $dnslist_domain
5523 .endd
5524 These commented-out lines are examples of how you could configure Exim to check
5525 sending hosts against a DNS black list. The first statement rejects messages
5526 from blacklisted hosts, whereas the second just inserts a warning header
5527 line.
5528 .code
5529 # require verify = csa
5530 .endd
5531 This commented-out line is an example of how you could turn on client SMTP
5532 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5533 records.
5534 .code
5535 accept
5536 .endd
5537 The final statement in the first ACL unconditionally accepts any recipient
5538 address that has successfully passed all the previous tests.
5539 .code
5540 acl_check_data:
5541 .endd
5542 This line marks the start of the second ACL, and names it. Most of the contents
5543 of this ACL are commented out:
5544 .code
5545 # deny    malware   = *
5546 #         message   = This message contains a virus \
5547 #                     ($malware_name).
5548 .endd
5549 These lines are examples of how to arrange for messages to be scanned for
5550 viruses when Exim has been compiled with the content-scanning extension, and a
5551 suitable virus scanner is installed. If the message is found to contain a
5552 virus, it is rejected with the given custom error message.
5553 .code
5554 # warn    spam      = nobody
5555 #         message   = X-Spam_score: $spam_score\n\
5556 #                     X-Spam_score_int: $spam_score_int\n\
5557 #                     X-Spam_bar: $spam_bar\n\
5558 #                     X-Spam_report: $spam_report
5559 .endd
5560 These lines are an example of how to arrange for messages to be scanned by
5561 SpamAssassin when Exim has been compiled with the content-scanning extension,
5562 and SpamAssassin has been installed. The SpamAssassin check is run with
5563 &`nobody`& as its user parameter, and the results are added to the message as a
5564 series of extra header line. In this case, the message is not rejected,
5565 whatever the spam score.
5566 .code
5567 accept
5568 .endd
5569 This final line in the DATA ACL accepts the message unconditionally.
5570
5571
5572 .section "Router configuration" "SECID55"
5573 .cindex "default" "routers"
5574 .cindex "routers" "default"
5575 The router configuration comes next in the default configuration, introduced
5576 by the line
5577 .code
5578 begin routers
5579 .endd
5580 Routers are the modules in Exim that make decisions about where to send
5581 messages. An address is passed to each router in turn, until it is either
5582 accepted, or failed. This means that the order in which you define the routers
5583 matters. Each router is fully described in its own chapter later in this
5584 manual. Here we give only brief overviews.
5585 .code
5586 # domain_literal:
5587 #   driver = ipliteral
5588 #   domains = !+local_domains
5589 #   transport = remote_smtp
5590 .endd
5591 .cindex "domain literal" "default router"
5592 This router is commented out because the majority of sites do not want to
5593 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
5594 you uncomment this router, you also need to uncomment the setting of
5595 &%allow_domain_literals%& in the main part of the configuration.
5596 .code
5597 dnslookup:
5598   driver = dnslookup
5599   domains = ! +local_domains
5600   transport = remote_smtp
5601   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
5602   no_more
5603 .endd
5604 The first uncommented router handles addresses that do not involve any local
5605 domains. This is specified by the line
5606 .code
5607 domains = ! +local_domains
5608 .endd
5609 The &%domains%& option lists the domains to which this router applies, but the
5610 exclamation mark is a negation sign, so the router is used only for domains
5611 that are not in the domain list called &'local_domains'& (which was defined at
5612 the start of the configuration). The plus sign before &'local_domains'&
5613 indicates that it is referring to a named list. Addresses in other domains are
5614 passed on to the following routers.
5615
5616 The name of the router driver is &(dnslookup)&,
5617 and is specified by the &%driver%& option. Do not be confused by the fact that
5618 the name of this router instance is the same as the name of the driver. The
5619 instance name is arbitrary, but the name set in the &%driver%& option must be
5620 one of the driver modules that is in the Exim binary.
5621
5622 The &(dnslookup)& router routes addresses by looking up their domains in the
5623 DNS in order to obtain a list of hosts to which the address is routed. If the
5624 router succeeds, the address is queued for the &(remote_smtp)& transport, as
5625 specified by the &%transport%& option. If the router does not find the domain
5626 in the DNS, no further routers are tried because of the &%no_more%& setting, so
5627 the address fails and is bounced.
5628
5629 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
5630 be entirely ignored. This option is present because a number of cases have been
5631 encountered where MX records in the DNS point to host names
5632 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
5633 Completely ignoring these IP addresses causes Exim to fail to route the
5634 email address, so it bounces. Otherwise, Exim would log a routing problem, and
5635 continue to try to deliver the message periodically until the address timed
5636 out.
5637 .code
5638 system_aliases:
5639   driver = redirect
5640   allow_fail
5641   allow_defer
5642   data = ${lookup{$local_part}lsearch{/etc/aliases}}
5643 # user = exim
5644   file_transport = address_file
5645   pipe_transport = address_pipe
5646 .endd
5647 Control reaches this and subsequent routers only for addresses in the local
5648 domains. This router checks to see whether the local part is defined as an
5649 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
5650 data that it looks up from that file. If no data is found for the local part,
5651 the value of the &%data%& option is empty, causing the address to be passed to
5652 the next router.
5653
5654 &_/etc/aliases_& is a conventional name for the system aliases file that is
5655 often used. That is why it is referenced by from the default configuration
5656 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
5657 &_Local/Makefile_& before building Exim.
5658 .code
5659 userforward:
5660   driver = redirect
5661   check_local_user
5662 # local_part_suffix = +* : -*
5663 # local_part_suffix_optional
5664   file = $home/.forward
5665 # allow_filter
5666   no_verify
5667   no_expn
5668   check_ancestor
5669   file_transport = address_file
5670   pipe_transport = address_pipe
5671   reply_transport = address_reply
5672 .endd
5673 This is the most complicated router in the default configuration. It is another
5674 redirection router, but this time it is looking for forwarding data set up by
5675 individual users. The &%check_local_user%& setting specifies a check that the
5676 local part of the address is the login name of a local user. If it is not, the
5677 router is skipped. The two commented options that follow &%check_local_user%&,
5678 namely:
5679 .code
5680 # local_part_suffix = +* : -*
5681 # local_part_suffix_optional
5682 .endd
5683 .vindex "&$local_part_suffix$&"
5684 show how you can specify the recognition of local part suffixes. If the first
5685 is uncommented, a suffix beginning with either a plus or a minus sign, followed
5686 by any sequence of characters, is removed from the local part and placed in the
5687 variable &$local_part_suffix$&. The second suffix option specifies that the
5688 presence of a suffix in the local part is optional. When a suffix is present,
5689 the check for a local login uses the local part with the suffix removed.
5690
5691 When a local user account is found, the file called &_.forward_& in the user's
5692 home directory is consulted. If it does not exist, or is empty, the router
5693 declines. Otherwise, the contents of &_.forward_& are interpreted as
5694 redirection data (see chapter &<<CHAPredirect>>& for more details).
5695
5696 .cindex "Sieve filter" "enabling in default router"
5697 Traditional &_.forward_& files contain just a list of addresses, pipes, or
5698 files. Exim supports this by default. However, if &%allow_filter%& is set (it
5699 is commented out by default), the contents of the file are interpreted as a set
5700 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
5701 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
5702 separate document entitled &'Exim's interfaces to mail filtering'&.
5703
5704 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
5705 verifying addresses, or when running as a consequence of an SMTP EXPN command.
5706 There are two reasons for doing this:
5707
5708 .olist
5709 Whether or not a local user has a &_.forward_& file is not really relevant when
5710 checking an address for validity; it makes sense not to waste resources doing
5711 unnecessary work.
5712 .next
5713 More importantly, when Exim is verifying addresses or handling an EXPN
5714 command during an SMTP session, it is running as the Exim user, not as root.
5715 The group is the Exim group, and no additional groups are set up.
5716 It may therefore not be possible for Exim to read users' &_.forward_& files at
5717 this time.
5718 .endlist
5719
5720 The setting of &%check_ancestor%& prevents the router from generating a new
5721 address that is the same as any previous address that was redirected. (This
5722 works round a problem concerning a bad interaction between aliasing and
5723 forwarding &-- see section &<<SECTredlocmai>>&).
5724
5725 The final three option settings specify the transports that are to be used when
5726 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
5727 auto-reply, respectively. For example, if a &_.forward_& file contains
5728 .code
5729 a.nother@elsewhere.example, /home/spqr/archive
5730 .endd
5731 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
5732 transport.
5733 .code
5734 localuser:
5735   driver = accept
5736   check_local_user
5737 # local_part_suffix = +* : -*
5738 # local_part_suffix_optional
5739   transport = local_delivery
5740 .endd
5741 The final router sets up delivery into local mailboxes, provided that the local
5742 part is the name of a local login, by accepting the address and assigning it to
5743 the &(local_delivery)& transport. Otherwise, we have reached the end of the
5744 routers, so the address is bounced. The commented suffix settings fulfil the
5745 same purpose as they do for the &(userforward)& router.
5746
5747
5748 .section "Transport configuration" "SECID56"
5749 .cindex "default" "transports"
5750 .cindex "transports" "default"
5751 Transports define mechanisms for actually delivering messages. They operate
5752 only when referenced from routers, so the order in which they are defined does
5753 not matter. The transports section of the configuration starts with
5754 .code
5755 begin transports
5756 .endd
5757 One remote transport and four local transports are defined.
5758 .code
5759 remote_smtp:
5760   driver = smtp
5761 .endd
5762 This transport is used for delivering messages over SMTP connections. All its
5763 options are defaulted. The list of remote hosts comes from the router.
5764 .code
5765 local_delivery:
5766   driver = appendfile
5767   file = /var/mail/$local_part
5768   delivery_date_add
5769   envelope_to_add
5770   return_path_add
5771 # group = mail
5772 # mode = 0660
5773 .endd
5774 This &(appendfile)& transport is used for local delivery to user mailboxes in
5775 traditional BSD mailbox format. By default it runs under the uid and gid of the
5776 local user, which requires the sticky bit to be set on the &_/var/mail_&
5777 directory. Some systems use the alternative approach of running mail deliveries
5778 under a particular group instead of using the sticky bit. The commented options
5779 show how this can be done.
5780
5781 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
5782 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
5783 similarly-named options above.
5784 .code
5785 address_pipe:
5786   driver = pipe
5787   return_output
5788 .endd
5789 This transport is used for handling deliveries to pipes that are generated by
5790 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
5791 option specifies that any output generated by the pipe is to be returned to the
5792 sender.
5793 .code
5794 address_file:
5795   driver = appendfile
5796   delivery_date_add
5797   envelope_to_add
5798   return_path_add
5799 .endd
5800 This transport is used for handling deliveries to files that are generated by
5801 redirection. The name of the file is not specified in this instance of
5802 &(appendfile)&, because it comes from the &(redirect)& router.
5803 .code
5804 address_reply:
5805   driver = autoreply
5806 .endd
5807 This transport is used for handling automatic replies generated by users'
5808 filter files.
5809
5810
5811
5812 .section "Default retry rule" "SECID57"
5813 .cindex "retry" "default rule"
5814 .cindex "default" "retry rule"
5815 The retry section of the configuration file contains rules which affect the way
5816 Exim retries deliveries that cannot be completed at the first attempt. It is
5817 introduced by the line
5818 .code
5819 begin retry
5820 .endd
5821 In the default configuration, there is just one rule, which applies to all
5822 errors:
5823 .code
5824 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
5825 .endd
5826 This causes any temporarily failing address to be retried every 15 minutes for
5827 2 hours, then at intervals starting at one hour and increasing by a factor of
5828 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
5829 is not delivered after 4 days of temporary failure, it is bounced.
5830
5831 If the retry section is removed from the configuration, or is empty (that is,
5832 if no retry rules are defined), Exim will not retry deliveries. This turns
5833 temporary errors into permanent errors.
5834
5835
5836 .section "Rewriting configuration" "SECID58"
5837 The rewriting section of the configuration, introduced by
5838 .code
5839 begin rewrite
5840 .endd
5841 contains rules for rewriting addresses in messages as they arrive. There are no
5842 rewriting rules in the default configuration file.
5843
5844
5845
5846 .section "Authenticators configuration" "SECTdefconfauth"
5847 .cindex "AUTH" "configuration"
5848 The authenticators section of the configuration, introduced by
5849 .code
5850 begin authenticators
5851 .endd
5852 defines mechanisms for the use of the SMTP AUTH command. The default
5853 configuration file contains two commented-out example authenticators
5854 which support plaintext username/password authentication using the
5855 standard PLAIN mechanism and the traditional but non-standard LOGIN
5856 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
5857 to support most MUA software.
5858
5859 The example PLAIN authenticator looks like this:
5860 .code
5861 #PLAIN:
5862 #  driver                  = plaintext
5863 #  server_set_id           = $auth2
5864 #  server_prompts          = :
5865 #  server_condition        = Authentication is not yet configured
5866 #  server_advertise_condition = ${if def:tls_cipher }
5867 .endd
5868 And the example LOGIN authenticator looks like this:
5869 .code
5870 #LOGIN:
5871 #  driver                  = plaintext
5872 #  server_set_id           = $auth1
5873 #  server_prompts          = <| Username: | Password:
5874 #  server_condition        = Authentication is not yet configured
5875 #  server_advertise_condition = ${if def:tls_cipher }
5876 .endd
5877
5878 The &%server_set_id%& option makes Exim remember the authenticated username
5879 in &$authenticated_id$&, which can be used later in ACLs or routers. The
5880 &%server_prompts%& option configures the &(plaintext)& authenticator so
5881 that it implements the details of the specific authentication mechanism,
5882 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
5883 when Exim offers authentication to clients; in the examples, this is only
5884 when TLS or SSL has been started, so to enable the authenticators you also
5885 need to add support for TLS as described in &<<SECTdefconfmain>>&.
5886
5887 The &%server_condition%& setting defines how to verify that the username and
5888 password are correct. In the examples it just produces an error message.
5889 To make the authenticators work, you can use a string expansion
5890 expression like one of the examples in &<<CHAPplaintext>>&.
5891
5892 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
5893 usercode and password are in different positions.  &<<CHAPplaintext>>&
5894 covers both.
5895
5896 .ecindex IIDconfiwal
5897
5898
5899
5900 . ////////////////////////////////////////////////////////////////////////////
5901 . ////////////////////////////////////////////////////////////////////////////
5902
5903 .chapter "Regular expressions" "CHAPregexp"
5904
5905 .cindex "regular expressions" "library"
5906 .cindex "PCRE"
5907 Exim supports the use of regular expressions in many of its options. It
5908 uses the PCRE regular expression library; this provides regular expression
5909 matching that is compatible with Perl 5. The syntax and semantics of
5910 regular expressions is discussed in many Perl reference books, and also in
5911 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
5912 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
5913
5914 The documentation for the syntax and semantics of the regular expressions that
5915 are supported by PCRE is included in the PCRE distribution, and no further
5916 description is included here. The PCRE functions are called from Exim using
5917 the default option settings (that is, with no PCRE options set), except that
5918 the PCRE_CASELESS option is set when the matching is required to be
5919 case-insensitive.
5920
5921 In most cases, when a regular expression is required in an Exim configuration,
5922 it has to start with a circumflex, in order to distinguish it from plain text
5923 or an &"ends with"& wildcard. In this example of a configuration setting, the
5924 second item in the colon-separated list is a regular expression.
5925 .code
5926 domains = a.b.c : ^\\d{3} : *.y.z : ...
5927 .endd
5928 The doubling of the backslash is required because of string expansion that
5929 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
5930 of this issue, and a way of avoiding the need for doubling backslashes. The
5931 regular expression that is eventually used in this example contains just one
5932 backslash. The circumflex is included in the regular expression, and has the
5933 normal effect of &"anchoring"& it to the start of the string that is being
5934 matched.
5935
5936 There are, however, two cases where a circumflex is not required for the
5937 recognition of a regular expression: these are the &%match%& condition in a
5938 string expansion, and the &%matches%& condition in an Exim filter file. In
5939 these cases, the relevant string is always treated as a regular expression; if
5940 it does not start with a circumflex, the expression is not anchored, and can
5941 match anywhere in the subject string.
5942
5943 In all cases, if you want a regular expression to match at the end of a string,
5944 you must code the $ metacharacter to indicate this. For example:
5945 .code
5946 domains = ^\\d{3}\\.example
5947 .endd
5948 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
5949 You need to use:
5950 .code
5951 domains = ^\\d{3}\\.example\$
5952 .endd
5953 if you want &'example'& to be the top-level domain. The backslash before the
5954 $ is needed because string expansion also interprets dollar characters.
5955
5956
5957
5958 . ////////////////////////////////////////////////////////////////////////////
5959 . ////////////////////////////////////////////////////////////////////////////
5960
5961 .chapter "File and database lookups" "CHAPfdlookup"
5962 .scindex IIDfidalo1 "file" "lookups"
5963 .scindex IIDfidalo2 "database" "lookups"
5964 .cindex "lookup" "description of"
5965 Exim can be configured to look up data in files or databases as it processes
5966 messages. Two different kinds of syntax are used:
5967
5968 .olist
5969 A string that is to be expanded may contain explicit lookup requests. These
5970 cause parts of the string to be replaced by data that is obtained from the
5971 lookup. Lookups of this type are conditional expansion items. Different results
5972 can be defined for the cases of lookup success and failure. See chapter
5973 &<<CHAPexpand>>&, where string expansions are described in detail.
5974 .next
5975 Lists of domains, hosts, and email addresses can contain lookup requests as a
5976 way of avoiding excessively long linear lists. In this case, the data that is
5977 returned by the lookup is often (but not always) discarded; whether the lookup
5978 succeeds or fails is what really counts. These kinds of list are described in
5979 chapter &<<CHAPdomhosaddlists>>&.
5980 .endlist
5981
5982 String expansions, lists, and lookups interact with each other in such a way
5983 that there is no order in which to describe any one of them that does not
5984 involve references to the others. Each of these three chapters makes more sense
5985 if you have read the other two first. If you are reading this for the first
5986 time, be aware that some of it will make a lot more sense after you have read
5987 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
5988
5989 .section "Examples of different lookup syntax" "SECID60"
5990 It is easy to confuse the two different kinds of lookup, especially as the
5991 lists that may contain the second kind are always expanded before being
5992 processed as lists. Therefore, they may also contain lookups of the first kind.
5993 Be careful to distinguish between the following two examples:
5994 .code
5995 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
5996 domains = lsearch;/some/file
5997 .endd
5998 The first uses a string expansion, the result of which must be a domain list.
5999 No strings have been specified for a successful or a failing lookup; the
6000 defaults in this case are the looked-up data and an empty string, respectively.
6001 The expansion takes place before the string is processed as a list, and the
6002 file that is searched could contain lines like this:
6003 .code
6004 192.168.3.4: domain1:domain2:...
6005 192.168.1.9: domain3:domain4:...
6006 .endd
6007 When the lookup succeeds, the result of the expansion is a list of domains (and
6008 possibly other types of item that are allowed in domain lists).
6009
6010 In the second example, the lookup is a single item in a domain list. It causes
6011 Exim to use a lookup to see if the domain that is being processed can be found
6012 in the file. The file could contains lines like this:
6013 .code
6014 domain1:
6015 domain2:
6016 .endd
6017 Any data that follows the keys is not relevant when checking that the domain
6018 matches the list item.
6019
6020 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6021 Consider a file containing lines like this:
6022 .code
6023 192.168.5.6: lsearch;/another/file
6024 .endd
6025 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6026 first &%domains%& setting above generates the second setting, which therefore
6027 causes a second lookup to occur.
6028
6029 The rest of this chapter describes the different lookup types that are
6030 available. Any of them can be used in any part of the configuration where a
6031 lookup is permitted.
6032
6033
6034 .section "Lookup types" "SECID61"
6035 .cindex "lookup" "types of"
6036 .cindex "single-key lookup" "definition of"
6037 Two different types of data lookup are implemented:
6038
6039 .ilist
6040 The &'single-key'& type requires the specification of a file in which to look,
6041 and a single key to search for. The key must be a non-empty string for the
6042 lookup to succeed. The lookup type determines how the file is searched.
6043 .next
6044 .cindex "query-style lookup" "definition of"
6045 The &'query-style'& type accepts a generalized database query. No particular
6046 key value is assumed by Exim for query-style lookups. You can use whichever
6047 Exim variables you need to construct the database query.
6048 .endlist
6049
6050 The code for each lookup type is in a separate source file that is included in
6051 the binary of Exim only if the corresponding compile-time option is set. The
6052 default settings in &_src/EDITME_& are:
6053 .code
6054 LOOKUP_DBM=yes
6055 LOOKUP_LSEARCH=yes
6056 .endd
6057 which means that only linear searching and DBM lookups are included by default.
6058 For some types of lookup (e.g. SQL databases), you need to install appropriate
6059 libraries and header files before building Exim.
6060
6061
6062
6063
6064 .section "Single-key lookup types" "SECTsinglekeylookups"
6065 .cindex "lookup" "single-key types"
6066 .cindex "single-key lookup" "list of types"
6067 The following single-key lookup types are implemented:
6068
6069 .ilist
6070 .cindex "cdb" "description of"
6071 .cindex "lookup" "cdb"
6072 .cindex "binary zero" "in lookup key"
6073 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6074 string without a terminating binary zero. The cdb format is designed for
6075 indexed files that are read frequently and never updated, except by total
6076 re-creation. As such, it is particularly suitable for large files containing
6077 aliases or other indexed data referenced by an MTA. Information about cdb can
6078 be found in several places:
6079 .display
6080 &url(http://www.pobox.com/~djb/cdb.html)
6081 &url(ftp://ftp.corpit.ru/pub/tinycdb/)
6082 &url(http://packages.debian.org/stable/utils/freecdb.html)
6083 .endd
6084 A cdb distribution is not needed in order to build Exim with cdb support,
6085 because the code for reading cdb files is included directly in Exim itself.
6086 However, no means of building or testing cdb files is provided with Exim, so
6087 you need to obtain a cdb distribution in order to do this.
6088 .next
6089 .cindex "DBM" "lookup type"
6090 .cindex "lookup" "dbm"
6091 .cindex "binary zero" "in lookup key"
6092 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6093 DBM file by looking up the record with the given key. A terminating binary
6094 zero is included in the key that is passed to the DBM library. See section
6095 &<<SECTdb>>& for a discussion of DBM libraries.
6096
6097 .cindex "Berkeley DB library" "file format"
6098 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6099 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6100 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6101 the DB_UNKNOWN option. This enables it to handle any of the types of database
6102 that the library supports, and can be useful for accessing DBM files created by
6103 other applications. (For earlier DB versions, DB_HASH is always used.)
6104 .next
6105 .cindex "lookup" "dbmnz"
6106 .cindex "lookup" "dbm &-- terminating zero"
6107 .cindex "binary zero" "in lookup key"
6108 .cindex "Courier"
6109 .cindex "&_/etc/userdbshadow.dat_&"
6110 .cindex "dmbnz lookup type"
6111 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6112 is not included in the key that is passed to the DBM library. You may need this
6113 if you want to look up data in files that are created by or shared with some
6114 other application that does not use terminating zeros. For example, you need to
6115 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6116 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6117 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6118 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6119 .next
6120 .cindex "lookup" "dsearch"
6121 .cindex "dsearch lookup type"
6122 &(dsearch)&: The given file must be a directory; this is searched for an entry
6123 whose name is the key by calling the &[lstat()]& function. The key may not
6124 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6125 the lookup is the name of the entry, which may be a file, directory,
6126 symbolic link, or any other kind of directory entry. An example of how this
6127 lookup can be used to support virtual domains is given in section
6128 &<<SECTvirtualdomains>>&.
6129 .next
6130 .cindex "lookup" "iplsearch"
6131 .cindex "iplsearch lookup type"
6132 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6133 terminated by a colon or white space or the end of the line. The keys in the
6134 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6135 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6136 being interpreted as a key terminator. For example:
6137 .code
6138 1.2.3.4:           data for 1.2.3.4
6139 192.168.0.0/16:    data for 192.168.0.0/16
6140 "abcd::cdab":      data for abcd::cdab
6141 "abcd:abcd::/32"   data for abcd:abcd::/32
6142 .endd
6143 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6144 file is searched linearly, using the CIDR masks where present, until a matching
6145 key is found. The first key that matches is used; there is no attempt to find a
6146 &"best"& match. Apart from the way the keys are matched, the processing for
6147 &(iplsearch)& is the same as for &(lsearch)&.
6148
6149 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6150 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6151 lookup types support only literal keys.
6152
6153 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6154 the implicit key is the host's IP address rather than its name (see section
6155 &<<SECThoslispatsikey>>&).
6156 .next
6157 .cindex "linear search"
6158 .cindex "lookup" "lsearch"
6159 .cindex "lsearch lookup type"
6160 .cindex "case sensitivity" "in lsearch lookup"
6161 &(lsearch)&: The given file is a text file that is searched linearly for a
6162 line beginning with the search key, terminated by a colon or white space or the
6163 end of the line. The search is case-insensitive; that is, upper and lower case
6164 letters are treated as the same. The first occurrence of the key that is found
6165 in the file is used.
6166
6167 White space between the key and the colon is permitted. The remainder of the
6168 line, with leading and trailing white space removed, is the data. This can be
6169 continued onto subsequent lines by starting them with any amount of white
6170 space, but only a single space character is included in the data at such a
6171 junction. If the data begins with a colon, the key must be terminated by a
6172 colon, for example:
6173 .code
6174 baduser:  :fail:
6175 .endd
6176 Empty lines and lines beginning with # are ignored, even if they occur in the
6177 middle of an item. This is the traditional textual format of alias files. Note
6178 that the keys in an &(lsearch)& file are literal strings. There is no
6179 wildcarding of any kind.
6180
6181 .cindex "lookup" "lsearch &-- colons in keys"
6182 .cindex "white space" "in lsearch key"
6183 In most &(lsearch)& files, keys are not required to contain colons or #
6184 characters, or white space. However, if you need this feature, it is available.
6185 If a key begins with a doublequote character, it is terminated only by a
6186 matching quote (or end of line), and the normal escaping rules apply to its
6187 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6188 quoted keys (exactly as for unquoted keys). There is no special handling of
6189 quotes for the data part of an &(lsearch)& line.
6190
6191 .next
6192 .cindex "NIS lookup type"
6193 .cindex "lookup" "NIS"
6194 .cindex "binary zero" "in lookup key"
6195 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6196 the given key, without a terminating binary zero. There is a variant called
6197 &(nis0)& which does include the terminating binary zero in the key. This is
6198 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6199 aliases; the full map names must be used.
6200
6201 .next
6202 .cindex "wildlsearch lookup type"
6203 .cindex "lookup" "wildlsearch"
6204 .cindex "nwildlsearch lookup type"
6205 .cindex "lookup" "nwildlsearch"
6206 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6207 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6208 the file may be wildcarded. The difference between these two lookup types is
6209 that for &(wildlsearch)&, each key in the file is string-expanded before being
6210 used, whereas for &(nwildlsearch)&, no expansion takes place.
6211
6212 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6213 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6214 file that are regular expressions can be made case-sensitive by the use of
6215 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6216
6217 . ==== As this is a nested list, any displays it contains must be indented
6218 . ==== as otherwise they are too far to the left.
6219
6220 .olist
6221 The string may begin with an asterisk to mean &"ends with"&. For example:
6222 .code
6223     *.a.b.c       data for anything.a.b.c
6224     *fish         data for anythingfish
6225 .endd
6226 .next
6227 The string may begin with a circumflex to indicate a regular expression. For
6228 example, for &(wildlsearch)&:
6229 .code
6230     ^\N\d+\.a\.b\N    data for <digits>.a.b
6231 .endd
6232 Note the use of &`\N`& to disable expansion of the contents of the regular
6233 expression. If you are using &(nwildlsearch)&, where the keys are not
6234 string-expanded, the equivalent entry is:
6235 .code
6236     ^\d+\.a\.b        data for <digits>.a.b
6237 .endd
6238 The case-insensitive flag is set at the start of compiling the regular
6239 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6240 For example, to make the entire pattern case-sensitive:
6241 .code
6242     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6243 .endd
6244
6245 If the regular expression contains white space or colon characters, you must
6246 either quote it (see &(lsearch)& above), or represent these characters in other
6247 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6248 colon. This may be easier than quoting, because if you quote, you have to
6249 escape all the backslashes inside the quotes.
6250
6251 &*Note*&: It is not possible to capture substrings in a regular expression
6252 match for later use, because the results of all lookups are cached. If a lookup
6253 is repeated, the result is taken from the cache, and no actual pattern matching
6254 takes place. The values of all the numeric variables are unset after a
6255 &((n)wildlsearch)& match.
6256
6257 .next
6258 Although I cannot see it being of much use, the general matching function that
6259 is used to implement &((n)wildlsearch)& means that the string may begin with a
6260 lookup name terminated by a semicolon, and followed by lookup data. For
6261 example:
6262 .code
6263     cdb;/some/file  data for keys that match the file
6264 .endd
6265 The data that is obtained from the nested lookup is discarded.
6266 .endlist olist
6267
6268 Keys that do not match any of these patterns are interpreted literally. The
6269 continuation rules for the data are the same as for &(lsearch)&, and keys may
6270 be followed by optional colons.
6271
6272 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6273 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6274 lookup types support only literal keys.
6275 .endlist ilist
6276
6277
6278 .section "Query-style lookup types" "SECID62"
6279 .cindex "lookup" "query-style types"
6280 .cindex "query-style lookup" "list of types"
6281 The supported query-style lookup types are listed below. Further details about
6282 many of them are given in later sections.
6283
6284 .ilist
6285 .cindex "DNS" "as a lookup type"
6286 .cindex "lookup" "DNS"
6287 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6288 are given in the supplied query. The resulting data is the contents of the
6289 records. See section &<<SECTdnsdb>>&.
6290 .next
6291 .cindex "InterBase lookup type"
6292 .cindex "lookup" "InterBase"
6293 &(ibase)&: This does a lookup in an InterBase database.
6294 .next
6295 .cindex "LDAP" "lookup type"
6296 .cindex "lookup" "LDAP"
6297 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6298 returns attributes from a single entry. There is a variant called &(ldapm)&
6299 that permits values from multiple entries to be returned. A third variant
6300 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6301 any attribute values. See section &<<SECTldap>>&.
6302 .next
6303 .cindex "MySQL" "lookup type"
6304 .cindex "lookup" "MySQL"
6305 &(mysql)&: The format of the query is an SQL statement that is passed to a
6306 MySQL database. See section &<<SECTsql>>&.
6307 .next
6308 .cindex "NIS+ lookup type"
6309 .cindex "lookup" "NIS+"
6310 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6311 the field to be returned. See section &<<SECTnisplus>>&.
6312 .next
6313 .cindex "Oracle" "lookup type"
6314 .cindex "lookup" "Oracle"
6315 &(oracle)&: The format of the query is an SQL statement that is passed to an
6316 Oracle database. See section &<<SECTsql>>&.
6317 .next
6318 .cindex "lookup" "passwd"
6319 .cindex "passwd lookup type"
6320 .cindex "&_/etc/passwd_&"
6321 &(passwd)& is a query-style lookup with queries that are just user names. The
6322 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6323 success, the result string is the same as you would get from an &(lsearch)&
6324 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6325 password value. For example:
6326 .code
6327 *:42:42:King Rat:/home/kr:/bin/bash
6328 .endd
6329 .next
6330 .cindex "PostgreSQL lookup type"
6331 .cindex "lookup" "PostgreSQL"
6332 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6333 PostgreSQL database. See section &<<SECTsql>>&.
6334
6335 .next
6336 .cindex "sqlite lookup type"
6337 .cindex "lookup" "sqlite"
6338 &(sqlite)&: The format of the query is a file name followed by an SQL statement
6339 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6340
6341 .next
6342 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6343 not likely to be useful in normal operation.
6344 .next
6345 .cindex "whoson lookup type"
6346 .cindex "lookup" "whoson"
6347 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6348 allows a server to check whether a particular (dynamically allocated) IP
6349 address is currently allocated to a known (trusted) user and, optionally, to
6350 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6351 at one time for &"POP before SMTP"& authentication, but that approach has been
6352 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6353 &"POP before SMTP"& checking using ACL statements such as
6354 .code
6355 require condition = \
6356   ${lookup whoson {$sender_host_address}{yes}{no}}
6357 .endd
6358 The query consists of a single IP address. The value returned is the name of
6359 the authenticated user, which is stored in the variable &$value$&. However, in
6360 this example, the data in &$value$& is not used; the result of the lookup is
6361 one of the fixed strings &"yes"& or &"no"&.
6362 .endlist
6363
6364
6365
6366 .section "Temporary errors in lookups" "SECID63"
6367 .cindex "lookup" "temporary error in"
6368 Lookup functions can return temporary error codes if the lookup cannot be
6369 completed. For example, an SQL or LDAP database might be unavailable. For this
6370 reason, it is not advisable to use a lookup that might do this for critical
6371 options such as a list of local domains.
6372
6373 When a lookup cannot be completed in a router or transport, delivery
6374 of the message (to the relevant address) is deferred, as for any other
6375 temporary error. In other circumstances Exim may assume the lookup has failed,
6376 or may give up altogether.
6377
6378
6379
6380 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
6381 .cindex "wildcard lookups"
6382 .cindex "lookup" "default values"
6383 .cindex "lookup" "wildcard"
6384 .cindex "lookup" "* added to type"
6385 .cindex "default" "in single-key lookups"
6386 In this context, a &"default value"& is a value specified by the administrator
6387 that is to be used if a lookup fails.
6388
6389 &*Note:*& This section applies only to single-key lookups. For query-style
6390 lookups, the facilities of the query language must be used. An attempt to
6391 specify a default for a query-style lookup provokes an error.
6392
6393 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
6394 and the initial lookup fails, the key &"*"& is looked up in the file to
6395 provide a default value. See also the section on partial matching below.
6396
6397 .cindex "*@ with single-key lookup"
6398 .cindex "lookup" "*@ added to type"
6399 .cindex "alias file" "per-domain default"
6400 Alternatively, if &"*@"& is added to a single-key lookup type (for example
6401 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
6402 character, a second lookup is done with everything before the last @ replaced
6403 by *. This makes it possible to provide per-domain defaults in alias files
6404 that include the domains in the keys. If the second lookup fails (or doesn't
6405 take place because there is no @ in the key), &"*"& is looked up.
6406 For example, a &(redirect)& router might contain:
6407 .code
6408 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
6409 .endd
6410 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
6411 looks up these keys, in this order:
6412 .code
6413 jane@eyre.example
6414 *@eyre.example
6415 *
6416 .endd
6417 The data is taken from whichever key it finds first. &*Note*&: In an
6418 &(lsearch)& file, this does not mean the first of these keys in the file. A
6419 complete scan is done for each key, and only if it is not found at all does
6420 Exim move on to try the next key.
6421
6422
6423
6424 .section "Partial matching in single-key lookups" "SECTpartiallookup"
6425 .cindex "partial matching"
6426 .cindex "wildcard lookups"
6427 .cindex "lookup" "partial matching"
6428 .cindex "lookup" "wildcard"
6429 .cindex "asterisk" "in search type"
6430 The normal operation of a single-key lookup is to search the file for an exact
6431 match with the given key. However, in a number of situations where domains are
6432 being looked up, it is useful to be able to do partial matching. In this case,
6433 information in the file that has a key starting with &"*."& is matched by any
6434 domain that ends with the components that follow the full stop. For example, if
6435 a key in a DBM file is
6436 .code
6437 *.dates.fict.example
6438 .endd
6439 then when partial matching is enabled this is matched by (amongst others)
6440 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
6441 by &'dates.fict.example'&, if that does not appear as a separate key in the
6442 file.
6443
6444 &*Note*&: Partial matching is not available for query-style lookups. It is
6445 also not available for any lookup items in address lists (see section
6446 &<<SECTaddresslist>>&).
6447
6448 Partial matching is implemented by doing a series of separate lookups using
6449 keys constructed by modifying the original subject key. This means that it can
6450 be used with any of the single-key lookup types, provided that
6451 partial matching keys
6452 beginning with a special prefix (default &"*."&) are included in the data file.
6453 Keys in the file that do not begin with the prefix are matched only by
6454 unmodified subject keys when partial matching is in use.
6455
6456 Partial matching is requested by adding the string &"partial-"& to the front of
6457 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
6458 is done, the subject key is first looked up unmodified; if that fails, &"*."&
6459 is added at the start of the subject key, and it is looked up again. If that
6460 fails, further lookups are tried with dot-separated components removed from the
6461 start of the subject key, one-by-one, and &"*."& added on the front of what
6462 remains.
6463
6464 A minimum number of two non-* components are required. This can be adjusted
6465 by including a number before the hyphen in the search type. For example,
6466 &%partial3-lsearch%& specifies a minimum of three non-* components in the
6467 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
6468 subject key is &'2250.dates.fict.example'& then the following keys are looked
6469 up when the minimum number of non-* components is two:
6470 .code
6471 2250.dates.fict.example
6472 *.2250.dates.fict.example
6473 *.dates.fict.example
6474 *.fict.example
6475 .endd
6476 As soon as one key in the sequence is successfully looked up, the lookup
6477 finishes.
6478
6479 .cindex "lookup" "partial matching &-- changing prefix"
6480 .cindex "prefix" "for partial matching"
6481 The use of &"*."& as the partial matching prefix is a default that can be
6482 changed. The motivation for this feature is to allow Exim to operate with file
6483 formats that are used by other MTAs. A different prefix can be supplied in
6484 parentheses instead of the hyphen after &"partial"&. For example:
6485 .code
6486 domains = partial(.)lsearch;/some/file
6487 .endd
6488 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
6489 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
6490 components is unchanged). The prefix may consist of any punctuation characters
6491 other than a closing parenthesis. It may be empty, for example:
6492 .code
6493 domains = partial1()cdb;/some/file
6494 .endd
6495 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
6496 &`a.b.c`&, &`b.c`&, and &`c`&.
6497
6498 If &"partial0"& is specified, what happens at the end (when the lookup with
6499 just one non-wild component has failed, and the original key is shortened right
6500 down to the null string) depends on the prefix:
6501
6502 .ilist
6503 If the prefix has zero length, the whole lookup fails.
6504 .next
6505 If the prefix has length 1, a lookup for just the prefix is done. For
6506 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
6507 .next
6508 Otherwise, if the prefix ends in a dot, the dot is removed, and the
6509 remainder is looked up. With the default prefix, therefore, the final lookup is
6510 for &"*"& on its own.
6511 .next
6512 Otherwise, the whole prefix is looked up.
6513 .endlist
6514
6515
6516 If the search type ends in &"*"& or &"*@"& (see section
6517 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
6518 this implies happens after all partial lookups have failed. If &"partial0"& is
6519 specified, adding &"*"& to the search type has no effect with the default
6520 prefix, because the &"*"& key is already included in the sequence of partial
6521 lookups. However, there might be a use for lookup types such as
6522 &"partial0(.)lsearch*"&.
6523
6524 The use of &"*"& in lookup partial matching differs from its use as a wildcard
6525 in domain lists and the like. Partial matching works only in terms of
6526 dot-separated components; a key such as &`*fict.example`&
6527 in a database file is useless, because the asterisk in a partial matching
6528 subject key is always followed by a dot.
6529
6530
6531
6532
6533 .section "Lookup caching" "SECID64"
6534 .cindex "lookup" "caching"
6535 .cindex "caching" "lookup data"
6536 Exim caches all lookup results in order to avoid needless repetition of
6537 lookups. However, because (apart from the daemon) Exim operates as a collection
6538 of independent, short-lived processes, this caching applies only within a
6539 single Exim process. There is no inter-process lookup caching facility.
6540
6541 For single-key lookups, Exim keeps the relevant files open in case there is
6542 another lookup that needs them. In some types of configuration this can lead to
6543 many files being kept open for messages with many recipients. To avoid hitting
6544 the operating system limit on the number of simultaneously open files, Exim
6545 closes the least recently used file when it needs to open more files than its
6546 own internal limit, which can be changed via the &%lookup_open_max%& option.
6547
6548 The single-key lookup files are closed and the lookup caches are flushed at
6549 strategic points during delivery &-- for example, after all routing is
6550 complete.
6551
6552
6553
6554
6555 .section "Quoting lookup data" "SECID65"
6556 .cindex "lookup" "quoting"
6557 .cindex "quoting" "in lookups"
6558 When data from an incoming message is included in a query-style lookup, there
6559 is the possibility of special characters in the data messing up the syntax of
6560 the query. For example, a NIS+ query that contains
6561 .code
6562 [name=$local_part]
6563 .endd
6564 will be broken if the local part happens to contain a closing square bracket.
6565 For NIS+, data can be enclosed in double quotes like this:
6566 .code
6567 [name="$local_part"]
6568 .endd
6569 but this still leaves the problem of a double quote in the data. The rule for
6570 NIS+ is that double quotes must be doubled. Other lookup types have different
6571 rules, and to cope with the differing requirements, an expansion operator
6572 of the following form is provided:
6573 .code
6574 ${quote_<lookup-type>:<string>}
6575 .endd
6576 For example, the safest way to write the NIS+ query is
6577 .code
6578 [name="${quote_nisplus:$local_part}"]
6579 .endd
6580 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
6581 operator can be used for all lookup types, but has no effect for single-key
6582 lookups, since no quoting is ever needed in their key strings.
6583
6584
6585
6586
6587 .section "More about dnsdb" "SECTdnsdb"
6588 .cindex "dnsdb lookup"
6589 .cindex "lookup" "dnsdb"
6590 .cindex "DNS" "as a lookup type"
6591 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
6592 of a record type and a domain name, separated by an equals sign. For example,
6593 an expansion string could contain:
6594 .code
6595 ${lookup dnsdb{mx=a.b.example}{$value}fail}
6596 .endd
6597 If the lookup succeeds, the result is placed in &$value$&, which in this case
6598 is used on its own as the result. If the lookup does not succeed, the
6599 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
6600 &<<SECTforexpfai>>& for an explanation of what this means.
6601
6602 The supported DNS record types are A, CNAME, MX, NS, PTR, SRV, and TXT, and,
6603 when Exim is compiled with IPv6 support, AAAA (and A6 if that is also
6604 configured). If no type is given, TXT is assumed. When the type is PTR,
6605 the data can be an IP address, written as normal; inversion and the addition of
6606 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
6607 .code
6608 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
6609 .endd
6610 If the data for a PTR record is not a syntactically valid IP address, it is not
6611 altered and nothing is added.
6612
6613 .cindex "MX record" "in &(dnsdb)& lookup"
6614 .cindex "SRV record" "in &(dnsdb)& lookup"
6615 For an MX lookup, both the preference value and the host name are returned for
6616 each record, separated by a space. For an SRV lookup, the priority, weight,
6617 port, and host name are returned for each record, separated by spaces.
6618
6619 For any record type, if multiple records are found (or, for A6 lookups, if a
6620 single record leads to multiple addresses), the data is returned as a
6621 concatenation, with newline as the default separator. The order, of course,
6622 depends on the DNS resolver. You can specify a different separator character
6623 between multiple records by putting a right angle-bracket followed immediately
6624 by the new separator at the start of the query. For example:
6625 .code
6626 ${lookup dnsdb{>: a=host1.example}}
6627 .endd
6628 It is permitted to specify a space as the separator character. Further
6629 white space is ignored.
6630
6631 .new
6632 .cindex "TXT record" "in &(dnsdb)& lookup"
6633 For TXT records with multiple items of data, only the first item is returned,
6634 unless a separator for them is specified using a comma after the separator
6635 character followed immediately by the TXT record item separator. To concatenate
6636 items without a separator, use a semicolon instead.
6637 .code
6638 ${lookup dnsdb{>\n,: txt=a.b.example}}
6639 ${lookup dnsdb{>\n; txt=a.b.example}}
6640 .endd
6641 It is permitted to specify a space as the separator character. Further
6642 white space is ignored.
6643 .wen
6644
6645 .section "Pseudo dnsdb record types" "SECID66"
6646 .cindex "MX record" "in &(dnsdb)& lookup"
6647 By default, both the preference value and the host name are returned for
6648 each MX record, separated by a space. If you want only host names, you can use
6649 the pseudo-type MXH:
6650 .code
6651 ${lookup dnsdb{mxh=a.b.example}}
6652 .endd
6653 In this case, the preference values are omitted, and just the host names are
6654 returned.
6655
6656 .cindex "name server for enclosing domain"
6657 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
6658 records on the given domain, but if none are found, it removes the first
6659 component of the domain name, and tries again. This process continues until NS
6660 records are found or there are no more components left (or there is a DNS
6661 error). In other words, it may return the name servers for a top-level domain,
6662 but it never returns the root name servers. If there are no NS records for the
6663 top-level domain, the lookup fails. Consider these examples:
6664 .code
6665 ${lookup dnsdb{zns=xxx.quercite.com}}
6666 ${lookup dnsdb{zns=xxx.edu}}
6667 .endd
6668 Assuming that in each case there are no NS records for the full domain name,
6669 the first returns the name servers for &%quercite.com%&, and the second returns
6670 the name servers for &%edu%&.
6671
6672 You should be careful about how you use this lookup because, unless the
6673 top-level domain does not exist, the lookup always returns some host names. The
6674 sort of use to which this might be put is for seeing if the name servers for a
6675 given domain are on a blacklist. You can probably assume that the name servers
6676 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
6677 such a list.
6678
6679 .cindex "CSA" "in &(dnsdb)& lookup"
6680 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
6681 records according to the CSA rules, which are described in section
6682 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
6683 not sufficient because of the extra parent domain search behaviour of CSA. The
6684 result of a successful lookup such as:
6685 .code
6686 ${lookup dnsdb {csa=$sender_helo_name}}
6687 .endd
6688 has two space-separated fields: an authorization code and a target host name.
6689 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
6690 authorization required but absent, or &"?"& for unknown.
6691
6692
6693 .section "Multiple dnsdb lookups" "SECID67"
6694 In the previous sections, &(dnsdb)& lookups for a single domain are described.
6695 However, you can specify a list of domains or IP addresses in a single
6696 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
6697 the default separator, but with the ability to change this. For example:
6698 .code
6699 ${lookup dnsdb{one.domain.com:two.domain.com}}
6700 ${lookup dnsdb{a=one.host.com:two.host.com}}
6701 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
6702 .endd
6703 In order to retain backwards compatibility, there is one special case: if
6704 the lookup type is PTR and no change of separator is specified, Exim looks
6705 to see if the rest of the string is precisely one IPv6 address. In this
6706 case, it does not treat it as a list.
6707
6708 The data from each lookup is concatenated, with newline separators by default,
6709 in the same way that multiple DNS records for a single item are handled. A
6710 different separator can be specified, as described above.
6711
6712 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
6713 temporary DNS error for any of them, the behaviour is controlled by
6714 an optional keyword followed by a comma that may appear before the record
6715 type. The possible keywords are &"defer_strict"&, &"defer_never"&, and
6716 &"defer_lax"&. With &"strict"& behaviour, any temporary DNS error causes the
6717 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
6718 ignored, and the behaviour is as if the DNS lookup failed to find anything.
6719 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
6720 error causes the whole lookup to defer only if none of the other lookups
6721 succeed. The default is &"lax"&, so the following lookups are equivalent:
6722 .code
6723 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
6724 ${lookup dnsdb{a=one.host.com:two.host.com}}
6725 .endd
6726 Thus, in the default case, as long as at least one of the DNS lookups
6727 yields some data, the lookup succeeds.
6728
6729
6730
6731
6732 .section "More about LDAP" "SECTldap"
6733 .cindex "LDAP" "lookup, more about"
6734 .cindex "lookup" "LDAP"
6735 .cindex "Solaris" "LDAP"
6736 The original LDAP implementation came from the University of Michigan; this has
6737 become &"Open LDAP"&, and there are now two different releases. Another
6738 implementation comes from Netscape, and Solaris 7 and subsequent releases
6739 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
6740 the lookup function level, their error handling is different. For this reason
6741 it is necessary to set a compile-time variable when building Exim with LDAP, to
6742 indicate which LDAP library is in use. One of the following should appear in
6743 your &_Local/Makefile_&:
6744 .code
6745 LDAP_LIB_TYPE=UMICHIGAN
6746 LDAP_LIB_TYPE=OPENLDAP1
6747 LDAP_LIB_TYPE=OPENLDAP2
6748 LDAP_LIB_TYPE=NETSCAPE
6749 LDAP_LIB_TYPE=SOLARIS
6750 .endd
6751 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
6752 same interface as the University of Michigan version.
6753
6754 There are three LDAP lookup types in Exim. These behave slightly differently in
6755 the way they handle the results of a query:
6756
6757 .ilist
6758 &(ldap)& requires the result to contain just one entry; if there are more, it
6759 gives an error.
6760 .next
6761 &(ldapdn)& also requires the result to contain just one entry, but it is the
6762 Distinguished Name that is returned rather than any attribute values.
6763 .next
6764 &(ldapm)& permits the result to contain more than one entry; the attributes
6765 from all of them are returned.
6766 .endlist
6767
6768
6769 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
6770 Exim behaves as if the entry did not exist, and the lookup fails. The format of
6771 the data returned by a successful lookup is described in the next section.
6772 First we explain how LDAP queries are coded.
6773
6774
6775 .section "Format of LDAP queries" "SECTforldaque"
6776 .cindex "LDAP" "query format"
6777 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
6778 the configuration of a &(redirect)& router one might have this setting:
6779 .code
6780 data = ${lookup ldap \
6781   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
6782   c=UK?mailbox?base?}}
6783 .endd
6784 .cindex "LDAP" "with TLS"
6785 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
6786 secure (encrypted) LDAP connections. The second of these ensures that an
6787 encrypted TLS connection is used.
6788
6789
6790 .section "LDAP quoting" "SECID68"
6791 .cindex "LDAP" "quoting"
6792 Two levels of quoting are required in LDAP queries, the first for LDAP itself
6793 and the second because the LDAP query is represented as a URL. Furthermore,
6794 within an LDAP query, two different kinds of quoting are required. For this
6795 reason, there are two different LDAP-specific quoting operators.
6796
6797 The &%quote_ldap%& operator is designed for use on strings that are part of
6798 filter specifications. Conceptually, it first does the following conversions on
6799 the string:
6800 .code
6801 *   =>   \2A
6802 (   =>   \28
6803 )   =>   \29
6804 \   =>   \5C
6805 .endd
6806 in accordance with RFC 2254. The resulting string is then quoted according
6807 to the rules for URLs, that is, all non-alphanumeric characters except
6808 .code
6809 ! $ ' - . _ ( ) * +
6810 .endd
6811 are converted to their hex values, preceded by a percent sign. For example:
6812 .code
6813 ${quote_ldap: a(bc)*, a<yz>; }
6814 .endd
6815 yields
6816 .code
6817 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
6818 .endd
6819 Removing the URL quoting, this is (with a leading and a trailing space):
6820 .code
6821 a\28bc\29\2A, a<yz>;
6822 .endd
6823 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
6824 base DN specifications in queries. Conceptually, it first converts the string
6825 by inserting a backslash in front of any of the following characters:
6826 .code
6827 , + " \ < > ;
6828 .endd
6829 It also inserts a backslash before any leading spaces or # characters, and
6830 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
6831 is then quoted according to the rules for URLs. For example:
6832 .code
6833 ${quote_ldap_dn: a(bc)*, a<yz>; }
6834 .endd
6835 yields
6836 .code
6837 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
6838 .endd
6839 Removing the URL quoting, this is (with a trailing space):
6840 .code
6841 \ a(bc)*\, a\<yz\>\;\
6842 .endd
6843 There are some further comments about quoting in the section on LDAP
6844 authentication below.
6845
6846
6847 .section "LDAP connections" "SECID69"
6848 .cindex "LDAP" "connections"
6849 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
6850 is in use, via a Unix domain socket. The example given above does not specify
6851 an LDAP server. A server that is reached by TCP/IP can be specified in a query
6852 by starting it with
6853 .code
6854 ldap://<hostname>:<port>/...
6855 .endd
6856 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
6857 used. When no server is specified in a query, a list of default servers is
6858 taken from the &%ldap_default_servers%& configuration option. This supplies a
6859 colon-separated list of servers which are tried in turn until one successfully
6860 handles a query, or there is a serious error. Successful handling either
6861 returns the requested data, or indicates that it does not exist. Serious errors
6862 are syntactical, or multiple values when only a single value is expected.
6863 Errors which cause the next server to be tried are connection failures, bind
6864 failures, and timeouts.
6865
6866 For each server name in the list, a port number can be given. The standard way
6867 of specifying a host and port is to use a colon separator (RFC 1738). Because
6868 &%ldap_default_servers%& is a colon-separated list, such colons have to be
6869 doubled. For example
6870 .code
6871 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
6872 .endd
6873 If &%ldap_default_servers%& is unset, a URL with no server name is passed
6874 to the LDAP library with no server name, and the library's default (normally
6875 the local host) is used.
6876
6877 If you are using the OpenLDAP library, you can connect to an LDAP server using
6878 a Unix domain socket instead of a TCP/IP connection. This is specified by using
6879 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
6880 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
6881 not available.
6882
6883 For this type of connection, instead of a host name for the server, a pathname
6884 for the socket is required, and the port number is not relevant. The pathname
6885 can be specified either as an item in &%ldap_default_servers%&, or inline in
6886 the query. In the former case, you can have settings such as
6887 .code
6888 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
6889 .endd
6890 When the pathname is given in the query, you have to escape the slashes as
6891 &`%2F`& to fit in with the LDAP URL syntax. For example:
6892 .code
6893 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
6894 .endd
6895 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
6896 a pathname, it uses the Unix domain socket code, even if the query actually
6897 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
6898 socket connection. This behaviour means that you can use a setting of
6899 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
6900 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
6901 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
6902 backup host.
6903
6904 If an explicit &`ldapi`& type is given in a query when a host name is
6905 specified, an error is diagnosed. However, if there are more items in
6906 &%ldap_default_servers%&, they are tried. In other words:
6907
6908 .ilist
6909 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
6910 interface.
6911 .next
6912 Using &`ldapi`& with a host name causes an error.
6913 .endlist
6914
6915
6916 Using &`ldapi`& with no host or path in the query, and no setting of
6917 &%ldap_default_servers%&, does whatever the library does by default.
6918
6919
6920
6921 .section "LDAP authentication and control information" "SECID70"
6922 .cindex "LDAP" "authentication"
6923 The LDAP URL syntax provides no way of passing authentication and other control
6924 information to the server. To make this possible, the URL in an LDAP query may
6925 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
6926 spaces. If a value contains spaces it must be enclosed in double quotes, and
6927 when double quotes are used, backslash is interpreted in the usual way inside
6928 them. The following names are recognized:
6929 .display
6930 &`DEREFERENCE`&  set the dereferencing parameter
6931 &`NETTIME    `&  set a timeout for a network operation
6932 &`USER       `&  set the DN, for authenticating the LDAP bind
6933 &`PASS       `&  set the password, likewise
6934 &`REFERRALS  `&  set the referrals parameter
6935 &`SIZE       `&  set the limit for the number of entries returned
6936 &`TIME       `&  set the maximum waiting time for a query
6937 .endd
6938 The value of the DEREFERENCE parameter must be one of the words &"never"&,
6939 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
6940 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
6941 library from trying to follow referrals issued by the LDAP server.
6942
6943 The name CONNECT is an obsolete name for NETTIME, retained for
6944 backwards compatibility. This timeout (specified as a number of seconds) is
6945 enforced from the client end for operations that can be carried out over a
6946 network. Specifically, it applies to network connections and calls to the
6947 &'ldap_result()'& function. If the value is greater than zero, it is used if
6948 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
6949 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
6950 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
6951 Netscape SDK; for OpenLDAP no action is taken.
6952
6953 The TIME parameter (also a number of seconds) is passed to the server to
6954 set a server-side limit on the time taken to complete a search.
6955
6956
6957 Here is an example of an LDAP query in an Exim lookup that uses some of these
6958 values. This is a single line, folded to fit on the page:
6959 .code
6960 ${lookup ldap
6961   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
6962   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
6963   {$value}fail}
6964 .endd
6965 The encoding of spaces as &`%20`& is a URL thing which should not be done for
6966 any of the auxiliary data. Exim configuration settings that include lookups
6967 which contain password information should be preceded by &"hide"& to prevent
6968 non-admin users from using the &%-bP%& option to see their values.
6969
6970 The auxiliary data items may be given in any order. The default is no
6971 connection timeout (the system timeout is used), no user or password, no limit
6972 on the number of entries returned, and no time limit on queries.
6973
6974 When a DN is quoted in the USER= setting for LDAP authentication, Exim
6975 removes any URL quoting that it may contain before passing it LDAP. Apparently
6976 some libraries do this for themselves, but some do not. Removing the URL
6977 quoting has two advantages:
6978
6979 .ilist
6980 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
6981 DNs as with DNs inside actual queries.
6982 .next
6983 It permits spaces inside USER= DNs.
6984 .endlist
6985
6986 For example, a setting such as
6987 .code
6988 USER=cn=${quote_ldap_dn:$1}
6989 .endd
6990 should work even if &$1$& contains spaces.
6991
6992 Expanded data for the PASS= value should be quoted using the &%quote%&
6993 expansion operator, rather than the LDAP quote operators. The only reason this
6994 field needs quoting is to ensure that it conforms to the Exim syntax, which
6995 does not allow unquoted spaces. For example:
6996 .code
6997 PASS=${quote:$3}
6998 .endd
6999 The LDAP authentication mechanism can be used to check passwords as part of
7000 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7001 &<<CHAPexpand>>&.
7002
7003
7004
7005 .section "Format of data returned by LDAP" "SECID71"
7006 .cindex "LDAP" "returned data formats"
7007 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7008 as a sequence of values, for example
7009 .code
7010 cn=manager, o=University of Cambridge, c=UK
7011 .endd
7012 The &(ldap)& lookup type generates an error if more than one entry matches the
7013 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7014 the result between the data from different entries. It is possible for multiple
7015 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7016 you know that whatever values are returned all came from a single entry in the
7017 directory.
7018
7019 In the common case where you specify a single attribute in your LDAP query, the
7020 result is not quoted, and does not contain the attribute name. If the attribute
7021 has multiple values, they are separated by commas.
7022
7023 If you specify multiple attributes, the result contains space-separated, quoted
7024 strings, each preceded by the attribute name and an equals sign. Within the
7025 quotes, the quote character, backslash, and newline are escaped with
7026 backslashes, and commas are used to separate multiple values for the attribute.
7027 Apart from the escaping, the string within quotes takes the same form as the
7028 output when a single attribute is requested. Specifying no attributes is the
7029 same as specifying all of an entry's attributes.
7030
7031 Here are some examples of the output format. The first line of each pair is an
7032 LDAP query, and the second is the data that is returned. The attribute called
7033 &%attr1%& has two values, whereas &%attr2%& has only one value:
7034 .code
7035 ldap:///o=base?attr1?sub?(uid=fred)
7036 value1.1, value1.2
7037
7038 ldap:///o=base?attr2?sub?(uid=fred)
7039 value two
7040
7041 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7042 attr1="value1.1, value1.2" attr2="value two"
7043
7044 ldap:///o=base??sub?(uid=fred)
7045 objectClass="top" attr1="value1.1, value1.2" attr2="value two"
7046 .endd
7047 The &%extract%& operator in string expansions can be used to pick out
7048 individual fields from data that consists of &'key'&=&'value'& pairs. You can
7049 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7050 results of LDAP lookups.
7051
7052
7053
7054
7055 .section "More about NIS+" "SECTnisplus"
7056 .cindex "NIS+ lookup type"
7057 .cindex "lookup" "NIS+"
7058 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7059 and field name. If this is given, the result of a successful query is the
7060 contents of the named field; otherwise the result consists of a concatenation
7061 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7062 values containing spaces are quoted. For example, the query
7063 .code
7064 [name=mg1456],passwd.org_dir
7065 .endd
7066 might return the string
7067 .code
7068 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7069 home=/home/mg1456 shell=/bin/bash shadow=""
7070 .endd
7071 (split over two lines here to fit on the page), whereas
7072 .code
7073 [name=mg1456],passwd.org_dir:gcos
7074 .endd
7075 would just return
7076 .code
7077 Martin Guerre
7078 .endd
7079 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7080 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7081 operator is to double any quote characters within the text.
7082
7083
7084
7085 .section "SQL lookups" "SECTsql"
7086 .cindex "SQL lookup types"
7087 .cindex "MySQL" "lookup type"
7088 .cindex "PostgreSQL lookup type"
7089 .cindex "lookup" "MySQL"
7090 .cindex "lookup" "PostgreSQL"
7091 .cindex "Oracle" "lookup type"
7092 .cindex "lookup" "Oracle"
7093 .cindex "InterBase lookup type"
7094 .cindex "lookup" "InterBase"
7095 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, and SQLite
7096 databases. Queries for these databases contain SQL statements, so an example
7097 might be
7098 .code
7099 ${lookup mysql{select mailbox from users where id='userx'}\
7100   {$value}fail}
7101 .endd
7102 If the result of the query contains more than one field, the data for each
7103 field in the row is returned, preceded by its name, so the result of
7104 .code
7105 ${lookup pgsql{select home,name from users where id='userx'}\
7106   {$value}}
7107 .endd
7108 might be
7109 .code
7110 home=/home/userx name="Mister X"
7111 .endd
7112 Empty values and values containing spaces are double quoted, with embedded
7113 quotes escaped by a backslash. If the result of the query contains just one
7114 field, the value is passed back verbatim, without a field name, for example:
7115 .code
7116 Mister X
7117 .endd
7118 If the result of the query yields more than one row, it is all concatenated,
7119 with a newline between the data for each row.
7120
7121
7122 .section "More about MySQL, PostgreSQL, Oracle, and InterBase" "SECID72"
7123 .cindex "MySQL" "lookup type"
7124 .cindex "PostgreSQL lookup type"
7125 .cindex "lookup" "MySQL"
7126 .cindex "lookup" "PostgreSQL"
7127 .cindex "Oracle" "lookup type"
7128 .cindex "lookup" "Oracle"
7129 .cindex "InterBase lookup type"
7130 .cindex "lookup" "InterBase"
7131 If any MySQL, PostgreSQL, Oracle, or InterBase lookups are used, the
7132 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, or &%ibase_servers%&
7133 option (as appropriate) must be set to a colon-separated list of server
7134 information.
7135 (For MySQL and PostgreSQL only, the global option need not be set if all
7136 queries contain their own server information &-- see section
7137 &<<SECTspeserque>>&.) Each item in the list is a slash-separated list of four
7138 items: host name, database name, user name, and password. In the case of
7139 Oracle, the host name field is used for the &"service name"&, and the database
7140 name field is not used and should be empty. For example:
7141 .code
7142 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7143 .endd
7144 Because password data is sensitive, you should always precede the setting with
7145 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7146 option. Here is an example where two MySQL servers are listed:
7147 .code
7148 hide mysql_servers = localhost/users/root/secret:\
7149                      otherhost/users/root/othersecret
7150 .endd
7151 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7152 because this is a colon-separated list, the colon has to be doubled. For each
7153 query, these parameter groups are tried in order until a connection is made and
7154 a query is successfully processed. The result of a query may be that no data is
7155 found, but that is still a successful query. In other words, the list of
7156 servers provides a backup facility, not a list of different places to look.
7157
7158 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7159 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7160 respectively, and the characters single-quote, double-quote, and backslash
7161 itself are escaped with backslashes. The &%quote_pgsql%& expansion operator, in
7162 addition, escapes the percent and underscore characters. This cannot be done
7163 for MySQL because these escapes are not recognized in contexts where these
7164 characters are not special.
7165
7166 .section "Specifying the server in the query" "SECTspeserque"
7167 For MySQL and PostgreSQL lookups (but not currently for Oracle and InterBase),
7168 it is possible to specify a list of servers with an individual query. This is
7169 done by starting the query with
7170 .display
7171 &`servers=`&&'server1:server2:server3:...'&&`;`&
7172 .endd
7173 Each item in the list may take one of two forms:
7174 .olist
7175 If it contains no slashes it is assumed to be just a host name. The appropriate
7176 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7177 of the same name, and the remaining parameters (database, user, password) are
7178 taken from there.
7179 .next
7180 If it contains any slashes, it is taken as a complete parameter set.
7181 .endlist
7182 The list of servers is used in exactly the same way as the global list.
7183 Once a connection to a server has happened and a query has been
7184 successfully executed, processing of the lookup ceases.
7185
7186 This feature is intended for use in master/slave situations where updates
7187 are occurring and you want to update the master rather than a slave. If the
7188 master is in the list as a backup for reading, you might have a global setting
7189 like this:
7190 .code
7191 mysql_servers = slave1/db/name/pw:\
7192                 slave2/db/name/pw:\
7193                 master/db/name/pw
7194 .endd
7195 In an updating lookup, you could then write:
7196 .code
7197 ${lookup mysql{servers=master; UPDATE ...} }
7198 .endd
7199 That query would then be sent only to the master server. If, on the other hand,
7200 the master is not to be used for reading, and so is not present in the global
7201 option, you can still update it by a query of this form:
7202 .code
7203 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7204 .endd
7205
7206
7207 .section "Special MySQL features" "SECID73"
7208 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7209 causes a connection to the server on the local host by means of a Unix domain
7210 socket. An alternate socket can be specified in parentheses. The full syntax of
7211 each item in &%mysql_servers%& is:
7212 .display
7213 <&'hostname'&>::<&'port'&>(<&'socket name'&>)/<&'database'&>/&&&
7214   <&'user'&>/<&'password'&>
7215 .endd
7216 Any of the three sub-parts of the first field can be omitted. For normal use on
7217 the local host it can be left blank or set to just &"localhost"&.
7218
7219 No database need be supplied &-- but if it is absent here, it must be given in
7220 the queries.
7221
7222 If a MySQL query is issued that does not request any data (an insert, update,
7223 or delete command), the result of the lookup is the number of rows affected.
7224
7225 &*Warning*&: This can be misleading. If an update does not actually change
7226 anything (for example, setting a field to the value it already has), the result
7227 is zero because no rows are affected.
7228
7229
7230 .section "Special PostgreSQL features" "SECID74"
7231 PostgreSQL lookups can also use Unix domain socket connections to the database.
7232 This is usually faster and costs less CPU time than a TCP/IP connection.
7233 However it can be used only if the mail server runs on the same machine as the
7234 database server. A configuration line for PostgreSQL via Unix domain sockets
7235 looks like this:
7236 .code
7237 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7238 .endd
7239 In other words, instead of supplying a host name, a path to the socket is
7240 given. The path name is enclosed in parentheses so that its slashes aren't
7241 visually confused with the delimiters for the other server parameters.
7242
7243 If a PostgreSQL query is issued that does not request any data (an insert,
7244 update, or delete command), the result of the lookup is the number of rows
7245 affected.
7246
7247 .section "More about SQLite" "SECTsqlite"
7248 .cindex "lookup" "SQLite"
7249 .cindex "sqlite lookup type"
7250 SQLite is different to the other SQL lookups because a file name is required in
7251 addition to the SQL query. An SQLite database is a single file, and there is no
7252 daemon as in the other SQL databases. The interface to Exim requires the name
7253 of the file, as an absolute path, to be given at the start of the query. It is
7254 separated from the query by white space. This means that the path name cannot
7255 contain white space. Here is a lookup expansion example:
7256 .code
7257 ${lookup sqlite {/some/thing/sqlitedb \
7258   select name from aliases where id='userx';}}
7259 .endd
7260 In a list, the syntax is similar. For example:
7261 .code
7262 domainlist relay_domains = sqlite;/some/thing/sqlitedb \
7263    select * from relays where ip='$sender_host_address';
7264 .endd
7265 The only character affected by the &%quote_sqlite%& operator is a single
7266 quote, which it doubles.
7267
7268 The SQLite library handles multiple simultaneous accesses to the database
7269 internally. Multiple readers are permitted, but only one process can
7270 update at once. Attempts to access the database while it is being updated
7271 are rejected after a timeout period, during which the SQLite library
7272 waits for the lock to be released. In Exim, the default timeout is set
7273 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7274 option.
7275 .ecindex IIDfidalo1
7276 .ecindex IIDfidalo2
7277
7278
7279 . ////////////////////////////////////////////////////////////////////////////
7280 . ////////////////////////////////////////////////////////////////////////////
7281
7282 .chapter "Domain, host, address, and local part lists" &&&
7283          "CHAPdomhosaddlists" &&&
7284          "Domain, host, and address lists"
7285 .scindex IIDdohoadli "lists of domains; hosts; etc."
7286 A number of Exim configuration options contain lists of domains, hosts,
7287 email addresses, or local parts. For example, the &%hold_domains%& option
7288 contains a list of domains whose delivery is currently suspended. These lists
7289 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7290 arguments to expansion conditions such as &%match_domain%&.
7291
7292 Each item in one of these lists is a pattern to be matched against a domain,
7293 host, email address, or local part, respectively. In the sections below, the
7294 different types of pattern for each case are described, but first we cover some
7295 general facilities that apply to all four kinds of list.
7296
7297
7298
7299 .section "Expansion of lists" "SECID75"
7300 .cindex "expansion" "of lists"
7301 Each list is expanded as a single string before it is used. The result of
7302 expansion must be a list, possibly containing empty items, which is split up
7303 into separate items for matching. By default, colon is the separator character,
7304 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7305 &<<SECTempitelis>>& for details of the list syntax; the second of these
7306 discusses the way to specify empty list items.
7307
7308
7309 If the string expansion is forced to fail, Exim behaves as if the item it is
7310 testing (domain, host, address, or local part) is not in the list. Other
7311 expansion failures cause temporary errors.
7312
7313 If an item in a list is a regular expression, backslashes, dollars and possibly
7314 other special characters in the expression must be protected against
7315 misinterpretation by the string expander. The easiest way to do this is to use
7316 the &`\N`& expansion feature to indicate that the contents of the regular
7317 expression should not be expanded. For example, in an ACL you might have:
7318 .code
7319 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7320                ${lookup{$domain}lsearch{/badsenders/bydomain}}
7321 .endd
7322 The first item is a regular expression that is protected from expansion by
7323 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7324 senders based on the receiving domain.
7325
7326
7327
7328
7329 .section "Negated items in lists" "SECID76"
7330 .cindex "list" "negation"
7331 .cindex "negation" "in lists"
7332 Items in a list may be positive or negative. Negative items are indicated by a
7333 leading exclamation mark, which may be followed by optional white space. A list
7334 defines a set of items (domains, etc). When Exim processes one of these lists,
7335 it is trying to find out whether a domain, host, address, or local part
7336 (respectively) is in the set that is defined by the list. It works like this:
7337
7338 The list is scanned from left to right. If a positive item is matched, the
7339 subject that is being checked is in the set; if a negative item is matched, the
7340 subject is not in the set. If the end of the list is reached without the
7341 subject having matched any of the patterns, it is in the set if the last item
7342 was a negative one, but not if it was a positive one. For example, the list in
7343 .code
7344 domainlist relay_domains = !a.b.c : *.b.c
7345 .endd
7346 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7347 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7348 list is positive. However, if the setting were
7349 .code
7350 domainlist relay_domains = !a.b.c
7351 .endd
7352 then all domains other than &'a.b.c'& would match because the last item in the
7353 list is negative. In other words, a list that ends with a negative item behaves
7354 as if it had an extra item &`:*`& on the end.
7355
7356 Another way of thinking about positive and negative items in lists is to read
7357 the connector as &"or"& after a positive item and as &"and"& after a negative
7358 item.
7359
7360
7361
7362 .section "File names in lists" "SECTfilnamlis"
7363 .cindex "list" "file name in"
7364 If an item in a domain, host, address, or local part list is an absolute file
7365 name (beginning with a slash character), each line of the file is read and
7366 processed as if it were an independent item in the list, except that further
7367 file names are not allowed,
7368 and no expansion of the data from the file takes place.
7369 Empty lines in the file are ignored, and the file may also contain comment
7370 lines:
7371
7372 .ilist
7373 For domain and host lists, if a # character appears anywhere in a line of the
7374 file, it and all following characters are ignored.
7375 .next
7376 Because local parts may legitimately contain # characters, a comment in an
7377 address list or local part list file is recognized only if # is preceded by
7378 white space or the start of the line. For example:
7379 .code
7380 not#comment@x.y.z   # but this is a comment
7381 .endd
7382 .endlist
7383
7384 Putting a file name in a list has the same effect as inserting each line of the
7385 file as an item in the list (blank lines and comments excepted). However, there
7386 is one important difference: the file is read each time the list is processed,
7387 so if its contents vary over time, Exim's behaviour changes.
7388
7389 If a file name is preceded by an exclamation mark, the sense of any match
7390 within the file is inverted. For example, if
7391 .code
7392 hold_domains = !/etc/nohold-domains
7393 .endd
7394 and the file contains the lines
7395 .code
7396 !a.b.c
7397 *.b.c
7398 .endd
7399 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
7400 any domain matching &`*.b.c`& is not.
7401
7402
7403
7404 .section "An lsearch file is not an out-of-line list" "SECID77"
7405 As will be described in the sections that follow, lookups can be used in lists
7406 to provide indexed methods of checking list membership. There has been some
7407 confusion about the way &(lsearch)& lookups work in lists. Because
7408 an &(lsearch)& file contains plain text and is scanned sequentially, it is
7409 sometimes thought that it is allowed to contain wild cards and other kinds of
7410 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
7411 always fixed strings, just as for any other single-key lookup type.
7412
7413 If you want to use a file to contain wild-card patterns that form part of a
7414 list, just give the file name on its own, without a search type, as described
7415 in the previous section. You could also use the &(wildlsearch)& or
7416 &(nwildlsearch)&, but there is no advantage in doing this.
7417
7418
7419
7420
7421 .section "Named lists" "SECTnamedlists"
7422 .cindex "named lists"
7423 .cindex "list" "named"
7424 A list of domains, hosts, email addresses, or local parts can be given a name
7425 which is then used to refer to the list elsewhere in the configuration. This is
7426 particularly convenient if the same list is required in several different
7427 places. It also allows lists to be given meaningful names, which can improve
7428 the readability of the configuration. For example, it is conventional to define
7429 a domain list called &'local_domains'& for all the domains that are handled
7430 locally on a host, using a configuration line such as
7431 .code
7432 domainlist local_domains = localhost:my.dom.example
7433 .endd
7434 Named lists are referenced by giving their name preceded by a plus sign, so,
7435 for example, a router that is intended to handle local domains would be
7436 configured with the line
7437 .code
7438 domains = +local_domains
7439 .endd
7440 The first router in a configuration is often one that handles all domains
7441 except the local ones, using a configuration with a negated item like this:
7442 .code
7443 dnslookup:
7444   driver = dnslookup
7445   domains = ! +local_domains
7446   transport = remote_smtp
7447   no_more
7448 .endd
7449 The four kinds of named list are created by configuration lines starting with
7450 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
7451 respectively. Then there follows the name that you are defining, followed by an
7452 equals sign and the list itself. For example:
7453 .code
7454 hostlist    relay_hosts = 192.168.23.0/24 : my.friend.example
7455 addresslist bad_senders = cdb;/etc/badsenders
7456 .endd
7457 A named list may refer to other named lists:
7458 .code
7459 domainlist  dom1 = first.example : second.example
7460 domainlist  dom2 = +dom1 : third.example
7461 domainlist  dom3 = fourth.example : +dom2 : fifth.example
7462 .endd
7463 &*Warning*&: If the last item in a referenced list is a negative one, the
7464 effect may not be what you intended, because the negation does not propagate
7465 out to the higher level. For example, consider:
7466 .code
7467 domainlist  dom1 = !a.b
7468 domainlist  dom2 = +dom1 : *.b
7469 .endd
7470 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
7471 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
7472 means it matches the second list as well. The effect is not the same as
7473 .code
7474 domainlist  dom2 = !a.b : *.b
7475 .endd
7476 where &'x.y'& does not match. It's best to avoid negation altogether in
7477 referenced lists if you can.
7478
7479 Named lists may have a performance advantage. When Exim is routing an
7480 address or checking an incoming message, it caches the result of tests on named
7481 lists. So, if you have a setting such as
7482 .code
7483 domains = +local_domains
7484 .endd
7485 on several of your routers
7486 or in several ACL statements,
7487 the actual test is done only for the first one. However, the caching works only
7488 if there are no expansions within the list itself or any sublists that it
7489 references. In other words, caching happens only for lists that are known to be
7490 the same each time they are referenced.
7491
7492 By default, there may be up to 16 named lists of each type. This limit can be
7493 extended by changing a compile-time variable. The use of domain and host lists
7494 is recommended for concepts such as local domains, relay domains, and relay
7495 hosts. The default configuration is set up like this.
7496
7497
7498
7499 .section "Named lists compared with macros" "SECID78"
7500 .cindex "list" "named compared with macro"
7501 .cindex "macro" "compared with named list"
7502 At first sight, named lists might seem to be no different from macros in the
7503 configuration file. However, macros are just textual substitutions. If you
7504 write
7505 .code
7506 ALIST = host1 : host2
7507 auth_advertise_hosts = !ALIST
7508 .endd
7509 it probably won't do what you want, because that is exactly the same as
7510 .code
7511 auth_advertise_hosts = !host1 : host2
7512 .endd
7513 Notice that the second host name is not negated. However, if you use a host
7514 list, and write
7515 .code
7516 hostlist alist = host1 : host2
7517 auth_advertise_hosts = ! +alist
7518 .endd
7519 the negation applies to the whole list, and so that is equivalent to
7520 .code
7521 auth_advertise_hosts = !host1 : !host2
7522 .endd
7523
7524
7525 .section "Named list caching" "SECID79"
7526 .cindex "list" "caching of named"
7527 .cindex "caching" "named lists"
7528 While processing a message, Exim caches the result of checking a named list if
7529 it is sure that the list is the same each time. In practice, this means that
7530 the cache operates only if the list contains no $ characters, which guarantees
7531 that it will not change when it is expanded. Sometimes, however, you may have
7532 an expanded list that you know will be the same each time within a given
7533 message. For example:
7534 .code
7535 domainlist special_domains = \
7536            ${lookup{$sender_host_address}cdb{/some/file}}
7537 .endd
7538 This provides a list of domains that depends only on the sending host's IP
7539 address. If this domain list is referenced a number of times (for example,
7540 in several ACL lines, or in several routers) the result of the check is not
7541 cached by default, because Exim does not know that it is going to be the
7542 same list each time.
7543
7544 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
7545 cache the result anyway. For example:
7546 .code
7547 domainlist_cache special_domains = ${lookup{...
7548 .endd
7549 If you do this, you should be absolutely sure that caching is going to do
7550 the right thing in all cases. When in doubt, leave it out.
7551
7552
7553
7554 .section "Domain lists" "SECTdomainlist"
7555 .cindex "domain list" "patterns for"
7556 .cindex "list" "domain list"
7557 Domain lists contain patterns that are to be matched against a mail domain.
7558 The following types of item may appear in domain lists:
7559
7560 .ilist
7561 .cindex "primary host name"
7562 .cindex "host name" "matched in domain list"
7563 .oindex "&%primary_hostname%&"
7564 .cindex "domain list" "matching primary host name"
7565 .cindex "@ in a domain list"
7566 If a pattern consists of a single @ character, it matches the local host name,
7567 as set by the &%primary_hostname%& option (or defaulted). This makes it
7568 possible to use the same configuration file on several different hosts that
7569 differ only in their names.
7570 .next
7571 .cindex "@[] in a domain list"
7572 .cindex "domain list" "matching local IP interfaces"
7573 .cindex "domain literal"
7574 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
7575 in square brackets (as in an email address that contains a domain literal), but
7576 only if that IP address is recognized as local for email routing purposes. The
7577 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
7578 control which of a host's several IP addresses are treated as local.
7579 In today's Internet, the use of domain literals is controversial.
7580 .next
7581 .cindex "@mx_any"
7582 .cindex "@mx_primary"
7583 .cindex "@mx_secondary"
7584 .cindex "domain list" "matching MX pointers to local host"
7585 If a pattern consists of the string &`@mx_any`& it matches any domain that
7586 has an MX record pointing to the local host or to any host that is listed in
7587 .oindex "&%hosts_treat_as_local%&"
7588 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
7589 are similar, except that the first matches only when a primary MX target is the
7590 local host, and the second only when no primary MX target is the local host,
7591 but a secondary MX target is. &"Primary"& means an MX record with the lowest
7592 preference value &-- there may of course be more than one of them.
7593
7594 The MX lookup that takes place when matching a pattern of this type is
7595 performed with the resolver options for widening names turned off. Thus, for
7596 example, a single-component domain will &'not'& be expanded by adding the
7597 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
7598 options of the &(dnslookup)& router for a discussion of domain widening.
7599
7600 Sometimes you may want to ignore certain IP addresses when using one of these
7601 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
7602 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
7603 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
7604 on a router). For example:
7605 .code
7606 domains = @mx_any/ignore=127.0.0.1
7607 .endd
7608 This example matches any domain that has an MX record pointing to one of
7609 the local host's IP addresses other than 127.0.0.1.
7610
7611 The list of IP addresses is in fact processed by the same code that processes
7612 host lists, so it may contain CIDR-coded network specifications and it may also
7613 contain negative items.
7614
7615 Because the list of IP addresses is a sublist within a domain list, you have to
7616 be careful about delimiters if there is more than one address. Like any other
7617 list, the default delimiter can be changed. Thus, you might have:
7618 .code
7619 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
7620           an.other.domain : ...
7621 .endd
7622 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
7623 involved, it is easiest to change the delimiter for the main list as well:
7624 .code
7625 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
7626           an.other.domain ? ...
7627 .endd
7628 .next
7629 .cindex "asterisk" "in domain list"
7630 .cindex "domain list" "asterisk in"
7631 .cindex "domain list" "matching &""ends with""&"
7632 If a pattern starts with an asterisk, the remaining characters of the pattern
7633 are compared with the terminating characters of the domain. The use of &"*"& in
7634 domain lists differs from its use in partial matching lookups. In a domain
7635 list, the character following the asterisk need not be a dot, whereas partial
7636 matching works only in terms of dot-separated components. For example, a domain
7637 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
7638 &'cipher.key.ex'&.
7639
7640 .next
7641 .cindex "regular expressions" "in domain list"
7642 .cindex "domain list" "matching regular expression"
7643 If a pattern starts with a circumflex character, it is treated as a regular
7644 expression, and matched against the domain using a regular expression matching
7645 function. The circumflex is treated as part of the regular expression.
7646 Email domains are case-independent, so this regular expression match is by
7647 default case-independent, but you can make it case-dependent by starting it
7648 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
7649 are given in chapter &<<CHAPregexp>>&.
7650
7651 &*Warning*&: Because domain lists are expanded before being processed, you
7652 must escape any backslash and dollar characters in the regular expression, or
7653 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
7654 it is not to be expanded (unless you really do want to build a regular
7655 expression by expansion, of course).
7656 .next
7657 .cindex "lookup" "in domain list"
7658 .cindex "domain list" "matching by lookup"
7659 If a pattern starts with the name of a single-key lookup type followed by a
7660 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
7661 must be a file name in a suitable format for the lookup type. For example, for
7662 &"cdb;"& it must be an absolute path:
7663 .code
7664 domains = cdb;/etc/mail/local_domains.cdb
7665 .endd
7666 The appropriate type of lookup is done on the file using the domain name as the
7667 key. In most cases, the data that is looked up is not used; Exim is interested
7668 only in whether or not the key is present in the file. However, when a lookup
7669 is used for the &%domains%& option on a router
7670 or a &%domains%& condition in an ACL statement, the data is preserved in the
7671 &$domain_data$& variable and can be referred to in other router options or
7672 other statements in the same ACL.
7673
7674 .next
7675 Any of the single-key lookup type names may be preceded by
7676 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
7677 .code
7678 domains = partial-dbm;/partial/domains
7679 .endd
7680 This causes partial matching logic to be invoked; a description of how this
7681 works is given in section &<<SECTpartiallookup>>&.
7682
7683 .next
7684 .cindex "asterisk" "in lookup type"
7685 Any of the single-key lookup types may be followed by an asterisk. This causes
7686 a default lookup for a key consisting of a single asterisk to be done if the
7687 original lookup fails. This is not a useful feature when using a domain list to
7688 select particular domains (because any domain would match), but it might have
7689 value if the result of the lookup is being used via the &$domain_data$&
7690 expansion variable.
7691 .next
7692 If the pattern starts with the name of a query-style lookup type followed by a
7693 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
7694 pattern must be an appropriate query for the lookup type, as described in
7695 chapter &<<CHAPfdlookup>>&. For example:
7696 .code
7697 hold_domains = mysql;select domain from holdlist \
7698   where domain = '$domain';
7699 .endd
7700 In most cases, the data that is looked up is not used (so for an SQL query, for
7701 example, it doesn't matter what field you select). Exim is interested only in
7702 whether or not the query succeeds. However, when a lookup is used for the
7703 &%domains%& option on a router, the data is preserved in the &$domain_data$&
7704 variable and can be referred to in other options.
7705 .next
7706 .cindex "domain list" "matching literal domain name"
7707 If none of the above cases apply, a caseless textual comparison is made
7708 between the pattern and the domain.
7709 .endlist
7710
7711 Here is an example that uses several different kinds of pattern:
7712 .code
7713 domainlist funny_domains = \
7714   @ : \
7715   lib.unseen.edu : \
7716   *.foundation.fict.example : \
7717   \N^[1-2]\d{3}\.fict\.example$\N : \
7718   partial-dbm;/opt/data/penguin/book : \
7719   nis;domains.byname : \
7720   nisplus;[name=$domain,status=local],domains.org_dir
7721 .endd
7722 There are obvious processing trade-offs among the various matching modes. Using
7723 an asterisk is faster than a regular expression, and listing a few names
7724 explicitly probably is too. The use of a file or database lookup is expensive,
7725 but may be the only option if hundreds of names are required. Because the
7726 patterns are tested in order, it makes sense to put the most commonly matched
7727 patterns earlier.
7728
7729
7730
7731 .section "Host lists" "SECThostlist"
7732 .cindex "host list" "patterns in"
7733 .cindex "list" "host list"
7734 Host lists are used to control what remote hosts are allowed to do. For
7735 example, some hosts may be allowed to use the local host as a relay, and some
7736 may be permitted to use the SMTP ETRN command. Hosts can be identified in
7737 two different ways, by name or by IP address. In a host list, some types of
7738 pattern are matched to a host name, and some are matched to an IP address.
7739 You need to be particularly careful with this when single-key lookups are
7740 involved, to ensure that the right value is being used as the key.
7741
7742
7743 .section "Special host list patterns" "SECID80"
7744 .cindex "empty item in hosts list"
7745 .cindex "host list" "empty string in"
7746 If a host list item is the empty string, it matches only when no remote host is
7747 involved. This is the case when a message is being received from a local
7748 process using SMTP on the standard input, that is, when a TCP/IP connection is
7749 not used.
7750
7751 .cindex "asterisk" "in host list"
7752 The special pattern &"*"& in a host list matches any host or no host. Neither
7753 the IP address nor the name is actually inspected.
7754
7755
7756
7757 .section "Host list patterns that match by IP address" "SECThoslispatip"
7758 .cindex "host list" "matching IP addresses"
7759 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
7760 the incoming address actually appears in the IPv6 host as
7761 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
7762 list, it is converted into a traditional IPv4 address first. (Not all operating
7763 systems accept IPv4 calls on IPv6 sockets, as there have been some security
7764 concerns.)
7765
7766 The following types of pattern in a host list check the remote host by
7767 inspecting its IP address:
7768
7769 .ilist
7770 If the pattern is a plain domain name (not a regular expression, not starting
7771 with *, not a lookup of any kind), Exim calls the operating system function
7772 to find the associated IP address(es). Exim uses the newer
7773 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
7774 This typically causes a forward DNS lookup of the name. The result is compared
7775 with the IP address of the subject host.
7776
7777 If there is a temporary problem (such as a DNS timeout) with the host name
7778 lookup, a temporary error occurs. For example, if the list is being used in an
7779 ACL condition, the ACL gives a &"defer"& response, usually leading to a
7780 temporary SMTP error code. If no IP address can be found for the host name,
7781 what happens is described in section &<<SECTbehipnot>>& below.
7782
7783 .next
7784 .cindex "@ in a host list"
7785 If the pattern is &"@"&, the primary host name is substituted and used as a
7786 domain name, as just described.
7787
7788 .next
7789 If the pattern is an IP address, it is matched against the IP address of the
7790 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
7791 IPv6 addresses can be given in colon-separated format, but the colons have to
7792 be doubled so as not to be taken as item separators when the default list
7793 separator is used. IPv6 addresses are recognized even when Exim is compiled
7794 without IPv6 support. This means that if they appear in a host list on an
7795 IPv4-only host, Exim will not treat them as host names. They are just addresses
7796 that can never match a client host.
7797
7798 .next
7799 .cindex "@[] in a host list"
7800 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
7801 the local host. For example, if the local host is an IPv4 host with one
7802 interface address 10.45.23.56, these two ACL statements have the same effect:
7803 .code
7804 accept hosts = 127.0.0.1 : 10.45.23.56
7805 accept hosts = @[]
7806 .endd
7807 .next
7808 .cindex "CIDR notation"
7809 If the pattern is an IP address followed by a slash and a mask length (for
7810 example 10.11.42.0/24), it is matched against the IP address of the subject
7811 host under the given mask. This allows, an entire network of hosts to be
7812 included (or excluded) by a single item. The mask uses CIDR notation; it
7813 specifies the number of address bits that must match, starting from the most
7814 significant end of the address.
7815
7816 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
7817 of a range of addresses. It is the number of bits in the network portion of the
7818 address. The above example specifies a 24-bit netmask, so it matches all 256
7819 addresses in the 10.11.42.0 network. An item such as
7820 .code
7821 192.168.23.236/31
7822 .endd
7823 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
7824 32 for an IPv4 address is the same as no mask at all; just a single address
7825 matches.
7826
7827 Here is another example which shows an IPv4 and an IPv6 network:
7828 .code
7829 recipient_unqualified_hosts = 192.168.0.0/16: \
7830                               3ffe::ffff::836f::::/48
7831 .endd
7832 The doubling of list separator characters applies only when these items
7833 appear inline in a host list. It is not required when indirecting via a file.
7834 For example:
7835 .code
7836 recipient_unqualified_hosts = /opt/exim/unqualnets
7837 .endd
7838 could make use of a file containing
7839 .code
7840 172.16.0.0/12
7841 3ffe:ffff:836f::/48
7842 .endd
7843 to have exactly the same effect as the previous example. When listing IPv6
7844 addresses inline, it is usually more convenient to use the facility for
7845 changing separator characters. This list contains the same two networks:
7846 .code
7847 recipient_unqualified_hosts = <; 172.16.0.0/12; \
7848                                  3ffe:ffff:836f::/48
7849 .endd
7850 The separator is changed to semicolon by the leading &"<;"& at the start of the
7851 list.
7852 .endlist
7853
7854
7855
7856 .section "Host list patterns for single-key lookups by host address" &&&
7857          "SECThoslispatsikey"
7858 .cindex "host list" "lookup of IP address"
7859 When a host is to be identified by a single-key lookup of its complete IP
7860 address, the pattern takes this form:
7861 .display
7862 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
7863 .endd
7864 For example:
7865 .code
7866 hosts_lookup = net-cdb;/hosts-by-ip.db
7867 .endd
7868 The text form of the IP address of the subject host is used as the lookup key.
7869 IPv6 addresses are converted to an unabbreviated form, using lower case
7870 letters, with dots as separators because colon is the key terminator in
7871 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
7872 quoting the keys, but this is a facility that was added later.] The data
7873 returned by the lookup is not used.
7874
7875 .cindex "IP address" "masking"
7876 .cindex "host list" "masked IP address"
7877 Single-key lookups can also be performed using masked IP addresses, using
7878 patterns of this form:
7879 .display
7880 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
7881 .endd
7882 For example:
7883 .code
7884 net24-dbm;/networks.db
7885 .endd
7886 The IP address of the subject host is masked using <&'number'&> as the mask
7887 length. A textual string is constructed from the masked value, followed by the
7888 mask, and this is used as the lookup key. For example, if the host's IP address
7889 is 192.168.34.6, the key that is looked up for the above example is
7890 &"192.168.34.0/24"&.
7891
7892 When an IPv6 address is converted to a string, dots are normally used instead
7893 of colons, so that keys in &(lsearch)& files need not contain colons (which
7894 terminate &(lsearch)& keys). This was implemented some time before the ability
7895 to quote keys was made available in &(lsearch)& files. However, the more
7896 recently implemented &(iplsearch)& files do require colons in IPv6 keys
7897 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
7898 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
7899 converted using colons and not dots. In all cases, full, unabbreviated IPv6
7900 addresses are always used.
7901
7902 Ideally, it would be nice to tidy up this anomalous situation by changing to
7903 colons in all cases, given that quoting is now available for &(lsearch)&.
7904 However, this would be an incompatible change that might break some existing
7905 configurations.
7906
7907 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
7908 IPv6 address) is not the same as specifying just &%net-%& without a number. In
7909 the former case the key strings include the mask value, whereas in the latter
7910 case the IP address is used on its own.
7911
7912
7913
7914 .section "Host list patterns that match by host name" "SECThoslispatnam"
7915 .cindex "host" "lookup failures"
7916 .cindex "unknown host name"
7917 .cindex "host list" "matching host name"
7918 There are several types of pattern that require Exim to know the name of the
7919 remote host. These are either wildcard patterns or lookups by name. (If a
7920 complete hostname is given without any wildcarding, it is used to find an IP
7921 address to match against, as described in the section &<<SECThoslispatip>>&
7922 above.)
7923
7924 If the remote host name is not already known when Exim encounters one of these
7925 patterns, it has to be found from the IP address.
7926 Although many sites on the Internet are conscientious about maintaining reverse
7927 DNS data for their hosts, there are also many that do not do this.
7928 Consequently, a name cannot always be found, and this may lead to unwanted
7929 effects. Take care when configuring host lists with wildcarded name patterns.
7930 Consider what will happen if a name cannot be found.
7931
7932 Because of the problems of determining host names from IP addresses, matching
7933 against host names is not as common as matching against IP addresses.
7934
7935 By default, in order to find a host name, Exim first does a reverse DNS lookup;
7936 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
7937 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
7938 are done can be changed by setting the &%host_lookup_order%& option. For
7939 security, once Exim has found one or more names, it looks up the IP addresses
7940 for these names and compares them with the IP address that it started with.
7941 Only those names whose IP addresses match are accepted. Any other names are
7942 discarded. If no names are left, Exim behaves as if the host name cannot be
7943 found. In the most common case there is only one name and one IP address.
7944
7945 There are some options that control what happens if a host name cannot be
7946 found. These are described in section &<<SECTbehipnot>>& below.
7947
7948 .cindex "host" "alias for"
7949 .cindex "alias for host"
7950 As a result of aliasing, hosts may have more than one name. When processing any
7951 of the following types of pattern, all the host's names are checked:
7952
7953 .ilist
7954 .cindex "asterisk" "in host list"
7955 If a pattern starts with &"*"& the remainder of the item must match the end of
7956 the host name. For example, &`*.b.c`& matches all hosts whose names end in
7957 &'.b.c'&. This special simple form is provided because this is a very common
7958 requirement. Other kinds of wildcarding require the use of a regular
7959 expression.
7960 .next
7961 .cindex "regular expressions" "in host list"
7962 .cindex "host list" "regular expression in"
7963 If the item starts with &"^"& it is taken to be a regular expression which is
7964 matched against the host name. Host names are case-independent, so this regular
7965 expression match is by default case-independent, but you can make it
7966 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
7967 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
7968 example,
7969 .code
7970 ^(a|b)\.c\.d$
7971 .endd
7972 is a regular expression that matches either of the two hosts &'a.c.d'& or
7973 &'b.c.d'&. When a regular expression is used in a host list, you must take care
7974 that backslash and dollar characters are not misinterpreted as part of the
7975 string expansion. The simplest way to do this is to use &`\N`& to mark that
7976 part of the string as non-expandable. For example:
7977 .code
7978 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
7979 .endd
7980 &*Warning*&: If you want to match a complete host name, you must include the
7981 &`$`& terminating metacharacter in the regular expression, as in the above
7982 example. Without it, a match at the start of the host name is all that is
7983 required.
7984 .endlist
7985
7986
7987
7988
7989 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
7990 .cindex "host" "lookup failures, permanent"
7991 While processing a host list, Exim may need to look up an IP address from a
7992 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
7993 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
7994 behaviour when it fails to find the information it is seeking is the same.
7995
7996 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
7997 apply to temporary DNS errors, whose handling is described in the next section.
7998
7999 .cindex "&`+include_unknown`&"
8000 .cindex "&`+ignore_unknown`&"
8001 By default, Exim behaves as if the host does not match the list. This may not
8002 always be what you want to happen. To change Exim's behaviour, the special
8003 items &`+include_unknown`& or &`+ignore_unknown`& may appear in the list (at
8004 top level &-- they are not recognized in an indirected file).
8005
8006 .ilist
8007 If any item that follows &`+include_unknown`& requires information that
8008 cannot found, Exim behaves as if the host does match the list. For example,
8009 .code
8010 host_reject_connection = +include_unknown:*.enemy.ex
8011 .endd
8012 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8013 any hosts whose name it cannot find.
8014
8015 .next
8016 If any item that follows &`+ignore_unknown`& requires information that cannot
8017 be found, Exim ignores that item and proceeds to the rest of the list. For
8018 example:
8019 .code
8020 accept hosts = +ignore_unknown : friend.example : \
8021                192.168.4.5
8022 .endd
8023 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8024 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8025 name can be found for 192.168.4.5, it is rejected.
8026 .endlist
8027
8028 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8029 list. The effect of each one lasts until the next, or until the end of the
8030 list.
8031
8032
8033 .section "Temporary DNS errors when looking up host information" &&&
8034          "SECTtemdnserr"
8035 .cindex "host" "lookup failures, temporary"
8036 .cindex "&`+include_defer`&"
8037 .cindex "&`+ignore_defer`&"
8038 A temporary DNS lookup failure normally causes a defer action (except when
8039 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8040 host lists can include &`+ignore_defer`& and &`+include_defer`&, analagous to
8041 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8042 section. These options should be used with care, probably only in non-critical
8043 host lists such as whitelists.
8044
8045
8046
8047 .section "Host list patterns for single-key lookups by host name" &&&
8048          "SECThoslispatnamsk"
8049 .cindex "unknown host name"
8050 .cindex "host list" "matching host name"
8051 If a pattern is of the form
8052 .display
8053 <&'single-key-search-type'&>;<&'search-data'&>
8054 .endd
8055 for example
8056 .code
8057 dbm;/host/accept/list
8058 .endd
8059 a single-key lookup is performed, using the host name as its key. If the
8060 lookup succeeds, the host matches the item. The actual data that is looked up
8061 is not used.
8062
8063 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8064 keys in the file, not IP addresses. If you want to do lookups based on IP
8065 addresses, you must precede the search type with &"net-"& (see section
8066 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8067 two items in the same list, one doing an address lookup and one doing a name
8068 lookup, both using the same file.
8069
8070
8071
8072 .section "Host list patterns for query-style lookups" "SECID81"
8073 If a pattern is of the form
8074 .display
8075 <&'query-style-search-type'&>;<&'query'&>
8076 .endd
8077 the query is obeyed, and if it succeeds, the host matches the item. The actual
8078 data that is looked up is not used. The variables &$sender_host_address$& and
8079 &$sender_host_name$& can be used in the query. For example:
8080 .code
8081 hosts_lookup = pgsql;\
8082   select ip from hostlist where ip='$sender_host_address'
8083 .endd
8084 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8085 can use the &%sg%& expansion item to change this if you need to. If you want to
8086 use masked IP addresses in database queries, you can use the &%mask%& expansion
8087 operator.
8088
8089 If the query contains a reference to &$sender_host_name$&, Exim automatically
8090 looks up the host name if has not already done so. (See section
8091 &<<SECThoslispatnam>>& for comments on finding host names.)
8092
8093 Historical note: prior to release 4.30, Exim would always attempt to find a
8094 host name before running the query, unless the search type was preceded by
8095 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8096 still recognized for query-style lookups, but its presence or absence has no
8097 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8098 See section &<<SECThoslispatsikey>>&.)
8099
8100
8101
8102 .section "Mixing wildcarded host names and addresses in host lists" &&&
8103          "SECTmixwilhos"
8104 .cindex "host list" "mixing names and addresses in"
8105 If you have name lookups or wildcarded host names and IP addresses in the same
8106 host list, you should normally put the IP addresses first. For example, in an
8107 ACL you could have:
8108 .code
8109 accept hosts = 10.9.8.7 : *.friend.example
8110 .endd
8111 The reason for this lies in the left-to-right way that Exim processes lists.
8112 It can test IP addresses without doing any DNS lookups, but when it reaches an
8113 item that requires a host name, it fails if it cannot find a host name to
8114 compare with the pattern. If the above list is given in the opposite order, the
8115 &%accept%& statement fails for a host whose name cannot be found, even if its
8116 IP address is 10.9.8.7.
8117
8118 If you really do want to do the name check first, and still recognize the IP
8119 address, you can rewrite the ACL like this:
8120 .code
8121 accept hosts = *.friend.example
8122 accept hosts = 10.9.8.7
8123 .endd
8124 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8125 &<<CHAPACL>>& for details of ACLs.
8126
8127
8128
8129
8130
8131 .section "Address lists" "SECTaddresslist"
8132 .cindex "list" "address list"
8133 .cindex "address list" "empty item"
8134 .cindex "address list" "patterns"
8135 Address lists contain patterns that are matched against mail addresses. There
8136 is one special case to be considered: the sender address of a bounce message is
8137 always empty. You can test for this by providing an empty item in an address
8138 list. For example, you can set up a router to process bounce messages by
8139 using this option setting:
8140 .code
8141 senders = :
8142 .endd
8143 The presence of the colon creates an empty item. If you do not provide any
8144 data, the list is empty and matches nothing. The empty sender can also be
8145 detected by a regular expression that matches an empty string,
8146 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8147
8148 Non-empty items in an address list can be straightforward email addresses. For
8149 example:
8150 .code
8151 senders = jbc@askone.example : hs@anacreon.example
8152 .endd
8153 A certain amount of wildcarding is permitted. If a pattern contains an @
8154 character, but is not a regular expression and does not begin with a
8155 semicolon-terminated lookup type (described below), the local part of the
8156 subject address is compared with the local part of the pattern, which may start
8157 with an asterisk. If the local parts match, the domain is checked in exactly
8158 the same way as for a pattern in a domain list. For example, the domain can be
8159 wildcarded, refer to a named list, or be a lookup:
8160 .code
8161 deny senders = *@*.spamming.site:\
8162                *@+hostile_domains:\
8163                bozo@partial-lsearch;/list/of/dodgy/sites:\
8164                *@dbm;/bad/domains.db
8165 .endd
8166 .cindex "local part" "starting with !"
8167 .cindex "address list" "local part starting with !"
8168 If a local part that begins with an exclamation mark is required, it has to be
8169 specified using a regular expression, because otherwise the exclamation mark is
8170 treated as a sign of negation, as is standard in lists.
8171
8172 If a non-empty pattern that is not a regular expression or a lookup does not
8173 contain an @ character, it is matched against the domain part of the subject
8174 address. The only two formats that are recognized this way are a literal
8175 domain, or a domain pattern that starts with *. In both these cases, the effect
8176 is the same as if &`*@`& preceded the pattern. For example:
8177 .code
8178 deny senders = enemy.domain : *.enemy.domain
8179 .endd
8180
8181 The following kinds of more complicated address list pattern can match any
8182 address, including the empty address that is characteristic of bounce message
8183 senders:
8184
8185 .ilist
8186 .cindex "regular expressions" "in address list"
8187 .cindex "address list" "regular expression in"
8188 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8189 done against the complete address, with the pattern as the regular expression.
8190 You must take care that backslash and dollar characters are not misinterpreted
8191 as part of the string expansion. The simplest way to do this is to use &`\N`&
8192 to mark that part of the string as non-expandable. For example:
8193 .code
8194 deny senders = \N^.*this.*@example\.com$\N : \
8195                \N^\d{8}.+@spamhaus.example$\N : ...
8196 .endd
8197 The &`\N`& sequences are removed by the expansion, so these items do indeed
8198 start with &"^"& by the time they are being interpreted as address patterns.
8199
8200 .next
8201 .cindex "address list" "lookup for complete address"
8202 Complete addresses can be looked up by using a pattern that starts with a
8203 lookup type terminated by a semicolon, followed by the data for the lookup. For
8204 example:
8205 .code
8206 deny senders = cdb;/etc/blocked.senders : \
8207   mysql;select address from blocked where \
8208   address='${quote_mysql:$sender_address}'
8209 .endd
8210 Both query-style and single-key lookup types can be used. For a single-key
8211 lookup type, Exim uses the complete address as the key. However, empty keys are
8212 not supported for single-key lookups, so a match against the empty address
8213 always fails. This restriction does not apply to query-style lookups.
8214
8215 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8216 cannot be used, and is ignored if specified, with an entry being written to the
8217 panic log.
8218 .cindex "*@ with single-key lookup"
8219 However, you can configure lookup defaults, as described in section
8220 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8221 default. For example, with this lookup:
8222 .code
8223 accept senders = lsearch*@;/some/file
8224 .endd
8225 the file could contains lines like this:
8226 .code
8227 user1@domain1.example
8228 *@domain2.example
8229 .endd
8230 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8231 that are tried is:
8232 .code
8233 nimrod@jaeger.example
8234 *@jaeger.example
8235 *
8236 .endd
8237 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8238 would mean that every address matches, thus rendering the test useless.
8239
8240 &*Warning 2*&: Do not confuse these two kinds of item:
8241 .code
8242 deny recipients = dbm*@;/some/file
8243 deny recipients = *@dbm;/some/file
8244 .endd
8245 The first does a whole address lookup, with defaulting, as just described,
8246 because it starts with a lookup type. The second matches the local part and
8247 domain independently, as described in a bullet point below.
8248 .endlist
8249
8250
8251 The following kinds of address list pattern can match only non-empty addresses.
8252 If the subject address is empty, a match against any of these pattern types
8253 always fails.
8254
8255
8256 .ilist
8257 .cindex "@@ with single-key lookup"
8258 .cindex "address list" "@@ lookup type"
8259 .cindex "address list" "split local part and domain"
8260 If a pattern starts with &"@@"& followed by a single-key lookup item
8261 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8262 split into a local part and a domain. The domain is looked up in the file. If
8263 it is not found, there is no match. If it is found, the data that is looked up
8264 from the file is treated as a colon-separated list of local part patterns, each
8265 of which is matched against the subject local part in turn.
8266
8267 .cindex "asterisk" "in address list"
8268 The lookup may be a partial one, and/or one involving a search for a default
8269 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8270 patterns that are looked up can be regular expressions or begin with &"*"&, or
8271 even be further lookups. They may also be independently negated. For example,
8272 with
8273 .code
8274 deny senders = @@dbm;/etc/reject-by-domain
8275 .endd
8276 the data from which the DBM file is built could contain lines like
8277 .code
8278 baddomain.com:  !postmaster : *
8279 .endd
8280 to reject all senders except &%postmaster%& from that domain.
8281
8282 .cindex "local part" "starting with !"
8283 If a local part that actually begins with an exclamation mark is required, it
8284 has to be specified using a regular expression. In &(lsearch)& files, an entry
8285 may be split over several lines by indenting the second and subsequent lines,
8286 but the separating colon must still be included at line breaks. White space
8287 surrounding the colons is ignored. For example:
8288 .code
8289 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
8290 spammer3 : spammer4
8291 .endd
8292 As in all colon-separated lists in Exim, a colon can be included in an item by
8293 doubling.
8294
8295 If the last item in the list starts with a right angle-bracket, the remainder
8296 of the item is taken as a new key to look up in order to obtain a continuation
8297 list of local parts. The new key can be any sequence of characters. Thus one
8298 might have entries like
8299 .code
8300 aol.com: spammer1 : spammer 2 : >*
8301 xyz.com: spammer3 : >*
8302 *:       ^\d{8}$
8303 .endd
8304 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8305 local parts for all domains, in addition to the specific local parts listed for
8306 each domain. Of course, using this feature costs another lookup each time a
8307 chain is followed, but the effort needed to maintain the data is reduced.
8308
8309 .cindex "loop" "in lookups"
8310 It is possible to construct loops using this facility, and in order to catch
8311 them, the chains may be no more than fifty items long.
8312
8313 .next
8314 The @@<&'lookup'&> style of item can also be used with a query-style
8315 lookup, but in this case, the chaining facility is not available. The lookup
8316 can only return a single list of local parts.
8317 .endlist
8318
8319 &*Warning*&: There is an important difference between the address list items
8320 in these two examples:
8321 .code
8322 senders = +my_list
8323 senders = *@+my_list
8324 .endd
8325 In the first one, &`my_list`& is a named address list, whereas in the second
8326 example it is a named domain list.
8327
8328
8329
8330
8331 .section "Case of letters in address lists" "SECTcasletadd"
8332 .cindex "case of local parts"
8333 .cindex "address list" "case forcing"
8334 .cindex "case forcing in address lists"
8335 Domains in email addresses are always handled caselessly, but for local parts
8336 case may be significant on some systems (see &%caseful_local_part%& for how
8337 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8338 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8339 blocking lists should be done in a case-independent manner. Since most address
8340 lists in Exim are used for this kind of control, Exim attempts to do this by
8341 default.
8342
8343 The domain portion of an address is always lowercased before matching it to an
8344 address list. The local part is lowercased by default, and any string
8345 comparisons that take place are done caselessly. This means that the data in
8346 the address list itself, in files included as plain file names, and in any file
8347 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8348 keys in files that are looked up by a search type other than &(lsearch)& (which
8349 works caselessly) must be in lower case, because these lookups are not
8350 case-independent.
8351
8352 .cindex "&`+caseful`&"
8353 To allow for the possibility of caseful address list matching, if an item in
8354 an address list is the string &"+caseful"&, the original case of the local
8355 part is restored for any comparisons that follow, and string comparisons are no
8356 longer case-independent. This does not affect the domain, which remains in
8357 lower case. However, although independent matches on the domain alone are still
8358 performed caselessly, regular expressions that match against an entire address
8359 become case-sensitive after &"+caseful"& has been seen.
8360
8361
8362
8363 .section "Local part lists" "SECTlocparlis"
8364 .cindex "list" "local part list"
8365 .cindex "local part" "list"
8366 Case-sensitivity in local part lists is handled in the same way as for address
8367 lists, as just described. The &"+caseful"& item can be used if required. In a
8368 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
8369 set false, the subject is lowercased and the matching is initially
8370 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
8371 matching in the local part list, but not elsewhere in the router. If
8372 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
8373 option is case-sensitive from the start.
8374
8375 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
8376 comments are handled in the same way as address lists &-- they are recognized
8377 only if the # is preceded by white space or the start of the line.
8378 Otherwise, local part lists are matched in the same way as domain lists, except
8379 that the special items that refer to the local host (&`@`&, &`@[]`&,
8380 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
8381 Refer to section &<<SECTdomainlist>>& for details of the other available item
8382 types.
8383 .ecindex IIDdohoadli
8384
8385
8386
8387
8388 . ////////////////////////////////////////////////////////////////////////////
8389 . ////////////////////////////////////////////////////////////////////////////
8390
8391 .chapter "String expansions" "CHAPexpand"
8392 .scindex IIDstrexp "expansion" "of strings"
8393 Many strings in Exim's run time configuration are expanded before use. Some of
8394 them are expanded every time they are used; others are expanded only once.
8395
8396 When a string is being expanded it is copied verbatim from left to right except
8397 when a dollar or backslash character is encountered. A dollar specifies the
8398 start of a portion of the string that is interpreted and replaced as described
8399 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
8400 escape character, as described in the following section.
8401
8402
8403
8404 .section "Literal text in expanded strings" "SECTlittext"
8405 .cindex "expansion" "including literal text"
8406 An uninterpreted dollar can be included in an expanded string by putting a
8407 backslash in front of it. A backslash can be used to prevent any special
8408 character being treated specially in an expansion, including backslash itself.
8409 If the string appears in quotes in the configuration file, two backslashes are
8410 required because the quotes themselves cause interpretation of backslashes when
8411 the string is read in (see section &<<SECTstrings>>&).
8412
8413 .cindex "expansion" "non-expandable substrings"
8414 A portion of the string can specified as non-expandable by placing it between
8415 two occurrences of &`\N`&. This is particularly useful for protecting regular
8416 expressions, which often contain backslashes and dollar signs. For example:
8417 .code
8418 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
8419 .endd
8420 On encountering the first &`\N`&, the expander copies subsequent characters
8421 without interpretation until it reaches the next &`\N`& or the end of the
8422 string.
8423
8424
8425
8426 .section "Character escape sequences in expanded strings" "SECID82"
8427 .cindex "expansion" "escape sequences"
8428 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
8429 expanded string is recognized as an escape sequence for the character newline,
8430 carriage return, or tab, respectively. A backslash followed by up to three
8431 octal digits is recognized as an octal encoding for a single character, and a
8432 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
8433 encoding.
8434
8435 These escape sequences are also recognized in quoted strings when they are read
8436 in. Their interpretation in expansions as well is useful for unquoted strings,
8437 and for other cases such as looked-up strings that are then expanded.
8438
8439
8440 .section "Testing string expansions" "SECID83"
8441 .cindex "expansion" "testing"
8442 .cindex "testing" "string expansion"
8443 .oindex "&%-be%&"
8444 Many expansions can be tested by calling Exim with the &%-be%& option. This
8445 takes the command arguments, or lines from the standard input if there are no
8446 arguments, runs them through the string expansion code, and writes the results
8447 to the standard output. Variables based on configuration values are set up, but
8448 since no message is being processed, variables such as &$local_part$& have no
8449 value. Nevertheless the &%-be%& option can be useful for checking out file and
8450 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
8451 and &%nhash%&.
8452
8453 Exim gives up its root privilege when it is called with the &%-be%& option, and
8454 instead runs under the uid and gid it was called with, to prevent users from
8455 using &%-be%& for reading files to which they do not have access.
8456
8457 .oindex "&%-bem%&"
8458 If you want to test expansions that include variables whose values are taken
8459 from a message, there are two other options that can be used. The &%-bem%&
8460 option is like &%-be%& except that it is followed by a file name. The file is
8461 read as a message before doing the test expansions. For example:
8462 .code
8463 exim -bem /tmp/test.message '$h_subject:'
8464 .endd
8465 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
8466 Exim message identifier. For example:
8467 .code
8468 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
8469 .endd
8470 This loads the message from Exim's spool before doing the test expansions, and
8471 is therefore restricted to admin users.
8472
8473
8474 .section "Forced expansion failure" "SECTforexpfai"
8475 .cindex "expansion" "forced failure"
8476 A number of expansions that are described in the following section have
8477 alternative &"true"& and &"false"& substrings, enclosed in brace characters
8478 (which are sometimes called &"curly brackets"&). Which of the two strings is
8479 used depends on some condition that is evaluated as part of the expansion. If,
8480 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
8481 the entire string expansion fails in a way that can be detected by the code
8482 that requested the expansion. This is called &"forced expansion failure"&, and
8483 its consequences depend on the circumstances. In some cases it is no different
8484 from any other expansion failure, but in others a different action may be
8485 taken. Such variations are mentioned in the documentation of the option that is
8486 being expanded.
8487
8488
8489
8490
8491 .section "Expansion items" "SECTexpansionitems"
8492 The following items are recognized in expanded strings. White space may be used
8493 between sub-items that are keywords or substrings enclosed in braces inside an
8494 outer set of braces, to improve readability. &*Warning*&: Within braces,
8495 white space is significant.
8496
8497 .vlist
8498 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
8499 .cindex "expansion" "variables"
8500 Substitute the contents of the named variable, for example:
8501 .code
8502 $local_part
8503 ${domain}
8504 .endd
8505 The second form can be used to separate the name from subsequent alphanumeric
8506 characters. This form (using braces) is available only for variables; it does
8507 &'not'& apply to message headers. The names of the variables are given in
8508 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
8509 given, the expansion fails.
8510
8511 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
8512 .cindex "expansion" "operators"
8513 The string is first itself expanded, and then the operation specified by
8514 <&'op'&> is applied to it. For example:
8515 .code
8516 ${lc:$local_part}
8517 .endd
8518 The string starts with the first character after the colon, which may be
8519 leading white space. A list of operators is given in section &<<SECTexpop>>&
8520 below. The operator notation is used for simple expansion items that have just
8521 one argument, because it reduces the number of braces and therefore makes the
8522 string easier to understand.
8523
8524 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
8525 This item inserts &"basic"& header lines. It is described with the &%header%&
8526 expansion item below.
8527
8528 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
8529        {*&<&'arg'&>&*}...}*&"
8530 .cindex &%dlfunc%&
8531 This expansion dynamically loads and then calls a locally-written C function.
8532 This functionality is available only if Exim is compiled with
8533 .code
8534 EXPAND_DLFUNC=yes
8535 .endd
8536 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
8537 object so that it doesn't reload the same object file in the same Exim process
8538 (but of course Exim does start new processes frequently).
8539
8540 There may be from zero to eight arguments to the function. When compiling
8541 a local function that is to be called in this way, &_local_scan.h_& should be
8542 included. The Exim variables and functions that are defined by that API
8543 are also available for dynamically loaded functions. The function itself
8544 must have the following type:
8545 .code
8546 int dlfunction(uschar **yield, int argc, uschar *argv[])
8547 .endd
8548 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
8549 function should return one of the following values:
8550
8551 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
8552 into the expanded string that is being built.
8553
8554 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
8555 from &'yield'&, if it is set.
8556
8557 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
8558 taken from &'yield'& if it is set.
8559
8560 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
8561
8562 When compiling a function that is to be used in this way with gcc,
8563 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
8564 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
8565
8566 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
8567        {*&<&'string3'&>&*}}*&"
8568 .cindex "expansion" "extracting substrings by key"
8569 .cindex "&%extract%&" "substrings by key"
8570 The key and <&'string1'&> are first expanded separately. Leading and trailing
8571 white space is removed from the key (but not from any of the strings). The key
8572 must not consist entirely of digits. The expanded <&'string1'&> must be of the
8573 form:
8574 .display
8575 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
8576 .endd
8577 .vindex "&$value$&"
8578 where the equals signs and spaces (but not both) are optional. If any of the
8579 values contain white space, they must be enclosed in double quotes, and any
8580 values that are enclosed in double quotes are subject to escape processing as
8581 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
8582 for the value that corresponds to the key. The search is case-insensitive. If
8583 the key is found, <&'string2'&> is expanded, and replaces the whole item;
8584 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
8585 variable &$value$& contains the value that has been extracted. Afterwards, it
8586 is restored to any previous value it might have had.
8587
8588 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
8589 key is not found. If {<&'string2'&>} is also omitted, the value that was
8590 extracted is used. Thus, for example, these two expansions are identical, and
8591 yield &"2001"&:
8592 .code
8593 ${extract{gid}{uid=1984 gid=2001}}
8594 ${extract{gid}{uid=1984 gid=2001}{$value}}
8595 .endd
8596 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
8597 appear, for example:
8598 .code
8599 ${extract{Z}{A=... B=...}{$value} fail }
8600 .endd
8601 This forces an expansion failure (see section &<<SECTforexpfai>>&);
8602 {<&'string2'&>} must be present for &"fail"& to be recognized.
8603
8604
8605 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
8606         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
8607 .cindex "expansion" "extracting substrings by number"
8608 .cindex "&%extract%&" "substrings by number"
8609 The <&'number'&> argument must consist entirely of decimal digits,
8610 apart from leading and trailing white space, which is ignored.
8611 This is what distinguishes this form of &%extract%& from the previous kind. It
8612 behaves in the same way, except that, instead of extracting a named field, it
8613 extracts from <&'string1'&> the field whose number is given as the first
8614 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
8615 <&'string3'&> as before.
8616
8617 The fields in the string are separated by any one of the characters in the
8618 separator string. These may include space or tab characters.
8619 The first field is numbered one. If the number is negative, the fields are
8620 counted from the end of the string, with the rightmost one numbered -1. If the
8621 number given is zero, the entire string is returned. If the modulus of the
8622 number is greater than the number of fields in the string, the result is the
8623 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
8624 provided. For example:
8625 .code
8626 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
8627 .endd
8628 yields &"42"&, and
8629 .code
8630 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
8631 .endd
8632 yields &"99"&. Two successive separators mean that the field between them is
8633 empty (for example, the fifth field above).
8634
8635
8636 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
8637 .cindex "list" "selecting by condition"
8638 .cindex "expansion" "selecting from list by condition"
8639 .vindex "&$item$&"
8640 After expansion, <&'string'&> is interpreted as a list, colon-separated by
8641 default, but the separator can be changed in the usual way. For each item
8642 in this list, its value is place in &$item$&, and then the condition is
8643 evaluated. If the condition is true, &$item$& is added to the output as an
8644 item in a new list; if the condition is false, the item is discarded. The
8645 separator used for the output list is the same as the one used for the
8646 input, but a separator setting is not included in the output. For example:
8647 .code
8648 ${filter{a:b:c}{!eq{$item}{b}}
8649 .endd
8650 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
8651 to what it was before. See also the &*map*& and &*reduce*& expansion items.
8652
8653
8654 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
8655 .cindex "hash function" "textual"
8656 .cindex "expansion" "textual hash"
8657 This is a textual hashing function, and was the first to be implemented in
8658 early versions of Exim. In current releases, there are other hashing functions
8659 (numeric, MD5, and SHA-1), which are described below.
8660
8661 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
8662 <&'n'&>. If you are using fixed values for these numbers, that is, if
8663 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
8664 use the simpler operator notation that avoids some of the braces:
8665 .code
8666 ${hash_<n>_<m>:<string>}
8667 .endd
8668 The second number is optional (in both notations). If <&'n'&> is greater than
8669 or equal to the length of the string, the expansion item returns the string.
8670 Otherwise it computes a new string of length <&'n'&> by applying a hashing
8671 function to the string. The new string consists of characters taken from the
8672 first <&'m'&> characters of the string
8673 .code
8674 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
8675 .endd
8676 If <&'m'&> is not present the value 26 is used, so that only lower case
8677 letters appear. For example:
8678 .display
8679 &`$hash{3}{monty}}           `&   yields  &`jmg`&
8680 &`$hash{5}{monty}}           `&   yields  &`monty`&
8681 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
8682 .endd
8683
8684 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
8685         &*$h_*&<&'header&~name'&>&*:*&" &&&
8686        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
8687         &*$bh_*&<&'header&~name'&>&*:*&" &&&
8688        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
8689         &*$rh_*&<&'header&~name'&>&*:*&"
8690 .cindex "expansion" "header insertion"
8691 .vindex "&$header_$&"
8692 .vindex "&$bheader_$&"
8693 .vindex "&$rheader_$&"
8694 .cindex "header lines" "in expansion strings"
8695 .cindex "header lines" "character sets"
8696 .cindex "header lines" "decoding"
8697 Substitute the contents of the named message header line, for example
8698 .code
8699 $header_reply-to:
8700 .endd
8701 The newline that terminates a header line is not included in the expansion, but
8702 internal newlines (caused by splitting the header line over several physical
8703 lines) may be present.
8704
8705 The difference between &%rheader%&, &%bheader%&, and &%header%& is in the way
8706 the data in the header line is interpreted.
8707
8708 .ilist
8709 .cindex "white space" "in header lines"
8710 &%rheader%& gives the original &"raw"& content of the header line, with no
8711 processing at all, and without the removal of leading and trailing white space.
8712
8713 .next
8714 .cindex "base64 encoding" "in header lines"
8715 &%bheader%& removes leading and trailing white space, and then decodes base64
8716 or quoted-printable MIME &"words"& within the header text, but does no
8717 character set translation. If decoding of what looks superficially like a MIME
8718 &"word"& fails, the raw string is returned. If decoding
8719 .cindex "binary zero" "in header line"
8720 produces a binary zero character, it is replaced by a question mark &-- this is
8721 what Exim does for binary zeros that are actually received in header lines.
8722
8723 .next
8724 &%header%& tries to translate the string as decoded by &%bheader%& to a
8725 standard character set. This is an attempt to produce the same string as would
8726 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
8727 returned. Translation is attempted only on operating systems that support the
8728 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
8729 a system Makefile or in &_Local/Makefile_&.
8730 .endlist ilist
8731
8732 In a filter file, the target character set for &%header%& can be specified by a
8733 command of the following form:
8734 .code
8735 headers charset "UTF-8"
8736 .endd
8737 This command affects all references to &$h_$& (or &$header_$&) expansions in
8738 subsequently obeyed filter commands. In the absence of this command, the target
8739 character set in a filter is taken from the setting of the &%headers_charset%&
8740 option in the runtime configuration. The value of this option defaults to the
8741 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
8742 ISO-8859-1.
8743
8744 Header names follow the syntax of RFC 2822, which states that they may contain
8745 any printing characters except space and colon. Consequently, curly brackets
8746 &'do not'& terminate header names, and should not be used to enclose them as
8747 if they were variables. Attempting to do so causes a syntax error.
8748
8749 Only header lines that are common to all copies of a message are visible to
8750 this mechanism. These are the original header lines that are received with the
8751 message, and any that are added by an ACL statement or by a system
8752 filter. Header lines that are added to a particular copy of a message by a
8753 router or transport are not accessible.
8754
8755 For incoming SMTP messages, no header lines are visible in ACLs that are obeyed
8756 before the DATA ACL, because the header structure is not set up until the
8757 message is received. Header lines that are added in a RCPT ACL (for example)
8758 are saved until the message's incoming header lines are available, at which
8759 point they are added. When a DATA ACL is running, however, header lines added
8760 by earlier ACLs are visible.
8761
8762 Upper case and lower case letters are synonymous in header names. If the
8763 following character is white space, the terminating colon may be omitted, but
8764 this is not recommended, because you may then forget it when it is needed. When
8765 white space terminates the header name, it is included in the expanded string.
8766 If the message does not contain the given header, the expansion item is
8767 replaced by an empty string. (See the &%def%& condition in section
8768 &<<SECTexpcond>>& for a means of testing for the existence of a header.)
8769
8770 If there is more than one header with the same name, they are all concatenated
8771 to form the substitution string, up to a maximum length of 64K. Unless
8772 &%rheader%& is being used, leading and trailing white space is removed from
8773 each header before concatenation, and a completely empty header is ignored. A
8774 newline character is then inserted between non-empty headers, but there is no
8775 newline at the very end. For the &%header%& and &%bheader%& expansion, for
8776 those headers that contain lists of addresses, a comma is also inserted at the
8777 junctions between headers. This does not happen for the &%rheader%& expansion.
8778
8779
8780 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
8781 .cindex "expansion" "hmac hashing"
8782 .cindex &%hmac%&
8783 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
8784 shared secret and some text into a message authentication code, as specified in
8785 RFC 2104. This differs from &`${md5:secret_text...}`& or
8786 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
8787 cryptographic hash, allowing for authentication that is not possible with MD5
8788 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
8789 present. For example:
8790 .code
8791 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
8792 .endd
8793 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
8794 produces:
8795 .code
8796 dd97e3ba5d1a61b5006108f8c8252953
8797 .endd
8798 As an example of how this might be used, you might put in the main part of
8799 an Exim configuration:
8800 .code
8801 SPAMSCAN_SECRET=cohgheeLei2thahw
8802 .endd
8803 In a router or a transport you could then have:
8804 .code
8805 headers_add = \
8806   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
8807   ${hmac{md5}{SPAMSCAN_SECRET}\
8808   {${primary_hostname},${message_exim_id},$h_message-id:}}
8809 .endd
8810 Then given a message, you can check where it was scanned by looking at the
8811 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
8812 this header line is authentic by recomputing the authentication code from the
8813 host name, message ID and the &'Message-id:'& header line. This can be done
8814 using Exim's &%-be%& option, or by other means, for example by using the
8815 &'hmac_md5_hex()'& function in Perl.
8816
8817
8818 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
8819 .cindex "expansion" "conditional"
8820 .cindex "&%if%&, expansion item"
8821 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
8822 item; otherwise <&'string2'&> is used. The available conditions are described
8823 in section &<<SECTexpcond>>& below. For example:
8824 .code
8825 ${if eq {$local_part}{postmaster} {yes}{no} }
8826 .endd
8827 The second string need not be present; if it is not and the condition is not
8828 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
8829 be present instead of the second string (without any curly brackets). In this
8830 case, the expansion is forced to fail if the condition is not true (see section
8831 &<<SECTforexpfai>>&).
8832
8833 If both strings are omitted, the result is the string &`true`& if the condition
8834 is true, and the empty string if the condition is false. This makes it less
8835 cumbersome to write custom ACL and router conditions. For example, instead of
8836 .code
8837 condition = ${if >{$acl_m4}{3}{true}{false}}
8838 .endd
8839 you can use
8840 .code
8841 condition = ${if >{$acl_m4}{3}}
8842 .endd
8843
8844 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
8845 .cindex "expansion" "string truncation"
8846 .cindex "&%length%& expansion item"
8847 The &%length%& item is used to extract the initial portion of a string. Both
8848 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
8849 you are using a fixed value for the number, that is, if <&'string1'&> does not
8850 change when expanded, you can use the simpler operator notation that avoids
8851 some of the braces:
8852 .code
8853 ${length_<n>:<string>}
8854 .endd
8855 The result of this item is either the first <&'n'&> characters or the whole
8856 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
8857 &%strlen%&, which gives the length of a string.
8858
8859
8860 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
8861         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
8862 This is the first of one of two different types of lookup item, which are both
8863 described in the next item.
8864
8865 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
8866         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
8867 .cindex "expansion" "lookup in"
8868 .cindex "file" "lookups"
8869 .cindex "lookup" "in expanded string"
8870 The two forms of lookup item specify data lookups in files and databases, as
8871 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
8872 lookups, and the second is used for query-style lookups. The <&'key'&>,
8873 <&'file'&>, and <&'query'&> strings are expanded before use.
8874
8875 If there is any white space in a lookup item which is part of a filter command,
8876 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
8877 other place where white space is significant, the lookup item must be enclosed
8878 in double quotes. The use of data lookups in users' filter files may be locked
8879 out by the system administrator.
8880
8881 .vindex "&$value$&"
8882 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
8883 During its expansion, the variable &$value$& contains the data returned by the
8884 lookup. Afterwards it reverts to the value it had previously (at the outer
8885 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
8886 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
8887 string on failure. If <&'string2'&> is provided, it can itself be a nested
8888 lookup, thus providing a mechanism for looking up a default value when the
8889 original lookup fails.
8890
8891 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
8892 data for the outer lookup while the parameters of the second lookup are
8893 expanded, and also while <&'string2'&> of the second lookup is expanded, should
8894 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
8895 appear, and in this case, if the lookup fails, the entire expansion is forced
8896 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
8897 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
8898 successful lookup, and nothing in the case of failure.
8899
8900 For single-key lookups, the string &"partial"& is permitted to precede the
8901 search type in order to do partial matching, and * or *@ may follow a search
8902 type to request default lookups if the key does not match (see sections
8903 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
8904
8905 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
8906 If a partial search is used, the variables &$1$& and &$2$& contain the wild
8907 and non-wild parts of the key during the expansion of the replacement text.
8908 They return to their previous values at the end of the lookup item.
8909
8910 This example looks up the postmaster alias in the conventional alias file:
8911 .code
8912 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
8913 .endd
8914 This example uses NIS+ to look up the full name of the user corresponding to
8915 the local part of an address, forcing the expansion to fail if it is not found:
8916 .code
8917 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
8918   {$value}fail}
8919 .endd
8920
8921
8922 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
8923 .cindex "expansion" "list creation"
8924 .vindex "&$item$&"
8925 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
8926 default, but the separator can be changed in the usual way. For each item
8927 in this list, its value is place in &$item$&, and then <&'string2'&> is
8928 expanded and added to the output as an item in a new list. The separator used
8929 for the output list is the same as the one used for the input, but a separator
8930 setting is not included in the output. For example:
8931 .code
8932 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
8933 .endd
8934 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
8935 value of &$item$& is restored to what it was before. See also the &*filter*&
8936 and &*reduce*& expansion items.
8937
8938 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
8939 .cindex "expansion" "numeric hash"
8940 .cindex "hash function" "numeric"
8941 The three strings are expanded; the first two must yield numbers. Call them
8942 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
8943 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
8944 can use the simpler operator notation that avoids some of the braces:
8945 .code
8946 ${nhash_<n>_<m>:<string>}
8947 .endd
8948 The second number is optional (in both notations). If there is only one number,
8949 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
8950 processed by a div/mod hash function that returns two numbers, separated by a
8951 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
8952 example,
8953 .code
8954 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
8955 .endd
8956 returns the string &"6/33"&.
8957
8958
8959
8960 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
8961 .cindex "Perl" "use in expanded string"
8962 .cindex "expansion" "calling Perl from"
8963 This item is available only if Exim has been built to include an embedded Perl
8964 interpreter. The subroutine name and the arguments are first separately
8965 expanded, and then the Perl subroutine is called with those arguments. No
8966 additional arguments need be given; the maximum number permitted, including the
8967 name of the subroutine, is nine.
8968
8969 The return value of the subroutine is inserted into the expanded string, unless
8970 the return value is &%undef%&. In that case, the expansion fails in the same
8971 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
8972 Whatever you return is evaluated in a scalar context. For example, if you
8973 return the name of a Perl vector, the return value is the size of the vector,
8974 not its contents.
8975
8976 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
8977 with the error message that was passed to &%die%&. More details of the embedded
8978 Perl facility are given in chapter &<<CHAPperl>>&.
8979
8980 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
8981 out the use of this expansion item in filter files.
8982
8983
8984 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
8985 .cindex "&%prvs%& expansion item"
8986 The first argument is a complete email address and the second is secret
8987 keystring. The third argument, specifying a key number, is optional. If absent,
8988 it defaults to 0. The result of the expansion is a prvs-signed email address,
8989 to be typically used with the &%return_path%& option on an &(smtp)& transport
8990 as part of a bounce address tag validation (BATV) scheme. For more discussion
8991 and an example, see section &<<SECTverifyPRVS>>&.
8992
8993 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
8994         {*&<&'string'&>&*}}*&"
8995 .cindex "&%prvscheck%& expansion item"
8996 This expansion item is the complement of the &%prvs%& item. It is used for
8997 checking prvs-signed addresses. If the expansion of the first argument does not
8998 yield a syntactically valid prvs-signed address, the whole item expands to the
8999 empty string. When the first argument does expand to a syntactically valid
9000 prvs-signed address, the second argument is expanded, with the prvs-decoded
9001 version of the address and the key number extracted from the address in the
9002 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9003
9004 These two variables can be used in the expansion of the second argument to
9005 retrieve the secret. The validity of the prvs-signed address is then checked
9006 against the secret. The result is stored in the variable &$prvscheck_result$&,
9007 which is empty for failure or &"1"& for success.
9008
9009 The third argument is optional; if it is missing, it defaults to an empty
9010 string. This argument is now expanded. If the result is an empty string, the
9011 result of the expansion is the decoded version of the address. This is the case
9012 whether or not the signature was valid. Otherwise, the result of the expansion
9013 is the expansion of the third argument.
9014
9015 All three variables can be used in the expansion of the third argument.
9016 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9017 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9018
9019 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9020 .cindex "expansion" "inserting an entire file"
9021 .cindex "file" "inserting into expansion"
9022 .cindex "&%readfile%& expansion item"
9023 The file name and end-of-line string are first expanded separately. The file is
9024 then read, and its contents replace the entire item. All newline characters in
9025 the file are replaced by the end-of-line string if it is present. Otherwise,
9026 newlines are left in the string.
9027 String expansion is not applied to the contents of the file. If you want this,
9028 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9029 the string expansion fails.
9030
9031 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9032 locks out the use of this expansion item in filter files.
9033
9034
9035
9036 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9037         {*&<&'timeout'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9038 .cindex "expansion" "inserting from a socket"
9039 .cindex "socket, use of in expansion"
9040 .cindex "&%readsocket%& expansion item"
9041 This item inserts data from a Unix domain or Internet socket into the expanded
9042 string. The minimal way of using it uses just two arguments, as in these
9043 examples:
9044 .code
9045 ${readsocket{/socket/name}{request string}}
9046 ${readsocket{inet:some.host:1234}{request string}}
9047 .endd
9048 For a Unix domain socket, the first substring must be the path to the socket.
9049 For an Internet socket, the first substring must contain &`inet:`& followed by
9050 a host name or IP address, followed by a colon and a port, which can be a
9051 number or the name of a TCP port in &_/etc/services_&. An IP address may
9052 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9053 example:
9054 .code
9055 ${readsocket{inet:[::1]:1234}{request string}}
9056 .endd
9057 Only a single host name may be given, but if looking it up yields more than
9058 one IP address, they are each tried in turn until a connection is made. For
9059 both kinds of socket, Exim makes a connection, writes the request string
9060 (unless it is an empty string) and reads from the socket until an end-of-file
9061 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9062 extend what can be done. Firstly, you can vary the timeout. For example:
9063 .code
9064 ${readsocket{/socket/name}{request string}{3s}}
9065 .endd
9066 A fourth argument allows you to change any newlines that are in the data
9067 that is read, in the same way as for &%readfile%& (see above). This example
9068 turns them into spaces:
9069 .code
9070 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9071 .endd
9072 As with all expansions, the substrings are expanded before the processing
9073 happens. Errors in these sub-expansions cause the expansion to fail. In
9074 addition, the following errors can occur:
9075
9076 .ilist
9077 Failure to create a socket file descriptor;
9078 .next
9079 Failure to connect the socket;
9080 .next
9081 Failure to write the request string;
9082 .next
9083 Timeout on reading from the socket.
9084 .endlist
9085
9086 By default, any of these errors causes the expansion to fail. However, if
9087 you supply a fifth substring, it is expanded and used when any of the above
9088 errors occurs. For example:
9089 .code
9090 ${readsocket{/socket/name}{request string}{3s}{\n}\
9091   {socket failure}}
9092 .endd
9093 You can test for the existence of a Unix domain socket by wrapping this
9094 expansion in &`${if exists`&, but there is a race condition between that test
9095 and the actual opening of the socket, so it is safer to use the fifth argument
9096 if you want to be absolutely sure of avoiding an expansion error for a
9097 non-existent Unix domain socket, or a failure to connect to an Internet socket.
9098
9099 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
9100 locks out the use of this expansion item in filter files.
9101
9102
9103 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9104 .cindex "expansion" "reducing a list to a scalar"
9105 .cindex "list" "reducing to a scalar"
9106 .vindex "&$value$&"
9107 .vindex "&$item$&"
9108 This operation reduces a list to a single, scalar string. After expansion,
9109 <&'string1'&> is interpreted as a list, colon-separated by default, but the
9110 separator can be changed in the usual way. Then <&'string2'&> is expanded and
9111 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
9112 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
9113 them. The result of that expansion is assigned to &$value$& before the next
9114 iteration. When the end of the list is reached, the final value of &$value$& is
9115 added to the expansion output. The &*reduce*& expansion item can be used in a
9116 number of ways. For example, to add up a list of numbers:
9117 .code
9118 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
9119 .endd
9120 The result of that expansion would be &`6`&. The maximum of a list of numbers
9121 can be found:
9122 .code
9123 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
9124 .endd
9125 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
9126 restored to what they were before. See also the &*filter*& and &*map*&
9127 expansion items.
9128
9129 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
9130 This item inserts &"raw"& header lines. It is described with the &%header%&
9131 expansion item above.
9132
9133 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
9134         {*&<&'string2'&>&*}}*&"
9135 .cindex "expansion" "running a command"
9136 .cindex "&%run%& expansion item"
9137 The command and its arguments are first expanded separately, and then the
9138 command is run in a separate process, but under the same uid and gid. As in
9139 other command executions from Exim, a shell is not used by default. If you want
9140 a shell, you must explicitly code it.
9141
9142 The standard input for the command exists, but is empty. The standard output
9143 and standard error are set to the same file descriptor.
9144 .cindex "return code" "from &%run%& expansion"
9145 .vindex "&$value$&"
9146 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
9147 and replaces the entire item; during this expansion, the standard output/error
9148 from the command is in the variable &$value$&. If the command fails,
9149 <&'string2'&>, if present, is expanded and used. Once again, during the
9150 expansion, the standard output/error from the command is in the variable
9151 &$value$&.
9152
9153 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
9154 can be the word &"fail"& (not in braces) to force expansion failure if the
9155 command does not succeed. If both strings are omitted, the result is contents
9156 of the standard output/error on success, and nothing on failure.
9157
9158 .vindex "&$runrc$&"
9159 The return code from the command is put in the variable &$runrc$&, and this
9160 remains set afterwards, so in a filter file you can do things like this:
9161 .code
9162 if "${run{x y z}{}}$runrc" is 1 then ...
9163   elif $runrc is 2 then ...
9164   ...
9165 endif
9166 .endd
9167 If execution of the command fails (for example, the command does not exist),
9168 the return code is 127 &-- the same code that shells use for non-existent
9169 commands.
9170
9171 &*Warning*&: In a router or transport, you cannot assume the order in which
9172 option values are expanded, except for those preconditions whose order of
9173 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
9174 by the expansion of one option, and use it in another.
9175
9176 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
9177 out the use of this expansion item in filter files.
9178
9179
9180 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
9181 .cindex "expansion" "string substitution"
9182 .cindex "&%sg%& expansion item"
9183 This item works like Perl's substitution operator (s) with the global (/g)
9184 option; hence its name. However, unlike the Perl equivalent, Exim does not
9185 modify the subject string; instead it returns the modified string for insertion
9186 into the overall expansion. The item takes three arguments: the subject string,
9187 a regular expression, and a substitution string. For example:
9188 .code
9189 ${sg{abcdefabcdef}{abc}{xyz}}
9190 .endd
9191 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
9192 if any $ or \ characters are required in the regular expression or in the
9193 substitution string, they have to be escaped. For example:
9194 .code
9195 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
9196 .endd
9197 yields &"defabc"&, and
9198 .code
9199 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
9200 .endd
9201 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
9202 the regular expression from string expansion.
9203
9204
9205
9206 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9207 .cindex "&%substr%& expansion item"
9208 .cindex "substring extraction"
9209 .cindex "expansion" "substring extraction"
9210 The three strings are expanded; the first two must yield numbers. Call them
9211 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9212 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9213 can use the simpler operator notation that avoids some of the braces:
9214 .code
9215 ${substr_<n>_<m>:<string>}
9216 .endd
9217 The second number is optional (in both notations).
9218 If it is absent in the simpler format, the preceding underscore must also be
9219 omitted.
9220
9221 The &%substr%& item can be used to extract more general substrings than
9222 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
9223 length required. For example
9224 .code
9225 ${substr{3}{2}{$local_part}}
9226 .endd
9227 If the starting offset is greater than the string length the result is the
9228 null string; if the length plus starting offset is greater than the string
9229 length, the result is the right-hand part of the string, starting from the
9230 given offset. The first character in the string has offset zero.
9231
9232 The &%substr%& expansion item can take negative offset values to count
9233 from the right-hand end of its operand. The last character is offset -1, the
9234 second-last is offset -2, and so on. Thus, for example,
9235 .code
9236 ${substr{-5}{2}{1234567}}
9237 .endd
9238 yields &"34"&. If the absolute value of a negative offset is greater than the
9239 length of the string, the substring starts at the beginning of the string, and
9240 the length is reduced by the amount of overshoot. Thus, for example,
9241 .code
9242 ${substr{-5}{2}{12}}
9243 .endd
9244 yields an empty string, but
9245 .code
9246 ${substr{-3}{2}{12}}
9247 .endd
9248 yields &"1"&.
9249
9250 When the second number is omitted from &%substr%&, the remainder of the string
9251 is taken if the offset is positive. If it is negative, all characters in the
9252 string preceding the offset point are taken. For example, an offset of -1 and
9253 no length, as in these semantically identical examples:
9254 .code
9255 ${substr_-1:abcde}
9256 ${substr{-1}{abcde}}
9257 .endd
9258 yields all but the last character of the string, that is, &"abcd"&.
9259
9260
9261
9262 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
9263         {*&<&'replacements'&>&*}}*&"
9264 .cindex "expansion" "character translation"
9265 .cindex "&%tr%& expansion item"
9266 This item does single-character translation on its subject string. The second
9267 argument is a list of characters to be translated in the subject string. Each
9268 matching character is replaced by the corresponding character from the
9269 replacement list. For example
9270 .code
9271 ${tr{abcdea}{ac}{13}}
9272 .endd
9273 yields &`1b3de1`&. If there are duplicates in the second character string, the
9274 last occurrence is used. If the third string is shorter than the second, its
9275 last character is replicated. However, if it is empty, no translation takes
9276 place.
9277 .endlist
9278
9279
9280
9281 .section "Expansion operators" "SECTexpop"
9282 .cindex "expansion" "operators"
9283 For expansion items that perform transformations on a single argument string,
9284 the &"operator"& notation is used because it is simpler and uses fewer braces.
9285 The substring is first expanded before the operation is applied to it. The
9286 following operations can be performed:
9287
9288 .vlist
9289 .vitem &*${address:*&<&'string'&>&*}*&
9290 .cindex "expansion" "RFC 2822 address handling"
9291 .cindex "&%address%& expansion item"
9292 The string is interpreted as an RFC 2822 address, as it might appear in a
9293 header line, and the effective address is extracted from it. If the string does
9294 not parse successfully, the result is empty.
9295
9296
9297 .vitem &*${addresses:*&<&'string'&>&*}*&
9298 .cindex "expansion" "RFC 2822 address handling"
9299 .cindex "&%addresses%& expansion item"
9300 The string (after expansion) is interpreted as a list of addresses in RFC
9301 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
9302 operative address (&'local-part@domain'&) is extracted from each item, and the
9303 result of the expansion is a colon-separated list, with appropriate
9304 doubling of colons should any happen to be present in the email addresses.
9305 Syntactically invalid RFC2822 address items are omitted from the output.
9306
9307 It is possible to specify a character other than colon for the output
9308 separator by starting the string with > followed by the new separator
9309 character. For example:
9310 .code
9311 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
9312 .endd
9313 expands to &`ceo@up.stairs&&sec@base.ment`&. Compare the &*address*& (singular)
9314 expansion item, which extracts the working address from a single RFC2822
9315 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
9316 processing lists.
9317
9318
9319 .vitem &*${base62:*&<&'digits'&>&*}*&
9320 .cindex "&%base62%& expansion item"
9321 .cindex "expansion" "conversion to base 62"
9322 The string must consist entirely of decimal digits. The number is converted to
9323 base 62 and output as a string of six characters, including leading zeros. In
9324 the few operating environments where Exim uses base 36 instead of base 62 for
9325 its message identifiers (because those systems do not have case-sensitive file
9326 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
9327 be absolutely clear: this is &'not'& base64 encoding.
9328
9329 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
9330 .cindex "&%base62d%& expansion item"
9331 .cindex "expansion" "conversion to base 62"
9332 The string must consist entirely of base-62 digits, or, in operating
9333 environments where Exim uses base 36 instead of base 62 for its message
9334 identifiers, base-36 digits. The number is converted to decimal and output as a
9335 string.
9336
9337 .vitem &*${domain:*&<&'string'&>&*}*&
9338 .cindex "domain" "extraction"
9339 .cindex "expansion" "domain extraction"
9340 The string is interpreted as an RFC 2822 address and the domain is extracted
9341 from it. If the string does not parse successfully, the result is empty.
9342
9343
9344 .vitem &*${escape:*&<&'string'&>&*}*&
9345 .cindex "expansion" "escaping non-printing characters"
9346 .cindex "&%escape%& expansion item"
9347 If the string contains any non-printing characters, they are converted to
9348 escape sequences starting with a backslash. Whether characters with the most
9349 significant bit set (so-called &"8-bit characters"&) count as printing or not
9350 is controlled by the &%print_topbitchars%& option.
9351
9352
9353 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
9354 .cindex "expansion" "expression evaluation"
9355 .cindex "expansion" "arithmetic expression"
9356 .cindex "&%eval%& expansion item"
9357 These items supports simple arithmetic and bitwise logical operations in
9358 expansion strings. The string (after expansion) must be a conventional
9359 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
9360 logical operators, and parentheses. All operations are carried out using
9361 integer arithmetic. The operator priorities are as follows (the same as in the
9362 C programming language):
9363 .table2 70pt 300pt
9364 .irow &'highest:'& "not (~), negate (-)"
9365 .irow ""   "multiply (*), divide (/), remainder (%)"
9366 .irow ""   "plus (+), minus (-)"
9367 .irow ""   "shift-left (<<), shift-right (>>)"
9368 .irow ""   "and (&&)"
9369 .irow ""   "xor (^)"
9370 .irow &'lowest:'&  "or (|)"
9371 .endtable
9372 Binary operators with the same priority are evaluated from left to right. White
9373 space is permitted before or after operators.
9374
9375 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
9376 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
9377 decimal, even if they start with a leading zero; hexadecimal numbers are not
9378 permitted. This can be useful when processing numbers extracted from dates or
9379 times, which often do have leading zeros.
9380
9381 A number may be followed by &"K"& or &"M"& to multiply it by 1024 or 1024*1024,
9382 respectively. Negative numbers are supported. The result of the computation is
9383 a decimal representation of the answer (without &"K"& or &"M"&). For example:
9384
9385 .display
9386 &`${eval:1+1}            `&  yields 2
9387 &`${eval:1+2*3}          `&  yields 7
9388 &`${eval:(1+2)*3}        `&  yields 9
9389 &`${eval:2+42%5}         `&  yields 4
9390 &`${eval:0xc&amp;5}          `&  yields 4
9391 &`${eval:0xc|5}          `&  yields 13
9392 &`${eval:0xc^5}          `&  yields 9
9393 &`${eval:0xc>>1}         `&  yields 6
9394 &`${eval:0xc<<1}         `&  yields 24
9395 &`${eval:~255&amp;0x1234}    `&  yields 4608
9396 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
9397 .endd
9398
9399 As a more realistic example, in an ACL you might have
9400 .code
9401 deny   message = Too many bad recipients
9402        condition =                    \
9403          ${if and {                   \
9404            {>{$rcpt_count}{10}}       \
9405            {                          \
9406            <                          \
9407              {$recipients_count}      \
9408              {${eval:$rcpt_count/2}}  \
9409            }                          \
9410          }{yes}{no}}
9411 .endd
9412 The condition is true if there have been more than 10 RCPT commands and
9413 fewer than half of them have resulted in a valid recipient.
9414
9415
9416 .vitem &*${expand:*&<&'string'&>&*}*&
9417 .cindex "expansion" "re-expansion of substring"
9418 The &%expand%& operator causes a string to be expanded for a second time. For
9419 example,
9420 .code
9421 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
9422 .endd
9423 first looks up a string in a file while expanding the operand for &%expand%&,
9424 and then re-expands what it has found.
9425
9426
9427 .vitem &*${from_utf8:*&<&'string'&>&*}*&
9428 .cindex "Unicode"
9429 .cindex "UTF-8" "conversion from"
9430 .cindex "expansion" "UTF-8 conversion"
9431 .cindex "&%from_utf8%& expansion item"
9432 The world is slowly moving towards Unicode, although there are no standards for
9433 email yet. However, other applications (including some databases) are starting
9434 to store data in Unicode, using UTF-8 encoding. This operator converts from a
9435 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
9436 converted to underscores. The input must be a valid UTF-8 string. If it is not,
9437 the result is an undefined sequence of bytes.
9438
9439 Unicode code points with values less than 256 are compatible with ASCII and
9440 ISO-8859-1 (also known as Latin-1).
9441 For example, character 169 is the copyright symbol in both cases, though the
9442 way it is encoded is different. In UTF-8, more than one byte is needed for
9443 characters with code values greater than 127, whereas ISO-8859-1 is a
9444 single-byte encoding (but thereby limited to 256 characters). This makes
9445 translation from UTF-8 to ISO-8859-1 straightforward.
9446
9447
9448 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
9449 .cindex "hash function" "textual"
9450 .cindex "expansion" "textual hash"
9451 The &%hash%& operator is a simpler interface to the hashing function that can
9452 be used when the two parameters are fixed numbers (as opposed to strings that
9453 change when expanded). The effect is the same as
9454 .code
9455 ${hash{<n>}{<m>}{<string>}}
9456 .endd
9457 See the description of the general &%hash%& item above for details. The
9458 abbreviation &%h%& can be used when &%hash%& is used as an operator.
9459
9460
9461
9462 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
9463 .cindex "base64 encoding" "conversion from hex"
9464 .cindex "expansion" "hex to base64"
9465 .cindex "&%hex2b64%& expansion item"
9466 This operator converts a hex string into one that is base64 encoded. This can
9467 be useful for processing the output of the MD5 and SHA-1 hashing functions.
9468
9469
9470 .vitem &*${lc:*&<&'string'&>&*}*&
9471 .cindex "case forcing in strings"
9472 .cindex "string" "case forcing"
9473 .cindex "lower casing"
9474 .cindex "expansion" "case forcing"
9475 .cindex "&%lc%& expansion item"
9476 This forces the letters in the string into lower-case, for example:
9477 .code
9478 ${lc:$local_part}
9479 .endd
9480
9481 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
9482 .cindex "expansion" "string truncation"
9483 .cindex "&%length%& expansion item"
9484 The &%length%& operator is a simpler interface to the &%length%& function that
9485 can be used when the parameter is a fixed number (as opposed to a string that
9486 changes when expanded). The effect is the same as
9487 .code
9488 ${length{<number>}{<string>}}
9489 .endd
9490 See the description of the general &%length%& item above for details. Note that
9491 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
9492 when &%length%& is used as an operator.
9493
9494
9495 .vitem &*${local_part:*&<&'string'&>&*}*&
9496 .cindex "expansion" "local part extraction"
9497 .cindex "&%local_part%& expansion item"
9498 The string is interpreted as an RFC 2822 address and the local part is
9499 extracted from it. If the string does not parse successfully, the result is
9500 empty.
9501
9502
9503 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
9504 .cindex "masked IP address"
9505 .cindex "IP address" "masking"
9506 .cindex "CIDR notation"
9507 .cindex "expansion" "IP address masking"
9508 .cindex "&%mask%& expansion item"
9509 If the form of the string to be operated on is not an IP address followed by a
9510 slash and an integer (that is, a network address in CIDR notation), the
9511 expansion fails. Otherwise, this operator converts the IP address to binary,
9512 masks off the least significant bits according to the bit count, and converts
9513 the result back to text, with mask appended. For example,
9514 .code
9515 ${mask:10.111.131.206/28}
9516 .endd
9517 returns the string &"10.111.131.192/28"&. Since this operation is expected to
9518 be mostly used for looking up masked addresses in files, the result for an IPv6
9519 address uses dots to separate components instead of colons, because colon
9520 terminates a key string in lsearch files. So, for example,
9521 .code
9522 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
9523 .endd
9524 returns the string
9525 .code
9526 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
9527 .endd
9528 Letters in IPv6 addresses are always output in lower case.
9529
9530
9531 .vitem &*${md5:*&<&'string'&>&*}*&
9532 .cindex "MD5 hash"
9533 .cindex "expansion" "MD5 hash"
9534 .cindex "&%md5%& expansion item"
9535 The &%md5%& operator computes the MD5 hash value of the string, and returns it
9536 as a 32-digit hexadecimal number, in which any letters are in lower case.
9537
9538
9539 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
9540 .cindex "expansion" "numeric hash"
9541 .cindex "hash function" "numeric"
9542 The &%nhash%& operator is a simpler interface to the numeric hashing function
9543 that can be used when the two parameters are fixed numbers (as opposed to
9544 strings that change when expanded). The effect is the same as
9545 .code
9546 ${nhash{<n>}{<m>}{<string>}}
9547 .endd
9548 See the description of the general &%nhash%& item above for details.
9549
9550
9551 .vitem &*${quote:*&<&'string'&>&*}*&
9552 .cindex "quoting" "in string expansions"
9553 .cindex "expansion" "quoting"
9554 .cindex "&%quote%& expansion item"
9555 The &%quote%& operator puts its argument into double quotes if it
9556 is an empty string or
9557 contains anything other than letters, digits, underscores, dots, and hyphens.
9558 Any occurrences of double quotes and backslashes are escaped with a backslash.
9559 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
9560 respectively For example,
9561 .code
9562 ${quote:ab"*"cd}
9563 .endd
9564 becomes
9565 .code
9566 "ab\"*\"cd"
9567 .endd
9568 The place where this is useful is when the argument is a substitution from a
9569 variable or a message header.
9570
9571 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
9572 .cindex "&%quote_local_part%& expansion item"
9573 This operator is like &%quote%&, except that it quotes the string only if
9574 required to do so by the rules of RFC 2822 for quoting local parts. For
9575 example, a plus sign would not cause quoting (but it would for &%quote%&).
9576 If you are creating a new email address from the contents of &$local_part$&
9577 (or any other unknown data), you should always use this operator.
9578
9579
9580 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
9581 .cindex "quoting" "lookup-specific"
9582 This operator applies lookup-specific quoting rules to the string. Each
9583 query-style lookup type has its own quoting rules which are described with
9584 the lookups in chapter &<<CHAPfdlookup>>&. For example,
9585 .code
9586 ${quote_ldap:two * two}
9587 .endd
9588 returns
9589 .code
9590 two%20%5C2A%20two
9591 .endd
9592 For single-key lookup types, no quoting is ever necessary and this operator
9593 yields an unchanged string.
9594
9595
9596 .vitem &*${randint:*&<&'n'&>&*}*&
9597 .cindex "random number"
9598 This operator returns a somewhat random number which is less than the
9599 supplied number and is at least 0.  The quality of this randomness depends
9600 on how Exim was built; the values are not suitable for keying material.
9601 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
9602 Otherwise, the implementation may be arc4random(), random() seeded by
9603 srandomdev() or srandom(), or a custom implementation even weaker than
9604 random().
9605
9606
9607 .vitem &*${rfc2047:*&<&'string'&>&*}*&
9608 .cindex "expansion" "RFC 2047"
9609 .cindex "RFC 2047" "expansion operator"
9610 .cindex "&%rfc2047%& expansion item"
9611 This operator encodes text according to the rules of RFC 2047. This is an
9612 encoding that is used in header lines to encode non-ASCII characters. It is
9613 assumed that the input string is in the encoding specified by the
9614 &%headers_charset%& option, which defaults to ISO-8859-1. If the string
9615 contains only characters in the range 33&--126, and no instances of the
9616 characters
9617 .code
9618 ? = ( ) < > @ , ; : \ " . [ ] _
9619 .endd
9620 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
9621 string, using as many &"encoded words"& as necessary to encode all the
9622 characters.
9623
9624
9625 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
9626 .cindex "expansion" "RFC 2047"
9627 .cindex "RFC 2047" "decoding"
9628 .cindex "&%rfc2047d%& expansion item"
9629 This operator decodes strings that are encoded as per RFC 2047. Binary zero
9630 bytes are replaced by question marks. Characters are converted into the
9631 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
9632 not recognized unless &%check_rfc2047_length%& is set false.
9633
9634 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
9635 access a header line, RFC 2047 decoding is done automatically. You do not need
9636 to use this operator as well.
9637
9638
9639
9640 .vitem &*${rxquote:*&<&'string'&>&*}*&
9641 .cindex "quoting" "in regular expressions"
9642 .cindex "regular expressions" "quoting"
9643 .cindex "&%rxquote%& expansion item"
9644 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
9645 characters in its argument. This is useful when substituting the values of
9646 variables or headers inside regular expressions.
9647
9648
9649 .vitem &*${sha1:*&<&'string'&>&*}*&
9650 .cindex "SHA-1 hash"
9651 .cindex "expansion" "SHA-1 hashing"
9652 .cindex "&%sha2%& expansion item"
9653 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
9654 it as a 40-digit hexadecimal number, in which any letters are in upper case.
9655
9656
9657 .vitem &*${stat:*&<&'string'&>&*}*&
9658 .cindex "expansion" "statting a file"
9659 .cindex "file" "extracting characteristics"
9660 .cindex "&%stat%& expansion item"
9661 The string, after expansion, must be a file path. A call to the &[stat()]&
9662 function is made for this path. If &[stat()]& fails, an error occurs and the
9663 expansion fails. If it succeeds, the data from the stat replaces the item, as a
9664 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
9665 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
9666 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
9667 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
9668 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
9669 can extract individual fields using the &%extract%& expansion item.
9670
9671 The use of the &%stat%& expansion in users' filter files can be locked out by
9672 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
9673 systems for files larger than 2GB.
9674
9675 .vitem &*${str2b64:*&<&'string'&>&*}*&
9676 .cindex "expansion" "base64 encoding"
9677 .cindex "base64 encoding" "in string expansion"
9678 .cindex "&%str2b64%& expansion item"
9679 This operator converts a string into one that is base64 encoded.
9680
9681
9682
9683 .vitem &*${strlen:*&<&'string'&>&*}*&
9684 .cindex "expansion" "string length"
9685 .cindex "string" "length in expansion"
9686 .cindex "&%strlen%& expansion item"
9687 The item is replace by the length of the expanded string, expressed as a
9688 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
9689
9690
9691 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
9692 .cindex "&%substr%& expansion item"
9693 .cindex "substring extraction"
9694 .cindex "expansion" "substring expansion"
9695 The &%substr%& operator is a simpler interface to the &%substr%& function that
9696 can be used when the two parameters are fixed numbers (as opposed to strings
9697 that change when expanded). The effect is the same as
9698 .code
9699 ${substr{<start>}{<length>}{<string>}}
9700 .endd
9701 See the description of the general &%substr%& item above for details. The
9702 abbreviation &%s%& can be used when &%substr%& is used as an operator.
9703
9704 .vitem &*${time_eval:*&<&'string'&>&*}*&
9705 .cindex "&%time_eval%& expansion item"
9706 .cindex "time interval" "decoding"
9707 This item converts an Exim time interval such as &`2d4h5m`& into a number of
9708 seconds.
9709
9710 .vitem &*${time_interval:*&<&'string'&>&*}*&
9711 .cindex "&%time_interval%& expansion item"
9712 .cindex "time interval" "formatting"
9713 The argument (after sub-expansion) must be a sequence of decimal digits that
9714 represents an interval of time as a number of seconds. It is converted into a
9715 number of larger units and output in Exim's normal time format, for example,
9716 &`1w3d4h2m6s`&.
9717
9718 .vitem &*${uc:*&<&'string'&>&*}*&
9719 .cindex "case forcing in strings"
9720 .cindex "string" "case forcing"
9721 .cindex "upper casing"
9722 .cindex "expansion" "case forcing"
9723 .cindex "&%uc%& expansion item"
9724 This forces the letters in the string into upper-case.
9725 .endlist
9726
9727
9728
9729
9730
9731
9732 .section "Expansion conditions" "SECTexpcond"
9733 .scindex IIDexpcond "expansion" "conditions"
9734 The following conditions are available for testing by the &%${if%& construct
9735 while expanding strings:
9736
9737 .vlist
9738 .vitem &*!*&<&'condition'&>
9739 .cindex "expansion" "negating a condition"
9740 .cindex "negation" "in expansion condition"
9741 Preceding any condition with an exclamation mark negates the result of the
9742 condition.
9743
9744 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
9745 .cindex "numeric comparison"
9746 .cindex "expansion" "numeric comparison"
9747 There are a number of symbolic operators for doing numeric comparisons. They
9748 are:
9749 .display
9750 &`=   `&   equal
9751 &`==  `&   equal
9752 &`>   `&   greater
9753 &`>=  `&   greater or equal
9754 &`<   `&   less
9755 &`<=  `&   less or equal
9756 .endd
9757 For example:
9758 .code
9759 ${if >{$message_size}{10M} ...
9760 .endd
9761 Note that the general negation operator provides for inequality testing. The
9762 two strings must take the form of optionally signed decimal integers,
9763 optionally followed by one of the letters &"K"& or &"M"& (in either upper or
9764 lower case), signifying multiplication by 1024 or 1024*1024, respectively.
9765 As a special case, the numerical value of an empty string is taken as
9766 zero.
9767
9768 .vitem &*bool&~{*&<&'string'&>&*}*&
9769 .cindex "expansion" "boolean parsing"
9770 .cindex "&%bool%& expansion condition"
9771 This condition turns a string holding a true or false representation into
9772 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
9773 (case-insensitively); also positive integer numbers map to true if non-zero,
9774 false if zero.  Leading whitespace is ignored.
9775 All other string values will result in expansion failure.
9776
9777 When combined with ACL variables, this expansion condition will let you
9778 make decisions in one place and act on those decisions in another place.
9779 For example,
9780 .code
9781 ${if bool{$acl_m_privileged_sender} ...
9782 .endd
9783
9784 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
9785 .cindex "expansion" "encrypted comparison"
9786 .cindex "encrypted strings, comparing"
9787 .cindex "&%crypteq%& expansion condition"
9788 This condition is included in the Exim binary if it is built to support any
9789 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
9790 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
9791 included in the binary.
9792
9793 The &%crypteq%& condition has two arguments. The first is encrypted and
9794 compared against the second, which is already encrypted. The second string may
9795 be in the LDAP form for storing encrypted strings, which starts with the
9796 encryption type in curly brackets, followed by the data. If the second string
9797 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
9798 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
9799 Typically this will be a field from a password file. An example of an encrypted
9800 string in LDAP form is:
9801 .code
9802 {md5}CY9rzUYh03PK3k6DJie09g==
9803 .endd
9804 If such a string appears directly in an expansion, the curly brackets have to
9805 be quoted, because they are part of the expansion syntax. For example:
9806 .code
9807 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
9808 .endd
9809 The following encryption types (whose names are matched case-independently) are
9810 supported:
9811
9812 .ilist
9813 .cindex "MD5 hash"
9814 .cindex "base64 encoding" "in encrypted password"
9815 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
9816 printable characters to compare with the remainder of the second string. If the
9817 length of the comparison string is 24, Exim assumes that it is base64 encoded
9818 (as in the above example). If the length is 32, Exim assumes that it is a
9819 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
9820 comparison fails.
9821
9822 .next
9823 .cindex "SHA-1 hash"
9824 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
9825 printable characters to compare with the remainder of the second string. If the
9826 length of the comparison string is 28, Exim assumes that it is base64 encoded.
9827 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
9828 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
9829
9830 .next
9831 .cindex "&[crypt()]&"
9832 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
9833 only the first eight characters of the password. However, in modern operating
9834 systems this is no longer true, and in many cases the entire password is used,
9835 whatever its length.
9836
9837 .next
9838 .cindex "&[crypt16()]&"
9839 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
9840 use up to 16 characters of the password in some operating systems. Again, in
9841 modern operating systems, more characters may be used.
9842 .endlist
9843 Exim has its own version of &[crypt16()]&, which is just a double call to
9844 &[crypt()]&. For operating systems that have their own version, setting
9845 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
9846 operating system version instead of its own. This option is set by default in
9847 the OS-dependent &_Makefile_& for those operating systems that are known to
9848 support &[crypt16()]&.
9849
9850 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
9851 it was not using the same algorithm as some operating systems' versions. It
9852 turns out that as well as &[crypt16()]& there is a function called
9853 &[bigcrypt()]& in some operating systems. This may or may not use the same
9854 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
9855
9856 However, since there is now a move away from the traditional &[crypt()]&
9857 functions towards using SHA1 and other algorithms, tidying up this area of
9858 Exim is seen as very low priority.
9859
9860 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
9861 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
9862 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
9863 default is &`{crypt}`&. Whatever the default, you can always use either
9864 function by specifying it explicitly in curly brackets.
9865
9866 .vitem &*def:*&<&'variable&~name'&>
9867 .cindex "expansion" "checking for empty variable"
9868 .cindex "&%def%& expansion condition"
9869 The &%def%& condition must be followed by the name of one of the expansion
9870 variables defined in section &<<SECTexpvar>>&. The condition is true if the
9871 variable does not contain the empty string. For example:
9872 .code
9873 ${if def:sender_ident {from $sender_ident}}
9874 .endd
9875 Note that the variable name is given without a leading &%$%& character. If the
9876 variable does not exist, the expansion fails.
9877
9878 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
9879         &~&*def:h_*&<&'header&~name'&>&*:*&"
9880 .cindex "expansion" "checking header line existence"
9881 This condition is true if a message is being processed and the named header
9882 exists in the message. For example,
9883 .code
9884 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
9885 .endd
9886 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
9887 the header name must be terminated by a colon if white space does not follow.
9888
9889 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
9890        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
9891 .cindex "string" "comparison"
9892 .cindex "expansion" "string comparison"
9893 .cindex "&%eq%& expansion condition"
9894 .cindex "&%eqi%& expansion condition"
9895 The two substrings are first expanded. The condition is true if the two
9896 resulting strings are identical. For &%eq%& the comparison includes the case of
9897 letters, whereas for &%eqi%& the comparison is case-independent.
9898
9899 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
9900 .cindex "expansion" "file existence test"
9901 .cindex "file" "existence test"
9902 .cindex "&%exists%&, expansion condition"
9903 The substring is first expanded and then interpreted as an absolute path. The
9904 condition is true if the named file (or directory) exists. The existence test
9905 is done by calling the &[stat()]& function. The use of the &%exists%& test in
9906 users' filter files may be locked out by the system administrator.
9907
9908 .vitem &*first_delivery*&
9909 .cindex "delivery" "first"
9910 .cindex "first delivery"
9911 .cindex "expansion" "first delivery test"
9912 .cindex "&%first_delivery%& expansion condition"
9913 This condition, which has no data, is true during a message's first delivery
9914 attempt. It is false during any subsequent delivery attempts.
9915
9916
9917 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
9918        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
9919 .cindex "list" "iterative conditions"
9920 .cindex "expansion" "&*forall*& condition"
9921 .cindex "expansion" "&*forany*& condition"
9922 .vindex "&$item$&"
9923 These conditions iterate over a list. The first argument is expanded to form
9924 the list. By default, the list separator is a colon, but it can be changed by
9925 the normal method. The second argument is interpreted as a condition that is to
9926 be applied to each item in the list in turn. During the interpretation of the
9927 condition, the current list item is placed in a variable called &$item$&.
9928 .ilist
9929 For &*forany*&, interpretation stops if the condition is true for any item, and
9930 the result of the whole condition is true. If the condition is false for all
9931 items in the list, the overall condition is false.
9932 .next
9933 For &*forall*&, interpretation stops if the condition is false for any item,
9934 and the result of the whole condition is false. If the condition is true for
9935 all items in the list, the overall condition is true.
9936 .endlist
9937 Note that negation of &*forany*& means that the condition must be false for all
9938 items for the overall condition to succeed, and negation of &*forall*& means
9939 that the condition must be false for at least one item. In this example, the
9940 list separator is changed to a comma:
9941 .code
9942 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
9943 .endd
9944 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
9945 being processed, to enable these expansion items to be nested.
9946
9947
9948 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
9949        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
9950 .cindex "string" "comparison"
9951 .cindex "expansion" "string comparison"
9952 .cindex "&%ge%& expansion condition"
9953 .cindex "&%gei%& expansion condition"
9954 The two substrings are first expanded. The condition is true if the first
9955 string is lexically greater than or equal to the second string. For &%ge%& the
9956 comparison includes the case of letters, whereas for &%gei%& the comparison is
9957 case-independent.
9958
9959 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
9960        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
9961 .cindex "string" "comparison"
9962 .cindex "expansion" "string comparison"
9963 .cindex "&%gt%& expansion condition"
9964 .cindex "&%gti%& expansion condition"
9965 The two substrings are first expanded. The condition is true if the first
9966 string is lexically greater than the second string. For &%gt%& the comparison
9967 includes the case of letters, whereas for &%gti%& the comparison is
9968 case-independent.
9969
9970 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
9971        &*isip4&~{*&<&'string'&>&*}*& &&&
9972        &*isip6&~{*&<&'string'&>&*}*&
9973 .cindex "IP address" "testing string format"
9974 .cindex "string" "testing for IP address"
9975 .cindex "&%isip%& expansion condition"
9976 .cindex "&%isip4%& expansion condition"
9977 .cindex "&%isip6%& expansion condition"
9978 The substring is first expanded, and then tested to see if it has the form of
9979 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
9980 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
9981
9982 For an IPv4 address, the test is for four dot-separated components, each of
9983 which consists of from one to three digits. For an IPv6 address, up to eight
9984 colon-separated components are permitted, each containing from one to four
9985 hexadecimal digits. There may be fewer than eight components if an empty
9986 component (adjacent colons) is present. Only one empty component is permitted.
9987
9988 &*Note*&: The checks are just on the form of the address; actual numerical
9989 values are not considered. Thus, for example, 999.999.999.999 passes the IPv4
9990 check. The main use of these tests is to distinguish between IP addresses and
9991 host names, or between IPv4 and IPv6 addresses. For example, you could use
9992 .code
9993 ${if isip4{$sender_host_address}...
9994 .endd
9995 to test which IP version an incoming SMTP connection is using.
9996
9997 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
9998 .cindex "LDAP" "use for authentication"
9999 .cindex "expansion" "LDAP authentication test"
10000 .cindex "&%ldapauth%& expansion condition"
10001 This condition supports user authentication using LDAP. See section
10002 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
10003 queries. For this use, the query must contain a user name and password. The
10004 query itself is not used, and can be empty. The condition is true if the
10005 password is not empty, and the user name and password are accepted by the LDAP
10006 server. An empty password is rejected without calling LDAP because LDAP binds
10007 with an empty password are considered anonymous regardless of the username, and
10008 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
10009 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
10010 this can be used.
10011
10012
10013 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10014        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10015 .cindex "string" "comparison"
10016 .cindex "expansion" "string comparison"
10017 .cindex "&%le%& expansion condition"
10018 .cindex "&%lei%& expansion condition"
10019 The two substrings are first expanded. The condition is true if the first
10020 string is lexically less than or equal to the second string. For &%le%& the
10021 comparison includes the case of letters, whereas for &%lei%& the comparison is
10022 case-independent.
10023
10024 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10025        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10026 .cindex "string" "comparison"
10027 .cindex "expansion" "string comparison"
10028 .cindex "&%lt%& expansion condition"
10029 .cindex "&%lti%& expansion condition"
10030 The two substrings are first expanded. The condition is true if the first
10031 string is lexically less than the second string. For &%lt%& the comparison
10032 includes the case of letters, whereas for &%lti%& the comparison is
10033 case-independent.
10034
10035
10036 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10037 .cindex "expansion" "regular expression comparison"
10038 .cindex "regular expressions" "match in expanded string"
10039 .cindex "&%match%& expansion condition"
10040 The two substrings are first expanded. The second is then treated as a regular
10041 expression and applied to the first. Because of the pre-expansion, if the
10042 regular expression contains dollar, or backslash characters, they must be
10043 escaped. Care must also be taken if the regular expression contains braces
10044 (curly brackets). A closing brace must be escaped so that it is not taken as a
10045 premature termination of <&'string2'&>. The easiest approach is to use the
10046 &`\N`& feature to disable expansion of the regular expression.
10047 For example,
10048 .code
10049 ${if match {$local_part}{\N^\d{3}\N} ...
10050 .endd
10051 If the whole expansion string is in double quotes, further escaping of
10052 backslashes is also required.
10053
10054 The condition is true if the regular expression match succeeds.
10055 The regular expression is not required to begin with a circumflex
10056 metacharacter, but if there is no circumflex, the expression is not anchored,
10057 and it may match anywhere in the subject, not just at the start. If you want
10058 the pattern to match at the end of the subject, you must include the &`$`&
10059 metacharacter at an appropriate point.
10060
10061 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
10062 At the start of an &%if%& expansion the values of the numeric variable
10063 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
10064 succeeds causes them to be reset to the substrings of that condition and they
10065 will have these values during the expansion of the success string. At the end
10066 of the &%if%& expansion, the previous values are restored. After testing a
10067 combination of conditions using &%or%&, the subsequent values of the numeric
10068 variables are those of the condition that succeeded.
10069
10070 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10071 .cindex "&%match_address%& expansion condition"
10072 See &*match_local_part*&.
10073
10074 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10075 .cindex "&%match_domain%& expansion condition"
10076 See &*match_local_part*&.
10077
10078 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10079 .cindex "&%match_ip%& expansion condition"
10080 This condition matches an IP address to a list of IP address patterns. It must
10081 be followed by two argument strings. The first (after expansion) must be an IP
10082 address or an empty string. The second (after expansion) is a restricted host
10083 list that can match only an IP address, not a host name. For example:
10084 .code
10085 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
10086 .endd
10087 The specific types of host list item that are permitted in the list are:
10088
10089 .ilist
10090 An IP address, optionally with a CIDR mask.
10091 .next
10092 A single asterisk, which matches any IP address.
10093 .next
10094 An empty item, which matches only if the IP address is empty. This could be
10095 useful for testing for a locally submitted message or one from specific hosts
10096 in a single test such as
10097 . ==== As this is a nested list, any displays it contains must be indented
10098 . ==== as otherwise they are too far to the left. This comment applies to
10099 . ==== the use of xmlto plus fop. There's no problem when formatting with
10100 . ==== sdop, with or without the extra indent.
10101 .code
10102   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
10103 .endd
10104 where the first item in the list is the empty string.
10105 .next
10106 The item @[] matches any of the local host's interface addresses.
10107 .next
10108 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
10109 even if &`net-`& is not specified. There is never any attempt to turn the IP
10110 address into a host name. The most common type of linear search for
10111 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
10112 masks. For example:
10113 .code
10114   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
10115 .endd
10116 It is of course possible to use other kinds of lookup, and in such a case, you
10117 do need to specify the &`net-`& prefix if you want to specify a specific
10118 address mask, for example:
10119 .code
10120   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
10121 .endd
10122 However, unless you are combining a &%match_ip%& condition with others, it is
10123 just as easy to use the fact that a lookup is itself a condition, and write:
10124 .code
10125   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
10126 .endd
10127 .endlist ilist
10128
10129 Consult section &<<SECThoslispatip>>& for further details of these patterns.
10130
10131 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10132 .cindex "domain list" "in expansion condition"
10133 .cindex "address list" "in expansion condition"
10134 .cindex "local part" "list, in expansion condition"
10135 .cindex "&%match_local_part%& expansion condition"
10136 This condition, together with &%match_address%& and &%match_domain%&, make it
10137 possible to test domain, address, and local part lists within expansions. Each
10138 condition requires two arguments: an item and a list to match. A trivial
10139 example is:
10140 .code
10141 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
10142 .endd
10143 In each case, the second argument may contain any of the allowable items for a
10144 list of the appropriate type. Also, because the second argument (after
10145 expansion) is a standard form of list, it is possible to refer to a named list.
10146 Thus, you can use conditions like this:
10147 .code
10148 ${if match_domain{$domain}{+local_domains}{...
10149 .endd
10150 .cindex "&`+caseful`&"
10151 For address lists, the matching starts off caselessly, but the &`+caseful`&
10152 item can be used, as in all address lists, to cause subsequent items to
10153 have their local parts matched casefully. Domains are always matched
10154 caselessly.
10155
10156 &*Note*&: Host lists are &'not'& supported in this way. This is because
10157 hosts have two identities: a name and an IP address, and it is not clear
10158 how to specify cleanly how such a test would work. However, IP addresses can be
10159 matched using &%match_ip%&.
10160
10161 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
10162 .cindex "PAM authentication"
10163 .cindex "AUTH" "with PAM"
10164 .cindex "Solaris" "PAM support"
10165 .cindex "expansion" "PAM authentication test"
10166 .cindex "&%pam%& expansion condition"
10167 &'Pluggable Authentication Modules'&
10168 (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is
10169 available in the latest releases of Solaris and in some GNU/Linux
10170 distributions. The Exim support, which is intended for use in conjunction with
10171 the SMTP AUTH command, is available only if Exim is compiled with
10172 .code
10173 SUPPORT_PAM=yes
10174 .endd
10175 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
10176 in some releases of GNU/Linux &%-ldl%& is also needed.
10177
10178 The argument string is first expanded, and the result must be a
10179 colon-separated list of strings. Leading and trailing white space is ignored.
10180 The PAM module is initialized with the service name &"exim"& and the user name
10181 taken from the first item in the colon-separated data string (<&'string1'&>).
10182 The remaining items in the data string are passed over in response to requests
10183 from the authentication function. In the simple case there will only be one
10184 request, for a password, so the data consists of just two strings.
10185
10186 There can be problems if any of the strings are permitted to contain colon
10187 characters. In the usual way, these have to be doubled to avoid being taken as
10188 separators. If the data is being inserted from a variable, the &%sg%& expansion
10189 item can be used to double any existing colons. For example, the configuration
10190 of a LOGIN authenticator might contain this setting:
10191 .code
10192 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
10193 .endd
10194 For a PLAIN authenticator you could use:
10195 .code
10196 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
10197 .endd
10198 In some operating systems, PAM authentication can be done only from a process
10199 running as root. Since Exim is running as the Exim user when receiving
10200 messages, this means that PAM cannot be used directly in those systems.
10201 A patched version of the &'pam_unix'& module that comes with the
10202 Linux PAM package is available from &url(http://www.e-admin.de/pam_exim/).
10203 The patched module allows one special uid/gid combination, in addition to root,
10204 to authenticate. If you build the patched module to allow the Exim user and
10205 group, PAM can then be used from an Exim authenticator.
10206
10207
10208 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
10209 .cindex "&'pwcheck'& daemon"
10210 .cindex "Cyrus"
10211 .cindex "expansion" "&'pwcheck'& authentication test"
10212 .cindex "&%pwcheck%& expansion condition"
10213 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
10214 This is one way of making it possible for passwords to be checked by a process
10215 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
10216 deprecated. Its replacement is &'saslauthd'& (see below).
10217
10218 The pwcheck support is not included in Exim by default. You need to specify
10219 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
10220 building Exim. For example:
10221 .code
10222 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
10223 .endd
10224 You do not need to install the full Cyrus software suite in order to use
10225 the pwcheck daemon. You can compile and install just the daemon alone
10226 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
10227 access to the &_/var/pwcheck_& directory.
10228
10229 The &%pwcheck%& condition takes one argument, which must be the user name and
10230 password, separated by a colon. For example, in a LOGIN authenticator
10231 configuration, you might have this:
10232 .code
10233 server_condition = ${if pwcheck{$auth1:$auth2}}
10234 .endd
10235 Again, for a PLAIN authenticator configuration, this would be:
10236 .code
10237 server_condition = ${if pwcheck{$auth2:$auth3}}
10238 .endd
10239 .vitem &*queue_running*&
10240 .cindex "queue runner" "detecting when delivering from"
10241 .cindex "expansion" "queue runner test"
10242 .cindex "&%queue_running%& expansion condition"
10243 This condition, which has no data, is true during delivery attempts that are
10244 initiated by queue runner processes, and false otherwise.
10245
10246
10247 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
10248 .cindex "Radius"
10249 .cindex "expansion" "Radius authentication"
10250 .cindex "&%radius%& expansion condition"
10251 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
10252 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
10253 the Radius client configuration file in order to build Exim with Radius
10254 support.
10255
10256 With just that one setting, Exim expects to be linked with the &%radiusclient%&
10257 library, using the original API. If you are using release 0.4.0 or later of
10258 this library, you need to set
10259 .code
10260 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
10261 .endd
10262 in &_Local/Makefile_& when building Exim. You can also link Exim with the
10263 &%libradius%& library that comes with FreeBSD. To do this, set
10264 .code
10265 RADIUS_LIB_TYPE=RADLIB
10266 .endd
10267 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
10268 You may also have to supply a suitable setting in EXTRALIBS so that the
10269 Radius library can be found when Exim is linked.
10270
10271 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
10272 Radius client library, which calls the Radius server. The condition is true if
10273 the authentication is successful. For example:
10274 .code
10275 server_condition = ${if radius{<arguments>}}
10276 .endd
10277
10278
10279 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
10280         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
10281 .cindex "&'saslauthd'& daemon"
10282 .cindex "Cyrus"
10283 .cindex "expansion" "&'saslauthd'& authentication test"
10284 .cindex "&%saslauthd%& expansion condition"
10285 This condition supports user authentication using the Cyrus &'saslauthd'&
10286 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
10287 Using this daemon is one way of making it possible for passwords to be checked
10288 by a process that is not running as root.
10289
10290 The saslauthd support is not included in Exim by default. You need to specify
10291 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
10292 building Exim. For example:
10293 .code
10294 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
10295 .endd
10296 You do not need to install the full Cyrus software suite in order to use
10297 the saslauthd daemon. You can compile and install just the daemon alone
10298 from the Cyrus SASL library.
10299
10300 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
10301 two are mandatory. For example:
10302 .code
10303 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
10304 .endd
10305 The service and the realm are optional (which is why the arguments are enclosed
10306 in their own set of braces). For details of the meaning of the service and
10307 realm, and how to run the daemon, consult the Cyrus documentation.
10308 .endlist vlist
10309
10310
10311
10312 .section "Combining expansion conditions" "SECID84"
10313 .cindex "expansion" "combining conditions"
10314 Several conditions can be tested at once by combining them using the &%and%&
10315 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
10316 conditions on their own, and precede their lists of sub-conditions. Each
10317 sub-condition must be enclosed in braces within the overall braces that contain
10318 the list. No repetition of &%if%& is used.
10319
10320
10321 .vlist
10322 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
10323 .cindex "&""or""& expansion condition"
10324 .cindex "expansion" "&""or""& of conditions"
10325 The sub-conditions are evaluated from left to right. The condition is true if
10326 any one of the sub-conditions is true.
10327 For example,
10328 .code
10329 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
10330 .endd
10331 When a true sub-condition is found, the following ones are parsed but not
10332 evaluated. If there are several &"match"& sub-conditions the values of the
10333 numeric variables afterwards are taken from the first one that succeeds.
10334
10335 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
10336 .cindex "&""and""& expansion condition"
10337 .cindex "expansion" "&""and""& of conditions"
10338 The sub-conditions are evaluated from left to right. The condition is true if
10339 all of the sub-conditions are true. If there are several &"match"&
10340 sub-conditions, the values of the numeric variables afterwards are taken from
10341 the last one. When a false sub-condition is found, the following ones are
10342 parsed but not evaluated.
10343 .endlist
10344 .ecindex IIDexpcond
10345
10346
10347
10348
10349 .section "Expansion variables" "SECTexpvar"
10350 .cindex "expansion" "variables, list of"
10351 This section contains an alphabetical list of all the expansion variables. Some
10352 of them are available only when Exim is compiled with specific options such as
10353 support for TLS or the content scanning extension.
10354
10355 .vlist
10356 .vitem "&$0$&, &$1$&, etc"
10357 .cindex "numerical variables (&$1$& &$2$& etc)"
10358 When a &%match%& expansion condition succeeds, these variables contain the
10359 captured substrings identified by the regular expression during subsequent
10360 processing of the success string of the containing &%if%& expansion item.
10361 However, they do not retain their values afterwards; in fact, their previous
10362 values are restored at the end of processing an &%if%& item. The numerical
10363 variables may also be set externally by some other matching process which
10364 precedes the expansion of the string. For example, the commands available in
10365 Exim filter files include an &%if%& command with its own regular expression
10366 matching condition.
10367
10368 .vitem "&$acl_c...$&"
10369 Values can be placed in these variables by the &%set%& modifier in an ACL. They
10370 can be given any name that starts with &$acl_c$& and is at least six characters
10371 long, but the sixth character must be either a digit or an underscore. For
10372 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
10373 variables persist throughout the lifetime of an SMTP connection. They can be
10374 used to pass information between ACLs and between different invocations of the
10375 same ACL. When a message is received, the values of these variables are saved
10376 with the message, and can be accessed by filters, routers, and transports
10377 during subsequent delivery.
10378
10379 .vitem "&$acl_m...$&"
10380 These variables are like the &$acl_c...$& variables, except that their values
10381 are reset after a message has been received. Thus, if several messages are
10382 received in one SMTP connection, &$acl_m...$& values are not passed on from one
10383 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
10384 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
10385 message is received, the values of these variables are saved with the message,
10386 and can be accessed by filters, routers, and transports during subsequent
10387 delivery.
10388
10389 .vitem &$acl_verify_message$&
10390 .vindex "&$acl_verify_message$&"
10391 After an address verification has failed, this variable contains the failure
10392 message. It retains its value for use in subsequent modifiers. The message can
10393 be preserved by coding like this:
10394 .code
10395 warn !verify = sender
10396      set acl_m0 = $acl_verify_message
10397 .endd
10398 You can use &$acl_verify_message$& during the expansion of the &%message%& or
10399 &%log_message%& modifiers, to include information about the verification
10400 failure.
10401
10402 .vitem &$address_data$&
10403 .vindex "&$address_data$&"
10404 This variable is set by means of the &%address_data%& option in routers. The
10405 value then remains with the address while it is processed by subsequent routers
10406 and eventually a transport. If the transport is handling multiple addresses,
10407 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
10408 for more details. &*Note*&: The contents of &$address_data$& are visible in
10409 user filter files.
10410
10411 If &$address_data$& is set when the routers are called from an ACL to verify
10412 a recipient address, the final value is still in the variable for subsequent
10413 conditions and modifiers of the ACL statement. If routing the address caused it
10414 to be redirected to just one address, the child address is also routed as part
10415 of the verification, and in this case the final value of &$address_data$& is
10416 from the child's routing.
10417
10418 If &$address_data$& is set when the routers are called from an ACL to verify a
10419 sender address, the final value is also preserved, but this time in
10420 &$sender_address_data$&, to distinguish it from data from a recipient
10421 address.
10422
10423 In both cases (recipient and sender verification), the value does not persist
10424 after the end of the current ACL statement. If you want to preserve
10425 these values for longer, you can save them in ACL variables.
10426
10427 .vitem &$address_file$&
10428 .vindex "&$address_file$&"
10429 When, as a result of aliasing, forwarding, or filtering, a message is directed
10430 to a specific file, this variable holds the name of the file when the transport
10431 is running. At other times, the variable is empty. For example, using the
10432 default configuration, if user &%r2d2%& has a &_.forward_& file containing
10433 .code
10434 /home/r2d2/savemail
10435 .endd
10436 then when the &(address_file)& transport is running, &$address_file$&
10437 contains the text string &`/home/r2d2/savemail`&.
10438 .cindex "Sieve filter" "value of &$address_file$&"
10439 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
10440 then up to the transport configuration to generate an appropriate absolute path
10441 to the relevant file.
10442
10443 .vitem &$address_pipe$&
10444 .vindex "&$address_pipe$&"
10445 When, as a result of aliasing or forwarding, a message is directed to a pipe,
10446 this variable holds the pipe command when the transport is running.
10447
10448 .vitem "&$auth1$& &-- &$auth3$&"
10449 .vindex "&$auth1$&, &$auth2$&, etc"
10450 These variables are used in SMTP authenticators (see chapters
10451 &<<CHAPplaintext>>&&--&<<CHAPspa>>&). Elsewhere, they are empty.
10452
10453 .vitem &$authenticated_id$&
10454 .cindex "authentication" "id"
10455 .vindex "&$authenticated_id$&"
10456 When a server successfully authenticates a client it may be configured to
10457 preserve some of the authentication information in the variable
10458 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
10459 user/password authenticator configuration might preserve the user name for use
10460 in the routers. Note that this is not the same information that is saved in
10461 &$sender_host_authenticated$&.
10462 When a message is submitted locally (that is, not over a TCP connection)
10463 the value of &$authenticated_id$& is normally the login name of the calling
10464 process. However, a trusted user can override this by means of the &%-oMai%&
10465 command line option.
10466
10467
10468
10469
10470 .vitem &$authenticated_sender$&
10471 .cindex "sender" "authenticated"
10472 .cindex "authentication" "sender"
10473 .cindex "AUTH" "on MAIL command"
10474 .vindex "&$authenticated_sender$&"
10475 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
10476 SMTP MAIL command if it believes the sender is sufficiently trusted, as
10477 described in section &<<SECTauthparamail>>&. Unless the data is the string
10478 &"<>"&, it is set as the authenticated sender of the message, and the value is
10479 available during delivery in the &$authenticated_sender$& variable. If the
10480 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
10481
10482 .vindex "&$qualify_domain$&"
10483 When a message is submitted locally (that is, not over a TCP connection), the
10484 value of &$authenticated_sender$& is an address constructed from the login
10485 name of the calling process and &$qualify_domain$&, except that a trusted user
10486 can override this by means of the &%-oMas%& command line option.
10487
10488
10489 .vitem &$authentication_failed$&
10490 .cindex "authentication" "failure"
10491 .vindex "&$authentication_failed$&"
10492 This variable is set to &"1"& in an Exim server if a client issues an AUTH
10493 command that does not succeed. Otherwise it is set to &"0"&. This makes it
10494 possible to distinguish between &"did not try to authenticate"&
10495 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
10496 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
10497 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
10498 negative response to an AUTH command, including (for example) an attempt to use
10499 an undefined mechanism.
10500
10501 .vitem &$body_linecount$&
10502 .cindex "message body" "line count"
10503 .cindex "body of message" "line count"
10504 .vindex "&$body_linecount$&"
10505 When a message is being received or delivered, this variable contains the
10506 number of lines in the message's body. See also &$message_linecount$&.
10507
10508 .vitem &$body_zerocount$&
10509 .cindex "message body" "binary zero count"
10510 .cindex "body of message" "binary zero count"
10511 .cindex "binary zero" "in message body"
10512 .vindex "&$body_zerocount$&"
10513 When a message is being received or delivered, this variable contains the
10514 number of binary zero bytes in the message's body.
10515
10516 .vitem &$bounce_recipient$&
10517 .vindex "&$bounce_recipient$&"
10518 This is set to the recipient address of a bounce message while Exim is creating
10519 it. It is useful if a customized bounce message text file is in use (see
10520 chapter &<<CHAPemsgcust>>&).
10521
10522 .vitem &$bounce_return_size_limit$&
10523 .vindex "&$bounce_return_size_limit$&"
10524 This contains the value set in the &%bounce_return_size_limit%& option, rounded
10525 up to a multiple of 1000. It is useful when a customized error message text
10526 file is in use (see chapter &<<CHAPemsgcust>>&).
10527
10528 .vitem &$caller_gid$&
10529 .cindex "gid (group id)" "caller"
10530 .vindex "&$caller_gid$&"
10531 The real group id under which the process that called Exim was running. This is
10532 not the same as the group id of the originator of a message (see
10533 &$originator_gid$&). If Exim re-execs itself, this variable in the new
10534 incarnation normally contains the Exim gid.
10535
10536 .vitem &$caller_uid$&
10537 .cindex "uid (user id)" "caller"
10538 .vindex "&$caller_uid$&"
10539 The real user id under which the process that called Exim was running. This is
10540 not the same as the user id of the originator of a message (see
10541 &$originator_uid$&). If Exim re-execs itself, this variable in the new
10542 incarnation normally contains the Exim uid.
10543
10544 .vitem &$compile_date$&
10545 .vindex "&$compile_date$&"
10546 The date on which the Exim binary was compiled.
10547
10548 .vitem &$compile_number$&
10549 .vindex "&$compile_number$&"
10550 The building process for Exim keeps a count of the number
10551 of times it has been compiled. This serves to distinguish different
10552 compilations of the same version of the program.
10553
10554 .vitem &$demime_errorlevel$&
10555 .vindex "&$demime_errorlevel$&"
10556 This variable is available when Exim is compiled with
10557 the content-scanning extension and the obsolete &%demime%& condition. For
10558 details, see section &<<SECTdemimecond>>&.
10559
10560 .vitem &$demime_reason$&
10561 .vindex "&$demime_reason$&"
10562 This variable is available when Exim is compiled with the
10563 content-scanning extension and the obsolete &%demime%& condition. For details,
10564 see section &<<SECTdemimecond>>&.
10565
10566 .vitem &$dnslist_domain$& &&&
10567        &$dnslist_matched$& &&&
10568        &$dnslist_text$& &&&
10569        &$dnslist_value$&
10570 .vindex "&$dnslist_domain$&"
10571 .vindex "&$dnslist_matched$&"
10572 .vindex "&$dnslist_text$&"
10573 .vindex "&$dnslist_value$&"
10574 .cindex "black list (DNS)"
10575 When a DNS (black) list lookup succeeds, these variables are set to contain
10576 the following data from the lookup: the list's domain name, the key that was
10577 looked up, the contents of any associated TXT record, and the value from the
10578 main A record. See section &<<SECID204>>& for more details.
10579
10580 .vitem &$domain$&
10581 .vindex "&$domain$&"
10582 When an address is being routed, or delivered on its own, this variable
10583 contains the domain. Uppercase letters in the domain are converted into lower
10584 case for &$domain$&.
10585
10586 Global address rewriting happens when a message is received, so the value of
10587 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
10588 is set during user filtering, but not during system filtering, because a
10589 message may have many recipients and the system filter is called just once.
10590
10591 When more than one address is being delivered at once (for example, several
10592 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
10593 have the same domain. Transports can be restricted to handling only one domain
10594 at a time if the value of &$domain$& is required at transport time &-- this is
10595 the default for local transports. For further details of the environment in
10596 which local transports are run, see chapter &<<CHAPenvironment>>&.
10597
10598 .oindex "&%delay_warning_condition%&"
10599 At the end of a delivery, if all deferred addresses have the same domain, it is
10600 set in &$domain$& during the expansion of &%delay_warning_condition%&.
10601
10602 The &$domain$& variable is also used in some other circumstances:
10603
10604 .ilist
10605 When an ACL is running for a RCPT command, &$domain$& contains the domain of
10606 the recipient address. The domain of the &'sender'& address is in
10607 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
10608 normally set during the running of the MAIL ACL. However, if the sender address
10609 is verified with a callout during the MAIL ACL, the sender domain is placed in
10610 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
10611 the &(smtp)& transport.
10612
10613 .next
10614 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
10615 &$domain$& contains the domain portion of the address that is being rewritten;
10616 it can be used in the expansion of the replacement address, for example, to
10617 rewrite domains by file lookup.
10618
10619 .next
10620 With one important exception, whenever a domain list is being scanned,
10621 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
10622 a &%sender_domains%& condition in an ACL is being processed, the subject domain
10623 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
10624 that, in a RCPT ACL, the sender domain list can be dependent on the
10625 recipient domain (which is what is in &$domain$& at this time).
10626
10627 .next
10628 .cindex "ETRN" "value of &$domain$&"
10629 .oindex "&%smtp_etrn_command%&"
10630 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
10631 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
10632 .endlist
10633
10634
10635 .vitem &$domain_data$&
10636 .vindex "&$domain_data$&"
10637 When the &%domains%& option on a router matches a domain by
10638 means of a lookup, the data read by the lookup is available during the running
10639 of the router as &$domain_data$&. In addition, if the driver routes the
10640 address to a transport, the value is available in that transport. If the
10641 transport is handling multiple addresses, the value from the first address is
10642 used.
10643
10644 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
10645 domain by means of a lookup. The data read by the lookup is available during
10646 the rest of the ACL statement. In all other situations, this variable expands
10647 to nothing.
10648
10649 .vitem &$exim_gid$&
10650 .vindex "&$exim_gid$&"
10651 This variable contains the numerical value of the Exim group id.
10652
10653 .vitem &$exim_path$&
10654 .vindex "&$exim_path$&"
10655 This variable contains the path to the Exim binary.
10656
10657 .vitem &$exim_uid$&
10658 .vindex "&$exim_uid$&"
10659 This variable contains the numerical value of the Exim user id.
10660
10661 .vitem &$found_extension$&
10662 .vindex "&$found_extension$&"
10663 This variable is available when Exim is compiled with the
10664 content-scanning extension and the obsolete &%demime%& condition. For details,
10665 see section &<<SECTdemimecond>>&.
10666
10667 .vitem &$header_$&<&'name'&>
10668 This is not strictly an expansion variable. It is expansion syntax for
10669 inserting the message header line with the given name. Note that the name must
10670 be terminated by colon or white space, because it may contain a wide variety of
10671 characters. Note also that braces must &'not'& be used.
10672
10673 .vitem &$home$&
10674 .vindex "&$home$&"
10675 When the &%check_local_user%& option is set for a router, the user's home
10676 directory is placed in &$home$& when the check succeeds. In particular, this
10677 means it is set during the running of users' filter files. A router may also
10678 explicitly set a home directory for use by a transport; this can be overridden
10679 by a setting on the transport itself.
10680
10681 When running a filter test via the &%-bf%& option, &$home$& is set to the value
10682 of the environment variable HOME.
10683
10684 .vitem &$host$&
10685 .vindex "&$host$&"
10686 If a router assigns an address to a transport (any transport), and passes a
10687 list of hosts with the address, the value of &$host$& when the transport starts
10688 to run is the name of the first host on the list. Note that this applies both
10689 to local and remote transports.
10690
10691 .cindex "transport" "filter"
10692 .cindex "filter" "transport filter"
10693 For the &(smtp)& transport, if there is more than one host, the value of
10694 &$host$& changes as the transport works its way through the list. In
10695 particular, when the &(smtp)& transport is expanding its options for encryption
10696 using TLS, or for specifying a transport filter (see chapter
10697 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
10698 is connected.
10699
10700 When used in the client part of an authenticator configuration (see chapter
10701 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
10702 client is connected.
10703
10704
10705 .vitem &$host_address$&
10706 .vindex "&$host_address$&"
10707 This variable is set to the remote host's IP address whenever &$host$& is set
10708 for a remote connection. It is also set to the IP address that is being checked
10709 when the &%ignore_target_hosts%& option is being processed.
10710
10711 .vitem &$host_data$&
10712 .vindex "&$host_data$&"
10713 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
10714 result of the lookup is made available in the &$host_data$& variable. This
10715 allows you, for example, to do things like this:
10716 .code
10717 deny  hosts = net-lsearch;/some/file
10718 message = $host_data
10719 .endd
10720 .vitem &$host_lookup_deferred$&
10721 .cindex "host name" "lookup, failure of"
10722 .vindex "&$host_lookup_deferred$&"
10723 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
10724 message comes from a remote host and there is an attempt to look up the host's
10725 name from its IP address, and the attempt is not successful, one of these
10726 variables is set to &"1"&.
10727
10728 .ilist
10729 If the lookup receives a definite negative response (for example, a DNS lookup
10730 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
10731
10732 .next
10733 If there is any kind of problem during the lookup, such that Exim cannot
10734 tell whether or not the host name is defined (for example, a timeout for a DNS
10735 lookup), &$host_lookup_deferred$& is set to &"1"&.
10736 .endlist ilist
10737
10738 Looking up a host's name from its IP address consists of more than just a
10739 single reverse lookup. Exim checks that a forward lookup of at least one of the
10740 names it receives from a reverse lookup yields the original IP address. If this
10741 is not the case, Exim does not accept the looked up name(s), and
10742 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
10743 IP address (for example, the existence of a PTR record in the DNS) is not
10744 sufficient on its own for the success of a host name lookup. If the reverse
10745 lookup succeeds, but there is a lookup problem such as a timeout when checking
10746 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
10747 &"1"&. See also &$sender_host_name$&.
10748
10749 .vitem &$host_lookup_failed$&
10750 .vindex "&$host_lookup_failed$&"
10751 See &$host_lookup_deferred$&.
10752
10753
10754 .vitem &$inode$&
10755 .vindex "&$inode$&"
10756 The only time this variable is set is while expanding the &%directory_file%&
10757 option in the &(appendfile)& transport. The variable contains the inode number
10758 of the temporary file which is about to be renamed. It can be used to construct
10759 a unique name for the file.
10760
10761 .vitem &$interface_address$&
10762 .vindex "&$interface_address$&"
10763 This is an obsolete name for &$received_ip_address$&.
10764
10765 .vitem &$interface_port$&
10766 .vindex "&$interface_port$&"
10767 This is an obsolete name for &$received_port$&.
10768
10769 .vitem &$item$&
10770 .vindex "&$item$&"
10771 This variable is used during the expansion of &*forall*& and &*forany*&
10772 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
10773 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
10774 empty.
10775
10776 .vitem &$ldap_dn$&
10777 .vindex "&$ldap_dn$&"
10778 This variable, which is available only when Exim is compiled with LDAP support,
10779 contains the DN from the last entry in the most recently successful LDAP
10780 lookup.
10781
10782 .vitem &$load_average$&
10783 .vindex "&$load_average$&"
10784 This variable contains the system load average, multiplied by 1000 so that it
10785 is an integer. For example, if the load average is 0.21, the value of the
10786 variable is 210. The value is recomputed every time the variable is referenced.
10787
10788 .vitem &$local_part$&
10789 .vindex "&$local_part$&"
10790 When an address is being routed, or delivered on its own, this
10791 variable contains the local part. When a number of addresses are being
10792 delivered together (for example, multiple RCPT commands in an SMTP
10793 session), &$local_part$& is not set.
10794
10795 Global address rewriting happens when a message is received, so the value of
10796 &$local_part$& during routing and delivery is the value after rewriting.
10797 &$local_part$& is set during user filtering, but not during system filtering,
10798 because a message may have many recipients and the system filter is called just
10799 once.
10800
10801 .vindex "&$local_part_prefix$&"
10802 .vindex "&$local_part_suffix$&"
10803 If a local part prefix or suffix has been recognized, it is not included in the
10804 value of &$local_part$& during routing and subsequent delivery. The values of
10805 any prefix or suffix are in &$local_part_prefix$& and
10806 &$local_part_suffix$&, respectively.
10807
10808 When a message is being delivered to a file, pipe, or autoreply transport as a
10809 result of aliasing or forwarding, &$local_part$& is set to the local part of
10810 the parent address, not to the file name or command (see &$address_file$& and
10811 &$address_pipe$&).
10812
10813 When an ACL is running for a RCPT command, &$local_part$& contains the
10814 local part of the recipient address.
10815
10816 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
10817 &$local_part$& contains the local part of the address that is being rewritten;
10818 it can be used in the expansion of the replacement address, for example.
10819
10820 In all cases, all quoting is removed from the local part. For example, for both
10821 the addresses
10822 .code
10823 "abc:xyz"@test.example
10824 abc\:xyz@test.example
10825 .endd
10826 the value of &$local_part$& is
10827 .code
10828 abc:xyz
10829 .endd
10830 If you use &$local_part$& to create another address, you should always wrap it
10831 inside a quoting operator. For example, in a &(redirect)& router you could
10832 have:
10833 .code
10834 data = ${quote_local_part:$local_part}@new.domain.example
10835 .endd
10836 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
10837 to process local parts in a case-dependent manner in a router, you can set the
10838 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
10839
10840 .vitem &$local_part_data$&
10841 .vindex "&$local_part_data$&"
10842 When the &%local_parts%& option on a router matches a local part by means of a
10843 lookup, the data read by the lookup is available during the running of the
10844 router as &$local_part_data$&. In addition, if the driver routes the address
10845 to a transport, the value is available in that transport. If the transport is
10846 handling multiple addresses, the value from the first address is used.
10847
10848 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
10849 matches a local part by means of a lookup. The data read by the lookup is
10850 available during the rest of the ACL statement. In all other situations, this
10851 variable expands to nothing.
10852
10853 .vitem &$local_part_prefix$&
10854 .vindex "&$local_part_prefix$&"
10855 When an address is being routed or delivered, and a
10856 specific prefix for the local part was recognized, it is available in this
10857 variable, having been removed from &$local_part$&.
10858
10859 .vitem &$local_part_suffix$&
10860 .vindex "&$local_part_suffix$&"
10861 When an address is being routed or delivered, and a
10862 specific suffix for the local part was recognized, it is available in this
10863 variable, having been removed from &$local_part$&.
10864
10865 .vitem &$local_scan_data$&
10866 .vindex "&$local_scan_data$&"
10867 This variable contains the text returned by the &[local_scan()]& function when
10868 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
10869
10870 .vitem &$local_user_gid$&
10871 .vindex "&$local_user_gid$&"
10872 See &$local_user_uid$&.
10873
10874 .vitem &$local_user_uid$&
10875 .vindex "&$local_user_uid$&"
10876 This variable and &$local_user_gid$& are set to the uid and gid after the
10877 &%check_local_user%& router precondition succeeds. This means that their values
10878 are available for the remaining preconditions (&%senders%&, &%require_files%&,
10879 and &%condition%&), for the &%address_data%& expansion, and for any
10880 router-specific expansions. At all other times, the values in these variables
10881 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
10882
10883 .vitem &$localhost_number$&
10884 .vindex "&$localhost_number$&"
10885 This contains the expanded value of the
10886 &%localhost_number%& option. The expansion happens after the main options have
10887 been read.
10888
10889 .vitem &$log_inodes$&
10890 .vindex "&$log_inodes$&"
10891 The number of free inodes in the disk partition where Exim's
10892 log files are being written. The value is recalculated whenever the variable is
10893 referenced. If the relevant file system does not have the concept of inodes,
10894 the value of is -1. See also the &%check_log_inodes%& option.
10895
10896 .vitem &$log_space$&
10897 .vindex "&$log_space$&"
10898 The amount of free space (as a number of kilobytes) in the disk
10899 partition where Exim's log files are being written. The value is recalculated
10900 whenever the variable is referenced. If the operating system does not have the
10901 ability to find the amount of free space (only true for experimental systems),
10902 the space value is -1. See also the &%check_log_space%& option.
10903
10904
10905 .vitem &$mailstore_basename$&
10906 .vindex "&$mailstore_basename$&"
10907 This variable is set only when doing deliveries in &"mailstore"& format in the
10908 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
10909 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
10910 contains the basename of the files that are being written, that is, the name
10911 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
10912 variable is empty.
10913
10914 .vitem &$malware_name$&
10915 .vindex "&$malware_name$&"
10916 This variable is available when Exim is compiled with the
10917 content-scanning extension. It is set to the name of the virus that was found
10918 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
10919
10920 .vitem &$max_received_linelength$&
10921 .vindex "&$max_received_linelength$&"
10922 .cindex "maximum" "line length"
10923 .cindex "line length" "maximum"
10924 This variable contains the number of bytes in the longest line that was
10925 received as part of the message, not counting the line termination
10926 character(s).
10927
10928 .vitem &$message_age$&
10929 .cindex "message" "age of"
10930 .vindex "&$message_age$&"
10931 This variable is set at the start of a delivery attempt to contain the number
10932 of seconds since the message was received. It does not change during a single
10933 delivery attempt.
10934
10935 .vitem &$message_body$&
10936 .cindex "body of message" "expansion variable"
10937 .cindex "message body" "in expansion"
10938 .cindex "binary zero" "in message body"
10939 .vindex "&$message_body$&"
10940 .oindex "&%message_body_visible%&"
10941 This variable contains the initial portion of a message's body while it is
10942 being delivered, and is intended mainly for use in filter files. The maximum
10943 number of characters of the body that are put into the variable is set by the
10944 &%message_body_visible%& configuration option; the default is 500.
10945
10946 .oindex "&%message_body_newlines%&"
10947 By default, newlines are converted into spaces in &$message_body$&, to make it
10948 easier to search for phrases that might be split over a line break. However,
10949 this can be disabled by setting &%message_body_newlines%& to be true. Binary
10950 zeros are always converted into spaces.
10951
10952 .vitem &$message_body_end$&
10953 .cindex "body of message" "expansion variable"
10954 .cindex "message body" "in expansion"
10955 .vindex "&$message_body_end$&"
10956 This variable contains the final portion of a message's
10957 body while it is being delivered. The format and maximum size are as for
10958 &$message_body$&.
10959
10960 .vitem &$message_body_size$&
10961 .cindex "body of message" "size"
10962 .cindex "message body" "size"
10963 .vindex "&$message_body_size$&"
10964 When a message is being delivered, this variable contains the size of the body
10965 in bytes. The count starts from the character after the blank line that
10966 separates the body from the header. Newlines are included in the count. See
10967 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
10968
10969 .vitem &$message_exim_id$&
10970 .vindex "&$message_exim_id$&"
10971 When a message is being received or delivered, this variable contains the
10972 unique message id that is generated and used by Exim to identify the message.
10973 An id is not created for a message until after its header has been successfully
10974 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
10975 line; it is the local id that Exim assigns to the message, for example:
10976 &`1BXTIK-0001yO-VA`&.
10977
10978 .vitem &$message_headers$&
10979 .vindex &$message_headers$&
10980 This variable contains a concatenation of all the header lines when a message
10981 is being processed, except for lines added by routers or transports. The header
10982 lines are separated by newline characters. Their contents are decoded in the
10983 same way as a header line that is inserted by &%bheader%&.
10984
10985 .vitem &$message_headers_raw$&
10986 .vindex &$message_headers_raw$&
10987 This variable is like &$message_headers$& except that no processing of the
10988 contents of header lines is done.
10989
10990 .vitem &$message_id$&
10991 This is an old name for &$message_exim_id$&, which is now deprecated.
10992
10993 .vitem &$message_linecount$&
10994 .vindex "&$message_linecount$&"
10995 This variable contains the total number of lines in the header and body of the
10996 message. Compare &$body_linecount$&, which is the count for the body only.
10997 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
10998 number of lines received. Before delivery happens (that is, before filters,
10999 routers, and transports run) the count is increased to include the
11000 &'Received:'& header line that Exim standardly adds, and also any other header
11001 lines that are added by ACLs. The blank line that separates the message header
11002 from the body is not counted. Here is an example of the use of this variable in
11003 a DATA ACL:
11004 .code
11005 deny message   = Too many lines in message header
11006      condition = \
11007       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
11008 .endd
11009 In the MAIL and RCPT ACLs, the value is zero because at that stage the
11010 message has not yet been received.
11011
11012 .vitem &$message_size$&
11013 .cindex "size" "of message"
11014 .cindex "message" "size"
11015 .vindex "&$message_size$&"
11016 When a message is being processed, this variable contains its size in bytes. In
11017 most cases, the size includes those headers that were received with the
11018 message, but not those (such as &'Envelope-to:'&) that are added to individual
11019 deliveries as they are written. However, there is one special case: during the
11020 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
11021 doing a delivery in maildir format, the value of &$message_size$& is the
11022 precise size of the file that has been written. See also
11023 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
11024
11025 .cindex "RCPT" "value of &$message_size$&"
11026 While running a per message ACL (mail/rcpt/predata), &$message_size$&
11027 contains the size supplied on the MAIL command, or -1 if no size was given. The
11028 value may not, of course, be truthful.
11029
11030 .vitem &$mime_$&&'xxx'&
11031 A number of variables whose names start with &$mime$& are
11032 available when Exim is compiled with the content-scanning extension. For
11033 details, see section &<<SECTscanmimepart>>&.
11034
11035 .vitem "&$n0$& &-- &$n9$&"
11036 These variables are counters that can be incremented by means
11037 of the &%add%& command in filter files.
11038
11039 .vitem &$original_domain$&
11040 .vindex "&$domain$&"
11041 .vindex "&$original_domain$&"
11042 When a top-level address is being processed for delivery, this contains the
11043 same value as &$domain$&. However, if a &"child"& address (for example,
11044 generated by an alias, forward, or filter file) is being processed, this
11045 variable contains the domain of the original address (lower cased). This
11046 differs from &$parent_domain$& only when there is more than one level of
11047 aliasing or forwarding. When more than one address is being delivered in a
11048 single transport run, &$original_domain$& is not set.
11049
11050 If a new address is created by means of a &%deliver%& command in a system
11051 filter, it is set up with an artificial &"parent"& address. This has the local
11052 part &'system-filter'& and the default qualify domain.
11053
11054 .vitem &$original_local_part$&
11055 .vindex "&$local_part$&"
11056 .vindex "&$original_local_part$&"
11057 When a top-level address is being processed for delivery, this contains the
11058 same value as &$local_part$&, unless a prefix or suffix was removed from the
11059 local part, because &$original_local_part$& always contains the full local
11060 part. When a &"child"& address (for example, generated by an alias, forward, or
11061 filter file) is being processed, this variable contains the full local part of
11062 the original address.
11063
11064 If the router that did the redirection processed the local part
11065 case-insensitively, the value in &$original_local_part$& is in lower case.
11066 This variable differs from &$parent_local_part$& only when there is more than
11067 one level of aliasing or forwarding. When more than one address is being
11068 delivered in a single transport run, &$original_local_part$& is not set.
11069
11070 If a new address is created by means of a &%deliver%& command in a system
11071 filter, it is set up with an artificial &"parent"& address. This has the local
11072 part &'system-filter'& and the default qualify domain.
11073
11074 .vitem &$originator_gid$&
11075 .cindex "gid (group id)" "of originating user"
11076 .cindex "sender" "gid"
11077 .vindex "&$caller_gid$&"
11078 .vindex "&$originator_gid$&"
11079 This variable contains the value of &$caller_gid$& that was set when the
11080 message was received. For messages received via the command line, this is the
11081 gid of the sending user. For messages received by SMTP over TCP/IP, this is
11082 normally the gid of the Exim user.
11083
11084 .vitem &$originator_uid$&
11085 .cindex "uid (user id)" "of originating user"
11086 .cindex "sender" "uid"
11087 .vindex "&$caller_uid$&"
11088 .vindex "&$originaltor_uid$&"
11089 The value of &$caller_uid$& that was set when the message was received. For
11090 messages received via the command line, this is the uid of the sending user.
11091 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
11092 user.
11093
11094 .vitem &$parent_domain$&
11095 .vindex "&$parent_domain$&"
11096 This variable is similar to &$original_domain$& (see
11097 above), except that it refers to the immediately preceding parent address.
11098
11099 .vitem &$parent_local_part$&
11100 .vindex "&$parent_local_part$&"
11101 This variable is similar to &$original_local_part$&
11102 (see above), except that it refers to the immediately preceding parent address.
11103
11104 .vitem &$pid$&
11105 .cindex "pid (process id)" "of current process"
11106 .vindex "&$pid$&"
11107 This variable contains the current process id.
11108
11109 .vitem &$pipe_addresses$&
11110 .cindex "filter" "transport filter"
11111 .cindex "transport" "filter"
11112 .vindex "&$pipe_addresses$&"
11113 This is not an expansion variable, but is mentioned here because the string
11114 &`$pipe_addresses`& is handled specially in the command specification for the
11115 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
11116 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
11117 It cannot be used in general expansion strings, and provokes an &"unknown
11118 variable"& error if encountered.
11119
11120 .vitem &$primary_hostname$&
11121 .vindex "&$primary_hostname$&"
11122 This variable contains the value set by &%primary_hostname%& in the
11123 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
11124 a single-component name, Exim calls &[gethostbyname()]& (or
11125 &[getipnodebyname()]& where available) in an attempt to acquire a fully
11126 qualified host name. See also &$smtp_active_hostname$&.
11127
11128
11129 .vitem &$prvscheck_address$&
11130 This variable is used in conjunction with the &%prvscheck%& expansion item,
11131 which is described in sections &<<SECTexpansionitems>>& and
11132 &<<SECTverifyPRVS>>&.
11133
11134 .vitem &$prvscheck_keynum$&
11135 This variable is used in conjunction with the &%prvscheck%& expansion item,
11136 which is described in sections &<<SECTexpansionitems>>& and
11137 &<<SECTverifyPRVS>>&.
11138
11139 .vitem &$prvscheck_result$&
11140 This variable is used in conjunction with the &%prvscheck%& expansion item,
11141 which is described in sections &<<SECTexpansionitems>>& and
11142 &<<SECTverifyPRVS>>&.
11143
11144 .vitem &$qualify_domain$&
11145 .vindex "&$qualify_domain$&"
11146 The value set for the &%qualify_domain%& option in the configuration file.
11147
11148 .vitem &$qualify_recipient$&
11149 .vindex "&$qualify_recipient$&"
11150 The value set for the &%qualify_recipient%& option in the configuration file,
11151 or if not set, the value of &$qualify_domain$&.
11152
11153 .vitem &$rcpt_count$&
11154 .vindex "&$rcpt_count$&"
11155 When a message is being received by SMTP, this variable contains the number of
11156 RCPT commands received for the current message. If this variable is used in a
11157 RCPT ACL, its value includes the current command.
11158
11159 .vitem &$rcpt_defer_count$&
11160 .vindex "&$rcpt_defer_count$&"
11161 .cindex "4&'xx'& responses" "count of"
11162 When a message is being received by SMTP, this variable contains the number of
11163 RCPT commands in the current message that have previously been rejected with a
11164 temporary (4&'xx'&) response.
11165
11166 .vitem &$rcpt_fail_count$&
11167 .vindex "&$rcpt_fail_count$&"
11168 When a message is being received by SMTP, this variable contains the number of
11169 RCPT commands in the current message that have previously been rejected with a
11170 permanent (5&'xx'&) response.
11171
11172 .vitem &$received_count$&
11173 .vindex "&$received_count$&"
11174 This variable contains the number of &'Received:'& header lines in the message,
11175 including the one added by Exim (so its value is always greater than zero). It
11176 is available in the DATA ACL, the non-SMTP ACL, and while routing and
11177 delivering.
11178
11179 .vitem &$received_for$&
11180 .vindex "&$received_for$&"
11181 If there is only a single recipient address in an incoming message, this
11182 variable contains that address when the &'Received:'& header line is being
11183 built. The value is copied after recipient rewriting has happened, but before
11184 the &[local_scan()]& function is run.
11185
11186 .vitem &$received_ip_address$&
11187 .vindex "&$received_ip_address$&"
11188 As soon as an Exim server starts processing an incoming TCP/IP connection, this
11189 variable is set to the address of the local IP interface, and &$received_port$&
11190 is set to the local port number. (The remote IP address and port are in
11191 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
11192 the port value is -1 unless it has been set using the &%-oMi%& command line
11193 option.
11194
11195 As well as being useful in ACLs (including the &"connect"& ACL), these variable
11196 could be used, for example, to make the file name for a TLS certificate depend
11197 on which interface and/or port is being used for the incoming connection. The
11198 values of &$received_ip_address$& and &$received_port$& are saved with any
11199 messages that are received, thus making these variables available at delivery
11200 time.
11201
11202 &*Note:*& There are no equivalent variables for outgoing connections, because
11203 the values are unknown (unless they are explicitly set by options of the
11204 &(smtp)& transport).
11205
11206 .vitem &$received_port$&
11207 .vindex "&$received_port$&"
11208 See &$received_ip_address$&.
11209
11210 .vitem &$received_protocol$&
11211 .vindex "&$received_protocol$&"
11212 When a message is being processed, this variable contains the name of the
11213 protocol by which it was received. Most of the names used by Exim are defined
11214 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
11215 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
11216 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
11217 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
11218 connection and the client was successfully authenticated.
11219
11220 Exim uses the protocol name &"smtps"& for the case when encryption is
11221 automatically set up on connection without the use of STARTTLS (see
11222 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
11223 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
11224 where the client initially uses EHLO, sets up an encrypted connection using
11225 STARTTLS, and then uses HELO afterwards.
11226
11227 The &%-oMr%& option provides a way of specifying a custom protocol name for
11228 messages that are injected locally by trusted callers. This is commonly used to
11229 identify messages that are being re-injected after some kind of scanning.
11230
11231 .vitem &$received_time$&
11232 .vindex "&$received_time$&"
11233 This variable contains the date and time when the current message was received,
11234 as a number of seconds since the start of the Unix epoch.
11235
11236 .vitem &$recipient_data$&
11237 .vindex "&$recipient_data$&"
11238 This variable is set after an indexing lookup success in an ACL &%recipients%&
11239 condition. It contains the data from the lookup, and the value remains set
11240 until the next &%recipients%& test. Thus, you can do things like this:
11241 .display
11242 &`require recipients  = cdb*@;/some/file`&
11243 &`deny    `&&'some further test involving'& &`$recipient_data`&
11244 .endd
11245 &*Warning*&: This variable is set only when a lookup is used as an indexing
11246 method in the address list, using the semicolon syntax as in the example above.
11247 The variable is not set for a lookup that is used as part of the string
11248 expansion that all such lists undergo before being interpreted.
11249
11250 .vitem &$recipient_verify_failure$&
11251 .vindex "&$recipient_verify_failure$&"
11252 In an ACL, when a recipient verification fails, this variable contains
11253 information about the failure. It is set to one of the following words:
11254
11255 .ilist
11256 &"qualify"&: The address was unqualified (no domain), and the message
11257 was neither local nor came from an exempted host.
11258
11259 .next
11260 &"route"&: Routing failed.
11261
11262 .next
11263 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
11264 or before the MAIL command (that is, on initial connection, HELO, or
11265 MAIL).
11266
11267 .next
11268 &"recipient"&: The RCPT command in a callout was rejected.
11269 .next
11270
11271 &"postmaster"&: The postmaster check in a callout was rejected.
11272 .endlist
11273
11274 The main use of this variable is expected to be to distinguish between
11275 rejections of MAIL and rejections of RCPT.
11276
11277 .vitem &$recipients$&
11278 .vindex "&$recipients$&"
11279 This variable contains a list of envelope recipients for a message. A comma and
11280 a space separate the addresses in the replacement text. However, the variable
11281 is not generally available, to prevent exposure of Bcc recipients in
11282 unprivileged users' filter files. You can use &$recipients$& only in these
11283 cases:
11284
11285 .olist
11286 In a system filter file.
11287 .next
11288 In the ACLs associated with the DATA command and with non-SMTP messages, that
11289 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
11290 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
11291 &%acl_not_smtp_mime%&.
11292 .next
11293 From within a &[local_scan()]& function.
11294 .endlist
11295
11296
11297 .vitem &$recipients_count$&
11298 .vindex "&$recipients_count$&"
11299 When a message is being processed, this variable contains the number of
11300 envelope recipients that came with the message. Duplicates are not excluded
11301 from the count. While a message is being received over SMTP, the number
11302 increases for each accepted recipient. It can be referenced in an ACL.
11303
11304
11305 .vitem &$regex_match_string$&
11306 .vindex "&$regex_match_string$&"
11307 This variable is set to contain the matching regular expression after a
11308 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
11309
11310
11311 .vitem &$reply_address$&
11312 .vindex "&$reply_address$&"
11313 When a message is being processed, this variable contains the contents of the
11314 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
11315 contents of the &'From:'& header line. Apart from the removal of leading
11316 white space, the value is not processed in any way. In particular, no RFC 2047
11317 decoding or character code translation takes place.
11318
11319 .vitem &$return_path$&
11320 .vindex "&$return_path$&"
11321 When a message is being delivered, this variable contains the return path &--
11322 the sender field that will be sent as part of the envelope. It is not enclosed
11323 in <> characters. At the start of routing an address, &$return_path$& has the
11324 same value as &$sender_address$&, but if, for example, an incoming message to a
11325 mailing list has been expanded by a router which specifies a different address
11326 for bounce messages, &$return_path$& subsequently contains the new bounce
11327 address, whereas &$sender_address$& always contains the original sender address
11328 that was received with the message. In other words, &$sender_address$& contains
11329 the incoming envelope sender, and &$return_path$& contains the outgoing
11330 envelope sender.
11331
11332 .vitem &$return_size_limit$&
11333 .vindex "&$return_size_limit$&"
11334 This is an obsolete name for &$bounce_return_size_limit$&.
11335
11336 .vitem &$runrc$&
11337 .cindex "return code" "from &%run%& expansion"
11338 .vindex "&$runrc$&"
11339 This variable contains the return code from a command that is run by the
11340 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
11341 assume the order in which option values are expanded, except for those
11342 preconditions whose order of testing is documented. Therefore, you cannot
11343 reliably expect to set &$runrc$& by the expansion of one option, and use it in
11344 another.
11345
11346 .vitem &$self_hostname$&
11347 .oindex "&%self%&" "value of host name"
11348 .vindex "&$self_hostname$&"
11349 When an address is routed to a supposedly remote host that turns out to be the
11350 local host, what happens is controlled by the &%self%& generic router option.
11351 One of its values causes the address to be passed to another router. When this
11352 happens, &$self_hostname$& is set to the name of the local host that the
11353 original router encountered. In other circumstances its contents are null.
11354
11355 .vitem &$sender_address$&
11356 .vindex "&$sender_address$&"
11357 When a message is being processed, this variable contains the sender's address
11358 that was received in the message's envelope. The case of letters in the address
11359 is retained, in both the local part and the domain. For bounce messages, the
11360 value of this variable is the empty string. See also &$return_path$&.
11361
11362 .vitem &$sender_address_data$&
11363 .vindex "&$address_data$&"
11364 .vindex "&$sender_address_data$&"
11365 If &$address_data$& is set when the routers are called from an ACL to verify a
11366 sender address, the final value is preserved in &$sender_address_data$&, to
11367 distinguish it from data from a recipient address. The value does not persist
11368 after the end of the current ACL statement. If you want to preserve it for
11369 longer, you can save it in an ACL variable.
11370
11371 .vitem &$sender_address_domain$&
11372 .vindex "&$sender_address_domain$&"
11373 The domain portion of &$sender_address$&.
11374
11375 .vitem &$sender_address_local_part$&
11376 .vindex "&$sender_address_local_part$&"
11377 The local part portion of &$sender_address$&.
11378
11379 .vitem &$sender_data$&
11380 .vindex "&$sender_data$&"
11381 This variable is set after a lookup success in an ACL &%senders%& condition or
11382 in a router &%senders%& option. It contains the data from the lookup, and the
11383 value remains set until the next &%senders%& test. Thus, you can do things like
11384 this:
11385 .display
11386 &`require senders      = cdb*@;/some/file`&
11387 &`deny    `&&'some further test involving'& &`$sender_data`&
11388 .endd
11389 &*Warning*&: This variable is set only when a lookup is used as an indexing
11390 method in the address list, using the semicolon syntax as in the example above.
11391 The variable is not set for a lookup that is used as part of the string
11392 expansion that all such lists undergo before being interpreted.
11393
11394 .vitem &$sender_fullhost$&
11395 .vindex "&$sender_fullhost$&"
11396 When a message is received from a remote host, this variable contains the host
11397 name and IP address in a single string. It ends with the IP address in square
11398 brackets, followed by a colon and a port number if the logging of ports is
11399 enabled. The format of the rest of the string depends on whether the host
11400 issued a HELO or EHLO SMTP command, and whether the host name was verified by
11401 looking up its IP address. (Looking up the IP address can be forced by the
11402 &%host_lookup%& option, independent of verification.) A plain host name at the
11403 start of the string is a verified host name; if this is not present,
11404 verification either failed or was not requested. A host name in parentheses is
11405 the argument of a HELO or EHLO command. This is omitted if it is identical to
11406 the verified host name or to the host's IP address in square brackets.
11407
11408 .vitem &$sender_helo_name$&
11409 .vindex "&$sender_helo_name$&"
11410 When a message is received from a remote host that has issued a HELO or EHLO
11411 command, the argument of that command is placed in this variable. It is also
11412 set if HELO or EHLO is used when a message is received using SMTP locally via
11413 the &%-bs%& or &%-bS%& options.
11414
11415 .vitem &$sender_host_address$&
11416 .vindex "&$sender_host_address$&"
11417 When a message is received from a remote host, this variable contains that
11418 host's IP address. For locally submitted messages, it is empty.
11419
11420 .vitem &$sender_host_authenticated$&
11421 .vindex "&$sender_host_authenticated$&"
11422 This variable contains the name (not the public name) of the authenticator
11423 driver that successfully authenticated the client from which the message was
11424 received. It is empty if there was no successful authentication. See also
11425 &$authenticated_id$&.
11426
11427 .vitem &$sender_host_name$&
11428 .vindex "&$sender_host_name$&"
11429 When a message is received from a remote host, this variable contains the
11430 host's name as obtained by looking up its IP address. For messages received by
11431 other means, this variable is empty.
11432
11433 .vindex "&$host_lookup_failed$&"
11434 If the host name has not previously been looked up, a reference to
11435 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
11436 A looked up name is accepted only if it leads back to the original IP address
11437 via a forward lookup. If either the reverse or the forward lookup fails to find
11438 any data, or if the forward lookup does not yield the original IP address,
11439 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
11440
11441 .vindex "&$host_lookup_deferred$&"
11442 However, if either of the lookups cannot be completed (for example, there is a
11443 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
11444 &$host_lookup_failed$& remains set to &"0"&.
11445
11446 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
11447 host name again if there is a subsequent reference to &$sender_host_name$&
11448 in the same Exim process, but it does try again if &$host_lookup_deferred$&
11449 is set to &"1"&.
11450
11451 Exim does not automatically look up every calling host's name. If you want
11452 maximum efficiency, you should arrange your configuration so that it avoids
11453 these lookups altogether. The lookup happens only if one or more of the
11454 following are true:
11455
11456 .ilist
11457 A string containing &$sender_host_name$& is expanded.
11458 .next
11459 The calling host matches the list in &%host_lookup%&. In the default
11460 configuration, this option is set to *, so it must be changed if lookups are
11461 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
11462 .next
11463 Exim needs the host name in order to test an item in a host list. The items
11464 that require this are described in sections &<<SECThoslispatnam>>& and
11465 &<<SECThoslispatnamsk>>&.
11466 .next
11467 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
11468 In this case, the host name is required to compare with the name quoted in any
11469 EHLO or HELO commands that the client issues.
11470 .next
11471 The remote host issues a EHLO or HELO command that quotes one of the
11472 domains in &%helo_lookup_domains%&. The default value of this option is
11473 . ==== As this is a nested list, any displays it contains must be indented
11474 . ==== as otherwise they are too far to the left.
11475 .code
11476   helo_lookup_domains = @ : @[]
11477 .endd
11478 which causes a lookup if a remote host (incorrectly) gives the server's name or
11479 IP address in an EHLO or HELO command.
11480 .endlist
11481
11482
11483 .vitem &$sender_host_port$&
11484 .vindex "&$sender_host_port$&"
11485 When a message is received from a remote host, this variable contains the port
11486 number that was used on the remote host.
11487
11488 .vitem &$sender_ident$&
11489 .vindex "&$sender_ident$&"
11490 When a message is received from a remote host, this variable contains the
11491 identification received in response to an RFC 1413 request. When a message has
11492 been received locally, this variable contains the login name of the user that
11493 called Exim.
11494
11495 .vitem &$sender_rate_$&&'xxx'&
11496 A number of variables whose names begin &$sender_rate_$& are set as part of the
11497 &%ratelimit%& ACL condition. Details are given in section
11498 &<<SECTratelimiting>>&.
11499
11500 .vitem &$sender_rcvhost$&
11501 .cindex "DNS" "reverse lookup"
11502 .cindex "reverse DNS lookup"
11503 .vindex "&$sender_rcvhost$&"
11504 This is provided specifically for use in &'Received:'& headers. It starts with
11505 either the verified host name (as obtained from a reverse DNS lookup) or, if
11506 there is no verified host name, the IP address in square brackets. After that
11507 there may be text in parentheses. When the first item is a verified host name,
11508 the first thing in the parentheses is the IP address in square brackets,
11509 followed by a colon and a port number if port logging is enabled. When the
11510 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
11511 the parentheses.
11512
11513 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
11514 was used and its argument was not identical to the real host name or IP
11515 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
11516 all three items are present in the parentheses, a newline and tab are inserted
11517 into the string, to improve the formatting of the &'Received:'& header.
11518
11519 .vitem &$sender_verify_failure$&
11520 .vindex "&$sender_verify_failure$&"
11521 In an ACL, when a sender verification fails, this variable contains information
11522 about the failure. The details are the same as for
11523 &$recipient_verify_failure$&.
11524
11525 .vitem &$sending_ip_address$&
11526 .vindex "&$sending_ip_address$&"
11527 This variable is set whenever an outgoing SMTP connection to another host has
11528 been set up. It contains the IP address of the local interface that is being
11529 used. This is useful if a host that has more than one IP address wants to take
11530 on different personalities depending on which one is being used. For incoming
11531 connections, see &$received_ip_address$&.
11532
11533 .vitem &$sending_port$&
11534 .vindex "&$sending_port$&"
11535 This variable is set whenever an outgoing SMTP connection to another host has
11536 been set up. It contains the local port that is being used. For incoming
11537 connections, see &$received_port$&.
11538
11539 .vitem &$smtp_active_hostname$&
11540 .vindex "&$smtp_active_hostname$&"
11541 During an incoming SMTP session, this variable contains the value of the active
11542 host name, as specified by the &%smtp_active_hostname%& option. The value of
11543 &$smtp_active_hostname$& is saved with any message that is received, so its
11544 value can be consulted during routing and delivery.
11545
11546 .vitem &$smtp_command$&
11547 .vindex "&$smtp_command$&"
11548 During the processing of an incoming SMTP command, this variable contains the
11549 entire command. This makes it possible to distinguish between HELO and EHLO in
11550 the HELO ACL, and also to distinguish between commands such as these:
11551 .code
11552 MAIL FROM:<>
11553 MAIL FROM: <>
11554 .endd
11555 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
11556 command, the address in &$smtp_command$& is the original address before any
11557 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
11558 the address after SMTP-time rewriting.
11559
11560 .vitem &$smtp_command_argument$&
11561 .cindex "SMTP" "command, argument for"
11562 .vindex "&$smtp_command_argument$&"
11563 While an ACL is running to check an SMTP command, this variable contains the
11564 argument, that is, the text that follows the command name, with leading white
11565 space removed. Following the introduction of &$smtp_command$&, this variable is
11566 somewhat redundant, but is retained for backwards compatibility.
11567
11568 .vitem &$smtp_count_at_connection_start$&
11569 .vindex "&$smtp_count_at_connection_start$&"
11570 This variable is set greater than zero only in processes spawned by the Exim
11571 daemon for handling incoming SMTP connections. The name is deliberately long,
11572 in order to emphasize what the contents are. When the daemon accepts a new
11573 connection, it increments this variable. A copy of the variable is passed to
11574 the child process that handles the connection, but its value is fixed, and
11575 never changes. It is only an approximation of how many incoming connections
11576 there actually are, because many other connections may come and go while a
11577 single connection is being processed. When a child process terminates, the
11578 daemon decrements its copy of the variable.
11579
11580 .vitem "&$sn0$& &-- &$sn9$&"
11581 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
11582 that were current at the end of the system filter file. This allows a system
11583 filter file to set values that can be tested in users' filter files. For
11584 example, a system filter could set a value indicating how likely it is that a
11585 message is junk mail.
11586
11587 .vitem &$spam_$&&'xxx'&
11588 A number of variables whose names start with &$spam$& are available when Exim
11589 is compiled with the content-scanning extension. For details, see section
11590 &<<SECTscanspamass>>&.
11591
11592
11593 .vitem &$spool_directory$&
11594 .vindex "&$spool_directory$&"
11595 The name of Exim's spool directory.
11596
11597 .vitem &$spool_inodes$&
11598 .vindex "&$spool_inodes$&"
11599 The number of free inodes in the disk partition where Exim's spool files are
11600 being written. The value is recalculated whenever the variable is referenced.
11601 If the relevant file system does not have the concept of inodes, the value of
11602 is -1. See also the &%check_spool_inodes%& option.
11603
11604 .vitem &$spool_space$&
11605 .vindex "&$spool_space$&"
11606 The amount of free space (as a number of kilobytes) in the disk partition where
11607 Exim's spool files are being written. The value is recalculated whenever the
11608 variable is referenced. If the operating system does not have the ability to
11609 find the amount of free space (only true for experimental systems), the space
11610 value is -1. For example, to check in an ACL that there is at least 50
11611 megabytes free on the spool, you could write:
11612 .code
11613 condition = ${if > {$spool_space}{50000}}
11614 .endd
11615 See also the &%check_spool_space%& option.
11616
11617
11618 .vitem &$thisaddress$&
11619 .vindex "&$thisaddress$&"
11620 This variable is set only during the processing of the &%foranyaddress%&
11621 command in a filter file. Its use is explained in the description of that
11622 command, which can be found in the separate document entitled &'Exim's
11623 interfaces to mail filtering'&.
11624
11625 .vitem &$tls_certificate_verified$&
11626 .vindex "&$tls_certificate_verified$&"
11627 This variable is set to &"1"& if a TLS certificate was verified when the
11628 message was received, and &"0"& otherwise.
11629
11630 .vitem &$tls_cipher$&
11631 .vindex "&$tls_cipher$&"
11632 When a message is received from a remote host over an encrypted SMTP
11633 connection, this variable is set to the cipher suite that was negotiated, for
11634 example DES-CBC3-SHA. In other circumstances, in particular, for message
11635 received over unencrypted connections, the variable is empty. Testing
11636 &$tls_cipher$& for emptiness is one way of distinguishing between encrypted and
11637 non-encrypted connections during ACL processing.
11638
11639 The &$tls_cipher$& variable retains its value during message delivery, except
11640 when an outward SMTP delivery takes place via the &(smtp)& transport. In this
11641 case, &$tls_cipher$& is cleared before any outgoing SMTP connection is made,
11642 and then set to the outgoing cipher suite if one is negotiated. See chapter
11643 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
11644 details of the &(smtp)& transport.
11645
11646 .vitem &$tls_peerdn$&
11647 .vindex "&$tls_peerdn$&"
11648 When a message is received from a remote host over an encrypted SMTP
11649 connection, and Exim is configured to request a certificate from the client,
11650 the value of the Distinguished Name of the certificate is made available in the
11651 &$tls_peerdn$& during subsequent processing. Like &$tls_cipher$&, the
11652 value is retained during message delivery, except during outbound SMTP
11653 deliveries.
11654
11655 .vitem &$tod_bsdinbox$&
11656 .vindex "&$tod_bsdinbox$&"
11657 The time of day and the date, in the format required for BSD-style mailbox
11658 files, for example: Thu Oct 17 17:14:09 1995.
11659
11660 .vitem &$tod_epoch$&
11661 .vindex "&$tod_epoch$&"
11662 The time and date as a number of seconds since the start of the Unix epoch.
11663
11664 .vitem &$tod_full$&
11665 .vindex "&$tod_full$&"
11666 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
11667 +0100. The timezone is always given as a numerical offset from UTC, with
11668 positive values used for timezones that are ahead (east) of UTC, and negative
11669 values for those that are behind (west).
11670
11671 .vitem &$tod_log$&
11672 .vindex "&$tod_log$&"
11673 The time and date in the format used for writing Exim's log files, for example:
11674 1995-10-12 15:32:29, but without a timezone.
11675
11676 .vitem &$tod_logfile$&
11677 .vindex "&$tod_logfile$&"
11678 This variable contains the date in the format yyyymmdd. This is the format that
11679 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
11680 flag.
11681
11682 .vitem &$tod_zone$&
11683 .vindex "&$tod_zone$&"
11684 This variable contains the numerical value of the local timezone, for example:
11685 -0500.
11686
11687 .vitem &$tod_zulu$&
11688 .vindex "&$tod_zulu$&"
11689 This variable contains the UTC date and time in &"Zulu"& format, as specified
11690 by ISO 8601, for example: 20030221154023Z.
11691
11692 .vitem &$value$&
11693 .vindex "&$value$&"
11694 This variable contains the result of an expansion lookup, extraction operation,
11695 or external command, as described above. It is also used during a
11696 &*reduce*& expansion.
11697
11698 .vitem &$version_number$&
11699 .vindex "&$version_number$&"
11700 The version number of Exim.
11701
11702 .vitem &$warn_message_delay$&
11703 .vindex "&$warn_message_delay$&"
11704 This variable is set only during the creation of a message warning about a
11705 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
11706
11707 .vitem &$warn_message_recipients$&
11708 .vindex "&$warn_message_recipients$&"
11709 This variable is set only during the creation of a message warning about a
11710 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
11711 .endlist
11712 .ecindex IIDstrexp
11713
11714
11715
11716 . ////////////////////////////////////////////////////////////////////////////
11717 . ////////////////////////////////////////////////////////////////////////////
11718
11719 .chapter "Embedded Perl" "CHAPperl"
11720 .scindex IIDperl "Perl" "calling from Exim"
11721 Exim can be built to include an embedded Perl interpreter. When this is done,
11722 Perl subroutines can be called as part of the string expansion process. To make
11723 use of the Perl support, you need version 5.004 or later of Perl installed on
11724 your system. To include the embedded interpreter in the Exim binary, include
11725 the line
11726 .code
11727 EXIM_PERL = perl.o
11728 .endd
11729 in your &_Local/Makefile_& and then build Exim in the normal way.
11730
11731
11732 .section "Setting up so Perl can be used" "SECID85"
11733 .oindex "&%perl_startup%&"
11734 Access to Perl subroutines is via a global configuration option called
11735 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
11736 no &%perl_startup%& option in the Exim configuration file then no Perl
11737 interpreter is started and there is almost no overhead for Exim (since none of
11738 the Perl library will be paged in unless used). If there is a &%perl_startup%&
11739 option then the associated value is taken to be Perl code which is executed in
11740 a newly created Perl interpreter.
11741
11742 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
11743 need backslashes before any characters to escape special meanings. The option
11744 should usually be something like
11745 .code
11746 perl_startup = do '/etc/exim.pl'
11747 .endd
11748 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
11749 use from Exim. Exim can be configured either to start up a Perl interpreter as
11750 soon as it is entered, or to wait until the first time it is needed. Starting
11751 the interpreter at the beginning ensures that it is done while Exim still has
11752 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
11753 fact used in a particular run. Also, note that this does not mean that Exim is
11754 necessarily running as root when Perl is called at a later time. By default,
11755 the interpreter is started only when it is needed, but this can be changed in
11756 two ways:
11757
11758 .ilist
11759 .oindex "&%perl_at_start%&"
11760 Setting &%perl_at_start%& (a boolean option) in the configuration requests
11761 a startup when Exim is entered.
11762 .next
11763 The command line option &%-ps%& also requests a startup when Exim is entered,
11764 overriding the setting of &%perl_at_start%&.
11765 .endlist
11766
11767 There is also a command line option &%-pd%& (for delay) which suppresses the
11768 initial startup, even if &%perl_at_start%& is set.
11769
11770
11771 .section "Calling Perl subroutines" "SECID86"
11772 When the configuration file includes a &%perl_startup%& option you can make use
11773 of the string expansion item to call the Perl subroutines that are defined
11774 by the &%perl_startup%& code. The operator is used in any of the following
11775 forms:
11776 .code
11777 ${perl{foo}}
11778 ${perl{foo}{argument}}
11779 ${perl{foo}{argument1}{argument2} ... }
11780 .endd
11781 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
11782 arguments may be passed. Passing more than this results in an expansion failure
11783 with an error message of the form
11784 .code
11785 Too many arguments passed to Perl subroutine "foo" (max is 8)
11786 .endd
11787 The return value of the Perl subroutine is evaluated in a scalar context before
11788 it is passed back to Exim to be inserted into the expanded string. If the
11789 return value is &'undef'&, the expansion is forced to fail in the same way as
11790 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
11791 by obeying Perl's &%die%& function, the expansion fails with the error message
11792 that was passed to &%die%&.
11793
11794
11795 .section "Calling Exim functions from Perl" "SECID87"
11796 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
11797 is available to call back into Exim's string expansion function. For example,
11798 the Perl code
11799 .code
11800 my $lp = Exim::expand_string('$local_part');
11801 .endd
11802 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
11803 Note those are single quotes and not double quotes to protect against
11804 &$local_part$& being interpolated as a Perl variable.
11805
11806 If the string expansion is forced to fail by a &"fail"& item, the result of
11807 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
11808 expansion string, the Perl call from the original expansion string fails with
11809 an appropriate error message, in the same way as if &%die%& were used.
11810
11811 .cindex "debugging" "from embedded Perl"
11812 .cindex "log" "writing from embedded Perl"
11813 Two other Exim functions are available for use from within Perl code.
11814 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
11815 debugging is enabled. If you want a newline at the end, you must supply it.
11816 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
11817 timestamp. In this case, you should not supply a terminating newline.
11818
11819
11820 .section "Use of standard output and error by Perl" "SECID88"
11821 .cindex "Perl" "standard output and error"
11822 You should not write to the standard error or output streams from within your
11823 Perl code, as it is not defined how these are set up. In versions of Exim
11824 before 4.50, it is possible for the standard output or error to refer to the
11825 SMTP connection during message reception via the daemon. Writing to this stream
11826 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
11827 error streams are connected to &_/dev/null_& in the daemon. The chaos is
11828 avoided, but the output is lost.
11829
11830 .cindex "Perl" "use of &%warn%&"
11831 The Perl &%warn%& statement writes to the standard error stream by default.
11832 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
11833 you have no control. When Exim starts up the Perl interpreter, it arranges for
11834 output from the &%warn%& statement to be written to the Exim main log. You can
11835 change this by including appropriate Perl magic somewhere in your Perl code.
11836 For example, to discard &%warn%& output completely, you need this:
11837 .code
11838 $SIG{__WARN__} = sub { };
11839 .endd
11840 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
11841 example, the code for the subroutine is empty, so it does nothing, but you can
11842 include any Perl code that you like. The text of the &%warn%& message is passed
11843 as the first subroutine argument.
11844 .ecindex IIDperl
11845
11846
11847 . ////////////////////////////////////////////////////////////////////////////
11848 . ////////////////////////////////////////////////////////////////////////////
11849
11850 .chapter "Starting the daemon and the use of network interfaces" &&&
11851          "CHAPinterfaces" &&&
11852          "Starting the daemon"
11853 .cindex "daemon" "starting"
11854 .cindex "interface" "listening"
11855 .cindex "network interface"
11856 .cindex "interface" "network"
11857 .cindex "IP address" "for listening"
11858 .cindex "daemon" "listening IP addresses"
11859 .cindex "TCP/IP" "setting listening interfaces"
11860 .cindex "TCP/IP" "setting listening ports"
11861 A host that is connected to a TCP/IP network may have one or more physical
11862 hardware network interfaces. Each of these interfaces may be configured as one
11863 or more &"logical"& interfaces, which are the entities that a program actually
11864 works with. Each of these logical interfaces is associated with an IP address.
11865 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
11866 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
11867 knowledge about the host's interfaces for use in three different circumstances:
11868
11869 .olist
11870 When a listening daemon is started, Exim needs to know which interfaces
11871 and ports to listen on.
11872 .next
11873 When Exim is routing an address, it needs to know which IP addresses
11874 are associated with local interfaces. This is required for the correct
11875 processing of MX lists by removing the local host and others with the
11876 same or higher priority values. Also, Exim needs to detect cases
11877 when an address is routed to an IP address that in fact belongs to the
11878 local host. Unless the &%self%& router option or the &%allow_localhost%&
11879 option of the smtp transport is set (as appropriate), this is treated
11880 as an error situation.
11881 .next
11882 When Exim connects to a remote host, it may need to know which interface to use
11883 for the outgoing connection.
11884 .endlist
11885
11886
11887 Exim's default behaviour is likely to be appropriate in the vast majority
11888 of cases. If your host has only one interface, and you want all its IP
11889 addresses to be treated in the same way, and you are using only the
11890 standard SMTP port, you should not need to take any special action. The
11891 rest of this chapter does not apply to you.
11892
11893 In a more complicated situation you may want to listen only on certain
11894 interfaces, or on different ports, and for this reason there are a number of
11895 options that can be used to influence Exim's behaviour. The rest of this
11896 chapter describes how they operate.
11897
11898 When a message is received over TCP/IP, the interface and port that were
11899 actually used are set in &$received_ip_address$& and &$received_port$&.
11900
11901
11902
11903 .section "Starting a listening daemon" "SECID89"
11904 When a listening daemon is started (by means of the &%-bd%& command line
11905 option), the interfaces and ports on which it listens are controlled by the
11906 following options:
11907
11908 .ilist
11909 &%daemon_smtp_ports%& contains a list of default ports. (For backward
11910 compatibility, this option can also be specified in the singular.)
11911 .next
11912 &%local_interfaces%& contains list of interface IP addresses on which to
11913 listen. Each item may optionally also specify a port.
11914 .endlist
11915
11916 The default list separator in both cases is a colon, but this can be changed as
11917 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
11918 it is usually best to change the separator to avoid having to double all the
11919 colons. For example:
11920 .code
11921 local_interfaces = <; 127.0.0.1 ; \
11922                       192.168.23.65 ; \
11923                       ::1 ; \
11924                       3ffe:ffff:836f::fe86:a061
11925 .endd
11926 There are two different formats for specifying a port along with an IP address
11927 in &%local_interfaces%&:
11928
11929 .olist
11930 The port is added onto the address with a dot separator. For example, to listen
11931 on port 1234 on two different IP addresses:
11932 .code
11933 local_interfaces = <; 192.168.23.65.1234 ; \
11934                       3ffe:ffff:836f::fe86:a061.1234
11935 .endd
11936 .next
11937 The IP address is enclosed in square brackets, and the port is added
11938 with a colon separator, for example:
11939 .code
11940 local_interfaces = <; [192.168.23.65]:1234 ; \
11941                       [3ffe:ffff:836f::fe86:a061]:1234
11942 .endd
11943 .endlist
11944
11945 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
11946 default setting contains just one port:
11947 .code
11948 daemon_smtp_ports = smtp
11949 .endd
11950 If more than one port is listed, each interface that does not have its own port
11951 specified listens on all of them. Ports that are listed in
11952 &%daemon_smtp_ports%& can be identified either by name (defined in
11953 &_/etc/services_&) or by number. However, when ports are given with individual
11954 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
11955
11956
11957
11958 .section "Special IP listening addresses" "SECID90"
11959 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
11960 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
11961 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
11962 instead of setting up separate listening sockets for each interface. The
11963 default value of &%local_interfaces%& is
11964 .code
11965 local_interfaces = 0.0.0.0
11966 .endd
11967 when Exim is built without IPv6 support; otherwise it is:
11968 .code
11969 local_interfaces = <; ::0 ; 0.0.0.0
11970 .endd
11971 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
11972
11973
11974
11975 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
11976 The &%-oX%& command line option can be used to override the values of
11977 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
11978 instance. Another way of doing this would be to use macros and the &%-D%&
11979 option. However, &%-oX%& can be used by any admin user, whereas modification of
11980 the runtime configuration by &%-D%& is allowed only when the caller is root or
11981 exim.
11982
11983 The value of &%-oX%& is a list of items. The default colon separator can be
11984 changed in the usual way if required. If there are any items that do not
11985 contain dots or colons (that is, are not IP addresses), the value of
11986 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
11987 items that do contain dots or colons, the value of &%local_interfaces%& is
11988 replaced by those items. Thus, for example,
11989 .code
11990 -oX 1225
11991 .endd
11992 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
11993 whereas
11994 .code
11995 -oX 192.168.34.5.1125
11996 .endd
11997 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
11998 (However, since &%local_interfaces%& now contains no items without ports, the
11999 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
12000
12001
12002
12003 .section "Support for the obsolete SSMTP (or SMTPS) protocol" "SECTsupobssmt"
12004 .cindex "ssmtp protocol"
12005 .cindex "smtps protocol"
12006 .cindex "SMTP" "ssmtp protocol"
12007 .cindex "SMTP" "smtps protocol"
12008 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
12009 before the STARTTLS command was standardized for SMTP. Some legacy clients
12010 still use this protocol. If the &%tls_on_connect_ports%& option is set to a
12011 list of port numbers, connections to those ports must use SSMTP. The most
12012 common use of this option is expected to be
12013 .code
12014 tls_on_connect_ports = 465
12015 .endd
12016 because 465 is the usual port number used by the legacy clients. There is also
12017 a command line option &%-tls-on-connect%&, which forces all ports to behave in
12018 this way when a daemon is started.
12019
12020 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
12021 daemon to listen on those ports. You must still specify them in
12022 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
12023 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
12024 connections via the daemon.)
12025
12026
12027
12028
12029 .section "IPv6 address scopes" "SECID92"
12030 .cindex "IPv6" "address scopes"
12031 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
12032 can, in principle, have the same link-local IPv6 address on different
12033 interfaces. Thus, additional information is needed, over and above the IP
12034 address, to distinguish individual interfaces. A convention of using a
12035 percent sign followed by something (often the interface name) has been
12036 adopted in some cases, leading to addresses like this:
12037 .code
12038 fe80::202:b3ff:fe03:45c1%eth0
12039 .endd
12040 To accommodate this usage, a percent sign followed by an arbitrary string is
12041 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
12042 to convert a textual IPv6 address for actual use. This function recognizes the
12043 percent convention in operating systems that support it, and it processes the
12044 address appropriately. Unfortunately, some older libraries have problems with
12045 &[getaddrinfo()]&. If
12046 .code
12047 IPV6_USE_INET_PTON=yes
12048 .endd
12049 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
12050 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
12051 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
12052 function.) Of course, this means that the additional functionality of
12053 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
12054
12055 .section "Disabling IPv6" "SECID93"
12056 .cindex "IPv6" "disabling"
12057 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
12058 run on a host whose kernel does not support IPv6. The binary will fall back to
12059 using IPv4, but it may waste resources looking up AAAA records, and trying to
12060 connect to IPv6 addresses, causing delays to mail delivery. If you set the
12061 .oindex "&%disable_ipv6%&"
12062 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
12063 activities take place. AAAA records are never looked up, and any IPv6 addresses
12064 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
12065 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
12066 to handle IPv6 literal addresses.
12067
12068 On the other hand, when IPv6 is in use, there may be times when you want to
12069 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
12070 option to globally suppress the lookup of AAAA records for specified domains,
12071 and you can use the &%ignore_target_hosts%& generic router option to ignore
12072 IPv6 addresses in an individual router.
12073
12074
12075
12076 .section "Examples of starting a listening daemon" "SECID94"
12077 The default case in an IPv6 environment is
12078 .code
12079 daemon_smtp_ports = smtp
12080 local_interfaces = <; ::0 ; 0.0.0.0
12081 .endd
12082 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
12083 Either one or two sockets may be used, depending on the characteristics of
12084 the TCP/IP stack. (This is complicated and messy; for more information,
12085 read the comments in the &_daemon.c_& source file.)
12086
12087 To specify listening on ports 25 and 26 on all interfaces:
12088 .code
12089 daemon_smtp_ports = 25 : 26
12090 .endd
12091 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
12092 .code
12093 local_interfaces = <; ::0.25     ; ::0.26 \
12094                       0.0.0.0.25 ; 0.0.0.0.26
12095 .endd
12096 To listen on the default port on all IPv4 interfaces, and on port 26 on the
12097 IPv4 loopback address only:
12098 .code
12099 local_interfaces = 0.0.0.0 : 127.0.0.1.26
12100 .endd
12101 To specify listening on the default port on specific interfaces only:
12102 .code
12103 local_interfaces = 192.168.34.67 : 192.168.34.67
12104 .endd
12105 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
12106
12107
12108
12109 .section "Recognizing the local host" "SECTreclocipadd"
12110 The &%local_interfaces%& option is also used when Exim needs to determine
12111 whether or not an IP address refers to the local host. That is, the IP
12112 addresses of all the interfaces on which a daemon is listening are always
12113 treated as local.
12114
12115 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
12116 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
12117 available interfaces from the operating system, and extracts the relevant
12118 (that is, IPv4 or IPv6) addresses to use for checking.
12119
12120 Some systems set up large numbers of virtual interfaces in order to provide
12121 many virtual web servers. In this situation, you may want to listen for
12122 email on only a few of the available interfaces, but nevertheless treat all
12123 interfaces as local when routing. You can do this by setting
12124 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
12125 &"all"& wildcard values. These addresses are recognized as local, but are not
12126 used for listening. Consider this example:
12127 .code
12128 local_interfaces = <; 127.0.0.1 ; ::1 ; \
12129                       192.168.53.235 ; \
12130                       3ffe:2101:12:1:a00:20ff:fe86:a061
12131
12132 extra_local_interfaces = <; ::0 ; 0.0.0.0
12133 .endd
12134 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
12135 address, but all available interface addresses are treated as local when
12136 Exim is routing.
12137
12138 In some environments the local host name may be in an MX list, but with an IP
12139 address that is not assigned to any local interface. In other cases it may be
12140 desirable to treat other host names as if they referred to the local host. Both
12141 these cases can be handled by setting the &%hosts_treat_as_local%& option.
12142 This contains host names rather than IP addresses. When a host is referenced
12143 during routing, either via an MX record or directly, it is treated as the local
12144 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
12145 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
12146
12147
12148
12149 .section "Delivering to a remote host" "SECID95"
12150 Delivery to a remote host is handled by the smtp transport. By default, it
12151 allows the system's TCP/IP functions to choose which interface to use (if
12152 there is more than one) when connecting to a remote host. However, the
12153 &%interface%& option can be set to specify which interface is used. See the
12154 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
12155 details.
12156
12157
12158
12159
12160 . ////////////////////////////////////////////////////////////////////////////
12161 . ////////////////////////////////////////////////////////////////////////////
12162
12163 .chapter "Main configuration" "CHAPmainconfig"
12164 .scindex IIDconfima "configuration file" "main section"
12165 .scindex IIDmaiconf "main configuration"
12166 The first part of the run time configuration file contains three types of item:
12167
12168 .ilist
12169 Macro definitions: These lines start with an upper case letter. See section
12170 &<<SECTmacrodefs>>& for details of macro processing.
12171 .next
12172 Named list definitions: These lines start with one of the words &"domainlist"&,
12173 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
12174 section &<<SECTnamedlists>>&.
12175 .next
12176 Main configuration settings: Each setting occupies one line of the file
12177 (with possible continuations). If any setting is preceded by the word
12178 &"hide"&, the &%-bP%& command line option displays its value to admin users
12179 only. See section &<<SECTcos>>& for a description of the syntax of these option
12180 settings.
12181 .endlist
12182
12183 This chapter specifies all the main configuration options, along with their
12184 types and default values. For ease of finding a particular option, they appear
12185 in alphabetical order in section &<<SECTalomo>>& below. However, because there
12186 are now so many options, they are first listed briefly in functional groups, as
12187 an aid to finding the name of the option you are looking for. Some options are
12188 listed in more than one group.
12189
12190 .section "Miscellaneous" "SECID96"
12191 .table2
12192 .row &%bi_command%&                  "to run for &%-bi%& command line option"
12193 .row &%disable_ipv6%&                "do no IPv6 processing"
12194 .row &%keep_malformed%&              "for broken files &-- should not happen"
12195 .row &%localhost_number%&            "for unique message ids in clusters"
12196 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
12197 .row &%message_body_visible%&        "how much to show in &$message_body$&"
12198 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
12199 .row &%print_topbitchars%&           "top-bit characters are printing"
12200 .row &%timezone%&                    "force time zone"
12201 .endtable
12202
12203
12204 .section "Exim parameters" "SECID97"
12205 .table2
12206 .row &%exim_group%&                  "override compiled-in value"
12207 .row &%exim_path%&                   "override compiled-in value"
12208 .row &%exim_user%&                   "override compiled-in value"
12209 .row &%primary_hostname%&            "default from &[uname()]&"
12210 .row &%split_spool_directory%&       "use multiple directories"
12211 .row &%spool_directory%&             "override compiled-in value"
12212 .endtable
12213
12214
12215
12216 .section "Privilege controls" "SECID98"
12217 .table2
12218 .row &%admin_groups%&                "groups that are Exim admin users"
12219 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
12220 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
12221 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
12222 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
12223 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
12224 .row &%never_users%&                 "do not run deliveries as these"
12225 .row &%prod_requires_admin%&         "forced delivery requires admin user"
12226 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
12227 .row &%trusted_groups%&              "groups that are trusted"
12228 .row &%trusted_users%&               "users that are trusted"
12229 .endtable
12230
12231
12232
12233 .section "Logging" "SECID99"
12234 .table2
12235 .row &%hosts_connection_nolog%&      "exemption from connect logging"
12236 .row &%log_file_path%&               "override compiled-in value"
12237 .row &%log_selector%&                "set/unset optional logging"
12238 .row &%log_timezone%&                "add timezone to log lines"
12239 .row &%message_logs%&                "create per-message logs"
12240 .row &%preserve_message_logs%&       "after message completion"
12241 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
12242 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
12243 .row &%syslog_facility%&             "set syslog &""facility""& field"
12244 .row &%syslog_processname%&          "set syslog &""ident""& field"
12245 .row &%syslog_timestamp%&            "timestamp syslog lines"
12246 .row &%write_rejectlog%&             "control use of message log"
12247 .endtable
12248
12249
12250
12251 .section "Frozen messages" "SECID100"
12252 .table2
12253 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
12254 .row &%freeze_tell%&                 "send message when freezing"
12255 .row &%move_frozen_messages%&        "to another directory"
12256 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
12257 .endtable
12258
12259
12260
12261 .section "Data lookups" "SECID101"
12262 .table2
12263 .row &%ibase_servers%&               "InterBase servers"
12264 .row &%ldap_default_servers%&        "used if no server in query"
12265 .row &%ldap_version%&                "set protocol version"
12266 .row &%lookup_open_max%&             "lookup files held open"
12267 .row &%mysql_servers%&               "default MySQL servers"
12268 .row &%oracle_servers%&              "Oracle servers"
12269 .row &%pgsql_servers%&               "default PostgreSQL servers"
12270 .row &%sqlite_lock_timeout%&         "as it says"
12271 .endtable
12272
12273
12274
12275 .section "Message ids" "SECID102"
12276 .table2
12277 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
12278 .row &%message_id_header_text%&      "ditto"
12279 .endtable
12280
12281
12282
12283 .section "Embedded Perl Startup" "SECID103"
12284 .table2
12285 .row &%perl_at_start%&               "always start the interpreter"
12286 .row &%perl_startup%&                "code to obey when starting Perl"
12287 .endtable
12288
12289
12290
12291 .section "Daemon" "SECID104"
12292 .table2
12293 .row &%daemon_smtp_ports%&           "default ports"
12294 .row &%daemon_startup_retries%&      "number of times to retry"
12295 .row &%daemon_startup_sleep%&        "time to sleep between tries"
12296 .row &%extra_local_interfaces%&      "not necessarily listened on"
12297 .row &%local_interfaces%&            "on which to listen, with optional ports"
12298 .row &%pid_file_path%&               "override compiled-in value"
12299 .row &%queue_run_max%&               "maximum simultaneous queue runners"
12300 .endtable
12301
12302
12303
12304 .section "Resource control" "SECID105"
12305 .table2
12306 .row &%check_log_inodes%&            "before accepting a message"
12307 .row &%check_log_space%&             "before accepting a message"
12308 .row &%check_spool_inodes%&          "before accepting a message"
12309 .row &%check_spool_space%&           "before accepting a message"
12310 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
12311 .row &%queue_only_load%&             "queue incoming if load high"
12312 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
12313 .row &%queue_run_max%&               "maximum simultaneous queue runners"
12314 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
12315 .row &%smtp_accept_max%&             "simultaneous incoming connections"
12316 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
12317 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
12318 .row &%smtp_accept_max_per_connection%& "messages per connection"
12319 .row &%smtp_accept_max_per_host%&    "connections from one host"
12320 .row &%smtp_accept_queue%&           "queue mail if more connections"
12321 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
12322                                            connection"
12323 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
12324 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
12325 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
12326 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
12327 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
12328 .endtable
12329
12330
12331
12332 .section "Policy controls" "SECID106"
12333 .table2
12334 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
12335 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
12336 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
12337 .row &%acl_smtp_auth%&               "ACL for AUTH"
12338 .row &%acl_smtp_connect%&            "ACL for connection"
12339 .row &%acl_smtp_data%&               "ACL for DATA"
12340 .row &%acl_smtp_etrn%&               "ACL for ETRN"
12341 .row &%acl_smtp_expn%&               "ACL for EXPN"
12342 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
12343 .row &%acl_smtp_mail%&               "ACL for MAIL"
12344 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
12345 .row &%acl_smtp_mime%&               "ACL for MIME parts"
12346 .row &%acl_smtp_predata%&            "ACL for start of data"
12347 .row &%acl_smtp_quit%&               "ACL for QUIT"
12348 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
12349 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
12350 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
12351 .row &%av_scanner%&                  "specify virus scanner"
12352 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
12353                                       words""&"
12354 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
12355 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
12356 .row &%header_maxsize%&              "total size of message header"
12357 .row &%header_line_maxsize%&         "individual header line limit"
12358 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
12359 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
12360 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
12361 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
12362 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
12363 .row &%host_lookup%&                 "host name looked up for these hosts"
12364 .row &%host_lookup_order%&           "order of DNS and local name lookups"
12365 .row &%host_reject_connection%&      "reject connection from these hosts"
12366 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
12367 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
12368 .row &%message_size_limit%&          "for all messages"
12369 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
12370 .row &%spamd_address%&               "set interface to SpamAssassin"
12371 .row &%strict_acl_vars%&             "object to unset ACL variables"
12372 .endtable
12373
12374
12375
12376 .section "Callout cache" "SECID107"
12377 .table2
12378 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
12379                                          item"
12380 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
12381                                          item"
12382 .row &%callout_negative_expire%&     "timeout for negative address cache item"
12383 .row &%callout_positive_expire%&     "timeout for positive address cache item"
12384 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
12385 .endtable
12386
12387
12388
12389 .section "TLS" "SECID108"
12390 .table2
12391 .row &%gnutls_require_kx%&           "control GnuTLS key exchanges"
12392 .row &%gnutls_require_mac%&          "control GnuTLS MAC algorithms"
12393 .row &%gnutls_require_protocols%&    "control GnuTLS protocols"
12394 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
12395 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
12396 .row &%tls_certificate%&             "location of server certificate"
12397 .row &%tls_crl%&                     "certificate revocation list"
12398 .row &%tls_dhparam%&                 "DH parameters for server"
12399 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
12400 .row &%tls_privatekey%&              "location of server private key"
12401 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
12402 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
12403 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
12404 .row &%tls_verify_certificates%&     "expected client certificates"
12405 .row &%tls_verify_hosts%&            "insist on client certificate verify"
12406 .endtable
12407
12408
12409
12410 .section "Local user handling" "SECID109"
12411 .table2
12412 .row &%finduser_retries%&            "useful in NIS environments"
12413 .row &%gecos_name%&                  "used when creating &'Sender:'&"
12414 .row &%gecos_pattern%&               "ditto"
12415 .row &%max_username_length%&         "for systems that truncate"
12416 .row &%unknown_login%&               "used when no login name found"
12417 .row &%unknown_username%&            "ditto"
12418 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
12419 .row &%uucp_from_sender%&            "ditto"
12420 .endtable
12421
12422
12423
12424 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
12425 .table2
12426 .row &%header_maxsize%&              "total size of message header"
12427 .row &%header_line_maxsize%&         "individual header line limit"
12428 .row &%message_size_limit%&          "applies to all messages"
12429 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
12430 .row &%received_header_text%&        "expanded to make &'Received:'&"
12431 .row &%received_headers_max%&        "for mail loop detection"
12432 .row &%recipients_max%&              "limit per message"
12433 .row &%recipients_max_reject%&       "permanently reject excess recipients"
12434 .endtable
12435
12436
12437
12438
12439 .section "Non-SMTP incoming messages" "SECID111"
12440 .table2
12441 .row &%receive_timeout%&             "for non-SMTP messages"
12442 .endtable
12443
12444
12445
12446
12447
12448 .section "Incoming SMTP messages" "SECID112"
12449 See also the &'Policy controls'& section above.
12450
12451 .table2
12452 .row &%host_lookup%&                 "host name looked up for these hosts"
12453 .row &%host_lookup_order%&           "order of DNS and local name lookups"
12454 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
12455 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
12456 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
12457 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
12458 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
12459 .row &%smtp_accept_max%&             "simultaneous incoming connections"
12460 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
12461 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
12462 .row &%smtp_accept_max_per_connection%& "messages per connection"
12463 .row &%smtp_accept_max_per_host%&    "connections from one host"
12464 .row &%smtp_accept_queue%&           "queue mail if more connections"
12465 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
12466                                            connection"
12467 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
12468 .row &%smtp_active_hostname%&        "host name to use in messages"
12469 .row &%smtp_banner%&                 "text for welcome banner"
12470 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
12471 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
12472 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
12473 .row &%smtp_etrn_command%&           "what to run for ETRN"
12474 .row &%smtp_etrn_serialize%&         "only one at once"
12475 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
12476 .row &%smtp_max_unknown_commands%&   "before dropping connection"
12477 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
12478 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
12479 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
12480 .row &%smtp_receive_timeout%&        "per command or data line"
12481 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
12482 .row &%smtp_return_error_details%&   "give detail on rejections"
12483 .endtable
12484
12485
12486
12487 .section "SMTP extensions" "SECID113"
12488 .table2
12489 .row &%accept_8bitmime%&             "advertise 8BITMIME"
12490 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
12491 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
12492 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
12493 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
12494 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
12495 .endtable
12496
12497
12498
12499 .section "Processing messages" "SECID114"
12500 .table2
12501 .row &%allow_domain_literals%&       "recognize domain literal syntax"
12502 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
12503 .row &%allow_utf8_domains%&          "in addresses"
12504 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
12505                                       words""&"
12506 .row &%delivery_date_remove%&        "from incoming messages"
12507 .row &%envelope_to_remove%&          "from incoming messages"
12508 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
12509 .row &%headers_charset%&             "default for translations"
12510 .row &%qualify_domain%&              "default for senders"
12511 .row &%qualify_recipient%&           "default for recipients"
12512 .row &%return_path_remove%&          "from incoming messages"
12513 .row &%strip_excess_angle_brackets%& "in addresses"
12514 .row &%strip_trailing_dot%&          "at end of addresses"
12515 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
12516 .endtable
12517
12518
12519
12520 .section "System filter" "SECID115"
12521 .table2
12522 .row &%system_filter%&               "locate system filter"
12523 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
12524                                             directory"
12525 .row &%system_filter_file_transport%& "transport for delivery to a file"
12526 .row &%system_filter_group%&         "group for filter running"
12527 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
12528 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
12529 .row &%system_filter_user%&          "user for filter running"
12530 .endtable
12531
12532
12533
12534 .section "Routing and delivery" "SECID116"
12535 .table2
12536 .row &%disable_ipv6%&                "do no IPv6 processing"
12537 .row &%dns_again_means_nonexist%&    "for broken domains"
12538 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
12539 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
12540 .row &%dns_retrans%&                 "parameter for resolver"
12541 .row &%dns_retry%&                   "parameter for resolver"
12542 .row &%hold_domains%&                "hold delivery for these domains"
12543 .row &%local_interfaces%&            "for routing checks"
12544 .row &%queue_domains%&               "no immediate delivery for these"
12545 .row &%queue_only%&                  "no immediate delivery at all"
12546 .row &%queue_only_file%&             "no immediate delivery if file exists"
12547 .row &%queue_only_load%&             "no immediate delivery if load is high"
12548 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
12549 .row &%queue_only_override%&         "allow command line to override"
12550 .row &%queue_run_in_order%&          "order of arrival"
12551 .row &%queue_run_max%&               "of simultaneous queue runners"
12552 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
12553 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
12554 .row &%remote_sort_domains%&         "order of remote deliveries"
12555 .row &%retry_data_expire%&           "timeout for retry data"
12556 .row &%retry_interval_max%&          "safety net for retry rules"
12557 .endtable
12558
12559
12560
12561 .section "Bounce and warning messages" "SECID117"
12562 .table2
12563 .row &%bounce_message_file%&         "content of bounce"
12564 .row &%bounce_message_text%&         "content of bounce"
12565 .row &%bounce_return_body%&          "include body if returning message"
12566 .row &%bounce_return_message%&       "include original message in bounce"
12567 .row &%bounce_return_size_limit%&    "limit on returned message"
12568 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
12569 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
12570 .row &%errors_copy%&                 "copy bounce messages"
12571 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
12572 .row &%delay_warning%&               "time schedule"
12573 .row &%delay_warning_condition%&     "condition for warning messages"
12574 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
12575 .row &%smtp_return_error_details%&   "give detail on rejections"
12576 .row &%warn_message_file%&           "content of warning message"
12577 .endtable
12578
12579
12580
12581 .section "Alphabetical list of main options" "SECTalomo"
12582 Those options that undergo string expansion before use are marked with
12583 &dagger;.
12584
12585 .option accept_8bitmime main boolean false
12586 .cindex "8BITMIME"
12587 .cindex "8-bit characters"
12588 This option causes Exim to send 8BITMIME in its response to an SMTP
12589 EHLO command, and to accept the BODY= parameter on MAIL commands.
12590 However, though Exim is 8-bit clean, it is not a protocol converter, and it
12591 takes no steps to do anything special with messages received by this route.
12592 Consequently, this option is turned off by default.
12593
12594 .option acl_not_smtp main string&!! unset
12595 .cindex "&ACL;" "for non-SMTP messages"
12596 .cindex "non-SMTP messages" "ACLs for"
12597 This option defines the ACL that is run when a non-SMTP message has been
12598 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
12599 further details.
12600
12601 .option acl_not_smtp_mime main string&!! unset
12602 This option defines the ACL that is run for individual MIME parts of non-SMTP
12603 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
12604 SMTP messages.
12605
12606 .option acl_not_smtp_start main string&!! unset
12607 .cindex "&ACL;" "at start of non-SMTP message"
12608 .cindex "non-SMTP messages" "ACLs for"
12609 This option defines the ACL that is run before Exim starts reading a
12610 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
12611
12612 .option acl_smtp_auth main string&!! unset
12613 .cindex "&ACL;" "setting up for SMTP commands"
12614 .cindex "AUTH" "ACL for"
12615 This option defines the ACL that is run when an SMTP AUTH command is
12616 received. See chapter &<<CHAPACL>>& for further details.
12617
12618 .option acl_smtp_connect main string&!! unset
12619 .cindex "&ACL;" "on SMTP connection"
12620 This option defines the ACL that is run when an SMTP connection is received.
12621 See chapter &<<CHAPACL>>& for further details.
12622
12623 .option acl_smtp_data main string&!! unset
12624 .cindex "DATA" "ACL for"
12625 This option defines the ACL that is run after an SMTP DATA command has been
12626 processed and the message itself has been received, but before the final
12627 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
12628
12629 .option acl_smtp_etrn main string&!! unset
12630 .cindex "ETRN" "ACL for"
12631 This option defines the ACL that is run when an SMTP ETRN command is
12632 received. See chapter &<<CHAPACL>>& for further details.
12633
12634 .option acl_smtp_expn main string&!! unset
12635 .cindex "EXPN" "ACL for"
12636 This option defines the ACL that is run when an SMTP EXPN command is
12637 received. See chapter &<<CHAPACL>>& for further details.
12638
12639 .option acl_smtp_helo main string&!! unset
12640 .cindex "EHLO" "ACL for"
12641 .cindex "HELO" "ACL for"
12642 This option defines the ACL that is run when an SMTP EHLO or HELO
12643 command is received. See chapter &<<CHAPACL>>& for further details.
12644
12645
12646 .option acl_smtp_mail main string&!! unset
12647 .cindex "MAIL" "ACL for"
12648 This option defines the ACL that is run when an SMTP MAIL command is
12649 received. See chapter &<<CHAPACL>>& for further details.
12650
12651 .option acl_smtp_mailauth main string&!! unset
12652 .cindex "AUTH" "on MAIL command"
12653 This option defines the ACL that is run when there is an AUTH parameter on
12654 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
12655 &<<CHAPSMTPAUTH>>& for details of authentication.
12656
12657 .option acl_smtp_mime main string&!! unset
12658 .cindex "MIME content scanning" "ACL for"
12659 This option is available when Exim is built with the content-scanning
12660 extension. It defines the ACL that is run for each MIME part in a message. See
12661 section &<<SECTscanmimepart>>& for details.
12662
12663 .option acl_smtp_predata main string&!! unset
12664 This option defines the ACL that is run when an SMTP DATA command is
12665 received, before the message itself is received. See chapter &<<CHAPACL>>& for
12666 further details.
12667
12668 .option acl_smtp_quit main string&!! unset
12669 .cindex "QUIT, ACL for"
12670 This option defines the ACL that is run when an SMTP QUIT command is
12671 received. See chapter &<<CHAPACL>>& for further details.
12672
12673 .option acl_smtp_rcpt main string&!! unset
12674 .cindex "RCPT" "ACL for"
12675 This option defines the ACL that is run when an SMTP RCPT command is
12676 received. See chapter &<<CHAPACL>>& for further details.
12677
12678 .option acl_smtp_starttls main string&!! unset
12679 .cindex "STARTTLS, ACL for"
12680 This option defines the ACL that is run when an SMTP STARTTLS command is
12681 received. See chapter &<<CHAPACL>>& for further details.
12682
12683 .option acl_smtp_vrfy main string&!! unset
12684 .cindex "VRFY" "ACL for"
12685 This option defines the ACL that is run when an SMTP VRFY command is
12686 received. See chapter &<<CHAPACL>>& for further details.
12687
12688 .option admin_groups main "string list&!!" unset
12689 .cindex "admin user"
12690 This option is expanded just once, at the start of Exim's processing. If the
12691 current group or any of the supplementary groups of an Exim caller is in this
12692 colon-separated list, the caller has admin privileges. If all your system
12693 programmers are in a specific group, for example, you can give them all Exim
12694 admin privileges by putting that group in &%admin_groups%&. However, this does
12695 not permit them to read Exim's spool files (whose group owner is the Exim gid).
12696 To permit this, you have to add individuals to the Exim group.
12697
12698 .option allow_domain_literals main boolean false
12699 .cindex "domain literal"
12700 If this option is set, the RFC 2822 domain literal format is permitted in
12701 email addresses. The option is not set by default, because the domain literal
12702 format is not normally required these days, and few people know about it. It
12703 has, however, been exploited by mail abusers.
12704
12705 Unfortunately, it seems that some DNS black list maintainers are using this
12706 format to report black listing to postmasters. If you want to accept messages
12707 addressed to your hosts by IP address, you need to set
12708 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
12709 domains (defined in the named domain list &%local_domains%& in the default
12710 configuration). This &"magic string"& matches the domain literal form of all
12711 the local host's IP addresses.
12712
12713
12714 .option allow_mx_to_ip main boolean false
12715 .cindex "MX record" "pointing to IP address"
12716 It appears that more and more DNS zone administrators are breaking the rules
12717 and putting domain names that look like IP addresses on the right hand side of
12718 MX records. Exim follows the rules and rejects this, giving an error message
12719 that explains the mis-configuration. However, some other MTAs support this
12720 practice, so to avoid &"Why can't Exim do this?"& complaints,
12721 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
12722 recommended, except when you have no other choice.
12723
12724 .option allow_utf8_domains main boolean false
12725 .cindex "domain" "UTF-8 characters in"
12726 .cindex "UTF-8" "in domain name"
12727 Lots of discussion is going on about internationalized domain names. One
12728 camp is strongly in favour of just using UTF-8 characters, and it seems
12729 that at least two other MTAs permit this. This option allows Exim users to
12730 experiment if they wish.
12731
12732 If it is set true, Exim's domain parsing function allows valid
12733 UTF-8 multicharacters to appear in domain name components, in addition to
12734 letters, digits, and hyphens. However, just setting this option is not
12735 enough; if you want to look up these domain names in the DNS, you must also
12736 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
12737 suitable setting is:
12738 .code
12739 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
12740   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
12741 .endd
12742 Alternatively, you can just disable this feature by setting
12743 .code
12744 dns_check_names_pattern =
12745 .endd
12746 That is, set the option to an empty string so that no check is done.
12747
12748
12749 .option auth_advertise_hosts main "host list&!!" *
12750 .cindex "authentication" "advertising"
12751 .cindex "AUTH" "advertising"
12752 If any server authentication mechanisms are configured, Exim advertises them in
12753 response to an EHLO command only if the calling host matches this list.
12754 Otherwise, Exim does not advertise AUTH.
12755 Exim does not accept AUTH commands from clients to which it has not
12756 advertised the availability of AUTH. The advertising of individual
12757 authentication mechanisms can be controlled by the use of the
12758 &%server_advertise_condition%& generic authenticator option on the individual
12759 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
12760
12761 Certain mail clients (for example, Netscape) require the user to provide a name
12762 and password for authentication if AUTH is advertised, even though it may
12763 not be needed (the host may accept messages from hosts on its local LAN without
12764 authentication, for example). The &%auth_advertise_hosts%& option can be used
12765 to make these clients more friendly by excluding them from the set of hosts to
12766 which Exim advertises AUTH.
12767
12768 .cindex "AUTH" "advertising when encrypted"
12769 If you want to advertise the availability of AUTH only when the connection
12770 is encrypted using TLS, you can make use of the fact that the value of this
12771 option is expanded, with a setting like this:
12772 .code
12773 auth_advertise_hosts = ${if eq{$tls_cipher}{}{}{*}}
12774 .endd
12775 .vindex "&$tls_cipher$&"
12776 If &$tls_cipher$& is empty, the session is not encrypted, and the result of
12777 the expansion is empty, thus matching no hosts. Otherwise, the result of the
12778 expansion is *, which matches all hosts.
12779
12780
12781 .option auto_thaw main time 0s
12782 .cindex "thawing messages"
12783 .cindex "unfreezing messages"
12784 If this option is set to a time greater than zero, a queue runner will try a
12785 new delivery attempt on any frozen message, other than a bounce message, if
12786 this much time has passed since it was frozen. This may result in the message
12787 being re-frozen if nothing has changed since the last attempt. It is a way of
12788 saying &"keep on trying, even though there are big problems"&.
12789
12790 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
12791 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
12792 thought to be very useful any more, and its use should probably be avoided.
12793
12794 .option av_scanner main string "see below"
12795 This option is available if Exim is built with the content-scanning extension.
12796 It specifies which anti-virus scanner to use. The default value is:
12797 .code
12798 sophie:/var/run/sophie
12799 .endd
12800 If the value of &%av_scanner%& starts with dollar character, it is expanded
12801 before use. See section &<<SECTscanvirus>>& for further details.
12802
12803
12804
12805 .option bi_command main string unset
12806 .oindex "&%-bi%&"
12807 This option supplies the name of a command that is run when Exim is called with
12808 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
12809 just the command name, it is not a complete command line. If an argument is
12810 required, it must come from the &%-oA%& command line option.
12811
12812
12813 .option bounce_message_file main string unset
12814 .cindex "bounce message" "customizing"
12815 .cindex "customizing" "bounce message"
12816 This option defines a template file containing paragraphs of text to be used
12817 for constructing bounce messages.  Details of the file's contents are given in
12818 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
12819
12820
12821 .option bounce_message_text main string unset
12822 When this option is set, its contents are included in the default bounce
12823 message immediately after &"This message was created automatically by mail
12824 delivery software."& It is not used if &%bounce_message_file%& is set.
12825
12826 .option bounce_return_body main boolean true
12827 .cindex "bounce message" "including body"
12828 This option controls whether the body of an incoming message is included in a
12829 bounce message when &%bounce_return_message%& is true. The default setting
12830 causes the entire message, both header and body, to be returned (subject to the
12831 value of &%bounce_return_size_limit%&). If this option is false, only the
12832 message header is included. In the case of a non-SMTP message containing an
12833 error that is detected during reception, only those header lines preceding the
12834 point at which the error was detected are returned.
12835 .cindex "bounce message" "including original"
12836
12837 .option bounce_return_message main boolean true
12838 If this option is set false, none of the original message is included in
12839 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
12840 &%bounce_return_body%&.
12841
12842
12843 .option bounce_return_size_limit main integer 100K
12844 .cindex "size" "of bounce, limit"
12845 .cindex "bounce message" "size limit"
12846 .cindex "limit" "bounce message size"
12847 This option sets a limit in bytes on the size of messages that are returned to
12848 senders as part of bounce messages when &%bounce_return_message%& is true. The
12849 limit should be less than the value of the global &%message_size_limit%& and of
12850 any &%message_size_limit%& settings on transports, to allow for the bounce text
12851 that Exim generates. If this option is set to zero there is no limit.
12852
12853 When the body of any message that is to be included in a bounce message is
12854 greater than the limit, it is truncated, and a comment pointing this out is
12855 added at the top. The actual cutoff may be greater than the value given, owing
12856 to the use of buffering for transferring the message in chunks (typically 8K in
12857 size). The idea is to save bandwidth on those undeliverable 15-megabyte
12858 messages.
12859
12860 .option bounce_sender_authentication main string unset
12861 .cindex "bounce message" "sender authentication"
12862 .cindex "authentication" "bounce message"
12863 .cindex "AUTH" "on bounce message"
12864 This option provides an authenticated sender address that is sent with any
12865 bounce messages generated by Exim that are sent over an authenticated SMTP
12866 connection. A typical setting might be:
12867 .code
12868 bounce_sender_authentication = mailer-daemon@my.domain.example
12869 .endd
12870 which would cause bounce messages to be sent using the SMTP command:
12871 .code
12872 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
12873 .endd
12874 The value of &%bounce_sender_authentication%& must always be a complete email
12875 address.
12876
12877 .option callout_domain_negative_expire main time 3h
12878 .cindex "caching" "callout timeouts"
12879 .cindex "callout" "caching timeouts"
12880 This option specifies the expiry time for negative callout cache data for a
12881 domain. See section &<<SECTcallver>>& for details of callout verification, and
12882 section &<<SECTcallvercache>>& for details of the caching.
12883
12884
12885 .option callout_domain_positive_expire main time 7d
12886 This option specifies the expiry time for positive callout cache data for a
12887 domain. See section &<<SECTcallver>>& for details of callout verification, and
12888 section &<<SECTcallvercache>>& for details of the caching.
12889
12890
12891 .option callout_negative_expire main time 2h
12892 This option specifies the expiry time for negative callout cache data for an
12893 address. See section &<<SECTcallver>>& for details of callout verification, and
12894 section &<<SECTcallvercache>>& for details of the caching.
12895
12896
12897 .option callout_positive_expire main time 24h
12898 This option specifies the expiry time for positive callout cache data for an
12899 address. See section &<<SECTcallver>>& for details of callout verification, and
12900 section &<<SECTcallvercache>>& for details of the caching.
12901
12902
12903 .option callout_random_local_part main string&!! "see below"
12904 This option defines the &"random"& local part that can be used as part of
12905 callout verification. The default value is
12906 .code
12907 $primary_host_name-$tod_epoch-testing
12908 .endd
12909 See section &<<CALLaddparcall>>& for details of how this value is used.
12910
12911
12912 .option check_log_inodes main integer 0
12913 See &%check_spool_space%& below.
12914
12915
12916 .option check_log_space main integer 0
12917 See &%check_spool_space%& below.
12918
12919 .oindex "&%check_rfc2047_length%&"
12920 .cindex "RFC 2047" "disabling length check"
12921 .option check_rfc2047_length main boolean true
12922 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
12923 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
12924 word; strings to be encoded that exceed this length are supposed to use
12925 multiple encoded words. By default, Exim does not recognize encoded words that
12926 exceed the maximum length. However, it seems that some software, in violation
12927 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
12928 set false, Exim recognizes encoded words of any length.
12929
12930
12931 .option check_spool_inodes main integer 0
12932 See &%check_spool_space%& below.
12933
12934
12935 .option check_spool_space main integer 0
12936 .cindex "checking disk space"
12937 .cindex "disk space, checking"
12938 .cindex "spool directory" "checking space"
12939 The four &%check_...%& options allow for checking of disk resources before a
12940 message is accepted.
12941
12942 .vindex "&$log_inodes$&"
12943 .vindex "&$log_space$&"
12944 .vindex "&$spool_inodes$&"
12945 .vindex "&$spool_space$&"
12946 When any of these options are set, they apply to all incoming messages. If you
12947 want to apply different checks to different kinds of message, you can do so by
12948 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
12949 &$spool_space$& in an ACL with appropriate additional conditions.
12950
12951
12952 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
12953 either value is greater than zero, for example:
12954 .code
12955 check_spool_space = 10M
12956 check_spool_inodes = 100
12957 .endd
12958 The spool partition is the one that contains the directory defined by
12959 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
12960 transit.
12961
12962 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
12963 files are written if either is greater than zero. These should be set only if
12964 &%log_file_path%& and &%spool_directory%& refer to different partitions.
12965
12966 If there is less space or fewer inodes than requested, Exim refuses to accept
12967 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
12968 error response to the MAIL command. If ESMTP is in use and there was a
12969 SIZE parameter on the MAIL command, its value is added to the
12970 &%check_spool_space%& value, and the check is performed even if
12971 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
12972
12973 The values for &%check_spool_space%& and &%check_log_space%& are held as a
12974 number of kilobytes. If a non-multiple of 1024 is specified, it is rounded up.
12975
12976 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
12977 failure a message is written to stderr and Exim exits with a non-zero code, as
12978 it obviously cannot send an error message of any kind.
12979
12980 .option daemon_smtp_ports main string &`smtp`&
12981 .cindex "port" "for daemon"
12982 .cindex "TCP/IP" "setting listening ports"
12983 This option specifies one or more default SMTP ports on which the Exim daemon
12984 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
12985 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
12986
12987 .option daemon_startup_retries main integer 9
12988 .cindex "daemon startup, retrying"
12989 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
12990 the daemon at startup when it cannot immediately bind a listening socket
12991 (typically because the socket is already in use): &%daemon_startup_retries%&
12992 defines the number of retries after the first failure, and
12993 &%daemon_startup_sleep%& defines the length of time to wait between retries.
12994
12995 .option daemon_startup_sleep main time 30s
12996 See &%daemon_startup_retries%&.
12997
12998 .option delay_warning main "time list" 24h
12999 .cindex "warning of delay"
13000 .cindex "delay warning, specifying"
13001 When a message is delayed, Exim sends a warning message to the sender at
13002 intervals specified by this option. The data is a colon-separated list of times
13003 after which to send warning messages. If the value of the option is an empty
13004 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
13005 message has been on the queue for longer than the last time, the last interval
13006 between the times is used to compute subsequent warning times. For example,
13007 with
13008 .code
13009 delay_warning = 4h:8h:24h
13010 .endd
13011 the first message is sent after 4 hours, the second after 8 hours, and
13012 the third one after 24 hours. After that, messages are sent every 16 hours,
13013 because that is the interval between the last two times on the list. If you set
13014 just one time, it specifies the repeat interval. For example, with:
13015 .code
13016 delay_warning = 6h
13017 .endd
13018 messages are repeated every six hours. To stop warnings after a given time, set
13019 a very large time at the end of the list. For example:
13020 .code
13021 delay_warning = 2h:12h:99d
13022 .endd
13023
13024 .option delay_warning_condition main string&!! "see below"
13025 .vindex "&$domain$&"
13026 The string is expanded at the time a warning message might be sent. If all the
13027 deferred addresses have the same domain, it is set in &$domain$& during the
13028 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
13029 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
13030 &"false"& (the comparison being done caselessly) then the warning message is
13031 not sent. The default is:
13032 .code
13033 delay_warning_condition = ${if or {\
13034   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
13035   { match{$h_precedence:}{(?i)bulk|list|junk} }\
13036   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
13037   } {no}{yes}}
13038 .endd
13039 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
13040 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
13041 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
13042 &"auto-replied"& in an &'Auto-Submitted:'& header.
13043
13044 .option deliver_drop_privilege main boolean false
13045 .cindex "unprivileged delivery"
13046 .cindex "delivery" "unprivileged"
13047 If this option is set true, Exim drops its root privilege at the start of a
13048 delivery process, and runs as the Exim user throughout. This severely restricts
13049 the kinds of local delivery that are possible, but is viable in certain types
13050 of configuration. There is a discussion about the use of root privilege in
13051 chapter &<<CHAPsecurity>>&.
13052
13053 .option deliver_queue_load_max main fixed-point unset
13054 .cindex "load average"
13055 .cindex "queue runner" "abandoning"
13056 When this option is set, a queue run is abandoned if the system load average
13057 becomes greater than the value of the option. The option has no effect on
13058 ancient operating systems on which Exim cannot determine the load average.
13059 See also &%queue_only_load%& and &%smtp_load_reserve%&.
13060
13061
13062 .option delivery_date_remove main boolean true
13063 .cindex "&'Delivery-date:'& header line"
13064 Exim's transports have an option for adding a &'Delivery-date:'& header to a
13065 message when it is delivered, in exactly the same way as &'Return-path:'& is
13066 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
13067 should not be present in incoming messages, and this option causes them to be
13068 removed at the time the message is received, to avoid any problems that might
13069 occur when a delivered message is subsequently sent on to some other recipient.
13070
13071 .option disable_fsync main boolean false
13072 .cindex "&[fsync()]&, disabling"
13073 This option is available only if Exim was built with the compile-time option
13074 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
13075 a runtime configuration generates an &"unknown option"& error. You should not
13076 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
13077 really, really, really understand what you are doing. &'No pre-compiled
13078 distributions of Exim should ever make this option available.'&
13079
13080 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
13081 updated files' data to be written to disc before continuing. Unexpected events
13082 such as crashes and power outages may cause data to be lost or scrambled.
13083 Here be Dragons. &*Beware.*&
13084
13085
13086 .option disable_ipv6 main boolean false
13087 .cindex "IPv6" "disabling"
13088 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
13089 activities take place. AAAA records are never looked up, and any IPv6 addresses
13090 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
13091 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13092 to handle IPv6 literal addresses.
13093
13094
13095 .option dns_again_means_nonexist main "domain list&!!" unset
13096 .cindex "DNS" "&""try again""& response; overriding"
13097 DNS lookups give a &"try again"& response for the DNS errors
13098 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
13099 keep trying to deliver a message, or to give repeated temporary errors to
13100 incoming mail. Sometimes the effect is caused by a badly set up name server and
13101 may persist for a long time. If a domain which exhibits this problem matches
13102 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
13103 This option should be used with care. You can make it apply to reverse lookups
13104 by a setting such as this:
13105 .code
13106 dns_again_means_nonexist = *.in-addr.arpa
13107 .endd
13108 This option applies to all DNS lookups that Exim does. It also applies when the
13109 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
13110 since these are most likely to be caused by DNS lookup problems. The
13111 &(dnslookup)& router has some options of its own for controlling what happens
13112 when lookups for MX or SRV records give temporary errors. These more specific
13113 options are applied after this global option.
13114
13115 .option dns_check_names_pattern main string "see below"
13116 .cindex "DNS" "pre-check of name syntax"
13117 When this option is set to a non-empty string, it causes Exim to check domain
13118 names for characters that are not allowed in host names before handing them to
13119 the DNS resolver, because some resolvers give temporary errors for names that
13120 contain unusual characters. If a domain name contains any unwanted characters,
13121 a &"not found"& result is forced, and the resolver is not called. The check is
13122 done by matching the domain name against a regular expression, which is the
13123 value of this option. The default pattern is
13124 .code
13125 dns_check_names_pattern = \
13126   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
13127 .endd
13128 which permits only letters, digits, slashes, and hyphens in components, but
13129 they must start and end with a letter or digit. Slashes are not, in fact,
13130 permitted in host names, but they are found in certain NS records (which can be
13131 accessed in Exim by using a &%dnsdb%& lookup). If you set
13132 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
13133 empty string.
13134
13135 .option dns_csa_search_limit main integer 5
13136 This option controls the depth of parental searching for CSA SRV records in the
13137 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
13138
13139 .option dns_csa_use_reverse main boolean true
13140 This option controls whether or not an IP address, given as a CSA domain, is
13141 reversed and looked up in the reverse DNS, as described in more detail in
13142 section &<<SECTverifyCSA>>&.
13143
13144 .option dns_ipv4_lookup main "domain list&!!" unset
13145 .cindex "IPv6" "DNS lookup for AAAA records"
13146 .cindex "DNS" "IPv6 lookup for AAAA records"
13147 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
13148 looks for IPv6 address records (AAAA records) as well as IPv4 address records
13149 (A records) when trying to find IP addresses for hosts, unless the host's
13150 domain matches this list.
13151
13152 This is a fudge to help with name servers that give big delays or otherwise do
13153 not work for the AAAA record type. In due course, when the world's name
13154 servers have all been upgraded, there should be no need for this option.
13155
13156
13157 .option dns_retrans main time 0s
13158 .cindex "DNS" "resolver options"
13159 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
13160 retransmission and retry parameters for DNS lookups. Values of zero (the
13161 defaults) leave the system default settings unchanged. The first value is the
13162 time between retries, and the second is the number of retries. It isn't
13163 totally clear exactly how these settings affect the total time a DNS lookup may
13164 take. I haven't found any documentation about timeouts on DNS lookups; these
13165 parameter values are available in the external resolver interface structure,
13166 but nowhere does it seem to describe how they are used or what you might want
13167 to set in them.
13168
13169
13170 .option dns_retry main integer 0
13171 See &%dns_retrans%& above.
13172
13173
13174 .option drop_cr main boolean false
13175 This is an obsolete option that is now a no-op. It used to affect the way Exim
13176 handled CR and LF characters in incoming messages. What happens now is
13177 described in section &<<SECTlineendings>>&.
13178
13179 .option dsn_from main "string&!!" "see below"
13180 .cindex "&'From:'& header line" "in bounces"
13181 .cindex "bounce messages" "&'From:'& line, specifying"
13182 This option can be used to vary the contents of &'From:'& header lines in
13183 bounces and other automatically generated messages (&"Delivery Status
13184 Notifications"& &-- hence the name of the option). The default setting is:
13185 .code
13186 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
13187 .endd
13188 The value is expanded every time it is needed. If the expansion fails, a
13189 panic is logged, and the default value is used.
13190
13191 .option envelope_to_remove main boolean true
13192 .cindex "&'Envelope-to:'& header line"
13193 Exim's transports have an option for adding an &'Envelope-to:'& header to a
13194 message when it is delivered, in exactly the same way as &'Return-path:'& is
13195 handled. &'Envelope-to:'& records the original recipient address from the
13196 messages's envelope that caused the delivery to happen. Such headers should not
13197 be present in incoming messages, and this option causes them to be removed at
13198 the time the message is received, to avoid any problems that might occur when a
13199 delivered message is subsequently sent on to some other recipient.
13200
13201
13202 .option errors_copy main "string list&!!" unset
13203 .cindex "bounce message" "copy to other address"
13204 .cindex "copy of bounce message"
13205 Setting this option causes Exim to send bcc copies of bounce messages that it
13206 generates to other addresses. &*Note*&: This does not apply to bounce messages
13207 coming from elsewhere. The value of the option is a colon-separated list of
13208 items. Each item consists of a pattern, terminated by white space, followed by
13209 a comma-separated list of email addresses. If a pattern contains spaces, it
13210 must be enclosed in double quotes.
13211
13212 Each pattern is processed in the same way as a single item in an address list
13213 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
13214 the bounce message, the message is copied to the addresses on the list. The
13215 items are scanned in order, and once a matching one is found, no further items
13216 are examined. For example:
13217 .code
13218 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
13219               rqps@mydomain   hostmaster@mydomain.example,\
13220                               postmaster@mydomain.example
13221 .endd
13222 .vindex "&$domain$&"
13223 .vindex "&$local_part$&"
13224 The address list is expanded before use. The expansion variables &$local_part$&
13225 and &$domain$& are set from the original recipient of the error message, and if
13226 there was any wildcard matching in the pattern, the expansion
13227 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
13228 variables &$0$&, &$1$&, etc. are set in the normal way.
13229
13230
13231 .option errors_reply_to main string unset
13232 .cindex "bounce message" "&'Reply-to:'& in"
13233 By default, Exim's bounce and delivery warning messages contain the header line
13234 .display
13235 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
13236 .endd
13237 .oindex &%quota_warn_message%&
13238 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
13239 A warning message that is generated by the &%quota_warn_message%& option in an
13240 &(appendfile)& transport may contain its own &'From:'& header line that
13241 overrides the default.
13242
13243 Experience shows that people reply to bounce messages. If the
13244 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
13245 and warning messages. For example:
13246 .code
13247 errors_reply_to = postmaster@my.domain.example
13248 .endd
13249 The value of the option is not expanded. It must specify a valid RFC 2822
13250 address. However, if a warning message that is generated by the
13251 &%quota_warn_message%& option in an &(appendfile)& transport contain its
13252 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
13253 not used.
13254
13255
13256 .option exim_group main string "compile-time configured"
13257 .cindex "gid (group id)" "Exim's own"
13258 .cindex "Exim group"
13259 This option changes the gid under which Exim runs when it gives up root
13260 privilege. The default value is compiled into the binary. The value of this
13261 option is used only when &%exim_user%& is also set. Unless it consists entirely
13262 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
13263 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
13264 security issues.
13265
13266
13267 .option exim_path main string "see below"
13268 .cindex "Exim binary, path name"
13269 This option specifies the path name of the Exim binary, which is used when Exim
13270 needs to re-exec itself. The default is set up to point to the file &'exim'& in
13271 the directory configured at compile time by the BIN_DIRECTORY setting. It
13272 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
13273 other place.
13274 &*Warning*&: Do not use a macro to define the value of this option, because
13275 you will break those Exim utilities that scan the configuration file to find
13276 where the binary is. (They then use the &%-bP%& option to extract option
13277 settings such as the value of &%spool_directory%&.)
13278
13279
13280 .option exim_user main string "compile-time configured"
13281 .cindex "uid (user id)" "Exim's own"
13282 .cindex "Exim user"
13283 This option changes the uid under which Exim runs when it gives up root
13284 privilege. The default value is compiled into the binary. Ownership of the run
13285 time configuration file and the use of the &%-C%& and &%-D%& command line
13286 options is checked against the values in the binary, not what is set here.
13287
13288 Unless it consists entirely of digits, the string is looked up using
13289 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
13290 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
13291 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
13292
13293
13294 .option extra_local_interfaces main "string list" unset
13295 This option defines network interfaces that are to be considered local when
13296 routing, but which are not used for listening by the daemon. See section
13297 &<<SECTreclocipadd>>& for details.
13298
13299
13300 . Allow this long option name to split; give it unsplit as a fifth argument
13301 . for the automatic .oindex that is generated by .option.
13302
13303 .option "extract_addresses_remove_ &~&~arguments" main boolean true &&&
13304          extract_addresses_remove_arguments
13305 .oindex "&%-t%&"
13306 .cindex "command line" "addresses with &%-t%&"
13307 .cindex "Sendmail compatibility" "&%-t%& option"
13308 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
13309 are present on the command line when the &%-t%& option is used to build an
13310 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
13311 line addresses are removed from the recipients list. This is also how Smail
13312 behaves. However, other Sendmail documentation (the O'Reilly book) states that
13313 command line addresses are added to those obtained from the header lines. When
13314 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
13315 argument headers. If it is set false, Exim adds rather than removes argument
13316 addresses.
13317
13318
13319 .option finduser_retries main integer 0
13320 .cindex "NIS, retrying user lookups"
13321 On systems running NIS or other schemes in which user and group information is
13322 distributed from a remote system, there can be times when &[getpwnam()]& and
13323 related functions fail, even when given valid data, because things time out.
13324 Unfortunately these failures cannot be distinguished from genuine &"not found"&
13325 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
13326 many extra times to find a user or a group, waiting for one second between
13327 retries.
13328
13329 .cindex "&_/etc/passwd_&" "multiple reading of"
13330 You should not set this option greater than zero if your user information is in
13331 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
13332 search the file multiple times for non-existent users, and also cause delay.
13333
13334
13335
13336 .option freeze_tell main "string list, comma separated" unset
13337 .cindex "freezing messages" "sending a message when freezing"
13338 On encountering certain errors, or when configured to do so in a system filter,
13339 ACL, or special router, Exim freezes a message. This means that no further
13340 delivery attempts take place until an administrator thaws the message, or the
13341 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
13342 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
13343 warning message whenever it freezes something, unless the message it is
13344 freezing is a locally-generated bounce message. (Without this exception there
13345 is the possibility of looping.) The warning message is sent to the addresses
13346 supplied as the comma-separated value of this option. If several of the
13347 message's addresses cause freezing, only a single message is sent. If the
13348 freezing was automatic, the reason(s) for freezing can be found in the message
13349 log. If you configure freezing in a filter or ACL, you must arrange for any
13350 logging that you require.
13351
13352
13353 .option gecos_name main string&!! unset
13354 .cindex "HP-UX"
13355 .cindex "&""gecos""& field, parsing"
13356 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
13357 password file to hold other information in addition to users' real names. Exim
13358 looks up this field for use when it is creating &'Sender:'& or &'From:'&
13359 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
13360 of the field are used unchanged, except that, if an ampersand is encountered,
13361 it is replaced by the user's login name with the first character forced to
13362 upper case, since this is a convention that is observed on many systems.
13363
13364 When these options are set, &%gecos_pattern%& is treated as a regular
13365 expression that is to be applied to the field (again with && replaced by the
13366 login name), and if it matches, &%gecos_name%& is expanded and used as the
13367 user's name.
13368
13369 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
13370 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
13371 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
13372 name terminates at the first comma, the following can be used:
13373 .code
13374 gecos_pattern = ([^,]*)
13375 gecos_name = $1
13376 .endd
13377
13378 .option gecos_pattern main string unset
13379 See &%gecos_name%& above.
13380
13381
13382 .option gnutls_require_kx main string unset
13383 This option controls the key exchange mechanisms when GnuTLS is used in an Exim
13384 server. For details, see section &<<SECTreqciphgnu>>&.
13385
13386 .option gnutls_require_mac main string unset
13387 This option controls the MAC algorithms when GnuTLS is used in an Exim
13388 server. For details, see section &<<SECTreqciphgnu>>&.
13389
13390 .option gnutls_require_protocols main string unset
13391 This option controls the protocols when GnuTLS is used in an Exim
13392 server. For details, see section &<<SECTreqciphgnu>>&.
13393
13394 .option gnutls_compat_mode main boolean unset
13395 This option controls whether GnuTLS is used in compatibility mode in an Exim
13396 server. This reduces security slightly, but improves interworking with older
13397 implementations of TLS.
13398
13399 .option headers_charset main string "see below"
13400 This option sets a default character set for translating from encoded MIME
13401 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
13402 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
13403 ultimate default is ISO-8859-1. For more details see the description of header
13404 insertions in section &<<SECTexpansionitems>>&.
13405
13406
13407
13408 .option header_maxsize main integer "see below"
13409 .cindex "header section" "maximum size of"
13410 .cindex "limit" "size of message header section"
13411 This option controls the overall maximum size of a message's header
13412 section. The default is the value of HEADER_MAXSIZE in
13413 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
13414 sections are rejected.
13415
13416
13417 .option header_line_maxsize main integer 0
13418 .cindex "header lines" "maximum size of"
13419 .cindex "limit" "size of one header line"
13420 This option limits the length of any individual header line in a message, after
13421 all the continuations have been joined together. Messages with individual
13422 header lines that are longer than the limit are rejected. The default value of
13423 zero means &"no limit"&.
13424
13425
13426
13427
13428 .option helo_accept_junk_hosts main "host list&!!" unset
13429 .cindex "HELO" "accepting junk data"
13430 .cindex "EHLO" "accepting junk data"
13431 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
13432 mail, and gives an error response for invalid data. Unfortunately, there are
13433 some SMTP clients that send syntactic junk. They can be accommodated by setting
13434 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
13435 if you want to do semantic checking.
13436 See also &%helo_allow_chars%& for a way of extending the permitted character
13437 set.
13438
13439
13440 .option helo_allow_chars main string unset
13441 .cindex "HELO" "underscores in"
13442 .cindex "EHLO" "underscores in"
13443 .cindex "underscore in EHLO/HELO"
13444 This option can be set to a string of rogue characters that are permitted in
13445 all EHLO and HELO names in addition to the standard letters, digits,
13446 hyphens, and dots. If you really must allow underscores, you can set
13447 .code
13448 helo_allow_chars = _
13449 .endd
13450 Note that the value is one string, not a list.
13451
13452
13453 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
13454 .cindex "HELO" "forcing reverse lookup"
13455 .cindex "EHLO" "forcing reverse lookup"
13456 If the domain given by a client in a HELO or EHLO command matches this
13457 list, a reverse lookup is done in order to establish the host's true name. The
13458 default forces a lookup if the client host gives the server's name or any of
13459 its IP addresses (in brackets), something that broken clients have been seen to
13460 do.
13461
13462
13463 .option helo_try_verify_hosts main "host list&!!" unset
13464 .cindex "HELO verifying" "optional"
13465 .cindex "EHLO" "verifying, optional"
13466 By default, Exim just checks the syntax of HELO and EHLO commands (see
13467 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
13468 to do more extensive checking of the data supplied by these commands. The ACL
13469 condition &`verify = helo`& is provided to make this possible.
13470 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
13471 to force the check to occur. From release 4.53 onwards, this is no longer
13472 necessary. If the check has not been done before &`verify = helo`& is
13473 encountered, it is done at that time. Consequently, this option is obsolete.
13474 Its specification is retained here for backwards compatibility.
13475
13476 When an EHLO or HELO command is received, if the calling host matches
13477 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
13478 EHLO command either:
13479
13480 .ilist
13481 is an IP literal matching the calling address of the host, or
13482 .next
13483 .cindex "DNS" "reverse lookup"
13484 .cindex "reverse DNS lookup"
13485 matches the host name that Exim obtains by doing a reverse lookup of the
13486 calling host address, or
13487 .next
13488 when looked up using &[gethostbyname()]& (or &[getipnodebyname()]& when
13489 available) yields the calling host address.
13490 .endlist
13491
13492 However, the EHLO or HELO command is not rejected if any of the checks
13493 fail. Processing continues, but the result of the check is remembered, and can
13494 be detected later in an ACL by the &`verify = helo`& condition.
13495
13496 .option helo_verify_hosts main "host list&!!" unset
13497 .cindex "HELO verifying" "mandatory"
13498 .cindex "EHLO" "verifying, mandatory"
13499 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
13500 backwards compatibility. For hosts that match this option, Exim checks the host
13501 name given in the HELO or EHLO in the same way as for
13502 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
13503 rejected with a 550 error, and entries are written to the main and reject logs.
13504 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
13505 error.
13506
13507 .option hold_domains main "domain list&!!" unset
13508 .cindex "domain" "delaying delivery"
13509 .cindex "delivery" "delaying certain domains"
13510 This option allows mail for particular domains to be held on the queue
13511 manually. The option is overridden if a message delivery is forced with the
13512 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
13513 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
13514 item in &%hold_domains%&, no routing or delivery for that address is done, and
13515 it is deferred every time the message is looked at.
13516
13517 This option is intended as a temporary operational measure for delaying the
13518 delivery of mail while some problem is being sorted out, or some new
13519 configuration tested. If you just want to delay the processing of some
13520 domains until a queue run occurs, you should use &%queue_domains%& or
13521 &%queue_smtp_domains%&, not &%hold_domains%&.
13522
13523 A setting of &%hold_domains%& does not override Exim's code for removing
13524 messages from the queue if they have been there longer than the longest retry
13525 time in any retry rule. If you want to hold messages for longer than the normal
13526 retry times, insert a dummy retry rule with a long retry time.
13527
13528
13529 .option host_lookup main "host list&!!" unset
13530 .cindex "host name" "lookup, forcing"
13531 Exim does not look up the name of a calling host from its IP address unless it
13532 is required to compare against some host list, or the host matches
13533 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
13534 option (which normally contains IP addresses rather than host names). The
13535 default configuration file contains
13536 .code
13537 host_lookup = *
13538 .endd
13539 which causes a lookup to happen for all hosts. If the expense of these lookups
13540 is felt to be too great, the setting can be changed or removed.
13541
13542 After a successful reverse lookup, Exim does a forward lookup on the name it
13543 has obtained, to verify that it yields the IP address that it started with. If
13544 this check fails, Exim behaves as if the name lookup failed.
13545
13546 .vindex "&$host_lookup_failed$&"
13547 .vindex "&$sender_host_name$&"
13548 After any kind of failure, the host name (in &$sender_host_name$&) remains
13549 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
13550 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
13551 &`verify = reverse_host_lookup`& in ACLs.
13552
13553
13554 .option host_lookup_order main "string list" &`bydns:byaddr`&
13555 This option specifies the order of different lookup methods when Exim is trying
13556 to find a host name from an IP address. The default is to do a DNS lookup
13557 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
13558 if that fails. You can change the order of these lookups, or omit one entirely,
13559 if you want.
13560
13561 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
13562 multiple PTR records in the DNS and the IP address is not listed in
13563 &_/etc/hosts_&. Different operating systems give different results in this
13564 case. That is why the default tries a DNS lookup first.
13565
13566
13567
13568 .option host_reject_connection main "host list&!!" unset
13569 .cindex "host" "rejecting connections from"
13570 If this option is set, incoming SMTP calls from the hosts listed are rejected
13571 as soon as the connection is made.
13572 This option is obsolete, and retained only for backward compatibility, because
13573 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
13574 connections immediately.
13575
13576 The ability to give an immediate rejection (either by this option or using an
13577 ACL) is provided for use in unusual cases. Many hosts will just try again,
13578 sometimes without much delay. Normally, it is better to use an ACL to reject
13579 incoming messages at a later stage, such as after RCPT commands. See
13580 chapter &<<CHAPACL>>&.
13581
13582
13583 .option hosts_connection_nolog main "host list&!!" unset
13584 .cindex "host" "not logging connections from"
13585 This option defines a list of hosts for which connection logging does not
13586 happen, even though the &%smtp_connection%& log selector is set. For example,
13587 you might want not to log SMTP connections from local processes, or from
13588 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
13589 the daemon; you should therefore strive to restrict its value to a short inline
13590 list of IP addresses and networks. To disable logging SMTP connections from
13591 local processes, you must create a host list with an empty item. For example:
13592 .code
13593 hosts_connection_nolog = :
13594 .endd
13595 If the &%smtp_connection%& log selector is not set, this option has no effect.
13596
13597
13598
13599 .option hosts_treat_as_local main "domain list&!!" unset
13600 .cindex "local host" "domains treated as"
13601 .cindex "host" "treated as local"
13602 If this option is set, any host names that match the domain list are treated as
13603 if they were the local host when Exim is scanning host lists obtained from MX
13604 records
13605 or other sources. Note that the value of this option is a domain list, not a
13606 host list, because it is always used to check host names, not IP addresses.
13607
13608 This option also applies when Exim is matching the special items
13609 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
13610 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
13611 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
13612 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
13613 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
13614 interfaces and recognizing the local host.
13615
13616
13617 .option ibase_servers main "string list" unset
13618 .cindex "InterBase" "server list"
13619 This option provides a list of InterBase servers and associated connection data,
13620 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
13621 The option is available only if Exim has been built with InterBase support.
13622
13623
13624
13625 .option ignore_bounce_errors_after main time 10w
13626 .cindex "bounce message" "discarding"
13627 .cindex "discarding bounce message"
13628 This option affects the processing of bounce messages that cannot be delivered,
13629 that is, those that suffer a permanent delivery failure. (Bounce messages that
13630 suffer temporary delivery failures are of course retried in the usual way.)
13631
13632 After a permanent delivery failure, bounce messages are frozen,
13633 because there is no sender to whom they can be returned. When a frozen bounce
13634 message has been on the queue for more than the given time, it is unfrozen at
13635 the next queue run, and a further delivery is attempted. If delivery fails
13636 again, the bounce message is discarded. This makes it possible to keep failed
13637 bounce messages around for a shorter time than the normal maximum retry time
13638 for frozen messages. For example,
13639 .code
13640 ignore_bounce_errors_after = 12h
13641 .endd
13642 retries failed bounce message deliveries after 12 hours, discarding any further
13643 failures. If the value of this option is set to a zero time period, bounce
13644 failures are discarded immediately. Setting a very long time (as in the default
13645 value) has the effect of disabling this option. For ways of automatically
13646 dealing with other kinds of frozen message, see &%auto_thaw%& and
13647 &%timeout_frozen_after%&.
13648
13649
13650 .option ignore_fromline_hosts main "host list&!!" unset
13651 .cindex "&""From""& line"
13652 .cindex "UUCP" "&""From""& line"
13653 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
13654 the headers of a message. By default this is treated as the start of the
13655 message's body, which means that any following headers are not recognized as
13656 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
13657 match those hosts that insist on sending it. If the sender is actually a local
13658 process rather than a remote host, and is using &%-bs%& to inject the messages,
13659 &%ignore_fromline_local%& must be set to achieve this effect.
13660
13661
13662 .option ignore_fromline_local main boolean false
13663 See &%ignore_fromline_hosts%& above.
13664
13665
13666 .option keep_malformed main time 4d
13667 This option specifies the length of time to keep messages whose spool files
13668 have been corrupted in some way. This should, of course, never happen. At the
13669 next attempt to deliver such a message, it gets removed. The incident is
13670 logged.
13671
13672
13673 .option ldap_default_servers main "string list" unset
13674 .cindex "LDAP" "default servers"
13675 This option provides a list of LDAP servers which are tried in turn when an
13676 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
13677 details of LDAP queries. This option is available only when Exim has been built
13678 with LDAP support.
13679
13680
13681 .option ldap_version main integer unset
13682 .cindex "LDAP" "protocol version, forcing"
13683 This option can be used to force Exim to set a specific protocol version for
13684 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
13685 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
13686 the LDAP headers; otherwise it is 2. This option is available only when Exim
13687 has been built with LDAP support.
13688
13689
13690
13691 .option local_from_check main boolean true
13692 .cindex "&'Sender:'& header line" "disabling addition of"
13693 .cindex "&'From:'& header line" "disabling checking of"
13694 When a message is submitted locally (that is, not over a TCP/IP connection) by
13695 an untrusted user, Exim removes any existing &'Sender:'& header line, and
13696 checks that the &'From:'& header line matches the login of the calling user and
13697 the domain specified by &%qualify_domain%&.
13698
13699 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
13700 locally submitted message is automatically qualified by Exim, unless the
13701 &%-bnq%& command line option is used.
13702
13703 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
13704 on the local part. If the &'From:'& header line does not match, Exim adds a
13705 &'Sender:'& header with an address constructed from the calling user's login
13706 and the default qualify domain.
13707
13708 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
13709 and no &'Sender:'& header is ever added. If, in addition, you want to retain
13710 &'Sender:'& header lines supplied by untrusted users, you must also set
13711 &%local_sender_retain%& to be true.
13712
13713 .cindex "envelope sender"
13714 These options affect only the header lines in the message. The envelope sender
13715 is still forced to be the login id at the qualify domain unless
13716 &%untrusted_set_sender%& permits the user to supply an envelope sender.
13717
13718 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
13719 request similar header line checking. See section &<<SECTthesenhea>>&, which
13720 has more details about &'Sender:'& processing.
13721
13722
13723
13724
13725 .option local_from_prefix main string unset
13726 When Exim checks the &'From:'& header line of locally submitted messages for
13727 matching the login id (see &%local_from_check%& above), it can be configured to
13728 ignore certain prefixes and suffixes in the local part of the address. This is
13729 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
13730 appropriate lists, in the same form as the &%local_part_prefix%& and
13731 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
13732 example, if
13733 .code
13734 local_from_prefix = *-
13735 .endd
13736 is set, a &'From:'& line containing
13737 .code
13738 From: anything-user@your.domain.example
13739 .endd
13740 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
13741 matches the actual sender address that is constructed from the login name and
13742 qualify domain.
13743
13744
13745 .option local_from_suffix main string unset
13746 See &%local_from_prefix%& above.
13747
13748
13749 .option local_interfaces main "string list" "see below"
13750 This option controls which network interfaces are used by the daemon for
13751 listening; they are also used to identify the local host when routing. Chapter
13752 &<<CHAPinterfaces>>& contains a full description of this option and the related
13753 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
13754 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
13755 &%local_interfaces%& is
13756 .code
13757 local_interfaces = 0.0.0.0
13758 .endd
13759 when Exim is built without IPv6 support; otherwise it is
13760 .code
13761 local_interfaces = <; ::0 ; 0.0.0.0
13762 .endd
13763
13764 .option local_scan_timeout main time 5m
13765 .cindex "timeout" "for &[local_scan()]& function"
13766 .cindex "&[local_scan()]& function" "timeout"
13767 This timeout applies to the &[local_scan()]& function (see chapter
13768 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
13769 the incoming message is rejected with a temporary error if it is an SMTP
13770 message. For a non-SMTP message, the message is dropped and Exim ends with a
13771 non-zero code. The incident is logged on the main and reject logs.
13772
13773
13774
13775 .option local_sender_retain main boolean false
13776 .cindex "&'Sender:'& header line" "retaining from local submission"
13777 When a message is submitted locally (that is, not over a TCP/IP connection) by
13778 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
13779 do not want this to happen, you must set &%local_sender_retain%&, and you must
13780 also set &%local_from_check%& to be false (Exim will complain if you do not).
13781 See also the ACL modifier &`control = suppress_local_fixups`&. Section
13782 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
13783
13784
13785
13786
13787 .option localhost_number main string&!! unset
13788 .cindex "host" "locally unique number for"
13789 .cindex "message ids" "with multiple hosts"
13790 .vindex "&$localhost_number$&"
13791 Exim's message ids are normally unique only within the local host. If
13792 uniqueness among a set of hosts is required, each host must set a different
13793 value for the &%localhost_number%& option. The string is expanded immediately
13794 after reading the configuration file (so that a number can be computed from the
13795 host name, for example) and the result of the expansion must be a number in the
13796 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
13797 systems). This is available in subsequent string expansions via the variable
13798 &$localhost_number$&. When &%localhost_number is set%&, the final two
13799 characters of the message id, instead of just being a fractional part of the
13800 time, are computed from the time and the local host number as described in
13801 section &<<SECTmessiden>>&.
13802
13803
13804
13805 .option log_file_path main "string list&!!" "set at compile time"
13806 .cindex "log" "file path for"
13807 This option sets the path which is used to determine the names of Exim's log
13808 files, or indicates that logging is to be to syslog, or both. It is expanded
13809 when Exim is entered, so it can, for example, contain a reference to the host
13810 name. If no specific path is set for the log files at compile or run time, they
13811 are written in a sub-directory called &_log_& in Exim's spool directory.
13812 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
13813 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
13814 used. If this string is fixed at your installation (contains no expansion
13815 variables) it is recommended that you do not set this option in the
13816 configuration file, but instead supply the path using LOG_FILE_PATH in
13817 &_Local/Makefile_& so that it is available to Exim for logging errors detected
13818 early on &-- in particular, failure to read the configuration file.
13819
13820
13821 .option log_selector main string unset
13822 .cindex "log" "selectors"
13823 This option can be used to reduce or increase the number of things that Exim
13824 writes to its log files. Its argument is made up of names preceded by plus or
13825 minus characters. For example:
13826 .code
13827 log_selector = +arguments -retry_defer
13828 .endd
13829 A list of possible names and what they control is given in the chapter on
13830 logging, in section &<<SECTlogselector>>&.
13831
13832
13833 .option log_timezone main boolean false
13834 .cindex "log" "timezone for entries"
13835 .vindex "&$tod_log$&"
13836 .vindex "&$tod_zone$&"
13837 By default, the timestamps on log lines are in local time without the
13838 timezone. This means that if your timezone changes twice a year, the timestamps
13839 in log lines are ambiguous for an hour when the clocks go back. One way of
13840 avoiding this problem is to set the timezone to UTC. An alternative is to set
13841 &%log_timezone%& true. This turns on the addition of the timezone offset to
13842 timestamps in log lines. Turning on this option can add quite a lot to the size
13843 of log files because each line is extended by 6 characters. Note that the
13844 &$tod_log$& variable contains the log timestamp without the zone, but there is
13845 another variable called &$tod_zone$& that contains just the timezone offset.
13846
13847
13848 .option lookup_open_max main integer 25
13849 .cindex "too many open files"
13850 .cindex "open files, too many"
13851 .cindex "file" "too many open"
13852 .cindex "lookup" "maximum open files"
13853 .cindex "limit" "open files for lookups"
13854 This option limits the number of simultaneously open files for single-key
13855 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
13856 Exim normally keeps these files open during routing, because often the same
13857 file is required several times. If the limit is reached, Exim closes the least
13858 recently used file. Note that if you are using the &'ndbm'& library, it
13859 actually opens two files for each logical DBM database, though it still counts
13860 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
13861 open files"& errors with NDBM, you need to reduce the value of
13862 &%lookup_open_max%&.
13863
13864
13865 .option max_username_length main integer 0
13866 .cindex "length of login name"
13867 .cindex "user name" "maximum length"
13868 .cindex "limit" "user name length"
13869 Some operating systems are broken in that they truncate long arguments to
13870 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
13871 this option is set greater than zero, any attempt to call &[getpwnam()]& with
13872 an argument that is longer behaves as if &[getpwnam()]& failed.
13873
13874
13875 .option message_body_newlines main bool false
13876 .cindex "message body" "newlines in variables"
13877 .cindex "newline" "in message body variables"
13878 .vindex "&$message_body$&"
13879 .vindex "&$message_body_end$&"
13880 By default, newlines in the message body are replaced by spaces when setting
13881 the &$message_body$& and &$message_body_end$& expansion variables. If this
13882 option is set true, this no longer happens.
13883
13884
13885 .option message_body_visible main integer 500
13886 .cindex "body of message" "visible size"
13887 .cindex "message body" "visible size"
13888 .vindex "&$message_body$&"
13889 .vindex "&$message_body_end$&"
13890 This option specifies how much of a message's body is to be included in the
13891 &$message_body$& and &$message_body_end$& expansion variables.
13892
13893
13894 .option message_id_header_domain main string&!! unset
13895 .cindex "&'Message-ID:'& header line"
13896 If this option is set, the string is expanded and used as the right hand side
13897 (domain) of the &'Message-ID:'& header that Exim creates if a
13898 locally-originated incoming message does not have one. &"Locally-originated"&
13899 means &"not received over TCP/IP."&
13900 Otherwise, the primary host name is used.
13901 Only letters, digits, dot and hyphen are accepted; any other characters are
13902 replaced by hyphens. If the expansion is forced to fail, or if the result is an
13903 empty string, the option is ignored.
13904
13905
13906 .option message_id_header_text main string&!! unset
13907 If this variable is set, the string is expanded and used to augment the text of
13908 the &'Message-id:'& header that Exim creates if a locally-originated incoming
13909 message does not have one. The text of this header is required by RFC 2822 to
13910 take the form of an address. By default, Exim uses its internal message id as
13911 the local part, and the primary host name as the domain. If this option is set,
13912 it is expanded, and provided the expansion is not forced to fail, and does not
13913 yield an empty string, the result is inserted into the header immediately
13914 before the @, separated from the internal message id by a dot. Any characters
13915 that are illegal in an address are automatically converted into hyphens. This
13916 means that variables such as &$tod_log$& can be used, because the spaces and
13917 colons will become hyphens.
13918
13919
13920 .option message_logs main boolean true
13921 .cindex "message logs" "disabling"
13922 .cindex "log" "message log; disabling"
13923 If this option is turned off, per-message log files are not created in the
13924 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
13925 Exim, by reducing the number of files involved in handling a message from a
13926 minimum of four (header spool file, body spool file, delivery journal, and
13927 per-message log) to three. The other major I/O activity is Exim's main log,
13928 which is not affected by this option.
13929
13930
13931 .option message_size_limit main string&!! 50M
13932 .cindex "message" "size limit"
13933 .cindex "limit" "message size"
13934 .cindex "size" "of message, limit"
13935 This option limits the maximum size of message that Exim will process. The
13936 value is expanded for each incoming connection so, for example, it can be made
13937 to depend on the IP address of the remote host for messages arriving via
13938 TCP/IP. After expansion, the value must be a sequence of decimal digits,
13939 optionally followed by K or M.
13940
13941 &*Note*&: This limit cannot be made to depend on a message's sender or any
13942 other properties of an individual message, because it has to be advertised in
13943 the server's response to EHLO. String expansion failure causes a temporary
13944 error. A value of zero means no limit, but its use is not recommended. See also
13945 &%bounce_return_size_limit%&.
13946
13947 Incoming SMTP messages are failed with a 552 error if the limit is
13948 exceeded; locally-generated messages either get a stderr message or a delivery
13949 failure message to the sender, depending on the &%-oe%& setting. Rejection of
13950 an oversized message is logged in both the main and the reject logs. See also
13951 the generic transport option &%message_size_limit%&, which limits the size of
13952 message that an individual transport can process.
13953
13954
13955 .option move_frozen_messages main boolean false
13956 .cindex "frozen messages" "moving"
13957 This option, which is available only if Exim has been built with the setting
13958 .code
13959 SUPPORT_MOVE_FROZEN_MESSAGES=yes
13960 .endd
13961 in &_Local/Makefile_&, causes frozen messages and their message logs to be
13962 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
13963 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
13964 standard utilities for handling such moved messages, and they do not show up in
13965 lists generated by &%-bp%& or by the Exim monitor.
13966
13967
13968 .option mua_wrapper main boolean false
13969 Setting this option true causes Exim to run in a very restrictive mode in which
13970 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
13971 contains a full description of this facility.
13972
13973
13974
13975 .option mysql_servers main "string list" unset
13976 .cindex "MySQL" "server list"
13977 This option provides a list of MySQL servers and associated connection data, to
13978 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
13979 option is available only if Exim has been built with MySQL support.
13980
13981
13982 .option never_users main "string list&!!" unset
13983 This option is expanded just once, at the start of Exim's processing. Local
13984 message deliveries are normally run in processes that are setuid to the
13985 recipient, and remote deliveries are normally run under Exim's own uid and gid.
13986 It is usually desirable to prevent any deliveries from running as root, as a
13987 safety precaution.
13988
13989 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
13990 list of users that must not be used for local deliveries. This list is fixed in
13991 the binary and cannot be overridden by the configuration file. By default, it
13992 contains just the single user name &"root"&. The &%never_users%& runtime option
13993 can be used to add more users to the fixed list.
13994
13995 If a message is to be delivered as one of the users on the fixed list or the
13996 &%never_users%& list, an error occurs, and delivery is deferred. A common
13997 example is
13998 .code
13999 never_users = root:daemon:bin
14000 .endd
14001 Including root is redundant if it is also on the fixed list, but it does no
14002 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
14003 transport driver.
14004
14005
14006 .option oracle_servers main "string list" unset
14007 .cindex "Oracle" "server list"
14008 This option provides a list of Oracle servers and associated connection data,
14009 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
14010 The option is available only if Exim has been built with Oracle support.
14011
14012
14013 .option percent_hack_domains main "domain list&!!" unset
14014 .cindex "&""percent hack""&"
14015 .cindex "source routing" "in email address"
14016 .cindex "address" "source-routed"
14017 The &"percent hack"& is the convention whereby a local part containing a
14018 percent sign is re-interpreted as a new email address, with the percent
14019 replaced by @. This is sometimes called &"source routing"&, though that term is
14020 also applied to RFC 2822 addresses that begin with an @ character. If this
14021 option is set, Exim implements the percent facility for those domains listed,
14022 but no others. This happens before an incoming SMTP address is tested against
14023 an ACL.
14024
14025 &*Warning*&: The &"percent hack"& has often been abused by people who are
14026 trying to get round relaying restrictions. For this reason, it is best avoided
14027 if at all possible. Unfortunately, a number of less security-conscious MTAs
14028 implement it unconditionally. If you are running Exim on a gateway host, and
14029 routing mail through to internal MTAs without processing the local parts, it is
14030 a good idea to reject recipient addresses with percent characters in their
14031 local parts. Exim's default configuration does this.
14032
14033
14034 .option perl_at_start main boolean false
14035 This option is available only when Exim is built with an embedded Perl
14036 interpreter. See chapter &<<CHAPperl>>& for details of its use.
14037
14038
14039 .option perl_startup main string unset
14040 This option is available only when Exim is built with an embedded Perl
14041 interpreter. See chapter &<<CHAPperl>>& for details of its use.
14042
14043
14044 .option pgsql_servers main "string list" unset
14045 .cindex "PostgreSQL lookup type" "server list"
14046 This option provides a list of PostgreSQL servers and associated connection
14047 data, to be used in conjunction with &(pgsql)& lookups (see section
14048 &<<SECID72>>&). The option is available only if Exim has been built with
14049 PostgreSQL support.
14050
14051
14052 .option pid_file_path main string&!! "set at compile time"
14053 .cindex "daemon" "pid file path"
14054 .cindex "pid file, path for"
14055 This option sets the name of the file to which the Exim daemon writes its
14056 process id. The string is expanded, so it can contain, for example, references
14057 to the host name:
14058 .code
14059 pid_file_path = /var/log/$primary_hostname/exim.pid
14060 .endd
14061 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
14062 spool directory.
14063 The value set by the option can be overridden by the &%-oP%& command line
14064 option. A pid file is not written if a &"non-standard"& daemon is run by means
14065 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
14066
14067
14068 .option pipelining_advertise_hosts main "host list&!!" *
14069 .cindex "PIPELINING" "suppressing advertising"
14070 This option can be used to suppress the advertisement of the SMTP
14071 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
14072 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
14073 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
14074 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
14075 that clients will use it; &"out of order"& commands that are &"expected"& do
14076 not count as protocol errors (see &%smtp_max_synprot_errors%&).
14077
14078
14079 .option preserve_message_logs main boolean false
14080 .cindex "message logs" "preserving"
14081 If this option is set, message log files are not deleted when messages are
14082 completed. Instead, they are moved to a sub-directory of the spool directory
14083 called &_msglog.OLD_&, where they remain available for statistical or debugging
14084 purposes. This is a dangerous option to set on systems with any appreciable
14085 volume of mail. Use with care!
14086
14087
14088 .option primary_hostname main string "see below"
14089 .cindex "name" "of local host"
14090 .cindex "host" "name of local"
14091 .cindex "local host" "name of"
14092 .vindex "&$primary_hostname$&"
14093 This specifies the name of the current host. It is used in the default EHLO or
14094 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
14095 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
14096 The value is also used by default in some SMTP response messages from an Exim
14097 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
14098
14099 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
14100 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
14101 contains only one component, Exim passes it to &[gethostbyname()]& (or
14102 &[getipnodebyname()]& when available) in order to obtain the fully qualified
14103 version. The variable &$primary_hostname$& contains the host name, whether set
14104 explicitly by this option, or defaulted.
14105
14106
14107 .option print_topbitchars main boolean false
14108 .cindex "printing characters"
14109 .cindex "8-bit characters"
14110 By default, Exim considers only those characters whose codes lie in the range
14111 32&--126 to be printing characters. In a number of circumstances (for example,
14112 when writing log entries) non-printing characters are converted into escape
14113 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
14114 is set, code values of 128 and above are also considered to be printing
14115 characters.
14116
14117 This option also affects the header syntax checks performed by the
14118 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
14119 the user's full name when constructing From: and Sender: addresses (as
14120 described in section &<<SECTconstr>>&). Setting this option can cause
14121 Exim to generate eight bit message headers that do not conform to the
14122 standards.
14123
14124
14125 .option process_log_path main string unset
14126 .cindex "process log path"
14127 .cindex "log" "process log"
14128 .cindex "&'exiwhat'&"
14129 This option sets the name of the file to which an Exim process writes its
14130 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
14131 utility script. If this option is unset, the file called &_exim-process.info_&
14132 in Exim's spool directory is used. The ability to specify the name explicitly
14133 can be useful in environments where two different Exims are running, using
14134 different spool directories.
14135
14136
14137 .option prod_requires_admin main boolean true
14138 .oindex "&%-M%&"
14139 .oindex "&%-R%&"
14140 .oindex "&%-q%&"
14141 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
14142 admin user unless &%prod_requires_admin%& is set false. See also
14143 &%queue_list_requires_admin%&.
14144
14145
14146 .option qualify_domain main string "see below"
14147 .cindex "domain" "for qualifying addresses"
14148 .cindex "address" "qualification"
14149 This option specifies the domain name that is added to any envelope sender
14150 addresses that do not have a domain qualification. It also applies to
14151 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
14152 are accepted by default only for locally-generated messages. Qualification is
14153 also applied to addresses in header lines such as &'From:'& and &'To:'& for
14154 locally-generated messages, unless the &%-bnq%& command line option is used.
14155
14156 Messages from external sources must always contain fully qualified addresses,
14157 unless the sending host matches &%sender_unqualified_hosts%& or
14158 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
14159 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
14160 necessary. Internally, Exim always works with fully qualified envelope
14161 addresses. If &%qualify_domain%& is not set, it defaults to the
14162 &%primary_hostname%& value.
14163
14164
14165 .option qualify_recipient main string "see below"
14166 This option allows you to specify a different domain for qualifying recipient
14167 addresses to the one that is used for senders. See &%qualify_domain%& above.
14168
14169
14170
14171 .option queue_domains main "domain list&!!" unset
14172 .cindex "domain" "specifying non-immediate delivery"
14173 .cindex "queueing incoming messages"
14174 .cindex "message" "queueing certain domains"
14175 This option lists domains for which immediate delivery is not required.
14176 A delivery process is started whenever a message is received, but only those
14177 domains that do not match are processed. All other deliveries wait until the
14178 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
14179
14180
14181 .option queue_list_requires_admin main boolean true
14182 .oindex "&%-bp%&"
14183 The &%-bp%& command-line option, which lists the messages that are on the
14184 queue, requires the caller to be an admin user unless
14185 &%queue_list_requires_admin%& is set false. See also &%prod_requires_admin%&.
14186
14187
14188 .option queue_only main boolean false
14189 .cindex "queueing incoming messages"
14190 .cindex "message" "queueing unconditionally"
14191 If &%queue_only%& is set, a delivery process is not automatically started
14192 whenever a message is received. Instead, the message waits on the queue for the
14193 next queue run. Even if &%queue_only%& is false, incoming messages may not get
14194 delivered immediately when certain conditions (such as heavy load) occur.
14195
14196 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
14197 and &%-odi%& command line options override &%queue_only%& unless
14198 &%queue_only_override%& is set false. See also &%queue_only_file%&,
14199 &%queue_only_load%&, and &%smtp_accept_queue%&.
14200
14201
14202 .option queue_only_file main string unset
14203 .cindex "queueing incoming messages"
14204 .cindex "message" "queueing by file existence"
14205 This option can be set to a colon-separated list of absolute path names, each
14206 one optionally preceded by &"smtp"&. When Exim is receiving a message,
14207 it tests for the existence of each listed path using a call to &[stat()]&. For
14208 each path that exists, the corresponding queueing option is set.
14209 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
14210 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
14211 .code
14212 queue_only_file = smtp/some/file
14213 .endd
14214 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
14215 &_/some/file_& exists.
14216
14217
14218 .option queue_only_load main fixed-point unset
14219 .cindex "load average"
14220 .cindex "queueing incoming messages"
14221 .cindex "message" "queueing by load"
14222 If the system load average is higher than this value, incoming messages from
14223 all sources are queued, and no automatic deliveries are started. If this
14224 happens during local or remote SMTP input, all subsequent messages received on
14225 the same SMTP connection are queued by default, whatever happens to the load in
14226 the meantime, but this can be changed by setting &%queue_only_load_latch%&
14227 false.
14228
14229 Deliveries will subsequently be performed by queue runner processes. This
14230 option has no effect on ancient operating systems on which Exim cannot
14231 determine the load average. See also &%deliver_queue_load_max%& and
14232 &%smtp_load_reserve%&.
14233
14234
14235 .option queue_only_load_latch main boolean true
14236 .cindex "load average" "re-evaluating per message"
14237 When this option is true (the default), once one message has been queued
14238 because the load average is higher than the value set by &%queue_only_load%&,
14239 all subsequent messages received on the same SMTP connection are also queued.
14240 This is a deliberate choice; even though the load average may fall below the
14241 threshold, it doesn't seem right to deliver later messages on the same
14242 connection when not delivering earlier ones. However, there are special
14243 circumstances such as very long-lived connections from scanning appliances
14244 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
14245 should be set false. This causes the value of the load average to be
14246 re-evaluated for each message.
14247
14248
14249 .option queue_only_override main boolean true
14250 .cindex "queueing incoming messages"
14251 When this option is true, the &%-od%&&'x'& command line options override the
14252 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
14253 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
14254 to override; they are accepted, but ignored.
14255
14256
14257 .option queue_run_in_order main boolean false
14258 .cindex "queue runner" "processing messages in order"
14259 If this option is set, queue runs happen in order of message arrival instead of
14260 in an arbitrary order. For this to happen, a complete list of the entire queue
14261 must be set up before the deliveries start. When the queue is all held in a
14262 single directory (the default), a single list is created for both the ordered
14263 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
14264 single list is not created when &%queue_run_in_order%& is false. In this case,
14265 the sub-directories are processed one at a time (in a random order), and this
14266 avoids setting up one huge list for the whole queue. Thus, setting
14267 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
14268 when the queue is large, because of the extra work in setting up the single,
14269 large list. In most situations, &%queue_run_in_order%& should not be set.
14270
14271
14272
14273 .option queue_run_max main integer 5
14274 .cindex "queue runner" "maximum number of"
14275 This controls the maximum number of queue runner processes that an Exim daemon
14276 can run simultaneously. This does not mean that it starts them all at once,
14277 but rather that if the maximum number are still running when the time comes to
14278 start another one, it refrains from starting another one. This can happen with
14279 very large queues and/or very sluggish deliveries. This option does not,
14280 however, interlock with other processes, so additional queue runners can be
14281 started by other means, or by killing and restarting the daemon.
14282
14283 Setting this option to zero does not suppress queue runs; rather, it disables
14284 the limit, allowing any number of simultaneous queue runner processes to be
14285 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
14286 the daemon's command line.
14287
14288 .option queue_smtp_domains main "domain list&!!" unset
14289 .cindex "queueing incoming messages"
14290 .cindex "message" "queueing remote deliveries"
14291 When this option is set, a delivery process is started whenever a message is
14292 received, routing is performed, and local deliveries take place.
14293 However, if any SMTP deliveries are required for domains that match
14294 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
14295 message waits on the queue for the next queue run. Since routing of the message
14296 has taken place, Exim knows to which remote hosts it must be delivered, and so
14297 when the queue run happens, multiple messages for the same host are delivered
14298 over a single SMTP connection. The &%-odqs%& command line option causes all
14299 SMTP deliveries to be queued in this way, and is equivalent to setting
14300 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
14301 &%queue_domains%&.
14302
14303
14304 .option receive_timeout main time 0s
14305 .cindex "timeout" "for non-SMTP input"
14306 This option sets the timeout for accepting a non-SMTP message, that is, the
14307 maximum time that Exim waits when reading a message on the standard input. If
14308 the value is zero, it will wait for ever. This setting is overridden by the
14309 &%-or%& command line option. The timeout for incoming SMTP messages is
14310 controlled by &%smtp_receive_timeout%&.
14311
14312 .option received_header_text main string&!! "see below"
14313 .cindex "customizing" "&'Received:'& header"
14314 .cindex "&'Received:'& header line" "customizing"
14315 This string defines the contents of the &'Received:'& message header that is
14316 added to each message, except for the timestamp, which is automatically added
14317 on at the end (preceded by a semicolon). The string is expanded each time it is
14318 used. If the expansion yields an empty string, no &'Received:'& header line is
14319 added to the message. Otherwise, the string should start with the text
14320 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
14321 header lines. The default setting is:
14322
14323 .code
14324 received_header_text = Received: \
14325   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
14326   {${if def:sender_ident \
14327   {from ${quote_local_part:$sender_ident} }}\
14328   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
14329   by $primary_hostname \
14330   ${if def:received_protocol {with $received_protocol}} \
14331   ${if def:tls_cipher {($tls_cipher)\n\t}}\
14332   (Exim $version_number)\n\t\
14333   ${if def:sender_address \
14334   {(envelope-from <$sender_address>)\n\t}}\
14335   id $message_exim_id\
14336   ${if def:received_for {\n\tfor $received_for}}
14337 .endd
14338
14339 The reference to the TLS cipher is omitted when Exim is built without TLS
14340 support. The use of conditional expansions ensures that this works for both
14341 locally generated messages and messages received from remote hosts, giving
14342 header lines such as the following:
14343 .code
14344 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
14345 by marley.carol.example with esmtp (Exim 4.00)
14346 (envelope-from <bob@carol.example>)
14347 id 16IOWa-00019l-00
14348 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
14349 Received: by scrooge.carol.example with local (Exim 4.00)
14350 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
14351 .endd
14352 Until the body of the message has been received, the timestamp is the time when
14353 the message started to be received. Once the body has arrived, and all policy
14354 checks have taken place, the timestamp is updated to the time at which the
14355 message was accepted.
14356
14357
14358 .option received_headers_max main integer 30
14359 .cindex "loop" "prevention"
14360 .cindex "mail loop prevention"
14361 .cindex "&'Received:'& header line" "counting"
14362 When a message is to be delivered, the number of &'Received:'& headers is
14363 counted, and if it is greater than this parameter, a mail loop is assumed to
14364 have occurred, the delivery is abandoned, and an error message is generated.
14365 This applies to both local and remote deliveries.
14366
14367
14368 .option recipient_unqualified_hosts main "host list&!!" unset
14369 .cindex "unqualified addresses"
14370 .cindex "host" "unqualified addresses from"
14371 This option lists those hosts from which Exim is prepared to accept unqualified
14372 recipient addresses in message envelopes. The addresses are made fully
14373 qualified by the addition of the &%qualify_recipient%& value. This option also
14374 affects message header lines. Exim does not reject unqualified recipient
14375 addresses in headers, but it qualifies them only if the message came from a
14376 host that matches &%recipient_unqualified_hosts%&,
14377 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
14378 option was not set.
14379
14380
14381 .option recipients_max main integer 0
14382 .cindex "limit" "number of recipients"
14383 .cindex "recipient" "maximum number"
14384 If this option is set greater than zero, it specifies the maximum number of
14385 original recipients for any message. Additional recipients that are generated
14386 by aliasing or forwarding do not count. SMTP messages get a 452 response for
14387 all recipients over the limit; earlier recipients are delivered as normal.
14388 Non-SMTP messages with too many recipients are failed, and no deliveries are
14389 done.
14390
14391 .cindex "RCPT" "maximum number of incoming"
14392 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
14393 RCPT commands in a single message.
14394
14395
14396 .option recipients_max_reject main boolean false
14397 If this option is set true, Exim rejects SMTP messages containing too many
14398 recipients by giving 552 errors to the surplus RCPT commands, and a 554
14399 error to the eventual DATA command. Otherwise (the default) it gives a 452
14400 error to the surplus RCPT commands and accepts the message on behalf of the
14401 initial set of recipients. The remote server should then re-send the message
14402 for the remaining recipients at a later time.
14403
14404
14405 .option remote_max_parallel main integer 2
14406 .cindex "delivery" "parallelism for remote"
14407 This option controls parallel delivery of one message to a number of remote
14408 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
14409 does all the remote deliveries for a message one by one. Otherwise, if a single
14410 message has to be delivered to more than one remote host, or if several copies
14411 have to be sent to the same remote host, up to &%remote_max_parallel%&
14412 deliveries are done simultaneously. If more than &%remote_max_parallel%&
14413 deliveries are required, the maximum number of processes are started, and as
14414 each one finishes, another is begun. The order of starting processes is the
14415 same as if sequential delivery were being done, and can be controlled by the
14416 &%remote_sort_domains%& option. If parallel delivery takes place while running
14417 with debugging turned on, the debugging output from each delivery process is
14418 tagged with its process id.
14419
14420 This option controls only the maximum number of parallel deliveries for one
14421 message in one Exim delivery process. Because Exim has no central queue
14422 manager, there is no way of controlling the total number of simultaneous
14423 deliveries if the configuration allows a delivery attempt as soon as a message
14424 is received.
14425
14426 .cindex "number of deliveries"
14427 .cindex "delivery" "maximum number of"
14428 If you want to control the total number of deliveries on the system, you
14429 need to set the &%queue_only%& option. This ensures that all incoming messages
14430 are added to the queue without starting a delivery process. Then set up an Exim
14431 daemon to start queue runner processes at appropriate intervals (probably
14432 fairly often, for example, every minute), and limit the total number of queue
14433 runners by setting the &%queue_run_max%& parameter. Because each queue runner
14434 delivers only one message at a time, the maximum number of deliveries that can
14435 then take place at once is &%queue_run_max%& multiplied by
14436 &%remote_max_parallel%&.
14437
14438 If it is purely remote deliveries you want to control, use
14439 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
14440 doing the SMTP routing before queueing, so that several messages for the same
14441 host will eventually get delivered down the same connection.
14442
14443
14444 .option remote_sort_domains main "domain list&!!" unset
14445 .cindex "sorting remote deliveries"
14446 .cindex "delivery" "sorting remote"
14447 When there are a number of remote deliveries for a message, they are sorted by
14448 domain into the order given by this list. For example,
14449 .code
14450 remote_sort_domains = *.cam.ac.uk:*.uk
14451 .endd
14452 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
14453 then to those in the &%uk%& domain, then to any others.
14454
14455
14456 .option retry_data_expire main time 7d
14457 .cindex "hints database" "data expiry"
14458 This option sets a &"use before"& time on retry information in Exim's hints
14459 database. Any older retry data is ignored. This means that, for example, once a
14460 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
14461 past failures.
14462
14463
14464 .option retry_interval_max main time 24h
14465 .cindex "retry" "limit on interval"
14466 .cindex "limit" "on retry interval"
14467 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
14468 intervals between delivery attempts for messages that cannot be delivered
14469 straight away. This option sets an overall limit to the length of time between
14470 retries. It cannot be set greater than 24 hours; any attempt to do so forces
14471 the default value.
14472
14473
14474 .option return_path_remove main boolean true
14475 .cindex "&'Return-path:'& header line" "removing"
14476 RFC 2821, section 4.4, states that an SMTP server must insert a
14477 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
14478 The &'Return-path:'& header preserves the sender address as received in the
14479 MAIL command. This description implies that this header should not be present
14480 in an incoming message. If &%return_path_remove%& is true, any existing
14481 &'Return-path:'& headers are removed from messages at the time they are
14482 received. Exim's transports have options for adding &'Return-path:'& headers at
14483 the time of delivery. They are normally used only for final local deliveries.
14484
14485
14486 .option return_size_limit main integer 100K
14487 This option is an obsolete synonym for &%bounce_return_size_limit%&.
14488
14489
14490 .option rfc1413_hosts main "host list&!!" *
14491 .cindex "RFC 1413"
14492 .cindex "host" "for RFC 1413 calls"
14493 RFC 1413 identification calls are made to any client host which matches an item
14494 in the list.
14495
14496 .option rfc1413_query_timeout main time 5s
14497 .cindex "RFC 1413" "query timeout"
14498 .cindex "timeout" "for RFC 1413 call"
14499 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
14500 no RFC 1413 calls are ever made.
14501
14502
14503 .option sender_unqualified_hosts main "host list&!!" unset
14504 .cindex "unqualified addresses"
14505 .cindex "host" "unqualified addresses from"
14506 This option lists those hosts from which Exim is prepared to accept unqualified
14507 sender addresses. The addresses are made fully qualified by the addition of
14508 &%qualify_domain%&. This option also affects message header lines. Exim does
14509 not reject unqualified addresses in headers that contain sender addresses, but
14510 it qualifies them only if the message came from a host that matches
14511 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
14512 using TCP/IP), and the &%-bnq%& option was not set.
14513
14514
14515 .option smtp_accept_keepalive main boolean true
14516 .cindex "keepalive" "on incoming connection"
14517 This option controls the setting of the SO_KEEPALIVE option on incoming
14518 TCP/IP socket connections. When set, it causes the kernel to probe idle
14519 connections periodically, by sending packets with &"old"& sequence numbers. The
14520 other end of the connection should send an acknowledgment if the connection is
14521 still okay or a reset if the connection has been aborted. The reason for doing
14522 this is that it has the beneficial effect of freeing up certain types of
14523 connection that can get stuck when the remote host is disconnected without
14524 tidying up the TCP/IP call properly. The keepalive mechanism takes several
14525 hours to detect unreachable hosts.
14526
14527
14528
14529 .option smtp_accept_max main integer 20
14530 .cindex "limit" "incoming SMTP connections"
14531 .cindex "SMTP" "incoming connection count"
14532 .cindex "inetd"
14533 This option specifies the maximum number of simultaneous incoming SMTP calls
14534 that Exim will accept. It applies only to the listening daemon; there is no
14535 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
14536 value is set to zero, no limit is applied. However, it is required to be
14537 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
14538 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
14539
14540 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
14541 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
14542 that limit has not been reached for the client host, &%smtp_accept_reserve%&
14543 and &%smtp_load_reserve%& are then checked before accepting the connection.
14544
14545
14546 .option smtp_accept_max_nonmail main integer 10
14547 .cindex "limit" "non-mail SMTP commands"
14548 .cindex "SMTP" "limiting non-mail commands"
14549 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
14550 the connection if there are too many. This option defines &"too many"&. The
14551 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
14552 client looping sending EHLO, for example. The check is applied only if the
14553 client host matches &%smtp_accept_max_nonmail_hosts%&.
14554
14555 When a new message is expected, one occurrence of RSET is not counted. This
14556 allows a client to send one RSET between messages (this is not necessary,
14557 but some clients do it). Exim also allows one uncounted occurrence of HELO
14558 or EHLO, and one occurrence of STARTTLS between messages. After
14559 starting up a TLS session, another EHLO is expected, and so it too is not
14560 counted. The first occurrence of AUTH in a connection, or immediately
14561 following STARTTLS is not counted. Otherwise, all commands other than
14562 MAIL, RCPT, DATA, and QUIT are counted.
14563
14564
14565 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
14566 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
14567 check by setting this option. The default value makes it apply to all hosts. By
14568 changing the value, you can exclude any badly-behaved hosts that you have to
14569 live with.
14570
14571
14572 . Allow this long option name to split; give it unsplit as a fifth argument
14573 . for the automatic .oindex that is generated by .option.
14574
14575 .option "smtp_accept_max_per_ &~&~connection" main integer 1000 &&&
14576          smtp_accept_max_per_connection
14577 .cindex "SMTP" "limiting incoming message count"
14578 .cindex "limit" "messages per SMTP connection"
14579 The value of this option limits the number of MAIL commands that Exim is
14580 prepared to accept over a single SMTP connection, whether or not each command
14581 results in the transfer of a message. After the limit is reached, a 421
14582 response is given to subsequent MAIL commands. This limit is a safety
14583 precaution against a client that goes mad (incidents of this type have been
14584 seen).
14585
14586
14587 .option smtp_accept_max_per_host main string&!! unset
14588 .cindex "limit" "SMTP connections from one host"
14589 .cindex "host" "limiting SMTP connections from"
14590 This option restricts the number of simultaneous IP connections from a single
14591 host (strictly, from a single IP address) to the Exim daemon. The option is
14592 expanded, to enable different limits to be applied to different hosts by
14593 reference to &$sender_host_address$&. Once the limit is reached, additional
14594 connection attempts from the same host are rejected with error code 421. This
14595 is entirely independent of &%smtp_accept_reserve%&. The option's default value
14596 of zero imposes no limit. If this option is set greater than zero, it is
14597 required that &%smtp_accept_max%& be non-zero.
14598
14599 &*Warning*&: When setting this option you should not use any expansion
14600 constructions that take an appreciable amount of time. The expansion and test
14601 happen in the main daemon loop, in order to reject additional connections
14602 without forking additional processes (otherwise a denial-of-service attack
14603 could cause a vast number or processes to be created). While the daemon is
14604 doing this processing, it cannot accept any other incoming connections.
14605
14606
14607
14608 .option smtp_accept_queue main integer 0
14609 .cindex "SMTP" "incoming connection count"
14610 .cindex "queueing incoming messages"
14611 .cindex "message" "queueing by SMTP connection count"
14612 If the number of simultaneous incoming SMTP connections being handled via the
14613 listening daemon exceeds this value, messages received by SMTP are just placed
14614 on the queue; no delivery processes are started automatically. The count is
14615 fixed at the start of an SMTP connection. It cannot be updated in the
14616 subprocess that receives messages, and so the queueing or not queueing applies
14617 to all messages received in the same connection.
14618
14619 A value of zero implies no limit, and clearly any non-zero value is useful only
14620 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
14621 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
14622 various &%-od%&&'x'& command line options.
14623
14624
14625 . Allow this long option name to split; give it unsplit as a fifth argument
14626 . for the automatic .oindex that is generated by .option.
14627
14628 .option "smtp_accept_queue_per_ &~&~connection" main integer 10 &&&
14629          smtp_accept_queue_per_connection
14630 .cindex "queueing incoming messages"
14631 .cindex "message" "queueing by message count"
14632 This option limits the number of delivery processes that Exim starts
14633 automatically when receiving messages via SMTP, whether via the daemon or by
14634 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
14635 and the number of messages received in a single SMTP session exceeds this
14636 number, subsequent messages are placed on the queue, but no delivery processes
14637 are started. This helps to limit the number of Exim processes when a server
14638 restarts after downtime and there is a lot of mail waiting for it on other
14639 systems. On large systems, the default should probably be increased, and on
14640 dial-in client systems it should probably be set to zero (that is, disabled).
14641
14642
14643 .option smtp_accept_reserve main integer 0
14644 .cindex "SMTP" "incoming call count"
14645 .cindex "host" "reserved"
14646 When &%smtp_accept_max%& is set greater than zero, this option specifies a
14647 number of SMTP connections that are reserved for connections from the hosts
14648 that are specified in &%smtp_reserve_hosts%&. The value set in
14649 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
14650 restricted to this number of connections; the option specifies a minimum number
14651 of connection slots for them, not a maximum. It is a guarantee that this group
14652 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
14653 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
14654 individual host.
14655
14656 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
14657 set to 5, once there are 45 active connections (from any hosts), new
14658 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
14659 provided the other criteria for acceptance are met.
14660
14661
14662 .option smtp_active_hostname main string&!! unset
14663 .cindex "host" "name in SMTP responses"
14664 .cindex "SMTP" "host name in responses"
14665 .vindex "&$primary_hostname$&"
14666 This option is provided for multi-homed servers that want to masquerade as
14667 several different hosts. At the start of an incoming SMTP connection, its value
14668 is expanded and used instead of the value of &$primary_hostname$& in SMTP
14669 responses. For example, it is used as domain name in the response to an
14670 incoming HELO or EHLO command.
14671
14672 .vindex "&$smtp_active_hostname$&"
14673 The active hostname is placed in the &$smtp_active_hostname$& variable, which
14674 is saved with any messages that are received. It is therefore available for use
14675 in routers and transports when the message is later delivered.
14676
14677 If this option is unset, or if its expansion is forced to fail, or if the
14678 expansion results in an empty string, the value of &$primary_hostname$& is
14679 used. Other expansion failures cause a message to be written to the main and
14680 panic logs, and the SMTP command receives a temporary error. Typically, the
14681 value of &%smtp_active_hostname%& depends on the incoming interface address.
14682 For example:
14683 .code
14684 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
14685   {cox.mydomain}{box.mydomain}}
14686 .endd
14687
14688 Although &$smtp_active_hostname$& is primarily concerned with incoming
14689 messages, it is also used as the default for HELO commands in callout
14690 verification if there is no remote transport from which to obtain a
14691 &%helo_data%& value.
14692
14693 .option smtp_banner main string&!! "see below"
14694 .cindex "SMTP" "welcome banner"
14695 .cindex "banner for SMTP"
14696 .cindex "welcome banner for SMTP"
14697 .cindex "customizing" "SMTP banner"
14698 This string, which is expanded every time it is used, is output as the initial
14699 positive response to an SMTP connection. The default setting is:
14700 .code
14701 smtp_banner = $smtp_active_hostname ESMTP Exim \
14702   $version_number $tod_full
14703 .endd
14704 Failure to expand the string causes a panic error. If you want to create a
14705 multiline response to the initial SMTP connection, use &"\n"& in the string at
14706 appropriate points, but not at the end. Note that the 220 code is not included
14707 in this string. Exim adds it automatically (several times in the case of a
14708 multiline response).
14709
14710
14711 .option smtp_check_spool_space main boolean true
14712 .cindex "checking disk space"
14713 .cindex "disk space, checking"
14714 .cindex "spool directory" "checking space"
14715 When this option is set, if an incoming SMTP session encounters the SIZE
14716 option on a MAIL command, it checks that there is enough space in the
14717 spool directory's partition to accept a message of that size, while still
14718 leaving free the amount specified by &%check_spool_space%& (even if that value
14719 is zero). If there isn't enough space, a temporary error code is returned.
14720
14721
14722 .option smtp_connect_backlog main integer 20
14723 .cindex "connection backlog"
14724 .cindex "SMTP" "connection backlog"
14725 .cindex "backlog of connections"
14726 This option specifies a maximum number of waiting SMTP connections. Exim passes
14727 this value to the TCP/IP system when it sets up its listener. Once this number
14728 of connections are waiting for the daemon's attention, subsequent connection
14729 attempts are refused at the TCP/IP level. At least, that is what the manuals
14730 say; in some circumstances such connection attempts have been observed to time
14731 out instead. For large systems it is probably a good idea to increase the
14732 value (to 50, say). It also gives some protection against denial-of-service
14733 attacks by SYN flooding.
14734
14735
14736 .option smtp_enforce_sync main boolean true
14737 .cindex "SMTP" "synchronization checking"
14738 .cindex "synchronization checking in SMTP"
14739 The SMTP protocol specification requires the client to wait for a response from
14740 the server at certain points in the dialogue. Without PIPELINING these
14741 synchronization points are after every command; with PIPELINING they are
14742 fewer, but they still exist.
14743
14744 Some spamming sites send out a complete set of SMTP commands without waiting
14745 for any response. Exim protects against this by rejecting a message if the
14746 client has sent further input when it should not have. The error response &"554
14747 SMTP synchronization error"& is sent, and the connection is dropped. Testing
14748 for this error cannot be perfect because of transmission delays (unexpected
14749 input may be on its way but not yet received when Exim checks). However, it
14750 does detect many instances.
14751
14752 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
14753 If you want to disable the check selectively (for example, only for certain
14754 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
14755 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
14756
14757
14758
14759 .option smtp_etrn_command main string&!! unset
14760 .cindex "ETRN" "command to be run"
14761 .vindex "&$domain$&"
14762 If this option is set, the given command is run whenever an SMTP ETRN
14763 command is received from a host that is permitted to issue such commands (see
14764 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
14765 are independently expanded. The expansion variable &$domain$& is set to the
14766 argument of the ETRN command, and no syntax checking is done on it. For
14767 example:
14768 .code
14769 smtp_etrn_command = /etc/etrn_command $domain \
14770                     $sender_host_address
14771 .endd
14772 A new process is created to run the command, but Exim does not wait for it to
14773 complete. Consequently, its status cannot be checked. If the command cannot be
14774 run, a line is written to the panic log, but the ETRN caller still receives
14775 a 250 success response. Exim is normally running under its own uid when
14776 receiving SMTP, so it is not possible for it to change the uid before running
14777 the command.
14778
14779
14780 .option smtp_etrn_serialize main boolean true
14781 .cindex "ETRN" "serializing"
14782 When this option is set, it prevents the simultaneous execution of more than
14783 one identical command as a result of ETRN in an SMTP connection. See
14784 section &<<SECTETRN>>& for details.
14785
14786
14787 .option smtp_load_reserve main fixed-point unset
14788 .cindex "load average"
14789 If the system load average ever gets higher than this, incoming SMTP calls are
14790 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
14791 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
14792 the load is over the limit. The option has no effect on ancient operating
14793 systems on which Exim cannot determine the load average. See also
14794 &%deliver_queue_load_max%& and &%queue_only_load%&.
14795
14796
14797
14798 .option smtp_max_synprot_errors main integer 3
14799 .cindex "SMTP" "limiting syntax and protocol errors"
14800 .cindex "limit" "SMTP syntax and protocol errors"
14801 Exim rejects SMTP commands that contain syntax or protocol errors. In
14802 particular, a syntactically invalid email address, as in this command:
14803 .code
14804 RCPT TO:<abc xyz@a.b.c>
14805 .endd
14806 causes immediate rejection of the command, before any other tests are done.
14807 (The ACL cannot be run if there is no valid address to set up for it.) An
14808 example of a protocol error is receiving RCPT before MAIL. If there are
14809 too many syntax or protocol errors in one SMTP session, the connection is
14810 dropped. The limit is set by this option.
14811
14812 .cindex "PIPELINING" "expected errors"
14813 When the PIPELINING extension to SMTP is in use, some protocol errors are
14814 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
14815 Exim assumes that PIPELINING will be used if it advertises it (see
14816 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
14817 not count towards the limit.
14818
14819
14820
14821 .option smtp_max_unknown_commands main integer 3
14822 .cindex "SMTP" "limiting unknown commands"
14823 .cindex "limit" "unknown SMTP commands"
14824 If there are too many unrecognized commands in an incoming SMTP session, an
14825 Exim server drops the connection. This is a defence against some kinds of abuse
14826 that subvert web
14827 clients
14828 into making connections to SMTP ports; in these circumstances, a number of
14829 non-SMTP command lines are sent first.
14830
14831
14832
14833 .option smtp_ratelimit_hosts main "host list&!!" unset
14834 .cindex "SMTP" "rate limiting"
14835 .cindex "limit" "rate of message arrival"
14836 .cindex "RCPT" "rate limiting"
14837 Some sites find it helpful to be able to limit the rate at which certain hosts
14838 can send them messages, and the rate at which an individual message can specify
14839 recipients.
14840
14841 Exim has two rate-limiting facilities. This section describes the older
14842 facility, which can limit rates within a single connection. The newer
14843 &%ratelimit%& ACL condition can limit rates across all connections. See section
14844 &<<SECTratelimiting>>& for details of the newer facility.
14845
14846 When a host matches &%smtp_ratelimit_hosts%&, the values of
14847 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
14848 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
14849 respectively. Each option, if set, must contain a set of four comma-separated
14850 values:
14851
14852 .ilist
14853 A threshold, before which there is no rate limiting.
14854 .next
14855 An initial time delay. Unlike other times in Exim, numbers with decimal
14856 fractional parts are allowed here.
14857 .next
14858 A factor by which to increase the delay each time.
14859 .next
14860 A maximum value for the delay. This should normally be less than 5 minutes,
14861 because after that time, the client is liable to timeout the SMTP command.
14862 .endlist
14863
14864 For example, these settings have been used successfully at the site which
14865 first suggested this feature, for controlling mail from their customers:
14866 .code
14867 smtp_ratelimit_mail = 2,0.5s,1.05,4m
14868 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
14869 .endd
14870 The first setting specifies delays that are applied to MAIL commands after
14871 two have been received over a single connection. The initial delay is 0.5
14872 seconds, increasing by a factor of 1.05 each time. The second setting applies
14873 delays to RCPT commands when more than four occur in a single message.
14874
14875
14876 .option smtp_ratelimit_mail main string unset
14877 See &%smtp_ratelimit_hosts%& above.
14878
14879
14880 .option smtp_ratelimit_rcpt main string unset
14881 See &%smtp_ratelimit_hosts%& above.
14882
14883
14884 .option smtp_receive_timeout main time 5m
14885 .cindex "timeout" "for SMTP input"
14886 .cindex "SMTP" "input timeout"
14887 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
14888 input, including batch SMTP. If a line of input (either an SMTP command or a
14889 data line) is not received within this time, the SMTP connection is dropped and
14890 the message is abandoned.
14891 A line is written to the log containing one of the following messages:
14892 .code
14893 SMTP command timeout on connection from...
14894 SMTP data timeout on connection from...
14895 .endd
14896 The former means that Exim was expecting to read an SMTP command; the latter
14897 means that it was in the DATA phase, reading the contents of a message.
14898
14899
14900 .oindex "&%-os%&"
14901 The value set by this option can be overridden by the
14902 &%-os%& command-line option. A setting of zero time disables the timeout, but
14903 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
14904 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
14905 timeout is controlled by &%receive_timeout%& and &%-or%&.
14906
14907
14908 .option smtp_reserve_hosts main "host list&!!" unset
14909 This option defines hosts for which SMTP connections are reserved; see
14910 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
14911
14912
14913 .option smtp_return_error_details main boolean false
14914 .cindex "SMTP" "details policy failures"
14915 .cindex "policy control" "rejection, returning details"
14916 In the default state, Exim uses bland messages such as
14917 &"Administrative prohibition"& when it rejects SMTP commands for policy
14918 reasons. Many sysadmins like this because it gives away little information
14919 to spammers. However, some other sysadmins who are applying strict checking
14920 policies want to give out much fuller information about failures. Setting
14921 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
14922 example, instead of &"Administrative prohibition"&, it might give:
14923 .code
14924 550-Rejected after DATA: '>' missing at end of address:
14925 550 failing address in "From" header is: <user@dom.ain
14926 .endd
14927
14928 .option spamd_address main string "see below"
14929 This option is available when Exim is compiled with the content-scanning
14930 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
14931 The default value is
14932 .code
14933 127.0.0.1 783
14934 .endd
14935 See section &<<SECTscanspamass>>& for more details.
14936
14937
14938
14939 .option split_spool_directory main boolean false
14940 .cindex "multiple spool directories"
14941 .cindex "spool directory" "split"
14942 .cindex "directories, multiple"
14943 If this option is set, it causes Exim to split its input directory into 62
14944 subdirectories, each with a single alphanumeric character as its name. The
14945 sixth character of the message id is used to allocate messages to
14946 subdirectories; this is the least significant base-62 digit of the time of
14947 arrival of the message.
14948
14949 Splitting up the spool in this way may provide better performance on systems
14950 where there are long mail queues, by reducing the number of files in any one
14951 directory. The msglog directory is also split up in a similar way to the input
14952 directory; however, if &%preserve_message_logs%& is set, all old msglog files
14953 are still placed in the single directory &_msglog.OLD_&.
14954
14955 It is not necessary to take any special action for existing messages when
14956 changing &%split_spool_directory%&. Exim notices messages that are in the
14957 &"wrong"& place, and continues to process them. If the option is turned off
14958 after a period of being on, the subdirectories will eventually empty and be
14959 automatically deleted.
14960
14961 When &%split_spool_directory%& is set, the behaviour of queue runner processes
14962 changes. Instead of creating a list of all messages in the queue, and then
14963 trying to deliver each one in turn, it constructs a list of those in one
14964 sub-directory and tries to deliver them, before moving on to the next
14965 sub-directory. The sub-directories are processed in a random order. This
14966 spreads out the scanning of the input directories, and uses less memory. It is
14967 particularly beneficial when there are lots of messages on the queue. However,
14968 if &%queue_run_in_order%& is set, none of this new processing happens. The
14969 entire queue has to be scanned and sorted before any deliveries can start.
14970
14971
14972 .option spool_directory main string&!! "set at compile time"
14973 .cindex "spool directory" "path to"
14974 This defines the directory in which Exim keeps its spool, that is, the messages
14975 it is waiting to deliver. The default value is taken from the compile-time
14976 configuration setting, if there is one. If not, this option must be set. The
14977 string is expanded, so it can contain, for example, a reference to
14978 &$primary_hostname$&.
14979
14980 If the spool directory name is fixed on your installation, it is recommended
14981 that you set it at build time rather than from this option, particularly if the
14982 log files are being written to the spool directory (see &%log_file_path%&).
14983 Otherwise log files cannot be used for errors that are detected early on, such
14984 as failures in the configuration file.
14985
14986 By using this option to override the compiled-in path, it is possible to run
14987 tests of Exim without using the standard spool.
14988
14989 .option sqlite_lock_timeout main time 5s
14990 .cindex "sqlite lookup type" "lock timeout"
14991 This option controls the timeout that the &(sqlite)& lookup uses when trying to
14992 access an SQLite database. See section &<<SECTsqlite>>& for more details.
14993
14994 .option strict_acl_vars main boolean false
14995 .cindex "&ACL;" "variables, handling unset"
14996 This option controls what happens if a syntactically valid but undefined ACL
14997 variable is referenced. If it is false (the default), an empty string
14998 is substituted; if it is true, an error is generated. See section
14999 &<<SECTaclvariables>>& for details of ACL variables.
15000
15001 .option strip_excess_angle_brackets main boolean false
15002 .cindex "angle brackets, excess"
15003 If this option is set, redundant pairs of angle brackets round &"route-addr"&
15004 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
15005 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
15006 passed on to another MTA, the excess angle brackets are not passed on. If this
15007 option is not set, multiple pairs of angle brackets cause a syntax error.
15008
15009
15010 .option strip_trailing_dot main boolean false
15011 .cindex "trailing dot on domain"
15012 .cindex "dot" "trailing on domain"
15013 If this option is set, a trailing dot at the end of a domain in an address is
15014 ignored. If this is in the envelope and the message is passed on to another
15015 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
15016 domain causes a syntax error.
15017 However, addresses in header lines are checked only when an ACL requests header
15018 syntax checking.
15019
15020
15021 .option syslog_duplication main boolean true
15022 .cindex "syslog" "duplicate log lines; suppressing"
15023 When Exim is logging to syslog, it writes the log lines for its three
15024 separate logs at different syslog priorities so that they can in principle
15025 be separated on the logging hosts. Some installations do not require this
15026 separation, and in those cases, the duplication of certain log lines is a
15027 nuisance. If &%syslog_duplication%& is set false, only one copy of any
15028 particular log line is written to syslog. For lines that normally go to
15029 both the main log and the reject log, the reject log version (possibly
15030 containing message header lines) is written, at LOG_NOTICE priority.
15031 Lines that normally go to both the main and the panic log are written at
15032 the LOG_ALERT priority.
15033
15034
15035 .option syslog_facility main string unset
15036 .cindex "syslog" "facility; setting"
15037 This option sets the syslog &"facility"& name, used when Exim is logging to
15038 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
15039 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
15040 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
15041 details of Exim's logging.
15042
15043
15044
15045 .option syslog_processname main string &`exim`&
15046 .cindex "syslog" "process name; setting"
15047 This option sets the syslog &"ident"& name, used when Exim is logging to
15048 syslog. The value must be no longer than 32 characters. See chapter
15049 &<<CHAPlog>>& for details of Exim's logging.
15050
15051
15052
15053 .option syslog_timestamp main boolean true
15054 .cindex "syslog" "timestamps"
15055 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
15056 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
15057 details of Exim's logging.
15058
15059
15060 .option system_filter main string&!! unset
15061 .cindex "filter" "system filter"
15062 .cindex "system filter" "specifying"
15063 .cindex "Sieve filter" "not available for system filter"
15064 This option specifies an Exim filter file that is applied to all messages at
15065 the start of each delivery attempt, before any routing is done. System filters
15066 must be Exim filters; they cannot be Sieve filters. If the system filter
15067 generates any deliveries to files or pipes, or any new mail messages, the
15068 appropriate &%system_filter_..._transport%& option(s) must be set, to define
15069 which transports are to be used. Details of this facility are given in chapter
15070 &<<CHAPsystemfilter>>&.
15071
15072
15073 .option system_filter_directory_transport main string&!! unset
15074 .vindex "&$address_file$&"
15075 This sets the name of the transport driver that is to be used when the
15076 &%save%& command in a system message filter specifies a path ending in &"/"&,
15077 implying delivery of each message into a separate file in some directory.
15078 During the delivery, the variable &$address_file$& contains the path name.
15079
15080
15081 .option system_filter_file_transport main string&!! unset
15082 .cindex "file" "transport for system filter"
15083 This sets the name of the transport driver that is to be used when the &%save%&
15084 command in a system message filter specifies a path not ending in &"/"&. During
15085 the delivery, the variable &$address_file$& contains the path name.
15086
15087 .option system_filter_group main string unset
15088 .cindex "gid (group id)" "system filter"
15089 This option is used only when &%system_filter_user%& is also set. It sets the
15090 gid under which the system filter is run, overriding any gid that is associated
15091 with the user. The value may be numerical or symbolic.
15092
15093 .option system_filter_pipe_transport main string&!! unset
15094 .cindex "&(pipe)& transport" "for system filter"
15095 .vindex "&$address_pipe$&"
15096 This specifies the transport driver that is to be used when a &%pipe%& command
15097 is used in a system filter. During the delivery, the variable &$address_pipe$&
15098 contains the pipe command.
15099
15100
15101 .option system_filter_reply_transport main string&!! unset
15102 .cindex "&(autoreply)& transport" "for system filter"
15103 This specifies the transport driver that is to be used when a &%mail%& command
15104 is used in a system filter.
15105
15106 .option system_filter_user main string unset
15107 .cindex "uid (user id)" "system filter"
15108 If this option is not set, the system filter is run in the main Exim delivery
15109 process, as root. When the option is set, the system filter runs in a separate
15110 process, as the given user. Unless the string consists entirely of digits, it
15111 is looked up in the password data. Failure to find the named user causes a
15112 configuration error. The gid is either taken from the password data, or
15113 specified by &%system_filter_group%&. When the uid is specified numerically,
15114 &%system_filter_group%& is required to be set.
15115
15116 If the system filter generates any pipe, file, or reply deliveries, the uid
15117 under which the filter is run is used when transporting them, unless a
15118 transport option overrides. Normally you should set &%system_filter_user%& if
15119 your system filter generates these kinds of delivery.
15120
15121
15122 .option tcp_nodelay main boolean true
15123 .cindex "daemon" "TCP_NODELAY on sockets"
15124 .cindex "Nagle algorithm"
15125 .cindex "TCP_NODELAY on listening sockets"
15126 If this option is set false, it stops the Exim daemon setting the
15127 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
15128 turns off the &"Nagle algorithm"&, which is a way of improving network
15129 performance in interactive (character-by-character) situations. Turning it off
15130 should improve Exim's performance a bit, so that is what happens by default.
15131 However, it appears that some broken clients cannot cope, and time out. Hence
15132 this option. It affects only those sockets that are set up for listening by the
15133 daemon. Sockets created by the smtp transport for delivering mail always set
15134 TCP_NODELAY.
15135
15136
15137 .option timeout_frozen_after main time 0s
15138 .cindex "frozen messages" "timing out"
15139 .cindex "timeout" "frozen messages"
15140 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
15141 message of any kind that has been on the queue for longer than the given time
15142 is automatically cancelled at the next queue run. If the frozen message is a
15143 bounce message, it is just discarded; otherwise, a bounce is sent to the
15144 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
15145 If you want to timeout frozen bounce messages earlier than other kinds of
15146 frozen message, see &%ignore_bounce_errors_after%&.
15147
15148 &*Note:*& the default value of zero means no timeouts; with this setting,
15149 frozen messages remain on the queue forever (except for any frozen bounce
15150 messages that are released by &%ignore_bounce_errors_after%&).
15151
15152
15153 .option timezone main string unset
15154 .cindex "timezone, setting"
15155 The value of &%timezone%& is used to set the environment variable TZ while
15156 running Exim (if it is different on entry). This ensures that all timestamps
15157 created by Exim are in the required timezone. If you want all your timestamps
15158 to be in UTC (aka GMT) you should set
15159 .code
15160 timezone = UTC
15161 .endd
15162 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
15163 or, if that is not set, from the value of the TZ environment variable when Exim
15164 is built. If &%timezone%& is set to the empty string, either at build or run
15165 time, any existing TZ variable is removed from the environment when Exim
15166 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
15167 unfortunately not all, operating systems.
15168
15169
15170 .option tls_advertise_hosts main "host list&!!" unset
15171 .cindex "TLS" "advertising"
15172 .cindex "encryption" "on SMTP connection"
15173 .cindex "SMTP" "encrypted connection"
15174 When Exim is built with support for TLS encrypted connections, the availability
15175 of the STARTTLS command to set up an encrypted session is advertised in
15176 response to EHLO only to those client hosts that match this option. See
15177 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
15178
15179
15180 .option tls_certificate main string&!! unset
15181 .cindex "TLS" "server certificate; location of"
15182 .cindex "certificate" "server, location of"
15183 The value of this option is expanded, and must then be the absolute path to a
15184 file which contains the server's certificates. The server's private key is also
15185 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
15186 &<<CHAPTLS>>& for further details.
15187
15188 &*Note*&: The certificates defined by this option are used only when Exim is
15189 receiving incoming messages as a server. If you want to supply certificates for
15190 use when sending messages as a client, you must set the &%tls_certificate%&
15191 option in the relevant &(smtp)& transport.
15192
15193
15194 .option tls_crl main string&!! unset
15195 .cindex "TLS" "server certificate revocation list"
15196 .cindex "certificate" "revocation list for server"
15197 This option specifies a certificate revocation list. The expanded value must
15198 be the name of a file that contains a CRL in PEM format.
15199
15200
15201 .option tls_dhparam main string&!! unset
15202 .cindex "TLS" "D-H parameters for server"
15203 The value of this option is expanded, and must then be the absolute path to
15204 a file which contains the server's DH parameter values.
15205 This is used only for OpenSSL. When Exim is linked with GnuTLS, this option is
15206 ignored. See section &<<SECTopenvsgnu>>& for further details.
15207
15208
15209 .option tls_on_connect_ports main "string list" unset
15210 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
15211 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
15212 set up without waiting for the client to issue a STARTTLS command. For
15213 further details, see section &<<SECTsupobssmt>>&.
15214
15215
15216
15217 .option tls_privatekey main string&!! unset
15218 .cindex "TLS" "server private key; location of"
15219 The value of this option is expanded, and must then be the absolute path to a
15220 file which contains the server's private key. If this option is unset, or if
15221 the expansion is forced to fail, or the result is an empty string, the private
15222 key is assumed to be in the same file as the server's certificates. See chapter
15223 &<<CHAPTLS>>& for further details.
15224
15225
15226 .option tls_remember_esmtp main boolean false
15227 .cindex "TLS" "esmtp state; remembering"
15228 .cindex "TLS" "broken clients"
15229 If this option is set true, Exim violates the RFCs by remembering that it is in
15230 &"esmtp"& state after successfully negotiating a TLS session. This provides
15231 support for broken clients that fail to send a new EHLO after starting a
15232 TLS session.
15233
15234
15235 .option tls_require_ciphers main string&!! unset
15236 .cindex "TLS" "requiring specific ciphers"
15237 .cindex "cipher" "requiring specific"
15238 This option controls which ciphers can be used for incoming TLS connections.
15239 The &(smtp)& transport has an option of the same name for controlling outgoing
15240 connections. This option is expanded for each connection, so can be varied for
15241 different clients if required. The value of this option must be a list of
15242 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
15243 in somewhat different ways. If GnuTLS is being used, the client controls the
15244 preference order of the available ciphers. Details are given in sections
15245 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
15246
15247
15248 .option tls_try_verify_hosts main "host list&!!" unset
15249 .cindex "TLS" "client certificate verification"
15250 .cindex "certificate" "verification of client"
15251 See &%tls_verify_hosts%& below.
15252
15253
15254 .option tls_verify_certificates main string&!! unset
15255 .cindex "TLS" "client certificate verification"
15256 .cindex "certificate" "verification of client"
15257 The value of this option is expanded, and must then be the absolute path to
15258 a file containing permitted certificates for clients that
15259 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&. Alternatively, if you
15260 are using OpenSSL, you can set &%tls_verify_certificates%& to the name of a
15261 directory containing certificate files. This does not work with GnuTLS; the
15262 option must be set to the name of a single file if you are using GnuTLS.
15263
15264
15265 .option tls_verify_hosts main "host list&!!" unset
15266 .cindex "TLS" "client certificate verification"
15267 .cindex "certificate" "verification of client"
15268 This option, along with &%tls_try_verify_hosts%&, controls the checking of
15269 certificates from clients. The expected certificates are defined by
15270 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
15271 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
15272 &%tls_verify_certificates%& is not set.
15273
15274 Any client that matches &%tls_verify_hosts%& is constrained by
15275 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
15276 present one of the listed certificates. If it does not, the connection is
15277 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
15278 the host to use TLS. It can still send SMTP commands through unencrypted
15279 connections. Forcing a client to use TLS has to be done separately using an
15280 ACL to reject inappropriate commands when the connection is not encrypted.
15281
15282 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
15283 matches this option (but not &%tls_verify_hosts%&), Exim requests a
15284 certificate and checks it against &%tls_verify_certificates%&, but does not
15285 abort the connection if there is no certificate or if it does not match. This
15286 state can be detected in an ACL, which makes it possible to implement policies
15287 such as &"accept for relay only if a verified certificate has been received,
15288 but accept for local delivery if encrypted, even without a verified
15289 certificate"&.
15290
15291 Client hosts that match neither of these lists are not asked to present
15292 certificates.
15293
15294
15295 .option trusted_groups main "string list&!!" unset
15296 .cindex "trusted groups"
15297 .cindex "groups" "trusted"
15298 This option is expanded just once, at the start of Exim's processing. If this
15299 option is set, any process that is running in one of the listed groups, or
15300 which has one of them as a supplementary group, is trusted. The groups can be
15301 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
15302 details of what trusted callers are permitted to do. If neither
15303 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
15304 are trusted.
15305
15306 .option trusted_users main "string list&!!" unset
15307 .cindex "trusted users"
15308 .cindex "user" "trusted"
15309 This option is expanded just once, at the start of Exim's processing. If this
15310 option is set, any process that is running as one of the listed users is
15311 trusted. The users can be specified numerically or by name. See section
15312 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
15313 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
15314 Exim user are trusted.
15315
15316 .option unknown_login main string&!! unset
15317 .cindex "uid (user id)" "unknown caller"
15318 .vindex "&$caller_uid$&"
15319 This is a specialized feature for use in unusual configurations. By default, if
15320 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
15321 gives up. The &%unknown_login%& option can be used to set a login name to be
15322 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
15323 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
15324 is used for the user's real name (gecos field), unless this has been set by the
15325 &%-F%& option.
15326
15327 .option unknown_username main string unset
15328 See &%unknown_login%&.
15329
15330 .option untrusted_set_sender main "address list&!!" unset
15331 .cindex "trusted users"
15332 .cindex "sender" "setting by untrusted user"
15333 .cindex "untrusted user setting sender"
15334 .cindex "user" "untrusted setting sender"
15335 .cindex "envelope sender"
15336 When an untrusted user submits a message to Exim using the standard input, Exim
15337 normally creates an envelope sender address from the user's login and the
15338 default qualification domain. Data from the &%-f%& option (for setting envelope
15339 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
15340 is used) is ignored.
15341
15342 However, untrusted users are permitted to set an empty envelope sender address,
15343 to declare that a message should never generate any bounces. For example:
15344 .code
15345 exim -f '<>' user@domain.example
15346 .endd
15347 .vindex "&$sender_ident$&"
15348 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
15349 other envelope sender addresses in a controlled way. When it is set, untrusted
15350 users are allowed to set envelope sender addresses that match any of the
15351 patterns in the list. Like all address lists, the string is expanded. The
15352 identity of the user is in &$sender_ident$&, so you can, for example, restrict
15353 users to setting senders that start with their login ids
15354 followed by a hyphen
15355 by a setting like this:
15356 .code
15357 untrusted_set_sender = ^$sender_ident-
15358 .endd
15359 If you want to allow untrusted users to set envelope sender addresses without
15360 restriction, you can use
15361 .code
15362 untrusted_set_sender = *
15363 .endd
15364 The &%untrusted_set_sender%& option applies to all forms of local input, but
15365 only to the setting of the envelope sender. It does not permit untrusted users
15366 to use the other options which trusted user can use to override message
15367 parameters. Furthermore, it does not stop Exim from removing an existing
15368 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
15369 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
15370 overriding these actions. The handling of the &'Sender:'& header is also
15371 described in section &<<SECTthesenhea>>&.
15372
15373 The log line for a message's arrival shows the envelope sender following
15374 &"<="&. For local messages, the user's login always follows, after &"U="&. In
15375 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
15376 envelope sender address, the user's login is shown in parentheses after the
15377 sender address.
15378
15379
15380 .option uucp_from_pattern main string "see below"
15381 .cindex "&""From""& line"
15382 .cindex "UUCP" "&""From""& line"
15383 Some applications that pass messages to an MTA via a command line interface use
15384 an initial line starting with &"From&~"& to pass the envelope sender. In
15385 particular, this is used by UUCP software. Exim recognizes such a line by means
15386 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
15387 matches, the sender address is constructed by expanding the contents of
15388 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
15389 default pattern recognizes lines in the following two forms:
15390 .code
15391 From ph10 Fri Jan  5 12:35 GMT 1996
15392 From ph10 Fri, 7 Jan 97 14:00:00 GMT
15393 .endd
15394 The pattern can be seen by running
15395 .code
15396 exim -bP uucp_from_pattern
15397 .endd
15398 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
15399 year in the second case. The first word after &"From&~"& is matched in the
15400 regular expression by a parenthesized subpattern. The default value for
15401 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
15402 (&"ph10"& in the example above) as the message's sender. See also
15403 &%ignore_fromline_hosts%&.
15404
15405
15406 .option uucp_from_sender main string&!! &`$1`&
15407 See &%uucp_from_pattern%& above.
15408
15409
15410 .option warn_message_file main string unset
15411 .cindex "warning of delay" "customizing the message"
15412 .cindex "customizing" "warning message"
15413 This option defines a template file containing paragraphs of text to be used
15414 for constructing the warning message which is sent by Exim when a message has
15415 been on the queue for a specified amount of time, as specified by
15416 &%delay_warning%&. Details of the file's contents are given in chapter
15417 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
15418
15419
15420 .option write_rejectlog main boolean true
15421 .cindex "reject log" "disabling"
15422 If this option is set false, Exim no longer writes anything to the reject log.
15423 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
15424 .ecindex IIDconfima
15425 .ecindex IIDmaiconf
15426
15427
15428
15429
15430 . ////////////////////////////////////////////////////////////////////////////
15431 . ////////////////////////////////////////////////////////////////////////////
15432
15433 .chapter "Generic options for routers" "CHAProutergeneric"
15434 .scindex IIDgenoprou1 "options" "generic; for routers"
15435 .scindex IIDgenoprou2 "generic options" "router"
15436 This chapter describes the generic options that apply to all routers.
15437 Those that are preconditions are marked with &Dagger; in the &"use"& field.
15438
15439 For a general description of how a router operates, see sections
15440 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
15441 which the preconditions are tested. The order of expansion of the options that
15442 provide data for a transport is: &%errors_to%&, &%headers_add%&,
15443 &%headers_remove%&, &%transport%&.
15444
15445
15446
15447 .option address_data routers string&!! unset
15448 .cindex "router" "data attached to address"
15449 The string is expanded just before the router is run, that is, after all the
15450 precondition tests have succeeded. If the expansion is forced to fail, the
15451 router declines, the value of &%address_data%& remains unchanged, and the
15452 &%more%& option controls what happens next. Other expansion failures cause
15453 delivery of the address to be deferred.
15454
15455 .vindex "&$address_data$&"
15456 When the expansion succeeds, the value is retained with the address, and can be
15457 accessed using the variable &$address_data$& in the current router, subsequent
15458 routers, and the eventual transport.
15459
15460 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
15461 that runs a user's filter file, the contents of &$address_data$& are accessible
15462 in the filter. This is not normally a problem, because such data is usually
15463 either not confidential or it &"belongs"& to the current user, but if you do
15464 put confidential data into &$address_data$& you need to remember this point.
15465
15466 Even if the router declines or passes, the value of &$address_data$& remains
15467 with the address, though it can be changed by another &%address_data%& setting
15468 on a subsequent router. If a router generates child addresses, the value of
15469 &$address_data$& propagates to them. This also applies to the special kind of
15470 &"child"& that is generated by a router with the &%unseen%& option.
15471
15472 The idea of &%address_data%& is that you can use it to look up a lot of data
15473 for the address once, and then pick out parts of the data later. For example,
15474 you could use a single LDAP lookup to return a string of the form
15475 .code
15476 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
15477 .endd
15478 In the transport you could pick out the mailbox by a setting such as
15479 .code
15480 file = ${extract{mailbox}{$address_data}}
15481 .endd
15482 This makes the configuration file less messy, and also reduces the number of
15483 lookups (though Exim does cache lookups).
15484
15485 .vindex "&$sender_address_data$&"
15486 .vindex "&$address_data$&"
15487 The &%address_data%& facility is also useful as a means of passing information
15488 from one router to another, and from a router to a transport. In addition, if
15489 &$address_data$& is set by a router when verifying a recipient address from an
15490 ACL, it remains available for use in the rest of the ACL statement. After
15491 verifying a sender, the value is transferred to &$sender_address_data$&.
15492
15493
15494
15495 .option address_test routers&!? boolean true
15496 .oindex "&%-bt%&"
15497 .cindex "router" "skipping when address testing"
15498 If this option is set false, the router is skipped when routing is being tested
15499 by means of the &%-bt%& command line option. This can be a convenience when
15500 your first router sends messages to an external scanner, because it saves you
15501 having to set the &"already scanned"& indicator when testing real address
15502 routing.
15503
15504
15505
15506 .option cannot_route_message routers string&!! unset
15507 .cindex "router" "customizing &""cannot route""& message"
15508 .cindex "customizing" "&""cannot route""& message"
15509 This option specifies a text message that is used when an address cannot be
15510 routed because Exim has run out of routers. The default message is
15511 &"Unrouteable address"&. This option is useful only on routers that have
15512 &%more%& set false, or on the very last router in a configuration, because the
15513 value that is used is taken from the last router that is considered. This
15514 includes a router that is skipped because its preconditions are not met, as
15515 well as a router that declines. For example, using the default configuration,
15516 you could put:
15517 .code
15518 cannot_route_message = Remote domain not found in DNS
15519 .endd
15520 on the first router, which is a &(dnslookup)& router with &%more%& set false,
15521 and
15522 .code
15523 cannot_route_message = Unknown local user
15524 .endd
15525 on the final router that checks for local users. If string expansion fails for
15526 this option, the default message is used. Unless the expansion failure was
15527 explicitly forced, a message about the failure is written to the main and panic
15528 logs, in addition to the normal message about the routing failure.
15529
15530
15531 .option caseful_local_part routers boolean false
15532 .cindex "case of local parts"
15533 .cindex "router" "case of local parts"
15534 By default, routers handle the local parts of addresses in a case-insensitive
15535 manner, though the actual case is preserved for transmission with the message.
15536 If you want the case of letters to be significant in a router, you must set
15537 this option true. For individual router options that contain address or local
15538 part lists (for example, &%local_parts%&), case-sensitive matching can be
15539 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
15540 more details.
15541
15542 .vindex "&$local_part$&"
15543 .vindex "&$original_local_part$&"
15544 .vindex "&$parent_local_part$&"
15545 The value of the &$local_part$& variable is forced to lower case while a
15546 router is running unless &%caseful_local_part%& is set. When a router assigns
15547 an address to a transport, the value of &$local_part$& when the transport runs
15548 is the same as it was in the router. Similarly, when a router generates child
15549 addresses by aliasing or forwarding, the values of &$original_local_part$&
15550 and &$parent_local_part$& are those that were used by the redirecting router.
15551
15552 This option applies to the processing of an address by a router. When a
15553 recipient address is being processed in an ACL, there is a separate &%control%&
15554 modifier that can be used to specify case-sensitive processing within the ACL
15555 (see section &<<SECTcontrols>>&).
15556
15557
15558
15559 .option check_local_user routers&!? boolean false
15560 .cindex "local user, checking in router"
15561 .cindex "router" "checking for local user"
15562 .cindex "&_/etc/passwd_&"
15563 .vindex "&$home$&"
15564 When this option is true, Exim checks that the local part of the recipient
15565 address (with affixes removed if relevant) is the name of an account on the
15566 local system. The check is done by calling the &[getpwnam()]& function rather
15567 than trying to read &_/etc/passwd_& directly. This means that other methods of
15568 holding password data (such as NIS) are supported. If the local part is a local
15569 user, &$home$& is set from the password data, and can be tested in other
15570 preconditions that are evaluated after this one (the order of evaluation is
15571 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
15572 overridden by &%router_home_directory%&. If the local part is not a local user,
15573 the router is skipped.
15574
15575 If you want to check that the local part is either the name of a local user
15576 or matches something else, you cannot combine &%check_local_user%& with a
15577 setting of &%local_parts%&, because that specifies the logical &'and'& of the
15578 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
15579 setting to achieve this. For example:
15580 .code
15581 local_parts = passwd;$local_part : lsearch;/etc/other/users
15582 .endd
15583 Note, however, that the side effects of &%check_local_user%& (such as setting
15584 up a home directory) do not occur when a &(passwd)& lookup is used in a
15585 &%local_parts%& (or any other) precondition.
15586
15587
15588
15589 .option condition routers&!? string&!! unset
15590 .cindex "router" "customized precondition"
15591 This option specifies a general precondition test that has to succeed for the
15592 router to be called. The &%condition%& option is the last precondition to be
15593 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
15594 result is a forced failure, or an empty string, or one of the strings &"0"& or
15595 &"no"& or &"false"& (checked without regard to the case of the letters), the
15596 router is skipped, and the address is offered to the next one.
15597
15598 If the result is any other value, the router is run (as this is the last
15599 precondition to be evaluated, all the other preconditions must be true).
15600
15601 The &%condition%& option provides a means of applying custom conditions to the
15602 running of routers. Note that in the case of a simple conditional expansion,
15603 the default expansion values are exactly what is wanted. For example:
15604 .code
15605 condition = ${if >{$message_age}{600}}
15606 .endd
15607 Because of the default behaviour of the string expansion, this is equivalent to
15608 .code
15609 condition = ${if >{$message_age}{600}{true}{}}
15610 .endd
15611 If the expansion fails (other than forced failure) delivery is deferred. Some
15612 of the other precondition options are common special cases that could in fact
15613 be specified using &%condition%&.
15614
15615
15616
15617 .option debug_print routers string&!! unset
15618 .cindex "testing" "variables in drivers"
15619 If this option is set and debugging is enabled (see the &%-d%& command line
15620 option), the string is expanded and included in the debugging output.
15621 If expansion of the string fails, the error message is written to the debugging
15622 output, and Exim carries on processing.
15623 This option is provided to help with checking out the values of variables and
15624 so on when debugging router configurations. For example, if a &%condition%&
15625 option appears not to be working, &%debug_print%& can be used to output the
15626 variables it references. The output happens after checks for &%domains%&,
15627 &%local_parts%&, and &%check_local_user%& but before any other preconditions
15628 are tested. A newline is added to the text if it does not end with one.
15629
15630
15631
15632 .option disable_logging routers boolean false
15633 If this option is set true, nothing is logged for any routing errors
15634 or for any deliveries caused by this router. You should not set this option
15635 unless you really, really know what you are doing. See also the generic
15636 transport option of the same name.
15637
15638
15639 .option domains routers&!? "domain list&!!" unset
15640 .cindex "router" "restricting to specific domains"
15641 .vindex "&$domain_data$&"
15642 If this option is set, the router is skipped unless the current domain matches
15643 the list. If the match is achieved by means of a file lookup, the data that the
15644 lookup returned for the domain is placed in &$domain_data$& for use in string
15645 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
15646 a list of the order in which preconditions are evaluated.
15647
15648
15649
15650 .option driver routers string unset
15651 This option must always be set. It specifies which of the available routers is
15652 to be used.
15653
15654
15655
15656 .option errors_to routers string&!! unset
15657 .cindex "envelope sender"
15658 .cindex "router" "changing address for errors"
15659 If a router successfully handles an address, it may assign the address to a
15660 transport for delivery or it may generate child addresses. In both cases, if
15661 there is a delivery problem during later processing, the resulting bounce
15662 message is sent to the address that results from expanding this string,
15663 provided that the address verifies successfully. The &%errors_to%& option is
15664 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
15665
15666 The &%errors_to%& setting associated with an address can be overridden if it
15667 subsequently passes through other routers that have their own &%errors_to%&
15668 settings, or if the message is delivered by a transport with a &%return_path%&
15669 setting.
15670
15671 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
15672 the expansion fails to verify, the errors address associated with the incoming
15673 address is used. At top level, this is the envelope sender. A non-forced
15674 expansion failure causes delivery to be deferred.
15675
15676 If an address for which &%errors_to%& has been set ends up being delivered over
15677 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
15678 any bounces that are generated by other MTAs on the delivery route are also
15679 sent there. You can set &%errors_to%& to the empty string by either of these
15680 settings:
15681 .code
15682 errors_to =
15683 errors_to = ""
15684 .endd
15685 An expansion item that yields an empty string has the same effect. If you do
15686 this, a locally detected delivery error for addresses processed by this router
15687 no longer gives rise to a bounce message; the error is discarded. If the
15688 address is delivered to a remote host, the return path is set to &`<>`&, unless
15689 overridden by the &%return_path%& option on the transport.
15690
15691 .vindex "&$address_data$&"
15692 If for some reason you want to discard local errors, but use a non-empty
15693 MAIL command for remote delivery, you can preserve the original return
15694 path in &$address_data$& in the router, and reinstate it in the transport by
15695 setting &%return_path%&.
15696
15697 The most common use of &%errors_to%& is to direct mailing list bounces to the
15698 manager of the list, as described in section &<<SECTmailinglists>>&, or to
15699 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
15700
15701
15702
15703 .option expn routers&!? boolean true
15704 .cindex "address" "testing"
15705 .cindex "testing" "addresses"
15706 .cindex "EXPN" "router skipping"
15707 .cindex "router" "skipping for EXPN"
15708 If this option is turned off, the router is skipped when testing an address
15709 as a result of processing an SMTP EXPN command. You might, for example,
15710 want to turn it off on a router for users' &_.forward_& files, while leaving it
15711 on for the system alias file.
15712 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
15713 are evaluated.
15714
15715 The use of the SMTP EXPN command is controlled by an ACL (see chapter
15716 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
15717 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
15718
15719
15720
15721 .option fail_verify routers boolean false
15722 .cindex "router" "forcing verification failure"
15723 Setting this option has the effect of setting both &%fail_verify_sender%& and
15724 &%fail_verify_recipient%& to the same value.
15725
15726
15727
15728 .option fail_verify_recipient routers boolean false
15729 If this option is true and an address is accepted by this router when
15730 verifying a recipient, verification fails.
15731
15732
15733
15734 .option fail_verify_sender routers boolean false
15735 If this option is true and an address is accepted by this router when
15736 verifying a sender, verification fails.
15737
15738
15739
15740 .option fallback_hosts routers "string list" unset
15741 .cindex "router" "fallback hosts"
15742 .cindex "fallback" "hosts specified on router"
15743 String expansion is not applied to this option. The argument must be a
15744 colon-separated list of host names or IP addresses. The list separator can be
15745 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
15746 each name or address. In fact, the format of each item is exactly the same as
15747 defined for the list of hosts in a &(manualroute)& router (see section
15748 &<<SECTformatonehostitem>>&).
15749
15750 If a router queues an address for a remote transport, this host list is
15751 associated with the address, and used instead of the transport's fallback host
15752 list. If &%hosts_randomize%& is set on the transport, the order of the list is
15753 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
15754 transport for further details.
15755
15756
15757 .option group routers string&!! "see below"
15758 .cindex "gid (group id)" "local delivery"
15759 .cindex "local transports" "uid and gid"
15760 .cindex "transport" "local"
15761 .cindex "router" "setting group"
15762 When a router queues an address for a transport, and the transport does not
15763 specify a group, the group given here is used when running the delivery
15764 process.
15765 The group may be specified numerically or by name. If expansion fails, the
15766 error is logged and delivery is deferred.
15767 The default is unset, unless &%check_local_user%& is set, when the default
15768 is taken from the password information. See also &%initgroups%& and &%user%&
15769 and the discussion in chapter &<<CHAPenvironment>>&.
15770
15771
15772
15773 .option headers_add routers string&!! unset
15774 .cindex "header lines" "adding"
15775 .cindex "router" "adding header lines"
15776 This option specifies a string of text that is expanded at routing time, and
15777 associated with any addresses that are accepted by the router. However, this
15778 option has no effect when an address is just being verified. The way in which
15779 the text is used to add header lines at transport time is described in section
15780 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
15781 message is in the process of being transported. This means that references to
15782 header lines in string expansions in the transport's configuration do not
15783 &"see"& the added header lines.
15784
15785 The &%headers_add%& option is expanded after &%errors_to%&, but before
15786 &%headers_remove%& and &%transport%&. If the expanded string is empty, or if
15787 the expansion is forced to fail, the option has no effect. Other expansion
15788 failures are treated as configuration errors.
15789
15790 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
15791 router that has the &%one_time%& option set.
15792
15793 .cindex "duplicate addresses"
15794 .oindex "&%unseen%&"
15795 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
15796 additions are deleted when the address is passed on to subsequent routers.
15797 For a &%redirect%& router, if a generated address is the same as the incoming
15798 address, this can lead to duplicate addresses with different header
15799 modifications. Exim does not do duplicate deliveries (except, in certain
15800 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
15801 which of the duplicates is discarded, so this ambiguous situation should be
15802 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
15803
15804
15805
15806 .option headers_remove routers string&!! unset
15807 .cindex "header lines" "removing"
15808 .cindex "router" "removing header lines"
15809 This option specifies a string of text that is expanded at routing time, and
15810 associated with any addresses that are accepted by the router. However, this
15811 option has no effect when an address is just being verified. The way in which
15812 the text is used to remove header lines at transport time is described in
15813 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
15814 the message is in the process of being transported. This means that references
15815 to header lines in string expansions in the transport's configuration still
15816 &"see"& the original header lines.
15817
15818 The &%headers_remove%& option is expanded after &%errors_to%& and
15819 &%headers_add%&, but before &%transport%&. If the expansion is forced to fail,
15820 the option has no effect. Other expansion failures are treated as configuration
15821 errors.
15822
15823 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
15824 router that has the &%one_time%& option set.
15825
15826 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
15827 removal requests are deleted when the address is passed on to subsequent
15828 routers, and this can lead to problems with duplicates -- see the similar
15829 warning for &%headers_add%& above.
15830
15831
15832 .option ignore_target_hosts routers "host list&!!" unset
15833 .cindex "IP address" "discarding"
15834 .cindex "router" "discarding IP addresses"
15835 Although this option is a host list, it should normally contain IP address
15836 entries rather than names. If any host that is looked up by the router has an
15837 IP address that matches an item in this list, Exim behaves as if that IP
15838 address did not exist. This option allows you to cope with rogue DNS entries
15839 like
15840 .code
15841 remote.domain.example.  A  127.0.0.1
15842 .endd
15843 by setting
15844 .code
15845 ignore_target_hosts = 127.0.0.1
15846 .endd
15847 on the relevant router. If all the hosts found by a &(dnslookup)& router are
15848 discarded in this way, the router declines. In a conventional configuration, an
15849 attempt to mail to such a domain would normally provoke the &"unrouteable
15850 domain"& error, and an attempt to verify an address in the domain would fail.
15851 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
15852 router declines if presented with one of the listed addresses.
15853
15854 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
15855 means of the first or the second of the following settings, respectively:
15856 .code
15857 ignore_target_hosts = 0.0.0.0/0
15858 ignore_target_hosts = <; 0::0/0
15859 .endd
15860 The pattern in the first line matches all IPv4 addresses, whereas the pattern
15861 in the second line matches all IPv6 addresses.
15862
15863 This option may also be useful for ignoring link-local and site-local IPv6
15864 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
15865 is expanded before use as a list, it is possible to make it dependent on the
15866 domain that is being routed.
15867
15868 .vindex "&$host_address$&"
15869 During its expansion, &$host_address$& is set to the IP address that is being
15870 checked.
15871
15872 .option initgroups routers boolean false
15873 .cindex "additional groups"
15874 .cindex "groups" "additional"
15875 .cindex "local transports" "uid and gid"
15876 .cindex "transport" "local"
15877 If the router queues an address for a transport, and this option is true, and
15878 the uid supplied by the router is not overridden by the transport, the
15879 &[initgroups()]& function is called when running the transport to ensure that
15880 any additional groups associated with the uid are set up. See also &%group%&
15881 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
15882
15883
15884
15885 .option local_part_prefix routers&!? "string list" unset
15886 .cindex "router" "prefix for local part"
15887 .cindex "prefix" "for local part, used in router"
15888 If this option is set, the router is skipped unless the local part starts with
15889 one of the given strings, or &%local_part_prefix_optional%& is true. See
15890 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
15891 evaluated.
15892
15893 The list is scanned from left to right, and the first prefix that matches is
15894 used. A limited form of wildcard is available; if the prefix begins with an
15895 asterisk, it matches the longest possible sequence of arbitrary characters at
15896 the start of the local part. An asterisk should therefore always be followed by
15897 some character that does not occur in normal local parts.
15898 .cindex "multiple mailboxes"
15899 .cindex "mailbox" "multiple"
15900 Wildcarding can be used to set up multiple user mailboxes, as described in
15901 section &<<SECTmulbox>>&.
15902
15903 .vindex "&$local_part$&"
15904 .vindex "&$local_part_prefix$&"
15905 During the testing of the &%local_parts%& option, and while the router is
15906 running, the prefix is removed from the local part, and is available in the
15907 expansion variable &$local_part_prefix$&. When a message is being delivered, if
15908 the router accepts the address, this remains true during subsequent delivery by
15909 a transport. In particular, the local part that is transmitted in the RCPT
15910 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
15911 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
15912 the relevant transport.
15913
15914 When an address is being verified, &%local_part_prefix%& affects only the
15915 behaviour of the router. If the callout feature of verification is in use, this
15916 means that the full address, including the prefix, will be used during the
15917 callout.
15918
15919 The prefix facility is commonly used to handle local parts of the form
15920 &%owner-something%&. Another common use is to support local parts of the form
15921 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
15922 to tell a user their forwarding is broken &-- by placing a router like this one
15923 immediately before the router that handles &_.forward_& files:
15924 .code
15925 real_localuser:
15926   driver = accept
15927   local_part_prefix = real-
15928   check_local_user
15929   transport = local_delivery
15930 .endd
15931 For security, it would probably be a good idea to restrict the use of this
15932 router to locally-generated messages, using a condition such as this:
15933 .code
15934   condition = ${if match {$sender_host_address}\
15935                          {\N^(|127\.0\.0\.1)$\N}}
15936 .endd
15937
15938 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
15939 both conditions must be met if not optional. Care must be taken if wildcards
15940 are used in both a prefix and a suffix on the same router. Different
15941 separator characters must be used to avoid ambiguity.
15942
15943
15944 .option local_part_prefix_optional routers boolean false
15945 See &%local_part_prefix%& above.
15946
15947
15948
15949 .option local_part_suffix routers&!? "string list" unset
15950 .cindex "router" "suffix for local part"
15951 .cindex "suffix for local part" "used in router"
15952 This option operates in the same way as &%local_part_prefix%&, except that the
15953 local part must end (rather than start) with the given string, the
15954 &%local_part_suffix_optional%& option determines whether the suffix is
15955 mandatory, and the wildcard * character, if present, must be the last
15956 character of the suffix. This option facility is commonly used to handle local
15957 parts of the form &%something-request%& and multiple user mailboxes of the form
15958 &%username-foo%&.
15959
15960
15961 .option local_part_suffix_optional routers boolean false
15962 See &%local_part_suffix%& above.
15963
15964
15965
15966 .option local_parts routers&!? "local part list&!!" unset
15967 .cindex "router" "restricting to specific local parts"
15968 .cindex "local part" "checking in router"
15969 The router is run only if the local part of the address matches the list.
15970 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
15971 are evaluated, and
15972 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
15973 string is expanded, it is possible to make it depend on the domain, for
15974 example:
15975 .code
15976 local_parts = dbm;/usr/local/specials/$domain
15977 .endd
15978 .vindex "&$local_part_data$&"
15979 If the match is achieved by a lookup, the data that the lookup returned
15980 for the local part is placed in the variable &$local_part_data$& for use in
15981 expansions of the router's private options. You might use this option, for
15982 example, if you have a large number of local virtual domains, and you want to
15983 send all postmaster mail to the same place without having to set up an alias in
15984 each virtual domain:
15985 .code
15986 postmaster:
15987   driver = redirect
15988   local_parts = postmaster
15989   data = postmaster@real.domain.example
15990 .endd
15991
15992
15993 .option log_as_local routers boolean "see below"
15994 .cindex "log" "delivery line"
15995 .cindex "delivery" "log line format"
15996 Exim has two logging styles for delivery, the idea being to make local
15997 deliveries stand out more visibly from remote ones. In the &"local"& style, the
15998 recipient address is given just as the local part, without a domain. The use of
15999 this style is controlled by this option. It defaults to true for the &(accept)&
16000 router, and false for all the others. This option applies only when a
16001 router assigns an address to a transport. It has no effect on routers that
16002 redirect addresses.
16003
16004
16005
16006 .option more routers boolean&!! true
16007 The result of string expansion for this option must be a valid boolean value,
16008 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
16009 result causes an error, and delivery is deferred. If the expansion is forced to
16010 fail, the default value for the option (true) is used. Other failures cause
16011 delivery to be deferred.
16012
16013 If this option is set false, and the router declines to handle the address, no
16014 further routers are tried, routing fails, and the address is bounced.
16015 .oindex "&%self%&"
16016 However, if the router explicitly passes an address to the following router by
16017 means of the setting
16018 .code
16019 self = pass
16020 .endd
16021 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
16022 does not affect the behaviour if one of the precondition tests fails. In that
16023 case, the address is always passed to the next router.
16024
16025 Note that &%address_data%& is not considered to be a precondition. If its
16026 expansion is forced to fail, the router declines, and the value of &%more%&
16027 controls what happens next.
16028
16029
16030 .option pass_on_timeout routers boolean false
16031 .cindex "timeout" "of router"
16032 .cindex "router" "timeout"
16033 If a router times out during a host lookup, it normally causes deferral of the
16034 address. If &%pass_on_timeout%& is set, the address is passed on to the next
16035 router, overriding &%no_more%&. This may be helpful for systems that are
16036 intermittently connected to the Internet, or those that want to pass to a smart
16037 host any messages that cannot immediately be delivered.
16038
16039 There are occasional other temporary errors that can occur while doing DNS
16040 lookups. They are treated in the same way as a timeout, and this option
16041 applies to all of them.
16042
16043
16044
16045 .option pass_router routers string unset
16046 .cindex "router" "go to after &""pass""&"
16047 Routers that recognize the generic &%self%& option (&(dnslookup)&,
16048 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
16049 routing to continue, and overriding a false setting of &%more%&. When one of
16050 these routers returns &"pass"&, the address is normally handed on to the next
16051 router in sequence. This can be changed by setting &%pass_router%& to the name
16052 of another router. However (unlike &%redirect_router%&) the named router must
16053 be below the current router, to avoid loops. Note that this option applies only
16054 to the special case of &"pass"&. It does not apply when a router returns
16055 &"decline"& because it cannot handle an address.
16056
16057
16058
16059 .option redirect_router routers string unset
16060 .cindex "router" "start at after redirection"
16061 Sometimes an administrator knows that it is pointless to reprocess addresses
16062 generated from alias or forward files with the same router again. For
16063 example, if an alias file translates real names into login ids there is no
16064 point searching the alias file a second time, especially if it is a large file.
16065
16066 The &%redirect_router%& option can be set to the name of any router instance.
16067 It causes the routing of any generated addresses to start at the named router
16068 instead of at the first router. This option has no effect if the router in
16069 which it is set does not generate new addresses.
16070
16071
16072
16073 .option require_files routers&!? "string list&!!" unset
16074 .cindex "file" "requiring for router"
16075 .cindex "router" "requiring file existence"
16076 This option provides a general mechanism for predicating the running of a
16077 router on the existence or non-existence of certain files or directories.
16078 Before running a router, as one of its precondition tests, Exim works its way
16079 through the &%require_files%& list, expanding each item separately.
16080
16081 Because the list is split before expansion, any colons in expansion items must
16082 be doubled, or the facility for using a different list separator must be used.
16083 If any expansion is forced to fail, the item is ignored. Other expansion
16084 failures cause routing of the address to be deferred.
16085
16086 If any expanded string is empty, it is ignored. Otherwise, except as described
16087 below, each string must be a fully qualified file path, optionally preceded by
16088 &"!"&. The paths are passed to the &[stat()]& function to test for the
16089 existence of the files or directories. The router is skipped if any paths not
16090 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
16091
16092 .cindex "NFS"
16093 If &[stat()]& cannot determine whether a file exists or not, delivery of
16094 the message is deferred. This can happen when NFS-mounted filesystems are
16095 unavailable.
16096
16097 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
16098 options, so you cannot use it to check for the existence of a file in which to
16099 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
16100 full list of the order in which preconditions are evaluated.) However, as
16101 these options are all expanded, you can use the &%exists%& expansion condition
16102 to make such tests. The &%require_files%& option is intended for checking files
16103 that the router may be going to use internally, or which are needed by a
16104 transport (for example &_.procmailrc_&).
16105
16106 During delivery, the &[stat()]& function is run as root, but there is a
16107 facility for some checking of the accessibility of a file by another user.
16108 This is not a proper permissions check, but just a &"rough"& check that
16109 operates as follows:
16110
16111 If an item in a &%require_files%& list does not contain any forward slash
16112 characters, it is taken to be the user (and optional group, separated by a
16113 comma) to be checked for subsequent files in the list. If no group is specified
16114 but the user is specified symbolically, the gid associated with the uid is
16115 used. For example:
16116 .code
16117 require_files = mail:/some/file
16118 require_files = $local_part:$home/.procmailrc
16119 .endd
16120 If a user or group name in a &%require_files%& list does not exist, the
16121 &%require_files%& condition fails.
16122
16123 Exim performs the check by scanning along the components of the file path, and
16124 checking the access for the given uid and gid. It checks for &"x"& access on
16125 directories, and &"r"& access on the final file. Note that this means that file
16126 access control lists, if the operating system has them, are ignored.
16127
16128 &*Warning 1*&: When the router is being run to verify addresses for an
16129 incoming SMTP message, Exim is not running as root, but under its own uid. This
16130 may affect the result of a &%require_files%& check. In particular, &[stat()]&
16131 may yield the error EACCES (&"Permission denied"&). This means that the Exim
16132 user is not permitted to read one of the directories on the file's path.
16133
16134 &*Warning 2*&: Even when Exim is running as root while delivering a message,
16135 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
16136 without root access. In this case, if a check for access by a particular user
16137 is requested, Exim creates a subprocess that runs as that user, and tries the
16138 check again in that process.
16139
16140 The default action for handling an unresolved EACCES is to consider it to
16141 be caused by a configuration error, and routing is deferred because the
16142 existence or non-existence of the file cannot be determined. However, in some
16143 circumstances it may be desirable to treat this condition as if the file did
16144 not exist. If the file name (or the exclamation mark that precedes the file
16145 name for non-existence) is preceded by a plus sign, the EACCES error is treated
16146 as if the file did not exist. For example:
16147 .code
16148 require_files = +/some/file
16149 .endd
16150 If the router is not an essential part of verification (for example, it
16151 handles users' &_.forward_& files), another solution is to set the &%verify%&
16152 option false so that the router is skipped when verifying.
16153
16154
16155
16156 .option retry_use_local_part routers boolean "see below"
16157 .cindex "hints database" "retry keys"
16158 .cindex "local part" "in retry keys"
16159 When a delivery suffers a temporary routing failure, a retry record is created
16160 in Exim's hints database. For addresses whose routing depends only on the
16161 domain, the key for the retry record should not involve the local part, but for
16162 other addresses, both the domain and the local part should be included.
16163 Usually, remote routing is of the former kind, and local routing is of the
16164 latter kind.
16165
16166 This option controls whether the local part is used to form the key for retry
16167 hints for addresses that suffer temporary errors while being handled by this
16168 router. The default value is true for any router that has &%check_local_user%&
16169 set, and false otherwise. Note that this option does not apply to hints keys
16170 for transport delays; they are controlled by a generic transport option of the
16171 same name.
16172
16173 The setting of &%retry_use_local_part%& applies only to the router on which it
16174 appears. If the router generates child addresses, they are routed
16175 independently; this setting does not become attached to them.
16176
16177
16178
16179 .option router_home_directory routers string&!! unset
16180 .cindex "router" "home directory for"
16181 .cindex "home directory" "for router"
16182 .vindex "&$home$&"
16183 This option sets a home directory for use while the router is running. (Compare
16184 &%transport_home_directory%&, which sets a home directory for later
16185 transporting.) In particular, if used on a &(redirect)& router, this option
16186 sets a value for &$home$& while a filter is running. The value is expanded;
16187 forced expansion failure causes the option to be ignored &-- other failures
16188 cause the router to defer.
16189
16190 Expansion of &%router_home_directory%& happens immediately after the
16191 &%check_local_user%& test (if configured), before any further expansions take
16192 place.
16193 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16194 are evaluated.)
16195 While the router is running, &%router_home_directory%& overrides the value of
16196 &$home$& that came from &%check_local_user%&.
16197
16198 When a router accepts an address and assigns it to a local transport (including
16199 the cases when a &(redirect)& router generates a pipe, file, or autoreply
16200 delivery), the home directory setting for the transport is taken from the first
16201 of these values that is set:
16202
16203 .ilist
16204 The &%home_directory%& option on the transport;
16205 .next
16206 The &%transport_home_directory%& option on the router;
16207 .next
16208 The password data if &%check_local_user%& is set on the router;
16209 .next
16210 The &%router_home_directory%& option on the router.
16211 .endlist
16212
16213 In other words, &%router_home_directory%& overrides the password data for the
16214 router, but not for the transport.
16215
16216
16217
16218 .option self routers string freeze
16219 .cindex "MX record" "pointing to local host"
16220 .cindex "local host" "MX pointing to"
16221 This option applies to those routers that use a recipient address to find a
16222 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
16223 and &(manualroute)& routers.
16224 Certain configurations of the &(queryprogram)& router can also specify a list
16225 of remote hosts.
16226 Usually such routers are configured to send the message to a remote host via an
16227 &(smtp)& transport. The &%self%& option specifies what happens when the first
16228 host on the list turns out to be the local host.
16229 The way in which Exim checks for the local host is described in section
16230 &<<SECTreclocipadd>>&.
16231
16232 Normally this situation indicates either an error in Exim's configuration (for
16233 example, the router should be configured not to process this domain), or an
16234 error in the DNS (for example, the MX should not point to this host). For this
16235 reason, the default action is to log the incident, defer the address, and
16236 freeze the message. The following alternatives are provided for use in special
16237 cases:
16238
16239 .vlist
16240 .vitem &%defer%&
16241 Delivery of the message is tried again later, but the message is not frozen.
16242
16243 .vitem "&%reroute%&: <&'domain'&>"
16244 The domain is changed to the given domain, and the address is passed back to
16245 be reprocessed by the routers. No rewriting of headers takes place. This
16246 behaviour is essentially a redirection.
16247
16248 .vitem "&%reroute: rewrite:%& <&'domain'&>"
16249 The domain is changed to the given domain, and the address is passed back to be
16250 reprocessed by the routers. Any headers that contain the original domain are
16251 rewritten.
16252
16253 .vitem &%pass%&
16254 .oindex "&%more%&"
16255 .vindex "&$self_hostname$&"
16256 The router passes the address to the next router, or to the router named in the
16257 &%pass_router%& option if it is set. This overrides &%no_more%&. During
16258 subsequent routing and delivery, the variable &$self_hostname$& contains the
16259 name of the local host that the router encountered. This can be used to
16260 distinguish between different cases for hosts with multiple names. The
16261 combination
16262 .code
16263 self = pass
16264 no_more
16265 .endd
16266 ensures that only those addresses that routed to the local host are passed on.
16267 Without &%no_more%&, addresses that were declined for other reasons would also
16268 be passed to the next router.
16269
16270 .vitem &%fail%&
16271 Delivery fails and an error report is generated.
16272
16273 .vitem &%send%&
16274 .cindex "local host" "sending to"
16275 The anomaly is ignored and the address is queued for the transport. This
16276 setting should be used with extreme caution. For an &(smtp)& transport, it
16277 makes sense only in cases where the program that is listening on the SMTP port
16278 is not this version of Exim. That is, it must be some other MTA, or Exim with a
16279 different configuration file that handles the domain in another way.
16280 .endlist
16281
16282
16283
16284 .option senders routers&!? "address list&!!" unset
16285 .cindex "router" "checking senders"
16286 If this option is set, the router is skipped unless the message's sender
16287 address matches something on the list.
16288 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16289 are evaluated.
16290
16291 There are issues concerning verification when the running of routers is
16292 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
16293 setting, it sets the sender to the null string. When using the &%-bt%& option
16294 to check a configuration file, it is necessary also to use the &%-f%& option to
16295 set an appropriate sender. For incoming mail, the sender is unset when
16296 verifying the sender, but is available when verifying any recipients. If the
16297 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
16298 matters.
16299
16300
16301 .option translate_ip_address routers string&!! unset
16302 .cindex "IP address" "translating"
16303 .cindex "packet radio"
16304 .cindex "router" "IP address translation"
16305 There exist some rare networking situations (for example, packet radio) where
16306 it is helpful to be able to translate IP addresses generated by normal routing
16307 mechanisms into other IP addresses, thus performing a kind of manual IP
16308 routing. This should be done only if the normal IP routing of the TCP/IP stack
16309 is inadequate or broken. Because this is an extremely uncommon requirement, the
16310 code to support this option is not included in the Exim binary unless
16311 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
16312
16313 .vindex "&$host_address$&"
16314 The &%translate_ip_address%& string is expanded for every IP address generated
16315 by the router, with the generated address set in &$host_address$&. If the
16316 expansion is forced to fail, no action is taken.
16317 For any other expansion error, delivery of the message is deferred.
16318 If the result of the expansion is an IP address, that replaces the original
16319 address; otherwise the result is assumed to be a host name &-- this is looked
16320 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
16321 produce one or more replacement IP addresses. For example, to subvert all IP
16322 addresses in some specific networks, this could be added to a router:
16323 .code
16324 translate_ip_address = \
16325   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
16326     {$value}fail}}
16327 .endd
16328 The file would contain lines like
16329 .code
16330 10.2.3.128/26    some.host
16331 10.8.4.34/26     10.44.8.15
16332 .endd
16333 You should not make use of this facility unless you really understand what you
16334 are doing.
16335
16336
16337
16338 .option transport routers string&!! unset
16339 This option specifies the transport to be used when a router accepts an address
16340 and sets it up for delivery. A transport is never needed if a router is used
16341 only for verification. The value of the option is expanded at routing time,
16342 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
16343 and result must be the name of one of the configured transports. If it is not,
16344 delivery is deferred.
16345
16346 The &%transport%& option is not used by the &(redirect)& router, but it does
16347 have some private options that set up transports for pipe and file deliveries
16348 (see chapter &<<CHAPredirect>>&).
16349
16350
16351
16352 .option transport_current_directory routers string&!! unset
16353 .cindex "current directory for local transport"
16354 This option associates a current directory with any address that is routed
16355 to a local transport. This can happen either because a transport is
16356 explicitly configured for the router, or because it generates a delivery to a
16357 file or a pipe. During the delivery process (that is, at transport time), this
16358 option string is expanded and is set as the current directory, unless
16359 overridden by a setting on the transport.
16360 If the expansion fails for any reason, including forced failure, an error is
16361 logged, and delivery is deferred.
16362 See chapter &<<CHAPenvironment>>& for details of the local delivery
16363 environment.
16364
16365
16366
16367
16368 .option transport_home_directory routers string&!! "see below"
16369 .cindex "home directory" "for local transport"
16370 This option associates a home directory with any address that is routed to a
16371 local transport. This can happen either because a transport is explicitly
16372 configured for the router, or because it generates a delivery to a file or a
16373 pipe. During the delivery process (that is, at transport time), the option
16374 string is expanded and is set as the home directory, unless overridden by a
16375 setting of &%home_directory%& on the transport.
16376 If the expansion fails for any reason, including forced failure, an error is
16377 logged, and delivery is deferred.
16378
16379 If the transport does not specify a home directory, and
16380 &%transport_home_directory%& is not set for the router, the home directory for
16381 the transport is taken from the password data if &%check_local_user%& is set for
16382 the router. Otherwise it is taken from &%router_home_directory%& if that option
16383 is set; if not, no home directory is set for the transport.
16384
16385 See chapter &<<CHAPenvironment>>& for further details of the local delivery
16386 environment.
16387
16388
16389
16390
16391 .option unseen routers boolean&!! false
16392 .cindex "router" "carrying on after success"
16393 The result of string expansion for this option must be a valid boolean value,
16394 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
16395 result causes an error, and delivery is deferred. If the expansion is forced to
16396 fail, the default value for the option (false) is used. Other failures cause
16397 delivery to be deferred.
16398
16399 When this option is set true, routing does not cease if the router accepts the
16400 address. Instead, a copy of the incoming address is passed to the next router,
16401 overriding a false setting of &%more%&. There is little point in setting
16402 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
16403 the value of &%unseen%& contains expansion items (and therefore, presumably, is
16404 sometimes true and sometimes false).
16405
16406 .cindex "copy of message (&%unseen%& option)"
16407 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
16408 qualifier in filter files. It can be used to cause copies of messages to be
16409 delivered to some other destination, while also carrying out a normal delivery.
16410 In effect, the current address is made into a &"parent"& that has two children
16411 &-- one that is delivered as specified by this router, and a clone that goes on
16412 to be routed further. For this reason, &%unseen%& may not be combined with the
16413 &%one_time%& option in a &(redirect)& router.
16414
16415 &*Warning*&: Header lines added to the address (or specified for removal) by
16416 this router or by previous routers affect the &"unseen"& copy of the message
16417 only. The clone that continues to be processed by further routers starts with
16418 no added headers and none specified for removal. For a &%redirect%& router, if
16419 a generated address is the same as the incoming address, this can lead to
16420 duplicate addresses with different header modifications. Exim does not do
16421 duplicate deliveries (except, in certain circumstances, to pipes -- see section
16422 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
16423 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
16424 &%redirect%& router may be of help.
16425
16426 Unlike the handling of header modifications, any data that was set by the
16427 &%address_data%& option in the current or previous routers &'is'& passed on to
16428 subsequent routers.
16429
16430
16431 .option user routers string&!! "see below"
16432 .cindex "uid (user id)" "local delivery"
16433 .cindex "local transports" "uid and gid"
16434 .cindex "transport" "local"
16435 .cindex "router" "user for filter processing"
16436 .cindex "filter" "user for processing"
16437 When a router queues an address for a transport, and the transport does not
16438 specify a user, the user given here is used when running the delivery process.
16439 The user may be specified numerically or by name. If expansion fails, the
16440 error is logged and delivery is deferred.
16441 This user is also used by the &(redirect)& router when running a filter file.
16442 The default is unset, except when &%check_local_user%& is set. In this case,
16443 the default is taken from the password information. If the user is specified as
16444 a name, and &%group%& is not set, the group associated with the user is used.
16445 See also &%initgroups%& and &%group%& and the discussion in chapter
16446 &<<CHAPenvironment>>&.
16447
16448
16449
16450 .option verify routers&!? boolean true
16451 Setting this option has the effect of setting &%verify_sender%& and
16452 &%verify_recipient%& to the same value.
16453
16454
16455 .option verify_only routers&!? boolean false
16456 .cindex "EXPN" "with &%verify_only%&"
16457 .oindex "&%-bv%&"
16458 .cindex "router" "used only when verifying"
16459 If this option is set, the router is used only when verifying an address or
16460 testing with the &%-bv%& option, not when actually doing a delivery, testing
16461 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
16462 restricted to verifying only senders or recipients by means of
16463 &%verify_sender%& and &%verify_recipient%&.
16464
16465 &*Warning*&: When the router is being run to verify addresses for an incoming
16466 SMTP message, Exim is not running as root, but under its own uid. If the router
16467 accesses any files, you need to make sure that they are accessible to the Exim
16468 user or group.
16469
16470
16471 .option verify_recipient routers&!? boolean true
16472 If this option is false, the router is skipped when verifying recipient
16473 addresses
16474 or testing recipient verification using &%-bv%&.
16475 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16476 are evaluated.
16477
16478
16479 .option verify_sender routers&!? boolean true
16480 If this option is false, the router is skipped when verifying sender addresses
16481 or testing sender verification using &%-bvs%&.
16482 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16483 are evaluated.
16484 .ecindex IIDgenoprou1
16485 .ecindex IIDgenoprou2
16486
16487
16488
16489
16490
16491
16492 . ////////////////////////////////////////////////////////////////////////////
16493 . ////////////////////////////////////////////////////////////////////////////
16494
16495 .chapter "The accept router" "CHID4"
16496 .cindex "&(accept)& router"
16497 .cindex "routers" "&(accept)&"
16498 The &(accept)& router has no private options of its own. Unless it is being
16499 used purely for verification (see &%verify_only%&) a transport is required to
16500 be defined by the generic &%transport%& option. If the preconditions that are
16501 specified by generic options are met, the router accepts the address and queues
16502 it for the given transport. The most common use of this router is for setting
16503 up deliveries to local mailboxes. For example:
16504 .code
16505 localusers:
16506   driver = accept
16507   domains = mydomain.example
16508   check_local_user
16509   transport = local_delivery
16510 .endd
16511 The &%domains%& condition in this example checks the domain of the address, and
16512 &%check_local_user%& checks that the local part is the login of a local user.
16513 When both preconditions are met, the &(accept)& router runs, and queues the
16514 address for the &(local_delivery)& transport.
16515
16516
16517
16518
16519
16520
16521 . ////////////////////////////////////////////////////////////////////////////
16522 . ////////////////////////////////////////////////////////////////////////////
16523
16524 .chapter "The dnslookup router" "CHAPdnslookup"
16525 .scindex IIDdnsrou1 "&(dnslookup)& router"
16526 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
16527 The &(dnslookup)& router looks up the hosts that handle mail for the
16528 recipient's domain in the DNS. A transport must always be set for this router,
16529 unless &%verify_only%& is set.
16530
16531 If SRV support is configured (see &%check_srv%& below), Exim first searches for
16532 SRV records. If none are found, or if SRV support is not configured,
16533 MX records are looked up. If no MX records exist, address records are sought.
16534 However, &%mx_domains%& can be set to disable the direct use of address
16535 records.
16536
16537 MX records of equal priority are sorted by Exim into a random order. Exim then
16538 looks for address records for the host names obtained from MX or SRV records.
16539 When a host has more than one IP address, they are sorted into a random order,
16540 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
16541 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
16542 generic option, the router declines.
16543
16544 Unless they have the highest priority (lowest MX value), MX records that point
16545 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
16546 are discarded, together with any other MX records of equal or lower priority.
16547
16548 .cindex "MX record" "pointing to local host"
16549 .cindex "local host" "MX pointing to"
16550 .oindex "&%self%&" "in &(dnslookup)& router"
16551 If the host pointed to by the highest priority MX record, or looked up as an
16552 address record, is the local host, or matches &%hosts_treat_as_local%&, what
16553 happens is controlled by the generic &%self%& option.
16554
16555
16556 .section "Problems with DNS lookups" "SECTprowitdnsloo"
16557 There have been problems with DNS servers when SRV records are looked up.
16558 Some mis-behaving servers return a DNS error or timeout when a non-existent
16559 SRV record is sought. Similar problems have in the past been reported for
16560 MX records. The global &%dns_again_means_nonexist%& option can help with this
16561 problem, but it is heavy-handed because it is a global option.
16562
16563 For this reason, there are two options, &%srv_fail_domains%& and
16564 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
16565 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
16566 an attempt to look up an SRV or MX record causes one of these results, and the
16567 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
16568 such record"&. In the case of an SRV lookup, this means that the router
16569 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
16570 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
16571 case routing fails.
16572
16573
16574
16575
16576 .section "Private options for dnslookup" "SECID118"
16577 .cindex "options" "&(dnslookup)& router"
16578 The private options for the &(dnslookup)& router are as follows:
16579
16580 .option check_secondary_mx dnslookup boolean false
16581 .cindex "MX record" "checking for secondary"
16582 If this option is set, the router declines unless the local host is found in
16583 (and removed from) the list of hosts obtained by MX lookup. This can be used to
16584 process domains for which the local host is a secondary mail exchanger
16585 differently to other domains. The way in which Exim decides whether a host is
16586 the local host is described in section &<<SECTreclocipadd>>&.
16587
16588
16589 .option check_srv dnslookup string&!! unset
16590 .cindex "SRV record" "enabling use of"
16591 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
16592 addition to MX and address records. The support is disabled by default. To
16593 enable SRV support, set the &%check_srv%& option to the name of the service
16594 required. For example,
16595 .code
16596 check_srv = smtp
16597 .endd
16598 looks for SRV records that refer to the normal smtp service. The option is
16599 expanded, so the service name can vary from message to message or address
16600 to address. This might be helpful if SRV records are being used for a
16601 submission service. If the expansion is forced to fail, the &%check_srv%&
16602 option is ignored, and the router proceeds to look for MX records in the
16603 normal way.
16604
16605 When the expansion succeeds, the router searches first for SRV records for
16606 the given service (it assumes TCP protocol). A single SRV record with a
16607 host name that consists of just a single dot indicates &"no such service for
16608 this domain"&; if this is encountered, the router declines. If other kinds of
16609 SRV record are found, they are used to construct a host list for delivery
16610 according to the rules of RFC 2782. MX records are not sought in this case.
16611
16612 When no SRV records are found, MX records (and address records) are sought in
16613 the traditional way. In other words, SRV records take precedence over MX
16614 records, just as MX records take precedence over address records. Note that
16615 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
16616 defined it. It is apparently believed that MX records are sufficient for email
16617 and that SRV records should not be used for this purpose. However, SRV records
16618 have an additional &"weight"& feature which some people might find useful when
16619 trying to split an SMTP load between hosts of different power.
16620
16621 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
16622 when there is a DNS lookup error.
16623
16624
16625
16626 .option mx_domains dnslookup "domain list&!!" unset
16627 .cindex "MX record" "required to exist"
16628 .cindex "SRV record" "required to exist"
16629 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
16630 record in order to be recognized. (The name of this option could be improved.)
16631 For example, if all the mail hosts in &'fict.example'& are known to have MX
16632 records, except for those in &'discworld.fict.example'&, you could use this
16633 setting:
16634 .code
16635 mx_domains = ! *.discworld.fict.example : *.fict.example
16636 .endd
16637 This specifies that messages addressed to a domain that matches the list but
16638 has no MX record should be bounced immediately instead of being routed using
16639 the address record.
16640
16641
16642 .option mx_fail_domains dnslookup "domain list&!!" unset
16643 If the DNS lookup for MX records for one of the domains in this list causes a
16644 DNS lookup error, Exim behaves as if no MX records were found. See section
16645 &<<SECTprowitdnsloo>>& for more discussion.
16646
16647
16648
16649
16650 .option qualify_single dnslookup boolean true
16651 .cindex "DNS" "resolver options"
16652 .cindex "DNS" "qualifying single-component names"
16653 When this option is true, the resolver option RES_DEFNAMES is set for DNS
16654 lookups. Typically, but not standardly, this causes the resolver to qualify
16655 single-component names with the default domain. For example, on a machine
16656 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
16657 &'thesaurus.ref.example'& inside the resolver. For details of what your
16658 resolver actually does, consult your man pages for &'resolver'& and
16659 &'resolv.conf'&.
16660
16661
16662
16663 .option rewrite_headers dnslookup boolean true
16664 .cindex "rewriting" "header lines"
16665 .cindex "header lines" "rewriting"
16666 If the domain name in the address that is being processed is not fully
16667 qualified, it may be expanded to its full form by a DNS lookup. For example, if
16668 an address is specified as &'dormouse@teaparty'&, the domain might be
16669 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
16670 occur as a result of setting the &%widen_domains%& option. If
16671 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
16672 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
16673 header lines of the message are rewritten with the full domain name.
16674
16675 This option should be turned off only when it is known that no message is
16676 ever going to be sent outside an environment where the abbreviation makes
16677 sense.
16678
16679 When an MX record is looked up in the DNS and matches a wildcard record, name
16680 servers normally return a record containing the name that has been looked up,
16681 making it impossible to detect whether a wildcard was present or not. However,
16682 some name servers have recently been seen to return the wildcard entry. If the
16683 name returned by a DNS lookup begins with an asterisk, it is not used for
16684 header rewriting.
16685
16686
16687 .option same_domain_copy_routing dnslookup boolean false
16688 .cindex "address" "copying routing"
16689 Addresses with the same domain are normally routed by the &(dnslookup)& router
16690 to the same list of hosts. However, this cannot be presumed, because the router
16691 options and preconditions may refer to the local part of the address. By
16692 default, therefore, Exim routes each address in a message independently. DNS
16693 servers run caches, so repeated DNS lookups are not normally expensive, and in
16694 any case, personal messages rarely have more than a few recipients.
16695
16696 If you are running mailing lists with large numbers of subscribers at the same
16697 domain, and you are using a &(dnslookup)& router which is independent of the
16698 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
16699 lookups for identical domains in one message. In this case, when &(dnslookup)&
16700 routes an address to a remote transport, any other unrouted addresses in the
16701 message that have the same domain are automatically given the same routing
16702 without processing them independently,
16703 provided the following conditions are met:
16704
16705 .ilist
16706 No router that processed the address specified &%headers_add%& or
16707 &%headers_remove%&.
16708 .next
16709 The router did not change the address in any way, for example, by &"widening"&
16710 the domain.
16711 .endlist
16712
16713
16714
16715
16716 .option search_parents dnslookup boolean false
16717 .cindex "DNS" "resolver options"
16718 When this option is true, the resolver option RES_DNSRCH is set for DNS
16719 lookups. This is different from the &%qualify_single%& option in that it
16720 applies to domains containing dots. Typically, but not standardly, it causes
16721 the resolver to search for the name in the current domain and in parent
16722 domains. For example, on a machine in the &'fict.example'& domain, if looking
16723 up &'teaparty.wonderland'& failed, the resolver would try
16724 &'teaparty.wonderland.fict.example'&. For details of what your resolver
16725 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
16726
16727 Setting this option true can cause problems in domains that have a wildcard MX
16728 record, because any domain that does not have its own MX record matches the
16729 local wildcard.
16730
16731
16732
16733 .option srv_fail_domains dnslookup "domain list&!!" unset
16734 If the DNS lookup for SRV records for one of the domains in this list causes a
16735 DNS lookup error, Exim behaves as if no SRV records were found. See section
16736 &<<SECTprowitdnsloo>>& for more discussion.
16737
16738
16739
16740
16741 .option widen_domains dnslookup "string list" unset
16742 .cindex "domain" "partial; widening"
16743 If a DNS lookup fails and this option is set, each of its strings in turn is
16744 added onto the end of the domain, and the lookup is tried again. For example,
16745 if
16746 .code
16747 widen_domains = fict.example:ref.example
16748 .endd
16749 is set and a lookup of &'klingon.dictionary'& fails,
16750 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
16751 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
16752 and &%search_parents%& options can cause some widening to be undertaken inside
16753 the DNS resolver. &%widen_domains%& is not applied to sender addresses
16754 when verifying, unless &%rewrite_headers%& is false (not the default).
16755
16756
16757 .section "Effect of qualify_single and search_parents" "SECID119"
16758 When a domain from an envelope recipient is changed by the resolver as a result
16759 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
16760 corresponding address in the message's header lines unless &%rewrite_headers%&
16761 is set false. Exim then re-routes the address, using the full domain.
16762
16763 These two options affect only the DNS lookup that takes place inside the router
16764 for the domain of the address that is being routed. They do not affect lookups
16765 such as that implied by
16766 .code
16767 domains = @mx_any
16768 .endd
16769 that may happen while processing a router precondition before the router is
16770 entered. No widening ever takes place for these lookups.
16771 .ecindex IIDdnsrou1
16772 .ecindex IIDdnsrou2
16773
16774
16775
16776
16777
16778
16779
16780
16781
16782 . ////////////////////////////////////////////////////////////////////////////
16783 . ////////////////////////////////////////////////////////////////////////////
16784
16785 .chapter "The ipliteral router" "CHID5"
16786 .cindex "&(ipliteral)& router"
16787 .cindex "domain literal" "routing"
16788 .cindex "routers" "&(ipliteral)&"
16789 This router has no private options. Unless it is being used purely for
16790 verification (see &%verify_only%&) a transport is required to be defined by the
16791 generic &%transport%& option. The router accepts the address if its domain part
16792 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
16793 router handles the address
16794 .code
16795 root@[192.168.1.1]
16796 .endd
16797 by setting up delivery to the host with that IP address. IPv4 domain literals
16798 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
16799 are similar, but the address is preceded by &`ipv6:`&. For example:
16800 .code
16801 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
16802 .endd
16803 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
16804 grounds that sooner or later somebody will try it.
16805
16806 .oindex "&%self%&" "in &(ipliteral)& router"
16807 If the IP address matches something in &%ignore_target_hosts%&, the router
16808 declines. If an IP literal turns out to refer to the local host, the generic
16809 &%self%& option determines what happens.
16810
16811 The RFCs require support for domain literals; however, their use is
16812 controversial in today's Internet. If you want to use this router, you must
16813 also set the main configuration option &%allow_domain_literals%&. Otherwise,
16814 Exim will not recognize the domain literal syntax in addresses.
16815
16816
16817
16818 . ////////////////////////////////////////////////////////////////////////////
16819 . ////////////////////////////////////////////////////////////////////////////
16820
16821 .chapter "The iplookup router" "CHID6"
16822 .cindex "&(iplookup)& router"
16823 .cindex "routers" "&(iplookup)&"
16824 The &(iplookup)& router was written to fulfil a specific requirement in
16825 Cambridge University (which in fact no longer exists). For this reason, it is
16826 not included in the binary of Exim by default. If you want to include it, you
16827 must set
16828 .code
16829 ROUTER_IPLOOKUP=yes
16830 .endd
16831 in your &_Local/Makefile_& configuration file.
16832
16833 The &(iplookup)& router routes an address by sending it over a TCP or UDP
16834 connection to one or more specific hosts. The host can then return the same or
16835 a different address &-- in effect rewriting the recipient address in the
16836 message's envelope. The new address is then passed on to subsequent routers. If
16837 this process fails, the address can be passed on to other routers, or delivery
16838 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
16839 must not be specified for it.
16840
16841 .cindex "options" "&(iplookup)& router"
16842 .option hosts iplookup string unset
16843 This option must be supplied. Its value is a colon-separated list of host
16844 names. The hosts are looked up using &[gethostbyname()]&
16845 (or &[getipnodebyname()]& when available)
16846 and are tried in order until one responds to the query. If none respond, what
16847 happens is controlled by &%optional%&.
16848
16849
16850 .option optional iplookup boolean false
16851 If &%optional%& is true, if no response is obtained from any host, the address
16852 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
16853 delivery to the address is deferred.
16854
16855
16856 .option port iplookup integer 0
16857 .cindex "port" "&(iplookup)& router"
16858 This option must be supplied. It specifies the port number for the TCP or UDP
16859 call.
16860
16861
16862 .option protocol iplookup string udp
16863 This option can be set to &"udp"& or &"tcp"& to specify which of the two
16864 protocols is to be used.
16865
16866
16867 .option query iplookup string&!! "see below"
16868 This defines the content of the query that is sent to the remote hosts. The
16869 default value is:
16870 .code
16871 $local_part@$domain $local_part@$domain
16872 .endd
16873 The repetition serves as a way of checking that a response is to the correct
16874 query in the default case (see &%response_pattern%& below).
16875
16876
16877 .option reroute iplookup string&!! unset
16878 If this option is not set, the rerouted address is precisely the byte string
16879 returned by the remote host, up to the first white space, if any. If set, the
16880 string is expanded to form the rerouted address. It can include parts matched
16881 in the response by &%response_pattern%& by means of numeric variables such as
16882 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
16883 whether or not a pattern is in use. In all cases, the rerouted address must end
16884 up in the form &'local_part@domain'&.
16885
16886
16887 .option response_pattern iplookup string unset
16888 This option can be set to a regular expression that is applied to the string
16889 returned from the remote host. If the pattern does not match the response, the
16890 router declines. If &%response_pattern%& is not set, no checking of the
16891 response is done, unless the query was defaulted, in which case there is a
16892 check that the text returned after the first white space is the original
16893 address. This checks that the answer that has been received is in response to
16894 the correct question. For example, if the response is just a new domain, the
16895 following could be used:
16896 .code
16897 response_pattern = ^([^@]+)$
16898 reroute = $local_part@$1
16899 .endd
16900
16901 .option timeout iplookup time 5s
16902 This specifies the amount of time to wait for a response from the remote
16903 machine. The same timeout is used for the &[connect()]& function for a TCP
16904 call. It does not apply to UDP.
16905
16906
16907
16908
16909 . ////////////////////////////////////////////////////////////////////////////
16910 . ////////////////////////////////////////////////////////////////////////////
16911
16912 .chapter "The manualroute router" "CHID7"
16913 .scindex IIDmanrou1 "&(manualroute)& router"
16914 .scindex IIDmanrou2 "routers" "&(manualroute)&"
16915 .cindex "domain" "manually routing"
16916 The &(manualroute)& router is so-called because it provides a way of manually
16917 routing an address according to its domain. It is mainly used when you want to
16918 route addresses to remote hosts according to your own rules, bypassing the
16919 normal DNS routing that looks up MX records. However, &(manualroute)& can also
16920 route to local transports, a facility that may be useful if you want to save
16921 messages for dial-in hosts in local files.
16922
16923 The &(manualroute)& router compares a list of domain patterns with the domain
16924 it is trying to route. If there is no match, the router declines. Each pattern
16925 has associated with it a list of hosts and some other optional data, which may
16926 include a transport. The combination of a pattern and its data is called a
16927 &"routing rule"&. For patterns that do not have an associated transport, the
16928 generic &%transport%& option must specify a transport, unless the router is
16929 being used purely for verification (see &%verify_only%&).
16930
16931 .vindex "&$host$&"
16932 In the case of verification, matching the domain pattern is sufficient for the
16933 router to accept the address. When actually routing an address for delivery,
16934 an address that matches a domain pattern is queued for the associated
16935 transport. If the transport is not a local one, a host list must be associated
16936 with the pattern; IP addresses are looked up for the hosts, and these are
16937 passed to the transport along with the mail address. For local transports, a
16938 host list is optional. If it is present, it is passed in &$host$& as a single
16939 text string.
16940
16941 The list of routing rules can be provided as an inline string in
16942 &%route_list%&, or the data can be obtained by looking up the domain in a file
16943 or database by setting &%route_data%&. Only one of these settings may appear in
16944 any one instance of &(manualroute)&. The format of routing rules is described
16945 below, following the list of private options.
16946
16947
16948 .section "Private options for manualroute" "SECTprioptman"
16949
16950 .cindex "options" "&(manualroute)& router"
16951 The private options for the &(manualroute)& router are as follows:
16952
16953 .option host_all_ignored manualroute string defer
16954 See &%host_find_failed%&.
16955
16956 .option host_find_failed manualroute string freeze
16957 This option controls what happens when &(manualroute)& tries to find an IP
16958 address for a host, and the host does not exist. The option can be set to one
16959 of the following values:
16960 .code
16961 decline
16962 defer
16963 fail
16964 freeze
16965 ignore
16966 pass
16967 .endd
16968 The default (&"freeze"&) assumes that this state is a serious configuration
16969 error. The difference between &"pass"& and &"decline"& is that the former
16970 forces the address to be passed to the next router (or the router defined by
16971 &%pass_router%&),
16972 .oindex "&%more%&"
16973 overriding &%no_more%&, whereas the latter passes the address to the next
16974 router only if &%more%& is true.
16975
16976 The value &"ignore"& causes Exim to completely ignore a host whose IP address
16977 cannot be found. If all the hosts in the list are ignored, the behaviour is
16978 controlled by the &%host_all_ignored%& option. This takes the same values
16979 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
16980
16981 The &%host_find_failed%& option applies only to a definite &"does not exist"&
16982 state; if a host lookup gets a temporary error, delivery is deferred unless the
16983 generic &%pass_on_timeout%& option is set.
16984
16985
16986 .option hosts_randomize manualroute boolean false
16987 .cindex "randomized host list"
16988 .cindex "host" "list of; randomized"
16989 If this option is set, the order of the items in a host list in a routing rule
16990 is randomized each time the list is used, unless an option in the routing rule
16991 overrides (see below). Randomizing the order of a host list can be used to do
16992 crude load sharing. However, if more than one mail address is routed by the
16993 same router to the same host list, the host lists are considered to be the same
16994 (even though they may be randomized into different orders) for the purpose of
16995 deciding whether to batch the deliveries into a single SMTP transaction.
16996
16997 When &%hosts_randomize%& is true, a host list may be split
16998 into groups whose order is separately randomized. This makes it possible to
16999 set up MX-like behaviour. The boundaries between groups are indicated by an
17000 item that is just &`+`& in the host list. For example:
17001 .code
17002 route_list = * host1:host2:host3:+:host4:host5
17003 .endd
17004 The order of the first three hosts and the order of the last two hosts is
17005 randomized for each use, but the first three always end up before the last two.
17006 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
17007 randomized host list is passed to an &(smtp)& transport that also has
17008 &%hosts_randomize set%&, the list is not re-randomized.
17009
17010
17011 .option route_data manualroute string&!! unset
17012 If this option is set, it must expand to yield the data part of a routing rule.
17013 Typically, the expansion string includes a lookup based on the domain. For
17014 example:
17015 .code
17016 route_data = ${lookup{$domain}dbm{/etc/routes}}
17017 .endd
17018 If the expansion is forced to fail, or the result is an empty string, the
17019 router declines. Other kinds of expansion failure cause delivery to be
17020 deferred.
17021
17022
17023 .option route_list manualroute "string list" unset
17024 This string is a list of routing rules, in the form defined below. Note that,
17025 unlike most string lists, the items are separated by semicolons. This is so
17026 that they may contain colon-separated host lists.
17027
17028
17029 .option same_domain_copy_routing manualroute boolean false
17030 .cindex "address" "copying routing"
17031 Addresses with the same domain are normally routed by the &(manualroute)&
17032 router to the same list of hosts. However, this cannot be presumed, because the
17033 router options and preconditions may refer to the local part of the address. By
17034 default, therefore, Exim routes each address in a message independently. DNS
17035 servers run caches, so repeated DNS lookups are not normally expensive, and in
17036 any case, personal messages rarely have more than a few recipients.
17037
17038 If you are running mailing lists with large numbers of subscribers at the same
17039 domain, and you are using a &(manualroute)& router which is independent of the
17040 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
17041 lookups for identical domains in one message. In this case, when
17042 &(manualroute)& routes an address to a remote transport, any other unrouted
17043 addresses in the message that have the same domain are automatically given the
17044 same routing without processing them independently. However, this is only done
17045 if &%headers_add%& and &%headers_remove%& are unset.
17046
17047
17048
17049
17050 .section "Routing rules in route_list" "SECID120"
17051 The value of &%route_list%& is a string consisting of a sequence of routing
17052 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
17053 entered as two semicolons. Alternatively, the list separator can be changed as
17054 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
17055 Empty rules are ignored. The format of each rule is
17056 .display
17057 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
17058 .endd
17059 The following example contains two rules, each with a simple domain pattern and
17060 no options:
17061 .code
17062 route_list = \
17063   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
17064   thes.ref.example  mail-3.ref.example:mail-4.ref.example
17065 .endd
17066 The three parts of a rule are separated by white space. The pattern and the
17067 list of hosts can be enclosed in quotes if necessary, and if they are, the
17068 usual quoting rules apply. Each rule in a &%route_list%& must start with a
17069 single domain pattern, which is the only mandatory item in the rule. The
17070 pattern is in the same format as one item in a domain list (see section
17071 &<<SECTdomainlist>>&),
17072 except that it may not be the name of an interpolated file.
17073 That is, it may be wildcarded, or a regular expression, or a file or database
17074 lookup (with semicolons doubled, because of the use of semicolon as a separator
17075 in a &%route_list%&).
17076
17077 The rules in &%route_list%& are searched in order until one of the patterns
17078 matches the domain that is being routed. The list of hosts and then options are
17079 then used as described below. If there is no match, the router declines. When
17080 &%route_list%& is set, &%route_data%& must not be set.
17081
17082
17083
17084 .section "Routing rules in route_data" "SECID121"
17085 The use of &%route_list%& is convenient when there are only a small number of
17086 routing rules. For larger numbers, it is easier to use a file or database to
17087 hold the routing information, and use the &%route_data%& option instead.
17088 The value of &%route_data%& is a list of hosts, followed by (optional) options.
17089 Most commonly, &%route_data%& is set as a string that contains an
17090 expansion lookup. For example, suppose we place two routing rules in a file
17091 like this:
17092 .code
17093 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
17094 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
17095 .endd
17096 This data can be accessed by setting
17097 .code
17098 route_data = ${lookup{$domain}lsearch{/the/file/name}}
17099 .endd
17100 Failure of the lookup results in an empty string, causing the router to
17101 decline. However, you do not have to use a lookup in &%route_data%&. The only
17102 requirement is that the result of expanding the string is a list of hosts,
17103 possibly followed by options, separated by white space. The list of hosts must
17104 be enclosed in quotes if it contains white space.
17105
17106
17107
17108
17109 .section "Format of the list of hosts" "SECID122"
17110 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
17111 always separately expanded before use. If the expansion fails, the router
17112 declines. The result of the expansion must be a colon-separated list of names
17113 and/or IP addresses, optionally also including ports. The format of each item
17114 in the list is described in the next section. The list separator can be changed
17115 as described in section &<<SECTlistconstruct>>&.
17116
17117 If the list of hosts was obtained from a &%route_list%& item, the following
17118 variables are set during its expansion:
17119
17120 .ilist
17121 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
17122 If the domain was matched against a regular expression, the numeric variables
17123 &$1$&, &$2$&, etc. may be set. For example:
17124 .code
17125 route_list = ^domain(\d+)   host-$1.text.example
17126 .endd
17127 .next
17128 &$0$& is always set to the entire domain.
17129 .next
17130 &$1$& is also set when partial matching is done in a file lookup.
17131
17132 .next
17133 .vindex "&$value$&"
17134 If the pattern that matched the domain was a lookup item, the data that was
17135 looked up is available in the expansion variable &$value$&. For example:
17136 .code
17137 route_list = lsearch;;/some/file.routes  $value
17138 .endd
17139 .endlist
17140
17141 Note the doubling of the semicolon in the pattern that is necessary because
17142 semicolon is the default route list separator.
17143
17144
17145
17146 .section "Format of one host item" "SECTformatonehostitem"
17147 Each item in the list of hosts is either a host name or an IP address,
17148 optionally with an attached port number. When no port is given, an IP address
17149 is not enclosed in brackets. When a port is specified, it overrides the port
17150 specification on the transport. The port is separated from the name or address
17151 by a colon. This leads to some complications:
17152
17153 .ilist
17154 Because colon is the default separator for the list of hosts, either
17155 the colon that specifies a port must be doubled, or the list separator must
17156 be changed. The following two examples have the same effect:
17157 .code
17158 route_list = * "host1.tld::1225 : host2.tld::1226"
17159 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
17160 .endd
17161 .next
17162 When IPv6 addresses are involved, it gets worse, because they contain
17163 colons of their own. To make this case easier, it is permitted to
17164 enclose an IP address (either v4 or v6) in square brackets if a port
17165 number follows. For example:
17166 .code
17167 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
17168 .endd
17169 .endlist
17170
17171 .section "How the list of hosts is used" "SECThostshowused"
17172 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
17173 the hosts is tried, in the order specified, when carrying out the SMTP
17174 delivery. However, the order can be changed by setting the &%hosts_randomize%&
17175 option, either on the router (see section &<<SECTprioptman>>& above), or on the
17176 transport.
17177
17178 Hosts may be listed by name or by IP address. An unadorned name in the list of
17179 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
17180 interpreted as an indirection to a sublist of hosts obtained by looking up MX
17181 records in the DNS. For example:
17182 .code
17183 route_list = *  x.y.z:p.q.r/MX:e.f.g
17184 .endd
17185 If this feature is used with a port specifier, the port must come last. For
17186 example:
17187 .code
17188 route_list = *  dom1.tld/mx::1225
17189 .endd
17190 If the &%hosts_randomize%& option is set, the order of the items in the list is
17191 randomized before any lookups are done. Exim then scans the list; for any name
17192 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
17193 be an interface on the local host and the item is not the first in the list,
17194 Exim discards it and any subsequent items. If it is the first item, what
17195 happens is controlled by the
17196 .oindex "&%self%&" "in &(manualroute)& router"
17197 &%self%& option of the router.
17198
17199 A name on the list that is followed by &`/MX`& is replaced with the list of
17200 hosts obtained by looking up MX records for the name. This is always a DNS
17201 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
17202 below) are not relevant here. The order of these hosts is determined by the
17203 preference values in the MX records, according to the usual rules. Because
17204 randomizing happens before the MX lookup, it does not affect the order that is
17205 defined by MX preferences.
17206
17207 If the local host is present in the sublist obtained from MX records, but is
17208 not the most preferred host in that list, it and any equally or less
17209 preferred hosts are removed before the sublist is inserted into the main list.
17210
17211 If the local host is the most preferred host in the MX list, what happens
17212 depends on where in the original list of hosts the &`/MX`& item appears. If it
17213 is not the first item (that is, there are previous hosts in the main list),
17214 Exim discards this name and any subsequent items in the main list.
17215
17216 If the MX item is first in the list of hosts, and the local host is the
17217 most preferred host, what happens is controlled by the &%self%& option of the
17218 router.
17219
17220 DNS failures when lookup up the MX records are treated in the same way as DNS
17221 failures when looking up IP addresses: &%pass_on_timeout%& and
17222 &%host_find_failed%& are used when relevant.
17223
17224 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
17225 whether obtained from an MX lookup or not.
17226
17227
17228
17229 .section "How the options are used" "SECThowoptused"
17230 The options are a sequence of words; in practice no more than three are ever
17231 present. One of the words can be the name of a transport; this overrides the
17232 &%transport%& option on the router for this particular routing rule only. The
17233 other words (if present) control randomization of the list of hosts on a
17234 per-rule basis, and how the IP addresses of the hosts are to be found when
17235 routing to a remote transport. These options are as follows:
17236
17237 .ilist
17238 &%randomize%&: randomize the order of the hosts in this list, overriding the
17239 setting of &%hosts_randomize%& for this routing rule only.
17240 .next
17241 &%no_randomize%&: do not randomize the order of the hosts in this list,
17242 overriding the setting of &%hosts_randomize%& for this routing rule only.
17243 .next
17244 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
17245 find IP addresses. This function may ultimately cause a DNS lookup, but it may
17246 also look in &_/etc/hosts_& or other sources of information.
17247 .next
17248 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
17249 no address records are found. If there is a temporary DNS error (such as a
17250 timeout), delivery is deferred.
17251 .endlist
17252
17253 For example:
17254 .code
17255 route_list = domain1  host1:host2:host3  randomize bydns;\
17256              domain2  host4:host5
17257 .endd
17258 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
17259 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
17260 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
17261 or &[gethostbyname()]&, and the result of the lookup is the result of that
17262 call.
17263
17264 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
17265 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
17266 instead of TRY_AGAIN. That is why the default action is to try a DNS
17267 lookup first. Only if that gives a definite &"no such host"& is the local
17268 function called.
17269
17270
17271
17272 If no IP address for a host can be found, what happens is controlled by the
17273 &%host_find_failed%& option.
17274
17275 .vindex "&$host$&"
17276 When an address is routed to a local transport, IP addresses are not looked up.
17277 The host list is passed to the transport in the &$host$& variable.
17278
17279
17280
17281 .section "Manualroute examples" "SECID123"
17282 In some of the examples that follow, the presence of the &%remote_smtp%&
17283 transport, as defined in the default configuration file, is assumed:
17284
17285 .ilist
17286 .cindex "smart host" "example router"
17287 The &(manualroute)& router can be used to forward all external mail to a
17288 &'smart host'&. If you have set up, in the main part of the configuration, a
17289 named domain list that contains your local domains, for example:
17290 .code
17291 domainlist local_domains = my.domain.example
17292 .endd
17293 You can arrange for all other domains to be routed to a smart host by making
17294 your first router something like this:
17295 .code
17296 smart_route:
17297   driver = manualroute
17298   domains = !+local_domains
17299   transport = remote_smtp
17300   route_list = * smarthost.ref.example
17301 .endd
17302 This causes all non-local addresses to be sent to the single host
17303 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
17304 they are tried in order
17305 (but you can use &%hosts_randomize%& to vary the order each time).
17306 Another way of configuring the same thing is this:
17307 .code
17308 smart_route:
17309   driver = manualroute
17310   transport = remote_smtp
17311   route_list = !+local_domains  smarthost.ref.example
17312 .endd
17313 There is no difference in behaviour between these two routers as they stand.
17314 However, they behave differently if &%no_more%& is added to them. In the first
17315 example, the router is skipped if the domain does not match the &%domains%&
17316 precondition; the following router is always tried. If the router runs, it
17317 always matches the domain and so can never decline. Therefore, &%no_more%&
17318 would have no effect. In the second case, the router is never skipped; it
17319 always runs. However, if it doesn't match the domain, it declines. In this case
17320 &%no_more%& would prevent subsequent routers from running.
17321
17322 .next
17323 .cindex "mail hub example"
17324 A &'mail hub'& is a host which receives mail for a number of domains via MX
17325 records in the DNS and delivers it via its own private routing mechanism. Often
17326 the final destinations are behind a firewall, with the mail hub being the one
17327 machine that can connect to machines both inside and outside the firewall. The
17328 &(manualroute)& router is usually used on a mail hub to route incoming messages
17329 to the correct hosts. For a small number of domains, the routing can be inline,
17330 using the &%route_list%& option, but for a larger number a file or database
17331 lookup is easier to manage.
17332
17333 If the domain names are in fact the names of the machines to which the mail is
17334 to be sent by the mail hub, the configuration can be quite simple. For
17335 example:
17336 .code
17337 hub_route:
17338   driver = manualroute
17339   transport = remote_smtp
17340   route_list = *.rhodes.tvs.example  $domain
17341 .endd
17342 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
17343 whose names are the same as the mail domains. A similar approach can be taken
17344 if the host name can be obtained from the domain name by a string manipulation
17345 that the expansion facilities can handle. Otherwise, a lookup based on the
17346 domain can be used to find the host:
17347 .code
17348 through_firewall:
17349   driver = manualroute
17350   transport = remote_smtp
17351   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
17352 .endd
17353 The result of the lookup must be the name or IP address of the host (or
17354 hosts) to which the address is to be routed. If the lookup fails, the route
17355 data is empty, causing the router to decline. The address then passes to the
17356 next router.
17357
17358 .next
17359 .cindex "batched SMTP output example"
17360 .cindex "SMTP" "batched outgoing; example"
17361 You can use &(manualroute)& to deliver messages to pipes or files in batched
17362 SMTP format for onward transportation by some other means. This is one way of
17363 storing mail for a dial-up host when it is not connected. The route list entry
17364 can be as simple as a single domain name in a configuration like this:
17365 .code
17366 save_in_file:
17367   driver = manualroute
17368   transport = batchsmtp_appendfile
17369   route_list = saved.domain.example
17370 .endd
17371 though often a pattern is used to pick up more than one domain. If there are
17372 several domains or groups of domains with different transport requirements,
17373 different transports can be listed in the routing information:
17374 .code
17375 save_in_file:
17376   driver = manualroute
17377   route_list = \
17378     *.saved.domain1.example  $domain  batch_appendfile; \
17379     *.saved.domain2.example  \
17380       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
17381       batch_pipe
17382 .endd
17383 .vindex "&$domain$&"
17384 .vindex "&$host$&"
17385 The first of these just passes the domain in the &$host$& variable, which
17386 doesn't achieve much (since it is also in &$domain$&), but the second does a
17387 file lookup to find a value to pass, causing the router to decline to handle
17388 the address if the lookup fails.
17389
17390 .next
17391 .cindex "UUCP" "example of router for"
17392 Routing mail directly to UUCP software is a specific case of the use of
17393 &(manualroute)& in a gateway to another mail environment. This is an example of
17394 one way it can be done:
17395 .code
17396 # Transport
17397 uucp:
17398   driver = pipe
17399   user = nobody
17400   command = /usr/local/bin/uux -r - \
17401     ${substr_-5:$host}!rmail ${local_part}
17402   return_fail_output = true
17403
17404 # Router
17405 uucphost:
17406   transport = uucp
17407   driver = manualroute
17408   route_data = \
17409     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
17410 .endd
17411 The file &_/usr/local/exim/uucphosts_& contains entries like
17412 .code
17413 darksite.ethereal.example:           darksite.UUCP
17414 .endd
17415 It can be set up more simply without adding and removing &".UUCP"& but this way
17416 makes clear the distinction between the domain name
17417 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
17418 .endlist
17419 .ecindex IIDmanrou1
17420 .ecindex IIDmanrou2
17421
17422
17423
17424
17425
17426
17427
17428
17429 . ////////////////////////////////////////////////////////////////////////////
17430 . ////////////////////////////////////////////////////////////////////////////
17431
17432 .chapter "The queryprogram router" "CHAPdriverlast"
17433 .scindex IIDquerou1 "&(queryprogram)& router"
17434 .scindex IIDquerou2 "routers" "&(queryprogram)&"
17435 .cindex "routing" "by external program"
17436 The &(queryprogram)& router routes an address by running an external command
17437 and acting on its output. This is an expensive way to route, and is intended
17438 mainly for use in lightly-loaded systems, or for performing experiments.
17439 However, if it is possible to use the precondition options (&%domains%&,
17440 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
17441 be used in special cases, even on a busy host. There are the following private
17442 options:
17443 .cindex "options" "&(queryprogram)& router"
17444
17445 .option command queryprogram string&!! unset
17446 This option must be set. It specifies the command that is to be run. The
17447 command is split up into a command name and arguments, and then each is
17448 expanded separately (exactly as for a &(pipe)& transport, described in chapter
17449 &<<CHAPpipetransport>>&).
17450
17451
17452 .option command_group queryprogram string unset
17453 .cindex "gid (group id)" "in &(queryprogram)& router"
17454 This option specifies a gid to be set when running the command while routing an
17455 address for deliver. It must be set if &%command_user%& specifies a numerical
17456 uid. If it begins with a digit, it is interpreted as the numerical value of the
17457 gid. Otherwise it is looked up using &[getgrnam()]&.
17458
17459
17460 .option command_user queryprogram string unset
17461 .cindex "uid (user id)" "for &(queryprogram)&"
17462 This option must be set. It specifies the uid which is set when running the
17463 command while routing an address for delivery. If the value begins with a digit,
17464 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
17465 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
17466 not set, a value for the gid also.
17467
17468 &*Warning:*& Changing uid and gid is possible only when Exim is running as
17469 root, which it does during a normal delivery in a conventional configuration.
17470 However, when an address is being verified during message reception, Exim is
17471 usually running as the Exim user, not as root. If the &(queryprogram)& router
17472 is called from a non-root process, Exim cannot change uid or gid before running
17473 the command. In this circumstance the command runs under the current uid and
17474 gid.
17475
17476
17477 .option current_directory queryprogram string /
17478 This option specifies an absolute path which is made the current directory
17479 before running the command.
17480
17481
17482 .option timeout queryprogram time 1h
17483 If the command does not complete within the timeout period, its process group
17484 is killed and the message is frozen. A value of zero time specifies no
17485 timeout.
17486
17487
17488 The standard output of the command is connected to a pipe, which is read when
17489 the command terminates. It should consist of a single line of output,
17490 containing up to five fields, separated by white space. The maximum length of
17491 the line is 1023 characters. Longer lines are silently truncated. The first
17492 field is one of the following words (case-insensitive):
17493
17494 .ilist
17495 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
17496 below).
17497 .next
17498 &'Decline'&: the router declines; pass the address to the next router, unless
17499 &%no_more%& is set.
17500 .next
17501 &'Fail'&: routing failed; do not pass the address to any more routers. Any
17502 subsequent text on the line is an error message. If the router is run as part
17503 of address verification during an incoming SMTP message, the message is
17504 included in the SMTP response.
17505 .next
17506 &'Defer'&: routing could not be completed at this time; try again later. Any
17507 subsequent text on the line is an error message which is logged. It is not
17508 included in any SMTP response.
17509 .next
17510 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
17511 .next
17512 &'Pass'&: pass the address to the next router (or the router specified by
17513 &%pass_router%&), overriding &%no_more%&.
17514 .next
17515 &'Redirect'&: the message is redirected. The remainder of the line is a list of
17516 new addresses, which are routed independently, starting with the first router,
17517 or the router specified by &%redirect_router%&, if set.
17518 .endlist
17519
17520 When the first word is &'accept'&, the remainder of the line consists of a
17521 number of keyed data values, as follows (split into two lines here, to fit on
17522 the page):
17523 .code
17524 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
17525 LOOKUP=byname|bydns DATA=<text>
17526 .endd
17527 The data items can be given in any order, and all are optional. If no transport
17528 is included, the transport specified by the generic &%transport%& option is
17529 used. The list of hosts and the lookup type are needed only if the transport is
17530 an &(smtp)& transport that does not itself supply a list of hosts.
17531
17532 The format of the list of hosts is the same as for the &(manualroute)& router.
17533 As well as host names and IP addresses with optional port numbers, as described
17534 in section &<<SECTformatonehostitem>>&, it may contain names followed by
17535 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
17536 (see section &<<SECThostshowused>>&).
17537
17538 If the lookup type is not specified, Exim behaves as follows when trying to
17539 find an IP address for each host: First, a DNS lookup is done. If this yields
17540 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
17541 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
17542 result of the lookup is the result of that call.
17543
17544 .vindex "&$address_data$&"
17545 If the DATA field is set, its value is placed in the &$address_data$&
17546 variable. For example, this return line
17547 .code
17548 accept hosts=x1.y.example:x2.y.example data="rule1"
17549 .endd
17550 routes the address to the default transport, passing a list of two hosts. When
17551 the transport runs, the string &"rule1"& is in &$address_data$&.
17552 .ecindex IIDquerou1
17553 .ecindex IIDquerou2
17554
17555
17556
17557
17558 . ////////////////////////////////////////////////////////////////////////////
17559 . ////////////////////////////////////////////////////////////////////////////
17560
17561 .chapter "The redirect router" "CHAPredirect"
17562 .scindex IIDredrou1 "&(redirect)& router"
17563 .scindex IIDredrou2 "routers" "&(redirect)&"
17564 .cindex "alias file" "in a &(redirect)& router"
17565 .cindex "address redirection" "&(redirect)& router"
17566 The &(redirect)& router handles several kinds of address redirection. Its most
17567 common uses are for resolving local part aliases from a central alias file
17568 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
17569 files, but it has many other potential uses. The incoming address can be
17570 redirected in several different ways:
17571
17572 .ilist
17573 It can be replaced by one or more new addresses which are themselves routed
17574 independently.
17575 .next
17576 It can be routed to be delivered to a given file or directory.
17577 .next
17578 It can be routed to be delivered to a specified pipe command.
17579 .next
17580 It can cause an automatic reply to be generated.
17581 .next
17582 It can be forced to fail, optionally with a custom error message.
17583 .next
17584 It can be temporarily deferred, optionally with a custom message.
17585 .next
17586 It can be discarded.
17587 .endlist
17588
17589 The generic &%transport%& option must not be set for &(redirect)& routers.
17590 However, there are some private options which define transports for delivery to
17591 files and pipes, and for generating autoreplies. See the &%file_transport%&,
17592 &%pipe_transport%& and &%reply_transport%& descriptions below.
17593
17594
17595
17596 .section "Redirection data" "SECID124"
17597 The router operates by interpreting a text string which it obtains either by
17598 expanding the contents of the &%data%& option, or by reading the entire
17599 contents of a file whose name is given in the &%file%& option. These two
17600 options are mutually exclusive. The first is commonly used for handling system
17601 aliases, in a configuration like this:
17602 .code
17603 system_aliases:
17604   driver = redirect
17605   data = ${lookup{$local_part}lsearch{/etc/aliases}}
17606 .endd
17607 If the lookup fails, the expanded string in this example is empty. When the
17608 expansion of &%data%& results in an empty string, the router declines. A forced
17609 expansion failure also causes the router to decline; other expansion failures
17610 cause delivery to be deferred.
17611
17612 A configuration using &%file%& is commonly used for handling users'
17613 &_.forward_& files, like this:
17614 .code
17615 userforward:
17616   driver = redirect
17617   check_local_user
17618   file = $home/.forward
17619   no_verify
17620 .endd
17621 If the file does not exist, or causes no action to be taken (for example, it is
17622 empty or consists only of comments), the router declines. &*Warning*&: This
17623 is not the case when the file contains syntactically valid items that happen to
17624 yield empty addresses, for example, items containing only RFC 2822 address
17625 comments.
17626
17627
17628
17629 .section "Forward files and address verification" "SECID125"
17630 .cindex "address redirection" "while verifying"
17631 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
17632 &_.forward_& files, as in the example above. There are two reasons for this:
17633
17634 .ilist
17635 When Exim is receiving an incoming SMTP message from a remote host, it is
17636 running under the Exim uid, not as root. Exim is unable to change uid to read
17637 the file as the user, and it may not be able to read it as the Exim user. So in
17638 practice the router may not be able to operate.
17639 .next
17640 However, even when the router can operate, the existence of a &_.forward_& file
17641 is unimportant when verifying an address. What should be checked is whether the
17642 local part is a valid user name or not. Cutting out the redirection processing
17643 saves some resources.
17644 .endlist
17645
17646
17647
17648
17649
17650
17651 .section "Interpreting redirection data" "SECID126"
17652 .cindex "Sieve filter" "specifying in redirection data"
17653 .cindex "filter" "specifying in redirection data"
17654 The contents of the data string, whether obtained from &%data%& or &%file%&,
17655 can be interpreted in two different ways:
17656
17657 .ilist
17658 If the &%allow_filter%& option is set true, and the data begins with the text
17659 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
17660 &'filtering'& instructions in the form of an Exim or Sieve filter file,
17661 respectively. Details of the syntax and semantics of filter files are described
17662 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
17663 document is intended for use by end users.
17664 .next
17665 Otherwise, the data must be a comma-separated list of redirection items, as
17666 described in the next section.
17667 .endlist
17668
17669 When a message is redirected to a file (a &"mail folder"&), the file name given
17670 in a non-filter redirection list must always be an absolute path. A filter may
17671 generate a relative path &-- how this is handled depends on the transport's
17672 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
17673 for the &(appendfile)& transport.
17674
17675
17676
17677 .section "Items in a non-filter redirection list" "SECTitenonfilred"
17678 .cindex "address redirection" "non-filter list items"
17679 When the redirection data is not an Exim or Sieve filter, for example, if it
17680 comes from a conventional alias or forward file, it consists of a list of
17681 addresses, file names, pipe commands, or certain special items (see section
17682 &<<SECTspecitredli>>& below). The special items can be individually enabled or
17683 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
17684 depending on their default values. The items in the list are separated by
17685 commas or newlines.
17686 If a comma is required in an item, the entire item must be enclosed in double
17687 quotes.
17688
17689 Lines starting with a # character are comments, and are ignored, and # may
17690 also appear following a comma, in which case everything between the # and the
17691 next newline character is ignored.
17692
17693 If an item is entirely enclosed in double quotes, these are removed. Otherwise
17694 double quotes are retained because some forms of mail address require their use
17695 (but never to enclose the entire address). In the following description,
17696 &"item"& refers to what remains after any surrounding double quotes have been
17697 removed.
17698
17699 .vindex "&$local_part$&"
17700 &*Warning*&: If you use an Exim expansion to construct a redirection address,
17701 and the expansion contains a reference to &$local_part$&, you should make use
17702 of the &%quote_local_part%& expansion operator, in case the local part contains
17703 special characters. For example, to redirect all mail for the domain
17704 &'obsolete.example'&, retaining the existing local part, you could use this
17705 setting:
17706 .code
17707 data = ${quote_local_part:$local_part}@newdomain.example
17708 .endd
17709
17710
17711 .section "Redirecting to a local mailbox" "SECTredlocmai"
17712 .cindex "routing" "loops in"
17713 .cindex "loop" "while routing, avoidance of"
17714 .cindex "address redirection" "to local mailbox"
17715 A redirection item may safely be the same as the address currently under
17716 consideration. This does not cause a routing loop, because a router is
17717 automatically skipped if any ancestor of the address that is being processed
17718 is the same as the current address and was processed by the current router.
17719 Such an address is therefore passed to the following routers, so it is handled
17720 as if there were no redirection. When making this loop-avoidance test, the
17721 complete local part, including any prefix or suffix, is used.
17722
17723 .cindex "address redirection" "local part without domain"
17724 Specifying the same local part without a domain is a common usage in personal
17725 filter files when the user wants to have messages delivered to the local
17726 mailbox and also forwarded elsewhere. For example, the user whose login is
17727 &'cleo'& might have a &_.forward_& file containing this:
17728 .code
17729 cleo, cleopatra@egypt.example
17730 .endd
17731 .cindex "backslash in alias file"
17732 .cindex "alias file" "backslash in"
17733 For compatibility with other MTAs, such unqualified local parts may be
17734 preceded by &"\"&, but this is not a requirement for loop prevention. However,
17735 it does make a difference if more than one domain is being handled
17736 synonymously.
17737
17738 If an item begins with &"\"& and the rest of the item parses as a valid RFC
17739 2822 address that does not include a domain, the item is qualified using the
17740 domain of the incoming address. In the absence of a leading &"\"&, unqualified
17741 addresses are qualified using the value in &%qualify_recipient%&, but you can
17742 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
17743
17744 Care must be taken if there are alias names for local users.
17745 Consider an MTA handling a single local domain where the system alias file
17746 contains:
17747 .code
17748 Sam.Reman: spqr
17749 .endd
17750 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
17751 messages in the local mailbox, and also forward copies elsewhere. He creates
17752 this forward file:
17753 .code
17754 Sam.Reman, spqr@reme.elsewhere.example
17755 .endd
17756 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
17757 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
17758 second time round, because it has previously routed it,
17759 and the following routers presumably cannot handle the alias. The forward file
17760 should really contain
17761 .code
17762 spqr, spqr@reme.elsewhere.example
17763 .endd
17764 but because this is such a common error, the &%check_ancestor%& option (see
17765 below) exists to provide a way to get round it. This is normally set on a
17766 &(redirect)& router that is handling users' &_.forward_& files.
17767
17768
17769
17770 .section "Special items in redirection lists" "SECTspecitredli"
17771 In addition to addresses, the following types of item may appear in redirection
17772 lists (that is, in non-filter redirection data):
17773
17774 .ilist
17775 .cindex "pipe" "in redirection list"
17776 .cindex "address redirection" "to pipe"
17777 An item is treated as a pipe command if it begins with &"|"& and does not parse
17778 as a valid RFC 2822 address that includes a domain. A transport for running the
17779 command must be specified by the &%pipe_transport%& option.
17780 Normally, either the router or the transport specifies a user and a group under
17781 which to run the delivery. The default is to use the Exim user and group.
17782
17783 Single or double quotes can be used for enclosing the individual arguments of
17784 the pipe command; no interpretation of escapes is done for single quotes. If
17785 the command contains a comma character, it is necessary to put the whole item
17786 in double quotes, for example:
17787 .code
17788 "|/some/command ready,steady,go"
17789 .endd
17790 since items in redirection lists are terminated by commas. Do not, however,
17791 quote just the command. An item such as
17792 .code
17793 |"/some/command ready,steady,go"
17794 .endd
17795 is interpreted as a pipe with a rather strange command name, and no arguments.
17796
17797 .next
17798 .cindex "file" "in redirection list"
17799 .cindex "address redirection" "to file"
17800 An item is interpreted as a path name if it begins with &"/"& and does not
17801 parse as a valid RFC 2822 address that includes a domain. For example,
17802 .code
17803 /home/world/minbari
17804 .endd
17805 is treated as a file name, but
17806 .code
17807 /s=molari/o=babylon/@x400gate.way
17808 .endd
17809 is treated as an address. For a file name, a transport must be specified using
17810 the &%file_transport%& option. However, if the generated path name ends with a
17811 forward slash character, it is interpreted as a directory name rather than a
17812 file name, and &%directory_transport%& is used instead.
17813
17814 Normally, either the router or the transport specifies a user and a group under
17815 which to run the delivery. The default is to use the Exim user and group.
17816
17817 .cindex "&_/dev/null_&"
17818 However, if a redirection item is the path &_/dev/null_&, delivery to it is
17819 bypassed at a high level, and the log entry shows &"**bypassed**"&
17820 instead of a transport name. In this case the user and group are not used.
17821
17822 .next
17823 .cindex "included address list"
17824 .cindex "address redirection" "included external list"
17825 If an item is of the form
17826 .code
17827 :include:<path name>
17828 .endd
17829 a list of further items is taken from the given file and included at that
17830 point. &*Note*&: Such a file can not be a filter file; it is just an
17831 out-of-line addition to the list. The items in the included list are separated
17832 by commas or newlines and are not subject to expansion. If this is the first
17833 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
17834 the alias name. This example is incorrect:
17835 .code
17836 list1    :include:/opt/lists/list1
17837 .endd
17838 It must be given as
17839 .code
17840 list1:   :include:/opt/lists/list1
17841 .endd
17842 .next
17843 .cindex "address redirection" "to black hole"
17844 Sometimes you want to throw away mail to a particular local part. Making the
17845 &%data%& option expand to an empty string does not work, because that causes
17846 the router to decline. Instead, the alias item
17847 .cindex "black hole"
17848 .cindex "abandoning mail"
17849 &':blackhole:'& can be used. It does what its name implies. No delivery is
17850 done, and no error message is generated. This has the same effect as specifing
17851 &_/dev/null_& as a destination, but it can be independently disabled.
17852
17853 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
17854 delivery is done for the original local part, even if other redirection items
17855 are present. If you are generating a multi-item list (for example, by reading a
17856 database) and need the ability to provide a no-op item, you must use
17857 &_/dev/null_&.
17858
17859 .next
17860 .cindex "delivery" "forcing failure"
17861 .cindex "delivery" "forcing deferral"
17862 .cindex "failing delivery" "forcing"
17863 .cindex "deferred delivery, forcing"
17864 .cindex "customizing" "failure message"
17865 An attempt to deliver a particular address can be deferred or forced to fail by
17866 redirection items of the form
17867 .code
17868 :defer:
17869 :fail:
17870 .endd
17871 respectively. When a redirection list contains such an item, it applies
17872 to the entire redirection; any other items in the list are ignored. Any
17873 text following &':fail:'& or &':defer:'& is placed in the error text
17874 associated with the failure. For example, an alias file might contain:
17875 .code
17876 X.Employee:  :fail: Gone away, no forwarding address
17877 .endd
17878 In the case of an address that is being verified from an ACL or as the subject
17879 of a
17880 .cindex "VRFY" "error text, display of"
17881 VRFY command, the text is included in the SMTP error response by
17882 default.
17883 .cindex "EXPN" "error text, display of"
17884 The text is not included in the response to an EXPN command. In non-SMTP cases
17885 the text is included in the error message that Exim generates.
17886
17887 .cindex "SMTP" "error codes"
17888 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
17889 &':fail:'&. However, if the message starts with three digits followed by a
17890 space, optionally followed by an extended code of the form &'n.n.n'&, also
17891 followed by a space, and the very first digit is the same as the default error
17892 code, the code from the message is used instead. If the very first digit is
17893 incorrect, a panic error is logged, and the default code is used. You can
17894 suppress the use of the supplied code in a redirect router by setting the
17895 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
17896 ignored.
17897
17898 .vindex "&$acl_verify_message$&"
17899 In an ACL, an explicitly provided message overrides the default, but the
17900 default message is available in the variable &$acl_verify_message$& and can
17901 therefore be included in a custom message if this is desired.
17902
17903 Normally the error text is the rest of the redirection list &-- a comma does
17904 not terminate it &-- but a newline does act as a terminator. Newlines are not
17905 normally present in alias expansions. In &(lsearch)& lookups they are removed
17906 as part of the continuation process, but they may exist in other kinds of
17907 lookup and in &':include:'& files.
17908
17909 During routing for message delivery (as opposed to verification), a redirection
17910 containing &':fail:'& causes an immediate failure of the incoming address,
17911 whereas &':defer:'& causes the message to remain on the queue so that a
17912 subsequent delivery attempt can happen at a later time. If an address is
17913 deferred for too long, it will ultimately fail, because the normal retry
17914 rules still apply.
17915
17916 .next
17917 .cindex "alias file" "exception to default"
17918 Sometimes it is useful to use a single-key search type with a default (see
17919 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
17920 for exceptions to the default. These can be handled by aliasing them to
17921 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
17922 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
17923 results in an empty redirection list has the same effect.
17924 .endlist
17925
17926
17927 .section "Duplicate addresses" "SECTdupaddr"
17928 .cindex "duplicate addresses"
17929 .cindex "address duplicate, discarding"
17930 .cindex "pipe" "duplicated"
17931 Exim removes duplicate addresses from the list to which it is delivering, so as
17932 to deliver just one copy to each address. This does not apply to deliveries
17933 routed to pipes by different immediate parent addresses, but an indirect
17934 aliasing scheme of the type
17935 .code
17936 pipe:       |/some/command $local_part
17937 localpart1: pipe
17938 localpart2: pipe
17939 .endd
17940 does not work with a message that is addressed to both local parts, because
17941 when the second is aliased to the intermediate local part &"pipe"& it gets
17942 discarded as being the same as a previously handled address. However, a scheme
17943 such as
17944 .code
17945 localpart1: |/some/command $local_part
17946 localpart2: |/some/command $local_part
17947 .endd
17948 does result in two different pipe deliveries, because the immediate parents of
17949 the pipes are distinct.
17950
17951
17952
17953 .section "Repeated redirection expansion" "SECID128"
17954 .cindex "repeated redirection expansion"
17955 .cindex "address redirection" "repeated for each delivery attempt"
17956 When a message cannot be delivered to all of its recipients immediately,
17957 leading to two or more delivery attempts, redirection expansion is carried out
17958 afresh each time for those addresses whose children were not all previously
17959 delivered. If redirection is being used as a mailing list, this can lead to new
17960 members of the list receiving copies of old messages. The &%one_time%& option
17961 can be used to avoid this.
17962
17963
17964 .section "Errors in redirection lists" "SECID129"
17965 .cindex "address redirection" "errors"
17966 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
17967 error is skipped, and an entry is written to the main log. This may be useful
17968 for mailing lists that are automatically managed. Otherwise, if an error is
17969 detected while generating the list of new addresses, the original address is
17970 deferred. See also &%syntax_errors_to%&.
17971
17972
17973
17974 .section "Private options for the redirect router" "SECID130"
17975
17976 .cindex "options" "&(redirect)& router"
17977 The private options for the &(redirect)& router are as follows:
17978
17979
17980 .option allow_defer redirect boolean false
17981 Setting this option allows the use of &':defer:'& in non-filter redirection
17982 data, or the &%defer%& command in an Exim filter file.
17983
17984
17985 .option allow_fail redirect boolean false
17986 .cindex "failing delivery" "from filter"
17987 If this option is true, the &':fail:'& item can be used in a redirection list,
17988 and the &%fail%& command may be used in an Exim filter file.
17989
17990
17991 .option allow_filter redirect boolean false
17992 .cindex "filter" "enabling use of"
17993 .cindex "Sieve filter" "enabling use of"
17994 Setting this option allows Exim to interpret redirection data that starts with
17995 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
17996 are some features of Exim filter files that some administrators may wish to
17997 lock out; see the &%forbid_filter_%&&'xxx'& options below.
17998
17999 It is also possible to lock out Exim filters or Sieve filters while allowing
18000 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
18001
18002
18003 The filter is run using the uid and gid set by the generic &%user%& and
18004 &%group%& options. These take their defaults from the password data if
18005 &%check_local_user%& is set, so in the normal case of users' personal filter
18006 files, the filter is run as the relevant user. When &%allow_filter%& is set
18007 true, Exim insists that either &%check_local_user%& or &%user%& is set.
18008
18009
18010
18011 .option allow_freeze redirect boolean false
18012 .cindex "freezing messages" "allowing in filter"
18013 Setting this option allows the use of the &%freeze%& command in an Exim filter.
18014 This command is more normally encountered in system filters, and is disabled by
18015 default for redirection filters because it isn't something you usually want to
18016 let ordinary users do.
18017
18018
18019
18020 .option check_ancestor redirect boolean false
18021 This option is concerned with handling generated addresses that are the same
18022 as some address in the list of redirection ancestors of the current address.
18023 Although it is turned off by default in the code, it is set in the default
18024 configuration file for handling users' &_.forward_& files. It is recommended
18025 for this use of the &(redirect)& router.
18026
18027 When &%check_ancestor%& is set, if a generated address (including the domain)
18028 is the same as any ancestor of the current address, it is replaced by a copy of
18029 the current address. This helps in the case where local part A is aliased to B,
18030 and B has a &_.forward_& file pointing back to A. For example, within a single
18031 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
18032 &_&~jb/.forward_& contains:
18033 .code
18034 \Joe.Bloggs, <other item(s)>
18035 .endd
18036 Without the &%check_ancestor%& setting, either local part (&"jb"& or
18037 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
18038 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
18039 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
18040 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
18041 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
18042 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
18043 original address. See also the &%repeat_use%& option below.
18044
18045
18046 .option check_group redirect boolean "see below"
18047 When the &%file%& option is used, the group owner of the file is checked only
18048 when this option is set. The permitted groups are those listed in the
18049 &%owngroups%& option, together with the user's default group if
18050 &%check_local_user%& is set. If the file has the wrong group, routing is
18051 deferred. The default setting for this option is true if &%check_local_user%&
18052 is set and the &%modemask%& option permits the group write bit, or if the
18053 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
18054
18055
18056
18057 .option check_owner redirect boolean "see below"
18058 When the &%file%& option is used, the owner of the file is checked only when
18059 this option is set. If &%check_local_user%& is set, the local user is
18060 permitted; otherwise the owner must be one of those listed in the &%owners%&
18061 option. The default value for this option is true if &%check_local_user%& or
18062 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
18063
18064
18065 .option data redirect string&!! unset
18066 This option is mutually exclusive with &%file%&. One or other of them must be
18067 set, but not both. The contents of &%data%& are expanded, and then used as the
18068 list of forwarding items, or as a set of filtering instructions. If the
18069 expansion is forced to fail, or the result is an empty string or a string that
18070 has no effect (consists entirely of comments), the router declines.
18071
18072 When filtering instructions are used, the string must begin with &"#Exim
18073 filter"&, and all comments in the string, including this initial one, must be
18074 terminated with newline characters. For example:
18075 .code
18076 data = #Exim filter\n\
18077        if $h_to: contains Exim then save $home/mail/exim endif
18078 .endd
18079 If you are reading the data from a database where newlines cannot be included,
18080 you can use the &${sg}$& expansion item to turn the escape string of your
18081 choice into a newline.
18082
18083
18084 .option directory_transport redirect string&!! unset
18085 A &(redirect)& router sets up a direct delivery to a directory when a path name
18086 ending with a slash is specified as a new &"address"&. The transport used is
18087 specified by this option, which, after expansion, must be the name of a
18088 configured transport. This should normally be an &(appendfile)& transport.
18089
18090
18091 .option file redirect string&!! unset
18092 This option specifies the name of a file that contains the redirection data. It
18093 is mutually exclusive with the &%data%& option. The string is expanded before
18094 use; if the expansion is forced to fail, the router declines. Other expansion
18095 failures cause delivery to be deferred. The result of a successful expansion
18096 must be an absolute path. The entire file is read and used as the redirection
18097 data. If the data is an empty string or a string that has no effect (consists
18098 entirely of comments), the router declines.
18099
18100 .cindex "NFS" "checking for file existence"
18101 If the attempt to open the file fails with a &"does not exist"& error, Exim
18102 runs a check on the containing directory,
18103 unless &%ignore_enotdir%& is true (see below).
18104 If the directory does not appear to exist, delivery is deferred. This can
18105 happen when users' &_.forward_& files are in NFS-mounted directories, and there
18106 is a mount problem. If the containing directory does exist, but the file does
18107 not, the router declines.
18108
18109
18110 .option file_transport redirect string&!! unset
18111 .vindex "&$address_file$&"
18112 A &(redirect)& router sets up a direct delivery to a file when a path name not
18113 ending in a slash is specified as a new &"address"&. The transport used is
18114 specified by this option, which, after expansion, must be the name of a
18115 configured transport. This should normally be an &(appendfile)& transport. When
18116 it is running, the file name is in &$address_file$&.
18117
18118
18119 .option filter_prepend_home redirect boolean true
18120 When this option is true, if a &(save)& command in an Exim filter specifies a
18121 relative path, and &$home$& is defined, it is automatically prepended to the
18122 relative path. If this option is set false, this action does not happen. The
18123 relative path is then passed to the transport unmodified.
18124
18125
18126 .option forbid_blackhole redirect boolean false
18127 If this option is true, the &':blackhole:'& item may not appear in a
18128 redirection list.
18129
18130
18131 .option forbid_exim_filter redirect boolean false
18132 If this option is set true, only Sieve filters are permitted when
18133 &%allow_filter%& is true.
18134
18135
18136
18137
18138 .option forbid_file redirect boolean false
18139 .cindex "delivery" "to file; forbidding"
18140 .cindex "Sieve filter" "forbidding delivery to a file"
18141 .cindex "Sieve filter" "&""keep""& facility; disabling"
18142 If this option is true, this router may not generate a new address that
18143 specifies delivery to a local file or directory, either from a filter or from a
18144 conventional forward file. This option is forced to be true if &%one_time%& is
18145 set. It applies to Sieve filters as well as to Exim filters, but if true, it
18146 locks out the Sieve's &"keep"& facility.
18147
18148
18149 .option forbid_filter_dlfunc redirect boolean false
18150 .cindex "filter" "locking out certain features"
18151 If this option is true, string expansions in Exim filters are not allowed to
18152 make use of the &%dlfunc%& expansion facility to run dynamically loaded
18153 functions.
18154
18155 .option forbid_filter_existstest redirect boolean false
18156 .cindex "expansion" "statting a file"
18157 If this option is true, string expansions in Exim filters are not allowed to
18158 make use of the &%exists%& condition or the &%stat%& expansion item.
18159
18160 .option forbid_filter_logwrite redirect boolean false
18161 If this option is true, use of the logging facility in Exim filters is not
18162 permitted. Logging is in any case available only if the filter is being run
18163 under some unprivileged uid (which is normally the case for ordinary users'
18164 &_.forward_& files).
18165
18166
18167 .option forbid_filter_lookup redirect boolean false
18168 If this option is true, string expansions in Exim filter files are not allowed
18169 to make use of &%lookup%& items.
18170
18171
18172 .option forbid_filter_perl redirect boolean false
18173 This option has an effect only if Exim is built with embedded Perl support. If
18174 it is true, string expansions in Exim filter files are not allowed to make use
18175 of the embedded Perl support.
18176
18177
18178 .option forbid_filter_readfile redirect boolean false
18179 If this option is true, string expansions in Exim filter files are not allowed
18180 to make use of &%readfile%& items.
18181
18182
18183 .option forbid_filter_readsocket redirect boolean false
18184 If this option is true, string expansions in Exim filter files are not allowed
18185 to make use of &%readsocket%& items.
18186
18187
18188 .option forbid_filter_reply redirect boolean false
18189 If this option is true, this router may not generate an automatic reply
18190 message. Automatic replies can be generated only from Exim or Sieve filter
18191 files, not from traditional forward files. This option is forced to be true if
18192 &%one_time%& is set.
18193
18194
18195 .option forbid_filter_run redirect boolean false
18196 If this option is true, string expansions in Exim filter files are not allowed
18197 to make use of &%run%& items.
18198
18199
18200 .option forbid_include redirect boolean false
18201 If this option is true, items of the form
18202 .code
18203 :include:<path name>
18204 .endd
18205 are not permitted in non-filter redirection lists.
18206
18207
18208 .option forbid_pipe redirect boolean false
18209 .cindex "delivery" "to pipe; forbidding"
18210 If this option is true, this router may not generate a new address which
18211 specifies delivery to a pipe, either from an Exim filter or from a conventional
18212 forward file. This option is forced to be true if &%one_time%& is set.
18213
18214
18215 .option forbid_sieve_filter redirect boolean false
18216 If this option is set true, only Exim filters are permitted when
18217 &%allow_filter%& is true.
18218
18219
18220 .cindex "SMTP" "error codes"
18221 .option forbid_smtp_code redirect boolean false
18222 If this option is set true, any SMTP error codes that are present at the start
18223 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
18224 the default codes (451 and 550, respectively) are always used.
18225
18226
18227
18228
18229 .option hide_child_in_errmsg redirect boolean false
18230 .cindex "bounce message" "redirection details; suppressing"
18231 If this option is true, it prevents Exim from quoting a child address if it
18232 generates a bounce or delay message for it. Instead it says &"an address
18233 generated from <&'the top level address'&>"&. Of course, this applies only to
18234 bounces generated locally. If a message is forwarded to another host, &'its'&
18235 bounce may well quote the generated address.
18236
18237
18238 .option ignore_eacces redirect boolean false
18239 .cindex "EACCES"
18240 If this option is set and an attempt to open a redirection file yields the
18241 EACCES error (permission denied), the &(redirect)& router behaves as if the
18242 file did not exist.
18243
18244
18245 .option ignore_enotdir redirect boolean false
18246 .cindex "ENOTDIR"
18247 If this option is set and an attempt to open a redirection file yields the
18248 ENOTDIR error (something on the path is not a directory), the &(redirect)&
18249 router behaves as if the file did not exist.
18250
18251 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
18252 router that has the &%file%& option set discovers that the file does not exist
18253 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
18254 against unmounted NFS directories. If the parent can not be statted, delivery
18255 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
18256 is set, because that option tells Exim to ignore &"something on the path is not
18257 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
18258 that some operating systems give ENOENT where others give ENOTDIR.
18259
18260
18261
18262 .option include_directory redirect string unset
18263 If this option is set, the path names of any &':include:'& items in a
18264 redirection list must start with this directory.
18265
18266
18267 .option modemask redirect "octal integer" 022
18268 This specifies mode bits which must not be set for a file specified by the
18269 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
18270
18271
18272 .option one_time redirect boolean false
18273 .cindex "one-time aliasing/forwarding expansion"
18274 .cindex "alias file" "one-time expansion"
18275 .cindex "forward file" "one-time expansion"
18276 .cindex "mailing lists" "one-time expansion"
18277 .cindex "address redirection" "one-time expansion"
18278 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
18279 files each time it tries to deliver a message causes a problem when one or more
18280 of the generated addresses fails be delivered at the first attempt. The problem
18281 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
18282 but of what happens when the redirection list changes during the time that the
18283 message is on Exim's queue. This is particularly true in the case of mailing
18284 lists, where new subscribers might receive copies of messages that were posted
18285 before they subscribed.
18286
18287 If &%one_time%& is set and any addresses generated by the router fail to
18288 deliver at the first attempt, the failing addresses are added to the message as
18289 &"top level"& addresses, and the parent address that generated them is marked
18290 &"delivered"&. Thus, redirection does not happen again at the next delivery
18291 attempt.
18292
18293 &*Warning 1*&: Any header line addition or removal that is specified by this
18294 router would be lost if delivery did not succeed at the first attempt. For this
18295 reason, the &%headers_add%& and &%headers_remove%& generic options are not
18296 permitted when &%one_time%& is set.
18297
18298 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
18299 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
18300 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
18301
18302 &*Warning 3*&: The &%unseen%& generic router option may not be set with
18303 &%one_time%&.
18304
18305 The original top-level address is remembered with each of the generated
18306 addresses, and is output in any log messages. However, any intermediate parent
18307 addresses are not recorded. This makes a difference to the log only if
18308 &%all_parents%& log selector is set. It is expected that &%one_time%& will
18309 typically be used for mailing lists, where there is normally just one level of
18310 expansion.
18311
18312
18313 .option owners redirect "string list" unset
18314 .cindex "ownership" "alias file"
18315 .cindex "ownership" "forward file"
18316 .cindex "alias file" "ownership"
18317 .cindex "forward file" "ownership"
18318 This specifies a list of permitted owners for the file specified by &%file%&.
18319 This list is in addition to the local user when &%check_local_user%& is set.
18320 See &%check_owner%& above.
18321
18322
18323 .option owngroups redirect "string list" unset
18324 This specifies a list of permitted groups for the file specified by &%file%&.
18325 The list is in addition to the local user's primary group when
18326 &%check_local_user%& is set. See &%check_group%& above.
18327
18328
18329 .option pipe_transport redirect string&!! unset
18330 .vindex "&$address_pipe$&"
18331 A &(redirect)& router sets up a direct delivery to a pipe when a string
18332 starting with a vertical bar character is specified as a new &"address"&. The
18333 transport used is specified by this option, which, after expansion, must be the
18334 name of a configured transport. This should normally be a &(pipe)& transport.
18335 When the transport is run, the pipe command is in &$address_pipe$&.
18336
18337
18338 .option qualify_domain redirect string&!! unset
18339 .vindex "&$qualify_recipient$&"
18340 If this option is set, and an unqualified address (one without a domain) is
18341 generated, and that address would normally be qualified by the global setting
18342 in &%qualify_recipient%&, it is instead qualified with the domain specified by
18343 expanding this string. If the expansion fails, the router declines. If you want
18344 to revert to the default, you can have the expansion generate
18345 &$qualify_recipient$&.
18346
18347 This option applies to all unqualified addresses generated by Exim filters,
18348 but for traditional &_.forward_& files, it applies only to addresses that are
18349 not preceded by a backslash. Sieve filters cannot generate unqualified
18350 addresses.
18351
18352 .option qualify_preserve_domain redirect boolean false
18353 .cindex "domain" "in redirection; preserving"
18354 .cindex "preserving domain in redirection"
18355 .cindex "address redirection" "domain; preserving"
18356 If this option is set, the router's local &%qualify_domain%& option must not be
18357 set (a configuration error occurs if it is). If an unqualified address (one
18358 without a domain) is generated, it is qualified with the domain of the parent
18359 address (the immediately preceding ancestor) instead of the global
18360 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
18361 this applies whether or not the address is preceded by a backslash.
18362
18363
18364 .option repeat_use redirect boolean true
18365 If this option is set false, the router is skipped for a child address that has
18366 any ancestor that was routed by this router. This test happens before any of
18367 the other preconditions are tested. Exim's default anti-looping rules skip
18368 only when the ancestor is the same as the current address. See also
18369 &%check_ancestor%& above and the generic &%redirect_router%& option.
18370
18371
18372 .option reply_transport redirect string&!! unset
18373 A &(redirect)& router sets up an automatic reply when a &%mail%& or
18374 &%vacation%& command is used in a filter file. The transport used is specified
18375 by this option, which, after expansion, must be the name of a configured
18376 transport. This should normally be an &(autoreply)& transport. Other transports
18377 are unlikely to do anything sensible or useful.
18378
18379
18380 .option rewrite redirect boolean true
18381 .cindex "address redirection" "disabling rewriting"
18382 If this option is set false, addresses generated by the router are not
18383 subject to address rewriting. Otherwise, they are treated like new addresses
18384 and are rewritten according to the global rewriting rules.
18385
18386
18387 .option sieve_subaddress redirect string&!! unset
18388 The value of this option is passed to a Sieve filter to specify the
18389 :subaddress part of an address.
18390
18391 .option sieve_useraddress redirect string&!! unset
18392 The value of this option is passed to a Sieve filter to specify the :user part
18393 of an address. However, if it is unset, the entire original local part
18394 (including any prefix or suffix) is used for :user.
18395
18396
18397 .option sieve_vacation_directory redirect string&!! unset
18398 .cindex "Sieve filter" "vacation directory"
18399 To enable the &"vacation"& extension for Sieve filters, you must set
18400 &%sieve_vacation_directory%& to the directory where vacation databases are held
18401 (do not put anything else in that directory), and ensure that the
18402 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
18403 needs their own directory; Exim will create it if necessary.
18404
18405
18406
18407 .option skip_syntax_errors redirect boolean false
18408 .cindex "forward file" "broken"
18409 .cindex "address redirection" "broken files"
18410 .cindex "alias file" "broken"
18411 .cindex "broken alias or forward files"
18412 .cindex "ignoring faulty addresses"
18413 .cindex "skipping faulty addresses"
18414 .cindex "error" "skipping bad syntax"
18415 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
18416 non-filter redirection data are skipped, and each failing address is logged. If
18417 &%syntax_errors_to%& is set, a message is sent to the address it defines,
18418 giving details of the failures. If &%syntax_errors_text%& is set, its contents
18419 are expanded and placed at the head of the error message generated by
18420 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
18421 be the same address as the generic &%errors_to%& option. The
18422 &%skip_syntax_errors%& option is often used when handling mailing lists.
18423
18424 If all the addresses in a redirection list are skipped because of syntax
18425 errors, the router declines to handle the original address, and it is passed to
18426 the following routers.
18427
18428 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
18429 error in the filter causes filtering to be abandoned without any action being
18430 taken. The incident is logged, and the router declines to handle the address,
18431 so it is passed to the following routers.
18432
18433 .cindex "Sieve filter" "syntax errors in"
18434 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
18435 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
18436 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
18437
18438 &%skip_syntax_errors%& can be used to specify that errors in users' forward
18439 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
18440 option, used with an address that does not get redirected, can be used to
18441 notify users of these errors, by means of a router like this:
18442 .code
18443 userforward:
18444   driver = redirect
18445   allow_filter
18446   check_local_user
18447   file = $home/.forward
18448   file_transport = address_file
18449   pipe_transport = address_pipe
18450   reply_transport = address_reply
18451   no_verify
18452   skip_syntax_errors
18453   syntax_errors_to = real-$local_part@$domain
18454   syntax_errors_text = \
18455    This is an automatically generated message. An error has\n\
18456    been found in your .forward file. Details of the error are\n\
18457    reported below. While this error persists, you will receive\n\
18458    a copy of this message for every message that is addressed\n\
18459    to you. If your .forward file is a filter file, or if it is\n\
18460    a non-filter file containing no valid forwarding addresses,\n\
18461    a copy of each incoming message will be put in your normal\n\
18462    mailbox. If a non-filter file contains at least one valid\n\
18463    forwarding address, forwarding to the valid addresses will\n\
18464    happen, and those will be the only deliveries that occur.
18465 .endd
18466 You also need a router to ensure that local addresses that are prefixed by
18467 &`real-`& are recognized, but not forwarded or filtered. For example, you could
18468 put this immediately before the &(userforward)& router:
18469 .code
18470 real_localuser:
18471   driver = accept
18472   check_local_user
18473   local_part_prefix = real-
18474   transport = local_delivery
18475 .endd
18476 For security, it would probably be a good idea to restrict the use of this
18477 router to locally-generated messages, using a condition such as this:
18478 .code
18479   condition = ${if match {$sender_host_address}\
18480                          {\N^(|127\.0\.0\.1)$\N}}
18481 .endd
18482
18483
18484 .option syntax_errors_text redirect string&!! unset
18485 See &%skip_syntax_errors%& above.
18486
18487
18488 .option syntax_errors_to redirect string unset
18489 See &%skip_syntax_errors%& above.
18490 .ecindex IIDredrou1
18491 .ecindex IIDredrou2
18492
18493
18494
18495
18496
18497
18498 . ////////////////////////////////////////////////////////////////////////////
18499 . ////////////////////////////////////////////////////////////////////////////
18500
18501 .chapter "Environment for running local transports" "CHAPenvironment" &&&
18502          "Environment for local transports"
18503 .scindex IIDenvlotra1 "local transports" "environment for"
18504 .scindex IIDenvlotra2 "environment for local transports"
18505 .scindex IIDenvlotra3 "transport" "local; environment for"
18506 Local transports handle deliveries to files and pipes. (The &(autoreply)&
18507 transport can be thought of as similar to a pipe.) Exim always runs transports
18508 in subprocesses, under specified uids and gids. Typical deliveries to local
18509 mailboxes run under the uid and gid of the local user.
18510
18511 Exim also sets a specific current directory while running the transport; for
18512 some transports a home directory setting is also relevant. The &(pipe)&
18513 transport is the only one that sets up environment variables; see section
18514 &<<SECTpipeenv>>& for details.
18515
18516 The values used for the uid, gid, and the directories may come from several
18517 different places. In many cases, the router that handles the address associates
18518 settings with that address as a result of its &%check_local_user%&, &%group%&,
18519 or &%user%& options. However, values may also be given in the transport's own
18520 configuration, and these override anything that comes from the router.
18521
18522
18523
18524 .section "Concurrent deliveries" "SECID131"
18525 .cindex "concurrent deliveries"
18526 .cindex "simultaneous deliveries"
18527 If two different messages for the same local recipient arrive more or less
18528 simultaneously, the two delivery processes are likely to run concurrently. When
18529 the &(appendfile)& transport is used to write to a file, Exim applies locking
18530 rules to stop concurrent processes from writing to the same file at the same
18531 time.
18532
18533 However, when you use a &(pipe)& transport, it is up to you to arrange any
18534 locking that is needed. Here is a silly example:
18535 .code
18536 my_transport:
18537   driver = pipe
18538   command = /bin/sh -c 'cat >>/some/file'
18539 .endd
18540 This is supposed to write the message at the end of the file. However, if two
18541 messages arrive at the same time, the file will be scrambled. You can use the
18542 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
18543 file using the same algorithm that Exim itself uses.
18544
18545
18546
18547
18548 .section "Uids and gids" "SECTenvuidgid"
18549 .cindex "local transports" "uid and gid"
18550 .cindex "transport" "local; uid and gid"
18551 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
18552 overrides any group that the router set in the address, even if &%user%& is not
18553 set for the transport. This makes it possible, for example, to run local mail
18554 delivery under the uid of the recipient (set by the router), but in a special
18555 group (set by the transport). For example:
18556 .code
18557 # Routers ...
18558 # User/group are set by check_local_user in this router
18559 local_users:
18560   driver = accept
18561   check_local_user
18562   transport = group_delivery
18563
18564 # Transports ...
18565 # This transport overrides the group
18566 group_delivery:
18567   driver = appendfile
18568   file = /var/spool/mail/$local_part
18569   group = mail
18570 .endd
18571 If &%user%& is set for a transport, its value overrides what is set in the
18572 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
18573 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
18574 set.
18575
18576 .oindex "&%initgroups%&"
18577 When the uid is taken from the transport's configuration, the &[initgroups()]&
18578 function is called for the groups associated with that uid if the
18579 &%initgroups%& option is set for the transport. When the uid is not specified
18580 by the transport, but is associated with the address by a router, the option
18581 for calling &[initgroups()]& is taken from the router configuration.
18582
18583 .cindex "&(pipe)& transport" "uid for"
18584 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
18585 is set and &%user%& is not set, the uid of the process that called Exim to
18586 receive the message is used, and if &%group%& is not set, the corresponding
18587 original gid is also used.
18588
18589 This is the detailed preference order for obtaining a gid; the first of the
18590 following that is set is used:
18591
18592 .ilist
18593 A &%group%& setting of the transport;
18594 .next
18595 A &%group%& setting of the router;
18596 .next
18597 A gid associated with a user setting of the router, either as a result of
18598 &%check_local_user%& or an explicit non-numeric &%user%& setting;
18599 .next
18600 The group associated with a non-numeric &%user%& setting of the transport;
18601 .next
18602 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
18603 the uid is the creator's uid;
18604 .next
18605 The Exim gid if the Exim uid is being used as a default.
18606 .endlist
18607
18608 If, for example, the user is specified numerically on the router and there are
18609 no group settings, no gid is available. In this situation, an error occurs.
18610 This is different for the uid, for which there always is an ultimate default.
18611 The first of the following that is set is used:
18612
18613 .ilist
18614 A &%user%& setting of the transport;
18615 .next
18616 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
18617 .next
18618 A &%user%& setting of the router;
18619 .next
18620 A &%check_local_user%& setting of the router;
18621 .next
18622 The Exim uid.
18623 .endlist
18624
18625 Of course, an error will still occur if the uid that is chosen is on the
18626 &%never_users%& list.
18627
18628
18629
18630
18631
18632 .section "Current and home directories" "SECID132"
18633 .cindex "current directory for local transport"
18634 .cindex "home directory" "for local transport"
18635 .cindex "transport" "local; home directory for"
18636 .cindex "transport" "local; current directory for"
18637 Routers may set current and home directories for local transports by means of
18638 the &%transport_current_directory%& and &%transport_home_directory%& options.
18639 However, if the transport's &%current_directory%& or &%home_directory%& options
18640 are set, they override the router's values. In detail, the home directory
18641 for a local transport is taken from the first of these values that is set:
18642
18643 .ilist
18644 The &%home_directory%& option on the transport;
18645 .next
18646 The &%transport_home_directory%& option on the router;
18647 .next
18648 The password data if &%check_local_user%& is set on the router;
18649 .next
18650 The &%router_home_directory%& option on the router.
18651 .endlist
18652
18653 The current directory is taken from the first of these values that is set:
18654
18655 .ilist
18656 The &%current_directory%& option on the transport;
18657 .next
18658 The &%transport_current_directory%& option on the router.
18659 .endlist
18660
18661
18662 If neither the router nor the transport sets a current directory, Exim uses the
18663 value of the home directory, if it is set. Otherwise it sets the current
18664 directory to &_/_& before running a local transport.
18665
18666
18667
18668 .section "Expansion variables derived from the address" "SECID133"
18669 .vindex "&$domain$&"
18670 .vindex "&$local_part$&"
18671 .vindex "&$original_domain$&"
18672 Normally a local delivery is handling a single address, and in that case the
18673 variables such as &$domain$& and &$local_part$& are set during local
18674 deliveries. However, in some circumstances more than one address may be handled
18675 at once (for example, while writing batch SMTP for onward transmission by some
18676 other means). In this case, the variables associated with the local part are
18677 never set, &$domain$& is set only if all the addresses have the same domain,
18678 and &$original_domain$& is never set.
18679 .ecindex IIDenvlotra1
18680 .ecindex IIDenvlotra2
18681 .ecindex IIDenvlotra3
18682
18683
18684
18685
18686
18687
18688
18689 . ////////////////////////////////////////////////////////////////////////////
18690 . ////////////////////////////////////////////////////////////////////////////
18691
18692 .chapter "Generic options for transports" "CHAPtransportgeneric"
18693 .scindex IIDgenoptra1 "generic options" "transport"
18694 .scindex IIDgenoptra2 "options" "generic; for transports"
18695 .scindex IIDgenoptra3 "transport" "generic options for"
18696 The following generic options apply to all transports:
18697
18698
18699 .option body_only transports boolean false
18700 .cindex "transport" "body only"
18701 .cindex "message" "transporting body only"
18702 .cindex "body of message" "transporting"
18703 If this option is set, the message's headers are not transported. It is
18704 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
18705 or &(pipe)& transports, the settings of &%message_prefix%& and
18706 &%message_suffix%& should be checked, because this option does not
18707 automatically suppress them.
18708
18709
18710 .option current_directory transports string&!! unset
18711 .cindex "transport" "current directory for"
18712 This specifies the current directory that is to be set while running the
18713 transport, overriding any value that may have been set by the router.
18714 If the expansion fails for any reason, including forced failure, an error is
18715 logged, and delivery is deferred.
18716
18717
18718 .option disable_logging transports boolean false
18719 If this option is set true, nothing is logged for any
18720 deliveries by the transport or for any
18721 transport errors. You should not set this option unless you really, really know
18722 what you are doing.
18723
18724
18725 .option debug_print transports string&!! unset
18726 .cindex "testing" "variables in drivers"
18727 If this option is set and debugging is enabled (see the &%-d%& command line
18728 option), the string is expanded and included in the debugging output when the
18729 transport is run.
18730 If expansion of the string fails, the error message is written to the debugging
18731 output, and Exim carries on processing.
18732 This facility is provided to help with checking out the values of variables and
18733 so on when debugging driver configurations. For example, if a &%headers_add%&
18734 option is not working properly, &%debug_print%& could be used to output the
18735 variables it references. A newline is added to the text if it does not end with
18736 one.
18737
18738
18739 .option delivery_date_add transports boolean false
18740 .cindex "&'Delivery-date:'& header line"
18741 If this option is true, a &'Delivery-date:'& header is added to the message.
18742 This gives the actual time the delivery was made. As this is not a standard
18743 header, Exim has a configuration option (&%delivery_date_remove%&) which
18744 requests its removal from incoming messages, so that delivered messages can
18745 safely be resent to other recipients.
18746
18747
18748 .option driver transports string unset
18749 This specifies which of the available transport drivers is to be used.
18750 There is no default, and this option must be set for every transport.
18751
18752
18753 .option envelope_to_add transports boolean false
18754 .cindex "&'Envelope-to:'& header line"
18755 If this option is true, an &'Envelope-to:'& header is added to the message.
18756 This gives the original address(es) in the incoming envelope that caused this
18757 delivery to happen. More than one address may be present if the transport is
18758 configured to handle several addresses at once, or if more than one original
18759 address was redirected to the same final address. As this is not a standard
18760 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
18761 its removal from incoming messages, so that delivered messages can safely be
18762 resent to other recipients.
18763
18764
18765 .option group transports string&!! "Exim group"
18766 .cindex "transport" "group; specifying"
18767 This option specifies a gid for running the transport process, overriding any
18768 value that the router supplies, and also overriding any value associated with
18769 &%user%& (see below).
18770
18771
18772 .option headers_add transports string&!! unset
18773 .cindex "header lines" "adding in transport"
18774 .cindex "transport" "header lines; adding"
18775 This option specifies a string of text that is expanded and added to the header
18776 portion of a message as it is transported, as described in section
18777 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
18778 routers. If the result of the expansion is an empty string, or if the expansion
18779 is forced to fail, no action is taken. Other expansion failures are treated as
18780 errors and cause the delivery to be deferred.
18781
18782
18783
18784 .option headers_only transports boolean false
18785 .cindex "transport" "header lines only"
18786 .cindex "message" "transporting headers only"
18787 .cindex "header lines" "transporting"
18788 If this option is set, the message's body is not transported. It is mutually
18789 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
18790 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
18791 checked, since this option does not automatically suppress them.
18792
18793
18794 .option headers_remove transports string&!! unset
18795 .cindex "header lines" "removing"
18796 .cindex "transport" "header lines; removing"
18797 This option specifies a string that is expanded into a list of header names;
18798 these headers are omitted from the message as it is transported, as described
18799 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
18800 routers. If the result of the expansion is an empty string, or if the expansion
18801 is forced to fail, no action is taken. Other expansion failures are treated as
18802 errors and cause the delivery to be deferred.
18803
18804
18805
18806 .option headers_rewrite transports string unset
18807 .cindex "transport" "header lines; rewriting"
18808 .cindex "rewriting" "at transport time"
18809 This option allows addresses in header lines to be rewritten at transport time,
18810 that is, as the message is being copied to its destination. The contents of the
18811 option are a colon-separated list of rewriting rules. Each rule is in exactly
18812 the same form as one of the general rewriting rules that are applied when a
18813 message is received. These are described in chapter &<<CHAPrewrite>>&. For
18814 example,
18815 .code
18816 headers_rewrite = a@b c@d f : \
18817                   x@y w@z
18818 .endd
18819 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
18820 &'w@z'& in all address-bearing header lines. The rules are applied to the
18821 header lines just before they are written out at transport time, so they affect
18822 only those copies of the message that pass through the transport. However, only
18823 the message's original header lines, and any that were added by a system
18824 filter, are rewritten. If a router or transport adds header lines, they are not
18825 affected by this option. These rewriting rules are &'not'& applied to the
18826 envelope. You can change the return path using &%return_path%&, but you cannot
18827 change envelope recipients at this time.
18828
18829
18830 .option home_directory transports string&!! unset
18831 .cindex "transport" "home directory for"
18832 .vindex "&$home$&"
18833 This option specifies a home directory setting for a local transport,
18834 overriding any value that may be set by the router. The home directory is
18835 placed in &$home$& while expanding the transport's private options. It is also
18836 used as the current directory if no current directory is set by the
18837 &%current_directory%& option on the transport or the
18838 &%transport_current_directory%& option on the router. If the expansion fails
18839 for any reason, including forced failure, an error is logged, and delivery is
18840 deferred.
18841
18842
18843 .option initgroups transports boolean false
18844 .cindex "additional groups"
18845 .cindex "groups" "additional"
18846 .cindex "transport" "group; additional"
18847 If this option is true and the uid for the delivery process is provided by the
18848 transport, the &[initgroups()]& function is called when running the transport
18849 to ensure that any additional groups associated with the uid are set up.
18850
18851
18852 .option message_size_limit transports string&!! 0
18853 .cindex "limit" "message size per transport"
18854 .cindex "size" "of message, limit"
18855 .cindex "transport" "message size; limiting"
18856 This option controls the size of messages passed through the transport. It is
18857 expanded before use; the result of the expansion must be a sequence of decimal
18858 digits, optionally followed by K or M. If the expansion fails for any reason,
18859 including forced failure, or if the result is not of the required form,
18860 delivery is deferred. If the value is greater than zero and the size of a
18861 message exceeds this limit, the address is failed. If there is any chance that
18862 the resulting bounce message could be routed to the same transport, you should
18863 ensure that &%return_size_limit%& is less than the transport's
18864 &%message_size_limit%&, as otherwise the bounce message will fail to get
18865 delivered.
18866
18867
18868
18869 .option rcpt_include_affixes transports boolean false
18870 .cindex "prefix" "for local part, including in envelope"
18871 .cindex "suffix for local part" "including in envelope"
18872 .cindex "local part" "prefix"
18873 .cindex "local part" "suffix"
18874 When this option is false (the default), and an address that has had any
18875 affixes (prefixes or suffixes) removed from the local part is delivered by any
18876 form of SMTP or LMTP, the affixes are not included. For example, if a router
18877 that contains
18878 .code
18879 local_part_prefix = *-
18880 .endd
18881 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
18882 is delivered with
18883 .code
18884 RCPT TO:<xyz@some.domain>
18885 .endd
18886 This is also the case when an ACL-time callout is being used to verify a
18887 recipient address. However, if &%rcpt_include_affixes%& is set true, the
18888 whole local part is included in the RCPT command. This option applies to BSMTP
18889 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
18890 &(lmtp)& and &(smtp)& transports.
18891
18892
18893 .option retry_use_local_part transports boolean "see below"
18894 .cindex "hints database" "retry keys"
18895 When a delivery suffers a temporary failure, a retry record is created
18896 in Exim's hints database. For remote deliveries, the key for the retry record
18897 is based on the name and/or IP address of the failing remote host. For local
18898 deliveries, the key is normally the entire address, including both the local
18899 part and the domain. This is suitable for most common cases of local delivery
18900 temporary failure &-- for example, exceeding a mailbox quota should delay only
18901 deliveries to that mailbox, not to the whole domain.
18902
18903 However, in some special cases you may want to treat a temporary local delivery
18904 as a failure associated with the domain, and not with a particular local part.
18905 (For example, if you are storing all mail for some domain in files.) You can do
18906 this by setting &%retry_use_local_part%& false.
18907
18908 For all the local transports, its default value is true. For remote transports,
18909 the default value is false for tidiness, but changing the value has no effect
18910 on a remote transport in the current implementation.
18911
18912
18913 .option return_path transports string&!! unset
18914 .cindex "envelope sender"
18915 .cindex "transport" "return path; changing"
18916 .cindex "return path" "changing in transport"
18917 If this option is set, the string is expanded at transport time and replaces
18918 the existing return path (envelope sender) value in the copy of the message
18919 that is being delivered. An empty return path is permitted. This feature is
18920 designed for remote deliveries, where the value of this option is used in the
18921 SMTP MAIL command. If you set &%return_path%& for a local transport, the
18922 only effect is to change the address that is placed in the &'Return-path:'&
18923 header line, if one is added to the message (see the next option).
18924
18925 &*Note:*& A changed return path is not logged unless you add
18926 &%return_path_on_delivery%& to the log selector.
18927
18928 .vindex "&$return_path$&"
18929 The expansion can refer to the existing value via &$return_path$&. This is
18930 either the message's envelope sender, or an address set by the
18931 &%errors_to%& option on a router. If the expansion is forced to fail, no
18932 replacement occurs; if it fails for another reason, delivery is deferred. This
18933 option can be used to support VERP (Variable Envelope Return Paths) &-- see
18934 section &<<SECTverp>>&.
18935
18936 &*Note*&: If a delivery error is detected locally, including the case when a
18937 remote server rejects a message at SMTP time, the bounce message is not sent to
18938 the value of this option. It is sent to the previously set errors address.
18939 This defaults to the incoming sender address, but can be changed by setting
18940 &%errors_to%& in a router.
18941
18942
18943
18944 .option return_path_add transports boolean false
18945 .cindex "&'Return-path:'& header line"
18946 If this option is true, a &'Return-path:'& header is added to the message.
18947 Although the return path is normally available in the prefix line of BSD
18948 mailboxes, this is commonly not displayed by MUAs, and so the user does not
18949 have easy access to it.
18950
18951 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
18952 the delivery SMTP server makes the final delivery"&. This implies that this
18953 header should not be present in incoming messages. Exim has a configuration
18954 option, &%return_path_remove%&, which requests removal of this header from
18955 incoming messages, so that delivered messages can safely be resent to other
18956 recipients.
18957
18958
18959 .option shadow_condition transports string&!! unset
18960 See &%shadow_transport%& below.
18961
18962
18963 .option shadow_transport transports string unset
18964 .cindex "shadow transport"
18965 .cindex "transport" "shadow"
18966 A local transport may set the &%shadow_transport%& option to the name of
18967 another local transport. Shadow remote transports are not supported.
18968
18969 Whenever a delivery to the main transport succeeds, and either
18970 &%shadow_condition%& is unset, or its expansion does not result in the empty
18971 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
18972 passed to the shadow transport, with the same delivery address or addresses. If
18973 expansion fails, no action is taken except that non-forced expansion failures
18974 cause a log line to be written.
18975
18976 The result of the shadow transport is discarded and does not affect the
18977 subsequent processing of the message. Only a single level of shadowing is
18978 provided; the &%shadow_transport%& option is ignored on any transport when it
18979 is running as a shadow. Options concerned with output from pipes are also
18980 ignored. The log line for the successful delivery has an item added on the end,
18981 of the form
18982 .code
18983 ST=<shadow transport name>
18984 .endd
18985 If the shadow transport did not succeed, the error message is put in
18986 parentheses afterwards. Shadow transports can be used for a number of different
18987 purposes, including keeping more detailed log information than Exim normally
18988 provides, and implementing automatic acknowledgment policies based on message
18989 headers that some sites insist on.
18990
18991
18992 .option transport_filter transports string&!! unset
18993 .cindex "transport" "filter"
18994 .cindex "filter" "transport filter"
18995 This option sets up a filtering (in the Unix shell sense) process for messages
18996 at transport time. It should not be confused with mail filtering as set up by
18997 individual users or via a system filter.
18998
18999 When the message is about to be written out, the command specified by
19000 &%transport_filter%& is started up in a separate, parallel process, and
19001 the entire message, including the header lines, is passed to it on its standard
19002 input (this in fact is done from a third process, to avoid deadlock). The
19003 command must be specified as an absolute path.
19004
19005 The lines of the message that are written to the transport filter are
19006 terminated by newline (&"\n"&). The message is passed to the filter before any
19007 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
19008 lines beginning with a dot, and also before any processing implied by the
19009 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
19010 &(pipe)& transports.
19011
19012 The standard error for the filter process is set to the same destination as its
19013 standard output; this is read and written to the message's ultimate
19014 destination. The process that writes the message to the filter, the
19015 filter itself, and the original process that reads the result and delivers it
19016 are all run in parallel, like a shell pipeline.
19017
19018 The filter can perform any transformations it likes, but of course should take
19019 care not to break RFC 2822 syntax. Exim does not check the result, except to
19020 test for a final newline when SMTP is in use. All messages transmitted over
19021 SMTP must end with a newline, so Exim supplies one if it is missing.
19022
19023 .cindex "content scanning" "per user"
19024 A transport filter can be used to provide content-scanning on a per-user basis
19025 at delivery time if the only required effect of the scan is to modify the
19026 message. For example, a content scan could insert a new header line containing
19027 a spam score. This could be interpreted by a filter in the user's MUA. It is
19028 not possible to discard a message at this stage.
19029
19030 .cindex "SMTP" "SIZE"
19031 A problem might arise if the filter increases the size of a message that is
19032 being sent down an SMTP connection. If the receiving SMTP server has indicated
19033 support for the SIZE parameter, Exim will have sent the size of the message
19034 at the start of the SMTP session. If what is actually sent is substantially
19035 more, the server might reject the message. This can be worked round by setting
19036 the &%size_addition%& option on the &(smtp)& transport, either to allow for
19037 additions to the message, or to disable the use of SIZE altogether.
19038
19039 .vindex "&$pipe_addresses$&"
19040 The value of the &%transport_filter%& option is the command string for starting
19041 the filter, which is run directly from Exim, not under a shell. The string is
19042 parsed by Exim in the same way as a command string for the &(pipe)& transport:
19043 Exim breaks it up into arguments and then expands each argument separately (see
19044 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
19045 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
19046 of arguments, one for each address that applies to this delivery. (This isn't
19047 an ideal name for this feature here, but as it was already implemented for the
19048 &(pipe)& transport, it seemed sensible not to change it.)
19049
19050 .vindex "&$host$&"
19051 .vindex "&$host_address$&"
19052 The expansion variables &$host$& and &$host_address$& are available when the
19053 transport is a remote one. They contain the name and IP address of the host to
19054 which the message is being sent. For example:
19055 .code
19056 transport_filter = /some/directory/transport-filter.pl \
19057   $host $host_address $sender_address $pipe_addresses
19058 .endd
19059
19060 Two problems arise if you want to use more complicated expansion items to
19061 generate transport filter commands, both of which due to the fact that the
19062 command is split up &'before'& expansion.
19063 .ilist
19064 If an expansion item contains white space, you must quote it, so that it is all
19065 part of the same command item. If the entire option setting is one such
19066 expansion item, you have to take care what kind of quoting you use. For
19067 example:
19068 .code
19069 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
19070 .endd
19071 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
19072 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
19073 stripped by Exim when it read the option's value. When the value is used, if
19074 the single quotes were missing, the line would be split into two items,
19075 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
19076 Exim tried to expand the first one.
19077 .next
19078 Except for the special case of &$pipe_addresses$& that is mentioned above, an
19079 expansion cannot generate multiple arguments, or a command name followed by
19080 arguments. Consider this example:
19081 .code
19082 transport_filter = ${lookup{$host}lsearch{/a/file}\
19083                     {$value}{/bin/cat}}
19084 .endd
19085 The result of the lookup is interpreted as the name of the command, even
19086 if it contains white space. The simplest way round this is to use a shell:
19087 .code
19088 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
19089                                {$value}{/bin/cat}}
19090 .endd
19091 .endlist
19092
19093 The filter process is run under the same uid and gid as the normal delivery.
19094 For remote deliveries this is the Exim uid/gid by default. The command should
19095 normally yield a zero return code. Transport filters are not supposed to fail.
19096 A non-zero code is taken to mean that the transport filter encountered some
19097 serious problem. Delivery of the message is deferred; the message remains on
19098 the queue and is tried again later. It is not possible to cause a message to be
19099 bounced from a transport filter.
19100
19101 If a transport filter is set on an autoreply transport, the original message is
19102 passed through the filter as it is being copied into the newly generated
19103 message, which happens if the &%return_message%& option is set.
19104
19105
19106 .option transport_filter_timeout transports time 5m
19107 .cindex "transport" "filter, timeout"
19108 When Exim is reading the output of a transport filter, it a applies a timeout
19109 that can be set by this option. Exceeding the timeout is normally treated as a
19110 temporary delivery failure. However, if a transport filter is used with a
19111 &(pipe)& transport, a timeout in the transport filter is treated in the same
19112 way as a timeout in the pipe command itself. By default, a timeout is a hard
19113 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
19114 becomes a temporary error.
19115
19116
19117 .option user transports string&!! "Exim user"
19118 .cindex "uid (user id)" "local delivery"
19119 .cindex "transport" "user, specifying"
19120 This option specifies the user under whose uid the delivery process is to be
19121 run, overriding any uid that may have been set by the router. If the user is
19122 given as a name, the uid is looked up from the password data, and the
19123 associated group is taken as the value of the gid to be used if the &%group%&
19124 option is not set.
19125
19126 For deliveries that use local transports, a user and group are normally
19127 specified explicitly or implicitly (for example, as a result of
19128 &%check_local_user%&) by the router or transport.
19129
19130 .cindex "hints database" "access by remote transport"
19131 For remote transports, you should leave this option unset unless you really are
19132 sure you know what you are doing. When a remote transport is running, it needs
19133 to be able to access Exim's hints databases, because each host may have its own
19134 retry data.
19135 .ecindex IIDgenoptra1
19136 .ecindex IIDgenoptra2
19137 .ecindex IIDgenoptra3
19138
19139
19140
19141
19142
19143
19144 . ////////////////////////////////////////////////////////////////////////////
19145 . ////////////////////////////////////////////////////////////////////////////
19146
19147 .chapter "Address batching in local transports" "CHAPbatching" &&&
19148          "Address batching"
19149 .cindex "transport" "local; address batching in"
19150 The only remote transport (&(smtp)&) is normally configured to handle more than
19151 one address at a time, so that when several addresses are routed to the same
19152 remote host, just one copy of the message is sent. Local transports, however,
19153 normally handle one address at a time. That is, a separate instance of the
19154 transport is run for each address that is routed to the transport. A separate
19155 copy of the message is delivered each time.
19156
19157 .cindex "batched local delivery"
19158 .oindex "&%batch_max%&"
19159 .oindex "&%batch_id%&"
19160 In special cases, it may be desirable to handle several addresses at once in a
19161 local transport, for example:
19162
19163 .ilist
19164 In an &(appendfile)& transport, when storing messages in files for later
19165 delivery by some other means, a single copy of the message with multiple
19166 recipients saves space.
19167 .next
19168 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
19169 a single copy saves time, and is the normal way LMTP is expected to work.
19170 .next
19171 In a &(pipe)& transport, when passing the message
19172 to a scanner program or
19173 to some other delivery mechanism such as UUCP, multiple recipients may be
19174 acceptable.
19175 .endlist
19176
19177 These three local transports all have the same options for controlling multiple
19178 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
19179 repeating the information for each transport, these options are described here.
19180
19181 The &%batch_max%& option specifies the maximum number of addresses that can be
19182 delivered together in a single run of the transport. Its default value is one
19183 (no batching). When more than one address is routed to a transport that has a
19184 &%batch_max%& value greater than one, the addresses are delivered in a batch
19185 (that is, in a single run of the transport with multiple recipients), subject
19186 to certain conditions:
19187
19188 .ilist
19189 .vindex "&$local_part$&"
19190 If any of the transport's options contain a reference to &$local_part$&, no
19191 batching is possible.
19192 .next
19193 .vindex "&$domain$&"
19194 If any of the transport's options contain a reference to &$domain$&, only
19195 addresses with the same domain are batched.
19196 .next
19197 .cindex "customizing" "batching condition"
19198 If &%batch_id%& is set, it is expanded for each address, and only those
19199 addresses with the same expanded value are batched. This allows you to specify
19200 customized batching conditions. Failure of the expansion for any reason,
19201 including forced failure, disables batching, but it does not stop the delivery
19202 from taking place.
19203 .next
19204 Batched addresses must also have the same errors address (where to send
19205 delivery errors), the same header additions and removals, the same user and
19206 group for the transport, and if a host list is present, the first host must
19207 be the same.
19208 .endlist
19209
19210 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
19211 both when the file or pipe command is specified in the transport, and when it
19212 is specified by a &(redirect)& router, but all the batched addresses must of
19213 course be routed to the same file or pipe command. These two transports have an
19214 option called &%use_bsmtp%&, which causes them to deliver the message in
19215 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
19216 &%check_string%& and &%escape_string%& options are forced to the values
19217 .code
19218 check_string = "."
19219 escape_string = ".."
19220 .endd
19221 when batched SMTP is in use. A full description of the batch SMTP mechanism is
19222 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
19223 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
19224
19225 .cindex "&'Envelope-to:'& header line"
19226 If the generic &%envelope_to_add%& option is set for a batching transport, the
19227 &'Envelope-to:'& header that is added to the message contains all the addresses
19228 that are being processed together. If you are using a batching &(appendfile)&
19229 transport without &%use_bsmtp%&, the only way to preserve the recipient
19230 addresses is to set the &%envelope_to_add%& option.
19231
19232 .cindex "&(pipe)& transport" "with multiple addresses"
19233 .vindex "&$pipe_addresses$&"
19234 If you are using a &(pipe)& transport without BSMTP, and setting the
19235 transport's &%command%& option, you can include &$pipe_addresses$& as part of
19236 the command. This is not a true variable; it is a bit of magic that causes each
19237 of the recipient addresses to be inserted into the command as a separate
19238 argument. This provides a way of accessing all the addresses that are being
19239 delivered in the batch. &*Note:*& This is not possible for pipe commands that
19240 are specified by a &(redirect)& router.
19241
19242
19243
19244
19245 . ////////////////////////////////////////////////////////////////////////////
19246 . ////////////////////////////////////////////////////////////////////////////
19247
19248 .chapter "The appendfile transport" "CHAPappendfile"
19249 .scindex IIDapptra1 "&(appendfile)& transport"
19250 .scindex IIDapptra2 "transports" "&(appendfile)&"
19251 .cindex "directory creation"
19252 .cindex "creating directories"
19253 The &(appendfile)& transport delivers a message by appending it to an existing
19254 file, or by creating an entirely new file in a specified directory. Single
19255 files to which messages are appended can be in the traditional Unix mailbox
19256 format, or optionally in the MBX format supported by the Pine MUA and
19257 University of Washington IMAP daemon, &'inter alia'&. When each message is
19258 being delivered as a separate file, &"maildir"& format can optionally be used
19259 to give added protection against failures that happen part-way through the
19260 delivery. A third form of separate-file delivery known as &"mailstore"& is also
19261 supported. For all file formats, Exim attempts to create as many levels of
19262 directory as necessary, provided that &%create_directory%& is set.
19263
19264 The code for the optional formats is not included in the Exim binary by
19265 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
19266 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
19267 included.
19268
19269 .cindex "quota" "system"
19270 Exim recognizes system quota errors, and generates an appropriate message. Exim
19271 also supports its own quota control within the transport, for use when the
19272 system facility is unavailable or cannot be used for some reason.
19273
19274 If there is an error while appending to a file (for example, quota exceeded or
19275 partition filled), Exim attempts to reset the file's length and last
19276 modification time back to what they were before. If there is an error while
19277 creating an entirely new file, the new file is removed.
19278
19279 Before appending to a file, a number of security checks are made, and the
19280 file is locked. A detailed description is given below, after the list of
19281 private options.
19282
19283 The &(appendfile)& transport is most commonly used for local deliveries to
19284 users' mailboxes. However, it can also be used as a pseudo-remote transport for
19285 putting messages into files for remote delivery by some means other than Exim.
19286 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
19287 option).
19288
19289
19290
19291 .section "The file and directory options" "SECTfildiropt"
19292 The &%file%& option specifies a single file, to which the message is appended;
19293 the &%directory%& option specifies a directory, in which a new file containing
19294 the message is created. Only one of these two options can be set, and for
19295 normal deliveries to mailboxes, one of them &'must'& be set.
19296
19297 .vindex "&$address_file$&"
19298 .vindex "&$local_part$&"
19299 However, &(appendfile)& is also used for delivering messages to files or
19300 directories whose names (or parts of names) are obtained from alias,
19301 forwarding, or filtering operations (for example, a &%save%& command in a
19302 user's Exim filter). When such a transport is running, &$local_part$& contains
19303 the local part that was aliased or forwarded, and &$address_file$& contains the
19304 name (or partial name) of the file or directory generated by the redirection
19305 operation. There are two cases:
19306
19307 .ilist
19308 If neither &%file%& nor &%directory%& is set, the redirection operation
19309 must specify an absolute path (one that begins with &`/`&). This is the most
19310 common case when users with local accounts use filtering to sort mail into
19311 different folders. See for example, the &(address_file)& transport in the
19312 default configuration. If the path ends with a slash, it is assumed to be the
19313 name of a directory. A delivery to a directory can also be forced by setting
19314 &%maildir_format%& or &%mailstore_format%&.
19315 .next
19316 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
19317 used to determine the file or directory name for the delivery. Normally, the
19318 contents of &$address_file$& are used in some way in the string expansion.
19319 .endlist
19320
19321
19322 .cindex "Sieve filter" "configuring &(appendfile)&"
19323 .cindex "Sieve filter" "relative mailbox path handling"
19324 As an example of the second case, consider an environment where users do not
19325 have home directories. They may be permitted to use Exim filter commands of the
19326 form:
19327 .code
19328 save folder23
19329 .endd
19330 or Sieve filter commands of the form:
19331 .code
19332 require "fileinto";
19333 fileinto "folder23";
19334 .endd
19335 In this situation, the expansion of &%file%& or &%directory%& in the transport
19336 must transform the relative path into an appropriate absolute file name. In the
19337 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
19338 is used as a result of a &"keep"& action in the filter. This example shows one
19339 way of handling this requirement:
19340 .code
19341 file = ${if eq{$address_file}{inbox} \
19342             {/var/mail/$local_part} \
19343             {${if eq{${substr_0_1:$address_file}}{/} \
19344                   {$address_file} \
19345                   {$home/mail/$address_file} \
19346             }} \
19347        }
19348 .endd
19349 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
19350 location, absolute paths are used without change, and other folders are in the
19351 &_mail_& directory within the home directory.
19352
19353 &*Note 1*&: While processing an Exim filter, a relative path such as
19354 &_folder23_& is turned into an absolute path if a home directory is known to
19355 the router. In particular, this is the case if &%check_local_user%& is set. If
19356 you want to prevent this happening at routing time, you can set
19357 &%router_home_directory%& empty. This forces the router to pass the relative
19358 path to the transport.
19359
19360 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
19361 the &%file%& or &%directory%& option is still used if it is set.
19362
19363
19364
19365
19366 .section "Private options for appendfile" "SECID134"
19367 .cindex "options" "&(appendfile)& transport"
19368
19369
19370
19371 .option allow_fifo appendfile boolean false
19372 .cindex "fifo (named pipe)"
19373 .cindex "named pipe (fifo)"
19374 .cindex "pipe" "named (fifo)"
19375 Setting this option permits delivery to named pipes (FIFOs) as well as to
19376 regular files. If no process is reading the named pipe at delivery time, the
19377 delivery is deferred.
19378
19379
19380 .option allow_symlink appendfile boolean false
19381 .cindex "symbolic link" "to mailbox"
19382 .cindex "mailbox" "symbolic link"
19383 By default, &(appendfile)& will not deliver if the path name for the file is
19384 that of a symbolic link. Setting this option relaxes that constraint, but there
19385 are security issues involved in the use of symbolic links. Be sure you know
19386 what you are doing if you set this. Details of exactly what this option affects
19387 are included in the discussion which follows this list of options.
19388
19389
19390 .option batch_id appendfile string&!! unset
19391 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
19392 However, batching is automatically disabled for &(appendfile)& deliveries that
19393 happen as a result of forwarding or aliasing or other redirection directly to a
19394 file.
19395
19396
19397 .option batch_max appendfile integer 1
19398 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
19399
19400
19401 .option check_group appendfile boolean false
19402 When this option is set, the group owner of the file defined by the &%file%&
19403 option is checked to see that it is the same as the group under which the
19404 delivery process is running. The default setting is false because the default
19405 file mode is 0600, which means that the group is irrelevant.
19406
19407
19408 .option check_owner appendfile boolean true
19409 When this option is set, the owner of the file defined by the &%file%& option
19410 is checked to ensure that it is the same as the user under which the delivery
19411 process is running.
19412
19413
19414 .option check_string appendfile string "see below"
19415 .cindex "&""From""& line"
19416 As &(appendfile)& writes the message, the start of each line is tested for
19417 matching &%check_string%&, and if it does, the initial matching characters are
19418 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
19419 a literal string, not a regular expression, and the case of any letters it
19420 contains is significant.
19421
19422 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
19423 are forced to &"."& and &".."& respectively, and any settings in the
19424 configuration are ignored. Otherwise, they default to &"From&~"& and
19425 &">From&~"& when the &%file%& option is set, and unset when any of the
19426 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
19427
19428 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
19429 suitable for traditional &"BSD"& mailboxes, where a line beginning with
19430 &"From&~"& indicates the start of a new message. All four options need changing
19431 if another format is used. For example, to deliver to mailboxes in MMDF format:
19432 .cindex "MMDF format mailbox"
19433 .cindex "mailbox" "MMDF format"
19434 .code
19435 check_string = "\1\1\1\1\n"
19436 escape_string = "\1\1\1\1 \n"
19437 message_prefix = "\1\1\1\1\n"
19438 message_suffix = "\1\1\1\1\n"
19439 .endd
19440 .option create_directory appendfile boolean true
19441 .cindex "directory creation"
19442 When this option is true, Exim attempts to create any missing superior
19443 directories for the file that it is about to write. A created directory's mode
19444 is given by the &%directory_mode%& option.
19445
19446 The group ownership of a newly created directory is highly dependent on the
19447 operating system (and possibly the file system) that is being used. For
19448 example, in Solaris, if the parent directory has the setgid bit set, its group
19449 is propagated to the child; if not, the currently set group is used. However,
19450 in FreeBSD, the parent's group is always used.
19451
19452
19453
19454 .option create_file appendfile string anywhere
19455 This option constrains the location of files and directories that are created
19456 by this transport. It applies to files defined by the &%file%& option and
19457 directories defined by the &%directory%& option. In the case of maildir
19458 delivery, it applies to the top level directory, not the maildir directories
19459 beneath.
19460
19461 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
19462 &"belowhome"&. In the second and third cases, a home directory must have been
19463 set for the transport. This option is not useful when an explicit file name is
19464 given for normal mailbox deliveries. It is intended for the case when file
19465 names are generated from users' &_.forward_& files. These are usually handled
19466 by an &(appendfile)& transport called &%address_file%&. See also
19467 &%file_must_exist%&.
19468
19469
19470 .option directory appendfile string&!! unset
19471 This option is mutually exclusive with the &%file%& option, but one of &%file%&
19472 or &%directory%& must be set, unless the delivery is the direct result of a
19473 redirection (see section &<<SECTfildiropt>>&).
19474
19475 When &%directory%& is set, the string is expanded, and the message is delivered
19476 into a new file or files in or below the given directory, instead of being
19477 appended to a single mailbox file. A number of different formats are provided
19478 (see &%maildir_format%& and &%mailstore_format%&), and see section
19479 &<<SECTopdir>>& for further details of this form of delivery.
19480
19481
19482 .option directory_file appendfile string&!! "see below"
19483 .cindex "base62"
19484 .vindex "&$inode$&"
19485 When &%directory%& is set, but neither &%maildir_format%& nor
19486 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
19487 whose name is obtained by expanding this string. The default value is:
19488 .code
19489 q${base62:$tod_epoch}-$inode
19490 .endd
19491 This generates a unique name from the current time, in base 62 form, and the
19492 inode of the file. The variable &$inode$& is available only when expanding this
19493 option.
19494
19495
19496 .option directory_mode appendfile "octal integer" 0700
19497 If &(appendfile)& creates any directories as a result of the
19498 &%create_directory%& option, their mode is specified by this option.
19499
19500
19501 .option escape_string appendfile string "see description"
19502 See &%check_string%& above.
19503
19504
19505 .option file appendfile string&!! unset
19506 This option is mutually exclusive with the &%directory%& option, but one of
19507 &%file%& or &%directory%& must be set, unless the delivery is the direct result
19508 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
19509 specifies a single file, to which the message is appended. One or more of
19510 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
19511 &%file%&.
19512
19513 .cindex "NFS" "lock file"
19514 .cindex "locking files"
19515 .cindex "lock files"
19516 If you are using more than one host to deliver over NFS into the same
19517 mailboxes, you should always use lock files.
19518
19519 The string value is expanded for each delivery, and must yield an absolute
19520 path. The most common settings of this option are variations on one of these
19521 examples:
19522 .code
19523 file = /var/spool/mail/$local_part
19524 file = /home/$local_part/inbox
19525 file = $home/inbox
19526 .endd
19527 .cindex "&""sticky""& bit"
19528 In the first example, all deliveries are done into the same directory. If Exim
19529 is configured to use lock files (see &%use_lockfile%& below) it must be able to
19530 create a file in the directory, so the &"sticky"& bit must be turned on for
19531 deliveries to be possible, or alternatively the &%group%& option can be used to
19532 run the delivery under a group id which has write access to the directory.
19533
19534
19535
19536 .option file_format appendfile string unset
19537 .cindex "file" "mailbox; checking existing format"
19538 This option requests the transport to check the format of an existing file
19539 before adding to it. The check consists of matching a specific string at the
19540 start of the file. The value of the option consists of an even number of
19541 colon-separated strings. The first of each pair is the test string, and the
19542 second is the name of a transport. If the transport associated with a matched
19543 string is not the current transport, control is passed over to the other
19544 transport. For example, suppose the standard &(local_delivery)& transport has
19545 this added to it:
19546 .code
19547 file_format = "From       : local_delivery :\
19548                \1\1\1\1\n : local_mmdf_delivery"
19549 .endd
19550 Mailboxes that begin with &"From"& are still handled by this transport, but if
19551 a mailbox begins with four binary ones followed by a newline, control is passed
19552 to a transport called &%local_mmdf_delivery%&, which presumably is configured
19553 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
19554 is assumed to match the current transport. If the start of a mailbox doesn't
19555 match any string, or if the transport named for a given string is not defined,
19556 delivery is deferred.
19557
19558
19559 .option file_must_exist appendfile boolean false
19560 If this option is true, the file specified by the &%file%& option must exist.
19561 A temporary error occurs if it does not, causing delivery to be deferred.
19562 If this option is false, the file is created if it does not exist.
19563
19564
19565 .option lock_fcntl_timeout appendfile time 0s
19566 .cindex "timeout" "mailbox locking"
19567 .cindex "mailbox" "locking, blocking and non-blocking"
19568 .cindex "locking files"
19569 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
19570 when locking an open mailbox file. If the call fails, the delivery process
19571 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
19572 Non-blocking calls are used so that the file is not kept open during the wait
19573 for the lock; the reason for this is to make it as safe as possible for
19574 deliveries over NFS in the case when processes might be accessing an NFS
19575 mailbox without using a lock file. This should not be done, but
19576 misunderstandings and hence misconfigurations are not unknown.
19577
19578 On a busy system, however, the performance of a non-blocking lock approach is
19579 not as good as using a blocking lock with a timeout. In this case, the waiting
19580 is done inside the system call, and Exim's delivery process acquires the lock
19581 and can proceed as soon as the previous lock holder releases it.
19582
19583 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
19584 timeout, are used. There may still be some retrying: the maximum number of
19585 retries is
19586 .code
19587 (lock_retries * lock_interval) / lock_fcntl_timeout
19588 .endd
19589 rounded up to the next whole number. In other words, the total time during
19590 which &(appendfile)& is trying to get a lock is roughly the same, unless
19591 &%lock_fcntl_timeout%& is set very large.
19592
19593 You should consider setting this option if you are getting a lot of delayed
19594 local deliveries because of errors of the form
19595 .code
19596 failed to lock mailbox /some/file (fcntl)
19597 .endd
19598
19599 .option lock_flock_timeout appendfile time 0s
19600 This timeout applies to file locking when using &[flock()]& (see
19601 &%use_flock%&); the timeout operates in a similar manner to
19602 &%lock_fcntl_timeout%&.
19603
19604
19605 .option lock_interval appendfile time 3s
19606 This specifies the time to wait between attempts to lock the file. See below
19607 for details of locking.
19608
19609
19610 .option lock_retries appendfile integer 10
19611 This specifies the maximum number of attempts to lock the file. A value of zero
19612 is treated as 1. See below for details of locking.
19613
19614
19615 .option lockfile_mode appendfile "octal integer" 0600
19616 This specifies the mode of the created lock file, when a lock file is being
19617 used (see &%use_lockfile%& and &%use_mbx_lock%&).
19618
19619
19620 .option lockfile_timeout appendfile time 30m
19621 .cindex "timeout" "mailbox locking"
19622 When a lock file is being used (see &%use_lockfile%&), if a lock file already
19623 exists and is older than this value, it is assumed to have been left behind by
19624 accident, and Exim attempts to remove it.
19625
19626
19627 .option mailbox_filecount appendfile string&!! unset
19628 .cindex "mailbox" "specifying size of"
19629 .cindex "size" "of mailbox"
19630 If this option is set, it is expanded, and the result is taken as the current
19631 number of files in the mailbox. It must be a decimal number, optionally
19632 followed by K or M. This provides a way of obtaining this information from an
19633 external source that maintains the data.
19634
19635
19636 .option mailbox_size appendfile string&!! unset
19637 .cindex "mailbox" "specifying size of"
19638 .cindex "size" "of mailbox"
19639 If this option is set, it is expanded, and the result is taken as the current
19640 size the mailbox. It must be a decimal number, optionally followed by K or M.
19641 This provides a way of obtaining this information from an external source that
19642 maintains the data. This is likely to be helpful for maildir deliveries where
19643 it is computationally expensive to compute the size of a mailbox.
19644
19645
19646
19647 .option maildir_format appendfile boolean false
19648 .cindex "maildir format" "specifying"
19649 If this option is set with the &%directory%& option, the delivery is into a new
19650 file, in the &"maildir"& format that is used by other mail software. When the
19651 transport is activated directly from a &(redirect)& router (for example, the
19652 &(address_file)& transport in the default configuration), setting
19653 &%maildir_format%& causes the path received from the router to be treated as a
19654 directory, whether or not it ends with &`/`&. This option is available only if
19655 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
19656 &<<SECTmaildirdelivery>>& below for further details.
19657
19658
19659 .option maildir_quota_directory_regex appendfile string "See below"
19660 .cindex "maildir format" "quota; directories included in"
19661 .cindex "quota" "maildir; directories included in"
19662 This option is relevant only when &%maildir_use_size_file%& is set. It defines
19663 a regular expression for specifying directories, relative to the quota
19664 directory (see &%quota_directory%&), that should be included in the quota
19665 calculation. The default value is:
19666 .code
19667 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
19668 .endd
19669 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
19670 (directories whose names begin with a dot). If you want to exclude the
19671 &_Trash_&
19672 folder from the count (as some sites do), you need to change this setting to
19673 .code
19674 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
19675 .endd
19676 This uses a negative lookahead in the regular expression to exclude the
19677 directory whose name is &_.Trash_&. When a directory is excluded from quota
19678 calculations, quota processing is bypassed for any messages that are delivered
19679 directly into that directory.
19680
19681
19682 .option maildir_retries appendfile integer 10
19683 This option specifies the number of times to retry when writing a file in
19684 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
19685
19686
19687 .option maildir_tag appendfile string&!! unset
19688 This option applies only to deliveries in maildir format, and is described in
19689 section &<<SECTmaildirdelivery>>& below.
19690
19691
19692 .option maildir_use_size_file appendfile boolean false
19693 .cindex "maildir format" "&_maildirsize_& file"
19694 Setting this option true enables support for &_maildirsize_& files. Exim
19695 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
19696 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
19697 value is zero. See &%maildir_quota_directory_regex%& above and section
19698 &<<SECTmaildirdelivery>>& below for further details.
19699
19700 .option maildirfolder_create_regex appendfile string unset
19701 .cindex "maildir format" "&_maildirfolder_& file"
19702 .cindex "&_maildirfolder_&, creating"
19703 The value of this option is a regular expression. If it is unset, it has no
19704 effect. Otherwise, before a maildir delivery takes place, the pattern is
19705 matched against the name of the maildir directory, that is, the directory
19706 containing the &_new_& and &_tmp_& subdirectories that will be used for the
19707 delivery. If there is a match, Exim checks for the existence of a file called
19708 &_maildirfolder_& in the directory, and creates it if it does not exist.
19709 See section &<<SECTmaildirdelivery>>& for more details.
19710
19711
19712 .option mailstore_format appendfile boolean false
19713 .cindex "mailstore format" "specifying"
19714 If this option is set with the &%directory%& option, the delivery is into two
19715 new files in  &"mailstore"& format. The option is available only if
19716 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
19717 below for further details.
19718
19719
19720 .option mailstore_prefix appendfile string&!! unset
19721 This option applies only to deliveries in mailstore format, and is described in
19722 section &<<SECTopdir>>& below.
19723
19724
19725 .option mailstore_suffix appendfile string&!! unset
19726 This option applies only to deliveries in mailstore format, and is described in
19727 section &<<SECTopdir>>& below.
19728
19729
19730 .option mbx_format appendfile boolean false
19731 .cindex "locking files"
19732 .cindex "file" "locking"
19733 .cindex "file" "MBX format"
19734 .cindex "MBX format, specifying"
19735 This option is available only if Exim has been compiled with SUPPORT_MBX
19736 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
19737 the message is appended to the mailbox file in MBX format instead of
19738 traditional Unix format. This format is supported by Pine4 and its associated
19739 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
19740
19741 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
19742 automatically changed by the use of &%mbx_format%&. They should normally be set
19743 empty when using MBX format, so this option almost always appears in this
19744 combination:
19745 .code
19746 mbx_format = true
19747 message_prefix =
19748 message_suffix =
19749 .endd
19750 If none of the locking options are mentioned in the configuration,
19751 &%use_mbx_lock%& is assumed and the other locking options default to false. It
19752 is possible to specify the other kinds of locking with &%mbx_format%&, but
19753 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
19754 interworks with &'c-client'&, providing for shared access to the mailbox. It
19755 should not be used if any program that does not use this form of locking is
19756 going to access the mailbox, nor should it be used if the mailbox file is NFS
19757 mounted, because it works only when the mailbox is accessed from a single host.
19758
19759 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
19760 the standard version of &'c-client'&, because as long as it has a mailbox open
19761 (this means for the whole of a Pine or IMAP session), Exim will not be able to
19762 append messages to it.
19763
19764
19765 .option message_prefix appendfile string&!! "see below"
19766 .cindex "&""From""& line"
19767 The string specified here is expanded and output at the start of every message.
19768 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
19769 in which case it is:
19770 .code
19771 message_prefix = "From ${if def:return_path{$return_path}\
19772   {MAILER-DAEMON}} $tod_bsdinbox\n"
19773 .endd
19774 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
19775 &`\n`& to &`\r\n`& in &%message_prefix%&.
19776
19777 .option message_suffix appendfile string&!! "see below"
19778 The string specified here is expanded and output at the end of every message.
19779 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
19780 in which case it is a single newline character. The suffix can be suppressed by
19781 setting
19782 .code
19783 message_suffix =
19784 .endd
19785 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
19786 &`\n`& to &`\r\n`& in &%message_suffix%&.
19787
19788 .option mode appendfile "octal integer" 0600
19789 If the output file is created, it is given this mode. If it already exists and
19790 has wider permissions, they are reduced to this mode. If it has narrower
19791 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
19792 if the delivery is the result of a &%save%& command in a filter file specifying
19793 a particular mode, the mode of the output file is always forced to take that
19794 value, and this option is ignored.
19795
19796
19797 .option mode_fail_narrower appendfile boolean true
19798 This option applies in the case when an existing mailbox file has a narrower
19799 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
19800 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
19801 continues with the delivery attempt, using the existing mode of the file.
19802
19803
19804 .option notify_comsat appendfile boolean false
19805 If this option is true, the &'comsat'& daemon is notified after every
19806 successful delivery to a user mailbox. This is the daemon that notifies logged
19807 on users about incoming mail.
19808
19809
19810 .option quota appendfile string&!! unset
19811 .cindex "quota" "imposed by Exim"
19812 This option imposes a limit on the size of the file to which Exim is appending,
19813 or to the total space used in the directory tree when the &%directory%& option
19814 is set. In the latter case, computation of the space used is expensive, because
19815 all the files in the directory (and any sub-directories) have to be
19816 individually inspected and their sizes summed. (See &%quota_size_regex%& and
19817 &%maildir_use_size_file%& for ways to avoid this in environments where users
19818 have no shell access to their mailboxes).
19819
19820 As there is no interlock against two simultaneous deliveries into a
19821 multi-file mailbox, it is possible for the quota to be overrun in this case.
19822 For single-file mailboxes, of course, an interlock is a necessity.
19823
19824 A file's size is taken as its &'used'& value. Because of blocking effects, this
19825 may be a lot less than the actual amount of disk space allocated to the file.
19826 If the sizes of a number of files are being added up, the rounding effect can
19827 become quite noticeable, especially on systems that have large block sizes.
19828 Nevertheless, it seems best to stick to the &'used'& figure, because this is
19829 the obvious value which users understand most easily.
19830
19831 The value of the option is expanded, and must then be a numerical value
19832 (decimal point allowed), optionally followed by one of the letters K, M, or G,
19833 for kilobytes, megabytes, or gigabytes. If Exim is running on a system with
19834 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
19835 be handled.
19836
19837 &*Note*&: A value of zero is interpreted as &"no quota"&.
19838
19839 The expansion happens while Exim is running as root, before it changes uid for
19840 the delivery. This means that files that are inaccessible to the end user can
19841 be used to hold quota values that are looked up in the expansion. When delivery
19842 fails because this quota is exceeded, the handling of the error is as for
19843 system quota failures.
19844
19845 By default, Exim's quota checking mimics system quotas, and restricts the
19846 mailbox to the specified maximum size, though the value is not accurate to the
19847 last byte, owing to separator lines and additional headers that may get added
19848 during message delivery. When a mailbox is nearly full, large messages may get
19849 refused even though small ones are accepted, because the size of the current
19850 message is added to the quota when the check is made. This behaviour can be
19851 changed by setting &%quota_is_inclusive%& false. When this is done, the check
19852 for exceeding the quota does not include the current message. Thus, deliveries
19853 continue until the quota has been exceeded; thereafter, no further messages are
19854 delivered. See also &%quota_warn_threshold%&.
19855
19856
19857 .option quota_directory appendfile string&!! unset
19858 This option defines the directory to check for quota purposes when delivering
19859 into individual files. The default is the delivery directory, or, if a file
19860 called &_maildirfolder_& exists in a maildir directory, the parent of the
19861 delivery directory.
19862
19863
19864 .option quota_filecount appendfile string&!! 0
19865 This option applies when the &%directory%& option is set. It limits the total
19866 number of files in the directory (compare the inode limit in system quotas). It
19867 can only be used if &%quota%& is also set. The value is expanded; an expansion
19868 failure causes delivery to be deferred. A value of zero is interpreted as
19869 &"no quota"&.
19870
19871
19872 .option quota_is_inclusive appendfile boolean true
19873 See &%quota%& above.
19874
19875
19876 .option quota_size_regex appendfile string unset
19877 This option applies when one of the delivery modes that writes a separate file
19878 for each message is being used. When Exim wants to find the size of one of
19879 these files in order to test the quota, it first checks &%quota_size_regex%&.
19880 If this is set to a regular expression that matches the file name, and it
19881 captures one string, that string is interpreted as a representation of the
19882 file's size. The value of &%quota_size_regex%& is not expanded.
19883
19884 This feature is useful only when users have no shell access to their mailboxes
19885 &-- otherwise they could defeat the quota simply by renaming the files. This
19886 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
19887 the file length to the file name. For example:
19888 .code
19889 maildir_tag = ,S=$message_size
19890 quota_size_regex = ,S=(\d+)
19891 .endd
19892 An alternative to &$message_size$& is &$message_linecount$&, which contains the
19893 number of lines in the message.
19894
19895 The regular expression should not assume that the length is at the end of the
19896 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
19897 sometimes add other information onto the ends of message file names.
19898
19899
19900
19901 .option quota_warn_message appendfile string&!! "see below"
19902 See below for the use of this option. If it is not set when
19903 &%quota_warn_threshold%& is set, it defaults to
19904 .code
19905 quota_warn_message = "\
19906   To: $local_part@$domain\n\
19907   Subject: Your mailbox\n\n\
19908   This message is automatically created \
19909   by mail delivery software.\n\n\
19910   The size of your mailbox has exceeded \
19911   a warning threshold that is\n\
19912   set by the system administrator.\n"
19913 .endd
19914
19915
19916 .option quota_warn_threshold appendfile string&!! 0
19917 .cindex "quota" "warning threshold"
19918 .cindex "mailbox" "size warning"
19919 .cindex "size" "of mailbox"
19920 This option is expanded in the same way as &%quota%& (see above). If the
19921 resulting value is greater than zero, and delivery of the message causes the
19922 size of the file or total space in the directory tree to cross the given
19923 threshold, a warning message is sent. If &%quota%& is also set, the threshold
19924 may be specified as a percentage of it by following the value with a percent
19925 sign. For example:
19926 .code
19927 quota = 10M
19928 quota_warn_threshold = 75%
19929 .endd
19930 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
19931 percent sign is ignored.
19932
19933 The warning message itself is specified by the &%quota_warn_message%& option,
19934 and it must start with a &'To:'& header line containing the recipient(s) of the
19935 warning message. These do not necessarily have to include the recipient(s) of
19936 the original message. A &'Subject:'& line should also normally be supplied. You
19937 can include any other header lines that you want. If you do not include a
19938 &'From:'& line, the default is:
19939 .code
19940 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
19941 .endd
19942 .oindex &%errors_reply_to%&
19943 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
19944 option.
19945
19946 The &%quota%& option does not have to be set in order to use this option; they
19947 are independent of one another except when the threshold is specified as a
19948 percentage.
19949
19950
19951 .option use_bsmtp appendfile boolean false
19952 .cindex "envelope sender"
19953 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
19954 format, with the envelope sender and recipient(s) included as SMTP commands. If
19955 you want to include a leading HELO command with such messages, you can do
19956 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
19957 for details of batch SMTP.
19958
19959
19960 .option use_crlf appendfile boolean false
19961 .cindex "carriage return"
19962 .cindex "linefeed"
19963 This option causes lines to be terminated with the two-character CRLF sequence
19964 (carriage return, linefeed) instead of just a linefeed character. In the case
19965 of batched SMTP, the byte sequence written to the file is then an exact image
19966 of what would be sent down a real SMTP connection.
19967
19968 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
19969 (which are used to supply the traditional &"From&~"& and blank line separators
19970 in Berkeley-style mailboxes) are written verbatim, so must contain their own
19971 carriage return characters if these are needed. In cases where these options
19972 have non-empty defaults, the values end with a single linefeed, so they must be
19973 changed to end with &`\r\n`& if &%use_crlf%& is set.
19974
19975
19976 .option use_fcntl_lock appendfile boolean "see below"
19977 This option controls the use of the &[fcntl()]& function to lock a file for
19978 exclusive use when a message is being appended. It is set by default unless
19979 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
19980 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
19981 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
19982
19983
19984 .option use_flock_lock appendfile boolean false
19985 This option is provided to support the use of &[flock()]& for file locking, for
19986 the few situations where it is needed. Most modern operating systems support
19987 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
19988 each other. Exim uses &[fcntl()]& locking by default.
19989
19990 This option is required only if you are using an operating system where
19991 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
19992 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
19993 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
19994
19995 .cindex "Solaris" "&[flock()]& support"
19996 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
19997 have it (and some, I think, provide a not quite right version built on top of
19998 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
19999 the ability to use it, and any attempt to do so will cause a configuration
20000 error.
20001
20002 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
20003 is just being mapped onto &[fcntl()]& by the OS).
20004
20005
20006 .option use_lockfile appendfile boolean "see below"
20007 If this option is turned off, Exim does not attempt to create a lock file when
20008 appending to a mailbox file. In this situation, the only locking is by
20009 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
20010 sure that every MUA that is ever going to look at your users' mailboxes uses
20011 &[fcntl()]& rather than a lock file, and even then only when you are not
20012 delivering over NFS from more than one host.
20013
20014 .cindex "NFS" "lock file"
20015 In order to append to an NFS file safely from more than one host, it is
20016 necessary to take out a lock &'before'& opening the file, and the lock file
20017 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
20018 file corruption.
20019
20020 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
20021 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
20022 except when &%mbx_format%& is set.
20023
20024
20025 .option use_mbx_lock appendfile boolean "see below"
20026 This option is available only if Exim has been compiled with SUPPORT_MBX
20027 set in &_Local/Makefile_&. Setting the option specifies that special MBX
20028 locking rules be used. It is set by default if &%mbx_format%& is set and none
20029 of the locking options are mentioned in the configuration. The locking rules
20030 are the same as are used by the &'c-client'& library that underlies Pine and
20031 the IMAP4 and POP daemons that come with it (see the discussion below). The
20032 rules allow for shared access to the mailbox. However, this kind of locking
20033 does not work when the mailbox is NFS mounted.
20034
20035 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
20036 &%use_flock_lock%& to control what kind of locking is used in implementing the
20037 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
20038 without &%use_fcntl_lock%& or &%use_flock_lock%&.
20039
20040
20041
20042
20043 .section "Operational details for appending" "SECTopappend"
20044 .cindex "appending to a file"
20045 .cindex "file" "appending"
20046 Before appending to a file, the following preparations are made:
20047
20048 .ilist
20049 If the name of the file is &_/dev/null_&, no action is taken, and a success
20050 return is given.
20051
20052 .next
20053 .cindex "directory creation"
20054 If any directories on the file's path are missing, Exim creates them if the
20055 &%create_directory%& option is set. A created directory's mode is given by the
20056 &%directory_mode%& option.
20057
20058 .next
20059 If &%file_format%& is set, the format of an existing file is checked. If this
20060 indicates that a different transport should be used, control is passed to that
20061 transport.
20062
20063 .next
20064 .cindex "file" "locking"
20065 .cindex "locking files"
20066 .cindex "NFS" "lock file"
20067 If &%use_lockfile%& is set, a lock file is built in a way that will work
20068 reliably over NFS, as follows:
20069
20070 .olist
20071 Create a &"hitching post"& file whose name is that of the lock file with the
20072 current time, primary host name, and process id added, by opening for writing
20073 as a new file. If this fails with an access error, delivery is deferred.
20074 .next
20075 Close the hitching post file, and hard link it to the lock file name.
20076 .next
20077 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
20078 Unlink the hitching post name.
20079 .next
20080 Otherwise, use &[stat()]& to get information about the hitching post file, and
20081 then unlink hitching post name. If the number of links is exactly two, creation
20082 of the lock file succeeded but something (for example, an NFS server crash and
20083 restart) caused this fact not to be communicated to the &[link()]& call.
20084 .next
20085 If creation of the lock file failed, wait for &%lock_interval%& and try again,
20086 up to &%lock_retries%& times. However, since any program that writes to a
20087 mailbox should complete its task very quickly, it is reasonable to time out old
20088 lock files that are normally the result of user agent and system crashes. If an
20089 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
20090 it before trying again.
20091 .endlist olist
20092
20093 .next
20094 A call is made to &[lstat()]& to discover whether the main file exists, and if
20095 so, what its characteristics are. If &[lstat()]& fails for any reason other
20096 than non-existence, delivery is deferred.
20097
20098 .next
20099 .cindex "symbolic link" "to mailbox"
20100 .cindex "mailbox" "symbolic link"
20101 If the file does exist and is a symbolic link, delivery is deferred, unless the
20102 &%allow_symlink%& option is set, in which case the ownership of the link is
20103 checked, and then &[stat()]& is called to find out about the real file, which
20104 is then subjected to the checks below. The check on the top-level link
20105 ownership prevents one user creating a link for another's mailbox in a sticky
20106 directory, though allowing symbolic links in this case is definitely not a good
20107 idea. If there is a chain of symbolic links, the intermediate ones are not
20108 checked.
20109
20110 .next
20111 If the file already exists but is not a regular file, or if the file's owner
20112 and group (if the group is being checked &-- see &%check_group%& above) are
20113 different from the user and group under which the delivery is running,
20114 delivery is deferred.
20115
20116 .next
20117 If the file's permissions are more generous than specified, they are reduced.
20118 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
20119 is set false, in which case the delivery is tried using the existing
20120 permissions.
20121
20122 .next
20123 The file's inode number is saved, and the file is then opened for appending.
20124 If this fails because the file has vanished, &(appendfile)& behaves as if it
20125 hadn't existed (see below). For any other failures, delivery is deferred.
20126
20127 .next
20128 If the file is opened successfully, check that the inode number hasn't
20129 changed, that it is still a regular file, and that the owner and permissions
20130 have not changed. If anything is wrong, defer delivery and freeze the message.
20131
20132 .next
20133 If the file did not exist originally, defer delivery if the &%file_must_exist%&
20134 option is set. Otherwise, check that the file is being created in a permitted
20135 directory if the &%create_file%& option is set (deferring on failure), and then
20136 open for writing as a new file, with the O_EXCL and O_CREAT options,
20137 except when dealing with a symbolic link (the &%allow_symlink%& option must be
20138 set). In this case, which can happen if the link points to a non-existent file,
20139 the file is opened for writing using O_CREAT but not O_EXCL, because
20140 that prevents link following.
20141
20142 .next
20143 .cindex "loop" "while file testing"
20144 If opening fails because the file exists, obey the tests given above for
20145 existing files. However, to avoid looping in a situation where the file is
20146 being continuously created and destroyed, the exists/not-exists loop is broken
20147 after 10 repetitions, and the message is then frozen.
20148
20149 .next
20150 If opening fails with any other error, defer delivery.
20151
20152 .next
20153 .cindex "file" "locking"
20154 .cindex "locking files"
20155 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
20156 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
20157 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
20158 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
20159 file, and an exclusive lock on the file whose name is
20160 .code
20161 /tmp/.<device-number>.<inode-number>
20162 .endd
20163 using the device and inode numbers of the open mailbox file, in accordance with
20164 the MBX locking rules. This file is created with a mode that is specified by
20165 the &%lockfile_mode%& option.
20166
20167 If Exim fails to lock the file, there are two possible courses of action,
20168 depending on the value of the locking timeout. This is obtained from
20169 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
20170
20171 If the timeout value is zero, the file is closed, Exim waits for
20172 &%lock_interval%&, and then goes back and re-opens the file as above and tries
20173 to lock it again. This happens up to &%lock_retries%& times, after which the
20174 delivery is deferred.
20175
20176 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
20177 &[flock()]& are used (with the given timeout), so there has already been some
20178 waiting involved by the time locking fails. Nevertheless, Exim does not give up
20179 immediately. It retries up to
20180 .code
20181 (lock_retries * lock_interval) / <timeout>
20182 .endd
20183 times (rounded up).
20184 .endlist
20185
20186 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
20187 and/or &[flock()]& locks) and then deletes the lock file if one was created.
20188
20189
20190 .section "Operational details for delivery to a new file" "SECTopdir"
20191 .cindex "delivery" "to single file"
20192 .cindex "&""From""& line"
20193 When the &%directory%& option is set instead of &%file%&, each message is
20194 delivered into a newly-created file or set of files. When &(appendfile)& is
20195 activated directly from a &(redirect)& router, neither &%file%& nor
20196 &%directory%& is normally set, because the path for delivery is supplied by the
20197 router. (See for example, the &(address_file)& transport in the default
20198 configuration.) In this case, delivery is to a new file if either the path name
20199 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
20200
20201 No locking is required while writing the message to a new file, so the various
20202 locking options of the transport are ignored. The &"From"& line that by default
20203 separates messages in a single file is not normally needed, nor is the escaping
20204 of message lines that start with &"From"&, and there is no need to ensure a
20205 newline at the end of each message. Consequently, the default values for
20206 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
20207 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
20208
20209 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
20210 the files in the delivery directory by default. However, you can specify a
20211 different directory by setting &%quota_directory%&. Also, for maildir
20212 deliveries (see below) the &_maildirfolder_& convention is honoured.
20213
20214
20215 .cindex "maildir format"
20216 .cindex "mailstore format"
20217 There are three different ways in which delivery to individual files can be
20218 done, controlled by the settings of the &%maildir_format%& and
20219 &%mailstore_format%& options. Note that code to support maildir or mailstore
20220 formats is not included in the binary unless SUPPORT_MAILDIR or
20221 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
20222
20223 .cindex "directory creation"
20224 In all three cases an attempt is made to create the directory and any necessary
20225 sub-directories if they do not exist, provided that the &%create_directory%&
20226 option is set (the default). The location of a created directory can be
20227 constrained by setting &%create_file%&. A created directory's mode is given by
20228 the &%directory_mode%& option. If creation fails, or if the
20229 &%create_directory%& option is not set when creation is required, delivery is
20230 deferred.
20231
20232
20233
20234 .section "Maildir delivery" "SECTmaildirdelivery"
20235 .cindex "maildir format" "description of"
20236 If the &%maildir_format%& option is true, Exim delivers each message by writing
20237 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
20238 directory that is defined by the &%directory%& option (the &"delivery
20239 directory"&). If the delivery is successful, the file is renamed into the
20240 &_new_& subdirectory.
20241
20242 In the file name, <&'stime'&> is the current time of day in seconds, and
20243 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
20244 Exim checks that the time-of-day clock has moved on by at least one microsecond
20245 before terminating the delivery process. This guarantees uniqueness for the
20246 file name. However, as a precaution, Exim calls &[stat()]& for the file before
20247 opening it. If any response other than ENOENT (does not exist) is given,
20248 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
20249
20250 Before Exim carries out a maildir delivery, it ensures that subdirectories
20251 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
20252 do not exist, Exim tries to create them and any superior directories in their
20253 path, subject to the &%create_directory%& and &%create_file%& options. If the
20254 &%maildirfolder_create_regex%& option is set, and the regular expression it
20255 contains matches the delivery directory, Exim also ensures that a file called
20256 &_maildirfolder_& exists in the delivery directory. If a missing directory or
20257 &_maildirfolder_& file cannot be created, delivery is deferred.
20258
20259 These features make it possible to use Exim to create all the necessary files
20260 and directories in a maildir mailbox, including subdirectories for maildir++
20261 folders. Consider this example:
20262 .code
20263 maildir_format = true
20264 directory = /var/mail/$local_part\
20265            ${if eq{$local_part_suffix}{}{}\
20266            {/.${substr_1:$local_part_suffix}}}
20267 maildirfolder_create_regex = /\.[^/]+$
20268 .endd
20269 If &$local_part_suffix$& is empty (there was no suffix for the local part),
20270 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
20271 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
20272 not match this name, so Exim will not look for or create the file
20273 &_/var/mail/pimbo/maildirfolder_&, though it will create
20274 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
20275
20276 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
20277 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
20278 does match &%maildirfolder_create_regex%&. In this case, Exim will create
20279 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
20280 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
20281
20282 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
20283 not inadvertently match the toplevel maildir directory, because a
20284 &_maildirfolder_& file at top level would completely break quota calculations.
20285
20286 .cindex "quota" "in maildir delivery"
20287 .cindex "maildir++"
20288 If Exim is required to check a &%quota%& setting before a maildir delivery, and
20289 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
20290 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
20291 Exim assumes the directory is a maildir++ folder directory, which is one level
20292 down from the user's top level mailbox directory. This causes it to start at
20293 the parent directory instead of the current directory when calculating the
20294 amount of space used.
20295
20296 One problem with delivering into a multi-file mailbox is that it is
20297 computationally expensive to compute the size of the mailbox for quota
20298 checking. Various approaches have been taken to reduce the amount of work
20299 needed. The next two sections describe two of them. A third alternative is to
20300 use some external process for maintaining the size data, and use the expansion
20301 of the &%mailbox_size%& option as a way of importing it into Exim.
20302
20303
20304
20305
20306 .section "Using tags to record message sizes" "SECID135"
20307 If &%maildir_tag%& is set, the string is expanded for each delivery.
20308 When the maildir file is renamed into the &_new_& sub-directory, the
20309 tag is added to its name. However, if adding the tag takes the length of the
20310 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
20311 the tag is dropped and the maildir file is created with no tag.
20312
20313 .vindex "&$message_size$&"
20314 Tags can be used to encode the size of files in their names; see
20315 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
20316 happens after the message has been written. The value of the &$message_size$&
20317 variable is set to the number of bytes actually written. If the expansion is
20318 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
20319 be deferred. The expanded tag may contain any printing characters except &"/"&.
20320 Non-printing characters in the string are ignored; if the resulting string is
20321 empty, it is ignored. If it starts with an alphanumeric character, a leading
20322 colon is inserted.
20323
20324
20325
20326 .section "Using a maildirsize file" "SECID136"
20327 .cindex "quota" "in maildir delivery"
20328 .cindex "maildir format" "&_maildirsize_& file"
20329 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
20330 storing quota and message size information in a file called &_maildirsize_&
20331 within the toplevel maildir directory. If this file does not exist, Exim
20332 creates it, setting the quota from the &%quota%& option of the transport. If
20333 the maildir directory itself does not exist, it is created before any attempt
20334 to write a &_maildirsize_& file.
20335
20336 The &_maildirsize_& file is used to hold information about the sizes of
20337 messages in the maildir, thus speeding up quota calculations. The quota value
20338 in the file is just a cache; if the quota is changed in the transport, the new
20339 value overrides the cached value when the next message is delivered. The cache
20340 is maintained for the benefit of other programs that access the maildir and
20341 need to know the quota.
20342
20343 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
20344 file is maintained (with a zero quota setting), but no quota is imposed.
20345
20346 A regular expression is available for controlling which directories in the
20347 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
20348 See the description of the &%maildir_quota_directory_regex%& option above for
20349 details.
20350
20351
20352 .section "Mailstore delivery" "SECID137"
20353 .cindex "mailstore format" "description of"
20354 If the &%mailstore_format%& option is true, each message is written as two
20355 files in the given directory. A unique base name is constructed from the
20356 message id and the current delivery process, and the files that are written use
20357 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
20358 contains the message's envelope, and the &_.msg_& file contains the message
20359 itself. The base name is placed in the variable &$mailstore_basename$&.
20360
20361 During delivery, the envelope is first written to a file with the suffix
20362 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
20363 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
20364 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
20365 file before accessing either of them. An alternative approach is to wait for
20366 the absence of a &_.tmp_& file.
20367
20368 The envelope file starts with any text defined by the &%mailstore_prefix%&
20369 option, expanded and terminated by a newline if there isn't one. Then follows
20370 the sender address on one line, then all the recipient addresses, one per line.
20371 There can be more than one recipient only if the &%batch_max%& option is set
20372 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
20373 appended to the file, followed by a newline if it does not end with one.
20374
20375 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
20376 failure, it is ignored. Other expansion errors are treated as serious
20377 configuration errors, and delivery is deferred. The variable
20378 &$mailstore_basename$& is available for use during these expansions.
20379
20380
20381 .section "Non-special new file delivery" "SECID138"
20382 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
20383 file is created directly in the named directory. For example, when delivering
20384 messages into files in batched SMTP format for later delivery to some host (see
20385 section &<<SECTbatchSMTP>>&), a setting such as
20386 .code
20387 directory = /var/bsmtp/$host
20388 .endd
20389 might be used. A message is written to a file with a temporary name, which is
20390 then renamed when the delivery is complete. The final name is obtained by
20391 expanding the contents of the &%directory_file%& option.
20392 .ecindex IIDapptra1
20393 .ecindex IIDapptra2
20394
20395
20396
20397
20398
20399
20400 . ////////////////////////////////////////////////////////////////////////////
20401 . ////////////////////////////////////////////////////////////////////////////
20402
20403 .chapter "The autoreply transport" "CHID8"
20404 .scindex IIDauttra1 "transports" "&(autoreply)&"
20405 .scindex IIDauttra2 "&(autoreply)& transport"
20406 The &(autoreply)& transport is not a true transport in that it does not cause
20407 the message to be transmitted. Instead, it generates a new mail message as an
20408 automatic reply to the incoming message. &'References:'& and
20409 &'Auto-Submitted:'& header lines are included. These are constructed according
20410 to the rules in RFCs 2822 and 3834, respectively.
20411
20412 If the router that passes the message to this transport does not have the
20413 &%unseen%& option set, the original message (for the current recipient) is not
20414 delivered anywhere. However, when the &%unseen%& option is set on the router
20415 that passes the message to this transport, routing of the address continues, so
20416 another router can set up a normal message delivery.
20417
20418
20419 The &(autoreply)& transport is usually run as the result of mail filtering, a
20420 &"vacation"& message being the standard example. However, it can also be run
20421 directly from a router like any other transport. To reduce the possibility of
20422 message cascades, messages created by the &(autoreply)& transport always have
20423 empty envelope sender addresses, like bounce messages.
20424
20425 The parameters of the message to be sent can be specified in the configuration
20426 by options described below. However, these are used only when the address
20427 passed to the transport does not contain its own reply information. When the
20428 transport is run as a consequence of a
20429 &%mail%&
20430 or &%vacation%& command in a filter file, the parameters of the message are
20431 supplied by the filter, and passed with the address. The transport's options
20432 that define the message are then ignored (so they are not usually set in this
20433 case). The message is specified entirely by the filter or by the transport; it
20434 is never built from a mixture of options. However, the &%file_optional%&,
20435 &%mode%&, and &%return_message%& options apply in all cases.
20436
20437 &(Autoreply)& is implemented as a local transport. When used as a result of a
20438 command in a user's filter file, &(autoreply)& normally runs under the uid and
20439 gid of the user, and with appropriate current and home directories (see chapter
20440 &<<CHAPenvironment>>&).
20441
20442 There is a subtle difference between routing a message to a &(pipe)& transport
20443 that generates some text to be returned to the sender, and routing it to an
20444 &(autoreply)& transport. This difference is noticeable only if more than one
20445 address from the same message is so handled. In the case of a pipe, the
20446 separate outputs from the different addresses are gathered up and returned to
20447 the sender in a single message, whereas if &(autoreply)& is used, a separate
20448 message is generated for each address that is passed to it.
20449
20450 Non-printing characters are not permitted in the header lines generated for the
20451 message that &(autoreply)& creates, with the exception of newlines that are
20452 immediately followed by white space. If any non-printing characters are found,
20453 the transport defers.
20454 Whether characters with the top bit set count as printing characters or not is
20455 controlled by the &%print_topbitchars%& global option.
20456
20457 If any of the generic options for manipulating headers (for example,
20458 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
20459 of the original message that is included in the generated message when
20460 &%return_message%& is set. They do not apply to the generated message itself.
20461
20462 .vindex "&$sender_address$&"
20463 If the &(autoreply)& transport receives return code 2 from Exim when it submits
20464 the message, indicating that there were no recipients, it does not treat this
20465 as an error. This means that autoreplies sent to &$sender_address$& when this
20466 is empty (because the incoming message is a bounce message) do not cause
20467 problems. They are just discarded.
20468
20469
20470
20471 .section "Private options for autoreply" "SECID139"
20472 .cindex "options" "&(autoreply)& transport"
20473
20474 .option bcc autoreply string&!! unset
20475 This specifies the addresses that are to receive &"blind carbon copies"& of the
20476 message when the message is specified by the transport.
20477
20478
20479 .option cc autoreply string&!! unset
20480 This specifies recipients of the message and the contents of the &'Cc:'& header
20481 when the message is specified by the transport.
20482
20483
20484 .option file autoreply string&!! unset
20485 The contents of the file are sent as the body of the message when the message
20486 is specified by the transport. If both &%file%& and &%text%& are set, the text
20487 string comes first.
20488
20489
20490 .option file_expand autoreply boolean false
20491 If this is set, the contents of the file named by the &%file%& option are
20492 subjected to string expansion as they are added to the message.
20493
20494
20495 .option file_optional autoreply boolean false
20496 If this option is true, no error is generated if the file named by the &%file%&
20497 option or passed with the address does not exist or cannot be read.
20498
20499
20500 .option from autoreply string&!! unset
20501 This specifies the contents of the &'From:'& header when the message is
20502 specified by the transport.
20503
20504
20505 .option headers autoreply string&!! unset
20506 This specifies additional RFC 2822 headers that are to be added to the message
20507 when the message is specified by the transport. Several can be given by using
20508 &"\n"& to separate them. There is no check on the format.
20509
20510
20511 .option log autoreply string&!! unset
20512 This option names a file in which a record of every message sent is logged when
20513 the message is specified by the transport.
20514
20515
20516 .option mode autoreply "octal integer" 0600
20517 If either the log file or the &"once"& file has to be created, this mode is
20518 used.
20519
20520
20521 .option never_mail autoreply "address list&!!" unset
20522 If any run of the transport creates a message with a recipient that matches any
20523 item in the list, that recipient is quietly discarded. If all recipients are
20524 discarded, no message is created. This applies both when the recipients are
20525 generated by a filter and when they are specified in the transport.
20526
20527
20528
20529 .option once autoreply string&!! unset
20530 This option names a file or DBM database in which a record of each &'To:'&
20531 recipient is kept when the message is specified by the transport. &*Note*&:
20532 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
20533
20534 If &%once%& is unset, or is set to an empty string, the message is always sent.
20535 By default, if &%once%& is set to a non-empty file name, the message
20536 is not sent if a potential recipient is already listed in the database.
20537 However, if the &%once_repeat%& option specifies a time greater than zero, the
20538 message is sent if that much time has elapsed since a message was last sent to
20539 this recipient. A setting of zero time for &%once_repeat%& (the default)
20540 prevents a message from being sent a second time &-- in this case, zero means
20541 infinity.
20542
20543 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
20544 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
20545 greater than zero, it changes the way Exim implements the &%once%& option.
20546 Instead of using a DBM file to record every recipient it sends to, it uses a
20547 regular file, whose size will never get larger than the given value.
20548
20549 In the file, Exim keeps a linear list of recipient addresses and the times at
20550 which they were sent messages. If the file is full when a new address needs to
20551 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
20552 means that a given recipient may receive multiple messages, but at
20553 unpredictable intervals that depend on the rate of turnover of addresses in the
20554 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
20555
20556
20557 .option once_file_size autoreply integer 0
20558 See &%once%& above.
20559
20560
20561 .option once_repeat autoreply time&!! 0s
20562 See &%once%& above.
20563 After expansion, the value of this option must be a valid time value.
20564
20565
20566 .option reply_to autoreply string&!! unset
20567 This specifies the contents of the &'Reply-To:'& header when the message is
20568 specified by the transport.
20569
20570
20571 .option return_message autoreply boolean false
20572 If this is set, a copy of the original message is returned with the new
20573 message, subject to the maximum size set in the &%return_size_limit%& global
20574 configuration option.
20575
20576
20577 .option subject autoreply string&!! unset
20578 This specifies the contents of the &'Subject:'& header when the message is
20579 specified by the transport. It is tempting to quote the original subject in
20580 automatic responses. For example:
20581 .code
20582 subject = Re: $h_subject:
20583 .endd
20584 There is a danger in doing this, however. It may allow a third party to
20585 subscribe your users to an opt-in mailing list, provided that the list accepts
20586 bounce messages as subscription confirmations. Well-managed lists require a
20587 non-bounce message to confirm a subscription, so the danger is relatively
20588 small.
20589
20590
20591
20592 .option text autoreply string&!! unset
20593 This specifies a single string to be used as the body of the message when the
20594 message is specified by the transport. If both &%text%& and &%file%& are set,
20595 the text comes first.
20596
20597
20598 .option to autoreply string&!! unset
20599 This specifies recipients of the message and the contents of the &'To:'& header
20600 when the message is specified by the transport.
20601 .ecindex IIDauttra1
20602 .ecindex IIDauttra2
20603
20604
20605
20606
20607 . ////////////////////////////////////////////////////////////////////////////
20608 . ////////////////////////////////////////////////////////////////////////////
20609
20610 .chapter "The lmtp transport" "CHAPLMTP"
20611 .cindex "transports" "&(lmtp)&"
20612 .cindex "&(lmtp)& transport"
20613 .cindex "LMTP" "over a pipe"
20614 .cindex "LMTP" "over a socket"
20615 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
20616 specified command
20617 or by interacting with a Unix domain socket.
20618 This transport is something of a cross between the &(pipe)& and &(smtp)&
20619 transports. Exim also has support for using LMTP over TCP/IP; this is
20620 implemented as an option for the &(smtp)& transport. Because LMTP is expected
20621 to be of minority interest, the default build-time configure in &_src/EDITME_&
20622 has it commented out. You need to ensure that
20623 .code
20624 TRANSPORT_LMTP=yes
20625 .endd
20626 .cindex "options" "&(lmtp)& transport"
20627 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
20628 included in the Exim binary. The private options of the &(lmtp)& transport are
20629 as follows:
20630
20631 .option batch_id lmtp string&!! unset
20632 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20633
20634
20635 .option batch_max lmtp integer 1
20636 This limits the number of addresses that can be handled in a single delivery.
20637 Most LMTP servers can handle several addresses at once, so it is normally a
20638 good idea to increase this value. See the description of local delivery
20639 batching in chapter &<<CHAPbatching>>&.
20640
20641
20642 .option command lmtp string&!! unset
20643 This option must be set if &%socket%& is not set. The string is a command which
20644 is run in a separate process. It is split up into a command name and list of
20645 arguments, each of which is separately expanded (so expansion cannot change the
20646 number of arguments). The command is run directly, not via a shell. The message
20647 is passed to the new process using the standard input and output to operate the
20648 LMTP protocol.
20649
20650 .option ignore_quota lmtp boolean false
20651 .cindex "LMTP" "ignoring quota errors"
20652 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
20653 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
20654 in its response to the LHLO command.
20655
20656 .option socket lmtp string&!! unset
20657 This option must be set if &%command%& is not set. The result of expansion must
20658 be the name of a Unix domain socket. The transport connects to the socket and
20659 delivers the message to it using the LMTP protocol.
20660
20661
20662 .option timeout lmtp time 5m
20663 The transport is aborted if the created process or Unix domain socket does not
20664 respond to LMTP commands or message input within this timeout. Delivery
20665 is deferred, and will be tried again later. Here is an example of a typical
20666 LMTP transport:
20667 .code
20668 lmtp:
20669   driver = lmtp
20670   command = /some/local/lmtp/delivery/program
20671   batch_max = 20
20672   user = exim
20673 .endd
20674 This delivers up to 20 addresses at a time, in a mixture of domains if
20675 necessary, running as the user &'exim'&.
20676
20677
20678
20679 . ////////////////////////////////////////////////////////////////////////////
20680 . ////////////////////////////////////////////////////////////////////////////
20681
20682 .chapter "The pipe transport" "CHAPpipetransport"
20683 .scindex IIDpiptra1 "transports" "&(pipe)&"
20684 .scindex IIDpiptra2 "&(pipe)& transport"
20685 The &(pipe)& transport is used to deliver messages via a pipe to a command
20686 running in another process. One example is the use of &(pipe)& as a
20687 pseudo-remote transport for passing messages to some other delivery mechanism
20688 (such as UUCP). Another is the use by individual users to automatically process
20689 their incoming messages. The &(pipe)& transport can be used in one of the
20690 following ways:
20691
20692 .ilist
20693 .vindex "&$local_part$&"
20694 A router routes one address to a transport in the normal way, and the
20695 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
20696 contains the local part of the address (as usual), and the command that is run
20697 is specified by the &%command%& option on the transport.
20698 .next
20699 .vindex "&$pipe_addresses$&"
20700 If the &%batch_max%& option is set greater than 1 (the default is 1), the
20701 transport can handle more than one address in a single run. In this case, when
20702 more than one address is routed to the transport, &$local_part$& is not set
20703 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
20704 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
20705 that are routed to the transport.
20706 .next
20707 .vindex "&$address_pipe$&"
20708 A router redirects an address directly to a pipe command (for example, from an
20709 alias or forward file). In this case, &$address_pipe$& contains the text of the
20710 pipe command, and the &%command%& option on the transport is ignored. If only
20711 one address is being transported (&%batch_max%& is not greater than one, or
20712 only one address was redirected to this pipe command), &$local_part$& contains
20713 the local part that was redirected.
20714 .endlist
20715
20716
20717 The &(pipe)& transport is a non-interactive delivery method. Exim can also
20718 deliver messages over pipes using the LMTP interactive protocol. This is
20719 implemented by the &(lmtp)& transport.
20720
20721 In the case when &(pipe)& is run as a consequence of an entry in a local user's
20722 &_.forward_& file, the command runs under the uid and gid of that user. In
20723 other cases, the uid and gid have to be specified explicitly, either on the
20724 transport or on the router that handles the address. Current and &"home"&
20725 directories are also controllable. See chapter &<<CHAPenvironment>>& for
20726 details of the local delivery environment and chapter &<<CHAPbatching>>&
20727 for a discussion of local delivery batching.
20728
20729
20730 .section "Concurrent delivery" "SECID140"
20731 If two messages arrive at almost the same time, and both are routed to a pipe
20732 delivery, the two pipe transports may be run concurrently. You must ensure that
20733 any pipe commands you set up are robust against this happening. If the commands
20734 write to a file, the &%exim_lock%& utility might be of use.
20735
20736
20737
20738
20739 .section "Returned status and data" "SECID141"
20740 .cindex "&(pipe)& transport" "returned data"
20741 If the command exits with a non-zero return code, the delivery is deemed to
20742 have failed, unless either the &%ignore_status%& option is set (in which case
20743 the return code is treated as zero), or the return code is one of those listed
20744 in the &%temp_errors%& option, which are interpreted as meaning &"try again
20745 later"&. In this case, delivery is deferred. Details of a permanent failure are
20746 logged, but are not included in the bounce message, which merely contains
20747 &"local delivery failed"&.
20748
20749 If the return code is greater than 128 and the command being run is a shell
20750 script, it normally means that the script was terminated by a signal whose
20751 value is the return code minus 128.
20752
20753 If Exim is unable to run the command (that is, if &[execve()]& fails), the
20754 return code is set to 127. This is the value that a shell returns if it is
20755 asked to run a non-existent command. The wording for the log line suggests that
20756 a non-existent command may be the problem.
20757
20758 The &%return_output%& option can affect the result of a pipe delivery. If it is
20759 set and the command produces any output on its standard output or standard
20760 error streams, the command is considered to have failed, even if it gave a zero
20761 return code or if &%ignore_status%& is set. The output from the command is
20762 included as part of the bounce message. The &%return_fail_output%& option is
20763 similar, except that output is returned only when the command exits with a
20764 failure return code, that is, a value other than zero or a code that matches
20765 &%temp_errors%&.
20766
20767
20768
20769 .section "How the command is run" "SECThowcommandrun"
20770 .cindex "&(pipe)& transport" "path for command"
20771 The command line is (by default) broken down into a command name and arguments
20772 by the &(pipe)& transport itself. The &%allow_commands%& and
20773 &%restrict_to_path%& options can be used to restrict the commands that may be
20774 run.
20775
20776 .cindex "quoting" "in pipe command"
20777 Unquoted arguments are delimited by white space. If an argument appears in
20778 double quotes, backslash is interpreted as an escape character in the usual
20779 way. If an argument appears in single quotes, no escaping is done.
20780
20781 String expansion is applied to the command line except when it comes from a
20782 traditional &_.forward_& file (commands from a filter file are expanded). The
20783 expansion is applied to each argument in turn rather than to the whole line.
20784 For this reason, any string expansion item that contains white space must be
20785 quoted so as to be contained within a single argument. A setting such as
20786 .code
20787 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
20788 .endd
20789 will not work, because the expansion item gets split between several
20790 arguments. You have to write
20791 .code
20792 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
20793 .endd
20794 to ensure that it is all in one argument. The expansion is done in this way,
20795 argument by argument, so that the number of arguments cannot be changed as a
20796 result of expansion, and quotes or backslashes in inserted variables do not
20797 interact with external quoting. However, this leads to problems if you want to
20798 generate multiple arguments (or the command name plus arguments) from a single
20799 expansion. In this situation, the simplest solution is to use a shell. For
20800 example:
20801 .code
20802 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
20803 .endd
20804
20805 .cindex "transport" "filter"
20806 .cindex "filter" "transport filter"
20807 .vindex "&$pipe_addresses$&"
20808 Special handling takes place when an argument consists of precisely the text
20809 &`$pipe_addresses`&. This is not a general expansion variable; the only
20810 place this string is recognized is when it appears as an argument for a pipe or
20811 transport filter command. It causes each address that is being handled to be
20812 inserted in the argument list at that point &'as a separate argument'&. This
20813 avoids any problems with spaces or shell metacharacters, and is of use when a
20814 &(pipe)& transport is handling groups of addresses in a batch.
20815
20816 After splitting up into arguments and expansion, the resulting command is run
20817 in a subprocess directly from the transport, &'not'& under a shell. The
20818 message that is being delivered is supplied on the standard input, and the
20819 standard output and standard error are both connected to a single pipe that is
20820 read by Exim. The &%max_output%& option controls how much output the command
20821 may produce, and the &%return_output%& and &%return_fail_output%& options
20822 control what is done with it.
20823
20824 Not running the command under a shell (by default) lessens the security risks
20825 in cases when a command from a user's filter file is built out of data that was
20826 taken from an incoming message. If a shell is required, it can of course be
20827 explicitly specified as the command to be run. However, there are circumstances
20828 where existing commands (for example, in &_.forward_& files) expect to be run
20829 under a shell and cannot easily be modified. To allow for these cases, there is
20830 an option called &%use_shell%&, which changes the way the &(pipe)& transport
20831 works. Instead of breaking up the command line as just described, it expands it
20832 as a single string and passes the result to &_/bin/sh_&. The
20833 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
20834 with &%use_shell%&, and the whole mechanism is inherently less secure.
20835
20836
20837
20838 .section "Environment variables" "SECTpipeenv"
20839 .cindex "&(pipe)& transport" "environment for command"
20840 .cindex "environment for pipe transport"
20841 The environment variables listed below are set up when the command is invoked.
20842 This list is a compromise for maximum compatibility with other MTAs. Note that
20843 the &%environment%& option can be used to add additional variables to this
20844 environment.
20845 .display
20846 &`DOMAIN            `&   the domain of the address
20847 &`HOME              `&   the home directory, if set
20848 &`HOST              `&   the host name when called from a router (see below)
20849 &`LOCAL_PART        `&   see below
20850 &`LOCAL_PART_PREFIX `&   see below
20851 &`LOCAL_PART_SUFFIX `&   see below
20852 &`LOGNAME           `&   see below
20853 &`MESSAGE_ID        `&   Exim's local ID for the message
20854 &`PATH              `&   as specified by the &%path%& option below
20855 &`QUALIFY_DOMAIN    `&   the sender qualification domain
20856 &`RECIPIENT         `&   the complete recipient address
20857 &`SENDER            `&   the sender of the message (empty if a bounce)
20858 &`SHELL             `&   &`/bin/sh`&
20859 &`TZ                `&   the value of the &%timezone%& option, if set
20860 &`USER              `&   see below
20861 .endd
20862 When a &(pipe)& transport is called directly from (for example) an &(accept)&
20863 router, LOCAL_PART is set to the local part of the address. When it is
20864 called as a result of a forward or alias expansion, LOCAL_PART is set to
20865 the local part of the address that was expanded. In both cases, any affixes are
20866 removed from the local part, and made available in LOCAL_PART_PREFIX and
20867 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
20868 same value as LOCAL_PART for compatibility with other MTAs.
20869
20870 .cindex "HOST"
20871 HOST is set only when a &(pipe)& transport is called from a router that
20872 associates hosts with an address, typically when using &(pipe)& as a
20873 pseudo-remote transport. HOST is set to the first host name specified by
20874 the router.
20875
20876 .cindex "HOME"
20877 If the transport's generic &%home_directory%& option is set, its value is used
20878 for the HOME environment variable. Otherwise, a home directory may be set
20879 by the router's &%transport_home_directory%& option, which defaults to the
20880 user's home directory if &%check_local_user%& is set.
20881
20882
20883 .section "Private options for pipe" "SECID142"
20884 .cindex "options" "&(pipe)& transport"
20885
20886
20887
20888 .option allow_commands pipe "string list&!!" unset
20889 .cindex "&(pipe)& transport" "permitted commands"
20890 The string is expanded, and is then interpreted as a colon-separated list of
20891 permitted commands. If &%restrict_to_path%& is not set, the only commands
20892 permitted are those in the &%allow_commands%& list. They need not be absolute
20893 paths; the &%path%& option is still used for relative paths. If
20894 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
20895 in the &%allow_commands%& list, or a name without any slashes that is found on
20896 the path. In other words, if neither &%allow_commands%& nor
20897 &%restrict_to_path%& is set, there is no restriction on the command, but
20898 otherwise only commands that are permitted by one or the other are allowed. For
20899 example, if
20900 .code
20901 allow_commands = /usr/bin/vacation
20902 .endd
20903 and &%restrict_to_path%& is not set, the only permitted command is
20904 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
20905 &%use_shell%& is set.
20906
20907
20908 .option batch_id pipe string&!! unset
20909 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20910
20911
20912 .option batch_max pipe integer 1
20913 This limits the number of addresses that can be handled in a single delivery.
20914 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20915
20916
20917 .option check_string pipe string unset
20918 As &(pipe)& writes the message, the start of each line is tested for matching
20919 &%check_string%&, and if it does, the initial matching characters are replaced
20920 by the contents of &%escape_string%&, provided both are set. The value of
20921 &%check_string%& is a literal string, not a regular expression, and the case of
20922 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
20923 of &%check_string%& and &%escape_string%& are forced to values that implement
20924 the SMTP escaping protocol. Any settings made in the configuration file are
20925 ignored.
20926
20927
20928 .option command pipe string&!! unset
20929 This option need not be set when &(pipe)& is being used to deliver to pipes
20930 obtained directly from address redirections. In other cases, the option must be
20931 set, to provide a command to be run. It need not yield an absolute path (see
20932 the &%path%& option below). The command is split up into separate arguments by
20933 Exim, and each argument is separately expanded, as described in section
20934 &<<SECThowcommandrun>>& above.
20935
20936
20937 .option environment pipe string&!! unset
20938 .cindex "&(pipe)& transport" "environment for command"
20939 .cindex "environment for &(pipe)& transport"
20940 This option is used to add additional variables to the environment in which the
20941 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
20942 a string which is expanded, and then interpreted as a colon-separated list of
20943 environment settings of the form <&'name'&>=<&'value'&>.
20944
20945
20946 .option escape_string pipe string unset
20947 See &%check_string%& above.
20948
20949
20950 .option freeze_exec_fail pipe boolean false
20951 .cindex "exec failure"
20952 .cindex "failure of exec"
20953 .cindex "&(pipe)& transport" "failure of exec"
20954 Failure to exec the command in a pipe transport is by default treated like
20955 any other failure while running the command. However, if &%freeze_exec_fail%&
20956 is set, failure to exec is treated specially, and causes the message to be
20957 frozen, whatever the setting of &%ignore_status%&.
20958
20959
20960 .option ignore_status pipe boolean false
20961 If this option is true, the status returned by the subprocess that is set up to
20962 run the command is ignored, and Exim behaves as if zero had been returned.
20963 Otherwise, a non-zero status or termination by signal causes an error return
20964 from the transport unless the status value is one of those listed in
20965 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
20966
20967 &*Note*&: This option does not apply to timeouts, which do not return a status.
20968 See the &%timeout_defer%& option for how timeouts are handled.
20969
20970 .option log_defer_output pipe boolean false
20971 .cindex "&(pipe)& transport" "logging output"
20972 If this option is set, and the status returned by the command is
20973 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
20974 and any output was produced, the first line of it is written to the main log.
20975
20976
20977 .option log_fail_output pipe boolean false
20978 If this option is set, and the command returns any output, and also ends with a
20979 return code that is neither zero nor one of the return codes listed in
20980 &%temp_errors%& (that is, the delivery failed), the first line of output is
20981 written to the main log. This option and &%log_output%& are mutually exclusive.
20982 Only one of them may be set.
20983
20984
20985
20986 .option log_output pipe boolean false
20987 If this option is set and the command returns any output, the first line of
20988 output is written to the main log, whatever the return code. This option and
20989 &%log_fail_output%& are mutually exclusive. Only one of them may be set.
20990
20991
20992
20993 .option max_output pipe integer 20K
20994 This specifies the maximum amount of output that the command may produce on its
20995 standard output and standard error file combined. If the limit is exceeded, the
20996 process running the command is killed. This is intended as a safety measure to
20997 catch runaway processes. The limit is applied independently of the settings of
20998 the options that control what is done with such output (for example,
20999 &%return_output%&). Because of buffering effects, the amount of output may
21000 exceed the limit by a small amount before Exim notices.
21001
21002
21003 .option message_prefix pipe string&!! "see below"
21004 The string specified here is expanded and output at the start of every message.
21005 The default is unset if &%use_bsmtp%& is set. Otherwise it is
21006 .code
21007 message_prefix = \
21008   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
21009   ${tod_bsdinbox}\n
21010 .endd
21011 .cindex "Cyrus"
21012 .cindex "&%tmail%&"
21013 .cindex "&""From""& line"
21014 This is required by the commonly used &_/usr/bin/vacation_& program.
21015 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
21016 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
21017 setting
21018 .code
21019 message_prefix =
21020 .endd
21021 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21022 &`\n`& to &`\r\n`& in &%message_prefix%&.
21023
21024
21025 .option message_suffix pipe string&!! "see below"
21026 The string specified here is expanded and output at the end of every message.
21027 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
21028 The suffix can be suppressed by setting
21029 .code
21030 message_suffix =
21031 .endd
21032 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21033 &`\n`& to &`\r\n`& in &%message_suffix%&.
21034
21035
21036 .option path pipe string "see below"
21037 This option specifies the string that is set up in the PATH environment
21038 variable of the subprocess. The default is:
21039 .code
21040 /bin:/usr/bin
21041 .endd
21042 If the &%command%& option does not yield an absolute path name, the command is
21043 sought in the PATH directories, in the usual way. &*Warning*&: This does not
21044 apply to a command specified as a transport filter.
21045
21046
21047 .option pipe_as_creator pipe boolean false
21048 .cindex "uid (user id)" "local delivery"
21049 If the generic &%user%& option is not set and this option is true, the delivery
21050 process is run under the uid that was in force when Exim was originally called
21051 to accept the message. If the group id is not otherwise set (via the generic
21052 &%group%& option), the gid that was in force when Exim was originally called to
21053 accept the message is used.
21054
21055
21056 .option restrict_to_path pipe boolean false
21057 When this option is set, any command name not listed in &%allow_commands%& must
21058 contain no slashes. The command is searched for only in the directories listed
21059 in the &%path%& option. This option is intended for use in the case when a pipe
21060 command has been generated from a user's &_.forward_& file. This is usually
21061 handled by a &(pipe)& transport called &%address_pipe%&.
21062
21063
21064 .option return_fail_output pipe boolean false
21065 If this option is true, and the command produced any output and ended with a
21066 return code other than zero or one of the codes listed in &%temp_errors%& (that
21067 is, the delivery failed), the output is returned in the bounce message.
21068 However, if the message has a null sender (that is, it is itself a bounce
21069 message), output from the command is discarded. This option and
21070 &%return_output%& are mutually exclusive. Only one of them may be set.
21071
21072
21073
21074 .option return_output pipe boolean false
21075 If this option is true, and the command produced any output, the delivery is
21076 deemed to have failed whatever the return code from the command, and the output
21077 is returned in the bounce message. Otherwise, the output is just discarded.
21078 However, if the message has a null sender (that is, it is a bounce message),
21079 output from the command is always discarded, whatever the setting of this
21080 option. This option and &%return_fail_output%& are mutually exclusive. Only one
21081 of them may be set.
21082
21083
21084
21085 .option temp_errors pipe "string list" "see below"
21086 .cindex "&(pipe)& transport" "temporary failure"
21087 This option contains either a colon-separated list of numbers, or a single
21088 asterisk. If &%ignore_status%& is false
21089 and &%return_output%& is not set,
21090 and the command exits with a non-zero return code, the failure is treated as
21091 temporary and the delivery is deferred if the return code matches one of the
21092 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
21093 codes are treated as permanent errors. The default setting contains the codes
21094 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
21095 compiled on a system that does not define these macros, it assumes values of 75
21096 and 73, respectively.
21097
21098
21099 .option timeout pipe time 1h
21100 If the command fails to complete within this time, it is killed. This normally
21101 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
21102 specifies no timeout. In order to ensure that any subprocesses created by the
21103 command are also killed, Exim makes the initial process a process group leader,
21104 and kills the whole process group on a timeout. However, this can be defeated
21105 if one of the processes starts a new process group.
21106
21107 .option timeout_defer pipe boolean false
21108 A timeout in a &(pipe)& transport, either in the command that the transport
21109 runs, or in a transport filter that is associated with it, is by default
21110 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
21111 is set true, both kinds of timeout become temporary errors, causing the
21112 delivery to be deferred.
21113
21114 .option umask pipe "octal integer" 022
21115 This specifies the umask setting for the subprocess that runs the command.
21116
21117
21118 .option use_bsmtp pipe boolean false
21119 .cindex "envelope sender"
21120 If this option is set true, the &(pipe)& transport writes messages in &"batch
21121 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
21122 commands. If you want to include a leading HELO command with such messages,
21123 you can do so by setting the &%message_prefix%& option. See section
21124 &<<SECTbatchSMTP>>& for details of batch SMTP.
21125
21126 .option use_classresources pipe boolean false
21127 .cindex "class resources (BSD)"
21128 This option is available only when Exim is running on FreeBSD, NetBSD, or
21129 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
21130 resource limits when a &(pipe)& transport is run to perform a delivery. The
21131 limits for the uid under which the pipe is to run are obtained from the login
21132 class database.
21133
21134
21135 .option use_crlf pipe boolean false
21136 .cindex "carriage return"
21137 .cindex "linefeed"
21138 This option causes lines to be terminated with the two-character CRLF sequence
21139 (carriage return, linefeed) instead of just a linefeed character. In the case
21140 of batched SMTP, the byte sequence written to the pipe is then an exact image
21141 of what would be sent down a real SMTP connection.
21142
21143 The contents of the &%message_prefix%& and &%message_suffix%& options are
21144 written verbatim, so must contain their own carriage return characters if these
21145 are needed. When &%use_bsmtp%& is not set, the default values for both
21146 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
21147 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
21148
21149
21150 .option use_shell pipe boolean false
21151 .vindex "&$pipe_addresses$&"
21152 If this option is set, it causes the command to be passed to &_/bin/sh_&
21153 instead of being run directly from the transport, as described in section
21154 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
21155 where the command is expected to be run under a shell and cannot easily be
21156 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
21157 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
21158 command is expanded as a single string, and handed to &_/bin/sh_& as data for
21159 its &%-c%& option.
21160
21161
21162
21163 .section "Using an external local delivery agent" "SECID143"
21164 .cindex "local delivery" "using an external agent"
21165 .cindex "&'procmail'&"
21166 .cindex "external local delivery"
21167 .cindex "delivery" "&'procmail'&"
21168 .cindex "delivery" "by external agent"
21169 The &(pipe)& transport can be used to pass all messages that require local
21170 delivery to a separate local delivery agent such as &%procmail%&. When doing
21171 this, care must be taken to ensure that the pipe is run under an appropriate
21172 uid and gid. In some configurations one wants this to be a uid that is trusted
21173 by the delivery agent to supply the correct sender of the message. It may be
21174 necessary to recompile or reconfigure the delivery agent so that it trusts an
21175 appropriate user. The following is an example transport and router
21176 configuration for &%procmail%&:
21177 .code
21178 # transport
21179 procmail_pipe:
21180   driver = pipe
21181   command = /usr/local/bin/procmail -d $local_part
21182   return_path_add
21183   delivery_date_add
21184   envelope_to_add
21185   check_string = "From "
21186   escape_string = ">From "
21187   umask = 077
21188   user = $local_part
21189   group = mail
21190
21191 # router
21192 procmail:
21193   driver = accept
21194   check_local_user
21195   transport = procmail_pipe
21196 .endd
21197 In this example, the pipe is run as the local user, but with the group set to
21198 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
21199 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
21200 user to supply a correct sender address. If you do not specify either a
21201 &%group%& or a &%user%& option, the pipe command is run as the local user. The
21202 home directory is the user's home directory by default.
21203
21204 &*Note*&: The command that the pipe transport runs does &'not'& begin with
21205 .code
21206 IFS=" "
21207 .endd
21208 as shown in some &%procmail%& documentation, because Exim does not by default
21209 use a shell to run pipe commands.
21210
21211 .cindex "Cyrus"
21212 The next example shows a transport and a router for a system where local
21213 deliveries are handled by the Cyrus IMAP server.
21214 .code
21215 # transport
21216 local_delivery_cyrus:
21217   driver = pipe
21218   command = /usr/cyrus/bin/deliver \
21219             -m ${substr_1:$local_part_suffix} -- $local_part
21220   user = cyrus
21221   group = mail
21222   return_output
21223   log_output
21224   message_prefix =
21225   message_suffix =
21226
21227 # router
21228 local_user_cyrus:
21229   driver = accept
21230   check_local_user
21231   local_part_suffix = .*
21232   transport = local_delivery_cyrus
21233 .endd
21234 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
21235 &%return_output%& to cause any text written by Cyrus to be returned to the
21236 sender.
21237 .ecindex IIDpiptra1
21238 .ecindex IIDpiptra2
21239
21240
21241 . ////////////////////////////////////////////////////////////////////////////
21242 . ////////////////////////////////////////////////////////////////////////////
21243
21244 .chapter "The smtp transport" "CHAPsmtptrans"
21245 .scindex IIDsmttra1 "transports" "&(smtp)&"
21246 .scindex IIDsmttra2 "&(smtp)& transport"
21247 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
21248 or LMTP protocol. The list of hosts to try can either be taken from the address
21249 that is being processed (having been set up by the router), or specified
21250 explicitly for the transport. Timeout and retry processing (see chapter
21251 &<<CHAPretry>>&) is applied to each IP address independently.
21252
21253
21254 .section "Multiple messages on a single connection" "SECID144"
21255 The sending of multiple messages over a single TCP/IP connection can arise in
21256 two ways:
21257
21258 .ilist
21259 If a message contains more than &%max_rcpt%& (see below) addresses that are
21260 routed to the same host, more than one copy of the message has to be sent to
21261 that host. In this situation, multiple copies may be sent in a single run of
21262 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
21263 does when it has too many addresses to send in one message also depends on the
21264 value of the global &%remote_max_parallel%& option. Details are given in
21265 section &<<SECToutSMTPTCP>>&.)
21266 .next
21267 .cindex "hints database" "remembering routing"
21268 When a message has been successfully delivered over a TCP/IP connection, Exim
21269 looks in its hints database to see if there are any other messages awaiting a
21270 connection to the same host. If there are, a new delivery process is started
21271 for one of them, and the current TCP/IP connection is passed on to it. The new
21272 process may in turn send multiple copies and possibly create yet another
21273 process.
21274 .endlist
21275
21276
21277 For each copy sent over the same TCP/IP connection, a sequence counter is
21278 incremented, and if it ever gets to the value of &%connection_max_messages%&,
21279 no further messages are sent over that connection.
21280
21281
21282
21283 .section "Use of the $host and $host_address variables" "SECID145"
21284 .vindex "&$host$&"
21285 .vindex "&$host_address$&"
21286 At the start of a run of the &(smtp)& transport, the values of &$host$& and
21287 &$host_address$& are the name and IP address of the first host on the host list
21288 passed by the router. However, when the transport is about to connect to a
21289 specific host, and while it is connected to that host, &$host$& and
21290 &$host_address$& are set to the values for that host. These are the values
21291 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
21292 &%serialize_hosts%&, and the various TLS options are expanded.
21293
21294
21295 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
21296 .vindex &$tls_cipher$&
21297 .vindex &$tls_peerdn$&
21298 At the start of a run of the &(smtp)& transport, the values of &$tls_cipher$&
21299 and &$tls_peerdn$& are the values that were set when the message was received.
21300 These are the values that are used for options that are expanded before any
21301 SMTP connections are made. Just before each connection is made, these two
21302 variables are emptied. If TLS is subsequently started, they are set to the
21303 appropriate values for the outgoing connection, and these are the values that
21304 are in force when any authenticators are run and when the
21305 &%authenticated_sender%& option is expanded.
21306
21307
21308 .section "Private options for smtp" "SECID146"
21309 .cindex "options" "&(smtp)& transport"
21310 The private options of the &(smtp)& transport are as follows:
21311
21312
21313 .option address_retry_include_sender smtp boolean true
21314 .cindex "4&'xx'& responses" "retrying after"
21315 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
21316 is the combination of sender and recipient that is delayed in subsequent queue
21317 runs until the retry time is reached. You can delay the recipient without
21318 reference to the sender (which is what earlier versions of Exim did), by
21319 setting &%address_retry_include_sender%& false. However, this can lead to
21320 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
21321
21322 .option allow_localhost smtp boolean false
21323 .cindex "local host" "sending to"
21324 .cindex "fallback" "hosts specified on transport"
21325 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
21326 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
21327 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
21328 the delivery anyway. This should be used only in special cases when the
21329 configuration ensures that no looping will result (for example, a differently
21330 configured Exim is listening on the port to which the message is sent).
21331
21332
21333 .option authenticated_sender smtp string&!! unset
21334 .cindex "Cyrus"
21335 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
21336 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
21337 overriding any existing authenticated sender value. If the string expansion is
21338 forced to fail, the option is ignored. Other expansion failures cause delivery
21339 to be deferred. If the result of expansion is an empty string, that is also
21340 ignored.
21341
21342 The expansion happens after the outgoing connection has been made and TLS
21343 started, if required. This means that the &$host$&, &$host_address$&,
21344 &$tls_cipher$&, and &$tls_peerdn$& variables are set according to the
21345 particular connection.
21346
21347 If the SMTP session is not authenticated, the expansion of
21348 &%authenticated_sender%& still happens (and can cause the delivery to be
21349 deferred if it fails), but no AUTH= item is added to MAIL commands
21350 unless &%authenticated_sender_force%& is true.
21351
21352 This option allows you to use the &(smtp)& transport in LMTP mode to
21353 deliver mail to Cyrus IMAP and provide the proper local part as the
21354 &"authenticated sender"&, via a setting such as:
21355 .code
21356 authenticated_sender = $local_part
21357 .endd
21358 This removes the need for IMAP subfolders to be assigned special ACLs to
21359 allow direct delivery to those subfolders.
21360
21361 Because of expected uses such as that just described for Cyrus (when no
21362 domain is involved), there is no checking on the syntax of the provided
21363 value.
21364
21365
21366 .option authenticated_sender_force smtp boolean false
21367 If this option is set true, the &%authenticated_sender%& option's value
21368 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
21369 authenticated as a client.
21370
21371
21372 .option command_timeout smtp time 5m
21373 This sets a timeout for receiving a response to an SMTP command that has been
21374 sent out. It is also used when waiting for the initial banner line from the
21375 remote host. Its value must not be zero.
21376
21377
21378 .option connect_timeout smtp time 5m
21379 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
21380 to a remote host. A setting of zero allows the system timeout (typically
21381 several minutes) to act. To have any effect, the value of this option must be
21382 less than the system timeout. However, it has been observed that on some
21383 systems there is no system timeout, which is why the default value for this
21384 option is 5 minutes, a value recommended by RFC 1123.
21385
21386
21387 .option connection_max_messages smtp integer 500
21388 .cindex "SMTP" "passed connection"
21389 .cindex "SMTP" "multiple deliveries"
21390 .cindex "multiple SMTP deliveries"
21391 This controls the maximum number of separate message deliveries that are sent
21392 over a single TCP/IP connection. If the value is zero, there is no limit.
21393 For testing purposes, this value can be overridden by the &%-oB%& command line
21394 option.
21395
21396
21397 .option data_timeout smtp time 5m
21398 This sets a timeout for the transmission of each block in the data portion of
21399 the message. As a result, the overall timeout for a message depends on the size
21400 of the message. Its value must not be zero. See also &%final_timeout%&.
21401
21402
21403 .option delay_after_cutoff smtp boolean true
21404 This option controls what happens when all remote IP addresses for a given
21405 domain have been inaccessible for so long that they have passed their retry
21406 cutoff times.
21407
21408 In the default state, if the next retry time has not been reached for any of
21409 them, the address is bounced without trying any deliveries. In other words,
21410 Exim delays retrying an IP address after the final cutoff time until a new
21411 retry time is reached, and can therefore bounce an address without ever trying
21412 a delivery, when machines have been down for a long time. Some people are
21413 unhappy at this prospect, so...
21414
21415 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
21416 addresses are past their final cutoff time, Exim tries to deliver to those
21417 IP addresses that have not been tried since the message arrived. If there are
21418 none, of if they all fail, the address is bounced. In other words, it does not
21419 delay when a new message arrives, but immediately tries those expired IP
21420 addresses that haven't been tried since the message arrived. If there is a
21421 continuous stream of messages for the dead hosts, unsetting
21422 &%delay_after_cutoff%& means that there will be many more attempts to deliver
21423 to them.
21424
21425
21426 .option dns_qualify_single smtp boolean true
21427 If the &%hosts%& or &%fallback_hosts%& option is being used,
21428 and the &%gethostbyname%& option is false,
21429 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
21430 in chapter &<<CHAPdnslookup>>& for more details.
21431
21432
21433 .option dns_search_parents smtp boolean false
21434 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
21435 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
21436 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
21437 details.
21438
21439
21440
21441 .option fallback_hosts smtp "string list" unset
21442 .cindex "fallback" "hosts specified on transport"
21443 String expansion is not applied to this option. The argument must be a
21444 colon-separated list of host names or IP addresses, optionally also including
21445 port numbers, though the separator can be changed, as described in section
21446 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
21447 item in a &%route_list%& setting for the &(manualroute)& router, as described
21448 in section &<<SECTformatonehostitem>>&.
21449
21450 Fallback hosts can also be specified on routers, which associate them with the
21451 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
21452 &%fallback_hosts%& specified on the transport is used only if the address does
21453 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
21454 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
21455 However, &%hosts_randomize%& does apply to fallback host lists.
21456
21457 If Exim is unable to deliver to any of the hosts for a particular address, and
21458 the errors are not permanent rejections, the address is put on a separate
21459 transport queue with its host list replaced by the fallback hosts, unless the
21460 address was routed via MX records and the current host was in the original MX
21461 list. In that situation, the fallback host list is not used.
21462
21463 Once normal deliveries are complete, the fallback queue is delivered by
21464 re-running the same transports with the new host lists. If several failing
21465 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
21466 copy of the message is sent.
21467
21468 The resolution of the host names on the fallback list is controlled by the
21469 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
21470 both to cases when the host list comes with the address and when it is taken
21471 from &%hosts%&. This option provides a &"use a smart host only if delivery
21472 fails"& facility.
21473
21474
21475 .option final_timeout smtp time 10m
21476 This is the timeout that applies while waiting for the response to the final
21477 line containing just &"."& that terminates a message. Its value must not be
21478 zero.
21479
21480 .option gethostbyname smtp boolean false
21481 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
21482 being used, names are looked up using &[gethostbyname()]&
21483 (or &[getipnodebyname()]& when available)
21484 instead of using the DNS. Of course, that function may in fact use the DNS, but
21485 it may also consult other sources of information such as &_/etc/hosts_&.
21486
21487 .option gnutls_require_kx smtp string unset
21488 This option controls the key exchange mechanisms when GnuTLS is used in an Exim
21489 client. For details, see section &<<SECTreqciphgnu>>&.
21490
21491 .option gnutls_require_mac smtp string unset
21492 This option controls the MAC algorithms when GnuTLS is used in an Exim
21493 client. For details, see section &<<SECTreqciphgnu>>&.
21494
21495 .option gnutls_require_protocols smtp string unset
21496 This option controls the protocols when GnuTLS is used in an Exim
21497 client. For details, see section &<<SECTreqciphgnu>>&.
21498
21499 .option gnutls_compat_mode smtp boolean unset
21500 This option controls whether GnuTLS is used in compatibility mode in an Exim
21501 server. This reduces security slightly, but improves interworking with older
21502 implementations of TLS.
21503
21504 .option helo_data smtp string&!! "see below"
21505 .cindex "HELO" "argument, setting"
21506 .cindex "EHLO" "argument, setting"
21507 .cindex "LHLO argument setting"
21508 The value of this option is expanded after a connection to a another host has
21509 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
21510 command that starts the outgoing SMTP or LMTP session. The default value of the
21511 option is:
21512 .code
21513 $primary_hostname
21514 .endd
21515 During the expansion, the variables &$host$& and &$host_address$& are set to
21516 the identity of the remote host, and the variables &$sending_ip_address$& and
21517 &$sending_port$& are set to the local IP address and port number that are being
21518 used. These variables can be used to generate different values for different
21519 servers or different local IP addresses. For example, if you want the string
21520 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
21521 interface address, you could use this:
21522 .code
21523 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
21524   {$primary_hostname}}
21525 .endd
21526 The use of &%helo_data%& applies both to sending messages and when doing
21527 callouts.
21528
21529 .option hosts smtp "string list&!!" unset
21530 Hosts are associated with an address by a router such as &(dnslookup)&, which
21531 finds the hosts by looking up the address domain in the DNS, or by
21532 &(manualroute)&, which has lists of hosts in its configuration. However,
21533 email addresses can be passed to the &(smtp)& transport by any router, and not
21534 all of them can provide an associated list of hosts.
21535
21536 The &%hosts%& option specifies a list of hosts to be used if the address being
21537 processed does not have any hosts associated with it. The hosts specified by
21538 &%hosts%& are also used, whether or not the address has its own hosts, if
21539 &%hosts_override%& is set.
21540
21541 The string is first expanded, before being interpreted as a colon-separated
21542 list of host names or IP addresses, possibly including port numbers. The
21543 separator may be changed to something other than colon, as described in section
21544 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
21545 item in a &%route_list%& setting for the &(manualroute)& router, as described
21546 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
21547 of the &(manualroute)& router is not available here.
21548
21549 If the expansion fails, delivery is deferred. Unless the failure was caused by
21550 the inability to complete a lookup, the error is logged to the panic log as
21551 well as the main log. Host names are looked up either by searching directly for
21552 address records in the DNS or by calling &[gethostbyname()]& (or
21553 &[getipnodebyname()]& when available), depending on the setting of the
21554 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
21555 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
21556 address are used.
21557
21558 During delivery, the hosts are tried in order, subject to their retry status,
21559 unless &%hosts_randomize%& is set.
21560
21561
21562 .option hosts_avoid_esmtp smtp "host list&!!" unset
21563 .cindex "ESMTP, avoiding use of"
21564 .cindex "HELO" "forcing use of"
21565 .cindex "EHLO" "avoiding use of"
21566 .cindex "PIPELINING" "avoiding the use of"
21567 This option is for use with broken hosts that announce ESMTP facilities (for
21568 example, PIPELINING) and then fail to implement them properly. When a host
21569 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
21570 start of the SMTP session. This means that it cannot use any of the ESMTP
21571 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
21572
21573
21574 .option hosts_avoid_pipelining smtp "host list&!!" unset
21575 .cindex "PIPELINING" "avoiding the use of"
21576 Exim will not use the SMTP PIPELINING extension when delivering to any host
21577 that matches this list, even if the server host advertises PIPELINING support.
21578
21579
21580 .option hosts_avoid_tls smtp "host list&!!" unset
21581 .cindex "TLS" "avoiding for certain hosts"
21582 Exim will not try to start a TLS session when delivering to any host that
21583 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
21584
21585
21586 .option hosts_max_try smtp integer 5
21587 .cindex "host" "maximum number to try"
21588 .cindex "limit" "number of hosts tried"
21589 .cindex "limit" "number of MX tried"
21590 .cindex "MX record" "maximum tried"
21591 This option limits the number of IP addresses that are tried for any one
21592 delivery in cases where there are temporary delivery errors. Section
21593 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
21594
21595
21596 .option hosts_max_try_hardlimit smtp integer 50
21597 This is an additional check on the maximum number of IP addresses that Exim
21598 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
21599 why it exists.
21600
21601
21602
21603 .option hosts_nopass_tls smtp "host list&!!" unset
21604 .cindex "TLS" "passing connection"
21605 .cindex "multiple SMTP deliveries"
21606 .cindex "TLS" "multiple message deliveries"
21607 For any host that matches this list, a connection on which a TLS session has
21608 been started will not be passed to a new delivery process for sending another
21609 message on the same connection. See section &<<SECTmulmessam>>& for an
21610 explanation of when this might be needed.
21611
21612
21613 .option hosts_override smtp boolean false
21614 If this option is set and the &%hosts%& option is also set, any hosts that are
21615 attached to the address are ignored, and instead the hosts specified by the
21616 &%hosts%& option are always used. This option does not apply to
21617 &%fallback_hosts%&.
21618
21619
21620 .option hosts_randomize smtp boolean false
21621 .cindex "randomized host list"
21622 .cindex "host" "list of; randomized"
21623 .cindex "fallback" "randomized hosts"
21624 If this option is set, and either the list of hosts is taken from the
21625 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
21626 were not obtained from MX records (this includes fallback hosts from the
21627 router), and were not randomized by the router, the order of trying the hosts
21628 is randomized each time the transport runs. Randomizing the order of a host
21629 list can be used to do crude load sharing.
21630
21631 When &%hosts_randomize%& is true, a host list may be split into groups whose
21632 order is separately randomized. This makes it possible to set up MX-like
21633 behaviour. The boundaries between groups are indicated by an item that is just
21634 &`+`& in the host list. For example:
21635 .code
21636 hosts = host1:host2:host3:+:host4:host5
21637 .endd
21638 The order of the first three hosts and the order of the last two hosts is
21639 randomized for each use, but the first three always end up before the last two.
21640 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
21641
21642 .option hosts_require_auth smtp "host list&!!" unset
21643 .cindex "authentication" "required by client"
21644 This option provides a list of servers for which authentication must succeed
21645 before Exim will try to transfer a message. If authentication fails for
21646 servers which are not in this list, Exim tries to send unauthenticated. If
21647 authentication fails for one of these servers, delivery is deferred. This
21648 temporary error is detectable in the retry rules, so it can be turned into a
21649 hard failure if required. See also &%hosts_try_auth%&, and chapter
21650 &<<CHAPSMTPAUTH>>& for details of authentication.
21651
21652
21653 .option hosts_require_tls smtp "host list&!!" unset
21654 .cindex "TLS" "requiring for certain servers"
21655 Exim will insist on using a TLS session when delivering to any host that
21656 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
21657 &*Note*&: This option affects outgoing mail only. To insist on TLS for
21658 incoming messages, use an appropriate ACL.
21659
21660 .option hosts_try_auth smtp "host list&!!" unset
21661 .cindex "authentication" "optional in client"
21662 This option provides a list of servers to which, provided they announce
21663 authentication support, Exim will attempt to authenticate as a client when it
21664 connects. If authentication fails, Exim will try to transfer the message
21665 unauthenticated. See also &%hosts_require_auth%&, and chapter
21666 &<<CHAPSMTPAUTH>>& for details of authentication.
21667
21668 .option interface smtp "string list&!!" unset
21669 .cindex "bind IP address"
21670 .cindex "IP address" "binding"
21671 .vindex "&$host$&"
21672 .vindex "&$host_address$&"
21673 This option specifies which interface to bind to when making an outgoing SMTP
21674 call. The value is an IP address, not an interface name such as
21675 &`eth0`&. Do not confuse this with the interface address that was used when a
21676 message was received, which is in &$received_ip_address$&, formerly known as
21677 &$interface_address$&. The name was changed to minimize confusion with the
21678 outgoing interface address. There is no variable that contains an outgoing
21679 interface address because, unless it is set by this option, its value is
21680 unknown.
21681
21682 During the expansion of the &%interface%& option the variables &$host$& and
21683 &$host_address$& refer to the host to which a connection is about to be made
21684 during the expansion of the string. Forced expansion failure, or an empty
21685 string result causes the option to be ignored. Otherwise, after expansion, the
21686 string must be a list of IP addresses, colon-separated by default, but the
21687 separator can be changed in the usual way. For example:
21688 .code
21689 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
21690 .endd
21691 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
21692 connection. If none of them are the correct type, the option is ignored. If
21693 &%interface%& is not set, or is ignored, the system's IP functions choose which
21694 interface to use if the host has more than one.
21695
21696
21697 .option keepalive smtp boolean true
21698 .cindex "keepalive" "on outgoing connection"
21699 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
21700 connections. When set, it causes the kernel to probe idle connections
21701 periodically, by sending packets with &"old"& sequence numbers. The other end
21702 of the connection should send a acknowledgment if the connection is still okay
21703 or a reset if the connection has been aborted. The reason for doing this is
21704 that it has the beneficial effect of freeing up certain types of connection
21705 that can get stuck when the remote host is disconnected without tidying up the
21706 TCP/IP call properly. The keepalive mechanism takes several hours to detect
21707 unreachable hosts.
21708
21709
21710 .option lmtp_ignore_quota smtp boolean false
21711 .cindex "LMTP" "ignoring quota errors"
21712 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
21713 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
21714 has advertised support for IGNOREQUOTA in its response to the LHLO command.
21715
21716 .option max_rcpt smtp integer 100
21717 .cindex "RCPT" "maximum number of outgoing"
21718 This option limits the number of RCPT commands that are sent in a single
21719 SMTP message transaction. Each set of addresses is treated independently, and
21720 so can cause parallel connections to the same host if &%remote_max_parallel%&
21721 permits this.
21722
21723
21724 .option multi_domain smtp boolean true
21725 .vindex "&$domain$&"
21726 When this option is set, the &(smtp)& transport can handle a number of
21727 addresses containing a mixture of different domains provided they all resolve
21728 to the same list of hosts. Turning the option off restricts the transport to
21729 handling only one domain at a time. This is useful if you want to use
21730 &$domain$& in an expansion for the transport, because it is set only when there
21731 is a single domain involved in a remote delivery.
21732
21733
21734 .option port smtp string&!! "see below"
21735 .cindex "port" "sending TCP/IP"
21736 .cindex "TCP/IP" "setting outgoing port"
21737 This option specifies the TCP/IP port on the server to which Exim connects.
21738 &*Note:*& Do not confuse this with the port that was used when a message was
21739 received, which is in &$received_port$&, formerly known as &$interface_port$&.
21740 The name was changed to minimize confusion with the outgoing port. There is no
21741 variable that contains an outgoing port.
21742
21743 If the value of this option begins with a digit it is taken as a port number;
21744 otherwise it is looked up using &[getservbyname()]&. The default value is
21745 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
21746 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
21747 is deferred.
21748
21749
21750
21751 .option protocol smtp string smtp
21752 .cindex "LMTP" "over TCP/IP"
21753 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
21754 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
21755 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
21756 deliveries into closed message stores. Exim also has support for running LMTP
21757 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
21758
21759
21760 .option retry_include_ip_address smtp boolean true
21761 Exim normally includes both the host name and the IP address in the key it
21762 constructs for indexing retry data after a temporary delivery failure. This
21763 means that when one of several IP addresses for a host is failing, it gets
21764 tried periodically (controlled by the retry rules), but use of the other IP
21765 addresses is not affected.
21766
21767 However, in some dialup environments hosts are assigned a different IP address
21768 each time they connect. In this situation the use of the IP address as part of
21769 the retry key leads to undesirable behaviour. Setting this option false causes
21770 Exim to use only the host name. This should normally be done on a separate
21771 instance of the &(smtp)& transport, set up specially to handle the dialup
21772 hosts.
21773
21774
21775 .option serialize_hosts smtp "host list&!!" unset
21776 .cindex "serializing connections"
21777 .cindex "host" "serializing connections"
21778 Because Exim operates in a distributed manner, if several messages for the same
21779 host arrive at around the same time, more than one simultaneous connection to
21780 the remote host can occur. This is not usually a problem except when there is a
21781 slow link between the hosts. In that situation it may be helpful to restrict
21782 Exim to one connection at a time. This can be done by setting
21783 &%serialize_hosts%& to match the relevant hosts.
21784
21785 .cindex "hints database" "serializing deliveries to a host"
21786 Exim implements serialization by means of a hints database in which a record is
21787 written whenever a process connects to one of the restricted hosts. The record
21788 is deleted when the connection is completed. Obviously there is scope for
21789 records to get left lying around if there is a system or program crash. To
21790 guard against this, Exim ignores any records that are more than six hours old.
21791
21792 If you set up this kind of serialization, you should also arrange to delete the
21793 relevant hints database whenever your system reboots. The names of the files
21794 start with &_misc_& and they are kept in the &_spool/db_& directory. There
21795 may be one or two files, depending on the type of DBM in use. The same files
21796 are used for ETRN serialization.
21797
21798
21799 .option size_addition smtp integer 1024
21800 .cindex "SMTP" "SIZE"
21801 .cindex "message" "size issue for transport filter"
21802 .cindex "size" "of message"
21803 .cindex "transport" "filter"
21804 .cindex "filter" "transport filter"
21805 If a remote SMTP server indicates that it supports the SIZE option of the
21806 MAIL command, Exim uses this to pass over the message size at the start of
21807 an SMTP transaction. It adds the value of &%size_addition%& to the value it
21808 sends, to allow for headers and other text that may be added during delivery by
21809 configuration options or in a transport filter. It may be necessary to increase
21810 this if a lot of text is added to messages.
21811
21812 Alternatively, if the value of &%size_addition%& is set negative, it disables
21813 the use of the SIZE option altogether.
21814
21815
21816 .option tls_certificate smtp string&!! unset
21817 .cindex "TLS" "client certificate, location of"
21818 .cindex "certificate" "client, location of"
21819 .vindex "&$host$&"
21820 .vindex "&$host_address$&"
21821 The value of this option must be the absolute path to a file which contains the
21822 client's certificate, for possible use when sending a message over an encrypted
21823 connection. The values of &$host$& and &$host_address$& are set to the name and
21824 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
21825 details of TLS.
21826
21827 &*Note*&: This option must be set if you want Exim to be able to use a TLS
21828 certificate when sending messages as a client. The global option of the same
21829 name specifies the certificate for Exim as a server; it is not automatically
21830 assumed that the same certificate should be used when Exim is operating as a
21831 client.
21832
21833
21834 .option tls_crl smtp string&!! unset
21835 .cindex "TLS" "client certificate revocation list"
21836 .cindex "certificate" "revocation list for client"
21837 This option specifies a certificate revocation list. The expanded value must
21838 be the name of a file that contains a CRL in PEM format.
21839
21840
21841 .option tls_privatekey smtp string&!! unset
21842 .cindex "TLS" "client private key, location of"
21843 .vindex "&$host$&"
21844 .vindex "&$host_address$&"
21845 The value of this option must be the absolute path to a file which contains the
21846 client's private key. This is used when sending a message over an encrypted
21847 connection using a client certificate. The values of &$host$& and
21848 &$host_address$& are set to the name and address of the server during the
21849 expansion. If this option is unset, or the expansion is forced to fail, or the
21850 result is an empty string, the private key is assumed to be in the same file as
21851 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
21852
21853
21854 .option tls_require_ciphers smtp string&!! unset
21855 .cindex "TLS" "requiring specific ciphers"
21856 .cindex "cipher" "requiring specific"
21857 .vindex "&$host$&"
21858 .vindex "&$host_address$&"
21859 The value of this option must be a list of permitted cipher suites, for use
21860 when setting up an outgoing encrypted connection. (There is a global option of
21861 the same name for controlling incoming connections.) The values of &$host$& and
21862 &$host_address$& are set to the name and address of the server during the
21863 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
21864 is used in different ways by OpenSSL and GnuTLS (see sections
21865 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
21866 ciphers is a preference order.
21867
21868
21869
21870 .option tls_tempfail_tryclear smtp boolean true
21871 .cindex "4&'xx'& responses" "to STARTTLS"
21872 When the server host is not in &%hosts_require_tls%&, and there is a problem in
21873 setting up a TLS session, this option determines whether or not Exim should try
21874 to deliver the message unencrypted. If it is set false, delivery to the
21875 current host is deferred; if there are other hosts, they are tried. If this
21876 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
21877 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
21878 TLS negotiation fails, Exim closes the current connection (because it is in an
21879 unknown state), opens a new one to the same host, and then tries the delivery
21880 in clear.
21881
21882
21883 .option tls_verify_certificates smtp string&!! unset
21884 .cindex "TLS" "server certificate verification"
21885 .cindex "certificate" "verification of server"
21886 .vindex "&$host$&"
21887 .vindex "&$host_address$&"
21888 The value of this option must be the absolute path to a file containing
21889 permitted server certificates, for use when setting up an encrypted connection.
21890 Alternatively, if you are using OpenSSL, you can set
21891 &%tls_verify_certificates%& to the name of a directory containing certificate
21892 files. This does not work with GnuTLS; the option must be set to the name of a
21893 single file if you are using GnuTLS. The values of &$host$& and
21894 &$host_address$& are set to the name and address of the server during the
21895 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
21896
21897
21898
21899
21900 .section "How the limits for the number of hosts to try are used" &&&
21901          "SECTvalhosmax"
21902 .cindex "host" "maximum number to try"
21903 .cindex "limit" "hosts; maximum number tried"
21904 There are two options that are concerned with the number of hosts that are
21905 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
21906 &%hosts_max_try_hardlimit%&.
21907
21908
21909 The &%hosts_max_try%& option limits the number of hosts that are tried
21910 for a single delivery. However, despite the term &"host"& in its name, the
21911 option actually applies to each IP address independently. In other words, a
21912 multihomed host is treated as several independent hosts, just as it is for
21913 retrying.
21914
21915 Many of the larger ISPs have multiple MX records which often point to
21916 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
21917 created as a result of routing one of these domains.
21918
21919 Trying every single IP address on such a long list does not seem sensible; if
21920 several at the top of the list fail, it is reasonable to assume there is some
21921 problem that is likely to affect all of them. Roughly speaking, the value of
21922 &%hosts_max_try%& is the maximum number that are tried before deferring the
21923 delivery. However, the logic cannot be quite that simple.
21924
21925 Firstly, IP addresses that are skipped because their retry times have not
21926 arrived do not count, and in addition, addresses that are past their retry
21927 limits are also not counted, even when they are tried. This means that when
21928 some IP addresses are past their retry limits, more than the value of
21929 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
21930 that all IP addresses are considered before timing out an email address (but
21931 see below for an exception).
21932
21933 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
21934 list to see if there is a subsequent host with a different (higher valued) MX.
21935 If there is, that host is considered next, and the current IP address is used
21936 but not counted. This behaviour helps in the case of a domain with a retry rule
21937 that hardly ever delays any hosts, as is now explained:
21938
21939 Consider the case of a long list of hosts with one MX value, and a few with a
21940 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
21941 hosts at the top of the list are tried at first. With the default retry rule,
21942 which specifies increasing retry times, the higher MX hosts are eventually
21943 tried when those at the top of the list are skipped because they have not
21944 reached their retry times.
21945
21946 However, it is common practice to put a fixed short retry time on domains for
21947 large ISPs, on the grounds that their servers are rarely down for very long.
21948 Unfortunately, these are exactly the domains that tend to resolve to long lists
21949 of hosts. The short retry time means that the lowest MX hosts are tried every
21950 time. The attempts may be in a different order because of random sorting, but
21951 without the special MX check, the higher MX hosts would never be tried until
21952 all the lower MX hosts had timed out (which might be several days), because
21953 there are always some lower MX hosts that have reached their retry times. With
21954 the special check, Exim considers at least one IP address from each MX value at
21955 every delivery attempt, even if the &%hosts_max_try%& limit has already been
21956 reached.
21957
21958 The above logic means that &%hosts_max_try%& is not a hard limit, and in
21959 particular, Exim normally eventually tries all the IP addresses before timing
21960 out an email address. When &%hosts_max_try%& was implemented, this seemed a
21961 reasonable thing to do. Recently, however, some lunatic DNS configurations have
21962 been set up with hundreds of IP addresses for some domains. It can
21963 take a very long time indeed for an address to time out in these cases.
21964
21965 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
21966 Exim never tries more than this number of IP addresses; if it hits this limit
21967 and they are all timed out, the email address is bounced, even though not all
21968 possible IP addresses have been tried.
21969 .ecindex IIDsmttra1
21970 .ecindex IIDsmttra2
21971
21972
21973
21974
21975
21976 . ////////////////////////////////////////////////////////////////////////////
21977 . ////////////////////////////////////////////////////////////////////////////
21978
21979 .chapter "Address rewriting" "CHAPrewrite"
21980 .scindex IIDaddrew "rewriting" "addresses"
21981 There are some circumstances in which Exim automatically rewrites domains in
21982 addresses. The two most common are when an address is given without a domain
21983 (referred to as an &"unqualified address"&) or when an address contains an
21984 abbreviated domain that is expanded by DNS lookup.
21985
21986 Unqualified envelope addresses are accepted only for locally submitted
21987 messages, or for messages that are received from hosts matching
21988 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
21989 appropriate. Unqualified addresses in header lines are qualified if they are in
21990 locally submitted messages, or messages from hosts that are permitted to send
21991 unqualified envelope addresses. Otherwise, unqualified addresses in header
21992 lines are neither qualified nor rewritten.
21993
21994 One situation in which Exim does &'not'& automatically rewrite a domain is
21995 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
21996 such a domain should be rewritten using the &"canonical"& name, and some MTAs
21997 do this. The new RFCs do not contain this suggestion.
21998
21999
22000 .section "Explicitly configured address rewriting" "SECID147"
22001 This chapter describes the rewriting rules that can be used in the
22002 main rewrite section of the configuration file, and also in the generic
22003 &%headers_rewrite%& option that can be set on any transport.
22004
22005 Some people believe that configured address rewriting is a Mortal Sin.
22006 Others believe that life is not possible without it. Exim provides the
22007 facility; you do not have to use it.
22008
22009 The main rewriting rules that appear in the &"rewrite"& section of the
22010 configuration file are applied to addresses in incoming messages, both envelope
22011 addresses and addresses in header lines. Each rule specifies the types of
22012 address to which it applies.
22013
22014 Whether or not addresses in header lines are rewritten depends on the origin of
22015 the headers and the type of rewriting. Global rewriting, that is, rewriting
22016 rules from the rewrite section of the configuration file, is applied only to
22017 those headers that were received with the message. Header lines that are added
22018 by ACLs or by a system filter or by individual routers or transports (which
22019 are specific to individual recipient addresses) are not rewritten by the global
22020 rules.
22021
22022 Rewriting at transport time, by means of the &%headers_rewrite%& option,
22023 applies all headers except those added by routers and transports. That is, as
22024 well as the headers that were received with the message, it also applies to
22025 headers that were added by an ACL or a system filter.
22026
22027
22028 In general, rewriting addresses from your own system or domain has some
22029 legitimacy. Rewriting other addresses should be done only with great care and
22030 in special circumstances. The author of Exim believes that rewriting should be
22031 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
22032 Although it can sometimes be used as a routing tool, this is very strongly
22033 discouraged.
22034
22035 There are two commonly encountered circumstances where rewriting is used, as
22036 illustrated by these examples:
22037
22038 .ilist
22039 The company whose domain is &'hitch.fict.example'& has a number of hosts that
22040 exchange mail with each other behind a firewall, but there is only a single
22041 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
22042 &'hitch.fict.example'& when sending mail off-site.
22043 .next
22044 A host rewrites the local parts of its own users so that, for example,
22045 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
22046 .endlist
22047
22048
22049
22050 .section "When does rewriting happen?" "SECID148"
22051 .cindex "rewriting" "timing of"
22052 .cindex "&ACL;" "rewriting addresses in"
22053 Configured address rewriting can take place at several different stages of a
22054 message's processing.
22055
22056 .vindex "&$sender_address$&"
22057 At the start of an ACL for MAIL, the sender address may have been rewritten
22058 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
22059 ordinary rewrite rules have yet been applied. If, however, the sender address
22060 is verified in the ACL, it is rewritten before verification, and remains
22061 rewritten thereafter. The subsequent value of &$sender_address$& is the
22062 rewritten address. This also applies if sender verification happens in a
22063 RCPT ACL. Otherwise, when the sender address is not verified, it is
22064 rewritten as soon as a message's header lines have been received.
22065
22066 .vindex "&$domain$&"
22067 .vindex "&$local_part$&"
22068 Similarly, at the start of an ACL for RCPT, the current recipient's address
22069 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
22070 rewrite rules have yet been applied to it. However, the behaviour is different
22071 from the sender address when a recipient is verified. The address is rewritten
22072 for the verification, but the rewriting is not remembered at this stage. The
22073 value of &$local_part$& and &$domain$& after verification are always the same
22074 as they were before (that is, they contain the unrewritten &-- except for
22075 SMTP-time rewriting &-- address).
22076
22077 As soon as a message's header lines have been received, all the envelope
22078 recipient addresses are permanently rewritten, and rewriting is also applied to
22079 the addresses in the header lines (if configured). This happens before adding
22080 any header lines that were specified in MAIL or RCPT ACLs, and
22081 .cindex "&[local_scan()]& function" "address rewriting; timing of"
22082 before the DATA ACL and &[local_scan()]& functions are run.
22083
22084 When an address is being routed, either for delivery or for verification,
22085 rewriting is applied immediately to child addresses that are generated by
22086 redirection, unless &%no_rewrite%& is set on the router.
22087
22088 .cindex "envelope sender" "rewriting at transport time"
22089 .cindex "rewriting" "at transport time"
22090 .cindex "header lines" "rewriting at transport time"
22091 At transport time, additional rewriting of addresses in header lines can be
22092 specified by setting the generic &%headers_rewrite%& option on a transport.
22093 This option contains rules that are identical in form to those in the rewrite
22094 section of the configuration file. They are applied to the original message
22095 header lines and any that were added by ACLs or a system filter. They are not
22096 applied to header lines that are added by routers or the transport.
22097
22098 The outgoing envelope sender can be rewritten by means of the &%return_path%&
22099 transport option. However, it is not possible to rewrite envelope recipients at
22100 transport time.
22101
22102
22103
22104
22105 .section "Testing the rewriting rules that apply on input" "SECID149"
22106 .cindex "rewriting" "testing"
22107 .cindex "testing" "rewriting"
22108 Exim's input rewriting configuration appears in a part of the run time
22109 configuration file headed by &"begin rewrite"&. It can be tested by the
22110 &%-brw%& command line option. This takes an address (which can be a full RFC
22111 2822 address) as its argument. The output is a list of how the address would be
22112 transformed by the rewriting rules for each of the different places it might
22113 appear in an incoming message, that is, for each different header and for the
22114 envelope sender and recipient fields. For example,
22115 .code
22116 exim -brw ph10@exim.workshop.example
22117 .endd
22118 might produce the output
22119 .code
22120 sender: Philip.Hazel@exim.workshop.example
22121 from: Philip.Hazel@exim.workshop.example
22122 to: ph10@exim.workshop.example
22123 cc: ph10@exim.workshop.example
22124 bcc: ph10@exim.workshop.example
22125 reply-to: Philip.Hazel@exim.workshop.example
22126 env-from: Philip.Hazel@exim.workshop.example
22127 env-to: ph10@exim.workshop.example
22128 .endd
22129 which shows that rewriting has been set up for that address when used in any of
22130 the source fields, but not when it appears as a recipient address. At the
22131 present time, there is no equivalent way of testing rewriting rules that are
22132 set for a particular transport.
22133
22134
22135 .section "Rewriting rules" "SECID150"
22136 .cindex "rewriting" "rules"
22137 The rewrite section of the configuration file consists of lines of rewriting
22138 rules in the form
22139 .display
22140 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
22141 .endd
22142 Rewriting rules that are specified for the &%headers_rewrite%& generic
22143 transport option are given as a colon-separated list. Each item in the list
22144 takes the same form as a line in the main rewriting configuration (except that
22145 any colons must be doubled, of course).
22146
22147 The formats of source patterns and replacement strings are described below.
22148 Each is terminated by white space, unless enclosed in double quotes, in which
22149 case normal quoting conventions apply inside the quotes. The flags are single
22150 characters which may appear in any order. Spaces and tabs between them are
22151 ignored.
22152
22153 For each address that could potentially be rewritten, the rules are scanned in
22154 order, and replacements for the address from earlier rules can themselves be
22155 replaced by later rules (but see the &"q"& and &"R"& flags).
22156
22157 The order in which addresses are rewritten is undefined, may change between
22158 releases, and must not be relied on, with one exception: when a message is
22159 received, the envelope sender is always rewritten first, before any header
22160 lines are rewritten. For example, the replacement string for a rewrite of an
22161 address in &'To:'& must not assume that the message's address in &'From:'& has
22162 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
22163 that the envelope sender has already been rewritten.
22164
22165 .vindex "&$domain$&"
22166 .vindex "&$local_part$&"
22167 The variables &$local_part$& and &$domain$& can be used in the replacement
22168 string to refer to the address that is being rewritten. Note that lookup-driven
22169 rewriting can be done by a rule of the form
22170 .code
22171 *@*   ${lookup ...
22172 .endd
22173 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
22174 refer to the address that is being rewritten.
22175
22176
22177 .section "Rewriting patterns" "SECID151"
22178 .cindex "rewriting" "patterns"
22179 .cindex "address list" "in a rewriting pattern"
22180 The source pattern in a rewriting rule is any item which may appear in an
22181 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
22182 single-item address list, which means that it is expanded before being tested
22183 against the address. As always, if you use a regular expression as a pattern,
22184 you must take care to escape dollar and backslash characters, or use the &`\N`&
22185 facility to suppress string expansion within the regular expression.
22186
22187 Domains in patterns should be given in lower case. Local parts in patterns are
22188 case-sensitive. If you want to do case-insensitive matching of local parts, you
22189 can use a regular expression that starts with &`^(?i)`&.
22190
22191 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
22192 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
22193 depending on the type of match which occurred. These can be used in the
22194 replacement string to insert portions of the incoming address. &$0$& always
22195 refers to the complete incoming address. When a regular expression is used, the
22196 numerical variables are set from its capturing subexpressions. For other types
22197 of pattern they are set as follows:
22198
22199 .ilist
22200 If a local part or domain starts with an asterisk, the numerical variables
22201 refer to the character strings matched by asterisks, with &$1$& associated with
22202 the first asterisk, and &$2$& with the second, if present. For example, if the
22203 pattern
22204 .code
22205 *queen@*.fict.example
22206 .endd
22207 is matched against the address &'hearts-queen@wonderland.fict.example'& then
22208 .code
22209 $0 = hearts-queen@wonderland.fict.example
22210 $1 = hearts-
22211 $2 = wonderland
22212 .endd
22213 Note that if the local part does not start with an asterisk, but the domain
22214 does, it is &$1$& that contains the wild part of the domain.
22215
22216 .next
22217 If the domain part of the pattern is a partial lookup, the wild and fixed parts
22218 of the domain are placed in the next available numerical variables. Suppose,
22219 for example, that the address &'foo@bar.baz.example'& is processed by a
22220 rewriting rule of the form
22221 .display
22222 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
22223 .endd
22224 and the key in the file that matches the domain is &`*.baz.example`&. Then
22225 .code
22226 $1 = foo
22227 $2 = bar
22228 $3 = baz.example
22229 .endd
22230 If the address &'foo@baz.example'& is looked up, this matches the same
22231 wildcard file entry, and in this case &$2$& is set to the empty string, but
22232 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
22233 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
22234 whole domain. For non-partial domain lookups, no numerical variables are set.
22235 .endlist
22236
22237
22238 .section "Rewriting replacements" "SECID152"
22239 .cindex "rewriting" "replacements"
22240 If the replacement string for a rule is a single asterisk, addresses that
22241 match the pattern and the flags are &'not'& rewritten, and no subsequent
22242 rewriting rules are scanned. For example,
22243 .code
22244 hatta@lookingglass.fict.example  *  f
22245 .endd
22246 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
22247 &'From:'& headers.
22248
22249 .vindex "&$domain$&"
22250 .vindex "&$local_part$&"
22251 If the replacement string is not a single asterisk, it is expanded, and must
22252 yield a fully qualified address. Within the expansion, the variables
22253 &$local_part$& and &$domain$& refer to the address that is being rewritten.
22254 Any letters they contain retain their original case &-- they are not lower
22255 cased. The numerical variables are set up according to the type of pattern that
22256 matched the address, as described above. If the expansion is forced to fail by
22257 the presence of &"fail"& in a conditional or lookup item, rewriting by the
22258 current rule is abandoned, but subsequent rules may take effect. Any other
22259 expansion failure causes the entire rewriting operation to be abandoned, and an
22260 entry written to the panic log.
22261
22262
22263
22264 .section "Rewriting flags" "SECID153"
22265 There are three different kinds of flag that may appear on rewriting rules:
22266
22267 .ilist
22268 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
22269 c, f, h, r, s, t.
22270 .next
22271 A flag that specifies rewriting at SMTP time: S.
22272 .next
22273 Flags that control the rewriting process: Q, q, R, w.
22274 .endlist
22275
22276 For rules that are part of the &%headers_rewrite%& generic transport option,
22277 E, F, T, and S are not permitted.
22278
22279
22280
22281 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
22282          "SECID154"
22283 .cindex "rewriting" "flags"
22284 If none of the following flag letters, nor the &"S"& flag (see section
22285 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
22286 and to both the sender and recipient fields of the envelope, whereas a
22287 transport-time rewriting rule just applies to all headers. Otherwise, the
22288 rewriting rule is skipped unless the relevant addresses are being processed.
22289 .display
22290 &`E`&       rewrite all envelope fields
22291 &`F`&       rewrite the envelope From field
22292 &`T`&       rewrite the envelope To field
22293 &`b`&       rewrite the &'Bcc:'& header
22294 &`c`&       rewrite the &'Cc:'& header
22295 &`f`&       rewrite the &'From:'& header
22296 &`h`&       rewrite all headers
22297 &`r`&       rewrite the &'Reply-To:'& header
22298 &`s`&       rewrite the &'Sender:'& header
22299 &`t`&       rewrite the &'To:'& header
22300 .endd
22301 "All headers" means all of the headers listed above that can be selected
22302 individually, plus their &'Resent-'& versions. It does not include
22303 other headers such as &'Subject:'& etc.
22304
22305 You should be particularly careful about rewriting &'Sender:'& headers, and
22306 restrict this to special known cases in your own domains.
22307
22308
22309 .section "The SMTP-time rewriting flag" "SECTrewriteS"
22310 .cindex "SMTP" "rewriting malformed addresses"
22311 .cindex "RCPT" "rewriting argument of"
22312 .cindex "MAIL" "rewriting argument of"
22313 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
22314 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
22315 before any other processing; even before syntax checking. The pattern is
22316 required to be a regular expression, and it is matched against the whole of the
22317 data for the command, including any surrounding angle brackets.
22318
22319 .vindex "&$domain$&"
22320 .vindex "&$local_part$&"
22321 This form of rewrite rule allows for the handling of addresses that are not
22322 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
22323 input). Because the input is not required to be a syntactically valid address,
22324 the variables &$local_part$& and &$domain$& are not available during the
22325 expansion of the replacement string. The result of rewriting replaces the
22326 original address in the MAIL or RCPT command.
22327
22328
22329 .section "Flags controlling the rewriting process" "SECID155"
22330 There are four flags which control the way the rewriting process works. These
22331 take effect only when a rule is invoked, that is, when the address is of the
22332 correct type (matches the flags) and matches the pattern:
22333
22334 .ilist
22335 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
22336 unqualified local part. It is qualified with &%qualify_recipient%&. In the
22337 absence of &"Q"& the rewritten address must always include a domain.
22338 .next
22339 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
22340 even if no rewriting actually takes place because of a &"fail"& in the
22341 expansion. The &"q"& flag is not effective if the address is of the wrong type
22342 (does not match the flags) or does not match the pattern.
22343 .next
22344 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
22345 address, up to ten times. It can be combined with the &"q"& flag, to stop
22346 rewriting once it fails to match (after at least one successful rewrite).
22347 .next
22348 .cindex "rewriting" "whole addresses"
22349 When an address in a header is rewritten, the rewriting normally applies only
22350 to the working part of the address, with any comments and RFC 2822 &"phrase"&
22351 left unchanged. For example, rewriting might change
22352 .code
22353 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
22354 .endd
22355 into
22356 .code
22357 From: Ford Prefect <prefectf@hitch.fict.example>
22358 .endd
22359 .cindex "RFC 2047"
22360 Sometimes there is a need to replace the whole address item, and this can be
22361 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
22362 causes an address in a header line to be rewritten, the entire address is
22363 replaced, not just the working part. The replacement must be a complete RFC
22364 2822 address, including the angle brackets if necessary. If text outside angle
22365 brackets contains a character whose value is greater than 126 or less than 32
22366 (except for tab), the text is encoded according to RFC 2047. The character set
22367 is taken from &%headers_charset%&, which defaults to ISO-8859-1.
22368
22369 When the &"w"& flag is set on a rule that causes an envelope address to be
22370 rewritten, all but the working part of the replacement address is discarded.
22371 .endlist
22372
22373
22374 .section "Rewriting examples" "SECID156"
22375 Here is an example of the two common rewriting paradigms:
22376 .code
22377 *@*.hitch.fict.example  $1@hitch.fict.example
22378 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
22379                      {$value}fail}@hitch.fict.example bctfrF
22380 .endd
22381 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
22382 the string expansion to fail if the lookup does not succeed. In this context it
22383 has the effect of leaving the original address unchanged, but Exim goes on to
22384 consider subsequent rewriting rules, if any, because the &"q"& flag is not
22385 present in that rule. An alternative to &"fail"& would be to supply &$1$&
22386 explicitly, which would cause the rewritten address to be the same as before,
22387 at the cost of a small bit of processing. Not supplying either of these is an
22388 error, since the rewritten address would then contain no local part.
22389
22390 The first example above replaces the domain with a superior, more general
22391 domain. This may not be desirable for certain local parts. If the rule
22392 .code
22393 root@*.hitch.fict.example  *
22394 .endd
22395 were inserted before the first rule, rewriting would be suppressed for the
22396 local part &'root'& at any domain ending in &'hitch.fict.example'&.
22397
22398 Rewriting can be made conditional on a number of tests, by making use of
22399 &${if$& in the expansion item. For example, to apply a rewriting rule only to
22400 messages that originate outside the local host:
22401 .code
22402 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
22403                          {$1@hitch.fict.example}fail}"
22404 .endd
22405 The replacement string is quoted in this example because it contains white
22406 space.
22407
22408 .cindex "rewriting" "bang paths"
22409 .cindex "bang paths" "rewriting"
22410 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
22411 an address it treats it as an unqualified local part which it qualifies with
22412 the local qualification domain (if the source of the message is local or if the
22413 remote host is permitted to send unqualified addresses). Rewriting can
22414 sometimes be used to handle simple bang paths with a fixed number of
22415 components. For example, the rule
22416 .code
22417 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
22418 .endd
22419 rewrites a two-component bang path &'host.name!user'& as the domain address
22420 &'user@host.name'&. However, there is a security implication in using this as
22421 a global rewriting rule for envelope addresses. It can provide a backdoor
22422 method for using your system as a relay, because the incoming addresses appear
22423 to be local. If the bang path addresses are received via SMTP, it is safer to
22424 use the &"S"& flag to rewrite them as they are received, so that relay checking
22425 can be done on the rewritten addresses.
22426 .ecindex IIDaddrew
22427
22428
22429
22430
22431
22432 . ////////////////////////////////////////////////////////////////////////////
22433 . ////////////////////////////////////////////////////////////////////////////
22434
22435 .chapter "Retry configuration" "CHAPretry"
22436 .scindex IIDretconf1 "retry" "configuration, description of"
22437 .scindex IIDregconf2 "configuration file" "retry section"
22438 The &"retry"& section of the runtime configuration file contains a list of
22439 retry rules that control how often Exim tries to deliver messages that cannot
22440 be delivered at the first attempt. If there are no retry rules (the section is
22441 empty or not present), there are no retries. In this situation, temporary
22442 errors are treated as permanent. The default configuration contains a single,
22443 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
22444 line option can be used to test which retry rule will be used for a given
22445 address, domain and error.
22446
22447 The most common cause of retries is temporary failure to deliver to a remote
22448 host because the host is down, or inaccessible because of a network problem.
22449 Exim's retry processing in this case is applied on a per-host (strictly, per IP
22450 address) basis, not on a per-message basis. Thus, if one message has recently
22451 been delayed, delivery of a new message to the same host is not immediately
22452 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
22453 log selector is set, the message
22454 .cindex "retry" "time not reached"
22455 &"retry time not reached"& is written to the main log whenever a delivery is
22456 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
22457 the handling of errors during remote deliveries.
22458
22459 Retry processing applies to routing as well as to delivering, except as covered
22460 in the next paragraph. The retry rules do not distinguish between these
22461 actions. It is not possible, for example, to specify different behaviour for
22462 failures to route the domain &'snark.fict.example'& and failures to deliver to
22463 the host &'snark.fict.example'&. I didn't think anyone would ever need this
22464 added complication, so did not implement it. However, although they share the
22465 same retry rule, the actual retry times for routing and transporting a given
22466 domain are maintained independently.
22467
22468 When a delivery is not part of a queue run (typically an immediate delivery on
22469 receipt of a message), the routers are always run, and local deliveries are
22470 always attempted, even if retry times are set for them. This makes for better
22471 behaviour if one particular message is causing problems (for example, causing
22472 quota overflow, or provoking an error in a filter file). If such a delivery
22473 suffers a temporary failure, the retry data is updated as normal, and
22474 subsequent delivery attempts from queue runs occur only when the retry time for
22475 the local address is reached.
22476
22477 .section "Changing retry rules" "SECID157"
22478 If you change the retry rules in your configuration, you should consider
22479 whether or not to delete the retry data that is stored in Exim's spool area in
22480 files with names like &_db/retry_&. Deleting any of Exim's hints files is
22481 always safe; that is why they are called &"hints"&.
22482
22483 The hints retry data contains suggested retry times based on the previous
22484 rules. In the case of a long-running problem with a remote host, it might
22485 record the fact that the host has timed out. If your new rules increase the
22486 timeout time for such a host, you should definitely remove the old retry data
22487 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
22488 messages that it should now be retaining.
22489
22490
22491
22492 .section "Format of retry rules" "SECID158"
22493 .cindex "retry" "rules"
22494 Each retry rule occupies one line and consists of three or four parts,
22495 separated by white space: a pattern, an error name, an optional list of sender
22496 addresses, and a list of retry parameters. The pattern and sender lists must be
22497 enclosed in double quotes if they contain white space. The rules are searched
22498 in order until one is found where the pattern, error name, and sender list (if
22499 present) match the failing host or address, the error that occurred, and the
22500 message's sender, respectively.
22501
22502
22503 The pattern is any single item that may appear in an address list (see section
22504 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
22505 which means that it is expanded before being tested against the address that
22506 has been delayed. A negated address list item is permitted. Address
22507 list processing treats a plain domain name as if it were preceded by &"*@"&,
22508 which makes it possible for many retry rules to start with just a domain. For
22509 example,
22510 .code
22511 lookingglass.fict.example        *  F,24h,30m;
22512 .endd
22513 provides a rule for any address in the &'lookingglass.fict.example'& domain,
22514 whereas
22515 .code
22516 alice@lookingglass.fict.example  *  F,24h,30m;
22517 .endd
22518 applies only to temporary failures involving the local part &%alice%&.
22519 In practice, almost all rules start with a domain name pattern without a local
22520 part.
22521
22522 .cindex "regular expressions" "in retry rules"
22523 &*Warning*&: If you use a regular expression in a routing rule pattern, it
22524 must match a complete address, not just a domain, because that is how regular
22525 expressions work in address lists.
22526 .display
22527 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
22528 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
22529 .endd
22530
22531
22532 .section "Choosing which retry rule to use for address errors" "SECID159"
22533 When Exim is looking for a retry rule after a routing attempt has failed (for
22534 example, after a DNS timeout), each line in the retry configuration is tested
22535 against the complete address only if &%retry_use_local_part%& is set for the
22536 router. Otherwise, only the domain is used, except when matching against a
22537 regular expression, when the local part of the address is replaced with &"*"&.
22538 A domain on its own can match a domain pattern, or a pattern that starts with
22539 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
22540 &%check_local_user%& is true, and false for other routers.
22541
22542 Similarly, when Exim is looking for a retry rule after a local delivery has
22543 failed (for example, after a mailbox full error), each line in the retry
22544 configuration is tested against the complete address only if
22545 &%retry_use_local_part%& is set for the transport (it defaults true for all
22546 local transports).
22547
22548 .cindex "4&'xx'& responses" "retry rules for"
22549 However, when Exim is looking for a retry rule after a remote delivery attempt
22550 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
22551 whole address is always used as the key when searching the retry rules. The
22552 rule that is found is used to create a retry time for the combination of the
22553 failing address and the message's sender. It is the combination of sender and
22554 recipient that is delayed in subsequent queue runs until its retry time is
22555 reached. You can delay the recipient without regard to the sender by setting
22556 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
22557 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
22558 commands.
22559
22560
22561
22562 .section "Choosing which retry rule to use for host and message errors" &&&
22563          "SECID160"
22564 For a temporary error that is not related to an individual address (for
22565 example, a connection timeout), each line in the retry configuration is checked
22566 twice. First, the name of the remote host is used as a domain name (preceded by
22567 &"*@"& when matching a regular expression). If this does not match the line,
22568 the domain from the email address is tried in a similar fashion. For example,
22569 suppose the MX records for &'a.b.c.example'& are
22570 .code
22571 a.b.c.example  MX  5  x.y.z.example
22572                MX  6  p.q.r.example
22573                MX  7  m.n.o.example
22574 .endd
22575 and the retry rules are
22576 .code
22577 p.q.r.example    *      F,24h,30m;
22578 a.b.c.example    *      F,4d,45m;
22579 .endd
22580 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
22581 first rule matches neither the host nor the domain, so Exim looks at the second
22582 rule. This does not match the host, but it does match the domain, so it is used
22583 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
22584 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
22585 first retry rule is used, because it matches the host.
22586
22587 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
22588 first rule to determine retry times, but for all the other hosts for the domain
22589 &'a.b.c.example'&, the second rule is used. The second rule is also used if
22590 routing to &'a.b.c.example'& suffers a temporary failure.
22591
22592 &*Note*&: The host name is used when matching the patterns, not its IP address.
22593 However, if a message is routed directly to an IP address without the use of a
22594 host name, for example, if a &(manualroute)& router contains a setting such as:
22595 .code
22596 route_list = *.a.example  192.168.34.23
22597 .endd
22598 then the &"host name"& that is used when searching for a retry rule is the
22599 textual form of the IP address.
22600
22601 .section "Retry rules for specific errors" "SECID161"
22602 .cindex "retry" "specific errors; specifying"
22603 The second field in a retry rule is the name of a particular error, or an
22604 asterisk, which matches any error. The errors that can be tested for are:
22605
22606 .vlist
22607 .vitem &%auth_failed%&
22608 Authentication failed when trying to send to a host in the
22609 &%hosts_require_auth%& list in an &(smtp)& transport.
22610
22611 .vitem &%data_4xx%&
22612 A 4&'xx'& error was received for an outgoing DATA command, either immediately
22613 after the command, or after sending the message's data.
22614
22615 .vitem &%mail_4xx%&
22616 A 4&'xx'& error was received for an outgoing MAIL command.
22617
22618 .vitem &%rcpt_4xx%&
22619 A 4&'xx'& error was received for an outgoing RCPT command.
22620 .endlist
22621
22622 For the three 4&'xx'& errors, either the first or both of the x's can be given
22623 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
22624 recognize 452 errors given to RCPT commands for addresses in a certain domain,
22625 and have retries every ten minutes with a one-hour timeout, you could set up a
22626 retry rule of this form:
22627 .code
22628 the.domain.name  rcpt_452   F,1h,10m
22629 .endd
22630 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
22631 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
22632
22633 .vlist
22634 .vitem &%lost_connection%&
22635 A server unexpectedly closed the SMTP connection. There may, of course,
22636 legitimate reasons for this (host died, network died), but if it repeats a lot
22637 for the same host, it indicates something odd.
22638
22639 .vitem &%refused_MX%&
22640 A connection to a host obtained from an MX record was refused.
22641
22642 .vitem &%refused_A%&
22643 A connection to a host not obtained from an MX record was refused.
22644
22645 .vitem &%refused%&
22646 A connection was refused.
22647
22648 .vitem &%timeout_connect_MX%&
22649 A connection attempt to a host obtained from an MX record timed out.
22650
22651 .vitem &%timeout_connect_A%&
22652 A connection attempt to a host not obtained from an MX record timed out.
22653
22654 .vitem &%timeout_connect%&
22655 A connection attempt timed out.
22656
22657 .vitem &%timeout_MX%&
22658 There was a timeout while connecting or during an SMTP session with a host
22659 obtained from an MX record.
22660
22661 .vitem &%timeout_A%&
22662 There was a timeout while connecting or during an SMTP session with a host not
22663 obtained from an MX record.
22664
22665 .vitem &%timeout%&
22666 There was a timeout while connecting or during an SMTP session.
22667
22668 .vitem &%tls_required%&
22669 The server was required to use TLS (it matched &%hosts_require_tls%& in the
22670 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
22671 to STARTTLS, or there was a problem setting up the TLS connection.
22672
22673 .vitem &%quota%&
22674 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
22675 transport.
22676
22677 .vitem &%quota_%&<&'time'&>
22678 .cindex "quota" "error testing in retry rule"
22679 .cindex "retry" "quota error testing"
22680 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
22681 transport, and the mailbox has not been accessed for <&'time'&>. For example,
22682 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
22683 for four days.
22684 .endlist
22685
22686 .cindex "mailbox" "time of last read"
22687 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
22688 timeouts when the mailbox is full and is not being read by its owner. Ideally,
22689 it should be based on the last time that the user accessed the mailbox.
22690 However, it is not always possible to determine this. Exim uses the following
22691 heuristic rules:
22692
22693 .ilist
22694 If the mailbox is a single file, the time of last access (the &"atime"&) is
22695 used. As no new messages are being delivered (because the mailbox is over
22696 quota), Exim does not access the file, so this is the time of last user access.
22697 .next
22698 .cindex "maildir format" "time of last read"
22699 For a maildir delivery, the time of last modification of the &_new_&
22700 subdirectory is used. As the mailbox is over quota, no new files are created in
22701 the &_new_& subdirectory, because no new messages are being delivered. Any
22702 change to the &_new_& subdirectory is therefore assumed to be the result of an
22703 MUA moving a new message to the &_cur_& directory when it is first read. The
22704 time that is used is therefore the last time that the user read a new message.
22705 .next
22706 For other kinds of multi-file mailbox, the time of last access cannot be
22707 obtained, so a retry rule that uses this type of error field is never matched.
22708 .endlist
22709
22710 The quota errors apply both to system-enforced quotas and to Exim's own quota
22711 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
22712 when a local delivery is deferred because a partition is full (the ENOSPC
22713 error).
22714
22715
22716
22717 .section "Retry rules for specified senders" "SECID162"
22718 .cindex "retry" "rules; sender-specific"
22719 You can specify retry rules that apply only when the failing message has a
22720 specific sender. In particular, this can be used to define retry rules that
22721 apply only to bounce messages. The third item in a retry rule can be of this
22722 form:
22723 .display
22724 &`senders=`&<&'address list'&>
22725 .endd
22726 The retry timings themselves are then the fourth item. For example:
22727 .code
22728 *   rcpt_4xx   senders=:   F,1h,30m
22729 .endd
22730 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
22731 host. If the address list contains white space, it must be enclosed in quotes.
22732 For example:
22733 .code
22734 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
22735 .endd
22736 &*Warning*&: This facility can be unhelpful if it is used for host errors
22737 (which do not depend on the recipient). The reason is that the sender is used
22738 only to match the retry rule. Once the rule has been found for a host error,
22739 its contents are used to set a retry time for the host, and this will apply to
22740 all messages, not just those with specific senders.
22741
22742 When testing retry rules using &%-brt%&, you can supply a sender using the
22743 &%-f%& command line option, like this:
22744 .code
22745 exim -f "" -brt user@dom.ain
22746 .endd
22747 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
22748 list is never matched.
22749
22750
22751
22752
22753
22754 .section "Retry parameters" "SECID163"
22755 .cindex "retry" "parameters in rules"
22756 The third (or fourth, if a senders list is present) field in a retry rule is a
22757 sequence of retry parameter sets, separated by semicolons. Each set consists of
22758 .display
22759 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
22760 .endd
22761 The letter identifies the algorithm for computing a new retry time; the cutoff
22762 time is the time beyond which this algorithm no longer applies, and the
22763 arguments vary the algorithm's action. The cutoff time is measured from the
22764 time that the first failure for the domain (combined with the local part if
22765 relevant) was detected, not from the time the message was received.
22766
22767 .cindex "retry" "algorithms"
22768 .cindex "retry" "fixed intervals"
22769 .cindex "retry" "increasing intervals"
22770 .cindex "retry" "random intervals"
22771 The available algorithms are:
22772
22773 .ilist
22774 &'F'&: retry at fixed intervals. There is a single time parameter specifying
22775 the interval.
22776 .next
22777 &'G'&: retry at geometrically increasing intervals. The first argument
22778 specifies a starting value for the interval, and the second a multiplier, which
22779 is used to increase the size of the interval at each retry.
22780 .next
22781 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
22782 retry, the previous interval is multiplied by the factor in order to get a
22783 maximum for the next interval. The minimum interval is the first argument of
22784 the parameter, and an actual interval is chosen randomly between them. Such a
22785 rule has been found to be helpful in cluster configurations when all the
22786 members of the cluster restart at once, and may therefore synchronize their
22787 queue processing times.
22788 .endlist
22789
22790 When computing the next retry time, the algorithm definitions are scanned in
22791 order until one whose cutoff time has not yet passed is reached. This is then
22792 used to compute a new retry time that is later than the current time. In the
22793 case of fixed interval retries, this simply means adding the interval to the
22794 current time. For geometrically increasing intervals, retry intervals are
22795 computed from the rule's parameters until one that is greater than the previous
22796 interval is found. The main configuration variable
22797 .cindex "limit" "retry interval"
22798 .cindex "retry" "interval, maximum"
22799 .oindex "&%retry_interval_max%&"
22800 &%retry_interval_max%& limits the maximum interval between retries. It
22801 cannot be set greater than &`24h`&, which is its default value.
22802
22803 A single remote domain may have a number of hosts associated with it, and each
22804 host may have more than one IP address. Retry algorithms are selected on the
22805 basis of the domain name, but are applied to each IP address independently. If,
22806 for example, a host has two IP addresses and one is unusable, Exim will
22807 generate retry times for it and will not try to use it until its next retry
22808 time comes. Thus the good IP address is likely to be tried first most of the
22809 time.
22810
22811 .cindex "hints database" "use for retrying"
22812 Retry times are hints rather than promises. Exim does not make any attempt to
22813 run deliveries exactly at the computed times. Instead, a queue runner process
22814 starts delivery processes for delayed messages periodically, and these attempt
22815 new deliveries only for those addresses that have passed their next retry time.
22816 If a new message arrives for a deferred address, an immediate delivery attempt
22817 occurs only if the address has passed its retry time. In the absence of new
22818 messages, the minimum time between retries is the interval between queue runner
22819 processes. There is not much point in setting retry times of five minutes if
22820 your queue runners happen only once an hour, unless there are a significant
22821 number of incoming messages (which might be the case on a system that is
22822 sending everything to a smart host, for example).
22823
22824 The data in the retry hints database can be inspected by using the
22825 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
22826 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
22827 &'exinext'& utility script can be used to find out what the next retry times
22828 are for the hosts associated with a particular mail domain, and also for local
22829 deliveries that have been deferred.
22830
22831
22832 .section "Retry rule examples" "SECID164"
22833 Here are some example retry rules:
22834 .code
22835 alice@wonderland.fict.example quota_5d  F,7d,3h
22836 wonderland.fict.example       quota_5d
22837 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
22838 lookingglass.fict.example     *         F,24h,30m;
22839 *                 refused_A   F,2h,20m;
22840 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
22841 .endd
22842 The first rule sets up special handling for mail to
22843 &'alice@wonderland.fict.example'& when there is an over-quota error and the
22844 mailbox has not been read for at least 5 days. Retries continue every three
22845 hours for 7 days. The second rule handles over-quota errors for all other local
22846 parts at &'wonderland.fict.example'&; the absence of a local part has the same
22847 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
22848 fail are bounced immediately if the mailbox has not been read for at least 5
22849 days.
22850
22851 The third rule handles all other errors at &'wonderland.fict.example'&; retries
22852 happen every 15 minutes for an hour, then with geometrically increasing
22853 intervals until two days have passed since a delivery first failed. After the
22854 first hour there is a delay of one hour, then two hours, then four hours, and
22855 so on (this is a rather extreme example).
22856
22857 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
22858 They happen every 30 minutes for 24 hours only. The remaining two rules handle
22859 all other domains, with special action for connection refusal from hosts that
22860 were not obtained from an MX record.
22861
22862 The final rule in a retry configuration should always have asterisks in the
22863 first two fields so as to provide a general catch-all for any addresses that do
22864 not have their own special handling. This example tries every 15 minutes for 2
22865 hours, then with intervals starting at one hour and increasing by a factor of
22866 1.5 up to 16 hours, then every 8 hours up to 5 days.
22867
22868
22869
22870 .section "Timeout of retry data" "SECID165"
22871 .cindex "timeout" "of retry data"
22872 .oindex "&%retry_data_expire%&"
22873 .cindex "hints database" "data expiry"
22874 .cindex "retry" "timeout of data"
22875 Exim timestamps the data that it writes to its retry hints database. When it
22876 consults the data during a delivery it ignores any that is older than the value
22877 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
22878 been tried for 7 days, Exim will try to deliver to it immediately a message
22879 arrives, and if that fails, it will calculate a retry time as if it were
22880 failing for the first time.
22881
22882 This improves the behaviour for messages routed to rarely-used hosts such as MX
22883 backups. If such a host was down at one time, and happens to be down again when
22884 Exim tries a month later, using the old retry data would imply that it had been
22885 down all the time, which is not a justified assumption.
22886
22887 If a host really is permanently dead, this behaviour causes a burst of retries
22888 every now and again, but only if messages routed to it are rare. If there is a
22889 message at least once every 7 days the retry data never expires.
22890
22891
22892
22893
22894 .section "Long-term failures" "SECID166"
22895 .cindex "delivery failure, long-term"
22896 .cindex "retry" "after long-term failure"
22897 Special processing happens when an email address has been failing for so long
22898 that the cutoff time for the last algorithm is reached. For example, using the
22899 default retry rule:
22900 .code
22901 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
22902 .endd
22903 the cutoff time is four days. Reaching the retry cutoff is independent of how
22904 long any specific message has been failing; it is the length of continuous
22905 failure for the recipient address that counts.
22906
22907 When the cutoff time is reached for a local delivery, or for all the IP
22908 addresses associated with a remote delivery, a subsequent delivery failure
22909 causes Exim to give up on the address, and a bounce message is generated.
22910 In order to cater for new messages that use the failing address, a next retry
22911 time is still computed from the final algorithm, and is used as follows:
22912
22913 For local deliveries, one delivery attempt is always made for any subsequent
22914 messages. If this delivery fails, the address fails immediately. The
22915 post-cutoff retry time is not used.
22916
22917 If the delivery is remote, there are two possibilities, controlled by the
22918 .oindex "&%delay_after_cutoff%&"
22919 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
22920 default. Until the post-cutoff retry time for one of the IP addresses is
22921 reached, the failing email address is bounced immediately, without a delivery
22922 attempt taking place. After that time, one new delivery attempt is made to
22923 those IP addresses that are past their retry times, and if that still fails,
22924 the address is bounced and new retry times are computed.
22925
22926 In other words, when all the hosts for a given email address have been failing
22927 for a long time, Exim bounces rather then defers until one of the hosts' retry
22928 times is reached. Then it tries once, and bounces if that attempt fails. This
22929 behaviour ensures that few resources are wasted in repeatedly trying to deliver
22930 to a broken destination, but if the host does recover, Exim will eventually
22931 notice.
22932
22933 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
22934 addresses are past their final cutoff time, Exim tries to deliver to those IP
22935 addresses that have not been tried since the message arrived. If there are
22936 no suitable IP addresses, or if they all fail, the address is bounced. In other
22937 words, it does not delay when a new message arrives, but tries the expired
22938 addresses immediately, unless they have been tried since the message arrived.
22939 If there is a continuous stream of messages for the failing domains, setting
22940 &%delay_after_cutoff%& false means that there will be many more attempts to
22941 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
22942 true.
22943
22944 .section "Deliveries that work intermittently" "SECID167"
22945 .cindex "retry" "intermittently working deliveries"
22946 Some additional logic is needed to cope with cases where a host is
22947 intermittently available, or when a message has some attribute that prevents
22948 its delivery when others to the same address get through. In this situation,
22949 because some messages are successfully delivered, the &"retry clock"& for the
22950 host or address keeps getting reset by the successful deliveries, and so
22951 failing messages remain on the queue for ever because the cutoff time is never
22952 reached.
22953
22954 Two exceptional actions are applied to prevent this happening. The first
22955 applies to errors that are related to a message rather than a remote host.
22956 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
22957 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
22958 commands, and quota failures. For this type of error, if a message's arrival
22959 time is earlier than the &"first failed"& time for the error, the earlier time
22960 is used when scanning the retry rules to decide when to try next and when to
22961 time out the address.
22962
22963 The exceptional second action applies in all cases. If a message has been on
22964 the queue for longer than the cutoff time of any applicable retry rule for a
22965 given address, a delivery is attempted for that address, even if it is not yet
22966 time, and if this delivery fails, the address is timed out. A new retry time is
22967 not computed in this case, so that other messages for the same address are
22968 considered immediately.
22969 .ecindex IIDretconf1
22970 .ecindex IIDregconf2
22971
22972
22973
22974
22975
22976
22977 . ////////////////////////////////////////////////////////////////////////////
22978 . ////////////////////////////////////////////////////////////////////////////
22979
22980 .chapter "SMTP authentication" "CHAPSMTPAUTH"
22981 .scindex IIDauthconf1 "SMTP" "authentication configuration"
22982 .scindex IIDauthconf2 "authentication"
22983 The &"authenticators"& section of Exim's run time configuration is concerned
22984 with SMTP authentication. This facility is an extension to the SMTP protocol,
22985 described in RFC 2554, which allows a client SMTP host to authenticate itself
22986 to a server. This is a common way for a server to recognize clients that are
22987 permitted to use it as a relay. SMTP authentication is not of relevance to the
22988 transfer of mail between servers that have no managerial connection with each
22989 other.
22990
22991 .cindex "AUTH" "description of"
22992 Very briefly, the way SMTP authentication works is as follows:
22993
22994 .ilist
22995 The server advertises a number of authentication &'mechanisms'& in response to
22996 the client's EHLO command.
22997 .next
22998 The client issues an AUTH command, naming a specific mechanism. The command
22999 may, optionally, contain some authentication data.
23000 .next
23001 The server may issue one or more &'challenges'&, to which the client must send
23002 appropriate responses. In simple authentication mechanisms, the challenges are
23003 just prompts for user names and passwords. The server does not have to issue
23004 any challenges &-- in some mechanisms the relevant data may all be transmitted
23005 with the AUTH command.
23006 .next
23007 The server either accepts or denies authentication.
23008 .next
23009 If authentication succeeds, the client may optionally make use of the AUTH
23010 option on the MAIL command to pass an authenticated sender in subsequent
23011 mail transactions. Authentication lasts for the remainder of the SMTP
23012 connection.
23013 .next
23014 If authentication fails, the client may give up, or it may try a different
23015 authentication mechanism, or it may try transferring mail over the
23016 unauthenticated connection.
23017 .endlist
23018
23019 If you are setting up a client, and want to know which authentication
23020 mechanisms the server supports, you can use Telnet to connect to port 25 (the
23021 SMTP port) on the server, and issue an EHLO command. The response to this
23022 includes the list of supported mechanisms. For example:
23023 .display
23024 &`$ `&&*&`telnet server.example 25`&*&
23025 &`Trying 192.168.34.25...`&
23026 &`Connected to server.example.`&
23027 &`Escape character is &#x0027;^]&#x0027;.`&
23028 &`220 server.example ESMTP Exim 4.20 ...`&
23029 &*&`ehlo client.example`&*&
23030 &`250-server.example Hello client.example [10.8.4.5]`&
23031 &`250-SIZE 52428800`&
23032 &`250-PIPELINING`&
23033 &`250-AUTH PLAIN`&
23034 &`250 HELP`&
23035 .endd
23036 The second-last line of this example output shows that the server supports
23037 authentication using the PLAIN mechanism. In Exim, the different authentication
23038 mechanisms are configured by specifying &'authenticator'& drivers. Like the
23039 routers and transports, which authenticators are included in the binary is
23040 controlled by build-time definitions. The following are currently available,
23041 included by setting
23042 .code
23043 AUTH_CRAM_MD5=yes
23044 AUTH_CYRUS_SASL=yes
23045 AUTH_PLAINTEXT=yes
23046 AUTH_SPA=yes
23047 .endd
23048 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
23049 authentication mechanism (RFC 2195), and the second provides an interface to
23050 the Cyrus SASL authentication library. The third can be configured to support
23051 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
23052 not formally documented, but used by several MUAs. The fourth authenticator
23053 supports Microsoft's &'Secure Password Authentication'& mechanism.
23054
23055 The authenticators are configured using the same syntax as other drivers (see
23056 section &<<SECTfordricon>>&). If no authenticators are required, no
23057 authentication section need be present in the configuration file. Each
23058 authenticator can in principle have both server and client functions. When Exim
23059 is receiving SMTP mail, it is acting as a server; when it is sending out
23060 messages over SMTP, it is acting as a client. Authenticator configuration
23061 options are provided for use in both these circumstances.
23062
23063 To make it clear which options apply to which situation, the prefixes
23064 &%server_%& and &%client_%& are used on option names that are specific to
23065 either the server or the client function, respectively. Server and client
23066 functions are disabled if none of their options are set. If an authenticator is
23067 to be used for both server and client functions, a single definition, using
23068 both sets of options, is required. For example:
23069 .code
23070 cram:
23071   driver = cram_md5
23072   public_name = CRAM-MD5
23073   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
23074   client_name = ph10
23075   client_secret = secret2
23076 .endd
23077 The &%server_%& option is used when Exim is acting as a server, and the
23078 &%client_%& options when it is acting as a client.
23079
23080 Descriptions of the individual authenticators are given in subsequent chapters.
23081 The remainder of this chapter covers the generic options for the
23082 authenticators, followed by general discussion of the way authentication works
23083 in Exim.
23084
23085
23086
23087 .section "Generic options for authenticators" "SECID168"
23088 .cindex "authentication" "generic options"
23089 .cindex "options" "generic; for authenticators"
23090
23091 .option client_condition authenticators string&!! unset
23092 When Exim is authenticating as a client, it skips any authenticator whose
23093 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
23094 used, for example, to skip plain text authenticators when the connection is not
23095 encrypted by a setting such as:
23096 .code
23097 client_condition = ${if !eq{$tls_cipher}{}}
23098 .endd
23099 (Older documentation incorrectly states that &$tls_cipher$& contains the cipher
23100 used for incoming messages. In fact, during SMTP delivery, it contains the
23101 cipher used for the delivery.)
23102
23103
23104 .option driver authenticators string unset
23105 This option must always be set. It specifies which of the available
23106 authenticators is to be used.
23107
23108
23109 .option public_name authenticators string unset
23110 This option specifies the name of the authentication mechanism that the driver
23111 implements, and by which it is known to the outside world. These names should
23112 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
23113 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
23114 defaults to the driver's instance name.
23115
23116
23117 .option server_advertise_condition authenticators string&!! unset
23118 When a server is about to advertise an authentication mechanism, the condition
23119 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
23120 mechanism is not advertised.
23121 If the expansion fails, the mechanism is not advertised. If the failure was not
23122 forced, and was not caused by a lookup defer, the incident is logged.
23123 See section &<<SECTauthexiser>>& below for further discussion.
23124
23125
23126 .option server_condition authenticators string&!! unset
23127 This option must be set for a &%plaintext%& server authenticator, where it
23128 is used directly to control authentication. See section &<<SECTplainserver>>&
23129 for details.
23130
23131 For the other authenticators, &%server_condition%& can be used as an additional
23132 authentication or authorization mechanism that is applied after the other
23133 authenticator conditions succeed. If it is set, it is expanded when the
23134 authenticator would otherwise return a success code. If the expansion is forced
23135 to fail, authentication fails. Any other expansion failure causes a temporary
23136 error code to be returned. If the result of a successful expansion is an empty
23137 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
23138 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
23139 other result, a temporary error code is returned, with the expanded string as
23140 the error text.
23141
23142
23143 .option server_debug_print authenticators string&!! unset
23144 If this option is set and authentication debugging is enabled (see the &%-d%&
23145 command line option), the string is expanded and included in the debugging
23146 output when the authenticator is run as a server. This can help with checking
23147 out the values of variables.
23148 If expansion of the string fails, the error message is written to the debugging
23149 output, and Exim carries on processing.
23150
23151
23152 .option server_set_id authenticators string&!! unset
23153 .vindex "&$authenticated_id$&"
23154 When an Exim server successfully authenticates a client, this string is
23155 expanded using data from the authentication, and preserved for any incoming
23156 messages in the variable &$authenticated_id$&. It is also included in the log
23157 lines for incoming messages. For example, a user/password authenticator
23158 configuration might preserve the user name that was used to authenticate, and
23159 refer to it subsequently during delivery of the message.
23160 If expansion fails, the option is ignored.
23161
23162
23163 .option server_mail_auth_condition authenticators string&!! unset
23164 This option allows a server to discard authenticated sender addresses supplied
23165 as part of MAIL commands in SMTP connections that are authenticated by the
23166 driver on which &%server_mail_auth_condition%& is set. The option is not used
23167 as part of the authentication process; instead its (unexpanded) value is
23168 remembered for later use.
23169 How it is used is described in the following section.
23170
23171
23172
23173
23174
23175 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
23176 .cindex "authentication" "sender; authenticated"
23177 .cindex "AUTH" "on MAIL command"
23178 When a client supplied an AUTH= item on a MAIL command, Exim applies
23179 the following checks before accepting it as the authenticated sender of the
23180 message:
23181
23182 .ilist
23183 If the connection is not using extended SMTP (that is, HELO was used rather
23184 than EHLO), the use of AUTH= is a syntax error.
23185 .next
23186 If the value of the AUTH= parameter is &"<>"&, it is ignored.
23187 .next
23188 .vindex "&$authenticated_sender$&"
23189 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
23190 running, the value of &$authenticated_sender$& is set to the value obtained
23191 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
23192 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
23193 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
23194 given for the MAIL command.
23195 .next
23196 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
23197 is accepted and placed in &$authenticated_sender$& only if the client has
23198 authenticated.
23199 .next
23200 If the AUTH= value was accepted by either of the two previous rules, and
23201 the client has authenticated, and the authenticator has a setting for the
23202 &%server_mail_auth_condition%&, the condition is checked at this point. The
23203 valued that was saved from the authenticator is expanded. If the expansion
23204 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
23205 &$authenticated_sender$& is deleted. If the expansion yields any other value,
23206 the value of &$authenticated_sender$& is retained and passed on with the
23207 message.
23208 .endlist
23209
23210
23211 When &$authenticated_sender$& is set for a message, it is passed on to other
23212 hosts to which Exim authenticates as a client. Do not confuse this value with
23213 &$authenticated_id$&, which is a string obtained from the authentication
23214 process, and which is not usually a complete email address.
23215
23216 .vindex "&$sender_address$&"
23217 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
23218 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
23219 therefore make use of &$authenticated_sender$&. The converse is not true: the
23220 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
23221 ACL is run.
23222
23223
23224
23225 .section "Authentication on an Exim server" "SECTauthexiser"
23226 .cindex "authentication" "on an Exim server"
23227 When Exim receives an EHLO command, it advertises the public names of those
23228 authenticators that are configured as servers, subject to the following
23229 conditions:
23230
23231 .ilist
23232 The client host must match &%auth_advertise_hosts%& (default *).
23233 .next
23234 It the &%server_advertise_condition%& option is set, its expansion must not
23235 yield the empty string, &"0"&, &"no"&, or &"false"&.
23236 .endlist
23237
23238 The order in which the authenticators are defined controls the order in which
23239 the mechanisms are advertised.
23240
23241 Some mail clients (for example, some versions of Netscape) require the user to
23242 provide a name and password for authentication whenever AUTH is advertised,
23243 even though authentication may not in fact be needed (for example, Exim may be
23244 set up to allow unconditional relaying from the client by an IP address check).
23245 You can make such clients more friendly by not advertising AUTH to them.
23246 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
23247 that runs for RCPT) to relay without authentication, you should set
23248 .code
23249 auth_advertise_hosts = ! 10.9.8.0/24
23250 .endd
23251 so that no authentication mechanisms are advertised to them.
23252
23253 The &%server_advertise_condition%& controls the advertisement of individual
23254 authentication mechanisms. For example, it can be used to restrict the
23255 advertisement of a particular mechanism to encrypted connections, by a setting
23256 such as:
23257 .code
23258 server_advertise_condition = ${if eq{$tls_cipher}{}{no}{yes}}
23259 .endd
23260 .vindex "&$tls_cipher$&"
23261 If the session is encrypted, &$tls_cipher$& is not empty, and so the expansion
23262 yields &"yes"&, which allows the advertisement to happen.
23263
23264 When an Exim server receives an AUTH command from a client, it rejects it
23265 immediately if AUTH was not advertised in response to an earlier EHLO
23266 command. This is the case if
23267
23268 .ilist
23269 The client host does not match &%auth_advertise_hosts%&; or
23270 .next
23271 No authenticators are configured with server options; or
23272 .next
23273 Expansion of &%server_advertise_condition%& blocked the advertising of all the
23274 server authenticators.
23275 .endlist
23276
23277
23278 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
23279 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
23280 AUTH is accepted from any client host.
23281
23282 If AUTH is not rejected by the ACL, Exim searches its configuration for a
23283 server authentication mechanism that was advertised in response to EHLO and
23284 that matches the one named in the AUTH command. If it finds one, it runs
23285 the appropriate authentication protocol, and authentication either succeeds or
23286 fails. If there is no matching advertised mechanism, the AUTH command is
23287 rejected with a 504 error.
23288
23289 .vindex "&$received_protocol$&"
23290 .vindex "&$sender_host_authenticated$&"
23291 When a message is received from an authenticated host, the value of
23292 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
23293 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
23294 public name) of the authenticator driver that successfully authenticated the
23295 client from which the message was received. This variable is empty if there was
23296 no successful authentication.
23297
23298
23299
23300
23301 .section "Testing server authentication" "SECID169"
23302 .cindex "authentication" "testing a server"
23303 .cindex "AUTH" "testing a server"
23304 .cindex "base64 encoding" "creating authentication test data"
23305 Exim's &%-bh%& option can be useful for testing server authentication
23306 configurations. The data for the AUTH command has to be sent using base64
23307 encoding. A quick way to produce such data for testing is the following Perl
23308 script:
23309 .code
23310 use MIME::Base64;
23311 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
23312 .endd
23313 .cindex "binary zero" "in authentication data"
23314 This interprets its argument as a Perl string, and then encodes it. The
23315 interpretation as a Perl string allows binary zeros, which are required for
23316 some kinds of authentication, to be included in the data. For example, a
23317 command line to run this script on such data might be
23318 .code
23319 encode '\0user\0password'
23320 .endd
23321 Note the use of single quotes to prevent the shell interpreting the
23322 backslashes, so that they can be interpreted by Perl to specify characters
23323 whose code value is zero.
23324
23325 &*Warning 1*&: If either of the user or password strings starts with an octal
23326 digit, you must use three zeros instead of one after the leading backslash. If
23327 you do not, the octal digit that starts your string will be incorrectly
23328 interpreted as part of the code for the first character.
23329
23330 &*Warning 2*&: If there are characters in the strings that Perl interprets
23331 specially, you must use a Perl escape to prevent them being misinterpreted. For
23332 example, a command such as
23333 .code
23334 encode '\0user@domain.com\0pas$$word'
23335 .endd
23336 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
23337
23338 If you have the &%mimencode%& command installed, another way to do produce
23339 base64-encoded strings is to run the command
23340 .code
23341 echo -e -n `\0user\0password' | mimencode
23342 .endd
23343 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
23344 in the argument, and the &%-n%& option specifies no newline at the end of its
23345 output. However, not all versions of &%echo%& recognize these options, so you
23346 should check your version before relying on this suggestion.
23347
23348
23349
23350 .section "Authentication by an Exim client" "SECID170"
23351 .cindex "authentication" "on an Exim client"
23352 The &(smtp)& transport has two options called &%hosts_require_auth%& and
23353 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
23354 announces support for authentication, and the host matches an entry in either
23355 of these options, Exim (as a client) tries to authenticate as follows:
23356
23357 .ilist
23358 For each authenticator that is configured as a client, in the order in which
23359 they are defined in the configuration, it searches the authentication
23360 mechanisms announced by the server for one whose name matches the public name
23361 of the authenticator.
23362 .next
23363 .vindex "&$host$&"
23364 .vindex "&$host_address$&"
23365 When it finds one that matches, it runs the authenticator's client code. The
23366 variables &$host$& and &$host_address$& are available for any string expansions
23367 that the client might do. They are set to the server's name and IP address. If
23368 any expansion is forced to fail, the authentication attempt is abandoned, and
23369 Exim moves on to the next authenticator. Otherwise an expansion failure causes
23370 delivery to be deferred.
23371 .next
23372 If the result of the authentication attempt is a temporary error or a timeout,
23373 Exim abandons trying to send the message to the host for the moment. It will
23374 try again later. If there are any backup hosts available, they are tried in the
23375 usual way.
23376 .next
23377 If the response to authentication is a permanent error (5&'xx'& code), Exim
23378 carries on searching the list of authenticators and tries another one if
23379 possible. If all authentication attempts give permanent errors, or if there are
23380 no attempts because no mechanisms match (or option expansions force failure),
23381 what happens depends on whether the host matches &%hosts_require_auth%& or
23382 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
23383 delivery is deferred. The error can be detected in the retry rules, and thereby
23384 turned into a permanent error if you wish. In the second case, Exim tries to
23385 deliver the message unauthenticated.
23386 .endlist
23387
23388 .cindex "AUTH" "on MAIL command"
23389 When Exim has authenticated itself to a remote server, it adds the AUTH
23390 parameter to the MAIL commands it sends, if it has an authenticated sender for
23391 the message. If the message came from a remote host, the authenticated sender
23392 is the one that was receiving on an incoming MAIL command, provided that the
23393 incoming connection was authenticated and the &%server_mail_auth%& condition
23394 allowed the authenticated sender to be retained. If a local process calls Exim
23395 to send a message, the sender address that is built from the login name and
23396 &%qualify_domain%& is treated as authenticated. However, if the
23397 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
23398 the authenticated sender that was received with the message.
23399 .ecindex IIDauthconf1
23400 .ecindex IIDauthconf2
23401
23402
23403
23404
23405
23406
23407 . ////////////////////////////////////////////////////////////////////////////
23408 . ////////////////////////////////////////////////////////////////////////////
23409
23410 .chapter "The plaintext authenticator" "CHAPplaintext"
23411 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
23412 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
23413 The &(plaintext)& authenticator can be configured to support the PLAIN and
23414 LOGIN authentication mechanisms, both of which transfer authentication data as
23415 plain (unencrypted) text (though base64 encoded). The use of plain text is a
23416 security risk; you are strongly advised to insist on the use of SMTP encryption
23417 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
23418 use unencrypted plain text, you should not use the same passwords for SMTP
23419 connections as you do for login accounts.
23420
23421 .section "Plaintext options" "SECID171"
23422 .cindex "options" "&(plaintext)& authenticator (server)"
23423 When configured as a server, &(plaintext)& uses the following options:
23424
23425 .option server_condition authenticators string&!! unset
23426 This is actually a global authentication option, but it must be set in order to
23427 configure the &(plaintext)& driver as a server. Its use is described below.
23428
23429 .option server_prompts plaintext string&!! unset
23430 The contents of this option, after expansion, must be a colon-separated list of
23431 prompt strings. If expansion fails, a temporary authentication rejection is
23432 given.
23433
23434 .section "Using plaintext in a server" "SECTplainserver"
23435 .cindex "AUTH" "in &(plaintext)& authenticator"
23436 .cindex "binary zero" "in &(plaintext)& authenticator"
23437 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
23438         "in &(plaintext)& authenticator"
23439 .vindex "&$auth1$&, &$auth2$&, etc"
23440 .cindex "base64 encoding" "in &(plaintext)& authenticator"
23441
23442 When running as a server, &(plaintext)& performs the authentication test by
23443 expanding a string. The data sent by the client with the AUTH command, or in
23444 response to subsequent prompts, is base64 encoded, and so may contain any byte
23445 values when decoded. If any data is supplied with the command, it is treated as
23446 a list of strings, separated by NULs (binary zeros), the first three of which
23447 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
23448 (neither LOGIN nor PLAIN uses more than three strings).
23449
23450 For compatibility with previous releases of Exim, the values are also placed in
23451 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
23452 variables for this purpose is now deprecated, as it can lead to confusion in
23453 string expansions that also use them for other things.
23454
23455 If there are more strings in &%server_prompts%& than the number of strings
23456 supplied with the AUTH command, the remaining prompts are used to obtain more
23457 data. Each response from the client may be a list of NUL-separated strings.
23458
23459 .vindex "&$authenticated_id$&"
23460 Once a sufficient number of data strings have been received,
23461 &%server_condition%& is expanded. If the expansion is forced to fail,
23462 authentication fails. Any other expansion failure causes a temporary error code
23463 to be returned. If the result of a successful expansion is an empty string,
23464 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
23465 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
23466 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
23467 For any other result, a temporary error code is returned, with the expanded
23468 string as the error text.
23469
23470 &*Warning*&: If you use a lookup in the expansion to find the user's
23471 password, be sure to make the authentication fail if the user is unknown.
23472 There are good and bad examples at the end of the next section.
23473
23474
23475
23476 .section "The PLAIN authentication mechanism" "SECID172"
23477 .cindex "PLAIN authentication mechanism"
23478 .cindex "authentication" "PLAIN mechanism"
23479 .cindex "binary zero" "in &(plaintext)& authenticator"
23480 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
23481 sent as one item of data (that is, one combined string containing two NUL
23482 separators). The data is sent either as part of the AUTH command, or
23483 subsequently in response to an empty prompt from the server.
23484
23485 The second and third strings are a user name and a corresponding password.
23486 Using a single fixed user name and password as an example, this could be
23487 configured as follows:
23488 .code
23489 fixed_plain:
23490   driver = plaintext
23491   public_name = PLAIN
23492   server_prompts = :
23493   server_condition = \
23494     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
23495   server_set_id = $auth2
23496 .endd
23497 Note that the default result strings from &%if%& (&"true"& or an empty string)
23498 are exactly what we want here, so they need not be specified. Obviously, if the
23499 password contains expansion-significant characters such as dollar, backslash,
23500 or closing brace, they have to be escaped.
23501
23502 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
23503 the end of a string list are ignored). If all the data comes as part of the
23504 AUTH command, as is commonly the case, the prompt is not used. This
23505 authenticator is advertised in the response to EHLO as
23506 .code
23507 250-AUTH PLAIN
23508 .endd
23509 and a client host can authenticate itself by sending the command
23510 .code
23511 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
23512 .endd
23513 As this contains three strings (more than the number of prompts), no further
23514 data is required from the client. Alternatively, the client may just send
23515 .code
23516 AUTH PLAIN
23517 .endd
23518 to initiate authentication, in which case the server replies with an empty
23519 prompt. The client must respond with the combined data string.
23520
23521 The data string is base64 encoded, as required by the RFC. This example,
23522 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
23523 represents a zero byte. This is split up into three strings, the first of which
23524 is empty. The &%server_condition%& option in the authenticator checks that the
23525 second two are &`username`& and &`mysecret`& respectively.
23526
23527 Having just one fixed user name and password, as in this example, is not very
23528 realistic, though for a small organization with only a handful of
23529 authenticating clients it could make sense.
23530
23531 A more sophisticated instance of this authenticator could use the user name in
23532 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
23533 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
23534 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
23535 This is an incorrect example:
23536 .code
23537 server_condition = \
23538   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
23539 .endd
23540 The expansion uses the user name (&$auth2$&) as the key to look up a password,
23541 which it then compares to the supplied password (&$auth3$&). Why is this example
23542 incorrect? It works fine for existing users, but consider what happens if a
23543 non-existent user name is given. The lookup fails, but as no success/failure
23544 strings are given for the lookup, it yields an empty string. Thus, to defeat
23545 the authentication, all a client has to do is to supply a non-existent user
23546 name and an empty password. The correct way of writing this test is:
23547 .code
23548 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
23549   {${if eq{$value}{$auth3}}} {false}}
23550 .endd
23551 In this case, if the lookup succeeds, the result is checked; if the lookup
23552 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
23553 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
23554 always fails if its second argument is empty. However, the second way of
23555 writing the test makes the logic clearer.
23556
23557
23558 .section "The LOGIN authentication mechanism" "SECID173"
23559 .cindex "LOGIN authentication mechanism"
23560 .cindex "authentication" "LOGIN mechanism"
23561 The LOGIN authentication mechanism is not documented in any RFC, but is in use
23562 in a number of programs. No data is sent with the AUTH command. Instead, a
23563 user name and password are supplied separately, in response to prompts. The
23564 plaintext authenticator can be configured to support this as in this example:
23565 .code
23566 fixed_login:
23567   driver = plaintext
23568   public_name = LOGIN
23569   server_prompts = User Name : Password
23570   server_condition = \
23571     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
23572   server_set_id = $auth1
23573 .endd
23574 Because of the way plaintext operates, this authenticator accepts data supplied
23575 with the AUTH command (in contravention of the specification of LOGIN), but
23576 if the client does not supply it (as is the case for LOGIN clients), the prompt
23577 strings are used to obtain two data items.
23578
23579 Some clients are very particular about the precise text of the prompts. For
23580 example, Outlook Express is reported to recognize only &"Username:"& and
23581 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
23582 strings. It uses the &%ldapauth%& expansion condition to check the user
23583 name and password by binding to an LDAP server:
23584 .code
23585 login:
23586   driver = plaintext
23587   public_name = LOGIN
23588   server_prompts = Username:: : Password::
23589   server_condition = ${if and{{
23590     !eq{}{$auth1} }{ \
23591     ldapauth{user="cn=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
23592              pass=${quote:$auth2} \
23593              ldap://ldap.example.org/} }} }
23594   server_set_id = uid=$auth1,ou=people,o=example.org
23595 .endd
23596 We have to check that the username is not empty before using it, because LDAP
23597 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
23598 operator to correctly quote the DN for authentication. However, the basic
23599 &%quote%& operator, rather than any of the LDAP quoting operators, is the
23600 correct one to use for the password, because quoting is needed only to make
23601 the password conform to the Exim syntax. At the LDAP level, the password is an
23602 uninterpreted string.
23603
23604
23605 .section "Support for different kinds of authentication" "SECID174"
23606 A number of string expansion features are provided for the purpose of
23607 interfacing to different ways of user authentication. These include checking
23608 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
23609 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
23610 &<<SECTexpcond>>&.
23611
23612
23613
23614
23615 .section "Using plaintext in a client" "SECID175"
23616 .cindex "options" "&(plaintext)& authenticator (client)"
23617 The &(plaintext)& authenticator has two client options:
23618
23619 .option client_ignore_invalid_base64 plaintext boolean false
23620 If the client receives a server prompt that is not a valid base64 string,
23621 authentication is abandoned by default. However, if this option is set true,
23622 the error in the challenge is ignored and the client sends the response as
23623 usual.
23624
23625 .option client_send plaintext string&!! unset
23626 The string is a colon-separated list of authentication data strings. Each
23627 string is independently expanded before being sent to the server. The first
23628 string is sent with the AUTH command; any more strings are sent in response
23629 to prompts from the server. Before each string is expanded, the value of the
23630 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
23631 with &$auth1$& for the first prompt. Up to three prompts are stored in this
23632 way. Thus, the prompt that is received in response to sending the first string
23633 (with the AUTH command) can be used in the expansion of the second string, and
23634 so on. If an invalid base64 string is received when
23635 &%client_ignore_invalid_base64%& is set, an empty string is put in the
23636 &$auth$&<&'n'&> variable.
23637
23638 &*Note*&: You cannot use expansion to create multiple strings, because
23639 splitting takes priority and happens first.
23640
23641 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
23642 the data, further processing is applied to each string before it is sent. If
23643 there are any single circumflex characters in the string, they are converted to
23644 NULs. Should an actual circumflex be required as data, it must be doubled in
23645 the string.
23646
23647 This is an example of a client configuration that implements the PLAIN
23648 authentication mechanism with a fixed user name and password:
23649 .code
23650 fixed_plain:
23651   driver = plaintext
23652   public_name = PLAIN
23653   client_send = ^username^mysecret
23654 .endd
23655 The lack of colons means that the entire text is sent with the AUTH
23656 command, with the circumflex characters converted to NULs. A similar example
23657 that uses the LOGIN mechanism is:
23658 .code
23659 fixed_login:
23660   driver = plaintext
23661   public_name = LOGIN
23662   client_send = : username : mysecret
23663 .endd
23664 The initial colon means that the first string is empty, so no data is sent with
23665 the AUTH command itself. The remaining strings are sent in response to
23666 prompts.
23667 .ecindex IIDplaiauth1
23668 .ecindex IIDplaiauth2
23669
23670
23671
23672
23673 . ////////////////////////////////////////////////////////////////////////////
23674 . ////////////////////////////////////////////////////////////////////////////
23675
23676 .chapter "The cram_md5 authenticator" "CHID9"
23677 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
23678 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
23679 .cindex "CRAM-MD5 authentication mechanism"
23680 .cindex "authentication" "CRAM-MD5 mechanism"
23681 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
23682 sends a challenge string to the client, and the response consists of a user
23683 name and the CRAM-MD5 digest of the challenge string combined with a secret
23684 string (password) which is known to both server and client. Thus, the secret
23685 is not sent over the network as plain text, which makes this authenticator more
23686 secure than &(plaintext)&. However, the downside is that the secret has to be
23687 available in plain text at either end.
23688
23689
23690 .section "Using cram_md5 as a server" "SECID176"
23691 .cindex "options" "&(cram_md5)& authenticator (server)"
23692 This authenticator has one server option, which must be set to configure the
23693 authenticator as a server:
23694
23695 .option server_secret cram_md5 string&!! unset
23696 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
23697 When the server receives the client's response, the user name is placed in
23698 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
23699 obtain the password for that user. The server then computes the CRAM-MD5 digest
23700 that the client should have sent, and checks that it received the correct
23701 string. If the expansion of &%server_secret%& is forced to fail, authentication
23702 fails. If the expansion fails for some other reason, a temporary error code is
23703 returned to the client.
23704
23705 For compatibility with previous releases of Exim, the user name is also placed
23706 in &$1$&. However, the use of this variables for this purpose is now
23707 deprecated, as it can lead to confusion in string expansions that also use
23708 numeric variables for other things.
23709
23710 For example, the following authenticator checks that the user name given by the
23711 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
23712 user name, authentication fails.
23713 .code
23714 fixed_cram:
23715   driver = cram_md5
23716   public_name = CRAM-MD5
23717   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
23718   server_set_id = $auth1
23719 .endd
23720 .vindex "&$authenticated_id$&"
23721 If authentication succeeds, the setting of &%server_set_id%& preserves the user
23722 name in &$authenticated_id$&. A more typical configuration might look up the
23723 secret string in a file, using the user name as the key. For example:
23724 .code
23725 lookup_cram:
23726   driver = cram_md5
23727   public_name = CRAM-MD5
23728   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
23729                   {$value}fail}
23730   server_set_id = $auth1
23731 .endd
23732 Note that this expansion explicitly forces failure if the lookup fails
23733 because &$auth1$& contains an unknown user name.
23734
23735
23736 .section "Using cram_md5 as a client" "SECID177"
23737 .cindex "options" "&(cram_md5)& authenticator (client)"
23738 When used as a client, the &(cram_md5)& authenticator has two options:
23739
23740
23741
23742 .option client_name cram_md5 string&!! "the primary host name"
23743 This string is expanded, and the result used as the user name data when
23744 computing the response to the server's challenge.
23745
23746
23747 .option client_secret cram_md5 string&!! unset
23748 This option must be set for the authenticator to work as a client. Its value is
23749 expanded and the result used as the secret string when computing the response.
23750
23751
23752 .vindex "&$host$&"
23753 .vindex "&$host_address$&"
23754 Different user names and secrets can be used for different servers by referring
23755 to &$host$& or &$host_address$& in the options. Forced failure of either
23756 expansion string is treated as an indication that this authenticator is not
23757 prepared to handle this case. Exim moves on to the next configured client
23758 authenticator. Any other expansion failure causes Exim to give up trying to
23759 send the message to the current server.
23760
23761 A simple example configuration of a &(cram_md5)& authenticator, using fixed
23762 strings, is:
23763 .code
23764 fixed_cram:
23765   driver = cram_md5
23766   public_name = CRAM-MD5
23767   client_name = ph10
23768   client_secret = secret
23769 .endd
23770 .ecindex IIDcramauth1
23771 .ecindex IIDcramauth2
23772
23773
23774
23775 . ////////////////////////////////////////////////////////////////////////////
23776 . ////////////////////////////////////////////////////////////////////////////
23777
23778 .chapter "The cyrus_sasl authenticator" "CHID10"
23779 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
23780 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
23781 .cindex "Cyrus" "SASL library"
23782 .cindex "Kerberos"
23783 The code for this authenticator was provided by Matthew Byng-Maddick of A L
23784 Digital Ltd (&url(http://www.aldigital.co.uk)).
23785
23786 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
23787 library implementation of the RFC 2222 (&"Simple Authentication and Security
23788 Layer"&). This library supports a number of authentication mechanisms,
23789 including PLAIN and LOGIN, but also several others that Exim does not support
23790 directly. In particular, there is support for Kerberos authentication.
23791
23792 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
23793 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
23794 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
23795 name of the driver to determine which mechanism to support.
23796
23797 Where access to some kind of secret file is required, for example in GSSAPI
23798 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
23799 user, and that the Cyrus SASL library has no way of escalating privileges
23800 by default. You may also find you need to set environment variables,
23801 depending on the driver you are using.
23802
23803 The application name provided by Exim is &"exim"&, so various SASL options may
23804 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
23805 Kerberos, note that because of limitations in the GSSAPI interface,
23806 changing the server keytab might need to be communicated down to the Kerberos
23807 layer independently. The mechanism for doing so is dependent upon the Kerberos
23808 implementation. For example, for Heimdal, the environment variable KRB5_KTNAME
23809 may be set to point to an alternative keytab file. Exim will pass this
23810 variable through from its own inherited environment when started as root or the
23811 Exim user. The keytab file needs to be readable by the Exim user.
23812
23813
23814 .section "Using cyrus_sasl as a server" "SECID178"
23815 The &(cyrus_sasl)& authenticator has four private options. It puts the username
23816 (on a successful authentication) into &$auth1$&. For compatibility with
23817 previous releases of Exim, the username is also placed in &$1$&. However, the
23818 use of this variable for this purpose is now deprecated, as it can lead to
23819 confusion in string expansions that also use numeric variables for other
23820 things.
23821
23822
23823 .option server_hostname cyrus_sasl string&!! "see below"
23824 This option selects the hostname that is used when communicating with the
23825 library. The default value is &`$primary_hostname`&. It is up to the underlying
23826 SASL plug-in what it does with this data.
23827
23828
23829 .option server_mech cyrus_sasl string "see below"
23830 This option selects the authentication mechanism this driver should use. The
23831 default is the value of the generic &%public_name%& option. This option allows
23832 you to use a different underlying mechanism from the advertised name. For
23833 example:
23834 .code
23835 sasl:
23836   driver = cyrus_sasl
23837   public_name = X-ANYTHING
23838   server_mech = CRAM-MD5
23839   server_set_id = $auth1
23840 .endd
23841
23842 .option server_realm cyrus_sasl string unset
23843 This specifies the SASL realm that the server claims to be in.
23844
23845
23846 .option server_service cyrus_sasl string &`smtp`&
23847 This is the SASL service that the server claims to implement.
23848
23849
23850 For straightforward cases, you do not need to set any of the authenticator's
23851 private options. All you need to do is to specify an appropriate mechanism as
23852 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
23853 PLAIN, you could have two authenticators as follows:
23854 .code
23855 sasl_cram_md5:
23856   driver = cyrus_sasl
23857   public_name = CRAM-MD5
23858   server_set_id = $auth1
23859
23860 sasl_plain:
23861   driver = cyrus_sasl
23862   public_name = PLAIN
23863   server_set_id = $auth2
23864 .endd
23865 Cyrus SASL does implement the LOGIN authentication method, even though it is
23866 not a standard method. It is disabled by default in the source distribution,
23867 but it is present in many binary distributions.
23868 .ecindex IIDcyrauth1
23869 .ecindex IIDcyrauth2
23870
23871
23872
23873
23874 . ////////////////////////////////////////////////////////////////////////////
23875 . ////////////////////////////////////////////////////////////////////////////
23876 .chapter "The dovecot authenticator" "CHAPdovecot"
23877 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
23878 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
23879 This authenticator is an interface to the authentication facility of the
23880 Dovecot POP/IMAP server, which can support a number of authentication methods.
23881 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
23882 to use the same mechanisms for SMTP authentication. This is a server
23883 authenticator only. There is only one option:
23884
23885 .option server_socket dovecot string unset
23886
23887 This option must specify the socket that is the interface to Dovecot
23888 authentication. The &%public_name%& option must specify an authentication
23889 mechanism that Dovecot is configured to support. You can have several
23890 authenticators for different mechanisms. For example:
23891 .code
23892 dovecot_plain:
23893   driver = dovecot
23894   public_name = PLAIN
23895   server_socket = /var/run/dovecot/auth-client
23896   server_set_id = $auth2
23897
23898 dovecot_ntlm:
23899   driver = dovecot
23900   public_name = NTLM
23901   server_socket = /var/run/dovecot/auth-client
23902   server_set_id = $auth1
23903 .endd
23904 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
23905 &$received_ip_address$& (that is, the connection is local), the &"secured"&
23906 option is passed in the Dovecot authentication command. If, for a TLS
23907 connection, a client certificate has been verified, the &"valid-client-cert"&
23908 option is passed. When authentication succeeds, the identity of the user
23909 who authenticated is placed in &$auth1$&.
23910 .ecindex IIDdcotauth1
23911 .ecindex IIDdcotauth2
23912
23913
23914 . ////////////////////////////////////////////////////////////////////////////
23915 . ////////////////////////////////////////////////////////////////////////////
23916
23917 .chapter "The spa authenticator" "CHAPspa"
23918 .scindex IIDspaauth1 "&(spa)& authenticator"
23919 .scindex IIDspaauth2 "authenticators" "&(spa)&"
23920 .cindex "authentication" "Microsoft Secure Password"
23921 .cindex "authentication" "NTLM"
23922 .cindex "Microsoft Secure Password Authentication"
23923 .cindex "NTLM authentication"
23924 The &(spa)& authenticator provides client support for Microsoft's &'Secure
23925 Password Authentication'& mechanism,
23926 which is also sometimes known as NTLM (NT LanMan). The code for client side of
23927 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
23928 taken from the Samba project (&url(http://www.samba.org)). The code for the
23929 server side was subsequently contributed by Tom Kistner. The mechanism works as
23930 follows:
23931
23932 .ilist
23933 After the AUTH command has been accepted, the client sends an SPA
23934 authentication request based on the user name and optional domain.
23935 .next
23936 The server sends back a challenge.
23937 .next
23938 The client builds a challenge response which makes use of the user's password
23939 and sends it to the server, which then accepts or rejects it.
23940 .endlist
23941
23942 Encryption is used to protect the password in transit.
23943
23944
23945
23946 .section "Using spa as a server" "SECID179"
23947 .cindex "options" "&(spa)& authenticator (server)"
23948 The &(spa)& authenticator has just one server option:
23949
23950 .option server_password spa string&!! unset
23951 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
23952 This option is expanded, and the result must be the cleartext password for the
23953 authenticating user, whose name is at this point in &$auth1$&. For
23954 compatibility with previous releases of Exim, the user name is also placed in
23955 &$1$&. However, the use of this variable for this purpose is now deprecated, as
23956 it can lead to confusion in string expansions that also use numeric variables
23957 for other things. For example:
23958 .code
23959 spa:
23960   driver = spa
23961   public_name = NTLM
23962   server_password = \
23963     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
23964 .endd
23965 If the expansion is forced to fail, authentication fails. Any other expansion
23966 failure causes a temporary error code to be returned.
23967
23968
23969
23970
23971
23972 .section "Using spa as a client" "SECID180"
23973 .cindex "options" "&(spa)& authenticator (client)"
23974 The &(spa)& authenticator has the following client options:
23975
23976
23977
23978 .option client_domain spa string&!! unset
23979 This option specifies an optional domain for the authentication.
23980
23981
23982 .option client_password spa string&!! unset
23983 This option specifies the user's password, and must be set.
23984
23985
23986 .option client_username spa string&!! unset
23987 This option specifies the user name, and must be set. Here is an example of a
23988 configuration of this authenticator for use with the mail servers at
23989 &'msn.com'&:
23990 .code
23991 msn:
23992   driver = spa
23993   public_name = MSN
23994   client_username = msn/msn_username
23995   client_password = msn_plaintext_password
23996   client_domain = DOMAIN_OR_UNSET
23997 .endd
23998 .ecindex IIDspaauth1
23999 .ecindex IIDspaauth2
24000
24001
24002
24003
24004
24005 . ////////////////////////////////////////////////////////////////////////////
24006 . ////////////////////////////////////////////////////////////////////////////
24007
24008 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
24009          "Encrypted SMTP connections"
24010 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
24011 .scindex IIDencsmtp2 "SMTP" "encryption"
24012 .cindex "TLS" "on SMTP connection"
24013 .cindex "OpenSSL"
24014 .cindex "GnuTLS"
24015 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
24016 Sockets Layer), is implemented by making use of the OpenSSL library or the
24017 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
24018 cryptographic code in the Exim distribution itself for implementing TLS. In
24019 order to use this feature you must install OpenSSL or GnuTLS, and then build a
24020 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
24021 You also need to understand the basic concepts of encryption at a managerial
24022 level, and in particular, the way that public keys, private keys, and
24023 certificates are used.
24024
24025 RFC 3207 defines how SMTP connections can make use of encryption. Once a
24026 connection is established, the client issues a STARTTLS command. If the
24027 server accepts this, the client and the server negotiate an encryption
24028 mechanism. If the negotiation succeeds, the data that subsequently passes
24029 between them is encrypted.
24030
24031 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
24032 and if so, what cipher suite is in use, whether the client supplied a
24033 certificate, and whether or not that certificate was verified. This makes it
24034 possible for an Exim server to deny or accept certain commands based on the
24035 encryption state.
24036
24037 &*Warning*&: Certain types of firewall and certain anti-virus products can
24038 disrupt TLS connections. You need to turn off SMTP scanning for these products
24039 in order to get TLS to work.
24040
24041
24042
24043 .section "Support for the legacy &""ssmtp""& (aka &""smtps""&) protocol" &&&
24044          "SECID284"
24045 .cindex "ssmtp protocol"
24046 .cindex "smtps protocol"
24047 .cindex "SMTP" "ssmtp protocol"
24048 .cindex "SMTP" "smtps protocol"
24049 Early implementations of encrypted SMTP used a different TCP port from normal
24050 SMTP, and expected an encryption negotiation to start immediately, instead of
24051 waiting for a STARTTLS command from the client using the standard SMTP
24052 port. The protocol was called &"ssmtp"& or &"smtps"&, and port 465 was
24053 allocated for this purpose.
24054
24055 This approach was abandoned when encrypted SMTP was standardized, but there are
24056 still some legacy clients that use it. Exim supports these clients by means of
24057 the &%tls_on_connect_ports%& global option. Its value must be a list of port
24058 numbers; the most common use is expected to be:
24059 .code
24060 tls_on_connect_ports = 465
24061 .endd
24062 The port numbers specified by this option apply to all SMTP connections, both
24063 via the daemon and via &'inetd'&. You still need to specify all the ports that
24064 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
24065 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
24066 an extra port &-- rather, it specifies different behaviour on a port that is
24067 defined elsewhere.
24068
24069 There is also a &%-tls-on-connect%& command line option. This overrides
24070 &%tls_on_connect_ports%&; it forces the legacy behaviour for all ports.
24071
24072
24073
24074
24075
24076
24077 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
24078 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
24079 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
24080 followed later, when the first versions of GnuTLS were released. To build Exim
24081 to use GnuTLS, you need to set
24082 .code
24083 USE_GNUTLS=yes
24084 .endd
24085 in Local/Makefile, in addition to
24086 .code
24087 SUPPORT_TLS=yes
24088 .endd
24089 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
24090 include files and libraries for GnuTLS can be found.
24091
24092 There are some differences in usage when using GnuTLS instead of OpenSSL:
24093
24094 .ilist
24095 The &%tls_verify_certificates%& option must contain the name of a file, not the
24096 name of a directory (for OpenSSL it can be either).
24097 .next
24098 The &%tls_dhparam%& option is ignored, because early versions of GnuTLS had no
24099 facility for varying its Diffie-Hellman parameters. I understand that this has
24100 changed, but Exim has not been updated to provide this facility.
24101 .next
24102 .vindex "&$tls_peerdn$&"
24103 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
24104 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
24105 affects the value of the &$tls_peerdn$& variable.
24106 .next
24107 OpenSSL identifies cipher suites using hyphens as separators, for example:
24108 DES-CBC3-SHA. GnuTLS uses underscores, for example: RSA_ARCFOUR_SHA. What is
24109 more, OpenSSL complains if underscores are present in a cipher list. To make
24110 life simpler, Exim changes underscores to hyphens for OpenSSL and hyphens to
24111 underscores for GnuTLS when processing lists of cipher suites in the
24112 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
24113 option).
24114 .next
24115 The &%tls_require_ciphers%& options operate differently, as described in the
24116 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
24117 .endlist
24118
24119
24120 .section "GnuTLS parameter computation" "SECID181"
24121 GnuTLS uses D-H parameters that may take a substantial amount of time
24122 to compute. It is unreasonable to re-compute them for every TLS session.
24123 Therefore, Exim keeps this data in a file in its spool directory, called
24124 &_gnutls-params_&. The file is owned by the Exim user and is readable only by
24125 its owner. Every Exim process that start up GnuTLS reads the D-H
24126 parameters from this file. If the file does not exist, the first Exim process
24127 that needs it computes the data and writes it to a temporary file which is
24128 renamed once it is complete. It does not matter if several Exim processes do
24129 this simultaneously (apart from wasting a few resources). Once a file is in
24130 place, new Exim processes immediately start using it.
24131
24132 For maximum security, the parameters that are stored in this file should be
24133 recalculated periodically, the frequency depending on your paranoia level.
24134 Arranging this is easy in principle; just delete the file when you want new
24135 values to be computed. However, there may be a problem. The calculation of new
24136 parameters needs random numbers, and these are obtained from &_/dev/random_&.
24137 If the system is not very active, &_/dev/random_& may delay returning data
24138 until enough randomness (entropy) is available. This may cause Exim to hang for
24139 a substantial amount of time, causing timeouts on incoming connections.
24140
24141 The solution is to generate the parameters externally to Exim. They are stored
24142 in &_gnutls-params_& in PEM format, which means that they can be generated
24143 externally using the &(certtool)& command that is part of GnuTLS.
24144
24145 To replace the parameters with new ones, instead of deleting the file
24146 and letting Exim re-create it, you can generate new parameters using
24147 &(certtool)& and, when this has been done, replace Exim's cache file by
24148 renaming. The relevant commands are something like this:
24149 .code
24150 # rm -f new-params
24151 # touch new-params
24152 # chown exim:exim new-params
24153 # chmod 0400 new-params
24154 # certtool --generate-privkey --bits 512 >new-params
24155 # echo "" >>new-params
24156 # certtool --generate-dh-params --bits 1024 >> new-params
24157 # mv new-params gnutls-params
24158 .endd
24159 If Exim never has to generate the parameters itself, the possibility of
24160 stalling is removed.
24161
24162
24163 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
24164 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
24165 .oindex "&%tls_require_ciphers%&" "OpenSSL"
24166 There is a function in the OpenSSL library that can be passed a list of cipher
24167 suites before the cipher negotiation takes place. This specifies which ciphers
24168 are acceptable. The list is colon separated and may contain names like
24169 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
24170 directly to this function call. The following quotation from the OpenSSL
24171 documentation specifies what forms of item are allowed in the cipher string:
24172
24173 .ilist
24174 It can consist of a single cipher suite such as RC4-SHA.
24175 .next
24176 It can represent a list of cipher suites containing a certain algorithm,
24177 or cipher suites of a certain type. For example SHA1 represents all
24178 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
24179 SSL v3 algorithms.
24180 .next
24181 Lists of cipher suites can be combined in a single cipher string using
24182 the + character. This is used as a logical and operation. For example
24183 SHA1+DES represents all cipher suites containing the SHA1 and the DES
24184 algorithms.
24185 .endlist
24186
24187 Each cipher string can be optionally preceded by one of the characters &`!`&,
24188 &`-`& or &`+`&.
24189 .ilist
24190 If &`!`& is used, the ciphers are permanently deleted from the list. The
24191 ciphers deleted can never reappear in the list even if they are explicitly
24192 stated.
24193 .next
24194 If &`-`& is used, the ciphers are deleted from the list, but some or all
24195 of the ciphers can be added again by later options.
24196 .next
24197 If &`+`& is used, the ciphers are moved to the end of the list. This
24198 option does not add any new ciphers; it just moves matching existing ones.
24199 .endlist
24200
24201 If none of these characters is present, the string is interpreted as
24202 a list of ciphers to be appended to the current preference list. If the list
24203 includes any ciphers already present they will be ignored: that is, they will
24204 not be moved to the end of the list.
24205 .endlist
24206
24207
24208
24209 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
24210          "SECTreqciphgnu"
24211 .cindex "GnuTLS" "specifying parameters for"
24212 .cindex "TLS" "specifying ciphers (GnuTLS)"
24213 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
24214 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
24215 .cindex "TLS" "specifying protocols (GnuTLS)"
24216 .oindex "&%tls_require_ciphers%&" "GnuTLS"
24217 The GnuTLS library allows the caller to specify separate lists of permitted key
24218 exchange methods, main cipher algorithms, MAC algorithms, and protocols.
24219 Unfortunately, these lists are numerical, and the library does not have a
24220 function for turning names into numbers. Consequently, lists of recognized
24221 names have to be built into the application. The permitted key exchange
24222 methods, ciphers, and MAC algorithms may be used in any combination to form a
24223 cipher suite. This is unlike OpenSSL, where complete cipher suite names are
24224 passed to its control function.
24225
24226 For compatibility with OpenSSL, the &%tls_require_ciphers%& option can be set
24227 to complete cipher suite names such as RSA_ARCFOUR_SHA, but for GnuTLS this
24228 option controls only the cipher algorithms. Exim searches each item in the
24229 list for the name of an available algorithm. For example, if the list
24230 contains RSA_AES_SHA, then AES is recognized, and the behaviour is exactly
24231 the same as if just AES were given.
24232
24233 .oindex "&%gnutls_require_kx%&"
24234 .oindex "&%gnutls_require_mac%&"
24235 .oindex "&%gnutls_require_protocols%&"
24236 There are additional options called &%gnutls_require_kx%&,
24237 &%gnutls_require_mac%&, and &%gnutls_require_protocols%& that can be used to
24238 restrict the key exchange methods, MAC algorithms, and protocols, respectively.
24239 These options are ignored if OpenSSL is in use.
24240
24241 All four options are available as global options, controlling how Exim
24242 behaves as a server, and also as options of the &(smtp)& transport, controlling
24243 how Exim behaves as a client. All the values are string expanded. After
24244 expansion, the values must be colon-separated lists, though the separator
24245 can be changed in the usual way.
24246
24247 Each of the four lists starts out with a default set of algorithms. If the
24248 first item in a list does &'not'& start with an exclamation mark, all the
24249 default items are deleted. In this case, only those that are explicitly
24250 specified can be used. If the first item in a list &'does'& start with an
24251 exclamation mark, the defaults are left on the list.
24252
24253 Then, any item that starts with an exclamation mark causes the relevant
24254 entry to be removed from the list, and any item that does not start with an
24255 exclamation mark causes a new entry to be added to the list. Unrecognized
24256 items in the list are ignored. Thus:
24257 .code
24258 tls_require_ciphers = !ARCFOUR
24259 .endd
24260 allows all the defaults except ARCFOUR, whereas
24261 .code
24262 tls_require_ciphers = AES : 3DES
24263 .endd
24264 allows only cipher suites that use AES or 3DES.
24265
24266 For &%tls_require_ciphers%& the recognized names are AES_256, AES_128, AES
24267 (both of the preceding), 3DES, ARCFOUR_128, ARCFOUR_40, and ARCFOUR (both of
24268 the preceding). The default list does not contain all of these; it just has
24269 AES_256, AES_128, 3DES, and ARCFOUR_128.
24270
24271 For &%gnutls_require_kx%&, the recognized names are DHE_RSA, RSA (which
24272 includes DHE_RSA), DHE_DSS, and DHE (which includes both DHE_RSA and
24273 DHE_DSS). The default list contains RSA, DHE_DSS, DHE_RSA.
24274
24275 For &%gnutls_require_mac%&, the recognized names are SHA (synonym SHA1), and
24276 MD5. The default list contains SHA, MD5.
24277
24278 For &%gnutls_require_protocols%&, the recognized names are TLS1 and SSL3.
24279 The default list contains TLS1, SSL3.
24280
24281 In a server, the order of items in these lists is unimportant. The server
24282 advertises the availability of all the relevant cipher suites. However, in a
24283 client, the order in the &%tls_require_ciphers%& list specifies a preference
24284 order for the cipher algorithms. The first one in the client's list that is
24285 also advertised by the server is tried first. The default order is as listed
24286 above.
24287
24288
24289
24290 .section "Configuring an Exim server to use TLS" "SECID182"
24291 .cindex "TLS" "configuring an Exim server"
24292 When Exim has been built with TLS support, it advertises the availability of
24293 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
24294 but not to any others. The default value of this option is unset, which means
24295 that STARTTLS is not advertised at all. This default is chosen because you
24296 need to set some other options in order to make TLS available, and also it is
24297 sensible for systems that want to use TLS only as a client.
24298
24299 If a client issues a STARTTLS command and there is some configuration
24300 problem in the server, the command is rejected with a 454 error. If the client
24301 persists in trying to issue SMTP commands, all except QUIT are rejected
24302 with the error
24303 .code
24304 554 Security failure
24305 .endd
24306 If a STARTTLS command is issued within an existing TLS session, it is
24307 rejected with a 554 error code.
24308
24309 To enable TLS operations on a server, you must set &%tls_advertise_hosts%& to
24310 match some hosts. You can, of course, set it to * to match all hosts.
24311 However, this is not all you need to do. TLS sessions to a server won't work
24312 without some further configuration at the server end.
24313
24314 It is rumoured that all existing clients that support TLS/SSL use RSA
24315 encryption. To make this work you need to set, in the server,
24316 .code
24317 tls_certificate = /some/file/name
24318 tls_privatekey = /some/file/name
24319 .endd
24320 These options are, in fact, expanded strings, so you can make them depend on
24321 the identity of the client that is connected if you wish. The first file
24322 contains the server's X509 certificate, and the second contains the private key
24323 that goes with it. These files need to be readable by the Exim user, and must
24324 always be given as full path names. They can be the same file if both the
24325 certificate and the key are contained within it. If &%tls_privatekey%& is not
24326 set, or if its expansion is forced to fail or results in an empty string, this
24327 is assumed to be the case. The certificate file may also contain intermediate
24328 certificates that need to be sent to the client to enable it to authenticate
24329 the server's certificate.
24330
24331 If you do not understand about certificates and keys, please try to find a
24332 source of this background information, which is not Exim-specific. (There are a
24333 few comments below in section &<<SECTcerandall>>&.)
24334
24335 &*Note*&: These options do not apply when Exim is operating as a client &--
24336 they apply only in the case of a server. If you need to use a certificate in an
24337 Exim client, you must set the options of the same names in an &(smtp)&
24338 transport.
24339
24340 With just these options, an Exim server will be able to use TLS. It does not
24341 require the client to have a certificate (but see below for how to insist on
24342 this). There is one other option that may be needed in other situations. If
24343 .code
24344 tls_dhparam = /some/file/name
24345 .endd
24346 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
24347 with the parameters contained in the file. This increases the set of cipher
24348 suites that the server supports. See the command
24349 .code
24350 openssl dhparam
24351 .endd
24352 for a way of generating this data. At present, &%tls_dhparam%& is used only
24353 when Exim is linked with OpenSSL. It is ignored if GnuTLS is being used.
24354
24355 The strings supplied for these three options are expanded every time a client
24356 host connects. It is therefore possible to use different certificates and keys
24357 for different hosts, if you so wish, by making use of the client's IP address
24358 in &$sender_host_address$& to control the expansion. If a string expansion is
24359 forced to fail, Exim behaves as if the option is not set.
24360
24361 .cindex "cipher" "logging"
24362 .cindex "log" "TLS cipher"
24363 .vindex "&$tls_cipher$&"
24364 The variable &$tls_cipher$& is set to the cipher suite that was negotiated for
24365 an incoming TLS connection. It is included in the &'Received:'& header of an
24366 incoming message (by default &-- you can, of course, change this), and it is
24367 also included in the log line that records a message's arrival, keyed by
24368 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
24369 condition can be used to test for specific cipher suites in ACLs.
24370 (For outgoing SMTP deliveries, &$tls_cipher$& is reset &-- see section
24371 &<<SECID185>>&.)
24372
24373 Once TLS has been established, the ACLs that run for subsequent SMTP commands
24374 can check the name of the cipher suite and vary their actions accordingly. The
24375 cipher suite names vary, depending on which TLS library is being used. For
24376 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
24377 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
24378 documentation for more details.
24379
24380
24381 .section "Requesting and verifying client certificates" "SECID183"
24382 .cindex "certificate" "verification of client"
24383 .cindex "TLS" "client certificate verification"
24384 If you want an Exim server to request a certificate when negotiating a TLS
24385 session with a client, you must set either &%tls_verify_hosts%& or
24386 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
24387 apply to all TLS connections. For any host that matches one of these options,
24388 Exim requests a certificate as part of the setup of the TLS session. The
24389 contents of the certificate are verified by comparing it with a list of
24390 expected certificates. These must be available in a file or,
24391 for OpenSSL only (not GnuTLS), a directory, identified by
24392 &%tls_verify_certificates%&.
24393
24394 A file can contain multiple certificates, concatenated end to end. If a
24395 directory is used
24396 (OpenSSL only),
24397 each certificate must be in a separate file, with a name (or a symbolic link)
24398 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
24399 certificate. You can compute the relevant hash by running the command
24400 .code
24401 openssl x509 -hash -noout -in /cert/file
24402 .endd
24403 where &_/cert/file_& contains a single certificate.
24404
24405 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
24406 what happens if the client does not supply a certificate, or if the certificate
24407 does not match any of the certificates in the collection named by
24408 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
24409 attempt to set up a TLS session is aborted, and the incoming connection is
24410 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
24411 session continues. ACLs that run for subsequent SMTP commands can detect the
24412 fact that no certificate was verified, and vary their actions accordingly. For
24413 example, you can insist on a certificate before accepting a message for
24414 relaying, but not when the message is destined for local delivery.
24415
24416 .vindex "&$tls_peerdn$&"
24417 When a client supplies a certificate (whether it verifies or not), the value of
24418 the Distinguished Name of the certificate is made available in the variable
24419 &$tls_peerdn$& during subsequent processing of the message.
24420
24421 .cindex "log" "distinguished name"
24422 Because it is often a long text string, it is not included in the log line or
24423 &'Received:'& header by default. You can arrange for it to be logged, keyed by
24424 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
24425 &%received_header_text%& to change the &'Received:'& header. When no
24426 certificate is supplied, &$tls_peerdn$& is empty.
24427
24428
24429 .section "Revoked certificates" "SECID184"
24430 .cindex "TLS" "revoked certificates"
24431 .cindex "revocation list"
24432 .cindex "certificate" "revocation list"
24433 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
24434 certificates are revoked. If you have such a list, you can pass it to an Exim
24435 server using the global option called &%tls_crl%& and to an Exim client using
24436 an identically named option for the &(smtp)& transport. In each case, the value
24437 of the option is expanded and must then be the name of a file that contains a
24438 CRL in PEM format.
24439
24440
24441 .section "Configuring an Exim client to use TLS" "SECID185"
24442 .cindex "cipher" "logging"
24443 .cindex "log" "TLS cipher"
24444 .cindex "log" "distinguished name"
24445 .cindex "TLS" "configuring an Exim client"
24446 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
24447 deliveries as well as to incoming, the latter one causing logging of the
24448 server certificate's DN. The remaining client configuration for TLS is all
24449 within the &(smtp)& transport.
24450
24451 It is not necessary to set any options to have TLS work in the &(smtp)&
24452 transport. If Exim is built with TLS support, and TLS is advertised by a
24453 server, the &(smtp)& transport always tries to start a TLS session. However,
24454 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
24455 transport) to a list of server hosts for which TLS should not be used.
24456
24457 If you do not want Exim to attempt to send messages unencrypted when an attempt
24458 to set up an encrypted connection fails in any way, you can set
24459 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
24460 those hosts, delivery is always deferred if an encrypted connection cannot be
24461 set up. If there are any other hosts for the address, they are tried in the
24462 usual way.
24463
24464 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
24465 the message unencrypted. It always does this if the response to STARTTLS is
24466 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
24467 session after a success response code, what happens is controlled by the
24468 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
24469 delivery to this host is deferred, and other hosts (if available) are tried. If
24470 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
24471 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
24472 negotiation fails, Exim closes the current connection (because it is in an
24473 unknown state), opens a new one to the same host, and then tries the delivery
24474 unencrypted.
24475
24476 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
24477 transport provide the client with a certificate, which is passed to the server
24478 if it requests it. If the server is Exim, it will request a certificate only if
24479 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
24480
24481 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
24482 must name a file or,
24483 for OpenSSL only (not GnuTLS), a directory, that contains a collection of
24484 expected server certificates. The client verifies the server's certificate
24485 against this collection, taking into account any revoked certificates that are
24486 in the list defined by &%tls_crl%&.
24487
24488 If
24489 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
24490 list of permitted cipher suites. If either of these checks fails, delivery to
24491 the current host is abandoned, and the &(smtp)& transport tries to deliver to
24492 alternative hosts, if any.
24493
24494  &*Note*&:
24495 These options must be set in the &(smtp)& transport for Exim to use TLS when it
24496 is operating as a client. Exim does not assume that a server certificate (set
24497 by the global options of the same name) should also be used when operating as a
24498 client.
24499
24500 .vindex "&$host$&"
24501 .vindex "&$host_address$&"
24502 All the TLS options in the &(smtp)& transport are expanded before use, with
24503 &$host$& and &$host_address$& containing the name and address of the server to
24504 which the client is connected. Forced failure of an expansion causes Exim to
24505 behave as if the relevant option were unset.
24506
24507 .vindex &$tls_cipher$&
24508 .vindex &$tls_peerdn$&
24509 Before an SMTP connection is established, the &$tls_cipher$& and &$tls_peerdn$&
24510 variables are emptied. (Until the first connection, they contain the values
24511 that were set when the message was received.) If STARTTLS is subsequently
24512 successfully obeyed, these variables are set to the relevant values for the
24513 outgoing connection.
24514
24515
24516
24517 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
24518          "SECTmulmessam"
24519 .cindex "multiple SMTP deliveries with TLS"
24520 .cindex "TLS" "multiple message deliveries"
24521 Exim sends multiple messages down the same TCP/IP connection by starting up
24522 an entirely new delivery process for each message, passing the socket from
24523 one process to the next. This implementation does not fit well with the use
24524 of TLS, because there is quite a lot of state information associated with a TLS
24525 connection, not just a socket identification. Passing all the state information
24526 to a new process is not feasible. Consequently, Exim shuts down an existing TLS
24527 session before passing the socket to a new process. The new process may then
24528 try to start a new TLS session, and if successful, may try to re-authenticate
24529 if AUTH is in use, before sending the next message.
24530
24531 The RFC is not clear as to whether or not an SMTP session continues in clear
24532 after TLS has been shut down, or whether TLS may be restarted again later, as
24533 just described. However, if the server is Exim, this shutdown and
24534 reinitialization works. It is not known which (if any) other servers operate
24535 successfully if the client closes a TLS session and continues with unencrypted
24536 SMTP, but there are certainly some that do not work. For such servers, Exim
24537 should not pass the socket to another process, because the failure of the
24538 subsequent attempt to use it would cause Exim to record a temporary host error,
24539 and delay other deliveries to that host.
24540
24541 To test for this case, Exim sends an EHLO command to the server after
24542 closing down the TLS session. If this fails in any way, the connection is
24543 closed instead of being passed to a new delivery process, but no retry
24544 information is recorded.
24545
24546 There is also a manual override; you can set &%hosts_nopass_tls%& on the
24547 &(smtp)& transport to match those hosts for which Exim should not pass
24548 connections to new processes if TLS has been used.
24549
24550
24551
24552
24553 .section "Certificates and all that" "SECTcerandall"
24554 .cindex "certificate" "references to discussion"
24555 In order to understand fully how TLS works, you need to know about
24556 certificates, certificate signing, and certificate authorities. This is not the
24557 place to give a tutorial, especially as I do not know very much about it
24558 myself. Some helpful introduction can be found in the FAQ for the SSL addition
24559 to Apache, currently at
24560 .display
24561 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
24562 .endd
24563 Other parts of the &'modssl'& documentation are also helpful, and have
24564 links to further files.
24565 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
24566 0-201-61598-3), contains both introductory and more in-depth descriptions.
24567 Some sample programs taken from the book are available from
24568 .display
24569 &url(http://www.rtfm.com/openssl-examples/)
24570 .endd
24571
24572
24573 .section "Certificate chains" "SECID186"
24574 The file named by &%tls_certificate%& may contain more than one
24575 certificate. This is useful in the case where the certificate that is being
24576 sent is validated by an intermediate certificate which the other end does
24577 not have. Multiple certificates must be in the correct order in the file.
24578 First the host's certificate itself, then the first intermediate
24579 certificate to validate the issuer of the host certificate, then the next
24580 intermediate certificate to validate the issuer of the first intermediate
24581 certificate, and so on, until finally (optionally) the root certificate.
24582 The root certificate must already be trusted by the recipient for
24583 validation to succeed, of course, but if it's not preinstalled, sending the
24584 root certificate along with the rest makes it available for the user to
24585 install if the receiving end is a client MUA that can interact with a user.
24586
24587
24588 .section "Self-signed certificates" "SECID187"
24589 .cindex "certificate" "self-signed"
24590 You can create a self-signed certificate using the &'req'& command provided
24591 with OpenSSL, like this:
24592 .code
24593 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
24594             -days 9999 -nodes
24595 .endd
24596 &_file1_& and &_file2_& can be the same file; the key and the certificate are
24597 delimited and so can be identified independently. The &%-days%& option
24598 specifies a period for which the certificate is valid. The &%-nodes%& option is
24599 important: if you do not set it, the key is encrypted with a passphrase
24600 that you are prompted for, and any use that is made of the key causes more
24601 prompting for the passphrase. This is not helpful if you are going to use
24602 this certificate and key in an MTA, where prompting is not possible.
24603
24604 A self-signed certificate made in this way is sufficient for testing, and
24605 may be adequate for all your requirements if you are mainly interested in
24606 encrypting transfers, and not in secure identification.
24607
24608 However, many clients require that the certificate presented by the server be a
24609 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
24610 certificate. In this situation, the self-signed certificate described above
24611 must be installed on the client host as a trusted root &'certification
24612 authority'& (CA), and the certificate used by Exim must be a user certificate
24613 signed with that self-signed certificate.
24614
24615 For information on creating self-signed CA certificates and using them to sign
24616 user certificates, see the &'General implementation overview'& chapter of the
24617 Open-source PKI book, available online at
24618 &url(http://ospkibook.sourceforge.net/).
24619 .ecindex IIDencsmtp1
24620 .ecindex IIDencsmtp2
24621
24622
24623
24624 . ////////////////////////////////////////////////////////////////////////////
24625 . ////////////////////////////////////////////////////////////////////////////
24626
24627 .chapter "Access control lists" "CHAPACL"
24628 .scindex IIDacl "&ACL;" "description"
24629 .cindex "control of incoming mail"
24630 .cindex "message" "controlling incoming"
24631 .cindex "policy control" "access control lists"
24632 Access Control Lists (ACLs) are defined in a separate section of the run time
24633 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
24634 name, terminated by a colon. Here is a complete ACL section that contains just
24635 one very small ACL:
24636 .code
24637 begin acl
24638 small_acl:
24639   accept   hosts = one.host.only
24640 .endd
24641 You can have as many lists as you like in the ACL section, and the order in
24642 which they appear does not matter. The lists are self-terminating.
24643
24644 The majority of ACLs are used to control Exim's behaviour when it receives
24645 certain SMTP commands. This applies both to incoming TCP/IP connections, and
24646 when a local process submits a message using SMTP by specifying the &%-bs%&
24647 option. The most common use is for controlling which recipients are accepted
24648 in incoming messages. In addition, you can define an ACL that is used to check
24649 local non-SMTP messages. The default configuration file contains an example of
24650 a realistic ACL for checking RCPT commands. This is discussed in chapter
24651 &<<CHAPdefconfil>>&.
24652
24653
24654 .section "Testing ACLs" "SECID188"
24655 The &%-bh%& command line option provides a way of testing your ACL
24656 configuration locally by running a fake SMTP session with which you interact.
24657 The host &'relay-test.mail-abuse.org'& provides a service for checking your
24658 relaying configuration (see section &<<SECTcheralcon>>& for more details).
24659
24660
24661
24662 .section "Specifying when ACLs are used" "SECID189"
24663 .cindex "&ACL;" "options for specifying"
24664 In order to cause an ACL to be used, you have to name it in one of the relevant
24665 options in the main part of the configuration. These options are:
24666 .cindex "AUTH" "ACL for"
24667 .cindex "DATA" "ACLs for"
24668 .cindex "ETRN" "ACL for"
24669 .cindex "EXPN" "ACL for"
24670 .cindex "HELO" "ACL for"
24671 .cindex "EHLO" "ACL for"
24672 .cindex "MAIL" "ACL for"
24673 .cindex "QUIT, ACL for"
24674 .cindex "RCPT" "ACL for"
24675 .cindex "STARTTLS, ACL for"
24676 .cindex "VRFY" "ACL for"
24677 .cindex "SMTP" "connection, ACL for"
24678 .cindex "non-SMTP messages" "ACLs for"
24679 .cindex "MIME content scanning" "ACL for"
24680
24681 .table2 140pt
24682 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
24683 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
24684 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
24685 .irow &%acl_smtp_auth%&        "ACL for AUTH"
24686 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
24687 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
24688 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
24689 .irow &%acl_smtp_expn%&        "ACL for EXPN"
24690 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
24691 .irow &%acl_smtp_mail%&        "ACL for MAIL"
24692 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
24693 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
24694 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
24695 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
24696 .irow &%acl_smtp_quit%&        "ACL for QUIT"
24697 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
24698 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
24699 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
24700 .endtable
24701
24702 For example, if you set
24703 .code
24704 acl_smtp_rcpt = small_acl
24705 .endd
24706 the little ACL defined above is used whenever Exim receives a RCPT command
24707 in an SMTP dialogue. The majority of policy tests on incoming messages can be
24708 done when RCPT commands arrive. A rejection of RCPT should cause the
24709 sending MTA to give up on the recipient address contained in the RCPT
24710 command, whereas rejection at other times may cause the client MTA to keep on
24711 trying to deliver the message. It is therefore recommended that you do as much
24712 testing as possible at RCPT time.
24713
24714
24715 .section "The non-SMTP ACLs" "SECID190"
24716 .cindex "non-SMTP messages" "ACLs for"
24717 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
24718 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
24719 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
24720 the state of the SMTP connection such as encryption and authentication) are not
24721 relevant and are forbidden in these ACLs. However, the sender and recipients
24722 are known, so the &%senders%& and &%sender_domains%& conditions and the
24723 &$sender_address$& and &$recipients$& variables can be used. Variables such as
24724 &$authenticated_sender$& are also available. You can specify added header lines
24725 in any of these ACLs.
24726
24727 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
24728 non-SMTP message, before any of the message has been read. (This is the
24729 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
24730 batched SMTP input, it runs after the DATA command has been reached. The
24731 result of this ACL is ignored; it cannot be used to reject a message. If you
24732 really need to, you could set a value in an ACL variable here and reject based
24733 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
24734 controls, and in particular, it can be used to set
24735 .code
24736 control = suppress_local_fixups
24737 .endd
24738 This cannot be used in the other non-SMTP ACLs because by the time they are
24739 run, it is too late.
24740
24741 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
24742 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
24743
24744 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
24745 kind of rejection is treated as permanent, because there is no way of sending a
24746 temporary error for these kinds of message.
24747
24748
24749 .section "The SMTP connect ACL" "SECID191"
24750 .cindex "SMTP" "connection, ACL for"
24751 .oindex &%smtp_banner%&
24752 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
24753 session, after the test specified by &%host_reject_connection%& (which is now
24754 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
24755 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
24756 the message override the banner message that is otherwise specified by the
24757 &%smtp_banner%& option.
24758
24759
24760 .section "The EHLO/HELO ACL" "SECID192"
24761 .cindex "EHLO" "ACL for"
24762 .cindex "HELO" "ACL for"
24763 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
24764 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
24765 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
24766 Note that a client may issue more than one EHLO or HELO command in an SMTP
24767 session, and indeed is required to issue a new EHLO or HELO after successfully
24768 setting up encryption following a STARTTLS command.
24769
24770 If the command is accepted by an &%accept%& verb that has a &%message%&
24771 modifier, the message may not contain more than one line (it will be truncated
24772 at the first newline and a panic logged if it does). Such a message cannot
24773 affect the EHLO options that are listed on the second and subsequent lines of
24774 an EHLO response.
24775
24776
24777 .section "The DATA ACLs" "SECID193"
24778 .cindex "DATA" "ACLs for"
24779 Two ACLs are associated with the DATA command, because it is two-stage
24780 command, with two responses being sent to the client.
24781 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
24782 is obeyed. This gives you control after all the RCPT commands, but before
24783 the message itself is received. It offers the opportunity to give a negative
24784 response to the DATA command before the data is transmitted. Header lines
24785 added by MAIL or RCPT ACLs are not visible at this time, but any that
24786 are defined here are visible when the &%acl_smtp_data%& ACL is run.
24787
24788 You cannot test the contents of the message, for example, to verify addresses
24789 in the headers, at RCPT time or when the DATA command is received. Such
24790 tests have to appear in the ACL that is run after the message itself has been
24791 received, before the final response to the DATA command is sent. This is
24792 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
24793 associated with the DATA command.
24794
24795 For both of these ACLs, it is not possible to reject individual recipients. An
24796 error response rejects the entire message. Unfortunately, it is known that some
24797 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
24798 before or after the data) correctly &-- they keep the message on their queues
24799 and try again later, but that is their problem, though it does waste some of
24800 your resources.
24801
24802
24803 .section "The SMTP MIME ACL" "SECID194"
24804 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
24805 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
24806
24807
24808 .section "The QUIT ACL" "SECTQUITACL"
24809 .cindex "QUIT, ACL for"
24810 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
24811 does not affect the response code to QUIT, which is always 221. Thus, the ACL
24812 does not in fact control any access. For this reason, the only verbs that are
24813 permitted are &%accept%& and &%warn%&.
24814
24815 This ACL can be used for tasks such as custom logging at the end of an SMTP
24816 session. For example, you can use ACL variables in other ACLs to count
24817 messages, recipients, etc., and log the totals at QUIT time using one or
24818 more &%logwrite%& modifiers on a &%warn%& verb.
24819
24820 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
24821 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
24822
24823 You do not need to have a final &%accept%&, but if you do, you can use a
24824 &%message%& modifier to specify custom text that is sent as part of the 221
24825 response to QUIT.
24826
24827 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
24828 failure (for example, failure to open a log file, or when Exim is bombing out
24829 because it has detected an unrecoverable error), all SMTP commands from the
24830 client are given temporary error responses until QUIT is received or the
24831 connection is closed. In these special cases, the QUIT ACL does not run.
24832
24833
24834 .section "The not-QUIT ACL" "SECTNOTQUITACL"
24835 .vindex &$acl_smtp_notquit$&
24836 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
24837 an SMTP session ends without sending QUIT. However, when Exim itself is is bad
24838 trouble, such as being unable to write to its log files, this ACL is not run,
24839 because it might try to do things (such as write to log files) that make the
24840 situation even worse.
24841
24842 Like the QUIT ACL, this ACL is provided to make it possible to do customized
24843 logging or to gather statistics, and its outcome is ignored. The &%delay%&
24844 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
24845 and &%warn%&.
24846
24847 .vindex &$smtp_notquit_reason$&
24848 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
24849 to a string that indicates the reason for the termination of the SMTP
24850 connection. The possible values are:
24851 .table2
24852 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
24853 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
24854 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
24855 .irow &`connection-lost`&          "The SMTP connection has been lost"
24856 .irow &`data-timeout`&             "Timeout while reading message data"
24857 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
24858 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
24859 .irow &`signal-exit`&              "SIGTERM or SIGINT"
24860 .irow &`synchronization-error`&    "SMTP synchronization error"
24861 .irow &`tls-failed`&               "TLS failed to start"
24862 .endtable
24863 In most cases when an SMTP connection is closed without having received QUIT,
24864 Exim sends an SMTP response message before actually closing the connection.
24865 With the exception of the &`acl-drop`& case, the default message can be
24866 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
24867 &%drop%& verb in another ACL, it is the message from the other ACL that is
24868 used.
24869
24870
24871 .section "Finding an ACL to use" "SECID195"
24872 .cindex "&ACL;" "finding which to use"
24873 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
24874 you can use different ACLs in different circumstances. For example,
24875 .code
24876 acl_smtp_rcpt = ${if ={25}{$interface_port} \
24877                      {acl_check_rcpt} {acl_check_rcpt_submit} }
24878 .endd
24879 In the default configuration file there are some example settings for
24880 providing an RFC 4409 message submission service on port 587 and a
24881 non-standard &"smtps"& service on port 465. You can use a string
24882 expansion like this to choose an ACL for MUAs on these ports which is
24883 more appropriate for this purpose than the default ACL on port 25.
24884
24885 The expanded string does not have to be the name of an ACL in the
24886 configuration file; there are other possibilities. Having expanded the
24887 string, Exim searches for an ACL as follows:
24888
24889 .ilist
24890 If the string begins with a slash, Exim uses it as a file name, and reads its
24891 contents as an ACL. The lines are processed in the same way as lines in the
24892 Exim configuration file. In particular, continuation lines are supported, blank
24893 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
24894 If the file does not exist or cannot be read, an error occurs (typically
24895 causing a temporary failure of whatever caused the ACL to be run). For example:
24896 .code
24897 acl_smtp_data = /etc/acls/\
24898   ${lookup{$sender_host_address}lsearch\
24899   {/etc/acllist}{$value}{default}}
24900 .endd
24901 This looks up an ACL file to use on the basis of the host's IP address, falling
24902 back to a default if the lookup fails. If an ACL is successfully read from a
24903 file, it is retained in memory for the duration of the Exim process, so that it
24904 can be re-used without having to re-read the file.
24905 .next
24906 If the string does not start with a slash, and does not contain any spaces,
24907 Exim searches the ACL section of the configuration for an ACL whose name
24908 matches the string.
24909 .next
24910 If no named ACL is found, or if the string contains spaces, Exim parses
24911 the string as an inline ACL. This can save typing in cases where you just
24912 want to have something like
24913 .code
24914 acl_smtp_vrfy = accept
24915 .endd
24916 in order to allow free use of the VRFY command. Such a string may contain
24917 newlines; it is processed in the same way as an ACL that is read from a file.
24918 .endlist
24919
24920
24921
24922
24923 .section "ACL return codes" "SECID196"
24924 .cindex "&ACL;" "return codes"
24925 Except for the QUIT ACL, which does not affect the SMTP return code (see
24926 section &<<SECTQUITACL>>& above), the result of running an ACL is either
24927 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
24928 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
24929 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
24930 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
24931 This also causes a 4&'xx'& return code.
24932
24933 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
24934 &"deny"&, because there is no mechanism for passing temporary errors to the
24935 submitters of non-SMTP messages.
24936
24937
24938 ACLs that are relevant to message reception may also return &"discard"&. This
24939 has the effect of &"accept"&, but causes either the entire message or an
24940 individual recipient address to be discarded. In other words, it is a
24941 blackholing facility. Use it with care.
24942
24943 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
24944 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
24945 RCPT ACL is to discard just the one recipient address. If there are no
24946 recipients left when the message's data is received, the DATA ACL is not
24947 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
24948 remaining recipients. The &"discard"& return is not permitted for the
24949 &%acl_smtp_predata%& ACL.
24950
24951
24952 .cindex "&[local_scan()]& function" "when all recipients discarded"
24953 The &[local_scan()]& function is always run, even if there are no remaining
24954 recipients; it may create new recipients.
24955
24956
24957
24958 .section "Unset ACL options" "SECID197"
24959 .cindex "&ACL;" "unset options"
24960 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
24961 all the same. &*Note*&: These defaults apply only when the relevant ACL is
24962 not defined at all. For any defined ACL, the default action when control
24963 reaches the end of the ACL statements is &"deny"&.
24964
24965 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
24966 these two are ACLs that are used only for their side effects. They cannot be
24967 used to accept or reject anything.
24968
24969 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
24970 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
24971 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
24972 when the ACL is not defined is &"accept"&.
24973
24974 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
24975 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
24976 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
24977 messages over an SMTP connection. For an example, see the ACL in the default
24978 configuration file.
24979
24980
24981
24982
24983 .section "Data for message ACLs" "SECID198"
24984 .cindex "&ACL;" "data for message ACL"
24985 .vindex &$domain$&
24986 .vindex &$local_part$&
24987 .vindex &$sender_address$&
24988 .vindex &$sender_host_address$&
24989 .vindex &$smtp_command$&
24990 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
24991 that contain information about the host and the message's sender (for example,
24992 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
24993 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
24994 &$local_part$& are set from the argument address. The entire SMTP command
24995 is available in &$smtp_command$&.
24996
24997 When an ACL for the AUTH parameter of MAIL is running, the variables that
24998 contain information about the host are set, but &$sender_address$& is not yet
24999 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
25000 how it is used.
25001
25002 .vindex "&$message_size$&"
25003 The &$message_size$& variable is set to the value of the SIZE parameter on
25004 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
25005 that parameter is not given. The value is updated to the true message size by
25006 the time the final DATA ACL is run (after the message data has been
25007 received).
25008
25009 .vindex "&$rcpt_count$&"
25010 .vindex "&$recipients_count$&"
25011 The &$rcpt_count$& variable increases by one for each RCPT command received.
25012 The &$recipients_count$& variable increases by one each time a RCPT command is
25013 accepted, so while an ACL for RCPT is being processed, it contains the number
25014 of previously accepted recipients. At DATA time (for both the DATA ACLs),
25015 &$rcpt_count$& contains the total number of RCPT commands, and
25016 &$recipients_count$& contains the total number of accepted recipients.
25017
25018
25019
25020
25021
25022 .section "Data for non-message ACLs" "SECTdatfornon"
25023 .cindex "&ACL;" "data for non-message ACL"
25024 .vindex &$smtp_command_argument$&
25025 .vindex &$smtp_command$&
25026 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
25027 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
25028 and the entire SMTP command is available in &$smtp_command$&.
25029 These variables can be tested using a &%condition%& condition. For example,
25030 here is an ACL for use with AUTH, which insists that either the session is
25031 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
25032 does not permit authentication methods that use cleartext passwords on
25033 unencrypted connections.
25034 .code
25035 acl_check_auth:
25036   accept encrypted = *
25037   accept condition = ${if eq{${uc:$smtp_command_argument}}\
25038                      {CRAM-MD5}}
25039   deny   message   = TLS encryption or CRAM-MD5 required
25040 .endd
25041 (Another way of applying this restriction is to arrange for the authenticators
25042 that use cleartext passwords not to be advertised when the connection is not
25043 encrypted. You can use the generic &%server_advertise_condition%& authenticator
25044 option to do this.)
25045
25046
25047
25048 .section "Format of an ACL" "SECID199"
25049 .cindex "&ACL;" "format of"
25050 .cindex "&ACL;" "verbs, definition of"
25051 An individual ACL consists of a number of statements. Each statement starts
25052 with a verb, optionally followed by a number of conditions and &"modifiers"&.
25053 Modifiers can change the way the verb operates, define error and log messages,
25054 set variables, insert delays, and vary the processing of accepted messages.
25055
25056 If all the conditions are met, the verb is obeyed. The same condition may be
25057 used (with different arguments) more than once in the same statement. This
25058 provides a means of specifying an &"and"& conjunction between conditions. For
25059 example:
25060 .code
25061 deny  dnslists = list1.example
25062 dnslists = list2.example
25063 .endd
25064 If there are no conditions, the verb is always obeyed. Exim stops evaluating
25065 the conditions and modifiers when it reaches a condition that fails. What
25066 happens then depends on the verb (and in one case, on a special modifier). Not
25067 all the conditions make sense at every testing point. For example, you cannot
25068 test a sender address in the ACL that is run for a VRFY command.
25069
25070
25071 .section "ACL verbs" "SECID200"
25072 The ACL verbs are as follows:
25073
25074 .ilist
25075 .cindex "&%accept%& ACL verb"
25076 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
25077 of the conditions are not met, what happens depends on whether &%endpass%&
25078 appears among the conditions (for syntax see below). If the failing condition
25079 is before &%endpass%&, control is passed to the next ACL statement; if it is
25080 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
25081 check a RCPT command:
25082 .code
25083 accept domains = +local_domains
25084 endpass
25085 verify = recipient
25086 .endd
25087 If the recipient domain does not match the &%domains%& condition, control
25088 passes to the next statement. If it does match, the recipient is verified, and
25089 the command is accepted if verification succeeds. However, if verification
25090 fails, the ACL yields &"deny"&, because the failing condition is after
25091 &%endpass%&.
25092
25093 The &%endpass%& feature has turned out to be confusing to many people, so its
25094 use is not recommended nowadays. It is always possible to rewrite an ACL so
25095 that &%endpass%& is not needed, and it is no longer used in the default
25096 configuration.
25097
25098 .cindex "&%message%& ACL modifier" "with &%accept%&"
25099 If a &%message%& modifier appears on an &%accept%& statement, its action
25100 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
25101 (when an &%accept%& verb either accepts or passes control to the next
25102 statement), &%message%& can be used to vary the message that is sent when an
25103 SMTP command is accepted. For example, in a RCPT ACL you could have:
25104 .display
25105 &`accept  `&<&'some conditions'&>
25106 &`        message = OK, I will allow you through today`&
25107 .endd
25108 You can specify an SMTP response code, optionally followed by an &"extended
25109 response code"& at the start of the message, but the first digit must be the
25110 same as would be sent by default, which is 2 for an &%accept%& verb.
25111
25112 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
25113 an error message that is used when access is denied. This behaviour is retained
25114 for backward compatibility, but current &"best practice"& is to avoid the use
25115 of &%endpass%&.
25116
25117
25118 .next
25119 .cindex "&%defer%& ACL verb"
25120 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
25121 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
25122 &%defer%& is the same as &%deny%&, because there is no way of sending a
25123 temporary error. For a RCPT command, &%defer%& is much the same as using a
25124 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
25125 be used in any ACL, and even for a recipient it might be a simpler approach.
25126
25127
25128 .next
25129 .cindex "&%deny%& ACL verb"
25130 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
25131 the conditions are not met, control is passed to the next ACL statement. For
25132 example,
25133 .code
25134 deny dnslists = blackholes.mail-abuse.org
25135 .endd
25136 rejects commands from hosts that are on a DNS black list.
25137
25138
25139 .next
25140 .cindex "&%discard%& ACL verb"
25141 &%discard%&: This verb behaves like &%accept%&, except that it returns
25142 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
25143 that are concerned with receiving messages. When all the conditions are true,
25144 the sending entity receives a &"success"& response. However, &%discard%& causes
25145 recipients to be discarded. If it is used in an ACL for RCPT, just the one
25146 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
25147 message's recipients are discarded. Recipients that are discarded before DATA
25148 do not appear in the log line when the &%received_recipients%& log selector is set.
25149
25150 If the &%log_message%& modifier is set when &%discard%& operates,
25151 its contents are added to the line that is automatically written to the log.
25152 The &%message%& modifier operates exactly as it does for &%accept%&.
25153
25154
25155 .next
25156 .cindex "&%drop%& ACL verb"
25157 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
25158 forcibly closed after the 5&'xx'& error message has been sent. For example:
25159 .code
25160 drop   message   = I don't take more than 20 RCPTs
25161        condition = ${if > {$rcpt_count}{20}}
25162 .endd
25163 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
25164 The connection is always dropped after sending a 550 response.
25165
25166 .next
25167 .cindex "&%require%& ACL verb"
25168 &%require%&: If all the conditions are met, control is passed to the next ACL
25169 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
25170 example, when checking a RCPT command,
25171 .code
25172 require message = Sender did not verify
25173         verify  = sender
25174 .endd
25175 passes control to subsequent statements only if the message's sender can be
25176 verified. Otherwise, it rejects the command. Note the positioning of the
25177 &%message%& modifier, before the &%verify%& condition. The reason for this is
25178 discussed in section &<<SECTcondmodproc>>&.
25179
25180 .next
25181 .cindex "&%warn%& ACL verb"
25182 &%warn%&: If all the conditions are true, a line specified by the
25183 &%log_message%& modifier is written to Exim's main log. Control always passes
25184 to the next ACL statement. If any condition is false, the log line is not
25185 written. If an identical log line is requested several times in the same
25186 message, only one copy is actually written to the log. If you want to force
25187 duplicates to be written, use the &%logwrite%& modifier instead.
25188
25189 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
25190 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
25191 &%logwrite%&, and &%add_header%&) that appear before the first failing
25192 condition. There is more about adding header lines in section
25193 &<<SECTaddheadacl>>&.
25194
25195 If any condition on a &%warn%& statement cannot be completed (that is, there is
25196 some sort of defer), the log line specified by &%log_message%& is not written.
25197 This does not include the case of a forced failure from a lookup, which
25198 is considered to be a successful completion. After a defer, no further
25199 conditions or modifiers in the &%warn%& statement are processed. The incident
25200 is logged, and the ACL continues to be processed, from the next statement
25201 onwards.
25202
25203
25204 .vindex "&$acl_verify_message$&"
25205 When one of the &%warn%& conditions is an address verification that fails, the
25206 text of the verification failure message is in &$acl_verify_message$&. If you
25207 want this logged, you must set it up explicitly. For example:
25208 .code
25209 warn   !verify = sender
25210        log_message = sender verify failed: $acl_verify_message
25211 .endd
25212 .endlist
25213
25214 At the end of each ACL there is an implicit unconditional &%deny%&.
25215
25216 As you can see from the examples above, the conditions and modifiers are
25217 written one to a line, with the first one on the same line as the verb, and
25218 subsequent ones on following lines. If you have a very long condition, you can
25219 continue it onto several physical lines by the usual backslash continuation
25220 mechanism. It is conventional to align the conditions vertically.
25221
25222
25223
25224 .section "ACL variables" "SECTaclvariables"
25225 .cindex "&ACL;" "variables"
25226 There are some special variables that can be set during ACL processing. They
25227 can be used to pass information between different ACLs, different invocations
25228 of the same ACL in the same SMTP connection, and between ACLs and the routers,
25229 transports, and filters that are used to deliver a message. The names of these
25230 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
25231 an underscore, but the remainder of the name can be any sequence of
25232 alphanumeric characters and underscores that you choose. There is no limit on
25233 the number of ACL variables. The two sets act as follows:
25234 .ilist
25235 The values of those variables whose names begin with &$acl_c$& persist
25236 throughout an SMTP connection. They are never reset. Thus, a value that is set
25237 while receiving one message is still available when receiving the next message
25238 on the same SMTP connection.
25239 .next
25240 The values of those variables whose names begin with &$acl_m$& persist only
25241 while a message is being received. They are reset afterwards. They are also
25242 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
25243 .endlist
25244
25245 When a message is accepted, the current values of all the ACL variables are
25246 preserved with the message and are subsequently made available at delivery
25247 time. The ACL variables are set by a modifier called &%set%&. For example:
25248 .code
25249 accept hosts = whatever
25250        set acl_m4 = some value
25251 accept authenticated = *
25252        set acl_c_auth = yes
25253 .endd
25254 &*Note*&: A leading dollar sign is not used when naming a variable that is to
25255 be set. If you want to set a variable without taking any action, you can use a
25256 &%warn%& verb without any other modifiers or conditions.
25257
25258 .oindex &%strict_acl_vars%&
25259 What happens if a syntactically valid but undefined ACL variable is
25260 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
25261 false (the default), an empty string is substituted; if it is true, an
25262 error is generated.
25263
25264 Versions of Exim before 4.64 have a limited set of numbered variables, but
25265 their names are compatible, so there is no problem with upgrading.
25266
25267
25268 .section "Condition and modifier processing" "SECTcondmodproc"
25269 .cindex "&ACL;" "conditions; processing"
25270 .cindex "&ACL;" "modifiers; processing"
25271 An exclamation mark preceding a condition negates its result. For example:
25272 .code
25273 deny   domains = *.dom.example
25274       !verify  = recipient
25275 .endd
25276 causes the ACL to return &"deny"& if the recipient domain ends in
25277 &'dom.example'& and the recipient address cannot be verified. Sometimes
25278 negation can be used on the right-hand side of a condition. For example, these
25279 two statements are equivalent:
25280 .code
25281 deny  hosts = !192.168.3.4
25282 deny !hosts =  192.168.3.4
25283 .endd
25284 However, for many conditions (&%verify%& being a good example), only left-hand
25285 side negation of the whole condition is possible.
25286
25287 The arguments of conditions and modifiers are expanded. A forced failure
25288 of an expansion causes a condition to be ignored, that is, it behaves as if the
25289 condition is true. Consider these two statements:
25290 .code
25291 accept  senders = ${lookup{$host_name}lsearch\
25292                   {/some/file}{$value}fail}
25293 accept  senders = ${lookup{$host_name}lsearch\
25294                   {/some/file}{$value}{}}
25295 .endd
25296 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
25297 the returned list is searched, but if the lookup fails the behaviour is
25298 different in the two cases. The &%fail%& in the first statement causes the
25299 condition to be ignored, leaving no further conditions. The &%accept%& verb
25300 therefore succeeds. The second statement, however, generates an empty list when
25301 the lookup fails. No sender can match an empty list, so the condition fails,
25302 and therefore the &%accept%& also fails.
25303
25304 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
25305 specify actions that are taken as the conditions for a statement are checked;
25306 others specify text for messages that are used when access is denied or a
25307 warning is generated. The &%control%& modifier affects the way an incoming
25308 message is handled.
25309
25310 The positioning of the modifiers in an ACL statement important, because the
25311 processing of a verb ceases as soon as its outcome is known. Only those
25312 modifiers that have already been encountered will take effect. For example,
25313 consider this use of the &%message%& modifier:
25314 .code
25315 require message = Can't verify sender
25316         verify  = sender
25317         message = Can't verify recipient
25318         verify  = recipient
25319         message = This message cannot be used
25320 .endd
25321 If sender verification fails, Exim knows that the result of the statement is
25322 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
25323 so its text is used as the error message. If sender verification succeeds, but
25324 recipient verification fails, the second message is used. If recipient
25325 verification succeeds, the third message becomes &"current"&, but is never used
25326 because there are no more conditions to cause failure.
25327
25328 For the &%deny%& verb, on the other hand, it is always the last &%message%&
25329 modifier that is used, because all the conditions must be true for rejection to
25330 happen. Specifying more than one &%message%& modifier does not make sense, and
25331 the message can even be specified after all the conditions. For example:
25332 .code
25333 deny   hosts = ...
25334       !senders = *@my.domain.example
25335        message = Invalid sender from client host
25336 .endd
25337 The &"deny"& result does not happen until the end of the statement is reached,
25338 by which time Exim has set up the message.
25339
25340
25341
25342 .section "ACL modifiers" "SECTACLmodi"
25343 .cindex "&ACL;" "modifiers; list of"
25344 The ACL modifiers are as follows:
25345
25346 .vlist
25347 .vitem &*add_header*&&~=&~<&'text'&>
25348 This modifier specifies one or more header lines that are to be added to an
25349 incoming message, assuming, of course, that the message is ultimately
25350 accepted. For details, see section &<<SECTaddheadacl>>&.
25351
25352 .vitem &*continue*&&~=&~<&'text'&>
25353 .cindex "&%continue%& ACL modifier"
25354 .cindex "database" "updating in ACL"
25355 This modifier does nothing of itself, and processing of the ACL always
25356 continues with the next condition or modifier. The value of &%continue%& is in
25357 the side effects of expanding its argument. Typically this could be used to
25358 update a database. It is really just a syntactic tidiness, to avoid having to
25359 write rather ugly lines like this:
25360 .display
25361 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
25362 .endd
25363 Instead, all you need is
25364 .display
25365 &`continue = `&<&'some expansion'&>
25366 .endd
25367
25368 .vitem &*control*&&~=&~<&'text'&>
25369 .cindex "&%control%& ACL modifier"
25370 This modifier affects the subsequent processing of the SMTP connection or of an
25371 incoming message that is accepted. The effect of the first type of control
25372 lasts for the duration of the connection, whereas the effect of the second type
25373 lasts only until the current message has been received. The message-specific
25374 controls always apply to the whole message, not to individual recipients,
25375 even if the &%control%& modifier appears in a RCPT ACL.
25376
25377 As there are now quite a few controls that can be applied, they are described
25378 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
25379 in several different ways. For example:
25380
25381 . ==== As this is a nested list, any displays it contains must be indented
25382 . ==== as otherwise they are too far to the left. That comment applies only
25383 . ==== when xmlto and fop are used; formatting with sdop gets it right either
25384 . ==== way.
25385
25386 .ilist
25387 It can be at the end of an &%accept%& statement:
25388 .code
25389     accept  ...some conditions
25390             control = queue_only
25391 .endd
25392 In this case, the control is applied when this statement yields &"accept"&, in
25393 other words, when the conditions are all true.
25394
25395 .next
25396 It can be in the middle of an &%accept%& statement:
25397 .code
25398     accept  ...some conditions...
25399             control = queue_only
25400             ...some more conditions...
25401 .endd
25402 If the first set of conditions are true, the control is applied, even if the
25403 statement does not accept because one of the second set of conditions is false.
25404 In this case, some subsequent statement must yield &"accept"& for the control
25405 to be relevant.
25406
25407 .next
25408 It can be used with &%warn%& to apply the control, leaving the
25409 decision about accepting or denying to a subsequent verb. For
25410 example:
25411 .code
25412     warn    ...some conditions...
25413             control = freeze
25414     accept  ...
25415 .endd
25416 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
25417 &%logwrite%&, so it does not add anything to the message and does not write a
25418 log entry.
25419
25420 .next
25421 If you want to apply a control unconditionally, you can use it with a
25422 &%require%& verb. For example:
25423 .code
25424     require  control = no_multiline_responses
25425 .endd
25426 .endlist
25427
25428 .vitem &*delay*&&~=&~<&'time'&>
25429 .cindex "&%delay%& ACL modifier"
25430 .oindex "&%-bh%&"
25431 This modifier may appear in any ACL. It causes Exim to wait for the time
25432 interval before proceeding. However, when testing Exim using the &%-bh%&
25433 option, the delay is not actually imposed (an appropriate message is output
25434 instead). The time is given in the usual Exim notation, and the delay happens
25435 as soon as the modifier is processed. In an SMTP session, pending output is
25436 flushed before the delay is imposed.
25437
25438 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
25439 example:
25440 .code
25441 deny    ...some conditions...
25442         delay = 30s
25443 .endd
25444 The delay happens if all the conditions are true, before the statement returns
25445 &"deny"&. Compare this with:
25446 .code
25447 deny    delay = 30s
25448         ...some conditions...
25449 .endd
25450 which waits for 30s before processing the conditions. The &%delay%& modifier
25451 can also be used with &%warn%& and together with &%control%&:
25452 .code
25453 warn    ...some conditions...
25454         delay = 2m
25455         control = freeze
25456 accept  ...
25457 .endd
25458
25459 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
25460 responses to several commands are no longer buffered and sent in one packet (as
25461 they would normally be) because all output is flushed before imposing the
25462 delay. This optimization is disabled so that a number of small delays do not
25463 appear to the client as one large aggregated delay that might provoke an
25464 unwanted timeout. You can, however, disable output flushing for &%delay%& by
25465 using a &%control%& modifier to set &%no_delay_flush%&.
25466
25467
25468 .vitem &*endpass*&
25469 .cindex "&%endpass%& ACL modifier"
25470 This modifier, which has no argument, is recognized only in &%accept%& and
25471 &%discard%& statements. It marks the boundary between the conditions whose
25472 failure causes control to pass to the next statement, and the conditions whose
25473 failure causes the ACL to return &"deny"&. This concept has proved to be
25474 confusing to some people, so the use of &%endpass%& is no longer recommended as
25475 &"best practice"&. See the description of &%accept%& above for more details.
25476
25477
25478 .vitem &*log_message*&&~=&~<&'text'&>
25479 .cindex "&%log_message%& ACL modifier"
25480 This modifier sets up a message that is used as part of the log message if the
25481 ACL denies access or a &%warn%& statement's conditions are true. For example:
25482 .code
25483 require log_message = wrong cipher suite $tls_cipher
25484         encrypted   = DES-CBC3-SHA
25485 .endd
25486 &%log_message%& is also used when recipients are discarded by &%discard%&. For
25487 example:
25488 .display
25489 &`discard `&<&'some conditions'&>
25490 &`        log_message = Discarded $local_part@$domain because...`&
25491 .endd
25492 When access is denied, &%log_message%& adds to any underlying error message
25493 that may exist because of a condition failure. For example, while verifying a
25494 recipient address, a &':fail:'& redirection might have already set up a
25495 message.
25496
25497 The message may be defined before the conditions to which it applies, because
25498 the string expansion does not happen until Exim decides that access is to be
25499 denied. This means that any variables that are set by the condition are
25500 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
25501 variables are set after a DNS black list lookup succeeds. If the expansion of
25502 &%log_message%& fails, or if the result is an empty string, the modifier is
25503 ignored.
25504
25505 .vindex "&$acl_verify_message$&"
25506 If you want to use a &%warn%& statement to log the result of an address
25507 verification, you can use &$acl_verify_message$& to include the verification
25508 error message.
25509
25510 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
25511 the start of the logged message. If the same warning log message is requested
25512 more than once while receiving  a single email message, only one copy is
25513 actually logged. If you want to log multiple copies, use &%logwrite%& instead
25514 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
25515 is logged for a successful &%warn%& statement.
25516
25517 If &%log_message%& is not present and there is no underlying error message (for
25518 example, from the failure of address verification), but &%message%& is present,
25519 the &%message%& text is used for logging rejections. However, if any text for
25520 logging contains newlines, only the first line is logged. In the absence of
25521 both &%log_message%& and &%message%&, a default built-in message is used for
25522 logging rejections.
25523
25524
25525 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
25526 .cindex "&%log_reject_target%& ACL modifier"
25527 .cindex "logging in ACL" "specifying which log"
25528 This modifier makes it possible to specify which logs are used for messages
25529 about ACL rejections. Its argument is a colon-separated list of words that can
25530 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
25531 may be empty, in which case a rejection is not logged at all. For example, this
25532 ACL fragment writes no logging information when access is denied:
25533 .display
25534 &`deny `&<&'some conditions'&>
25535 &`     log_reject_target =`&
25536 .endd
25537 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
25538 permanent and temporary rejections. Its effect lasts for the rest of the
25539 current ACL.
25540
25541
25542 .vitem &*logwrite*&&~=&~<&'text'&>
25543 .cindex "&%logwrite%& ACL modifier"
25544 .cindex "logging in ACL" "immediate"
25545 This modifier writes a message to a log file as soon as it is encountered when
25546 processing an ACL. (Compare &%log_message%&, which, except in the case of
25547 &%warn%& and &%discard%&, is used only if the ACL statement denies
25548 access.) The &%logwrite%& modifier can be used to log special incidents in
25549 ACLs. For example:
25550 .display
25551 &`accept `&<&'some special conditions'&>
25552 &`       control  = freeze`&
25553 &`       logwrite = froze message because ...`&
25554 .endd
25555 By default, the message is written to the main log. However, it may begin
25556 with a colon, followed by a comma-separated list of log names, and then
25557 another colon, to specify exactly which logs are to be written. For
25558 example:
25559 .code
25560 logwrite = :main,reject: text for main and reject logs
25561 logwrite = :panic: text for panic log only
25562 .endd
25563
25564
25565 .vitem &*message*&&~=&~<&'text'&>
25566 .cindex "&%message%& ACL modifier"
25567 This modifier sets up a text string that is expanded and used as a response
25568 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
25569 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
25570 there is some complication if &%endpass%& is involved; see the description of
25571 &%accept%& for details.)
25572
25573 The expansion of the message happens at the time Exim decides that the ACL is
25574 to end, not at the time it processes &%message%&. If the expansion fails, or
25575 generates an empty string, the modifier is ignored. Here is an example where
25576 &%message%& must be specified first, because the ACL ends with a rejection if
25577 the &%hosts%& condition fails:
25578 .code
25579 require  message = Host not recognized
25580          hosts = 10.0.0.0/8
25581 .endd
25582 (Once a condition has failed, no further conditions or modifiers are
25583 processed.)
25584
25585 .cindex "SMTP" "error codes"
25586 .oindex "&%smtp_banner%&
25587 For ACLs that are triggered by SMTP commands, the message is returned as part
25588 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
25589 is meaningful only for SMTP, as no message is returned when a non-SMTP message
25590 is accepted. In the case of the connect ACL, accepting with a message modifier
25591 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
25592 accept message may not contain more than one line (otherwise it will be
25593 truncated at the first newline and a panic logged), and it cannot affect the
25594 EHLO options.
25595
25596 When SMTP is involved, the message may begin with an overriding response code,
25597 consisting of three digits optionally followed by an &"extended response code"&
25598 of the form &'n.n.n'&, each code being followed by a space. For example:
25599 .code
25600 deny  message = 599 1.2.3 Host not welcome
25601       hosts = 192.168.34.0/24
25602 .endd
25603 The first digit of the supplied response code must be the same as would be sent
25604 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
25605 access, but for the predata ACL, note that the default success code is 354, not
25606 2&'xx'&.
25607
25608 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
25609 the message modifier cannot override the 221 response code.
25610
25611 The text in a &%message%& modifier is literal; any quotes are taken as
25612 literals, but because the string is expanded, backslash escapes are processed
25613 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
25614 response.
25615
25616 .vindex "&$acl_verify_message$&"
25617 If &%message%& is used on a statement that verifies an address, the message
25618 specified overrides any message that is generated by the verification process.
25619 However, the original message is available in the variable
25620 &$acl_verify_message$&, so you can incorporate it into your message if you
25621 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
25622 routers to be passed back as part of the SMTP response, you should either not
25623 use a &%message%& modifier, or make use of &$acl_verify_message$&.
25624
25625 For compatibility with previous releases of Exim, a &%message%& modifier that
25626 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
25627 modifier, but this usage is now deprecated. However, &%message%& acts only when
25628 all the conditions are true, wherever it appears in an ACL command, whereas
25629 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
25630 &%warn%& in an ACL that is not concerned with receiving a message, it has no
25631 effect.
25632
25633
25634 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
25635 .cindex "&%set%& ACL modifier"
25636 This modifier puts a value into one of the ACL variables (see section
25637 &<<SECTaclvariables>>&).
25638 .endlist
25639
25640
25641
25642
25643
25644 .section "Use of the control modifier" "SECTcontrols"
25645 .cindex "&%control%& ACL modifier"
25646 The &%control%& modifier supports the following settings:
25647
25648 .vlist
25649 .vitem &*control&~=&~allow_auth_unadvertised*&
25650 This modifier allows a client host to use the SMTP AUTH command even when it
25651 has not been advertised in response to EHLO. Furthermore, because there are
25652 apparently some really broken clients that do this, Exim will accept AUTH after
25653 HELO (rather than EHLO) when this control is set. It should be used only if you
25654 really need it, and you should limit its use to those broken clients that do
25655 not work without it. For example:
25656 .code
25657 warn hosts   = 192.168.34.25
25658      control = allow_auth_unadvertised
25659 .endd
25660 Normally, when an Exim server receives an AUTH command, it checks the name of
25661 the authentication mechanism that is given in the command to ensure that it
25662 matches an advertised mechanism. When this control is set, the check that a
25663 mechanism has been advertised is bypassed. Any configured mechanism can be used
25664 by the client. This control is permitted only in the connection and HELO ACLs.
25665
25666
25667 .vitem &*control&~=&~caseful_local_part*& &&&
25668        &*control&~=&~caselower_local_part*&
25669 .cindex "&ACL;" "case of local part in"
25670 .cindex "case of local parts"
25671 .vindex "&$local_part$&"
25672 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
25673 (that is, during RCPT processing). By default, the contents of &$local_part$&
25674 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
25675 any uppercase letters in the original local part are restored in &$local_part$&
25676 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
25677 is encountered.
25678
25679 These controls affect only the current recipient. Moreover, they apply only to
25680 local part handling that takes place directly in the ACL (for example, as a key
25681 in lookups). If a test to verify the recipient is obeyed, the case-related
25682 handling of the local part during the verification is controlled by the router
25683 configuration (see the &%caseful_local_part%& generic router option).
25684
25685 This facility could be used, for example, to add a spam score to local parts
25686 containing upper case letters. For example, using &$acl_m4$& to accumulate the
25687 spam score:
25688 .code
25689 warn  control = caseful_local_part
25690       set acl_m4 = ${eval:\
25691                      $acl_m4 + \
25692                      ${if match{$local_part}{[A-Z]}{1}{0}}\
25693                     }
25694       control = caselower_local_part
25695 .endd
25696 Notice that we put back the lower cased version afterwards, assuming that
25697 is what is wanted for subsequent tests.
25698
25699 .vitem &*control&~=&~enforce_sync*& &&&
25700        &*control&~=&~no_enforce_sync*&
25701 .cindex "SMTP" "synchronization checking"
25702 .cindex "synchronization checking in SMTP"
25703 These controls make it possible to be selective about when SMTP synchronization
25704 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
25705 state of the switch (it is true by default). See the description of this option
25706 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
25707
25708 The effect of these two controls lasts for the remainder of the SMTP
25709 connection. They can appear in any ACL except the one for the non-SMTP
25710 messages. The most straightforward place to put them is in the ACL defined by
25711 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
25712 before the first synchronization check. The expected use is to turn off the
25713 synchronization checks for badly-behaved hosts that you nevertheless need to
25714 work with.
25715
25716
25717 .vitem &*control&~=&~fakedefer/*&<&'message'&>
25718 .cindex "fake defer"
25719 .cindex "defer, fake"
25720 This control works in exactly the same way as &%fakereject%& (described below)
25721 except that it causes an SMTP 450 response after the message data instead of a
25722 550 response. You must take care when using &%fakedefer%& because it causes the
25723 messages to be duplicated when the sender retries. Therefore, you should not
25724 use &%fakedefer%& if the message is to be delivered normally.
25725
25726 .vitem &*control&~=&~fakereject/*&<&'message'&>
25727 .cindex "fake rejection"
25728 .cindex "rejection, fake"
25729 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
25730 words, only when an SMTP message is being received. If Exim accepts the
25731 message, instead the final 250 response, a 550 rejection message is sent.
25732 However, Exim proceeds to deliver the message as normal. The control applies
25733 only to the current message, not to any subsequent ones that may be received in
25734 the same SMTP connection.
25735
25736 The text for the 550 response is taken from the &%control%& modifier. If no
25737 message is supplied, the following is used:
25738 .code
25739 550-Your message has been rejected but is being
25740 550-kept for evaluation.
25741 550-If it was a legitimate message, it may still be
25742 550 delivered to the target recipient(s).
25743 .endd
25744 This facility should be used with extreme caution.
25745
25746 .vitem &*control&~=&~freeze*&
25747 .cindex "frozen messages" "forcing in ACL"
25748 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
25749 other words, only when a message is being received. If the message is accepted,
25750 it is placed on Exim's queue and frozen. The control applies only to the
25751 current message, not to any subsequent ones that may be received in the same
25752 SMTP connection.
25753
25754 This modifier can optionally be followed by &`/no_tell`&. If the global option
25755 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
25756 is told about the freezing), provided all the &*control=freeze*& modifiers that
25757 are obeyed for the current message have the &`/no_tell`& option.
25758
25759 .vitem &*control&~=&~no_delay_flush*&
25760 .cindex "SMTP" "output flushing, disabling for delay"
25761 Exim normally flushes SMTP output before implementing a delay in an ACL, to
25762 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
25763 use. This control, as long as it is encountered before the &%delay%& modifier,
25764 disables such output flushing.
25765
25766 .vitem &*control&~=&~no_callout_flush*&
25767 .cindex "SMTP" "output flushing, disabling for callout"
25768 Exim normally flushes SMTP output before performing a callout in an ACL, to
25769 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
25770 use. This control, as long as it is encountered before the &%verify%& condition
25771 that causes the callout, disables such output flushing.
25772
25773 .vitem &*control&~=&~no_mbox_unspool*&
25774 This control is available when Exim is compiled with the content scanning
25775 extension. Content scanning may require a copy of the current message, or parts
25776 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
25777 or spam scanner. Normally, such copies are deleted when they are no longer
25778 needed. If this control is set, the copies are not deleted. The control applies
25779 only to the current message, not to any subsequent ones that may be received in
25780 the same SMTP connection. It is provided for debugging purposes and is unlikely
25781 to be useful in production.
25782
25783 .vitem &*control&~=&~no_multiline_responses*&
25784 .cindex "multiline responses, suppressing"
25785 This control is permitted for any ACL except the one for non-SMTP messages.
25786 It seems that there are broken clients in use that cannot handle multiline
25787 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
25788
25789 If this control is set, multiline SMTP responses from ACL rejections are
25790 suppressed. One way of doing this would have been to put out these responses as
25791 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
25792 (&"use multiline responses for more"& it says &-- ha!), and some of the
25793 responses might get close to that. So this facility, which is after all only a
25794 sop to broken clients, is implemented by doing two very easy things:
25795
25796 .ilist
25797 Extra information that is normally output as part of a rejection caused by
25798 sender verification failure is omitted. Only the final line (typically &"sender
25799 verification failed"&) is sent.
25800 .next
25801 If a &%message%& modifier supplies a multiline response, only the first
25802 line is output.
25803 .endlist
25804
25805 The setting of the switch can, of course, be made conditional on the
25806 calling host. Its effect lasts until the end of the SMTP connection.
25807
25808 .vitem &*control&~=&~no_pipelining*&
25809 .cindex "PIPELINING" "suppressing advertising"
25810 This control turns off the advertising of the PIPELINING extension to SMTP in
25811 the current session. To be useful, it must be obeyed before Exim sends its
25812 response to an EHLO command. Therefore, it should normally appear in an ACL
25813 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
25814 &%pipelining_advertise_hosts%&.
25815
25816 .vitem &*control&~=&~queue_only*&
25817 .oindex "&%queue_only%&"
25818 .cindex "queueing incoming messages"
25819 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
25820 other words, only when a message is being received. If the message is accepted,
25821 it is placed on Exim's queue and left there for delivery by a subsequent queue
25822 runner. No immediate delivery process is started. In other words, it has the
25823 effect as the &%queue_only%& global option. However, the control applies only
25824 to the current message, not to any subsequent ones that may be received in the
25825 same SMTP connection.
25826
25827 .vitem &*control&~=&~submission/*&<&'options'&>
25828 .cindex "message" "submission"
25829 .cindex "submission mode"
25830 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
25831 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
25832 the current message is a submission from a local MUA. In this case, Exim
25833 operates in &"submission mode"&, and applies certain fixups to the message if
25834 necessary. For example, it adds a &'Date:'& header line if one is not present.
25835 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
25836 late (the message has already been created).
25837
25838 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
25839 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
25840 submission mode; the available options for this control are described there.
25841 The control applies only to the current message, not to any subsequent ones
25842 that may be received in the same SMTP connection.
25843
25844 .vitem &*control&~=&~suppress_local_fixups*&
25845 .cindex "submission fixups, suppressing"
25846 This control applies to locally submitted (non TCP/IP) messages, and is the
25847 complement of &`control = submission`&. It disables the fixups that are
25848 normally applied to locally-submitted messages. Specifically:
25849
25850 .ilist
25851 Any &'Sender:'& header line is left alone (in this respect, it is a
25852 dynamic version of &%local_sender_retain%&).
25853 .next
25854 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
25855 .next
25856 There is no check that &'From:'& corresponds to the actual sender.
25857 .endlist ilist
25858
25859 This control may be useful when a remotely-originated message is accepted,
25860 passed to some scanning program, and then re-submitted for delivery. It can be
25861 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
25862 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
25863 data is read.
25864
25865 &*Note:*& This control applies only to the current message, not to any others
25866 that are being submitted at the same time using &%-bs%& or &%-bS%&.
25867 .endlist vlist
25868
25869
25870 .section "Summary of message fixup control" "SECTsummesfix"
25871 All four possibilities for message fixups can be specified:
25872
25873 .ilist
25874 Locally submitted, fixups applied: the default.
25875 .next
25876 Locally submitted, no fixups applied: use
25877 &`control = suppress_local_fixups`&.
25878 .next
25879 Remotely submitted, no fixups applied: the default.
25880 .next
25881 Remotely submitted, fixups applied: use &`control = submission`&.
25882 .endlist
25883
25884
25885
25886 .section "Adding header lines in ACLs" "SECTaddheadacl"
25887 .cindex "header lines" "adding in an ACL"
25888 .cindex "header lines" "position of added lines"
25889 .cindex "&%message%& ACL modifier"
25890 The &%add_header%& modifier can be used to add one or more extra header lines
25891 to an incoming message, as in this example:
25892 .code
25893 warn dnslists = sbl.spamhaus.org : \
25894                 dialup.mail-abuse.org
25895      add_header = X-blacklisted-at: $dnslist_domain
25896 .endd
25897 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
25898 MIME, and non-SMTP ACLs (in other words, those that are concerned with
25899 receiving a message). The message must ultimately be accepted for
25900 &%add_header%& to have any significant effect. You can use &%add_header%& with
25901 any ACL verb, including &%deny%& (though this is potentially useful only in a
25902 RCPT ACL).
25903
25904 If the data for the &%add_header%& modifier contains one or more newlines that
25905 are not followed by a space or a tab, it is assumed to contain multiple header
25906 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
25907 front of any line that is not a valid header line.
25908
25909 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
25910 They are added to the message before processing the DATA and MIME ACLs.
25911 However, if an identical header line is requested more than once, only one copy
25912 is actually added to the message. Further header lines may be accumulated
25913 during the DATA and MIME ACLs, after which they are added to the message, again
25914 with duplicates suppressed. Thus, it is possible to add two identical header
25915 lines to an SMTP message, but only if one is added before DATA and one after.
25916 In the case of non-SMTP messages, new headers are accumulated during the
25917 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
25918 message is rejected after DATA or by the non-SMTP ACL, all added header lines
25919 are included in the entry that is written to the reject log.
25920
25921 .cindex "header lines" "added; visibility of"
25922 Header lines are not visible in string expansions until they are added to the
25923 message. It follows that header lines defined in the MAIL, RCPT, and predata
25924 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
25925 header lines that are added by the DATA or MIME ACLs are not visible in those
25926 ACLs. Because of this restriction, you cannot use header lines as a way of
25927 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
25928 this, you can use ACL variables, as described in section
25929 &<<SECTaclvariables>>&.
25930
25931 The &%add_header%& modifier acts immediately it is encountered during the
25932 processing of an ACL. Notice the difference between these two cases:
25933 .display
25934 &`accept add_header = ADDED: some text`&
25935 &`       `&<&'some condition'&>
25936
25937 &`accept `&<&'some condition'&>
25938 &`       add_header = ADDED: some text`&
25939 .endd
25940 In the first case, the header line is always added, whether or not the
25941 condition is true. In the second case, the header line is added only if the
25942 condition is true. Multiple occurrences of &%add_header%& may occur in the same
25943 ACL statement. All those that are encountered before a condition fails are
25944 honoured.
25945
25946 .cindex "&%warn%& ACL verb"
25947 For compatibility with previous versions of Exim, a &%message%& modifier for a
25948 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
25949 effect only if all the conditions are true, even if it appears before some of
25950 them. Furthermore, only the last occurrence of &%message%& is honoured. This
25951 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
25952 are present on a &%warn%& verb, both are processed according to their
25953 specifications.
25954
25955 By default, new header lines are added to a message at the end of the existing
25956 header lines. However, you can specify that any particular header line should
25957 be added right at the start (before all the &'Received:'& lines), immediately
25958 after the first block of &'Received:'& lines, or immediately before any line
25959 that is not a &'Received:'& or &'Resent-something:'& header.
25960
25961 This is done by specifying &":at_start:"&, &":after_received:"&, or
25962 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
25963 header line, respectively. (Header text cannot start with a colon, as there has
25964 to be a header name first.) For example:
25965 .code
25966 warn add_header = \
25967        :after_received:X-My-Header: something or other...
25968 .endd
25969 If more than one header line is supplied in a single &%add_header%& modifier,
25970 each one is treated independently and can therefore be placed differently. If
25971 you add more than one line at the start, or after the Received: block, they end
25972 up in reverse order.
25973
25974 &*Warning*&: This facility currently applies only to header lines that are
25975 added in an ACL. It does NOT work for header lines that are added in a
25976 system filter or in a router or transport.
25977
25978
25979
25980
25981 .section "ACL conditions" "SECTaclconditions"
25982 .cindex "&ACL;" "conditions; list of"
25983 Some of conditions listed in this section are available only when Exim is
25984 compiled with the content-scanning extension. They are included here briefly
25985 for completeness. More detailed descriptions can be found in the discussion on
25986 content scanning in chapter &<<CHAPexiscan>>&.
25987
25988 Not all conditions are relevant in all circumstances. For example, testing
25989 senders and recipients does not make sense in an ACL that is being run as the
25990 result of the arrival of an ETRN command, and checks on message headers can be
25991 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
25992 can use the same condition (with different parameters) more than once in the
25993 same ACL statement. This provides a way of specifying an &"and"& conjunction.
25994 The conditions are as follows:
25995
25996
25997 .vlist
25998 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
25999 .cindex "&ACL;" "nested"
26000 .cindex "&ACL;" "indirect"
26001 .cindex "&%acl%& ACL condition"
26002 The possible values of the argument are the same as for the
26003 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
26004 &"accept"& the condition is true; if it returns &"deny"& the condition is
26005 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
26006 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
26007 condition false. This means that further processing of the &%warn%& verb
26008 ceases, but processing of the ACL continues.
26009
26010 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
26011 the connection is dropped. If it returns &"discard"&, the verb must be
26012 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
26013 conditions are tested.
26014
26015 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
26016 loops. This condition allows you to use different ACLs in different
26017 circumstances. For example, different ACLs can be used to handle RCPT commands
26018 for different local users or different local domains.
26019
26020 .vitem &*authenticated&~=&~*&<&'string&~list'&>
26021 .cindex "&%authenticated%& ACL condition"
26022 .cindex "authentication" "ACL checking"
26023 .cindex "&ACL;" "testing for authentication"
26024 If the SMTP connection is not authenticated, the condition is false. Otherwise,
26025 the name of the authenticator is tested against the list. To test for
26026 authentication by any authenticator, you can set
26027 .code
26028 authenticated = *
26029 .endd
26030
26031 .vitem &*condition&~=&~*&<&'string'&>
26032 .cindex "&%condition%& ACL condition"
26033 .cindex "customizing" "ACL condition"
26034 .cindex "&ACL;" "customized test"
26035 .cindex "&ACL;" "testing, customized"
26036 This feature allows you to make up custom conditions. If the result of
26037 expanding the string is an empty string, the number zero, or one of the strings
26038 &"no"& or &"false"&, the condition is false. If the result is any non-zero
26039 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
26040 any other value, some error is assumed to have occurred, and the ACL returns
26041 &"defer"&. However, if the expansion is forced to fail, the condition is
26042 ignored. The effect is to treat it as true, whether it is positive or
26043 negative.
26044
26045 .vitem &*decode&~=&~*&<&'location'&>
26046 .cindex "&%decode%& ACL condition"
26047 This condition is available only when Exim is compiled with the
26048 content-scanning extension, and it is allowed only in the ACL defined by
26049 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
26050 If all goes well, the condition is true. It is false only if there are
26051 problems such as a syntax error or a memory shortage. For more details, see
26052 chapter &<<CHAPexiscan>>&.
26053
26054 .vitem &*demime&~=&~*&<&'extension&~list'&>
26055 .cindex "&%demime%& ACL condition"
26056 This condition is available only when Exim is compiled with the
26057 content-scanning extension. Its use is described in section
26058 &<<SECTdemimecond>>&.
26059
26060 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
26061 .cindex "&%dnslists%& ACL condition"
26062 .cindex "DNS list" "in ACL"
26063 .cindex "black list (DNS)"
26064 .cindex "&ACL;" "testing a DNS list"
26065 This condition checks for entries in DNS black lists. These are also known as
26066 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
26067 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
26068 different variants of this condition to describe briefly here. See sections
26069 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
26070
26071 .vitem &*domains&~=&~*&<&'domain&~list'&>
26072 .cindex "&%domains%& ACL condition"
26073 .cindex "domain" "ACL checking"
26074 .cindex "&ACL;" "testing a recipient domain"
26075 .vindex "&$domain_data$&"
26076 This condition is relevant only after a RCPT command. It checks that the domain
26077 of the recipient address is in the domain list. If percent-hack processing is
26078 enabled, it is done before this test is done. If the check succeeds with a
26079 lookup, the result of the lookup is placed in &$domain_data$& until the next
26080 &%domains%& test.
26081
26082 &*Note carefully*& (because many people seem to fall foul of this): you cannot
26083 use &%domains%& in a DATA ACL.
26084
26085
26086 .vitem &*encrypted&~=&~*&<&'string&~list'&>
26087 .cindex "&%encrypted%& ACL condition"
26088 .cindex "encryption" "checking in an ACL"
26089 .cindex "&ACL;" "testing for encryption"
26090 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
26091 name of the cipher suite in use is tested against the list. To test for
26092 encryption without testing for any specific cipher suite(s), set
26093 .code
26094 encrypted = *
26095 .endd
26096
26097
26098 .vitem &*hosts&~=&~*&<&'&~host&~list'&>
26099 .cindex "&%hosts%& ACL condition"
26100 .cindex "host" "ACL checking"
26101 .cindex "&ACL;" "testing the client host"
26102 This condition tests that the calling host matches the host list. If you have
26103 name lookups or wildcarded host names and IP addresses in the same host list,
26104 you should normally put the IP addresses first. For example, you could have:
26105 .code
26106 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
26107 .endd
26108 The lookup in this example uses the host name for its key. This is implied by
26109 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
26110 and it wouldn't matter which way round you had these two items.)
26111
26112 The reason for the problem with host names lies in the left-to-right way that
26113 Exim processes lists. It can test IP addresses without doing any DNS lookups,
26114 but when it reaches an item that requires a host name, it fails if it cannot
26115 find a host name to compare with the pattern. If the above list is given in the
26116 opposite order, the &%accept%& statement fails for a host whose name cannot be
26117 found, even if its IP address is 10.9.8.7.
26118
26119 If you really do want to do the name check first, and still recognize the IP
26120 address even if the name lookup fails, you can rewrite the ACL like this:
26121 .code
26122 accept hosts = dbm;/etc/friendly/hosts
26123 accept hosts = 10.9.8.7
26124 .endd
26125 The default action on failing to find the host name is to assume that the host
26126 is not in the list, so the first &%accept%& statement fails. The second
26127 statement can then check the IP address.
26128
26129 .vindex "&$host_data$&"
26130 If a &%hosts%& condition is satisfied by means of a lookup, the result
26131 of the lookup is made available in the &$host_data$& variable. This
26132 allows you, for example, to set up a statement like this:
26133 .code
26134 deny  hosts = net-lsearch;/some/file
26135 message = $host_data
26136 .endd
26137 which gives a custom error message for each denied host.
26138
26139 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
26140 .cindex "&%local_parts%& ACL condition"
26141 .cindex "local part" "ACL checking"
26142 .cindex "&ACL;" "testing a local part"
26143 .vindex "&$local_part_data$&"
26144 This condition is relevant only after a RCPT command. It checks that the local
26145 part of the recipient address is in the list. If percent-hack processing is
26146 enabled, it is done before this test. If the check succeeds with a lookup, the
26147 result of the lookup is placed in &$local_part_data$&, which remains set until
26148 the next &%local_parts%& test.
26149
26150 .vitem &*malware&~=&~*&<&'option'&>
26151 .cindex "&%malware%& ACL condition"
26152 .cindex "&ACL;" "virus scanning"
26153 .cindex "&ACL;" "scanning for viruses"
26154 This condition is available only when Exim is compiled with the
26155 content-scanning extension. It causes the incoming message to be scanned for
26156 viruses. For details, see chapter &<<CHAPexiscan>>&.
26157
26158 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
26159 .cindex "&%mime_regex%& ACL condition"
26160 .cindex "&ACL;" "testing by regex matching"
26161 This condition is available only when Exim is compiled with the
26162 content-scanning extension, and it is allowed only in the ACL defined by
26163 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
26164 with any of the regular expressions. For details, see chapter
26165 &<<CHAPexiscan>>&.
26166
26167 .vitem &*ratelimit&~=&~*&<&'parameters'&>
26168 .cindex "rate limiting"
26169 This condition can be used to limit the rate at which a user or host submits
26170 messages. Details are given in section &<<SECTratelimiting>>&.
26171
26172 .vitem &*recipients&~=&~*&<&'address&~list'&>
26173 .cindex "&%recipients%& ACL condition"
26174 .cindex "recipient" "ACL checking"
26175 .cindex "&ACL;" "testing a recipient"
26176 This condition is relevant only after a RCPT command. It checks the entire
26177 recipient address against a list of recipients.
26178
26179 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
26180 .cindex "&%regex%& ACL condition"
26181 .cindex "&ACL;" "testing by regex matching"
26182 This condition is available only when Exim is compiled with the
26183 content-scanning extension, and is available only in the DATA, MIME, and
26184 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
26185 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
26186
26187 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
26188 .cindex "&%sender_domains%& ACL condition"
26189 .cindex "sender" "ACL checking"
26190 .cindex "&ACL;" "testing a sender domain"
26191 .vindex "&$domain$&"
26192 .vindex "&$sender_address_domain$&"
26193 This condition tests the domain of the sender of the message against the given
26194 domain list. &*Note*&: The domain of the sender address is in
26195 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
26196 of this condition. This is an exception to the general rule for testing domain
26197 lists. It is done this way so that, if this condition is used in an ACL for a
26198 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
26199 influence the sender checking.
26200
26201 &*Warning*&: It is a bad idea to use this condition on its own as a control on
26202 relaying, because sender addresses are easily, and commonly, forged.
26203
26204 .vitem &*senders&~=&~*&<&'address&~list'&>
26205 .cindex "&%senders%& ACL condition"
26206 .cindex "sender" "ACL checking"
26207 .cindex "&ACL;" "testing a sender"
26208 This condition tests the sender of the message against the given list. To test
26209 for a bounce message, which has an empty sender, set
26210 .code
26211 senders = :
26212 .endd
26213 &*Warning*&: It is a bad idea to use this condition on its own as a control on
26214 relaying, because sender addresses are easily, and commonly, forged.
26215
26216 .vitem &*spam&~=&~*&<&'username'&>
26217 .cindex "&%spam%& ACL condition"
26218 .cindex "&ACL;" "scanning for spam"
26219 This condition is available only when Exim is compiled with the
26220 content-scanning extension. It causes the incoming message to be scanned by
26221 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
26222
26223 .vitem &*verify&~=&~certificate*&
26224 .cindex "&%verify%& ACL condition"
26225 .cindex "TLS" "client certificate verification"
26226 .cindex "certificate" "verification of client"
26227 .cindex "&ACL;" "certificate verification"
26228 .cindex "&ACL;" "testing a TLS certificate"
26229 This condition is true in an SMTP session if the session is encrypted, and a
26230 certificate was received from the client, and the certificate was verified. The
26231 server requests a certificate only if the client matches &%tls_verify_hosts%&
26232 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
26233
26234 .vitem &*verify&~=&~csa*&
26235 .cindex "CSA verification"
26236 This condition checks whether the sending host (the client) is authorized to
26237 send email. Details of how this works are given in section
26238 &<<SECTverifyCSA>>&.
26239
26240 .vitem &*verify&~=&~header_sender/*&<&'options'&>
26241 .cindex "&%verify%& ACL condition"
26242 .cindex "&ACL;" "verifying sender in the header"
26243 .cindex "header lines" "verifying the sender in"
26244 .cindex "sender" "verifying in header"
26245 .cindex "verifying" "sender in header"
26246 This condition is relevant only in an ACL that is run after a message has been
26247 received, that is, in an ACL specified by &%acl_smtp_data%& or
26248 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
26249 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
26250 is loosely thought of as a &"sender"& address (hence the name of the test).
26251 However, an address that appears in one of these headers need not be an address
26252 that accepts bounce messages; only sender addresses in envelopes are required
26253 to accept bounces. Therefore, if you use the callout option on this check, you
26254 might want to arrange for a non-empty address in the MAIL command.
26255
26256 Details of address verification and the options are given later, starting at
26257 section &<<SECTaddressverification>>& (callouts are described in section
26258 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
26259 condition to restrict it to bounce messages only:
26260 .code
26261 deny    senders = :
26262         message = A valid sender header is required for bounces
26263        !verify  = header_sender
26264 .endd
26265
26266 .vitem &*verify&~=&~header_syntax*&
26267 .cindex "&%verify%& ACL condition"
26268 .cindex "&ACL;" "verifying header syntax"
26269 .cindex "header lines" "verifying syntax"
26270 .cindex "verifying" "header syntax"
26271 This condition is relevant only in an ACL that is run after a message has been
26272 received, that is, in an ACL specified by &%acl_smtp_data%& or
26273 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
26274 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
26275 and &'Bcc:'&). Unqualified addresses (local parts without domains) are
26276 permitted only in locally generated messages and from hosts that match
26277 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
26278 appropriate.
26279
26280 Note that this condition is a syntax check only. However, a common spamming
26281 ploy used to be to send syntactically invalid headers such as
26282 .code
26283 To: @
26284 .endd
26285 and this condition can be used to reject such messages, though they are not as
26286 common as they used to be.
26287
26288 .vitem &*verify&~=&~helo*&
26289 .cindex "&%verify%& ACL condition"
26290 .cindex "&ACL;" "verifying HELO/EHLO"
26291 .cindex "HELO" "verifying"
26292 .cindex "EHLO" "verifying"
26293 .cindex "verifying" "EHLO"
26294 .cindex "verifying" "HELO"
26295 This condition is true if a HELO or EHLO command has been received from the
26296 client host, and its contents have been verified. If there has been no previous
26297 attempt to verify the HELO/EHLO contents, it is carried out when this
26298 condition is encountered. See the description of the &%helo_verify_hosts%& and
26299 &%helo_try_verify_hosts%& options for details of how to request verification
26300 independently of this condition.
26301
26302 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
26303 option), this condition is always true.
26304
26305
26306 .vitem &*verify&~=&~not_blind*&
26307 .cindex "verifying" "not blind"
26308 .cindex "bcc recipients, verifying none"
26309 This condition checks that there are no blind (bcc) recipients in the message.
26310 Every envelope recipient must appear either in a &'To:'& header line or in a
26311 &'Cc:'& header line for this condition to be true. Local parts are checked
26312 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
26313 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
26314 used only in a DATA or non-SMTP ACL.
26315
26316 There are, of course, many legitimate messages that make use of blind (bcc)
26317 recipients. This check should not be used on its own for blocking messages.
26318
26319
26320 .vitem &*verify&~=&~recipient/*&<&'options'&>
26321 .cindex "&%verify%& ACL condition"
26322 .cindex "&ACL;" "verifying recipient"
26323 .cindex "recipient" "verifying"
26324 .cindex "verifying" "recipient"
26325 .vindex "&$address_data$&"
26326 This condition is relevant only after a RCPT command. It verifies the current
26327 recipient. Details of address verification are given later, starting at section
26328 &<<SECTaddressverification>>&. After a recipient has been verified, the value
26329 of &$address_data$& is the last value that was set while routing the address.
26330 This applies even if the verification fails. When an address that is being
26331 verified is redirected to a single address, verification continues with the new
26332 address, and in that case, the subsequent value of &$address_data$& is the
26333 value for the child address.
26334
26335 .vitem &*verify&~=&~reverse_host_lookup*&
26336 .cindex "&%verify%& ACL condition"
26337 .cindex "&ACL;" "verifying host reverse lookup"
26338 .cindex "host" "verifying reverse lookup"
26339 This condition ensures that a verified host name has been looked up from the IP
26340 address of the client host. (This may have happened already if the host name
26341 was needed for checking a host list, or if the host matched &%host_lookup%&.)
26342 Verification ensures that the host name obtained from a reverse DNS lookup, or
26343 one of its aliases, does, when it is itself looked up in the DNS, yield the
26344 original IP address.
26345
26346 If this condition is used for a locally generated message (that is, when there
26347 is no client host involved), it always succeeds.
26348
26349 .vitem &*verify&~=&~sender/*&<&'options'&>
26350 .cindex "&%verify%& ACL condition"
26351 .cindex "&ACL;" "verifying sender"
26352 .cindex "sender" "verifying"
26353 .cindex "verifying" "sender"
26354 This condition is relevant only after a MAIL or RCPT command, or after a
26355 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
26356 the message's sender is empty (that is, this is a bounce message), the
26357 condition is true. Otherwise, the sender address is verified.
26358
26359 .vindex "&$address_data$&"
26360 .vindex "&$sender_address_data$&"
26361 If there is data in the &$address_data$& variable at the end of routing, its
26362 value is placed in &$sender_address_data$& at the end of verification. This
26363 value can be used in subsequent conditions and modifiers in the same ACL
26364 statement. It does not persist after the end of the current statement. If you
26365 want to preserve the value for longer, you can save it in an ACL variable.
26366
26367 Details of verification are given later, starting at section
26368 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
26369 to avoid doing it more than once per message.
26370
26371 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
26372 .cindex "&%verify%& ACL condition"
26373 This is a variation of the previous option, in which a modified address is
26374 verified as a sender.
26375 .endlist
26376
26377
26378
26379 .section "Using DNS lists" "SECTmorednslists"
26380 .cindex "DNS list" "in ACL"
26381 .cindex "black list (DNS)"
26382 .cindex "&ACL;" "testing a DNS list"
26383 In its simplest form, the &%dnslists%& condition tests whether the calling host
26384 is on at least one of a number of DNS lists by looking up the inverted IP
26385 address in one or more DNS domains. (Note that DNS list domains are not mail
26386 domains, so the &`+`& syntax for named lists doesn't work - it is used for
26387 special options instead.) For example, if the calling host's IP
26388 address is 192.168.62.43, and the ACL statement is
26389 .code
26390 deny dnslists = blackholes.mail-abuse.org : \
26391                 dialups.mail-abuse.org
26392 .endd
26393 the following records are looked up:
26394 .code
26395 43.62.168.192.blackholes.mail-abuse.org
26396 43.62.168.192.dialups.mail-abuse.org
26397 .endd
26398 As soon as Exim finds an existing DNS record, processing of the list stops.
26399 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
26400 to test that a host is on more than one list (an &"and"& conjunction), you can
26401 use two separate conditions:
26402 .code
26403 deny dnslists = blackholes.mail-abuse.org
26404      dnslists = dialups.mail-abuse.org
26405 .endd
26406 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
26407 behaves as if the host does not match the list item, that is, as if the DNS
26408 record does not exist. If there are further items in the DNS list, they are
26409 processed.
26410
26411 This is usually the required action when &%dnslists%& is used with &%deny%&
26412 (which is the most common usage), because it prevents a DNS failure from
26413 blocking mail. However, you can change this behaviour by putting one of the
26414 following special items in the list:
26415 .display
26416 &`+include_unknown `&   behave as if the item is on the list
26417 &`+exclude_unknown `&   behave as if the item is not on the list (default)
26418 &`+defer_unknown   `&   give a temporary error
26419 .endd
26420 .cindex "&`+include_unknown`&"
26421 .cindex "&`+exclude_unknown`&"
26422 .cindex "&`+defer_unknown`&"
26423 Each of these applies to any subsequent items on the list. For example:
26424 .code
26425 deny dnslists = +defer_unknown : foo.bar.example
26426 .endd
26427 Testing the list of domains stops as soon as a match is found. If you want to
26428 warn for one list and block for another, you can use two different statements:
26429 .code
26430 deny  dnslists = blackholes.mail-abuse.org
26431 warn  message  = X-Warn: sending host is on dialups list
26432       dnslists = dialups.mail-abuse.org
26433 .endd
26434 DNS list lookups are cached by Exim for the duration of the SMTP session,
26435 so a lookup based on the IP address is done at most once for any incoming
26436 connection. Exim does not share information between multiple incoming
26437 connections (but your local name server cache should be active).
26438
26439
26440
26441 .section "Specifying the IP address for a DNS list lookup" "SECID201"
26442 .cindex "DNS list" "keyed by explicit IP address"
26443 By default, the IP address that is used in a DNS list lookup is the IP address
26444 of the calling host. However, you can specify another IP address by listing it
26445 after the domain name, introduced by a slash. For example:
26446 .code
26447 deny dnslists = black.list.tld/192.168.1.2
26448 .endd
26449 This feature is not very helpful with explicit IP addresses; it is intended for
26450 use with IP addresses that are looked up, for example, the IP addresses of the
26451 MX hosts or nameservers of an email sender address. For an example, see section
26452 &<<SECTmulkeyfor>>& below.
26453
26454
26455
26456
26457 .section "DNS lists keyed on domain names" "SECID202"
26458 .cindex "DNS list" "keyed by domain name"
26459 There are some lists that are keyed on domain names rather than inverted IP
26460 addresses (see for example the &'domain based zones'& link at
26461 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
26462 with these lists. You can change the name that is looked up in a DNS list by
26463 listing it after the domain name, introduced by a slash. For example,
26464 .code
26465 deny  message  = Sender's domain is listed at $dnslist_domain
26466       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
26467 .endd
26468 This particular example is useful only in ACLs that are obeyed after the
26469 RCPT or DATA commands, when a sender address is available. If (for
26470 example) the message's sender is &'user@tld.example'& the name that is looked
26471 up by this example is
26472 .code
26473 tld.example.dsn.rfc-ignorant.org
26474 .endd
26475 A single &%dnslists%& condition can contain entries for both names and IP
26476 addresses. For example:
26477 .code
26478 deny dnslists = sbl.spamhaus.org : \
26479                 dsn.rfc-ignorant.org/$sender_address_domain
26480 .endd
26481 The first item checks the sending host's IP address; the second checks a domain
26482 name. The whole condition is true if either of the DNS lookups succeeds.
26483
26484
26485
26486
26487 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
26488 .cindex "DNS list" "multiple keys for"
26489 The syntax described above for looking up explicitly-defined values (either
26490 names or IP addresses) in a DNS blacklist is a simplification. After the domain
26491 name for the DNS list, what follows the slash can in fact be a list of items.
26492 As with all lists in Exim, the default separator is a colon. However, because
26493 this is a sublist within the list of DNS blacklist domains, it is necessary
26494 either to double the separators like this:
26495 .code
26496 dnslists = black.list.tld/name.1::name.2
26497 .endd
26498 or to change the separator character, like this:
26499 .code
26500 dnslists = black.list.tld/<;name.1;name.2
26501 .endd
26502 If an item in the list is an IP address, it is inverted before the DNS
26503 blacklist domain is appended. If it is not an IP address, no inversion
26504 occurs. Consider this condition:
26505 .code
26506 dnslists = black.list.tld/<;192.168.1.2;a.domain
26507 .endd
26508 The DNS lookups that occur are:
26509 .code
26510 2.1.168.192.black.list.tld
26511 a.domain.black.list.tld
26512 .endd
26513 Once a DNS record has been found (that matches a specific IP return
26514 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
26515 are done. If there is a temporary DNS error, the rest of the sublist of domains
26516 or IP addresses is tried. A temporary error for the whole dnslists item occurs
26517 only if no other DNS lookup in this sublist succeeds. In other words, a
26518 successful lookup for any of the items in the sublist overrides a temporary
26519 error for a previous item.
26520
26521 The ability to supply a list of items after the slash is in some sense just a
26522 syntactic convenience. These two examples have the same effect:
26523 .code
26524 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
26525 dnslists = black.list.tld/a.domain::b.domain
26526 .endd
26527 However, when the data for the list is obtained from a lookup, the second form
26528 is usually much more convenient. Consider this example:
26529 .code
26530 deny message  = The mail servers for the domain \
26531                 $sender_address_domain \
26532                 are listed at $dnslist_domain ($dnslist_value); \
26533                 see $dnslist_text.
26534      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
26535                                    ${lookup dnsdb {>|mxh=\
26536                                    $sender_address_domain} }} }
26537 .endd
26538 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
26539 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
26540 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
26541 of expanding the condition might be something like this:
26542 .code
26543 dnslists = sbl.spahmaus.org/<|192.168.2.3|192.168.5.6|...
26544 .endd
26545 Thus, this example checks whether or not the IP addresses of the sender
26546 domain's mail servers are on the Spamhaus black list.
26547
26548 The key that was used for a successful DNS list lookup is put into the variable
26549 &$dnslist_matched$& (see section &<<SECID204>>&).
26550
26551
26552
26553
26554 .section "Data returned by DNS lists" "SECID203"
26555 .cindex "DNS list" "data returned from"
26556 DNS lists are constructed using address records in the DNS. The original RBL
26557 just used the address 127.0.0.1 on the right hand side of each record, but the
26558 RBL+ list and some other lists use a number of values with different meanings.
26559 The values used on the RBL+ list are:
26560 .display
26561 127.1.0.1  RBL
26562 127.1.0.2  DUL
26563 127.1.0.3  DUL and RBL
26564 127.1.0.4  RSS
26565 127.1.0.5  RSS and RBL
26566 127.1.0.6  RSS and DUL
26567 127.1.0.7  RSS and DUL and RBL
26568 .endd
26569 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
26570 different values. Some DNS lists may return more than one address record;
26571 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
26572
26573
26574 .section "Variables set from DNS lists" "SECID204"
26575 .cindex "expansion" "variables, set from DNS list"
26576 .cindex "DNS list" "variables set from"
26577 .vindex "&$dnslist_domain$&"
26578 .vindex "&$dnslist_matched$&"
26579 .vindex "&$dnslist_text$&"
26580 .vindex "&$dnslist_value$&"
26581 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
26582 the name of the overall domain that matched (for example,
26583 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
26584 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
26585 the DNS record. When the key is an IP address, it is not reversed in
26586 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
26587 cases, for example:
26588 .code
26589 deny dnslists = spamhaus.example
26590 .endd
26591 the key is also available in another variable (in this case,
26592 &$sender_host_address$&). In more complicated cases, however, this is not true.
26593 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
26594 might generate a dnslists lookup like this:
26595 .code
26596 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
26597 .endd
26598 If this condition succeeds, the value in &$dnslist_matched$& might be
26599 &`192.168.6.7`& (for example).
26600
26601 If more than one address record is returned by the DNS lookup, all the IP
26602 addresses are included in &$dnslist_value$&, separated by commas and spaces.
26603 The variable &$dnslist_text$& contains the contents of any associated TXT
26604 record. For lists such as RBL+ the TXT record for a merged entry is often not
26605 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
26606 information.
26607
26608 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
26609 &-- although these appear before the condition in the ACL, they are not
26610 expanded until after it has failed. For example:
26611 .code
26612 deny    hosts = !+local_networks
26613         message = $sender_host_address is listed \
26614                   at $dnslist_domain
26615         dnslists = rbl-plus.mail-abuse.example
26616 .endd
26617
26618
26619
26620 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
26621 .cindex "DNS list" "matching specific returned data"
26622 You can add an equals sign and an IP address after a &%dnslists%& domain name
26623 in order to restrict its action to DNS records with a matching right hand side.
26624 For example,
26625 .code
26626 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
26627 .endd
26628 rejects only those hosts that yield 127.0.0.2. Without this additional data,
26629 any address record is considered to be a match. For the moment, we assume
26630 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
26631 describes how multiple records are handled.
26632
26633 More than one IP address may be given for checking, using a comma as a
26634 separator. These are alternatives &-- if any one of them matches, the
26635 &%dnslists%& condition is true. For example:
26636 .code
26637 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
26638 .endd
26639 If you want to specify a constraining address list and also specify names or IP
26640 addresses to be looked up, the constraining address list must be specified
26641 first. For example:
26642 .code
26643 deny dnslists = dsn.rfc-ignorant.org\
26644                 =127.0.0.2/$sender_address_domain
26645 .endd
26646
26647 If the character &`&&`& is used instead of &`=`&, the comparison for each
26648 listed IP address is done by a bitwise &"and"& instead of by an equality test.
26649 In other words, the listed addresses are used as bit masks. The comparison is
26650 true if all the bits in the mask are present in the address that is being
26651 tested. For example:
26652 .code
26653 dnslists = a.b.c&0.0.0.3
26654 .endd
26655 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
26656 want to test whether one bit or another bit is present (as opposed to both
26657 being present), you must use multiple values. For example:
26658 .code
26659 dnslists = a.b.c&0.0.0.1,0.0.0.2
26660 .endd
26661 matches if the final component of the address is an odd number or two times
26662 an odd number.
26663
26664
26665
26666 .section "Negated DNS matching conditions" "SECID205"
26667 You can supply a negative list of IP addresses as part of a &%dnslists%&
26668 condition. Whereas
26669 .code
26670 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
26671 .endd
26672 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
26673 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
26674 .code
26675 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
26676 .endd
26677 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
26678 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
26679 words, the result of the test is inverted if an exclamation mark appears before
26680 the &`=`& (or the &`&&`&) sign.
26681
26682 &*Note*&: This kind of negation is not the same as negation in a domain,
26683 host, or address list (which is why the syntax is different).
26684
26685 If you are using just one list, the negation syntax does not gain you much. The
26686 previous example is precisely equivalent to
26687 .code
26688 deny  dnslists = a.b.c
26689      !dnslists = a.b.c=127.0.0.2,127.0.0.3
26690 .endd
26691 However, if you are using multiple lists, the negation syntax is clearer.
26692 Consider this example:
26693 .code
26694 deny  dnslists = sbl.spamhaus.org : \
26695                  list.dsbl.org : \
26696                  dnsbl.njabl.org!=127.0.0.3 : \
26697                  relays.ordb.org
26698 .endd
26699 Using only positive lists, this would have to be:
26700 .code
26701 deny  dnslists = sbl.spamhaus.org : \
26702                  list.dsbl.org
26703 deny  dnslists = dnsbl.njabl.org
26704      !dnslists = dnsbl.njabl.org=127.0.0.3
26705 deny  dnslists = relays.ordb.org
26706 .endd
26707 which is less clear, and harder to maintain.
26708
26709
26710
26711
26712 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
26713 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
26714 thereby providing more than one IP address. When an item in a &%dnslists%& list
26715 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
26716 the match to specific results from the DNS lookup, there are two ways in which
26717 the checking can be handled. For example, consider the condition:
26718 .code
26719 dnslists = a.b.c=127.0.0.1
26720 .endd
26721 What happens if the DNS lookup for the incoming IP address yields both
26722 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
26723 condition true because at least one given value was found, or is it false
26724 because at least one of the found values was not listed? And how does this
26725 affect negated conditions? Both possibilities are provided for with the help of
26726 additional separators &`==`& and &`=&&`&.
26727
26728 .ilist
26729 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
26730 IP addresses matches one of the listed addresses. For the example above, the
26731 condition is true because 127.0.0.1 matches.
26732 .next
26733 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
26734 looked up IP addresses matches one of the listed addresses. If the condition is
26735 changed to:
26736 .code
26737 dnslists = a.b.c==127.0.0.1
26738 .endd
26739 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
26740 false because 127.0.0.2 is not listed. You would need to have:
26741 .code
26742 dnslists = a.b.c==127.0.0.1,127.0.0.2
26743 .endd
26744 for the condition to be true.
26745 .endlist
26746
26747 When &`!`& is used to negate IP address matching, it inverts the result, giving
26748 the precise opposite of the behaviour above. Thus:
26749 .ilist
26750 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
26751 addresses matches one of the listed addresses. Consider:
26752 .code
26753 dnslists = a.b.c!&0.0.0.1
26754 .endd
26755 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
26756 false because 127.0.0.1 matches.
26757 .next
26758 If &`!==`& or &`!=&&`& is used, the condition is true there is at least one
26759 looked up IP address that does not match. Consider:
26760 .code
26761 dnslists = a.b.c!=&0.0.0.1
26762 .endd
26763 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
26764 true, because 127.0.0.2 does not match. You would need to have:
26765 .code
26766 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
26767 .endd
26768 for the condition to be false.
26769 .endlist
26770 When the DNS lookup yields only a single IP address, there is no difference
26771 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
26772
26773
26774
26775
26776 .section "Detailed information from merged DNS lists" "SECTmordetinf"
26777 .cindex "DNS list" "information from merged"
26778 When the facility for restricting the matching IP values in a DNS list is used,
26779 the text from the TXT record that is set in &$dnslist_text$& may not reflect
26780 the true reason for rejection. This happens when lists are merged and the IP
26781 address in the A record is used to distinguish them; unfortunately there is
26782 only one TXT record. One way round this is not to use merged lists, but that
26783 can be inefficient because it requires multiple DNS lookups where one would do
26784 in the vast majority of cases when the host of interest is not on any of the
26785 lists.
26786
26787 A less inefficient way of solving this problem is available. If
26788 two domain names, comma-separated, are given, the second is used first to
26789 do an initial check, making use of any IP value restrictions that are set.
26790 If there is a match, the first domain is used, without any IP value
26791 restrictions, to get the TXT record. As a byproduct of this, there is also
26792 a check that the IP being tested is indeed on the first list. The first
26793 domain is the one that is put in &$dnslist_domain$&. For example:
26794 .code
26795 reject message  = \
26796          rejected because $sender_host_address is blacklisted \
26797          at $dnslist_domain\n$dnslist_text
26798        dnslists = \
26799          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
26800          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
26801 .endd
26802 For the first blacklist item, this starts by doing a lookup in
26803 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
26804 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
26805 value, and as long as something is found, it looks for the corresponding TXT
26806 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
26807 The second blacklist item is processed similarly.
26808
26809 If you are interested in more than one merged list, the same list must be
26810 given several times, but because the results of the DNS lookups are cached,
26811 the DNS calls themselves are not repeated. For example:
26812 .code
26813 reject dnslists = \
26814          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
26815          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
26816          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
26817          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
26818 .endd
26819 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
26820 values matches (or if no record is found), this is the only lookup that is
26821 done. Only if there is a match is one of the more specific lists consulted.
26822
26823
26824
26825 .section "DNS lists and IPv6" "SECTmorednslistslast"
26826 .cindex "IPv6" "DNS black lists"
26827 .cindex "DNS list" "IPv6 usage"
26828 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
26829 nibble by nibble. For example, if the calling host's IP address is
26830 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
26831 .code
26832 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
26833   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
26834 .endd
26835 (split over two lines here to fit on the page). Unfortunately, some of the DNS
26836 lists contain wildcard records, intended for IPv4, that interact badly with
26837 IPv6. For example, the DNS entry
26838 .code
26839 *.3.some.list.example.    A    127.0.0.1
26840 .endd
26841 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
26842 Unfortunately, it also matches the entire 3::/4 IPv6 network.
26843
26844 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
26845 &%condition%& condition, as in this example:
26846 .code
26847 deny   condition = ${if isip4{$sender_host_address}}
26848        dnslists  = some.list.example
26849 .endd
26850
26851 .section "Rate limiting incoming messages" "SECTratelimiting"
26852 .cindex "rate limiting" "client sending"
26853 .cindex "limiting client sending rates"
26854 .oindex "&%smtp_ratelimit_*%&"
26855 The &%ratelimit%& ACL condition can be used to measure and control the rate at
26856 which clients can send email. This is more powerful than the
26857 &%smtp_ratelimit_*%& options, because those options control the rate of
26858 commands in a single SMTP session only, whereas the &%ratelimit%& condition
26859 works across all connections (concurrent and sequential) from the same client
26860 host. The syntax of the &%ratelimit%& condition is:
26861 .display
26862 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
26863 .endd
26864 If the average client sending rate is less than &'m'& messages per time
26865 period &'p'& then the condition is false; otherwise it is true.
26866
26867 As a side-effect, the &%ratelimit%& condition sets the expansion variable
26868 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
26869 configured value of &'m'&, and &$sender_rate_period$& to the configured value
26870 of &'p'&.
26871
26872 The parameter &'p'& is the smoothing time constant, in the form of an Exim
26873 time interval, for example, &`8h`& for eight hours. A larger time constant
26874 means that it takes Exim longer to forget a client's past behaviour. The
26875 parameter &'m'& is the maximum number of messages that a client is permitted to
26876 send in each time interval. It also specifies the number of messages permitted
26877 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
26878 constant, you can allow a client to send more messages in a burst without
26879 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
26880 both small, messages must be sent at an even rate.
26881
26882 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
26883 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
26884 when deploying the &%ratelimit%& ACL condition. The script prints usage
26885 instructions when it is run with no arguments.
26886
26887 The key is used to look up the data for calculating the client's average
26888 sending rate. This data is stored in Exim's spool directory, alongside the
26889 retry and other hints databases. The default key is &$sender_host_address$&,
26890 which means Exim computes the sending rate of each client host IP address.
26891 By changing the key you can change how Exim identifies clients for the purpose
26892 of ratelimiting. For example, to limit the sending rate of each authenticated
26893 user, independent of the computer they are sending from, set the key to
26894 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
26895 example, &$authenticated_id$& is only meaningful if the client has
26896 authenticated (which you can check with the &%authenticated%& ACL condition).
26897
26898 The lookup key does not have to identify clients: If you want to limit the
26899 rate at which a recipient receives messages, you can use the key
26900 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
26901 ACL.
26902
26903 Internally, Exim appends the smoothing constant &'p'& and the options onto the
26904 lookup key because they alter the meaning of the stored data. This is not true
26905 for the limit &'m'&, so you can alter the configured maximum rate and Exim will
26906 still remember clients' past behaviour, but if you alter the other ratelimit
26907 parameters Exim forgets past behaviour.
26908
26909 Each &%ratelimit%& condition can have up to three options. One option
26910 specifies what Exim measures the rate of, and the second specifies how Exim
26911 handles excessively fast clients. The third option can be &`noupdate`&, to
26912 disable updating of the ratelimiting database (see section &<<rearatdat>>&).
26913 The options are separated by a slash, like the other parameters. They may
26914 appear in any order.
26915
26916 .section "Ratelimit options for what is being measured" "ratoptmea"
26917 The &%per_conn%& option limits the client's connection rate.
26918
26919 The &%per_mail%& option limits the client's rate of sending messages. This is
26920 the default if none of the &%per_*%& options is specified.
26921
26922 The &%per_byte%& option limits the sender's email bandwidth. Note that it is
26923 best to use this option in the DATA ACL; if it is used in an earlier ACL it
26924 relies on the SIZE parameter specified by the client in its MAIL command,
26925 which may be inaccurate or completely missing. You can follow the limit &'m'&
26926 in the configuration with K, M, or G to specify limits in kilobytes,
26927 megabytes, or gigabytes, respectively.
26928
26929 The &%per_rcpt%& option causes Exim to limit the rate at which
26930 recipients are accepted. To be effective, it would need to be used in
26931 either the &%acl_smtp_rcpt%& or the &%acl_not_smtp%& ACL. In the
26932 &%acl_smtp_rcpt%& ACL, the number of recipients is incremented by one.
26933 In the case of a locally submitted message in the &%acl_not_smtp%& ACL,
26934 the number of recipients is incremented by the &%$recipients_count%&
26935 for the entire message. Note that in either case the rate limiting
26936 engine will see a message with many recipients as a large high-speed
26937 burst.
26938
26939 The &%per_cmd%& option causes Exim to recompute the rate every time the
26940 condition is processed. This can be used to limit the SMTP command rate.
26941 This command is essentially an alias of &%per_rcpt%& to make it clear
26942 that the effect is to limit the rate at which individual commands,
26943 rather than recipients, are accepted.
26944
26945 .section "Ratelimit options for handling fast clients" "ratophanfas"
26946 If a client's average rate is greater than the maximum, the rate limiting
26947 engine can react in two possible ways, depending on the presence of the
26948 &%strict%& or &%leaky%& options. This is independent of the other
26949 counter-measures (such as rejecting the message) that may be specified by the
26950 rest of the ACL. The default mode is leaky, which avoids a sender's
26951 over-aggressive retry rate preventing it from getting any email through.
26952
26953 The &%strict%& option means that the client's recorded rate is always
26954 updated. The effect of this is that Exim measures the client's average rate
26955 of attempts to send email, which can be much higher than the maximum it is
26956 actually allowed. If the client is over the limit it may be subjected to
26957 counter-measures by the ACL until it slows down below the maximum rate. If
26958 the client stops attempting to send email for the time specified in the &'p'&
26959 parameter then its computed rate will decay exponentially to 37% of its peak
26960 value. You can work out the time (the number of smoothing periods) that a
26961 client is subjected to counter-measures after an over-limit burst with this
26962 formula:
26963 .code
26964         ln(peakrate/maxrate)
26965 .endd
26966 The &%leaky%& (default) option means that the client's recorded rate is not
26967 updated if it is above the limit. The effect of this is that Exim measures the
26968 client's average rate of successfully sent email, which cannot be greater than
26969 the maximum allowed. If the client is over the limit it may suffer some
26970 counter-measures (as specified in the ACL), but it will still be able to send
26971 email at the configured maximum rate, whatever the rate of its attempts. This
26972 is generally the better choice if you have clients that retry automatically.
26973
26974 .section "Using rate limiting" "useratlim"
26975 Exim's other ACL facilities are used to define what counter-measures are taken
26976 when the rate limit is exceeded. This might be anything from logging a warning
26977 (for example, while measuring existing sending rates in order to define
26978 policy), through time delays to slow down fast senders, up to rejecting the
26979 message. For example:
26980 .code
26981 # Log all senders' rates
26982 warn ratelimit = 0 / 1h / strict
26983      log_message = Sender rate $sender_rate / $sender_rate_period
26984
26985 # Slow down fast senders; note the need to truncate $sender_rate
26986 # at the decimal point.
26987 warn ratelimit = 100 / 1h / per_rcpt / strict
26988      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
26989                    $sender_rate_limit }s
26990
26991 # Keep authenticated users under control
26992 deny authenticated = *
26993      ratelimit = 100 / 1d / strict / $authenticated_id
26994
26995 # System-wide rate limit
26996 defer message = Sorry, too busy. Try again later.
26997      ratelimit = 10 / 1s / $primary_hostname
26998
26999 # Restrict incoming rate from each host, with a default
27000 # set using a macro and special cases looked up in a table.
27001 defer message = Sender rate exceeds $sender_rate_limit \
27002                messages per $sender_rate_period
27003      ratelimit = ${lookup {$sender_host_address} \
27004                    cdb {DB/ratelimits.cdb} \
27005                    {$value} {RATELIMIT} }
27006 .endd
27007 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
27008 especially with the &%per_rcpt%& option, you may suffer from a performance
27009 bottleneck caused by locking on the ratelimit hints database. Apart from
27010 making your ACLs less complicated, you can reduce the problem by using a
27011 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
27012 this means that Exim will lose its hints data after a reboot (including retry
27013 hints, the callout cache, and ratelimit data).
27014
27015
27016 .section "Reading ratelimit data without updating" "rearatdat"
27017 .cindex "rate limitint" "reading data without updating"
27018 If the &%noupdate%& option is present on a &%ratelimit%& ACL condition, Exim
27019 computes the rate and checks the limit as normal, but it does not update the
27020 saved data. This means that, in relevant ACLs, it is possible to lookup the
27021 existence of a specified (or auto-generated) ratelimit key without incrementing
27022 the ratelimit counter for that key. In order for this to be useful, another ACL
27023 entry must set the rate for the same key (otherwise it will always be zero).
27024 For example:
27025 .code
27026 acl_check_connect:
27027   deny ratelimit = 100 / 5m / strict / per_cmd / noupdate
27028        log_message = RATE: $sender_rate/$sender_rate_period \
27029                      (max $sender_rate_limit)
27030 .endd
27031 .display
27032 &'... some other logic and tests...'&
27033 .endd
27034 .code
27035 acl_check_mail:
27036   warn ratelimit = 100 / 5m / strict / per_cmd
27037        condition = ${if le{$sender_rate}{$sender_rate_limit}}
27038        logwrite  = RATE UPDATE: $sender_rate/$sender_rate_period \
27039                      (max $sender_rate_limit)
27040 .endd
27041 In this example, the rate is tested and used to deny access (when it is too
27042 high) in the connect ACL, but the actual computation of the remembered rate
27043 happens later, on a per-command basis, in another ACL.
27044
27045
27046
27047 .section "Address verification" "SECTaddressverification"
27048 .cindex "verifying address" "options for"
27049 .cindex "policy control" "address verification"
27050 Several of the &%verify%& conditions described in section
27051 &<<SECTaclconditions>>& cause addresses to be verified. Section
27052 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
27053 The verification conditions can be followed by options that modify the
27054 verification process. The options are separated from the keyword and from each
27055 other by slashes, and some of them contain parameters. For example:
27056 .code
27057 verify = sender/callout
27058 verify = recipient/defer_ok/callout=10s,defer_ok
27059 .endd
27060 The first stage of address verification, which always happens, is to run the
27061 address through the routers, in &"verify mode"&. Routers can detect the
27062 difference between verification and routing for delivery, and their actions can
27063 be varied by a number of generic options such as &%verify%& and &%verify_only%&
27064 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
27065 The available options are as follows:
27066
27067 .ilist
27068 If the &%callout%& option is specified, successful routing to one or more
27069 remote hosts is followed by a &"callout"& to those hosts as an additional
27070 check. Callouts and their sub-options are discussed in the next section.
27071 .next
27072 If there is a defer error while doing verification routing, the ACL
27073 normally returns &"defer"&. However, if you include &%defer_ok%& in the
27074 options, the condition is forced to be true instead. Note that this is a main
27075 verification option as well as a suboption for callouts.
27076 .next
27077 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
27078 discusses the reporting of sender address verification failures.
27079 .next
27080 The &%success_on_redirect%& option causes verification always to succeed
27081 immediately after a successful redirection. By default, if a redirection
27082 generates just one address, that address is also verified. See further
27083 discussion in section &<<SECTredirwhilveri>>&.
27084 .endlist
27085
27086 .cindex "verifying address" "differentiating failures"
27087 .vindex "&$recipient_verify_failure$&"
27088 .vindex "&$sender_verify_failure$&"
27089 .vindex "&$acl_verify_message$&"
27090 After an address verification failure, &$acl_verify_message$& contains the
27091 error message that is associated with the failure. It can be preserved by
27092 coding like this:
27093 .code
27094 warn  !verify = sender
27095        set acl_m0 = $acl_verify_message
27096 .endd
27097 If you are writing your own custom rejection message or log message when
27098 denying access, you can use this variable to include information about the
27099 verification failure.
27100
27101 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
27102 appropriate) contains one of the following words:
27103
27104 .ilist
27105 &%qualify%&: The address was unqualified (no domain), and the message
27106 was neither local nor came from an exempted host.
27107 .next
27108 &%route%&: Routing failed.
27109 .next
27110 &%mail%&: Routing succeeded, and a callout was attempted; rejection
27111 occurred at or before the MAIL command (that is, on initial
27112 connection, HELO, or MAIL).
27113 .next
27114 &%recipient%&: The RCPT command in a callout was rejected.
27115 .next
27116 &%postmaster%&: The postmaster check in a callout was rejected.
27117 .endlist
27118
27119 The main use of these variables is expected to be to distinguish between
27120 rejections of MAIL and rejections of RCPT in callouts.
27121
27122
27123
27124
27125 .section "Callout verification" "SECTcallver"
27126 .cindex "verifying address" "by callout"
27127 .cindex "callout" "verification"
27128 .cindex "SMTP" "callout verification"
27129 For non-local addresses, routing verifies the domain, but is unable to do any
27130 checking of the local part. There are situations where some means of verifying
27131 the local part is desirable. One way this can be done is to make an SMTP
27132 &'callback'& to a delivery host for the sender address or a &'callforward'& to
27133 a subsequent host for a recipient address, to see if the host accepts the
27134 address. We use the term &'callout'& to cover both cases. Note that for a
27135 sender address, the callback is not to the client host that is trying to
27136 deliver the message, but to one of the hosts that accepts incoming mail for the
27137 sender's domain.
27138
27139 Exim does not do callouts by default. If you want them to happen, you must
27140 request them by setting appropriate options on the &%verify%& condition, as
27141 described below. This facility should be used with care, because it can add a
27142 lot of resource usage to the cost of verifying an address. However, Exim does
27143 cache the results of callouts, which helps to reduce the cost. Details of
27144 caching are in section &<<SECTcallvercache>>&.
27145
27146 Recipient callouts are usually used only between hosts that are controlled by
27147 the same administration. For example, a corporate gateway host could use
27148 callouts to check for valid recipients on an internal mailserver. A successful
27149 callout does not guarantee that a real delivery to the address would succeed;
27150 on the other hand, a failing callout does guarantee that a delivery would fail.
27151
27152 If the &%callout%& option is present on a condition that verifies an address, a
27153 second stage of verification occurs if the address is successfully routed to
27154 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
27155 &(manualroute)& router, where the router specifies the hosts. However, if a
27156 router that does not set up hosts routes to an &(smtp)& transport with a
27157 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
27158 &%hosts_override%& set, its hosts are always used, whether or not the router
27159 supplies a host list.
27160
27161 The port that is used is taken from the transport, if it is specified and is a
27162 remote transport. (For routers that do verification only, no transport need be
27163 specified.) Otherwise, the default SMTP port is used. If a remote transport
27164 specifies an outgoing interface, this is used; otherwise the interface is not
27165 specified. Likewise, the text that is used for the HELO command is taken from
27166 the transport's &%helo_data%& option; if there is no transport, the value of
27167 &$smtp_active_hostname$& is used.
27168
27169 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
27170 test whether a bounce message could be delivered to the sender address. The
27171 following SMTP commands are sent:
27172 .display
27173 &`HELO `&<&'local host name'&>
27174 &`MAIL FROM:<>`&
27175 &`RCPT TO:`&<&'the address to be tested'&>
27176 &`QUIT`&
27177 .endd
27178 LHLO is used instead of HELO if the transport's &%protocol%& option is
27179 set to &"lmtp"&.
27180
27181 A recipient callout check is similar. By default, it also uses an empty address
27182 for the sender. This default is chosen because most hosts do not make use of
27183 the sender address when verifying a recipient. Using the same address means
27184 that a single cache entry can be used for each recipient. Some sites, however,
27185 do make use of the sender address when verifying. These are catered for by the
27186 &%use_sender%& and &%use_postmaster%& options, described in the next section.
27187
27188 If the response to the RCPT command is a 2&'xx'& code, the verification
27189 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
27190 Exim tries the next host, if any. If there is a problem with all the remote
27191 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
27192 &%callout%& option is given, in which case the condition is forced to succeed.
27193
27194 .cindex "SMTP" "output flushing, disabling for callout"
27195 A callout may take a little time. For this reason, Exim normally flushes SMTP
27196 output before performing a callout in an ACL, to avoid unexpected timeouts in
27197 clients when the SMTP PIPELINING extension is in use. The flushing can be
27198 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
27199
27200
27201
27202
27203 .section "Additional parameters for callouts" "CALLaddparcall"
27204 .cindex "callout" "additional parameters for"
27205 The &%callout%& option can be followed by an equals sign and a number of
27206 optional parameters, separated by commas. For example:
27207 .code
27208 verify = recipient/callout=10s,defer_ok
27209 .endd
27210 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
27211 separate verify options, is retained for backwards compatibility, but is now
27212 deprecated. The additional parameters for &%callout%& are as follows:
27213
27214
27215 .vlist
27216 .vitem <&'a&~time&~interval'&>
27217 .cindex "callout" "timeout, specifying"
27218 This specifies the timeout that applies for the callout attempt to each host.
27219 For example:
27220 .code
27221 verify = sender/callout=5s
27222 .endd
27223 The default is 30 seconds. The timeout is used for each response from the
27224 remote host. It is also used for the initial connection, unless overridden by
27225 the &%connect%& parameter.
27226
27227
27228 .vitem &*connect&~=&~*&<&'time&~interval'&>
27229 .cindex "callout" "connection timeout, specifying"
27230 This parameter makes it possible to set a different (usually smaller) timeout
27231 for making the SMTP connection. For example:
27232 .code
27233 verify = sender/callout=5s,connect=1s
27234 .endd
27235 If not specified, this timeout defaults to the general timeout value.
27236
27237 .vitem &*defer_ok*&
27238 .cindex "callout" "defer, action on"
27239 When this parameter is present, failure to contact any host, or any other kind
27240 of temporary error, is treated as success by the ACL. However, the cache is not
27241 updated in this circumstance.
27242
27243 .vitem &*fullpostmaster*&
27244 .cindex "callout" "full postmaster check"
27245 This operates like the &%postmaster%& option (see below), but if the check for
27246 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
27247 accordance with the specification in RFC 2821. The RFC states that the
27248 unqualified address &'postmaster'& should be accepted.
27249
27250
27251 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
27252 .cindex "callout" "sender when verifying header"
27253 When verifying addresses in header lines using the &%header_sender%&
27254 verification option, Exim behaves by default as if the addresses are envelope
27255 sender addresses from a message. Callout verification therefore tests to see
27256 whether a bounce message could be delivered, by using an empty address in the
27257 MAIL command. However, it is arguable that these addresses might never be used
27258 as envelope senders, and could therefore justifiably reject bounce messages
27259 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
27260 address to use in the MAIL command. For example:
27261 .code
27262 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
27263 .endd
27264 This parameter is available only for the &%header_sender%& verification option.
27265
27266
27267 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
27268 .cindex "callout" "overall timeout, specifying"
27269 This parameter sets an overall timeout for performing a callout verification.
27270 For example:
27271 .code
27272 verify = sender/callout=5s,maxwait=30s
27273 .endd
27274 This timeout defaults to four times the callout timeout for individual SMTP
27275 commands. The overall timeout applies when there is more than one host that can
27276 be tried. The timeout is checked before trying the next host. This prevents
27277 very long delays if there are a large number of hosts and all are timing out
27278 (for example, when network connections are timing out).
27279
27280
27281 .vitem &*no_cache*&
27282 .cindex "callout" "cache, suppressing"
27283 .cindex "caching callout, suppressing"
27284 When this parameter is given, the callout cache is neither read nor updated.
27285
27286 .vitem &*postmaster*&
27287 .cindex "callout" "postmaster; checking"
27288 When this parameter is set, a successful callout check is followed by a similar
27289 check for the local part &'postmaster'& at the same domain. If this address is
27290 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
27291 the postmaster check is recorded in a cache record; if it is a failure, this is
27292 used to fail subsequent callouts for the domain without a connection being
27293 made, until the cache record expires.
27294
27295 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
27296 The postmaster check uses an empty sender in the MAIL command by default.
27297 You can use this parameter to do a postmaster check using a different address.
27298 For example:
27299 .code
27300 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
27301 .endd
27302 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
27303 one overrides. The &%postmaster%& parameter is equivalent to this example:
27304 .code
27305 require  verify = sender/callout=postmaster_mailfrom=
27306 .endd
27307 &*Warning*&: The caching arrangements for postmaster checking do not take
27308 account of the sender address. It is assumed that either the empty address or
27309 a fixed non-empty address will be used. All that Exim remembers is that the
27310 postmaster check for the domain succeeded or failed.
27311
27312
27313 .vitem &*random*&
27314 .cindex "callout" "&""random""& check"
27315 When this parameter is set, before doing the normal callout check, Exim does a
27316 check for a &"random"& local part at the same domain. The local part is not
27317 really random &-- it is defined by the expansion of the option
27318 &%callout_random_local_part%&, which defaults to
27319 .code
27320 $primary_host_name-$tod_epoch-testing
27321 .endd
27322 The idea here is to try to determine whether the remote host accepts all local
27323 parts without checking. If it does, there is no point in doing callouts for
27324 specific local parts. If the &"random"& check succeeds, the result is saved in
27325 a cache record, and used to force the current and subsequent callout checks to
27326 succeed without a connection being made, until the cache record expires.
27327
27328 .vitem &*use_postmaster*&
27329 .cindex "callout" "sender for recipient check"
27330 This parameter applies to recipient callouts only. For example:
27331 .code
27332 deny  !verify = recipient/callout=use_postmaster
27333 .endd
27334 .vindex "&$qualify_domain$&"
27335 It causes a non-empty postmaster address to be used in the MAIL command when
27336 performing the callout for the recipient, and also for a &"random"& check if
27337 that is configured. The local part of the address is &`postmaster`& and the
27338 domain is the contents of &$qualify_domain$&.
27339
27340 .vitem &*use_sender*&
27341 This option applies to recipient callouts only. For example:
27342 .code
27343 require  verify = recipient/callout=use_sender
27344 .endd
27345 It causes the message's actual sender address to be used in the MAIL
27346 command when performing the callout, instead of an empty address. There is no
27347 need to use this option unless you know that the called hosts make use of the
27348 sender when checking recipients. If used indiscriminately, it reduces the
27349 usefulness of callout caching.
27350 .endlist
27351
27352 If you use any of the parameters that set a non-empty sender for the MAIL
27353 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
27354 &%use_sender%&), you should think about possible loops. Recipient checking is
27355 usually done between two hosts that are under the same management, and the host
27356 that receives the callouts is not normally configured to do callouts itself.
27357 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
27358 these circumstances.
27359
27360 However, if you use a non-empty sender address for a callout to an arbitrary
27361 host, there is the likelihood that the remote host will itself initiate a
27362 callout check back to your host. As it is checking what appears to be a message
27363 sender, it is likely to use an empty address in MAIL, thus avoiding a
27364 callout loop. However, to be on the safe side it would be best to set up your
27365 own ACLs so that they do not do sender verification checks when the recipient
27366 is the address you use for header sender or postmaster callout checking.
27367
27368 Another issue to think about when using non-empty senders for callouts is
27369 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
27370 by the sender/recipient combination; thus, for any given recipient, many more
27371 actual callouts are performed than when an empty sender or postmaster is used.
27372
27373
27374
27375
27376 .section "Callout caching" "SECTcallvercache"
27377 .cindex "hints database" "callout cache"
27378 .cindex "callout" "cache, description of"
27379 .cindex "caching" "callout"
27380 Exim caches the results of callouts in order to reduce the amount of resources
27381 used, unless you specify the &%no_cache%& parameter with the &%callout%&
27382 option. A hints database called &"callout"& is used for the cache. Two
27383 different record types are used: one records the result of a callout check for
27384 a specific address, and the other records information that applies to the
27385 entire domain (for example, that it accepts the local part &'postmaster'&).
27386
27387 When an original callout fails, a detailed SMTP error message is given about
27388 the failure. However, for subsequent failures use the cache data, this message
27389 is not available.
27390
27391 The expiry times for negative and positive address cache records are
27392 independent, and can be set by the global options &%callout_negative_expire%&
27393 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
27394
27395 If a host gives a negative response to an SMTP connection, or rejects any
27396 commands up to and including
27397 .code
27398 MAIL FROM:<>
27399 .endd
27400 (but not including the MAIL command with a non-empty address),
27401 any callout attempt is bound to fail. Exim remembers such failures in a
27402 domain cache record, which it uses to fail callouts for the domain without
27403 making new connections, until the domain record times out. There are two
27404 separate expiry times for domain cache records:
27405 &%callout_domain_negative_expire%& (default 3h) and
27406 &%callout_domain_positive_expire%& (default 7d).
27407
27408 Domain records expire when the negative expiry time is reached if callouts
27409 cannot be made for the domain, or if the postmaster check failed.
27410 Otherwise, they expire when the positive expiry time is reached. This
27411 ensures that, for example, a host that stops accepting &"random"& local parts
27412 will eventually be noticed.
27413
27414 The callout caching mechanism is based on the domain of the address that is
27415 being tested. If the domain routes to several hosts, it is assumed that their
27416 behaviour will be the same.
27417
27418
27419
27420 .section "Sender address verification reporting" "SECTsenaddver"
27421 .cindex "verifying" "suppressing error details"
27422 See section &<<SECTaddressverification>>& for a general discussion of
27423 verification. When sender verification fails in an ACL, the details of the
27424 failure are given as additional output lines before the 550 response to the
27425 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
27426 you might see:
27427 .code
27428 MAIL FROM:<xyz@abc.example>
27429 250 OK
27430 RCPT TO:<pqr@def.example>
27431 550-Verification failed for <xyz@abc.example>
27432 550-Called:   192.168.34.43
27433 550-Sent:     RCPT TO:<xyz@abc.example>
27434 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
27435 550 Sender verification failed
27436 .endd
27437 If more than one RCPT command fails in the same way, the details are given
27438 only for the first of them. However, some administrators do not want to send
27439 out this much information. You can suppress the details by adding
27440 &`/no_details`& to the ACL statement that requests sender verification. For
27441 example:
27442 .code
27443 verify = sender/no_details
27444 .endd
27445
27446 .section "Redirection while verifying" "SECTredirwhilveri"
27447 .cindex "verifying" "redirection while"
27448 .cindex "address redirection" "while verifying"
27449 A dilemma arises when a local address is redirected by aliasing or forwarding
27450 during verification: should the generated addresses themselves be verified,
27451 or should the successful expansion of the original address be enough to verify
27452 it? By default, Exim takes the following pragmatic approach:
27453
27454 .ilist
27455 When an incoming address is redirected to just one child address, verification
27456 continues with the child address, and if that fails to verify, the original
27457 verification also fails.
27458 .next
27459 When an incoming address is redirected to more than one child address,
27460 verification does not continue. A success result is returned.
27461 .endlist
27462
27463 This seems the most reasonable behaviour for the common use of aliasing as a
27464 way of redirecting different local parts to the same mailbox. It means, for
27465 example, that a pair of alias entries of the form
27466 .code
27467 A.Wol:   aw123
27468 aw123:   :fail: Gone away, no forwarding address
27469 .endd
27470 work as expected, with both local parts causing verification failure. When a
27471 redirection generates more than one address, the behaviour is more like a
27472 mailing list, where the existence of the alias itself is sufficient for
27473 verification to succeed.
27474
27475 It is possible, however, to change the default behaviour so that all successful
27476 redirections count as successful verifications, however many new addresses are
27477 generated. This is specified by the &%success_on_redirect%& verification
27478 option. For example:
27479 .code
27480 require verify = recipient/success_on_redirect/callout=10s
27481 .endd
27482 In this example, verification succeeds if a router generates a new address, and
27483 the callout does not occur, because no address was routed to a remote host.
27484
27485 When verification is being tested via the &%-bv%& option, the treatment of
27486 redirections is as just described, unless the &%-v%& or any debugging option is
27487 also specified. In that case, full verification is done for every generated
27488 address and a report is output for each of them.
27489
27490
27491
27492 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
27493 .cindex "CSA" "verifying"
27494 Client SMTP Authorization is a system that allows a site to advertise
27495 which machines are and are not permitted to send email. This is done by placing
27496 special SRV records in the DNS; these are looked up using the client's HELO
27497 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
27498 Authorization checks in Exim are performed by the ACL condition:
27499 .code
27500 verify = csa
27501 .endd
27502 This fails if the client is not authorized. If there is a DNS problem, or if no
27503 valid CSA SRV record is found, or if the client is authorized, the condition
27504 succeeds. These three cases can be distinguished using the expansion variable
27505 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
27506 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
27507 be likely to cause problems for legitimate email.
27508
27509 The error messages produced by the CSA code include slightly more
27510 detail. If &$csa_status$& is &"defer"&, this may be because of problems
27511 looking up the CSA SRV record, or problems looking up the CSA target
27512 address record. There are four reasons for &$csa_status$& being &"fail"&:
27513
27514 .ilist
27515 The client's host name is explicitly not authorized.
27516 .next
27517 The client's IP address does not match any of the CSA target IP addresses.
27518 .next
27519 The client's host name is authorized but it has no valid target IP addresses
27520 (for example, the target's addresses are IPv6 and the client is using IPv4).
27521 .next
27522 The client's host name has no CSA SRV record but a parent domain has asserted
27523 that all subdomains must be explicitly authorized.
27524 .endlist
27525
27526 The &%csa%& verification condition can take an argument which is the domain to
27527 use for the DNS query. The default is:
27528 .code
27529 verify = csa/$sender_helo_name
27530 .endd
27531 This implementation includes an extension to CSA. If the query domain
27532 is an address literal such as [192.0.2.95], or if it is a bare IP
27533 address, Exim searches for CSA SRV records in the reverse DNS as if
27534 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
27535 meaningful to say:
27536 .code
27537 verify = csa/$sender_host_address
27538 .endd
27539 In fact, this is the check that Exim performs if the client does not say HELO.
27540 This extension can be turned off by setting the main configuration option
27541 &%dns_csa_use_reverse%& to be false.
27542
27543 If a CSA SRV record is not found for the domain itself, a search
27544 is performed through its parent domains for a record which might be
27545 making assertions about subdomains. The maximum depth of this search is limited
27546 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
27547 default. Exim does not look for CSA SRV records in a top level domain, so the
27548 default settings handle HELO domains as long as seven
27549 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
27550 of legitimate HELO domains.
27551
27552 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
27553 direct SRV lookups, this is not sufficient because of the extra parent domain
27554 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
27555 addresses into lookups in the reverse DNS space. The result of a successful
27556 lookup such as:
27557 .code
27558 ${lookup dnsdb {csa=$sender_helo_name}}
27559 .endd
27560 has two space-separated fields: an authorization code and a target host name.
27561 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
27562 authorization required but absent, or &"?"& for unknown.
27563
27564
27565
27566
27567 .section "Bounce address tag validation" "SECTverifyPRVS"
27568 .cindex "BATV, verifying"
27569 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
27570 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
27571 Genuine incoming bounce messages should therefore always be addressed to
27572 recipients that have a valid tag. This scheme is a way of detecting unwanted
27573 bounce messages caused by sender address forgeries (often called &"collateral
27574 spam"&), because the recipients of such messages do not include valid tags.
27575
27576 There are two expansion items to help with the implementation of the BATV
27577 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
27578 the original envelope sender address by using a simple key to add a hash of the
27579 address and some time-based randomizing information. The &%prvs%& expansion
27580 item creates a signed address, and the &%prvscheck%& expansion item checks one.
27581 The syntax of these expansion items is described in section
27582 &<<SECTexpansionitems>>&.
27583
27584 As an example, suppose the secret per-address keys are stored in an MySQL
27585 database. A query to look up the key for an address could be defined as a macro
27586 like this:
27587 .code
27588 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
27589                 WHERE sender='${quote_mysql:$prvscheck_address}'\
27590                 }{$value}}
27591 .endd
27592 Suppose also that the senders who make use of BATV are defined by an address
27593 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
27594 use this:
27595 .code
27596 # Bounces: drop unsigned addresses for BATV senders
27597 deny message = This address does not send an unsigned reverse path
27598      senders = :
27599      recipients = +batv_senders
27600
27601 # Bounces: In case of prvs-signed address, check signature.
27602 deny message = Invalid reverse path signature.
27603      senders = :
27604      condition  = ${prvscheck {$local_part@$domain}\
27605                   {PRVSCHECK_SQL}{1}}
27606      !condition = $prvscheck_result
27607 .endd
27608 The first statement rejects recipients for bounce messages that are addressed
27609 to plain BATV sender addresses, because it is known that BATV senders do not
27610 send out messages with plain sender addresses. The second statement rejects
27611 recipients that are prvs-signed, but with invalid signatures (either because
27612 the key is wrong, or the signature has timed out).
27613
27614 A non-prvs-signed address is not rejected by the second statement, because the
27615 &%prvscheck%& expansion yields an empty string if its first argument is not a
27616 prvs-signed address, thus causing the &%condition%& condition to be false. If
27617 the first argument is a syntactically valid prvs-signed address, the yield is
27618 the third string (in this case &"1"&), whether or not the cryptographic and
27619 timeout checks succeed. The &$prvscheck_result$& variable contains the result
27620 of the checks (empty for failure, &"1"& for success).
27621
27622 There is one more issue you must consider when implementing prvs-signing:
27623 you have to ensure that the routers accept prvs-signed addresses and
27624 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
27625 router to remove the signature with a configuration along these lines:
27626 .code
27627 batv_redirect:
27628   driver = redirect
27629   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
27630 .endd
27631 This works because, if the third argument of &%prvscheck%& is empty, the result
27632 of the expansion of a prvs-signed address is the decoded value of the original
27633 address. This router should probably be the first of your routers that handles
27634 local addresses.
27635
27636 To create BATV-signed addresses in the first place, a transport of this form
27637 can be used:
27638 .code
27639 external_smtp_batv:
27640   driver = smtp
27641   return_path = ${prvs {$return_path} \
27642                        {${lookup mysql{SELECT \
27643                        secret FROM batv_prvs WHERE \
27644                        sender='${quote_mysql:$sender_address}'} \
27645                        {$value}fail}}}
27646 .endd
27647 If no key can be found for the existing return path, no signing takes place.
27648
27649
27650
27651 .section "Using an ACL to control relaying" "SECTrelaycontrol"
27652 .cindex "&ACL;" "relay control"
27653 .cindex "relaying" "control by ACL"
27654 .cindex "policy control" "relay control"
27655 An MTA is said to &'relay'& a message if it receives it from some host and
27656 delivers it directly to another host as a result of a remote address contained
27657 within it. Redirecting a local address via an alias or forward file and then
27658 passing the message on to another host is not relaying,
27659 .cindex "&""percent hack""&"
27660 but a redirection as a result of the &"percent hack"& is.
27661
27662 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
27663 A host which is acting as a gateway or an MX backup is concerned with incoming
27664 relaying from arbitrary hosts to a specific set of domains. On the other hand,
27665 a host which is acting as a smart host for a number of clients is concerned
27666 with outgoing relaying from those clients to the Internet at large. Often the
27667 same host is fulfilling both functions,
27668 . ///
27669 . as illustrated in the diagram below,
27670 . ///
27671 but in principle these two kinds of relaying are entirely independent. What is
27672 not wanted is the transmission of mail from arbitrary remote hosts through your
27673 system to arbitrary domains.
27674
27675
27676 You can implement relay control by means of suitable statements in the ACL that
27677 runs for each RCPT command. For convenience, it is often easiest to use
27678 Exim's named list facility to define the domains and hosts involved. For
27679 example, suppose you want to do the following:
27680
27681 .ilist
27682 Deliver a number of domains to mailboxes on the local host (or process them
27683 locally in some other way). Let's say these are &'my.dom1.example'& and
27684 &'my.dom2.example'&.
27685 .next
27686 Relay mail for a number of other domains for which you are the secondary MX.
27687 These might be &'friend1.example'& and &'friend2.example'&.
27688 .next
27689 Relay mail from the hosts on your local LAN, to whatever domains are involved.
27690 Suppose your LAN is 192.168.45.0/24.
27691 .endlist
27692
27693
27694 In the main part of the configuration, you put the following definitions:
27695 .code
27696 domainlist local_domains = my.dom1.example : my.dom2.example
27697 domainlist relay_domains = friend1.example : friend2.example
27698 hostlist   relay_hosts   = 192.168.45.0/24
27699 .endd
27700 Now you can use these definitions in the ACL that is run for every RCPT
27701 command:
27702 .code
27703 acl_check_rcpt:
27704   accept domains = +local_domains : +relay_domains
27705   accept hosts   = +relay_hosts
27706 .endd
27707 The first statement accepts any RCPT command that contains an address in
27708 the local or relay domains. For any other domain, control passes to the second
27709 statement, which accepts the command only if it comes from one of the relay
27710 hosts. In practice, you will probably want to make your ACL more sophisticated
27711 than this, for example, by including sender and recipient verification. The
27712 default configuration includes a more comprehensive example, which is described
27713 in chapter &<<CHAPdefconfil>>&.
27714
27715
27716
27717 .section "Checking a relay configuration" "SECTcheralcon"
27718 .cindex "relaying" "checking control of"
27719 You can check the relay characteristics of your configuration in the same way
27720 that you can test any ACL behaviour for an incoming SMTP connection, by using
27721 the &%-bh%& option to run a fake SMTP session with which you interact.
27722
27723 For specifically testing for unwanted relaying, the host
27724 &'relay-test.mail-abuse.org'& provides a useful service. If you telnet to this
27725 host from the host on which Exim is running, using the normal telnet port, you
27726 will see a normal telnet connection message and then quite a long delay. Be
27727 patient. The remote host is making an SMTP connection back to your host, and
27728 trying a number of common probes to test for open relay vulnerability. The
27729 results of the tests will eventually appear on your terminal.
27730 .ecindex IIDacl
27731
27732
27733
27734 . ////////////////////////////////////////////////////////////////////////////
27735 . ////////////////////////////////////////////////////////////////////////////
27736
27737 .chapter "Content scanning at ACL time" "CHAPexiscan"
27738 .scindex IIDcosca "content scanning" "at ACL time"
27739 The extension of Exim to include content scanning at ACL time, formerly known
27740 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
27741 was integrated into the main source for Exim release 4.50, and Tom continues to
27742 maintain it. Most of the wording of this chapter is taken from Tom's
27743 specification.
27744
27745 It is also possible to scan the content of messages at other times. The
27746 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
27747 scanning after all the ACLs have run. A transport filter can be used to scan
27748 messages at delivery time (see the &%transport_filter%& option, described in
27749 chapter &<<CHAPtransportgeneric>>&).
27750
27751 If you want to include the ACL-time content-scanning features when you compile
27752 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
27753 &_Local/Makefile_&. When you do that, the Exim binary is built with:
27754
27755 .ilist
27756 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
27757 for all MIME parts for SMTP and non-SMTP messages, respectively.
27758 .next
27759 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
27760 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
27761 run at the end of message reception (the &%acl_smtp_data%& ACL).
27762 .next
27763 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
27764 of messages, or parts of messages, for debugging purposes.
27765 .next
27766 Additional expansion variables that are set in the new ACL and by the new
27767 conditions.
27768 .next
27769 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
27770 .endlist
27771
27772 There is another content-scanning configuration option for &_Local/Makefile_&,
27773 called WITH_OLD_DEMIME. If this is set, the old, deprecated &%demime%& ACL
27774 condition is compiled, in addition to all the other content-scanning features.
27775
27776 Content-scanning is continually evolving, and new features are still being
27777 added. While such features are still unstable and liable to incompatible
27778 changes, they are made available in Exim by setting options whose names begin
27779 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
27780 this manual. You can find out about them by reading the file called
27781 &_doc/experimental.txt_&.
27782
27783 All the content-scanning facilities work on a MBOX copy of the message that is
27784 temporarily created in a file called:
27785 .display
27786 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
27787 .endd
27788 The &_.eml_& extension is a friendly hint to virus scanners that they can
27789 expect an MBOX-like structure inside that file. The file is created when the
27790 first content scanning facility is called. Subsequent calls to content
27791 scanning conditions open the same file again. The directory is recursively
27792 removed when the &%acl_smtp_data%& ACL has finished running, unless
27793 .code
27794 control = no_mbox_unspool
27795 .endd
27796 has been encountered. When the MIME ACL decodes files, they are put into the
27797 same directory by default.
27798
27799
27800
27801 .section "Scanning for viruses" "SECTscanvirus"
27802 .cindex "virus scanning"
27803 .cindex "content scanning" "for viruses"
27804 .cindex "content scanning" "the &%malware%& condition"
27805 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
27806 It supports a &"generic"& interface to scanners called via the shell, and
27807 specialized interfaces for &"daemon"& type virus scanners, which are resident
27808 in memory and thus are much faster.
27809
27810 .oindex "&%av_scanner%&"
27811 You can set the &%av_scanner%& option in first part of the Exim configuration
27812 file to specify which scanner to use, together with any additional options that
27813 are needed. The basic syntax is as follows:
27814 .display
27815 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
27816 .endd
27817 If you do not set &%av_scanner%&, it defaults to
27818 .code
27819 av_scanner = sophie:/var/run/sophie
27820 .endd
27821 If the value of &%av_scanner%& starts with dollar character, it is expanded
27822 before use. The following scanner types are supported in this release:
27823
27824 .vlist
27825 .vitem &%aveserver%&
27826 .cindex "virus scanners" "Kaspersky"
27827 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
27828 at &url(http://www.kaspersky.com). This scanner type takes one option,
27829 which is the path to the daemon's UNIX socket. The default is shown in this
27830 example:
27831 .code
27832 av_scanner = aveserver:/var/run/aveserver
27833 .endd
27834
27835 .vitem &%clamd%&
27836 .cindex "virus scanners" "clamd"
27837 This daemon-type scanner is GPL and free. You can get it at
27838 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
27839 unpack MIME containers, so it used to be recommended to unpack MIME attachments
27840 in the MIME ACL. This no longer believed to be necessary. One option is
27841 required: either the path and name of a UNIX socket file, or a hostname or IP
27842 number, and a port, separated by space, as in the second of these examples:
27843 .code
27844 av_scanner = clamd:/opt/clamd/socket
27845 av_scanner = clamd:192.168.2.100 1234
27846 .endd
27847 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
27848 contributing the code for this scanner.
27849
27850 .vitem &%cmdline%&
27851 .cindex "virus scanners" "command line interface"
27852 This is the keyword for the generic command line scanner interface. It can be
27853 used to attach virus scanners that are invoked from the shell. This scanner
27854 type takes 3 mandatory options:
27855
27856 .olist
27857 The full path and name of the scanner binary, with all command line options,
27858 and a placeholder (&`%s`&) for the directory to scan.
27859
27860 .next
27861 A regular expression to match against the STDOUT and STDERR output of the
27862 virus scanner. If the expression matches, a virus was found. You must make
27863 absolutely sure that this expression matches on &"virus found"&. This is called
27864 the &"trigger"& expression.
27865
27866 .next
27867 Another regular expression, containing exactly one pair of parentheses, to
27868 match the name of the virus found in the scanners output. This is called the
27869 &"name"& expression.
27870 .endlist olist
27871
27872 For example, Sophos Sweep reports a virus on a line like this:
27873 .code
27874 Virus 'W32/Magistr-B' found in file ./those.bat
27875 .endd
27876 For the trigger expression, we can match the phrase &"found in file"&. For the
27877 name expression, we want to extract the W32/Magistr-B string, so we can match
27878 for the single quotes left and right of it. Altogether, this makes the
27879 configuration setting:
27880 .code
27881 av_scanner = cmdline:\
27882              /path/to/sweep -ss -all -rec -archive %s:\
27883              found in file:'(.+)'
27884 .endd
27885 .vitem &%drweb%&
27886 .cindex "virus scanners" "DrWeb"
27887 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface takes one
27888 argument, either a full path to a UNIX socket, or an IP address and port
27889 separated by white space, as in these examples:
27890 .code
27891 av_scanner = drweb:/var/run/drwebd.sock
27892 av_scanner = drweb:192.168.2.20 31337
27893 .endd
27894 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
27895 is used. Thanks to Alex Miller for contributing the code for this scanner.
27896
27897 .vitem &%fsecure%&
27898 .cindex "virus scanners" "F-Secure"
27899 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
27900 argument which is the path to a UNIX socket. For example:
27901 .code
27902 av_scanner = fsecure:/path/to/.fsav
27903 .endd
27904 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
27905 Thelmen for contributing the code for this scanner.
27906
27907 .vitem &%kavdaemon%&
27908 .cindex "virus scanners" "Kaspersky"
27909 This is the scanner daemon of Kaspersky Version 4. This version of the
27910 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
27911 scanner type takes one option, which is the path to the daemon's UNIX socket.
27912 For example:
27913 .code
27914 av_scanner = kavdaemon:/opt/AVP/AvpCtl
27915 .endd
27916 The default path is &_/var/run/AvpCtl_&.
27917
27918 .vitem &%mksd%&
27919 .cindex "virus scanners" "mksd"
27920 This is a daemon type scanner that is aimed mainly at Polish users, though some
27921 parts of documentation are now available in English. You can get it at
27922 &url(http://linux.mks.com.pl/). The only option for this scanner type is
27923 the maximum number of processes used simultaneously to scan the attachments,
27924 provided that the demime facility is employed and also provided that mksd has
27925 been run with at least the same number of child processes. For example:
27926 .code
27927 av_scanner = mksd:2
27928 .endd
27929 You can safely omit this option (the default value is 1).
27930
27931 .vitem &%sophie%&
27932 .cindex "virus scanners" "Sophos and Sophie"
27933 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
27934 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
27935 for this scanner type is the path to the UNIX socket that Sophie uses for
27936 client communication. For example:
27937 .code
27938 av_scanner = sophie:/tmp/sophie
27939 .endd
27940 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
27941 the option.
27942 .endlist
27943
27944 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
27945 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
27946 ACL.
27947
27948 The &%av_scanner%& option is expanded each time &%malware%& is called. This
27949 makes it possible to use different scanners. See further below for an example.
27950 The &%malware%& condition caches its results, so when you use it multiple times
27951 for the same message, the actual scanning process is only carried out once.
27952 However, using expandable items in &%av_scanner%& disables this caching, in
27953 which case each use of the &%malware%& condition causes a new scan of the
27954 message.
27955
27956 The &%malware%& condition takes a right-hand argument that is expanded before
27957 use. It can then be one of
27958
27959 .ilist
27960 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
27961 The condition succeeds if a virus was found, and fail otherwise. This is the
27962 recommended usage.
27963 .next
27964 &"false"& or &"0"& or an empty string, in which case no scanning is done and
27965 the condition fails immediately.
27966 .next
27967 A regular expression, in which case the message is scanned for viruses. The
27968 condition succeeds if a virus is found and its name matches the regular
27969 expression. This allows you to take special actions on certain types of virus.
27970 .endlist
27971
27972 You can append &`/defer_ok`& to the &%malware%& condition to accept messages
27973 even if there is a problem with the virus scanner. Otherwise, such a problem
27974 causes the ACL to defer.
27975
27976 .vindex "&$malware_name$&"
27977 When a virus is found, the condition sets up an expansion variable called
27978 &$malware_name$& that contains the name of the virus. You can use it in a
27979 &%message%& modifier that specifies the error returned to the sender, and/or in
27980 logging data.
27981
27982 If your virus scanner cannot unpack MIME and TNEF containers itself, you should
27983 use the &%demime%& condition (see section &<<SECTdemimecond>>&) before the
27984 &%malware%& condition.
27985
27986 Here is a very simple scanning example:
27987 .code
27988 deny message = This message contains malware ($malware_name)
27989      demime = *
27990      malware = *
27991 .endd
27992 The next example accepts messages when there is a problem with the scanner:
27993 .code
27994 deny message = This message contains malware ($malware_name)
27995      demime = *
27996      malware = */defer_ok
27997 .endd
27998 The next example shows how to use an ACL variable to scan with both sophie and
27999 aveserver. It assumes you have set:
28000 .code
28001 av_scanner = $acl_m0
28002 .endd
28003 in the main Exim configuration.
28004 .code
28005 deny message = This message contains malware ($malware_name)
28006      set acl_m0 = sophie
28007      malware = *
28008
28009 deny message = This message contains malware ($malware_name)
28010      set acl_m0 = aveserver
28011      malware = *
28012 .endd
28013
28014
28015 .section "Scanning with SpamAssassin" "SECTscanspamass"
28016 .cindex "content scanning" "for spam"
28017 .cindex "spam scanning"
28018 .cindex "SpamAssassin"
28019 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
28020 score and a report for the message. You can get SpamAssassin at
28021 &url(http://www.spamassassin.org), or, if you have a working Perl
28022 installation, you can use CPAN by running:
28023 .code
28024 perl -MCPAN -e 'install Mail::SpamAssassin'
28025 .endd
28026 SpamAssassin has its own set of configuration files. Please review its
28027 documentation to see how you can tweak it. The default installation should work
28028 nicely, however.
28029
28030 .oindex "&%spamd_address%&"
28031 After having installed and configured SpamAssassin, start the &%spamd%& daemon.
28032 By default, it listens on 127.0.0.1, TCP port 783. If you use another host or
28033 port for &%spamd%&, you must set the &%spamd_address%& option in the global
28034 part of the Exim configuration as follows (example):
28035 .code
28036 spamd_address = 192.168.99.45 387
28037 .endd
28038 You do not need to set this option if you use the default. As of version 2.60,
28039 &%spamd%& also supports communication over UNIX sockets. If you want to use
28040 these, supply &%spamd_address%& with an absolute file name instead of a
28041 address/port pair:
28042 .code
28043 spamd_address = /var/run/spamd_socket
28044 .endd
28045 You can have multiple &%spamd%& servers to improve scalability. These can
28046 reside on other hardware reachable over the network. To specify multiple
28047 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
28048 option, separated with colons:
28049 .code
28050 spamd_address = 192.168.2.10 783 : \
28051                 192.168.2.11 783 : \
28052                 192.168.2.12 783
28053 .endd
28054 Up to 32 &%spamd%& servers are supported. The servers are queried in a random
28055 fashion. When a server fails to respond to the connection attempt, all other
28056 servers are tried until one succeeds. If no server responds, the &%spam%&
28057 condition defers.
28058
28059 &*Warning*&: It is not possible to use the UNIX socket connection method with
28060 multiple &%spamd%& servers.
28061
28062 The &%spamd_address%& variable is expanded before use if it starts with
28063 a dollar sign. In this case, the expansion may return a string that is
28064 used as the list so that multiple spamd servers can be the result of an
28065 expansion.
28066
28067 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
28068 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
28069 .code
28070 deny message = This message was classified as SPAM
28071      spam = joe
28072 .endd
28073 The right-hand side of the &%spam%& condition specifies a name. This is
28074 relevant if you have set up multiple SpamAssassin profiles. If you do not want
28075 to scan using a specific profile, but rather use the SpamAssassin system-wide
28076 default profile, you can scan for an unknown name, or simply use &"nobody"&.
28077 However, you must put something on the right-hand side.
28078
28079 The name allows you to use per-domain or per-user antispam profiles in
28080 principle, but this is not straightforward in practice, because a message may
28081 have multiple recipients, not necessarily all in the same domain. Because the
28082 &%spam%& condition has to be called from a DATA ACL in order to be able to
28083 read the contents of the message, the variables &$local_part$& and &$domain$&
28084 are not set.
28085
28086 The right-hand side of the &%spam%& condition is expanded before being used, so
28087 you can put lookups or conditions there. When the right-hand side evaluates to
28088 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
28089
28090
28091 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
28092 large ones may cause significant performance degradation. As most spam messages
28093 are quite small, it is recommended that you do not scan the big ones. For
28094 example:
28095 .code
28096 deny message = This message was classified as SPAM
28097      condition = ${if < {$message_size}{10K}}
28098      spam = nobody
28099 .endd
28100
28101 The &%spam%& condition returns true if the threshold specified in the user's
28102 SpamAssassin profile has been matched or exceeded. If you want to use the
28103 &%spam%& condition for its side effects (see the variables below), you can make
28104 it always return &"true"& by appending &`:true`& to the username.
28105
28106 .cindex "spam scanning" "returned variables"
28107 When the &%spam%& condition is run, it sets up a number of expansion
28108 variables. With the exception of &$spam_score_int$&, these are usable only
28109 within ACLs; their values are not retained with the message and so cannot be
28110 used at delivery time.
28111
28112 .vlist
28113 .vitem &$spam_score$&
28114 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
28115 for inclusion in log or reject messages.
28116
28117 .vitem &$spam_score_int$&
28118 The spam score of the message, multiplied by ten, as an integer value. For
28119 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
28120 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
28121 The integer value is useful for numeric comparisons in
28122 conditions. This variable is special; its value is saved with the message, and
28123 written to Exim's spool file. This means that it can be used during the whole
28124 life of the message on your Exim system, in particular, in routers or
28125 transports during the later delivery phase.
28126
28127 .vitem &$spam_bar$&
28128 A string consisting of a number of &"+"& or &"-"& characters, representing the
28129 integer part of the spam score value. A spam score of 4.4 would have a
28130 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
28131 headers, since MUAs can match on such strings.
28132
28133 .vitem &$spam_report$&
28134 A multiline text table, containing the full SpamAssassin report for the
28135 message. Useful for inclusion in headers or reject messages.
28136 .endlist
28137
28138 The &%spam%& condition caches its results unless expansion in
28139 spamd_address was used. If you call it again with the same user name, it
28140 does not scan again, but rather returns the same values as before.
28141
28142 The &%spam%& condition returns DEFER if there is any error while running
28143 the message through SpamAssassin or if the expansion of spamd_address
28144 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
28145 statement block), append &`/defer_ok`& to the right-hand side of the
28146 spam condition, like this:
28147 .code
28148 deny message = This message was classified as SPAM
28149      spam    = joe/defer_ok
28150 .endd
28151 This causes messages to be accepted even if there is a problem with &%spamd%&.
28152
28153 Here is a longer, commented example of the use of the &%spam%&
28154 condition:
28155 .code
28156 # put headers in all messages (no matter if spam or not)
28157 warn  spam = nobody:true
28158       add_header = X-Spam-Score: $spam_score ($spam_bar)
28159       add_header = X-Spam-Report: $spam_report
28160
28161 # add second subject line with *SPAM* marker when message
28162 # is over threshold
28163 warn  spam = nobody
28164       add_header = Subject: *SPAM* $h_Subject:
28165
28166 # reject spam at high scores (> 12)
28167 deny  message = This message scored $spam_score spam points.
28168       spam = nobody:true
28169       condition = ${if >{$spam_score_int}{120}{1}{0}}
28170 .endd
28171
28172
28173
28174 .section "Scanning MIME parts" "SECTscanmimepart"
28175 .cindex "content scanning" "MIME parts"
28176 .cindex "MIME content scanning"
28177 .oindex "&%acl_smtp_mime%&"
28178 .oindex "&%acl_not_smtp_mime%&"
28179 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
28180 each MIME part of an SMTP message, including multipart types, in the sequence
28181 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
28182 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
28183 options may both refer to the same ACL if you want the same processing in both
28184 cases.
28185
28186 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
28187 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
28188 the case of a non-SMTP message. However, a MIME ACL is called only if the
28189 message contains a &'Content-Type:'& header line. When a call to a MIME
28190 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
28191 result code is sent to the client. In the case of an SMTP message, the
28192 &%acl_smtp_data%& ACL is not called when this happens.
28193
28194 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
28195 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
28196 condition to match against the raw MIME part. You can also use the
28197 &%mime_regex%& condition to match against the decoded MIME part (see section
28198 &<<SECTscanregex>>&).
28199
28200 At the start of a MIME ACL, a number of variables are set from the header
28201 information for the relevant MIME part. These are described below. The contents
28202 of the MIME part are not by default decoded into a disk file except for MIME
28203 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
28204 part into a disk file, you can use the &%decode%& condition. The general
28205 syntax is:
28206 .display
28207 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
28208 .endd
28209 The right hand side is expanded before use. After expansion,
28210 the value can be:
28211
28212 .olist
28213 &"0"& or &"false"&, in which case no decoding is done.
28214 .next
28215 The string &"default"&. In that case, the file is put in the temporary
28216 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
28217 a sequential file name consisting of the message id and a sequence number. The
28218 full path and name is available in &$mime_decoded_filename$& after decoding.
28219 .next
28220 A full path name starting with a slash. If the full name is an existing
28221 directory, it is used as a replacement for the default directory. The filename
28222 is then sequentially assigned. If the path does not exist, it is used as
28223 the full path and file name.
28224 .next
28225 If the string does not start with a slash, it is used as the
28226 filename, and the default path is then used.
28227 .endlist
28228 The &%decode%& condition normally succeeds. It is only false for syntax
28229 errors or unusual circumstances such as memory shortages. You can easily decode
28230 a file with its original, proposed filename using
28231 .code
28232 decode = $mime_filename
28233 .endd
28234 However, you should keep in mind that &$mime_filename$& might contain
28235 anything. If you place files outside of the default path, they are not
28236 automatically unlinked.
28237
28238 For RFC822 attachments (these are messages attached to messages, with a
28239 content-type of &"message/rfc822"&), the ACL is called again in the same manner
28240 as for the primary message, only that the &$mime_is_rfc822$& expansion
28241 variable is set (see below). Attached messages are always decoded to disk
28242 before being checked, and the files are unlinked once the check is done.
28243
28244 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
28245 used to match regular expressions against raw and decoded MIME parts,
28246 respectively. They are described in section &<<SECTscanregex>>&.
28247
28248 .cindex "MIME content scanning" "returned variables"
28249 The following list describes all expansion variables that are
28250 available in the MIME ACL:
28251
28252 .vlist
28253 .vitem &$mime_boundary$&
28254 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
28255 have a boundary string, which is stored in this variable. If the current part
28256 has no boundary parameter in the &'Content-Type:'& header, this variable
28257 contains the empty string.
28258
28259 .vitem &$mime_charset$&
28260 This variable contains the character set identifier, if one was found in the
28261 &'Content-Type:'& header. Examples for charset identifiers are:
28262 .code
28263 us-ascii
28264 gb2312 (Chinese)
28265 iso-8859-1
28266 .endd
28267 Please note that this value is not normalized, so you should do matches
28268 case-insensitively.
28269
28270 .vitem &$mime_content_description$&
28271 This variable contains the normalized content of the &'Content-Description:'&
28272 header. It can contain a human-readable description of the parts content. Some
28273 implementations repeat the filename for attachments here, but they are usually
28274 only used for display purposes.
28275
28276 .vitem &$mime_content_disposition$&
28277 This variable contains the normalized content of the &'Content-Disposition:'&
28278 header. You can expect strings like &"attachment"& or &"inline"& here.
28279
28280 .vitem &$mime_content_id$&
28281 This variable contains the normalized content of the &'Content-ID:'& header.
28282 This is a unique ID that can be used to reference a part from another part.
28283
28284 .vitem &$mime_content_size$&
28285 This variable is set only after the &%decode%& modifier (see above) has been
28286 successfully run. It contains the size of the decoded part in kilobytes. The
28287 size is always rounded up to full kilobytes, so only a completely empty part
28288 has a &$mime_content_size$& of zero.
28289
28290 .vitem &$mime_content_transfer_encoding$&
28291 This variable contains the normalized content of the
28292 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
28293 type. Typical values are &"base64"& and &"quoted-printable"&.
28294
28295 .vitem &$mime_content_type$&
28296 If the MIME part has a &'Content-Type:'& header, this variable contains its
28297 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
28298 are some examples of popular MIME types, as they may appear in this variable:
28299 .code
28300 text/plain
28301 text/html
28302 application/octet-stream
28303 image/jpeg
28304 audio/midi
28305 .endd
28306 If the MIME part has no &'Content-Type:'& header, this variable contains the
28307 empty string.
28308
28309 .vitem &$mime_decoded_filename$&
28310 This variable is set only after the &%decode%& modifier (see above) has been
28311 successfully run. It contains the full path and file name of the file
28312 containing the decoded data.
28313 .endlist
28314
28315 .cindex "RFC 2047"
28316 .vlist
28317 .vitem &$mime_filename$&
28318 This is perhaps the most important of the MIME variables. It contains a
28319 proposed filename for an attachment, if one was found in either the
28320 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
28321 RFC2047 decoded, but no additional sanity checks are done. If no filename was
28322 found, this variable contains the empty string.
28323
28324 .vitem &$mime_is_coverletter$&
28325 This variable attempts to differentiate the &"cover letter"& of an e-mail from
28326 attached data. It can be used to clamp down on flashy or unnecessarily encoded
28327 content in the cover letter, while not restricting attachments at all.
28328
28329 The variable contains 1 (true) for a MIME part believed to be part of the
28330 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
28331 follows:
28332
28333 .olist
28334 The outermost MIME part of a message is always a cover letter.
28335
28336 .next
28337 If a multipart/alternative or multipart/related MIME part is a cover letter,
28338 so are all MIME subparts within that multipart.
28339
28340 .next
28341 If any other multipart is a cover letter, the first subpart is a cover letter,
28342 and the rest are attachments.
28343
28344 .next
28345 All parts contained within an attachment multipart are attachments.
28346 .endlist olist
28347
28348 As an example, the following will ban &"HTML mail"& (including that sent with
28349 alternative plain text), while allowing HTML files to be attached. HTML
28350 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
28351 .code
28352 deny message = HTML mail is not accepted here
28353 !condition = $mime_is_rfc822
28354 condition = $mime_is_coverletter
28355 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
28356 .endd
28357 .vitem &$mime_is_multipart$&
28358 This variable has the value 1 (true) when the current part has the main type
28359 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
28360 Since multipart entities only serve as containers for other parts, you may not
28361 want to carry out specific actions on them.
28362
28363 .vitem &$mime_is_rfc822$&
28364 This variable has the value 1 (true) if the current part is not a part of the
28365 checked message itself, but part of an attached message. Attached message
28366 decoding is fully recursive.
28367
28368 .vitem &$mime_part_count$&
28369 This variable is a counter that is raised for each processed MIME part. It
28370 starts at zero for the very first part (which is usually a multipart). The
28371 counter is per-message, so it is reset when processing RFC822 attachments (see
28372 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
28373 complete, so you can use it in the DATA ACL to determine the number of MIME
28374 parts of a message. For non-MIME messages, this variable contains the value -1.
28375 .endlist
28376
28377
28378
28379 .section "Scanning with regular expressions" "SECTscanregex"
28380 .cindex "content scanning" "with regular expressions"
28381 .cindex "regular expressions" "content scanning with"
28382 You can specify your own custom regular expression matches on the full body of
28383 the message, or on individual MIME parts.
28384
28385 The &%regex%& condition takes one or more regular expressions as arguments and
28386 matches them against the full message (when called in the DATA ACL) or a raw
28387 MIME part (when called in the MIME ACL). The &%regex%& condition matches
28388 linewise, with a maximum line length of 32K characters. That means you cannot
28389 have multiline matches with the &%regex%& condition.
28390
28391 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
28392 to 32K of decoded content (the whole content at once, not linewise). If the
28393 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
28394 is decoded automatically when &%mime_regex%& is executed (using default path
28395 and filename values). If the decoded data is larger than  32K, only the first
28396 32K characters are checked.
28397
28398 The regular expressions are passed as a colon-separated list. To include a
28399 literal colon, you must double it. Since the whole right-hand side string is
28400 expanded before being used, you must also escape dollar signs and backslashes
28401 with more backslashes, or use the &`\N`& facility to disable expansion.
28402 Here is a simple example that contains two regular expressions:
28403 .code
28404 deny message = contains blacklisted regex ($regex_match_string)
28405      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
28406 .endd
28407 The conditions returns true if any one of the regular expressions matches. The
28408 &$regex_match_string$& expansion variable is then set up and contains the
28409 matching regular expression.
28410
28411 &*Warning*&: With large messages, these conditions can be fairly
28412 CPU-intensive.
28413
28414
28415
28416
28417 .section "The demime condition" "SECTdemimecond"
28418 .cindex "content scanning" "MIME checking"
28419 .cindex "MIME content scanning"
28420 The &%demime%& ACL condition provides MIME unpacking, sanity checking and file
28421 extension blocking. It is usable only in the DATA and non-SMTP ACLs. The
28422 &%demime%& condition uses a simpler interface to MIME decoding than the MIME
28423 ACL functionality, but provides no additional facilities. Please note that this
28424 condition is deprecated and kept only for backward compatibility. You must set
28425 the WITH_OLD_DEMIME option in &_Local/Makefile_& at build time to be able to
28426 use the &%demime%& condition.
28427
28428 The &%demime%& condition unpacks MIME containers in the message. It detects
28429 errors in MIME containers and can match file extensions found in the message
28430 against a list. Using this facility produces files containing the unpacked MIME
28431 parts of the message in the temporary scan directory. If you do antivirus
28432 scanning, it is recommended that you use the &%demime%& condition before the
28433 antivirus (&%malware%&) condition.
28434
28435 On the right-hand side of the &%demime%& condition you can pass a
28436 colon-separated list of file extensions that it should match against. For
28437 example:
28438 .code
28439 deny message = Found blacklisted file attachment
28440      demime  = vbs:com:bat:pif:prf:lnk
28441 .endd
28442 If one of the file extensions is found, the condition is true, otherwise it is
28443 false. If there is a temporary error while demimeing (for example, &"disk
28444 full"&), the condition defers, and the message is temporarily rejected (unless
28445 the condition is on a &%warn%& verb).
28446
28447 The right-hand side is expanded before being treated as a list, so you can have
28448 conditions and lookups there. If it expands to an empty string, &"false"&, or
28449 zero (&"0"&), no demimeing is done and the condition is false.
28450
28451 The &%demime%& condition set the following variables:
28452
28453 .vlist
28454 .vitem &$demime_errorlevel$&
28455 .vindex "&$demime_errorlevel$&"
28456 When an error is detected in a MIME container, this variable contains the
28457 severity of the error, as an integer number. The higher the value, the more
28458 severe the error (the current maximum value is 3). If this variable is unset or
28459 zero, no error occurred.
28460
28461 .vitem &$demime_reason$&
28462 .vindex "&$demime_reason$&"
28463 When &$demime_errorlevel$& is greater than zero, this variable contains a
28464 human-readable text string describing the MIME error that occurred.
28465 .endlist
28466
28467 .vlist
28468 .vitem &$found_extension$&
28469 .vindex "&$found_extension$&"
28470 When the &%demime%& condition is true, this variable contains the file
28471 extension it found.
28472 .endlist
28473
28474 Both &$demime_errorlevel$& and &$demime_reason$& are set by the first call of
28475 the &%demime%& condition, and are not changed on subsequent calls.
28476
28477 If you do not want to check for file extensions, but rather use the &%demime%&
28478 condition for unpacking or error checking purposes, pass &"*"& as the
28479 right-hand side value. Here is a more elaborate example of how to use this
28480 facility:
28481 .code
28482 # Reject messages with serious MIME container errors
28483 deny  message = Found MIME error ($demime_reason).
28484       demime = *
28485       condition = ${if >{$demime_errorlevel}{2}{1}{0}}
28486
28487 # Reject known virus spreading file extensions.
28488 # Accepting these is pretty much braindead.
28489 deny  message = contains $found_extension file (blacklisted).
28490       demime  = com:vbs:bat:pif:scr
28491
28492 # Freeze .exe and .doc files. Postmaster can
28493 # examine them and eventually thaw them.
28494 deny  log_message = Another $found_extension file.
28495       demime = exe:doc
28496       control = freeze
28497 .endd
28498 .ecindex IIDcosca
28499
28500
28501
28502
28503 . ////////////////////////////////////////////////////////////////////////////
28504 . ////////////////////////////////////////////////////////////////////////////
28505
28506 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
28507          "Local scan function"
28508 .scindex IIDlosca "&[local_scan()]& function" "description of"
28509 .cindex "customizing" "input scan using C function"
28510 .cindex "policy control" "by local scan function"
28511 In these days of email worms, viruses, and ever-increasing spam, some sites
28512 want to apply a lot of checking to messages before accepting them.
28513
28514 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
28515 passing messages to external virus and spam scanning software. You can also do
28516 a certain amount in Exim itself through string expansions and the &%condition%&
28517 condition in the ACL that runs after the SMTP DATA command or the ACL for
28518 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
28519
28520 To allow for further customization to a site's own requirements, there is the
28521 possibility of linking Exim with a private message scanning function, written
28522 in C. If you want to run code that is written in something other than C, you
28523 can of course use a little C stub to call it.
28524
28525 The local scan function is run once for every incoming message, at the point
28526 when Exim is just about to accept the message.
28527 It can therefore be used to control non-SMTP messages from local processes as
28528 well as messages arriving via SMTP.
28529
28530 Exim applies a timeout to calls of the local scan function, and there is an
28531 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
28532 Zero means &"no timeout"&.
28533 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
28534 before calling the local scan function, so that the most common types of crash
28535 are caught. If the timeout is exceeded or one of those signals is caught, the
28536 incoming message is rejected with a temporary error if it is an SMTP message.
28537 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
28538 code. The incident is logged on the main and reject logs.
28539
28540
28541
28542 .section "Building Exim to use a local scan function" "SECID207"
28543 .cindex "&[local_scan()]& function" "building Exim to use"
28544 To make use of the local scan function feature, you must tell Exim where your
28545 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
28546 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
28547 directory, so you might set
28548 .code
28549 LOCAL_SCAN_SOURCE=Local/local_scan.c
28550 .endd
28551 for example. The function must be called &[local_scan()]&. It is called by
28552 Exim after it has received a message, when the success return code is about to
28553 be sent. This is after all the ACLs have been run. The return code from your
28554 function controls whether the message is actually accepted or not. There is a
28555 commented template function (that just accepts the message) in the file
28556 _src/local_scan.c_.
28557
28558 If you want to make use of Exim's run time configuration file to set options
28559 for your &[local_scan()]& function, you must also set
28560 .code
28561 LOCAL_SCAN_HAS_OPTIONS=yes
28562 .endd
28563 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
28564
28565
28566
28567
28568 .section "API for local_scan()" "SECTapiforloc"
28569 .cindex "&[local_scan()]& function" "API description"
28570 You must include this line near the start of your code:
28571 .code
28572 #include "local_scan.h"
28573 .endd
28574 This header file defines a number of variables and other values, and the
28575 prototype for the function itself. Exim is coded to use unsigned char values
28576 almost exclusively, and one of the things this header defines is a shorthand
28577 for &`unsigned char`& called &`uschar`&.
28578 It also contains the following macro definitions, to simplify casting character
28579 strings and pointers to character strings:
28580 .code
28581 #define CS   (char *)
28582 #define CCS  (const char *)
28583 #define CSS  (char **)
28584 #define US   (unsigned char *)
28585 #define CUS  (const unsigned char *)
28586 #define USS  (unsigned char **)
28587 .endd
28588 The function prototype for &[local_scan()]& is:
28589 .code
28590 extern int local_scan(int fd, uschar **return_text);
28591 .endd
28592 The arguments are as follows:
28593
28594 .ilist
28595 &%fd%& is a file descriptor for the file that contains the body of the message
28596 (the -D file). The file is open for reading and writing, but updating it is not
28597 recommended. &*Warning*&: You must &'not'& close this file descriptor.
28598
28599 The descriptor is positioned at character 19 of the file, which is the first
28600 character of the body itself, because the first 19 characters are the message
28601 id followed by &`-D`& and a newline. If you rewind the file, you should use the
28602 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
28603 case this changes in some future version.
28604 .next
28605 &%return_text%& is an address which you can use to return a pointer to a text
28606 string at the end of the function. The value it points to on entry is NULL.
28607 .endlist
28608
28609 The function must return an &%int%& value which is one of the following macros:
28610
28611 .vlist
28612 .vitem &`LOCAL_SCAN_ACCEPT`&
28613 .vindex "&$local_scan_data$&"
28614 The message is accepted. If you pass back a string of text, it is saved with
28615 the message, and made available in the variable &$local_scan_data$&. No
28616 newlines are permitted (if there are any, they are turned into spaces) and the
28617 maximum length of text is 1000 characters.
28618
28619 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
28620 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
28621 queued without immediate delivery, and is frozen.
28622
28623 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
28624 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
28625 queued without immediate delivery.
28626
28627 .vitem &`LOCAL_SCAN_REJECT`&
28628 The message is rejected; the returned text is used as an error message which is
28629 passed back to the sender and which is also logged. Newlines are permitted &--
28630 they cause a multiline response for SMTP rejections, but are converted to
28631 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
28632 used.
28633
28634 .vitem &`LOCAL_SCAN_TEMPREJECT`&
28635 The message is temporarily rejected; the returned text is used as an error
28636 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
28637 problem"& is used.
28638
28639 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
28640 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
28641 message is not written to the reject log. It has the effect of unsetting the
28642 &%rejected_header%& log selector for just this rejection. If
28643 &%rejected_header%& is already unset (see the discussion of the
28644 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
28645 same as LOCAL_SCAN_REJECT.
28646
28647 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
28648 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
28649 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
28650 .endlist
28651
28652 If the message is not being received by interactive SMTP, rejections are
28653 reported by writing to &%stderr%& or by sending an email, as configured by the
28654 &%-oe%& command line options.
28655
28656
28657
28658 .section "Configuration options for local_scan()" "SECTconoptloc"
28659 .cindex "&[local_scan()]& function" "configuration options"
28660 It is possible to have option settings in the main configuration file
28661 that set values in static variables in the &[local_scan()]& module. If you
28662 want to do this, you must have the line
28663 .code
28664 LOCAL_SCAN_HAS_OPTIONS=yes
28665 .endd
28666 in your &_Local/Makefile_& when you build Exim. (This line is in
28667 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
28668 file, you must define static variables to hold the option values, and a table
28669 to define them.
28670
28671 The table must be a vector called &%local_scan_options%&, of type
28672 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
28673 and a pointer to the variable that holds the value. The entries must appear in
28674 alphabetical order. Following &%local_scan_options%& you must also define a
28675 variable called &%local_scan_options_count%& that contains the number of
28676 entries in the table. Here is a short example, showing two kinds of option:
28677 .code
28678 static int my_integer_option = 42;
28679 static uschar *my_string_option = US"a default string";
28680
28681 optionlist local_scan_options[] = {
28682   { "my_integer", opt_int,       &my_integer_option },
28683   { "my_string",  opt_stringptr, &my_string_option }
28684 };
28685
28686 int local_scan_options_count =
28687   sizeof(local_scan_options)/sizeof(optionlist);
28688 .endd
28689 The values of the variables can now be changed from Exim's runtime
28690 configuration file by including a local scan section as in this example:
28691 .code
28692 begin local_scan
28693 my_integer = 99
28694 my_string = some string of text...
28695 .endd
28696 The available types of option data are as follows:
28697
28698 .vlist
28699 .vitem &*opt_bool*&
28700 This specifies a boolean (true/false) option. The address should point to a
28701 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
28702 that are defined as &"1"& and &"0"&, respectively. If you want to detect
28703 whether such a variable has been set at all, you can initialize it to
28704 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
28705 values.)
28706
28707 .vitem &*opt_fixed*&
28708 This specifies a fixed point number, such as is used for load averages.
28709 The address should point to a variable of type &`int`&. The value is stored
28710 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
28711
28712 .vitem &*opt_int*&
28713 This specifies an integer; the address should point to a variable of type
28714 &`int`&. The value may be specified in any of the integer formats accepted by
28715 Exim.
28716
28717 .vitem &*opt_mkint*&
28718 This is the same as &%opt_int%&, except that when such a value is output in a
28719 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
28720 printed with the suffix K or M.
28721
28722 .vitem &*opt_octint*&
28723 This also specifies an integer, but the value is always interpreted as an
28724 octal integer, whether or not it starts with the digit zero, and it is
28725 always output in octal.
28726
28727 .vitem &*opt_stringptr*&
28728 This specifies a string value; the address must be a pointer to a
28729 variable that points to a string (for example, of type &`uschar *`&).
28730
28731 .vitem &*opt_time*&
28732 This specifies a time interval value. The address must point to a variable of
28733 type &`int`&. The value that is placed there is a number of seconds.
28734 .endlist
28735
28736 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
28737 out the values of all the &[local_scan()]& options.
28738
28739
28740
28741 .section "Available Exim variables" "SECID208"
28742 .cindex "&[local_scan()]& function" "available Exim variables"
28743 The header &_local_scan.h_& gives you access to a number of C variables. These
28744 are the only ones that are guaranteed to be maintained from release to release.
28745 Note, however, that you can obtain the value of any Exim expansion variable,
28746 including &$recipients$&, by calling &'expand_string()'&. The exported
28747 C variables are as follows:
28748
28749 .vlist
28750 .vitem &*int&~body_linecount*&
28751 This variable contains the number of lines in the message's body.
28752
28753 .vitem &*int&~body_zerocount*&
28754 This variable contains the number of binary zero bytes in the message's body.
28755
28756 .vitem &*unsigned&~int&~debug_selector*&
28757 This variable is set to zero when no debugging is taking place. Otherwise, it
28758 is a bitmap of debugging selectors. Two bits are identified for use in
28759 &[local_scan()]&; they are defined as macros:
28760
28761 .ilist
28762 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
28763 testing option that is not privileged &-- any caller may set it. All the
28764 other selector bits can be set only by admin users.
28765
28766 .next
28767 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
28768 by the &`+local_scan`& debug selector. It is not included in the default set
28769 of debugging bits.
28770 .endlist ilist
28771
28772 Thus, to write to the debugging output only when &`+local_scan`& has been
28773 selected, you should use code like this:
28774 .code
28775 if ((debug_selector & D_local_scan) != 0)
28776   debug_printf("xxx", ...);
28777 .endd
28778 .vitem &*uschar&~*expand_string_message*&
28779 After a failing call to &'expand_string()'& (returned value NULL), the
28780 variable &%expand_string_message%& contains the error message, zero-terminated.
28781
28782 .vitem &*header_line&~*header_list*&
28783 A pointer to a chain of header lines. The &%header_line%& structure is
28784 discussed below.
28785
28786 .vitem &*header_line&~*header_last*&
28787 A pointer to the last of the header lines.
28788
28789 .vitem &*uschar&~*headers_charset*&
28790 The value of the &%headers_charset%& configuration option.
28791
28792 .vitem &*BOOL&~host_checking*&
28793 This variable is TRUE during a host checking session that is initiated by the
28794 &%-bh%& command line option.
28795
28796 .vitem &*uschar&~*interface_address*&
28797 The IP address of the interface that received the message, as a string. This
28798 is NULL for locally submitted messages.
28799
28800 .vitem &*int&~interface_port*&
28801 The port on which this message was received. When testing with the &%-bh%&
28802 command line option, the value of this variable is -1 unless a port has been
28803 specified via the &%-oMi%& option.
28804
28805 .vitem &*uschar&~*message_id*&
28806 This variable contains Exim's message id for the incoming message (the value of
28807 &$message_exim_id$&) as a zero-terminated string.
28808
28809 .vitem &*uschar&~*received_protocol*&
28810 The name of the protocol by which the message was received.
28811
28812 .vitem &*int&~recipients_count*&
28813 The number of accepted recipients.
28814
28815 .vitem &*recipient_item&~*recipients_list*&
28816 .cindex "recipient" "adding in local scan"
28817 .cindex "recipient" "removing in local scan"
28818 The list of accepted recipients, held in a vector of length
28819 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
28820 can add additional recipients by calling &'receive_add_recipient()'& (see
28821 below). You can delete recipients by removing them from the vector and
28822 adjusting the value in &%recipients_count%&. In particular, by setting
28823 &%recipients_count%& to zero you remove all recipients. If you then return the
28824 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
28825 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
28826 and then call &'receive_add_recipient()'& as often as needed.
28827
28828 .vitem &*uschar&~*sender_address*&
28829 The envelope sender address. For bounce messages this is the empty string.
28830
28831 .vitem &*uschar&~*sender_host_address*&
28832 The IP address of the sending host, as a string. This is NULL for
28833 locally-submitted messages.
28834
28835 .vitem &*uschar&~*sender_host_authenticated*&
28836 The name of the authentication mechanism that was used, or NULL if the message
28837 was not received over an authenticated SMTP connection.
28838
28839 .vitem &*uschar&~*sender_host_name*&
28840 The name of the sending host, if known.
28841
28842 .vitem &*int&~sender_host_port*&
28843 The port on the sending host.
28844
28845 .vitem &*BOOL&~smtp_input*&
28846 This variable is TRUE for all SMTP input, including BSMTP.
28847
28848 .vitem &*BOOL&~smtp_batched_input*&
28849 This variable is TRUE for BSMTP input.
28850
28851 .vitem &*int&~store_pool*&
28852 The contents of this variable control which pool of memory is used for new
28853 requests. See section &<<SECTmemhanloc>>& for details.
28854 .endlist
28855
28856
28857 .section "Structure of header lines" "SECID209"
28858 The &%header_line%& structure contains the members listed below.
28859 You can add additional header lines by calling the &'header_add()'& function
28860 (see below). You can cause header lines to be ignored (deleted) by setting
28861 their type to *.
28862
28863
28864 .vlist
28865 .vitem &*struct&~header_line&~*next*&
28866 A pointer to the next header line, or NULL for the last line.
28867
28868 .vitem &*int&~type*&
28869 A code identifying certain headers that Exim recognizes. The codes are printing
28870 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
28871 Notice in particular that any header line whose type is * is not transmitted
28872 with the message. This flagging is used for header lines that have been
28873 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
28874 lines.) Effectively, * means &"deleted"&.
28875
28876 .vitem &*int&~slen*&
28877 The number of characters in the header line, including the terminating and any
28878 internal newlines.
28879
28880 .vitem &*uschar&~*text*&
28881 A pointer to the text of the header. It always ends with a newline, followed by
28882 a zero byte. Internal newlines are preserved.
28883 .endlist
28884
28885
28886
28887 .section "Structure of recipient items" "SECID210"
28888 The &%recipient_item%& structure contains these members:
28889
28890 .vlist
28891 .vitem &*uschar&~*address*&
28892 This is a pointer to the recipient address as it was received.
28893
28894 .vitem &*int&~pno*&
28895 This is used in later Exim processing when top level addresses are created by
28896 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
28897 and must always contain -1 at this stage.
28898
28899 .vitem &*uschar&~*errors_to*&
28900 If this value is not NULL, bounce messages caused by failing to deliver to the
28901 recipient are sent to the address it contains. In other words, it overrides the
28902 envelope sender for this one recipient. (Compare the &%errors_to%& generic
28903 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
28904 an unqualified address, Exim qualifies it using the domain from
28905 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
28906 is NULL for all recipients.
28907 .endlist
28908
28909
28910
28911 .section "Available Exim functions" "SECID211"
28912 .cindex "&[local_scan()]& function" "available Exim functions"
28913 The header &_local_scan.h_& gives you access to a number of Exim functions.
28914 These are the only ones that are guaranteed to be maintained from release to
28915 release:
28916
28917 .vlist
28918 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
28919        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
28920
28921 This function creates a child process that runs the command specified by
28922 &%argv%&. The environment for the process is specified by &%envp%&, which can
28923 be NULL if no environment variables are to be passed. A new umask is supplied
28924 for the process in &%newumask%&.
28925
28926 Pipes to the standard input and output of the new process are set up
28927 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
28928 standard error is cloned to the standard output. If there are any file
28929 descriptors &"in the way"& in the new process, they are closed. If the final
28930 argument is TRUE, the new process is made into a process group leader.
28931
28932 The function returns the pid of the new process, or -1 if things go wrong.
28933
28934 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
28935 This function waits for a child process to terminate, or for a timeout (in
28936 seconds) to expire. A timeout value of zero means wait as long as it takes. The
28937 return value is as follows:
28938
28939 .ilist
28940 >= 0
28941
28942 The process terminated by a normal exit and the value is the process
28943 ending status.
28944
28945 .next
28946 < 0 and > &--256
28947
28948 The process was terminated by a signal and the value is the negation of the
28949 signal number.
28950
28951 .next
28952 &--256
28953
28954 The process timed out.
28955 .next
28956 &--257
28957
28958 The was some other error in wait(); &%errno%& is still set.
28959 .endlist
28960
28961 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
28962 This function provide you with a means of submitting a new message to
28963 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
28964 want, but this packages it all up for you.) The function creates a pipe,
28965 forks a subprocess that is running
28966 .code
28967 exim -t -oem -oi -f <>
28968 .endd
28969 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
28970 that is connected to the standard input. The yield of the function is the PID
28971 of the subprocess. You can then write a message to the file descriptor, with
28972 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
28973
28974 When you have finished, call &'child_close()'& to wait for the process to
28975 finish and to collect its ending status. A timeout value of zero is usually
28976 fine in this circumstance. Unless you have made a mistake with the recipient
28977 addresses, you should get a return code of zero.
28978
28979
28980 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
28981        *sender_authentication)*&
28982 This function is a more sophisticated version of &'child_open()'&. The command
28983 that it runs is:
28984 .display
28985 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
28986 .endd
28987 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
28988
28989
28990 .vitem &*void&~debug_printf(char&~*,&~...)*&
28991 This is Exim's debugging function, with arguments as for &'(printf()'&. The
28992 output is written to the standard error stream. If no debugging is selected,
28993 calls to &'debug_printf()'& have no effect. Normally, you should make calls
28994 conditional on the &`local_scan`& debug selector by coding like this:
28995 .code
28996 if ((debug_selector & D_local_scan) != 0)
28997   debug_printf("xxx", ...);
28998 .endd
28999
29000 .vitem &*uschar&~*expand_string(uschar&~*string)*&
29001 This is an interface to Exim's string expansion code. The return value is the
29002 expanded string, or NULL if there was an expansion failure.
29003 The C variable &%expand_string_message%& contains an error message after an
29004 expansion failure. If expansion does not change the string, the return value is
29005 the pointer to the input string. Otherwise, the return value points to a new
29006 block of memory that was obtained by a call to &'store_get()'&. See section
29007 &<<SECTmemhanloc>>& below for a discussion of memory handling.
29008
29009 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
29010 This function allows you to an add additional header line at the end of the
29011 existing ones. The first argument is the type, and should normally be a space
29012 character. The second argument is a format string and any number of
29013 substitution arguments as for &[sprintf()]&. You may include internal newlines
29014 if you want, and you must ensure that the string ends with a newline.
29015
29016 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
29017         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
29018 This function adds a new header line at a specified point in the header
29019 chain. The header itself is specified as for &'header_add()'&.
29020
29021 If &%name%& is NULL, the new header is added at the end of the chain if
29022 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
29023 NULL, the header lines are searched for the first non-deleted header that
29024 matches the name. If one is found, the new header is added before it if
29025 &%after%& is false. If &%after%& is true, the new header is added after the
29026 found header and any adjacent subsequent ones with the same name (even if
29027 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
29028 option controls where the header is added. If it is true, addition is at the
29029 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
29030 headers, or at the top if there are no &'Received:'& headers, you could use
29031 .code
29032 header_add_at_position(TRUE, US"Received", TRUE,
29033   ' ', "X-xxx: ...");
29034 .endd
29035 Normally, there is always at least one non-deleted &'Received:'& header, but
29036 there may not be if &%received_header_text%& expands to an empty string.
29037
29038
29039 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
29040 This function removes header lines. If &%occurrence%& is zero or negative, all
29041 occurrences of the header are removed. If occurrence is greater than zero, that
29042 particular instance of the header is removed. If no header(s) can be found that
29043 match the specification, the function does nothing.
29044
29045
29046 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
29047         int&~length,&~BOOL&~notdel)*&"
29048 This function tests whether the given header has the given name. It is not just
29049 a string comparison, because white space is permitted between the name and the
29050 colon. If the &%notdel%& argument is true, a false return is forced for all
29051 &"deleted"& headers; otherwise they are not treated specially. For example:
29052 .code
29053 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
29054 .endd
29055 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
29056 .cindex "base64 encoding" "functions for &[local_scan()]& use"
29057 This function base64-encodes a string, which is passed by address and length.
29058 The text may contain bytes of any value, including zero. The result is passed
29059 back in dynamic memory that is obtained by calling &'store_get()'&. It is
29060 zero-terminated.
29061
29062 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
29063 This function decodes a base64-encoded string. Its arguments are a
29064 zero-terminated base64-encoded string and the address of a variable that is set
29065 to point to the result, which is in dynamic memory. The length of the decoded
29066 string is the yield of the function. If the input is invalid base64 data, the
29067 yield is -1. A zero byte is added to the end of the output string to make it
29068 easy to interpret as a C string (assuming it contains no zeros of its own). The
29069 added zero byte is not included in the returned count.
29070
29071 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
29072 This function checks for a match in a domain list. Domains are always
29073 matched caselessly. The return value is one of the following:
29074 .display
29075 &`OK     `& match succeeded
29076 &`FAIL   `& match failed
29077 &`DEFER  `& match deferred
29078 .endd
29079 DEFER is usually caused by some kind of lookup defer, such as the
29080 inability to contact a database.
29081
29082 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
29083         BOOL&~caseless)*&"
29084 This function checks for a match in a local part list. The third argument
29085 controls case-sensitivity. The return values are as for
29086 &'lss_match_domain()'&.
29087
29088 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
29089         BOOL&~caseless)*&"
29090 This function checks for a match in an address list. The third argument
29091 controls the case-sensitivity of the local part match. The domain is always
29092 matched caselessly. The return values are as for &'lss_match_domain()'&.
29093
29094 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
29095         uschar&~*list)*&"
29096 This function checks for a match in a host list. The most common usage is
29097 expected to be
29098 .code
29099 lss_match_host(sender_host_name, sender_host_address, ...)
29100 .endd
29101 .vindex "&$sender_host_address$&"
29102 An empty address field matches an empty item in the host list. If the host name
29103 is NULL, the name corresponding to &$sender_host_address$& is automatically
29104 looked up if a host name is required to match an item in the list. The return
29105 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
29106 returns ERROR in the case when it had to look up a host name, but the lookup
29107 failed.
29108
29109 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
29110         *format,&~...)*&"
29111 This function writes to Exim's log files. The first argument should be zero (it
29112 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
29113 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
29114 them. It specifies to which log or logs the message is written. The remaining
29115 arguments are a format and relevant insertion arguments. The string should not
29116 contain any newlines, not even at the end.
29117
29118
29119 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
29120 This function adds an additional recipient to the message. The first argument
29121 is the recipient address. If it is unqualified (has no domain), it is qualified
29122 with the &%qualify_recipient%& domain. The second argument must always be -1.
29123
29124 This function does not allow you to specify a private &%errors_to%& address (as
29125 described with the structure of &%recipient_item%& above), because it pre-dates
29126 the addition of that field to the structure. However, it is easy to add such a
29127 value afterwards. For example:
29128 .code
29129  receive_add_recipient(US"monitor@mydom.example", -1);
29130  recipients_list[recipients_count-1].errors_to =
29131    US"postmaster@mydom.example";
29132 .endd
29133
29134 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
29135 This is a convenience function to remove a named recipient from the list of
29136 recipients. It returns true if a recipient was removed, and false if no
29137 matching recipient could be found. The argument must be a complete email
29138 address.
29139 .endlist
29140
29141
29142 .cindex "RFC 2047"
29143 .vlist
29144 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
29145   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
29146 This function decodes strings that are encoded according to RFC 2047. Typically
29147 these are the contents of header lines. First, each &"encoded word"& is decoded
29148 from the Q or B encoding into a byte-string. Then, if provided with the name of
29149 a charset encoding, and if the &[iconv()]& function is available, an attempt is
29150 made  to translate the result to the named character set. If this fails, the
29151 binary string is returned with an error message.
29152
29153 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
29154 maximum MIME word length is enforced. The third argument is the target
29155 encoding, or NULL if no translation is wanted.
29156
29157 .cindex "binary zero" "in RFC 2047 decoding"
29158 .cindex "RFC 2047" "binary zero in"
29159 If a binary zero is encountered in the decoded string, it is replaced by the
29160 contents of the &%zeroval%& argument. For use with Exim headers, the value must
29161 not be 0 because header lines are handled as zero-terminated strings.
29162
29163 The function returns the result of processing the string, zero-terminated; if
29164 &%lenptr%& is not NULL, the length of the result is set in the variable to
29165 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
29166
29167 If an error is encountered, the function returns NULL and uses the &%error%&
29168 argument to return an error message. The variable pointed to by &%error%& is
29169 set to NULL if there is no error; it may be set non-NULL even when the function
29170 returns a non-NULL value if decoding was successful, but there was a problem
29171 with translation.
29172
29173
29174 .vitem &*int&~smtp_fflush(void)*&
29175 This function is used in conjunction with &'smtp_printf()'&, as described
29176 below.
29177
29178 .vitem &*void&~smtp_printf(char&~*,&~...)*&
29179 The arguments of this function are like &[printf()]&; it writes to the SMTP
29180 output stream. You should use this function only when there is an SMTP output
29181 stream, that is, when the incoming message is being received via interactive
29182 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
29183 is FALSE. If you want to test for an incoming message from another host (as
29184 opposed to a local process that used the &%-bs%& command line option), you can
29185 test the value of &%sender_host_address%&, which is non-NULL when a remote host
29186 is involved.
29187
29188 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
29189 output function, so it can be used for all forms of SMTP connection.
29190
29191 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
29192 must start with an appropriate response code: 550 if you are going to return
29193 LOCAL_SCAN_REJECT, 451 if you are going to return
29194 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
29195 initial lines of a multi-line response, the code must be followed by a hyphen
29196 to indicate that the line is not the final response line. You must also ensure
29197 that the lines you write terminate with CRLF. For example:
29198 .code
29199 smtp_printf("550-this is some extra info\r\n");
29200 return LOCAL_SCAN_REJECT;
29201 .endd
29202 Note that you can also create multi-line responses by including newlines in
29203 the data returned via the &%return_text%& argument. The added value of using
29204 &'smtp_printf()'& is that, for instance, you could introduce delays between
29205 multiple output lines.
29206
29207 The &'smtp_printf()'& function does not return any error indication, because it
29208 does not automatically flush pending output, and therefore does not test
29209 the state of the stream. (In the main code of Exim, flushing and error
29210 detection is done when Exim is ready for the next SMTP input command.) If
29211 you want to flush the output and check for an error (for example, the
29212 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
29213 arguments. It flushes the output stream, and returns a non-zero value if there
29214 is an error.
29215
29216 .vitem &*void&~*store_get(int)*&
29217 This function accesses Exim's internal store (memory) manager. It gets a new
29218 chunk of memory whose size is given by the argument. Exim bombs out if it ever
29219 runs out of memory. See the next section for a discussion of memory handling.
29220
29221 .vitem &*void&~*store_get_perm(int)*&
29222 This function is like &'store_get()'&, but it always gets memory from the
29223 permanent pool. See the next section for a discussion of memory handling.
29224
29225 .vitem &*uschar&~*string_copy(uschar&~*string)*&
29226 See below.
29227
29228 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
29229 See below.
29230
29231 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
29232 These three functions create strings using Exim's dynamic memory facilities.
29233 The first makes a copy of an entire string. The second copies up to a maximum
29234 number of characters, indicated by the second argument. The third uses a format
29235 and insertion arguments to create a new string. In each case, the result is a
29236 pointer to a new string in the current memory pool. See the next section for
29237 more discussion.
29238 .endlist
29239
29240
29241
29242 .section "More about Exim's memory handling" "SECTmemhanloc"
29243 .cindex "&[local_scan()]& function" "memory handling"
29244 No function is provided for freeing memory, because that is never needed.
29245 The dynamic memory that Exim uses when receiving a message is automatically
29246 recycled if another message is received by the same process (this applies only
29247 to incoming SMTP connections &-- other input methods can supply only one
29248 message at a time). After receiving the last message, a reception process
29249 terminates.
29250
29251 Because it is recycled, the normal dynamic memory cannot be used for holding
29252 data that must be preserved over a number of incoming messages on the same SMTP
29253 connection. However, Exim in fact uses two pools of dynamic memory; the second
29254 one is not recycled, and can be used for this purpose.
29255
29256 If you want to allocate memory that remains available for subsequent messages
29257 in the same SMTP connection, you should set
29258 .code
29259 store_pool = POOL_PERM
29260 .endd
29261 before calling the function that does the allocation. There is no need to
29262 restore the value if you do not need to; however, if you do want to revert to
29263 the normal pool, you can either restore the previous value of &%store_pool%& or
29264 set it explicitly to POOL_MAIN.
29265
29266 The pool setting applies to all functions that get dynamic memory, including
29267 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
29268 There is also a convenience function called &'store_get_perm()'& that gets a
29269 block of memory from the permanent pool while preserving the value of
29270 &%store_pool%&.
29271 .ecindex IIDlosca
29272
29273
29274
29275
29276 . ////////////////////////////////////////////////////////////////////////////
29277 . ////////////////////////////////////////////////////////////////////////////
29278
29279 .chapter "System-wide message filtering" "CHAPsystemfilter"
29280 .scindex IIDsysfil1 "filter" "system filter"
29281 .scindex IIDsysfil2 "filtering all mail"
29282 .scindex IIDsysfil3 "system filter"
29283 The previous chapters (on ACLs and the local scan function) describe checks
29284 that can be applied to messages before they are accepted by a host. There is
29285 also a mechanism for checking messages once they have been received, but before
29286 they are delivered. This is called the &'system filter'&.
29287
29288 The system filter operates in a similar manner to users' filter files, but it
29289 is run just once per message (however many recipients the message has).
29290 It should not normally be used as a substitute for routing, because &%deliver%&
29291 commands in a system router provide new envelope recipient addresses.
29292 The system filter must be an Exim filter. It cannot be a Sieve filter.
29293
29294 The system filter is run at the start of a delivery attempt, before any routing
29295 is done. If a message fails to be completely delivered at the first attempt,
29296 the system filter is run again at the start of every retry.
29297 If you want your filter to do something only once per message, you can make use
29298 of the &%first_delivery%& condition in an &%if%& command in the filter to
29299 prevent it happening on retries.
29300
29301 .vindex "&$domain$&"
29302 .vindex "&$local_part$&"
29303 &*Warning*&: Because the system filter runs just once, variables that are
29304 specific to individual recipient addresses, such as &$local_part$& and
29305 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
29306 you want to run a centrally-specified filter for each recipient address
29307 independently, you can do so by setting up a suitable &(redirect)& router, as
29308 described in section &<<SECTperaddfil>>& below.
29309
29310
29311 .section "Specifying a system filter" "SECID212"
29312 .cindex "uid (user id)" "system filter"
29313 .cindex "gid (group id)" "system filter"
29314 The name of the file that contains the system filter must be specified by
29315 setting &%system_filter%&. If you want the filter to run under a uid and gid
29316 other than root, you must also set &%system_filter_user%& and
29317 &%system_filter_group%& as appropriate. For example:
29318 .code
29319 system_filter = /etc/mail/exim.filter
29320 system_filter_user = exim
29321 .endd
29322 If a system filter generates any deliveries directly to files or pipes (via the
29323 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
29324 specified by setting &%system_filter_file_transport%& and
29325 &%system_filter_pipe_transport%&, respectively. Similarly,
29326 &%system_filter_reply_transport%& must be set to handle any messages generated
29327 by the &%reply%& command.
29328
29329
29330 .section "Testing a system filter" "SECID213"
29331 You can run simple tests of a system filter in the same way as for a user
29332 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
29333 are permitted only in system filters are recognized.
29334
29335 If you want to test the combined effect of a system filter and a user filter,
29336 you can use both &%-bF%& and &%-bf%& on the same command line.
29337
29338
29339
29340 .section "Contents of a system filter" "SECID214"
29341 The language used to specify system filters is the same as for users' filter
29342 files. It is described in the separate end-user document &'Exim's interface to
29343 mail filtering'&. However, there are some additional features that are
29344 available only in system filters; these are described in subsequent sections.
29345 If they are encountered in a user's filter file or when testing with &%-bf%&,
29346 they cause errors.
29347
29348 .cindex "frozen messages" "manual thaw; testing in filter"
29349 There are two special conditions which, though available in users' filter
29350 files, are designed for use in system filters. The condition &%first_delivery%&
29351 is true only for the first attempt at delivering a message, and
29352 &%manually_thawed%& is true only if the message has been frozen, and
29353 subsequently thawed by an admin user. An explicit forced delivery counts as a
29354 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
29355
29356 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
29357 specify an &"unseen"& (non-significant) delivery, and that delivery does not
29358 succeed, it will not be tried again.
29359 If you want Exim to retry an unseen delivery until it succeeds, you should
29360 arrange to set it up every time the filter runs.
29361
29362 When a system filter finishes running, the values of the variables &$n0$& &--
29363 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
29364 users' filter files. Thus a system filter can, for example, set up &"scores"&
29365 to which users' filter files can refer.
29366
29367
29368
29369 .section "Additional variable for system filters" "SECID215"
29370 .vindex "&$recipients$&"
29371 The expansion variable &$recipients$&, containing a list of all the recipients
29372 of the message (separated by commas and white space), is available in system
29373 filters. It is not available in users' filters for privacy reasons.
29374
29375
29376
29377 .section "Defer, freeze, and fail commands for system filters" "SECID216"
29378 .cindex "freezing messages"
29379 .cindex "message" "freezing"
29380 .cindex "message" "forced failure"
29381 .cindex "&%fail%&" "in system filter"
29382 .cindex "&%freeze%& in system filter"
29383 .cindex "&%defer%& in system filter"
29384 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
29385 always available in system filters, but are not normally enabled in users'
29386 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
29387 for the &(redirect)& router.) These commands can optionally be followed by the
29388 word &%text%& and a string containing an error message, for example:
29389 .code
29390 fail text "this message looks like spam to me"
29391 .endd
29392 The keyword &%text%& is optional if the next character is a double quote.
29393
29394 The &%defer%& command defers delivery of the original recipients of the
29395 message. The &%fail%& command causes all the original recipients to be failed,
29396 and a bounce message to be created. The &%freeze%& command suspends all
29397 delivery attempts for the original recipients. In all cases, any new deliveries
29398 that are specified by the filter are attempted as normal after the filter has
29399 run.
29400
29401 The &%freeze%& command is ignored if the message has been manually unfrozen and
29402 not manually frozen since. This means that automatic freezing by a system
29403 filter can be used as a way of checking out suspicious messages. If a message
29404 is found to be all right, manually unfreezing it allows it to be delivered.
29405
29406 .cindex "log" "&%fail%& command log line"
29407 .cindex "&%fail%&" "log line; reducing"
29408 The text given with a fail command is used as part of the bounce message as
29409 well as being written to the log. If the message is quite long, this can fill
29410 up a lot of log space when such failures are common. To reduce the size of the
29411 log message, Exim interprets the text in a special way if it starts with the
29412 two characters &`<<`& and contains &`>>`& later. The text between these two
29413 strings is written to the log, and the rest of the text is used in the bounce
29414 message. For example:
29415 .code
29416 fail "<<filter test 1>>Your message is rejected \
29417      because it contains attachments that we are \
29418      not prepared to receive."
29419 .endd
29420
29421 .cindex "loop" "caused by &%fail%&"
29422 Take great care with the &%fail%& command when basing the decision to fail on
29423 the contents of the message, because the bounce message will of course include
29424 the contents of the original message and will therefore trigger the &%fail%&
29425 command again (causing a mail loop) unless steps are taken to prevent this.
29426 Testing the &%error_message%& condition is one way to prevent this. You could
29427 use, for example
29428 .code
29429 if $message_body contains "this is spam" and not error_message
29430 then fail text "spam is not wanted here" endif
29431 .endd
29432 though of course that might let through unwanted bounce messages. The
29433 alternative is clever checking of the body and/or headers to detect bounces
29434 generated by the filter.
29435
29436 The interpretation of a system filter file ceases after a
29437 &%defer%&,
29438 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
29439 set up earlier in the filter file are honoured, so you can use a sequence such
29440 as
29441 .code
29442 mail ...
29443 freeze
29444 .endd
29445 to send a specified message when the system filter is freezing (or deferring or
29446 failing) a message. The normal deliveries for the message do not, of course,
29447 take place.
29448
29449
29450
29451 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
29452 .cindex "header lines" "adding; in system filter"
29453 .cindex "header lines" "removing; in system filter"
29454 .cindex "filter" "header lines; adding/removing"
29455 Two filter commands that are available only in system filters are:
29456 .code
29457 headers add <string>
29458 headers remove <string>
29459 .endd
29460 The argument for the &%headers add%& is a string that is expanded and then
29461 added to the end of the message's headers. It is the responsibility of the
29462 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
29463 space is ignored, and if the string is otherwise empty, or if the expansion is
29464 forced to fail, the command has no effect.
29465
29466 You can use &"\n"& within the string, followed by white space, to specify
29467 continued header lines. More than one header may be added in one command by
29468 including &"\n"& within the string without any following white space. For
29469 example:
29470 .code
29471 headers add "X-header-1: ....\n  \
29472              continuation of X-header-1 ...\n\
29473              X-header-2: ...."
29474 .endd
29475 Note that the header line continuation white space after the first newline must
29476 be placed before the backslash that continues the input string, because white
29477 space after input continuations is ignored.
29478
29479 The argument for &%headers remove%& is a colon-separated list of header names.
29480 This command applies only to those headers that are stored with the message;
29481 those that are added at delivery time (such as &'Envelope-To:'& and
29482 &'Return-Path:'&) cannot be removed by this means. If there is more than one
29483 header with the same name, they are all removed.
29484
29485 The &%headers%& command in a system filter makes an immediate change to the set
29486 of header lines that was received with the message (with possible additions
29487 from ACL processing). Subsequent commands in the system filter operate on the
29488 modified set, which also forms the basis for subsequent message delivery.
29489 Unless further modified during routing or transporting, this set of headers is
29490 used for all recipients of the message.
29491
29492 During routing and transporting, the variables that refer to the contents of
29493 header lines refer only to those lines that are in this set. Thus, header lines
29494 that are added by a system filter are visible to users' filter files and to all
29495 routers and transports. This contrasts with the manipulation of header lines by
29496 routers and transports, which is not immediate, but which instead is saved up
29497 until the message is actually being written (see section
29498 &<<SECTheadersaddrem>>&).
29499
29500 If the message is not delivered at the first attempt, header lines that were
29501 added by the system filter are stored with the message, and so are still
29502 present at the next delivery attempt. Header lines that were removed are still
29503 present, but marked &"deleted"& so that they are not transported with the
29504 message. For this reason, it is usual to make the &%headers%& command
29505 conditional on &%first_delivery%& so that the set of header lines is not
29506 modified more than once.
29507
29508 Because header modification in a system filter acts immediately, you have to
29509 use an indirect approach if you want to modify the contents of a header line.
29510 For example:
29511 .code
29512 headers add "Old-Subject: $h_subject:"
29513 headers remove "Subject"
29514 headers add "Subject: new subject (was: $h_old-subject:)"
29515 headers remove "Old-Subject"
29516 .endd
29517
29518
29519
29520 .section "Setting an errors address in a system filter" "SECID217"
29521 .cindex "envelope sender"
29522 In a system filter, if a &%deliver%& command is followed by
29523 .code
29524 errors_to <some address>
29525 .endd
29526 in order to change the envelope sender (and hence the error reporting) for that
29527 delivery, any address may be specified. (In a user filter, only the current
29528 user's address can be set.) For example, if some mail is being monitored, you
29529 might use
29530 .code
29531 unseen deliver monitor@spying.example errors_to root@local.example
29532 .endd
29533 to take a copy which would not be sent back to the normal error reporting
29534 address if its delivery failed.
29535
29536
29537
29538 .section "Per-address filtering" "SECTperaddfil"
29539 .vindex "&$domain$&"
29540 .vindex "&$local_part$&"
29541 In contrast to the system filter, which is run just once per message for each
29542 delivery attempt, it is also possible to set up a system-wide filtering
29543 operation that runs once for each recipient address. In this case, variables
29544 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
29545 filter file could be made dependent on them. This is an example of a router
29546 which implements such a filter:
29547 .code
29548 central_filter:
29549   check_local_user
29550   driver = redirect
29551   domains = +local_domains
29552   file = /central/filters/$local_part
29553   no_verify
29554   allow_filter
29555   allow_freeze
29556 .endd
29557 The filter is run in a separate process under its own uid. Therefore, either
29558 &%check_local_user%& must be set (as above), in which case the filter is run as
29559 the local user, or the &%user%& option must be used to specify which user to
29560 use. If both are set, &%user%& overrides.
29561
29562 Care should be taken to ensure that none of the commands in the filter file
29563 specify a significant delivery if the message is to go on to be delivered to
29564 its intended recipient. The router will not then claim to have dealt with the
29565 address, so it will be passed on to subsequent routers to be delivered in the
29566 normal way.
29567 .ecindex IIDsysfil1
29568 .ecindex IIDsysfil2
29569 .ecindex IIDsysfil3
29570
29571
29572
29573
29574
29575
29576 . ////////////////////////////////////////////////////////////////////////////
29577 . ////////////////////////////////////////////////////////////////////////////
29578
29579 .chapter "Message processing" "CHAPmsgproc"
29580 .scindex IIDmesproc "message" "general processing"
29581 Exim performs various transformations on the sender and recipient addresses of
29582 all messages that it handles, and also on the messages' header lines. Some of
29583 these are optional and configurable, while others always take place. All of
29584 this processing, except rewriting as a result of routing, and the addition or
29585 removal of header lines while delivering, happens when a message is received,
29586 before it is placed on Exim's queue.
29587
29588 Some of the automatic processing takes place by default only for
29589 &"locally-originated"& messages. This adjective is used to describe messages
29590 that are not received over TCP/IP, but instead are passed to an Exim process on
29591 its standard input. This includes the interactive &"local SMTP"& case that is
29592 set up by the &%-bs%& command line option.
29593
29594 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
29595 or ::1) are not considered to be locally-originated. Exim does not treat the
29596 loopback interface specially in any way.
29597
29598 If you want the loopback interface to be treated specially, you must ensure
29599 that there are appropriate entries in your ACLs.
29600
29601
29602
29603
29604 .section "Submission mode for non-local messages" "SECTsubmodnon"
29605 .cindex "message" "submission"
29606 .cindex "submission mode"
29607 Processing that happens automatically for locally-originated messages (unless
29608 &%suppress_local_fixups%& is set) can also be requested for messages that are
29609 received over TCP/IP. The term &"submission mode"& is used to describe this
29610 state. Submission mode is set by the modifier
29611 .code
29612 control = submission
29613 .endd
29614 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
29615 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
29616 a local submission, and is normally used when the source of the message is
29617 known to be an MUA running on a client host (as opposed to an MTA). For
29618 example, to set submission mode for messages originating on the IPv4 loopback
29619 interface, you could include the following in the MAIL ACL:
29620 .code
29621 warn  hosts = 127.0.0.1
29622       control = submission
29623 .endd
29624 .cindex "&%sender_retain%& submission option"
29625 There are some options that can be used when setting submission mode. A slash
29626 is used to separate options. For example:
29627 .code
29628 control = submission/sender_retain
29629 .endd
29630 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
29631 true and &%local_from_check%& false for the current incoming message. The first
29632 of these allows an existing &'Sender:'& header in the message to remain, and
29633 the second suppresses the check to ensure that &'From:'& matches the
29634 authenticated sender. With this setting, Exim still fixes up messages by adding
29635 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
29636 attempt to check sender authenticity in header lines.
29637
29638 When &%sender_retain%& is not set, a submission mode setting may specify a
29639 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
29640 example:
29641 .code
29642 control = submission/domain=some.domain
29643 .endd
29644 The domain may be empty. How this value is used is described in sections
29645 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
29646 that allows you to specify the user's full name for inclusion in a created
29647 &'Sender:'& or &'From:'& header line. For example:
29648 .code
29649 accept authenticated = *
29650        control = submission/domain=wonderland.example/\
29651                             name=${lookup {$authenticated_id} \
29652                                    lsearch {/etc/exim/namelist}}
29653 .endd
29654 Because the name may contain any characters, including slashes, the &%name%&
29655 option must be given last. The remainder of the string is used as the name. For
29656 the example above, if &_/etc/exim/namelist_& contains:
29657 .code
29658 bigegg:  Humpty Dumpty
29659 .endd
29660 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
29661 line would be:
29662 .code
29663 Sender: Humpty Dumpty <bigegg@wonderland.example>
29664 .endd
29665 .cindex "return path" "in submission mode"
29666 By default, submission mode forces the return path to the same address as is
29667 used to create the &'Sender:'& header. However, if &%sender_retain%& is
29668 specified, the return path is also left unchanged.
29669
29670 &*Note*&: The changes caused by submission mode take effect after the predata
29671 ACL. This means that any sender checks performed before the fix-ups use the
29672 untrusted sender address specified by the user, not the trusted sender address
29673 specified by submission mode. Although this might be slightly unexpected, it
29674 does mean that you can configure ACL checks to spot that a user is trying to
29675 spoof another's address.
29676
29677 .section "Line endings" "SECTlineendings"
29678 .cindex "line endings"
29679 .cindex "carriage return"
29680 .cindex "linefeed"
29681 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
29682 linefeed) is the line ending for messages transmitted over the Internet using
29683 SMTP over TCP/IP. However, within individual operating systems, different
29684 conventions are used. For example, Unix-like systems use just LF, but others
29685 use CRLF or just CR.
29686
29687 Exim was designed for Unix-like systems, and internally, it stores messages
29688 using the system's convention of a single LF as a line terminator. When
29689 receiving a message, all line endings are translated to this standard format.
29690 Originally, it was thought that programs that passed messages directly to an
29691 MTA within an operating system would use that system's convention. Experience
29692 has shown that this is not the case; for example, there are Unix applications
29693 that use CRLF in this circumstance. For this reason, and for compatibility with
29694 other MTAs, the way Exim handles line endings for all messages is now as
29695 follows:
29696
29697 .ilist
29698 LF not preceded by CR is treated as a line ending.
29699 .next
29700 CR is treated as a line ending; if it is immediately followed by LF, the LF
29701 is ignored.
29702 .next
29703 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
29704 nor a local message in the state where a line containing only a dot is a
29705 terminator.
29706 .next
29707 If a bare CR is encountered within a header line, an extra space is added after
29708 the line terminator so as not to end the header line. The reasoning behind this
29709 is that bare CRs in header lines are most likely either to be mistakes, or
29710 people trying to play silly games.
29711 .next
29712 If the first header line received in a message ends with CRLF, a subsequent
29713 bare LF in a header line is treated in the same way as a bare CR in a header
29714 line.
29715 .endlist
29716
29717
29718
29719
29720
29721 .section "Unqualified addresses" "SECID218"
29722 .cindex "unqualified addresses"
29723 .cindex "address" "qualification"
29724 By default, Exim expects every envelope address it receives from an external
29725 host to be fully qualified. Unqualified addresses cause negative responses to
29726 SMTP commands. However, because SMTP is used as a means of transporting
29727 messages from MUAs running on personal workstations, there is sometimes a
29728 requirement to accept unqualified addresses from specific hosts or IP networks.
29729
29730 Exim has two options that separately control which hosts may send unqualified
29731 sender or recipient addresses in SMTP commands, namely
29732 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
29733 cases, if an unqualified address is accepted, it is qualified by adding the
29734 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
29735
29736 .oindex "&%qualify_domain%&"
29737 .oindex "&%qualify_recipient%&"
29738 Unqualified addresses in header lines are automatically qualified for messages
29739 that are locally originated, unless the &%-bnq%& option is given on the command
29740 line. For messages received over SMTP, unqualified addresses in header lines
29741 are qualified only if unqualified addresses are permitted in SMTP commands. In
29742 other words, such qualification is also controlled by
29743 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
29744
29745
29746
29747
29748 .section "The UUCP From line" "SECID219"
29749 .cindex "&""From""& line"
29750 .cindex "UUCP" "&""From""& line"
29751 .cindex "sender" "address"
29752 .oindex "&%uucp_from_pattern%&"
29753 .oindex "&%uucp_from_sender%&"
29754 .cindex "envelope sender"
29755 .cindex "Sendmail compatibility" "&""From""& line"
29756 Messages that have come from UUCP (and some other applications) often begin
29757 with a line containing the envelope sender and a timestamp, following the word
29758 &"From"&. Examples of two common formats are:
29759 .code
29760 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
29761 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
29762 .endd
29763 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
29764 Exim recognizes such lines at the start of messages that are submitted to it
29765 via the command line (that is, on the standard input). It does not recognize
29766 such lines in incoming SMTP messages, unless the sending host matches
29767 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
29768 and &%ignore_fromline_local%& is set. The recognition is controlled by a
29769 regular expression that is defined by the &%uucp_from_pattern%& option, whose
29770 default value matches the two common cases shown above and puts the address
29771 that follows &"From"& into &$1$&.
29772
29773 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
29774 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
29775 a trusted user, the message's sender address is constructed by expanding the
29776 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
29777 then parsed as an RFC 2822 address. If there is no domain, the local part is
29778 qualified with &%qualify_domain%& unless it is the empty string. However, if
29779 the command line &%-f%& option is used, it overrides the &"From"& line.
29780
29781 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
29782 sender address is not changed. This is also the case for incoming SMTP messages
29783 that are permitted to contain &"From"& lines.
29784
29785 Only one &"From"& line is recognized. If there is more than one, the second is
29786 treated as a data line that starts the body of the message, as it is not valid
29787 as a header line. This also happens if a &"From"& line is present in an
29788 incoming SMTP message from a source that is not permitted to send them.
29789
29790
29791
29792 .section "Resent- header lines" "SECID220"
29793 .cindex "&%Resent-%& header lines"
29794 RFC 2822 makes provision for sets of header lines starting with the string
29795 &`Resent-`& to be added to a message when it is resent by the original
29796 recipient to somebody else. These headers are &'Resent-Date:'&,
29797 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
29798 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
29799
29800 .blockquote
29801 &'Resent fields are strictly informational. They MUST NOT be used in the normal
29802 processing of replies or other such automatic actions on messages.'&
29803 .endblockquote
29804
29805 This leaves things a bit vague as far as other processing actions such as
29806 address rewriting are concerned. Exim treats &%Resent-%& header lines as
29807 follows:
29808
29809 .ilist
29810 A &'Resent-From:'& line that just contains the login id of the submitting user
29811 is automatically rewritten in the same way as &'From:'& (see below).
29812 .next
29813 If there's a rewriting rule for a particular header line, it is also applied to
29814 &%Resent-%& header lines of the same type. For example, a rule that rewrites
29815 &'From:'& also rewrites &'Resent-From:'&.
29816 .next
29817 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
29818 also removed.
29819 .next
29820 For a locally-submitted message,
29821 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
29822 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
29823 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
29824 included in log lines in this case.
29825 .next
29826 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
29827 &%Resent-%& header lines are present.
29828 .endlist
29829
29830
29831
29832
29833 .section "The Auto-Submitted: header line" "SECID221"
29834 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
29835 includes the header line:
29836 .code
29837 Auto-Submitted: auto-replied
29838 .endd
29839
29840 .section "The Bcc: header line" "SECID222"
29841 .cindex "&'Bcc:'& header line"
29842 If Exim is called with the &%-t%& option, to take recipient addresses from a
29843 message's header, it removes any &'Bcc:'& header line that may exist (after
29844 extracting its addresses). If &%-t%& is not present on the command line, any
29845 existing &'Bcc:'& is not removed.
29846
29847
29848 .section "The Date: header line" "SECID223"
29849 .cindex "&'Date:'& header line"
29850 If a locally-generated or submission-mode message has no &'Date:'& header line,
29851 Exim adds one, using the current date and time, unless the
29852 &%suppress_local_fixups%& control has been specified.
29853
29854 .section "The Delivery-date: header line" "SECID224"
29855 .cindex "&'Delivery-date:'& header line"
29856 .oindex "&%delivery_date_remove%&"
29857 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
29858 set. Exim can be configured to add them to the final delivery of messages. (See
29859 the generic &%delivery_date_add%& transport option.) They should not be present
29860 in messages in transit. If the &%delivery_date_remove%& configuration option is
29861 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
29862 messages.
29863
29864
29865 .section "The Envelope-to: header line" "SECID225"
29866 .cindex "&'Envelope-to:'& header line"
29867 .oindex "&%envelope_to_remove%&"
29868 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
29869 Exim can be configured to add them to the final delivery of messages. (See the
29870 generic &%envelope_to_add%& transport option.) They should not be present in
29871 messages in transit. If the &%envelope_to_remove%& configuration option is set
29872 (the default), Exim removes &'Envelope-to:'& header lines from incoming
29873 messages.
29874
29875
29876 .section "The From: header line" "SECTthefrohea"
29877 .cindex "&'From:'& header line"
29878 .cindex "Sendmail compatibility" "&""From""& line"
29879 .cindex "message" "submission"
29880 .cindex "submission mode"
29881 If a submission-mode message does not contain a &'From:'& header line, Exim
29882 adds one if either of the following conditions is true:
29883
29884 .ilist
29885 The envelope sender address is not empty (that is, this is not a bounce
29886 message). The added header line copies the envelope sender address.
29887 .next
29888 .vindex "&$authenticated_id$&"
29889 The SMTP session is authenticated and &$authenticated_id$& is not empty.
29890 .olist
29891 .vindex "&$qualify_domain$&"
29892 If no domain is specified by the submission control, the local part is
29893 &$authenticated_id$& and the domain is &$qualify_domain$&.
29894 .next
29895 If a non-empty domain is specified by the submission control, the local
29896 part is &$authenticated_id$&, and the domain is the specified domain.
29897 .next
29898 If an empty domain is specified by the submission control,
29899 &$authenticated_id$& is assumed to be the complete address.
29900 .endlist
29901 .endlist
29902
29903 A non-empty envelope sender takes precedence.
29904
29905 If a locally-generated incoming message does not contain a &'From:'& header
29906 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
29907 containing the sender's address. The calling user's login name and full name
29908 are used to construct the address, as described in section &<<SECTconstr>>&.
29909 They are obtained from the password data by calling &[getpwuid()]& (but see the
29910 &%unknown_login%& configuration option). The address is qualified with
29911 &%qualify_domain%&.
29912
29913 For compatibility with Sendmail, if an incoming, non-SMTP message has a
29914 &'From:'& header line containing just the unqualified login name of the calling
29915 user, this is replaced by an address containing the user's login name and full
29916 name as described in section &<<SECTconstr>>&.
29917
29918
29919 .section "The Message-ID: header line" "SECID226"
29920 .cindex "&'Message-ID:'& header line"
29921 .cindex "message" "submission"
29922 .oindex "&%message_id_header_text%&"
29923 If a locally-generated or submission-mode incoming message does not contain a
29924 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
29925 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
29926 to the message. If there are any &'Resent-:'& headers in the message, it
29927 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
29928 message id, preceded by the letter E to ensure it starts with a letter, and
29929 followed by @ and the primary host name. Additional information can be included
29930 in this header line by setting the &%message_id_header_text%& and/or
29931 &%message_id_header_domain%& options.
29932
29933
29934 .section "The Received: header line" "SECID227"
29935 .cindex "&'Received:'& header line"
29936 A &'Received:'& header line is added at the start of every message. The
29937 contents are defined by the &%received_header_text%& configuration option, and
29938 Exim automatically adds a semicolon and a timestamp to the configured string.
29939
29940 The &'Received:'& header is generated as soon as the message's header lines
29941 have been received. At this stage, the timestamp in the &'Received:'& header
29942 line is the time that the message started to be received. This is the value
29943 that is seen by the DATA ACL and by the &[local_scan()]& function.
29944
29945 Once a message is accepted, the timestamp in the &'Received:'& header line is
29946 changed to the time of acceptance, which is (apart from a small delay while the
29947 -H spool file is written) the earliest time at which delivery could start.
29948
29949
29950 .section "The References: header line" "SECID228"
29951 .cindex "&'References:'& header line"
29952 Messages created by the &(autoreply)& transport include a &'References:'&
29953 header line. This is constructed according to the rules that are described in
29954 section 3.64 of RFC 2822 (which states that replies should contain such a
29955 header line), and section 3.14 of RFC 3834 (which states that automatic
29956 responses are not different in this respect). However, because some mail
29957 processing software does not cope well with very long header lines, no more
29958 than 12 message IDs are copied from the &'References:'& header line in the
29959 incoming message. If there are more than 12, the first one and then the final
29960 11 are copied, before adding the message ID of the incoming message.
29961
29962
29963
29964 .section "The Return-path: header line" "SECID229"
29965 .cindex "&'Return-path:'& header line"
29966 .oindex "&%return_path_remove%&"
29967 &'Return-path:'& header lines are defined as something an MTA may insert when
29968 it does the final delivery of messages. (See the generic &%return_path_add%&
29969 transport option.) Therefore, they should not be present in messages in
29970 transit. If the &%return_path_remove%& configuration option is set (the
29971 default), Exim removes &'Return-path:'& header lines from incoming messages.
29972
29973
29974
29975 .section "The Sender: header line" "SECTthesenhea"
29976 .cindex "&'Sender:'& header line"
29977 .cindex "message" "submission"
29978 For a locally-originated message from an untrusted user, Exim may remove an
29979 existing &'Sender:'& header line, and it may add a new one. You can modify
29980 these actions by setting the &%local_sender_retain%& option true, the
29981 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
29982 control setting.
29983
29984 When a local message is received from an untrusted user and
29985 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
29986 control has not been set, a check is made to see if the address given in the
29987 &'From:'& header line is the correct (local) sender of the message. The address
29988 that is expected has the login name as the local part and the value of
29989 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
29990 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
29991 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
29992 line is added to the message.
29993
29994 If you set &%local_from_check%& false, this checking does not occur. However,
29995 the removal of an existing &'Sender:'& line still happens, unless you also set
29996 &%local_sender_retain%& to be true. It is not possible to set both of these
29997 options true at the same time.
29998
29999 .cindex "submission mode"
30000 By default, no processing of &'Sender:'& header lines is done for messages
30001 received over TCP/IP or for messages submitted by trusted users. However, when
30002 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
30003 not specified on the submission control, the following processing takes place:
30004
30005 .vindex "&$authenticated_id$&"
30006 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
30007 authenticated, and &$authenticated_id$& is not empty, a sender address is
30008 created as follows:
30009
30010 .ilist
30011 .vindex "&$qualify_domain$&"
30012 If no domain is specified by the submission control, the local part is
30013 &$authenticated_id$& and the domain is &$qualify_domain$&.
30014 .next
30015 If a non-empty domain is specified by the submission control, the local part
30016 is &$authenticated_id$&, and the domain is the specified domain.
30017 .next
30018 If an empty domain is specified by the submission control,
30019 &$authenticated_id$& is assumed to be the complete address.
30020 .endlist
30021
30022 This address is compared with the address in the &'From:'& header line. If they
30023 are different, a &'Sender:'& header line containing the created address is
30024 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
30025 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
30026
30027 .cindex "return path" "created from &'Sender:'&"
30028 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
30029 the message (the envelope sender address) is changed to be the same address,
30030 except in the case of submission mode when &%sender_retain%& is specified.
30031
30032
30033
30034 .section "Adding and removing header lines in routers and transports" &&&
30035          "SECTheadersaddrem"
30036 .cindex "header lines" "adding; in router or transport"
30037 .cindex "header lines" "removing; in router or transport"
30038 When a message is delivered, the addition and removal of header lines can be
30039 specified in a system filter, or on any of the routers and transports that
30040 process the message. Section &<<SECTaddremheasys>>& contains details about
30041 modifying headers in a system filter. Header lines can also be added in an ACL
30042 as a message is received (see section &<<SECTaddheadacl>>&).
30043
30044 In contrast to what happens in a system filter, header modifications that are
30045 specified on routers and transports apply only to the particular recipient
30046 addresses that are being processed by those routers and transports. These
30047 changes do not actually take place until a copy of the message is being
30048 transported. Therefore, they do not affect the basic set of header lines, and
30049 they do not affect the values of the variables that refer to header lines.
30050
30051 &*Note*&: In particular, this means that any expansions in the configuration of
30052 the transport cannot refer to the modified header lines, because such
30053 expansions all occur before the message is actually transported.
30054
30055 For both routers and transports, the result of expanding a &%headers_add%&
30056 option must be in the form of one or more RFC 2822 header lines, separated by
30057 newlines (coded as &"\n"&). For example:
30058 .code
30059 headers_add = X-added-header: added by $primary_hostname\n\
30060               X-added-second: another added header line
30061 .endd
30062 Exim does not check the syntax of these added header lines.
30063
30064 The result of expanding &%headers_remove%& must consist of a colon-separated
30065 list of header names. This is confusing, because header names themselves are
30066 often terminated by colons. In this case, the colons are the list separators,
30067 not part of the names. For example:
30068 .code
30069 headers_remove = return-receipt-to:acknowledge-to
30070 .endd
30071 When &%headers_add%& or &%headers_remove%& is specified on a router, its value
30072 is expanded at routing time, and then associated with all addresses that are
30073 accepted by that router, and also with any new addresses that it generates. If
30074 an address passes through several routers as a result of aliasing or
30075 forwarding, the changes are cumulative.
30076
30077 .oindex "&%unseen%&"
30078 However, this does not apply to multiple routers that result from the use of
30079 the &%unseen%& option. Any header modifications that were specified by the
30080 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
30081
30082 Addresses that end up with different &%headers_add%& or &%headers_remove%&
30083 settings cannot be delivered together in a batch, so a transport is always
30084 dealing with a set of addresses that have the same header-processing
30085 requirements.
30086
30087 The transport starts by writing the original set of header lines that arrived
30088 with the message, possibly modified by the system filter. As it writes out
30089 these lines, it consults the list of header names that were attached to the
30090 recipient address(es) by &%headers_remove%& options in routers, and it also
30091 consults the transport's own &%headers_remove%& option. Header lines whose
30092 names are on either of these lists are not written out. If there are multiple
30093 instances of any listed header, they are all skipped.
30094
30095 After the remaining original header lines have been written, new header
30096 lines that were specified by routers' &%headers_add%& options are written, in
30097 the order in which they were attached to the address. These are followed by any
30098 header lines specified by the transport's &%headers_add%& option.
30099
30100 This way of handling header line modifications in routers and transports has
30101 the following consequences:
30102
30103 .ilist
30104 The original set of header lines, possibly modified by the system filter,
30105 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
30106 to it, at all times.
30107 .next
30108 Header lines that are added by a router's
30109 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
30110 expansion syntax in subsequent routers or the transport.
30111 .next
30112 Conversely, header lines that are specified for removal by &%headers_remove%&
30113 in a router remain visible to subsequent routers and the transport.
30114 .next
30115 Headers added to an address by &%headers_add%& in a router cannot be removed by
30116 a later router or by a transport.
30117 .next
30118 An added header can refer to the contents of an original header that is to be
30119 removed, even it has the same name as the added header. For example:
30120 .code
30121 headers_remove = subject
30122 headers_add = Subject: new subject (was: $h_subject:)
30123 .endd
30124 .endlist
30125
30126 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
30127 for a &(redirect)& router that has the &%one_time%& option set.
30128
30129
30130
30131
30132
30133 .section "Constructed addresses" "SECTconstr"
30134 .cindex "address" "constructed"
30135 .cindex "constructed address"
30136 When Exim constructs a sender address for a locally-generated message, it uses
30137 the form
30138 .display
30139 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
30140 .endd
30141 For example:
30142 .code
30143 Zaphod Beeblebrox <zaphod@end.univ.example>
30144 .endd
30145 The user name is obtained from the &%-F%& command line option if set, or
30146 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
30147 &"gecos"& field from the password entry. If the &"gecos"& field contains an
30148 ampersand character, this is replaced by the login name with the first letter
30149 upper cased, as is conventional in a number of operating systems. See the
30150 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
30151 The &%unknown_username%& option can be used to specify user names in cases when
30152 there is no password file entry.
30153
30154 .cindex "RFC 2047"
30155 In all cases, the user name is made to conform to RFC 2822 by quoting all or
30156 parts of it if necessary. In addition, if it contains any non-printing
30157 characters, it is encoded as described in RFC 2047, which defines a way of
30158 including non-ASCII characters in header lines. The value of the
30159 &%headers_charset%& option specifies the name of the encoding that is used (the
30160 characters are assumed to be in this encoding). The setting of
30161 &%print_topbitchars%& controls whether characters with the top bit set (that
30162 is, with codes greater than 127) count as printing characters or not.
30163
30164
30165
30166 .section "Case of local parts" "SECID230"
30167 .cindex "case of local parts"
30168 .cindex "local part" "case of"
30169 RFC 2822 states that the case of letters in the local parts of addresses cannot
30170 be assumed to be non-significant. Exim preserves the case of local parts of
30171 addresses, but by default it uses a lower-cased form when it is routing,
30172 because on most Unix systems, usernames are in lower case and case-insensitive
30173 routing is required. However, any particular router can be made to use the
30174 original case for local parts by setting the &%caseful_local_part%& generic
30175 router option.
30176
30177 .cindex "mixed-case login names"
30178 If you must have mixed-case user names on your system, the best way to proceed,
30179 assuming you want case-independent handling of incoming email, is to set up
30180 your first router to convert incoming local parts in your domains to the
30181 correct case by means of a file lookup. For example:
30182 .code
30183 correct_case:
30184   driver = redirect
30185   domains = +local_domains
30186   data = ${lookup{$local_part}cdb\
30187               {/etc/usercased.cdb}{$value}fail}\
30188               @$domain
30189 .endd
30190 For this router, the local part is forced to lower case by the default action
30191 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
30192 up a new local part in the correct case. If you then set &%caseful_local_part%&
30193 on any subsequent routers which process your domains, they will operate on
30194 local parts with the correct case in a case-sensitive manner.
30195
30196
30197
30198 .section "Dots in local parts" "SECID231"
30199 .cindex "dot" "in local part"
30200 .cindex "local part" "dots in"
30201 RFC 2822 forbids empty components in local parts. That is, an unquoted local
30202 part may not begin or end with a dot, nor have two consecutive dots in the
30203 middle. However, it seems that many MTAs do not enforce this, so Exim permits
30204 empty components for compatibility.
30205
30206
30207
30208 .section "Rewriting addresses" "SECID232"
30209 .cindex "rewriting" "addresses"
30210 Rewriting of sender and recipient addresses, and addresses in headers, can
30211 happen automatically, or as the result of configuration options, as described
30212 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
30213 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
30214
30215 Automatic rewriting includes qualification, as mentioned above. The other case
30216 in which it can happen is when an incomplete non-local domain is given. The
30217 routing process may cause this to be expanded into the full domain name. For
30218 example, a header such as
30219 .code
30220 To: hare@teaparty
30221 .endd
30222 might get rewritten as
30223 .code
30224 To: hare@teaparty.wonderland.fict.example
30225 .endd
30226 Rewriting as a result of routing is the one kind of message processing that
30227 does not happen at input time, as it cannot be done until the address has
30228 been routed.
30229
30230 Strictly, one should not do &'any'& deliveries of a message until all its
30231 addresses have been routed, in case any of the headers get changed as a
30232 result of routing. However, doing this in practice would hold up many
30233 deliveries for unreasonable amounts of time, just because one address could not
30234 immediately be routed. Exim therefore does not delay other deliveries when
30235 routing of one or more addresses is deferred.
30236 .ecindex IIDmesproc
30237
30238
30239
30240 . ////////////////////////////////////////////////////////////////////////////
30241 . ////////////////////////////////////////////////////////////////////////////
30242
30243 .chapter "SMTP processing" "CHAPSMTP"
30244 .scindex IIDsmtpproc1 "SMTP" "processing details"
30245 .scindex IIDsmtpproc2 "LMTP" "processing details"
30246 Exim supports a number of different ways of using the SMTP protocol, and its
30247 LMTP variant, which is an interactive protocol for transferring messages into a
30248 closed mail store application. This chapter contains details of how SMTP is
30249 processed. For incoming mail, the following are available:
30250
30251 .ilist
30252 SMTP over TCP/IP (Exim daemon or &'inetd'&);
30253 .next
30254 SMTP over the standard input and output (the &%-bs%& option);
30255 .next
30256 Batched SMTP on the standard input (the &%-bS%& option).
30257 .endlist
30258
30259 For mail delivery, the following are available:
30260
30261 .ilist
30262 SMTP over TCP/IP (the &(smtp)& transport);
30263 .next
30264 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
30265 &"lmtp"&);
30266 .next
30267 LMTP over a pipe to a process running in the local host (the &(lmtp)&
30268 transport);
30269 .next
30270 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
30271 the &%use_bsmtp%& option set).
30272 .endlist
30273
30274 &'Batched SMTP'& is the name for a process in which batches of messages are
30275 stored in or read from files (or pipes), in a format in which SMTP commands are
30276 used to contain the envelope information.
30277
30278
30279
30280 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
30281 .cindex "SMTP" "outgoing over TCP/IP"
30282 .cindex "outgoing SMTP over TCP/IP"
30283 .cindex "LMTP" "over TCP/IP"
30284 .cindex "outgoing LMTP over TCP/IP"
30285 .cindex "EHLO"
30286 .cindex "HELO"
30287 .cindex "SIZE option on MAIL command"
30288 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
30289 The &%protocol%& option selects which protocol is to be used, but the actual
30290 processing is the same in both cases.
30291
30292 If, in response to its EHLO command, Exim is told that the SIZE
30293 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
30294 command. The value of <&'n'&> is the message size plus the value of the
30295 &%size_addition%& option (default 1024) to allow for additions to the message
30296 such as per-transport header lines, or changes made in a
30297 .cindex "transport" "filter"
30298 .cindex "filter" "transport filter"
30299 transport filter. If &%size_addition%& is set negative, the use of SIZE is
30300 suppressed.
30301
30302 If the remote server advertises support for PIPELINING, Exim uses the
30303 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
30304 required for the transaction.
30305
30306 If the remote server advertises support for the STARTTLS command, and Exim
30307 was built to support TLS encryption, it tries to start a TLS session unless the
30308 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
30309
30310 If the remote server advertises support for the AUTH command, Exim scans
30311 the authenticators configuration for any suitable client settings, as described
30312 in chapter &<<CHAPSMTPAUTH>>&.
30313
30314 .cindex "carriage return"
30315 .cindex "linefeed"
30316 Responses from the remote host are supposed to be terminated by CR followed by
30317 LF. However, there are known to be hosts that do not send CR characters, so in
30318 order to be able to interwork with such hosts, Exim treats LF on its own as a
30319 line terminator.
30320
30321 If a message contains a number of different addresses, all those with the same
30322 characteristics (for example, the same envelope sender) that resolve to the
30323 same set of hosts, in the same order, are sent in a single SMTP transaction,
30324 even if they are for different domains, unless there are more than the setting
30325 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
30326 they are split into groups containing no more than &%max_rcpt%&s addresses
30327 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
30328 in parallel sessions. The order of hosts with identical MX values is not
30329 significant when checking whether addresses can be batched in this way.
30330
30331 When the &(smtp)& transport suffers a temporary failure that is not
30332 message-related, Exim updates its transport-specific database, which contains
30333 records indexed by host name that remember which messages are waiting for each
30334 particular host. It also updates the retry database with new retry times.
30335
30336 .cindex "hints database" "retry keys"
30337 Exim's retry hints are based on host name plus IP address, so if one address of
30338 a multi-homed host is broken, it will soon be skipped most of the time.
30339 See the next section for more detail about error handling.
30340
30341 .cindex "SMTP" "passed connection"
30342 .cindex "SMTP" "batching over TCP/IP"
30343 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
30344 looks in the hints database for the transport to see if there are any queued
30345 messages waiting for the host to which it is connected. If it finds one, it
30346 creates a new Exim process using the &%-MC%& option (which can only be used by
30347 a process running as root or the Exim user) and passes the TCP/IP socket to it
30348 so that it can deliver another message using the same socket. The new process
30349 does only those deliveries that are routed to the connected host, and may in
30350 turn pass the socket on to a third process, and so on.
30351
30352 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
30353 limit the number of messages sent down a single TCP/IP connection.
30354
30355 .cindex "asterisk" "after IP address"
30356 The second and subsequent messages delivered down an existing connection are
30357 identified in the main log by the addition of an asterisk after the closing
30358 square bracket of the IP address.
30359
30360
30361
30362
30363 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
30364 .cindex "error" "in outgoing SMTP"
30365 .cindex "SMTP" "errors in outgoing"
30366 .cindex "host" "error"
30367 Three different kinds of error are recognized for outgoing SMTP: host errors,
30368 message errors, and recipient errors.
30369
30370 .vlist
30371 .vitem "&*Host errors*&"
30372 A host error is not associated with a particular message or with a
30373 particular recipient of a message. The host errors are:
30374
30375 .ilist
30376 Connection refused or timed out,
30377 .next
30378 Any error response code on connection,
30379 .next
30380 Any error response code to EHLO or HELO,
30381 .next
30382 Loss of connection at any time, except after &"."&,
30383 .next
30384 I/O errors at any time,
30385 .next
30386 Timeouts during the session, other than in response to MAIL, RCPT or
30387 the &"."& at the end of the data.
30388 .endlist ilist
30389
30390 For a host error, a permanent error response on connection, or in response to
30391 EHLO, causes all addresses routed to the host to be failed. Any other host
30392 error causes all addresses to be deferred, and retry data to be created for the
30393 host. It is not tried again, for any message, until its retry time arrives. If
30394 the current set of addresses are not all delivered in this run (to some
30395 alternative host), the message is added to the list of those waiting for this
30396 host, so if it is still undelivered when a subsequent successful delivery is
30397 made to the host, it will be sent down the same SMTP connection.
30398
30399 .vitem "&*Message errors*&"
30400 .cindex "message" "error"
30401 A message error is associated with a particular message when sent to a
30402 particular host, but not with a particular recipient of the message. The
30403 message errors are:
30404
30405 .ilist
30406 Any error response code to MAIL, DATA, or the &"."& that terminates
30407 the data,
30408 .next
30409 Timeout after MAIL,
30410 .next
30411 Timeout or loss of connection after the &"."& that terminates the data. A
30412 timeout after the DATA command itself is treated as a host error, as is loss of
30413 connection at any other time.
30414 .endlist ilist
30415
30416 For a message error, a permanent error response (5&'xx'&) causes all addresses
30417 to be failed, and a delivery error report to be returned to the sender. A
30418 temporary error response (4&'xx'&), or one of the timeouts, causes all
30419 addresses to be deferred. Retry data is not created for the host, but instead,
30420 a retry record for the combination of host plus message id is created. The
30421 message is not added to the list of those waiting for this host. This ensures
30422 that the failing message will not be sent to this host again until the retry
30423 time arrives. However, other messages that are routed to the host are not
30424 affected, so if it is some property of the message that is causing the error,
30425 it will not stop the delivery of other mail.
30426
30427 If the remote host specified support for the SIZE parameter in its response
30428 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
30429 over-large message will cause a message error because the error arrives as a
30430 response to MAIL.
30431
30432 .vitem "&*Recipient errors*&"
30433 .cindex "recipient" "error"
30434 A recipient error is associated with a particular recipient of a message. The
30435 recipient errors are:
30436
30437 .ilist
30438 Any error response to RCPT,
30439 .next
30440 Timeout after RCPT.
30441 .endlist
30442
30443 For a recipient error, a permanent error response (5&'xx'&) causes the
30444 recipient address to be failed, and a bounce message to be returned to the
30445 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
30446 address to be deferred, and routing retry data to be created for it. This is
30447 used to delay processing of the address in subsequent queue runs, until its
30448 routing retry time arrives. This applies to all messages, but because it
30449 operates only in queue runs, one attempt will be made to deliver a new message
30450 to the failing address before the delay starts to operate. This ensures that,
30451 if the failure is really related to the message rather than the recipient
30452 (&"message too big for this recipient"& is a possible example), other messages
30453 have a chance of getting delivered. If a delivery to the address does succeed,
30454 the retry information gets cleared, so all stuck messages get tried again, and
30455 the retry clock is reset.
30456
30457 The message is not added to the list of those waiting for this host. Use of the
30458 host for other messages is unaffected, and except in the case of a timeout,
30459 other recipients are processed independently, and may be successfully delivered
30460 in the current SMTP session. After a timeout it is of course impossible to
30461 proceed with the session, so all addresses get deferred. However, those other
30462 than the one that failed do not suffer any subsequent retry delays. Therefore,
30463 if one recipient is causing trouble, the others have a chance of getting
30464 through when a subsequent delivery attempt occurs before the failing
30465 recipient's retry time.
30466 .endlist
30467
30468 In all cases, if there are other hosts (or IP addresses) available for the
30469 current set of addresses (for example, from multiple MX records), they are
30470 tried in this run for any undelivered addresses, subject of course to their
30471 own retry data. In other words, recipient error retry data does not take effect
30472 until the next delivery attempt.
30473
30474 Some hosts have been observed to give temporary error responses to every
30475 MAIL command at certain times (&"insufficient space"& has been seen). It
30476 would be nice if such circumstances could be recognized, and defer data for the
30477 host itself created, but this is not possible within the current Exim design.
30478 What actually happens is that retry data for every (host, message) combination
30479 is created.
30480
30481 The reason that timeouts after MAIL and RCPT are treated specially is that
30482 these can sometimes arise as a result of the remote host's verification
30483 procedures. Exim makes this assumption, and treats them as if a temporary error
30484 response had been received. A timeout after &"."& is treated specially because
30485 it is known that some broken implementations fail to recognize the end of the
30486 message if the last character of the last line is a binary zero. Thus, it is
30487 helpful to treat this case as a message error.
30488
30489 Timeouts at other times are treated as host errors, assuming a problem with the
30490 host, or the connection to it. If a timeout after MAIL, RCPT,
30491 or &"."& is really a connection problem, the assumption is that at the next try
30492 the timeout is likely to occur at some other point in the dialogue, causing it
30493 then to be treated as a host error.
30494
30495 There is experimental evidence that some MTAs drop the connection after the
30496 terminating &"."& if they do not like the contents of the message for some
30497 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
30498 should be given. That is why Exim treats this case as a message rather than a
30499 host error, in order not to delay other messages to the same host.
30500
30501
30502
30503
30504 .section "Incoming SMTP messages over TCP/IP" "SECID233"
30505 .cindex "SMTP" "incoming over TCP/IP"
30506 .cindex "incoming SMTP over TCP/IP"
30507 .cindex "inetd"
30508 .cindex "daemon"
30509 Incoming SMTP messages can be accepted in one of two ways: by running a
30510 listening daemon, or by using &'inetd'&. In the latter case, the entry in
30511 &_/etc/inetd.conf_& should be like this:
30512 .code
30513 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
30514 .endd
30515 Exim distinguishes between this case and the case of a locally running user
30516 agent using the &%-bs%& option by checking whether or not the standard input is
30517 a socket. When it is, either the port must be privileged (less than 1024), or
30518 the caller must be root or the Exim user. If any other user passes a socket
30519 with an unprivileged port number, Exim prints a message on the standard error
30520 stream and exits with an error code.
30521
30522 By default, Exim does not make a log entry when a remote host connects or
30523 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
30524 unexpected. It can be made to write such log entries by setting the
30525 &%smtp_connection%& log selector.
30526
30527 .cindex "carriage return"
30528 .cindex "linefeed"
30529 Commands from the remote host are supposed to be terminated by CR followed by
30530 LF. However, there are known to be hosts that do not send CR characters. In
30531 order to be able to interwork with such hosts, Exim treats LF on its own as a
30532 line terminator.
30533 Furthermore, because common code is used for receiving messages from all
30534 sources, a CR on its own is also interpreted as a line terminator. However, the
30535 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
30536
30537 .cindex "EHLO" "invalid data"
30538 .cindex "HELO" "invalid data"
30539 One area that sometimes gives rise to problems concerns the EHLO or
30540 HELO commands. Some clients send syntactically invalid versions of these
30541 commands, which Exim rejects by default. (This is nothing to do with verifying
30542 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
30543 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
30544 match the broken hosts that send invalid commands.
30545
30546 .cindex "SIZE option on MAIL command"
30547 .cindex "MAIL" "SIZE option"
30548 The amount of disk space available is checked whenever SIZE is received on
30549 a MAIL command, independently of whether &%message_size_limit%& or
30550 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
30551 false. A temporary error is given if there is not enough space. If
30552 &%check_spool_space%& is set, the check is for that amount of space plus the
30553 value given with SIZE, that is, it checks that the addition of the incoming
30554 message will not reduce the space below the threshold.
30555
30556 When a message is successfully received, Exim includes the local message id in
30557 its response to the final &"."& that terminates the data. If the remote host
30558 logs this text it can help with tracing what has happened to a message.
30559
30560 The Exim daemon can limit the number of simultaneous incoming connections it is
30561 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
30562 number of simultaneous incoming connections from a single remote host (see the
30563 &%smtp_accept_max_per_host%& option). Additional connection attempts are
30564 rejected using the SMTP temporary error code 421.
30565
30566 The Exim daemon does not rely on the SIGCHLD signal to detect when a
30567 subprocess has finished, as this can get lost at busy times. Instead, it looks
30568 for completed subprocesses every time it wakes up. Provided there are other
30569 things happening (new incoming calls, starts of queue runs), completed
30570 processes will be noticed and tidied away. On very quiet systems you may
30571 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
30572 it will be noticed when the daemon next wakes up.
30573
30574 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
30575 and can also be set up to reject SMTP calls from non-reserved hosts at times of
30576 high system load &-- for details see the &%smtp_accept_reserve%&,
30577 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
30578 applies in both the daemon and &'inetd'& cases.
30579
30580 Exim normally starts a delivery process for each message received, though this
30581 can be varied by means of the &%-odq%& command line option and the
30582 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
30583 number of simultaneously running delivery processes started in this way from
30584 SMTP input can be limited by the &%smtp_accept_queue%& and
30585 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
30586 subsequently received messages are just put on the input queue without starting
30587 a delivery process.
30588
30589 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
30590 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
30591 started up from the &'inetd'& daemon, because in that case each connection is
30592 handled by an entirely independent Exim process. Control by load average is,
30593 however, available with &'inetd'&.
30594
30595 Exim can be configured to verify addresses in incoming SMTP commands as they
30596 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
30597 to rewrite addresses at this time &-- before any syntax checking is done. See
30598 section &<<SECTrewriteS>>&.
30599
30600 Exim can also be configured to limit the rate at which a client host submits
30601 MAIL and RCPT commands in a single SMTP session. See the
30602 &%smtp_ratelimit_hosts%& option.
30603
30604
30605
30606 .section "Unrecognized SMTP commands" "SECID234"
30607 .cindex "SMTP" "unrecognized commands"
30608 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
30609 commands during a single SMTP connection, it drops the connection after sending
30610 the error response to the last command. The default value for
30611 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
30612 abuse that subvert web servers into making connections to SMTP ports; in these
30613 circumstances, a number of non-SMTP lines are sent first.
30614
30615
30616 .section "Syntax and protocol errors in SMTP commands" "SECID235"
30617 .cindex "SMTP" "syntax errors"
30618 .cindex "SMTP" "protocol errors"
30619 A syntax error is detected if an SMTP command is recognized, but there is
30620 something syntactically wrong with its data, for example, a malformed email
30621 address in a RCPT command. Protocol errors include invalid command
30622 sequencing such as RCPT before MAIL. If Exim receives more than
30623 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
30624 drops the connection after sending the error response to the last command. The
30625 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
30626 broken clients that loop sending bad commands (yes, it has been seen).
30627
30628
30629
30630 .section "Use of non-mail SMTP commands" "SECID236"
30631 .cindex "SMTP" "non-mail commands"
30632 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
30633 DATA. Exim counts such commands, and drops the connection if there are too
30634 many of them in a single SMTP session. This action catches some
30635 denial-of-service attempts and things like repeated failing AUTHs, or a mad
30636 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
30637 defines what &"too many"& means. Its default value is 10.
30638
30639 When a new message is expected, one occurrence of RSET is not counted. This
30640 allows a client to send one RSET between messages (this is not necessary,
30641 but some clients do it). Exim also allows one uncounted occurrence of HELO
30642 or EHLO, and one occurrence of STARTTLS between messages. After
30643 starting up a TLS session, another EHLO is expected, and so it too is not
30644 counted.
30645
30646 The first occurrence of AUTH in a connection, or immediately following
30647 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
30648 RCPT, DATA, and QUIT are counted.
30649
30650 You can control which hosts are subject to the limit set by
30651 &%smtp_accept_max_nonmail%& by setting
30652 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
30653 the limit apply to all hosts. This option means that you can exclude any
30654 specific badly-behaved hosts that you have to live with.
30655
30656
30657
30658
30659 .section "The VRFY and EXPN commands" "SECID237"
30660 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
30661 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
30662 appropriate) in order to decide whether the command should be accepted or not.
30663 If no ACL is defined, the command is rejected.
30664
30665 .cindex "VRFY" "processing"
30666 When VRFY is accepted, it runs exactly the same code as when Exim is
30667 called with the &%-bv%& option.
30668
30669 .cindex "EXPN" "processing"
30670 When EXPN is accepted, a single-level expansion of the address is done.
30671 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
30672 than a verification (the &%-bv%& option). If an unqualified local part is given
30673 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
30674 of VRFY and EXPN commands are logged on the main and reject logs, and
30675 VRFY verification failures are logged on the main log for consistency with
30676 RCPT failures.
30677
30678
30679
30680 .section "The ETRN command" "SECTETRN"
30681 .cindex "ETRN" "processing"
30682 RFC 1985 describes an SMTP command called ETRN that is designed to
30683 overcome the security problems of the TURN command (which has fallen into
30684 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
30685 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
30686 should be accepted or not. If no ACL is defined, the command is rejected.
30687
30688 The ETRN command is concerned with &"releasing"& messages that are awaiting
30689 delivery to certain hosts. As Exim does not organize its message queue by host,
30690 the only form of ETRN that is supported by default is the one where the
30691 text starts with the &"#"& prefix, in which case the remainder of the text is
30692 specific to the SMTP server. A valid ETRN command causes a run of Exim with
30693 the &%-R%& option to happen, with the remainder of the ETRN text as its
30694 argument. For example,
30695 .code
30696 ETRN #brigadoon
30697 .endd
30698 runs the command
30699 .code
30700 exim -R brigadoon
30701 .endd
30702 which causes a delivery attempt on all messages with undelivered addresses
30703 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
30704 default), Exim prevents the simultaneous execution of more than one queue run
30705 for the same argument string as a result of an ETRN command. This stops
30706 a misbehaving client from starting more than one queue runner at once.
30707
30708 .cindex "hints database" "ETRN serialization"
30709 Exim implements the serialization by means of a hints database in which a
30710 record is written whenever a process is started by ETRN, and deleted when
30711 the process completes. However, Exim does not keep the SMTP session waiting for
30712 the ETRN process to complete. Once ETRN is accepted, the client is sent
30713 a &"success"& return code. Obviously there is scope for hints records to get
30714 left lying around if there is a system or program crash. To guard against this,
30715 Exim ignores any records that are more than six hours old.
30716
30717 .oindex "&%smtp_etrn_command%&"
30718 For more control over what ETRN does, the &%smtp_etrn_command%& option can
30719 used. This specifies a command that is run whenever ETRN is received,
30720 whatever the form of its argument. For
30721 example:
30722 .code
30723 smtp_etrn_command = /etc/etrn_command $domain \
30724                     $sender_host_address
30725 .endd
30726 .vindex "&$domain$&"
30727 The string is split up into arguments which are independently expanded. The
30728 expansion variable &$domain$& is set to the argument of the ETRN command,
30729 and no syntax checking is done on the contents of this argument. Exim does not
30730 wait for the command to complete, so its status code is not checked. Exim runs
30731 under its own uid and gid when receiving incoming SMTP, so it is not possible
30732 for it to change them before running the command.
30733
30734
30735
30736 .section "Incoming local SMTP" "SECID238"
30737 .cindex "SMTP" "local incoming"
30738 Some user agents use SMTP to pass messages to their local MTA using the
30739 standard input and output, as opposed to passing the envelope on the command
30740 line and writing the message to the standard input. This is supported by the
30741 &%-bs%& option. This form of SMTP is handled in the same way as incoming
30742 messages over TCP/IP (including the use of ACLs), except that the envelope
30743 sender given in a MAIL command is ignored unless the caller is trusted. In
30744 an ACL you can detect this form of SMTP input by testing for an empty host
30745 identification. It is common to have this as the first line in the ACL that
30746 runs for RCPT commands:
30747 .code
30748 accept hosts = :
30749 .endd
30750 This accepts SMTP messages from local processes without doing any other tests.
30751
30752
30753
30754 .section "Outgoing batched SMTP" "SECTbatchSMTP"
30755 .cindex "SMTP" "batched outgoing"
30756 .cindex "batched SMTP output"
30757 Both the &(appendfile)& and &(pipe)& transports can be used for handling
30758 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
30759 be output in BSMTP format. No SMTP responses are possible for this form of
30760 delivery. All it is doing is using SMTP commands as a way of transmitting the
30761 envelope along with the message.
30762
30763 The message is written to the file or pipe preceded by the SMTP commands
30764 MAIL and RCPT, and followed by a line containing a single dot. Lines in
30765 the message that start with a dot have an extra dot added. The SMTP command
30766 HELO is not normally used. If it is required, the &%message_prefix%& option
30767 can be used to specify it.
30768
30769 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
30770 one recipient address at a time by default. However, you can arrange for them
30771 to handle several addresses at once by setting the &%batch_max%& option. When
30772 this is done for BSMTP, messages may contain multiple RCPT commands. See
30773 chapter &<<CHAPbatching>>& for more details.
30774
30775 .vindex "&$host$&"
30776 When one or more addresses are routed to a BSMTP transport by a router that
30777 sets up a host list, the name of the first host on the list is available to the
30778 transport in the variable &$host$&. Here is an example of such a transport and
30779 router:
30780 .code
30781 begin routers
30782 route_append:
30783   driver = manualroute
30784   transport = smtp_appendfile
30785   route_list = domain.example  batch.host.example
30786
30787 begin transports
30788 smtp_appendfile:
30789   driver = appendfile
30790   directory = /var/bsmtp/$host
30791   batch_max = 1000
30792   use_bsmtp
30793   user = exim
30794 .endd
30795 This causes messages addressed to &'domain.example'& to be written in BSMTP
30796 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
30797 message (unless there are more than 1000 recipients).
30798
30799
30800
30801 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
30802 .cindex "SMTP" "batched incoming"
30803 .cindex "batched SMTP input"
30804 The &%-bS%& command line option causes Exim to accept one or more messages by
30805 reading SMTP on the standard input, but to generate no responses. If the caller
30806 is trusted, the senders in the MAIL commands are believed; otherwise the
30807 sender is always the caller of Exim. Unqualified senders and receivers are not
30808 rejected (there seems little point) but instead just get qualified. HELO
30809 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
30810 as NOOP; QUIT quits.
30811
30812 No policy checking is done for BSMTP input. That is, no ACL is run at anytime.
30813 In this respect it is like non-SMTP local input.
30814
30815 If an error is detected while reading a message, including a missing &"."& at
30816 the end, Exim gives up immediately. It writes details of the error to the
30817 standard output in a stylized way that the calling program should be able to
30818 make some use of automatically, for example:
30819 .code
30820 554 Unexpected end of file
30821 Transaction started in line 10
30822 Error detected in line 14
30823 .endd
30824 It writes a more verbose version, for human consumption, to the standard error
30825 file, for example:
30826 .code
30827 An error was detected while processing a file of BSMTP input.
30828 The error message was:
30829
30830 501 '>' missing at end of address
30831
30832 The SMTP transaction started in line 10.
30833 The error was detected in line 12.
30834 The SMTP command at fault was:
30835
30836 rcpt to:<malformed@in.com.plete
30837
30838 1 previous message was successfully processed.
30839 The rest of the batch was abandoned.
30840 .endd
30841 The return code from Exim is zero only if there were no errors. It is 1 if some
30842 messages were accepted before an error was detected, and 2 if no messages were
30843 accepted.
30844 .ecindex IIDsmtpproc1
30845 .ecindex IIDsmtpproc2
30846
30847
30848
30849 . ////////////////////////////////////////////////////////////////////////////
30850 . ////////////////////////////////////////////////////////////////////////////
30851
30852 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
30853          "Customizing messages"
30854 When a message fails to be delivered, or remains on the queue for more than a
30855 configured amount of time, Exim sends a message to the original sender, or
30856 to an alternative configured address. The text of these messages is built into
30857 the code of Exim, but it is possible to change it, either by adding a single
30858 string, or by replacing each of the paragraphs by text supplied in a file.
30859
30860 The &'From:'& and &'To:'& header lines are automatically generated; you can
30861 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
30862 option. Exim also adds the line
30863 .code
30864 Auto-Submitted: auto-generated
30865 .endd
30866 to all warning and bounce messages,
30867
30868
30869 .section "Customizing bounce messages" "SECID239"
30870 .cindex "customizing" "bounce message"
30871 .cindex "bounce message" "customizing"
30872 If &%bounce_message_text%& is set, its contents are included in the default
30873 message immediately after &"This message was created automatically by mail
30874 delivery software."& The string is not expanded. It is not used if
30875 &%bounce_message_file%& is set.
30876
30877 When &%bounce_message_file%& is set, it must point to a template file for
30878 constructing error messages. The file consists of a series of text items,
30879 separated by lines consisting of exactly four asterisks. If the file cannot be
30880 opened, default text is used and a message is written to the main and panic
30881 logs. If any text item in the file is empty, default text is used for that
30882 item.
30883
30884 .vindex "&$bounce_recipient$&"
30885 .vindex "&$bounce_return_size_limit$&"
30886 Each item of text that is read from the file is expanded, and there are two
30887 expansion variables which can be of use here: &$bounce_recipient$& is set to
30888 the recipient of an error message while it is being created, and
30889 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
30890 option, rounded to a whole number.
30891
30892 The items must appear in the file in the following order:
30893
30894 .ilist
30895 The first item is included in the headers, and should include at least a
30896 &'Subject:'& header. Exim does not check the syntax of these headers.
30897 .next
30898 The second item forms the start of the error message. After it, Exim lists the
30899 failing addresses with their error messages.
30900 .next
30901 The third item is used to introduce any text from pipe transports that is to be
30902 returned to the sender. It is omitted if there is no such text.
30903 .next
30904 The fourth item is used to introduce the copy of the message that is returned
30905 as part of the error report.
30906 .next
30907 The fifth item is added after the fourth one if the returned message is
30908 truncated because it is bigger than &%return_size_limit%&.
30909 .next
30910 The sixth item is added after the copy of the original message.
30911 .endlist
30912
30913 The default state (&%bounce_message_file%& unset) is equivalent to the
30914 following file, in which the sixth item is empty. The &'Subject:'& and some
30915 other lines have been split in order to fit them on the page:
30916 .code
30917 Subject: Mail delivery failed
30918   ${if eq{$sender_address}{$bounce_recipient}
30919   {: returning message to sender}}
30920 ****
30921 This message was created automatically by mail delivery software.
30922
30923 A message ${if eq{$sender_address}{$bounce_recipient}
30924   {that you sent }{sent by
30925
30926 <$sender_address>
30927
30928 }}could not be delivered to all of its recipients.
30929 This is a permanent error. The following address(es) failed:
30930 ****
30931 The following text was generated during the delivery attempt(s):
30932 ****
30933 ------ This is a copy of the message, including all the headers.
30934   ------
30935 ****
30936 ------ The body of the message is $message_size characters long;
30937   only the first
30938 ------ $bounce_return_size_limit or so are included here.
30939 ****
30940 .endd
30941 .section "Customizing warning messages" "SECTcustwarn"
30942 .cindex "customizing" "warning message"
30943 .cindex "warning of delay" "customizing the message"
30944 The option &%warn_message_file%& can be pointed at a template file for use when
30945 warnings about message delays are created. In this case there are only three
30946 text sections:
30947
30948 .ilist
30949 The first item is included in the headers, and should include at least a
30950 &'Subject:'& header. Exim does not check the syntax of these headers.
30951 .next
30952 The second item forms the start of the warning message. After it, Exim lists
30953 the delayed addresses.
30954 .next
30955 The third item then ends the message.
30956 .endlist
30957
30958 The default state is equivalent to the following file, except that some lines
30959 have been split here, in order to fit them on the page:
30960 .code
30961 Subject: Warning: message $message_exim_id delayed
30962   $warn_message_delay
30963 ****
30964 This message was created automatically by mail delivery software.
30965
30966 A message ${if eq{$sender_address}{$warn_message_recipients}
30967 {that you sent }{sent by
30968
30969 <$sender_address>
30970
30971 }}has not been delivered to all of its recipients after
30972 more than $warn_message_delay on the queue on $primary_hostname.
30973
30974 The message identifier is:     $message_exim_id
30975 The subject of the message is: $h_subject
30976 The date of the message is:    $h_date
30977
30978 The following address(es) have not yet been delivered:
30979 ****
30980 No action is required on your part. Delivery attempts will
30981 continue for some time, and this warning may be repeated at
30982 intervals if the message remains undelivered. Eventually the
30983 mail delivery software will give up, and when that happens,
30984 the message will be returned to you.
30985 .endd
30986 .vindex "&$warn_message_delay$&"
30987 .vindex "&$warn_message_recipients$&"
30988 However, in the default state the subject and date lines are omitted if no
30989 appropriate headers exist. During the expansion of this file,
30990 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
30991 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
30992 of recipients for the warning message. There may be more than one if there are
30993 multiple addresses with different &%errors_to%& settings on the routers that
30994 handled them.
30995
30996
30997
30998
30999 . ////////////////////////////////////////////////////////////////////////////
31000 . ////////////////////////////////////////////////////////////////////////////
31001
31002 .chapter "Some common configuration settings" "CHAPcomconreq"
31003 This chapter discusses some configuration settings that seem to be fairly
31004 common. More examples and discussion can be found in the Exim book.
31005
31006
31007
31008 .section "Sending mail to a smart host" "SECID240"
31009 .cindex "smart host" "example router"
31010 If you want to send all mail for non-local domains to a &"smart host"&, you
31011 should replace the default &(dnslookup)& router with a router which does the
31012 routing explicitly:
31013 .code
31014 send_to_smart_host:
31015   driver = manualroute
31016   route_list = !+local_domains smart.host.name
31017   transport = remote_smtp
31018 .endd
31019 You can use the smart host's IP address instead of the name if you wish.
31020 If you are using Exim only to submit messages to a smart host, and not for
31021 receiving incoming messages, you can arrange for it to do the submission
31022 synchronously by setting the &%mua_wrapper%& option (see chapter
31023 &<<CHAPnonqueueing>>&).
31024
31025
31026
31027
31028 .section "Using Exim to handle mailing lists" "SECTmailinglists"
31029 .cindex "mailing lists"
31030 Exim can be used to run simple mailing lists, but for large and/or complicated
31031 requirements, the use of additional specialized mailing list software such as
31032 Majordomo or Mailman is recommended.
31033
31034 The &(redirect)& router can be used to handle mailing lists where each list
31035 is maintained in a separate file, which can therefore be managed by an
31036 independent manager. The &%domains%& router option can be used to run these
31037 lists in a separate domain from normal mail. For example:
31038 .code
31039 lists:
31040   driver = redirect
31041   domains = lists.example
31042   file = /usr/lists/$local_part
31043   forbid_pipe
31044   forbid_file
31045   errors_to = $local_part-request@lists.example
31046   no_more
31047 .endd
31048 This router is skipped for domains other than &'lists.example'&. For addresses
31049 in that domain, it looks for a file that matches the local part. If there is no
31050 such file, the router declines, but because &%no_more%& is set, no subsequent
31051 routers are tried, and so the whole delivery fails.
31052
31053 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
31054 expanded into a file name or a pipe delivery, which is usually inappropriate in
31055 a mailing list.
31056
31057 .oindex "&%errors_to%&"
31058 The &%errors_to%& option specifies that any delivery errors caused by addresses
31059 taken from a mailing list are to be sent to the given address rather than the
31060 original sender of the message. However, before acting on this, Exim verifies
31061 the error address, and ignores it if verification fails.
31062
31063 For example, using the configuration above, mail sent to
31064 &'dicts@lists.example'& is passed on to those addresses contained in
31065 &_/usr/lists/dicts_&, with error reports directed to
31066 &'dicts-request@lists.example'&, provided that this address can be verified.
31067 There could be a file called &_/usr/lists/dicts-request_& containing
31068 the address(es) of this particular list's manager(s), but other approaches,
31069 such as setting up an earlier router (possibly using the &%local_part_prefix%&
31070 or &%local_part_suffix%& options) to handle addresses of the form
31071 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
31072
31073
31074
31075 .section "Syntax errors in mailing lists" "SECID241"
31076 .cindex "mailing lists" "syntax errors in"
31077 If an entry in redirection data contains a syntax error, Exim normally defers
31078 delivery of the original address. That means that a syntax error in a mailing
31079 list holds up all deliveries to the list. This may not be appropriate when a
31080 list is being maintained automatically from data supplied by users, and the
31081 addresses are not rigorously checked.
31082
31083 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
31084 entries that fail to parse, noting the incident in the log. If in addition
31085 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
31086 whenever a broken address is skipped. It is usually appropriate to set
31087 &%syntax_errors_to%& to the same address as &%errors_to%&.
31088
31089
31090
31091 .section "Re-expansion of mailing lists" "SECID242"
31092 .cindex "mailing lists" "re-expansion of"
31093 Exim remembers every individual address to which a message has been delivered,
31094 in order to avoid duplication, but it normally stores only the original
31095 recipient addresses with a message. If all the deliveries to a mailing list
31096 cannot be done at the first attempt, the mailing list is re-expanded when the
31097 delivery is next tried. This means that alterations to the list are taken into
31098 account at each delivery attempt, so addresses that have been added to
31099 the list since the message arrived will therefore receive a copy of the
31100 message, even though it pre-dates their subscription.
31101
31102 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
31103 on the &(redirect)& router. If this is done, any addresses generated by the
31104 router that fail to deliver at the first attempt are added to the message as
31105 &"top level"& addresses, and the parent address that generated them is marked
31106 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
31107 subsequent delivery attempts. The disadvantage of this is that if any of the
31108 failing addresses are incorrect, correcting them in the file has no effect on
31109 pre-existing messages.
31110
31111 The original top-level address is remembered with each of the generated
31112 addresses, and is output in any log messages. However, any intermediate parent
31113 addresses are not recorded. This makes a difference to the log only if the
31114 &%all_parents%& selector is set, but for mailing lists there is normally only
31115 one level of expansion anyway.
31116
31117
31118
31119 .section "Closed mailing lists" "SECID243"
31120 .cindex "mailing lists" "closed"
31121 The examples so far have assumed open mailing lists, to which anybody may
31122 send mail. It is also possible to set up closed lists, where mail is accepted
31123 from specified senders only. This is done by making use of the generic
31124 &%senders%& option to restrict the router that handles the list.
31125
31126 The following example uses the same file as a list of recipients and as a list
31127 of permitted senders. It requires three routers:
31128 .code
31129 lists_request:
31130   driver = redirect
31131   domains = lists.example
31132   local_part_suffix = -request
31133   file = /usr/lists/$local_part$local_part_suffix
31134   no_more
31135
31136 lists_post:
31137   driver = redirect
31138   domains = lists.example
31139   senders = ${if exists {/usr/lists/$local_part}\
31140              {lsearch;/usr/lists/$local_part}{*}}
31141   file = /usr/lists/$local_part
31142   forbid_pipe
31143   forbid_file
31144   errors_to = $local_part-request@lists.example
31145   no_more
31146
31147 lists_closed:
31148   driver = redirect
31149   domains = lists.example
31150   allow_fail
31151   data = :fail: $local_part@lists.example is a closed mailing list
31152 .endd
31153 All three routers have the same &%domains%& setting, so for any other domains,
31154 they are all skipped. The first router runs only if the local part ends in
31155 &%-request%&. It handles messages to the list manager(s) by means of an open
31156 mailing list.
31157
31158 The second router runs only if the &%senders%& precondition is satisfied. It
31159 checks for the existence of a list that corresponds to the local part, and then
31160 checks that the sender is on the list by means of a linear search. It is
31161 necessary to check for the existence of the file before trying to search it,
31162 because otherwise Exim thinks there is a configuration error. If the file does
31163 not exist, the expansion of &%senders%& is *, which matches all senders. This
31164 means that the router runs, but because there is no list, declines, and
31165 &%no_more%& ensures that no further routers are run. The address fails with an
31166 &"unrouteable address"& error.
31167
31168 The third router runs only if the second router is skipped, which happens when
31169 a mailing list exists, but the sender is not on it. This router forcibly fails
31170 the address, giving a suitable error message.
31171
31172
31173
31174
31175 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
31176 .cindex "VERP"
31177 .cindex "Variable Envelope Return Paths"
31178 .cindex "envelope sender"
31179 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
31180 are a way of helping mailing list administrators discover which subscription
31181 address is the cause of a particular delivery failure. The idea is to encode
31182 the original recipient address in the outgoing envelope sender address, so that
31183 if the message is forwarded by another host and then subsequently bounces, the
31184 original recipient can be extracted from the recipient address of the bounce.
31185
31186 .oindex &%errors_to%&
31187 .oindex &%return_path%&
31188 Envelope sender addresses can be modified by Exim using two different
31189 facilities: the &%errors_to%& option on a router (as shown in previous mailing
31190 list examples), or the &%return_path%& option on a transport. The second of
31191 these is effective only if the message is successfully delivered to another
31192 host; it is not used for errors detected on the local host (see the description
31193 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
31194 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
31195 .code
31196 verp_smtp:
31197   driver = smtp
31198   max_rcpt = 1
31199   return_path = \
31200     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
31201       {$1-request+$local_part=$domain@your.dom.example}fail}
31202 .endd
31203 This has the effect of rewriting the return path (envelope sender) on outgoing
31204 SMTP messages, if the local part of the original return path ends in
31205 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
31206 local part and domain of the recipient into the return path. Suppose, for
31207 example, that a message whose return path has been set to
31208 &'somelist-request@your.dom.example'& is sent to
31209 &'subscriber@other.dom.example'&. In the transport, the return path is
31210 rewritten as
31211 .code
31212 somelist-request+subscriber=other.dom.example@your.dom.example
31213 .endd
31214 .vindex "&$local_part$&"
31215 For this to work, you must tell Exim to send multiple copies of messages that
31216 have more than one recipient, so that each copy has just one recipient. This is
31217 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
31218 might be sent to several different recipients in the same domain, in which case
31219 &$local_part$& is not available in the transport, because it is not unique.
31220
31221 Unless your host is doing nothing but mailing list deliveries, you should
31222 probably use a separate transport for the VERP deliveries, so as not to use
31223 extra resources in making one-per-recipient copies for other deliveries. This
31224 can easily be done by expanding the &%transport%& option in the router:
31225 .code
31226 dnslookup:
31227   driver = dnslookup
31228   domains = ! +local_domains
31229   transport = \
31230     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
31231       {verp_smtp}{remote_smtp}}
31232   no_more
31233 .endd
31234 If you want to change the return path using &%errors_to%& in a router instead
31235 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
31236 routers that handle mailing list addresses. This will ensure that all delivery
31237 errors, including those detected on the local host, are sent to the VERP
31238 address.
31239
31240 On a host that does no local deliveries and has no manual routing, only the
31241 &(dnslookup)& router needs to be changed. A special transport is not needed for
31242 SMTP deliveries. Every mailing list recipient has its own return path value,
31243 and so Exim must hand them to the transport one at a time. Here is an example
31244 of a &(dnslookup)& router that implements VERP:
31245 .code
31246 verp_dnslookup:
31247   driver = dnslookup
31248   domains = ! +local_domains
31249   transport = remote_smtp
31250   errors_to = \
31251     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
31252      {$1-request+$local_part=$domain@your.dom.example}fail}
31253   no_more
31254 .endd
31255 Before you start sending out messages with VERPed return paths, you must also
31256 configure Exim to accept the bounce messages that come back to those paths.
31257 Typically this is done by setting a &%local_part_suffix%& option for a
31258 router, and using this to route the messages to wherever you want to handle
31259 them.
31260
31261 The overhead incurred in using VERP depends very much on the size of the
31262 message, the number of recipient addresses that resolve to the same remote
31263 host, and the speed of the connection over which the message is being sent. If
31264 a lot of addresses resolve to the same host and the connection is slow, sending
31265 a separate copy of the message for each address may take substantially longer
31266 than sending a single copy with many recipients (for which VERP cannot be
31267 used).
31268
31269
31270
31271
31272
31273
31274 .section "Virtual domains" "SECTvirtualdomains"
31275 .cindex "virtual domains"
31276 .cindex "domain" "virtual"
31277 The phrase &'virtual domain'& is unfortunately used with two rather different
31278 meanings:
31279
31280 .ilist
31281 A domain for which there are no real mailboxes; all valid local parts are
31282 aliases for other email addresses. Common examples are organizational
31283 top-level domains and &"vanity"& domains.
31284 .next
31285 One of a number of independent domains that are all handled by the same host,
31286 with mailboxes on that host, but where the mailbox owners do not necessarily
31287 have login accounts on that host.
31288 .endlist
31289
31290 The first usage is probably more common, and does seem more &"virtual"& than
31291 the second. This kind of domain can be handled in Exim with a straightforward
31292 aliasing router. One approach is to create a separate alias file for each
31293 virtual domain. Exim can test for the existence of the alias file to determine
31294 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
31295 to a router of this form:
31296 .code
31297 virtual:
31298   driver = redirect
31299   domains = dsearch;/etc/mail/virtual
31300   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
31301   no_more
31302 .endd
31303 The &%domains%& option specifies that the router is to be skipped, unless there
31304 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
31305 domain that is being processed. When the router runs, it looks up the local
31306 part in the file to find a new address (or list of addresses). The &%no_more%&
31307 setting ensures that if the lookup fails (leading to &%data%& being an empty
31308 string), Exim gives up on the address without trying any subsequent routers.
31309
31310 This one router can handle all the virtual domains because the alias file names
31311 follow a fixed pattern. Permissions can be arranged so that appropriate people
31312 can edit the different alias files. A successful aliasing operation results in
31313 a new envelope recipient address, which is then routed from scratch.
31314
31315 The other kind of &"virtual"& domain can also be handled in a straightforward
31316 way. One approach is to create a file for each domain containing a list of
31317 valid local parts, and use it in a router like this:
31318 .code
31319 my_domains:
31320   driver = accept
31321   domains = dsearch;/etc/mail/domains
31322   local_parts = lsearch;/etc/mail/domains/$domain
31323   transport = my_mailboxes
31324 .endd
31325 The address is accepted if there is a file for the domain, and the local part
31326 can be found in the file. The &%domains%& option is used to check for the
31327 file's existence because &%domains%& is tested before the &%local_parts%&
31328 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
31329 because that option is tested after &%local_parts%&. The transport is as
31330 follows:
31331 .code
31332 my_mailboxes:
31333   driver = appendfile
31334   file = /var/mail/$domain/$local_part
31335   user = mail
31336 .endd
31337 This uses a directory of mailboxes for each domain. The &%user%& setting is
31338 required, to specify which uid is to be used for writing to the mailboxes.
31339
31340 The configuration shown here is just one example of how you might support this
31341 requirement. There are many other ways this kind of configuration can be set
31342 up, for example, by using a database instead of separate files to hold all the
31343 information about the domains.
31344
31345
31346
31347 .section "Multiple user mailboxes" "SECTmulbox"
31348 .cindex "multiple mailboxes"
31349 .cindex "mailbox" "multiple"
31350 .cindex "local part" "prefix"
31351 .cindex "local part" "suffix"
31352 Heavy email users often want to operate with multiple mailboxes, into which
31353 incoming mail is automatically sorted. A popular way of handling this is to
31354 allow users to use multiple sender addresses, so that replies can easily be
31355 identified. Users are permitted to add prefixes or suffixes to their local
31356 parts for this purpose. The wildcard facility of the generic router options
31357 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
31358 example, consider this router:
31359 .code
31360 userforward:
31361   driver = redirect
31362   check_local_user
31363   file = $home/.forward
31364   local_part_suffix = -*
31365   local_part_suffix_optional
31366   allow_filter
31367 .endd
31368 .vindex "&$local_part_suffix$&"
31369 It runs a user's &_.forward_& file for all local parts of the form
31370 &'username-*'&. Within the filter file the user can distinguish different
31371 cases by testing the variable &$local_part_suffix$&. For example:
31372 .code
31373 if $local_part_suffix contains -special then
31374 save /home/$local_part/Mail/special
31375 endif
31376 .endd
31377 If the filter file does not exist, or does not deal with such addresses, they
31378 fall through to subsequent routers, and, assuming no subsequent use of the
31379 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
31380 control over which suffixes are valid.
31381
31382 Alternatively, a suffix can be used to trigger the use of a different
31383 &_.forward_& file &-- which is the way a similar facility is implemented in
31384 another MTA:
31385 .code
31386 userforward:
31387   driver = redirect
31388   check_local_user
31389   file = $home/.forward$local_part_suffix
31390   local_part_suffix = -*
31391   local_part_suffix_optional
31392   allow_filter
31393 .endd
31394 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
31395 example, &_.forward-special_& is used. Once again, if the appropriate file
31396 does not exist, or does not deal with the address, it is passed on to
31397 subsequent routers, which could, if required, look for an unqualified
31398 &_.forward_& file to use as a default.
31399
31400
31401
31402 .section "Simplified vacation processing" "SECID244"
31403 .cindex "vacation processing"
31404 The traditional way of running the &'vacation'& program is for a user to set up
31405 a pipe command in a &_.forward_& file
31406 (see section &<<SECTspecitredli>>& for syntax details).
31407 This is prone to error by inexperienced users. There are two features of Exim
31408 that can be used to make this process simpler for users:
31409
31410 .ilist
31411 A local part prefix such as &"vacation-"& can be specified on a router which
31412 can cause the message to be delivered directly to the &'vacation'& program, or
31413 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
31414 &_.forward_& file are then much simpler. For example:
31415 .code
31416 spqr, vacation-spqr
31417 .endd
31418 .next
31419 The &%require_files%& generic router option can be used to trigger a
31420 vacation delivery by checking for the existence of a certain file in the
31421 user's home directory. The &%unseen%& generic option should also be used, to
31422 ensure that the original delivery also proceeds. In this case, all the user has
31423 to do is to create a file called, say, &_.vacation_&, containing a vacation
31424 message.
31425 .endlist
31426
31427 Another advantage of both these methods is that they both work even when the
31428 use of arbitrary pipes by users is locked out.
31429
31430
31431
31432 .section "Taking copies of mail" "SECID245"
31433 .cindex "message" "copying every"
31434 Some installations have policies that require archive copies of all messages to
31435 be made. A single copy of each message can easily be taken by an appropriate
31436 command in a system filter, which could, for example, use a different file for
31437 each day's messages.
31438
31439 There is also a shadow transport mechanism that can be used to take copies of
31440 messages that are successfully delivered by local transports, one copy per
31441 delivery. This could be used, &'inter alia'&, to implement automatic
31442 notification of delivery by sites that insist on doing such things.
31443
31444
31445
31446 .section "Intermittently connected hosts" "SECID246"
31447 .cindex "intermittently connected hosts"
31448 It has become quite common (because it is cheaper) for hosts to connect to the
31449 Internet periodically rather than remain connected all the time. The normal
31450 arrangement is that mail for such hosts accumulates on a system that is
31451 permanently connected.
31452
31453 Exim was designed for use on permanently connected hosts, and so it is not
31454 particularly well-suited to use in an intermittently connected environment.
31455 Nevertheless there are some features that can be used.
31456
31457
31458 .section "Exim on the upstream server host" "SECID247"
31459 It is tempting to arrange for incoming mail for the intermittently connected
31460 host to remain on Exim's queue until the client connects. However, this
31461 approach does not scale very well. Two different kinds of waiting message are
31462 being mixed up in the same queue &-- those that cannot be delivered because of
31463 some temporary problem, and those that are waiting for their destination host
31464 to connect. This makes it hard to manage the queue, as well as wasting
31465 resources, because each queue runner scans the entire queue.
31466
31467 A better approach is to separate off those messages that are waiting for an
31468 intermittently connected host. This can be done by delivering these messages
31469 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
31470 format, from where they are transmitted by other software when their
31471 destination connects. This makes it easy to collect all the mail for one host
31472 in a single directory, and to apply local timeout rules on a per-message basis
31473 if required.
31474
31475 On a very small scale, leaving the mail on Exim's queue can be made to work. If
31476 you are doing this, you should configure Exim with a long retry period for the
31477 intermittent host. For example:
31478 .code
31479 cheshire.wonderland.fict.example    *   F,5d,24h
31480 .endd
31481 This stops a lot of failed delivery attempts from occurring, but Exim remembers
31482 which messages it has queued up for that host. Once the intermittent host comes
31483 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
31484 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
31485 causes all the queued up messages to be delivered, often down a single SMTP
31486 connection. While the host remains connected, any new messages get delivered
31487 immediately.
31488
31489 If the connecting hosts do not have fixed IP addresses, that is, if a host is
31490 issued with a different IP address each time it connects, Exim's retry
31491 mechanisms on the holding host get confused, because the IP address is normally
31492 used as part of the key string for holding retry information. This can be
31493 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
31494 Since this has disadvantages for permanently connected hosts, it is best to
31495 arrange a separate transport for the intermittently connected ones.
31496
31497
31498
31499 .section "Exim on the intermittently connected client host" "SECID248"
31500 The value of &%smtp_accept_queue_per_connection%& should probably be
31501 increased, or even set to zero (that is, disabled) on the intermittently
31502 connected host, so that all incoming messages down a single connection get
31503 delivered immediately.
31504
31505 .cindex "SMTP" "passed connection"
31506 .cindex "SMTP" "multiple deliveries"
31507 .cindex "multiple SMTP deliveries"
31508 Mail waiting to be sent from an intermittently connected host will probably
31509 not have been routed, because without a connection DNS lookups are not
31510 possible. This means that if a normal queue run is done at connection time,
31511 each message is likely to be sent in a separate SMTP session. This can be
31512 avoided by starting the queue run with a command line option beginning with
31513 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
31514 first pass, routing is done but no deliveries take place. The second pass is a
31515 normal queue run; since all the messages have been previously routed, those
31516 destined for the same host are likely to get sent as multiple deliveries in a
31517 single SMTP connection.
31518
31519
31520
31521 . ////////////////////////////////////////////////////////////////////////////
31522 . ////////////////////////////////////////////////////////////////////////////
31523
31524 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
31525          "Exim as a non-queueing client"
31526 .cindex "client, non-queueing"
31527 .cindex "smart host" "suppressing queueing"
31528 On a personal computer, it is a common requirement for all
31529 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
31530 configured to operate that way, for all the popular operating systems.
31531 However, there are some MUAs for Unix-like systems that cannot be so
31532 configured: they submit messages using the command line interface of
31533 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
31534 messages this way.
31535
31536 If the personal computer runs continuously, there is no problem, because it can
31537 run a conventional MTA that handles delivery to the smart host, and deal with
31538 any delays via its queueing mechanism. However, if the computer does not run
31539 continuously or runs different operating systems at different times, queueing
31540 email is not desirable.
31541
31542 There is therefore a requirement for something that can provide the
31543 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
31544 any queueing or retrying facilities. Furthermore, the delivery to the smart
31545 host should be synchronous, so that if it fails, the sending MUA is immediately
31546 informed. In other words, we want something that extends an MUA that submits
31547 to a local MTA via the command line so that it behaves like one that submits
31548 to a remote smart host using TCP/SMTP.
31549
31550 There are a number of applications (for example, there is one called &'ssmtp'&)
31551 that do this job. However, people have found them to be lacking in various
31552 ways. For instance, you might want to allow aliasing and forwarding to be done
31553 before sending a message to the smart host.
31554
31555 Exim already had the necessary infrastructure for doing this job. Just a few
31556 tweaks were needed to make it behave as required, though it is somewhat of an
31557 overkill to use a fully-featured MTA for this purpose.
31558
31559 .oindex "&%mua_wrapper%&"
31560 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
31561 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
31562 assumes that it is being used to &"wrap"& a command-line MUA in the manner
31563 just described. As well as setting &%mua_wrapper%&, you also need to provide a
31564 compatible router and transport configuration. Typically there will be just one
31565 router and one transport, sending everything to a smart host.
31566
31567 When run in MUA wrapping mode, the behaviour of Exim changes in the
31568 following ways:
31569
31570 .ilist
31571 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
31572 In other words, the only way to submit messages is via the command line.
31573 .next
31574 Each message is synchronously delivered as soon as it is received (&%-odi%& is
31575 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
31576 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
31577 does not finish until the delivery attempt is complete. If the delivery is
31578 successful, a zero return code is given.
31579 .next
31580 Address redirection is permitted, but the final routing for all addresses must
31581 be to the same remote transport, and to the same list of hosts. Furthermore,
31582 the return address (envelope sender) must be the same for all recipients, as
31583 must any added or deleted header lines. In other words, it must be possible to
31584 deliver the message in a single SMTP transaction, however many recipients there
31585 are.
31586 .next
31587 If these conditions are not met, or if routing any address results in a
31588 failure or defer status, or if Exim is unable to deliver all the recipients
31589 successfully to one of the smart hosts, delivery of the entire message fails.
31590 .next
31591 Because no queueing is allowed, all failures are treated as permanent; there
31592 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
31593 smart host. Furthermore, because only a single yes/no response can be given to
31594 the caller, it is not possible to deliver to some recipients and not others. If
31595 there is an error (temporary or permanent) for any recipient, all are failed.
31596 .next
31597 If more than one smart host is listed, Exim will try another host after a
31598 connection failure or a timeout, in the normal way. However, if this kind of
31599 failure happens for all the hosts, the delivery fails.
31600 .next
31601 When delivery fails, an error message is written to the standard error stream
31602 (as well as to Exim's log), and Exim exits to the caller with a return code
31603 value 1. The message is expunged from Exim's spool files. No bounce messages
31604 are ever generated.
31605 .next
31606 No retry data is maintained, and any retry rules are ignored.
31607 .next
31608 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
31609 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
31610 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
31611 .endlist
31612
31613 The overall effect is that Exim makes a single synchronous attempt to deliver
31614 the message, failing if there is any kind of problem. Because no local
31615 deliveries are done and no daemon can be run, Exim does not need root
31616 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
31617 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
31618 the advantages and disadvantages of running without root privilege.
31619
31620
31621
31622
31623 . ////////////////////////////////////////////////////////////////////////////
31624 . ////////////////////////////////////////////////////////////////////////////
31625
31626 .chapter "Log files" "CHAPlog"
31627 .scindex IIDloggen "log" "general description"
31628 .cindex "log" "types of"
31629 Exim writes three different logs, referred to as the main log, the reject log,
31630 and the panic log:
31631
31632 .ilist
31633 .cindex "main log"
31634 The main log records the arrival of each message and each delivery in a single
31635 line in each case. The format is as compact as possible, in an attempt to keep
31636 down the size of log files. Two-character flag sequences make it easy to pick
31637 out these lines. A number of other events are recorded in the main log. Some of
31638 them are optional, in which case the &%log_selector%& option controls whether
31639 they are included or not. A Perl script called &'eximstats'&, which does simple
31640 analysis of main log files, is provided in the Exim distribution (see section
31641 &<<SECTmailstat>>&).
31642 .next
31643 .cindex "reject log"
31644 The reject log records information from messages that are rejected as a result
31645 of a configuration option (that is, for policy reasons).
31646 The first line of each rejection is a copy of the line that is also written to
31647 the main log. Then, if the message's header has been read at the time the log
31648 is written, its contents are written to this log. Only the original header
31649 lines are available; header lines added by ACLs are not logged. You can use the
31650 reject log to check that your policy controls are working correctly; on a busy
31651 host this may be easier than scanning the main log for rejection messages. You
31652 can suppress the writing of the reject log by setting &%write_rejectlog%&
31653 false.
31654 .next
31655 .cindex "panic log"
31656 .cindex "system log"
31657 When certain serious errors occur, Exim writes entries to its panic log. If the
31658 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
31659 are usually written to the main log as well, but can get lost amid the mass of
31660 other entries. The panic log should be empty under normal circumstances. It is
31661 therefore a good idea to check it (or to have a &'cron'& script check it)
31662 regularly, in order to become aware of any problems. When Exim cannot open its
31663 panic log, it tries as a last resort to write to the system log (syslog). This
31664 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
31665 message itself is written at priority LOG_CRIT.
31666 .endlist
31667
31668 Every log line starts with a timestamp, in the format shown in the following
31669 example. Note that many of the examples shown in this chapter are line-wrapped.
31670 In the log file, this would be all on one line:
31671 .code
31672 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
31673   by QUIT
31674 .endd
31675 By default, the timestamps are in the local timezone. There are two
31676 ways of changing this:
31677
31678 .ilist
31679 You can set the &%timezone%& option to a different time zone; in particular, if
31680 you set
31681 .code
31682 timezone = UTC
31683 .endd
31684 the timestamps will be in UTC (aka GMT).
31685 .next
31686 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
31687 example:
31688 .code
31689 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
31690 .endd
31691 .endlist
31692
31693 .cindex "log" "process ids in"
31694 .cindex "pid (process id)" "in log lines"
31695 Exim does not include its process id in log lines by default, but you can
31696 request that it does so by specifying the &`pid`& log selector (see section
31697 &<<SECTlogselector>>&). When this is set, the process id is output, in square
31698 brackets, immediately after the time and date.
31699
31700
31701
31702
31703 .section "Where the logs are written" "SECTwhelogwri"
31704 .cindex "log" "destination"
31705 .cindex "log" "to file"
31706 .cindex "log" "to syslog"
31707 .cindex "syslog"
31708 The logs may be written to local files, or to syslog, or both. However, it
31709 should be noted that many syslog implementations use UDP as a transport, and
31710 are therefore unreliable in the sense that messages are not guaranteed to
31711 arrive at the loghost, nor is the ordering of messages necessarily maintained.
31712 It has also been reported that on large log files (tens of megabytes) you may
31713 need to tweak syslog to prevent it syncing the file with each write &-- on
31714 Linux this has been seen to make syslog take 90% plus of CPU time.
31715
31716 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
31717 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
31718 configuration. This latter string is expanded, so it can contain, for example,
31719 references to the host name:
31720 .code
31721 log_file_path = /var/log/$primary_hostname/exim_%slog
31722 .endd
31723 It is generally advisable, however, to set the string in &_Local/Makefile_&
31724 rather than at run time, because then the setting is available right from the
31725 start of Exim's execution. Otherwise, if there's something it wants to log
31726 before it has read the configuration file (for example, an error in the
31727 configuration file) it will not use the path you want, and may not be able to
31728 log at all.
31729
31730 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
31731 list, currently limited to at most two items. This is one option where the
31732 facility for changing a list separator may not be used. The list must always be
31733 colon-separated. If an item in the list is &"syslog"& then syslog is used;
31734 otherwise the item must either be an absolute path, containing &`%s`& at the
31735 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
31736 implying the use of a default path.
31737
31738 When Exim encounters an empty item in the list, it searches the list defined by
31739 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
31740 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
31741 mean &"use the path specified at build time"&. It no such item exists, log
31742 files are written in the &_log_& subdirectory of the spool directory. This is
31743 equivalent to the setting:
31744 .code
31745 log_file_path = $spool_directory/log/%slog
31746 .endd
31747 If you do not specify anything at build time or run time, that is where the
31748 logs are written.
31749
31750 A log file path may also contain &`%D`& if datestamped log file names are in
31751 use &-- see section &<<SECTdatlogfil>>& below.
31752
31753 Here are some examples of possible settings:
31754 .display
31755 &`LOG_FILE_PATH=syslog                    `& syslog only
31756 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
31757 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
31758 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
31759 .endd
31760 If there are more than two paths in the list, the first is used and a panic
31761 error is logged.
31762
31763
31764
31765 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
31766 .cindex "log" "cycling local files"
31767 .cindex "cycling logs"
31768 .cindex "&'exicyclog'&"
31769 .cindex "log" "local files; writing to"
31770 Some operating systems provide centralized and standardized methods for cycling
31771 log files. For those that do not, a utility script called &'exicyclog'& is
31772 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
31773 main and reject logs each time it is called. The maximum number of old logs to
31774 keep can be set. It is suggested this script is run as a daily &'cron'& job.
31775
31776 An Exim delivery process opens the main log when it first needs to write to it,
31777 and it keeps the file open in case subsequent entries are required &-- for
31778 example, if a number of different deliveries are being done for the same
31779 message. However, remote SMTP deliveries can take a long time, and this means
31780 that the file may be kept open long after it is renamed if &'exicyclog'& or
31781 something similar is being used to rename log files on a regular basis. To
31782 ensure that a switch of log files is noticed as soon as possible, Exim calls
31783 &[stat()]& on the main log's name before reusing an open file, and if the file
31784 does not exist, or its inode has changed, the old file is closed and Exim
31785 tries to open the main log from scratch. Thus, an old log file may remain open
31786 for quite some time, but no Exim processes should write to it once it has been
31787 renamed.
31788
31789
31790
31791 .section "Datestamped log files" "SECTdatlogfil"
31792 .cindex "log" "datestamped files"
31793 Instead of cycling the main and reject log files by renaming them
31794 periodically, some sites like to use files whose names contain a datestamp,
31795 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_&.
31796 Exim has support for this way of working. It is enabled by setting the
31797 &%log_file_path%& option to a path that includes &`%D`& at the point where the
31798 datestamp is required. For example:
31799 .code
31800 log_file_path = /var/spool/exim/log/%slog-%D
31801 log_file_path = /var/log/exim-%s-%D.log
31802 log_file_path = /var/spool/exim/log/%D-%slog
31803 .endd
31804 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
31805 examples of names generated by the above examples:
31806 .code
31807 /var/spool/exim/log/mainlog-20021225
31808 /var/log/exim-reject-20021225.log
31809 /var/spool/exim/log/20021225-mainlog
31810 .endd
31811 When this form of log file is specified, Exim automatically switches to new
31812 files at midnight. It does not make any attempt to compress old logs; you
31813 will need to write your own script if you require this. You should not
31814 run &'exicyclog'& with this form of logging.
31815
31816 The location of the panic log is also determined by &%log_file_path%&, but it
31817 is not datestamped, because rotation of the panic log does not make sense.
31818 When generating the name of the panic log, &`%D`& is removed from the string.
31819 In addition, if it immediately follows a slash, a following non-alphanumeric
31820 character is removed; otherwise a preceding non-alphanumeric character is
31821 removed. Thus, the three examples above would give these panic log names:
31822 .code
31823 /var/spool/exim/log/paniclog
31824 /var/log/exim-panic.log
31825 /var/spool/exim/log/paniclog
31826 .endd
31827
31828
31829 .section "Logging to syslog" "SECID249"
31830 .cindex "log" "syslog; writing to"
31831 The use of syslog does not change what Exim logs or the format of its messages,
31832 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
31833 Exim's log lines are omitted when these lines are sent to syslog. Apart from
31834 that, the same strings are written to syslog as to log files. The syslog
31835 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
31836 by default, but you can change these by setting the &%syslog_facility%& and
31837 &%syslog_processname%& options, respectively. If Exim was compiled with
31838 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
31839 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
31840 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
31841 the time and host name to each line.
31842 The three log streams are mapped onto syslog priorities as follows:
31843
31844 .ilist
31845 &'mainlog'& is mapped to LOG_INFO
31846 .next
31847 &'rejectlog'& is mapped to LOG_NOTICE
31848 .next
31849 &'paniclog'& is mapped to LOG_ALERT
31850 .endlist
31851
31852 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
31853 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
31854 these are routed by syslog to the same place. You can suppress this duplication
31855 by setting &%syslog_duplication%& false.
31856
31857 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
31858 entries contain multiple lines when headers are included. To cope with both
31859 these cases, entries written to syslog are split into separate &[syslog()]&
31860 calls at each internal newline, and also after a maximum of
31861 870 data characters. (This allows for a total syslog line length of 1024, when
31862 additions such as timestamps are added.) If you are running a syslog
31863 replacement that can handle lines longer than the 1024 characters allowed by
31864 RFC 3164, you should set
31865 .code
31866 SYSLOG_LONG_LINES=yes
31867 .endd
31868 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
31869 lines, but it still splits at internal newlines in &'reject'& log entries.
31870
31871 To make it easy to re-assemble split lines later, each component of a split
31872 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
31873 where <&'n'&> is the component number and <&'m'&> is the total number of
31874 components in the entry. The / delimiter is used when the line was split
31875 because it was too long; if it was split because of an internal newline, the \
31876 delimiter is used. For example, supposing the length limit to be 50 instead of
31877 870, the following would be the result of a typical rejection message to
31878 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
31879 name, and pid as added by syslog:
31880 .code
31881 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
31882 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
31883 [3/5]  when scanning for sender: missing or malformed lo
31884 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
31885 [5/5] mple>)
31886 .endd
31887 The same error might cause the following lines to be written to &"rejectlog"&
31888 (LOG_NOTICE):
31889 .code
31890 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
31891 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
31892 [3/18] er when scanning for sender: missing or malformed
31893 [4/18]  local part in "<>" (envelope sender is <ph10@cam
31894 [5\18] .example>)
31895 [6\18] Recipients: ph10@some.domain.cam.example
31896 [7\18] P Received: from [127.0.0.1] (ident=ph10)
31897 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
31898 [9\18]        id 16RdAL-0006pc-00
31899 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
31900 [11\18] 09:43 +0100
31901 [12\18] F From: <>
31902 [13\18]   Subject: this is a test header
31903 [18\18]   X-something: this is another header
31904 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
31905 [16\18] le>
31906 [17\18] B Bcc:
31907 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
31908 .endd
31909 Log lines that are neither too long nor contain newlines are written to syslog
31910 without modification.
31911
31912 If only syslog is being used, the Exim monitor is unable to provide a log tail
31913 display, unless syslog is routing &'mainlog'& to a file on the local host and
31914 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
31915 where it is.
31916
31917
31918
31919 .section "Log line flags" "SECID250"
31920 One line is written to the main log for each message received, and for each
31921 successful, unsuccessful, and delayed delivery. These lines can readily be
31922 picked out by the distinctive two-character flags that immediately follow the
31923 timestamp. The flags are:
31924 .display
31925 &`<=`&     message arrival
31926 &`=>`&     normal message delivery
31927 &`->`&     additional address in same delivery
31928 &`*>`&     delivery suppressed by &%-N%&
31929 &`**`&     delivery failed; address bounced
31930 &`==`&     delivery deferred; temporary problem
31931 .endd
31932
31933
31934 .section "Logging message reception" "SECID251"
31935 .cindex "log" "reception line"
31936 The format of the single-line entry in the main log that is written for every
31937 message received is shown in the basic example below, which is split over
31938 several lines in order to fit it on the page:
31939 .code
31940 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
31941   H=mailer.fict.example [192.168.123.123] U=exim
31942   P=smtp S=5678 id=<incoming message id>
31943 .endd
31944 The address immediately following &"<="& is the envelope sender address. A
31945 bounce message is shown with the sender address &"<>"&, and if it is locally
31946 generated, this is followed by an item of the form
31947 .code
31948 R=<message id>
31949 .endd
31950 which is a reference to the message that caused the bounce to be sent.
31951
31952 .cindex "HELO"
31953 .cindex "EHLO"
31954 For messages from other hosts, the H and U fields identify the remote host and
31955 record the RFC 1413 identity of the user that sent the message, if one was
31956 received. The number given in square brackets is the IP address of the sending
31957 host. If there is a single, unparenthesized  host name in the H field, as
31958 above, it has been verified to correspond to the IP address (see the
31959 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
31960 by the remote host in the SMTP HELO or EHLO command, and has not been
31961 verified. If verification yields a different name to that given for HELO or
31962 EHLO, the verified name appears first, followed by the HELO or EHLO
31963 name in parentheses.
31964
31965 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
31966 without brackets, in the HELO or EHLO command, leading to entries in
31967 the log containing text like these examples:
31968 .code
31969 H=(10.21.32.43) [192.168.8.34]
31970 H=([10.21.32.43]) [192.168.8.34]
31971 .endd
31972 This can be confusing. Only the final address in square brackets can be relied
31973 on.
31974
31975 For locally generated messages (that is, messages not received over TCP/IP),
31976 the H field is omitted, and the U field contains the login name of the caller
31977 of Exim.
31978
31979 .cindex "authentication" "logging"
31980 .cindex "AUTH" "logging"
31981 For all messages, the P field specifies the protocol used to receive the
31982 message. This is the value that is stored in &$received_protocol$&. In the case
31983 of incoming SMTP messages, the value indicates whether or not any SMTP
31984 extensions (ESMTP), encryption, or authentication were used. If the SMTP
31985 session was encrypted, there is an additional X field that records the cipher
31986 suite that was used.
31987
31988 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
31989 hosts that have authenticated themselves using the SMTP AUTH command. The first
31990 value is used when the SMTP connection was encrypted (&"secure"&). In this case
31991 there is an additional item A= followed by the name of the authenticator that
31992 was used. If an authenticated identification was set up by the authenticator's
31993 &%server_set_id%& option, this is logged too, separated by a colon from the
31994 authenticator name.
31995
31996 .cindex "size" "of message"
31997 The id field records the existing message id, if present. The size of the
31998 received message is given by the S field. When the message is delivered,
31999 headers may be removed or added, so that the size of delivered copies of the
32000 message may not correspond with this value (and indeed may be different to each
32001 other).
32002
32003 The &%log_selector%& option can be used to request the logging of additional
32004 data when a message is received. See section &<<SECTlogselector>>& below.
32005
32006
32007
32008 .section "Logging deliveries" "SECID252"
32009 .cindex "log" "delivery line"
32010 The format of the single-line entry in the main log that is written for every
32011 delivery is shown in one of the examples below, for local and remote
32012 deliveries, respectively. Each example has been split into two lines in order
32013 to fit it on the page:
32014 .code
32015 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
32016   <marv@hitch.fict.example> R=localuser T=local_delivery
32017 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
32018   monk@holistic.fict.example R=dnslookup T=remote_smtp
32019   H=holistic.fict.example [192.168.234.234]
32020 .endd
32021 For ordinary local deliveries, the original address is given in angle brackets
32022 after the final delivery address, which might be a pipe or a file. If
32023 intermediate address(es) exist between the original and the final address, the
32024 last of these is given in parentheses after the final address. The R and T
32025 fields record the router and transport that were used to process the address.
32026
32027 If a shadow transport was run after a successful local delivery, the log line
32028 for the successful delivery has an item added on the end, of the form
32029 .display
32030 &`ST=<`&&'shadow transport name'&&`>`&
32031 .endd
32032 If the shadow transport did not succeed, the error message is put in
32033 parentheses afterwards.
32034
32035 .cindex "asterisk" "after IP address"
32036 When more than one address is included in a single delivery (for example, two
32037 SMTP RCPT commands in one transaction) the second and subsequent addresses are
32038 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
32039 down a single SMTP connection, an asterisk follows the IP address in the log
32040 lines for the second and subsequent messages.
32041
32042 The generation of a reply message by a filter file gets logged as a
32043 &"delivery"& to the addressee, preceded by &">"&.
32044
32045 The &%log_selector%& option can be used to request the logging of additional
32046 data when a message is delivered. See section &<<SECTlogselector>>& below.
32047
32048
32049 .section "Discarded deliveries" "SECID253"
32050 .cindex "discarded messages"
32051 .cindex "message" "discarded"
32052 .cindex "delivery" "discarded; logging"
32053 When a message is discarded as a result of the command &"seen finish"& being
32054 obeyed in a filter file which generates no deliveries, a log entry of the form
32055 .code
32056 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
32057   <low.club@bridge.example> R=userforward
32058 .endd
32059 is written, to record why no deliveries are logged. When a message is discarded
32060 because it is aliased to &":blackhole:"& the log line is like this:
32061 .code
32062 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
32063   <hole@nowhere.example> R=blackhole_router
32064 .endd
32065
32066
32067 .section "Deferred deliveries" "SECID254"
32068 When a delivery is deferred, a line of the following form is logged:
32069 .code
32070 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
32071   R=dnslookup T=smtp defer (146): Connection refused
32072 .endd
32073 In the case of remote deliveries, the error is the one that was given for the
32074 last IP address that was tried. Details of individual SMTP failures are also
32075 written to the log, so the above line would be preceded by something like
32076 .code
32077 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
32078   mail1.endrest.example [192.168.239.239]: Connection refused
32079 .endd
32080 When a deferred address is skipped because its retry time has not been reached,
32081 a message is written to the log, but this can be suppressed by setting an
32082 appropriate value in &%log_selector%&.
32083
32084
32085
32086 .section "Delivery failures" "SECID255"
32087 .cindex "delivery" "failure; logging"
32088 If a delivery fails because an address cannot be routed, a line of the
32089 following form is logged:
32090 .code
32091 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
32092   <jim@trek99.example>: unknown mail domain
32093 .endd
32094 If a delivery fails at transport time, the router and transport are shown, and
32095 the response from the remote host is included, as in this example:
32096 .code
32097 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
32098   R=dnslookup T=remote_smtp: SMTP error from remote mailer
32099   after pipelined RCPT TO:<ace400@pb.example>: host
32100   pbmail3.py.example [192.168.63.111]: 553 5.3.0
32101   <ace400@pb.example>...Addressee unknown
32102 .endd
32103 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
32104 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
32105 disabling PIPELINING. The log lines for all forms of delivery failure are
32106 flagged with &`**`&.
32107
32108
32109
32110 .section "Fake deliveries" "SECID256"
32111 .cindex "delivery" "fake; logging"
32112 If a delivery does not actually take place because the &%-N%& option has been
32113 used to suppress it, a normal delivery line is written to the log, except that
32114 &"=>"& is replaced by &"*>"&.
32115
32116
32117
32118 .section "Completion" "SECID257"
32119 A line of the form
32120 .code
32121 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
32122 .endd
32123 is written to the main log when a message is about to be removed from the spool
32124 at the end of its processing.
32125
32126
32127
32128
32129 .section "Summary of Fields in Log Lines" "SECID258"
32130 .cindex "log" "summary of fields"
32131 A summary of the field identifiers that are used in log lines is shown in
32132 the following table:
32133 .display
32134 &`A   `&        authenticator name (and optional id)
32135 &`C   `&        SMTP confirmation on delivery
32136 &`    `&        command list for &"no mail in SMTP session"&
32137 &`CV  `&        certificate verification status
32138 &`D   `&        duration of &"no mail in SMTP session"&
32139 &`DN  `&        distinguished name from peer certificate
32140 &`DT  `&        on &`=>`& lines: time taken for a delivery
32141 &`F   `&        sender address (on delivery lines)
32142 &`H   `&        host name and IP address
32143 &`I   `&        local interface used
32144 &`id  `&        message id for incoming message
32145 &`P   `&        on &`<=`& lines: protocol used
32146 &`    `&        on &`=>`& and &`**`& lines: return path
32147 &`QT  `&        on &`=>`& lines: time spent on queue so far
32148 &`    `&        on &"Completed"& lines: time spent on queue
32149 &`R   `&        on &`<=`& lines: reference for local bounce
32150 &`    `&        on &`=>`&  &`**`& and &`==`& lines: router name
32151 &`S   `&        size of message
32152 &`ST  `&        shadow transport name
32153 &`T   `&        on &`<=`& lines: message subject (topic)
32154 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
32155 &`U   `&        local user or RFC 1413 identity
32156 &`X   `&        TLS cipher suite
32157 .endd
32158
32159
32160 .section "Other log entries" "SECID259"
32161 Various other types of log entry are written from time to time. Most should be
32162 self-explanatory. Among the more common are:
32163
32164 .ilist
32165 .cindex "retry" "time not reached"
32166 &'retry time not reached'&&~&~An address previously suffered a temporary error
32167 during routing or local delivery, and the time to retry has not yet arrived.
32168 This message is not written to an individual message log file unless it happens
32169 during the first delivery attempt.
32170 .next
32171 &'retry time not reached for any host'&&~&~An address previously suffered
32172 temporary errors during remote delivery, and the retry time has not yet arrived
32173 for any of the hosts to which it is routed.
32174 .next
32175 .cindex "spool directory" "file locked"
32176 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
32177 some other Exim process is already working on the message. This can be quite
32178 common if queue running processes are started at frequent intervals. The
32179 &'exiwhat'& utility script can be used to find out what Exim processes are
32180 doing.
32181 .next
32182 .cindex "error" "ignored"
32183 &'error ignored'&&~&~There are several circumstances that give rise to this
32184 message:
32185 .olist
32186 Exim failed to deliver a bounce message whose age was greater than
32187 &%ignore_bounce_errors_after%&. The bounce was discarded.
32188 .next
32189 A filter file set up a delivery using the &"noerror"& option, and the delivery
32190 failed. The delivery was discarded.
32191 .next
32192 A delivery set up by a router configured with
32193 . ==== As this is a nested list, any displays it contains must be indented
32194 . ==== as otherwise they are too far to the left.
32195 .code
32196     errors_to = <>
32197 .endd
32198 failed. The delivery was discarded.
32199 .endlist olist
32200 .endlist ilist
32201
32202
32203
32204
32205
32206 .section "Reducing or increasing what is logged" "SECTlogselector"
32207 .cindex "log" "selectors"
32208 By setting the &%log_selector%& global option, you can disable some of Exim's
32209 default logging, or you can request additional logging. The value of
32210 &%log_selector%& is made up of names preceded by plus or minus characters. For
32211 example:
32212 .code
32213 log_selector = +arguments -retry_defer
32214 .endd
32215 The list of optional log items is in the following table, with the default
32216 selection marked by asterisks:
32217 .display
32218 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
32219 &` address_rewrite            `&  address rewriting
32220 &` all_parents                `&  all parents in => lines
32221 &` arguments                  `&  command line arguments
32222 &`*connection_reject          `&  connection rejections
32223 &`*delay_delivery             `&  immediate delivery delayed
32224 &` deliver_time               `&  time taken to perform delivery
32225 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
32226 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
32227 &`*etrn                       `&  ETRN commands
32228 &`*host_lookup_failed         `&  as it says
32229 &` ident_timeout              `&  timeout for ident connection
32230 &` incoming_interface         `&  incoming interface on <= lines
32231 &` incoming_port              `&  incoming port on <= lines
32232 &`*lost_incoming_connection   `&  as it says (includes timeouts)
32233 &` outgoing_port              `&  add remote port to => lines
32234 &`*queue_run                  `&  start and end queue runs
32235 &` queue_time                 `&  time on queue for one recipient
32236 &` queue_time_overall         `&  time on queue for whole message
32237 &` pid                        `&  Exim process id
32238 &` received_recipients        `&  recipients on <= lines
32239 &` received_sender            `&  sender on <= lines
32240 &`*rejected_header            `&  header contents on reject log
32241 &`*retry_defer                `&  &"retry time not reached"&
32242 &` return_path_on_delivery    `&  put return path on => and ** lines
32243 &` sender_on_delivery         `&  add sender to => lines
32244 &`*sender_verify_fail         `&  sender verification failures
32245 &`*size_reject                `&  rejection because too big
32246 &`*skip_delivery              `&  delivery skipped in a queue run
32247 &` smtp_confirmation          `&  SMTP confirmation on => lines
32248 &` smtp_connection            `&  SMTP connections
32249 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
32250 &` smtp_no_mail               `&  session with no MAIL commands
32251 &` smtp_protocol_error        `&  SMTP protocol errors
32252 &` smtp_syntax_error          `&  SMTP syntax errors
32253 &` subject                    `&  contents of &'Subject:'& on <= lines
32254 &` tls_certificate_verified   `&  certificate verification status
32255 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
32256 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
32257 &` unknown_in_list            `&  DNS lookup failed in list match
32258
32259 &` all                        `&  all of the above
32260 .endd
32261 More details on each of these items follows:
32262
32263 .ilist
32264 .cindex "&%warn%& ACL verb" "log when skipping"
32265 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
32266 its conditions cannot be evaluated, a log line to this effect is written if
32267 this log selector is set.
32268 .next
32269 .cindex "log" "rewriting"
32270 .cindex "rewriting" "logging"
32271 &%address_rewrite%&: This applies both to global rewrites and per-transport
32272 rewrites, but not to rewrites in filters run as an unprivileged user (because
32273 such users cannot access the log).
32274 .next
32275 .cindex "log" "full parentage"
32276 &%all_parents%&: Normally only the original and final addresses are logged on
32277 delivery lines; with this selector, intermediate parents are given in
32278 parentheses between them.
32279 .next
32280 .cindex "log" "Exim arguments"
32281 .cindex "Exim arguments, logging"
32282 &%arguments%&: This causes Exim to write the arguments with which it was called
32283 to the main log, preceded by the current working directory. This is a debugging
32284 feature, added to make it easier to find out how certain MUAs call
32285 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
32286 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
32287 that are empty or that contain white space are quoted. Non-printing characters
32288 are shown as escape sequences. This facility cannot log unrecognized arguments,
32289 because the arguments are checked before the configuration file is read. The
32290 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
32291 between the caller and Exim.
32292 .next
32293 .cindex "log" "connection rejections"
32294 &%connection_reject%&: A log entry is written whenever an incoming SMTP
32295 connection is rejected, for whatever reason.
32296 .next
32297 .cindex "log" "delayed delivery"
32298 .cindex "delayed delivery, logging"
32299 &%delay_delivery%&: A log entry is written whenever a delivery process is not
32300 started for an incoming message because the load is too high or too many
32301 messages were received on one connection. Logging does not occur if no delivery
32302 process is started because &%queue_only%& is set or &%-odq%& was used.
32303 .next
32304 .cindex "log" "delivery duration"
32305 &%deliver_time%&: For each delivery, the amount of real time it has taken to
32306 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
32307 .next
32308 .cindex "log" "message size on delivery"
32309 .cindex "size" "of message"
32310 &%delivery_size%&: For each delivery, the size of message delivered is added to
32311 the &"=>"& line, tagged with S=.
32312 .next
32313 .cindex "log" "dnslist defer"
32314 .cindex "DNS list" "logging defer"
32315 .cindex "black list (DNS)"
32316 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
32317 DNS black list suffers a temporary error.
32318 .next
32319 .cindex "log" "ETRN commands"
32320 .cindex "ETRN" "logging"
32321 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
32322 is run to determine whether or not it is actually accepted. An invalid ETRN
32323 command, or one received within a message transaction is not logged by this
32324 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
32325 .next
32326 .cindex "log" "host lookup failure"
32327 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
32328 any addresses, or when a lookup of an IP address fails to find a host name, a
32329 log line is written. This logging does not apply to direct DNS lookups when
32330 routing email addresses, but it does apply to &"byname"& lookups.
32331 .next
32332 .cindex "log" "ident timeout"
32333 .cindex "RFC 1413" "logging timeout"
32334 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
32335 client's ident port times out.
32336 .next
32337 .cindex "log" "incoming interface"
32338 .cindex "interface" "logging"
32339 &%incoming_interface%&: The interface on which a message was received is added
32340 to the &"<="& line as an IP address in square brackets, tagged by I= and
32341 followed by a colon and the port number. The local interface and port are also
32342 added to other SMTP log lines, for example &"SMTP connection from"&, and to
32343 rejection lines.
32344 .next
32345 .cindex "log" "incoming remote port"
32346 .cindex "port" "logging remote"
32347 .cindex "TCP/IP" "logging incoming remote port"
32348 .vindex "&$sender_fullhost$&"
32349 .vindex "&$sender_rcvhost$&"
32350 &%incoming_port%&: The remote port number from which a message was received is
32351 added to log entries and &'Received:'& header lines, following the IP address
32352 in square brackets, and separated from it by a colon. This is implemented by
32353 changing the value that is put in the &$sender_fullhost$& and
32354 &$sender_rcvhost$& variables. Recording the remote port number has become more
32355 important with the widening use of NAT (see RFC 2505).
32356 .next
32357 .cindex "log" "dropped connection"
32358 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
32359 connection is unexpectedly dropped.
32360 .next
32361 .cindex "log" "outgoing remote port"
32362 .cindex "port" "logging outgoint remote"
32363 .cindex "TCP/IP" "logging ougtoing remote port"
32364 &%outgoing_port%&: The remote port number is added to delivery log lines (those
32365 containing => tags) following the IP address. This option is not included in
32366 the default setting, because for most ordinary configurations, the remote port
32367 number is always 25 (the SMTP port).
32368 .next
32369 .cindex "log" "process ids in"
32370 .cindex "pid (process id)" "in log lines"
32371 &%pid%&: The current process id is added to every log line, in square brackets,
32372 immediately after the time and date.
32373 .next
32374 .cindex "log" "queue run"
32375 .cindex "queue runner" "logging"
32376 &%queue_run%&: The start and end of every queue run are logged.
32377 .next
32378 .cindex "log" "queue time"
32379 &%queue_time%&: The amount of time the message has been in the queue on the
32380 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
32381 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
32382 includes reception time as well as the delivery time for the current address.
32383 This means that it may be longer than the difference between the arrival and
32384 delivery log line times, because the arrival log line is not written until the
32385 message has been successfully received.
32386 .next
32387 &%queue_time_overall%&: The amount of time the message has been in the queue on
32388 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
32389 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
32390 message, so it includes reception time as well as the total delivery time.
32391 .next
32392 .cindex "log" "recipients"
32393 &%received_recipients%&: The recipients of a message are listed in the main log
32394 as soon as the message is received. The list appears at the end of the log line
32395 that is written when a message is received, preceded by the word &"for"&. The
32396 addresses are listed after they have been qualified, but before any rewriting
32397 has taken place.
32398 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
32399 in the list.
32400 .next
32401 .cindex "log" "sender reception"
32402 &%received_sender%&: The unrewritten original sender of a message is added to
32403 the end of the log line that records the message's arrival, after the word
32404 &"from"& (before the recipients if &%received_recipients%& is also set).
32405 .next
32406 .cindex "log" "header lines for rejection"
32407 &%rejected_header%&: If a message's header has been received at the time a
32408 rejection is written to the reject log, the complete header is added to the
32409 log. Header logging can be turned off individually for messages that are
32410 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
32411 .next
32412 .cindex "log" "retry defer"
32413 &%retry_defer%&: A log line is written if a delivery is deferred because a
32414 retry time has not yet been reached. However, this &"retry time not reached"&
32415 message is always omitted from individual message logs after the first delivery
32416 attempt.
32417 .next
32418 .cindex "log" "return path"
32419 &%return_path_on_delivery%&: The return path that is being transmitted with
32420 the message is included in delivery and bounce lines, using the tag P=.
32421 This is omitted if no delivery actually happens, for example, if routing fails,
32422 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
32423 .next
32424 .cindex "log" "sender on delivery"
32425 &%sender_on_delivery%&: The message's sender address is added to every delivery
32426 and bounce line, tagged by F= (for &"from"&).
32427 This is the original sender that was received with the message; it is not
32428 necessarily the same as the outgoing return path.
32429 .next
32430 .cindex "log" "sender verify failure"
32431 &%sender_verify_fail%&: If this selector is unset, the separate log line that
32432 gives details of a sender verification failure is not written. Log lines for
32433 the rejection of SMTP commands contain just &"sender verify failed"&, so some
32434 detail is lost.
32435 .next
32436 .cindex "log" "size rejection"
32437 &%size_reject%&: A log line is written whenever a message is rejected because
32438 it is too big.
32439 .next
32440 .cindex "log" "frozen messages; skipped"
32441 .cindex "frozen messages" "logging skipping"
32442 &%skip_delivery%&: A log line is written whenever a message is skipped during a
32443 queue run because it is frozen or because another process is already delivering
32444 it.
32445 .cindex "&""spool file is locked""&"
32446 The message that is written is &"spool file is locked"&.
32447 .next
32448 .cindex "log" "smtp confirmation"
32449 .cindex "SMTP" "logging confirmation"
32450 &%smtp_confirmation%&: The response to the final &"."& in the SMTP dialogue for
32451 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
32452 A number of MTAs (including Exim) return an identifying string in this
32453 response.
32454 .next
32455 .cindex "log" "SMTP connections"
32456 .cindex "SMTP" "logging connections"
32457 &%smtp_connection%&: A log line is written whenever an SMTP connection is
32458 established or closed, unless the connection is from a host that matches
32459 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
32460 only when the closure is unexpected.) This applies to connections from local
32461 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
32462 dropped in the middle of a message, a log line is always written, whether or
32463 not this selector is set, but otherwise nothing is written at the start and end
32464 of connections unless this selector is enabled.
32465
32466 For TCP/IP connections to an Exim daemon, the current number of connections is
32467 included in the log message for each new connection, but note that the count is
32468 reset if the daemon is restarted.
32469 Also, because connections are closed (and the closure is logged) in
32470 subprocesses, the count may not include connections that have been closed but
32471 whose termination the daemon has not yet noticed. Thus, while it is possible to
32472 match up the opening and closing of connections in the log, the value of the
32473 logged counts may not be entirely accurate.
32474 .next
32475 .cindex "log" "SMTP transaction; incomplete"
32476 .cindex "SMTP" "logging incomplete transactions"
32477 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
32478 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
32479 and the message sender plus any accepted recipients are included in the log
32480 line. This can provide evidence of dictionary attacks.
32481 .next
32482 .cindex "log" "non-MAIL SMTP sessions"
32483 .cindex "MAIL" "logging session without"
32484 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
32485 connection terminates without having issued a MAIL command. This includes both
32486 the case when the connection is dropped, and the case when QUIT is used. It
32487 does not include cases where the connection is rejected right at the start (by
32488 an ACL, or because there are too many connections, or whatever). These cases
32489 already have their own log lines.
32490
32491 The log line that is written contains the identity of the client in the usual
32492 way, followed by D= and a time, which records the duration of the connection.
32493 If the connection was authenticated, this fact is logged exactly as it is for
32494 an incoming message, with an A= item. If the connection was encrypted, CV=,
32495 DN=, and X= items may appear as they do for an incoming message, controlled by
32496 the same logging options.
32497
32498 Finally, if any SMTP commands were issued during the connection, a C= item
32499 is added to the line, listing the commands that were used. For example,
32500 .code
32501 C=EHLO,QUIT
32502 .endd
32503 shows that the client issued QUIT straight after EHLO. If there were fewer
32504 than 20 commands, they are all listed. If there were more than 20 commands,
32505 the last 20 are listed, preceded by &"..."&. However, with the default
32506 setting of 10 for &%smtp_accep_max_nonmail%&, the connection will in any case
32507 have been aborted before 20 non-mail commands are processed.
32508 .next
32509 .cindex "log" "SMTP protocol error"
32510 .cindex "SMTP" "logging protocol error"
32511 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
32512 encountered. Exim does not have perfect detection of all protocol errors
32513 because of transmission delays and the use of pipelining. If PIPELINING has
32514 been advertised to a client, an Exim server assumes that the client will use
32515 it, and therefore it does not count &"expected"& errors (for example, RCPT
32516 received after rejecting MAIL) as protocol errors.
32517 .next
32518 .cindex "SMTP" "logging syntax errors"
32519 .cindex "SMTP" "syntax errors; logging"
32520 .cindex "SMTP" "unknown command; logging"
32521 .cindex "log" "unknown SMTP command"
32522 .cindex "log" "SMTP syntax error"
32523 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
32524 encountered. An unrecognized command is treated as a syntax error. For an
32525 external connection, the host identity is given; for an internal connection
32526 using &%-bs%& the sender identification (normally the calling user) is given.
32527 .next
32528 .cindex "log" "subject"
32529 .cindex "subject, logging"
32530 &%subject%&: The subject of the message is added to the arrival log line,
32531 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
32532 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
32533 specifies whether characters with values greater than 127 should be logged
32534 unchanged, or whether they should be rendered as escape sequences.
32535 .next
32536 .cindex "log" "certificate verification"
32537 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
32538 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
32539 verified, and &`CV=no`& if not.
32540 .next
32541 .cindex "log" "TLS cipher"
32542 .cindex "TLS" "logging cipher"
32543 &%tls_cipher%&: When a message is sent or received over an encrypted
32544 connection, the cipher suite used is added to the log line, preceded by X=.
32545 .next
32546 .cindex "log" "TLS peer DN"
32547 .cindex "TLS" "logging peer DN"
32548 &%tls_peerdn%&: When a message is sent or received over an encrypted
32549 connection, and a certificate is supplied by the remote host, the peer DN is
32550 added to the log line, preceded by DN=.
32551 .next
32552 .cindex "log" "DNS failure in list"
32553 &%unknown_in_list%&: This setting causes a log entry to be written when the
32554 result of a list match is failure because a DNS lookup failed.
32555 .endlist
32556
32557
32558 .section "Message log" "SECID260"
32559 .cindex "message" "log file for"
32560 .cindex "log" "message log; description of"
32561 .cindex "&_msglog_& directory"
32562 .oindex "&%preserve_message_logs%&"
32563 In addition to the general log files, Exim writes a log file for each message
32564 that it handles. The names of these per-message logs are the message ids, and
32565 they are kept in the &_msglog_& sub-directory of the spool directory. Each
32566 message log contains copies of the log lines that apply to the message. This
32567 makes it easier to inspect the status of an individual message without having
32568 to search the main log. A message log is deleted when processing of the message
32569 is complete, unless &%preserve_message_logs%& is set, but this should be used
32570 only with great care because they can fill up your disk very quickly.
32571
32572 On a heavily loaded system, it may be desirable to disable the use of
32573 per-message logs, in order to reduce disk I/O. This can be done by setting the
32574 &%message_logs%& option false.
32575 .ecindex IIDloggen
32576
32577
32578
32579
32580 . ////////////////////////////////////////////////////////////////////////////
32581 . ////////////////////////////////////////////////////////////////////////////
32582
32583 .chapter "Exim utilities" "CHAPutils"
32584 .scindex IIDutils "utilities"
32585 A number of utility scripts and programs are supplied with Exim and are
32586 described in this chapter. There is also the Exim Monitor, which is covered in
32587 the next chapter. The utilities described here are:
32588
32589 .itable none 0 0 3  7* left  15* left  40* left
32590 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
32591   "list what Exim processes are doing"
32592 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
32593 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
32594 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
32595 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
32596                                                 various criteria"
32597 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
32598 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
32599   "extract statistics from the log"
32600 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
32601   "check address acceptance from given IP"
32602 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
32603 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
32604 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
32605 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
32606 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
32607 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
32608 .endtable
32609
32610 Another utility that might be of use to sites with many MTAs is Tom Kistner's
32611 &'exilog'&. It provides log visualizations across multiple Exim servers. See
32612 &url(http://duncanthrax.net/exilog/) for details.
32613
32614
32615
32616
32617 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
32618 .cindex "&'exiwhat'&"
32619 .cindex "process, querying"
32620 .cindex "SIGUSR1"
32621 On operating systems that can restart a system call after receiving a signal
32622 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
32623 a line describing what it is doing to the file &_exim-process.info_& in the
32624 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
32625 processes it can find, having first emptied the file. It then waits for one
32626 second to allow the Exim processes to react before displaying the results. In
32627 order to run &'exiwhat'& successfully you have to have sufficient privilege to
32628 send the signal to the Exim processes, so it is normally run as root.
32629
32630 &*Warning*&: This is not an efficient process. It is intended for occasional
32631 use by system administrators. It is not sensible, for example, to set up a
32632 script that sends SIGUSR1 signals to Exim processes at short intervals.
32633
32634
32635 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
32636 varies in different operating systems. Not only are different options used,
32637 but the format of the output is different. For this reason, there are some
32638 system configuration options that configure exactly how &'exiwhat'& works. If
32639 it doesn't seem to be working for you, check the following compile-time
32640 options:
32641 .display
32642 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
32643 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
32644 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
32645 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
32646 .endd
32647 An example of typical output from &'exiwhat'& is
32648 .code
32649 164 daemon: -q1h, listening on port 25
32650 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
32651 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
32652   [10.19.42.42] (editor@ref.example)
32653 10592 handling incoming call from [192.168.243.242]
32654 10628 accepting a local non-SMTP message
32655 .endd
32656 The first number in the output line is the process number. The third line has
32657 been split here, in order to fit it on the page.
32658
32659
32660
32661 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
32662 .cindex "&'exiqgrep'&"
32663 .cindex "queue" "grepping"
32664 This utility is a Perl script contributed by Matt Hubbard. It runs
32665 .code
32666 exim -bpu
32667 .endd
32668 to obtain a queue listing with undelivered recipients only, and then greps the
32669 output to select messages that match given criteria. The following selection
32670 options are available:
32671
32672 .vlist
32673 .vitem &*-f*&&~<&'regex'&>
32674 Match the sender address. The field that is tested is enclosed in angle
32675 brackets, so you can test for bounce messages with
32676 .code
32677 exiqgrep -f '^<>$'
32678 .endd
32679 .vitem &*-r*&&~<&'regex'&>
32680 Match a recipient address. The field that is tested is not enclosed in angle
32681 brackets.
32682
32683 .vitem &*-s*&&~<&'regex'&>
32684 Match against the size field.
32685
32686 .vitem &*-y*&&~<&'seconds'&>
32687 Match messages that are younger than the given time.
32688
32689 .vitem &*-o*&&~<&'seconds'&>
32690 Match messages that are older than the given time.
32691
32692 .vitem &*-z*&
32693 Match only frozen messages.
32694
32695 .vitem &*-x*&
32696 Match only non-frozen messages.
32697 .endlist
32698
32699 The following options control the format of the output:
32700
32701 .vlist
32702 .vitem &*-c*&
32703 Display only the count of matching messages.
32704
32705 .vitem &*-l*&
32706 Long format &-- display the full message information as output by Exim. This is
32707 the default.
32708
32709 .vitem &*-i*&
32710 Display message ids only.
32711
32712 .vitem &*-b*&
32713 Brief format &-- one line per message.
32714
32715 .vitem &*-R*&
32716 Display messages in reverse order.
32717 .endlist
32718
32719 There is one more option, &%-h%&, which outputs a list of options.
32720
32721
32722
32723 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
32724 .cindex "&'exiqsumm'&"
32725 .cindex "queue" "summary"
32726 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
32727 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
32728 running a command such as
32729 .code
32730 exim -bp | exiqsumm
32731 .endd
32732 The output consists of one line for each domain that has messages waiting for
32733 it, as in the following example:
32734 .code
32735 3   2322   74m   66m  msn.com.example
32736 .endd
32737 Each line lists the number of pending deliveries for a domain, their total
32738 volume, and the length of time that the oldest and the newest messages have
32739 been waiting. Note that the number of pending deliveries is greater than the
32740 number of messages when messages have more than one recipient.
32741
32742 A summary line is output at the end. By default the output is sorted on the
32743 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
32744 the output to be sorted by oldest message and by count of messages,
32745 respectively. There are also three options that split the messages for each
32746 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
32747 separates frozen messages, and &%-s%& separates messages according to their
32748 sender.
32749
32750 The output of &'exim -bp'& contains the original addresses in the message, so
32751 this also applies to the output from &'exiqsumm'&. No domains from addresses
32752 generated by aliasing or forwarding are included (unless the &%one_time%&
32753 option of the &(redirect)& router has been used to convert them into &"top
32754 level"& addresses).
32755
32756
32757
32758
32759 .section "Extracting specific information from the log (exigrep)" &&&
32760          "SECTextspeinf"
32761 .cindex "&'exigrep'&"
32762 .cindex "log" "extracts; grepping for"
32763 The &'exigrep'& utility is a Perl script that searches one or more main log
32764 files for entries that match a given pattern. When it finds a match, it
32765 extracts all the log entries for the relevant message, not just those that
32766 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
32767 given message, or all mail for a given user, or for a given host, for example.
32768 The input files can be in Exim log format or syslog format.
32769 If a matching log line is not associated with a specific message, it is
32770 included in &'exigrep'&'s output without any additional lines. The usage is:
32771 .display
32772 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
32773 .endd
32774 If no log file names are given on the command line, the standard input is read.
32775
32776 The &%-t%& argument specifies a number of seconds. It adds an additional
32777 condition for message selection. Messages that are complete are shown only if
32778 they spent more than <&'n'&> seconds on the queue.
32779
32780 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
32781 makes it case-sensitive. This may give a performance improvement when searching
32782 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
32783 option; with &%-I%& they do not. In both cases it is possible to change the
32784 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
32785
32786 The &%-l%& option means &"literal"&, that is, treat all characters in the
32787 pattern as standing for themselves. Otherwise the pattern must be a Perl
32788 regular expression.
32789
32790 The &%-v%& option inverts the matching condition. That is, a line is selected
32791 if it does &'not'& match the pattern.
32792
32793 If the location of a &'zcat'& command is known from the definition of
32794 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
32795 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
32796
32797
32798 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
32799 .cindex "&'exipick'&"
32800 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
32801 lists messages from the queue according to a variety of criteria. For details
32802 of &'exipick'&'s facilities, visit the web page at
32803 &url(http://www.exim.org/eximwiki/ToolExipickManPage) or run &'exipick'& with
32804 the &%--help%& option.
32805
32806
32807 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
32808 .cindex "log" "cycling local files"
32809 .cindex "cycling logs"
32810 .cindex "&'exicyclog'&"
32811 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
32812 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
32813 you are using log files with datestamps in their names (see section
32814 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
32815 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
32816 There are two command line options for &'exicyclog'&:
32817 .ilist
32818 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
32819 default that is set when Exim is built. The default default is 10.
32820 .next
32821 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
32822 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
32823 overriding the script's default, which is to find the setting from Exim's
32824 configuration.
32825 .endlist
32826
32827 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
32828 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
32829 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
32830 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
32831 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
32832 logs are handled similarly.
32833
32834 If the limit is greater than 99, the script uses 3-digit numbers such as
32835 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
32836 to one that is greater, or &'vice versa'&, you will have to fix the names of
32837 any existing log files.
32838
32839 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
32840 the end are deleted. All files with numbers greater than 01 are compressed,
32841 using a compression command which is configured by the COMPRESS_COMMAND
32842 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
32843 root &%crontab%& entry of the form
32844 .code
32845 1 0 * * * su exim -c /usr/exim/bin/exicyclog
32846 .endd
32847 assuming you have used the name &"exim"& for the Exim user. You can run
32848 &'exicyclog'& as root if you wish, but there is no need.
32849
32850
32851
32852 .section "Mail statistics (eximstats)" "SECTmailstat"
32853 .cindex "statistics"
32854 .cindex "&'eximstats'&"
32855 A Perl script called &'eximstats'& is provided for extracting statistical
32856 information from log files. The output is either plain text, or HTML.
32857 Exim log files are also supported by the &'Lire'& system produced by the
32858 LogReport Foundation &url(http://www.logreport.org).
32859
32860 The &'eximstats'& script has been hacked about quite a bit over time. The
32861 latest version is the result of some extensive revision by Steve Campbell. A
32862 lot of information is given by default, but there are options for suppressing
32863 various parts of it. Following any options, the arguments to the script are a
32864 list of files, which should be main log files. For example:
32865 .code
32866 eximstats -nr /var/spool/exim/log/mainlog.01
32867 .endd
32868 By default, &'eximstats'& extracts information about the number and volume of
32869 messages received from or delivered to various hosts. The information is sorted
32870 both by message count and by volume, and the top fifty hosts in each category
32871 are listed on the standard output. Similar information, based on email
32872 addresses or domains instead of hosts can be requested by means of various
32873 options. For messages delivered and received locally, similar statistics are
32874 also produced per user.
32875
32876 The output also includes total counts and statistics about delivery errors, and
32877 histograms showing the number of messages received and deliveries made in each
32878 hour of the day. A delivery with more than one address in its envelope (for
32879 example, an SMTP transaction with more than one RCPT command) is counted
32880 as a single delivery by &'eximstats'&.
32881
32882 Though normally more deliveries than receipts are reported (as messages may
32883 have multiple recipients), it is possible for &'eximstats'& to report more
32884 messages received than delivered, even though the queue is empty at the start
32885 and end of the period in question. If an incoming message contains no valid
32886 recipients, no deliveries are recorded for it. A bounce message is handled as
32887 an entirely separate message.
32888
32889 &'eximstats'& always outputs a grand total summary giving the volume and number
32890 of messages received and deliveries made, and the number of hosts involved in
32891 each case. It also outputs the number of messages that were delayed (that is,
32892 not completely delivered at the first attempt), and the number that had at
32893 least one address that failed.
32894
32895 The remainder of the output is in sections that can be independently disabled
32896 or modified by various options. It consists of a summary of deliveries by
32897 transport, histograms of messages received and delivered per time interval
32898 (default per hour), information about the time messages spent on the queue,
32899 a list of relayed messages, lists of the top fifty sending hosts, local
32900 senders, destination hosts, and destination local users by count and by volume,
32901 and a list of delivery errors that occurred.
32902
32903 The relay information lists messages that were actually relayed, that is, they
32904 came from a remote host and were directly delivered to some other remote host,
32905 without being processed (for example, for aliasing or forwarding) locally.
32906
32907 There are quite a few options for &'eximstats'& to control exactly what it
32908 outputs. These are documented in the Perl script itself, and can be extracted
32909 by running the command &(perldoc)& on the script. For example:
32910 .code
32911 perldoc /usr/exim/bin/eximstats
32912 .endd
32913
32914 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
32915 .cindex "&'exim_checkaccess'&"
32916 .cindex "policy control" "checking access"
32917 .cindex "checking access"
32918 The &%-bh%& command line argument allows you to run a fake SMTP session with
32919 debugging output, in order to check what Exim is doing when it is applying
32920 policy controls to incoming SMTP mail. However, not everybody is sufficiently
32921 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
32922 sometimes you just want to answer the question &"Does this address have
32923 access?"& without bothering with any further details.
32924
32925 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
32926 two arguments, an IP address and an email address:
32927 .code
32928 exim_checkaccess 10.9.8.7 A.User@a.domain.example
32929 .endd
32930 The utility runs a call to Exim with the &%-bh%& option, to test whether the
32931 given email address would be accepted in a RCPT command in a TCP/IP
32932 connection from the host with the given IP address. The output of the utility
32933 is either the word &"accepted"&, or the SMTP error response, for example:
32934 .code
32935 Rejected:
32936 550 Relay not permitted
32937 .endd
32938 When running this test, the utility uses &`<>`& as the envelope sender address
32939 for the MAIL command, but you can change this by providing additional
32940 options. These are passed directly to the Exim command. For example, to specify
32941 that the test is to be run with the sender address &'himself@there.example'&
32942 you can use:
32943 .code
32944 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
32945                  -f himself@there.example
32946 .endd
32947 Note that these additional Exim command line items must be given after the two
32948 mandatory arguments.
32949
32950 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
32951 while running its checks. You can run checks that include callouts by using
32952 &%-bhc%&, but this is not yet available in a &"packaged"& form.
32953
32954
32955
32956 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
32957 .cindex "DBM" "building dbm files"
32958 .cindex "building DBM files"
32959 .cindex "&'exim_dbmbuild'&"
32960 .cindex "lower casing"
32961 .cindex "binary zero" "in lookup key"
32962 The &'exim_dbmbuild'& program reads an input file containing keys and data in
32963 the format used by the &(lsearch)& lookup (see section
32964 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
32965 names as keys and the remainder of the information as data. The lower-casing
32966 can be prevented by calling the program with the &%-nolc%& option.
32967
32968 A terminating zero is included as part of the key string. This is expected by
32969 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
32970 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
32971 strings or the data strings. The &(dbmnz)& lookup type can be used with such
32972 files.
32973
32974 The program requires two arguments: the name of the input file (which can be a
32975 single hyphen to indicate the standard input), and the name of the output file.
32976 It creates the output under a temporary name, and then renames it if all went
32977 well.
32978
32979 .cindex "USE_DB"
32980 If the native DB interface is in use (USE_DB is set in a compile-time
32981 configuration file &-- this is common in free versions of Unix) the two file
32982 names must be different, because in this mode the Berkeley DB functions create
32983 a single output file using exactly the name given. For example,
32984 .code
32985 exim_dbmbuild /etc/aliases /etc/aliases.db
32986 .endd
32987 reads the system alias file and creates a DBM version of it in
32988 &_/etc/aliases.db_&.
32989
32990 In systems that use the &'ndbm'& routines (mostly proprietary versions of
32991 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
32992 environment, the suffixes are added to the second argument of
32993 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
32994 when the Berkeley functions are used in compatibility mode (though this is not
32995 recommended), because in that case it adds a &_.db_& suffix to the file name.
32996
32997 If a duplicate key is encountered, the program outputs a warning, and when it
32998 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
32999 option is used. By default, only the first of a set of duplicates is used &--
33000 this makes it compatible with &(lsearch)& lookups. There is an option
33001 &%-lastdup%& which causes it to use the data for the last duplicate instead.
33002 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
33003 &%stderr%&. For other errors, where it doesn't actually make a new file, the
33004 return code is 2.
33005
33006
33007
33008
33009 .section "Finding individual retry times (exinext)" "SECTfinindret"
33010 .cindex "retry" "times"
33011 .cindex "&'exinext'&"
33012 A utility called &'exinext'& (mostly a Perl script) provides the ability to
33013 fish specific information out of the retry database. Given a mail domain (or a
33014 complete address), it looks up the hosts for that domain, and outputs any retry
33015 information for the hosts or for the domain. At present, the retry information
33016 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
33017 output. For example:
33018 .code
33019 $ exinext piglet@milne.fict.example
33020 kanga.milne.example:192.168.8.1 error 146: Connection refused
33021   first failed: 21-Feb-1996 14:57:34
33022   last tried:   21-Feb-1996 14:57:34
33023   next try at:  21-Feb-1996 15:02:34
33024 roo.milne.example:192.168.8.3 error 146: Connection refused
33025   first failed: 20-Jan-1996 13:12:08
33026   last tried:   21-Feb-1996 11:42:03
33027   next try at:  21-Feb-1996 19:42:03
33028   past final cutoff time
33029 .endd
33030 You can also give &'exinext'& a local part, without a domain, and it
33031 will give any retry information for that local part in your default domain.
33032 A message id can be used to obtain retry information pertaining to a specific
33033 message. This exists only when an attempt to deliver a message to a remote host
33034 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
33035 &'exinext'& is not particularly efficient, but then it is not expected to be
33036 run very often.
33037
33038 The &'exinext'& utility calls Exim to find out information such as the location
33039 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
33040 passed on to the &'exim'& commands. The first specifies an alternate Exim
33041 configuration file, and the second sets macros for use within the configuration
33042 file. These features are mainly to help in testing, but might also be useful in
33043 environments where more than one configuration file is in use.
33044
33045
33046
33047 .section "Hints database maintenance" "SECThindatmai"
33048 .cindex "hints database" "maintenance"
33049 .cindex "maintaining Exim's hints database"
33050 Three utility programs are provided for maintaining the DBM files that Exim
33051 uses to contain its delivery hint information. Each program requires two
33052 arguments. The first specifies the name of Exim's spool directory, and the
33053 second is the name of the database it is to operate on. These are as follows:
33054
33055 .ilist
33056 &'retry'&: the database of retry information
33057 .next
33058 &'wait-'&<&'transport name'&>: databases of information about messages waiting
33059 for remote hosts
33060 .next
33061 &'callout'&: the callout cache
33062 .next
33063 &'ratelimit'&: the data for implementing the ratelimit ACL condition
33064 .next
33065 &'misc'&: other hints data
33066 .endlist
33067
33068 The &'misc'& database is used for
33069
33070 .ilist
33071 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
33072 .next
33073 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
33074 &(smtp)& transport)
33075 .endlist
33076
33077
33078
33079 .section "exim_dumpdb" "SECID261"
33080 .cindex "&'exim_dumpdb'&"
33081 The entire contents of a database are written to the standard output by the
33082 &'exim_dumpdb'& program, which has no options or arguments other than the
33083 spool and database names. For example, to dump the retry database:
33084 .code
33085 exim_dumpdb /var/spool/exim retry
33086 .endd
33087 Two lines of output are produced for each entry:
33088 .code
33089 T:mail.ref.example:192.168.242.242 146 77 Connection refused
33090 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
33091 .endd
33092 The first item on the first line is the key of the record. It starts with one
33093 of the letters R, or T, depending on whether it refers to a routing or
33094 transport retry. For a local delivery, the next part is the local address; for
33095 a remote delivery it is the name of the remote host, followed by its failing IP
33096 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
33097 transport). If the remote port is not the standard one (port 25), it is added
33098 to the IP address. Then there follows an error code, an additional error code,
33099 and a textual description of the error.
33100
33101 The three times on the second line are the time of first failure, the time of
33102 the last delivery attempt, and the computed time for the next attempt. The line
33103 ends with an asterisk if the cutoff time for the last retry rule has been
33104 exceeded.
33105
33106 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
33107 consists of a host name followed by a list of ids for messages that are or were
33108 waiting to be delivered to that host. If there are a very large number for any
33109 one host, continuation records, with a sequence number added to the host name,
33110 may be seen. The data in these records is often out of date, because a message
33111 may be routed to several alternative hosts, and Exim makes no effort to keep
33112 cross-references.
33113
33114
33115
33116 .section "exim_tidydb" "SECID262"
33117 .cindex "&'exim_tidydb'&"
33118 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
33119 database. If run with no options, it removes all records that are more than 30
33120 days old. The age is calculated from the date and time that the record was last
33121 updated. Note that, in the case of the retry database, it is &'not'& the time
33122 since the first delivery failure. Information about a host that has been down
33123 for more than 30 days will remain in the database, provided that the record is
33124 updated sufficiently often.
33125
33126 The cutoff date can be altered by means of the &%-t%& option, which must be
33127 followed by a time. For example, to remove all records older than a week from
33128 the retry database:
33129 .code
33130 exim_tidydb -t 7d /var/spool/exim retry
33131 .endd
33132 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
33133 message ids. In the former these appear as data in records keyed by host &--
33134 they were messages that were waiting for that host &-- and in the latter they
33135 are the keys for retry information for messages that have suffered certain
33136 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
33137 message ids in database records are those of messages that are still on the
33138 queue. Message ids for messages that no longer exist are removed from
33139 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
33140 For the &'retry'& database, records whose keys are non-existent message ids are
33141 removed. The &'exim_tidydb'& utility outputs comments on the standard output
33142 whenever it removes information from the database.
33143
33144 Certain records are automatically removed by Exim when they are no longer
33145 needed, but others are not. For example, if all the MX hosts for a domain are
33146 down, a retry record is created for each one. If the primary MX host comes back
33147 first, its record is removed when Exim successfully delivers to it, but the
33148 records for the others remain because Exim has not tried to use those hosts.
33149
33150 It is important, therefore, to run &'exim_tidydb'& periodically on all the
33151 hints databases. You should do this at a quiet time of day, because it requires
33152 a database to be locked (and therefore inaccessible to Exim) while it does its
33153 work. Removing records from a DBM file does not normally make the file smaller,
33154 but all the common DBM libraries are able to re-use the space that is released.
33155 After an initial phase of increasing in size, the databases normally reach a
33156 point at which they no longer get any bigger, as long as they are regularly
33157 tidied.
33158
33159 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
33160 databases is likely to keep on increasing.
33161
33162
33163
33164
33165 .section "exim_fixdb" "SECID263"
33166 .cindex "&'exim_fixdb'&"
33167 The &'exim_fixdb'& program is a utility for interactively modifying databases.
33168 Its main use is for testing Exim, but it might also be occasionally useful for
33169 getting round problems in a live system. It has no options, and its interface
33170 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
33171 key of a database record can then be entered, and the data for that record is
33172 displayed.
33173
33174 If &"d"& is typed at the next prompt, the entire record is deleted. For all
33175 except the &'retry'& database, that is the only operation that can be carried
33176 out. For the &'retry'& database, each field is output preceded by a number, and
33177 data for individual fields can be changed by typing the field number followed
33178 by new data, for example:
33179 .code
33180 > 4 951102:1000
33181 .endd
33182 resets the time of the next delivery attempt. Time values are given as a
33183 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
33184 used as optional separators.
33185
33186
33187
33188
33189 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
33190 .cindex "mailbox" "maintenance"
33191 .cindex "&'exim_lock'&"
33192 .cindex "locking mailboxes"
33193 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
33194 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
33195 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
33196 a user agent while investigating a problem. The utility requires the name of
33197 the file as its first argument. If the locking is successful, the second
33198 argument is run as a command (using C's &[system()]& function); if there is no
33199 second argument, the value of the SHELL environment variable is used; if this
33200 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
33201 is unlocked and the utility ends. The following options are available:
33202
33203 .vlist
33204 .vitem &%-fcntl%&
33205 Use &[fcntl()]& locking on the open mailbox.
33206
33207 .vitem &%-flock%&
33208 Use &[flock()]& locking on the open mailbox, provided the operating system
33209 supports it.
33210
33211 .vitem &%-interval%&
33212 This must be followed by a number, which is a number of seconds; it sets the
33213 interval to sleep between retries (default 3).
33214
33215 .vitem &%-lockfile%&
33216 Create a lock file before opening the mailbox.
33217
33218 .vitem &%-mbx%&
33219 Lock the mailbox using MBX rules.
33220
33221 .vitem &%-q%&
33222 Suppress verification output.
33223
33224 .vitem &%-retries%&
33225 This must be followed by a number; it sets the number of times to try to get
33226 the lock (default 10).
33227
33228 .vitem &%-restore_time%&
33229 This option causes &%exim_lock%& to restore the modified and read times to the
33230 locked file before exiting. This allows you to access a locked mailbox (for
33231 example, to take a backup copy) without disturbing the times that the user
33232 subsequently sees.
33233
33234 .vitem &%-timeout%&
33235 This must be followed by a number, which is a number of seconds; it sets a
33236 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
33237 default), a non-blocking call is used.
33238
33239 .vitem &%-v%&
33240 Generate verbose output.
33241 .endlist
33242
33243 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
33244 default is to create a lock file and also to use &[fcntl()]& locking on the
33245 mailbox, which is the same as Exim's default. The use of &%-flock%& or
33246 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
33247 requires that the directory containing the file be writeable. Locking by lock
33248 file does not last for ever; Exim assumes that a lock file is expired if it is
33249 more than 30 minutes old.
33250
33251 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
33252 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
33253 to be taken out on the open mailbox, and an exclusive lock on the file
33254 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
33255 number of the mailbox file. When the locking is released, if an exclusive lock
33256 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
33257
33258 The default output contains verification of the locking that takes place. The
33259 &%-v%& option causes some additional information to be given. The &%-q%& option
33260 suppresses all output except error messages.
33261
33262 A command such as
33263 .code
33264 exim_lock /var/spool/mail/spqr
33265 .endd
33266 runs an interactive shell while the file is locked, whereas
33267 .display
33268 &`exim_lock -q /var/spool/mail/spqr <<End`&
33269 <&'some commands'&>
33270 &`End`&
33271 .endd
33272 runs a specific non-interactive sequence of commands while the file is locked,
33273 suppressing all verification output. A single command can be run by a command
33274 such as
33275 .code
33276 exim_lock -q /var/spool/mail/spqr \
33277   "cp /var/spool/mail/spqr /some/where"
33278 .endd
33279 Note that if a command is supplied, it must be entirely contained within the
33280 second argument &-- hence the quotes.
33281 .ecindex IIDutils
33282
33283
33284 . ////////////////////////////////////////////////////////////////////////////
33285 . ////////////////////////////////////////////////////////////////////////////
33286
33287 .chapter "The Exim monitor" "CHAPeximon"
33288 .scindex IIDeximon "Exim monitor" "description"
33289 .cindex "X-windows"
33290 .cindex "&'eximon'&"
33291 .cindex "Local/eximon.conf"
33292 .cindex "&_exim_monitor/EDITME_&"
33293 The Exim monitor is an application which displays in an X window information
33294 about the state of Exim's queue and what Exim is doing. An admin user can
33295 perform certain operations on messages from this GUI interface; however all
33296 such facilities are also available from the command line, and indeed, the
33297 monitor itself makes use of the command line to perform any actions requested.
33298
33299
33300
33301 .section "Running the monitor" "SECID264"
33302 The monitor is started by running the script called &'eximon'&. This is a shell
33303 script that sets up a number of environment variables, and then runs the
33304 binary called &_eximon.bin_&. The default appearance of the monitor window can
33305 be changed by editing the &_Local/eximon.conf_& file created by editing
33306 &_exim_monitor/EDITME_&. Comments in that file describe what the various
33307 parameters are for.
33308
33309 The parameters that get built into the &'eximon'& script can be overridden for
33310 a particular invocation by setting up environment variables of the same names,
33311 preceded by &`EXIMON_`&. For example, a shell command such as
33312 .code
33313 EXIMON_LOG_DEPTH=400 eximon
33314 .endd
33315 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
33316 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
33317 overrides the Exim log file configuration. This makes it possible to have
33318 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
33319 syslog messages are routed to a file on the local host.
33320
33321 X resources can be used to change the appearance of the window in the normal
33322 way. For example, a resource setting of the form
33323 .code
33324 Eximon*background: gray94
33325 .endd
33326 changes the colour of the background to light grey rather than white. The
33327 stripcharts are drawn with both the data lines and the reference lines in
33328 black. This means that the reference lines are not visible when on top of the
33329 data. However, their colour can be changed by setting a resource called
33330 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
33331 For example, if your X server is running Unix, you could set up lighter
33332 reference lines in the stripcharts by obeying
33333 .code
33334 xrdb -merge <<End
33335 Eximon*highlight: gray
33336 End
33337 .endd
33338 .cindex "admin user"
33339 In order to see the contents of messages on the queue, and to operate on them,
33340 &'eximon'& must either be run as root or by an admin user.
33341
33342 The monitor's window is divided into three parts. The first contains one or
33343 more stripcharts and two action buttons, the second contains a &"tail"& of the
33344 main log file, and the third is a display of the queue of messages awaiting
33345 delivery, with two more action buttons. The following sections describe these
33346 different parts of the display.
33347
33348
33349
33350
33351 .section "The stripcharts" "SECID265"
33352 .cindex "stripchart"
33353 The first stripchart is always a count of messages on the queue. Its name can
33354 be configured by setting QUEUE_STRIPCHART_NAME in the
33355 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
33356 configuration script by regular expression matches on log file entries, making
33357 it possible to display, for example, counts of messages delivered to certain
33358 hosts or using certain transports. The supplied defaults display counts of
33359 received and delivered messages, and of local and SMTP deliveries. The default
33360 period between stripchart updates is one minute; this can be adjusted by a
33361 parameter in the &_Local/eximon.conf_& file.
33362
33363 The stripchart displays rescale themselves automatically as the value they are
33364 displaying changes. There are always 10 horizontal lines in each chart; the
33365 title string indicates the value of each division when it is greater than one.
33366 For example, &"x2"& means that each division represents a value of 2.
33367
33368 It is also possible to have a stripchart which shows the percentage fullness of
33369 a particular disk partition, which is useful when local deliveries are confined
33370 to a single partition.
33371
33372 .cindex "&%statvfs%& function"
33373 This relies on the availability of the &[statvfs()]& function or equivalent in
33374 the operating system. Most, but not all versions of Unix that support Exim have
33375 this. For this particular stripchart, the top of the chart always represents
33376 100%, and the scale is given as &"x10%"&. This chart is configured by setting
33377 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
33378 &_Local/eximon.conf_& file.
33379
33380
33381
33382
33383 .section "Main action buttons" "SECID266"
33384 .cindex "size" "of monitor window"
33385 .cindex "Exim monitor" "window size"
33386 .cindex "window size"
33387 Below the stripcharts there is an action button for quitting the monitor. Next
33388 to this is another button marked &"Size"&. They are placed here so that
33389 shrinking the window to its default minimum size leaves just the queue count
33390 stripchart and these two buttons visible. Pressing the &"Size"& button causes
33391 the window to expand to its maximum size, unless it is already at the maximum,
33392 in which case it is reduced to its minimum.
33393
33394 When expanding to the maximum, if the window cannot be fully seen where it
33395 currently is, it is moved back to where it was the last time it was at full
33396 size. When it is expanding from its minimum size, the old position is
33397 remembered, and next time it is reduced to the minimum it is moved back there.
33398
33399 The idea is that you can keep a reduced window just showing one or two
33400 stripcharts at a convenient place on your screen, easily expand it to show
33401 the full window when required, and just as easily put it back to what it was.
33402 The idea is copied from what the &'twm'& window manager does for its
33403 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
33404 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
33405
33406 Normally, the monitor starts up with the window at its full size, but it can be
33407 built so that it starts up with the window at its smallest size, by setting
33408 START_SMALL=yes in &_Local/eximon.conf_&.
33409
33410
33411
33412 .section "The log display" "SECID267"
33413 .cindex "log" "tail of; in monitor"
33414 The second section of the window is an area in which a display of the tail of
33415 the main log is maintained.
33416 To save space on the screen, the timestamp on each log line is shortened by
33417 removing the date and, if &%log_timezone%& is set, the timezone.
33418 The log tail is not available when the only destination for logging data is
33419 syslog, unless the syslog lines are routed to a local file whose name is passed
33420 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
33421
33422 The log sub-window has a scroll bar at its lefthand side which can be used to
33423 move back to look at earlier text, and the up and down arrow keys also have a
33424 scrolling effect. The amount of log that is kept depends on the setting of
33425 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
33426 to use. When this is full, the earlier 50% of data is discarded &-- this is
33427 much more efficient than throwing it away line by line. The sub-window also has
33428 a horizontal scroll bar for accessing the ends of long log lines. This is the
33429 only means of horizontal scrolling; the right and left arrow keys are not
33430 available. Text can be cut from this part of the window using the mouse in the
33431 normal way. The size of this subwindow is controlled by parameters in the
33432 configuration file &_Local/eximon.conf_&.
33433
33434 Searches of the text in the log window can be carried out by means of the ^R
33435 and ^S keystrokes, which default to a reverse and a forward search,
33436 respectively. The search covers only the text that is displayed in the window.
33437 It cannot go further back up the log.
33438
33439 The point from which the search starts is indicated by a caret marker. This is
33440 normally at the end of the text in the window, but can be positioned explicitly
33441 by pointing and clicking with the left mouse button, and is moved automatically
33442 by a successful search. If new text arrives in the window when it is scrolled
33443 back, the caret remains where it is, but if the window is not scrolled back,
33444 the caret is moved to the end of the new text.
33445
33446 Pressing ^R or ^S pops up a window into which the search text can be typed.
33447 There are buttons for selecting forward or reverse searching, for carrying out
33448 the search, and for cancelling. If the &"Search"& button is pressed, the search
33449 happens and the window remains so that further searches can be done. If the
33450 &"Return"& key is pressed, a single search is done and the window is closed. If
33451 ^C is typed the search is cancelled.
33452
33453 The searching facility is implemented using the facilities of the Athena text
33454 widget. By default this pops up a window containing both &"search"& and
33455 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
33456 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
33457 However, the linkers in BSDI and HP-UX seem unable to handle an externally
33458 provided version of &%TextPop%& when the remaining parts of the text widget
33459 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
33460 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
33461 on these systems, at the expense of having unwanted items in the search popup
33462 window.
33463
33464
33465
33466 .section "The queue display" "SECID268"
33467 .cindex "queue" "display in monitor"
33468 The bottom section of the monitor window contains a list of all messages that
33469 are on the queue, which includes those currently being received or delivered,
33470 as well as those awaiting delivery. The size of this subwindow is controlled by
33471 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
33472 at which it is updated is controlled by another parameter in the same file &--
33473 the default is 5 minutes, since queue scans can be quite expensive. However,
33474 there is an &"Update"& action button just above the display which can be used
33475 to force an update of the queue display at any time.
33476
33477 When a host is down for some time, a lot of pending mail can build up for it,
33478 and this can make it hard to deal with other messages on the queue. To help
33479 with this situation there is a button next to &"Update"& called &"Hide"&. If
33480 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
33481 type anything in here and press &"Return"&, the text is added to a chain of
33482 such texts, and if every undelivered address in a message matches at least one
33483 of the texts, the message is not displayed.
33484
33485 If there is an address that does not match any of the texts, all the addresses
33486 are displayed as normal. The matching happens on the ends of addresses so, for
33487 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
33488 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
33489 has been set up, a button called &"Unhide"& is displayed. If pressed, it
33490 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
33491 a hide request is automatically cancelled after one hour.
33492
33493 While the dialogue box is displayed, you can't press any buttons or do anything
33494 else to the monitor window. For this reason, if you want to cut text from the
33495 queue display to use in the dialogue box, you have to do the cutting before
33496 pressing the &"Hide"& button.
33497
33498 The queue display contains, for each unhidden queued message, the length of
33499 time it has been on the queue, the size of the message, the message id, the
33500 message sender, and the first undelivered recipient, all on one line. If it is
33501 a bounce message, the sender is shown as &"<>"&. If there is more than one
33502 recipient to which the message has not yet been delivered, subsequent ones are
33503 listed on additional lines, up to a maximum configured number, following which
33504 an ellipsis is displayed. Recipients that have already received the message are
33505 not shown.
33506
33507 .cindex "frozen messages" "display"
33508 If a message is frozen, an asterisk is displayed at the left-hand side.
33509
33510 The queue display has a vertical scroll bar, and can also be scrolled by means
33511 of the arrow keys. Text can be cut from it using the mouse in the normal way.
33512 The text searching facilities, as described above for the log window, are also
33513 available, but the caret is always moved to the end of the text when the queue
33514 display is updated.
33515
33516
33517
33518 .section "The queue menu" "SECID269"
33519 .cindex "queue" "menu in monitor"
33520 If the &%shift%& key is held down and the left button is clicked when the mouse
33521 pointer is over the text for any message, an action menu pops up, and the first
33522 line of the queue display for the message is highlighted. This does not affect
33523 any selected text.
33524
33525 If you want to use some other event for popping up the menu, you can set the
33526 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
33527 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
33528 value set in this parameter is a standard X event description. For example, to
33529 run eximon using &%ctrl%& rather than &%shift%& you could use
33530 .code
33531 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
33532 .endd
33533 The title of the menu is the message id, and it contains entries which act as
33534 follows:
33535
33536 .ilist
33537 &'message log'&: The contents of the message log for the message are displayed
33538 in a new text window.
33539 .next
33540 &'headers'&: Information from the spool file that contains the envelope
33541 information and headers is displayed in a new text window. See chapter
33542 &<<CHAPspool>>& for a description of the format of spool files.
33543 .next
33544 &'body'&: The contents of the spool file containing the body of the message are
33545 displayed in a new text window. There is a default limit of 20,000 bytes to the
33546 amount of data displayed. This can be changed by setting the BODY_MAX
33547 option at compile time, or the EXIMON_BODY_MAX option at run time.
33548 .next
33549 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
33550 delivery of the message. This causes an automatic thaw if the message is
33551 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
33552 a new text window. The delivery is run in a separate process, to avoid holding
33553 up the monitor while the delivery proceeds.
33554 .next
33555 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
33556 that the message be frozen.
33557 .next
33558 .cindex "thawing messages"
33559 .cindex "unfreezing messages"
33560 .cindex "frozen messages" "thawing"
33561 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
33562 that the message be thawed.
33563 .next
33564 .cindex "delivery" "forcing failure"
33565 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
33566 that Exim gives up trying to deliver the message. A bounce message is generated
33567 for any remaining undelivered addresses.
33568 .next
33569 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
33570 that the message be deleted from the system without generating a bounce
33571 message.
33572 .next
33573 &'add recipient'&: A dialog box is displayed into which a recipient address can
33574 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
33575 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
33576 Otherwise it must be entered as a fully qualified address. Pressing RETURN
33577 causes a call to Exim to be made using the &%-Mar%& option to request that an
33578 additional recipient be added to the message, unless the entry box is empty, in
33579 which case no action is taken.
33580 .next
33581 &'mark delivered'&: A dialog box is displayed into which a recipient address
33582 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
33583 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
33584 Otherwise it must be entered as a fully qualified address. Pressing RETURN
33585 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
33586 recipient address as already delivered, unless the entry box is empty, in which
33587 case no action is taken.
33588 .next
33589 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
33590 mark all recipient addresses as already delivered.
33591 .next
33592 &'edit sender'&: A dialog box is displayed initialized with the current
33593 sender's address. Pressing RETURN causes a call to Exim to be made using the
33594 &%-Mes%& option to replace the sender address, unless the entry box is empty,
33595 in which case no action is taken. If you want to set an empty sender (as in
33596 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
33597 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
33598 the address is qualified with that domain.
33599 .endlist
33600
33601 When a delivery is forced, a window showing the &%-v%& output is displayed. In
33602 other cases when a call to Exim is made, if there is any output from Exim (in
33603 particular, if the command fails) a window containing the command and the
33604 output is displayed. Otherwise, the results of the action are normally apparent
33605 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
33606 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
33607 if no output is generated.
33608
33609 The queue display is automatically updated for actions such as freezing and
33610 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
33611 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
33612 force an update of the display after one of these actions.
33613
33614 In any text window that is displayed as result of a menu action, the normal
33615 cut-and-paste facility is available, and searching can be carried out using ^R
33616 and ^S, as described above for the log tail window.
33617 .ecindex IIDeximon
33618
33619
33620
33621
33622
33623 . ////////////////////////////////////////////////////////////////////////////
33624 . ////////////////////////////////////////////////////////////////////////////
33625
33626 .chapter "Security considerations" "CHAPsecurity"
33627 .scindex IIDsecurcon "security" "discussion of"
33628 This chapter discusses a number of issues concerned with security, some of
33629 which are also covered in other parts of this manual.
33630
33631 For reasons that this author does not understand, some people have promoted
33632 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
33633 existence of this chapter in the documentation. However, the intent of the
33634 chapter is simply to describe the way Exim works in relation to certain
33635 security concerns, not to make any specific claims about the effectiveness of
33636 its security as compared with other MTAs.
33637
33638 What follows is a description of the way Exim is supposed to be. Best efforts
33639 have been made to try to ensure that the code agrees with the theory, but an
33640 absence of bugs can never be guaranteed. Any that are reported will get fixed
33641 as soon as possible.
33642
33643
33644 .section "Building a more &""hardened""& Exim" "SECID286"
33645 .cindex "security" "build-time features"
33646 There are a number of build-time options that can be set in &_Local/Makefile_&
33647 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
33648 Exim administrator who does not have the root password, or by someone who has
33649 penetrated the Exim (but not the root) account. These options are as follows:
33650
33651 .ilist
33652 ALT_CONFIG_PREFIX can be set to a string that is required to match the
33653 start of any file names used with the &%-C%& option. When it is set, these file
33654 names are also not allowed to contain the sequence &"/../"&. (However, if the
33655 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
33656 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
33657 default setting for &%ALT_CONFIG_PREFIX%&.
33658
33659 If the permitted configuration files are confined to a directory to
33660 which only root has access, this guards against someone who has broken
33661 into the Exim account from running a privileged Exim with an arbitrary
33662 configuration file, and using it to break into other accounts.
33663 .next
33664 If ALT_CONFIG_ROOT_ONLY is defined, root privilege is retained for &%-C%&
33665 and &%-D%& only if the caller of Exim is root. Without it, the Exim user may
33666 also use &%-C%& and &%-D%& and retain privilege. Setting this option locks out
33667 the possibility of testing a configuration using &%-C%& right through message
33668 reception and delivery, even if the caller is root. The reception works, but by
33669 that time, Exim is running as the Exim user, so when it re-execs to regain
33670 privilege for the delivery, the use of &%-C%& causes privilege to be lost.
33671 However, root can test reception and delivery using two separate commands.
33672 ALT_CONFIG_ROOT_ONLY is not set by default.
33673 .next
33674 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
33675 is disabled.
33676 .next
33677 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
33678 never to be used for any deliveries. This is like the &%never_users%& runtime
33679 option, but it cannot be overridden; the runtime option adds additional users
33680 to the list. The default setting is &"root"&; this prevents a non-root user who
33681 is permitted to modify the runtime file from using Exim as a way to get root.
33682 .endlist
33683
33684
33685
33686
33687 .section "Root privilege" "SECID270"
33688 .cindex "setuid"
33689 .cindex "root privilege"
33690 The Exim binary is normally setuid to root, which means that it gains root
33691 privilege (runs as root) when it starts execution. In some special cases (for
33692 example, when the daemon is not in use and there are no local deliveries), it
33693 may be possible to run Exim setuid to some user other than root. This is
33694 discussed in the next section. However, in most installations, root privilege
33695 is required for two things:
33696
33697 .ilist
33698 To set up a socket connected to the standard SMTP port (25) when initialising
33699 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
33700 not required.
33701 .next
33702 To be able to change uid and gid in order to read users' &_.forward_& files and
33703 perform local deliveries as the receiving user or as specified in the
33704 configuration.
33705 .endlist
33706
33707 It is not necessary to be root to do any of the other things Exim does, such as
33708 receiving messages and delivering them externally over SMTP, and it is
33709 obviously more secure if Exim does not run as root except when necessary.
33710 For this reason, a user and group for Exim to use must be defined in
33711 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
33712 group"&. Their values can be changed by the run time configuration, though this
33713 is not recommended. Often a user called &'exim'& is used, but some sites use
33714 &'mail'& or another user name altogether.
33715
33716 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
33717 abdication; the process cannot regain root afterwards. Prior to release 4.00,
33718 &[seteuid()]& was used in some circumstances, but this is no longer the case.
33719
33720 After a new Exim process has interpreted its command line options, it changes
33721 uid and gid in the following cases:
33722
33723 .ilist
33724 .oindex "&%-C%&"
33725 .oindex "&%-D%&"
33726 If the &%-C%& option is used to specify an alternate configuration file, or if
33727 the &%-D%& option is used to define macro values for the configuration, and the
33728 calling process is not running as root or the Exim user, the uid and gid are
33729 changed to those of the calling process.
33730 However, if ALT_CONFIG_ROOT_ONLY is defined in &_Local/Makefile_&, only
33731 root callers may use &%-C%& and &%-D%& without losing privilege, and if
33732 DISABLE_D_OPTION is set, the &%-D%& option may not be used at all.
33733 .next
33734 .oindex "&%-be%&"
33735 .oindex "&%-bf%&"
33736 .oindex "&%-bF%&"
33737 If the expansion test option (&%-be%&) or one of the filter testing options
33738 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
33739 calling process.
33740 .next
33741 If the process is not a daemon process or a queue runner process or a delivery
33742 process or a process for testing address routing (started with &%-bt%&), the
33743 uid and gid are changed to the Exim user and group. This means that Exim always
33744 runs under its own uid and gid when receiving messages. This also applies when
33745 testing address verification
33746 .oindex "&%-bv%&"
33747 .oindex "&%-bh%&"
33748 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
33749 option).
33750 .next
33751 For a daemon, queue runner, delivery, or address testing process, the uid
33752 remains as root at this stage, but the gid is changed to the Exim group.
33753 .endlist
33754
33755 The processes that initially retain root privilege behave as follows:
33756
33757 .ilist
33758 A daemon process changes the gid to the Exim group and the uid to the Exim
33759 user after setting up one or more listening sockets. The &[initgroups()]&
33760 function is called, so that if the Exim user is in any additional groups, they
33761 will be used during message reception.
33762 .next
33763 A queue runner process retains root privilege throughout its execution. Its
33764 job is to fork a controlled sequence of delivery processes.
33765 .next
33766 A delivery process retains root privilege throughout most of its execution,
33767 but any actual deliveries (that is, the transports themselves) are run in
33768 subprocesses which always change to a non-root uid and gid. For local
33769 deliveries this is typically the uid and gid of the owner of the mailbox; for
33770 remote deliveries, the Exim uid and gid are used. Once all the delivery
33771 subprocesses have been run, a delivery process changes to the Exim uid and gid
33772 while doing post-delivery tidying up such as updating the retry database and
33773 generating bounce and warning messages.
33774
33775 While the recipient addresses in a message are being routed, the delivery
33776 process runs as root. However, if a user's filter file has to be processed,
33777 this is done in a subprocess that runs under the individual user's uid and
33778 gid. A system filter is run as root unless &%system_filter_user%& is set.
33779 .next
33780 A process that is testing addresses (the &%-bt%& option) runs as root so that
33781 the routing is done in the same environment as a message delivery.
33782 .endlist
33783
33784
33785
33786
33787 .section "Running Exim without privilege" "SECTrunexiwitpri"
33788 .cindex "privilege, running without"
33789 .cindex "unprivileged running"
33790 .cindex "root privilege" "running without"
33791 Some installations like to run Exim in an unprivileged state for more of its
33792 operation, for added security. Support for this mode of operation is provided
33793 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
33794 gid are changed to the Exim user and group at the start of a delivery process
33795 (and also queue runner and address testing processes). This means that address
33796 routing is no longer run as root, and the deliveries themselves cannot change
33797 to any other uid.
33798
33799 .cindex SIGHUP
33800 .cindex "daemon" "restarting"
33801 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
33802 that the daemon can still be started in the usual way, and it can respond
33803 correctly to SIGHUP because the re-invocation regains root privilege.
33804
33805 An alternative approach is to make Exim setuid to the Exim user and also setgid
33806 to the Exim group. If you do this, the daemon must be started from a root
33807 process. (Calling Exim from a root process makes it behave in the way it does
33808 when it is setuid root.) However, the daemon cannot restart itself after a
33809 SIGHUP signal because it cannot regain privilege.
33810
33811 It is still useful to set &%deliver_drop_privilege%& in this case, because it
33812 stops Exim from trying to re-invoke itself to do a delivery after a message has
33813 been received. Such a re-invocation is a waste of resources because it has no
33814 effect.
33815
33816 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
33817 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
33818 to the Exim user seems a clean approach, but there is one complication:
33819
33820 In this style of operation, Exim is running with the real uid and gid set to
33821 those of the calling process, and the effective uid/gid set to Exim's values.
33822 Ideally, any association with the calling process' uid/gid should be dropped,
33823 that is, the real uid/gid should be reset to the effective values so as to
33824 discard any privileges that the caller may have. While some operating systems
33825 have a function that permits this action for a non-root effective uid, quite a
33826 number of them do not. Because of this lack of standardization, Exim does not
33827 address this problem at this time.
33828
33829 For this reason, the recommended approach for &"mostly unprivileged"& running
33830 is to keep the Exim binary setuid to root, and to set
33831 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
33832 be used in the most straightforward way.
33833
33834 If you configure Exim not to run delivery processes as root, there are a
33835 number of restrictions on what you can do:
33836
33837 .ilist
33838 You can deliver only as the Exim user/group. You should  explicitly use the
33839 &%user%& and &%group%& options to override routers or local transports that
33840 normally deliver as the recipient. This makes sure that configurations that
33841 work in this mode function the same way in normal mode. Any implicit or
33842 explicit specification of another user causes an error.
33843 .next
33844 Use of &_.forward_& files is severely restricted, such that it is usually
33845 not worthwhile to include them in the configuration.
33846 .next
33847 Users who wish to use &_.forward_& would have to make their home directory and
33848 the file itself accessible to the Exim user. Pipe and append-to-file entries,
33849 and their equivalents in Exim filters, cannot be used. While they could be
33850 enabled in the Exim user's name, that would be insecure and not very useful.
33851 .next
33852 Unless the local user mailboxes are all owned by the Exim user (possible in
33853 some POP3 or IMAP-only environments):
33854
33855 .olist
33856 They must be owned by the Exim group and be writeable by that group. This
33857 implies you must set &%mode%& in the appendfile configuration, as well as the
33858 mode of the mailbox files themselves.
33859 .next
33860 You must set &%no_check_owner%&, since most or all of the files will not be
33861 owned by the Exim user.
33862 .next
33863 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
33864 on a newly created mailbox when unprivileged. This also implies that new
33865 mailboxes need to be created manually.
33866 .endlist olist
33867 .endlist ilist
33868
33869
33870 These restrictions severely restrict what can be done in local deliveries.
33871 However, there are no restrictions on remote deliveries. If you are running a
33872 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
33873 gives more security at essentially no cost.
33874
33875 If you are using the &%mua_wrapper%& facility (see chapter
33876 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
33877
33878
33879
33880
33881 .section "Delivering to local files" "SECID271"
33882 Full details of the checks applied by &(appendfile)& before it writes to a file
33883 are given in chapter &<<CHAPappendfile>>&.
33884
33885
33886
33887 .section "IPv4 source routing" "SECID272"
33888 .cindex "source routing" "in IP packets"
33889 .cindex "IP source routing"
33890 Many operating systems suppress IP source-routed packets in the kernel, but
33891 some cannot be made to do this, so Exim does its own check. It logs incoming
33892 IPv4 source-routed TCP calls, and then drops them. Things are all different in
33893 IPv6. No special checking is currently done.
33894
33895
33896
33897 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
33898 Support for these SMTP commands is disabled by default. If required, they can
33899 be enabled by defining suitable ACLs.
33900
33901
33902
33903
33904 .section "Privileged users" "SECID274"
33905 .cindex "trusted users"
33906 .cindex "admin user"
33907 .cindex "privileged user"
33908 .cindex "user" "trusted"
33909 .cindex "user" "admin"
33910 Exim recognizes two sets of users with special privileges. Trusted users are
33911 able to submit new messages to Exim locally, but supply their own sender
33912 addresses and information about a sending host. For other users submitting
33913 local messages, Exim sets up the sender address from the uid, and doesn't
33914 permit a remote host to be specified.
33915
33916 .oindex "&%-f%&"
33917 However, an untrusted user is permitted to use the &%-f%& command line option
33918 in the special form &%-f <>%& to indicate that a delivery failure for the
33919 message should not cause an error report. This affects the message's envelope,
33920 but it does not affect the &'Sender:'& header. Untrusted users may also be
33921 permitted to use specific forms of address with the &%-f%& option by setting
33922 the &%untrusted_set_sender%& option.
33923
33924 Trusted users are used to run processes that receive mail messages from some
33925 other mail domain and pass them on to Exim for delivery either locally, or over
33926 the Internet. Exim trusts a caller that is running as root, as the Exim user,
33927 as any user listed in the &%trusted_users%& configuration option, or under any
33928 group listed in the &%trusted_groups%& option.
33929
33930 Admin users are permitted to do things to the messages on Exim's queue. They
33931 can freeze or thaw messages, cause them to be returned to their senders, remove
33932 them entirely, or modify them in various ways. In addition, admin users can run
33933 the Exim monitor and see all the information it is capable of providing, which
33934 includes the contents of files on the spool.
33935
33936 .oindex "&%-M%&"
33937 .oindex "&%-q%&"
33938 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
33939 delivery of messages on its queue is restricted to admin users. This
33940 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
33941 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
33942 queue is also restricted to admin users. This restriction can be relaxed by
33943 setting &%no_queue_list_requires_admin%&.
33944
33945 Exim recognizes an admin user if the calling process is running as root or as
33946 the Exim user or if any of the groups associated with the calling process is
33947 the Exim group. It is not necessary actually to be running under the Exim
33948 group. However, if admin users who are not root or the Exim user are to access
33949 the contents of files on the spool via the Exim monitor (which runs
33950 unprivileged), Exim must be built to allow group read access to its spool
33951 files.
33952
33953
33954
33955 .section "Spool files" "SECID275"
33956 .cindex "spool directory" "files"
33957 Exim's spool directory and everything it contains is owned by the Exim user and
33958 set to the Exim group. The mode for spool files is defined in the
33959 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
33960 any user who is a member of the Exim group can access these files.
33961
33962
33963
33964 .section "Use of argv[0]" "SECID276"
33965 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
33966 of specific strings, Exim assumes certain options. For example, calling Exim
33967 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
33968 to calling it with the option &%-bS%&. There are no security implications in
33969 this.
33970
33971
33972
33973 .section "Use of %f formatting" "SECID277"
33974 The only use made of &"%f"& by Exim is in formatting load average values. These
33975 are actually stored in integer variables as 1000 times the load average.
33976 Consequently, their range is limited and so therefore is the length of the
33977 converted output.
33978
33979
33980
33981 .section "Embedded Exim path" "SECID278"
33982 Exim uses its own path name, which is embedded in the code, only when it needs
33983 to re-exec in order to regain root privilege. Therefore, it is not root when it
33984 does so. If some bug allowed the path to get overwritten, it would lead to an
33985 arbitrary program's being run as exim, not as root.
33986
33987
33988
33989 .section "Use of sprintf()" "SECID279"
33990 .cindex "&[sprintf()]&"
33991 A large number of occurrences of &"sprintf"& in the code are actually calls to
33992 &'string_sprintf()'&, a function that returns the result in malloc'd store.
33993 The intermediate formatting is done into a large fixed buffer by a function
33994 that runs through the format string itself, and checks the length of each
33995 conversion before performing it, thus preventing buffer overruns.
33996
33997 The remaining uses of &[sprintf()]& happen in controlled circumstances where
33998 the output buffer is known to be sufficiently long to contain the converted
33999 string.
34000
34001
34002
34003 .section "Use of debug_printf() and log_write()" "SECID280"
34004 Arbitrary strings are passed to both these functions, but they do their
34005 formatting by calling the function &'string_vformat()'&, which runs through
34006 the format string itself, and checks the length of each conversion.
34007
34008
34009
34010 .section "Use of strcat() and strcpy()" "SECID281"
34011 These are used only in cases where the output buffer is known to be large
34012 enough to hold the result.
34013 .ecindex IIDsecurcon
34014
34015
34016
34017
34018 . ////////////////////////////////////////////////////////////////////////////
34019 . ////////////////////////////////////////////////////////////////////////////
34020
34021 .chapter "Format of spool files" "CHAPspool"
34022 .scindex IIDforspo1 "format" "spool files"
34023 .scindex IIDforspo2 "spool directory" "format of files"
34024 .scindex IIDforspo3 "spool files" "format of"
34025 .cindex "spool files" "editing"
34026 A message on Exim's queue consists of two files, whose names are the message id
34027 followed by -D and -H, respectively. The data portion of the message is kept in
34028 the -D file on its own. The message's envelope, status, and headers are all
34029 kept in the -H file, whose format is described in this chapter. Each of these
34030 two files contains the final component of its own name as its first line. This
34031 is insurance against disk crashes where the directory is lost but the files
34032 themselves are recoverable.
34033
34034 Some people are tempted into editing -D files in order to modify messages. You
34035 need to be extremely careful if you do this; it is not recommended and you are
34036 on your own if you do it. Here are some of the pitfalls:
34037
34038 .ilist
34039 You must ensure that Exim does not try to deliver the message while you are
34040 fiddling with it. The safest way is to take out a write lock on the -D file,
34041 which is what Exim itself does, using &[fcntl()]&. If you update the file in
34042 place, the lock will be retained. If you write a new file and rename it, the
34043 lock will be lost at the instant of rename.
34044 .next
34045 .vindex "&$body_linecount$&"
34046 If you change the number of lines in the file, the value of
34047 &$body_linecount$&, which is stored in the -H file, will be incorrect. At
34048 present, this value is not used by Exim, but there is no guarantee that this
34049 will always be the case.
34050 .next
34051 If the message is in MIME format, you must take care not to break it.
34052 .next
34053 If the message is cryptographically signed, any change will invalidate the
34054 signature.
34055 .endlist
34056 All in all, modifying -D files is fraught with danger.
34057
34058 Files whose names end with -J may also be seen in the &_input_& directory (or
34059 its subdirectories when &%split_spool_directory%& is set). These are journal
34060 files, used to record addresses to which the message has been delivered during
34061 the course of a delivery attempt. If there are still undelivered recipients at
34062 the end, the -H file is updated, and the -J file is deleted. If, however, there
34063 is some kind of crash (for example, a power outage) before this happens, the -J
34064 file remains in existence. When Exim next processes the message, it notices the
34065 -J file and uses it to update the -H file before starting the next delivery
34066 attempt.
34067
34068 .section "Format of the -H file" "SECID282"
34069 .cindex "uid (user id)" "in spool file"
34070 .cindex "gid (group id)" "in spool file"
34071 The second line of the -H file contains the login name for the uid of the
34072 process that called Exim to read the message, followed by the numerical uid and
34073 gid. For a locally generated message, this is normally the user who sent the
34074 message. For a message received over TCP/IP via the daemon, it is
34075 normally the Exim user.
34076
34077 The third line of the file contains the address of the message's sender as
34078 transmitted in the envelope, contained in angle brackets. The sender address is
34079 empty for bounce messages. For incoming SMTP mail, the sender address is given
34080 in the MAIL command. For locally generated mail, the sender address is
34081 created by Exim from the login name of the current user and the configured
34082 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
34083 leading &"From&~"& line if the caller is trusted, or if the supplied address is
34084 &"<>"& or an address that matches &%untrusted_set_senders%&.
34085
34086 The fourth line contains two numbers. The first is the time that the message
34087 was received, in the conventional Unix form &-- the number of seconds since the
34088 start of the epoch. The second number is a count of the number of messages
34089 warning of delayed delivery that have been sent to the sender.
34090
34091 There follow a number of lines starting with a hyphen. These can appear in any
34092 order, and are omitted when not relevant:
34093
34094 .vlist
34095 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
34096 This item is obsolete, and is not generated from Exim release 4.61 onwards;
34097 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
34098 recognized, to provide backward compatibility. In the old format, a line of
34099 this form is present for every ACL variable that is not empty. The number
34100 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
34101 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
34102 the data string for the variable. The string itself starts at the beginning of
34103 the next line, and is followed by a newline character. It may contain internal
34104 newlines.
34105
34106 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
34107 A line of this form is present for every ACL connection variable that is
34108 defined. Note that there is a space between &%-aclc%& and the rest of the name.
34109 The length is the length of the data string for the variable. The string itself
34110 starts at the beginning of the next line, and is followed by a newline
34111 character. It may contain internal newlines.
34112
34113 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
34114 A line of this form is present for every ACL message variable that is defined.
34115 Note that there is a space between &%-aclm%& and the rest of the name. The
34116 length is the length of the data string for the variable. The string itself
34117 starts at the beginning of the next line, and is followed by a newline
34118 character. It may contain internal newlines.
34119
34120 .vitem "&%-active_hostname%&&~<&'hostname'&>"
34121 This is present if, when the message was received over SMTP, the value of
34122 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
34123
34124 .vitem &%-allow_unqualified_recipient%&
34125 This is present if unqualified recipient addresses are permitted in header
34126 lines (to stop such addresses from being qualified if rewriting occurs at
34127 transport time). Local messages that were input using &%-bnq%& and remote
34128 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
34129
34130 .vitem &%-allow_unqualified_sender%&
34131 This is present if unqualified sender addresses are permitted in header lines
34132 (to stop such addresses from being qualified if rewriting occurs at transport
34133 time). Local messages that were input using &%-bnq%& and remote messages from
34134 hosts that match &%sender_unqualified_hosts%& set this flag.
34135
34136 .vitem "&%-auth_id%&&~<&'text'&>"
34137 The id information for a message received on an authenticated SMTP connection
34138 &-- the value of the &$authenticated_id$& variable.
34139
34140 .vitem "&%-auth_sender%&&~<&'address'&>"
34141 The address of an authenticated sender &-- the value of the
34142 &$authenticated_sender$& variable.
34143
34144 .vitem "&%-body_linecount%&&~<&'number'&>"
34145 This records the number of lines in the body of the message, and is always
34146 present.
34147
34148 .vitem "&%-body_zerocount%&&~<&'number'&>"
34149 This records the number of binary zero bytes in the body of the message, and is
34150 present if the number is greater than zero.
34151
34152 .vitem &%-deliver_firsttime%&
34153 This is written when a new message is first added to the spool. When the spool
34154 file is updated after a deferral, it is omitted.
34155
34156 .vitem "&%-frozen%&&~<&'time'&>"
34157 .cindex "frozen messages" "spool data"
34158 The message is frozen, and the freezing happened at <&'time'&>.
34159
34160 .vitem "&%-helo_name%&&~<&'text'&>"
34161 This records the host name as specified by a remote host in a HELO or EHLO
34162 command.
34163
34164 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
34165 This records the IP address of the host from which the message was received and
34166 the remote port number that was used. It is omitted for locally generated
34167 messages.
34168
34169 .vitem "&%-host_auth%&&~<&'text'&>"
34170 If the message was received on an authenticated SMTP connection, this records
34171 the name of the authenticator &-- the value of the
34172 &$sender_host_authenticated$& variable.
34173
34174 .vitem &%-host_lookup_failed%&
34175 This is present if an attempt to look up the sending host's name from its IP
34176 address failed. It corresponds to the &$host_lookup_failed$& variable.
34177
34178 .vitem "&%-host_name%&&~<&'text'&>"
34179 .cindex "reverse DNS lookup"
34180 .cindex "DNS" "reverse lookup"
34181 This records the name of the remote host from which the message was received,
34182 if the host name was looked up from the IP address when the message was being
34183 received. It is not present if no reverse lookup was done.
34184
34185 .vitem "&%-ident%&&~<&'text'&>"
34186 For locally submitted messages, this records the login of the originating user,
34187 unless it was a trusted user and the &%-oMt%& option was used to specify an
34188 ident value. For messages received over TCP/IP, this records the ident string
34189 supplied by the remote host, if any.
34190
34191 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
34192 This records the IP address of the local interface and the port number through
34193 which a message was received from a remote host. It is omitted for locally
34194 generated messages.
34195
34196 .vitem &%-local%&
34197 The message is from a local sender.
34198
34199 .vitem &%-localerror%&
34200 The message is a locally-generated bounce message.
34201
34202 .vitem "&%-local_scan%&&~<&'string'&>"
34203 This records the data string that was returned by the &[local_scan()]& function
34204 when the message was received &-- the value of the &$local_scan_data$&
34205 variable. It is omitted if no data was returned.
34206
34207 .vitem &%-manual_thaw%&
34208 The message was frozen but has been thawed manually, that is, by an explicit
34209 Exim command rather than via the auto-thaw process.
34210
34211 .vitem &%-N%&
34212 A testing delivery process was started using the &%-N%& option to suppress any
34213 actual deliveries, but delivery was deferred. At any further delivery attempts,
34214 &%-N%& is assumed.
34215
34216 .vitem &%-received_protocol%&
34217 This records the value of the &$received_protocol$& variable, which contains
34218 the name of the protocol by which the message was received.
34219
34220 .vitem &%-sender_set_untrusted%&
34221 The envelope sender of this message was set by an untrusted local caller (used
34222 to ensure that the caller is displayed in queue listings).
34223
34224 .vitem "&%-spam_score_int%&&~<&'number'&>"
34225 If a message was scanned by SpamAssassin, this is present. It records the value
34226 of &$spam_score_int$&.
34227
34228 .vitem &%-tls_certificate_verified%&
34229 A TLS certificate was received from the client that sent this message, and the
34230 certificate was verified by the server.
34231
34232 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
34233 When the message was received over an encrypted connection, this records the
34234 name of the cipher suite that was used.
34235
34236 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
34237 When the message was received over an encrypted connection, and a certificate
34238 was received from the client, this records the Distinguished Name from that
34239 certificate.
34240 .endlist
34241
34242 Following the options there is a list of those addresses to which the message
34243 is not to be delivered. This set of addresses is initialized from the command
34244 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
34245 is set; otherwise it starts out empty. Whenever a successful delivery is made,
34246 the address is added to this set. The addresses are kept internally as a
34247 balanced binary tree, and it is a representation of that tree which is written
34248 to the spool file. If an address is expanded via an alias or forward file, the
34249 original address is added to the tree when deliveries to all its child
34250 addresses are complete.
34251
34252 If the tree is empty, there is a single line in the spool file containing just
34253 the text &"XX"&. Otherwise, each line consists of two letters, which are either
34254 Y or N, followed by an address. The address is the value for the node of the
34255 tree, and the letters indicate whether the node has a left branch and/or a
34256 right branch attached to it, respectively. If branches exist, they immediately
34257 follow. Here is an example of a three-node tree:
34258 .code
34259 YY darcy@austen.fict.example
34260 NN alice@wonderland.fict.example
34261 NN editor@thesaurus.ref.example
34262 .endd
34263 After the non-recipients tree, there is a list of the message's recipients.
34264 This is a simple list, preceded by a count. It includes all the original
34265 recipients of the message, including those to whom the message has already been
34266 delivered. In the simplest case, the list contains one address per line. For
34267 example:
34268 .code
34269 4
34270 editor@thesaurus.ref.example
34271 darcy@austen.fict.example
34272 rdo@foundation
34273 alice@wonderland.fict.example
34274 .endd
34275 However, when a child address has been added to the top-level addresses as a
34276 result of the use of the &%one_time%& option on a &(redirect)& router, each
34277 line is of the following form:
34278 .display
34279 <&'top-level address'&> <&'errors_to address'&> &&&
34280   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
34281 .endd
34282 The 01 flag bit indicates the presence of the three other fields that follow
34283 the top-level address. Other bits may be used in future to support additional
34284 fields. The <&'parent number'&> is the offset in the recipients list of the
34285 original parent of the &"one time"& address. The first two fields are the
34286 envelope sender that is associated with this address and its length. If the
34287 length is zero, there is no special envelope sender (there are then two space
34288 characters in the line). A non-empty field can arise from a &(redirect)& router
34289 that has an &%errors_to%& setting.
34290
34291
34292 A blank line separates the envelope and status information from the headers
34293 which follow. A header may occupy several lines of the file, and to save effort
34294 when reading it in, each header is preceded by a number and an identifying
34295 character. The number is the number of characters in the header, including any
34296 embedded newlines and the terminating newline. The character is one of the
34297 following:
34298
34299 .table2 50pt
34300 .row <&'blank'&>         "header in which Exim has no special interest"
34301 .row &`B`&               "&'Bcc:'& header"
34302 .row &`C`&               "&'Cc:'& header"
34303 .row &`F`&               "&'From:'& header"
34304 .row &`I`&               "&'Message-id:'& header"
34305 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
34306 .row &`R`&               "&'Reply-To:'& header"
34307 .row &`S`&               "&'Sender:'& header"
34308 .row &`T`&               "&'To:'& header"
34309 .row &`*`&               "replaced or deleted header"
34310 .endtable
34311
34312 Deleted or replaced (rewritten) headers remain in the spool file for debugging
34313 purposes. They are not transmitted when the message is delivered. Here is a
34314 typical set of headers:
34315 .code
34316 111P Received: by hobbit.fict.example with local (Exim 4.00)
34317 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
34318 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
34319 038* X-rewrote-sender: bb@hobbit.fict.example
34320 042* From: Bilbo Baggins <bb@hobbit.fict.example>
34321 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
34322 099* To: alice@wonderland.fict.example, rdo@foundation,
34323 darcy@austen.fict.example, editor@thesaurus.ref.example
34324 104T To: alice@wonderland.fict.example, rdo@foundation.example,
34325 darcy@austen.fict.example, editor@thesaurus.ref.example
34326 038  Date: Fri, 11 May 2001 10:28:59 +0100
34327 .endd
34328 The asterisked headers indicate that the envelope sender, &'From:'& header, and
34329 &'To:'& header have been rewritten, the last one because routing expanded the
34330 unqualified domain &'foundation'&.
34331 .ecindex IIDforspo1
34332 .ecindex IIDforspo2
34333 .ecindex IIDforspo3
34334
34335 . ////////////////////////////////////////////////////////////////////////////
34336 . ////////////////////////////////////////////////////////////////////////////
34337
34338 .chapter "Support for DKIM (DomainKeys Identified Mail) - RFC4871" "CHID12" &&&
34339          "DKIM Support"
34340 .cindex "DKIM"
34341
34342 Since version 4.70, DKIM support is compiled into Exim by default. It can be
34343 disabled by setting DISABLE_DKIM=yes in Local/Makefile.
34344
34345 Exim's DKIM implementation allows to
34346 .olist
34347 Sign outgoing messages: This function is implemented in the SMTP transport.
34348 It can co-exist with all other Exim features, including transport filters.
34349 .next
34350 Verify signatures in incoming messages: This is implemented by an additional
34351 ACL (acl_smtp_dkim), which can be called several times per message, with
34352 different signature context.
34353 .endlist
34354
34355 In typical Exim style, the verification implementation does not include any
34356 default "policy". Instead it enables you to build your own policy using
34357 Exim's standard controls.
34358
34359 Please note that verification of DKIM signatures in incoming mail is turned
34360 on by default for logging purposes. For each signature in incoming email,
34361 exim will log a line displaying the most important signature details, and the
34362 signature status. Here is an example:
34363 .code
34364 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM: d=facebookmail.com s=q1-2009b c=relaxed/relaxed a=rsa-sha1 i=@facebookmail.com t=1252484542 [verification succeeded]
34365 .endd
34366 You might want to turn off DKIM verification processing entirely for internal
34367 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
34368 control modifier. This should typically be done in the RCPT ACL, at points
34369 where you accept mail from relay sources (internal hosts or authenticated
34370 senders).
34371
34372
34373 .section "Signing outgoing messages" "SECID513"
34374 .cindex "DKIM" "signing"
34375
34376 Signing is implemented by setting private options on the SMTP transport.
34377 These options take (expandable) strings as arguments.
34378
34379 .option dkim_domain smtp string&!! unset
34380 MANDATORY
34381 The domain you want to sign with. The result of this expanded
34382 option is put into the &%$dkim_domain%& expansion variable.
34383
34384 .option dkim_selector smtp string&!! unset
34385 MANDATORY
34386 This sets the key selector string. You can use the &%$dkim_domain%& expansion
34387 variable to look up a matching selector. The result is put in the expansion
34388 variable &%$dkim_selector%& which should be used in the &%dkim_private_key%&
34389 option along with &%$dkim_domain%&.
34390
34391 .option dkim_private_key smtp string&!! unset
34392 MANDATORY
34393 This sets the private key to use. You can use the &%$dkim_domain%& and
34394 &%$dkim_selector%& expansion variables to determine the private key to use.
34395 The result can either
34396 .ilist
34397 be a valid RSA private key in ASCII armor, including line breaks.
34398 .next
34399 start with a slash, in which case it is treated as a file that contains
34400 the private key.
34401 .next
34402 be "0", "false" or the empty string, in which case the message will not
34403 be signed. This case will not result in an error, even if &%dkim_strict%&
34404 is set.
34405 .endlist
34406
34407 .option dkim_canon smtp string&!! unset
34408 OPTIONAL
34409 This option sets the canonicalization method used when signing a message.
34410 The DKIM RFC currently supports two methods: "simple" and "relaxed".
34411 The option defaults to "relaxed" when unset. Note: the current implementation
34412 only supports using the same canonicalization method for both headers and body.
34413
34414 .option dkim_strict smtp string&!! unset
34415 OPTIONAL
34416 This  option  defines  how  Exim  behaves  when  signing a message that
34417 should be signed fails for some reason.  When the expansion evaluates to
34418 either "1" or "true", Exim will defer. Otherwise Exim will send the message
34419 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
34420 variables here.
34421
34422 .option dkim_sign_headers smtp string&!! unset
34423 OPTIONAL
34424 When set, this option must expand to (or be specified as) a colon-separated
34425 list of header names. Headers with these names will be included in the message
34426 signature. When unspecified, the header names recommended in RFC4871 will be
34427 used.
34428
34429
34430 .section "Verifying DKIM signatures in incoming mail" "SECID514"
34431 .cindex "DKIM" "verification"
34432
34433 Verification of DKIM signatures in incoming email is implemented via the
34434 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
34435 syntactically(!) correct signature in the incoming message.
34436
34437 To evaluate the signature in the ACL a large number of expansion variables
34438 containing the signature status and its details are set up during the
34439 runtime of the ACL.
34440
34441 Calling the ACL only for existing signatures is not sufficient to build
34442 more advanced policies. For that reason, the global option
34443 &%dkim_verify_signers%&, and a global expansion variable
34444 &%$dkim_signers%& exist.
34445
34446 The global option &%dkim_verify_signers%& can be set to a colon-separated
34447 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
34448 called. It is expanded when the message has been received. At this point,
34449 the expansion variable &%$dkim_signers%& already contains a colon-
34450 separated list of signer domains and identities for the message. When
34451 &%dkim_verify_signers%& is not specified in the main configuration,
34452 it defaults as:
34453 .code
34454 dkim_verify_signers = $dkim_signers
34455 .endd
34456 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
34457 DKIM signature in the message. Current DKIM verifiers may want to explicitly
34458 call the ACL for known domains or identities. This would be achieved as follows:
34459 .code
34460 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
34461 .endd
34462 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
34463 and "ebay.com", plus all domains and identities that have signatures in the message.
34464 You can also be more creative in constructing your policy. Example:
34465 .code
34466 dkim_verify_signers = $sender_address_domain:$dkim_signers
34467 .endd
34468
34469 If a domain or identity is listed several times in the (expanded) value of
34470 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
34471
34472
34473 Inside the &%acl_smtp_dkim%&, the following expansion variables are
34474 available (from most to least important):
34475
34476 .vlist
34477 .vitem &%$dkim_cur_signer%&
34478 The signer that is being evaluated in this ACL run. This can be domain or
34479 an identity. This is one of the list items from the expanded main option
34480 &%dkim_verify_signers%& (see above).
34481 .vitem &%$dkim_verify_status%&
34482 A string describing the general status of the signature. One of
34483 .ilist
34484 &%none%&: There is no signature in the message for the current domain or
34485 identity (as reflected by &%$dkim_cur_signer%&).
34486 .next
34487 &%invalid%&: The signature could not be verified due to a processing error.
34488 More detail is available in &%$dkim_verify_reason%&.
34489 .next
34490 &%fail%&: Verification of the signature failed.  More detail is
34491 available in &%$dkim_verify_reason%&.
34492 .next
34493 &%pass%&: The signature passed verification. It is valid.
34494 .endlist
34495 .vitem &%$dkim_verify_reason%&
34496 A string giving a litte bit more detail when &%$dkim_verify_status%& is either
34497 "fail" or "invalid". One of
34498 .ilist
34499 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
34500 key for the domain could not be retrieved. This may be a temporary problem.
34501 .next
34502 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
34503 record for the domain is syntactically invalid.
34504 .next
34505 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
34506 body hash does not match the one specified in the signature header. This
34507 means that the message body was modified in transit.
34508 .next
34509 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
34510 could not be verified. This may mean that headers were modified,
34511 re-written or otherwise changed in a way which is incompatible with
34512 DKIM verification. It may of course also mean that the signature is forged.
34513 .endlist
34514 .vitem &%$dkim_domain%&
34515 The signing domain. IMPORTANT: This variable is only populated if there is
34516 an actual signature in the message for the current domain or identity (as
34517 reflected by &%$dkim_cur_signer%&).
34518 .vitem &%$dkim_identity%&
34519 The signing identity, if present. IMPORTANT: This variable is only populated
34520 if there is an actual signature in the message for the current domain or
34521 identity (as reflected by &%$dkim_cur_signer%&).
34522 .vitem &%$dkim_selector%&
34523 The key record selector string
34524 .vitem &%$dkim_algo%&
34525 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
34526 .vitem &%$dkim_canon_body%&
34527 The body canonicalization method. One of 'relaxed' or 'simple'.
34528 .vitem &%dkim_canon_headers%&
34529 The header canonicalization method. One of 'relaxed' or 'simple'.
34530 .vitem &%$dkim_copiedheaders%&
34531 A transcript of headers and their values which are included in the signature
34532 (copied from the 'z=' tag of the signature).
34533 .vitem &%$dkim_bodylength%&
34534 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
34535 limit was set by the signer, "9999999999999" is returned. This makes sure
34536 that this variable always expands to an integer value.
34537 .vitem &%$dkim_created%&
34538 UNIX timestamp reflecting the date and time when the signature was created.
34539 When this was not specified by the signer, "0" is returned.
34540 .vitem &%$dkim_expires%&
34541 UNIX timestamp reflecting the date and time when the signer wants the
34542 signature to be treated as "expired". When this was not specified by the
34543 signer, "9999999999999" is returned. This makes it possible to do useful
34544 integer size comparisons against this value.
34545 .vitem &%$dkim_headernames%&
34546 A colon-separated list of names of headers included in the signature.
34547 .vitem &%$dkim_key_testing%&
34548 "1" if the key record has the "testing" flag set, "0" if not.
34549 .vitem &%$dkim_key_nosubdomaining%&
34550 "1" if the key record forbids subdomaining, "0" otherwise.
34551 .vitem &%$dkim_key_srvtype%&
34552 Service type (tag s=) from the key record. Defaults to "*" if not specified
34553 in the key record.
34554 .vitem &%$dkim_key_granularity%&
34555 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
34556 in the key record.
34557 .vitem &%$dkim_key_notes%&
34558 Notes from the key record (tag n=)
34559 .endlist
34560
34561 In addition, two ACL conditions are provided:
34562
34563 .vlist
34564 .vitem &%dkim_signers%&
34565 ACL condition that checks a colon-separated list of domains or identities
34566 for a match against the domain or identity that the ACL is currently verifying
34567 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
34568 verb to a group of domains or identities, like:
34569
34570 .code
34571 # Warn when message apparently from GMail has no signature at all
34572 warn log_message = GMail sender without DKIM signature
34573      sender_domains = gmail.com
34574      dkim_signers = gmail.com
34575      dkim_status = none
34576 .endd
34577
34578 .vitem &%dkim_status%&
34579 ACL condition that checks a colon-separated list of possible DKIM verification
34580 results agains the actual result of verification. This is typically used
34581 to restrict an ACL verb to a list of verification outcomes, like:
34582
34583 .code
34584 deny message = Message from Paypal with invalid or missing signature
34585      sender_domains = paypal.com:paypal.de
34586      dkim_signers = paypal.com:paypal.de
34587      dkim_status = none:invalid:fail
34588 .endd
34589
34590 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
34591 see the documentation of the &%$dkim_verify_status%& expansion variable above
34592 for more information of what they mean.
34593 .endlist
34594
34595 . ////////////////////////////////////////////////////////////////////////////
34596 . ////////////////////////////////////////////////////////////////////////////
34597
34598 .chapter "Adding new drivers or lookup types" "CHID13" &&&
34599          "Adding drivers or lookups"
34600 .cindex "adding drivers"
34601 .cindex "new drivers, adding"
34602 .cindex "drivers" "adding new"
34603 The following actions have to be taken in order to add a new router, transport,
34604 authenticator, or lookup type to Exim:
34605
34606 .olist
34607 Choose a name for the driver or lookup type that does not conflict with any
34608 existing name; I will use &"newdriver"& in what follows.
34609 .next
34610 Add to &_src/EDITME_& the line:
34611 .display
34612 <&'type'&>&`_NEWDRIVER=yes`&
34613 .endd
34614 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
34615 code is not to be included in the binary by default, comment this line out. You
34616 should also add any relevant comments about the driver or lookup type.
34617 .next
34618 Add to &_src/config.h.defaults_& the line:
34619 .code
34620 #define <type>_NEWDRIVER
34621 .endd
34622 .next
34623 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
34624 and create a table entry as is done for all the other drivers and lookup types.
34625 .next
34626 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
34627 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
34628 driver or lookup type and add it to the definition of OBJ.
34629 .next
34630 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
34631 &_src_&.
34632 .next
34633 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
34634 as for other drivers and lookups.
34635 .endlist
34636
34637 Then all you need to do is write the code! A good way to start is to make a
34638 proforma by copying an existing module of the same type, globally changing all
34639 occurrences of the name, and cutting out most of the code. Note that any
34640 options you create must be listed in alphabetical order, because the tables are
34641 searched using a binary chop procedure.
34642
34643 There is a &_README_& file in each of the sub-directories of &_src_& describing
34644 the interface that is expected.
34645
34646
34647
34648
34649 . ////////////////////////////////////////////////////////////////////////////
34650 . ////////////////////////////////////////////////////////////////////////////
34651
34652 . /////////////////////////////////////////////////////////////////////////////
34653 . These lines are processing instructions for the Simple DocBook Processor that
34654 . Philip Hazel has developed as a less cumbersome way of making PostScript and
34655 . PDFs than using xmlto and fop. They will be ignored by all other XML
34656 . processors.
34657 . /////////////////////////////////////////////////////////////////////////////
34658
34659 .literal xml
34660 <?sdop
34661   format="newpage"
34662   foot_right_recto="&chaptertitle;"
34663   foot_right_verso="&chaptertitle;"
34664 ?>
34665 .literal off
34666
34667 .makeindex "Options index"   "option"
34668 .makeindex "Variables index" "variable"
34669 .makeindex "Concept index"   "concept"
34670
34671
34672 . /////////////////////////////////////////////////////////////////////////////
34673 . /////////////////////////////////////////////////////////////////////////////