1 . $Cambridge: exim/doc/doc-docbook/spec.xfpt,v 1.82 2010/06/06 02:08:50 pdp Exp $
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.
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 . /////////////////////////////////////////////////////////////////////////////
17 . /////////////////////////////////////////////////////////////////////////////
18 . This outputs the standard DocBook boilerplate.
19 . /////////////////////////////////////////////////////////////////////////////
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
28 . /////////////////////////////////////////////////////////////////////////////
32 foot_right_recto="&chaptertitle; (&chapternumber;)"
33 foot_right_verso="&chaptertitle; (&chapternumber;)"
34 toc_chapter_blanks="yes,yes"
35 table_warn_overflow="overprint"
39 . /////////////////////////////////////////////////////////////////////////////
40 . This generate the outermost <book> element that wraps then entire document.
41 . /////////////////////////////////////////////////////////////////////////////
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 . /////////////////////////////////////////////////////////////////////////////
50 .set previousversion "4.71"
53 .set ACL "access control lists (ACLs)"
54 .set I " "
57 . /////////////////////////////////////////////////////////////////////////////
58 . Additional xfpt markup used by this document, over and above the default
59 . provided in the xfpt library.
60 . /////////////////////////////////////////////////////////////////////////////
62 . --- Override the &$ flag to automatically insert a $ with the variable name
64 .flag &$ $& "<varname>$" "</varname>"
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.
69 .flag &!! "</emphasis>†<emphasis>"
70 .flag &!? "</emphasis>‡<emphasis>"
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
84 .itable all 0 0 4 8* left 6* center 6* center 6* right
85 .row "&%$1%&" "Use: &'$2'&" "Type: &'$3'&" "Default: &'$4'&"
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.
93 .macro table2 196pt 254pt
94 .itable none 0 0 2 $1 left $2 left
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.
103 .row "&I;$1" "$2" "$3" "$4"
107 .row "&I;$1" "$2" "$3"
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.
121 &<indexterm role="concept">&
122 &<primary>&$1&</primary>&
124 &<secondary>&$2&</secondary>&
130 &<indexterm role="concept" id="$1" class="startofrange">&
131 &<primary>&$2&</primary>&
133 &<secondary>&$3&</secondary>&
139 &<indexterm role="concept" startref="$1" class="endofrange"/>&
143 &<indexterm role="option">&
144 &<primary>&$1&</primary>&
146 &<secondary>&$2&</secondary>&
152 &<indexterm role="variable">&
153 &<primary>&$1&</primary>&
155 &<secondary>&$2&</secondary>&
161 .echo "** Don't use .index; use .cindex or .oindex or .vindex"
163 . ////////////////////////////////////////////////////////////////////////////
166 . ////////////////////////////////////////////////////////////////////////////
167 . The <bookinfo> element is removed from the XML before processing for Ascii
169 . ////////////////////////////////////////////////////////////////////////////
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>
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 . /////////////////////////////////////////////////////////////////////////////
194 .chapter "Introduction" "CHID1"
197 <indexterm role="variable">
198 <primary>$1, $2, etc.</primary>
199 <see><emphasis>numerical variables</emphasis></see>
201 <indexterm role="concept">
202 <primary>address</primary>
203 <secondary>rewriting</secondary>
204 <see><emphasis>rewriting</emphasis></see>
206 <indexterm role="concept">
207 <primary>Bounce Address Tag Validation</primary>
208 <see><emphasis>BATV</emphasis></see>
210 <indexterm role="concept">
211 <primary>Client SMTP Authorization</primary>
212 <see><emphasis>CSA</emphasis></see>
214 <indexterm role="concept">
215 <primary>CR character</primary>
216 <see><emphasis>carriage return</emphasis></see>
218 <indexterm role="concept">
219 <primary>CRL</primary>
220 <see><emphasis>certificate revocation list</emphasis></see>
222 <indexterm role="concept">
223 <primary>delivery</primary>
224 <secondary>failure report</secondary>
225 <see><emphasis>bounce message</emphasis></see>
227 <indexterm role="concept">
228 <primary>dialup</primary>
229 <see><emphasis>intermittently connected hosts</emphasis></see>
231 <indexterm role="concept">
232 <primary>exiscan</primary>
233 <see><emphasis>content scanning</emphasis></see>
235 <indexterm role="concept">
236 <primary>failover</primary>
237 <see><emphasis>fallback</emphasis></see>
239 <indexterm role="concept">
240 <primary>fallover</primary>
241 <see><emphasis>fallback</emphasis></see>
243 <indexterm role="concept">
244 <primary>filter</primary>
245 <secondary>Sieve</secondary>
246 <see><emphasis>Sieve filter</emphasis></see>
248 <indexterm role="concept">
249 <primary>ident</primary>
250 <see><emphasis>RFC 1413</emphasis></see>
252 <indexterm role="concept">
253 <primary>LF character</primary>
254 <see><emphasis>linefeed</emphasis></see>
256 <indexterm role="concept">
257 <primary>maximum</primary>
258 <seealso><emphasis>limit</emphasis></seealso>
260 <indexterm role="concept">
261 <primary>monitor</primary>
262 <see><emphasis>Exim monitor</emphasis></see>
264 <indexterm role="concept">
265 <primary>no_<emphasis>xxx</emphasis></primary>
266 <see>entry for xxx</see>
268 <indexterm role="concept">
269 <primary>NUL</primary>
270 <see><emphasis>binary zero</emphasis></see>
272 <indexterm role="concept">
273 <primary>passwd file</primary>
274 <see><emphasis>/etc/passwd</emphasis></see>
276 <indexterm role="concept">
277 <primary>process id</primary>
278 <see><emphasis>pid</emphasis></see>
280 <indexterm role="concept">
281 <primary>RBL</primary>
282 <see><emphasis>DNS list</emphasis></see>
284 <indexterm role="concept">
285 <primary>redirection</primary>
286 <see><emphasis>address redirection</emphasis></see>
288 <indexterm role="concept">
289 <primary>return path</primary>
290 <seealso><emphasis>envelope sender</emphasis></seealso>
292 <indexterm role="concept">
293 <primary>scanning</primary>
294 <see><emphasis>content scanning</emphasis></see>
296 <indexterm role="concept">
297 <primary>SSL</primary>
298 <see><emphasis>TLS</emphasis></see>
300 <indexterm role="concept">
301 <primary>string</primary>
302 <secondary>expansion</secondary>
303 <see><emphasis>expansion</emphasis></see>
305 <indexterm role="concept">
306 <primary>top bit</primary>
307 <see><emphasis>8-bit characters</emphasis></see>
309 <indexterm role="concept">
310 <primary>variables</primary>
311 <see><emphasis>expansion, variables</emphasis></see>
313 <indexterm role="concept">
314 <primary>zero, binary</primary>
315 <see><emphasis>binary zero</emphasis></see>
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 . /////////////////////////////////////////////////////////////////////////////
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.
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.
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.
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_&.
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.
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.
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
367 .section "Exim documentation" "SECID1"
368 . Keep this example change bar when updating the documentation!
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.
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
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/)).
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.)
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
404 .cindex "&_doc/NewStuff_&"
405 .cindex "&_doc/ChangeLog_&"
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.
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_&.
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_&.
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_&
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"
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.
442 .section "FTP and web sites" "SECID2"
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.
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.
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.
467 .section "Mailing lists" "SECID3"
468 .cindex "mailing lists" "for Exim users"
469 The following Exim mailing lists exist:
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"
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'&
485 &url(http://lists.alioth.debian.org/mailman/listinfo/pkg-exim4-users)
487 Please ask Debian-specific questions on this list and not on the general Exim
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/).
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.
507 .section "Where to find the Exim distribution" "SECTavail"
509 .cindex "distribution" "ftp site"
510 The master ftp site for the Exim distribution is
512 &*ftp://ftp.csx.cam.ac.uk/pub/software/email/exim*&
516 &*ftp://ftp.exim.org/pub/exim*&
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_&.
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
528 &_exim-n.nn.tar.bz2_&
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.
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
542 &_exim-n.nn.tar.gz.asc_&
543 &_exim-n.nn.tar.bz2.asc_&
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.
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:
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_&
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.
563 .section "Limitations" "SECID6"
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.
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
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.
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
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.
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.
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.
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.
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.
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.
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
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'&
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.
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.
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
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'&.
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'&.
691 .cindex "return path" "definition of"
692 &'Return path'& is another name that is used for the sender address in a
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.
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.
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.
719 . ////////////////////////////////////////////////////////////////////////////
720 . ////////////////////////////////////////////////////////////////////////////
722 .chapter "Incorporated code" "CHID2"
723 .cindex "incorporated code"
724 .cindex "regular expressions" "library"
726 A number of pieces of external code are included in the Exim distribution.
729 Regular expressions are supported in the main Exim program and in the
730 Exim monitor using the freely-distributable PCRE library, copyright
731 © 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).
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:
744 Copyright © 1998 Nigel Metheringham, Planet Online Ltd
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
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).
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
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.
774 Copyright © 2001 Carnegie Mellon University. All rights reserved.
776 Redistribution and use in source and binary forms, with or without
777 modification, are permitted provided that the following conditions
781 Redistributions of source code must retain the above copyright
782 notice, this list of conditions and the following disclaimer.
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
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
794 Office of Technology Transfer
795 Carnegie Mellon University
797 Pittsburgh, PA 15213-3890
798 (412) 268-4387, fax: (412) 268-7395
799 tech-transfer@andrew.cmu.edu
802 Redistributions of any form whatsoever must retain the following
805 &"This product includes software developed by Computing Services
806 at Carnegie Mellon University (&url(http://www.cmu.edu/computing/)."&
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.
819 .cindex "Exim monitor" "acknowledgment"
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.
828 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
829 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
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.
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
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.
860 . ////////////////////////////////////////////////////////////////////////////
861 . ////////////////////////////////////////////////////////////////////////////
863 .chapter "How Exim receives and delivers mail" "CHID11" &&&
864 "Receiving and delivering mail"
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.
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:
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
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.
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.
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.
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.
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.
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:
933 Sieve filters are written in the standard filtering language that is defined
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.
940 User filters are run as part of the routing process, described below.
944 .section "Message identification" "SECTmessiden"
945 .cindex "message ids" "details of format"
946 .cindex "format" "of message id"
947 .cindex "id of message"
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.
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
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).
975 After the first hyphen, the next six characters are the id of the process that
976 received the message.
978 There are two different possibilities for the final two characters:
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.
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
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.
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:
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.
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.
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.
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.
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.
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.
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.
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.
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.
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>>&.
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>>&).
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.
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
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.
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
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.
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.
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.
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.
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
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.
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.
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
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.
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.
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.
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.
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.
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
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
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.
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).
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'&.
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.
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.
1300 &'error'&: There is some error in the router (for example, a syntax error in
1301 its configuration). The action is as for defer.
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.
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.
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.
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>>&.
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.
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
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.
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.
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.
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).
1365 If the &%domains%& option is set, the domain of the address must be in the set
1366 of domains that it defines.
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.
1379 .vindex "&$local_user_uid$&"
1380 .vindex "&$local_user_gid$&"
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.
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.
1394 If the &%senders%& option is set, the envelope sender address must be in the
1395 set of addresses that it defines.
1397 If the &%require_files%& option is set, the existence or non-existence of
1398 specified files is tested.
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>>&.
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_&).
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:
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
1428 .cindex "Sieve filter" "not available for system filter"
1429 (&*Note*&: Sieve cannot be used for system filter files.)
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
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.
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.
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.
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.
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).
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.
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.
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
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.
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.
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
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
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
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
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.
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
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
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%&).
1599 . ////////////////////////////////////////////////////////////////////////////
1600 . ////////////////////////////////////////////////////////////////////////////
1602 .chapter "Building and installing Exim" "CHID3"
1603 .scindex IIDbuex "building Exim"
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:
1611 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1612 .irow &_CHANGES_& "contains a reference to where changes are &&&
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 &&&
1621 Other files whose names begin with &_README_& may also be present. The
1622 following subdirectories are created:
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"
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.
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
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.
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/).
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.
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.
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.
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
1696 A traditional &'ndbm'& implementation, such as that supplied as part of
1697 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
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.
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.
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.
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/).
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.
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:
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.
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.
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:
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
1759 INCLUDE=-I/usr/local/include/db-4.1
1760 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1762 There is further detailed discussion about the various DBM libraries in the
1763 file &_doc/dbm.discuss.txt_& in the Exim distribution.
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.
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.
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
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
1800 WITH_CONTENT_SCAN=yes
1802 in your &_Local/Makefile_&. For details of the facilities themselves, see
1803 chapter &<<CHAPexiscan>>&.
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.
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
1823 .section "Support for iconv()" "SECID26"
1824 .cindex "&[iconv()]& support"
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.
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
1842 to your &_Local/Makefile_& and rebuild Exim.
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
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
1862 If OpenSSL is installed, you should set
1865 TLS_LIBS=-lssl -lcrypto
1867 in &_Local/Makefile_&. You may also need to specify the locations of the
1868 OpenSSL library and include files. For example:
1871 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1872 TLS_INCLUDE=-I/usr/local/openssl/include/
1874 .cindex "USE_GNUTLS"
1875 If GnuTLS is installed, you should set
1879 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1881 in &_Local/Makefile_&, and again you may need to specify the locations of the
1882 library and include files. For example:
1886 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1887 TLS_INCLUDE=-I/usr/gnu/include
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>>&.
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_&,
1909 USE_TCP_WRAPPERS=yes
1910 CFLAGS=-O -I/usr/local/include
1911 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1913 in &_Local/Makefile_&. The name to use in the &'tcpwrappers'& control files is
1914 &"exim"&. For example, the line
1916 exim : LOCAL 192.168.1. .friendly.domain.example
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
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
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.
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.
1954 &*Warning*&: The &%-j%& (parallel) flag must not be used with &'make'&; the
1955 building process fails if it is set.
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.
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.
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:
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.
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
1997 &_OS/Makefile-Default_&
1998 &_OS/Makefile-_&<&'ostype'&>
2000 &_Local/Makefile-_&<&'ostype'&>
2001 &_Local/Makefile-_&<&'archtype'&>
2002 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2003 &_OS/Makefile-Base_&
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.
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.
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
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
2048 If you are compiling for just one operating system, it may be easier to put
2049 these lines directly into &_Local/Makefile_&.
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.
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:
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
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,
2087 must be defined in &_Local/Makefile_&. Details of this facility are given in
2088 chapter &<<CHAPperl>>&.
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_&:
2098 XINCLUDE=-I$(X11)/include
2099 XLFLAGS=-L$(X11)/lib
2101 These are overridden in some of the operating-system configuration files. For
2102 example, in &_OS/Makefile-SunOS5_& there is
2105 XINCLUDE=-I$(X11)/include
2106 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
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.
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.
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
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.
2132 .section "OS-specific header files" "SECID30"
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.
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
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'&>
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.
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).
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.
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.
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.
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
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
2214 make DESTDIR=/some/directory/ install
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.
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.
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).
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
2242 make INSTALL_ARG=-n install
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
2250 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2252 .cindex "installing Exim" "install script options"
2253 There are two other options that can be supplied to the installation script.
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.
2259 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2263 INSTALL_ARG can be used to pass these options to the script. For example:
2265 make INSTALL_ARG=-no_symlink install
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:
2271 make INSTALL_ARG='-no_symlink exim' install
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
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.
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
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:
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
2314 &`exim -bt`& <&'local username'&>
2316 should verify that it recognizes a local mailbox, and
2318 &`exim -bt`& <&'remote address'&>
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:
2324 exim -v postmaster@your.domain.example
2325 From: user@your.domain.example
2326 To: postmaster@your.domain.example
2327 Subject: Testing Exim
2329 This is a test message.
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"&.
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
2343 &`exim -d -M`& <&'exim-message-id'&>
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.)
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>>&.
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
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
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.
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
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
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.
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.
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
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
2437 /etc/init.d/sendmail stop
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
2445 pid=`cat /var/spool/exim/exim-daemon.pid`
2447 to obtain the daemon's pid directly from the file that Exim saves it in.
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.
2456 . ////////////////////////////////////////////////////////////////////////////
2457 . ////////////////////////////////////////////////////////////////////////////
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.
2470 .section "Setting options by program name" "SECID38"
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
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_&.
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
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.
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.
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.
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"&.
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.
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.
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.
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.
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.
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.
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%&).
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
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
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.
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 . ////////////////////////////////////////////////////////////////////////////
2589 <!-- === Start of command line options === -->
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.
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
2607 .vitem &%--version%&
2608 .oindex "&%--version%&"
2609 This option is an alias for &%-bV%& and causes version information to be
2612 .vitem &%-B%&<&'type'&>
2614 .cindex "8-bit characters"
2615 .cindex "Sendmail compatibility" "8-bit characters"
2616 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2617 clean; it ignores this option.
2622 .cindex "SMTP" "listener"
2623 .cindex "queue runner"
2624 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2625 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2626 that the daemon should also initiate periodic queue runs.
2628 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2629 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2630 disconnect from the controlling terminal. When running this way, it can be
2631 stopped by pressing ctrl-C.
2633 By default, Exim listens for incoming connections to the standard SMTP port on
2634 all the host's running interfaces. However, it is possible to listen on other
2635 ports, on multiple ports, and only on specific interfaces. Chapter
2636 &<<CHAPinterfaces>>& contains a description of the options that control this.
2638 When a listening daemon
2639 .cindex "daemon" "process id (pid)"
2640 .cindex "pid (process id)" "of daemon"
2641 is started without the use of &%-oX%& (that is, without overriding the normal
2642 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2643 in Exim's spool directory. This location can be overridden by setting
2644 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2647 When &%-oX%& is used on the command line to start a listening daemon, the
2648 process id is not written to the normal pid file path. However, &%-oP%& can be
2649 used to specify a path on the command line if a pid file is required.
2653 .cindex "daemon" "restarting"
2654 can be used to cause the daemon to re-execute itself. This should be done
2655 whenever Exim's configuration file, or any file that is incorporated into it by
2656 means of the &%.include%& facility, is changed, and also whenever a new version
2657 of Exim is installed. It is not necessary to do this when other files that are
2658 referenced from the configuration (for example, alias files) are changed,
2659 because these are reread each time they are used.
2663 This option has the same effect as &%-bd%& except that it never disconnects
2664 from the controlling terminal, even when no debugging is specified.
2668 .cindex "testing" "string expansion"
2669 .cindex "expansion" "testing"
2670 Run Exim in expansion testing mode. Exim discards its root privilege, to
2671 prevent ordinary users from using this mode to read otherwise inaccessible
2672 files. If no arguments are given, Exim runs interactively, prompting for lines
2673 of data. Otherwise, it processes each argument in turn.
2675 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2676 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2677 used without command line arguments. If successful, it uses the &[readline()]&
2678 function, which provides extensive line-editing facilities, for reading the
2679 test data. A line history is supported.
2681 Long expansion expressions can be split over several lines by using backslash
2682 continuations. As in Exim's run time configuration, white space at the start of
2683 continuation lines is ignored. Each argument or data line is passed through the
2684 string expansion mechanism, and the result is output. Variable values from the
2685 configuration file (for example, &$qualify_domain$&) are available, but no
2686 message-specific values (such as &$sender_domain$&) are set, because no message
2687 is being processed (but see &%-bem%& and &%-Mset%&).
2689 &*Note*&: If you use this mechanism to test lookups, and you change the data
2690 files or databases you are using, you must exit and restart Exim before trying
2691 the same lookup again. Otherwise, because each Exim process caches the results
2692 of lookups, you will just get the same result as before.
2694 .vitem &%-bem%&&~<&'filename'&>
2696 .cindex "testing" "string expansion"
2697 .cindex "expansion" "testing"
2698 This option operates like &%-be%& except that it must be followed by the name
2699 of a file. For example:
2701 exim -bem /tmp/testmessage
2703 The file is read as a message (as if receiving a locally-submitted non-SMTP
2704 message) before any of the test expansions are done. Thus, message-specific
2705 variables such as &$message_size$& and &$header_from:$& are available. However,
2706 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2707 recipients are read from the headers in the normal way, and are shown in the
2708 &$recipients$& variable. Note that recipients cannot be given on the command
2709 line, because further arguments are taken as strings to expand (just like
2712 .vitem &%-bF%&&~<&'filename'&>
2714 .cindex "system filter" "testing"
2715 .cindex "testing" "system filter"
2716 This option is the same as &%-bf%& except that it assumes that the filter being
2717 tested is a system filter. The additional commands that are available only in
2718 system filters are recognized.
2720 .vitem &%-bf%&&~<&'filename'&>
2722 .cindex "filter" "testing"
2723 .cindex "testing" "filter file"
2724 .cindex "forward file" "testing"
2725 .cindex "testing" "forward file"
2726 .cindex "Sieve filter" "testing"
2727 This option runs Exim in user filter testing mode; the file is the filter file
2728 to be tested, and a test message must be supplied on the standard input. If
2729 there are no message-dependent tests in the filter, an empty file can be
2732 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2733 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2734 filter and a user filter in the same run. For example:
2736 exim -bF /system/filter -bf /user/filter </test/message
2738 This is helpful when the system filter adds header lines or sets filter
2739 variables that are used by the user filter.
2741 If the test filter file does not begin with one of the special lines
2746 it is taken to be a normal &_.forward_& file, and is tested for validity under
2747 that interpretation. See sections &<<SECTitenonfilred>>& to
2748 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2751 The result of an Exim command that uses &%-bf%&, provided no errors are
2752 detected, is a list of the actions that Exim would try to take if presented
2753 with the message for real. More details of filter testing are given in the
2754 separate document entitled &'Exim's interfaces to mail filtering'&.
2756 When testing a filter file,
2757 .cindex "&""From""& line"
2758 .cindex "envelope sender"
2759 .oindex "&%-f%&" "for filter testing"
2760 the envelope sender can be set by the &%-f%& option,
2761 or by a &"From&~"& line at the start of the test message. Various parameters
2762 that would normally be taken from the envelope recipient address of the message
2763 can be set by means of additional command line options (see the next four
2766 .vitem &%-bfd%&&~<&'domain'&>
2768 .vindex "&$qualify_domain$&"
2769 This sets the domain of the recipient address when a filter file is being
2770 tested by means of the &%-bf%& option. The default is the value of
2773 .vitem &%-bfl%&&~<&'local&~part'&>
2775 This sets the local part of the recipient address when a filter file is being
2776 tested by means of the &%-bf%& option. The default is the username of the
2777 process that calls Exim. A local part should be specified with any prefix or
2778 suffix stripped, because that is how it appears to the filter when a message is
2779 actually being delivered.
2781 .vitem &%-bfp%&&~<&'prefix'&>
2783 This sets the prefix of the local part of the recipient address when a filter
2784 file is being tested by means of the &%-bf%& option. The default is an empty
2787 .vitem &%-bfs%&&~<&'suffix'&>
2789 This sets the suffix of the local part of the recipient address when a filter
2790 file is being tested by means of the &%-bf%& option. The default is an empty
2793 .vitem &%-bh%&&~<&'IP&~address'&>
2795 .cindex "testing" "incoming SMTP"
2796 .cindex "SMTP" "testing incoming"
2797 .cindex "testing" "relay control"
2798 .cindex "relaying" "testing configuration"
2799 .cindex "policy control" "testing"
2800 .cindex "debugging" "&%-bh%& option"
2801 This option runs a fake SMTP session as if from the given IP address, using the
2802 standard input and output. The IP address may include a port number at the end,
2803 after a full stop. For example:
2805 exim -bh 10.9.8.7.1234
2806 exim -bh fe80::a00:20ff:fe86:a061.5678
2808 When an IPv6 address is given, it is converted into canonical form. In the case
2809 of the second example above, the value of &$sender_host_address$& after
2810 conversion to the canonical form is
2811 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2813 Comments as to what is going on are written to the standard error file. These
2814 include lines beginning with &"LOG"& for anything that would have been logged.
2815 This facility is provided for testing configuration options for incoming
2816 messages, to make sure they implement the required policy. For example, you can
2817 test your relay controls using &%-bh%&.
2821 You can test features of the configuration that rely on ident (RFC 1413)
2822 information by using the &%-oMt%& option. However, Exim cannot actually perform
2823 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2826 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2827 are also skipped when testing using &%-bh%&. If you want these callouts to
2828 occur, use &%-bhc%& instead.
2830 Messages supplied during the testing session are discarded, and nothing is
2831 written to any of the real log files. There may be pauses when DNS (and other)
2832 lookups are taking place, and of course these may time out. The &%-oMi%& option
2833 can be used to specify a specific IP interface and port if this is important,
2834 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2835 session were authenticated.
2837 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2838 output just states whether a given recipient address from a given host is
2839 acceptable or not. See section &<<SECTcheckaccess>>&.
2841 Features such as authentication and encryption, where the client input is not
2842 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2843 specialized SMTP test program such as
2844 &url(http://jetmore.org/john/code/#swaks,swaks).
2846 .vitem &%-bhc%&&~<&'IP&~address'&>
2848 This option operates in the same way as &%-bh%&, except that address
2849 verification callouts are performed if required. This includes consulting and
2850 updating the callout cache database.
2854 .cindex "alias file" "building"
2855 .cindex "building alias file"
2856 .cindex "Sendmail compatibility" "&%-bi%& option"
2857 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2858 Exim does not have the concept of a single alias file, and so it cannot mimic
2859 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2860 tend to appear in various scripts such as NIS make files, so the option must be
2863 If &%-bi%& is encountered, the command specified by the &%bi_command%&
2864 configuration option is run, under the uid and gid of the caller of Exim. If
2865 the &%-oA%& option is used, its value is passed to the command as an argument.
2866 The command set by &%bi_command%& may not contain arguments. The command can
2867 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
2868 if this is required. If the &%bi_command%& option is not set, calling Exim with
2873 .cindex "local message reception"
2874 This option runs an Exim receiving process that accepts an incoming,
2875 locally-generated message on the current input. The recipients are given as the
2876 command arguments (except when &%-t%& is also present &-- see below). Each
2877 argument can be a comma-separated list of RFC 2822 addresses. This is the
2878 default option for selecting the overall action of an Exim call; it is assumed
2879 if no other conflicting option is present.
2881 If any addresses in the message are unqualified (have no domain), they are
2882 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
2883 options, as appropriate. The &%-bnq%& option (see below) provides a way of
2884 suppressing this for special cases.
2886 Policy checks on the contents of local messages can be enforced by means of
2887 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
2889 .cindex "return code" "for &%-bm%&"
2890 The return code is zero if the message is successfully accepted. Otherwise, the
2891 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
2894 .cindex "message" "format"
2895 .cindex "format" "message"
2896 .cindex "&""From""& line"
2897 .cindex "UUCP" "&""From""& line"
2898 .cindex "Sendmail compatibility" "&""From""& line"
2899 of the message must be as defined in RFC 2822, except that, for
2900 compatibility with Sendmail and Smail, a line in one of the forms
2902 From sender Fri Jan 5 12:55 GMT 1997
2903 From sender Fri, 5 Jan 97 12:55:01
2905 (with the weekday optional, and possibly with additional text after the date)
2906 is permitted to appear at the start of the message. There appears to be no
2907 authoritative specification of the format of this line. Exim recognizes it by
2908 matching against the regular expression defined by the &%uucp_from_pattern%&
2909 option, which can be changed if necessary.
2911 .oindex "&%-f%&" "overriding &""From""& line"
2912 The specified sender is treated as if it were given as the argument to the
2913 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
2914 preference to the address taken from the message. The caller of Exim must be a
2915 trusted user for the sender of a message to be set in this way.
2919 .cindex "address qualification, suppressing"
2920 By default, Exim automatically qualifies unqualified addresses (those
2921 without domains) that appear in messages that are submitted locally (that
2922 is, not over TCP/IP). This qualification applies both to addresses in
2923 envelopes, and addresses in header lines. Sender addresses are qualified using
2924 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
2925 defaults to the value of &%qualify_domain%&).
2927 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
2928 being used to re-submit messages that originally came from remote hosts after
2929 content scanning, you probably do not want to qualify unqualified addresses in
2930 header lines. (Such lines will be present only if you have not enabled a header
2931 syntax check in the appropriate ACL.)
2933 The &%-bnq%& option suppresses all qualification of unqualified addresses in
2934 messages that originate on the local host. When this is used, unqualified
2935 addresses in the envelope provoke errors (causing message rejection) and
2936 unqualified addresses in header lines are left alone.
2941 .cindex "configuration options" "extracting"
2942 .cindex "options" "configuration &-- extracting"
2943 If this option is given with no arguments, it causes the values of all Exim's
2944 main configuration options to be written to the standard output. The values
2945 of one or more specific options can be requested by giving their names as
2946 arguments, for example:
2948 exim -bP qualify_domain hold_domains
2950 .cindex "hiding configuration option values"
2951 .cindex "configuration options" "hiding value of"
2952 .cindex "options" "hiding value of"
2953 However, any option setting that is preceded by the word &"hide"& in the
2954 configuration file is not shown in full, except to an admin user. For other
2955 users, the output is as in this example:
2957 mysql_servers = <value not displayable>
2959 If &%configure_file%& is given as an argument, the name of the run time
2960 configuration file is output.
2961 If a list of configuration files was supplied, the value that is output here
2962 is the name of the file that was actually used.
2964 .cindex "daemon" "process id (pid)"
2965 .cindex "pid (process id)" "of daemon"
2966 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
2967 directories where log files and daemon pid files are written are output,
2968 respectively. If these values are unset, log files are written in a
2969 sub-directory of the spool directory called &%log%&, and the pid file is
2970 written directly into the spool directory.
2972 If &%-bP%& is followed by a name preceded by &`+`&, for example,
2974 exim -bP +local_domains
2976 it searches for a matching named list of any type (domain, host, address, or
2977 local part) and outputs what it finds.
2979 .cindex "options" "router &-- extracting"
2980 .cindex "options" "transport &-- extracting"
2981 .cindex "options" "authenticator &-- extracting"
2982 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
2983 followed by the name of an appropriate driver instance, the option settings for
2984 that driver are output. For example:
2986 exim -bP transport local_delivery
2988 The generic driver options are output first, followed by the driver's private
2989 options. A list of the names of drivers of a particular type can be obtained by
2990 using one of the words &%router_list%&, &%transport_list%&, or
2991 &%authenticator_list%&, and a complete list of all drivers with their option
2992 settings can be obtained by using &%routers%&, &%transports%&, or
2995 .cindex "options" "macro &-- extracting"
2996 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
2997 are available, similarly to the drivers. Because macros are sometimes used
2998 for storing passwords, this option is restricted.
2999 The output format is one item per line.
3003 .cindex "queue" "listing messages on"
3004 .cindex "listing" "messages on the queue"
3005 This option requests a listing of the contents of the mail queue on the
3006 standard output. If the &%-bp%& option is followed by a list of message ids,
3007 just those messages are listed. By default, this option can be used only by an
3008 admin user. However, the &%queue_list_requires_admin%& option can be set false
3009 to allow any user to see the queue.
3011 Each message on the queue is displayed as in the following example:
3013 25m 2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3014 red.king@looking-glass.fict.example
3017 .cindex "message" "size in queue listing"
3018 .cindex "size" "of message"
3019 The first line contains the length of time the message has been on the queue
3020 (in this case 25 minutes), the size of the message (2.9K), the unique local
3021 identifier for the message, and the message sender, as contained in the
3022 envelope. For bounce messages, the sender address is empty, and appears as
3023 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3024 the default sender address, the user's login name is shown in parentheses
3025 before the sender address.
3027 .cindex "frozen messages" "in queue listing"
3028 If the message is frozen (attempts to deliver it are suspended) then the text
3029 &"*** frozen ***"& is displayed at the end of this line.
3031 The recipients of the message (taken from the envelope, not the headers) are
3032 displayed on subsequent lines. Those addresses to which the message has already
3033 been delivered are marked with the letter D. If an original address gets
3034 expanded into several addresses via an alias or forward file, the original is
3035 displayed with a D only when deliveries for all of its child addresses are
3041 This option operates like &%-bp%&, but in addition it shows delivered addresses
3042 that were generated from the original top level address(es) in each message by
3043 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3049 .cindex "queue" "count of messages on"
3050 This option counts the number of messages on the queue, and writes the total
3051 to the standard output. It is restricted to admin users, unless
3052 &%queue_list_requires_admin%& is set false.
3057 This option operates like &%-bp%&, but the output is not sorted into
3058 chronological order of message arrival. This can speed it up when there are
3059 lots of messages on the queue, and is particularly useful if the output is
3060 going to be post-processed in a way that doesn't need the sorting.
3064 This option is a combination of &%-bpr%& and &%-bpa%&.
3068 This option is a combination of &%-bpr%& and &%-bpu%&.
3073 This option operates like &%-bp%& but shows only undelivered top-level
3074 addresses for each message displayed. Addresses generated by aliasing or
3075 forwarding are not shown, unless the message was deferred after processing by a
3076 router with the &%one_time%& option set.
3081 .cindex "testing" "retry configuration"
3082 .cindex "retry" "configuration testing"
3083 This option is for testing retry rules, and it must be followed by up to three
3084 arguments. It causes Exim to look for a retry rule that matches the values
3085 and to write it to the standard output. For example:
3087 exim -brt bach.comp.mus.example
3088 Retry rule: *.comp.mus.example F,2h,15m; F,4d,30m;
3090 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3091 argument, which is required, can be a complete address in the form
3092 &'local_part@domain'&, or it can be just a domain name. If the second argument
3093 contains a dot, it is interpreted as an optional second domain name; if no
3094 retry rule is found for the first argument, the second is tried. This ties in
3095 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3096 rule is found that matches the host, one that matches the mail domain is
3097 sought. Finally, an argument that is the name of a specific delivery error, as
3098 used in setting up retry rules, can be given. For example:
3100 exim -brt haydn.comp.mus.example quota_3d
3101 Retry rule: *@haydn.comp.mus.example quota_3d F,1h,15m
3106 .cindex "testing" "rewriting"
3107 .cindex "rewriting" "testing"
3108 This option is for testing address rewriting rules, and it must be followed by
3109 a single argument, consisting of either a local part without a domain, or a
3110 complete address with a fully qualified domain. Exim outputs how this address
3111 would be rewritten for each possible place it might appear. See chapter
3112 &<<CHAPrewrite>>& for further details.
3116 .cindex "SMTP" "batched incoming"
3117 .cindex "batched SMTP input"
3118 This option is used for batched SMTP input, which is an alternative interface
3119 for non-interactive local message submission. A number of messages can be
3120 submitted in a single run. However, despite its name, this is not really SMTP
3121 input. Exim reads each message's envelope from SMTP commands on the standard
3122 input, but generates no responses. If the caller is trusted, or
3123 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3124 believed; otherwise the sender is always the caller of Exim.
3126 The message itself is read from the standard input, in SMTP format (leading
3127 dots doubled), terminated by a line containing just a single dot. An error is
3128 provoked if the terminating dot is missing. A further message may then follow.
3130 As for other local message submissions, the contents of incoming batch SMTP
3131 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3132 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3133 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3135 Some other SMTP commands are recognized in the input. HELO and EHLO act
3136 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3137 QUIT quits, ignoring the rest of the standard input.
3139 .cindex "return code" "for &%-bS%&"
3140 If any error is encountered, reports are written to the standard output and
3141 error streams, and Exim gives up immediately. The return code is 0 if no error
3142 was detected; it is 1 if one or more messages were accepted before the error
3143 was detected; otherwise it is 2.
3145 More details of input using batched SMTP are given in section
3146 &<<SECTincomingbatchedSMTP>>&.
3150 .cindex "SMTP" "local input"
3151 .cindex "local SMTP input"
3152 This option causes Exim to accept one or more messages by reading SMTP commands
3153 on the standard input, and producing SMTP replies on the standard output. SMTP
3154 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3155 Some user agents use this interface as a way of passing locally-generated
3156 messages to the MTA.
3159 .cindex "sender" "source of"
3160 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3161 set, the senders of messages are taken from the SMTP MAIL commands.
3162 Otherwise the content of these commands is ignored and the sender is set up as
3163 the calling user. Unqualified addresses are automatically qualified using
3164 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3165 &%-bnq%& option is used.
3169 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3170 using a listening daemon. Exim can distinguish the two cases by checking
3171 whether the standard input is a TCP/IP socket. When Exim is called from
3172 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3173 above concerning senders and qualification do not apply. In this situation,
3174 Exim behaves in exactly the same way as it does when receiving a message via
3175 the listening daemon.
3177 .vitem &%-bmalware%&&~<&'filename'&>
3178 .oindex "&%-bmalware%&"
3179 .cindex "testing", "malware"
3180 .cindex "malware scan test"
3181 This debugging option causes Exim to scan the given file,
3182 using the malware scanning framework. The option of av_scanner influences
3183 this option, so if av_scanner's value is dependent upon an expansion then
3184 the expansion should have defaults which apply to this invocation. Exim will
3185 have changed working directory before resolving the filename, so using fully
3186 qualified pathnames is advisable. This option requires admin privileges.
3190 .cindex "testing" "addresses"
3191 .cindex "address" "testing"
3192 This option runs Exim in address testing mode, in which each argument is taken
3193 as a recipient address to be tested for deliverability. The results are
3194 written to the standard output. If a test fails, and the caller is not an admin
3195 user, no details of the failure are output, because these might contain
3196 sensitive information such as usernames and passwords for database lookups.
3198 If no arguments are given, Exim runs in an interactive manner, prompting with a
3199 right angle bracket for addresses to be tested.
3201 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3202 &[readline()]& function, because it is running as &'root'& and there are
3205 Each address is handled as if it were the recipient address of a message
3206 (compare the &%-bv%& option). It is passed to the routers and the result is
3207 written to the standard output. However, any router that has
3208 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3209 genuine routing tests if your first router passes everything to a scanner
3212 .cindex "return code" "for &%-bt%&"
3213 The return code is 2 if any address failed outright; it is 1 if no address
3214 failed outright but at least one could not be resolved for some reason. Return
3215 code 0 is given only when all addresses succeed.
3217 .cindex "duplicate addresses"
3218 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3219 addresses after routing is complete, so that only one delivery takes place.
3220 This does not happen when testing with &%-bt%&; the full results of routing are
3223 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3224 routers in the configuration makes any tests on the sender address of a
3226 .oindex "&%-f%&" "for address testing"
3227 you can use the &%-f%& option to set an appropriate sender when running
3228 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3229 default qualifying domain. However, if you have set up (for example) routers
3230 whose behaviour depends on the contents of an incoming message, you cannot test
3231 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3236 .cindex "version number of Exim"
3237 This option causes Exim to write the current version number, compilation
3238 number, and compilation date of the &'exim'& binary to the standard output.
3239 It also lists the DBM library this is being used, the optional modules (such as
3240 specific lookup types), the drivers that are included in the binary, and the
3241 name of the run time configuration file that is in use.
3243 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3244 configuration file. However, this is a static check only. It cannot check
3245 values that are to be expanded. For example, although a misspelt ACL verb is
3246 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3247 alone to discover (for example) all the typos in the configuration; some
3248 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3249 dynamic testing facilities.
3253 .cindex "verifying address" "using &%-bv%&"
3254 .cindex "address" "verification"
3255 This option runs Exim in address verification mode, in which each argument is
3256 taken as a recipient address to be verified by the routers. (This does
3257 not involve any verification callouts). During normal operation, verification
3258 happens mostly as a consequence processing a &%verify%& condition in an ACL
3259 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3260 including callouts, see the &%-bh%& and &%-bhc%& options.
3262 If verification fails, and the caller is not an admin user, no details of the
3263 failure are output, because these might contain sensitive information such as
3264 usernames and passwords for database lookups.
3266 If no arguments are given, Exim runs in an interactive manner, prompting with a
3267 right angle bracket for addresses to be verified.
3269 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3270 &[readline()]& function, because it is running as &'exim'& and there are
3273 Verification differs from address testing (the &%-bt%& option) in that routers
3274 that have &%no_verify%& set are skipped, and if the address is accepted by a
3275 router that has &%fail_verify%& set, verification fails. The address is
3276 verified as a recipient if &%-bv%& is used; to test verification for a sender
3277 address, &%-bvs%& should be used.
3279 If the &%-v%& option is not set, the output consists of a single line for each
3280 address, stating whether it was verified or not, and giving a reason in the
3281 latter case. Without &%-v%&, generating more than one address by redirection
3282 causes verification to end successfully, without considering the generated
3283 addresses. However, if just one address is generated, processing continues,
3284 and the generated address must verify successfully for the overall verification
3287 When &%-v%& is set, more details are given of how the address has been handled,
3288 and in the case of address redirection, all the generated addresses are also
3289 considered. Verification may succeed for some and fail for others.
3292 .cindex "return code" "for &%-bv%&"
3293 return code is 2 if any address failed outright; it is 1 if no address
3294 failed outright but at least one could not be resolved for some reason. Return
3295 code 0 is given only when all addresses succeed.
3297 If any of the routers in the configuration makes any tests on the sender
3298 address of a message, you should use the &%-f%& option to set an appropriate
3299 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3300 calling user at the default qualifying domain.
3304 This option acts like &%-bv%&, but verifies the address as a sender rather
3305 than a recipient address. This affects any rewriting and qualification that
3308 .vitem &%-C%&&~<&'filelist'&>
3310 .cindex "configuration file" "alternate"
3311 .cindex "CONFIGURE_FILE"
3312 .cindex "alternate configuration file"
3313 This option causes Exim to find the run time configuration file from the given
3314 list instead of from the list specified by the CONFIGURE_FILE
3315 compile-time setting. Usually, the list will consist of just a single file
3316 name, but it can be a colon-separated list of names. In this case, the first
3317 file that exists is used. Failure to open an existing file stops Exim from
3318 proceeding any further along the list, and an error is generated.
3320 When this option is used by a caller other than root or the Exim user, and the
3321 list is different from the compiled-in list, Exim gives up its root privilege
3322 immediately, and runs with the real and effective uid and gid set to those of
3323 the caller. However, if ALT_CONFIG_ROOT_ONLY is defined in
3324 &_Local/Makefile_&, root privilege is retained for &%-C%& only if the caller of
3327 That is, the Exim user is no longer privileged in this regard. This build-time
3328 option is not set by default in the Exim source distribution tarbundle.
3329 However, if you are using a &"packaged"& version of Exim (source or binary),
3330 the packagers might have enabled it.
3332 Setting ALT_CONFIG_ROOT_ONLY locks out the possibility of testing a
3333 configuration using &%-C%& right through message reception and delivery, even
3334 if the caller is root. The reception works, but by that time, Exim is running
3335 as the Exim user, so when it re-executes to regain privilege for the delivery,
3336 the use of &%-C%& causes privilege to be lost. However, root can test reception
3337 and delivery using two separate commands (one to put a message on the queue,
3338 using &%-odq%&, and another to do the delivery, using &%-M%&).
3340 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3341 prefix string with which any file named in a &%-C%& command line option
3342 must start. In addition, the file name must not contain the sequence &`/../`&.
3343 However, if the value of the &%-C%& option is identical to the value of
3344 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3345 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3346 unset, any file name can be used with &%-C%&.
3348 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3349 to a directory to which only root has access. This prevents someone who has
3350 broken into the Exim account from running a privileged Exim with an arbitrary
3353 The &%-C%& facility is useful for ensuring that configuration files are
3354 syntactically correct, but cannot be used for test deliveries, unless the
3355 caller is privileged, or unless it is an exotic configuration that does not
3356 require privilege. No check is made on the owner or group of the files
3357 specified by this option.
3359 .vitem &%-D%&<&'macro'&>=<&'value'&>
3361 .cindex "macro" "setting on command line"
3362 This option can be used to override macro definitions in the configuration file
3363 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3364 unprivileged caller, it causes Exim to give up its root privilege.
3365 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3366 completely disabled, and its use causes an immediate error exit.
3368 The entire option (including equals sign if present) must all be within one
3369 command line item. &%-D%& can be used to set the value of a macro to the empty
3370 string, in which case the equals sign is optional. These two commands are
3376 To include spaces in a macro definition item, quotes must be used. If you use
3377 quotes, spaces are permitted around the macro name and the equals sign. For
3380 exim '-D ABC = something' ...
3382 &%-D%& may be repeated up to 10 times on a command line.
3384 .vitem &%-d%&<&'debug&~options'&>
3386 .cindex "debugging" "list of selectors"
3387 .cindex "debugging" "&%-d%& option"
3388 This option causes debugging information to be written to the standard
3389 error stream. It is restricted to admin users because debugging output may show
3390 database queries that contain password information. Also, the details of users'
3391 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3392 writes an error message to the standard error stream and exits with a non-zero
3395 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3396 standard debugging data is output. This can be reduced, or increased to include
3397 some more rarely needed information, by directly following &%-d%& with a string
3398 made up of names preceded by plus or minus characters. These add or remove sets
3399 of debugging data, respectively. For example, &%-d+filter%& adds filter
3400 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3401 no spaces are allowed in the debug setting. The available debugging categories
3404 &`acl `& ACL interpretation
3405 &`auth `& authenticators
3406 &`deliver `& general delivery logic
3407 &`dns `& DNS lookups (see also resolver)
3408 &`dnsbl `& DNS black list (aka RBL) code
3409 &`exec `& arguments for &[execv()]& calls
3410 &`expand `& detailed debugging for string expansions
3411 &`filter `& filter handling
3412 &`hints_lookup `& hints data lookups
3413 &`host_lookup `& all types of name-to-IP address handling
3414 &`ident `& ident lookup
3415 &`interface `& lists of local interfaces
3416 &`lists `& matching things in lists
3417 &`load `& system load checks
3418 &`local_scan `& can be used by &[local_scan()]& (see chapter &&&
3419 &<<CHAPlocalscan>>&)
3420 &`lookup `& general lookup code and all lookups
3421 &`memory `& memory handling
3422 &`pid `& add pid to debug output lines
3423 &`process_info `& setting info for the process log
3424 &`queue_run `& queue runs
3425 &`receive `& general message reception logic
3426 &`resolver `& turn on the DNS resolver's debugging output
3427 &`retry `& retry handling
3428 &`rewrite `& address rewriting
3429 &`route `& address routing
3430 &`timestamp `& add timestamp to debug output lines
3432 &`transport `& transports
3433 &`uid `& changes of uid/gid and looking up uid/gid
3434 &`verify `& address verification logic
3435 &`all `& almost all of the above (see below), and also &%-v%&
3437 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3438 for &`-all`&. The reason for this is that &`+all`& is something that people
3439 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3440 is included, an awful lot of output that is very rarely of interest is
3441 generated, so it now has to be explicitly requested. However, &`-all`& does
3442 turn everything off.
3444 .cindex "resolver, debugging output"
3445 .cindex "DNS resolver, debugging output"
3446 The &`resolver`& option produces output only if the DNS resolver was compiled
3447 with DEBUG enabled. This is not the case in some operating systems. Also,
3448 unfortunately, debugging output from the DNS resolver is written to stdout
3451 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3452 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3453 However, the &`pid`& selector is forced when debugging is turned on for a
3454 daemon, which then passes it on to any re-executed Exims. Exim also
3455 automatically adds the pid to debug lines when several remote deliveries are
3458 The &`timestamp`& selector causes the current time to be inserted at the start
3459 of all debug output lines. This can be useful when trying to track down delays
3462 If the &%debug_print%& option is set in any driver, it produces output whenever
3463 any debugging is selected, or if &%-v%& is used.
3465 .vitem &%-dd%&<&'debug&~options'&>
3467 This option behaves exactly like &%-d%& except when used on a command that
3468 starts a daemon process. In that case, debugging is turned off for the
3469 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3470 behaviour of the daemon without creating as much output as full debugging does.
3473 .oindex "&%-dropcr%&"
3474 This is an obsolete option that is now a no-op. It used to affect the way Exim
3475 handled CR and LF characters in incoming messages. What happens now is
3476 described in section &<<SECTlineendings>>&.
3480 .cindex "bounce message" "generating"
3481 This option specifies that an incoming message is a locally-generated delivery
3482 failure report. It is used internally by Exim when handling delivery failures
3483 and is not intended for external use. Its only effect is to stop Exim
3484 generating certain messages to the postmaster, as otherwise message cascades
3485 could occur in some situations. As part of the same option, a message id may
3486 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3487 new message contains the id, following &"R="&, as a cross-reference.
3490 .oindex "&%-e%&&'x'&"
3491 There are a number of Sendmail options starting with &%-oe%& which seem to be
3492 called by various programs without the leading &%o%& in the option. For
3493 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3494 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3496 .vitem &%-F%&&~<&'string'&>
3498 .cindex "sender" "name"
3499 .cindex "name" "of sender"
3500 This option sets the sender's full name for use when a locally-generated
3501 message is being accepted. In the absence of this option, the user's &'gecos'&
3502 entry from the password data is used. As users are generally permitted to alter
3503 their &'gecos'& entries, no security considerations are involved. White space
3504 between &%-F%& and the <&'string'&> is optional.
3506 .vitem &%-f%&&~<&'address'&>
3508 .cindex "sender" "address"
3509 .cindex "address" "sender"
3510 .cindex "trusted users"
3511 .cindex "envelope sender"
3512 .cindex "user" "trusted"
3513 This option sets the address of the envelope sender of a locally-generated
3514 message (also known as the return path). The option can normally be used only
3515 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3518 Processes running as root or the Exim user are always trusted. Other
3519 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3520 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3521 of a local message is set to the caller's login name at the default qualify
3524 There is one exception to the restriction on the use of &%-f%&: an empty sender
3525 can be specified by any user, trusted or not, to create a message that can
3526 never provoke a bounce. An empty sender can be specified either as an empty
3527 string, or as a pair of angle brackets with nothing between them, as in these
3528 examples of shell commands:
3530 exim -f '<>' user@domain
3531 exim -f "" user@domain
3533 In addition, the use of &%-f%& is not restricted when testing a filter file
3534 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3537 Allowing untrusted users to change the sender address does not of itself make
3538 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3539 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3540 though this can be overridden by setting &%no_local_from_check%&.
3543 .cindex "&""From""& line"
3544 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3545 given as two arguments or one combined argument). The sender of a
3546 locally-generated message can also be set (when permitted) by an initial
3547 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3548 if &%-f%& is also present, it overrides &"From&~"&.
3552 .cindex "Sendmail compatibility" "&%-G%& option ignored"
3553 This is a Sendmail option which is ignored by Exim.
3555 .vitem &%-h%&&~<&'number'&>
3557 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3558 This option is accepted for compatibility with Sendmail, but has no effect. (In
3559 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3564 .cindex "Solaris" "&'mail'& command"
3565 .cindex "dot" "in incoming non-SMTP message"
3566 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3567 line by itself should not terminate an incoming, non-SMTP message. I can find
3568 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3569 command in Solaris 2.4 uses it. See also &%-ti%&.
3571 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3573 .cindex "forcing delivery"
3574 .cindex "delivery" "forcing attempt"
3575 .cindex "frozen messages" "forcing delivery"
3576 This option requests Exim to run a delivery attempt on each message in turn. If
3577 any of the messages are frozen, they are automatically thawed before the
3578 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3579 and &%hold_domains%& are ignored.
3582 .cindex "hints database" "overriding retry hints"
3583 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3584 the normal retry time has not yet been reached. This option requires the caller
3585 to be an admin user. However, there is an option called &%prod_requires_admin%&
3586 which can be set false to relax this restriction (and also the same requirement
3587 for the &%-q%&, &%-R%&, and &%-S%& options).
3589 The deliveries happen synchronously, that is, the original Exim process does
3590 not terminate until all the delivery attempts have finished. No output is
3591 produced unless there is a serious error. If you want to see what is happening,
3592 use the &%-v%& option as well, or inspect Exim's main log.
3594 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3596 .cindex "message" "adding recipients"
3597 .cindex "recipient" "adding"
3598 This option requests Exim to add the addresses to the list of recipients of the
3599 message (&"ar"& for &"add recipients"&). The first argument must be a message
3600 id, and the remaining ones must be email addresses. However, if the message is
3601 active (in the middle of a delivery attempt), it is not altered. This option
3602 can be used only by an admin user.
3604 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3605 &~<&'message&~id'&>"
3607 .cindex "SMTP" "passed connection"
3608 .cindex "SMTP" "multiple deliveries"
3609 .cindex "multiple SMTP deliveries"
3610 This option is not intended for use by external callers. It is used internally
3611 by Exim to invoke another instance of itself to deliver a waiting message using
3612 an existing SMTP connection, which is passed as the standard input. Details are
3613 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3614 must be root or the Exim user in order to use it.
3618 This option is not intended for use by external callers. It is used internally
3619 by Exim in conjunction with the &%-MC%& option. It signifies that the
3620 connection to the remote host has been authenticated.
3624 This option is not intended for use by external callers. It is used internally
3625 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3626 which Exim is connected supports pipelining.
3628 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3630 This option is not intended for use by external callers. It is used internally
3631 by Exim in conjunction with the &%-MC%& option when the original delivery was
3632 started by a queue runner. It passes on the process id of the queue runner,
3633 together with the file descriptor number of an open pipe. Closure of the pipe
3634 signals the final completion of the sequence of processes that are passing
3635 messages through the same SMTP connection.
3639 This option is not intended for use by external callers. It is used internally
3640 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3641 SMTP SIZE option should be used on messages delivered down the existing
3646 This option is not intended for use by external callers. It is used internally
3647 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3648 host to which Exim is connected supports TLS encryption.
3650 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3652 .cindex "hints database" "not overridden by &%-Mc%&"
3653 .cindex "delivery" "manually started &-- not forced"
3654 This option requests Exim to run a delivery attempt on each message in turn,
3655 but unlike the &%-M%& option, it does check for retry hints, and respects any
3656 that are found. This option is not very useful to external callers. It is
3657 provided mainly for internal use by Exim when it needs to re-invoke itself in
3658 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3659 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3660 respects retry times and other options such as &%hold_domains%& that are
3661 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3662 If you want to run a specific delivery as if in a queue run, you should use
3663 &%-q%& with a message id argument. A distinction between queue run deliveries
3664 and other deliveries is made in one or two places.
3666 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3668 .cindex "message" "changing sender"
3669 .cindex "sender" "changing"
3670 This option requests Exim to change the sender address in the message to the
3671 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3672 &"edit sender"&). There must be exactly two arguments. The first argument must
3673 be a message id, and the second one an email address. However, if the message
3674 is active (in the middle of a delivery attempt), its status is not altered.
3675 This option can be used only by an admin user.
3677 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3679 .cindex "freezing messages"
3680 .cindex "message" "manually freezing"
3681 This option requests Exim to mark each listed message as &"frozen"&. This
3682 prevents any delivery attempts taking place until the message is &"thawed"&,
3683 either manually or as a result of the &%auto_thaw%& configuration option.
3684 However, if any of the messages are active (in the middle of a delivery
3685 attempt), their status is not altered. This option can be used only by an admin
3688 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3690 .cindex "giving up on messages"
3691 .cindex "message" "abandoning delivery attempts"
3692 .cindex "delivery" "abandoning further attempts"
3693 This option requests Exim to give up trying to deliver the listed messages,
3694 including any that are frozen. However, if any of the messages are active,
3695 their status is not altered. For non-bounce messages, a delivery error message
3696 is sent to the sender, containing the text &"cancelled by administrator"&.
3697 Bounce messages are just discarded. This option can be used only by an admin
3700 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3702 .cindex "delivery" "cancelling all"
3703 This option requests Exim to mark all the recipient addresses in the messages
3704 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3705 message is active (in the middle of a delivery attempt), its status is not
3706 altered. This option can be used only by an admin user.
3708 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3710 .cindex "delivery" "cancelling by address"
3711 .cindex "recipient" "removing"
3712 .cindex "removing recipients"
3713 This option requests Exim to mark the given addresses as already delivered
3714 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3715 the remaining ones must be email addresses. These are matched to recipient
3716 addresses in the message in a case-sensitive manner. If the message is active
3717 (in the middle of a delivery attempt), its status is not altered. This option
3718 can be used only by an admin user.
3720 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3722 .cindex "removing messages"
3723 .cindex "abandoning mail"
3724 .cindex "message" "manually discarding"
3725 This option requests Exim to remove the given messages from the queue. No
3726 bounce messages are sent; each message is simply forgotten. However, if any of
3727 the messages are active, their status is not altered. This option can be used
3728 only by an admin user or by the user who originally caused the message to be
3729 placed on the queue.
3731 .vitem &%-Mset%&&~<&'message&~id'&>
3733 .cindex "testing" "string expansion"
3734 .cindex "expansion" "testing"
3735 This option is useful only in conjunction with &%-be%& (that is, when testing
3736 string expansions). Exim loads the given message from its spool before doing
3737 the test expansions, thus setting message-specific variables such as
3738 &$message_size$& and the header variables. The &$recipients$& variable is made
3739 available. This feature is provided to make it easier to test expansions that
3740 make use of these variables. However, this option can be used only by an admin
3741 user. See also &%-bem%&.
3743 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3745 .cindex "thawing messages"
3746 .cindex "unfreezing messages"
3747 .cindex "frozen messages" "thawing"
3748 .cindex "message" "thawing frozen"
3749 This option requests Exim to &"thaw"& any of the listed messages that are
3750 &"frozen"&, so that delivery attempts can resume. However, if any of the
3751 messages are active, their status is not altered. This option can be used only
3754 .vitem &%-Mvb%&&~<&'message&~id'&>
3756 .cindex "listing" "message body"
3757 .cindex "message" "listing body of"
3758 This option causes the contents of the message body (-D) spool file to be
3759 written to the standard output. This option can be used only by an admin user.
3761 .vitem &%-Mvc%&&~<&'message&~id'&>
3763 .cindex "message" "listing in RFC 2822 format"
3764 .cindex "listing" "message in RFC 2822 format"
3765 This option causes a copy of the complete message (header lines plus body) to
3766 be written to the standard output in RFC 2822 format. This option can be used
3767 only by an admin user.
3769 .vitem &%-Mvh%&&~<&'message&~id'&>
3771 .cindex "listing" "message headers"
3772 .cindex "header lines" "listing"
3773 .cindex "message" "listing header lines"
3774 This option causes the contents of the message headers (-H) spool file to be
3775 written to the standard output. This option can be used only by an admin user.
3777 .vitem &%-Mvl%&&~<&'message&~id'&>
3779 .cindex "listing" "message log"
3780 .cindex "message" "listing message log"
3781 This option causes the contents of the message log spool file to be written to
3782 the standard output. This option can be used only by an admin user.
3786 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
3787 treats it that way too.
3791 .cindex "debugging" "&%-N%& option"
3792 .cindex "debugging" "suppressing delivery"
3793 This is a debugging option that inhibits delivery of a message at the transport
3794 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
3795 it just doesn't actually transport the message, but instead behaves as if it
3796 had successfully done so. However, it does not make any updates to the retry
3797 database, and the log entries for deliveries are flagged with &"*>"& rather
3800 Because &%-N%& discards any message to which it applies, only root or the Exim
3801 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
3802 words, an ordinary user can use it only when supplying an incoming message to
3803 which it will apply. Although transportation never fails when &%-N%& is set, an
3804 address may be deferred because of a configuration problem on a transport, or a
3805 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
3806 the message, and applies to any subsequent delivery attempts that may happen
3811 .cindex "Sendmail compatibility" "&%-n%& option ignored"
3812 This option is interpreted by Sendmail to mean &"no aliasing"&. It is ignored
3815 .vitem &%-O%&&~<&'data'&>
3817 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
3820 .vitem &%-oA%&&~<&'file&~name'&>
3822 .cindex "Sendmail compatibility" "&%-oA%& option"
3823 This option is used by Sendmail in conjunction with &%-bi%& to specify an
3824 alternative alias file name. Exim handles &%-bi%& differently; see the
3827 .vitem &%-oB%&&~<&'n'&>
3829 .cindex "SMTP" "passed connection"
3830 .cindex "SMTP" "multiple deliveries"
3831 .cindex "multiple SMTP deliveries"
3832 This is a debugging option which limits the maximum number of messages that can
3833 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
3834 transport. If <&'n'&> is omitted, the limit is set to 1.
3838 .cindex "background delivery"
3839 .cindex "delivery" "in the background"
3840 This option applies to all modes in which Exim accepts incoming messages,
3841 including the listening daemon. It requests &"background"& delivery of such
3842 messages, which means that the accepting process automatically starts a
3843 delivery process for each message received, but does not wait for the delivery
3844 processes to finish.
3846 When all the messages have been received, the reception process exits,
3847 leaving the delivery processes to finish in their own time. The standard output
3848 and error streams are closed at the start of each delivery process.
3849 This is the default action if none of the &%-od%& options are present.
3851 If one of the queueing options in the configuration file
3852 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
3853 overrides it if &%queue_only_override%& is set true, which is the default
3854 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
3858 .cindex "foreground delivery"
3859 .cindex "delivery" "in the foreground"
3860 This option requests &"foreground"& (synchronous) delivery when Exim has
3861 accepted a locally-generated message. (For the daemon it is exactly the same as
3862 &%-odb%&.) A delivery process is automatically started to deliver the message,
3863 and Exim waits for it to complete before proceeding.
3865 The original Exim reception process does not finish until the delivery
3866 process for the final message has ended. The standard error stream is left open
3869 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
3870 false and one of the queueing options in the configuration file is in effect.
3872 If there is a temporary delivery error during foreground delivery, the
3873 message is left on the queue for later delivery, and the original reception
3874 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
3875 restricted configuration that never queues messages.
3880 This option is synonymous with &%-odf%&. It is provided for compatibility with
3885 .cindex "non-immediate delivery"
3886 .cindex "delivery" "suppressing immediate"
3887 .cindex "queueing incoming messages"
3888 This option applies to all modes in which Exim accepts incoming messages,
3889 including the listening daemon. It specifies that the accepting process should
3890 not automatically start a delivery process for each message received. Messages
3891 are placed on the queue, and remain there until a subsequent queue runner
3892 process encounters them. There are several configuration options (such as
3893 &%queue_only%&) that can be used to queue incoming messages under certain
3894 conditions. This option overrides all of them and also &%-odqs%&. It always
3899 .cindex "SMTP" "delaying delivery"
3900 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
3901 However, like &%-odb%& and &%-odi%&, this option has no effect if
3902 &%queue_only_override%& is false and one of the queueing options in the
3903 configuration file is in effect.
3905 When &%-odqs%& does operate, a delivery process is started for each incoming
3906 message, in the background by default, but in the foreground if &%-odi%& is
3907 also present. The recipient addresses are routed, and local deliveries are done
3908 in the normal way. However, if any SMTP deliveries are required, they are not
3909 done at this time, so the message remains on the queue until a subsequent queue
3910 runner process encounters it. Because routing was done, Exim knows which
3911 messages are waiting for which hosts, and so a number of messages for the same
3912 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
3913 configuration option has the same effect for specific domains. See also the
3918 .cindex "error" "reporting"
3919 If an error is detected while a non-SMTP message is being received (for
3920 example, a malformed address), the error is reported to the sender in a mail
3923 .cindex "return code" "for &%-oee%&"
3925 this error message is successfully sent, the Exim receiving process
3926 exits with a return code of zero. If not, the return code is 2 if the problem
3927 is that the original message has no recipients, or 1 any other error. This is
3928 the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
3932 .cindex "error" "reporting"
3933 .cindex "return code" "for &%-oem%&"
3934 This is the same as &%-oee%&, except that Exim always exits with a non-zero
3935 return code, whether or not the error message was successfully sent.
3936 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
3940 .cindex "error" "reporting"
3941 If an error is detected while a non-SMTP message is being received, the
3942 error is reported by writing a message to the standard error file (stderr).
3943 .cindex "return code" "for &%-oep%&"
3944 The return code is 1 for all errors.
3948 .cindex "error" "reporting"
3949 This option is supported for compatibility with Sendmail, but has the same
3954 .cindex "error" "reporting"
3955 This option is supported for compatibility with Sendmail, but has the same
3960 .cindex "dot" "in incoming non-SMTP message"
3961 This option, which has the same effect as &%-i%&, specifies that a dot on a
3962 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
3963 single dot does terminate, though Exim does no special processing for other
3964 lines that start with a dot. This option is set by default if Exim is called as
3965 &'rmail'&. See also &%-ti%&.
3968 .oindex "&%-oitrue%&"
3969 This option is treated as synonymous with &%-oi%&.
3971 .vitem &%-oMa%&&~<&'host&~address'&>
3973 .cindex "sender" "host address, specifying for local message"
3974 A number of options starting with &%-oM%& can be used to set values associated
3975 with remote hosts on locally-submitted messages (that is, messages not received
3976 over TCP/IP). These options can be used by any caller in conjunction with the
3977 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
3978 other circumstances, they are ignored unless the caller is trusted.
3980 The &%-oMa%& option sets the sender host address. This may include a port
3981 number at the end, after a full stop (period). For example:
3983 exim -bs -oMa 10.9.8.7.1234
3985 An alternative syntax is to enclose the IP address in square brackets,
3986 followed by a colon and the port number:
3988 exim -bs -oMa [10.9.8.7]:1234
3990 The IP address is placed in the &$sender_host_address$& variable, and the
3991 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
3992 are present on the command line, the sender host IP address is taken from
3993 whichever one is last.
3995 .vitem &%-oMaa%&&~<&'name'&>
3997 .cindex "authentication" "name, specifying for local message"
3998 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
3999 option sets the value of &$sender_host_authenticated$& (the authenticator
4000 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4001 This option can be used with &%-bh%& and &%-bs%& to set up an
4002 authenticated SMTP session without actually using the SMTP AUTH command.
4004 .vitem &%-oMai%&&~<&'string'&>
4006 .cindex "authentication" "id, specifying for local message"
4007 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4008 option sets the value of &$authenticated_id$& (the id that was authenticated).
4009 This overrides the default value (the caller's login id, except with &%-bh%&,
4010 where there is no default) for messages from local sources. See chapter
4011 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4013 .vitem &%-oMas%&&~<&'address'&>
4015 .cindex "authentication" "sender, specifying for local message"
4016 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4017 option sets the authenticated sender value in &$authenticated_sender$&. It
4018 overrides the sender address that is created from the caller's login id for
4019 messages from local sources, except when &%-bh%& is used, when there is no
4020 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4021 specified on a MAIL command overrides this value. See chapter
4022 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4024 .vitem &%-oMi%&&~<&'interface&~address'&>
4026 .cindex "interface" "address, specifying for local message"
4027 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4028 option sets the IP interface address value. A port number may be included,
4029 using the same syntax as for &%-oMa%&. The interface address is placed in
4030 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4032 .vitem &%-oMr%&&~<&'protocol&~name'&>
4034 .cindex "protocol, specifying for local message"
4035 .vindex "&$received_protocol$&"
4036 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4037 option sets the received protocol value that is stored in
4038 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4039 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4040 SMTP protocol names (see the description of &$received_protocol$& in section
4041 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4042 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4045 .vitem &%-oMs%&&~<&'host&~name'&>
4047 .cindex "sender" "host name, specifying for local message"
4048 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4049 option sets the sender host name in &$sender_host_name$&. When this option is
4050 present, Exim does not attempt to look up a host name from an IP address; it
4051 uses the name it is given.
4053 .vitem &%-oMt%&&~<&'ident&~string'&>
4055 .cindex "sender" "ident string, specifying for local message"
4056 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4057 option sets the sender ident value in &$sender_ident$&. The default setting for
4058 local callers is the login id of the calling process, except when &%-bh%& is
4059 used, when there is no default.
4063 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4064 In Sendmail, this option means &"me too"&, indicating that the sender of a
4065 message should receive a copy of the message if the sender appears in an alias
4066 expansion. Exim always does this, so the option does nothing.
4070 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4071 This option is ignored. In Sendmail it specifies &"old style headers"&,
4072 whatever that means.
4074 .vitem &%-oP%&&~<&'path'&>
4076 .cindex "pid (process id)" "of daemon"
4077 .cindex "daemon" "process id (pid)"
4078 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4079 value. The option specifies the file to which the process id of the daemon is
4080 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4081 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4082 because in those cases, the normal pid file is not used.
4084 .vitem &%-or%&&~<&'time'&>
4086 .cindex "timeout" "for non-SMTP input"
4087 This option sets a timeout value for incoming non-SMTP messages. If it is not
4088 set, Exim will wait forever for the standard input. The value can also be set
4089 by the &%receive_timeout%& option. The format used for specifying times is
4090 described in section &<<SECTtimeformat>>&.
4092 .vitem &%-os%&&~<&'time'&>
4094 .cindex "timeout" "for SMTP input"
4095 .cindex "SMTP" "input timeout"
4096 This option sets a timeout value for incoming SMTP messages. The timeout
4097 applies to each SMTP command and block of data. The value can also be set by
4098 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4099 for specifying times is described in section &<<SECTtimeformat>>&.
4103 This option has exactly the same effect as &%-v%&.
4105 .vitem &%-oX%&&~<&'number&~or&~string'&>
4107 .cindex "TCP/IP" "setting listening ports"
4108 .cindex "TCP/IP" "setting listening interfaces"
4109 .cindex "port" "receiving TCP/IP"
4110 This option is relevant only when the &%-bd%& (start listening daemon) option
4111 is also given. It controls which ports and interfaces the daemon uses. Details
4112 of the syntax, and how it interacts with configuration file options, are given
4113 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4114 file is written unless &%-oP%& is also present to specify a pid file name.
4118 .cindex "Perl" "starting the interpreter"
4119 This option applies when an embedded Perl interpreter is linked with Exim (see
4120 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4121 option, forcing the starting of the interpreter to be delayed until it is
4126 .cindex "Perl" "starting the interpreter"
4127 This option applies when an embedded Perl interpreter is linked with Exim (see
4128 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4129 option, forcing the starting of the interpreter to occur as soon as Exim is
4132 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4134 For compatibility with Sendmail, this option is equivalent to
4136 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4138 It sets the incoming protocol and host name (for trusted callers). The
4139 host name and its colon can be omitted when only the protocol is to be set.
4140 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4141 to embedded Perl. It is therefore impossible to set a protocol value of &`p`&
4142 or &`s`& using this option (but that does not seem a real limitation).
4146 .cindex "queue runner" "starting manually"
4147 This option is normally restricted to admin users. However, there is a
4148 configuration option called &%prod_requires_admin%& which can be set false to
4149 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4150 and &%-S%& options).
4152 .cindex "queue runner" "description of operation"
4153 The &%-q%& option starts one queue runner process. This scans the queue of
4154 waiting messages, and runs a delivery process for each one in turn. It waits
4155 for each delivery process to finish before starting the next one. A delivery
4156 process may not actually do any deliveries if the retry times for the addresses
4157 have not been reached. Use &%-qf%& (see below) if you want to override this.
4160 .cindex "SMTP" "passed connection"
4161 .cindex "SMTP" "multiple deliveries"
4162 .cindex "multiple SMTP deliveries"
4163 the delivery process spawns other processes to deliver other messages down
4164 passed SMTP connections, the queue runner waits for these to finish before
4167 When all the queued messages have been considered, the original queue runner
4168 process terminates. In other words, a single pass is made over the waiting
4169 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4170 this to be repeated periodically.
4172 Exim processes the waiting messages in an unpredictable order. It isn't very
4173 random, but it is likely to be different each time, which is all that matters.
4174 If one particular message screws up a remote MTA, other messages to the same
4175 MTA have a chance of getting through if they get tried first.
4177 It is possible to cause the messages to be processed in lexical message id
4178 order, which is essentially the order in which they arrived, by setting the
4179 &%queue_run_in_order%& option, but this is not recommended for normal use.
4181 .vitem &%-q%&<&'qflags'&>
4182 The &%-q%& option may be followed by one or more flag letters that change its
4183 behaviour. They are all optional, but if more than one is present, they must
4184 appear in the correct order. Each flag is described in a separate item below.
4188 .cindex "queue" "double scanning"
4189 .cindex "queue" "routing"
4190 .cindex "routing" "whole queue before delivery"
4191 An option starting with &%-qq%& requests a two-stage queue run. In the first
4192 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4193 every domain. Addresses are routed, local deliveries happen, but no remote
4196 .cindex "hints database" "remembering routing"
4197 The hints database that remembers which messages are waiting for specific hosts
4198 is updated, as if delivery to those hosts had been deferred. After this is
4199 complete, a second, normal queue scan happens, with routing and delivery taking
4200 place as normal. Messages that are routed to the same host should mostly be
4201 delivered down a single SMTP
4202 .cindex "SMTP" "passed connection"
4203 .cindex "SMTP" "multiple deliveries"
4204 .cindex "multiple SMTP deliveries"
4205 connection because of the hints that were set up during the first queue scan.
4206 This option may be useful for hosts that are connected to the Internet
4209 .vitem &%-q[q]i...%&
4211 .cindex "queue" "initial delivery"
4212 If the &'i'& flag is present, the queue runner runs delivery processes only for
4213 those messages that haven't previously been tried. (&'i'& stands for &"initial
4214 delivery"&.) This can be helpful if you are putting messages on the queue using
4215 &%-odq%& and want a queue runner just to process the new messages.
4217 .vitem &%-q[q][i]f...%&
4219 .cindex "queue" "forcing delivery"
4220 .cindex "delivery" "forcing in queue run"
4221 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4222 message, whereas without &'f'& only those non-frozen addresses that have passed
4223 their retry times are tried.
4225 .vitem &%-q[q][i]ff...%&
4227 .cindex "frozen messages" "forcing delivery"
4228 If &'ff'& is present, a delivery attempt is forced for every message, whether
4231 .vitem &%-q[q][i][f[f]]l%&
4233 .cindex "queue" "local deliveries only"
4234 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4235 be done. If a message requires any remote deliveries, it remains on the queue
4238 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4239 .cindex "queue" "delivering specific messages"
4240 When scanning the queue, Exim can be made to skip over messages whose ids are
4241 lexically less than a given value by following the &%-q%& option with a
4242 starting message id. For example:
4244 exim -q 0t5C6f-0000c8-00
4246 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4247 second message id is given, messages whose ids are lexically greater than it
4248 are also skipped. If the same id is given twice, for example,
4250 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4252 just one delivery process is started, for that message. This differs from
4253 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4254 that it counts as a delivery from a queue run. Note that the selection
4255 mechanism does not affect the order in which the messages are scanned. There
4256 are also other ways of selecting specific sets of messages for delivery in a
4257 queue run &-- see &%-R%& and &%-S%&.
4259 .vitem &%-q%&<&'qflags'&><&'time'&>
4260 .cindex "queue runner" "starting periodically"
4261 .cindex "periodic queue running"
4262 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4263 starting a queue runner process at intervals specified by the given time value
4264 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4265 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4266 single daemon process handles both functions. A common way of starting up a
4267 combined daemon at system boot time is to use a command such as
4269 /usr/exim/bin/exim -bd -q30m
4271 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4272 process every 30 minutes.
4274 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4275 pid file is written unless one is explicitly requested by the &%-oP%& option.
4277 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4279 This option is synonymous with &%-R%&. It is provided for Sendmail
4282 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4284 This option is synonymous with &%-S%&.
4286 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4288 .cindex "queue runner" "for specific recipients"
4289 .cindex "delivery" "to given domain"
4290 .cindex "domain" "delivery to"
4291 The <&'rsflags'&> may be empty, in which case the white space before the string
4292 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4293 which are the possible values for <&'rsflags'&>. White space is required if
4294 <&'rsflags'&> is not empty.
4296 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4297 perform a single queue run, except that, when scanning the messages on the
4298 queue, Exim processes only those that have at least one undelivered recipient
4299 address containing the given string, which is checked in a case-independent
4300 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4301 regular expression; otherwise it is a literal string.
4303 If you want to do periodic queue runs for messages with specific recipients,
4304 you can combine &%-R%& with &%-q%& and a time value. For example:
4306 exim -q25m -R @special.domain.example
4308 This example does a queue run for messages with recipients in the given domain
4309 every 25 minutes. Any additional flags that are specified with &%-q%& are
4310 applied to each queue run.
4312 Once a message is selected for delivery by this mechanism, all its addresses
4313 are processed. For the first selected message, Exim overrides any retry
4314 information and forces a delivery attempt for each undelivered address. This
4315 means that if delivery of any address in the first message is successful, any
4316 existing retry information is deleted, and so delivery attempts for that
4317 address in subsequently selected messages (which are processed without forcing)
4318 will run. However, if delivery of any address does not succeed, the retry
4319 information is updated, and in subsequently selected messages, the failing
4320 address will be skipped.
4322 .cindex "frozen messages" "forcing delivery"
4323 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4324 all selected messages, not just the first; frozen messages are included when
4327 The &%-R%& option makes it straightforward to initiate delivery of all messages
4328 to a given domain after a host has been down for some time. When the SMTP
4329 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4330 effect is to run Exim with the &%-R%& option, but it can be configured to run
4331 an arbitrary command instead.
4335 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4337 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4339 .cindex "delivery" "from given sender"
4340 .cindex "queue runner" "for specific senders"
4341 This option acts like &%-R%& except that it checks the string against each
4342 message's sender instead of against the recipients. If &%-R%& is also set, both
4343 conditions must be met for a message to be selected. If either of the options
4344 has &'f'& or &'ff'& in its flags, the associated action is taken.
4346 .vitem &%-Tqt%&&~<&'times'&>
4348 This an option that is exclusively for use by the Exim testing suite. It is not
4349 recognized when Exim is run normally. It allows for the setting up of explicit
4350 &"queue times"& so that various warning/retry features can be tested.
4354 .cindex "recipient" "extracting from header lines"
4355 .cindex "&'Bcc:'& header line"
4356 .cindex "&'Cc:'& header line"
4357 .cindex "&'To:'& header line"
4358 When Exim is receiving a locally-generated, non-SMTP message on its standard
4359 input, the &%-t%& option causes the recipients of the message to be obtained
4360 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4361 from the command arguments. The addresses are extracted before any rewriting
4362 takes place and the &'Bcc:'& header line, if present, is then removed.
4364 .cindex "Sendmail compatibility" "&%-t%& option"
4365 If the command has any arguments, they specify addresses to which the message
4366 is &'not'& to be delivered. That is, the argument addresses are removed from
4367 the recipients list obtained from the headers. This is compatible with Smail 3
4368 and in accordance with the documented behaviour of several versions of
4369 Sendmail, as described in man pages on a number of operating systems (e.g.
4370 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4371 argument addresses to those obtained from the headers, and the O'Reilly
4372 Sendmail book documents it that way. Exim can be made to add argument addresses
4373 instead of subtracting them by setting the option
4374 &%extract_addresses_remove_arguments%& false.
4376 .cindex "&%Resent-%& header lines" "with &%-t%&"
4377 If there are any &%Resent-%& header lines in the message, Exim extracts
4378 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4379 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4380 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4381 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4383 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4384 message is resent several times). The RFC also specifies that they should be
4385 added at the front of the message, and separated by &'Received:'& lines. It is
4386 not at all clear how &%-t%& should operate in the present of multiple sets,
4387 nor indeed exactly what constitutes a &"set"&.
4388 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4389 are often added at the end of the header, and if a message is resent more than
4390 once, it is common for the original set of &%Resent-%& headers to be renamed as
4391 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4395 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4396 compatibility with Sendmail.
4398 .vitem &%-tls-on-connect%&
4399 .oindex "&%-tls-on-connect%&"
4400 .cindex "TLS" "use without STARTTLS"
4401 .cindex "TLS" "automatic start"
4402 This option is available when Exim is compiled with TLS support. It forces all
4403 incoming SMTP connections to behave as if the incoming port is listed in the
4404 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4405 &<<CHAPTLS>>& for further details.
4410 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4411 Sendmail uses this option for &"initial message submission"&, and its
4412 documentation states that in future releases, it may complain about
4413 syntactically invalid messages rather than fixing them when this flag is not
4414 set. Exim ignores this option.
4418 This option causes Exim to write information to the standard error stream,
4419 describing what it is doing. In particular, it shows the log lines for
4420 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4421 dialogue is shown. Some of the log lines shown may not actually be written to
4422 the log if the setting of &%log_selector%& discards them. Any relevant
4423 selectors are shown with each log line. If none are shown, the logging is
4428 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4429 National Language Support extended characters in the body of the mail item"&).
4430 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4438 . ////////////////////////////////////////////////////////////////////////////
4439 . Insert a stylized DocBook comment here, to identify the end of the command
4440 . line options. This is for the benefit of the Perl script that automatically
4441 . creates a man page for the options.
4442 . ////////////////////////////////////////////////////////////////////////////
4445 <!-- === End of command line options === -->
4452 . ////////////////////////////////////////////////////////////////////////////
4453 . ////////////////////////////////////////////////////////////////////////////
4456 .chapter "The Exim run time configuration file" "CHAPconf" &&&
4457 "The runtime configuration file"
4459 .cindex "run time configuration"
4460 .cindex "configuration file" "general description"
4461 .cindex "CONFIGURE_FILE"
4462 .cindex "configuration file" "errors in"
4463 .cindex "error" "in configuration file"
4464 .cindex "return code" "for bad configuration"
4465 Exim uses a single run time configuration file that is read whenever an Exim
4466 binary is executed. Note that in normal operation, this happens frequently,
4467 because Exim is designed to operate in a distributed manner, without central
4470 If a syntax error is detected while reading the configuration file, Exim
4471 writes a message on the standard error, and exits with a non-zero return code.
4472 The message is also written to the panic log. &*Note*&: Only simple syntax
4473 errors can be detected at this time. The values of any expanded options are
4474 not checked until the expansion happens, even when the expansion does not
4475 actually alter the string.
4477 The name of the configuration file is compiled into the binary for security
4478 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4479 most configurations, this specifies a single file. However, it is permitted to
4480 give a colon-separated list of file names, in which case Exim uses the first
4481 existing file in the list.
4484 .cindex "EXIM_GROUP"
4485 .cindex "CONFIGURE_OWNER"
4486 .cindex "CONFIGURE_GROUP"
4487 .cindex "configuration file" "ownership"
4488 .cindex "ownership" "configuration file"
4489 The run time configuration file must be owned by root or by the user that is
4490 specified at compile time by the EXIM_USER option, or by the user that is
4491 specified at compile time by the CONFIGURE_OWNER option (if set). The
4492 configuration file must not be world-writeable or group-writeable, unless its
4493 group is the one specified at compile time by the EXIM_GROUP option or by the
4494 CONFIGURE_GROUP option.
4496 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4497 to root, anybody who is able to edit the run time configuration file has an
4498 easy way to run commands as root. If you make your mail administrators members
4499 of the Exim group, but do not trust them with root, make sure that the run time
4500 configuration is not group writeable.
4502 A default configuration file, which will work correctly in simple situations,
4503 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4504 defines just one file name, the installation process copies the default
4505 configuration to a new file of that name if it did not previously exist. If
4506 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4507 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4512 .section "Using a different configuration file" "SECID40"
4513 .cindex "configuration file" "alternate"
4514 A one-off alternate configuration can be specified by the &%-C%& command line
4515 option, which may specify a single file or a list of files. However, when
4516 &%-C%& is used, Exim gives up its root privilege, unless called by root or the
4517 Exim user (or unless the argument for &%-C%& is identical to the built-in value
4518 from CONFIGURE_FILE). &%-C%& is useful mainly for checking the syntax of
4519 configuration files before installing them. No owner or group checks are done
4520 on a configuration file specified by &%-C%&.
4522 The privileged use of &%-C%& by the Exim user can be locked out by setting
4523 ALT_CONFIG_ROOT_ONLY in &_Local/Makefile_& when building Exim. However,
4524 if you do this, you also lock out the possibility of testing a
4525 configuration using &%-C%& right through message reception and delivery, even
4526 if the caller is root. The reception works, but by that time, Exim is running
4527 as the Exim user, so when it re-execs to regain privilege for the delivery, the
4528 use of &%-C%& causes privilege to be lost. However, root can test reception and
4529 delivery using two separate commands (one to put a message on the queue, using
4530 &%-odq%&, and another to do the delivery, using &%-M%&).
4532 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4533 prefix string with which any file named in a &%-C%& command line option must
4534 start. In addition, the file name must not contain the sequence &"&`/../`&"&.
4535 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any file
4536 name can be used with &%-C%&.
4538 One-off changes to a configuration can be specified by the &%-D%& command line
4539 option, which defines and overrides values for macros used inside the
4540 configuration file. However, like &%-C%&, the use of this option by a
4541 non-privileged user causes Exim to discard its root privilege.
4542 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4543 completely disabled, and its use causes an immediate error exit.
4545 Some sites may wish to use the same Exim binary on different machines that
4546 share a file system, but to use different configuration files on each machine.
4547 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4548 looks for a file whose name is the configuration file name followed by a dot
4549 and the machine's node name, as obtained from the &[uname()]& function. If this
4550 file does not exist, the standard name is tried. This processing occurs for
4551 each file name in the list given by CONFIGURE_FILE or &%-C%&.
4553 In some esoteric situations different versions of Exim may be run under
4554 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4555 help with this. See the comments in &_src/EDITME_& for details.
4559 .section "Configuration file format" "SECTconffilfor"
4560 .cindex "configuration file" "format of"
4561 .cindex "format" "configuration file"
4562 Exim's configuration file is divided into a number of different parts. General
4563 option settings must always appear at the start of the file. The other parts
4564 are all optional, and may appear in any order. Each part other than the first
4565 is introduced by the word &"begin"& followed by the name of the part. The
4569 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4572 .cindex "AUTH" "configuration"
4573 &'authenticators'&: Configuration settings for the authenticator drivers. These
4574 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4576 &'routers'&: Configuration settings for the router drivers. Routers process
4577 addresses and determine how the message is to be delivered (see chapters
4578 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4580 &'transports'&: Configuration settings for the transport drivers. Transports
4581 define mechanisms for copying messages to destinations (see chapters
4582 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4584 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4585 If there is no retry section, or if it is empty (that is, no retry rules are
4586 defined), Exim will not retry deliveries. In this situation, temporary errors
4587 are treated the same as permanent errors. Retry rules are discussed in chapter
4590 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4591 when new addresses are generated during delivery. Rewriting is discussed in
4592 chapter &<<CHAPrewrite>>&.
4594 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4595 want to use this feature, you must set
4597 LOCAL_SCAN_HAS_OPTIONS=yes
4599 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4600 facility are given in chapter &<<CHAPlocalscan>>&.
4603 .cindex "configuration file" "leading white space in"
4604 .cindex "configuration file" "trailing white space in"
4605 .cindex "white space" "in configuration file"
4606 Leading and trailing white space in configuration lines is always ignored.
4608 Blank lines in the file, and lines starting with a # character (ignoring
4609 leading white space) are treated as comments and are ignored. &*Note*&: A
4610 # character other than at the beginning of a line is not treated specially,
4611 and does not introduce a comment.
4613 Any non-comment line can be continued by ending it with a backslash. Note that
4614 the general rule for white space means that trailing white space after the
4615 backslash and leading white space at the start of continuation
4616 lines is ignored. Comment lines beginning with # (but not empty lines) may
4617 appear in the middle of a sequence of continuation lines.
4619 A convenient way to create a configuration file is to start from the
4620 default, which is supplied in &_src/configure.default_&, and add, delete, or
4621 change settings as required.
4623 The ACLs, retry rules, and rewriting rules have their own syntax which is
4624 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4625 respectively. The other parts of the configuration file have some syntactic
4626 items in common, and these are described below, from section &<<SECTcos>>&
4627 onwards. Before that, the inclusion, macro, and conditional facilities are
4632 .section "File inclusions in the configuration file" "SECID41"
4633 .cindex "inclusions in configuration file"
4634 .cindex "configuration file" "including other files"
4635 .cindex "&`.include`& in configuration file"
4636 .cindex "&`.include_if_exists`& in configuration file"
4637 You can include other files inside Exim's run time configuration file by
4640 &`.include`& <&'file name'&>
4641 &`.include_if_exists`& <&'file name'&>
4643 on a line by itself. Double quotes round the file name are optional. If you use
4644 the first form, a configuration error occurs if the file does not exist; the
4645 second form does nothing for non-existent files. In all cases, an absolute file
4648 Includes may be nested to any depth, but remember that Exim reads its
4649 configuration file often, so it is a good idea to keep them to a minimum.
4650 If you change the contents of an included file, you must HUP the daemon,
4651 because an included file is read only when the configuration itself is read.
4653 The processing of inclusions happens early, at a physical line level, so, like
4654 comment lines, an inclusion can be used in the middle of an option setting,
4657 hosts_lookup = a.b.c \
4660 Include processing happens after macro processing (see below). Its effect is to
4661 process the lines of the included file as if they occurred inline where the
4666 .section "Macros in the configuration file" "SECTmacrodefs"
4667 .cindex "macro" "description of"
4668 .cindex "configuration file" "macros"
4669 If a line in the main part of the configuration (that is, before the first
4670 &"begin"& line) begins with an upper case letter, it is taken as a macro
4671 definition, and must be of the form
4673 <&'name'&> = <&'rest of line'&>
4675 The name must consist of letters, digits, and underscores, and need not all be
4676 in upper case, though that is recommended. The rest of the line, including any
4677 continuations, is the replacement text, and has leading and trailing white
4678 space removed. Quotes are not removed. The replacement text can never end with
4679 a backslash character, but this doesn't seem to be a serious limitation.
4681 Macros may also be defined between router, transport, authenticator, or ACL
4682 definitions. They may not, however, be defined within an individual driver or
4683 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
4685 .section "Macro substitution" "SECID42"
4686 Once a macro is defined, all subsequent lines in the file (and any included
4687 files) are scanned for the macro name; if there are several macros, the line is
4688 scanned for each in turn, in the order in which the macros are defined. The
4689 replacement text is not re-scanned for the current macro, though it is scanned
4690 for subsequently defined macros. For this reason, a macro name may not contain
4691 the name of a previously defined macro as a substring. You could, for example,
4694 &`ABCD_XYZ = `&<&'something'&>
4695 &`ABCD = `&<&'something else'&>
4697 but putting the definitions in the opposite order would provoke a configuration
4698 error. Macro expansion is applied to individual physical lines from the file,
4699 before checking for line continuation or file inclusion (see above). If a line
4700 consists solely of a macro name, and the expansion of the macro is empty, the
4701 line is ignored. A macro at the start of a line may turn the line into a
4702 comment line or a &`.include`& line.
4705 .section "Redefining macros" "SECID43"
4706 Once defined, the value of a macro can be redefined later in the configuration
4707 (or in an included file). Redefinition is specified by using &'=='& instead of
4712 MAC == updated value
4714 Redefinition does not alter the order in which the macros are applied to the
4715 subsequent lines of the configuration file. It is still the same order in which
4716 the macros were originally defined. All that changes is the macro's value.
4717 Redefinition makes it possible to accumulate values. For example:
4721 MAC == MAC and something added
4723 This can be helpful in situations where the configuration file is built
4724 from a number of other files.
4726 .section "Overriding macro values" "SECID44"
4727 The values set for macros in the configuration file can be overridden by the
4728 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
4729 used, unless called by root or the Exim user. A definition on the command line
4730 using the &%-D%& option causes all definitions and redefinitions within the
4735 .section "Example of macro usage" "SECID45"
4736 As an example of macro usage, consider a configuration where aliases are looked
4737 up in a MySQL database. It helps to keep the file less cluttered if long
4738 strings such as SQL statements are defined separately as macros, for example:
4740 ALIAS_QUERY = select mailbox from user where \
4741 login='${quote_mysql:$local_part}';
4743 This can then be used in a &(redirect)& router setting like this:
4745 data = ${lookup mysql{ALIAS_QUERY}}
4747 In earlier versions of Exim macros were sometimes used for domain, host, or
4748 address lists. In Exim 4 these are handled better by named lists &-- see
4749 section &<<SECTnamedlists>>&.
4752 .section "Conditional skips in the configuration file" "SECID46"
4753 .cindex "configuration file" "conditional skips"
4754 .cindex "&`.ifdef`&"
4755 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
4756 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
4757 portions of the configuration file. The processing happens whenever the file is
4758 read (that is, when an Exim binary starts to run).
4760 The implementation is very simple. Instances of the first four directives must
4761 be followed by text that includes the names of one or macros. The condition
4762 that is tested is whether or not any macro substitution has taken place in the
4766 message_size_limit = 50M
4768 message_size_limit = 100M
4771 sets a message size limit of 50M if the macro &`AAA`& is defined, and 100M
4772 otherwise. If there is more than one macro named on the line, the condition
4773 is true if any of them are defined. That is, it is an &"or"& condition. To
4774 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
4776 Although you can use a macro expansion to generate one of these directives,
4777 it is not very useful, because the condition &"there was a macro substitution
4778 in this line"& will always be true.
4780 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
4781 to clarify complicated nestings.
4785 .section "Common option syntax" "SECTcos"
4786 .cindex "common option syntax"
4787 .cindex "syntax of common options"
4788 .cindex "configuration file" "common option syntax"
4789 For the main set of options, driver options, and &[local_scan()]& options,
4790 each setting is on a line by itself, and starts with a name consisting of
4791 lower-case letters and underscores. Many options require a data value, and in
4792 these cases the name must be followed by an equals sign (with optional white
4793 space) and then the value. For example:
4795 qualify_domain = mydomain.example.com
4797 .cindex "hiding configuration option values"
4798 .cindex "configuration options" "hiding value of"
4799 .cindex "options" "hiding value of"
4800 Some option settings may contain sensitive data, for example, passwords for
4801 accessing databases. To stop non-admin users from using the &%-bP%& command
4802 line option to read these values, you can precede the option settings with the
4803 word &"hide"&. For example:
4805 hide mysql_servers = localhost/users/admin/secret-password
4807 For non-admin users, such options are displayed like this:
4809 mysql_servers = <value not displayable>
4811 If &"hide"& is used on a driver option, it hides the value of that option on
4812 all instances of the same driver.
4814 The following sections describe the syntax used for the different data types
4815 that are found in option settings.
4818 .section "Boolean options" "SECID47"
4819 .cindex "format" "boolean"
4820 .cindex "boolean configuration values"
4821 .oindex "&%no_%&&'xxx'&"
4822 .oindex "&%not_%&&'xxx'&"
4823 Options whose type is given as boolean are on/off switches. There are two
4824 different ways of specifying such options: with and without a data value. If
4825 the option name is specified on its own without data, the switch is turned on;
4826 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
4827 boolean options may be followed by an equals sign and one of the words
4828 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
4829 the following two settings have exactly the same effect:
4834 The following two lines also have the same (opposite) effect:
4839 You can use whichever syntax you prefer.
4844 .section "Integer values" "SECID48"
4845 .cindex "integer configuration values"
4846 .cindex "format" "integer"
4847 If an option's type is given as &"integer"&, the value can be given in decimal,
4848 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
4849 number is assumed. Otherwise, it is treated as an octal number unless it starts
4850 with the characters &"0x"&, in which case the remainder is interpreted as a
4853 If an integer value is followed by the letter K, it is multiplied by 1024; if
4854 it is followed by the letter M, it is multiplied by 1024x1024. When the values
4855 of integer option settings are output, values which are an exact multiple of
4856 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
4857 and M. The printing style is independent of the actual input format that was
4861 .section "Octal integer values" "SECID49"
4862 .cindex "integer format"
4863 .cindex "format" "octal integer"
4864 If an option's type is given as &"octal integer"&, its value is always
4865 interpreted as an octal number, whether or not it starts with the digit zero.
4866 Such options are always output in octal.
4869 .section "Fixed point numbers" "SECID50"
4870 .cindex "fixed point configuration values"
4871 .cindex "format" "fixed point"
4872 If an option's type is given as &"fixed-point"&, its value must be a decimal
4873 integer, optionally followed by a decimal point and up to three further digits.
4877 .section "Time intervals" "SECTtimeformat"
4878 .cindex "time interval" "specifying in configuration"
4879 .cindex "format" "time interval"
4880 A time interval is specified as a sequence of numbers, each followed by one of
4881 the following letters, with no intervening white space:
4891 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
4892 intervals are output in the same format. Exim does not restrict the values; it
4893 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
4897 .section "String values" "SECTstrings"
4898 .cindex "string" "format of configuration values"
4899 .cindex "format" "string"
4900 If an option's type is specified as &"string"&, the value can be specified with
4901 or without double-quotes. If it does not start with a double-quote, the value
4902 consists of the remainder of the line plus any continuation lines, starting at
4903 the first character after any leading white space, with trailing white space
4904 removed, and with no interpretation of the characters in the string. Because
4905 Exim removes comment lines (those beginning with #) at an early stage, they can
4906 appear in the middle of a multi-line string. The following two settings are
4907 therefore equivalent:
4909 trusted_users = uucp:mail
4910 trusted_users = uucp:\
4911 # This comment line is ignored
4914 .cindex "string" "quoted"
4915 .cindex "escape characters in quoted strings"
4916 If a string does start with a double-quote, it must end with a closing
4917 double-quote, and any backslash characters other than those used for line
4918 continuation are interpreted as escape characters, as follows:
4921 .irow &`\\`& "single backslash"
4922 .irow &`\n`& "newline"
4923 .irow &`\r`& "carriage return"
4925 .irow "&`\`&<&'octal digits'&>" "up to 3 octal digits specify one character"
4926 .irow "&`\x`&<&'hex digits'&>" "up to 2 hexadecimal digits specify one &&&
4930 If a backslash is followed by some other character, including a double-quote
4931 character, that character replaces the pair.
4933 Quoting is necessary only if you want to make use of the backslash escapes to
4934 insert special characters, or if you need to specify a value with leading or
4935 trailing spaces. These cases are rare, so quoting is almost never needed in
4936 current versions of Exim. In versions of Exim before 3.14, quoting was required
4937 in order to continue lines, so you may come across older configuration files
4938 and examples that apparently quote unnecessarily.
4941 .section "Expanded strings" "SECID51"
4942 .cindex "expansion" "definition of"
4943 Some strings in the configuration file are subjected to &'string expansion'&,
4944 by which means various parts of the string may be changed according to the
4945 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
4946 is as just described; in particular, the handling of backslashes in quoted
4947 strings is done as part of the input process, before expansion takes place.
4948 However, backslash is also an escape character for the expander, so any
4949 backslashes that are required for that reason must be doubled if they are
4950 within a quoted configuration string.
4953 .section "User and group names" "SECID52"
4954 .cindex "user name" "format of"
4955 .cindex "format" "user name"
4956 .cindex "groups" "name format"
4957 .cindex "format" "group name"
4958 User and group names are specified as strings, using the syntax described
4959 above, but the strings are interpreted specially. A user or group name must
4960 either consist entirely of digits, or be a name that can be looked up using the
4961 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
4964 .section "List construction" "SECTlistconstruct"
4965 .cindex "list" "syntax of in configuration"
4966 .cindex "format" "list item in configuration"
4967 .cindex "string" "list, definition of"
4968 The data for some configuration options is a list of items, with colon as the
4969 default separator. Many of these options are shown with type &"string list"& in
4970 the descriptions later in this document. Others are listed as &"domain list"&,
4971 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
4972 are all the same; however, those other than &"string list"& are subject to
4973 particular kinds of interpretation, as described in chapter
4974 &<<CHAPdomhosaddlists>>&.
4976 In all these cases, the entire list is treated as a single string as far as the
4977 input syntax is concerned. The &%trusted_users%& setting in section
4978 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
4979 in a list, it must be entered as two colons. Leading and trailing white space
4980 on each item in a list is ignored. This makes it possible to include items that
4981 start with a colon, and in particular, certain forms of IPv6 address. For
4984 local_interfaces = 127.0.0.1 : ::::1
4986 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
4988 &*Note*&: Although leading and trailing white space is ignored in individual
4989 list items, it is not ignored when parsing the list. The space after the first
4990 colon in the example above is necessary. If it were not there, the list would
4991 be interpreted as the two items 127.0.0.1:: and 1.
4993 .section "Changing list separators" "SECID53"
4994 .cindex "list separator" "changing"
4995 .cindex "IPv6" "addresses in lists"
4996 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
4997 introduced to allow the separator character to be changed. If a list begins
4998 with a left angle bracket, followed by any punctuation character, that
4999 character is used instead of colon as the list separator. For example, the list
5000 above can be rewritten to use a semicolon separator like this:
5002 local_interfaces = <; 127.0.0.1 ; ::1
5004 This facility applies to all lists, with the exception of the list in
5005 &%log_file_path%&. It is recommended that the use of non-colon separators be
5006 confined to circumstances where they really are needed.
5008 .cindex "list separator" "newline as"
5009 .cindex "newline" "as list separator"
5010 It is also possible to use newline and other control characters (those with
5011 code values less than 32, plus DEL) as separators in lists. Such separators
5012 must be provided literally at the time the list is processed. For options that
5013 are string-expanded, you can write the separator using a normal escape
5014 sequence. This will be processed by the expander before the string is
5015 interpreted as a list. For example, if a newline-separated list of domains is
5016 generated by a lookup, you can process it directly by a line such as this:
5018 domains = <\n ${lookup mysql{.....}}
5020 This avoids having to change the list separator in such data. You are unlikely
5021 to want to use a control character as a separator in an option that is not
5022 expanded, because the value is literal text. However, it can be done by giving
5023 the value in quotes. For example:
5025 local_interfaces = "<\n 127.0.0.1 \n ::1"
5027 Unlike printing character separators, which can be included in list items by
5028 doubling, it is not possible to include a control character as data when it is
5029 set as the separator. Two such characters in succession are interpreted as
5030 enclosing an empty list item.
5034 .section "Empty items in lists" "SECTempitelis"
5035 .cindex "list" "empty item in"
5036 An empty item at the end of a list is always ignored. In other words, trailing
5037 separator characters are ignored. Thus, the list in
5039 senders = user@domain :
5041 contains only a single item. If you want to include an empty string as one item
5042 in a list, it must not be the last item. For example, this list contains three
5043 items, the second of which is empty:
5045 senders = user1@domain : : user2@domain
5047 &*Note*&: There must be white space between the two colons, as otherwise they
5048 are interpreted as representing a single colon data character (and the list
5049 would then contain just one item). If you want to specify a list that contains
5050 just one, empty item, you can do it as in this example:
5054 In this case, the first item is empty, and the second is discarded because it
5055 is at the end of the list.
5060 .section "Format of driver configurations" "SECTfordricon"
5061 .cindex "drivers" "configuration format"
5062 There are separate parts in the configuration for defining routers, transports,
5063 and authenticators. In each part, you are defining a number of driver
5064 instances, each with its own set of options. Each driver instance is defined by
5065 a sequence of lines like this:
5067 <&'instance name'&>:
5072 In the following example, the instance name is &(localuser)&, and it is
5073 followed by three options settings:
5078 transport = local_delivery
5080 For each driver instance, you specify which Exim code module it uses &-- by the
5081 setting of the &%driver%& option &-- and (optionally) some configuration
5082 settings. For example, in the case of transports, if you want a transport to
5083 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5084 a local file you would use the &(appendfile)& driver. Each of the drivers is
5085 described in detail in its own separate chapter later in this manual.
5087 You can have several routers, transports, or authenticators that are based on
5088 the same underlying driver (each must have a different instance name).
5090 The order in which routers are defined is important, because addresses are
5091 passed to individual routers one by one, in order. The order in which
5092 transports are defined does not matter at all. The order in which
5093 authenticators are defined is used only when Exim, as a client, is searching
5094 them to find one that matches an authentication mechanism offered by the
5097 .cindex "generic options"
5098 .cindex "options" "generic &-- definition of"
5099 Within a driver instance definition, there are two kinds of option: &'generic'&
5100 and &'private'&. The generic options are those that apply to all drivers of the
5101 same type (that is, all routers, all transports or all authenticators). The
5102 &%driver%& option is a generic option that must appear in every definition.
5103 .cindex "private options"
5104 The private options are special for each driver, and none need appear, because
5105 they all have default values.
5107 The options may appear in any order, except that the &%driver%& option must
5108 precede any private options, since these depend on the particular driver. For
5109 this reason, it is recommended that &%driver%& always be the first option.
5111 Driver instance names, which are used for reference in log entries and
5112 elsewhere, can be any sequence of letters, digits, and underscores (starting
5113 with a letter) and must be unique among drivers of the same type. A router and
5114 a transport (for example) can each have the same name, but no two router
5115 instances can have the same name. The name of a driver instance should not be
5116 confused with the name of the underlying driver module. For example, the
5117 configuration lines:
5122 create an instance of the &(smtp)& transport driver whose name is
5123 &(remote_smtp)&. The same driver code can be used more than once, with
5124 different instance names and different option settings each time. A second
5125 instance of the &(smtp)& transport, with different options, might be defined
5131 command_timeout = 10s
5133 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5134 these transport instances from routers, and these names would appear in log
5137 Comment lines may be present in the middle of driver specifications. The full
5138 list of option settings for any particular driver instance, including all the
5139 defaulted values, can be extracted by making use of the &%-bP%& command line
5147 . ////////////////////////////////////////////////////////////////////////////
5148 . ////////////////////////////////////////////////////////////////////////////
5150 .chapter "The default configuration file" "CHAPdefconfil"
5151 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5152 .cindex "default" "configuration file &""walk through""&"
5153 The default configuration file supplied with Exim as &_src/configure.default_&
5154 is sufficient for a host with simple mail requirements. As an introduction to
5155 the way Exim is configured, this chapter &"walks through"& the default
5156 configuration, giving brief explanations of the settings. Detailed descriptions
5157 of the options are given in subsequent chapters. The default configuration file
5158 itself contains extensive comments about ways you might want to modify the
5159 initial settings. However, note that there are many options that are not
5160 mentioned at all in the default configuration.
5164 .section "Main configuration settings" "SECTdefconfmain"
5165 The main (global) configuration option settings must always come first in the
5166 file. The first thing you'll see in the file, after some initial comments, is
5169 # primary_hostname =
5171 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5172 to know the official, fully qualified name of your host, and this is where you
5173 can specify it. However, in most cases you do not need to set this option. When
5174 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5176 The first three non-comment configuration lines are as follows:
5178 domainlist local_domains = @
5179 domainlist relay_to_domains =
5180 hostlist relay_from_hosts = 127.0.0.1
5182 These are not, in fact, option settings. They are definitions of two named
5183 domain lists and one named host list. Exim allows you to give names to lists of
5184 domains, hosts, and email addresses, in order to make it easier to manage the
5185 configuration file (see section &<<SECTnamedlists>>&).
5187 The first line defines a domain list called &'local_domains'&; this is used
5188 later in the configuration to identify domains that are to be delivered
5191 .cindex "@ in a domain list"
5192 There is just one item in this list, the string &"@"&. This is a special form
5193 of entry which means &"the name of the local host"&. Thus, if the local host is
5194 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5195 be delivered locally. Because the local host's name is referenced indirectly,
5196 the same configuration file can be used on different hosts.
5198 The second line defines a domain list called &'relay_to_domains'&, but the
5199 list itself is empty. Later in the configuration we will come to the part that
5200 controls mail relaying through the local host; it allows relaying to any
5201 domains in this list. By default, therefore, no relaying on the basis of a mail
5202 domain is permitted.
5204 The third line defines a host list called &'relay_from_hosts'&. This list is
5205 used later in the configuration to permit relaying from any host or IP address
5206 that matches the list. The default contains just the IP address of the IPv4
5207 loopback interface, which means that processes on the local host are able to
5208 submit mail for relaying by sending it over TCP/IP to that interface. No other
5209 hosts are permitted to submit messages for relaying.
5211 Just to be sure there's no misunderstanding: at this point in the configuration
5212 we aren't actually setting up any controls. We are just defining some domains
5213 and hosts that will be used in the controls that are specified later.
5215 The next two configuration lines are genuine option settings:
5217 acl_smtp_rcpt = acl_check_rcpt
5218 acl_smtp_data = acl_check_data
5220 These options specify &'Access Control Lists'& (ACLs) that are to be used
5221 during an incoming SMTP session for every recipient of a message (every RCPT
5222 command), and after the contents of the message have been received,
5223 respectively. The names of the lists are &'acl_check_rcpt'& and
5224 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5225 section of the configuration. The RCPT ACL controls which recipients are
5226 accepted for an incoming message &-- if a configuration does not provide an ACL
5227 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5228 contents of a message to be checked.
5230 Two commented-out option settings are next:
5232 # av_scanner = clamd:/tmp/clamd
5233 # spamd_address = 127.0.0.1 783
5235 These are example settings that can be used when Exim is compiled with the
5236 content-scanning extension. The first specifies the interface to the virus
5237 scanner, and the second specifies the interface to SpamAssassin. Further
5238 details are given in chapter &<<CHAPexiscan>>&.
5240 Three more commented-out option settings follow:
5242 # tls_advertise_hosts = *
5243 # tls_certificate = /etc/ssl/exim.crt
5244 # tls_privatekey = /etc/ssl/exim.pem
5246 These are example settings that can be used when Exim is compiled with
5247 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5248 first one specifies the list of clients that are allowed to use TLS when
5249 connecting to this server; in this case the wildcard means all clients. The
5250 other options specify where Exim should find its TLS certificate and private
5251 key, which together prove the server's identity to any clients that connect.
5252 More details are given in chapter &<<CHAPTLS>>&.
5254 Another two commented-out option settings follow:
5256 # daemon_smtp_ports = 25 : 465 : 587
5257 # tls_on_connect_ports = 465
5259 .cindex "port" "465 and 587"
5260 .cindex "port" "for message submission"
5261 .cindex "message" "submission, ports for"
5262 .cindex "ssmtp protocol"
5263 .cindex "smtps protocol"
5264 .cindex "SMTP" "ssmtp protocol"
5265 .cindex "SMTP" "smtps protocol"
5266 These options provide better support for roaming users who wish to use this
5267 server for message submission. They are not much use unless you have turned on
5268 TLS (as described in the previous paragraph) and authentication (about which
5269 more in section &<<SECTdefconfauth>>&). The usual SMTP port 25 is often blocked
5270 on end-user networks, so RFC 4409 specifies that message submission should use
5271 port 587 instead. However some software (notably Microsoft Outlook) cannot be
5272 configured to use port 587 correctly, so these settings also enable the
5273 non-standard &"smtps"& (aka &"ssmtp"&) port 465 (see section
5274 &<<SECTsupobssmt>>&).
5276 Two more commented-out options settings follow:
5279 # qualify_recipient =
5281 The first of these specifies a domain that Exim uses when it constructs a
5282 complete email address from a local login name. This is often needed when Exim
5283 receives a message from a local process. If you do not set &%qualify_domain%&,
5284 the value of &%primary_hostname%& is used. If you set both of these options,
5285 you can have different qualification domains for sender and recipient
5286 addresses. If you set only the first one, its value is used in both cases.
5288 .cindex "domain literal" "recognizing format"
5289 The following line must be uncommented if you want Exim to recognize
5290 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5291 (an IP address within square brackets) instead of a named domain.
5293 # allow_domain_literals
5295 The RFCs still require this form, but many people think that in the modern
5296 Internet it makes little sense to permit mail to be sent to specific hosts by
5297 quoting their IP addresses. This ancient format has been used by people who
5298 try to abuse hosts by using them for unwanted relaying. However, some
5299 people believe there are circumstances (for example, messages addressed to
5300 &'postmaster'&) where domain literals are still useful.
5302 The next configuration line is a kind of trigger guard:
5306 It specifies that no delivery must ever be run as the root user. The normal
5307 convention is to set up &'root'& as an alias for the system administrator. This
5308 setting is a guard against slips in the configuration.
5309 The list of users specified by &%never_users%& is not, however, the complete
5310 list; the build-time configuration in &_Local/Makefile_& has an option called
5311 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5312 contents of &%never_users%& are added to this list. By default
5313 FIXED_NEVER_USERS also specifies root.
5315 When a remote host connects to Exim in order to send mail, the only information
5316 Exim has about the host's identity is its IP address. The next configuration
5321 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5322 in order to get a host name. This improves the quality of the logging
5323 information, but if you feel it is too expensive, you can remove it entirely,
5324 or restrict the lookup to hosts on &"nearby"& networks.
5325 Note that it is not always possible to find a host name from an IP address,
5326 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5329 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5330 1413 (hence their names):
5333 rfc1413_query_timeout = 5s
5335 These settings cause Exim to make ident callbacks for all incoming SMTP calls.
5336 You can limit the hosts to which these calls are made, or change the timeout
5337 that is used. If you set the timeout to zero, all ident calls are disabled.
5338 Although they are cheap and can provide useful information for tracing problem
5339 messages, some hosts and firewalls have problems with ident calls. This can
5340 result in a timeout instead of an immediate refused connection, leading to
5341 delays on starting up an incoming SMTP session.
5343 When Exim receives messages over SMTP connections, it expects all addresses to
5344 be fully qualified with a domain, as required by the SMTP definition. However,
5345 if you are running a server to which simple clients submit messages, you may
5346 find that they send unqualified addresses. The two commented-out options:
5348 # sender_unqualified_hosts =
5349 # recipient_unqualified_hosts =
5351 show how you can specify hosts that are permitted to send unqualified sender
5352 and recipient addresses, respectively.
5354 The &%percent_hack_domains%& option is also commented out:
5356 # percent_hack_domains =
5358 It provides a list of domains for which the &"percent hack"& is to operate.
5359 This is an almost obsolete form of explicit email routing. If you do not know
5360 anything about it, you can safely ignore this topic.
5362 The last two settings in the main part of the default configuration are
5363 concerned with messages that have been &"frozen"& on Exim's queue. When a
5364 message is frozen, Exim no longer continues to try to deliver it. Freezing
5365 occurs when a bounce message encounters a permanent failure because the sender
5366 address of the original message that caused the bounce is invalid, so the
5367 bounce cannot be delivered. This is probably the most common case, but there
5368 are also other conditions that cause freezing, and frozen messages are not
5369 always bounce messages.
5371 ignore_bounce_errors_after = 2d
5372 timeout_frozen_after = 7d
5374 The first of these options specifies that failing bounce messages are to be
5375 discarded after 2 days on the queue. The second specifies that any frozen
5376 message (whether a bounce message or not) is to be timed out (and discarded)
5377 after a week. In this configuration, the first setting ensures that no failing
5378 bounce message ever lasts a week.
5382 .section "ACL configuration" "SECID54"
5383 .cindex "default" "ACLs"
5384 .cindex "&ACL;" "default configuration"
5385 In the default configuration, the ACL section follows the main configuration.
5386 It starts with the line
5390 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5391 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5392 and &%acl_smtp_data%& above.
5394 .cindex "RCPT" "ACL for"
5395 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5396 RCPT command specifies one of the message's recipients. The ACL statements
5397 are considered in order, until the recipient address is either accepted or
5398 rejected. The RCPT command is then accepted or rejected, according to the
5399 result of the ACL processing.
5403 This line, consisting of a name terminated by a colon, marks the start of the
5408 This ACL statement accepts the recipient if the sending host matches the list.
5409 But what does that strange list mean? It doesn't actually contain any host
5410 names or IP addresses. The presence of the colon puts an empty item in the
5411 list; Exim matches this only if the incoming message did not come from a remote
5412 host, because in that case, the remote hostname is empty. The colon is
5413 important. Without it, the list itself is empty, and can never match anything.
5415 What this statement is doing is to accept unconditionally all recipients in
5416 messages that are submitted by SMTP from local processes using the standard
5417 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5420 deny message = Restricted characters in address
5421 domains = +local_domains
5422 local_parts = ^[.] : ^.*[@%!/|]
5424 deny message = Restricted characters in address
5425 domains = !+local_domains
5426 local_parts = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5428 These statements are concerned with local parts that contain any of the
5429 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5430 Although these characters are entirely legal in local parts (in the case of
5431 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5432 in Internet mail addresses.
5434 The first three have in the past been associated with explicitly routed
5435 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5436 option). Addresses containing these characters are regularly tried by spammers
5437 in an attempt to bypass relaying restrictions, and also by open relay testing
5438 programs. Unless you really need them it is safest to reject these characters
5439 at this early stage. This configuration is heavy-handed in rejecting these
5440 characters for all messages it accepts from remote hosts. This is a deliberate
5441 policy of being as safe as possible.
5443 The first rule above is stricter, and is applied to messages that are addressed
5444 to one of the local domains handled by this host. This is implemented by the
5445 first condition, which restricts it to domains that are listed in the
5446 &'local_domains'& domain list. The &"+"& character is used to indicate a
5447 reference to a named list. In this configuration, there is just one domain in
5448 &'local_domains'&, but in general there may be many.
5450 The second condition on the first statement uses two regular expressions to
5451 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5452 or &"|"&. If you have local accounts that include these characters, you will
5453 have to modify this rule.
5455 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5456 allows them because they have been encountered in practice. (Consider the
5457 common convention of local parts constructed as
5458 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5459 the author of Exim, who has no second initial.) However, a local part starting
5460 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5461 file name (for example, for a mailing list). This is also true for local parts
5462 that contain slashes. A pipe symbol can also be troublesome if the local part
5463 is incorporated unthinkingly into a shell command line.
5465 The second rule above applies to all other domains, and is less strict. This
5466 allows your own users to send outgoing messages to sites that use slashes
5467 and vertical bars in their local parts. It blocks local parts that begin
5468 with a dot, slash, or vertical bar, but allows these characters within the
5469 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5470 and &"!"& is blocked, as before. The motivation here is to prevent your users
5471 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5473 accept local_parts = postmaster
5474 domains = +local_domains
5476 This statement, which has two conditions, accepts an incoming address if the
5477 local part is &'postmaster'& and the domain is one of those listed in the
5478 &'local_domains'& domain list. The &"+"& character is used to indicate a
5479 reference to a named list. In this configuration, there is just one domain in
5480 &'local_domains'&, but in general there may be many.
5482 The presence of this statement means that mail to postmaster is never blocked
5483 by any of the subsequent tests. This can be helpful while sorting out problems
5484 in cases where the subsequent tests are incorrectly denying access.
5486 require verify = sender
5488 This statement requires the sender address to be verified before any subsequent
5489 ACL statement can be used. If verification fails, the incoming recipient
5490 address is refused. Verification consists of trying to route the address, to
5491 see if a bounce message could be delivered to it. In the case of remote
5492 addresses, basic verification checks only the domain, but &'callouts'& can be
5493 used for more verification if required. Section &<<SECTaddressverification>>&
5494 discusses the details of address verification.
5496 accept hosts = +relay_from_hosts
5497 control = submission
5499 This statement accepts the address if the message is coming from one of the
5500 hosts that are defined as being allowed to relay through this host. Recipient
5501 verification is omitted here, because in many cases the clients are dumb MUAs
5502 that do not cope well with SMTP error responses. For the same reason, the
5503 second line specifies &"submission mode"& for messages that are accepted. This
5504 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5505 messages that are deficient in some way, for example, because they lack a
5506 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5507 probably add recipient verification here, and disable submission mode.
5509 accept authenticated = *
5510 control = submission
5512 This statement accepts the address if the client host has authenticated itself.
5513 Submission mode is again specified, on the grounds that such messages are most
5514 likely to come from MUAs. The default configuration does not define any
5515 authenticators, though it does include some nearly complete commented-out
5516 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5517 fact authenticate until you complete the authenticator definitions.
5519 require message = relay not permitted
5520 domains = +local_domains : +relay_domains
5522 This statement rejects the address if its domain is neither a local domain nor
5523 one of the domains for which this host is a relay.
5525 require verify = recipient
5527 This statement requires the recipient address to be verified; if verification
5528 fails, the address is rejected.
5530 # deny message = rejected because $sender_host_address \
5531 # is in a black list at $dnslist_domain\n\
5533 # dnslists = black.list.example
5535 # warn dnslists = black.list.example
5536 # add_header = X-Warning: $sender_host_address is in \
5537 # a black list at $dnslist_domain
5538 # log_message = found in $dnslist_domain
5540 These commented-out lines are examples of how you could configure Exim to check
5541 sending hosts against a DNS black list. The first statement rejects messages
5542 from blacklisted hosts, whereas the second just inserts a warning header
5545 # require verify = csa
5547 This commented-out line is an example of how you could turn on client SMTP
5548 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5553 The final statement in the first ACL unconditionally accepts any recipient
5554 address that has successfully passed all the previous tests.
5558 This line marks the start of the second ACL, and names it. Most of the contents
5559 of this ACL are commented out:
5562 # message = This message contains a virus \
5565 These lines are examples of how to arrange for messages to be scanned for
5566 viruses when Exim has been compiled with the content-scanning extension, and a
5567 suitable virus scanner is installed. If the message is found to contain a
5568 virus, it is rejected with the given custom error message.
5570 # warn spam = nobody
5571 # message = X-Spam_score: $spam_score\n\
5572 # X-Spam_score_int: $spam_score_int\n\
5573 # X-Spam_bar: $spam_bar\n\
5574 # X-Spam_report: $spam_report
5576 These lines are an example of how to arrange for messages to be scanned by
5577 SpamAssassin when Exim has been compiled with the content-scanning extension,
5578 and SpamAssassin has been installed. The SpamAssassin check is run with
5579 &`nobody`& as its user parameter, and the results are added to the message as a
5580 series of extra header line. In this case, the message is not rejected,
5581 whatever the spam score.
5585 This final line in the DATA ACL accepts the message unconditionally.
5588 .section "Router configuration" "SECID55"
5589 .cindex "default" "routers"
5590 .cindex "routers" "default"
5591 The router configuration comes next in the default configuration, introduced
5596 Routers are the modules in Exim that make decisions about where to send
5597 messages. An address is passed to each router in turn, until it is either
5598 accepted, or failed. This means that the order in which you define the routers
5599 matters. Each router is fully described in its own chapter later in this
5600 manual. Here we give only brief overviews.
5603 # driver = ipliteral
5604 # domains = !+local_domains
5605 # transport = remote_smtp
5607 .cindex "domain literal" "default router"
5608 This router is commented out because the majority of sites do not want to
5609 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
5610 you uncomment this router, you also need to uncomment the setting of
5611 &%allow_domain_literals%& in the main part of the configuration.
5615 domains = ! +local_domains
5616 transport = remote_smtp
5617 ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
5620 The first uncommented router handles addresses that do not involve any local
5621 domains. This is specified by the line
5623 domains = ! +local_domains
5625 The &%domains%& option lists the domains to which this router applies, but the
5626 exclamation mark is a negation sign, so the router is used only for domains
5627 that are not in the domain list called &'local_domains'& (which was defined at
5628 the start of the configuration). The plus sign before &'local_domains'&
5629 indicates that it is referring to a named list. Addresses in other domains are
5630 passed on to the following routers.
5632 The name of the router driver is &(dnslookup)&,
5633 and is specified by the &%driver%& option. Do not be confused by the fact that
5634 the name of this router instance is the same as the name of the driver. The
5635 instance name is arbitrary, but the name set in the &%driver%& option must be
5636 one of the driver modules that is in the Exim binary.
5638 The &(dnslookup)& router routes addresses by looking up their domains in the
5639 DNS in order to obtain a list of hosts to which the address is routed. If the
5640 router succeeds, the address is queued for the &(remote_smtp)& transport, as
5641 specified by the &%transport%& option. If the router does not find the domain
5642 in the DNS, no further routers are tried because of the &%no_more%& setting, so
5643 the address fails and is bounced.
5645 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
5646 be entirely ignored. This option is present because a number of cases have been
5647 encountered where MX records in the DNS point to host names
5648 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
5649 Completely ignoring these IP addresses causes Exim to fail to route the
5650 email address, so it bounces. Otherwise, Exim would log a routing problem, and
5651 continue to try to deliver the message periodically until the address timed
5658 data = ${lookup{$local_part}lsearch{/etc/aliases}}
5660 file_transport = address_file
5661 pipe_transport = address_pipe
5663 Control reaches this and subsequent routers only for addresses in the local
5664 domains. This router checks to see whether the local part is defined as an
5665 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
5666 data that it looks up from that file. If no data is found for the local part,
5667 the value of the &%data%& option is empty, causing the address to be passed to
5670 &_/etc/aliases_& is a conventional name for the system aliases file that is
5671 often used. That is why it is referenced by from the default configuration
5672 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
5673 &_Local/Makefile_& before building Exim.
5678 # local_part_suffix = +* : -*
5679 # local_part_suffix_optional
5680 file = $home/.forward
5685 file_transport = address_file
5686 pipe_transport = address_pipe
5687 reply_transport = address_reply
5689 This is the most complicated router in the default configuration. It is another
5690 redirection router, but this time it is looking for forwarding data set up by
5691 individual users. The &%check_local_user%& setting specifies a check that the
5692 local part of the address is the login name of a local user. If it is not, the
5693 router is skipped. The two commented options that follow &%check_local_user%&,
5696 # local_part_suffix = +* : -*
5697 # local_part_suffix_optional
5699 .vindex "&$local_part_suffix$&"
5700 show how you can specify the recognition of local part suffixes. If the first
5701 is uncommented, a suffix beginning with either a plus or a minus sign, followed
5702 by any sequence of characters, is removed from the local part and placed in the
5703 variable &$local_part_suffix$&. The second suffix option specifies that the
5704 presence of a suffix in the local part is optional. When a suffix is present,
5705 the check for a local login uses the local part with the suffix removed.
5707 When a local user account is found, the file called &_.forward_& in the user's
5708 home directory is consulted. If it does not exist, or is empty, the router
5709 declines. Otherwise, the contents of &_.forward_& are interpreted as
5710 redirection data (see chapter &<<CHAPredirect>>& for more details).
5712 .cindex "Sieve filter" "enabling in default router"
5713 Traditional &_.forward_& files contain just a list of addresses, pipes, or
5714 files. Exim supports this by default. However, if &%allow_filter%& is set (it
5715 is commented out by default), the contents of the file are interpreted as a set
5716 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
5717 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
5718 separate document entitled &'Exim's interfaces to mail filtering'&.
5720 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
5721 verifying addresses, or when running as a consequence of an SMTP EXPN command.
5722 There are two reasons for doing this:
5725 Whether or not a local user has a &_.forward_& file is not really relevant when
5726 checking an address for validity; it makes sense not to waste resources doing
5729 More importantly, when Exim is verifying addresses or handling an EXPN
5730 command during an SMTP session, it is running as the Exim user, not as root.
5731 The group is the Exim group, and no additional groups are set up.
5732 It may therefore not be possible for Exim to read users' &_.forward_& files at
5736 The setting of &%check_ancestor%& prevents the router from generating a new
5737 address that is the same as any previous address that was redirected. (This
5738 works round a problem concerning a bad interaction between aliasing and
5739 forwarding &-- see section &<<SECTredlocmai>>&).
5741 The final three option settings specify the transports that are to be used when
5742 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
5743 auto-reply, respectively. For example, if a &_.forward_& file contains
5745 a.nother@elsewhere.example, /home/spqr/archive
5747 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
5753 # local_part_suffix = +* : -*
5754 # local_part_suffix_optional
5755 transport = local_delivery
5757 The final router sets up delivery into local mailboxes, provided that the local
5758 part is the name of a local login, by accepting the address and assigning it to
5759 the &(local_delivery)& transport. Otherwise, we have reached the end of the
5760 routers, so the address is bounced. The commented suffix settings fulfil the
5761 same purpose as they do for the &(userforward)& router.
5764 .section "Transport configuration" "SECID56"
5765 .cindex "default" "transports"
5766 .cindex "transports" "default"
5767 Transports define mechanisms for actually delivering messages. They operate
5768 only when referenced from routers, so the order in which they are defined does
5769 not matter. The transports section of the configuration starts with
5773 One remote transport and four local transports are defined.
5778 This transport is used for delivering messages over SMTP connections. All its
5779 options are defaulted. The list of remote hosts comes from the router.
5783 file = /var/mail/$local_part
5790 This &(appendfile)& transport is used for local delivery to user mailboxes in
5791 traditional BSD mailbox format. By default it runs under the uid and gid of the
5792 local user, which requires the sticky bit to be set on the &_/var/mail_&
5793 directory. Some systems use the alternative approach of running mail deliveries
5794 under a particular group instead of using the sticky bit. The commented options
5795 show how this can be done.
5797 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
5798 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
5799 similarly-named options above.
5805 This transport is used for handling deliveries to pipes that are generated by
5806 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
5807 option specifies that any output generated by the pipe is to be returned to the
5816 This transport is used for handling deliveries to files that are generated by
5817 redirection. The name of the file is not specified in this instance of
5818 &(appendfile)&, because it comes from the &(redirect)& router.
5823 This transport is used for handling automatic replies generated by users'
5828 .section "Default retry rule" "SECID57"
5829 .cindex "retry" "default rule"
5830 .cindex "default" "retry rule"
5831 The retry section of the configuration file contains rules which affect the way
5832 Exim retries deliveries that cannot be completed at the first attempt. It is
5833 introduced by the line
5837 In the default configuration, there is just one rule, which applies to all
5840 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
5842 This causes any temporarily failing address to be retried every 15 minutes for
5843 2 hours, then at intervals starting at one hour and increasing by a factor of
5844 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
5845 is not delivered after 4 days of temporary failure, it is bounced.
5847 If the retry section is removed from the configuration, or is empty (that is,
5848 if no retry rules are defined), Exim will not retry deliveries. This turns
5849 temporary errors into permanent errors.
5852 .section "Rewriting configuration" "SECID58"
5853 The rewriting section of the configuration, introduced by
5857 contains rules for rewriting addresses in messages as they arrive. There are no
5858 rewriting rules in the default configuration file.
5862 .section "Authenticators configuration" "SECTdefconfauth"
5863 .cindex "AUTH" "configuration"
5864 The authenticators section of the configuration, introduced by
5866 begin authenticators
5868 defines mechanisms for the use of the SMTP AUTH command. The default
5869 configuration file contains two commented-out example authenticators
5870 which support plaintext username/password authentication using the
5871 standard PLAIN mechanism and the traditional but non-standard LOGIN
5872 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
5873 to support most MUA software.
5875 The example PLAIN authenticator looks like this:
5878 # driver = plaintext
5879 # server_set_id = $auth2
5880 # server_prompts = :
5881 # server_condition = Authentication is not yet configured
5882 # server_advertise_condition = ${if def:tls_cipher }
5884 And the example LOGIN authenticator looks like this:
5887 # driver = plaintext
5888 # server_set_id = $auth1
5889 # server_prompts = <| Username: | Password:
5890 # server_condition = Authentication is not yet configured
5891 # server_advertise_condition = ${if def:tls_cipher }
5894 The &%server_set_id%& option makes Exim remember the authenticated username
5895 in &$authenticated_id$&, which can be used later in ACLs or routers. The
5896 &%server_prompts%& option configures the &(plaintext)& authenticator so
5897 that it implements the details of the specific authentication mechanism,
5898 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
5899 when Exim offers authentication to clients; in the examples, this is only
5900 when TLS or SSL has been started, so to enable the authenticators you also
5901 need to add support for TLS as described in &<<SECTdefconfmain>>&.
5903 The &%server_condition%& setting defines how to verify that the username and
5904 password are correct. In the examples it just produces an error message.
5905 To make the authenticators work, you can use a string expansion
5906 expression like one of the examples in &<<CHAPplaintext>>&.
5908 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
5909 usercode and password are in different positions. &<<CHAPplaintext>>&
5912 .ecindex IIDconfiwal
5916 . ////////////////////////////////////////////////////////////////////////////
5917 . ////////////////////////////////////////////////////////////////////////////
5919 .chapter "Regular expressions" "CHAPregexp"
5921 .cindex "regular expressions" "library"
5923 Exim supports the use of regular expressions in many of its options. It
5924 uses the PCRE regular expression library; this provides regular expression
5925 matching that is compatible with Perl 5. The syntax and semantics of
5926 regular expressions is discussed in many Perl reference books, and also in
5927 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
5928 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
5930 The documentation for the syntax and semantics of the regular expressions that
5931 are supported by PCRE is included in the PCRE distribution, and no further
5932 description is included here. The PCRE functions are called from Exim using
5933 the default option settings (that is, with no PCRE options set), except that
5934 the PCRE_CASELESS option is set when the matching is required to be
5937 In most cases, when a regular expression is required in an Exim configuration,
5938 it has to start with a circumflex, in order to distinguish it from plain text
5939 or an &"ends with"& wildcard. In this example of a configuration setting, the
5940 second item in the colon-separated list is a regular expression.
5942 domains = a.b.c : ^\\d{3} : *.y.z : ...
5944 The doubling of the backslash is required because of string expansion that
5945 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
5946 of this issue, and a way of avoiding the need for doubling backslashes. The
5947 regular expression that is eventually used in this example contains just one
5948 backslash. The circumflex is included in the regular expression, and has the
5949 normal effect of &"anchoring"& it to the start of the string that is being
5952 There are, however, two cases where a circumflex is not required for the
5953 recognition of a regular expression: these are the &%match%& condition in a
5954 string expansion, and the &%matches%& condition in an Exim filter file. In
5955 these cases, the relevant string is always treated as a regular expression; if
5956 it does not start with a circumflex, the expression is not anchored, and can
5957 match anywhere in the subject string.
5959 In all cases, if you want a regular expression to match at the end of a string,
5960 you must code the $ metacharacter to indicate this. For example:
5962 domains = ^\\d{3}\\.example
5964 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
5967 domains = ^\\d{3}\\.example\$
5969 if you want &'example'& to be the top-level domain. The backslash before the
5970 $ is needed because string expansion also interprets dollar characters.
5974 . ////////////////////////////////////////////////////////////////////////////
5975 . ////////////////////////////////////////////////////////////////////////////
5977 .chapter "File and database lookups" "CHAPfdlookup"
5978 .scindex IIDfidalo1 "file" "lookups"
5979 .scindex IIDfidalo2 "database" "lookups"
5980 .cindex "lookup" "description of"
5981 Exim can be configured to look up data in files or databases as it processes
5982 messages. Two different kinds of syntax are used:
5985 A string that is to be expanded may contain explicit lookup requests. These
5986 cause parts of the string to be replaced by data that is obtained from the
5987 lookup. Lookups of this type are conditional expansion items. Different results
5988 can be defined for the cases of lookup success and failure. See chapter
5989 &<<CHAPexpand>>&, where string expansions are described in detail.
5991 Lists of domains, hosts, and email addresses can contain lookup requests as a
5992 way of avoiding excessively long linear lists. In this case, the data that is
5993 returned by the lookup is often (but not always) discarded; whether the lookup
5994 succeeds or fails is what really counts. These kinds of list are described in
5995 chapter &<<CHAPdomhosaddlists>>&.
5998 String expansions, lists, and lookups interact with each other in such a way
5999 that there is no order in which to describe any one of them that does not
6000 involve references to the others. Each of these three chapters makes more sense
6001 if you have read the other two first. If you are reading this for the first
6002 time, be aware that some of it will make a lot more sense after you have read
6003 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6005 .section "Examples of different lookup syntax" "SECID60"
6006 It is easy to confuse the two different kinds of lookup, especially as the
6007 lists that may contain the second kind are always expanded before being
6008 processed as lists. Therefore, they may also contain lookups of the first kind.
6009 Be careful to distinguish between the following two examples:
6011 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6012 domains = lsearch;/some/file
6014 The first uses a string expansion, the result of which must be a domain list.
6015 No strings have been specified for a successful or a failing lookup; the
6016 defaults in this case are the looked-up data and an empty string, respectively.
6017 The expansion takes place before the string is processed as a list, and the
6018 file that is searched could contain lines like this:
6020 192.168.3.4: domain1:domain2:...
6021 192.168.1.9: domain3:domain4:...
6023 When the lookup succeeds, the result of the expansion is a list of domains (and
6024 possibly other types of item that are allowed in domain lists).
6026 In the second example, the lookup is a single item in a domain list. It causes
6027 Exim to use a lookup to see if the domain that is being processed can be found
6028 in the file. The file could contains lines like this:
6033 Any data that follows the keys is not relevant when checking that the domain
6034 matches the list item.
6036 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6037 Consider a file containing lines like this:
6039 192.168.5.6: lsearch;/another/file
6041 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6042 first &%domains%& setting above generates the second setting, which therefore
6043 causes a second lookup to occur.
6045 The rest of this chapter describes the different lookup types that are
6046 available. Any of them can be used in any part of the configuration where a
6047 lookup is permitted.
6050 .section "Lookup types" "SECID61"
6051 .cindex "lookup" "types of"
6052 .cindex "single-key lookup" "definition of"
6053 Two different types of data lookup are implemented:
6056 The &'single-key'& type requires the specification of a file in which to look,
6057 and a single key to search for. The key must be a non-empty string for the
6058 lookup to succeed. The lookup type determines how the file is searched.
6060 .cindex "query-style lookup" "definition of"
6061 The &'query-style'& type accepts a generalized database query. No particular
6062 key value is assumed by Exim for query-style lookups. You can use whichever
6063 Exim variables you need to construct the database query.
6066 The code for each lookup type is in a separate source file that is included in
6067 the binary of Exim only if the corresponding compile-time option is set. The
6068 default settings in &_src/EDITME_& are:
6073 which means that only linear searching and DBM lookups are included by default.
6074 For some types of lookup (e.g. SQL databases), you need to install appropriate
6075 libraries and header files before building Exim.
6080 .section "Single-key lookup types" "SECTsinglekeylookups"
6081 .cindex "lookup" "single-key types"
6082 .cindex "single-key lookup" "list of types"
6083 The following single-key lookup types are implemented:
6086 .cindex "cdb" "description of"
6087 .cindex "lookup" "cdb"
6088 .cindex "binary zero" "in lookup key"
6089 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6090 string without a terminating binary zero. The cdb format is designed for
6091 indexed files that are read frequently and never updated, except by total
6092 re-creation. As such, it is particularly suitable for large files containing
6093 aliases or other indexed data referenced by an MTA. Information about cdb can
6094 be found in several places:
6096 &url(http://www.pobox.com/~djb/cdb.html)
6097 &url(ftp://ftp.corpit.ru/pub/tinycdb/)
6098 &url(http://packages.debian.org/stable/utils/freecdb.html)
6100 A cdb distribution is not needed in order to build Exim with cdb support,
6101 because the code for reading cdb files is included directly in Exim itself.
6102 However, no means of building or testing cdb files is provided with Exim, so
6103 you need to obtain a cdb distribution in order to do this.
6105 .cindex "DBM" "lookup type"
6106 .cindex "lookup" "dbm"
6107 .cindex "binary zero" "in lookup key"
6108 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6109 DBM file by looking up the record with the given key. A terminating binary
6110 zero is included in the key that is passed to the DBM library. See section
6111 &<<SECTdb>>& for a discussion of DBM libraries.
6113 .cindex "Berkeley DB library" "file format"
6114 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6115 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6116 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6117 the DB_UNKNOWN option. This enables it to handle any of the types of database
6118 that the library supports, and can be useful for accessing DBM files created by
6119 other applications. (For earlier DB versions, DB_HASH is always used.)
6121 .cindex "lookup" "dbmnz"
6122 .cindex "lookup" "dbm &-- terminating zero"
6123 .cindex "binary zero" "in lookup key"
6125 .cindex "&_/etc/userdbshadow.dat_&"
6126 .cindex "dmbnz lookup type"
6127 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6128 is not included in the key that is passed to the DBM library. You may need this
6129 if you want to look up data in files that are created by or shared with some
6130 other application that does not use terminating zeros. For example, you need to
6131 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6132 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6133 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6134 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6136 .cindex "lookup" "dsearch"
6137 .cindex "dsearch lookup type"
6138 &(dsearch)&: The given file must be a directory; this is searched for an entry
6139 whose name is the key by calling the &[lstat()]& function. The key may not
6140 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6141 the lookup is the name of the entry, which may be a file, directory,
6142 symbolic link, or any other kind of directory entry. An example of how this
6143 lookup can be used to support virtual domains is given in section
6144 &<<SECTvirtualdomains>>&.
6146 .cindex "lookup" "iplsearch"
6147 .cindex "iplsearch lookup type"
6148 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6149 terminated by a colon or white space or the end of the line. The keys in the
6150 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6151 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6152 being interpreted as a key terminator. For example:
6154 1.2.3.4: data for 1.2.3.4
6155 192.168.0.0/16: data for 192.168.0.0/16
6156 "abcd::cdab": data for abcd::cdab
6157 "abcd:abcd::/32" data for abcd:abcd::/32
6159 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6160 file is searched linearly, using the CIDR masks where present, until a matching
6161 key is found. The first key that matches is used; there is no attempt to find a
6162 &"best"& match. Apart from the way the keys are matched, the processing for
6163 &(iplsearch)& is the same as for &(lsearch)&.
6165 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6166 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6167 lookup types support only literal keys.
6169 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6170 the implicit key is the host's IP address rather than its name (see section
6171 &<<SECThoslispatsikey>>&).
6173 .cindex "linear search"
6174 .cindex "lookup" "lsearch"
6175 .cindex "lsearch lookup type"
6176 .cindex "case sensitivity" "in lsearch lookup"
6177 &(lsearch)&: The given file is a text file that is searched linearly for a
6178 line beginning with the search key, terminated by a colon or white space or the
6179 end of the line. The search is case-insensitive; that is, upper and lower case
6180 letters are treated as the same. The first occurrence of the key that is found
6181 in the file is used.
6183 White space between the key and the colon is permitted. The remainder of the
6184 line, with leading and trailing white space removed, is the data. This can be
6185 continued onto subsequent lines by starting them with any amount of white
6186 space, but only a single space character is included in the data at such a
6187 junction. If the data begins with a colon, the key must be terminated by a
6192 Empty lines and lines beginning with # are ignored, even if they occur in the
6193 middle of an item. This is the traditional textual format of alias files. Note
6194 that the keys in an &(lsearch)& file are literal strings. There is no
6195 wildcarding of any kind.
6197 .cindex "lookup" "lsearch &-- colons in keys"
6198 .cindex "white space" "in lsearch key"
6199 In most &(lsearch)& files, keys are not required to contain colons or #
6200 characters, or white space. However, if you need this feature, it is available.
6201 If a key begins with a doublequote character, it is terminated only by a
6202 matching quote (or end of line), and the normal escaping rules apply to its
6203 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6204 quoted keys (exactly as for unquoted keys). There is no special handling of
6205 quotes for the data part of an &(lsearch)& line.
6208 .cindex "NIS lookup type"
6209 .cindex "lookup" "NIS"
6210 .cindex "binary zero" "in lookup key"
6211 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6212 the given key, without a terminating binary zero. There is a variant called
6213 &(nis0)& which does include the terminating binary zero in the key. This is
6214 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6215 aliases; the full map names must be used.
6218 .cindex "wildlsearch lookup type"
6219 .cindex "lookup" "wildlsearch"
6220 .cindex "nwildlsearch lookup type"
6221 .cindex "lookup" "nwildlsearch"
6222 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6223 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6224 the file may be wildcarded. The difference between these two lookup types is
6225 that for &(wildlsearch)&, each key in the file is string-expanded before being
6226 used, whereas for &(nwildlsearch)&, no expansion takes place.
6228 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6229 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6230 file that are regular expressions can be made case-sensitive by the use of
6231 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6233 . ==== As this is a nested list, any displays it contains must be indented
6234 . ==== as otherwise they are too far to the left.
6237 The string may begin with an asterisk to mean &"ends with"&. For example:
6239 *.a.b.c data for anything.a.b.c
6240 *fish data for anythingfish
6243 The string may begin with a circumflex to indicate a regular expression. For
6244 example, for &(wildlsearch)&:
6246 ^\N\d+\.a\.b\N data for <digits>.a.b
6248 Note the use of &`\N`& to disable expansion of the contents of the regular
6249 expression. If you are using &(nwildlsearch)&, where the keys are not
6250 string-expanded, the equivalent entry is:
6252 ^\d+\.a\.b data for <digits>.a.b
6254 The case-insensitive flag is set at the start of compiling the regular
6255 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6256 For example, to make the entire pattern case-sensitive:
6258 ^(?-i)\d+\.a\.b data for <digits>.a.b
6261 If the regular expression contains white space or colon characters, you must
6262 either quote it (see &(lsearch)& above), or represent these characters in other
6263 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6264 colon. This may be easier than quoting, because if you quote, you have to
6265 escape all the backslashes inside the quotes.
6267 &*Note*&: It is not possible to capture substrings in a regular expression
6268 match for later use, because the results of all lookups are cached. If a lookup
6269 is repeated, the result is taken from the cache, and no actual pattern matching
6270 takes place. The values of all the numeric variables are unset after a
6271 &((n)wildlsearch)& match.
6274 Although I cannot see it being of much use, the general matching function that
6275 is used to implement &((n)wildlsearch)& means that the string may begin with a
6276 lookup name terminated by a semicolon, and followed by lookup data. For
6279 cdb;/some/file data for keys that match the file
6281 The data that is obtained from the nested lookup is discarded.
6284 Keys that do not match any of these patterns are interpreted literally. The
6285 continuation rules for the data are the same as for &(lsearch)&, and keys may
6286 be followed by optional colons.
6288 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6289 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6290 lookup types support only literal keys.
6294 .section "Query-style lookup types" "SECID62"
6295 .cindex "lookup" "query-style types"
6296 .cindex "query-style lookup" "list of types"
6297 The supported query-style lookup types are listed below. Further details about
6298 many of them are given in later sections.
6301 .cindex "DNS" "as a lookup type"
6302 .cindex "lookup" "DNS"
6303 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6304 are given in the supplied query. The resulting data is the contents of the
6305 records. See section &<<SECTdnsdb>>&.
6307 .cindex "InterBase lookup type"
6308 .cindex "lookup" "InterBase"
6309 &(ibase)&: This does a lookup in an InterBase database.
6311 .cindex "LDAP" "lookup type"
6312 .cindex "lookup" "LDAP"
6313 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6314 returns attributes from a single entry. There is a variant called &(ldapm)&
6315 that permits values from multiple entries to be returned. A third variant
6316 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6317 any attribute values. See section &<<SECTldap>>&.
6319 .cindex "MySQL" "lookup type"
6320 .cindex "lookup" "MySQL"
6321 &(mysql)&: The format of the query is an SQL statement that is passed to a
6322 MySQL database. See section &<<SECTsql>>&.
6324 .cindex "NIS+ lookup type"
6325 .cindex "lookup" "NIS+"
6326 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6327 the field to be returned. See section &<<SECTnisplus>>&.
6329 .cindex "Oracle" "lookup type"
6330 .cindex "lookup" "Oracle"
6331 &(oracle)&: The format of the query is an SQL statement that is passed to an
6332 Oracle database. See section &<<SECTsql>>&.
6334 .cindex "lookup" "passwd"
6335 .cindex "passwd lookup type"
6336 .cindex "&_/etc/passwd_&"
6337 &(passwd)& is a query-style lookup with queries that are just user names. The
6338 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6339 success, the result string is the same as you would get from an &(lsearch)&
6340 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6341 password value. For example:
6343 *:42:42:King Rat:/home/kr:/bin/bash
6346 .cindex "PostgreSQL lookup type"
6347 .cindex "lookup" "PostgreSQL"
6348 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6349 PostgreSQL database. See section &<<SECTsql>>&.
6352 .cindex "sqlite lookup type"
6353 .cindex "lookup" "sqlite"
6354 &(sqlite)&: The format of the query is a file name followed by an SQL statement
6355 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6358 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6359 not likely to be useful in normal operation.
6361 .cindex "whoson lookup type"
6362 .cindex "lookup" "whoson"
6363 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6364 allows a server to check whether a particular (dynamically allocated) IP
6365 address is currently allocated to a known (trusted) user and, optionally, to
6366 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6367 at one time for &"POP before SMTP"& authentication, but that approach has been
6368 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6369 &"POP before SMTP"& checking using ACL statements such as
6371 require condition = \
6372 ${lookup whoson {$sender_host_address}{yes}{no}}
6374 The query consists of a single IP address. The value returned is the name of
6375 the authenticated user, which is stored in the variable &$value$&. However, in
6376 this example, the data in &$value$& is not used; the result of the lookup is
6377 one of the fixed strings &"yes"& or &"no"&.
6382 .section "Temporary errors in lookups" "SECID63"
6383 .cindex "lookup" "temporary error in"
6384 Lookup functions can return temporary error codes if the lookup cannot be
6385 completed. For example, an SQL or LDAP database might be unavailable. For this
6386 reason, it is not advisable to use a lookup that might do this for critical
6387 options such as a list of local domains.
6389 When a lookup cannot be completed in a router or transport, delivery
6390 of the message (to the relevant address) is deferred, as for any other
6391 temporary error. In other circumstances Exim may assume the lookup has failed,
6392 or may give up altogether.
6396 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
6397 .cindex "wildcard lookups"
6398 .cindex "lookup" "default values"
6399 .cindex "lookup" "wildcard"
6400 .cindex "lookup" "* added to type"
6401 .cindex "default" "in single-key lookups"
6402 In this context, a &"default value"& is a value specified by the administrator
6403 that is to be used if a lookup fails.
6405 &*Note:*& This section applies only to single-key lookups. For query-style
6406 lookups, the facilities of the query language must be used. An attempt to
6407 specify a default for a query-style lookup provokes an error.
6409 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
6410 and the initial lookup fails, the key &"*"& is looked up in the file to
6411 provide a default value. See also the section on partial matching below.
6413 .cindex "*@ with single-key lookup"
6414 .cindex "lookup" "*@ added to type"
6415 .cindex "alias file" "per-domain default"
6416 Alternatively, if &"*@"& is added to a single-key lookup type (for example
6417 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
6418 character, a second lookup is done with everything before the last @ replaced
6419 by *. This makes it possible to provide per-domain defaults in alias files
6420 that include the domains in the keys. If the second lookup fails (or doesn't
6421 take place because there is no @ in the key), &"*"& is looked up.
6422 For example, a &(redirect)& router might contain:
6424 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
6426 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
6427 looks up these keys, in this order:
6433 The data is taken from whichever key it finds first. &*Note*&: In an
6434 &(lsearch)& file, this does not mean the first of these keys in the file. A
6435 complete scan is done for each key, and only if it is not found at all does
6436 Exim move on to try the next key.
6440 .section "Partial matching in single-key lookups" "SECTpartiallookup"
6441 .cindex "partial matching"
6442 .cindex "wildcard lookups"
6443 .cindex "lookup" "partial matching"
6444 .cindex "lookup" "wildcard"
6445 .cindex "asterisk" "in search type"
6446 The normal operation of a single-key lookup is to search the file for an exact
6447 match with the given key. However, in a number of situations where domains are
6448 being looked up, it is useful to be able to do partial matching. In this case,
6449 information in the file that has a key starting with &"*."& is matched by any
6450 domain that ends with the components that follow the full stop. For example, if
6451 a key in a DBM file is
6453 *.dates.fict.example
6455 then when partial matching is enabled this is matched by (amongst others)
6456 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
6457 by &'dates.fict.example'&, if that does not appear as a separate key in the
6460 &*Note*&: Partial matching is not available for query-style lookups. It is
6461 also not available for any lookup items in address lists (see section
6462 &<<SECTaddresslist>>&).
6464 Partial matching is implemented by doing a series of separate lookups using
6465 keys constructed by modifying the original subject key. This means that it can
6466 be used with any of the single-key lookup types, provided that
6467 partial matching keys
6468 beginning with a special prefix (default &"*."&) are included in the data file.
6469 Keys in the file that do not begin with the prefix are matched only by
6470 unmodified subject keys when partial matching is in use.
6472 Partial matching is requested by adding the string &"partial-"& to the front of
6473 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
6474 is done, the subject key is first looked up unmodified; if that fails, &"*."&
6475 is added at the start of the subject key, and it is looked up again. If that
6476 fails, further lookups are tried with dot-separated components removed from the
6477 start of the subject key, one-by-one, and &"*."& added on the front of what
6480 A minimum number of two non-* components are required. This can be adjusted
6481 by including a number before the hyphen in the search type. For example,
6482 &%partial3-lsearch%& specifies a minimum of three non-* components in the
6483 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
6484 subject key is &'2250.dates.fict.example'& then the following keys are looked
6485 up when the minimum number of non-* components is two:
6487 2250.dates.fict.example
6488 *.2250.dates.fict.example
6489 *.dates.fict.example
6492 As soon as one key in the sequence is successfully looked up, the lookup
6495 .cindex "lookup" "partial matching &-- changing prefix"
6496 .cindex "prefix" "for partial matching"
6497 The use of &"*."& as the partial matching prefix is a default that can be
6498 changed. The motivation for this feature is to allow Exim to operate with file
6499 formats that are used by other MTAs. A different prefix can be supplied in
6500 parentheses instead of the hyphen after &"partial"&. For example:
6502 domains = partial(.)lsearch;/some/file
6504 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
6505 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
6506 components is unchanged). The prefix may consist of any punctuation characters
6507 other than a closing parenthesis. It may be empty, for example:
6509 domains = partial1()cdb;/some/file
6511 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
6512 &`a.b.c`&, &`b.c`&, and &`c`&.
6514 If &"partial0"& is specified, what happens at the end (when the lookup with
6515 just one non-wild component has failed, and the original key is shortened right
6516 down to the null string) depends on the prefix:
6519 If the prefix has zero length, the whole lookup fails.
6521 If the prefix has length 1, a lookup for just the prefix is done. For
6522 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
6524 Otherwise, if the prefix ends in a dot, the dot is removed, and the
6525 remainder is looked up. With the default prefix, therefore, the final lookup is
6526 for &"*"& on its own.
6528 Otherwise, the whole prefix is looked up.
6532 If the search type ends in &"*"& or &"*@"& (see section
6533 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
6534 this implies happens after all partial lookups have failed. If &"partial0"& is
6535 specified, adding &"*"& to the search type has no effect with the default
6536 prefix, because the &"*"& key is already included in the sequence of partial
6537 lookups. However, there might be a use for lookup types such as
6538 &"partial0(.)lsearch*"&.
6540 The use of &"*"& in lookup partial matching differs from its use as a wildcard
6541 in domain lists and the like. Partial matching works only in terms of
6542 dot-separated components; a key such as &`*fict.example`&
6543 in a database file is useless, because the asterisk in a partial matching
6544 subject key is always followed by a dot.
6549 .section "Lookup caching" "SECID64"
6550 .cindex "lookup" "caching"
6551 .cindex "caching" "lookup data"
6552 Exim caches all lookup results in order to avoid needless repetition of
6553 lookups. However, because (apart from the daemon) Exim operates as a collection
6554 of independent, short-lived processes, this caching applies only within a
6555 single Exim process. There is no inter-process lookup caching facility.
6557 For single-key lookups, Exim keeps the relevant files open in case there is
6558 another lookup that needs them. In some types of configuration this can lead to
6559 many files being kept open for messages with many recipients. To avoid hitting
6560 the operating system limit on the number of simultaneously open files, Exim
6561 closes the least recently used file when it needs to open more files than its
6562 own internal limit, which can be changed via the &%lookup_open_max%& option.
6564 The single-key lookup files are closed and the lookup caches are flushed at
6565 strategic points during delivery &-- for example, after all routing is
6571 .section "Quoting lookup data" "SECID65"
6572 .cindex "lookup" "quoting"
6573 .cindex "quoting" "in lookups"
6574 When data from an incoming message is included in a query-style lookup, there
6575 is the possibility of special characters in the data messing up the syntax of
6576 the query. For example, a NIS+ query that contains
6580 will be broken if the local part happens to contain a closing square bracket.
6581 For NIS+, data can be enclosed in double quotes like this:
6583 [name="$local_part"]
6585 but this still leaves the problem of a double quote in the data. The rule for
6586 NIS+ is that double quotes must be doubled. Other lookup types have different
6587 rules, and to cope with the differing requirements, an expansion operator
6588 of the following form is provided:
6590 ${quote_<lookup-type>:<string>}
6592 For example, the safest way to write the NIS+ query is
6594 [name="${quote_nisplus:$local_part}"]
6596 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
6597 operator can be used for all lookup types, but has no effect for single-key
6598 lookups, since no quoting is ever needed in their key strings.
6603 .section "More about dnsdb" "SECTdnsdb"
6604 .cindex "dnsdb lookup"
6605 .cindex "lookup" "dnsdb"
6606 .cindex "DNS" "as a lookup type"
6607 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
6608 of a record type and a domain name, separated by an equals sign. For example,
6609 an expansion string could contain:
6611 ${lookup dnsdb{mx=a.b.example}{$value}fail}
6613 If the lookup succeeds, the result is placed in &$value$&, which in this case
6614 is used on its own as the result. If the lookup does not succeed, the
6615 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
6616 &<<SECTforexpfai>>& for an explanation of what this means.
6618 The supported DNS record types are A, CNAME, MX, NS, PTR, SRV, and TXT, and,
6619 when Exim is compiled with IPv6 support, AAAA (and A6 if that is also
6620 configured). If no type is given, TXT is assumed. When the type is PTR,
6621 the data can be an IP address, written as normal; inversion and the addition of
6622 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
6624 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
6626 If the data for a PTR record is not a syntactically valid IP address, it is not
6627 altered and nothing is added.
6629 .cindex "MX record" "in &(dnsdb)& lookup"
6630 .cindex "SRV record" "in &(dnsdb)& lookup"
6631 For an MX lookup, both the preference value and the host name are returned for
6632 each record, separated by a space. For an SRV lookup, the priority, weight,
6633 port, and host name are returned for each record, separated by spaces.
6635 For any record type, if multiple records are found (or, for A6 lookups, if a
6636 single record leads to multiple addresses), the data is returned as a
6637 concatenation, with newline as the default separator. The order, of course,
6638 depends on the DNS resolver. You can specify a different separator character
6639 between multiple records by putting a right angle-bracket followed immediately
6640 by the new separator at the start of the query. For example:
6642 ${lookup dnsdb{>: a=host1.example}}
6644 It is permitted to specify a space as the separator character. Further
6645 white space is ignored.
6648 .cindex "TXT record" "in &(dnsdb)& lookup"
6649 For TXT records with multiple items of data, only the first item is returned,
6650 unless a separator for them is specified using a comma after the separator
6651 character followed immediately by the TXT record item separator. To concatenate
6652 items without a separator, use a semicolon instead.
6654 ${lookup dnsdb{>\n,: txt=a.b.example}}
6655 ${lookup dnsdb{>\n; txt=a.b.example}}
6657 It is permitted to specify a space as the separator character. Further
6658 white space is ignored.
6661 .section "Pseudo dnsdb record types" "SECID66"
6662 .cindex "MX record" "in &(dnsdb)& lookup"
6663 By default, both the preference value and the host name are returned for
6664 each MX record, separated by a space. If you want only host names, you can use
6665 the pseudo-type MXH:
6667 ${lookup dnsdb{mxh=a.b.example}}
6669 In this case, the preference values are omitted, and just the host names are
6672 .cindex "name server for enclosing domain"
6673 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
6674 records on the given domain, but if none are found, it removes the first
6675 component of the domain name, and tries again. This process continues until NS
6676 records are found or there are no more components left (or there is a DNS
6677 error). In other words, it may return the name servers for a top-level domain,
6678 but it never returns the root name servers. If there are no NS records for the
6679 top-level domain, the lookup fails. Consider these examples:
6681 ${lookup dnsdb{zns=xxx.quercite.com}}
6682 ${lookup dnsdb{zns=xxx.edu}}
6684 Assuming that in each case there are no NS records for the full domain name,
6685 the first returns the name servers for &%quercite.com%&, and the second returns
6686 the name servers for &%edu%&.
6688 You should be careful about how you use this lookup because, unless the
6689 top-level domain does not exist, the lookup always returns some host names. The
6690 sort of use to which this might be put is for seeing if the name servers for a
6691 given domain are on a blacklist. You can probably assume that the name servers
6692 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
6695 .cindex "CSA" "in &(dnsdb)& lookup"
6696 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
6697 records according to the CSA rules, which are described in section
6698 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
6699 not sufficient because of the extra parent domain search behaviour of CSA. The
6700 result of a successful lookup such as:
6702 ${lookup dnsdb {csa=$sender_helo_name}}
6704 has two space-separated fields: an authorization code and a target host name.
6705 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
6706 authorization required but absent, or &"?"& for unknown.
6709 .section "Multiple dnsdb lookups" "SECID67"
6710 In the previous sections, &(dnsdb)& lookups for a single domain are described.
6711 However, you can specify a list of domains or IP addresses in a single
6712 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
6713 the default separator, but with the ability to change this. For example:
6715 ${lookup dnsdb{one.domain.com:two.domain.com}}
6716 ${lookup dnsdb{a=one.host.com:two.host.com}}
6717 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
6719 In order to retain backwards compatibility, there is one special case: if
6720 the lookup type is PTR and no change of separator is specified, Exim looks
6721 to see if the rest of the string is precisely one IPv6 address. In this
6722 case, it does not treat it as a list.
6724 The data from each lookup is concatenated, with newline separators by default,
6725 in the same way that multiple DNS records for a single item are handled. A
6726 different separator can be specified, as described above.
6728 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
6729 temporary DNS error for any of them, the behaviour is controlled by
6730 an optional keyword followed by a comma that may appear before the record
6731 type. The possible keywords are &"defer_strict"&, &"defer_never"&, and
6732 &"defer_lax"&. With &"strict"& behaviour, any temporary DNS error causes the
6733 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
6734 ignored, and the behaviour is as if the DNS lookup failed to find anything.
6735 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
6736 error causes the whole lookup to defer only if none of the other lookups
6737 succeed. The default is &"lax"&, so the following lookups are equivalent:
6739 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
6740 ${lookup dnsdb{a=one.host.com:two.host.com}}
6742 Thus, in the default case, as long as at least one of the DNS lookups
6743 yields some data, the lookup succeeds.
6748 .section "More about LDAP" "SECTldap"
6749 .cindex "LDAP" "lookup, more about"
6750 .cindex "lookup" "LDAP"
6751 .cindex "Solaris" "LDAP"
6752 The original LDAP implementation came from the University of Michigan; this has
6753 become &"Open LDAP"&, and there are now two different releases. Another
6754 implementation comes from Netscape, and Solaris 7 and subsequent releases
6755 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
6756 the lookup function level, their error handling is different. For this reason
6757 it is necessary to set a compile-time variable when building Exim with LDAP, to
6758 indicate which LDAP library is in use. One of the following should appear in
6759 your &_Local/Makefile_&:
6761 LDAP_LIB_TYPE=UMICHIGAN
6762 LDAP_LIB_TYPE=OPENLDAP1
6763 LDAP_LIB_TYPE=OPENLDAP2
6764 LDAP_LIB_TYPE=NETSCAPE
6765 LDAP_LIB_TYPE=SOLARIS
6767 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
6768 same interface as the University of Michigan version.
6770 There are three LDAP lookup types in Exim. These behave slightly differently in
6771 the way they handle the results of a query:
6774 &(ldap)& requires the result to contain just one entry; if there are more, it
6777 &(ldapdn)& also requires the result to contain just one entry, but it is the
6778 Distinguished Name that is returned rather than any attribute values.
6780 &(ldapm)& permits the result to contain more than one entry; the attributes
6781 from all of them are returned.
6785 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
6786 Exim behaves as if the entry did not exist, and the lookup fails. The format of
6787 the data returned by a successful lookup is described in the next section.
6788 First we explain how LDAP queries are coded.
6791 .section "Format of LDAP queries" "SECTforldaque"
6792 .cindex "LDAP" "query format"
6793 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
6794 the configuration of a &(redirect)& router one might have this setting:
6796 data = ${lookup ldap \
6797 {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
6798 c=UK?mailbox?base?}}
6800 .cindex "LDAP" "with TLS"
6801 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
6802 secure (encrypted) LDAP connections. The second of these ensures that an
6803 encrypted TLS connection is used.
6806 .section "LDAP quoting" "SECID68"
6807 .cindex "LDAP" "quoting"
6808 Two levels of quoting are required in LDAP queries, the first for LDAP itself
6809 and the second because the LDAP query is represented as a URL. Furthermore,
6810 within an LDAP query, two different kinds of quoting are required. For this
6811 reason, there are two different LDAP-specific quoting operators.
6813 The &%quote_ldap%& operator is designed for use on strings that are part of
6814 filter specifications. Conceptually, it first does the following conversions on
6822 in accordance with RFC 2254. The resulting string is then quoted according
6823 to the rules for URLs, that is, all non-alphanumeric characters except
6827 are converted to their hex values, preceded by a percent sign. For example:
6829 ${quote_ldap: a(bc)*, a<yz>; }
6833 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
6835 Removing the URL quoting, this is (with a leading and a trailing space):
6837 a\28bc\29\2A, a<yz>;
6839 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
6840 base DN specifications in queries. Conceptually, it first converts the string
6841 by inserting a backslash in front of any of the following characters:
6845 It also inserts a backslash before any leading spaces or # characters, and
6846 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
6847 is then quoted according to the rules for URLs. For example:
6849 ${quote_ldap_dn: a(bc)*, a<yz>; }
6853 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
6855 Removing the URL quoting, this is (with a trailing space):
6857 \ a(bc)*\, a\<yz\>\;\
6859 There are some further comments about quoting in the section on LDAP
6860 authentication below.
6863 .section "LDAP connections" "SECID69"
6864 .cindex "LDAP" "connections"
6865 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
6866 is in use, via a Unix domain socket. The example given above does not specify
6867 an LDAP server. A server that is reached by TCP/IP can be specified in a query
6870 ldap://<hostname>:<port>/...
6872 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
6873 used. When no server is specified in a query, a list of default servers is
6874 taken from the &%ldap_default_servers%& configuration option. This supplies a
6875 colon-separated list of servers which are tried in turn until one successfully
6876 handles a query, or there is a serious error. Successful handling either
6877 returns the requested data, or indicates that it does not exist. Serious errors
6878 are syntactical, or multiple values when only a single value is expected.
6879 Errors which cause the next server to be tried are connection failures, bind
6880 failures, and timeouts.
6882 For each server name in the list, a port number can be given. The standard way
6883 of specifying a host and port is to use a colon separator (RFC 1738). Because
6884 &%ldap_default_servers%& is a colon-separated list, such colons have to be
6885 doubled. For example
6887 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
6889 If &%ldap_default_servers%& is unset, a URL with no server name is passed
6890 to the LDAP library with no server name, and the library's default (normally
6891 the local host) is used.
6893 If you are using the OpenLDAP library, you can connect to an LDAP server using
6894 a Unix domain socket instead of a TCP/IP connection. This is specified by using
6895 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
6896 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
6899 For this type of connection, instead of a host name for the server, a pathname
6900 for the socket is required, and the port number is not relevant. The pathname
6901 can be specified either as an item in &%ldap_default_servers%&, or inline in
6902 the query. In the former case, you can have settings such as
6904 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
6906 When the pathname is given in the query, you have to escape the slashes as
6907 &`%2F`& to fit in with the LDAP URL syntax. For example:
6909 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
6911 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
6912 a pathname, it uses the Unix domain socket code, even if the query actually
6913 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
6914 socket connection. This behaviour means that you can use a setting of
6915 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
6916 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
6917 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
6920 If an explicit &`ldapi`& type is given in a query when a host name is
6921 specified, an error is diagnosed. However, if there are more items in
6922 &%ldap_default_servers%&, they are tried. In other words:
6925 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
6928 Using &`ldapi`& with a host name causes an error.
6932 Using &`ldapi`& with no host or path in the query, and no setting of
6933 &%ldap_default_servers%&, does whatever the library does by default.
6937 .section "LDAP authentication and control information" "SECID70"
6938 .cindex "LDAP" "authentication"
6939 The LDAP URL syntax provides no way of passing authentication and other control
6940 information to the server. To make this possible, the URL in an LDAP query may
6941 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
6942 spaces. If a value contains spaces it must be enclosed in double quotes, and
6943 when double quotes are used, backslash is interpreted in the usual way inside
6944 them. The following names are recognized:
6946 &`DEREFERENCE`& set the dereferencing parameter
6947 &`NETTIME `& set a timeout for a network operation
6948 &`USER `& set the DN, for authenticating the LDAP bind
6949 &`PASS `& set the password, likewise
6950 &`REFERRALS `& set the referrals parameter
6951 &`SIZE `& set the limit for the number of entries returned
6952 &`TIME `& set the maximum waiting time for a query
6954 The value of the DEREFERENCE parameter must be one of the words &"never"&,
6955 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
6956 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
6957 library from trying to follow referrals issued by the LDAP server.
6959 The name CONNECT is an obsolete name for NETTIME, retained for
6960 backwards compatibility. This timeout (specified as a number of seconds) is
6961 enforced from the client end for operations that can be carried out over a
6962 network. Specifically, it applies to network connections and calls to the
6963 &'ldap_result()'& function. If the value is greater than zero, it is used if
6964 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
6965 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
6966 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
6967 Netscape SDK; for OpenLDAP no action is taken.
6969 The TIME parameter (also a number of seconds) is passed to the server to
6970 set a server-side limit on the time taken to complete a search.
6973 Here is an example of an LDAP query in an Exim lookup that uses some of these
6974 values. This is a single line, folded to fit on the page:
6977 {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
6978 ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
6981 The encoding of spaces as &`%20`& is a URL thing which should not be done for
6982 any of the auxiliary data. Exim configuration settings that include lookups
6983 which contain password information should be preceded by &"hide"& to prevent
6984 non-admin users from using the &%-bP%& option to see their values.
6986 The auxiliary data items may be given in any order. The default is no
6987 connection timeout (the system timeout is used), no user or password, no limit
6988 on the number of entries returned, and no time limit on queries.
6990 When a DN is quoted in the USER= setting for LDAP authentication, Exim
6991 removes any URL quoting that it may contain before passing it LDAP. Apparently
6992 some libraries do this for themselves, but some do not. Removing the URL
6993 quoting has two advantages:
6996 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
6997 DNs as with DNs inside actual queries.
6999 It permits spaces inside USER= DNs.
7002 For example, a setting such as
7004 USER=cn=${quote_ldap_dn:$1}
7006 should work even if &$1$& contains spaces.
7008 Expanded data for the PASS= value should be quoted using the &%quote%&
7009 expansion operator, rather than the LDAP quote operators. The only reason this
7010 field needs quoting is to ensure that it conforms to the Exim syntax, which
7011 does not allow unquoted spaces. For example:
7015 The LDAP authentication mechanism can be used to check passwords as part of
7016 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7021 .section "Format of data returned by LDAP" "SECID71"
7022 .cindex "LDAP" "returned data formats"
7023 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7024 as a sequence of values, for example
7026 cn=manager, o=University of Cambridge, c=UK
7028 The &(ldap)& lookup type generates an error if more than one entry matches the
7029 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7030 the result between the data from different entries. It is possible for multiple
7031 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7032 you know that whatever values are returned all came from a single entry in the
7035 In the common case where you specify a single attribute in your LDAP query, the
7036 result is not quoted, and does not contain the attribute name. If the attribute
7037 has multiple values, they are separated by commas.
7039 If you specify multiple attributes, the result contains space-separated, quoted
7040 strings, each preceded by the attribute name and an equals sign. Within the
7041 quotes, the quote character, backslash, and newline are escaped with
7042 backslashes, and commas are used to separate multiple values for the attribute.
7043 Apart from the escaping, the string within quotes takes the same form as the
7044 output when a single attribute is requested. Specifying no attributes is the
7045 same as specifying all of an entry's attributes.
7047 Here are some examples of the output format. The first line of each pair is an
7048 LDAP query, and the second is the data that is returned. The attribute called
7049 &%attr1%& has two values, whereas &%attr2%& has only one value:
7051 ldap:///o=base?attr1?sub?(uid=fred)
7054 ldap:///o=base?attr2?sub?(uid=fred)
7057 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7058 attr1="value1.1, value1.2" attr2="value two"
7060 ldap:///o=base??sub?(uid=fred)
7061 objectClass="top" attr1="value1.1, value1.2" attr2="value two"
7063 The &%extract%& operator in string expansions can be used to pick out
7064 individual fields from data that consists of &'key'&=&'value'& pairs. You can
7065 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7066 results of LDAP lookups.
7071 .section "More about NIS+" "SECTnisplus"
7072 .cindex "NIS+ lookup type"
7073 .cindex "lookup" "NIS+"
7074 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7075 and field name. If this is given, the result of a successful query is the
7076 contents of the named field; otherwise the result consists of a concatenation
7077 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7078 values containing spaces are quoted. For example, the query
7080 [name=mg1456],passwd.org_dir
7082 might return the string
7084 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7085 home=/home/mg1456 shell=/bin/bash shadow=""
7087 (split over two lines here to fit on the page), whereas
7089 [name=mg1456],passwd.org_dir:gcos
7095 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7096 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7097 operator is to double any quote characters within the text.
7101 .section "SQL lookups" "SECTsql"
7102 .cindex "SQL lookup types"
7103 .cindex "MySQL" "lookup type"
7104 .cindex "PostgreSQL lookup type"
7105 .cindex "lookup" "MySQL"
7106 .cindex "lookup" "PostgreSQL"
7107 .cindex "Oracle" "lookup type"
7108 .cindex "lookup" "Oracle"
7109 .cindex "InterBase lookup type"
7110 .cindex "lookup" "InterBase"
7111 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, and SQLite
7112 databases. Queries for these databases contain SQL statements, so an example
7115 ${lookup mysql{select mailbox from users where id='userx'}\
7118 If the result of the query contains more than one field, the data for each
7119 field in the row is returned, preceded by its name, so the result of
7121 ${lookup pgsql{select home,name from users where id='userx'}\
7126 home=/home/userx name="Mister X"
7128 Empty values and values containing spaces are double quoted, with embedded
7129 quotes escaped by a backslash. If the result of the query contains just one
7130 field, the value is passed back verbatim, without a field name, for example:
7134 If the result of the query yields more than one row, it is all concatenated,
7135 with a newline between the data for each row.
7138 .section "More about MySQL, PostgreSQL, Oracle, and InterBase" "SECID72"
7139 .cindex "MySQL" "lookup type"
7140 .cindex "PostgreSQL lookup type"
7141 .cindex "lookup" "MySQL"
7142 .cindex "lookup" "PostgreSQL"
7143 .cindex "Oracle" "lookup type"
7144 .cindex "lookup" "Oracle"
7145 .cindex "InterBase lookup type"
7146 .cindex "lookup" "InterBase"
7147 If any MySQL, PostgreSQL, Oracle, or InterBase lookups are used, the
7148 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, or &%ibase_servers%&
7149 option (as appropriate) must be set to a colon-separated list of server
7151 (For MySQL and PostgreSQL only, the global option need not be set if all
7152 queries contain their own server information &-- see section
7153 &<<SECTspeserque>>&.) Each item in the list is a slash-separated list of four
7154 items: host name, database name, user name, and password. In the case of
7155 Oracle, the host name field is used for the &"service name"&, and the database
7156 name field is not used and should be empty. For example:
7158 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7160 Because password data is sensitive, you should always precede the setting with
7161 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7162 option. Here is an example where two MySQL servers are listed:
7164 hide mysql_servers = localhost/users/root/secret:\
7165 otherhost/users/root/othersecret
7167 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7168 because this is a colon-separated list, the colon has to be doubled. For each
7169 query, these parameter groups are tried in order until a connection is made and
7170 a query is successfully processed. The result of a query may be that no data is
7171 found, but that is still a successful query. In other words, the list of
7172 servers provides a backup facility, not a list of different places to look.
7174 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7175 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7176 respectively, and the characters single-quote, double-quote, and backslash
7177 itself are escaped with backslashes. The &%quote_pgsql%& expansion operator, in
7178 addition, escapes the percent and underscore characters. This cannot be done
7179 for MySQL because these escapes are not recognized in contexts where these
7180 characters are not special.
7182 .section "Specifying the server in the query" "SECTspeserque"
7183 For MySQL and PostgreSQL lookups (but not currently for Oracle and InterBase),
7184 it is possible to specify a list of servers with an individual query. This is
7185 done by starting the query with
7187 &`servers=`&&'server1:server2:server3:...'&&`;`&
7189 Each item in the list may take one of two forms:
7191 If it contains no slashes it is assumed to be just a host name. The appropriate
7192 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7193 of the same name, and the remaining parameters (database, user, password) are
7196 If it contains any slashes, it is taken as a complete parameter set.
7198 The list of servers is used in exactly the same way as the global list.
7199 Once a connection to a server has happened and a query has been
7200 successfully executed, processing of the lookup ceases.
7202 This feature is intended for use in master/slave situations where updates
7203 are occurring and you want to update the master rather than a slave. If the
7204 master is in the list as a backup for reading, you might have a global setting
7207 mysql_servers = slave1/db/name/pw:\
7211 In an updating lookup, you could then write:
7213 ${lookup mysql{servers=master; UPDATE ...} }
7215 That query would then be sent only to the master server. If, on the other hand,
7216 the master is not to be used for reading, and so is not present in the global
7217 option, you can still update it by a query of this form:
7219 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7223 .section "Special MySQL features" "SECID73"
7224 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7225 causes a connection to the server on the local host by means of a Unix domain
7226 socket. An alternate socket can be specified in parentheses. The full syntax of
7227 each item in &%mysql_servers%& is:
7229 <&'hostname'&>::<&'port'&>(<&'socket name'&>)/<&'database'&>/&&&
7230 <&'user'&>/<&'password'&>
7232 Any of the three sub-parts of the first field can be omitted. For normal use on
7233 the local host it can be left blank or set to just &"localhost"&.
7235 No database need be supplied &-- but if it is absent here, it must be given in
7238 If a MySQL query is issued that does not request any data (an insert, update,
7239 or delete command), the result of the lookup is the number of rows affected.
7241 &*Warning*&: This can be misleading. If an update does not actually change
7242 anything (for example, setting a field to the value it already has), the result
7243 is zero because no rows are affected.
7246 .section "Special PostgreSQL features" "SECID74"
7247 PostgreSQL lookups can also use Unix domain socket connections to the database.
7248 This is usually faster and costs less CPU time than a TCP/IP connection.
7249 However it can be used only if the mail server runs on the same machine as the
7250 database server. A configuration line for PostgreSQL via Unix domain sockets
7253 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7255 In other words, instead of supplying a host name, a path to the socket is
7256 given. The path name is enclosed in parentheses so that its slashes aren't
7257 visually confused with the delimiters for the other server parameters.
7259 If a PostgreSQL query is issued that does not request any data (an insert,
7260 update, or delete command), the result of the lookup is the number of rows
7263 .section "More about SQLite" "SECTsqlite"
7264 .cindex "lookup" "SQLite"
7265 .cindex "sqlite lookup type"
7266 SQLite is different to the other SQL lookups because a file name is required in
7267 addition to the SQL query. An SQLite database is a single file, and there is no
7268 daemon as in the other SQL databases. The interface to Exim requires the name
7269 of the file, as an absolute path, to be given at the start of the query. It is
7270 separated from the query by white space. This means that the path name cannot
7271 contain white space. Here is a lookup expansion example:
7273 ${lookup sqlite {/some/thing/sqlitedb \
7274 select name from aliases where id='userx';}}
7276 In a list, the syntax is similar. For example:
7278 domainlist relay_domains = sqlite;/some/thing/sqlitedb \
7279 select * from relays where ip='$sender_host_address';
7281 The only character affected by the &%quote_sqlite%& operator is a single
7282 quote, which it doubles.
7284 The SQLite library handles multiple simultaneous accesses to the database
7285 internally. Multiple readers are permitted, but only one process can
7286 update at once. Attempts to access the database while it is being updated
7287 are rejected after a timeout period, during which the SQLite library
7288 waits for the lock to be released. In Exim, the default timeout is set
7289 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7295 . ////////////////////////////////////////////////////////////////////////////
7296 . ////////////////////////////////////////////////////////////////////////////
7298 .chapter "Domain, host, address, and local part lists" &&&
7299 "CHAPdomhosaddlists" &&&
7300 "Domain, host, and address lists"
7301 .scindex IIDdohoadli "lists of domains; hosts; etc."
7302 A number of Exim configuration options contain lists of domains, hosts,
7303 email addresses, or local parts. For example, the &%hold_domains%& option
7304 contains a list of domains whose delivery is currently suspended. These lists
7305 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7306 arguments to expansion conditions such as &%match_domain%&.
7308 Each item in one of these lists is a pattern to be matched against a domain,
7309 host, email address, or local part, respectively. In the sections below, the
7310 different types of pattern for each case are described, but first we cover some
7311 general facilities that apply to all four kinds of list.
7315 .section "Expansion of lists" "SECID75"
7316 .cindex "expansion" "of lists"
7317 Each list is expanded as a single string before it is used. The result of
7318 expansion must be a list, possibly containing empty items, which is split up
7319 into separate items for matching. By default, colon is the separator character,
7320 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7321 &<<SECTempitelis>>& for details of the list syntax; the second of these
7322 discusses the way to specify empty list items.
7325 If the string expansion is forced to fail, Exim behaves as if the item it is
7326 testing (domain, host, address, or local part) is not in the list. Other
7327 expansion failures cause temporary errors.
7329 If an item in a list is a regular expression, backslashes, dollars and possibly
7330 other special characters in the expression must be protected against
7331 misinterpretation by the string expander. The easiest way to do this is to use
7332 the &`\N`& expansion feature to indicate that the contents of the regular
7333 expression should not be expanded. For example, in an ACL you might have:
7335 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7336 ${lookup{$domain}lsearch{/badsenders/bydomain}}
7338 The first item is a regular expression that is protected from expansion by
7339 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7340 senders based on the receiving domain.
7345 .section "Negated items in lists" "SECID76"
7346 .cindex "list" "negation"
7347 .cindex "negation" "in lists"
7348 Items in a list may be positive or negative. Negative items are indicated by a
7349 leading exclamation mark, which may be followed by optional white space. A list
7350 defines a set of items (domains, etc). When Exim processes one of these lists,
7351 it is trying to find out whether a domain, host, address, or local part
7352 (respectively) is in the set that is defined by the list. It works like this:
7354 The list is scanned from left to right. If a positive item is matched, the
7355 subject that is being checked is in the set; if a negative item is matched, the
7356 subject is not in the set. If the end of the list is reached without the
7357 subject having matched any of the patterns, it is in the set if the last item
7358 was a negative one, but not if it was a positive one. For example, the list in
7360 domainlist relay_domains = !a.b.c : *.b.c
7362 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7363 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7364 list is positive. However, if the setting were
7366 domainlist relay_domains = !a.b.c
7368 then all domains other than &'a.b.c'& would match because the last item in the
7369 list is negative. In other words, a list that ends with a negative item behaves
7370 as if it had an extra item &`:*`& on the end.
7372 Another way of thinking about positive and negative items in lists is to read
7373 the connector as &"or"& after a positive item and as &"and"& after a negative
7378 .section "File names in lists" "SECTfilnamlis"
7379 .cindex "list" "file name in"
7380 If an item in a domain, host, address, or local part list is an absolute file
7381 name (beginning with a slash character), each line of the file is read and
7382 processed as if it were an independent item in the list, except that further
7383 file names are not allowed,
7384 and no expansion of the data from the file takes place.
7385 Empty lines in the file are ignored, and the file may also contain comment
7389 For domain and host lists, if a # character appears anywhere in a line of the
7390 file, it and all following characters are ignored.
7392 Because local parts may legitimately contain # characters, a comment in an
7393 address list or local part list file is recognized only if # is preceded by
7394 white space or the start of the line. For example:
7396 not#comment@x.y.z # but this is a comment
7400 Putting a file name in a list has the same effect as inserting each line of the
7401 file as an item in the list (blank lines and comments excepted). However, there
7402 is one important difference: the file is read each time the list is processed,
7403 so if its contents vary over time, Exim's behaviour changes.
7405 If a file name is preceded by an exclamation mark, the sense of any match
7406 within the file is inverted. For example, if
7408 hold_domains = !/etc/nohold-domains
7410 and the file contains the lines
7415 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
7416 any domain matching &`*.b.c`& is not.
7420 .section "An lsearch file is not an out-of-line list" "SECID77"
7421 As will be described in the sections that follow, lookups can be used in lists
7422 to provide indexed methods of checking list membership. There has been some
7423 confusion about the way &(lsearch)& lookups work in lists. Because
7424 an &(lsearch)& file contains plain text and is scanned sequentially, it is
7425 sometimes thought that it is allowed to contain wild cards and other kinds of
7426 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
7427 always fixed strings, just as for any other single-key lookup type.
7429 If you want to use a file to contain wild-card patterns that form part of a
7430 list, just give the file name on its own, without a search type, as described
7431 in the previous section. You could also use the &(wildlsearch)& or
7432 &(nwildlsearch)&, but there is no advantage in doing this.
7437 .section "Named lists" "SECTnamedlists"
7438 .cindex "named lists"
7439 .cindex "list" "named"
7440 A list of domains, hosts, email addresses, or local parts can be given a name
7441 which is then used to refer to the list elsewhere in the configuration. This is
7442 particularly convenient if the same list is required in several different
7443 places. It also allows lists to be given meaningful names, which can improve
7444 the readability of the configuration. For example, it is conventional to define
7445 a domain list called &'local_domains'& for all the domains that are handled
7446 locally on a host, using a configuration line such as
7448 domainlist local_domains = localhost:my.dom.example
7450 Named lists are referenced by giving their name preceded by a plus sign, so,
7451 for example, a router that is intended to handle local domains would be
7452 configured with the line
7454 domains = +local_domains
7456 The first router in a configuration is often one that handles all domains
7457 except the local ones, using a configuration with a negated item like this:
7461 domains = ! +local_domains
7462 transport = remote_smtp
7465 The four kinds of named list are created by configuration lines starting with
7466 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
7467 respectively. Then there follows the name that you are defining, followed by an
7468 equals sign and the list itself. For example:
7470 hostlist relay_hosts = 192.168.23.0/24 : my.friend.example
7471 addresslist bad_senders = cdb;/etc/badsenders
7473 A named list may refer to other named lists:
7475 domainlist dom1 = first.example : second.example
7476 domainlist dom2 = +dom1 : third.example
7477 domainlist dom3 = fourth.example : +dom2 : fifth.example
7479 &*Warning*&: If the last item in a referenced list is a negative one, the
7480 effect may not be what you intended, because the negation does not propagate
7481 out to the higher level. For example, consider:
7483 domainlist dom1 = !a.b
7484 domainlist dom2 = +dom1 : *.b
7486 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
7487 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
7488 means it matches the second list as well. The effect is not the same as
7490 domainlist dom2 = !a.b : *.b
7492 where &'x.y'& does not match. It's best to avoid negation altogether in
7493 referenced lists if you can.
7495 Named lists may have a performance advantage. When Exim is routing an
7496 address or checking an incoming message, it caches the result of tests on named
7497 lists. So, if you have a setting such as
7499 domains = +local_domains
7501 on several of your routers
7502 or in several ACL statements,
7503 the actual test is done only for the first one. However, the caching works only
7504 if there are no expansions within the list itself or any sublists that it
7505 references. In other words, caching happens only for lists that are known to be
7506 the same each time they are referenced.
7508 By default, there may be up to 16 named lists of each type. This limit can be
7509 extended by changing a compile-time variable. The use of domain and host lists
7510 is recommended for concepts such as local domains, relay domains, and relay
7511 hosts. The default configuration is set up like this.
7515 .section "Named lists compared with macros" "SECID78"
7516 .cindex "list" "named compared with macro"
7517 .cindex "macro" "compared with named list"
7518 At first sight, named lists might seem to be no different from macros in the
7519 configuration file. However, macros are just textual substitutions. If you
7522 ALIST = host1 : host2
7523 auth_advertise_hosts = !ALIST
7525 it probably won't do what you want, because that is exactly the same as
7527 auth_advertise_hosts = !host1 : host2
7529 Notice that the second host name is not negated. However, if you use a host
7532 hostlist alist = host1 : host2
7533 auth_advertise_hosts = ! +alist
7535 the negation applies to the whole list, and so that is equivalent to
7537 auth_advertise_hosts = !host1 : !host2
7541 .section "Named list caching" "SECID79"
7542 .cindex "list" "caching of named"
7543 .cindex "caching" "named lists"
7544 While processing a message, Exim caches the result of checking a named list if
7545 it is sure that the list is the same each time. In practice, this means that
7546 the cache operates only if the list contains no $ characters, which guarantees
7547 that it will not change when it is expanded. Sometimes, however, you may have
7548 an expanded list that you know will be the same each time within a given
7549 message. For example:
7551 domainlist special_domains = \
7552 ${lookup{$sender_host_address}cdb{/some/file}}
7554 This provides a list of domains that depends only on the sending host's IP
7555 address. If this domain list is referenced a number of times (for example,
7556 in several ACL lines, or in several routers) the result of the check is not
7557 cached by default, because Exim does not know that it is going to be the
7558 same list each time.
7560 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
7561 cache the result anyway. For example:
7563 domainlist_cache special_domains = ${lookup{...
7565 If you do this, you should be absolutely sure that caching is going to do
7566 the right thing in all cases. When in doubt, leave it out.
7570 .section "Domain lists" "SECTdomainlist"
7571 .cindex "domain list" "patterns for"
7572 .cindex "list" "domain list"
7573 Domain lists contain patterns that are to be matched against a mail domain.
7574 The following types of item may appear in domain lists:
7577 .cindex "primary host name"
7578 .cindex "host name" "matched in domain list"
7579 .oindex "&%primary_hostname%&"
7580 .cindex "domain list" "matching primary host name"
7581 .cindex "@ in a domain list"
7582 If a pattern consists of a single @ character, it matches the local host name,
7583 as set by the &%primary_hostname%& option (or defaulted). This makes it
7584 possible to use the same configuration file on several different hosts that
7585 differ only in their names.
7587 .cindex "@[] in a domain list"
7588 .cindex "domain list" "matching local IP interfaces"
7589 .cindex "domain literal"
7590 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
7591 in square brackets (as in an email address that contains a domain literal), but
7592 only if that IP address is recognized as local for email routing purposes. The
7593 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
7594 control which of a host's several IP addresses are treated as local.
7595 In today's Internet, the use of domain literals is controversial.
7598 .cindex "@mx_primary"
7599 .cindex "@mx_secondary"
7600 .cindex "domain list" "matching MX pointers to local host"
7601 If a pattern consists of the string &`@mx_any`& it matches any domain that
7602 has an MX record pointing to the local host or to any host that is listed in
7603 .oindex "&%hosts_treat_as_local%&"
7604 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
7605 are similar, except that the first matches only when a primary MX target is the
7606 local host, and the second only when no primary MX target is the local host,
7607 but a secondary MX target is. &"Primary"& means an MX record with the lowest
7608 preference value &-- there may of course be more than one of them.
7610 The MX lookup that takes place when matching a pattern of this type is
7611 performed with the resolver options for widening names turned off. Thus, for
7612 example, a single-component domain will &'not'& be expanded by adding the
7613 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
7614 options of the &(dnslookup)& router for a discussion of domain widening.
7616 Sometimes you may want to ignore certain IP addresses when using one of these
7617 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
7618 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
7619 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
7620 on a router). For example:
7622 domains = @mx_any/ignore=127.0.0.1
7624 This example matches any domain that has an MX record pointing to one of
7625 the local host's IP addresses other than 127.0.0.1.
7627 The list of IP addresses is in fact processed by the same code that processes
7628 host lists, so it may contain CIDR-coded network specifications and it may also
7629 contain negative items.
7631 Because the list of IP addresses is a sublist within a domain list, you have to
7632 be careful about delimiters if there is more than one address. Like any other
7633 list, the default delimiter can be changed. Thus, you might have:
7635 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
7636 an.other.domain : ...
7638 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
7639 involved, it is easiest to change the delimiter for the main list as well:
7641 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
7642 an.other.domain ? ...
7645 .cindex "asterisk" "in domain list"
7646 .cindex "domain list" "asterisk in"
7647 .cindex "domain list" "matching &""ends with""&"
7648 If a pattern starts with an asterisk, the remaining characters of the pattern
7649 are compared with the terminating characters of the domain. The use of &"*"& in
7650 domain lists differs from its use in partial matching lookups. In a domain
7651 list, the character following the asterisk need not be a dot, whereas partial
7652 matching works only in terms of dot-separated components. For example, a domain
7653 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
7657 .cindex "regular expressions" "in domain list"
7658 .cindex "domain list" "matching regular expression"
7659 If a pattern starts with a circumflex character, it is treated as a regular
7660 expression, and matched against the domain using a regular expression matching
7661 function. The circumflex is treated as part of the regular expression.
7662 Email domains are case-independent, so this regular expression match is by
7663 default case-independent, but you can make it case-dependent by starting it
7664 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
7665 are given in chapter &<<CHAPregexp>>&.
7667 &*Warning*&: Because domain lists are expanded before being processed, you
7668 must escape any backslash and dollar characters in the regular expression, or
7669 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
7670 it is not to be expanded (unless you really do want to build a regular
7671 expression by expansion, of course).
7673 .cindex "lookup" "in domain list"
7674 .cindex "domain list" "matching by lookup"
7675 If a pattern starts with the name of a single-key lookup type followed by a
7676 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
7677 must be a file name in a suitable format for the lookup type. For example, for
7678 &"cdb;"& it must be an absolute path:
7680 domains = cdb;/etc/mail/local_domains.cdb
7682 The appropriate type of lookup is done on the file using the domain name as the
7683 key. In most cases, the data that is looked up is not used; Exim is interested
7684 only in whether or not the key is present in the file. However, when a lookup
7685 is used for the &%domains%& option on a router
7686 or a &%domains%& condition in an ACL statement, the data is preserved in the
7687 &$domain_data$& variable and can be referred to in other router options or
7688 other statements in the same ACL.
7691 Any of the single-key lookup type names may be preceded by
7692 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
7694 domains = partial-dbm;/partial/domains
7696 This causes partial matching logic to be invoked; a description of how this
7697 works is given in section &<<SECTpartiallookup>>&.
7700 .cindex "asterisk" "in lookup type"
7701 Any of the single-key lookup types may be followed by an asterisk. This causes
7702 a default lookup for a key consisting of a single asterisk to be done if the
7703 original lookup fails. This is not a useful feature when using a domain list to
7704 select particular domains (because any domain would match), but it might have
7705 value if the result of the lookup is being used via the &$domain_data$&
7708 If the pattern starts with the name of a query-style lookup type followed by a
7709 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
7710 pattern must be an appropriate query for the lookup type, as described in
7711 chapter &<<CHAPfdlookup>>&. For example:
7713 hold_domains = mysql;select domain from holdlist \
7714 where domain = '$domain';
7716 In most cases, the data that is looked up is not used (so for an SQL query, for
7717 example, it doesn't matter what field you select). Exim is interested only in
7718 whether or not the query succeeds. However, when a lookup is used for the
7719 &%domains%& option on a router, the data is preserved in the &$domain_data$&
7720 variable and can be referred to in other options.
7722 .cindex "domain list" "matching literal domain name"
7723 If none of the above cases apply, a caseless textual comparison is made
7724 between the pattern and the domain.
7727 Here is an example that uses several different kinds of pattern:
7729 domainlist funny_domains = \
7732 *.foundation.fict.example : \
7733 \N^[1-2]\d{3}\.fict\.example$\N : \
7734 partial-dbm;/opt/data/penguin/book : \
7735 nis;domains.byname : \
7736 nisplus;[name=$domain,status=local],domains.org_dir
7738 There are obvious processing trade-offs among the various matching modes. Using
7739 an asterisk is faster than a regular expression, and listing a few names
7740 explicitly probably is too. The use of a file or database lookup is expensive,
7741 but may be the only option if hundreds of names are required. Because the
7742 patterns are tested in order, it makes sense to put the most commonly matched
7747 .section "Host lists" "SECThostlist"
7748 .cindex "host list" "patterns in"
7749 .cindex "list" "host list"
7750 Host lists are used to control what remote hosts are allowed to do. For
7751 example, some hosts may be allowed to use the local host as a relay, and some
7752 may be permitted to use the SMTP ETRN command. Hosts can be identified in
7753 two different ways, by name or by IP address. In a host list, some types of
7754 pattern are matched to a host name, and some are matched to an IP address.
7755 You need to be particularly careful with this when single-key lookups are
7756 involved, to ensure that the right value is being used as the key.
7759 .section "Special host list patterns" "SECID80"
7760 .cindex "empty item in hosts list"
7761 .cindex "host list" "empty string in"
7762 If a host list item is the empty string, it matches only when no remote host is
7763 involved. This is the case when a message is being received from a local
7764 process using SMTP on the standard input, that is, when a TCP/IP connection is
7767 .cindex "asterisk" "in host list"
7768 The special pattern &"*"& in a host list matches any host or no host. Neither
7769 the IP address nor the name is actually inspected.
7773 .section "Host list patterns that match by IP address" "SECThoslispatip"
7774 .cindex "host list" "matching IP addresses"
7775 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
7776 the incoming address actually appears in the IPv6 host as
7777 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
7778 list, it is converted into a traditional IPv4 address first. (Not all operating
7779 systems accept IPv4 calls on IPv6 sockets, as there have been some security
7782 The following types of pattern in a host list check the remote host by
7783 inspecting its IP address:
7786 If the pattern is a plain domain name (not a regular expression, not starting
7787 with *, not a lookup of any kind), Exim calls the operating system function
7788 to find the associated IP address(es). Exim uses the newer
7789 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
7790 This typically causes a forward DNS lookup of the name. The result is compared
7791 with the IP address of the subject host.
7793 If there is a temporary problem (such as a DNS timeout) with the host name
7794 lookup, a temporary error occurs. For example, if the list is being used in an
7795 ACL condition, the ACL gives a &"defer"& response, usually leading to a
7796 temporary SMTP error code. If no IP address can be found for the host name,
7797 what happens is described in section &<<SECTbehipnot>>& below.
7800 .cindex "@ in a host list"
7801 If the pattern is &"@"&, the primary host name is substituted and used as a
7802 domain name, as just described.
7805 If the pattern is an IP address, it is matched against the IP address of the
7806 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
7807 IPv6 addresses can be given in colon-separated format, but the colons have to
7808 be doubled so as not to be taken as item separators when the default list
7809 separator is used. IPv6 addresses are recognized even when Exim is compiled
7810 without IPv6 support. This means that if they appear in a host list on an
7811 IPv4-only host, Exim will not treat them as host names. They are just addresses
7812 that can never match a client host.
7815 .cindex "@[] in a host list"
7816 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
7817 the local host. For example, if the local host is an IPv4 host with one
7818 interface address 10.45.23.56, these two ACL statements have the same effect:
7820 accept hosts = 127.0.0.1 : 10.45.23.56
7824 .cindex "CIDR notation"
7825 If the pattern is an IP address followed by a slash and a mask length (for
7826 example 10.11.42.0/24), it is matched against the IP address of the subject
7827 host under the given mask. This allows, an entire network of hosts to be
7828 included (or excluded) by a single item. The mask uses CIDR notation; it
7829 specifies the number of address bits that must match, starting from the most
7830 significant end of the address.
7832 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
7833 of a range of addresses. It is the number of bits in the network portion of the
7834 address. The above example specifies a 24-bit netmask, so it matches all 256
7835 addresses in the 10.11.42.0 network. An item such as
7839 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
7840 32 for an IPv4 address is the same as no mask at all; just a single address
7843 Here is another example which shows an IPv4 and an IPv6 network:
7845 recipient_unqualified_hosts = 192.168.0.0/16: \
7846 3ffe::ffff::836f::::/48
7848 The doubling of list separator characters applies only when these items
7849 appear inline in a host list. It is not required when indirecting via a file.
7852 recipient_unqualified_hosts = /opt/exim/unqualnets
7854 could make use of a file containing
7859 to have exactly the same effect as the previous example. When listing IPv6
7860 addresses inline, it is usually more convenient to use the facility for
7861 changing separator characters. This list contains the same two networks:
7863 recipient_unqualified_hosts = <; 172.16.0.0/12; \
7866 The separator is changed to semicolon by the leading &"<;"& at the start of the
7872 .section "Host list patterns for single-key lookups by host address" &&&
7873 "SECThoslispatsikey"
7874 .cindex "host list" "lookup of IP address"
7875 When a host is to be identified by a single-key lookup of its complete IP
7876 address, the pattern takes this form:
7878 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
7882 hosts_lookup = net-cdb;/hosts-by-ip.db
7884 The text form of the IP address of the subject host is used as the lookup key.
7885 IPv6 addresses are converted to an unabbreviated form, using lower case
7886 letters, with dots as separators because colon is the key terminator in
7887 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
7888 quoting the keys, but this is a facility that was added later.] The data
7889 returned by the lookup is not used.
7891 .cindex "IP address" "masking"
7892 .cindex "host list" "masked IP address"
7893 Single-key lookups can also be performed using masked IP addresses, using
7894 patterns of this form:
7896 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
7900 net24-dbm;/networks.db
7902 The IP address of the subject host is masked using <&'number'&> as the mask
7903 length. A textual string is constructed from the masked value, followed by the
7904 mask, and this is used as the lookup key. For example, if the host's IP address
7905 is 192.168.34.6, the key that is looked up for the above example is
7906 &"192.168.34.0/24"&.
7908 When an IPv6 address is converted to a string, dots are normally used instead
7909 of colons, so that keys in &(lsearch)& files need not contain colons (which
7910 terminate &(lsearch)& keys). This was implemented some time before the ability
7911 to quote keys was made available in &(lsearch)& files. However, the more
7912 recently implemented &(iplsearch)& files do require colons in IPv6 keys
7913 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
7914 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
7915 converted using colons and not dots. In all cases, full, unabbreviated IPv6
7916 addresses are always used.
7918 Ideally, it would be nice to tidy up this anomalous situation by changing to
7919 colons in all cases, given that quoting is now available for &(lsearch)&.
7920 However, this would be an incompatible change that might break some existing
7923 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
7924 IPv6 address) is not the same as specifying just &%net-%& without a number. In
7925 the former case the key strings include the mask value, whereas in the latter
7926 case the IP address is used on its own.
7930 .section "Host list patterns that match by host name" "SECThoslispatnam"
7931 .cindex "host" "lookup failures"
7932 .cindex "unknown host name"
7933 .cindex "host list" "matching host name"
7934 There are several types of pattern that require Exim to know the name of the
7935 remote host. These are either wildcard patterns or lookups by name. (If a
7936 complete hostname is given without any wildcarding, it is used to find an IP
7937 address to match against, as described in the section &<<SECThoslispatip>>&
7940 If the remote host name is not already known when Exim encounters one of these
7941 patterns, it has to be found from the IP address.
7942 Although many sites on the Internet are conscientious about maintaining reverse
7943 DNS data for their hosts, there are also many that do not do this.
7944 Consequently, a name cannot always be found, and this may lead to unwanted
7945 effects. Take care when configuring host lists with wildcarded name patterns.
7946 Consider what will happen if a name cannot be found.
7948 Because of the problems of determining host names from IP addresses, matching
7949 against host names is not as common as matching against IP addresses.
7951 By default, in order to find a host name, Exim first does a reverse DNS lookup;
7952 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
7953 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
7954 are done can be changed by setting the &%host_lookup_order%& option. For
7955 security, once Exim has found one or more names, it looks up the IP addresses
7956 for these names and compares them with the IP address that it started with.
7957 Only those names whose IP addresses match are accepted. Any other names are
7958 discarded. If no names are left, Exim behaves as if the host name cannot be
7959 found. In the most common case there is only one name and one IP address.
7961 There are some options that control what happens if a host name cannot be
7962 found. These are described in section &<<SECTbehipnot>>& below.
7964 .cindex "host" "alias for"
7965 .cindex "alias for host"
7966 As a result of aliasing, hosts may have more than one name. When processing any
7967 of the following types of pattern, all the host's names are checked:
7970 .cindex "asterisk" "in host list"
7971 If a pattern starts with &"*"& the remainder of the item must match the end of
7972 the host name. For example, &`*.b.c`& matches all hosts whose names end in
7973 &'.b.c'&. This special simple form is provided because this is a very common
7974 requirement. Other kinds of wildcarding require the use of a regular
7977 .cindex "regular expressions" "in host list"
7978 .cindex "host list" "regular expression in"
7979 If the item starts with &"^"& it is taken to be a regular expression which is
7980 matched against the host name. Host names are case-independent, so this regular
7981 expression match is by default case-independent, but you can make it
7982 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
7983 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
7988 is a regular expression that matches either of the two hosts &'a.c.d'& or
7989 &'b.c.d'&. When a regular expression is used in a host list, you must take care
7990 that backslash and dollar characters are not misinterpreted as part of the
7991 string expansion. The simplest way to do this is to use &`\N`& to mark that
7992 part of the string as non-expandable. For example:
7994 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
7996 &*Warning*&: If you want to match a complete host name, you must include the
7997 &`$`& terminating metacharacter in the regular expression, as in the above
7998 example. Without it, a match at the start of the host name is all that is
8005 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8006 .cindex "host" "lookup failures, permanent"
8007 While processing a host list, Exim may need to look up an IP address from a
8008 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8009 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8010 behaviour when it fails to find the information it is seeking is the same.
8012 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8013 apply to temporary DNS errors, whose handling is described in the next section.
8015 .cindex "&`+include_unknown`&"
8016 .cindex "&`+ignore_unknown`&"
8017 By default, Exim behaves as if the host does not match the list. This may not
8018 always be what you want to happen. To change Exim's behaviour, the special
8019 items &`+include_unknown`& or &`+ignore_unknown`& may appear in the list (at
8020 top level &-- they are not recognized in an indirected file).
8023 If any item that follows &`+include_unknown`& requires information that
8024 cannot found, Exim behaves as if the host does match the list. For example,
8026 host_reject_connection = +include_unknown:*.enemy.ex
8028 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8029 any hosts whose name it cannot find.
8032 If any item that follows &`+ignore_unknown`& requires information that cannot
8033 be found, Exim ignores that item and proceeds to the rest of the list. For
8036 accept hosts = +ignore_unknown : friend.example : \
8039 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8040 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8041 name can be found for 192.168.4.5, it is rejected.
8044 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8045 list. The effect of each one lasts until the next, or until the end of the
8049 .section "Temporary DNS errors when looking up host information" &&&
8051 .cindex "host" "lookup failures, temporary"
8052 .cindex "&`+include_defer`&"
8053 .cindex "&`+ignore_defer`&"
8054 A temporary DNS lookup failure normally causes a defer action (except when
8055 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8056 host lists can include &`+ignore_defer`& and &`+include_defer`&, analagous to
8057 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8058 section. These options should be used with care, probably only in non-critical
8059 host lists such as whitelists.
8063 .section "Host list patterns for single-key lookups by host name" &&&
8064 "SECThoslispatnamsk"
8065 .cindex "unknown host name"
8066 .cindex "host list" "matching host name"
8067 If a pattern is of the form
8069 <&'single-key-search-type'&>;<&'search-data'&>
8073 dbm;/host/accept/list
8075 a single-key lookup is performed, using the host name as its key. If the
8076 lookup succeeds, the host matches the item. The actual data that is looked up
8079 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8080 keys in the file, not IP addresses. If you want to do lookups based on IP
8081 addresses, you must precede the search type with &"net-"& (see section
8082 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8083 two items in the same list, one doing an address lookup and one doing a name
8084 lookup, both using the same file.
8088 .section "Host list patterns for query-style lookups" "SECID81"
8089 If a pattern is of the form
8091 <&'query-style-search-type'&>;<&'query'&>
8093 the query is obeyed, and if it succeeds, the host matches the item. The actual
8094 data that is looked up is not used. The variables &$sender_host_address$& and
8095 &$sender_host_name$& can be used in the query. For example:
8097 hosts_lookup = pgsql;\
8098 select ip from hostlist where ip='$sender_host_address'
8100 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8101 can use the &%sg%& expansion item to change this if you need to. If you want to
8102 use masked IP addresses in database queries, you can use the &%mask%& expansion
8105 If the query contains a reference to &$sender_host_name$&, Exim automatically
8106 looks up the host name if has not already done so. (See section
8107 &<<SECThoslispatnam>>& for comments on finding host names.)
8109 Historical note: prior to release 4.30, Exim would always attempt to find a
8110 host name before running the query, unless the search type was preceded by
8111 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8112 still recognized for query-style lookups, but its presence or absence has no
8113 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8114 See section &<<SECThoslispatsikey>>&.)
8118 .section "Mixing wildcarded host names and addresses in host lists" &&&
8120 .cindex "host list" "mixing names and addresses in"
8121 If you have name lookups or wildcarded host names and IP addresses in the same
8122 host list, you should normally put the IP addresses first. For example, in an
8125 accept hosts = 10.9.8.7 : *.friend.example
8127 The reason for this lies in the left-to-right way that Exim processes lists.
8128 It can test IP addresses without doing any DNS lookups, but when it reaches an
8129 item that requires a host name, it fails if it cannot find a host name to
8130 compare with the pattern. If the above list is given in the opposite order, the
8131 &%accept%& statement fails for a host whose name cannot be found, even if its
8132 IP address is 10.9.8.7.
8134 If you really do want to do the name check first, and still recognize the IP
8135 address, you can rewrite the ACL like this:
8137 accept hosts = *.friend.example
8138 accept hosts = 10.9.8.7
8140 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8141 &<<CHAPACL>>& for details of ACLs.
8147 .section "Address lists" "SECTaddresslist"
8148 .cindex "list" "address list"
8149 .cindex "address list" "empty item"
8150 .cindex "address list" "patterns"
8151 Address lists contain patterns that are matched against mail addresses. There
8152 is one special case to be considered: the sender address of a bounce message is
8153 always empty. You can test for this by providing an empty item in an address
8154 list. For example, you can set up a router to process bounce messages by
8155 using this option setting:
8159 The presence of the colon creates an empty item. If you do not provide any
8160 data, the list is empty and matches nothing. The empty sender can also be
8161 detected by a regular expression that matches an empty string,
8162 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8164 Non-empty items in an address list can be straightforward email addresses. For
8167 senders = jbc@askone.example : hs@anacreon.example
8169 A certain amount of wildcarding is permitted. If a pattern contains an @
8170 character, but is not a regular expression and does not begin with a
8171 semicolon-terminated lookup type (described below), the local part of the
8172 subject address is compared with the local part of the pattern, which may start
8173 with an asterisk. If the local parts match, the domain is checked in exactly
8174 the same way as for a pattern in a domain list. For example, the domain can be
8175 wildcarded, refer to a named list, or be a lookup:
8177 deny senders = *@*.spamming.site:\
8178 *@+hostile_domains:\
8179 bozo@partial-lsearch;/list/of/dodgy/sites:\
8180 *@dbm;/bad/domains.db
8182 .cindex "local part" "starting with !"
8183 .cindex "address list" "local part starting with !"
8184 If a local part that begins with an exclamation mark is required, it has to be
8185 specified using a regular expression, because otherwise the exclamation mark is
8186 treated as a sign of negation, as is standard in lists.
8188 If a non-empty pattern that is not a regular expression or a lookup does not
8189 contain an @ character, it is matched against the domain part of the subject
8190 address. The only two formats that are recognized this way are a literal
8191 domain, or a domain pattern that starts with *. In both these cases, the effect
8192 is the same as if &`*@`& preceded the pattern. For example:
8194 deny senders = enemy.domain : *.enemy.domain
8197 The following kinds of more complicated address list pattern can match any
8198 address, including the empty address that is characteristic of bounce message
8202 .cindex "regular expressions" "in address list"
8203 .cindex "address list" "regular expression in"
8204 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8205 done against the complete address, with the pattern as the regular expression.
8206 You must take care that backslash and dollar characters are not misinterpreted
8207 as part of the string expansion. The simplest way to do this is to use &`\N`&
8208 to mark that part of the string as non-expandable. For example:
8210 deny senders = \N^.*this.*@example\.com$\N : \
8211 \N^\d{8}.+@spamhaus.example$\N : ...
8213 The &`\N`& sequences are removed by the expansion, so these items do indeed
8214 start with &"^"& by the time they are being interpreted as address patterns.
8217 .cindex "address list" "lookup for complete address"
8218 Complete addresses can be looked up by using a pattern that starts with a
8219 lookup type terminated by a semicolon, followed by the data for the lookup. For
8222 deny senders = cdb;/etc/blocked.senders : \
8223 mysql;select address from blocked where \
8224 address='${quote_mysql:$sender_address}'
8226 Both query-style and single-key lookup types can be used. For a single-key
8227 lookup type, Exim uses the complete address as the key. However, empty keys are
8228 not supported for single-key lookups, so a match against the empty address
8229 always fails. This restriction does not apply to query-style lookups.
8231 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8232 cannot be used, and is ignored if specified, with an entry being written to the
8234 .cindex "*@ with single-key lookup"
8235 However, you can configure lookup defaults, as described in section
8236 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8237 default. For example, with this lookup:
8239 accept senders = lsearch*@;/some/file
8241 the file could contains lines like this:
8243 user1@domain1.example
8246 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8249 nimrod@jaeger.example
8253 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8254 would mean that every address matches, thus rendering the test useless.
8256 &*Warning 2*&: Do not confuse these two kinds of item:
8258 deny recipients = dbm*@;/some/file
8259 deny recipients = *@dbm;/some/file
8261 The first does a whole address lookup, with defaulting, as just described,
8262 because it starts with a lookup type. The second matches the local part and
8263 domain independently, as described in a bullet point below.
8267 The following kinds of address list pattern can match only non-empty addresses.
8268 If the subject address is empty, a match against any of these pattern types
8273 .cindex "@@ with single-key lookup"
8274 .cindex "address list" "@@ lookup type"
8275 .cindex "address list" "split local part and domain"
8276 If a pattern starts with &"@@"& followed by a single-key lookup item
8277 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8278 split into a local part and a domain. The domain is looked up in the file. If
8279 it is not found, there is no match. If it is found, the data that is looked up
8280 from the file is treated as a colon-separated list of local part patterns, each
8281 of which is matched against the subject local part in turn.
8283 .cindex "asterisk" "in address list"
8284 The lookup may be a partial one, and/or one involving a search for a default
8285 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8286 patterns that are looked up can be regular expressions or begin with &"*"&, or
8287 even be further lookups. They may also be independently negated. For example,
8290 deny senders = @@dbm;/etc/reject-by-domain
8292 the data from which the DBM file is built could contain lines like
8294 baddomain.com: !postmaster : *
8296 to reject all senders except &%postmaster%& from that domain.
8298 .cindex "local part" "starting with !"
8299 If a local part that actually begins with an exclamation mark is required, it
8300 has to be specified using a regular expression. In &(lsearch)& files, an entry
8301 may be split over several lines by indenting the second and subsequent lines,
8302 but the separating colon must still be included at line breaks. White space
8303 surrounding the colons is ignored. For example:
8305 aol.com: spammer1 : spammer2 : ^[0-9]+$ :
8308 As in all colon-separated lists in Exim, a colon can be included in an item by
8311 If the last item in the list starts with a right angle-bracket, the remainder
8312 of the item is taken as a new key to look up in order to obtain a continuation
8313 list of local parts. The new key can be any sequence of characters. Thus one
8314 might have entries like
8316 aol.com: spammer1 : spammer 2 : >*
8317 xyz.com: spammer3 : >*
8320 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8321 local parts for all domains, in addition to the specific local parts listed for
8322 each domain. Of course, using this feature costs another lookup each time a
8323 chain is followed, but the effort needed to maintain the data is reduced.
8325 .cindex "loop" "in lookups"
8326 It is possible to construct loops using this facility, and in order to catch
8327 them, the chains may be no more than fifty items long.
8330 The @@<&'lookup'&> style of item can also be used with a query-style
8331 lookup, but in this case, the chaining facility is not available. The lookup
8332 can only return a single list of local parts.
8335 &*Warning*&: There is an important difference between the address list items
8336 in these two examples:
8339 senders = *@+my_list
8341 In the first one, &`my_list`& is a named address list, whereas in the second
8342 example it is a named domain list.
8347 .section "Case of letters in address lists" "SECTcasletadd"
8348 .cindex "case of local parts"
8349 .cindex "address list" "case forcing"
8350 .cindex "case forcing in address lists"
8351 Domains in email addresses are always handled caselessly, but for local parts
8352 case may be significant on some systems (see &%caseful_local_part%& for how
8353 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8354 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8355 blocking lists should be done in a case-independent manner. Since most address
8356 lists in Exim are used for this kind of control, Exim attempts to do this by
8359 The domain portion of an address is always lowercased before matching it to an
8360 address list. The local part is lowercased by default, and any string
8361 comparisons that take place are done caselessly. This means that the data in
8362 the address list itself, in files included as plain file names, and in any file
8363 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8364 keys in files that are looked up by a search type other than &(lsearch)& (which
8365 works caselessly) must be in lower case, because these lookups are not
8368 .cindex "&`+caseful`&"
8369 To allow for the possibility of caseful address list matching, if an item in
8370 an address list is the string &"+caseful"&, the original case of the local
8371 part is restored for any comparisons that follow, and string comparisons are no
8372 longer case-independent. This does not affect the domain, which remains in
8373 lower case. However, although independent matches on the domain alone are still
8374 performed caselessly, regular expressions that match against an entire address
8375 become case-sensitive after &"+caseful"& has been seen.
8379 .section "Local part lists" "SECTlocparlis"
8380 .cindex "list" "local part list"
8381 .cindex "local part" "list"
8382 Case-sensitivity in local part lists is handled in the same way as for address
8383 lists, as just described. The &"+caseful"& item can be used if required. In a
8384 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
8385 set false, the subject is lowercased and the matching is initially
8386 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
8387 matching in the local part list, but not elsewhere in the router. If
8388 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
8389 option is case-sensitive from the start.
8391 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
8392 comments are handled in the same way as address lists &-- they are recognized
8393 only if the # is preceded by white space or the start of the line.
8394 Otherwise, local part lists are matched in the same way as domain lists, except
8395 that the special items that refer to the local host (&`@`&, &`@[]`&,
8396 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
8397 Refer to section &<<SECTdomainlist>>& for details of the other available item
8399 .ecindex IIDdohoadli
8404 . ////////////////////////////////////////////////////////////////////////////
8405 . ////////////////////////////////////////////////////////////////////////////
8407 .chapter "String expansions" "CHAPexpand"
8408 .scindex IIDstrexp "expansion" "of strings"
8409 Many strings in Exim's run time configuration are expanded before use. Some of
8410 them are expanded every time they are used; others are expanded only once.
8412 When a string is being expanded it is copied verbatim from left to right except
8413 when a dollar or backslash character is encountered. A dollar specifies the
8414 start of a portion of the string that is interpreted and replaced as described
8415 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
8416 escape character, as described in the following section.
8420 .section "Literal text in expanded strings" "SECTlittext"
8421 .cindex "expansion" "including literal text"
8422 An uninterpreted dollar can be included in an expanded string by putting a
8423 backslash in front of it. A backslash can be used to prevent any special
8424 character being treated specially in an expansion, including backslash itself.
8425 If the string appears in quotes in the configuration file, two backslashes are
8426 required because the quotes themselves cause interpretation of backslashes when
8427 the string is read in (see section &<<SECTstrings>>&).
8429 .cindex "expansion" "non-expandable substrings"
8430 A portion of the string can specified as non-expandable by placing it between
8431 two occurrences of &`\N`&. This is particularly useful for protecting regular
8432 expressions, which often contain backslashes and dollar signs. For example:
8434 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
8436 On encountering the first &`\N`&, the expander copies subsequent characters
8437 without interpretation until it reaches the next &`\N`& or the end of the
8442 .section "Character escape sequences in expanded strings" "SECID82"
8443 .cindex "expansion" "escape sequences"
8444 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
8445 expanded string is recognized as an escape sequence for the character newline,
8446 carriage return, or tab, respectively. A backslash followed by up to three
8447 octal digits is recognized as an octal encoding for a single character, and a
8448 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
8451 These escape sequences are also recognized in quoted strings when they are read
8452 in. Their interpretation in expansions as well is useful for unquoted strings,
8453 and for other cases such as looked-up strings that are then expanded.
8456 .section "Testing string expansions" "SECID83"
8457 .cindex "expansion" "testing"
8458 .cindex "testing" "string expansion"
8460 Many expansions can be tested by calling Exim with the &%-be%& option. This
8461 takes the command arguments, or lines from the standard input if there are no
8462 arguments, runs them through the string expansion code, and writes the results
8463 to the standard output. Variables based on configuration values are set up, but
8464 since no message is being processed, variables such as &$local_part$& have no
8465 value. Nevertheless the &%-be%& option can be useful for checking out file and
8466 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
8469 Exim gives up its root privilege when it is called with the &%-be%& option, and
8470 instead runs under the uid and gid it was called with, to prevent users from
8471 using &%-be%& for reading files to which they do not have access.
8474 If you want to test expansions that include variables whose values are taken
8475 from a message, there are two other options that can be used. The &%-bem%&
8476 option is like &%-be%& except that it is followed by a file name. The file is
8477 read as a message before doing the test expansions. For example:
8479 exim -bem /tmp/test.message '$h_subject:'
8481 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
8482 Exim message identifier. For example:
8484 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
8486 This loads the message from Exim's spool before doing the test expansions, and
8487 is therefore restricted to admin users.
8490 .section "Forced expansion failure" "SECTforexpfai"
8491 .cindex "expansion" "forced failure"
8492 A number of expansions that are described in the following section have
8493 alternative &"true"& and &"false"& substrings, enclosed in brace characters
8494 (which are sometimes called &"curly brackets"&). Which of the two strings is
8495 used depends on some condition that is evaluated as part of the expansion. If,
8496 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
8497 the entire string expansion fails in a way that can be detected by the code
8498 that requested the expansion. This is called &"forced expansion failure"&, and
8499 its consequences depend on the circumstances. In some cases it is no different
8500 from any other expansion failure, but in others a different action may be
8501 taken. Such variations are mentioned in the documentation of the option that is
8507 .section "Expansion items" "SECTexpansionitems"
8508 The following items are recognized in expanded strings. White space may be used
8509 between sub-items that are keywords or substrings enclosed in braces inside an
8510 outer set of braces, to improve readability. &*Warning*&: Within braces,
8511 white space is significant.
8514 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
8515 .cindex "expansion" "variables"
8516 Substitute the contents of the named variable, for example:
8521 The second form can be used to separate the name from subsequent alphanumeric
8522 characters. This form (using braces) is available only for variables; it does
8523 &'not'& apply to message headers. The names of the variables are given in
8524 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
8525 given, the expansion fails.
8527 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
8528 .cindex "expansion" "operators"
8529 The string is first itself expanded, and then the operation specified by
8530 <&'op'&> is applied to it. For example:
8534 The string starts with the first character after the colon, which may be
8535 leading white space. A list of operators is given in section &<<SECTexpop>>&
8536 below. The operator notation is used for simple expansion items that have just
8537 one argument, because it reduces the number of braces and therefore makes the
8538 string easier to understand.
8540 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
8541 This item inserts &"basic"& header lines. It is described with the &%header%&
8542 expansion item below.
8544 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
8545 {*&<&'arg'&>&*}...}*&"
8547 This expansion dynamically loads and then calls a locally-written C function.
8548 This functionality is available only if Exim is compiled with
8552 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
8553 object so that it doesn't reload the same object file in the same Exim process
8554 (but of course Exim does start new processes frequently).
8556 There may be from zero to eight arguments to the function. When compiling
8557 a local function that is to be called in this way, &_local_scan.h_& should be
8558 included. The Exim variables and functions that are defined by that API
8559 are also available for dynamically loaded functions. The function itself
8560 must have the following type:
8562 int dlfunction(uschar **yield, int argc, uschar *argv[])
8564 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
8565 function should return one of the following values:
8567 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
8568 into the expanded string that is being built.
8570 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
8571 from &'yield'&, if it is set.
8573 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
8574 taken from &'yield'& if it is set.
8576 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
8578 When compiling a function that is to be used in this way with gcc,
8579 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
8580 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
8582 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
8583 {*&<&'string3'&>&*}}*&"
8584 .cindex "expansion" "extracting substrings by key"
8585 .cindex "&%extract%&" "substrings by key"
8586 The key and <&'string1'&> are first expanded separately. Leading and trailing
8587 white space is removed from the key (but not from any of the strings). The key
8588 must not consist entirely of digits. The expanded <&'string1'&> must be of the
8591 <&'key1'&> = <&'value1'&> <&'key2'&> = <&'value2'&> ...
8594 where the equals signs and spaces (but not both) are optional. If any of the
8595 values contain white space, they must be enclosed in double quotes, and any
8596 values that are enclosed in double quotes are subject to escape processing as
8597 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
8598 for the value that corresponds to the key. The search is case-insensitive. If
8599 the key is found, <&'string2'&> is expanded, and replaces the whole item;
8600 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
8601 variable &$value$& contains the value that has been extracted. Afterwards, it
8602 is restored to any previous value it might have had.
8604 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
8605 key is not found. If {<&'string2'&>} is also omitted, the value that was
8606 extracted is used. Thus, for example, these two expansions are identical, and
8609 ${extract{gid}{uid=1984 gid=2001}}
8610 ${extract{gid}{uid=1984 gid=2001}{$value}}
8612 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
8613 appear, for example:
8615 ${extract{Z}{A=... B=...}{$value} fail }
8617 This forces an expansion failure (see section &<<SECTforexpfai>>&);
8618 {<&'string2'&>} must be present for &"fail"& to be recognized.
8621 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
8622 {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
8623 .cindex "expansion" "extracting substrings by number"
8624 .cindex "&%extract%&" "substrings by number"
8625 The <&'number'&> argument must consist entirely of decimal digits,
8626 apart from leading and trailing white space, which is ignored.
8627 This is what distinguishes this form of &%extract%& from the previous kind. It
8628 behaves in the same way, except that, instead of extracting a named field, it
8629 extracts from <&'string1'&> the field whose number is given as the first
8630 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
8631 <&'string3'&> as before.
8633 The fields in the string are separated by any one of the characters in the
8634 separator string. These may include space or tab characters.
8635 The first field is numbered one. If the number is negative, the fields are
8636 counted from the end of the string, with the rightmost one numbered -1. If the
8637 number given is zero, the entire string is returned. If the modulus of the
8638 number is greater than the number of fields in the string, the result is the
8639 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
8640 provided. For example:
8642 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
8646 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
8648 yields &"99"&. Two successive separators mean that the field between them is
8649 empty (for example, the fifth field above).
8652 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
8653 .cindex "list" "selecting by condition"
8654 .cindex "expansion" "selecting from list by condition"
8656 After expansion, <&'string'&> is interpreted as a list, colon-separated by
8657 default, but the separator can be changed in the usual way. For each item
8658 in this list, its value is place in &$item$&, and then the condition is
8659 evaluated. If the condition is true, &$item$& is added to the output as an
8660 item in a new list; if the condition is false, the item is discarded. The
8661 separator used for the output list is the same as the one used for the
8662 input, but a separator setting is not included in the output. For example:
8664 ${filter{a:b:c}{!eq{$item}{b}}
8666 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
8667 to what it was before. See also the &*map*& and &*reduce*& expansion items.
8670 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
8671 .cindex "hash function" "textual"
8672 .cindex "expansion" "textual hash"
8673 This is a textual hashing function, and was the first to be implemented in
8674 early versions of Exim. In current releases, there are other hashing functions
8675 (numeric, MD5, and SHA-1), which are described below.
8677 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
8678 <&'n'&>. If you are using fixed values for these numbers, that is, if
8679 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
8680 use the simpler operator notation that avoids some of the braces:
8682 ${hash_<n>_<m>:<string>}
8684 The second number is optional (in both notations). If <&'n'&> is greater than
8685 or equal to the length of the string, the expansion item returns the string.
8686 Otherwise it computes a new string of length <&'n'&> by applying a hashing
8687 function to the string. The new string consists of characters taken from the
8688 first <&'m'&> characters of the string
8690 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
8692 If <&'m'&> is not present the value 26 is used, so that only lower case
8693 letters appear. For example:
8695 &`$hash{3}{monty}} `& yields &`jmg`&
8696 &`$hash{5}{monty}} `& yields &`monty`&
8697 &`$hash{4}{62}{monty python}}`& yields &`fbWx`&
8700 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
8701 &*$h_*&<&'header&~name'&>&*:*&" &&&
8702 "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
8703 &*$bh_*&<&'header&~name'&>&*:*&" &&&
8704 "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
8705 &*$rh_*&<&'header&~name'&>&*:*&"
8706 .cindex "expansion" "header insertion"
8707 .vindex "&$header_$&"
8708 .vindex "&$bheader_$&"
8709 .vindex "&$rheader_$&"
8710 .cindex "header lines" "in expansion strings"
8711 .cindex "header lines" "character sets"
8712 .cindex "header lines" "decoding"
8713 Substitute the contents of the named message header line, for example
8717 The newline that terminates a header line is not included in the expansion, but
8718 internal newlines (caused by splitting the header line over several physical
8719 lines) may be present.
8721 The difference between &%rheader%&, &%bheader%&, and &%header%& is in the way
8722 the data in the header line is interpreted.
8725 .cindex "white space" "in header lines"
8726 &%rheader%& gives the original &"raw"& content of the header line, with no
8727 processing at all, and without the removal of leading and trailing white space.
8730 .cindex "base64 encoding" "in header lines"
8731 &%bheader%& removes leading and trailing white space, and then decodes base64
8732 or quoted-printable MIME &"words"& within the header text, but does no
8733 character set translation. If decoding of what looks superficially like a MIME
8734 &"word"& fails, the raw string is returned. If decoding
8735 .cindex "binary zero" "in header line"
8736 produces a binary zero character, it is replaced by a question mark &-- this is
8737 what Exim does for binary zeros that are actually received in header lines.
8740 &%header%& tries to translate the string as decoded by &%bheader%& to a
8741 standard character set. This is an attempt to produce the same string as would
8742 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
8743 returned. Translation is attempted only on operating systems that support the
8744 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
8745 a system Makefile or in &_Local/Makefile_&.
8748 In a filter file, the target character set for &%header%& can be specified by a
8749 command of the following form:
8751 headers charset "UTF-8"
8753 This command affects all references to &$h_$& (or &$header_$&) expansions in
8754 subsequently obeyed filter commands. In the absence of this command, the target
8755 character set in a filter is taken from the setting of the &%headers_charset%&
8756 option in the runtime configuration. The value of this option defaults to the
8757 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
8760 Header names follow the syntax of RFC 2822, which states that they may contain
8761 any printing characters except space and colon. Consequently, curly brackets
8762 &'do not'& terminate header names, and should not be used to enclose them as
8763 if they were variables. Attempting to do so causes a syntax error.
8765 Only header lines that are common to all copies of a message are visible to
8766 this mechanism. These are the original header lines that are received with the
8767 message, and any that are added by an ACL statement or by a system
8768 filter. Header lines that are added to a particular copy of a message by a
8769 router or transport are not accessible.
8771 For incoming SMTP messages, no header lines are visible in ACLs that are obeyed
8772 before the DATA ACL, because the header structure is not set up until the
8773 message is received. Header lines that are added in a RCPT ACL (for example)
8774 are saved until the message's incoming header lines are available, at which
8775 point they are added. When a DATA ACL is running, however, header lines added
8776 by earlier ACLs are visible.
8778 Upper case and lower case letters are synonymous in header names. If the
8779 following character is white space, the terminating colon may be omitted, but
8780 this is not recommended, because you may then forget it when it is needed. When
8781 white space terminates the header name, it is included in the expanded string.
8782 If the message does not contain the given header, the expansion item is
8783 replaced by an empty string. (See the &%def%& condition in section
8784 &<<SECTexpcond>>& for a means of testing for the existence of a header.)
8786 If there is more than one header with the same name, they are all concatenated
8787 to form the substitution string, up to a maximum length of 64K. Unless
8788 &%rheader%& is being used, leading and trailing white space is removed from
8789 each header before concatenation, and a completely empty header is ignored. A
8790 newline character is then inserted between non-empty headers, but there is no
8791 newline at the very end. For the &%header%& and &%bheader%& expansion, for
8792 those headers that contain lists of addresses, a comma is also inserted at the
8793 junctions between headers. This does not happen for the &%rheader%& expansion.
8796 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
8797 .cindex "expansion" "hmac hashing"
8799 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
8800 shared secret and some text into a message authentication code, as specified in
8801 RFC 2104. This differs from &`${md5:secret_text...}`& or
8802 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
8803 cryptographic hash, allowing for authentication that is not possible with MD5
8804 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
8805 present. For example:
8807 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
8809 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
8812 dd97e3ba5d1a61b5006108f8c8252953
8814 As an example of how this might be used, you might put in the main part of
8815 an Exim configuration:
8817 SPAMSCAN_SECRET=cohgheeLei2thahw
8819 In a router or a transport you could then have:
8822 X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
8823 ${hmac{md5}{SPAMSCAN_SECRET}\
8824 {${primary_hostname},${message_exim_id},$h_message-id:}}
8826 Then given a message, you can check where it was scanned by looking at the
8827 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
8828 this header line is authentic by recomputing the authentication code from the
8829 host name, message ID and the &'Message-id:'& header line. This can be done
8830 using Exim's &%-be%& option, or by other means, for example by using the
8831 &'hmac_md5_hex()'& function in Perl.
8834 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
8835 .cindex "expansion" "conditional"
8836 .cindex "&%if%&, expansion item"
8837 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
8838 item; otherwise <&'string2'&> is used. The available conditions are described
8839 in section &<<SECTexpcond>>& below. For example:
8841 ${if eq {$local_part}{postmaster} {yes}{no} }
8843 The second string need not be present; if it is not and the condition is not
8844 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
8845 be present instead of the second string (without any curly brackets). In this
8846 case, the expansion is forced to fail if the condition is not true (see section
8847 &<<SECTforexpfai>>&).
8849 If both strings are omitted, the result is the string &`true`& if the condition
8850 is true, and the empty string if the condition is false. This makes it less
8851 cumbersome to write custom ACL and router conditions. For example, instead of
8853 condition = ${if >{$acl_m4}{3}{true}{false}}
8857 condition = ${if >{$acl_m4}{3}}
8860 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
8861 .cindex "expansion" "string truncation"
8862 .cindex "&%length%& expansion item"
8863 The &%length%& item is used to extract the initial portion of a string. Both
8864 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
8865 you are using a fixed value for the number, that is, if <&'string1'&> does not
8866 change when expanded, you can use the simpler operator notation that avoids
8869 ${length_<n>:<string>}
8871 The result of this item is either the first <&'n'&> characters or the whole
8872 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
8873 &%strlen%&, which gives the length of a string.
8876 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
8877 {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
8878 This is the first of one of two different types of lookup item, which are both
8879 described in the next item.
8881 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
8882 {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
8883 .cindex "expansion" "lookup in"
8884 .cindex "file" "lookups"
8885 .cindex "lookup" "in expanded string"
8886 The two forms of lookup item specify data lookups in files and databases, as
8887 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
8888 lookups, and the second is used for query-style lookups. The <&'key'&>,
8889 <&'file'&>, and <&'query'&> strings are expanded before use.
8891 If there is any white space in a lookup item which is part of a filter command,
8892 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
8893 other place where white space is significant, the lookup item must be enclosed
8894 in double quotes. The use of data lookups in users' filter files may be locked
8895 out by the system administrator.
8898 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
8899 During its expansion, the variable &$value$& contains the data returned by the
8900 lookup. Afterwards it reverts to the value it had previously (at the outer
8901 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
8902 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
8903 string on failure. If <&'string2'&> is provided, it can itself be a nested
8904 lookup, thus providing a mechanism for looking up a default value when the
8905 original lookup fails.
8907 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
8908 data for the outer lookup while the parameters of the second lookup are
8909 expanded, and also while <&'string2'&> of the second lookup is expanded, should
8910 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
8911 appear, and in this case, if the lookup fails, the entire expansion is forced
8912 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
8913 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
8914 successful lookup, and nothing in the case of failure.
8916 For single-key lookups, the string &"partial"& is permitted to precede the
8917 search type in order to do partial matching, and * or *@ may follow a search
8918 type to request default lookups if the key does not match (see sections
8919 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
8921 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
8922 If a partial search is used, the variables &$1$& and &$2$& contain the wild
8923 and non-wild parts of the key during the expansion of the replacement text.
8924 They return to their previous values at the end of the lookup item.
8926 This example looks up the postmaster alias in the conventional alias file:
8928 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
8930 This example uses NIS+ to look up the full name of the user corresponding to
8931 the local part of an address, forcing the expansion to fail if it is not found:
8933 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
8938 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
8939 .cindex "expansion" "list creation"
8941 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
8942 default, but the separator can be changed in the usual way. For each item
8943 in this list, its value is place in &$item$&, and then <&'string2'&> is
8944 expanded and added to the output as an item in a new list. The separator used
8945 for the output list is the same as the one used for the input, but a separator
8946 setting is not included in the output. For example:
8948 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
8950 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
8951 value of &$item$& is restored to what it was before. See also the &*filter*&
8952 and &*reduce*& expansion items.
8954 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
8955 .cindex "expansion" "numeric hash"
8956 .cindex "hash function" "numeric"
8957 The three strings are expanded; the first two must yield numbers. Call them
8958 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
8959 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
8960 can use the simpler operator notation that avoids some of the braces:
8962 ${nhash_<n>_<m>:<string>}
8964 The second number is optional (in both notations). If there is only one number,
8965 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
8966 processed by a div/mod hash function that returns two numbers, separated by a
8967 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
8970 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
8972 returns the string &"6/33"&.
8976 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
8977 .cindex "Perl" "use in expanded string"
8978 .cindex "expansion" "calling Perl from"
8979 This item is available only if Exim has been built to include an embedded Perl
8980 interpreter. The subroutine name and the arguments are first separately
8981 expanded, and then the Perl subroutine is called with those arguments. No
8982 additional arguments need be given; the maximum number permitted, including the
8983 name of the subroutine, is nine.
8985 The return value of the subroutine is inserted into the expanded string, unless
8986 the return value is &%undef%&. In that case, the expansion fails in the same
8987 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
8988 Whatever you return is evaluated in a scalar context. For example, if you
8989 return the name of a Perl vector, the return value is the size of the vector,
8992 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
8993 with the error message that was passed to &%die%&. More details of the embedded
8994 Perl facility are given in chapter &<<CHAPperl>>&.
8996 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
8997 out the use of this expansion item in filter files.
9000 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9001 .cindex "&%prvs%& expansion item"
9002 The first argument is a complete email address and the second is secret
9003 keystring. The third argument, specifying a key number, is optional. If absent,
9004 it defaults to 0. The result of the expansion is a prvs-signed email address,
9005 to be typically used with the &%return_path%& option on an &(smtp)& transport
9006 as part of a bounce address tag validation (BATV) scheme. For more discussion
9007 and an example, see section &<<SECTverifyPRVS>>&.
9009 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
9010 {*&<&'string'&>&*}}*&"
9011 .cindex "&%prvscheck%& expansion item"
9012 This expansion item is the complement of the &%prvs%& item. It is used for
9013 checking prvs-signed addresses. If the expansion of the first argument does not
9014 yield a syntactically valid prvs-signed address, the whole item expands to the
9015 empty string. When the first argument does expand to a syntactically valid
9016 prvs-signed address, the second argument is expanded, with the prvs-decoded
9017 version of the address and the key number extracted from the address in the
9018 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9020 These two variables can be used in the expansion of the second argument to
9021 retrieve the secret. The validity of the prvs-signed address is then checked
9022 against the secret. The result is stored in the variable &$prvscheck_result$&,
9023 which is empty for failure or &"1"& for success.
9025 The third argument is optional; if it is missing, it defaults to an empty
9026 string. This argument is now expanded. If the result is an empty string, the
9027 result of the expansion is the decoded version of the address. This is the case
9028 whether or not the signature was valid. Otherwise, the result of the expansion
9029 is the expansion of the third argument.
9031 All three variables can be used in the expansion of the third argument.
9032 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9033 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9035 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9036 .cindex "expansion" "inserting an entire file"
9037 .cindex "file" "inserting into expansion"
9038 .cindex "&%readfile%& expansion item"
9039 The file name and end-of-line string are first expanded separately. The file is
9040 then read, and its contents replace the entire item. All newline characters in
9041 the file are replaced by the end-of-line string if it is present. Otherwise,
9042 newlines are left in the string.
9043 String expansion is not applied to the contents of the file. If you want this,
9044 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9045 the string expansion fails.
9047 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9048 locks out the use of this expansion item in filter files.
9052 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9053 {*&<&'timeout'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9054 .cindex "expansion" "inserting from a socket"
9055 .cindex "socket, use of in expansion"
9056 .cindex "&%readsocket%& expansion item"
9057 This item inserts data from a Unix domain or Internet socket into the expanded
9058 string. The minimal way of using it uses just two arguments, as in these
9061 ${readsocket{/socket/name}{request string}}
9062 ${readsocket{inet:some.host:1234}{request string}}
9064 For a Unix domain socket, the first substring must be the path to the socket.
9065 For an Internet socket, the first substring must contain &`inet:`& followed by
9066 a host name or IP address, followed by a colon and a port, which can be a
9067 number or the name of a TCP port in &_/etc/services_&. An IP address may
9068 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9071 ${readsocket{inet:[::1]:1234}{request string}}
9073 Only a single host name may be given, but if looking it up yields more than
9074 one IP address, they are each tried in turn until a connection is made. For
9075 both kinds of socket, Exim makes a connection, writes the request string
9076 (unless it is an empty string) and reads from the socket until an end-of-file
9077 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9078 extend what can be done. Firstly, you can vary the timeout. For example:
9080 ${readsocket{/socket/name}{request string}{3s}}
9082 A fourth argument allows you to change any newlines that are in the data
9083 that is read, in the same way as for &%readfile%& (see above). This example
9084 turns them into spaces:
9086 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9088 As with all expansions, the substrings are expanded before the processing
9089 happens. Errors in these sub-expansions cause the expansion to fail. In
9090 addition, the following errors can occur:
9093 Failure to create a socket file descriptor;
9095 Failure to connect the socket;
9097 Failure to write the request string;
9099 Timeout on reading from the socket.
9102 By default, any of these errors causes the expansion to fail. However, if
9103 you supply a fifth substring, it is expanded and used when any of the above
9104 errors occurs. For example:
9106 ${readsocket{/socket/name}{request string}{3s}{\n}\
9109 You can test for the existence of a Unix domain socket by wrapping this
9110 expansion in &`${if exists`&, but there is a race condition between that test
9111 and the actual opening of the socket, so it is safer to use the fifth argument
9112 if you want to be absolutely sure of avoiding an expansion error for a
9113 non-existent Unix domain socket, or a failure to connect to an Internet socket.
9115 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
9116 locks out the use of this expansion item in filter files.
9119 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9120 .cindex "expansion" "reducing a list to a scalar"
9121 .cindex "list" "reducing to a scalar"
9124 This operation reduces a list to a single, scalar string. After expansion,
9125 <&'string1'&> is interpreted as a list, colon-separated by default, but the
9126 separator can be changed in the usual way. Then <&'string2'&> is expanded and
9127 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
9128 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
9129 them. The result of that expansion is assigned to &$value$& before the next
9130 iteration. When the end of the list is reached, the final value of &$value$& is
9131 added to the expansion output. The &*reduce*& expansion item can be used in a
9132 number of ways. For example, to add up a list of numbers:
9134 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
9136 The result of that expansion would be &`6`&. The maximum of a list of numbers
9139 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
9141 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
9142 restored to what they were before. See also the &*filter*& and &*map*&
9145 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
9146 This item inserts &"raw"& header lines. It is described with the &%header%&
9147 expansion item above.
9149 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
9150 {*&<&'string2'&>&*}}*&"
9151 .cindex "expansion" "running a command"
9152 .cindex "&%run%& expansion item"
9153 The command and its arguments are first expanded separately, and then the
9154 command is run in a separate process, but under the same uid and gid. As in
9155 other command executions from Exim, a shell is not used by default. If you want
9156 a shell, you must explicitly code it.
9158 The standard input for the command exists, but is empty. The standard output
9159 and standard error are set to the same file descriptor.
9160 .cindex "return code" "from &%run%& expansion"
9162 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
9163 and replaces the entire item; during this expansion, the standard output/error
9164 from the command is in the variable &$value$&. If the command fails,
9165 <&'string2'&>, if present, is expanded and used. Once again, during the
9166 expansion, the standard output/error from the command is in the variable
9169 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
9170 can be the word &"fail"& (not in braces) to force expansion failure if the
9171 command does not succeed. If both strings are omitted, the result is contents
9172 of the standard output/error on success, and nothing on failure.
9175 The return code from the command is put in the variable &$runrc$&, and this
9176 remains set afterwards, so in a filter file you can do things like this:
9178 if "${run{x y z}{}}$runrc" is 1 then ...
9179 elif $runrc is 2 then ...
9183 If execution of the command fails (for example, the command does not exist),
9184 the return code is 127 &-- the same code that shells use for non-existent
9187 &*Warning*&: In a router or transport, you cannot assume the order in which
9188 option values are expanded, except for those preconditions whose order of
9189 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
9190 by the expansion of one option, and use it in another.
9192 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
9193 out the use of this expansion item in filter files.
9196 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
9197 .cindex "expansion" "string substitution"
9198 .cindex "&%sg%& expansion item"
9199 This item works like Perl's substitution operator (s) with the global (/g)
9200 option; hence its name. However, unlike the Perl equivalent, Exim does not
9201 modify the subject string; instead it returns the modified string for insertion
9202 into the overall expansion. The item takes three arguments: the subject string,
9203 a regular expression, and a substitution string. For example:
9205 ${sg{abcdefabcdef}{abc}{xyz}}
9207 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
9208 if any $ or \ characters are required in the regular expression or in the
9209 substitution string, they have to be escaped. For example:
9211 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
9213 yields &"defabc"&, and
9215 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
9217 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
9218 the regular expression from string expansion.
9222 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9223 .cindex "&%substr%& expansion item"
9224 .cindex "substring extraction"
9225 .cindex "expansion" "substring extraction"
9226 The three strings are expanded; the first two must yield numbers. Call them
9227 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9228 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9229 can use the simpler operator notation that avoids some of the braces:
9231 ${substr_<n>_<m>:<string>}
9233 The second number is optional (in both notations).
9234 If it is absent in the simpler format, the preceding underscore must also be
9237 The &%substr%& item can be used to extract more general substrings than
9238 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
9239 length required. For example
9241 ${substr{3}{2}{$local_part}}
9243 If the starting offset is greater than the string length the result is the
9244 null string; if the length plus starting offset is greater than the string
9245 length, the result is the right-hand part of the string, starting from the
9246 given offset. The first character in the string has offset zero.
9248 The &%substr%& expansion item can take negative offset values to count
9249 from the right-hand end of its operand. The last character is offset -1, the
9250 second-last is offset -2, and so on. Thus, for example,
9252 ${substr{-5}{2}{1234567}}
9254 yields &"34"&. If the absolute value of a negative offset is greater than the
9255 length of the string, the substring starts at the beginning of the string, and
9256 the length is reduced by the amount of overshoot. Thus, for example,
9258 ${substr{-5}{2}{12}}
9260 yields an empty string, but
9262 ${substr{-3}{2}{12}}
9266 When the second number is omitted from &%substr%&, the remainder of the string
9267 is taken if the offset is positive. If it is negative, all characters in the
9268 string preceding the offset point are taken. For example, an offset of -1 and
9269 no length, as in these semantically identical examples:
9272 ${substr{-1}{abcde}}
9274 yields all but the last character of the string, that is, &"abcd"&.
9278 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
9279 {*&<&'replacements'&>&*}}*&"
9280 .cindex "expansion" "character translation"
9281 .cindex "&%tr%& expansion item"
9282 This item does single-character translation on its subject string. The second
9283 argument is a list of characters to be translated in the subject string. Each
9284 matching character is replaced by the corresponding character from the
9285 replacement list. For example
9287 ${tr{abcdea}{ac}{13}}
9289 yields &`1b3de1`&. If there are duplicates in the second character string, the
9290 last occurrence is used. If the third string is shorter than the second, its
9291 last character is replicated. However, if it is empty, no translation takes
9297 .section "Expansion operators" "SECTexpop"
9298 .cindex "expansion" "operators"
9299 For expansion items that perform transformations on a single argument string,
9300 the &"operator"& notation is used because it is simpler and uses fewer braces.
9301 The substring is first expanded before the operation is applied to it. The
9302 following operations can be performed:
9305 .vitem &*${address:*&<&'string'&>&*}*&
9306 .cindex "expansion" "RFC 2822 address handling"
9307 .cindex "&%address%& expansion item"
9308 The string is interpreted as an RFC 2822 address, as it might appear in a
9309 header line, and the effective address is extracted from it. If the string does
9310 not parse successfully, the result is empty.
9313 .vitem &*${addresses:*&<&'string'&>&*}*&
9314 .cindex "expansion" "RFC 2822 address handling"
9315 .cindex "&%addresses%& expansion item"
9316 The string (after expansion) is interpreted as a list of addresses in RFC
9317 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
9318 operative address (&'local-part@domain'&) is extracted from each item, and the
9319 result of the expansion is a colon-separated list, with appropriate
9320 doubling of colons should any happen to be present in the email addresses.
9321 Syntactically invalid RFC2822 address items are omitted from the output.
9323 It is possible to specify a character other than colon for the output
9324 separator by starting the string with > followed by the new separator
9325 character. For example:
9327 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
9329 expands to &`ceo@up.stairs&&sec@base.ment`&. Compare the &*address*& (singular)
9330 expansion item, which extracts the working address from a single RFC2822
9331 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
9335 .vitem &*${base62:*&<&'digits'&>&*}*&
9336 .cindex "&%base62%& expansion item"
9337 .cindex "expansion" "conversion to base 62"
9338 The string must consist entirely of decimal digits. The number is converted to
9339 base 62 and output as a string of six characters, including leading zeros. In
9340 the few operating environments where Exim uses base 36 instead of base 62 for
9341 its message identifiers (because those systems do not have case-sensitive file
9342 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
9343 be absolutely clear: this is &'not'& base64 encoding.
9345 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
9346 .cindex "&%base62d%& expansion item"
9347 .cindex "expansion" "conversion to base 62"
9348 The string must consist entirely of base-62 digits, or, in operating
9349 environments where Exim uses base 36 instead of base 62 for its message
9350 identifiers, base-36 digits. The number is converted to decimal and output as a
9353 .vitem &*${domain:*&<&'string'&>&*}*&
9354 .cindex "domain" "extraction"
9355 .cindex "expansion" "domain extraction"
9356 The string is interpreted as an RFC 2822 address and the domain is extracted
9357 from it. If the string does not parse successfully, the result is empty.
9360 .vitem &*${escape:*&<&'string'&>&*}*&
9361 .cindex "expansion" "escaping non-printing characters"
9362 .cindex "&%escape%& expansion item"
9363 If the string contains any non-printing characters, they are converted to
9364 escape sequences starting with a backslash. Whether characters with the most
9365 significant bit set (so-called &"8-bit characters"&) count as printing or not
9366 is controlled by the &%print_topbitchars%& option.
9369 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
9370 .cindex "expansion" "expression evaluation"
9371 .cindex "expansion" "arithmetic expression"
9372 .cindex "&%eval%& expansion item"
9373 These items supports simple arithmetic and bitwise logical operations in
9374 expansion strings. The string (after expansion) must be a conventional
9375 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
9376 logical operators, and parentheses. All operations are carried out using
9377 integer arithmetic. The operator priorities are as follows (the same as in the
9378 C programming language):
9380 .irow &'highest:'& "not (~), negate (-)"
9381 .irow "" "multiply (*), divide (/), remainder (%)"
9382 .irow "" "plus (+), minus (-)"
9383 .irow "" "shift-left (<<), shift-right (>>)"
9386 .irow &'lowest:'& "or (|)"
9388 Binary operators with the same priority are evaluated from left to right. White
9389 space is permitted before or after operators.
9391 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
9392 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
9393 decimal, even if they start with a leading zero; hexadecimal numbers are not
9394 permitted. This can be useful when processing numbers extracted from dates or
9395 times, which often do have leading zeros.
9397 A number may be followed by &"K"& or &"M"& to multiply it by 1024 or 1024*1024,
9398 respectively. Negative numbers are supported. The result of the computation is
9399 a decimal representation of the answer (without &"K"& or &"M"&). For example:
9402 &`${eval:1+1} `& yields 2
9403 &`${eval:1+2*3} `& yields 7
9404 &`${eval:(1+2)*3} `& yields 9
9405 &`${eval:2+42%5} `& yields 4
9406 &`${eval:0xc&5} `& yields 4
9407 &`${eval:0xc|5} `& yields 13
9408 &`${eval:0xc^5} `& yields 9
9409 &`${eval:0xc>>1} `& yields 6
9410 &`${eval:0xc<<1} `& yields 24
9411 &`${eval:~255&0x1234} `& yields 4608
9412 &`${eval:-(~255&0x1234)} `& yields -4608
9415 As a more realistic example, in an ACL you might have
9417 deny message = Too many bad recipients
9420 {>{$rcpt_count}{10}} \
9423 {$recipients_count} \
9424 {${eval:$rcpt_count/2}} \
9428 The condition is true if there have been more than 10 RCPT commands and
9429 fewer than half of them have resulted in a valid recipient.
9432 .vitem &*${expand:*&<&'string'&>&*}*&
9433 .cindex "expansion" "re-expansion of substring"
9434 The &%expand%& operator causes a string to be expanded for a second time. For
9437 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
9439 first looks up a string in a file while expanding the operand for &%expand%&,
9440 and then re-expands what it has found.
9443 .vitem &*${from_utf8:*&<&'string'&>&*}*&
9445 .cindex "UTF-8" "conversion from"
9446 .cindex "expansion" "UTF-8 conversion"
9447 .cindex "&%from_utf8%& expansion item"
9448 The world is slowly moving towards Unicode, although there are no standards for
9449 email yet. However, other applications (including some databases) are starting
9450 to store data in Unicode, using UTF-8 encoding. This operator converts from a
9451 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
9452 converted to underscores. The input must be a valid UTF-8 string. If it is not,
9453 the result is an undefined sequence of bytes.
9455 Unicode code points with values less than 256 are compatible with ASCII and
9456 ISO-8859-1 (also known as Latin-1).
9457 For example, character 169 is the copyright symbol in both cases, though the
9458 way it is encoded is different. In UTF-8, more than one byte is needed for
9459 characters with code values greater than 127, whereas ISO-8859-1 is a
9460 single-byte encoding (but thereby limited to 256 characters). This makes
9461 translation from UTF-8 to ISO-8859-1 straightforward.
9464 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
9465 .cindex "hash function" "textual"
9466 .cindex "expansion" "textual hash"
9467 The &%hash%& operator is a simpler interface to the hashing function that can
9468 be used when the two parameters are fixed numbers (as opposed to strings that
9469 change when expanded). The effect is the same as
9471 ${hash{<n>}{<m>}{<string>}}
9473 See the description of the general &%hash%& item above for details. The
9474 abbreviation &%h%& can be used when &%hash%& is used as an operator.
9478 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
9479 .cindex "base64 encoding" "conversion from hex"
9480 .cindex "expansion" "hex to base64"
9481 .cindex "&%hex2b64%& expansion item"
9482 This operator converts a hex string into one that is base64 encoded. This can
9483 be useful for processing the output of the MD5 and SHA-1 hashing functions.
9486 .vitem &*${lc:*&<&'string'&>&*}*&
9487 .cindex "case forcing in strings"
9488 .cindex "string" "case forcing"
9489 .cindex "lower casing"
9490 .cindex "expansion" "case forcing"
9491 .cindex "&%lc%& expansion item"
9492 This forces the letters in the string into lower-case, for example:
9497 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
9498 .cindex "expansion" "string truncation"
9499 .cindex "&%length%& expansion item"
9500 The &%length%& operator is a simpler interface to the &%length%& function that
9501 can be used when the parameter is a fixed number (as opposed to a string that
9502 changes when expanded). The effect is the same as
9504 ${length{<number>}{<string>}}
9506 See the description of the general &%length%& item above for details. Note that
9507 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
9508 when &%length%& is used as an operator.
9511 .vitem &*${local_part:*&<&'string'&>&*}*&
9512 .cindex "expansion" "local part extraction"
9513 .cindex "&%local_part%& expansion item"
9514 The string is interpreted as an RFC 2822 address and the local part is
9515 extracted from it. If the string does not parse successfully, the result is
9519 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
9520 .cindex "masked IP address"
9521 .cindex "IP address" "masking"
9522 .cindex "CIDR notation"
9523 .cindex "expansion" "IP address masking"
9524 .cindex "&%mask%& expansion item"
9525 If the form of the string to be operated on is not an IP address followed by a
9526 slash and an integer (that is, a network address in CIDR notation), the
9527 expansion fails. Otherwise, this operator converts the IP address to binary,
9528 masks off the least significant bits according to the bit count, and converts
9529 the result back to text, with mask appended. For example,
9531 ${mask:10.111.131.206/28}
9533 returns the string &"10.111.131.192/28"&. Since this operation is expected to
9534 be mostly used for looking up masked addresses in files, the result for an IPv6
9535 address uses dots to separate components instead of colons, because colon
9536 terminates a key string in lsearch files. So, for example,
9538 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
9542 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
9544 Letters in IPv6 addresses are always output in lower case.
9547 .vitem &*${md5:*&<&'string'&>&*}*&
9549 .cindex "expansion" "MD5 hash"
9550 .cindex "&%md5%& expansion item"
9551 The &%md5%& operator computes the MD5 hash value of the string, and returns it
9552 as a 32-digit hexadecimal number, in which any letters are in lower case.
9555 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
9556 .cindex "expansion" "numeric hash"
9557 .cindex "hash function" "numeric"
9558 The &%nhash%& operator is a simpler interface to the numeric hashing function
9559 that can be used when the two parameters are fixed numbers (as opposed to
9560 strings that change when expanded). The effect is the same as
9562 ${nhash{<n>}{<m>}{<string>}}
9564 See the description of the general &%nhash%& item above for details.
9567 .vitem &*${quote:*&<&'string'&>&*}*&
9568 .cindex "quoting" "in string expansions"
9569 .cindex "expansion" "quoting"
9570 .cindex "&%quote%& expansion item"
9571 The &%quote%& operator puts its argument into double quotes if it
9572 is an empty string or
9573 contains anything other than letters, digits, underscores, dots, and hyphens.
9574 Any occurrences of double quotes and backslashes are escaped with a backslash.
9575 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
9576 respectively For example,
9584 The place where this is useful is when the argument is a substitution from a
9585 variable or a message header.
9587 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
9588 .cindex "&%quote_local_part%& expansion item"
9589 This operator is like &%quote%&, except that it quotes the string only if
9590 required to do so by the rules of RFC 2822 for quoting local parts. For
9591 example, a plus sign would not cause quoting (but it would for &%quote%&).
9592 If you are creating a new email address from the contents of &$local_part$&
9593 (or any other unknown data), you should always use this operator.
9596 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
9597 .cindex "quoting" "lookup-specific"
9598 This operator applies lookup-specific quoting rules to the string. Each
9599 query-style lookup type has its own quoting rules which are described with
9600 the lookups in chapter &<<CHAPfdlookup>>&. For example,
9602 ${quote_ldap:two * two}
9608 For single-key lookup types, no quoting is ever necessary and this operator
9609 yields an unchanged string.
9612 .vitem &*${randint:*&<&'n'&>&*}*&
9613 .cindex "random number"
9614 This operator returns a somewhat random number which is less than the
9615 supplied number and is at least 0. The quality of this randomness depends
9616 on how Exim was built; the values are not suitable for keying material.
9617 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
9618 Otherwise, the implementation may be arc4random(), random() seeded by
9619 srandomdev() or srandom(), or a custom implementation even weaker than
9623 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
9624 .cindex "expansion" "IP address"
9625 This operator reverses an IP address; for IPv4 addresses, the result is in
9626 dotted-quad decimal form, while for IPv6 addreses the result is in
9627 dotted-nibble hexadecimal form. In both cases, this is the "natural" form
9628 for DNS. For example,
9630 ${reverse_ip:192.0.2.4} and ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.3}
9634 4.2.0.192 and 3.0.2.0.0.0.0.c.d.c.b.a.1.0.0.0.9.0.0.0.2.4.c.0.8.b.d.0.1.0.0.2
9638 .vitem &*${rfc2047:*&<&'string'&>&*}*&
9639 .cindex "expansion" "RFC 2047"
9640 .cindex "RFC 2047" "expansion operator"
9641 .cindex "&%rfc2047%& expansion item"
9642 This operator encodes text according to the rules of RFC 2047. This is an
9643 encoding that is used in header lines to encode non-ASCII characters. It is
9644 assumed that the input string is in the encoding specified by the
9645 &%headers_charset%& option, which defaults to ISO-8859-1. If the string
9646 contains only characters in the range 33&--126, and no instances of the
9649 ? = ( ) < > @ , ; : \ " . [ ] _
9651 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
9652 string, using as many &"encoded words"& as necessary to encode all the
9656 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
9657 .cindex "expansion" "RFC 2047"
9658 .cindex "RFC 2047" "decoding"
9659 .cindex "&%rfc2047d%& expansion item"
9660 This operator decodes strings that are encoded as per RFC 2047. Binary zero
9661 bytes are replaced by question marks. Characters are converted into the
9662 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
9663 not recognized unless &%check_rfc2047_length%& is set false.
9665 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
9666 access a header line, RFC 2047 decoding is done automatically. You do not need
9667 to use this operator as well.
9671 .vitem &*${rxquote:*&<&'string'&>&*}*&
9672 .cindex "quoting" "in regular expressions"
9673 .cindex "regular expressions" "quoting"
9674 .cindex "&%rxquote%& expansion item"
9675 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
9676 characters in its argument. This is useful when substituting the values of
9677 variables or headers inside regular expressions.
9680 .vitem &*${sha1:*&<&'string'&>&*}*&
9681 .cindex "SHA-1 hash"
9682 .cindex "expansion" "SHA-1 hashing"
9683 .cindex "&%sha2%& expansion item"
9684 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
9685 it as a 40-digit hexadecimal number, in which any letters are in upper case.
9688 .vitem &*${stat:*&<&'string'&>&*}*&
9689 .cindex "expansion" "statting a file"
9690 .cindex "file" "extracting characteristics"
9691 .cindex "&%stat%& expansion item"
9692 The string, after expansion, must be a file path. A call to the &[stat()]&
9693 function is made for this path. If &[stat()]& fails, an error occurs and the
9694 expansion fails. If it succeeds, the data from the stat replaces the item, as a
9695 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
9696 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
9697 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
9698 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
9699 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
9700 can extract individual fields using the &%extract%& expansion item.
9702 The use of the &%stat%& expansion in users' filter files can be locked out by
9703 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
9704 systems for files larger than 2GB.
9706 .vitem &*${str2b64:*&<&'string'&>&*}*&
9707 .cindex "expansion" "base64 encoding"
9708 .cindex "base64 encoding" "in string expansion"
9709 .cindex "&%str2b64%& expansion item"
9710 This operator converts a string into one that is base64 encoded.
9714 .vitem &*${strlen:*&<&'string'&>&*}*&
9715 .cindex "expansion" "string length"
9716 .cindex "string" "length in expansion"
9717 .cindex "&%strlen%& expansion item"
9718 The item is replace by the length of the expanded string, expressed as a
9719 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
9722 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
9723 .cindex "&%substr%& expansion item"
9724 .cindex "substring extraction"
9725 .cindex "expansion" "substring expansion"
9726 The &%substr%& operator is a simpler interface to the &%substr%& function that
9727 can be used when the two parameters are fixed numbers (as opposed to strings
9728 that change when expanded). The effect is the same as
9730 ${substr{<start>}{<length>}{<string>}}
9732 See the description of the general &%substr%& item above for details. The
9733 abbreviation &%s%& can be used when &%substr%& is used as an operator.
9735 .vitem &*${time_eval:*&<&'string'&>&*}*&
9736 .cindex "&%time_eval%& expansion item"
9737 .cindex "time interval" "decoding"
9738 This item converts an Exim time interval such as &`2d4h5m`& into a number of
9741 .vitem &*${time_interval:*&<&'string'&>&*}*&
9742 .cindex "&%time_interval%& expansion item"
9743 .cindex "time interval" "formatting"
9744 The argument (after sub-expansion) must be a sequence of decimal digits that
9745 represents an interval of time as a number of seconds. It is converted into a
9746 number of larger units and output in Exim's normal time format, for example,
9749 .vitem &*${uc:*&<&'string'&>&*}*&
9750 .cindex "case forcing in strings"
9751 .cindex "string" "case forcing"
9752 .cindex "upper casing"
9753 .cindex "expansion" "case forcing"
9754 .cindex "&%uc%& expansion item"
9755 This forces the letters in the string into upper-case.
9763 .section "Expansion conditions" "SECTexpcond"
9764 .scindex IIDexpcond "expansion" "conditions"
9765 The following conditions are available for testing by the &%${if%& construct
9766 while expanding strings:
9769 .vitem &*!*&<&'condition'&>
9770 .cindex "expansion" "negating a condition"
9771 .cindex "negation" "in expansion condition"
9772 Preceding any condition with an exclamation mark negates the result of the
9775 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
9776 .cindex "numeric comparison"
9777 .cindex "expansion" "numeric comparison"
9778 There are a number of symbolic operators for doing numeric comparisons. They
9784 &`>= `& greater or equal
9786 &`<= `& less or equal
9790 ${if >{$message_size}{10M} ...
9792 Note that the general negation operator provides for inequality testing. The
9793 two strings must take the form of optionally signed decimal integers,
9794 optionally followed by one of the letters &"K"& or &"M"& (in either upper or
9795 lower case), signifying multiplication by 1024 or 1024*1024, respectively.
9796 As a special case, the numerical value of an empty string is taken as
9799 .vitem &*bool&~{*&<&'string'&>&*}*&
9800 .cindex "expansion" "boolean parsing"
9801 .cindex "&%bool%& expansion condition"
9802 This condition turns a string holding a true or false representation into
9803 a boolean state. It parses &"true"&, &"false"&, &"yes"& and &"no"&
9804 (case-insensitively); also positive integer numbers map to true if non-zero,
9805 false if zero. Leading whitespace is ignored.
9806 All other string values will result in expansion failure.
9808 When combined with ACL variables, this expansion condition will let you
9809 make decisions in one place and act on those decisions in another place.
9812 ${if bool{$acl_m_privileged_sender} ...
9815 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
9816 .cindex "expansion" "encrypted comparison"
9817 .cindex "encrypted strings, comparing"
9818 .cindex "&%crypteq%& expansion condition"
9819 This condition is included in the Exim binary if it is built to support any
9820 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
9821 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
9822 included in the binary.
9824 The &%crypteq%& condition has two arguments. The first is encrypted and
9825 compared against the second, which is already encrypted. The second string may
9826 be in the LDAP form for storing encrypted strings, which starts with the
9827 encryption type in curly brackets, followed by the data. If the second string
9828 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
9829 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
9830 Typically this will be a field from a password file. An example of an encrypted
9831 string in LDAP form is:
9833 {md5}CY9rzUYh03PK3k6DJie09g==
9835 If such a string appears directly in an expansion, the curly brackets have to
9836 be quoted, because they are part of the expansion syntax. For example:
9838 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
9840 The following encryption types (whose names are matched case-independently) are
9845 .cindex "base64 encoding" "in encrypted password"
9846 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
9847 printable characters to compare with the remainder of the second string. If the
9848 length of the comparison string is 24, Exim assumes that it is base64 encoded
9849 (as in the above example). If the length is 32, Exim assumes that it is a
9850 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
9854 .cindex "SHA-1 hash"
9855 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
9856 printable characters to compare with the remainder of the second string. If the
9857 length of the comparison string is 28, Exim assumes that it is base64 encoded.
9858 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
9859 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
9862 .cindex "&[crypt()]&"
9863 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
9864 only the first eight characters of the password. However, in modern operating
9865 systems this is no longer true, and in many cases the entire password is used,
9866 whatever its length.
9869 .cindex "&[crypt16()]&"
9870 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
9871 use up to 16 characters of the password in some operating systems. Again, in
9872 modern operating systems, more characters may be used.
9874 Exim has its own version of &[crypt16()]&, which is just a double call to
9875 &[crypt()]&. For operating systems that have their own version, setting
9876 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
9877 operating system version instead of its own. This option is set by default in
9878 the OS-dependent &_Makefile_& for those operating systems that are known to
9879 support &[crypt16()]&.
9881 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
9882 it was not using the same algorithm as some operating systems' versions. It
9883 turns out that as well as &[crypt16()]& there is a function called
9884 &[bigcrypt()]& in some operating systems. This may or may not use the same
9885 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
9887 However, since there is now a move away from the traditional &[crypt()]&
9888 functions towards using SHA1 and other algorithms, tidying up this area of
9889 Exim is seen as very low priority.
9891 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
9892 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
9893 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
9894 default is &`{crypt}`&. Whatever the default, you can always use either
9895 function by specifying it explicitly in curly brackets.
9897 .vitem &*def:*&<&'variable&~name'&>
9898 .cindex "expansion" "checking for empty variable"
9899 .cindex "&%def%& expansion condition"
9900 The &%def%& condition must be followed by the name of one of the expansion
9901 variables defined in section &<<SECTexpvar>>&. The condition is true if the
9902 variable does not contain the empty string. For example:
9904 ${if def:sender_ident {from $sender_ident}}
9906 Note that the variable name is given without a leading &%$%& character. If the
9907 variable does not exist, the expansion fails.
9909 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
9910 &~&*def:h_*&<&'header&~name'&>&*:*&"
9911 .cindex "expansion" "checking header line existence"
9912 This condition is true if a message is being processed and the named header
9913 exists in the message. For example,
9915 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
9917 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
9918 the header name must be terminated by a colon if white space does not follow.
9920 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
9921 &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
9922 .cindex "string" "comparison"
9923 .cindex "expansion" "string comparison"
9924 .cindex "&%eq%& expansion condition"
9925 .cindex "&%eqi%& expansion condition"
9926 The two substrings are first expanded. The condition is true if the two
9927 resulting strings are identical. For &%eq%& the comparison includes the case of
9928 letters, whereas for &%eqi%& the comparison is case-independent.
9930 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
9931 .cindex "expansion" "file existence test"
9932 .cindex "file" "existence test"
9933 .cindex "&%exists%&, expansion condition"
9934 The substring is first expanded and then interpreted as an absolute path. The
9935 condition is true if the named file (or directory) exists. The existence test
9936 is done by calling the &[stat()]& function. The use of the &%exists%& test in
9937 users' filter files may be locked out by the system administrator.
9939 .vitem &*first_delivery*&
9940 .cindex "delivery" "first"
9941 .cindex "first delivery"
9942 .cindex "expansion" "first delivery test"
9943 .cindex "&%first_delivery%& expansion condition"
9944 This condition, which has no data, is true during a message's first delivery
9945 attempt. It is false during any subsequent delivery attempts.
9948 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
9949 "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
9950 .cindex "list" "iterative conditions"
9951 .cindex "expansion" "&*forall*& condition"
9952 .cindex "expansion" "&*forany*& condition"
9954 These conditions iterate over a list. The first argument is expanded to form
9955 the list. By default, the list separator is a colon, but it can be changed by
9956 the normal method. The second argument is interpreted as a condition that is to
9957 be applied to each item in the list in turn. During the interpretation of the
9958 condition, the current list item is placed in a variable called &$item$&.
9960 For &*forany*&, interpretation stops if the condition is true for any item, and
9961 the result of the whole condition is true. If the condition is false for all
9962 items in the list, the overall condition is false.
9964 For &*forall*&, interpretation stops if the condition is false for any item,
9965 and the result of the whole condition is false. If the condition is true for
9966 all items in the list, the overall condition is true.
9968 Note that negation of &*forany*& means that the condition must be false for all
9969 items for the overall condition to succeed, and negation of &*forall*& means
9970 that the condition must be false for at least one item. In this example, the
9971 list separator is changed to a comma:
9973 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
9975 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
9976 being processed, to enable these expansion items to be nested.
9979 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
9980 &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
9981 .cindex "string" "comparison"
9982 .cindex "expansion" "string comparison"
9983 .cindex "&%ge%& expansion condition"
9984 .cindex "&%gei%& expansion condition"
9985 The two substrings are first expanded. The condition is true if the first
9986 string is lexically greater than or equal to the second string. For &%ge%& the
9987 comparison includes the case of letters, whereas for &%gei%& the comparison is
9990 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
9991 &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
9992 .cindex "string" "comparison"
9993 .cindex "expansion" "string comparison"
9994 .cindex "&%gt%& expansion condition"
9995 .cindex "&%gti%& expansion condition"
9996 The two substrings are first expanded. The condition is true if the first
9997 string is lexically greater than the second string. For &%gt%& the comparison
9998 includes the case of letters, whereas for &%gti%& the comparison is
10001 .vitem &*isip&~{*&<&'string'&>&*}*& &&&
10002 &*isip4&~{*&<&'string'&>&*}*& &&&
10003 &*isip6&~{*&<&'string'&>&*}*&
10004 .cindex "IP address" "testing string format"
10005 .cindex "string" "testing for IP address"
10006 .cindex "&%isip%& expansion condition"
10007 .cindex "&%isip4%& expansion condition"
10008 .cindex "&%isip6%& expansion condition"
10009 The substring is first expanded, and then tested to see if it has the form of
10010 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
10011 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
10013 For an IPv4 address, the test is for four dot-separated components, each of
10014 which consists of from one to three digits. For an IPv6 address, up to eight
10015 colon-separated components are permitted, each containing from one to four
10016 hexadecimal digits. There may be fewer than eight components if an empty
10017 component (adjacent colons) is present. Only one empty component is permitted.
10019 &*Note*&: The checks are just on the form of the address; actual numerical
10020 values are not considered. Thus, for example, 999.999.999.999 passes the IPv4
10021 check. The main use of these tests is to distinguish between IP addresses and
10022 host names, or between IPv4 and IPv6 addresses. For example, you could use
10024 ${if isip4{$sender_host_address}...
10026 to test which IP version an incoming SMTP connection is using.
10028 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
10029 .cindex "LDAP" "use for authentication"
10030 .cindex "expansion" "LDAP authentication test"
10031 .cindex "&%ldapauth%& expansion condition"
10032 This condition supports user authentication using LDAP. See section
10033 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
10034 queries. For this use, the query must contain a user name and password. The
10035 query itself is not used, and can be empty. The condition is true if the
10036 password is not empty, and the user name and password are accepted by the LDAP
10037 server. An empty password is rejected without calling LDAP because LDAP binds
10038 with an empty password are considered anonymous regardless of the username, and
10039 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
10040 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
10044 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10045 &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10046 .cindex "string" "comparison"
10047 .cindex "expansion" "string comparison"
10048 .cindex "&%le%& expansion condition"
10049 .cindex "&%lei%& expansion condition"
10050 The two substrings are first expanded. The condition is true if the first
10051 string is lexically less than or equal to the second string. For &%le%& the
10052 comparison includes the case of letters, whereas for &%lei%& the comparison is
10055 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10056 &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10057 .cindex "string" "comparison"
10058 .cindex "expansion" "string comparison"
10059 .cindex "&%lt%& expansion condition"
10060 .cindex "&%lti%& expansion condition"
10061 The two substrings are first expanded. The condition is true if the first
10062 string is lexically less than the second string. For &%lt%& the comparison
10063 includes the case of letters, whereas for &%lti%& the comparison is
10067 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10068 .cindex "expansion" "regular expression comparison"
10069 .cindex "regular expressions" "match in expanded string"
10070 .cindex "&%match%& expansion condition"
10071 The two substrings are first expanded. The second is then treated as a regular
10072 expression and applied to the first. Because of the pre-expansion, if the
10073 regular expression contains dollar, or backslash characters, they must be
10074 escaped. Care must also be taken if the regular expression contains braces
10075 (curly brackets). A closing brace must be escaped so that it is not taken as a
10076 premature termination of <&'string2'&>. The easiest approach is to use the
10077 &`\N`& feature to disable expansion of the regular expression.
10080 ${if match {$local_part}{\N^\d{3}\N} ...
10082 If the whole expansion string is in double quotes, further escaping of
10083 backslashes is also required.
10085 The condition is true if the regular expression match succeeds.
10086 The regular expression is not required to begin with a circumflex
10087 metacharacter, but if there is no circumflex, the expression is not anchored,
10088 and it may match anywhere in the subject, not just at the start. If you want
10089 the pattern to match at the end of the subject, you must include the &`$`&
10090 metacharacter at an appropriate point.
10092 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
10093 At the start of an &%if%& expansion the values of the numeric variable
10094 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
10095 succeeds causes them to be reset to the substrings of that condition and they
10096 will have these values during the expansion of the success string. At the end
10097 of the &%if%& expansion, the previous values are restored. After testing a
10098 combination of conditions using &%or%&, the subsequent values of the numeric
10099 variables are those of the condition that succeeded.
10101 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10102 .cindex "&%match_address%& expansion condition"
10103 See &*match_local_part*&.
10105 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10106 .cindex "&%match_domain%& expansion condition"
10107 See &*match_local_part*&.
10109 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10110 .cindex "&%match_ip%& expansion condition"
10111 This condition matches an IP address to a list of IP address patterns. It must
10112 be followed by two argument strings. The first (after expansion) must be an IP
10113 address or an empty string. The second (after expansion) is a restricted host
10114 list that can match only an IP address, not a host name. For example:
10116 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
10118 The specific types of host list item that are permitted in the list are:
10121 An IP address, optionally with a CIDR mask.
10123 A single asterisk, which matches any IP address.
10125 An empty item, which matches only if the IP address is empty. This could be
10126 useful for testing for a locally submitted message or one from specific hosts
10127 in a single test such as
10128 . ==== As this is a nested list, any displays it contains must be indented
10129 . ==== as otherwise they are too far to the left. This comment applies to
10130 . ==== the use of xmlto plus fop. There's no problem when formatting with
10131 . ==== sdop, with or without the extra indent.
10133 ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
10135 where the first item in the list is the empty string.
10137 The item @[] matches any of the local host's interface addresses.
10139 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
10140 even if &`net-`& is not specified. There is never any attempt to turn the IP
10141 address into a host name. The most common type of linear search for
10142 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
10143 masks. For example:
10145 ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
10147 It is of course possible to use other kinds of lookup, and in such a case, you
10148 do need to specify the &`net-`& prefix if you want to specify a specific
10149 address mask, for example:
10151 ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
10153 However, unless you are combining a &%match_ip%& condition with others, it is
10154 just as easy to use the fact that a lookup is itself a condition, and write:
10156 ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
10160 Consult section &<<SECThoslispatip>>& for further details of these patterns.
10162 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10163 .cindex "domain list" "in expansion condition"
10164 .cindex "address list" "in expansion condition"
10165 .cindex "local part" "list, in expansion condition"
10166 .cindex "&%match_local_part%& expansion condition"
10167 This condition, together with &%match_address%& and &%match_domain%&, make it
10168 possible to test domain, address, and local part lists within expansions. Each
10169 condition requires two arguments: an item and a list to match. A trivial
10172 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
10174 In each case, the second argument may contain any of the allowable items for a
10175 list of the appropriate type. Also, because the second argument (after
10176 expansion) is a standard form of list, it is possible to refer to a named list.
10177 Thus, you can use conditions like this:
10179 ${if match_domain{$domain}{+local_domains}{...
10181 .cindex "&`+caseful`&"
10182 For address lists, the matching starts off caselessly, but the &`+caseful`&
10183 item can be used, as in all address lists, to cause subsequent items to
10184 have their local parts matched casefully. Domains are always matched
10187 &*Note*&: Host lists are &'not'& supported in this way. This is because
10188 hosts have two identities: a name and an IP address, and it is not clear
10189 how to specify cleanly how such a test would work. However, IP addresses can be
10190 matched using &%match_ip%&.
10192 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
10193 .cindex "PAM authentication"
10194 .cindex "AUTH" "with PAM"
10195 .cindex "Solaris" "PAM support"
10196 .cindex "expansion" "PAM authentication test"
10197 .cindex "&%pam%& expansion condition"
10198 &'Pluggable Authentication Modules'&
10199 (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is
10200 available in the latest releases of Solaris and in some GNU/Linux
10201 distributions. The Exim support, which is intended for use in conjunction with
10202 the SMTP AUTH command, is available only if Exim is compiled with
10206 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
10207 in some releases of GNU/Linux &%-ldl%& is also needed.
10209 The argument string is first expanded, and the result must be a
10210 colon-separated list of strings. Leading and trailing white space is ignored.
10211 The PAM module is initialized with the service name &"exim"& and the user name
10212 taken from the first item in the colon-separated data string (<&'string1'&>).
10213 The remaining items in the data string are passed over in response to requests
10214 from the authentication function. In the simple case there will only be one
10215 request, for a password, so the data consists of just two strings.
10217 There can be problems if any of the strings are permitted to contain colon
10218 characters. In the usual way, these have to be doubled to avoid being taken as
10219 separators. If the data is being inserted from a variable, the &%sg%& expansion
10220 item can be used to double any existing colons. For example, the configuration
10221 of a LOGIN authenticator might contain this setting:
10223 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
10225 For a PLAIN authenticator you could use:
10227 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
10229 In some operating systems, PAM authentication can be done only from a process
10230 running as root. Since Exim is running as the Exim user when receiving
10231 messages, this means that PAM cannot be used directly in those systems.
10232 A patched version of the &'pam_unix'& module that comes with the
10233 Linux PAM package is available from &url(http://www.e-admin.de/pam_exim/).
10234 The patched module allows one special uid/gid combination, in addition to root,
10235 to authenticate. If you build the patched module to allow the Exim user and
10236 group, PAM can then be used from an Exim authenticator.
10239 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
10240 .cindex "&'pwcheck'& daemon"
10242 .cindex "expansion" "&'pwcheck'& authentication test"
10243 .cindex "&%pwcheck%& expansion condition"
10244 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
10245 This is one way of making it possible for passwords to be checked by a process
10246 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
10247 deprecated. Its replacement is &'saslauthd'& (see below).
10249 The pwcheck support is not included in Exim by default. You need to specify
10250 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
10251 building Exim. For example:
10253 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
10255 You do not need to install the full Cyrus software suite in order to use
10256 the pwcheck daemon. You can compile and install just the daemon alone
10257 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
10258 access to the &_/var/pwcheck_& directory.
10260 The &%pwcheck%& condition takes one argument, which must be the user name and
10261 password, separated by a colon. For example, in a LOGIN authenticator
10262 configuration, you might have this:
10264 server_condition = ${if pwcheck{$auth1:$auth2}}
10266 Again, for a PLAIN authenticator configuration, this would be:
10268 server_condition = ${if pwcheck{$auth2:$auth3}}
10270 .vitem &*queue_running*&
10271 .cindex "queue runner" "detecting when delivering from"
10272 .cindex "expansion" "queue runner test"
10273 .cindex "&%queue_running%& expansion condition"
10274 This condition, which has no data, is true during delivery attempts that are
10275 initiated by queue runner processes, and false otherwise.
10278 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
10280 .cindex "expansion" "Radius authentication"
10281 .cindex "&%radius%& expansion condition"
10282 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
10283 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
10284 the Radius client configuration file in order to build Exim with Radius
10287 With just that one setting, Exim expects to be linked with the &%radiusclient%&
10288 library, using the original API. If you are using release 0.4.0 or later of
10289 this library, you need to set
10291 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
10293 in &_Local/Makefile_& when building Exim. You can also link Exim with the
10294 &%libradius%& library that comes with FreeBSD. To do this, set
10296 RADIUS_LIB_TYPE=RADLIB
10298 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
10299 You may also have to supply a suitable setting in EXTRALIBS so that the
10300 Radius library can be found when Exim is linked.
10302 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
10303 Radius client library, which calls the Radius server. The condition is true if
10304 the authentication is successful. For example:
10306 server_condition = ${if radius{<arguments>}}
10310 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
10311 {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
10312 .cindex "&'saslauthd'& daemon"
10314 .cindex "expansion" "&'saslauthd'& authentication test"
10315 .cindex "&%saslauthd%& expansion condition"
10316 This condition supports user authentication using the Cyrus &'saslauthd'&
10317 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
10318 Using this daemon is one way of making it possible for passwords to be checked
10319 by a process that is not running as root.
10321 The saslauthd support is not included in Exim by default. You need to specify
10322 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
10323 building Exim. For example:
10325 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
10327 You do not need to install the full Cyrus software suite in order to use
10328 the saslauthd daemon. You can compile and install just the daemon alone
10329 from the Cyrus SASL library.
10331 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
10332 two are mandatory. For example:
10334 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
10336 The service and the realm are optional (which is why the arguments are enclosed
10337 in their own set of braces). For details of the meaning of the service and
10338 realm, and how to run the daemon, consult the Cyrus documentation.
10343 .section "Combining expansion conditions" "SECID84"
10344 .cindex "expansion" "combining conditions"
10345 Several conditions can be tested at once by combining them using the &%and%&
10346 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
10347 conditions on their own, and precede their lists of sub-conditions. Each
10348 sub-condition must be enclosed in braces within the overall braces that contain
10349 the list. No repetition of &%if%& is used.
10353 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
10354 .cindex "&""or""& expansion condition"
10355 .cindex "expansion" "&""or""& of conditions"
10356 The sub-conditions are evaluated from left to right. The condition is true if
10357 any one of the sub-conditions is true.
10360 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
10362 When a true sub-condition is found, the following ones are parsed but not
10363 evaluated. If there are several &"match"& sub-conditions the values of the
10364 numeric variables afterwards are taken from the first one that succeeds.
10366 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
10367 .cindex "&""and""& expansion condition"
10368 .cindex "expansion" "&""and""& of conditions"
10369 The sub-conditions are evaluated from left to right. The condition is true if
10370 all of the sub-conditions are true. If there are several &"match"&
10371 sub-conditions, the values of the numeric variables afterwards are taken from
10372 the last one. When a false sub-condition is found, the following ones are
10373 parsed but not evaluated.
10375 .ecindex IIDexpcond
10380 .section "Expansion variables" "SECTexpvar"
10381 .cindex "expansion" "variables, list of"
10382 This section contains an alphabetical list of all the expansion variables. Some
10383 of them are available only when Exim is compiled with specific options such as
10384 support for TLS or the content scanning extension.
10387 .vitem "&$0$&, &$1$&, etc"
10388 .cindex "numerical variables (&$1$& &$2$& etc)"
10389 When a &%match%& expansion condition succeeds, these variables contain the
10390 captured substrings identified by the regular expression during subsequent
10391 processing of the success string of the containing &%if%& expansion item.
10392 However, they do not retain their values afterwards; in fact, their previous
10393 values are restored at the end of processing an &%if%& item. The numerical
10394 variables may also be set externally by some other matching process which
10395 precedes the expansion of the string. For example, the commands available in
10396 Exim filter files include an &%if%& command with its own regular expression
10397 matching condition.
10399 .vitem "&$acl_c...$&"
10400 Values can be placed in these variables by the &%set%& modifier in an ACL. They
10401 can be given any name that starts with &$acl_c$& and is at least six characters
10402 long, but the sixth character must be either a digit or an underscore. For
10403 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
10404 variables persist throughout the lifetime of an SMTP connection. They can be
10405 used to pass information between ACLs and between different invocations of the
10406 same ACL. When a message is received, the values of these variables are saved
10407 with the message, and can be accessed by filters, routers, and transports
10408 during subsequent delivery.
10410 .vitem "&$acl_m...$&"
10411 These variables are like the &$acl_c...$& variables, except that their values
10412 are reset after a message has been received. Thus, if several messages are
10413 received in one SMTP connection, &$acl_m...$& values are not passed on from one
10414 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
10415 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
10416 message is received, the values of these variables are saved with the message,
10417 and can be accessed by filters, routers, and transports during subsequent
10420 .vitem &$acl_verify_message$&
10421 .vindex "&$acl_verify_message$&"
10422 After an address verification has failed, this variable contains the failure
10423 message. It retains its value for use in subsequent modifiers. The message can
10424 be preserved by coding like this:
10426 warn !verify = sender
10427 set acl_m0 = $acl_verify_message
10429 You can use &$acl_verify_message$& during the expansion of the &%message%& or
10430 &%log_message%& modifiers, to include information about the verification
10433 .vitem &$address_data$&
10434 .vindex "&$address_data$&"
10435 This variable is set by means of the &%address_data%& option in routers. The
10436 value then remains with the address while it is processed by subsequent routers
10437 and eventually a transport. If the transport is handling multiple addresses,
10438 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
10439 for more details. &*Note*&: The contents of &$address_data$& are visible in
10442 If &$address_data$& is set when the routers are called from an ACL to verify
10443 a recipient address, the final value is still in the variable for subsequent
10444 conditions and modifiers of the ACL statement. If routing the address caused it
10445 to be redirected to just one address, the child address is also routed as part
10446 of the verification, and in this case the final value of &$address_data$& is
10447 from the child's routing.
10449 If &$address_data$& is set when the routers are called from an ACL to verify a
10450 sender address, the final value is also preserved, but this time in
10451 &$sender_address_data$&, to distinguish it from data from a recipient
10454 In both cases (recipient and sender verification), the value does not persist
10455 after the end of the current ACL statement. If you want to preserve
10456 these values for longer, you can save them in ACL variables.
10458 .vitem &$address_file$&
10459 .vindex "&$address_file$&"
10460 When, as a result of aliasing, forwarding, or filtering, a message is directed
10461 to a specific file, this variable holds the name of the file when the transport
10462 is running. At other times, the variable is empty. For example, using the
10463 default configuration, if user &%r2d2%& has a &_.forward_& file containing
10465 /home/r2d2/savemail
10467 then when the &(address_file)& transport is running, &$address_file$&
10468 contains the text string &`/home/r2d2/savemail`&.
10469 .cindex "Sieve filter" "value of &$address_file$&"
10470 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
10471 then up to the transport configuration to generate an appropriate absolute path
10472 to the relevant file.
10474 .vitem &$address_pipe$&
10475 .vindex "&$address_pipe$&"
10476 When, as a result of aliasing or forwarding, a message is directed to a pipe,
10477 this variable holds the pipe command when the transport is running.
10479 .vitem "&$auth1$& &-- &$auth3$&"
10480 .vindex "&$auth1$&, &$auth2$&, etc"
10481 These variables are used in SMTP authenticators (see chapters
10482 &<<CHAPplaintext>>&&--&<<CHAPspa>>&). Elsewhere, they are empty.
10484 .vitem &$authenticated_id$&
10485 .cindex "authentication" "id"
10486 .vindex "&$authenticated_id$&"
10487 When a server successfully authenticates a client it may be configured to
10488 preserve some of the authentication information in the variable
10489 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
10490 user/password authenticator configuration might preserve the user name for use
10491 in the routers. Note that this is not the same information that is saved in
10492 &$sender_host_authenticated$&.
10493 When a message is submitted locally (that is, not over a TCP connection)
10494 the value of &$authenticated_id$& is normally the login name of the calling
10495 process. However, a trusted user can override this by means of the &%-oMai%&
10496 command line option.
10501 .vitem &$authenticated_sender$&
10502 .cindex "sender" "authenticated"
10503 .cindex "authentication" "sender"
10504 .cindex "AUTH" "on MAIL command"
10505 .vindex "&$authenticated_sender$&"
10506 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
10507 SMTP MAIL command if it believes the sender is sufficiently trusted, as
10508 described in section &<<SECTauthparamail>>&. Unless the data is the string
10509 &"<>"&, it is set as the authenticated sender of the message, and the value is
10510 available during delivery in the &$authenticated_sender$& variable. If the
10511 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
10513 .vindex "&$qualify_domain$&"
10514 When a message is submitted locally (that is, not over a TCP connection), the
10515 value of &$authenticated_sender$& is an address constructed from the login
10516 name of the calling process and &$qualify_domain$&, except that a trusted user
10517 can override this by means of the &%-oMas%& command line option.
10520 .vitem &$authentication_failed$&
10521 .cindex "authentication" "failure"
10522 .vindex "&$authentication_failed$&"
10523 This variable is set to &"1"& in an Exim server if a client issues an AUTH
10524 command that does not succeed. Otherwise it is set to &"0"&. This makes it
10525 possible to distinguish between &"did not try to authenticate"&
10526 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
10527 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
10528 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
10529 negative response to an AUTH command, including (for example) an attempt to use
10530 an undefined mechanism.
10532 .vitem &$body_linecount$&
10533 .cindex "message body" "line count"
10534 .cindex "body of message" "line count"
10535 .vindex "&$body_linecount$&"
10536 When a message is being received or delivered, this variable contains the
10537 number of lines in the message's body. See also &$message_linecount$&.
10539 .vitem &$body_zerocount$&
10540 .cindex "message body" "binary zero count"
10541 .cindex "body of message" "binary zero count"
10542 .cindex "binary zero" "in message body"
10543 .vindex "&$body_zerocount$&"
10544 When a message is being received or delivered, this variable contains the
10545 number of binary zero bytes in the message's body.
10547 .vitem &$bounce_recipient$&
10548 .vindex "&$bounce_recipient$&"
10549 This is set to the recipient address of a bounce message while Exim is creating
10550 it. It is useful if a customized bounce message text file is in use (see
10551 chapter &<<CHAPemsgcust>>&).
10553 .vitem &$bounce_return_size_limit$&
10554 .vindex "&$bounce_return_size_limit$&"
10555 This contains the value set in the &%bounce_return_size_limit%& option, rounded
10556 up to a multiple of 1000. It is useful when a customized error message text
10557 file is in use (see chapter &<<CHAPemsgcust>>&).
10559 .vitem &$caller_gid$&
10560 .cindex "gid (group id)" "caller"
10561 .vindex "&$caller_gid$&"
10562 The real group id under which the process that called Exim was running. This is
10563 not the same as the group id of the originator of a message (see
10564 &$originator_gid$&). If Exim re-execs itself, this variable in the new
10565 incarnation normally contains the Exim gid.
10567 .vitem &$caller_uid$&
10568 .cindex "uid (user id)" "caller"
10569 .vindex "&$caller_uid$&"
10570 The real user id under which the process that called Exim was running. This is
10571 not the same as the user id of the originator of a message (see
10572 &$originator_uid$&). If Exim re-execs itself, this variable in the new
10573 incarnation normally contains the Exim uid.
10575 .vitem &$compile_date$&
10576 .vindex "&$compile_date$&"
10577 The date on which the Exim binary was compiled.
10579 .vitem &$compile_number$&
10580 .vindex "&$compile_number$&"
10581 The building process for Exim keeps a count of the number
10582 of times it has been compiled. This serves to distinguish different
10583 compilations of the same version of the program.
10585 .vitem &$demime_errorlevel$&
10586 .vindex "&$demime_errorlevel$&"
10587 This variable is available when Exim is compiled with
10588 the content-scanning extension and the obsolete &%demime%& condition. For
10589 details, see section &<<SECTdemimecond>>&.
10591 .vitem &$demime_reason$&
10592 .vindex "&$demime_reason$&"
10593 This variable is available when Exim is compiled with the
10594 content-scanning extension and the obsolete &%demime%& condition. For details,
10595 see section &<<SECTdemimecond>>&.
10597 .vitem &$dnslist_domain$& &&&
10598 &$dnslist_matched$& &&&
10599 &$dnslist_text$& &&&
10601 .vindex "&$dnslist_domain$&"
10602 .vindex "&$dnslist_matched$&"
10603 .vindex "&$dnslist_text$&"
10604 .vindex "&$dnslist_value$&"
10605 .cindex "black list (DNS)"
10606 When a DNS (black) list lookup succeeds, these variables are set to contain
10607 the following data from the lookup: the list's domain name, the key that was
10608 looked up, the contents of any associated TXT record, and the value from the
10609 main A record. See section &<<SECID204>>& for more details.
10612 .vindex "&$domain$&"
10613 When an address is being routed, or delivered on its own, this variable
10614 contains the domain. Uppercase letters in the domain are converted into lower
10615 case for &$domain$&.
10617 Global address rewriting happens when a message is received, so the value of
10618 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
10619 is set during user filtering, but not during system filtering, because a
10620 message may have many recipients and the system filter is called just once.
10622 When more than one address is being delivered at once (for example, several
10623 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
10624 have the same domain. Transports can be restricted to handling only one domain
10625 at a time if the value of &$domain$& is required at transport time &-- this is
10626 the default for local transports. For further details of the environment in
10627 which local transports are run, see chapter &<<CHAPenvironment>>&.
10629 .oindex "&%delay_warning_condition%&"
10630 At the end of a delivery, if all deferred addresses have the same domain, it is
10631 set in &$domain$& during the expansion of &%delay_warning_condition%&.
10633 The &$domain$& variable is also used in some other circumstances:
10636 When an ACL is running for a RCPT command, &$domain$& contains the domain of
10637 the recipient address. The domain of the &'sender'& address is in
10638 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
10639 normally set during the running of the MAIL ACL. However, if the sender address
10640 is verified with a callout during the MAIL ACL, the sender domain is placed in
10641 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
10642 the &(smtp)& transport.
10645 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
10646 &$domain$& contains the domain portion of the address that is being rewritten;
10647 it can be used in the expansion of the replacement address, for example, to
10648 rewrite domains by file lookup.
10651 With one important exception, whenever a domain list is being scanned,
10652 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
10653 a &%sender_domains%& condition in an ACL is being processed, the subject domain
10654 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
10655 that, in a RCPT ACL, the sender domain list can be dependent on the
10656 recipient domain (which is what is in &$domain$& at this time).
10659 .cindex "ETRN" "value of &$domain$&"
10660 .oindex "&%smtp_etrn_command%&"
10661 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
10662 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
10666 .vitem &$domain_data$&
10667 .vindex "&$domain_data$&"
10668 When the &%domains%& option on a router matches a domain by
10669 means of a lookup, the data read by the lookup is available during the running
10670 of the router as &$domain_data$&. In addition, if the driver routes the
10671 address to a transport, the value is available in that transport. If the
10672 transport is handling multiple addresses, the value from the first address is
10675 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
10676 domain by means of a lookup. The data read by the lookup is available during
10677 the rest of the ACL statement. In all other situations, this variable expands
10680 .vitem &$exim_gid$&
10681 .vindex "&$exim_gid$&"
10682 This variable contains the numerical value of the Exim group id.
10684 .vitem &$exim_path$&
10685 .vindex "&$exim_path$&"
10686 This variable contains the path to the Exim binary.
10688 .vitem &$exim_uid$&
10689 .vindex "&$exim_uid$&"
10690 This variable contains the numerical value of the Exim user id.
10692 .vitem &$found_extension$&
10693 .vindex "&$found_extension$&"
10694 This variable is available when Exim is compiled with the
10695 content-scanning extension and the obsolete &%demime%& condition. For details,
10696 see section &<<SECTdemimecond>>&.
10698 .vitem &$header_$&<&'name'&>
10699 This is not strictly an expansion variable. It is expansion syntax for
10700 inserting the message header line with the given name. Note that the name must
10701 be terminated by colon or white space, because it may contain a wide variety of
10702 characters. Note also that braces must &'not'& be used.
10706 When the &%check_local_user%& option is set for a router, the user's home
10707 directory is placed in &$home$& when the check succeeds. In particular, this
10708 means it is set during the running of users' filter files. A router may also
10709 explicitly set a home directory for use by a transport; this can be overridden
10710 by a setting on the transport itself.
10712 When running a filter test via the &%-bf%& option, &$home$& is set to the value
10713 of the environment variable HOME.
10717 If a router assigns an address to a transport (any transport), and passes a
10718 list of hosts with the address, the value of &$host$& when the transport starts
10719 to run is the name of the first host on the list. Note that this applies both
10720 to local and remote transports.
10722 .cindex "transport" "filter"
10723 .cindex "filter" "transport filter"
10724 For the &(smtp)& transport, if there is more than one host, the value of
10725 &$host$& changes as the transport works its way through the list. In
10726 particular, when the &(smtp)& transport is expanding its options for encryption
10727 using TLS, or for specifying a transport filter (see chapter
10728 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
10731 When used in the client part of an authenticator configuration (see chapter
10732 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
10733 client is connected.
10736 .vitem &$host_address$&
10737 .vindex "&$host_address$&"
10738 This variable is set to the remote host's IP address whenever &$host$& is set
10739 for a remote connection. It is also set to the IP address that is being checked
10740 when the &%ignore_target_hosts%& option is being processed.
10742 .vitem &$host_data$&
10743 .vindex "&$host_data$&"
10744 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
10745 result of the lookup is made available in the &$host_data$& variable. This
10746 allows you, for example, to do things like this:
10748 deny hosts = net-lsearch;/some/file
10749 message = $host_data
10751 .vitem &$host_lookup_deferred$&
10752 .cindex "host name" "lookup, failure of"
10753 .vindex "&$host_lookup_deferred$&"
10754 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
10755 message comes from a remote host and there is an attempt to look up the host's
10756 name from its IP address, and the attempt is not successful, one of these
10757 variables is set to &"1"&.
10760 If the lookup receives a definite negative response (for example, a DNS lookup
10761 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
10764 If there is any kind of problem during the lookup, such that Exim cannot
10765 tell whether or not the host name is defined (for example, a timeout for a DNS
10766 lookup), &$host_lookup_deferred$& is set to &"1"&.
10769 Looking up a host's name from its IP address consists of more than just a
10770 single reverse lookup. Exim checks that a forward lookup of at least one of the
10771 names it receives from a reverse lookup yields the original IP address. If this
10772 is not the case, Exim does not accept the looked up name(s), and
10773 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
10774 IP address (for example, the existence of a PTR record in the DNS) is not
10775 sufficient on its own for the success of a host name lookup. If the reverse
10776 lookup succeeds, but there is a lookup problem such as a timeout when checking
10777 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
10778 &"1"&. See also &$sender_host_name$&.
10780 .vitem &$host_lookup_failed$&
10781 .vindex "&$host_lookup_failed$&"
10782 See &$host_lookup_deferred$&.
10786 .vindex "&$inode$&"
10787 The only time this variable is set is while expanding the &%directory_file%&
10788 option in the &(appendfile)& transport. The variable contains the inode number
10789 of the temporary file which is about to be renamed. It can be used to construct
10790 a unique name for the file.
10792 .vitem &$interface_address$&
10793 .vindex "&$interface_address$&"
10794 This is an obsolete name for &$received_ip_address$&.
10796 .vitem &$interface_port$&
10797 .vindex "&$interface_port$&"
10798 This is an obsolete name for &$received_port$&.
10802 This variable is used during the expansion of &*forall*& and &*forany*&
10803 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
10804 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
10808 .vindex "&$ldap_dn$&"
10809 This variable, which is available only when Exim is compiled with LDAP support,
10810 contains the DN from the last entry in the most recently successful LDAP
10813 .vitem &$load_average$&
10814 .vindex "&$load_average$&"
10815 This variable contains the system load average, multiplied by 1000 so that it
10816 is an integer. For example, if the load average is 0.21, the value of the
10817 variable is 210. The value is recomputed every time the variable is referenced.
10819 .vitem &$local_part$&
10820 .vindex "&$local_part$&"
10821 When an address is being routed, or delivered on its own, this
10822 variable contains the local part. When a number of addresses are being
10823 delivered together (for example, multiple RCPT commands in an SMTP
10824 session), &$local_part$& is not set.
10826 Global address rewriting happens when a message is received, so the value of
10827 &$local_part$& during routing and delivery is the value after rewriting.
10828 &$local_part$& is set during user filtering, but not during system filtering,
10829 because a message may have many recipients and the system filter is called just
10832 .vindex "&$local_part_prefix$&"
10833 .vindex "&$local_part_suffix$&"
10834 If a local part prefix or suffix has been recognized, it is not included in the
10835 value of &$local_part$& during routing and subsequent delivery. The values of
10836 any prefix or suffix are in &$local_part_prefix$& and
10837 &$local_part_suffix$&, respectively.
10839 When a message is being delivered to a file, pipe, or autoreply transport as a
10840 result of aliasing or forwarding, &$local_part$& is set to the local part of
10841 the parent address, not to the file name or command (see &$address_file$& and
10844 When an ACL is running for a RCPT command, &$local_part$& contains the
10845 local part of the recipient address.
10847 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
10848 &$local_part$& contains the local part of the address that is being rewritten;
10849 it can be used in the expansion of the replacement address, for example.
10851 In all cases, all quoting is removed from the local part. For example, for both
10854 "abc:xyz"@test.example
10855 abc\:xyz@test.example
10857 the value of &$local_part$& is
10861 If you use &$local_part$& to create another address, you should always wrap it
10862 inside a quoting operator. For example, in a &(redirect)& router you could
10865 data = ${quote_local_part:$local_part}@new.domain.example
10867 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
10868 to process local parts in a case-dependent manner in a router, you can set the
10869 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
10871 .vitem &$local_part_data$&
10872 .vindex "&$local_part_data$&"
10873 When the &%local_parts%& option on a router matches a local part by means of a
10874 lookup, the data read by the lookup is available during the running of the
10875 router as &$local_part_data$&. In addition, if the driver routes the address
10876 to a transport, the value is available in that transport. If the transport is
10877 handling multiple addresses, the value from the first address is used.
10879 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
10880 matches a local part by means of a lookup. The data read by the lookup is
10881 available during the rest of the ACL statement. In all other situations, this
10882 variable expands to nothing.
10884 .vitem &$local_part_prefix$&
10885 .vindex "&$local_part_prefix$&"
10886 When an address is being routed or delivered, and a
10887 specific prefix for the local part was recognized, it is available in this
10888 variable, having been removed from &$local_part$&.
10890 .vitem &$local_part_suffix$&
10891 .vindex "&$local_part_suffix$&"
10892 When an address is being routed or delivered, and a
10893 specific suffix for the local part was recognized, it is available in this
10894 variable, having been removed from &$local_part$&.
10896 .vitem &$local_scan_data$&
10897 .vindex "&$local_scan_data$&"
10898 This variable contains the text returned by the &[local_scan()]& function when
10899 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
10901 .vitem &$local_user_gid$&
10902 .vindex "&$local_user_gid$&"
10903 See &$local_user_uid$&.
10905 .vitem &$local_user_uid$&
10906 .vindex "&$local_user_uid$&"
10907 This variable and &$local_user_gid$& are set to the uid and gid after the
10908 &%check_local_user%& router precondition succeeds. This means that their values
10909 are available for the remaining preconditions (&%senders%&, &%require_files%&,
10910 and &%condition%&), for the &%address_data%& expansion, and for any
10911 router-specific expansions. At all other times, the values in these variables
10912 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
10914 .vitem &$localhost_number$&
10915 .vindex "&$localhost_number$&"
10916 This contains the expanded value of the
10917 &%localhost_number%& option. The expansion happens after the main options have
10920 .vitem &$log_inodes$&
10921 .vindex "&$log_inodes$&"
10922 The number of free inodes in the disk partition where Exim's
10923 log files are being written. The value is recalculated whenever the variable is
10924 referenced. If the relevant file system does not have the concept of inodes,
10925 the value of is -1. See also the &%check_log_inodes%& option.
10927 .vitem &$log_space$&
10928 .vindex "&$log_space$&"
10929 The amount of free space (as a number of kilobytes) in the disk
10930 partition where Exim's log files are being written. The value is recalculated
10931 whenever the variable is referenced. If the operating system does not have the
10932 ability to find the amount of free space (only true for experimental systems),
10933 the space value is -1. See also the &%check_log_space%& option.
10936 .vitem &$mailstore_basename$&
10937 .vindex "&$mailstore_basename$&"
10938 This variable is set only when doing deliveries in &"mailstore"& format in the
10939 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
10940 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
10941 contains the basename of the files that are being written, that is, the name
10942 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
10945 .vitem &$malware_name$&
10946 .vindex "&$malware_name$&"
10947 This variable is available when Exim is compiled with the
10948 content-scanning extension. It is set to the name of the virus that was found
10949 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
10951 .vitem &$max_received_linelength$&
10952 .vindex "&$max_received_linelength$&"
10953 .cindex "maximum" "line length"
10954 .cindex "line length" "maximum"
10955 This variable contains the number of bytes in the longest line that was
10956 received as part of the message, not counting the line termination
10959 .vitem &$message_age$&
10960 .cindex "message" "age of"
10961 .vindex "&$message_age$&"
10962 This variable is set at the start of a delivery attempt to contain the number
10963 of seconds since the message was received. It does not change during a single
10966 .vitem &$message_body$&
10967 .cindex "body of message" "expansion variable"
10968 .cindex "message body" "in expansion"
10969 .cindex "binary zero" "in message body"
10970 .vindex "&$message_body$&"
10971 .oindex "&%message_body_visible%&"
10972 This variable contains the initial portion of a message's body while it is
10973 being delivered, and is intended mainly for use in filter files. The maximum
10974 number of characters of the body that are put into the variable is set by the
10975 &%message_body_visible%& configuration option; the default is 500.
10977 .oindex "&%message_body_newlines%&"
10978 By default, newlines are converted into spaces in &$message_body$&, to make it
10979 easier to search for phrases that might be split over a line break. However,
10980 this can be disabled by setting &%message_body_newlines%& to be true. Binary
10981 zeros are always converted into spaces.
10983 .vitem &$message_body_end$&
10984 .cindex "body of message" "expansion variable"
10985 .cindex "message body" "in expansion"
10986 .vindex "&$message_body_end$&"
10987 This variable contains the final portion of a message's
10988 body while it is being delivered. The format and maximum size are as for
10991 .vitem &$message_body_size$&
10992 .cindex "body of message" "size"
10993 .cindex "message body" "size"
10994 .vindex "&$message_body_size$&"
10995 When a message is being delivered, this variable contains the size of the body
10996 in bytes. The count starts from the character after the blank line that
10997 separates the body from the header. Newlines are included in the count. See
10998 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
11000 .vitem &$message_exim_id$&
11001 .vindex "&$message_exim_id$&"
11002 When a message is being received or delivered, this variable contains the
11003 unique message id that is generated and used by Exim to identify the message.
11004 An id is not created for a message until after its header has been successfully
11005 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
11006 line; it is the local id that Exim assigns to the message, for example:
11007 &`1BXTIK-0001yO-VA`&.
11009 .vitem &$message_headers$&
11010 .vindex &$message_headers$&
11011 This variable contains a concatenation of all the header lines when a message
11012 is being processed, except for lines added by routers or transports. The header
11013 lines are separated by newline characters. Their contents are decoded in the
11014 same way as a header line that is inserted by &%bheader%&.
11016 .vitem &$message_headers_raw$&
11017 .vindex &$message_headers_raw$&
11018 This variable is like &$message_headers$& except that no processing of the
11019 contents of header lines is done.
11021 .vitem &$message_id$&
11022 This is an old name for &$message_exim_id$&, which is now deprecated.
11024 .vitem &$message_linecount$&
11025 .vindex "&$message_linecount$&"
11026 This variable contains the total number of lines in the header and body of the
11027 message. Compare &$body_linecount$&, which is the count for the body only.
11028 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
11029 number of lines received. Before delivery happens (that is, before filters,
11030 routers, and transports run) the count is increased to include the
11031 &'Received:'& header line that Exim standardly adds, and also any other header
11032 lines that are added by ACLs. The blank line that separates the message header
11033 from the body is not counted. Here is an example of the use of this variable in
11036 deny message = Too many lines in message header
11038 ${if <{250}{${eval:$message_linecount - $body_linecount}}}
11040 In the MAIL and RCPT ACLs, the value is zero because at that stage the
11041 message has not yet been received.
11043 .vitem &$message_size$&
11044 .cindex "size" "of message"
11045 .cindex "message" "size"
11046 .vindex "&$message_size$&"
11047 When a message is being processed, this variable contains its size in bytes. In
11048 most cases, the size includes those headers that were received with the
11049 message, but not those (such as &'Envelope-to:'&) that are added to individual
11050 deliveries as they are written. However, there is one special case: during the
11051 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
11052 doing a delivery in maildir format, the value of &$message_size$& is the
11053 precise size of the file that has been written. See also
11054 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
11056 .cindex "RCPT" "value of &$message_size$&"
11057 While running a per message ACL (mail/rcpt/predata), &$message_size$&
11058 contains the size supplied on the MAIL command, or -1 if no size was given. The
11059 value may not, of course, be truthful.
11061 .vitem &$mime_$&&'xxx'&
11062 A number of variables whose names start with &$mime$& are
11063 available when Exim is compiled with the content-scanning extension. For
11064 details, see section &<<SECTscanmimepart>>&.
11066 .vitem "&$n0$& &-- &$n9$&"
11067 These variables are counters that can be incremented by means
11068 of the &%add%& command in filter files.
11070 .vitem &$original_domain$&
11071 .vindex "&$domain$&"
11072 .vindex "&$original_domain$&"
11073 When a top-level address is being processed for delivery, this contains the
11074 same value as &$domain$&. However, if a &"child"& address (for example,
11075 generated by an alias, forward, or filter file) is being processed, this
11076 variable contains the domain of the original address (lower cased). This
11077 differs from &$parent_domain$& only when there is more than one level of
11078 aliasing or forwarding. When more than one address is being delivered in a
11079 single transport run, &$original_domain$& is not set.
11081 If a new address is created by means of a &%deliver%& command in a system
11082 filter, it is set up with an artificial &"parent"& address. This has the local
11083 part &'system-filter'& and the default qualify domain.
11085 .vitem &$original_local_part$&
11086 .vindex "&$local_part$&"
11087 .vindex "&$original_local_part$&"
11088 When a top-level address is being processed for delivery, this contains the
11089 same value as &$local_part$&, unless a prefix or suffix was removed from the
11090 local part, because &$original_local_part$& always contains the full local
11091 part. When a &"child"& address (for example, generated by an alias, forward, or
11092 filter file) is being processed, this variable contains the full local part of
11093 the original address.
11095 If the router that did the redirection processed the local part
11096 case-insensitively, the value in &$original_local_part$& is in lower case.
11097 This variable differs from &$parent_local_part$& only when there is more than
11098 one level of aliasing or forwarding. When more than one address is being
11099 delivered in a single transport run, &$original_local_part$& is not set.
11101 If a new address is created by means of a &%deliver%& command in a system
11102 filter, it is set up with an artificial &"parent"& address. This has the local
11103 part &'system-filter'& and the default qualify domain.
11105 .vitem &$originator_gid$&
11106 .cindex "gid (group id)" "of originating user"
11107 .cindex "sender" "gid"
11108 .vindex "&$caller_gid$&"
11109 .vindex "&$originator_gid$&"
11110 This variable contains the value of &$caller_gid$& that was set when the
11111 message was received. For messages received via the command line, this is the
11112 gid of the sending user. For messages received by SMTP over TCP/IP, this is
11113 normally the gid of the Exim user.
11115 .vitem &$originator_uid$&
11116 .cindex "uid (user id)" "of originating user"
11117 .cindex "sender" "uid"
11118 .vindex "&$caller_uid$&"
11119 .vindex "&$originaltor_uid$&"
11120 The value of &$caller_uid$& that was set when the message was received. For
11121 messages received via the command line, this is the uid of the sending user.
11122 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
11125 .vitem &$parent_domain$&
11126 .vindex "&$parent_domain$&"
11127 This variable is similar to &$original_domain$& (see
11128 above), except that it refers to the immediately preceding parent address.
11130 .vitem &$parent_local_part$&
11131 .vindex "&$parent_local_part$&"
11132 This variable is similar to &$original_local_part$&
11133 (see above), except that it refers to the immediately preceding parent address.
11136 .cindex "pid (process id)" "of current process"
11138 This variable contains the current process id.
11140 .vitem &$pipe_addresses$&
11141 .cindex "filter" "transport filter"
11142 .cindex "transport" "filter"
11143 .vindex "&$pipe_addresses$&"
11144 This is not an expansion variable, but is mentioned here because the string
11145 &`$pipe_addresses`& is handled specially in the command specification for the
11146 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
11147 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
11148 It cannot be used in general expansion strings, and provokes an &"unknown
11149 variable"& error if encountered.
11151 .vitem &$primary_hostname$&
11152 .vindex "&$primary_hostname$&"
11153 This variable contains the value set by &%primary_hostname%& in the
11154 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
11155 a single-component name, Exim calls &[gethostbyname()]& (or
11156 &[getipnodebyname()]& where available) in an attempt to acquire a fully
11157 qualified host name. See also &$smtp_active_hostname$&.
11160 .vitem &$prvscheck_address$&
11161 This variable is used in conjunction with the &%prvscheck%& expansion item,
11162 which is described in sections &<<SECTexpansionitems>>& and
11163 &<<SECTverifyPRVS>>&.
11165 .vitem &$prvscheck_keynum$&
11166 This variable is used in conjunction with the &%prvscheck%& expansion item,
11167 which is described in sections &<<SECTexpansionitems>>& and
11168 &<<SECTverifyPRVS>>&.
11170 .vitem &$prvscheck_result$&
11171 This variable is used in conjunction with the &%prvscheck%& expansion item,
11172 which is described in sections &<<SECTexpansionitems>>& and
11173 &<<SECTverifyPRVS>>&.
11175 .vitem &$qualify_domain$&
11176 .vindex "&$qualify_domain$&"
11177 The value set for the &%qualify_domain%& option in the configuration file.
11179 .vitem &$qualify_recipient$&
11180 .vindex "&$qualify_recipient$&"
11181 The value set for the &%qualify_recipient%& option in the configuration file,
11182 or if not set, the value of &$qualify_domain$&.
11184 .vitem &$rcpt_count$&
11185 .vindex "&$rcpt_count$&"
11186 When a message is being received by SMTP, this variable contains the number of
11187 RCPT commands received for the current message. If this variable is used in a
11188 RCPT ACL, its value includes the current command.
11190 .vitem &$rcpt_defer_count$&
11191 .vindex "&$rcpt_defer_count$&"
11192 .cindex "4&'xx'& responses" "count of"
11193 When a message is being received by SMTP, this variable contains the number of
11194 RCPT commands in the current message that have previously been rejected with a
11195 temporary (4&'xx'&) response.
11197 .vitem &$rcpt_fail_count$&
11198 .vindex "&$rcpt_fail_count$&"
11199 When a message is being received by SMTP, this variable contains the number of
11200 RCPT commands in the current message that have previously been rejected with a
11201 permanent (5&'xx'&) response.
11203 .vitem &$received_count$&
11204 .vindex "&$received_count$&"
11205 This variable contains the number of &'Received:'& header lines in the message,
11206 including the one added by Exim (so its value is always greater than zero). It
11207 is available in the DATA ACL, the non-SMTP ACL, and while routing and
11210 .vitem &$received_for$&
11211 .vindex "&$received_for$&"
11212 If there is only a single recipient address in an incoming message, this
11213 variable contains that address when the &'Received:'& header line is being
11214 built. The value is copied after recipient rewriting has happened, but before
11215 the &[local_scan()]& function is run.
11217 .vitem &$received_ip_address$&
11218 .vindex "&$received_ip_address$&"
11219 As soon as an Exim server starts processing an incoming TCP/IP connection, this
11220 variable is set to the address of the local IP interface, and &$received_port$&
11221 is set to the local port number. (The remote IP address and port are in
11222 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
11223 the port value is -1 unless it has been set using the &%-oMi%& command line
11226 As well as being useful in ACLs (including the &"connect"& ACL), these variable
11227 could be used, for example, to make the file name for a TLS certificate depend
11228 on which interface and/or port is being used for the incoming connection. The
11229 values of &$received_ip_address$& and &$received_port$& are saved with any
11230 messages that are received, thus making these variables available at delivery
11233 &*Note:*& There are no equivalent variables for outgoing connections, because
11234 the values are unknown (unless they are explicitly set by options of the
11235 &(smtp)& transport).
11237 .vitem &$received_port$&
11238 .vindex "&$received_port$&"
11239 See &$received_ip_address$&.
11241 .vitem &$received_protocol$&
11242 .vindex "&$received_protocol$&"
11243 When a message is being processed, this variable contains the name of the
11244 protocol by which it was received. Most of the names used by Exim are defined
11245 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
11246 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
11247 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
11248 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
11249 connection and the client was successfully authenticated.
11251 Exim uses the protocol name &"smtps"& for the case when encryption is
11252 automatically set up on connection without the use of STARTTLS (see
11253 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
11254 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
11255 where the client initially uses EHLO, sets up an encrypted connection using
11256 STARTTLS, and then uses HELO afterwards.
11258 The &%-oMr%& option provides a way of specifying a custom protocol name for
11259 messages that are injected locally by trusted callers. This is commonly used to
11260 identify messages that are being re-injected after some kind of scanning.
11262 .vitem &$received_time$&
11263 .vindex "&$received_time$&"
11264 This variable contains the date and time when the current message was received,
11265 as a number of seconds since the start of the Unix epoch.
11267 .vitem &$recipient_data$&
11268 .vindex "&$recipient_data$&"
11269 This variable is set after an indexing lookup success in an ACL &%recipients%&
11270 condition. It contains the data from the lookup, and the value remains set
11271 until the next &%recipients%& test. Thus, you can do things like this:
11273 &`require recipients = cdb*@;/some/file`&
11274 &`deny `&&'some further test involving'& &`$recipient_data`&
11276 &*Warning*&: This variable is set only when a lookup is used as an indexing
11277 method in the address list, using the semicolon syntax as in the example above.
11278 The variable is not set for a lookup that is used as part of the string
11279 expansion that all such lists undergo before being interpreted.
11281 .vitem &$recipient_verify_failure$&
11282 .vindex "&$recipient_verify_failure$&"
11283 In an ACL, when a recipient verification fails, this variable contains
11284 information about the failure. It is set to one of the following words:
11287 &"qualify"&: The address was unqualified (no domain), and the message
11288 was neither local nor came from an exempted host.
11291 &"route"&: Routing failed.
11294 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
11295 or before the MAIL command (that is, on initial connection, HELO, or
11299 &"recipient"&: The RCPT command in a callout was rejected.
11302 &"postmaster"&: The postmaster check in a callout was rejected.
11305 The main use of this variable is expected to be to distinguish between
11306 rejections of MAIL and rejections of RCPT.
11308 .vitem &$recipients$&
11309 .vindex "&$recipients$&"
11310 This variable contains a list of envelope recipients for a message. A comma and
11311 a space separate the addresses in the replacement text. However, the variable
11312 is not generally available, to prevent exposure of Bcc recipients in
11313 unprivileged users' filter files. You can use &$recipients$& only in these
11317 In a system filter file.
11319 In the ACLs associated with the DATA command and with non-SMTP messages, that
11320 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
11321 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
11322 &%acl_not_smtp_mime%&.
11324 From within a &[local_scan()]& function.
11328 .vitem &$recipients_count$&
11329 .vindex "&$recipients_count$&"
11330 When a message is being processed, this variable contains the number of
11331 envelope recipients that came with the message. Duplicates are not excluded
11332 from the count. While a message is being received over SMTP, the number
11333 increases for each accepted recipient. It can be referenced in an ACL.
11336 .vitem &$regex_match_string$&
11337 .vindex "&$regex_match_string$&"
11338 This variable is set to contain the matching regular expression after a
11339 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
11342 .vitem &$reply_address$&
11343 .vindex "&$reply_address$&"
11344 When a message is being processed, this variable contains the contents of the
11345 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
11346 contents of the &'From:'& header line. Apart from the removal of leading
11347 white space, the value is not processed in any way. In particular, no RFC 2047
11348 decoding or character code translation takes place.
11350 .vitem &$return_path$&
11351 .vindex "&$return_path$&"
11352 When a message is being delivered, this variable contains the return path &--
11353 the sender field that will be sent as part of the envelope. It is not enclosed
11354 in <> characters. At the start of routing an address, &$return_path$& has the
11355 same value as &$sender_address$&, but if, for example, an incoming message to a
11356 mailing list has been expanded by a router which specifies a different address
11357 for bounce messages, &$return_path$& subsequently contains the new bounce
11358 address, whereas &$sender_address$& always contains the original sender address
11359 that was received with the message. In other words, &$sender_address$& contains
11360 the incoming envelope sender, and &$return_path$& contains the outgoing
11363 .vitem &$return_size_limit$&
11364 .vindex "&$return_size_limit$&"
11365 This is an obsolete name for &$bounce_return_size_limit$&.
11368 .cindex "return code" "from &%run%& expansion"
11369 .vindex "&$runrc$&"
11370 This variable contains the return code from a command that is run by the
11371 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
11372 assume the order in which option values are expanded, except for those
11373 preconditions whose order of testing is documented. Therefore, you cannot
11374 reliably expect to set &$runrc$& by the expansion of one option, and use it in
11377 .vitem &$self_hostname$&
11378 .oindex "&%self%&" "value of host name"
11379 .vindex "&$self_hostname$&"
11380 When an address is routed to a supposedly remote host that turns out to be the
11381 local host, what happens is controlled by the &%self%& generic router option.
11382 One of its values causes the address to be passed to another router. When this
11383 happens, &$self_hostname$& is set to the name of the local host that the
11384 original router encountered. In other circumstances its contents are null.
11386 .vitem &$sender_address$&
11387 .vindex "&$sender_address$&"
11388 When a message is being processed, this variable contains the sender's address
11389 that was received in the message's envelope. The case of letters in the address
11390 is retained, in both the local part and the domain. For bounce messages, the
11391 value of this variable is the empty string. See also &$return_path$&.
11393 .vitem &$sender_address_data$&
11394 .vindex "&$address_data$&"
11395 .vindex "&$sender_address_data$&"
11396 If &$address_data$& is set when the routers are called from an ACL to verify a
11397 sender address, the final value is preserved in &$sender_address_data$&, to
11398 distinguish it from data from a recipient address. The value does not persist
11399 after the end of the current ACL statement. If you want to preserve it for
11400 longer, you can save it in an ACL variable.
11402 .vitem &$sender_address_domain$&
11403 .vindex "&$sender_address_domain$&"
11404 The domain portion of &$sender_address$&.
11406 .vitem &$sender_address_local_part$&
11407 .vindex "&$sender_address_local_part$&"
11408 The local part portion of &$sender_address$&.
11410 .vitem &$sender_data$&
11411 .vindex "&$sender_data$&"
11412 This variable is set after a lookup success in an ACL &%senders%& condition or
11413 in a router &%senders%& option. It contains the data from the lookup, and the
11414 value remains set until the next &%senders%& test. Thus, you can do things like
11417 &`require senders = cdb*@;/some/file`&
11418 &`deny `&&'some further test involving'& &`$sender_data`&
11420 &*Warning*&: This variable is set only when a lookup is used as an indexing
11421 method in the address list, using the semicolon syntax as in the example above.
11422 The variable is not set for a lookup that is used as part of the string
11423 expansion that all such lists undergo before being interpreted.
11425 .vitem &$sender_fullhost$&
11426 .vindex "&$sender_fullhost$&"
11427 When a message is received from a remote host, this variable contains the host
11428 name and IP address in a single string. It ends with the IP address in square
11429 brackets, followed by a colon and a port number if the logging of ports is
11430 enabled. The format of the rest of the string depends on whether the host
11431 issued a HELO or EHLO SMTP command, and whether the host name was verified by
11432 looking up its IP address. (Looking up the IP address can be forced by the
11433 &%host_lookup%& option, independent of verification.) A plain host name at the
11434 start of the string is a verified host name; if this is not present,
11435 verification either failed or was not requested. A host name in parentheses is
11436 the argument of a HELO or EHLO command. This is omitted if it is identical to
11437 the verified host name or to the host's IP address in square brackets.
11439 .vitem &$sender_helo_name$&
11440 .vindex "&$sender_helo_name$&"
11441 When a message is received from a remote host that has issued a HELO or EHLO
11442 command, the argument of that command is placed in this variable. It is also
11443 set if HELO or EHLO is used when a message is received using SMTP locally via
11444 the &%-bs%& or &%-bS%& options.
11446 .vitem &$sender_host_address$&
11447 .vindex "&$sender_host_address$&"
11448 When a message is received from a remote host, this variable contains that
11449 host's IP address. For locally submitted messages, it is empty.
11451 .vitem &$sender_host_authenticated$&
11452 .vindex "&$sender_host_authenticated$&"
11453 This variable contains the name (not the public name) of the authenticator
11454 driver that successfully authenticated the client from which the message was
11455 received. It is empty if there was no successful authentication. See also
11456 &$authenticated_id$&.
11458 .vitem &$sender_host_name$&
11459 .vindex "&$sender_host_name$&"
11460 When a message is received from a remote host, this variable contains the
11461 host's name as obtained by looking up its IP address. For messages received by
11462 other means, this variable is empty.
11464 .vindex "&$host_lookup_failed$&"
11465 If the host name has not previously been looked up, a reference to
11466 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
11467 A looked up name is accepted only if it leads back to the original IP address
11468 via a forward lookup. If either the reverse or the forward lookup fails to find
11469 any data, or if the forward lookup does not yield the original IP address,
11470 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
11472 .vindex "&$host_lookup_deferred$&"
11473 However, if either of the lookups cannot be completed (for example, there is a
11474 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
11475 &$host_lookup_failed$& remains set to &"0"&.
11477 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
11478 host name again if there is a subsequent reference to &$sender_host_name$&
11479 in the same Exim process, but it does try again if &$host_lookup_deferred$&
11482 Exim does not automatically look up every calling host's name. If you want
11483 maximum efficiency, you should arrange your configuration so that it avoids
11484 these lookups altogether. The lookup happens only if one or more of the
11485 following are true:
11488 A string containing &$sender_host_name$& is expanded.
11490 The calling host matches the list in &%host_lookup%&. In the default
11491 configuration, this option is set to *, so it must be changed if lookups are
11492 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
11494 Exim needs the host name in order to test an item in a host list. The items
11495 that require this are described in sections &<<SECThoslispatnam>>& and
11496 &<<SECThoslispatnamsk>>&.
11498 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
11499 In this case, the host name is required to compare with the name quoted in any
11500 EHLO or HELO commands that the client issues.
11502 The remote host issues a EHLO or HELO command that quotes one of the
11503 domains in &%helo_lookup_domains%&. The default value of this option is
11504 . ==== As this is a nested list, any displays it contains must be indented
11505 . ==== as otherwise they are too far to the left.
11507 helo_lookup_domains = @ : @[]
11509 which causes a lookup if a remote host (incorrectly) gives the server's name or
11510 IP address in an EHLO or HELO command.
11514 .vitem &$sender_host_port$&
11515 .vindex "&$sender_host_port$&"
11516 When a message is received from a remote host, this variable contains the port
11517 number that was used on the remote host.
11519 .vitem &$sender_ident$&
11520 .vindex "&$sender_ident$&"
11521 When a message is received from a remote host, this variable contains the
11522 identification received in response to an RFC 1413 request. When a message has
11523 been received locally, this variable contains the login name of the user that
11526 .vitem &$sender_rate_$&&'xxx'&
11527 A number of variables whose names begin &$sender_rate_$& are set as part of the
11528 &%ratelimit%& ACL condition. Details are given in section
11529 &<<SECTratelimiting>>&.
11531 .vitem &$sender_rcvhost$&
11532 .cindex "DNS" "reverse lookup"
11533 .cindex "reverse DNS lookup"
11534 .vindex "&$sender_rcvhost$&"
11535 This is provided specifically for use in &'Received:'& headers. It starts with
11536 either the verified host name (as obtained from a reverse DNS lookup) or, if
11537 there is no verified host name, the IP address in square brackets. After that
11538 there may be text in parentheses. When the first item is a verified host name,
11539 the first thing in the parentheses is the IP address in square brackets,
11540 followed by a colon and a port number if port logging is enabled. When the
11541 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
11544 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
11545 was used and its argument was not identical to the real host name or IP
11546 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
11547 all three items are present in the parentheses, a newline and tab are inserted
11548 into the string, to improve the formatting of the &'Received:'& header.
11550 .vitem &$sender_verify_failure$&
11551 .vindex "&$sender_verify_failure$&"
11552 In an ACL, when a sender verification fails, this variable contains information
11553 about the failure. The details are the same as for
11554 &$recipient_verify_failure$&.
11556 .vitem &$sending_ip_address$&
11557 .vindex "&$sending_ip_address$&"
11558 This variable is set whenever an outgoing SMTP connection to another host has
11559 been set up. It contains the IP address of the local interface that is being
11560 used. This is useful if a host that has more than one IP address wants to take
11561 on different personalities depending on which one is being used. For incoming
11562 connections, see &$received_ip_address$&.
11564 .vitem &$sending_port$&
11565 .vindex "&$sending_port$&"
11566 This variable is set whenever an outgoing SMTP connection to another host has
11567 been set up. It contains the local port that is being used. For incoming
11568 connections, see &$received_port$&.
11570 .vitem &$smtp_active_hostname$&
11571 .vindex "&$smtp_active_hostname$&"
11572 During an incoming SMTP session, this variable contains the value of the active
11573 host name, as specified by the &%smtp_active_hostname%& option. The value of
11574 &$smtp_active_hostname$& is saved with any message that is received, so its
11575 value can be consulted during routing and delivery.
11577 .vitem &$smtp_command$&
11578 .vindex "&$smtp_command$&"
11579 During the processing of an incoming SMTP command, this variable contains the
11580 entire command. This makes it possible to distinguish between HELO and EHLO in
11581 the HELO ACL, and also to distinguish between commands such as these:
11586 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
11587 command, the address in &$smtp_command$& is the original address before any
11588 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
11589 the address after SMTP-time rewriting.
11591 .vitem &$smtp_command_argument$&
11592 .cindex "SMTP" "command, argument for"
11593 .vindex "&$smtp_command_argument$&"
11594 While an ACL is running to check an SMTP command, this variable contains the
11595 argument, that is, the text that follows the command name, with leading white
11596 space removed. Following the introduction of &$smtp_command$&, this variable is
11597 somewhat redundant, but is retained for backwards compatibility.
11599 .vitem &$smtp_count_at_connection_start$&
11600 .vindex "&$smtp_count_at_connection_start$&"
11601 This variable is set greater than zero only in processes spawned by the Exim
11602 daemon for handling incoming SMTP connections. The name is deliberately long,
11603 in order to emphasize what the contents are. When the daemon accepts a new
11604 connection, it increments this variable. A copy of the variable is passed to
11605 the child process that handles the connection, but its value is fixed, and
11606 never changes. It is only an approximation of how many incoming connections
11607 there actually are, because many other connections may come and go while a
11608 single connection is being processed. When a child process terminates, the
11609 daemon decrements its copy of the variable.
11611 .vitem "&$sn0$& &-- &$sn9$&"
11612 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
11613 that were current at the end of the system filter file. This allows a system
11614 filter file to set values that can be tested in users' filter files. For
11615 example, a system filter could set a value indicating how likely it is that a
11616 message is junk mail.
11618 .vitem &$spam_$&&'xxx'&
11619 A number of variables whose names start with &$spam$& are available when Exim
11620 is compiled with the content-scanning extension. For details, see section
11621 &<<SECTscanspamass>>&.
11624 .vitem &$spool_directory$&
11625 .vindex "&$spool_directory$&"
11626 The name of Exim's spool directory.
11628 .vitem &$spool_inodes$&
11629 .vindex "&$spool_inodes$&"
11630 The number of free inodes in the disk partition where Exim's spool files are
11631 being written. The value is recalculated whenever the variable is referenced.
11632 If the relevant file system does not have the concept of inodes, the value of
11633 is -1. See also the &%check_spool_inodes%& option.
11635 .vitem &$spool_space$&
11636 .vindex "&$spool_space$&"
11637 The amount of free space (as a number of kilobytes) in the disk partition where
11638 Exim's spool files are being written. The value is recalculated whenever the
11639 variable is referenced. If the operating system does not have the ability to
11640 find the amount of free space (only true for experimental systems), the space
11641 value is -1. For example, to check in an ACL that there is at least 50
11642 megabytes free on the spool, you could write:
11644 condition = ${if > {$spool_space}{50000}}
11646 See also the &%check_spool_space%& option.
11649 .vitem &$thisaddress$&
11650 .vindex "&$thisaddress$&"
11651 This variable is set only during the processing of the &%foranyaddress%&
11652 command in a filter file. Its use is explained in the description of that
11653 command, which can be found in the separate document entitled &'Exim's
11654 interfaces to mail filtering'&.
11656 .vitem &$tls_certificate_verified$&
11657 .vindex "&$tls_certificate_verified$&"
11658 This variable is set to &"1"& if a TLS certificate was verified when the
11659 message was received, and &"0"& otherwise.
11661 .vitem &$tls_cipher$&
11662 .vindex "&$tls_cipher$&"
11663 When a message is received from a remote host over an encrypted SMTP
11664 connection, this variable is set to the cipher suite that was negotiated, for
11665 example DES-CBC3-SHA. In other circumstances, in particular, for message
11666 received over unencrypted connections, the variable is empty. Testing
11667 &$tls_cipher$& for emptiness is one way of distinguishing between encrypted and
11668 non-encrypted connections during ACL processing.
11670 The &$tls_cipher$& variable retains its value during message delivery, except
11671 when an outward SMTP delivery takes place via the &(smtp)& transport. In this
11672 case, &$tls_cipher$& is cleared before any outgoing SMTP connection is made,
11673 and then set to the outgoing cipher suite if one is negotiated. See chapter
11674 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
11675 details of the &(smtp)& transport.
11677 .vitem &$tls_peerdn$&
11678 .vindex "&$tls_peerdn$&"
11679 When a message is received from a remote host over an encrypted SMTP
11680 connection, and Exim is configured to request a certificate from the client,
11681 the value of the Distinguished Name of the certificate is made available in the
11682 &$tls_peerdn$& during subsequent processing. Like &$tls_cipher$&, the
11683 value is retained during message delivery, except during outbound SMTP
11686 .vitem &$tod_bsdinbox$&
11687 .vindex "&$tod_bsdinbox$&"
11688 The time of day and the date, in the format required for BSD-style mailbox
11689 files, for example: Thu Oct 17 17:14:09 1995.
11691 .vitem &$tod_epoch$&
11692 .vindex "&$tod_epoch$&"
11693 The time and date as a number of seconds since the start of the Unix epoch.
11695 .vitem &$tod_full$&
11696 .vindex "&$tod_full$&"
11697 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
11698 +0100. The timezone is always given as a numerical offset from UTC, with
11699 positive values used for timezones that are ahead (east) of UTC, and negative
11700 values for those that are behind (west).
11703 .vindex "&$tod_log$&"
11704 The time and date in the format used for writing Exim's log files, for example:
11705 1995-10-12 15:32:29, but without a timezone.
11707 .vitem &$tod_logfile$&
11708 .vindex "&$tod_logfile$&"
11709 This variable contains the date in the format yyyymmdd. This is the format that
11710 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
11713 .vitem &$tod_zone$&
11714 .vindex "&$tod_zone$&"
11715 This variable contains the numerical value of the local timezone, for example:
11718 .vitem &$tod_zulu$&
11719 .vindex "&$tod_zulu$&"
11720 This variable contains the UTC date and time in &"Zulu"& format, as specified
11721 by ISO 8601, for example: 20030221154023Z.
11724 .vindex "&$value$&"
11725 This variable contains the result of an expansion lookup, extraction operation,
11726 or external command, as described above. It is also used during a
11727 &*reduce*& expansion.
11729 .vitem &$version_number$&
11730 .vindex "&$version_number$&"
11731 The version number of Exim.
11733 .vitem &$warn_message_delay$&
11734 .vindex "&$warn_message_delay$&"
11735 This variable is set only during the creation of a message warning about a
11736 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
11738 .vitem &$warn_message_recipients$&
11739 .vindex "&$warn_message_recipients$&"
11740 This variable is set only during the creation of a message warning about a
11741 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
11747 . ////////////////////////////////////////////////////////////////////////////
11748 . ////////////////////////////////////////////////////////////////////////////
11750 .chapter "Embedded Perl" "CHAPperl"
11751 .scindex IIDperl "Perl" "calling from Exim"
11752 Exim can be built to include an embedded Perl interpreter. When this is done,
11753 Perl subroutines can be called as part of the string expansion process. To make
11754 use of the Perl support, you need version 5.004 or later of Perl installed on
11755 your system. To include the embedded interpreter in the Exim binary, include
11760 in your &_Local/Makefile_& and then build Exim in the normal way.
11763 .section "Setting up so Perl can be used" "SECID85"
11764 .oindex "&%perl_startup%&"
11765 Access to Perl subroutines is via a global configuration option called
11766 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
11767 no &%perl_startup%& option in the Exim configuration file then no Perl
11768 interpreter is started and there is almost no overhead for Exim (since none of
11769 the Perl library will be paged in unless used). If there is a &%perl_startup%&
11770 option then the associated value is taken to be Perl code which is executed in
11771 a newly created Perl interpreter.
11773 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
11774 need backslashes before any characters to escape special meanings. The option
11775 should usually be something like
11777 perl_startup = do '/etc/exim.pl'
11779 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
11780 use from Exim. Exim can be configured either to start up a Perl interpreter as
11781 soon as it is entered, or to wait until the first time it is needed. Starting
11782 the interpreter at the beginning ensures that it is done while Exim still has
11783 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
11784 fact used in a particular run. Also, note that this does not mean that Exim is
11785 necessarily running as root when Perl is called at a later time. By default,
11786 the interpreter is started only when it is needed, but this can be changed in
11790 .oindex "&%perl_at_start%&"
11791 Setting &%perl_at_start%& (a boolean option) in the configuration requests
11792 a startup when Exim is entered.
11794 The command line option &%-ps%& also requests a startup when Exim is entered,
11795 overriding the setting of &%perl_at_start%&.
11798 There is also a command line option &%-pd%& (for delay) which suppresses the
11799 initial startup, even if &%perl_at_start%& is set.
11802 .section "Calling Perl subroutines" "SECID86"
11803 When the configuration file includes a &%perl_startup%& option you can make use
11804 of the string expansion item to call the Perl subroutines that are defined
11805 by the &%perl_startup%& code. The operator is used in any of the following
11809 ${perl{foo}{argument}}
11810 ${perl{foo}{argument1}{argument2} ... }
11812 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
11813 arguments may be passed. Passing more than this results in an expansion failure
11814 with an error message of the form
11816 Too many arguments passed to Perl subroutine "foo" (max is 8)
11818 The return value of the Perl subroutine is evaluated in a scalar context before
11819 it is passed back to Exim to be inserted into the expanded string. If the
11820 return value is &'undef'&, the expansion is forced to fail in the same way as
11821 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
11822 by obeying Perl's &%die%& function, the expansion fails with the error message
11823 that was passed to &%die%&.
11826 .section "Calling Exim functions from Perl" "SECID87"
11827 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
11828 is available to call back into Exim's string expansion function. For example,
11831 my $lp = Exim::expand_string('$local_part');
11833 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
11834 Note those are single quotes and not double quotes to protect against
11835 &$local_part$& being interpolated as a Perl variable.
11837 If the string expansion is forced to fail by a &"fail"& item, the result of
11838 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
11839 expansion string, the Perl call from the original expansion string fails with
11840 an appropriate error message, in the same way as if &%die%& were used.
11842 .cindex "debugging" "from embedded Perl"
11843 .cindex "log" "writing from embedded Perl"
11844 Two other Exim functions are available for use from within Perl code.
11845 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
11846 debugging is enabled. If you want a newline at the end, you must supply it.
11847 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
11848 timestamp. In this case, you should not supply a terminating newline.
11851 .section "Use of standard output and error by Perl" "SECID88"
11852 .cindex "Perl" "standard output and error"
11853 You should not write to the standard error or output streams from within your
11854 Perl code, as it is not defined how these are set up. In versions of Exim
11855 before 4.50, it is possible for the standard output or error to refer to the
11856 SMTP connection during message reception via the daemon. Writing to this stream
11857 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
11858 error streams are connected to &_/dev/null_& in the daemon. The chaos is
11859 avoided, but the output is lost.
11861 .cindex "Perl" "use of &%warn%&"
11862 The Perl &%warn%& statement writes to the standard error stream by default.
11863 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
11864 you have no control. When Exim starts up the Perl interpreter, it arranges for
11865 output from the &%warn%& statement to be written to the Exim main log. You can
11866 change this by including appropriate Perl magic somewhere in your Perl code.
11867 For example, to discard &%warn%& output completely, you need this:
11869 $SIG{__WARN__} = sub { };
11871 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
11872 example, the code for the subroutine is empty, so it does nothing, but you can
11873 include any Perl code that you like. The text of the &%warn%& message is passed
11874 as the first subroutine argument.
11878 . ////////////////////////////////////////////////////////////////////////////
11879 . ////////////////////////////////////////////////////////////////////////////
11881 .chapter "Starting the daemon and the use of network interfaces" &&&
11882 "CHAPinterfaces" &&&
11883 "Starting the daemon"
11884 .cindex "daemon" "starting"
11885 .cindex "interface" "listening"
11886 .cindex "network interface"
11887 .cindex "interface" "network"
11888 .cindex "IP address" "for listening"
11889 .cindex "daemon" "listening IP addresses"
11890 .cindex "TCP/IP" "setting listening interfaces"
11891 .cindex "TCP/IP" "setting listening ports"
11892 A host that is connected to a TCP/IP network may have one or more physical
11893 hardware network interfaces. Each of these interfaces may be configured as one
11894 or more &"logical"& interfaces, which are the entities that a program actually
11895 works with. Each of these logical interfaces is associated with an IP address.
11896 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
11897 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
11898 knowledge about the host's interfaces for use in three different circumstances:
11901 When a listening daemon is started, Exim needs to know which interfaces
11902 and ports to listen on.
11904 When Exim is routing an address, it needs to know which IP addresses
11905 are associated with local interfaces. This is required for the correct
11906 processing of MX lists by removing the local host and others with the
11907 same or higher priority values. Also, Exim needs to detect cases
11908 when an address is routed to an IP address that in fact belongs to the
11909 local host. Unless the &%self%& router option or the &%allow_localhost%&
11910 option of the smtp transport is set (as appropriate), this is treated
11911 as an error situation.
11913 When Exim connects to a remote host, it may need to know which interface to use
11914 for the outgoing connection.
11918 Exim's default behaviour is likely to be appropriate in the vast majority
11919 of cases. If your host has only one interface, and you want all its IP
11920 addresses to be treated in the same way, and you are using only the
11921 standard SMTP port, you should not need to take any special action. The
11922 rest of this chapter does not apply to you.
11924 In a more complicated situation you may want to listen only on certain
11925 interfaces, or on different ports, and for this reason there are a number of
11926 options that can be used to influence Exim's behaviour. The rest of this
11927 chapter describes how they operate.
11929 When a message is received over TCP/IP, the interface and port that were
11930 actually used are set in &$received_ip_address$& and &$received_port$&.
11934 .section "Starting a listening daemon" "SECID89"
11935 When a listening daemon is started (by means of the &%-bd%& command line
11936 option), the interfaces and ports on which it listens are controlled by the
11940 &%daemon_smtp_ports%& contains a list of default ports. (For backward
11941 compatibility, this option can also be specified in the singular.)
11943 &%local_interfaces%& contains list of interface IP addresses on which to
11944 listen. Each item may optionally also specify a port.
11947 The default list separator in both cases is a colon, but this can be changed as
11948 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
11949 it is usually best to change the separator to avoid having to double all the
11950 colons. For example:
11952 local_interfaces = <; 127.0.0.1 ; \
11955 3ffe:ffff:836f::fe86:a061
11957 There are two different formats for specifying a port along with an IP address
11958 in &%local_interfaces%&:
11961 The port is added onto the address with a dot separator. For example, to listen
11962 on port 1234 on two different IP addresses:
11964 local_interfaces = <; 192.168.23.65.1234 ; \
11965 3ffe:ffff:836f::fe86:a061.1234
11968 The IP address is enclosed in square brackets, and the port is added
11969 with a colon separator, for example:
11971 local_interfaces = <; [192.168.23.65]:1234 ; \
11972 [3ffe:ffff:836f::fe86:a061]:1234
11976 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
11977 default setting contains just one port:
11979 daemon_smtp_ports = smtp
11981 If more than one port is listed, each interface that does not have its own port
11982 specified listens on all of them. Ports that are listed in
11983 &%daemon_smtp_ports%& can be identified either by name (defined in
11984 &_/etc/services_&) or by number. However, when ports are given with individual
11985 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
11989 .section "Special IP listening addresses" "SECID90"
11990 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
11991 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
11992 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
11993 instead of setting up separate listening sockets for each interface. The
11994 default value of &%local_interfaces%& is
11996 local_interfaces = 0.0.0.0
11998 when Exim is built without IPv6 support; otherwise it is:
12000 local_interfaces = <; ::0 ; 0.0.0.0
12002 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
12006 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
12007 The &%-oX%& command line option can be used to override the values of
12008 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
12009 instance. Another way of doing this would be to use macros and the &%-D%&
12010 option. However, &%-oX%& can be used by any admin user, whereas modification of
12011 the runtime configuration by &%-D%& is allowed only when the caller is root or
12014 The value of &%-oX%& is a list of items. The default colon separator can be
12015 changed in the usual way if required. If there are any items that do not
12016 contain dots or colons (that is, are not IP addresses), the value of
12017 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
12018 items that do contain dots or colons, the value of &%local_interfaces%& is
12019 replaced by those items. Thus, for example,
12023 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
12026 -oX 192.168.34.5.1125
12028 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
12029 (However, since &%local_interfaces%& now contains no items without ports, the
12030 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
12034 .section "Support for the obsolete SSMTP (or SMTPS) protocol" "SECTsupobssmt"
12035 .cindex "ssmtp protocol"
12036 .cindex "smtps protocol"
12037 .cindex "SMTP" "ssmtp protocol"
12038 .cindex "SMTP" "smtps protocol"
12039 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
12040 before the STARTTLS command was standardized for SMTP. Some legacy clients
12041 still use this protocol. If the &%tls_on_connect_ports%& option is set to a
12042 list of port numbers, connections to those ports must use SSMTP. The most
12043 common use of this option is expected to be
12045 tls_on_connect_ports = 465
12047 because 465 is the usual port number used by the legacy clients. There is also
12048 a command line option &%-tls-on-connect%&, which forces all ports to behave in
12049 this way when a daemon is started.
12051 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
12052 daemon to listen on those ports. You must still specify them in
12053 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
12054 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
12055 connections via the daemon.)
12060 .section "IPv6 address scopes" "SECID92"
12061 .cindex "IPv6" "address scopes"
12062 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
12063 can, in principle, have the same link-local IPv6 address on different
12064 interfaces. Thus, additional information is needed, over and above the IP
12065 address, to distinguish individual interfaces. A convention of using a
12066 percent sign followed by something (often the interface name) has been
12067 adopted in some cases, leading to addresses like this:
12069 fe80::202:b3ff:fe03:45c1%eth0
12071 To accommodate this usage, a percent sign followed by an arbitrary string is
12072 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
12073 to convert a textual IPv6 address for actual use. This function recognizes the
12074 percent convention in operating systems that support it, and it processes the
12075 address appropriately. Unfortunately, some older libraries have problems with
12076 &[getaddrinfo()]&. If
12078 IPV6_USE_INET_PTON=yes
12080 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
12081 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
12082 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
12083 function.) Of course, this means that the additional functionality of
12084 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
12086 .section "Disabling IPv6" "SECID93"
12087 .cindex "IPv6" "disabling"
12088 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
12089 run on a host whose kernel does not support IPv6. The binary will fall back to
12090 using IPv4, but it may waste resources looking up AAAA records, and trying to
12091 connect to IPv6 addresses, causing delays to mail delivery. If you set the
12092 .oindex "&%disable_ipv6%&"
12093 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
12094 activities take place. AAAA records are never looked up, and any IPv6 addresses
12095 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
12096 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
12097 to handle IPv6 literal addresses.
12099 On the other hand, when IPv6 is in use, there may be times when you want to
12100 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
12101 option to globally suppress the lookup of AAAA records for specified domains,
12102 and you can use the &%ignore_target_hosts%& generic router option to ignore
12103 IPv6 addresses in an individual router.
12107 .section "Examples of starting a listening daemon" "SECID94"
12108 The default case in an IPv6 environment is
12110 daemon_smtp_ports = smtp
12111 local_interfaces = <; ::0 ; 0.0.0.0
12113 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
12114 Either one or two sockets may be used, depending on the characteristics of
12115 the TCP/IP stack. (This is complicated and messy; for more information,
12116 read the comments in the &_daemon.c_& source file.)
12118 To specify listening on ports 25 and 26 on all interfaces:
12120 daemon_smtp_ports = 25 : 26
12122 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
12124 local_interfaces = <; ::0.25 ; ::0.26 \
12125 0.0.0.0.25 ; 0.0.0.0.26
12127 To listen on the default port on all IPv4 interfaces, and on port 26 on the
12128 IPv4 loopback address only:
12130 local_interfaces = 0.0.0.0 : 127.0.0.1.26
12132 To specify listening on the default port on specific interfaces only:
12134 local_interfaces = 192.168.34.67 : 192.168.34.67
12136 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
12140 .section "Recognizing the local host" "SECTreclocipadd"
12141 The &%local_interfaces%& option is also used when Exim needs to determine
12142 whether or not an IP address refers to the local host. That is, the IP
12143 addresses of all the interfaces on which a daemon is listening are always
12146 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
12147 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
12148 available interfaces from the operating system, and extracts the relevant
12149 (that is, IPv4 or IPv6) addresses to use for checking.
12151 Some systems set up large numbers of virtual interfaces in order to provide
12152 many virtual web servers. In this situation, you may want to listen for
12153 email on only a few of the available interfaces, but nevertheless treat all
12154 interfaces as local when routing. You can do this by setting
12155 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
12156 &"all"& wildcard values. These addresses are recognized as local, but are not
12157 used for listening. Consider this example:
12159 local_interfaces = <; 127.0.0.1 ; ::1 ; \
12161 3ffe:2101:12:1:a00:20ff:fe86:a061
12163 extra_local_interfaces = <; ::0 ; 0.0.0.0
12165 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
12166 address, but all available interface addresses are treated as local when
12169 In some environments the local host name may be in an MX list, but with an IP
12170 address that is not assigned to any local interface. In other cases it may be
12171 desirable to treat other host names as if they referred to the local host. Both
12172 these cases can be handled by setting the &%hosts_treat_as_local%& option.
12173 This contains host names rather than IP addresses. When a host is referenced
12174 during routing, either via an MX record or directly, it is treated as the local
12175 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
12176 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
12180 .section "Delivering to a remote host" "SECID95"
12181 Delivery to a remote host is handled by the smtp transport. By default, it
12182 allows the system's TCP/IP functions to choose which interface to use (if
12183 there is more than one) when connecting to a remote host. However, the
12184 &%interface%& option can be set to specify which interface is used. See the
12185 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
12191 . ////////////////////////////////////////////////////////////////////////////
12192 . ////////////////////////////////////////////////////////////////////////////
12194 .chapter "Main configuration" "CHAPmainconfig"
12195 .scindex IIDconfima "configuration file" "main section"
12196 .scindex IIDmaiconf "main configuration"
12197 The first part of the run time configuration file contains three types of item:
12200 Macro definitions: These lines start with an upper case letter. See section
12201 &<<SECTmacrodefs>>& for details of macro processing.
12203 Named list definitions: These lines start with one of the words &"domainlist"&,
12204 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
12205 section &<<SECTnamedlists>>&.
12207 Main configuration settings: Each setting occupies one line of the file
12208 (with possible continuations). If any setting is preceded by the word
12209 &"hide"&, the &%-bP%& command line option displays its value to admin users
12210 only. See section &<<SECTcos>>& for a description of the syntax of these option
12214 This chapter specifies all the main configuration options, along with their
12215 types and default values. For ease of finding a particular option, they appear
12216 in alphabetical order in section &<<SECTalomo>>& below. However, because there
12217 are now so many options, they are first listed briefly in functional groups, as
12218 an aid to finding the name of the option you are looking for. Some options are
12219 listed in more than one group.
12221 .section "Miscellaneous" "SECID96"
12223 .row &%bi_command%& "to run for &%-bi%& command line option"
12224 .row &%disable_ipv6%& "do no IPv6 processing"
12225 .row &%keep_malformed%& "for broken files &-- should not happen"
12226 .row &%localhost_number%& "for unique message ids in clusters"
12227 .row &%message_body_newlines%& "retain newlines in &$message_body$&"
12228 .row &%message_body_visible%& "how much to show in &$message_body$&"
12229 .row &%mua_wrapper%& "run in &""MUA wrapper""& mode"
12230 .row &%print_topbitchars%& "top-bit characters are printing"
12231 .row &%timezone%& "force time zone"
12235 .section "Exim parameters" "SECID97"
12237 .row &%exim_group%& "override compiled-in value"
12238 .row &%exim_path%& "override compiled-in value"
12239 .row &%exim_user%& "override compiled-in value"
12240 .row &%primary_hostname%& "default from &[uname()]&"
12241 .row &%split_spool_directory%& "use multiple directories"
12242 .row &%spool_directory%& "override compiled-in value"
12247 .section "Privilege controls" "SECID98"
12249 .row &%admin_groups%& "groups that are Exim admin users"
12250 .row &%deliver_drop_privilege%& "drop root for delivery processes"
12251 .row &%local_from_check%& "insert &'Sender:'& if necessary"
12252 .row &%local_from_prefix%& "for testing &'From:'& for local sender"
12253 .row &%local_from_suffix%& "for testing &'From:'& for local sender"
12254 .row &%local_sender_retain%& "keep &'Sender:'& from untrusted user"
12255 .row &%never_users%& "do not run deliveries as these"
12256 .row &%prod_requires_admin%& "forced delivery requires admin user"
12257 .row &%queue_list_requires_admin%& "queue listing requires admin user"
12258 .row &%trusted_groups%& "groups that are trusted"
12259 .row &%trusted_users%& "users that are trusted"
12264 .section "Logging" "SECID99"
12266 .row &%hosts_connection_nolog%& "exemption from connect logging"
12267 .row &%log_file_path%& "override compiled-in value"
12268 .row &%log_selector%& "set/unset optional logging"
12269 .row &%log_timezone%& "add timezone to log lines"
12270 .row &%message_logs%& "create per-message logs"
12271 .row &%preserve_message_logs%& "after message completion"
12272 .row &%process_log_path%& "for SIGUSR1 and &'exiwhat'&"
12273 .row &%syslog_duplication%& "controls duplicate log lines on syslog"
12274 .row &%syslog_facility%& "set syslog &""facility""& field"
12275 .row &%syslog_processname%& "set syslog &""ident""& field"
12276 .row &%syslog_timestamp%& "timestamp syslog lines"
12277 .row &%write_rejectlog%& "control use of message log"
12282 .section "Frozen messages" "SECID100"
12284 .row &%auto_thaw%& "sets time for retrying frozen messages"
12285 .row &%freeze_tell%& "send message when freezing"
12286 .row &%move_frozen_messages%& "to another directory"
12287 .row &%timeout_frozen_after%& "keep frozen messages only so long"
12292 .section "Data lookups" "SECID101"
12294 .row &%ibase_servers%& "InterBase servers"
12295 .row &%ldap_default_servers%& "used if no server in query"
12296 .row &%ldap_version%& "set protocol version"
12297 .row &%lookup_open_max%& "lookup files held open"
12298 .row &%mysql_servers%& "default MySQL servers"
12299 .row &%oracle_servers%& "Oracle servers"
12300 .row &%pgsql_servers%& "default PostgreSQL servers"
12301 .row &%sqlite_lock_timeout%& "as it says"
12306 .section "Message ids" "SECID102"
12308 .row &%message_id_header_domain%& "used to build &'Message-ID:'& header"
12309 .row &%message_id_header_text%& "ditto"
12314 .section "Embedded Perl Startup" "SECID103"
12316 .row &%perl_at_start%& "always start the interpreter"
12317 .row &%perl_startup%& "code to obey when starting Perl"
12322 .section "Daemon" "SECID104"
12324 .row &%daemon_smtp_ports%& "default ports"
12325 .row &%daemon_startup_retries%& "number of times to retry"
12326 .row &%daemon_startup_sleep%& "time to sleep between tries"
12327 .row &%extra_local_interfaces%& "not necessarily listened on"
12328 .row &%local_interfaces%& "on which to listen, with optional ports"
12329 .row &%pid_file_path%& "override compiled-in value"
12330 .row &%queue_run_max%& "maximum simultaneous queue runners"
12335 .section "Resource control" "SECID105"
12337 .row &%check_log_inodes%& "before accepting a message"
12338 .row &%check_log_space%& "before accepting a message"
12339 .row &%check_spool_inodes%& "before accepting a message"
12340 .row &%check_spool_space%& "before accepting a message"
12341 .row &%deliver_queue_load_max%& "no queue deliveries if load high"
12342 .row &%queue_only_load%& "queue incoming if load high"
12343 .row &%queue_only_load_latch%& "don't re-evaluate load for each message"
12344 .row &%queue_run_max%& "maximum simultaneous queue runners"
12345 .row &%remote_max_parallel%& "parallel SMTP delivery per message"
12346 .row &%smtp_accept_max%& "simultaneous incoming connections"
12347 .row &%smtp_accept_max_nonmail%& "non-mail commands"
12348 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
12349 .row &%smtp_accept_max_per_connection%& "messages per connection"
12350 .row &%smtp_accept_max_per_host%& "connections from one host"
12351 .row &%smtp_accept_queue%& "queue mail if more connections"
12352 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
12354 .row &%smtp_accept_reserve%& "only reserve hosts if more connections"
12355 .row &%smtp_check_spool_space%& "from SIZE on MAIL command"
12356 .row &%smtp_connect_backlog%& "passed to TCP/IP stack"
12357 .row &%smtp_load_reserve%& "SMTP from reserved hosts if load high"
12358 .row &%smtp_reserve_hosts%& "these are the reserve hosts"
12363 .section "Policy controls" "SECID106"
12365 .row &%acl_not_smtp%& "ACL for non-SMTP messages"
12366 .row &%acl_not_smtp_mime%& "ACL for non-SMTP MIME parts"
12367 .row &%acl_not_smtp_start%& "ACL for start of non-SMTP message"
12368 .row &%acl_smtp_auth%& "ACL for AUTH"
12369 .row &%acl_smtp_connect%& "ACL for connection"
12370 .row &%acl_smtp_data%& "ACL for DATA"
12371 .row &%acl_smtp_dkim%& "ACL for DKIM verification"
12372 .row &%acl_smtp_etrn%& "ACL for ETRN"
12373 .row &%acl_smtp_expn%& "ACL for EXPN"
12374 .row &%acl_smtp_helo%& "ACL for EHLO or HELO"
12375 .row &%acl_smtp_mail%& "ACL for MAIL"
12376 .row &%acl_smtp_mailauth%& "ACL for AUTH on MAIL command"
12377 .row &%acl_smtp_mime%& "ACL for MIME parts"
12378 .row &%acl_smtp_predata%& "ACL for start of data"
12379 .row &%acl_smtp_quit%& "ACL for QUIT"
12380 .row &%acl_smtp_rcpt%& "ACL for RCPT"
12381 .row &%acl_smtp_starttls%& "ACL for STARTTLS"
12382 .row &%acl_smtp_vrfy%& "ACL for VRFY"
12383 .row &%av_scanner%& "specify virus scanner"
12384 .row &%check_rfc2047_length%& "check length of RFC 2047 &""encoded &&&
12386 .row &%dns_csa_search_limit%& "control CSA parent search depth"
12387 .row &%dns_csa_use_reverse%& "en/disable CSA IP reverse search"
12388 .row &%header_maxsize%& "total size of message header"
12389 .row &%header_line_maxsize%& "individual header line limit"
12390 .row &%helo_accept_junk_hosts%& "allow syntactic junk from these hosts"
12391 .row &%helo_allow_chars%& "allow illegal chars in HELO names"
12392 .row &%helo_lookup_domains%& "lookup hostname for these HELO names"
12393 .row &%helo_try_verify_hosts%& "HELO soft-checked for these hosts"
12394 .row &%helo_verify_hosts%& "HELO hard-checked for these hosts"
12395 .row &%host_lookup%& "host name looked up for these hosts"
12396 .row &%host_lookup_order%& "order of DNS and local name lookups"
12397 .row &%host_reject_connection%& "reject connection from these hosts"
12398 .row &%hosts_treat_as_local%& "useful in some cluster configurations"
12399 .row &%local_scan_timeout%& "timeout for &[local_scan()]&"
12400 .row &%message_size_limit%& "for all messages"
12401 .row &%percent_hack_domains%& "recognize %-hack for these domains"
12402 .row &%spamd_address%& "set interface to SpamAssassin"
12403 .row &%strict_acl_vars%& "object to unset ACL variables"
12408 .section "Callout cache" "SECID107"
12410 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
12412 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
12414 .row &%callout_negative_expire%& "timeout for negative address cache item"
12415 .row &%callout_positive_expire%& "timeout for positive address cache item"
12416 .row &%callout_random_local_part%& "string to use for &""random""& testing"
12421 .section "TLS" "SECID108"
12423 .row &%gnutls_require_kx%& "control GnuTLS key exchanges"
12424 .row &%gnutls_require_mac%& "control GnuTLS MAC algorithms"
12425 .row &%gnutls_require_protocols%& "control GnuTLS protocols"
12426 .row &%gnutls_compat_mode%& "use GnuTLS compatibility mode"
12427 .row &%openssl_options%& "adjust OpenSSL compatibility options"
12428 .row &%tls_advertise_hosts%& "advertise TLS to these hosts"
12429 .row &%tls_certificate%& "location of server certificate"
12430 .row &%tls_crl%& "certificate revocation list"
12431 .row &%tls_dhparam%& "DH parameters for server"
12432 .row &%tls_on_connect_ports%& "specify SSMTP (SMTPS) ports"
12433 .row &%tls_privatekey%& "location of server private key"
12434 .row &%tls_remember_esmtp%& "don't reset after starting TLS"
12435 .row &%tls_require_ciphers%& "specify acceptable ciphers"
12436 .row &%tls_try_verify_hosts%& "try to verify client certificate"
12437 .row &%tls_verify_certificates%& "expected client certificates"
12438 .row &%tls_verify_hosts%& "insist on client certificate verify"
12443 .section "Local user handling" "SECID109"
12445 .row &%finduser_retries%& "useful in NIS environments"
12446 .row &%gecos_name%& "used when creating &'Sender:'&"
12447 .row &%gecos_pattern%& "ditto"
12448 .row &%max_username_length%& "for systems that truncate"
12449 .row &%unknown_login%& "used when no login name found"
12450 .row &%unknown_username%& "ditto"
12451 .row &%uucp_from_pattern%& "for recognizing &""From ""& lines"
12452 .row &%uucp_from_sender%& "ditto"
12457 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
12459 .row &%header_maxsize%& "total size of message header"
12460 .row &%header_line_maxsize%& "individual header line limit"
12461 .row &%message_size_limit%& "applies to all messages"
12462 .row &%percent_hack_domains%& "recognize %-hack for these domains"
12463 .row &%received_header_text%& "expanded to make &'Received:'&"
12464 .row &%received_headers_max%& "for mail loop detection"
12465 .row &%recipients_max%& "limit per message"
12466 .row &%recipients_max_reject%& "permanently reject excess recipients"
12472 .section "Non-SMTP incoming messages" "SECID111"
12474 .row &%receive_timeout%& "for non-SMTP messages"
12481 .section "Incoming SMTP messages" "SECID112"
12482 See also the &'Policy controls'& section above.
12485 .row &%host_lookup%& "host name looked up for these hosts"
12486 .row &%host_lookup_order%& "order of DNS and local name lookups"
12487 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
12488 .row &%rfc1413_hosts%& "make ident calls to these hosts"
12489 .row &%rfc1413_query_timeout%& "zero disables ident calls"
12490 .row &%sender_unqualified_hosts%& "may send unqualified senders"
12491 .row &%smtp_accept_keepalive%& "some TCP/IP magic"
12492 .row &%smtp_accept_max%& "simultaneous incoming connections"
12493 .row &%smtp_accept_max_nonmail%& "non-mail commands"
12494 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
12495 .row &%smtp_accept_max_per_connection%& "messages per connection"
12496 .row &%smtp_accept_max_per_host%& "connections from one host"
12497 .row &%smtp_accept_queue%& "queue mail if more connections"
12498 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
12500 .row &%smtp_accept_reserve%& "only reserve hosts if more connections"
12501 .row &%smtp_active_hostname%& "host name to use in messages"
12502 .row &%smtp_banner%& "text for welcome banner"
12503 .row &%smtp_check_spool_space%& "from SIZE on MAIL command"
12504 .row &%smtp_connect_backlog%& "passed to TCP/IP stack"
12505 .row &%smtp_enforce_sync%& "of SMTP command/responses"
12506 .row &%smtp_etrn_command%& "what to run for ETRN"
12507 .row &%smtp_etrn_serialize%& "only one at once"
12508 .row &%smtp_load_reserve%& "only reserve hosts if this load"
12509 .row &%smtp_max_unknown_commands%& "before dropping connection"
12510 .row &%smtp_ratelimit_hosts%& "apply ratelimiting to these hosts"
12511 .row &%smtp_ratelimit_mail%& "ratelimit for MAIL commands"
12512 .row &%smtp_ratelimit_rcpt%& "ratelimit for RCPT commands"
12513 .row &%smtp_receive_timeout%& "per command or data line"
12514 .row &%smtp_reserve_hosts%& "these are the reserve hosts"
12515 .row &%smtp_return_error_details%& "give detail on rejections"
12520 .section "SMTP extensions" "SECID113"
12522 .row &%accept_8bitmime%& "advertise 8BITMIME"
12523 .row &%auth_advertise_hosts%& "advertise AUTH to these hosts"
12524 .row &%ignore_fromline_hosts%& "allow &""From ""& from these hosts"
12525 .row &%ignore_fromline_local%& "allow &""From ""& from local SMTP"
12526 .row &%pipelining_advertise_hosts%& "advertise pipelining to these hosts"
12527 .row &%tls_advertise_hosts%& "advertise TLS to these hosts"
12532 .section "Processing messages" "SECID114"
12534 .row &%allow_domain_literals%& "recognize domain literal syntax"
12535 .row &%allow_mx_to_ip%& "allow MX to point to IP address"
12536 .row &%allow_utf8_domains%& "in addresses"
12537 .row &%check_rfc2047_length%& "check length of RFC 2047 &""encoded &&&
12539 .row &%delivery_date_remove%& "from incoming messages"
12540 .row &%envelope_to_remove%& "from incoming messages"
12541 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
12542 .row &%headers_charset%& "default for translations"
12543 .row &%qualify_domain%& "default for senders"
12544 .row &%qualify_recipient%& "default for recipients"
12545 .row &%return_path_remove%& "from incoming messages"
12546 .row &%strip_excess_angle_brackets%& "in addresses"
12547 .row &%strip_trailing_dot%& "at end of addresses"
12548 .row &%untrusted_set_sender%& "untrusted can set envelope sender"
12553 .section "System filter" "SECID115"
12555 .row &%system_filter%& "locate system filter"
12556 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
12558 .row &%system_filter_file_transport%& "transport for delivery to a file"
12559 .row &%system_filter_group%& "group for filter running"
12560 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
12561 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
12562 .row &%system_filter_user%& "user for filter running"
12567 .section "Routing and delivery" "SECID116"
12569 .row &%disable_ipv6%& "do no IPv6 processing"
12570 .row &%dns_again_means_nonexist%& "for broken domains"
12571 .row &%dns_check_names_pattern%& "pre-DNS syntax check"
12572 .row &%dns_ipv4_lookup%& "only v4 lookup for these domains"
12573 .row &%dns_retrans%& "parameter for resolver"
12574 .row &%dns_retry%& "parameter for resolver"
12575 .row &%hold_domains%& "hold delivery for these domains"
12576 .row &%local_interfaces%& "for routing checks"
12577 .row &%queue_domains%& "no immediate delivery for these"
12578 .row &%queue_only%& "no immediate delivery at all"
12579 .row &%queue_only_file%& "no immediate delivery if file exists"
12580 .row &%queue_only_load%& "no immediate delivery if load is high"
12581 .row &%queue_only_load_latch%& "don't re-evaluate load for each message"
12582 .row &%queue_only_override%& "allow command line to override"
12583 .row &%queue_run_in_order%& "order of arrival"
12584 .row &%queue_run_max%& "of simultaneous queue runners"
12585 .row &%queue_smtp_domains%& "no immediate SMTP delivery for these"
12586 .row &%remote_max_parallel%& "parallel SMTP delivery per message"
12587 .row &%remote_sort_domains%& "order of remote deliveries"
12588 .row &%retry_data_expire%& "timeout for retry data"
12589 .row &%retry_interval_max%& "safety net for retry rules"
12594 .section "Bounce and warning messages" "SECID117"
12596 .row &%bounce_message_file%& "content of bounce"
12597 .row &%bounce_message_text%& "content of bounce"
12598 .row &%bounce_return_body%& "include body if returning message"
12599 .row &%bounce_return_message%& "include original message in bounce"
12600 .row &%bounce_return_size_limit%& "limit on returned message"
12601 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
12602 .row &%dsn_from%& "set &'From:'& contents in bounces"
12603 .row &%errors_copy%& "copy bounce messages"
12604 .row &%errors_reply_to%& "&'Reply-to:'& in bounces"
12605 .row &%delay_warning%& "time schedule"
12606 .row &%delay_warning_condition%& "condition for warning messages"
12607 .row &%ignore_bounce_errors_after%& "discard undeliverable bounces"
12608 .row &%smtp_return_error_details%& "give detail on rejections"
12609 .row &%warn_message_file%& "content of warning message"
12614 .section "Alphabetical list of main options" "SECTalomo"
12615 Those options that undergo string expansion before use are marked with
12618 .option accept_8bitmime main boolean false
12620 .cindex "8-bit characters"
12621 This option causes Exim to send 8BITMIME in its response to an SMTP
12622 EHLO command, and to accept the BODY= parameter on MAIL commands.
12623 However, though Exim is 8-bit clean, it is not a protocol converter, and it
12624 takes no steps to do anything special with messages received by this route.
12625 Consequently, this option is turned off by default.
12627 .option acl_not_smtp main string&!! unset
12628 .cindex "&ACL;" "for non-SMTP messages"
12629 .cindex "non-SMTP messages" "ACLs for"
12630 This option defines the ACL that is run when a non-SMTP message has been
12631 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
12634 .option acl_not_smtp_mime main string&!! unset
12635 This option defines the ACL that is run for individual MIME parts of non-SMTP
12636 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
12639 .option acl_not_smtp_start main string&!! unset
12640 .cindex "&ACL;" "at start of non-SMTP message"
12641 .cindex "non-SMTP messages" "ACLs for"
12642 This option defines the ACL that is run before Exim starts reading a
12643 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
12645 .option acl_smtp_auth main string&!! unset
12646 .cindex "&ACL;" "setting up for SMTP commands"
12647 .cindex "AUTH" "ACL for"
12648 This option defines the ACL that is run when an SMTP AUTH command is
12649 received. See chapter &<<CHAPACL>>& for further details.
12651 .option acl_smtp_connect main string&!! unset
12652 .cindex "&ACL;" "on SMTP connection"
12653 This option defines the ACL that is run when an SMTP connection is received.
12654 See chapter &<<CHAPACL>>& for further details.
12656 .option acl_smtp_data main string&!! unset
12657 .cindex "DATA" "ACL for"
12658 This option defines the ACL that is run after an SMTP DATA command has been
12659 processed and the message itself has been received, but before the final
12660 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
12662 .option acl_smtp_etrn main string&!! unset
12663 .cindex "ETRN" "ACL for"
12664 This option defines the ACL that is run when an SMTP ETRN command is
12665 received. See chapter &<<CHAPACL>>& for further details.
12667 .option acl_smtp_expn main string&!! unset
12668 .cindex "EXPN" "ACL for"
12669 This option defines the ACL that is run when an SMTP EXPN command is
12670 received. See chapter &<<CHAPACL>>& for further details.
12672 .option acl_smtp_helo main string&!! unset
12673 .cindex "EHLO" "ACL for"
12674 .cindex "HELO" "ACL for"
12675 This option defines the ACL that is run when an SMTP EHLO or HELO
12676 command is received. See chapter &<<CHAPACL>>& for further details.
12679 .option acl_smtp_mail main string&!! unset
12680 .cindex "MAIL" "ACL for"
12681 This option defines the ACL that is run when an SMTP MAIL command is
12682 received. See chapter &<<CHAPACL>>& for further details.
12684 .option acl_smtp_mailauth main string&!! unset
12685 .cindex "AUTH" "on MAIL command"
12686 This option defines the ACL that is run when there is an AUTH parameter on
12687 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
12688 &<<CHAPSMTPAUTH>>& for details of authentication.
12690 .option acl_smtp_mime main string&!! unset
12691 .cindex "MIME content scanning" "ACL for"
12692 This option is available when Exim is built with the content-scanning
12693 extension. It defines the ACL that is run for each MIME part in a message. See
12694 section &<<SECTscanmimepart>>& for details.
12696 .option acl_smtp_predata main string&!! unset
12697 This option defines the ACL that is run when an SMTP DATA command is
12698 received, before the message itself is received. See chapter &<<CHAPACL>>& for
12701 .option acl_smtp_quit main string&!! unset
12702 .cindex "QUIT, ACL for"
12703 This option defines the ACL that is run when an SMTP QUIT command is
12704 received. See chapter &<<CHAPACL>>& for further details.
12706 .option acl_smtp_rcpt main string&!! unset
12707 .cindex "RCPT" "ACL for"
12708 This option defines the ACL that is run when an SMTP RCPT command is
12709 received. See chapter &<<CHAPACL>>& for further details.
12711 .option acl_smtp_starttls main string&!! unset
12712 .cindex "STARTTLS, ACL for"
12713 This option defines the ACL that is run when an SMTP STARTTLS command is
12714 received. See chapter &<<CHAPACL>>& for further details.
12716 .option acl_smtp_vrfy main string&!! unset
12717 .cindex "VRFY" "ACL for"
12718 This option defines the ACL that is run when an SMTP VRFY command is
12719 received. See chapter &<<CHAPACL>>& for further details.
12721 .option admin_groups main "string list&!!" unset
12722 .cindex "admin user"
12723 This option is expanded just once, at the start of Exim's processing. If the
12724 current group or any of the supplementary groups of an Exim caller is in this
12725 colon-separated list, the caller has admin privileges. If all your system
12726 programmers are in a specific group, for example, you can give them all Exim
12727 admin privileges by putting that group in &%admin_groups%&. However, this does
12728 not permit them to read Exim's spool files (whose group owner is the Exim gid).
12729 To permit this, you have to add individuals to the Exim group.
12731 .option allow_domain_literals main boolean false
12732 .cindex "domain literal"
12733 If this option is set, the RFC 2822 domain literal format is permitted in
12734 email addresses. The option is not set by default, because the domain literal
12735 format is not normally required these days, and few people know about it. It
12736 has, however, been exploited by mail abusers.
12738 Unfortunately, it seems that some DNS black list maintainers are using this
12739 format to report black listing to postmasters. If you want to accept messages
12740 addressed to your hosts by IP address, you need to set
12741 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
12742 domains (defined in the named domain list &%local_domains%& in the default
12743 configuration). This &"magic string"& matches the domain literal form of all
12744 the local host's IP addresses.
12747 .option allow_mx_to_ip main boolean false
12748 .cindex "MX record" "pointing to IP address"
12749 It appears that more and more DNS zone administrators are breaking the rules
12750 and putting domain names that look like IP addresses on the right hand side of
12751 MX records. Exim follows the rules and rejects this, giving an error message
12752 that explains the mis-configuration. However, some other MTAs support this
12753 practice, so to avoid &"Why can't Exim do this?"& complaints,
12754 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
12755 recommended, except when you have no other choice.
12757 .option allow_utf8_domains main boolean false
12758 .cindex "domain" "UTF-8 characters in"
12759 .cindex "UTF-8" "in domain name"
12760 Lots of discussion is going on about internationalized domain names. One
12761 camp is strongly in favour of just using UTF-8 characters, and it seems
12762 that at least two other MTAs permit this. This option allows Exim users to
12763 experiment if they wish.
12765 If it is set true, Exim's domain parsing function allows valid
12766 UTF-8 multicharacters to appear in domain name components, in addition to
12767 letters, digits, and hyphens. However, just setting this option is not
12768 enough; if you want to look up these domain names in the DNS, you must also
12769 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
12770 suitable setting is:
12772 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
12773 (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
12775 Alternatively, you can just disable this feature by setting
12777 dns_check_names_pattern =
12779 That is, set the option to an empty string so that no check is done.
12782 .option auth_advertise_hosts main "host list&!!" *
12783 .cindex "authentication" "advertising"
12784 .cindex "AUTH" "advertising"
12785 If any server authentication mechanisms are configured, Exim advertises them in
12786 response to an EHLO command only if the calling host matches this list.
12787 Otherwise, Exim does not advertise AUTH.
12788 Exim does not accept AUTH commands from clients to which it has not
12789 advertised the availability of AUTH. The advertising of individual
12790 authentication mechanisms can be controlled by the use of the
12791 &%server_advertise_condition%& generic authenticator option on the individual
12792 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
12794 Certain mail clients (for example, Netscape) require the user to provide a name
12795 and password for authentication if AUTH is advertised, even though it may
12796 not be needed (the host may accept messages from hosts on its local LAN without
12797 authentication, for example). The &%auth_advertise_hosts%& option can be used
12798 to make these clients more friendly by excluding them from the set of hosts to
12799 which Exim advertises AUTH.
12801 .cindex "AUTH" "advertising when encrypted"
12802 If you want to advertise the availability of AUTH only when the connection
12803 is encrypted using TLS, you can make use of the fact that the value of this
12804 option is expanded, with a setting like this:
12806 auth_advertise_hosts = ${if eq{$tls_cipher}{}{}{*}}
12808 .vindex "&$tls_cipher$&"
12809 If &$tls_cipher$& is empty, the session is not encrypted, and the result of
12810 the expansion is empty, thus matching no hosts. Otherwise, the result of the
12811 expansion is *, which matches all hosts.
12814 .option auto_thaw main time 0s
12815 .cindex "thawing messages"
12816 .cindex "unfreezing messages"
12817 If this option is set to a time greater than zero, a queue runner will try a
12818 new delivery attempt on any frozen message, other than a bounce message, if
12819 this much time has passed since it was frozen. This may result in the message
12820 being re-frozen if nothing has changed since the last attempt. It is a way of
12821 saying &"keep on trying, even though there are big problems"&.
12823 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
12824 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
12825 thought to be very useful any more, and its use should probably be avoided.
12827 .option av_scanner main string "see below"
12828 This option is available if Exim is built with the content-scanning extension.
12829 It specifies which anti-virus scanner to use. The default value is:
12831 sophie:/var/run/sophie
12833 If the value of &%av_scanner%& starts with a dollar character, it is expanded
12834 before use. See section &<<SECTscanvirus>>& for further details.
12838 .option bi_command main string unset
12840 This option supplies the name of a command that is run when Exim is called with
12841 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
12842 just the command name, it is not a complete command line. If an argument is
12843 required, it must come from the &%-oA%& command line option.
12846 .option bounce_message_file main string unset
12847 .cindex "bounce message" "customizing"
12848 .cindex "customizing" "bounce message"
12849 This option defines a template file containing paragraphs of text to be used
12850 for constructing bounce messages. Details of the file's contents are given in
12851 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
12854 .option bounce_message_text main string unset
12855 When this option is set, its contents are included in the default bounce
12856 message immediately after &"This message was created automatically by mail
12857 delivery software."& It is not used if &%bounce_message_file%& is set.
12859 .option bounce_return_body main boolean true
12860 .cindex "bounce message" "including body"
12861 This option controls whether the body of an incoming message is included in a
12862 bounce message when &%bounce_return_message%& is true. The default setting
12863 causes the entire message, both header and body, to be returned (subject to the
12864 value of &%bounce_return_size_limit%&). If this option is false, only the
12865 message header is included. In the case of a non-SMTP message containing an
12866 error that is detected during reception, only those header lines preceding the
12867 point at which the error was detected are returned.
12868 .cindex "bounce message" "including original"
12870 .option bounce_return_message main boolean true
12871 If this option is set false, none of the original message is included in
12872 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
12873 &%bounce_return_body%&.
12876 .option bounce_return_size_limit main integer 100K
12877 .cindex "size" "of bounce, limit"
12878 .cindex "bounce message" "size limit"
12879 .cindex "limit" "bounce message size"
12880 This option sets a limit in bytes on the size of messages that are returned to
12881 senders as part of bounce messages when &%bounce_return_message%& is true. The
12882 limit should be less than the value of the global &%message_size_limit%& and of
12883 any &%message_size_limit%& settings on transports, to allow for the bounce text
12884 that Exim generates. If this option is set to zero there is no limit.
12886 When the body of any message that is to be included in a bounce message is
12887 greater than the limit, it is truncated, and a comment pointing this out is
12888 added at the top. The actual cutoff may be greater than the value given, owing
12889 to the use of buffering for transferring the message in chunks (typically 8K in
12890 size). The idea is to save bandwidth on those undeliverable 15-megabyte
12893 .option bounce_sender_authentication main string unset
12894 .cindex "bounce message" "sender authentication"
12895 .cindex "authentication" "bounce message"
12896 .cindex "AUTH" "on bounce message"
12897 This option provides an authenticated sender address that is sent with any
12898 bounce messages generated by Exim that are sent over an authenticated SMTP
12899 connection. A typical setting might be:
12901 bounce_sender_authentication = mailer-daemon@my.domain.example
12903 which would cause bounce messages to be sent using the SMTP command:
12905 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
12907 The value of &%bounce_sender_authentication%& must always be a complete email
12910 .option callout_domain_negative_expire main time 3h
12911 .cindex "caching" "callout timeouts"
12912 .cindex "callout" "caching timeouts"
12913 This option specifies the expiry time for negative callout cache data for a
12914 domain. See section &<<SECTcallver>>& for details of callout verification, and
12915 section &<<SECTcallvercache>>& for details of the caching.
12918 .option callout_domain_positive_expire main time 7d
12919 This option specifies the expiry time for positive callout cache data for a
12920 domain. See section &<<SECTcallver>>& for details of callout verification, and
12921 section &<<SECTcallvercache>>& for details of the caching.
12924 .option callout_negative_expire main time 2h
12925 This option specifies the expiry time for negative callout cache data for an
12926 address. See section &<<SECTcallver>>& for details of callout verification, and
12927 section &<<SECTcallvercache>>& for details of the caching.
12930 .option callout_positive_expire main time 24h
12931 This option specifies the expiry time for positive callout cache data for an
12932 address. See section &<<SECTcallver>>& for details of callout verification, and
12933 section &<<SECTcallvercache>>& for details of the caching.
12936 .option callout_random_local_part main string&!! "see below"
12937 This option defines the &"random"& local part that can be used as part of
12938 callout verification. The default value is
12940 $primary_host_name-$tod_epoch-testing
12942 See section &<<CALLaddparcall>>& for details of how this value is used.
12945 .option check_log_inodes main integer 0
12946 See &%check_spool_space%& below.
12949 .option check_log_space main integer 0
12950 See &%check_spool_space%& below.
12952 .oindex "&%check_rfc2047_length%&"
12953 .cindex "RFC 2047" "disabling length check"
12954 .option check_rfc2047_length main boolean true
12955 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
12956 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
12957 word; strings to be encoded that exceed this length are supposed to use
12958 multiple encoded words. By default, Exim does not recognize encoded words that
12959 exceed the maximum length. However, it seems that some software, in violation
12960 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
12961 set false, Exim recognizes encoded words of any length.
12964 .option check_spool_inodes main integer 0
12965 See &%check_spool_space%& below.
12968 .option check_spool_space main integer 0
12969 .cindex "checking disk space"
12970 .cindex "disk space, checking"
12971 .cindex "spool directory" "checking space"
12972 The four &%check_...%& options allow for checking of disk resources before a
12973 message is accepted.
12975 .vindex "&$log_inodes$&"
12976 .vindex "&$log_space$&"
12977 .vindex "&$spool_inodes$&"
12978 .vindex "&$spool_space$&"
12979 When any of these options are set, they apply to all incoming messages. If you
12980 want to apply different checks to different kinds of message, you can do so by
12981 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
12982 &$spool_space$& in an ACL with appropriate additional conditions.
12985 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
12986 either value is greater than zero, for example:
12988 check_spool_space = 10M
12989 check_spool_inodes = 100
12991 The spool partition is the one that contains the directory defined by
12992 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
12995 &%check_log_space%& and &%check_log_inodes%& check the partition in which log
12996 files are written if either is greater than zero. These should be set only if
12997 &%log_file_path%& and &%spool_directory%& refer to different partitions.
12999 If there is less space or fewer inodes than requested, Exim refuses to accept
13000 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
13001 error response to the MAIL command. If ESMTP is in use and there was a
13002 SIZE parameter on the MAIL command, its value is added to the
13003 &%check_spool_space%& value, and the check is performed even if
13004 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
13006 The values for &%check_spool_space%& and &%check_log_space%& are held as a
13007 number of kilobytes. If a non-multiple of 1024 is specified, it is rounded up.
13009 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
13010 failure a message is written to stderr and Exim exits with a non-zero code, as
13011 it obviously cannot send an error message of any kind.
13013 .option daemon_smtp_ports main string &`smtp`&
13014 .cindex "port" "for daemon"
13015 .cindex "TCP/IP" "setting listening ports"
13016 This option specifies one or more default SMTP ports on which the Exim daemon
13017 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
13018 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
13020 .option daemon_startup_retries main integer 9
13021 .cindex "daemon startup, retrying"
13022 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
13023 the daemon at startup when it cannot immediately bind a listening socket
13024 (typically because the socket is already in use): &%daemon_startup_retries%&
13025 defines the number of retries after the first failure, and
13026 &%daemon_startup_sleep%& defines the length of time to wait between retries.
13028 .option daemon_startup_sleep main time 30s
13029 See &%daemon_startup_retries%&.
13031 .option delay_warning main "time list" 24h
13032 .cindex "warning of delay"
13033 .cindex "delay warning, specifying"
13034 When a message is delayed, Exim sends a warning message to the sender at
13035 intervals specified by this option. The data is a colon-separated list of times
13036 after which to send warning messages. If the value of the option is an empty
13037 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
13038 message has been on the queue for longer than the last time, the last interval
13039 between the times is used to compute subsequent warning times. For example,
13042 delay_warning = 4h:8h:24h
13044 the first message is sent after 4 hours, the second after 8 hours, and
13045 the third one after 24 hours. After that, messages are sent every 16 hours,
13046 because that is the interval between the last two times on the list. If you set
13047 just one time, it specifies the repeat interval. For example, with:
13051 messages are repeated every six hours. To stop warnings after a given time, set
13052 a very large time at the end of the list. For example:
13054 delay_warning = 2h:12h:99d
13057 .option delay_warning_condition main string&!! "see below"
13058 .vindex "&$domain$&"
13059 The string is expanded at the time a warning message might be sent. If all the
13060 deferred addresses have the same domain, it is set in &$domain$& during the
13061 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
13062 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
13063 &"false"& (the comparison being done caselessly) then the warning message is
13064 not sent. The default is:
13066 delay_warning_condition = ${if or {\
13067 { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
13068 { match{$h_precedence:}{(?i)bulk|list|junk} }\
13069 { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
13072 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
13073 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
13074 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
13075 &"auto-replied"& in an &'Auto-Submitted:'& header.
13077 .option deliver_drop_privilege main boolean false
13078 .cindex "unprivileged delivery"
13079 .cindex "delivery" "unprivileged"
13080 If this option is set true, Exim drops its root privilege at the start of a
13081 delivery process, and runs as the Exim user throughout. This severely restricts
13082 the kinds of local delivery that are possible, but is viable in certain types
13083 of configuration. There is a discussion about the use of root privilege in
13084 chapter &<<CHAPsecurity>>&.
13086 .option deliver_queue_load_max main fixed-point unset
13087 .cindex "load average"
13088 .cindex "queue runner" "abandoning"
13089 When this option is set, a queue run is abandoned if the system load average
13090 becomes greater than the value of the option. The option has no effect on
13091 ancient operating systems on which Exim cannot determine the load average.
13092 See also &%queue_only_load%& and &%smtp_load_reserve%&.
13095 .option delivery_date_remove main boolean true
13096 .cindex "&'Delivery-date:'& header line"
13097 Exim's transports have an option for adding a &'Delivery-date:'& header to a
13098 message when it is delivered, in exactly the same way as &'Return-path:'& is
13099 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
13100 should not be present in incoming messages, and this option causes them to be
13101 removed at the time the message is received, to avoid any problems that might
13102 occur when a delivered message is subsequently sent on to some other recipient.
13104 .option disable_fsync main boolean false
13105 .cindex "&[fsync()]&, disabling"
13106 This option is available only if Exim was built with the compile-time option
13107 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
13108 a runtime configuration generates an &"unknown option"& error. You should not
13109 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
13110 really, really, really understand what you are doing. &'No pre-compiled
13111 distributions of Exim should ever make this option available.'&
13113 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
13114 updated files' data to be written to disc before continuing. Unexpected events
13115 such as crashes and power outages may cause data to be lost or scrambled.
13116 Here be Dragons. &*Beware.*&
13119 .option disable_ipv6 main boolean false
13120 .cindex "IPv6" "disabling"
13121 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
13122 activities take place. AAAA records are never looked up, and any IPv6 addresses
13123 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
13124 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13125 to handle IPv6 literal addresses.
13128 .option dns_again_means_nonexist main "domain list&!!" unset
13129 .cindex "DNS" "&""try again""& response; overriding"
13130 DNS lookups give a &"try again"& response for the DNS errors
13131 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
13132 keep trying to deliver a message, or to give repeated temporary errors to
13133 incoming mail. Sometimes the effect is caused by a badly set up name server and
13134 may persist for a long time. If a domain which exhibits this problem matches
13135 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
13136 This option should be used with care. You can make it apply to reverse lookups
13137 by a setting such as this:
13139 dns_again_means_nonexist = *.in-addr.arpa
13141 This option applies to all DNS lookups that Exim does. It also applies when the
13142 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
13143 since these are most likely to be caused by DNS lookup problems. The
13144 &(dnslookup)& router has some options of its own for controlling what happens
13145 when lookups for MX or SRV records give temporary errors. These more specific
13146 options are applied after this global option.
13148 .option dns_check_names_pattern main string "see below"
13149 .cindex "DNS" "pre-check of name syntax"
13150 When this option is set to a non-empty string, it causes Exim to check domain
13151 names for characters that are not allowed in host names before handing them to
13152 the DNS resolver, because some resolvers give temporary errors for names that
13153 contain unusual characters. If a domain name contains any unwanted characters,
13154 a &"not found"& result is forced, and the resolver is not called. The check is
13155 done by matching the domain name against a regular expression, which is the
13156 value of this option. The default pattern is
13158 dns_check_names_pattern = \
13159 (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
13161 which permits only letters, digits, slashes, and hyphens in components, but
13162 they must start and end with a letter or digit. Slashes are not, in fact,
13163 permitted in host names, but they are found in certain NS records (which can be
13164 accessed in Exim by using a &%dnsdb%& lookup). If you set
13165 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
13168 .option dns_csa_search_limit main integer 5
13169 This option controls the depth of parental searching for CSA SRV records in the
13170 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
13172 .option dns_csa_use_reverse main boolean true
13173 This option controls whether or not an IP address, given as a CSA domain, is
13174 reversed and looked up in the reverse DNS, as described in more detail in
13175 section &<<SECTverifyCSA>>&.
13177 .option dns_ipv4_lookup main "domain list&!!" unset
13178 .cindex "IPv6" "DNS lookup for AAAA records"
13179 .cindex "DNS" "IPv6 lookup for AAAA records"
13180 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
13181 looks for IPv6 address records (AAAA records) as well as IPv4 address records
13182 (A records) when trying to find IP addresses for hosts, unless the host's
13183 domain matches this list.
13185 This is a fudge to help with name servers that give big delays or otherwise do
13186 not work for the AAAA record type. In due course, when the world's name
13187 servers have all been upgraded, there should be no need for this option.
13190 .option dns_retrans main time 0s
13191 .cindex "DNS" "resolver options"
13192 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
13193 retransmission and retry parameters for DNS lookups. Values of zero (the
13194 defaults) leave the system default settings unchanged. The first value is the
13195 time between retries, and the second is the number of retries. It isn't
13196 totally clear exactly how these settings affect the total time a DNS lookup may
13197 take. I haven't found any documentation about timeouts on DNS lookups; these
13198 parameter values are available in the external resolver interface structure,
13199 but nowhere does it seem to describe how they are used or what you might want
13203 .option dns_retry main integer 0
13204 See &%dns_retrans%& above.
13207 .option drop_cr main boolean false
13208 This is an obsolete option that is now a no-op. It used to affect the way Exim
13209 handled CR and LF characters in incoming messages. What happens now is
13210 described in section &<<SECTlineendings>>&.
13212 .option dsn_from main "string&!!" "see below"
13213 .cindex "&'From:'& header line" "in bounces"
13214 .cindex "bounce messages" "&'From:'& line, specifying"
13215 This option can be used to vary the contents of &'From:'& header lines in
13216 bounces and other automatically generated messages (&"Delivery Status
13217 Notifications"& &-- hence the name of the option). The default setting is:
13219 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
13221 The value is expanded every time it is needed. If the expansion fails, a
13222 panic is logged, and the default value is used.
13224 .option envelope_to_remove main boolean true
13225 .cindex "&'Envelope-to:'& header line"
13226 Exim's transports have an option for adding an &'Envelope-to:'& header to a
13227 message when it is delivered, in exactly the same way as &'Return-path:'& is
13228 handled. &'Envelope-to:'& records the original recipient address from the
13229 messages's envelope that caused the delivery to happen. Such headers should not
13230 be present in incoming messages, and this option causes them to be removed at
13231 the time the message is received, to avoid any problems that might occur when a
13232 delivered message is subsequently sent on to some other recipient.
13235 .option errors_copy main "string list&!!" unset
13236 .cindex "bounce message" "copy to other address"
13237 .cindex "copy of bounce message"
13238 Setting this option causes Exim to send bcc copies of bounce messages that it
13239 generates to other addresses. &*Note*&: This does not apply to bounce messages
13240 coming from elsewhere. The value of the option is a colon-separated list of
13241 items. Each item consists of a pattern, terminated by white space, followed by
13242 a comma-separated list of email addresses. If a pattern contains spaces, it
13243 must be enclosed in double quotes.
13245 Each pattern is processed in the same way as a single item in an address list
13246 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
13247 the bounce message, the message is copied to the addresses on the list. The
13248 items are scanned in order, and once a matching one is found, no further items
13249 are examined. For example:
13251 errors_copy = spqr@mydomain postmaster@mydomain.example :\
13252 rqps@mydomain hostmaster@mydomain.example,\
13253 postmaster@mydomain.example
13255 .vindex "&$domain$&"
13256 .vindex "&$local_part$&"
13257 The address list is expanded before use. The expansion variables &$local_part$&
13258 and &$domain$& are set from the original recipient of the error message, and if
13259 there was any wildcard matching in the pattern, the expansion
13260 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
13261 variables &$0$&, &$1$&, etc. are set in the normal way.
13264 .option errors_reply_to main string unset
13265 .cindex "bounce message" "&'Reply-to:'& in"
13266 By default, Exim's bounce and delivery warning messages contain the header line
13268 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
13270 .oindex &%quota_warn_message%&
13271 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
13272 A warning message that is generated by the &%quota_warn_message%& option in an
13273 &(appendfile)& transport may contain its own &'From:'& header line that
13274 overrides the default.
13276 Experience shows that people reply to bounce messages. If the
13277 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
13278 and warning messages. For example:
13280 errors_reply_to = postmaster@my.domain.example
13282 The value of the option is not expanded. It must specify a valid RFC 2822
13283 address. However, if a warning message that is generated by the
13284 &%quota_warn_message%& option in an &(appendfile)& transport contain its
13285 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
13289 .option exim_group main string "compile-time configured"
13290 .cindex "gid (group id)" "Exim's own"
13291 .cindex "Exim group"
13292 This option changes the gid under which Exim runs when it gives up root
13293 privilege. The default value is compiled into the binary. The value of this
13294 option is used only when &%exim_user%& is also set. Unless it consists entirely
13295 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
13296 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
13300 .option exim_path main string "see below"
13301 .cindex "Exim binary, path name"
13302 This option specifies the path name of the Exim binary, which is used when Exim
13303 needs to re-exec itself. The default is set up to point to the file &'exim'& in
13304 the directory configured at compile time by the BIN_DIRECTORY setting. It
13305 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
13307 &*Warning*&: Do not use a macro to define the value of this option, because
13308 you will break those Exim utilities that scan the configuration file to find
13309 where the binary is. (They then use the &%-bP%& option to extract option
13310 settings such as the value of &%spool_directory%&.)
13313 .option exim_user main string "compile-time configured"
13314 .cindex "uid (user id)" "Exim's own"
13315 .cindex "Exim user"
13316 This option changes the uid under which Exim runs when it gives up root
13317 privilege. The default value is compiled into the binary. Ownership of the run
13318 time configuration file and the use of the &%-C%& and &%-D%& command line
13319 options is checked against the values in the binary, not what is set here.
13321 Unless it consists entirely of digits, the string is looked up using
13322 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
13323 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
13324 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
13327 .option extra_local_interfaces main "string list" unset
13328 This option defines network interfaces that are to be considered local when
13329 routing, but which are not used for listening by the daemon. See section
13330 &<<SECTreclocipadd>>& for details.
13333 . Allow this long option name to split; give it unsplit as a fifth argument
13334 . for the automatic .oindex that is generated by .option.
13336 .option "extract_addresses_remove_ &~&~arguments" main boolean true &&&
13337 extract_addresses_remove_arguments
13339 .cindex "command line" "addresses with &%-t%&"
13340 .cindex "Sendmail compatibility" "&%-t%& option"
13341 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
13342 are present on the command line when the &%-t%& option is used to build an
13343 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
13344 line addresses are removed from the recipients list. This is also how Smail
13345 behaves. However, other Sendmail documentation (the O'Reilly book) states that
13346 command line addresses are added to those obtained from the header lines. When
13347 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
13348 argument headers. If it is set false, Exim adds rather than removes argument
13352 .option finduser_retries main integer 0
13353 .cindex "NIS, retrying user lookups"
13354 On systems running NIS or other schemes in which user and group information is
13355 distributed from a remote system, there can be times when &[getpwnam()]& and
13356 related functions fail, even when given valid data, because things time out.
13357 Unfortunately these failures cannot be distinguished from genuine &"not found"&
13358 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
13359 many extra times to find a user or a group, waiting for one second between
13362 .cindex "&_/etc/passwd_&" "multiple reading of"
13363 You should not set this option greater than zero if your user information is in
13364 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
13365 search the file multiple times for non-existent users, and also cause delay.
13369 .option freeze_tell main "string list, comma separated" unset
13370 .cindex "freezing messages" "sending a message when freezing"
13371 On encountering certain errors, or when configured to do so in a system filter,
13372 ACL, or special router, Exim freezes a message. This means that no further
13373 delivery attempts take place until an administrator thaws the message, or the
13374 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
13375 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
13376 warning message whenever it freezes something, unless the message it is
13377 freezing is a locally-generated bounce message. (Without this exception there
13378 is the possibility of looping.) The warning message is sent to the addresses
13379 supplied as the comma-separated value of this option. If several of the
13380 message's addresses cause freezing, only a single message is sent. If the
13381 freezing was automatic, the reason(s) for freezing can be found in the message
13382 log. If you configure freezing in a filter or ACL, you must arrange for any
13383 logging that you require.
13386 .option gecos_name main string&!! unset
13388 .cindex "&""gecos""& field, parsing"
13389 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
13390 password file to hold other information in addition to users' real names. Exim
13391 looks up this field for use when it is creating &'Sender:'& or &'From:'&
13392 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
13393 of the field are used unchanged, except that, if an ampersand is encountered,
13394 it is replaced by the user's login name with the first character forced to
13395 upper case, since this is a convention that is observed on many systems.
13397 When these options are set, &%gecos_pattern%& is treated as a regular
13398 expression that is to be applied to the field (again with && replaced by the
13399 login name), and if it matches, &%gecos_name%& is expanded and used as the
13402 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
13403 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
13404 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
13405 name terminates at the first comma, the following can be used:
13407 gecos_pattern = ([^,]*)
13411 .option gecos_pattern main string unset
13412 See &%gecos_name%& above.
13415 .option gnutls_require_kx main string unset
13416 This option controls the key exchange mechanisms when GnuTLS is used in an Exim
13417 server. For details, see section &<<SECTreqciphgnu>>&.
13419 .option gnutls_require_mac main string unset
13420 This option controls the MAC algorithms when GnuTLS is used in an Exim
13421 server. For details, see section &<<SECTreqciphgnu>>&.
13423 .option gnutls_require_protocols main string unset
13424 This option controls the protocols when GnuTLS is used in an Exim
13425 server. For details, see section &<<SECTreqciphgnu>>&.
13427 .option gnutls_compat_mode main boolean unset
13428 This option controls whether GnuTLS is used in compatibility mode in an Exim
13429 server. This reduces security slightly, but improves interworking with older
13430 implementations of TLS.
13432 .option headers_charset main string "see below"
13433 This option sets a default character set for translating from encoded MIME
13434 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
13435 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
13436 ultimate default is ISO-8859-1. For more details see the description of header
13437 insertions in section &<<SECTexpansionitems>>&.
13441 .option header_maxsize main integer "see below"
13442 .cindex "header section" "maximum size of"
13443 .cindex "limit" "size of message header section"
13444 This option controls the overall maximum size of a message's header
13445 section. The default is the value of HEADER_MAXSIZE in
13446 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
13447 sections are rejected.
13450 .option header_line_maxsize main integer 0
13451 .cindex "header lines" "maximum size of"
13452 .cindex "limit" "size of one header line"
13453 This option limits the length of any individual header line in a message, after
13454 all the continuations have been joined together. Messages with individual
13455 header lines that are longer than the limit are rejected. The default value of
13456 zero means &"no limit"&.
13461 .option helo_accept_junk_hosts main "host list&!!" unset
13462 .cindex "HELO" "accepting junk data"
13463 .cindex "EHLO" "accepting junk data"
13464 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
13465 mail, and gives an error response for invalid data. Unfortunately, there are
13466 some SMTP clients that send syntactic junk. They can be accommodated by setting
13467 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
13468 if you want to do semantic checking.
13469 See also &%helo_allow_chars%& for a way of extending the permitted character
13473 .option helo_allow_chars main string unset
13474 .cindex "HELO" "underscores in"
13475 .cindex "EHLO" "underscores in"
13476 .cindex "underscore in EHLO/HELO"
13477 This option can be set to a string of rogue characters that are permitted in
13478 all EHLO and HELO names in addition to the standard letters, digits,
13479 hyphens, and dots. If you really must allow underscores, you can set
13481 helo_allow_chars = _
13483 Note that the value is one string, not a list.
13486 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
13487 .cindex "HELO" "forcing reverse lookup"
13488 .cindex "EHLO" "forcing reverse lookup"
13489 If the domain given by a client in a HELO or EHLO command matches this
13490 list, a reverse lookup is done in order to establish the host's true name. The
13491 default forces a lookup if the client host gives the server's name or any of
13492 its IP addresses (in brackets), something that broken clients have been seen to
13496 .option helo_try_verify_hosts main "host list&!!" unset
13497 .cindex "HELO verifying" "optional"
13498 .cindex "EHLO" "verifying, optional"
13499 By default, Exim just checks the syntax of HELO and EHLO commands (see
13500 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
13501 to do more extensive checking of the data supplied by these commands. The ACL
13502 condition &`verify = helo`& is provided to make this possible.
13503 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
13504 to force the check to occur. From release 4.53 onwards, this is no longer
13505 necessary. If the check has not been done before &`verify = helo`& is
13506 encountered, it is done at that time. Consequently, this option is obsolete.
13507 Its specification is retained here for backwards compatibility.
13509 When an EHLO or HELO command is received, if the calling host matches
13510 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
13511 EHLO command either:
13514 is an IP literal matching the calling address of the host, or
13516 .cindex "DNS" "reverse lookup"
13517 .cindex "reverse DNS lookup"
13518 matches the host name that Exim obtains by doing a reverse lookup of the
13519 calling host address, or
13521 when looked up using &[gethostbyname()]& (or &[getipnodebyname()]& when
13522 available) yields the calling host address.
13525 However, the EHLO or HELO command is not rejected if any of the checks
13526 fail. Processing continues, but the result of the check is remembered, and can
13527 be detected later in an ACL by the &`verify = helo`& condition.
13529 .option helo_verify_hosts main "host list&!!" unset
13530 .cindex "HELO verifying" "mandatory"
13531 .cindex "EHLO" "verifying, mandatory"
13532 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
13533 backwards compatibility. For hosts that match this option, Exim checks the host
13534 name given in the HELO or EHLO in the same way as for
13535 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
13536 rejected with a 550 error, and entries are written to the main and reject logs.
13537 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
13540 .option hold_domains main "domain list&!!" unset
13541 .cindex "domain" "delaying delivery"
13542 .cindex "delivery" "delaying certain domains"
13543 This option allows mail for particular domains to be held on the queue
13544 manually. The option is overridden if a message delivery is forced with the
13545 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
13546 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
13547 item in &%hold_domains%&, no routing or delivery for that address is done, and
13548 it is deferred every time the message is looked at.
13550 This option is intended as a temporary operational measure for delaying the
13551 delivery of mail while some problem is being sorted out, or some new
13552 configuration tested. If you just want to delay the processing of some
13553 domains until a queue run occurs, you should use &%queue_domains%& or
13554 &%queue_smtp_domains%&, not &%hold_domains%&.
13556 A setting of &%hold_domains%& does not override Exim's code for removing
13557 messages from the queue if they have been there longer than the longest retry
13558 time in any retry rule. If you want to hold messages for longer than the normal
13559 retry times, insert a dummy retry rule with a long retry time.
13562 .option host_lookup main "host list&!!" unset
13563 .cindex "host name" "lookup, forcing"
13564 Exim does not look up the name of a calling host from its IP address unless it
13565 is required to compare against some host list, or the host matches
13566 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
13567 option (which normally contains IP addresses rather than host names). The
13568 default configuration file contains
13572 which causes a lookup to happen for all hosts. If the expense of these lookups
13573 is felt to be too great, the setting can be changed or removed.
13575 After a successful reverse lookup, Exim does a forward lookup on the name it
13576 has obtained, to verify that it yields the IP address that it started with. If
13577 this check fails, Exim behaves as if the name lookup failed.
13579 .vindex "&$host_lookup_failed$&"
13580 .vindex "&$sender_host_name$&"
13581 After any kind of failure, the host name (in &$sender_host_name$&) remains
13582 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
13583 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
13584 &`verify = reverse_host_lookup`& in ACLs.
13587 .option host_lookup_order main "string list" &`bydns:byaddr`&
13588 This option specifies the order of different lookup methods when Exim is trying
13589 to find a host name from an IP address. The default is to do a DNS lookup
13590 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
13591 if that fails. You can change the order of these lookups, or omit one entirely,
13594 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
13595 multiple PTR records in the DNS and the IP address is not listed in
13596 &_/etc/hosts_&. Different operating systems give different results in this
13597 case. That is why the default tries a DNS lookup first.
13601 .option host_reject_connection main "host list&!!" unset
13602 .cindex "host" "rejecting connections from"
13603 If this option is set, incoming SMTP calls from the hosts listed are rejected
13604 as soon as the connection is made.
13605 This option is obsolete, and retained only for backward compatibility, because
13606 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
13607 connections immediately.
13609 The ability to give an immediate rejection (either by this option or using an
13610 ACL) is provided for use in unusual cases. Many hosts will just try again,
13611 sometimes without much delay. Normally, it is better to use an ACL to reject
13612 incoming messages at a later stage, such as after RCPT commands. See
13613 chapter &<<CHAPACL>>&.
13616 .option hosts_connection_nolog main "host list&!!" unset
13617 .cindex "host" "not logging connections from"
13618 This option defines a list of hosts for which connection logging does not
13619 happen, even though the &%smtp_connection%& log selector is set. For example,
13620 you might want not to log SMTP connections from local processes, or from
13621 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
13622 the daemon; you should therefore strive to restrict its value to a short inline
13623 list of IP addresses and networks. To disable logging SMTP connections from
13624 local processes, you must create a host list with an empty item. For example:
13626 hosts_connection_nolog = :
13628 If the &%smtp_connection%& log selector is not set, this option has no effect.
13632 .option hosts_treat_as_local main "domain list&!!" unset
13633 .cindex "local host" "domains treated as"
13634 .cindex "host" "treated as local"
13635 If this option is set, any host names that match the domain list are treated as
13636 if they were the local host when Exim is scanning host lists obtained from MX
13638 or other sources. Note that the value of this option is a domain list, not a
13639 host list, because it is always used to check host names, not IP addresses.
13641 This option also applies when Exim is matching the special items
13642 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
13643 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
13644 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
13645 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
13646 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
13647 interfaces and recognizing the local host.
13650 .option ibase_servers main "string list" unset
13651 .cindex "InterBase" "server list"
13652 This option provides a list of InterBase servers and associated connection data,
13653 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
13654 The option is available only if Exim has been built with InterBase support.
13658 .option ignore_bounce_errors_after main time 10w
13659 .cindex "bounce message" "discarding"
13660 .cindex "discarding bounce message"
13661 This option affects the processing of bounce messages that cannot be delivered,
13662 that is, those that suffer a permanent delivery failure. (Bounce messages that
13663 suffer temporary delivery failures are of course retried in the usual way.)
13665 After a permanent delivery failure, bounce messages are frozen,
13666 because there is no sender to whom they can be returned. When a frozen bounce
13667 message has been on the queue for more than the given time, it is unfrozen at
13668 the next queue run, and a further delivery is attempted. If delivery fails
13669 again, the bounce message is discarded. This makes it possible to keep failed
13670 bounce messages around for a shorter time than the normal maximum retry time
13671 for frozen messages. For example,
13673 ignore_bounce_errors_after = 12h
13675 retries failed bounce message deliveries after 12 hours, discarding any further
13676 failures. If the value of this option is set to a zero time period, bounce
13677 failures are discarded immediately. Setting a very long time (as in the default
13678 value) has the effect of disabling this option. For ways of automatically
13679 dealing with other kinds of frozen message, see &%auto_thaw%& and
13680 &%timeout_frozen_after%&.
13683 .option ignore_fromline_hosts main "host list&!!" unset
13684 .cindex "&""From""& line"
13685 .cindex "UUCP" "&""From""& line"
13686 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
13687 the headers of a message. By default this is treated as the start of the
13688 message's body, which means that any following headers are not recognized as
13689 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
13690 match those hosts that insist on sending it. If the sender is actually a local
13691 process rather than a remote host, and is using &%-bs%& to inject the messages,
13692 &%ignore_fromline_local%& must be set to achieve this effect.
13695 .option ignore_fromline_local main boolean false
13696 See &%ignore_fromline_hosts%& above.
13699 .option keep_malformed main time 4d
13700 This option specifies the length of time to keep messages whose spool files
13701 have been corrupted in some way. This should, of course, never happen. At the
13702 next attempt to deliver such a message, it gets removed. The incident is
13706 .option ldap_default_servers main "string list" unset
13707 .cindex "LDAP" "default servers"
13708 This option provides a list of LDAP servers which are tried in turn when an
13709 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
13710 details of LDAP queries. This option is available only when Exim has been built
13714 .option ldap_version main integer unset
13715 .cindex "LDAP" "protocol version, forcing"
13716 This option can be used to force Exim to set a specific protocol version for
13717 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
13718 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
13719 the LDAP headers; otherwise it is 2. This option is available only when Exim
13720 has been built with LDAP support.
13724 .option local_from_check main boolean true
13725 .cindex "&'Sender:'& header line" "disabling addition of"
13726 .cindex "&'From:'& header line" "disabling checking of"
13727 When a message is submitted locally (that is, not over a TCP/IP connection) by
13728 an untrusted user, Exim removes any existing &'Sender:'& header line, and
13729 checks that the &'From:'& header line matches the login of the calling user and
13730 the domain specified by &%qualify_domain%&.
13732 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
13733 locally submitted message is automatically qualified by Exim, unless the
13734 &%-bnq%& command line option is used.
13736 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
13737 on the local part. If the &'From:'& header line does not match, Exim adds a
13738 &'Sender:'& header with an address constructed from the calling user's login
13739 and the default qualify domain.
13741 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
13742 and no &'Sender:'& header is ever added. If, in addition, you want to retain
13743 &'Sender:'& header lines supplied by untrusted users, you must also set
13744 &%local_sender_retain%& to be true.
13746 .cindex "envelope sender"
13747 These options affect only the header lines in the message. The envelope sender
13748 is still forced to be the login id at the qualify domain unless
13749 &%untrusted_set_sender%& permits the user to supply an envelope sender.
13751 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
13752 request similar header line checking. See section &<<SECTthesenhea>>&, which
13753 has more details about &'Sender:'& processing.
13758 .option local_from_prefix main string unset
13759 When Exim checks the &'From:'& header line of locally submitted messages for
13760 matching the login id (see &%local_from_check%& above), it can be configured to
13761 ignore certain prefixes and suffixes in the local part of the address. This is
13762 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
13763 appropriate lists, in the same form as the &%local_part_prefix%& and
13764 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
13767 local_from_prefix = *-
13769 is set, a &'From:'& line containing
13771 From: anything-user@your.domain.example
13773 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
13774 matches the actual sender address that is constructed from the login name and
13778 .option local_from_suffix main string unset
13779 See &%local_from_prefix%& above.
13782 .option local_interfaces main "string list" "see below"
13783 This option controls which network interfaces are used by the daemon for
13784 listening; they are also used to identify the local host when routing. Chapter
13785 &<<CHAPinterfaces>>& contains a full description of this option and the related
13786 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
13787 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
13788 &%local_interfaces%& is
13790 local_interfaces = 0.0.0.0
13792 when Exim is built without IPv6 support; otherwise it is
13794 local_interfaces = <; ::0 ; 0.0.0.0
13797 .option local_scan_timeout main time 5m
13798 .cindex "timeout" "for &[local_scan()]& function"
13799 .cindex "&[local_scan()]& function" "timeout"
13800 This timeout applies to the &[local_scan()]& function (see chapter
13801 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
13802 the incoming message is rejected with a temporary error if it is an SMTP
13803 message. For a non-SMTP message, the message is dropped and Exim ends with a
13804 non-zero code. The incident is logged on the main and reject logs.
13808 .option local_sender_retain main boolean false
13809 .cindex "&'Sender:'& header line" "retaining from local submission"
13810 When a message is submitted locally (that is, not over a TCP/IP connection) by
13811 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
13812 do not want this to happen, you must set &%local_sender_retain%&, and you must
13813 also set &%local_from_check%& to be false (Exim will complain if you do not).
13814 See also the ACL modifier &`control = suppress_local_fixups`&. Section
13815 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
13820 .option localhost_number main string&!! unset
13821 .cindex "host" "locally unique number for"
13822 .cindex "message ids" "with multiple hosts"
13823 .vindex "&$localhost_number$&"
13824 Exim's message ids are normally unique only within the local host. If
13825 uniqueness among a set of hosts is required, each host must set a different
13826 value for the &%localhost_number%& option. The string is expanded immediately
13827 after reading the configuration file (so that a number can be computed from the
13828 host name, for example) and the result of the expansion must be a number in the
13829 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
13830 systems). This is available in subsequent string expansions via the variable
13831 &$localhost_number$&. When &%localhost_number is set%&, the final two
13832 characters of the message id, instead of just being a fractional part of the
13833 time, are computed from the time and the local host number as described in
13834 section &<<SECTmessiden>>&.
13838 .option log_file_path main "string list&!!" "set at compile time"
13839 .cindex "log" "file path for"
13840 This option sets the path which is used to determine the names of Exim's log
13841 files, or indicates that logging is to be to syslog, or both. It is expanded
13842 when Exim is entered, so it can, for example, contain a reference to the host
13843 name. If no specific path is set for the log files at compile or run time, they
13844 are written in a sub-directory called &_log_& in Exim's spool directory.
13845 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
13846 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
13847 used. If this string is fixed at your installation (contains no expansion
13848 variables) it is recommended that you do not set this option in the
13849 configuration file, but instead supply the path using LOG_FILE_PATH in
13850 &_Local/Makefile_& so that it is available to Exim for logging errors detected
13851 early on &-- in particular, failure to read the configuration file.
13854 .option log_selector main string unset
13855 .cindex "log" "selectors"
13856 This option can be used to reduce or increase the number of things that Exim
13857 writes to its log files. Its argument is made up of names preceded by plus or
13858 minus characters. For example:
13860 log_selector = +arguments -retry_defer
13862 A list of possible names and what they control is given in the chapter on
13863 logging, in section &<<SECTlogselector>>&.
13866 .option log_timezone main boolean false
13867 .cindex "log" "timezone for entries"
13868 .vindex "&$tod_log$&"
13869 .vindex "&$tod_zone$&"
13870 By default, the timestamps on log lines are in local time without the
13871 timezone. This means that if your timezone changes twice a year, the timestamps
13872 in log lines are ambiguous for an hour when the clocks go back. One way of
13873 avoiding this problem is to set the timezone to UTC. An alternative is to set
13874 &%log_timezone%& true. This turns on the addition of the timezone offset to
13875 timestamps in log lines. Turning on this option can add quite a lot to the size
13876 of log files because each line is extended by 6 characters. Note that the
13877 &$tod_log$& variable contains the log timestamp without the zone, but there is
13878 another variable called &$tod_zone$& that contains just the timezone offset.
13881 .option lookup_open_max main integer 25
13882 .cindex "too many open files"
13883 .cindex "open files, too many"
13884 .cindex "file" "too many open"
13885 .cindex "lookup" "maximum open files"
13886 .cindex "limit" "open files for lookups"
13887 This option limits the number of simultaneously open files for single-key
13888 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
13889 Exim normally keeps these files open during routing, because often the same
13890 file is required several times. If the limit is reached, Exim closes the least
13891 recently used file. Note that if you are using the &'ndbm'& library, it
13892 actually opens two files for each logical DBM database, though it still counts
13893 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
13894 open files"& errors with NDBM, you need to reduce the value of
13895 &%lookup_open_max%&.
13898 .option max_username_length main integer 0
13899 .cindex "length of login name"
13900 .cindex "user name" "maximum length"
13901 .cindex "limit" "user name length"
13902 Some operating systems are broken in that they truncate long arguments to
13903 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
13904 this option is set greater than zero, any attempt to call &[getpwnam()]& with
13905 an argument that is longer behaves as if &[getpwnam()]& failed.
13908 .option message_body_newlines main bool false
13909 .cindex "message body" "newlines in variables"
13910 .cindex "newline" "in message body variables"
13911 .vindex "&$message_body$&"
13912 .vindex "&$message_body_end$&"
13913 By default, newlines in the message body are replaced by spaces when setting
13914 the &$message_body$& and &$message_body_end$& expansion variables. If this
13915 option is set true, this no longer happens.
13918 .option message_body_visible main integer 500
13919 .cindex "body of message" "visible size"
13920 .cindex "message body" "visible size"
13921 .vindex "&$message_body$&"
13922 .vindex "&$message_body_end$&"
13923 This option specifies how much of a message's body is to be included in the
13924 &$message_body$& and &$message_body_end$& expansion variables.
13927 .option message_id_header_domain main string&!! unset
13928 .cindex "&'Message-ID:'& header line"
13929 If this option is set, the string is expanded and used as the right hand side
13930 (domain) of the &'Message-ID:'& header that Exim creates if a
13931 locally-originated incoming message does not have one. &"Locally-originated"&
13932 means &"not received over TCP/IP."&
13933 Otherwise, the primary host name is used.
13934 Only letters, digits, dot and hyphen are accepted; any other characters are
13935 replaced by hyphens. If the expansion is forced to fail, or if the result is an
13936 empty string, the option is ignored.
13939 .option message_id_header_text main string&!! unset
13940 If this variable is set, the string is expanded and used to augment the text of
13941 the &'Message-id:'& header that Exim creates if a locally-originated incoming
13942 message does not have one. The text of this header is required by RFC 2822 to
13943 take the form of an address. By default, Exim uses its internal message id as
13944 the local part, and the primary host name as the domain. If this option is set,
13945 it is expanded, and provided the expansion is not forced to fail, and does not
13946 yield an empty string, the result is inserted into the header immediately
13947 before the @, separated from the internal message id by a dot. Any characters
13948 that are illegal in an address are automatically converted into hyphens. This
13949 means that variables such as &$tod_log$& can be used, because the spaces and
13950 colons will become hyphens.
13953 .option message_logs main boolean true
13954 .cindex "message logs" "disabling"
13955 .cindex "log" "message log; disabling"
13956 If this option is turned off, per-message log files are not created in the
13957 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
13958 Exim, by reducing the number of files involved in handling a message from a
13959 minimum of four (header spool file, body spool file, delivery journal, and
13960 per-message log) to three. The other major I/O activity is Exim's main log,
13961 which is not affected by this option.
13964 .option message_size_limit main string&!! 50M
13965 .cindex "message" "size limit"
13966 .cindex "limit" "message size"
13967 .cindex "size" "of message, limit"
13968 This option limits the maximum size of message that Exim will process. The
13969 value is expanded for each incoming connection so, for example, it can be made
13970 to depend on the IP address of the remote host for messages arriving via
13971 TCP/IP. After expansion, the value must be a sequence of decimal digits,
13972 optionally followed by K or M.
13974 &*Note*&: This limit cannot be made to depend on a message's sender or any
13975 other properties of an individual message, because it has to be advertised in
13976 the server's response to EHLO. String expansion failure causes a temporary
13977 error. A value of zero means no limit, but its use is not recommended. See also
13978 &%bounce_return_size_limit%&.
13980 Incoming SMTP messages are failed with a 552 error if the limit is
13981 exceeded; locally-generated messages either get a stderr message or a delivery
13982 failure message to the sender, depending on the &%-oe%& setting. Rejection of
13983 an oversized message is logged in both the main and the reject logs. See also
13984 the generic transport option &%message_size_limit%&, which limits the size of
13985 message that an individual transport can process.
13987 If you use a virus-scanner and set this option to to a value larger than the
13988 maximum size that your virus-scanner is configured to support, you may get
13989 failures triggered by large mails. The right size to configure for the
13990 virus-scanner depends upon what data is passed and the options in use but it's
13991 probably safest to just set it to a little larger than this value. Eg, with a
13992 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
13993 some problems may result.
13996 .option move_frozen_messages main boolean false
13997 .cindex "frozen messages" "moving"
13998 This option, which is available only if Exim has been built with the setting
14000 SUPPORT_MOVE_FROZEN_MESSAGES=yes
14002 in &_Local/Makefile_&, causes frozen messages and their message logs to be
14003 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
14004 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
14005 standard utilities for handling such moved messages, and they do not show up in
14006 lists generated by &%-bp%& or by the Exim monitor.
14009 .option mua_wrapper main boolean false
14010 Setting this option true causes Exim to run in a very restrictive mode in which
14011 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
14012 contains a full description of this facility.
14016 .option mysql_servers main "string list" unset
14017 .cindex "MySQL" "server list"
14018 This option provides a list of MySQL servers and associated connection data, to
14019 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
14020 option is available only if Exim has been built with MySQL support.
14023 .option never_users main "string list&!!" unset
14024 This option is expanded just once, at the start of Exim's processing. Local
14025 message deliveries are normally run in processes that are setuid to the
14026 recipient, and remote deliveries are normally run under Exim's own uid and gid.
14027 It is usually desirable to prevent any deliveries from running as root, as a
14030 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
14031 list of users that must not be used for local deliveries. This list is fixed in
14032 the binary and cannot be overridden by the configuration file. By default, it
14033 contains just the single user name &"root"&. The &%never_users%& runtime option
14034 can be used to add more users to the fixed list.
14036 If a message is to be delivered as one of the users on the fixed list or the
14037 &%never_users%& list, an error occurs, and delivery is deferred. A common
14040 never_users = root:daemon:bin
14042 Including root is redundant if it is also on the fixed list, but it does no
14043 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
14047 .option openssl_options main "string list" +dont_insert_empty_fragments
14048 .cindex "OpenSSL "compatibility options"
14049 This option allows an administrator to adjust the SSL options applied
14050 by OpenSSL to connections. It is given as a space-separated list of items,
14051 each one to be +added or -subtracted from the current value. The default
14052 value is one option which happens to have been set historically. You can
14053 remove all options with:
14055 openssl_options = -all
14057 This option is only available if Exim is built against OpenSSL. The values
14058 available for this option vary according to the age of your OpenSSL install.
14059 The &"all"& value controls a subset of flags which are available, typically
14060 the bug workaround options. The &'SSL_CTX_set_options'& man page will
14061 list the values known on your system and Exim should support all the
14062 &"bug workaround"& options and many of the &"modifying"& options. The Exim
14063 names lose the leading &"SSL_OP_"& and are lower-cased.
14065 Note that adjusting the options can have severe impact upon the security of
14066 SSL as used by Exim. It is possible to disable safety checks and shoot
14067 yourself in the foot in various unpleasant ways. This option should not be
14068 adjusted lightly. An unrecognised item will be detected at by invoking Exim
14069 with the &%-bV%& flag.
14073 openssl_options = -all +microsoft_big_sslv3_buffer
14077 .option oracle_servers main "string list" unset
14078 .cindex "Oracle" "server list"
14079 This option provides a list of Oracle servers and associated connection data,
14080 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
14081 The option is available only if Exim has been built with Oracle support.
14084 .option percent_hack_domains main "domain list&!!" unset
14085 .cindex "&""percent hack""&"
14086 .cindex "source routing" "in email address"
14087 .cindex "address" "source-routed"
14088 The &"percent hack"& is the convention whereby a local part containing a
14089 percent sign is re-interpreted as a new email address, with the percent
14090 replaced by @. This is sometimes called &"source routing"&, though that term is
14091 also applied to RFC 2822 addresses that begin with an @ character. If this
14092 option is set, Exim implements the percent facility for those domains listed,
14093 but no others. This happens before an incoming SMTP address is tested against
14096 &*Warning*&: The &"percent hack"& has often been abused by people who are
14097 trying to get round relaying restrictions. For this reason, it is best avoided
14098 if at all possible. Unfortunately, a number of less security-conscious MTAs
14099 implement it unconditionally. If you are running Exim on a gateway host, and
14100 routing mail through to internal MTAs without processing the local parts, it is
14101 a good idea to reject recipient addresses with percent characters in their
14102 local parts. Exim's default configuration does this.
14105 .option perl_at_start main boolean false
14106 This option is available only when Exim is built with an embedded Perl
14107 interpreter. See chapter &<<CHAPperl>>& for details of its use.
14110 .option perl_startup main string unset
14111 This option is available only when Exim is built with an embedded Perl
14112 interpreter. See chapter &<<CHAPperl>>& for details of its use.
14115 .option pgsql_servers main "string list" unset
14116 .cindex "PostgreSQL lookup type" "server list"
14117 This option provides a list of PostgreSQL servers and associated connection
14118 data, to be used in conjunction with &(pgsql)& lookups (see section
14119 &<<SECID72>>&). The option is available only if Exim has been built with
14120 PostgreSQL support.
14123 .option pid_file_path main string&!! "set at compile time"
14124 .cindex "daemon" "pid file path"
14125 .cindex "pid file, path for"
14126 This option sets the name of the file to which the Exim daemon writes its
14127 process id. The string is expanded, so it can contain, for example, references
14130 pid_file_path = /var/log/$primary_hostname/exim.pid
14132 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
14134 The value set by the option can be overridden by the &%-oP%& command line
14135 option. A pid file is not written if a &"non-standard"& daemon is run by means
14136 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
14139 .option pipelining_advertise_hosts main "host list&!!" *
14140 .cindex "PIPELINING" "suppressing advertising"
14141 This option can be used to suppress the advertisement of the SMTP
14142 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
14143 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
14144 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
14145 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
14146 that clients will use it; &"out of order"& commands that are &"expected"& do
14147 not count as protocol errors (see &%smtp_max_synprot_errors%&).
14150 .option preserve_message_logs main boolean false
14151 .cindex "message logs" "preserving"
14152 If this option is set, message log files are not deleted when messages are
14153 completed. Instead, they are moved to a sub-directory of the spool directory
14154 called &_msglog.OLD_&, where they remain available for statistical or debugging
14155 purposes. This is a dangerous option to set on systems with any appreciable
14156 volume of mail. Use with care!
14159 .option primary_hostname main string "see below"
14160 .cindex "name" "of local host"
14161 .cindex "host" "name of local"
14162 .cindex "local host" "name of"
14163 .vindex "&$primary_hostname$&"
14164 This specifies the name of the current host. It is used in the default EHLO or
14165 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
14166 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
14167 The value is also used by default in some SMTP response messages from an Exim
14168 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
14170 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
14171 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
14172 contains only one component, Exim passes it to &[gethostbyname()]& (or
14173 &[getipnodebyname()]& when available) in order to obtain the fully qualified
14174 version. The variable &$primary_hostname$& contains the host name, whether set
14175 explicitly by this option, or defaulted.
14178 .option print_topbitchars main boolean false
14179 .cindex "printing characters"
14180 .cindex "8-bit characters"
14181 By default, Exim considers only those characters whose codes lie in the range
14182 32&--126 to be printing characters. In a number of circumstances (for example,
14183 when writing log entries) non-printing characters are converted into escape
14184 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
14185 is set, code values of 128 and above are also considered to be printing
14188 This option also affects the header syntax checks performed by the
14189 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
14190 the user's full name when constructing From: and Sender: addresses (as
14191 described in section &<<SECTconstr>>&). Setting this option can cause
14192 Exim to generate eight bit message headers that do not conform to the
14196 .option process_log_path main string unset
14197 .cindex "process log path"
14198 .cindex "log" "process log"
14199 .cindex "&'exiwhat'&"
14200 This option sets the name of the file to which an Exim process writes its
14201 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
14202 utility script. If this option is unset, the file called &_exim-process.info_&
14203 in Exim's spool directory is used. The ability to specify the name explicitly
14204 can be useful in environments where two different Exims are running, using
14205 different spool directories.
14208 .option prod_requires_admin main boolean true
14212 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
14213 admin user unless &%prod_requires_admin%& is set false. See also
14214 &%queue_list_requires_admin%&.
14217 .option qualify_domain main string "see below"
14218 .cindex "domain" "for qualifying addresses"
14219 .cindex "address" "qualification"
14220 This option specifies the domain name that is added to any envelope sender
14221 addresses that do not have a domain qualification. It also applies to
14222 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
14223 are accepted by default only for locally-generated messages. Qualification is
14224 also applied to addresses in header lines such as &'From:'& and &'To:'& for
14225 locally-generated messages, unless the &%-bnq%& command line option is used.
14227 Messages from external sources must always contain fully qualified addresses,
14228 unless the sending host matches &%sender_unqualified_hosts%& or
14229 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
14230 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
14231 necessary. Internally, Exim always works with fully qualified envelope
14232 addresses. If &%qualify_domain%& is not set, it defaults to the
14233 &%primary_hostname%& value.
14236 .option qualify_recipient main string "see below"
14237 This option allows you to specify a different domain for qualifying recipient
14238 addresses to the one that is used for senders. See &%qualify_domain%& above.
14242 .option queue_domains main "domain list&!!" unset
14243 .cindex "domain" "specifying non-immediate delivery"
14244 .cindex "queueing incoming messages"
14245 .cindex "message" "queueing certain domains"
14246 This option lists domains for which immediate delivery is not required.
14247 A delivery process is started whenever a message is received, but only those
14248 domains that do not match are processed. All other deliveries wait until the
14249 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
14252 .option queue_list_requires_admin main boolean true
14254 The &%-bp%& command-line option, which lists the messages that are on the
14255 queue, requires the caller to be an admin user unless
14256 &%queue_list_requires_admin%& is set false. See also &%prod_requires_admin%&.
14259 .option queue_only main boolean false
14260 .cindex "queueing incoming messages"
14261 .cindex "message" "queueing unconditionally"
14262 If &%queue_only%& is set, a delivery process is not automatically started
14263 whenever a message is received. Instead, the message waits on the queue for the
14264 next queue run. Even if &%queue_only%& is false, incoming messages may not get
14265 delivered immediately when certain conditions (such as heavy load) occur.
14267 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
14268 and &%-odi%& command line options override &%queue_only%& unless
14269 &%queue_only_override%& is set false. See also &%queue_only_file%&,
14270 &%queue_only_load%&, and &%smtp_accept_queue%&.
14273 .option queue_only_file main string unset
14274 .cindex "queueing incoming messages"
14275 .cindex "message" "queueing by file existence"
14276 This option can be set to a colon-separated list of absolute path names, each
14277 one optionally preceded by &"smtp"&. When Exim is receiving a message,
14278 it tests for the existence of each listed path using a call to &[stat()]&. For
14279 each path that exists, the corresponding queueing option is set.
14280 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
14281 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
14283 queue_only_file = smtp/some/file
14285 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
14286 &_/some/file_& exists.
14289 .option queue_only_load main fixed-point unset
14290 .cindex "load average"
14291 .cindex "queueing incoming messages"
14292 .cindex "message" "queueing by load"
14293 If the system load average is higher than this value, incoming messages from
14294 all sources are queued, and no automatic deliveries are started. If this
14295 happens during local or remote SMTP input, all subsequent messages received on
14296 the same SMTP connection are queued by default, whatever happens to the load in
14297 the meantime, but this can be changed by setting &%queue_only_load_latch%&
14300 Deliveries will subsequently be performed by queue runner processes. This
14301 option has no effect on ancient operating systems on which Exim cannot
14302 determine the load average. See also &%deliver_queue_load_max%& and
14303 &%smtp_load_reserve%&.
14306 .option queue_only_load_latch main boolean true
14307 .cindex "load average" "re-evaluating per message"
14308 When this option is true (the default), once one message has been queued
14309 because the load average is higher than the value set by &%queue_only_load%&,
14310 all subsequent messages received on the same SMTP connection are also queued.
14311 This is a deliberate choice; even though the load average may fall below the
14312 threshold, it doesn't seem right to deliver later messages on the same
14313 connection when not delivering earlier ones. However, there are special
14314 circumstances such as very long-lived connections from scanning appliances
14315 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
14316 should be set false. This causes the value of the load average to be
14317 re-evaluated for each message.
14320 .option queue_only_override main boolean true
14321 .cindex "queueing incoming messages"
14322 When this option is true, the &%-od%&&'x'& command line options override the
14323 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
14324 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
14325 to override; they are accepted, but ignored.
14328 .option queue_run_in_order main boolean false
14329 .cindex "queue runner" "processing messages in order"
14330 If this option is set, queue runs happen in order of message arrival instead of
14331 in an arbitrary order. For this to happen, a complete list of the entire queue
14332 must be set up before the deliveries start. When the queue is all held in a
14333 single directory (the default), a single list is created for both the ordered
14334 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
14335 single list is not created when &%queue_run_in_order%& is false. In this case,
14336 the sub-directories are processed one at a time (in a random order), and this
14337 avoids setting up one huge list for the whole queue. Thus, setting
14338 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
14339 when the queue is large, because of the extra work in setting up the single,
14340 large list. In most situations, &%queue_run_in_order%& should not be set.
14344 .option queue_run_max main integer 5
14345 .cindex "queue runner" "maximum number of"
14346 This controls the maximum number of queue runner processes that an Exim daemon
14347 can run simultaneously. This does not mean that it starts them all at once,
14348 but rather that if the maximum number are still running when the time comes to
14349 start another one, it refrains from starting another one. This can happen with
14350 very large queues and/or very sluggish deliveries. This option does not,
14351 however, interlock with other processes, so additional queue runners can be
14352 started by other means, or by killing and restarting the daemon.
14354 Setting this option to zero does not suppress queue runs; rather, it disables
14355 the limit, allowing any number of simultaneous queue runner processes to be
14356 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
14357 the daemon's command line.
14359 .option queue_smtp_domains main "domain list&!!" unset
14360 .cindex "queueing incoming messages"
14361 .cindex "message" "queueing remote deliveries"
14362 When this option is set, a delivery process is started whenever a message is
14363 received, routing is performed, and local deliveries take place.
14364 However, if any SMTP deliveries are required for domains that match
14365 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
14366 message waits on the queue for the next queue run. Since routing of the message
14367 has taken place, Exim knows to which remote hosts it must be delivered, and so
14368 when the queue run happens, multiple messages for the same host are delivered
14369 over a single SMTP connection. The &%-odqs%& command line option causes all
14370 SMTP deliveries to be queued in this way, and is equivalent to setting
14371 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
14375 .option receive_timeout main time 0s
14376 .cindex "timeout" "for non-SMTP input"
14377 This option sets the timeout for accepting a non-SMTP message, that is, the
14378 maximum time that Exim waits when reading a message on the standard input. If
14379 the value is zero, it will wait for ever. This setting is overridden by the
14380 &%-or%& command line option. The timeout for incoming SMTP messages is
14381 controlled by &%smtp_receive_timeout%&.
14383 .option received_header_text main string&!! "see below"
14384 .cindex "customizing" "&'Received:'& header"
14385 .cindex "&'Received:'& header line" "customizing"
14386 This string defines the contents of the &'Received:'& message header that is
14387 added to each message, except for the timestamp, which is automatically added
14388 on at the end (preceded by a semicolon). The string is expanded each time it is
14389 used. If the expansion yields an empty string, no &'Received:'& header line is
14390 added to the message. Otherwise, the string should start with the text
14391 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
14392 header lines. The default setting is:
14395 received_header_text = Received: \
14396 ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
14397 {${if def:sender_ident \
14398 {from ${quote_local_part:$sender_ident} }}\
14399 ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
14400 by $primary_hostname \
14401 ${if def:received_protocol {with $received_protocol}} \
14402 ${if def:tls_cipher {($tls_cipher)\n\t}}\
14403 (Exim $version_number)\n\t\
14404 ${if def:sender_address \
14405 {(envelope-from <$sender_address>)\n\t}}\
14406 id $message_exim_id\
14407 ${if def:received_for {\n\tfor $received_for}}
14410 The reference to the TLS cipher is omitted when Exim is built without TLS
14411 support. The use of conditional expansions ensures that this works for both
14412 locally generated messages and messages received from remote hosts, giving
14413 header lines such as the following:
14415 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
14416 by marley.carol.example with esmtp (Exim 4.00)
14417 (envelope-from <bob@carol.example>)
14418 id 16IOWa-00019l-00
14419 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
14420 Received: by scrooge.carol.example with local (Exim 4.00)
14421 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
14423 Until the body of the message has been received, the timestamp is the time when
14424 the message started to be received. Once the body has arrived, and all policy
14425 checks have taken place, the timestamp is updated to the time at which the
14426 message was accepted.
14429 .option received_headers_max main integer 30
14430 .cindex "loop" "prevention"
14431 .cindex "mail loop prevention"
14432 .cindex "&'Received:'& header line" "counting"
14433 When a message is to be delivered, the number of &'Received:'& headers is
14434 counted, and if it is greater than this parameter, a mail loop is assumed to
14435 have occurred, the delivery is abandoned, and an error message is generated.
14436 This applies to both local and remote deliveries.
14439 .option recipient_unqualified_hosts main "host list&!!" unset
14440 .cindex "unqualified addresses"
14441 .cindex "host" "unqualified addresses from"
14442 This option lists those hosts from which Exim is prepared to accept unqualified
14443 recipient addresses in message envelopes. The addresses are made fully
14444 qualified by the addition of the &%qualify_recipient%& value. This option also
14445 affects message header lines. Exim does not reject unqualified recipient
14446 addresses in headers, but it qualifies them only if the message came from a
14447 host that matches &%recipient_unqualified_hosts%&,
14448 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
14449 option was not set.
14452 .option recipients_max main integer 0
14453 .cindex "limit" "number of recipients"
14454 .cindex "recipient" "maximum number"
14455 If this option is set greater than zero, it specifies the maximum number of
14456 original recipients for any message. Additional recipients that are generated
14457 by aliasing or forwarding do not count. SMTP messages get a 452 response for
14458 all recipients over the limit; earlier recipients are delivered as normal.
14459 Non-SMTP messages with too many recipients are failed, and no deliveries are
14462 .cindex "RCPT" "maximum number of incoming"
14463 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
14464 RCPT commands in a single message.
14467 .option recipients_max_reject main boolean false
14468 If this option is set true, Exim rejects SMTP messages containing too many
14469 recipients by giving 552 errors to the surplus RCPT commands, and a 554
14470 error to the eventual DATA command. Otherwise (the default) it gives a 452
14471 error to the surplus RCPT commands and accepts the message on behalf of the
14472 initial set of recipients. The remote server should then re-send the message
14473 for the remaining recipients at a later time.
14476 .option remote_max_parallel main integer 2
14477 .cindex "delivery" "parallelism for remote"
14478 This option controls parallel delivery of one message to a number of remote
14479 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
14480 does all the remote deliveries for a message one by one. Otherwise, if a single
14481 message has to be delivered to more than one remote host, or if several copies
14482 have to be sent to the same remote host, up to &%remote_max_parallel%&
14483 deliveries are done simultaneously. If more than &%remote_max_parallel%&
14484 deliveries are required, the maximum number of processes are started, and as
14485 each one finishes, another is begun. The order of starting processes is the
14486 same as if sequential delivery were being done, and can be controlled by the
14487 &%remote_sort_domains%& option. If parallel delivery takes place while running
14488 with debugging turned on, the debugging output from each delivery process is
14489 tagged with its process id.
14491 This option controls only the maximum number of parallel deliveries for one
14492 message in one Exim delivery process. Because Exim has no central queue
14493 manager, there is no way of controlling the total number of simultaneous
14494 deliveries if the configuration allows a delivery attempt as soon as a message
14497 .cindex "number of deliveries"
14498 .cindex "delivery" "maximum number of"
14499 If you want to control the total number of deliveries on the system, you
14500 need to set the &%queue_only%& option. This ensures that all incoming messages
14501 are added to the queue without starting a delivery process. Then set up an Exim
14502 daemon to start queue runner processes at appropriate intervals (probably
14503 fairly often, for example, every minute), and limit the total number of queue
14504 runners by setting the &%queue_run_max%& parameter. Because each queue runner
14505 delivers only one message at a time, the maximum number of deliveries that can
14506 then take place at once is &%queue_run_max%& multiplied by
14507 &%remote_max_parallel%&.
14509 If it is purely remote deliveries you want to control, use
14510 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
14511 doing the SMTP routing before queueing, so that several messages for the same
14512 host will eventually get delivered down the same connection.
14515 .option remote_sort_domains main "domain list&!!" unset
14516 .cindex "sorting remote deliveries"
14517 .cindex "delivery" "sorting remote"
14518 When there are a number of remote deliveries for a message, they are sorted by
14519 domain into the order given by this list. For example,
14521 remote_sort_domains = *.cam.ac.uk:*.uk
14523 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
14524 then to those in the &%uk%& domain, then to any others.
14527 .option retry_data_expire main time 7d
14528 .cindex "hints database" "data expiry"
14529 This option sets a &"use before"& time on retry information in Exim's hints
14530 database. Any older retry data is ignored. This means that, for example, once a
14531 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
14535 .option retry_interval_max main time 24h
14536 .cindex "retry" "limit on interval"
14537 .cindex "limit" "on retry interval"
14538 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
14539 intervals between delivery attempts for messages that cannot be delivered
14540 straight away. This option sets an overall limit to the length of time between
14541 retries. It cannot be set greater than 24 hours; any attempt to do so forces
14545 .option return_path_remove main boolean true
14546 .cindex "&'Return-path:'& header line" "removing"
14547 RFC 2821, section 4.4, states that an SMTP server must insert a
14548 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
14549 The &'Return-path:'& header preserves the sender address as received in the
14550 MAIL command. This description implies that this header should not be present
14551 in an incoming message. If &%return_path_remove%& is true, any existing
14552 &'Return-path:'& headers are removed from messages at the time they are
14553 received. Exim's transports have options for adding &'Return-path:'& headers at
14554 the time of delivery. They are normally used only for final local deliveries.
14557 .option return_size_limit main integer 100K
14558 This option is an obsolete synonym for &%bounce_return_size_limit%&.
14561 .option rfc1413_hosts main "host list&!!" *
14563 .cindex "host" "for RFC 1413 calls"
14564 RFC 1413 identification calls are made to any client host which matches an item
14567 .option rfc1413_query_timeout main time 5s
14568 .cindex "RFC 1413" "query timeout"
14569 .cindex "timeout" "for RFC 1413 call"
14570 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
14571 no RFC 1413 calls are ever made.
14574 .option sender_unqualified_hosts main "host list&!!" unset
14575 .cindex "unqualified addresses"
14576 .cindex "host" "unqualified addresses from"
14577 This option lists those hosts from which Exim is prepared to accept unqualified
14578 sender addresses. The addresses are made fully qualified by the addition of
14579 &%qualify_domain%&. This option also affects message header lines. Exim does
14580 not reject unqualified addresses in headers that contain sender addresses, but
14581 it qualifies them only if the message came from a host that matches
14582 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
14583 using TCP/IP), and the &%-bnq%& option was not set.
14586 .option smtp_accept_keepalive main boolean true
14587 .cindex "keepalive" "on incoming connection"
14588 This option controls the setting of the SO_KEEPALIVE option on incoming
14589 TCP/IP socket connections. When set, it causes the kernel to probe idle
14590 connections periodically, by sending packets with &"old"& sequence numbers. The
14591 other end of the connection should send an acknowledgment if the connection is
14592 still okay or a reset if the connection has been aborted. The reason for doing
14593 this is that it has the beneficial effect of freeing up certain types of
14594 connection that can get stuck when the remote host is disconnected without
14595 tidying up the TCP/IP call properly. The keepalive mechanism takes several
14596 hours to detect unreachable hosts.
14600 .option smtp_accept_max main integer 20
14601 .cindex "limit" "incoming SMTP connections"
14602 .cindex "SMTP" "incoming connection count"
14604 This option specifies the maximum number of simultaneous incoming SMTP calls
14605 that Exim will accept. It applies only to the listening daemon; there is no
14606 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
14607 value is set to zero, no limit is applied. However, it is required to be
14608 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
14609 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
14611 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
14612 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
14613 that limit has not been reached for the client host, &%smtp_accept_reserve%&
14614 and &%smtp_load_reserve%& are then checked before accepting the connection.
14617 .option smtp_accept_max_nonmail main integer 10
14618 .cindex "limit" "non-mail SMTP commands"
14619 .cindex "SMTP" "limiting non-mail commands"
14620 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
14621 the connection if there are too many. This option defines &"too many"&. The
14622 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
14623 client looping sending EHLO, for example. The check is applied only if the
14624 client host matches &%smtp_accept_max_nonmail_hosts%&.
14626 When a new message is expected, one occurrence of RSET is not counted. This
14627 allows a client to send one RSET between messages (this is not necessary,
14628 but some clients do it). Exim also allows one uncounted occurrence of HELO
14629 or EHLO, and one occurrence of STARTTLS between messages. After
14630 starting up a TLS session, another EHLO is expected, and so it too is not
14631 counted. The first occurrence of AUTH in a connection, or immediately
14632 following STARTTLS is not counted. Otherwise, all commands other than
14633 MAIL, RCPT, DATA, and QUIT are counted.
14636 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
14637 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
14638 check by setting this option. The default value makes it apply to all hosts. By
14639 changing the value, you can exclude any badly-behaved hosts that you have to
14643 . Allow this long option name to split; give it unsplit as a fifth argument
14644 . for the automatic .oindex that is generated by .option.
14646 .option "smtp_accept_max_per_ &~&~connection" main integer 1000 &&&
14647 smtp_accept_max_per_connection
14648 .cindex "SMTP" "limiting incoming message count"
14649 .cindex "limit" "messages per SMTP connection"
14650 The value of this option limits the number of MAIL commands that Exim is
14651 prepared to accept over a single SMTP connection, whether or not each command
14652 results in the transfer of a message. After the limit is reached, a 421
14653 response is given to subsequent MAIL commands. This limit is a safety
14654 precaution against a client that goes mad (incidents of this type have been
14658 .option smtp_accept_max_per_host main string&!! unset
14659 .cindex "limit" "SMTP connections from one host"
14660 .cindex "host" "limiting SMTP connections from"
14661 This option restricts the number of simultaneous IP connections from a single
14662 host (strictly, from a single IP address) to the Exim daemon. The option is
14663 expanded, to enable different limits to be applied to different hosts by
14664 reference to &$sender_host_address$&. Once the limit is reached, additional
14665 connection attempts from the same host are rejected with error code 421. This
14666 is entirely independent of &%smtp_accept_reserve%&. The option's default value
14667 of zero imposes no limit. If this option is set greater than zero, it is
14668 required that &%smtp_accept_max%& be non-zero.
14670 &*Warning*&: When setting this option you should not use any expansion
14671 constructions that take an appreciable amount of time. The expansion and test
14672 happen in the main daemon loop, in order to reject additional connections
14673 without forking additional processes (otherwise a denial-of-service attack
14674 could cause a vast number or processes to be created). While the daemon is
14675 doing this processing, it cannot accept any other incoming connections.
14679 .option smtp_accept_queue main integer 0
14680 .cindex "SMTP" "incoming connection count"
14681 .cindex "queueing incoming messages"
14682 .cindex "message" "queueing by SMTP connection count"
14683 If the number of simultaneous incoming SMTP connections being handled via the
14684 listening daemon exceeds this value, messages received by SMTP are just placed
14685 on the queue; no delivery processes are started automatically. The count is
14686 fixed at the start of an SMTP connection. It cannot be updated in the
14687 subprocess that receives messages, and so the queueing or not queueing applies
14688 to all messages received in the same connection.
14690 A value of zero implies no limit, and clearly any non-zero value is useful only
14691 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
14692 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
14693 various &%-od%&&'x'& command line options.
14696 . Allow this long option name to split; give it unsplit as a fifth argument
14697 . for the automatic .oindex that is generated by .option.
14699 .option "smtp_accept_queue_per_ &~&~connection" main integer 10 &&&
14700 smtp_accept_queue_per_connection
14701 .cindex "queueing incoming messages"
14702 .cindex "message" "queueing by message count"
14703 This option limits the number of delivery processes that Exim starts
14704 automatically when receiving messages via SMTP, whether via the daemon or by
14705 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
14706 and the number of messages received in a single SMTP session exceeds this
14707 number, subsequent messages are placed on the queue, but no delivery processes
14708 are started. This helps to limit the number of Exim processes when a server
14709 restarts after downtime and there is a lot of mail waiting for it on other
14710 systems. On large systems, the default should probably be increased, and on
14711 dial-in client systems it should probably be set to zero (that is, disabled).
14714 .option smtp_accept_reserve main integer 0
14715 .cindex "SMTP" "incoming call count"
14716 .cindex "host" "reserved"
14717 When &%smtp_accept_max%& is set greater than zero, this option specifies a
14718 number of SMTP connections that are reserved for connections from the hosts
14719 that are specified in &%smtp_reserve_hosts%&. The value set in
14720 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
14721 restricted to this number of connections; the option specifies a minimum number
14722 of connection slots for them, not a maximum. It is a guarantee that this group
14723 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
14724 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
14727 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
14728 set to 5, once there are 45 active connections (from any hosts), new
14729 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
14730 provided the other criteria for acceptance are met.
14733 .option smtp_active_hostname main string&!! unset
14734 .cindex "host" "name in SMTP responses"
14735 .cindex "SMTP" "host name in responses"
14736 .vindex "&$primary_hostname$&"
14737 This option is provided for multi-homed servers that want to masquerade as
14738 several different hosts. At the start of an incoming SMTP connection, its value
14739 is expanded and used instead of the value of &$primary_hostname$& in SMTP
14740 responses. For example, it is used as domain name in the response to an
14741 incoming HELO or EHLO command.
14743 .vindex "&$smtp_active_hostname$&"
14744 The active hostname is placed in the &$smtp_active_hostname$& variable, which
14745 is saved with any messages that are received. It is therefore available for use
14746 in routers and transports when the message is later delivered.
14748 If this option is unset, or if its expansion is forced to fail, or if the
14749 expansion results in an empty string, the value of &$primary_hostname$& is
14750 used. Other expansion failures cause a message to be written to the main and
14751 panic logs, and the SMTP command receives a temporary error. Typically, the
14752 value of &%smtp_active_hostname%& depends on the incoming interface address.
14755 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
14756 {cox.mydomain}{box.mydomain}}
14759 Although &$smtp_active_hostname$& is primarily concerned with incoming
14760 messages, it is also used as the default for HELO commands in callout
14761 verification if there is no remote transport from which to obtain a
14762 &%helo_data%& value.
14764 .option smtp_banner main string&!! "see below"
14765 .cindex "SMTP" "welcome banner"
14766 .cindex "banner for SMTP"
14767 .cindex "welcome banner for SMTP"
14768 .cindex "customizing" "SMTP banner"
14769 This string, which is expanded every time it is used, is output as the initial
14770 positive response to an SMTP connection. The default setting is:
14772 smtp_banner = $smtp_active_hostname ESMTP Exim \
14773 $version_number $tod_full
14775 Failure to expand the string causes a panic error. If you want to create a
14776 multiline response to the initial SMTP connection, use &"\n"& in the string at
14777 appropriate points, but not at the end. Note that the 220 code is not included
14778 in this string. Exim adds it automatically (several times in the case of a
14779 multiline response).
14782 .option smtp_check_spool_space main boolean true
14783 .cindex "checking disk space"
14784 .cindex "disk space, checking"
14785 .cindex "spool directory" "checking space"
14786 When this option is set, if an incoming SMTP session encounters the SIZE
14787 option on a MAIL command, it checks that there is enough space in the
14788 spool directory's partition to accept a message of that size, while still
14789 leaving free the amount specified by &%check_spool_space%& (even if that value
14790 is zero). If there isn't enough space, a temporary error code is returned.
14793 .option smtp_connect_backlog main integer 20
14794 .cindex "connection backlog"
14795 .cindex "SMTP" "connection backlog"
14796 .cindex "backlog of connections"
14797 This option specifies a maximum number of waiting SMTP connections. Exim passes
14798 this value to the TCP/IP system when it sets up its listener. Once this number
14799 of connections are waiting for the daemon's attention, subsequent connection
14800 attempts are refused at the TCP/IP level. At least, that is what the manuals
14801 say; in some circumstances such connection attempts have been observed to time
14802 out instead. For large systems it is probably a good idea to increase the
14803 value (to 50, say). It also gives some protection against denial-of-service
14804 attacks by SYN flooding.
14807 .option smtp_enforce_sync main boolean true
14808 .cindex "SMTP" "synchronization checking"
14809 .cindex "synchronization checking in SMTP"
14810 The SMTP protocol specification requires the client to wait for a response from
14811 the server at certain points in the dialogue. Without PIPELINING these
14812 synchronization points are after every command; with PIPELINING they are
14813 fewer, but they still exist.
14815 Some spamming sites send out a complete set of SMTP commands without waiting
14816 for any response. Exim protects against this by rejecting a message if the
14817 client has sent further input when it should not have. The error response &"554
14818 SMTP synchronization error"& is sent, and the connection is dropped. Testing
14819 for this error cannot be perfect because of transmission delays (unexpected
14820 input may be on its way but not yet received when Exim checks). However, it
14821 does detect many instances.
14823 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
14824 If you want to disable the check selectively (for example, only for certain
14825 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
14826 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
14830 .option smtp_etrn_command main string&!! unset
14831 .cindex "ETRN" "command to be run"
14832 .vindex "&$domain$&"
14833 If this option is set, the given command is run whenever an SMTP ETRN
14834 command is received from a host that is permitted to issue such commands (see
14835 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
14836 are independently expanded. The expansion variable &$domain$& is set to the
14837 argument of the ETRN command, and no syntax checking is done on it. For
14840 smtp_etrn_command = /etc/etrn_command $domain \
14841 $sender_host_address
14843 A new process is created to run the command, but Exim does not wait for it to
14844 complete. Consequently, its status cannot be checked. If the command cannot be
14845 run, a line is written to the panic log, but the ETRN caller still receives
14846 a 250 success response. Exim is normally running under its own uid when
14847 receiving SMTP, so it is not possible for it to change the uid before running
14851 .option smtp_etrn_serialize main boolean true
14852 .cindex "ETRN" "serializing"
14853 When this option is set, it prevents the simultaneous execution of more than
14854 one identical command as a result of ETRN in an SMTP connection. See
14855 section &<<SECTETRN>>& for details.
14858 .option smtp_load_reserve main fixed-point unset
14859 .cindex "load average"
14860 If the system load average ever gets higher than this, incoming SMTP calls are
14861 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
14862 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
14863 the load is over the limit. The option has no effect on ancient operating
14864 systems on which Exim cannot determine the load average. See also
14865 &%deliver_queue_load_max%& and &%queue_only_load%&.
14869 .option smtp_max_synprot_errors main integer 3
14870 .cindex "SMTP" "limiting syntax and protocol errors"
14871 .cindex "limit" "SMTP syntax and protocol errors"
14872 Exim rejects SMTP commands that contain syntax or protocol errors. In
14873 particular, a syntactically invalid email address, as in this command:
14875 RCPT TO:<abc xyz@a.b.c>
14877 causes immediate rejection of the command, before any other tests are done.
14878 (The ACL cannot be run if there is no valid address to set up for it.) An
14879 example of a protocol error is receiving RCPT before MAIL. If there are
14880 too many syntax or protocol errors in one SMTP session, the connection is
14881 dropped. The limit is set by this option.
14883 .cindex "PIPELINING" "expected errors"
14884 When the PIPELINING extension to SMTP is in use, some protocol errors are
14885 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
14886 Exim assumes that PIPELINING will be used if it advertises it (see
14887 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
14888 not count towards the limit.
14892 .option smtp_max_unknown_commands main integer 3
14893 .cindex "SMTP" "limiting unknown commands"
14894 .cindex "limit" "unknown SMTP commands"
14895 If there are too many unrecognized commands in an incoming SMTP session, an
14896 Exim server drops the connection. This is a defence against some kinds of abuse
14899 into making connections to SMTP ports; in these circumstances, a number of
14900 non-SMTP command lines are sent first.
14904 .option smtp_ratelimit_hosts main "host list&!!" unset
14905 .cindex "SMTP" "rate limiting"
14906 .cindex "limit" "rate of message arrival"
14907 .cindex "RCPT" "rate limiting"
14908 Some sites find it helpful to be able to limit the rate at which certain hosts
14909 can send them messages, and the rate at which an individual message can specify
14912 Exim has two rate-limiting facilities. This section describes the older
14913 facility, which can limit rates within a single connection. The newer
14914 &%ratelimit%& ACL condition can limit rates across all connections. See section
14915 &<<SECTratelimiting>>& for details of the newer facility.
14917 When a host matches &%smtp_ratelimit_hosts%&, the values of
14918 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
14919 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
14920 respectively. Each option, if set, must contain a set of four comma-separated
14924 A threshold, before which there is no rate limiting.
14926 An initial time delay. Unlike other times in Exim, numbers with decimal
14927 fractional parts are allowed here.
14929 A factor by which to increase the delay each time.
14931 A maximum value for the delay. This should normally be less than 5 minutes,
14932 because after that time, the client is liable to timeout the SMTP command.
14935 For example, these settings have been used successfully at the site which
14936 first suggested this feature, for controlling mail from their customers:
14938 smtp_ratelimit_mail = 2,0.5s,1.05,4m
14939 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
14941 The first setting specifies delays that are applied to MAIL commands after
14942 two have been received over a single connection. The initial delay is 0.5
14943 seconds, increasing by a factor of 1.05 each time. The second setting applies
14944 delays to RCPT commands when more than four occur in a single message.
14947 .option smtp_ratelimit_mail main string unset
14948 See &%smtp_ratelimit_hosts%& above.
14951 .option smtp_ratelimit_rcpt main string unset
14952 See &%smtp_ratelimit_hosts%& above.
14955 .option smtp_receive_timeout main time 5m
14956 .cindex "timeout" "for SMTP input"
14957 .cindex "SMTP" "input timeout"
14958 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
14959 input, including batch SMTP. If a line of input (either an SMTP command or a
14960 data line) is not received within this time, the SMTP connection is dropped and
14961 the message is abandoned.
14962 A line is written to the log containing one of the following messages:
14964 SMTP command timeout on connection from...
14965 SMTP data timeout on connection from...
14967 The former means that Exim was expecting to read an SMTP command; the latter
14968 means that it was in the DATA phase, reading the contents of a message.
14972 The value set by this option can be overridden by the
14973 &%-os%& command-line option. A setting of zero time disables the timeout, but
14974 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
14975 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
14976 timeout is controlled by &%receive_timeout%& and &%-or%&.
14979 .option smtp_reserve_hosts main "host list&!!" unset
14980 This option defines hosts for which SMTP connections are reserved; see
14981 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
14984 .option smtp_return_error_details main boolean false
14985 .cindex "SMTP" "details policy failures"
14986 .cindex "policy control" "rejection, returning details"
14987 In the default state, Exim uses bland messages such as
14988 &"Administrative prohibition"& when it rejects SMTP commands for policy
14989 reasons. Many sysadmins like this because it gives away little information
14990 to spammers. However, some other sysadmins who are applying strict checking
14991 policies want to give out much fuller information about failures. Setting
14992 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
14993 example, instead of &"Administrative prohibition"&, it might give:
14995 550-Rejected after DATA: '>' missing at end of address:
14996 550 failing address in "From" header is: <user@dom.ain
14999 .option spamd_address main string "see below"
15000 This option is available when Exim is compiled with the content-scanning
15001 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
15002 The default value is
15006 See section &<<SECTscanspamass>>& for more details.
15010 .option split_spool_directory main boolean false
15011 .cindex "multiple spool directories"
15012 .cindex "spool directory" "split"
15013 .cindex "directories, multiple"
15014 If this option is set, it causes Exim to split its input directory into 62
15015 subdirectories, each with a single alphanumeric character as its name. The
15016 sixth character of the message id is used to allocate messages to
15017 subdirectories; this is the least significant base-62 digit of the time of
15018 arrival of the message.
15020 Splitting up the spool in this way may provide better performance on systems
15021 where there are long mail queues, by reducing the number of files in any one
15022 directory. The msglog directory is also split up in a similar way to the input
15023 directory; however, if &%preserve_message_logs%& is set, all old msglog files
15024 are still placed in the single directory &_msglog.OLD_&.
15026 It is not necessary to take any special action for existing messages when
15027 changing &%split_spool_directory%&. Exim notices messages that are in the
15028 &"wrong"& place, and continues to process them. If the option is turned off
15029 after a period of being on, the subdirectories will eventually empty and be
15030 automatically deleted.
15032 When &%split_spool_directory%& is set, the behaviour of queue runner processes
15033 changes. Instead of creating a list of all messages in the queue, and then
15034 trying to deliver each one in turn, it constructs a list of those in one
15035 sub-directory and tries to deliver them, before moving on to the next
15036 sub-directory. The sub-directories are processed in a random order. This
15037 spreads out the scanning of the input directories, and uses less memory. It is
15038 particularly beneficial when there are lots of messages on the queue. However,
15039 if &%queue_run_in_order%& is set, none of this new processing happens. The
15040 entire queue has to be scanned and sorted before any deliveries can start.
15043 .option spool_directory main string&!! "set at compile time"
15044 .cindex "spool directory" "path to"
15045 This defines the directory in which Exim keeps its spool, that is, the messages
15046 it is waiting to deliver. The default value is taken from the compile-time
15047 configuration setting, if there is one. If not, this option must be set. The
15048 string is expanded, so it can contain, for example, a reference to
15049 &$primary_hostname$&.
15051 If the spool directory name is fixed on your installation, it is recommended
15052 that you set it at build time rather than from this option, particularly if the
15053 log files are being written to the spool directory (see &%log_file_path%&).
15054 Otherwise log files cannot be used for errors that are detected early on, such
15055 as failures in the configuration file.
15057 By using this option to override the compiled-in path, it is possible to run
15058 tests of Exim without using the standard spool.
15060 .option sqlite_lock_timeout main time 5s
15061 .cindex "sqlite lookup type" "lock timeout"
15062 This option controls the timeout that the &(sqlite)& lookup uses when trying to
15063 access an SQLite database. See section &<<SECTsqlite>>& for more details.
15065 .option strict_acl_vars main boolean false
15066 .cindex "&ACL;" "variables, handling unset"
15067 This option controls what happens if a syntactically valid but undefined ACL
15068 variable is referenced. If it is false (the default), an empty string
15069 is substituted; if it is true, an error is generated. See section
15070 &<<SECTaclvariables>>& for details of ACL variables.
15072 .option strip_excess_angle_brackets main boolean false
15073 .cindex "angle brackets, excess"
15074 If this option is set, redundant pairs of angle brackets round &"route-addr"&
15075 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
15076 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
15077 passed on to another MTA, the excess angle brackets are not passed on. If this
15078 option is not set, multiple pairs of angle brackets cause a syntax error.
15081 .option strip_trailing_dot main boolean false
15082 .cindex "trailing dot on domain"
15083 .cindex "dot" "trailing on domain"
15084 If this option is set, a trailing dot at the end of a domain in an address is
15085 ignored. If this is in the envelope and the message is passed on to another
15086 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
15087 domain causes a syntax error.
15088 However, addresses in header lines are checked only when an ACL requests header
15092 .option syslog_duplication main boolean true
15093 .cindex "syslog" "duplicate log lines; suppressing"
15094 When Exim is logging to syslog, it writes the log lines for its three
15095 separate logs at different syslog priorities so that they can in principle
15096 be separated on the logging hosts. Some installations do not require this
15097 separation, and in those cases, the duplication of certain log lines is a
15098 nuisance. If &%syslog_duplication%& is set false, only one copy of any
15099 particular log line is written to syslog. For lines that normally go to
15100 both the main log and the reject log, the reject log version (possibly
15101 containing message header lines) is written, at LOG_NOTICE priority.
15102 Lines that normally go to both the main and the panic log are written at
15103 the LOG_ALERT priority.
15106 .option syslog_facility main string unset
15107 .cindex "syslog" "facility; setting"
15108 This option sets the syslog &"facility"& name, used when Exim is logging to
15109 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
15110 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
15111 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
15112 details of Exim's logging.
15116 .option syslog_processname main string &`exim`&
15117 .cindex "syslog" "process name; setting"
15118 This option sets the syslog &"ident"& name, used when Exim is logging to
15119 syslog. The value must be no longer than 32 characters. See chapter
15120 &<<CHAPlog>>& for details of Exim's logging.
15124 .option syslog_timestamp main boolean true
15125 .cindex "syslog" "timestamps"
15126 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
15127 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
15128 details of Exim's logging.
15131 .option system_filter main string&!! unset
15132 .cindex "filter" "system filter"
15133 .cindex "system filter" "specifying"
15134 .cindex "Sieve filter" "not available for system filter"
15135 This option specifies an Exim filter file that is applied to all messages at
15136 the start of each delivery attempt, before any routing is done. System filters
15137 must be Exim filters; they cannot be Sieve filters. If the system filter
15138 generates any deliveries to files or pipes, or any new mail messages, the
15139 appropriate &%system_filter_..._transport%& option(s) must be set, to define
15140 which transports are to be used. Details of this facility are given in chapter
15141 &<<CHAPsystemfilter>>&.
15144 .option system_filter_directory_transport main string&!! unset
15145 .vindex "&$address_file$&"
15146 This sets the name of the transport driver that is to be used when the
15147 &%save%& command in a system message filter specifies a path ending in &"/"&,
15148 implying delivery of each message into a separate file in some directory.
15149 During the delivery, the variable &$address_file$& contains the path name.
15152 .option system_filter_file_transport main string&!! unset
15153 .cindex "file" "transport for system filter"
15154 This sets the name of the transport driver that is to be used when the &%save%&
15155 command in a system message filter specifies a path not ending in &"/"&. During
15156 the delivery, the variable &$address_file$& contains the path name.
15158 .option system_filter_group main string unset
15159 .cindex "gid (group id)" "system filter"
15160 This option is used only when &%system_filter_user%& is also set. It sets the
15161 gid under which the system filter is run, overriding any gid that is associated
15162 with the user. The value may be numerical or symbolic.
15164 .option system_filter_pipe_transport main string&!! unset
15165 .cindex "&(pipe)& transport" "for system filter"
15166 .vindex "&$address_pipe$&"
15167 This specifies the transport driver that is to be used when a &%pipe%& command
15168 is used in a system filter. During the delivery, the variable &$address_pipe$&
15169 contains the pipe command.
15172 .option system_filter_reply_transport main string&!! unset
15173 .cindex "&(autoreply)& transport" "for system filter"
15174 This specifies the transport driver that is to be used when a &%mail%& command
15175 is used in a system filter.
15177 .option system_filter_user main string unset
15178 .cindex "uid (user id)" "system filter"
15179 If this option is not set, the system filter is run in the main Exim delivery
15180 process, as root. When the option is set, the system filter runs in a separate
15181 process, as the given user. Unless the string consists entirely of digits, it
15182 is looked up in the password data. Failure to find the named user causes a
15183 configuration error. The gid is either taken from the password data, or
15184 specified by &%system_filter_group%&. When the uid is specified numerically,
15185 &%system_filter_group%& is required to be set.
15187 If the system filter generates any pipe, file, or reply deliveries, the uid
15188 under which the filter is run is used when transporting them, unless a
15189 transport option overrides. Normally you should set &%system_filter_user%& if
15190 your system filter generates these kinds of delivery.
15193 .option tcp_nodelay main boolean true
15194 .cindex "daemon" "TCP_NODELAY on sockets"
15195 .cindex "Nagle algorithm"
15196 .cindex "TCP_NODELAY on listening sockets"
15197 If this option is set false, it stops the Exim daemon setting the
15198 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
15199 turns off the &"Nagle algorithm"&, which is a way of improving network
15200 performance in interactive (character-by-character) situations. Turning it off
15201 should improve Exim's performance a bit, so that is what happens by default.
15202 However, it appears that some broken clients cannot cope, and time out. Hence
15203 this option. It affects only those sockets that are set up for listening by the
15204 daemon. Sockets created by the smtp transport for delivering mail always set
15208 .option timeout_frozen_after main time 0s
15209 .cindex "frozen messages" "timing out"
15210 .cindex "timeout" "frozen messages"
15211 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
15212 message of any kind that has been on the queue for longer than the given time
15213 is automatically cancelled at the next queue run. If the frozen message is a
15214 bounce message, it is just discarded; otherwise, a bounce is sent to the
15215 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
15216 If you want to timeout frozen bounce messages earlier than other kinds of
15217 frozen message, see &%ignore_bounce_errors_after%&.
15219 &*Note:*& the default value of zero means no timeouts; with this setting,
15220 frozen messages remain on the queue forever (except for any frozen bounce
15221 messages that are released by &%ignore_bounce_errors_after%&).
15224 .option timezone main string unset
15225 .cindex "timezone, setting"
15226 The value of &%timezone%& is used to set the environment variable TZ while
15227 running Exim (if it is different on entry). This ensures that all timestamps
15228 created by Exim are in the required timezone. If you want all your timestamps
15229 to be in UTC (aka GMT) you should set
15233 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
15234 or, if that is not set, from the value of the TZ environment variable when Exim
15235 is built. If &%timezone%& is set to the empty string, either at build or run
15236 time, any existing TZ variable is removed from the environment when Exim
15237 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
15238 unfortunately not all, operating systems.
15241 .option tls_advertise_hosts main "host list&!!" unset
15242 .cindex "TLS" "advertising"
15243 .cindex "encryption" "on SMTP connection"
15244 .cindex "SMTP" "encrypted connection"
15245 When Exim is built with support for TLS encrypted connections, the availability
15246 of the STARTTLS command to set up an encrypted session is advertised in
15247 response to EHLO only to those client hosts that match this option. See
15248 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
15251 .option tls_certificate main string&!! unset
15252 .cindex "TLS" "server certificate; location of"
15253 .cindex "certificate" "server, location of"
15254 The value of this option is expanded, and must then be the absolute path to a
15255 file which contains the server's certificates. The server's private key is also
15256 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
15257 &<<CHAPTLS>>& for further details.
15259 &*Note*&: The certificates defined by this option are used only when Exim is
15260 receiving incoming messages as a server. If you want to supply certificates for
15261 use when sending messages as a client, you must set the &%tls_certificate%&
15262 option in the relevant &(smtp)& transport.
15265 .option tls_crl main string&!! unset
15266 .cindex "TLS" "server certificate revocation list"
15267 .cindex "certificate" "revocation list for server"
15268 This option specifies a certificate revocation list. The expanded value must
15269 be the name of a file that contains a CRL in PEM format.
15272 .option tls_dhparam main string&!! unset
15273 .cindex "TLS" "D-H parameters for server"
15274 The value of this option is expanded, and must then be the absolute path to
15275 a file which contains the server's DH parameter values.
15276 This is used only for OpenSSL. When Exim is linked with GnuTLS, this option is
15277 ignored. See section &<<SECTopenvsgnu>>& for further details.
15280 .option tls_on_connect_ports main "string list" unset
15281 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
15282 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
15283 set up without waiting for the client to issue a STARTTLS command. For
15284 further details, see section &<<SECTsupobssmt>>&.
15288 .option tls_privatekey main string&!! unset
15289 .cindex "TLS" "server private key; location of"
15290 The value of this option is expanded, and must then be the absolute path to a
15291 file which contains the server's private key. If this option is unset, or if
15292 the expansion is forced to fail, or the result is an empty string, the private
15293 key is assumed to be in the same file as the server's certificates. See chapter
15294 &<<CHAPTLS>>& for further details.
15297 .option tls_remember_esmtp main boolean false
15298 .cindex "TLS" "esmtp state; remembering"
15299 .cindex "TLS" "broken clients"
15300 If this option is set true, Exim violates the RFCs by remembering that it is in
15301 &"esmtp"& state after successfully negotiating a TLS session. This provides
15302 support for broken clients that fail to send a new EHLO after starting a
15306 .option tls_require_ciphers main string&!! unset
15307 .cindex "TLS" "requiring specific ciphers"
15308 .cindex "cipher" "requiring specific"
15309 This option controls which ciphers can be used for incoming TLS connections.
15310 The &(smtp)& transport has an option of the same name for controlling outgoing
15311 connections. This option is expanded for each connection, so can be varied for
15312 different clients if required. The value of this option must be a list of
15313 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
15314 in somewhat different ways. If GnuTLS is being used, the client controls the
15315 preference order of the available ciphers. Details are given in sections
15316 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
15319 .option tls_try_verify_hosts main "host list&!!" unset
15320 .cindex "TLS" "client certificate verification"
15321 .cindex "certificate" "verification of client"
15322 See &%tls_verify_hosts%& below.
15325 .option tls_verify_certificates main string&!! unset
15326 .cindex "TLS" "client certificate verification"
15327 .cindex "certificate" "verification of client"
15328 The value of this option is expanded, and must then be the absolute path to
15329 a file containing permitted certificates for clients that
15330 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&. Alternatively, if you
15331 are using OpenSSL, you can set &%tls_verify_certificates%& to the name of a
15332 directory containing certificate files. This does not work with GnuTLS; the
15333 option must be set to the name of a single file if you are using GnuTLS.
15336 .option tls_verify_hosts main "host list&!!" unset
15337 .cindex "TLS" "client certificate verification"
15338 .cindex "certificate" "verification of client"
15339 This option, along with &%tls_try_verify_hosts%&, controls the checking of
15340 certificates from clients. The expected certificates are defined by
15341 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
15342 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
15343 &%tls_verify_certificates%& is not set.
15345 Any client that matches &%tls_verify_hosts%& is constrained by
15346 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
15347 present one of the listed certificates. If it does not, the connection is
15348 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
15349 the host to use TLS. It can still send SMTP commands through unencrypted
15350 connections. Forcing a client to use TLS has to be done separately using an
15351 ACL to reject inappropriate commands when the connection is not encrypted.
15353 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
15354 matches this option (but not &%tls_verify_hosts%&), Exim requests a
15355 certificate and checks it against &%tls_verify_certificates%&, but does not
15356 abort the connection if there is no certificate or if it does not match. This
15357 state can be detected in an ACL, which makes it possible to implement policies
15358 such as &"accept for relay only if a verified certificate has been received,
15359 but accept for local delivery if encrypted, even without a verified
15362 Client hosts that match neither of these lists are not asked to present
15366 .option trusted_groups main "string list&!!" unset
15367 .cindex "trusted groups"
15368 .cindex "groups" "trusted"
15369 This option is expanded just once, at the start of Exim's processing. If this
15370 option is set, any process that is running in one of the listed groups, or
15371 which has one of them as a supplementary group, is trusted. The groups can be
15372 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
15373 details of what trusted callers are permitted to do. If neither
15374 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
15377 .option trusted_users main "string list&!!" unset
15378 .cindex "trusted users"
15379 .cindex "user" "trusted"
15380 This option is expanded just once, at the start of Exim's processing. If this
15381 option is set, any process that is running as one of the listed users is
15382 trusted. The users can be specified numerically or by name. See section
15383 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
15384 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
15385 Exim user are trusted.
15387 .option unknown_login main string&!! unset
15388 .cindex "uid (user id)" "unknown caller"
15389 .vindex "&$caller_uid$&"
15390 This is a specialized feature for use in unusual configurations. By default, if
15391 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
15392 gives up. The &%unknown_login%& option can be used to set a login name to be
15393 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
15394 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
15395 is used for the user's real name (gecos field), unless this has been set by the
15398 .option unknown_username main string unset
15399 See &%unknown_login%&.
15401 .option untrusted_set_sender main "address list&!!" unset
15402 .cindex "trusted users"
15403 .cindex "sender" "setting by untrusted user"
15404 .cindex "untrusted user setting sender"
15405 .cindex "user" "untrusted setting sender"
15406 .cindex "envelope sender"
15407 When an untrusted user submits a message to Exim using the standard input, Exim
15408 normally creates an envelope sender address from the user's login and the
15409 default qualification domain. Data from the &%-f%& option (for setting envelope
15410 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
15411 is used) is ignored.
15413 However, untrusted users are permitted to set an empty envelope sender address,
15414 to declare that a message should never generate any bounces. For example:
15416 exim -f '<>' user@domain.example
15418 .vindex "&$sender_ident$&"
15419 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
15420 other envelope sender addresses in a controlled way. When it is set, untrusted
15421 users are allowed to set envelope sender addresses that match any of the
15422 patterns in the list. Like all address lists, the string is expanded. The
15423 identity of the user is in &$sender_ident$&, so you can, for example, restrict
15424 users to setting senders that start with their login ids
15425 followed by a hyphen
15426 by a setting like this:
15428 untrusted_set_sender = ^$sender_ident-
15430 If you want to allow untrusted users to set envelope sender addresses without
15431 restriction, you can use
15433 untrusted_set_sender = *
15435 The &%untrusted_set_sender%& option applies to all forms of local input, but
15436 only to the setting of the envelope sender. It does not permit untrusted users
15437 to use the other options which trusted user can use to override message
15438 parameters. Furthermore, it does not stop Exim from removing an existing
15439 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
15440 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
15441 overriding these actions. The handling of the &'Sender:'& header is also
15442 described in section &<<SECTthesenhea>>&.
15444 The log line for a message's arrival shows the envelope sender following
15445 &"<="&. For local messages, the user's login always follows, after &"U="&. In
15446 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
15447 envelope sender address, the user's login is shown in parentheses after the
15451 .option uucp_from_pattern main string "see below"
15452 .cindex "&""From""& line"
15453 .cindex "UUCP" "&""From""& line"
15454 Some applications that pass messages to an MTA via a command line interface use
15455 an initial line starting with &"From&~"& to pass the envelope sender. In
15456 particular, this is used by UUCP software. Exim recognizes such a line by means
15457 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
15458 matches, the sender address is constructed by expanding the contents of
15459 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
15460 default pattern recognizes lines in the following two forms:
15462 From ph10 Fri Jan 5 12:35 GMT 1996
15463 From ph10 Fri, 7 Jan 97 14:00:00 GMT
15465 The pattern can be seen by running
15467 exim -bP uucp_from_pattern
15469 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
15470 year in the second case. The first word after &"From&~"& is matched in the
15471 regular expression by a parenthesized subpattern. The default value for
15472 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
15473 (&"ph10"& in the example above) as the message's sender. See also
15474 &%ignore_fromline_hosts%&.
15477 .option uucp_from_sender main string&!! &`$1`&
15478 See &%uucp_from_pattern%& above.
15481 .option warn_message_file main string unset
15482 .cindex "warning of delay" "customizing the message"
15483 .cindex "customizing" "warning message"
15484 This option defines a template file containing paragraphs of text to be used
15485 for constructing the warning message which is sent by Exim when a message has
15486 been on the queue for a specified amount of time, as specified by
15487 &%delay_warning%&. Details of the file's contents are given in chapter
15488 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
15491 .option write_rejectlog main boolean true
15492 .cindex "reject log" "disabling"
15493 If this option is set false, Exim no longer writes anything to the reject log.
15494 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
15495 .ecindex IIDconfima
15496 .ecindex IIDmaiconf
15501 . ////////////////////////////////////////////////////////////////////////////
15502 . ////////////////////////////////////////////////////////////////////////////
15504 .chapter "Generic options for routers" "CHAProutergeneric"
15505 .scindex IIDgenoprou1 "options" "generic; for routers"
15506 .scindex IIDgenoprou2 "generic options" "router"
15507 This chapter describes the generic options that apply to all routers.
15508 Those that are preconditions are marked with ‡ in the &"use"& field.
15510 For a general description of how a router operates, see sections
15511 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
15512 which the preconditions are tested. The order of expansion of the options that
15513 provide data for a transport is: &%errors_to%&, &%headers_add%&,
15514 &%headers_remove%&, &%transport%&.
15518 .option address_data routers string&!! unset
15519 .cindex "router" "data attached to address"
15520 The string is expanded just before the router is run, that is, after all the
15521 precondition tests have succeeded. If the expansion is forced to fail, the
15522 router declines, the value of &%address_data%& remains unchanged, and the
15523 &%more%& option controls what happens next. Other expansion failures cause
15524 delivery of the address to be deferred.
15526 .vindex "&$address_data$&"
15527 When the expansion succeeds, the value is retained with the address, and can be
15528 accessed using the variable &$address_data$& in the current router, subsequent
15529 routers, and the eventual transport.
15531 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
15532 that runs a user's filter file, the contents of &$address_data$& are accessible
15533 in the filter. This is not normally a problem, because such data is usually
15534 either not confidential or it &"belongs"& to the current user, but if you do
15535 put confidential data into &$address_data$& you need to remember this point.
15537 Even if the router declines or passes, the value of &$address_data$& remains
15538 with the address, though it can be changed by another &%address_data%& setting
15539 on a subsequent router. If a router generates child addresses, the value of
15540 &$address_data$& propagates to them. This also applies to the special kind of
15541 &"child"& that is generated by a router with the &%unseen%& option.
15543 The idea of &%address_data%& is that you can use it to look up a lot of data
15544 for the address once, and then pick out parts of the data later. For example,
15545 you could use a single LDAP lookup to return a string of the form
15547 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
15549 In the transport you could pick out the mailbox by a setting such as
15551 file = ${extract{mailbox}{$address_data}}
15553 This makes the configuration file less messy, and also reduces the number of
15554 lookups (though Exim does cache lookups).
15556 .vindex "&$sender_address_data$&"
15557 .vindex "&$address_data$&"
15558 The &%address_data%& facility is also useful as a means of passing information
15559 from one router to another, and from a router to a transport. In addition, if
15560 &$address_data$& is set by a router when verifying a recipient address from an
15561 ACL, it remains available for use in the rest of the ACL statement. After
15562 verifying a sender, the value is transferred to &$sender_address_data$&.
15566 .option address_test routers&!? boolean true
15568 .cindex "router" "skipping when address testing"
15569 If this option is set false, the router is skipped when routing is being tested
15570 by means of the &%-bt%& command line option. This can be a convenience when
15571 your first router sends messages to an external scanner, because it saves you
15572 having to set the &"already scanned"& indicator when testing real address
15577 .option cannot_route_message routers string&!! unset
15578 .cindex "router" "customizing &""cannot route""& message"
15579 .cindex "customizing" "&""cannot route""& message"
15580 This option specifies a text message that is used when an address cannot be
15581 routed because Exim has run out of routers. The default message is
15582 &"Unrouteable address"&. This option is useful only on routers that have
15583 &%more%& set false, or on the very last router in a configuration, because the
15584 value that is used is taken from the last router that is considered. This
15585 includes a router that is skipped because its preconditions are not met, as
15586 well as a router that declines. For example, using the default configuration,
15589 cannot_route_message = Remote domain not found in DNS
15591 on the first router, which is a &(dnslookup)& router with &%more%& set false,
15594 cannot_route_message = Unknown local user
15596 on the final router that checks for local users. If string expansion fails for
15597 this option, the default message is used. Unless the expansion failure was
15598 explicitly forced, a message about the failure is written to the main and panic
15599 logs, in addition to the normal message about the routing failure.
15602 .option caseful_local_part routers boolean false
15603 .cindex "case of local parts"
15604 .cindex "router" "case of local parts"
15605 By default, routers handle the local parts of addresses in a case-insensitive
15606 manner, though the actual case is preserved for transmission with the message.
15607 If you want the case of letters to be significant in a router, you must set
15608 this option true. For individual router options that contain address or local
15609 part lists (for example, &%local_parts%&), case-sensitive matching can be
15610 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
15613 .vindex "&$local_part$&"
15614 .vindex "&$original_local_part$&"
15615 .vindex "&$parent_local_part$&"
15616 The value of the &$local_part$& variable is forced to lower case while a
15617 router is running unless &%caseful_local_part%& is set. When a router assigns
15618 an address to a transport, the value of &$local_part$& when the transport runs
15619 is the same as it was in the router. Similarly, when a router generates child
15620 addresses by aliasing or forwarding, the values of &$original_local_part$&
15621 and &$parent_local_part$& are those that were used by the redirecting router.
15623 This option applies to the processing of an address by a router. When a
15624 recipient address is being processed in an ACL, there is a separate &%control%&
15625 modifier that can be used to specify case-sensitive processing within the ACL
15626 (see section &<<SECTcontrols>>&).
15630 .option check_local_user routers&!? boolean false
15631 .cindex "local user, checking in router"
15632 .cindex "router" "checking for local user"
15633 .cindex "&_/etc/passwd_&"
15635 When this option is true, Exim checks that the local part of the recipient
15636 address (with affixes removed if relevant) is the name of an account on the
15637 local system. The check is done by calling the &[getpwnam()]& function rather
15638 than trying to read &_/etc/passwd_& directly. This means that other methods of
15639 holding password data (such as NIS) are supported. If the local part is a local
15640 user, &$home$& is set from the password data, and can be tested in other
15641 preconditions that are evaluated after this one (the order of evaluation is
15642 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
15643 overridden by &%router_home_directory%&. If the local part is not a local user,
15644 the router is skipped.
15646 If you want to check that the local part is either the name of a local user
15647 or matches something else, you cannot combine &%check_local_user%& with a
15648 setting of &%local_parts%&, because that specifies the logical &'and'& of the
15649 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
15650 setting to achieve this. For example:
15652 local_parts = passwd;$local_part : lsearch;/etc/other/users
15654 Note, however, that the side effects of &%check_local_user%& (such as setting
15655 up a home directory) do not occur when a &(passwd)& lookup is used in a
15656 &%local_parts%& (or any other) precondition.
15660 .option condition routers&!? string&!! unset
15661 .cindex "router" "customized precondition"
15662 This option specifies a general precondition test that has to succeed for the
15663 router to be called. The &%condition%& option is the last precondition to be
15664 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
15665 result is a forced failure, or an empty string, or one of the strings &"0"& or
15666 &"no"& or &"false"& (checked without regard to the case of the letters), the
15667 router is skipped, and the address is offered to the next one.
15669 If the result is any other value, the router is run (as this is the last
15670 precondition to be evaluated, all the other preconditions must be true).
15672 The &%condition%& option provides a means of applying custom conditions to the
15673 running of routers. Note that in the case of a simple conditional expansion,
15674 the default expansion values are exactly what is wanted. For example:
15676 condition = ${if >{$message_age}{600}}
15678 Because of the default behaviour of the string expansion, this is equivalent to
15680 condition = ${if >{$message_age}{600}{true}{}}
15682 If the expansion fails (other than forced failure) delivery is deferred. Some
15683 of the other precondition options are common special cases that could in fact
15684 be specified using &%condition%&.
15688 .option debug_print routers string&!! unset
15689 .cindex "testing" "variables in drivers"
15690 If this option is set and debugging is enabled (see the &%-d%& command line
15691 option), the string is expanded and included in the debugging output.
15692 If expansion of the string fails, the error message is written to the debugging
15693 output, and Exim carries on processing.
15694 This option is provided to help with checking out the values of variables and
15695 so on when debugging router configurations. For example, if a &%condition%&
15696 option appears not to be working, &%debug_print%& can be used to output the
15697 variables it references. The output happens after checks for &%domains%&,
15698 &%local_parts%&, and &%check_local_user%& but before any other preconditions
15699 are tested. A newline is added to the text if it does not end with one.
15703 .option disable_logging routers boolean false
15704 If this option is set true, nothing is logged for any routing errors
15705 or for any deliveries caused by this router. You should not set this option
15706 unless you really, really know what you are doing. See also the generic
15707 transport option of the same name.
15710 .option domains routers&!? "domain list&!!" unset
15711 .cindex "router" "restricting to specific domains"
15712 .vindex "&$domain_data$&"
15713 If this option is set, the router is skipped unless the current domain matches
15714 the list. If the match is achieved by means of a file lookup, the data that the
15715 lookup returned for the domain is placed in &$domain_data$& for use in string
15716 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
15717 a list of the order in which preconditions are evaluated.
15721 .option driver routers string unset
15722 This option must always be set. It specifies which of the available routers is
15727 .option errors_to routers string&!! unset
15728 .cindex "envelope sender"
15729 .cindex "router" "changing address for errors"
15730 If a router successfully handles an address, it may assign the address to a
15731 transport for delivery or it may generate child addresses. In both cases, if
15732 there is a delivery problem during later processing, the resulting bounce
15733 message is sent to the address that results from expanding this string,
15734 provided that the address verifies successfully. The &%errors_to%& option is
15735 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
15737 The &%errors_to%& setting associated with an address can be overridden if it
15738 subsequently passes through other routers that have their own &%errors_to%&
15739 settings, or if the message is delivered by a transport with a &%return_path%&
15742 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
15743 the expansion fails to verify, the errors address associated with the incoming
15744 address is used. At top level, this is the envelope sender. A non-forced
15745 expansion failure causes delivery to be deferred.
15747 If an address for which &%errors_to%& has been set ends up being delivered over
15748 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
15749 any bounces that are generated by other MTAs on the delivery route are also
15750 sent there. You can set &%errors_to%& to the empty string by either of these
15756 An expansion item that yields an empty string has the same effect. If you do
15757 this, a locally detected delivery error for addresses processed by this router
15758 no longer gives rise to a bounce message; the error is discarded. If the
15759 address is delivered to a remote host, the return path is set to &`<>`&, unless
15760 overridden by the &%return_path%& option on the transport.
15762 .vindex "&$address_data$&"
15763 If for some reason you want to discard local errors, but use a non-empty
15764 MAIL command for remote delivery, you can preserve the original return
15765 path in &$address_data$& in the router, and reinstate it in the transport by
15766 setting &%return_path%&.
15768 The most common use of &%errors_to%& is to direct mailing list bounces to the
15769 manager of the list, as described in section &<<SECTmailinglists>>&, or to
15770 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
15774 .option expn routers&!? boolean true
15775 .cindex "address" "testing"
15776 .cindex "testing" "addresses"
15777 .cindex "EXPN" "router skipping"
15778 .cindex "router" "skipping for EXPN"
15779 If this option is turned off, the router is skipped when testing an address
15780 as a result of processing an SMTP EXPN command. You might, for example,
15781 want to turn it off on a router for users' &_.forward_& files, while leaving it
15782 on for the system alias file.
15783 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
15786 The use of the SMTP EXPN command is controlled by an ACL (see chapter
15787 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
15788 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
15792 .option fail_verify routers boolean false
15793 .cindex "router" "forcing verification failure"
15794 Setting this option has the effect of setting both &%fail_verify_sender%& and
15795 &%fail_verify_recipient%& to the same value.
15799 .option fail_verify_recipient routers boolean false
15800 If this option is true and an address is accepted by this router when
15801 verifying a recipient, verification fails.
15805 .option fail_verify_sender routers boolean false
15806 If this option is true and an address is accepted by this router when
15807 verifying a sender, verification fails.
15811 .option fallback_hosts routers "string list" unset
15812 .cindex "router" "fallback hosts"
15813 .cindex "fallback" "hosts specified on router"
15814 String expansion is not applied to this option. The argument must be a
15815 colon-separated list of host names or IP addresses. The list separator can be
15816 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
15817 each name or address. In fact, the format of each item is exactly the same as
15818 defined for the list of hosts in a &(manualroute)& router (see section
15819 &<<SECTformatonehostitem>>&).
15821 If a router queues an address for a remote transport, this host list is
15822 associated with the address, and used instead of the transport's fallback host
15823 list. If &%hosts_randomize%& is set on the transport, the order of the list is
15824 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
15825 transport for further details.
15828 .option group routers string&!! "see below"
15829 .cindex "gid (group id)" "local delivery"
15830 .cindex "local transports" "uid and gid"
15831 .cindex "transport" "local"
15832 .cindex "router" "setting group"
15833 When a router queues an address for a transport, and the transport does not
15834 specify a group, the group given here is used when running the delivery
15836 The group may be specified numerically or by name. If expansion fails, the
15837 error is logged and delivery is deferred.
15838 The default is unset, unless &%check_local_user%& is set, when the default
15839 is taken from the password information. See also &%initgroups%& and &%user%&
15840 and the discussion in chapter &<<CHAPenvironment>>&.
15844 .option headers_add routers string&!! unset
15845 .cindex "header lines" "adding"
15846 .cindex "router" "adding header lines"
15847 This option specifies a string of text that is expanded at routing time, and
15848 associated with any addresses that are accepted by the router. However, this
15849 option has no effect when an address is just being verified. The way in which
15850 the text is used to add header lines at transport time is described in section
15851 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
15852 message is in the process of being transported. This means that references to
15853 header lines in string expansions in the transport's configuration do not
15854 &"see"& the added header lines.
15856 The &%headers_add%& option is expanded after &%errors_to%&, but before
15857 &%headers_remove%& and &%transport%&. If the expanded string is empty, or if
15858 the expansion is forced to fail, the option has no effect. Other expansion
15859 failures are treated as configuration errors.
15861 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
15862 router that has the &%one_time%& option set.
15864 .cindex "duplicate addresses"
15865 .oindex "&%unseen%&"
15866 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
15867 additions are deleted when the address is passed on to subsequent routers.
15868 For a &%redirect%& router, if a generated address is the same as the incoming
15869 address, this can lead to duplicate addresses with different header
15870 modifications. Exim does not do duplicate deliveries (except, in certain
15871 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
15872 which of the duplicates is discarded, so this ambiguous situation should be
15873 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
15877 .option headers_remove routers string&!! unset
15878 .cindex "header lines" "removing"
15879 .cindex "router" "removing header lines"
15880 This option specifies a string of text that is expanded at routing time, and
15881 associated with any addresses that are accepted by the router. However, this
15882 option has no effect when an address is just being verified. The way in which
15883 the text is used to remove header lines at transport time is described in
15884 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
15885 the message is in the process of being transported. This means that references
15886 to header lines in string expansions in the transport's configuration still
15887 &"see"& the original header lines.
15889 The &%headers_remove%& option is expanded after &%errors_to%& and
15890 &%headers_add%&, but before &%transport%&. If the expansion is forced to fail,
15891 the option has no effect. Other expansion failures are treated as configuration
15894 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
15895 router that has the &%one_time%& option set.
15897 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
15898 removal requests are deleted when the address is passed on to subsequent
15899 routers, and this can lead to problems with duplicates -- see the similar
15900 warning for &%headers_add%& above.
15903 .option ignore_target_hosts routers "host list&!!" unset
15904 .cindex "IP address" "discarding"
15905 .cindex "router" "discarding IP addresses"
15906 Although this option is a host list, it should normally contain IP address
15907 entries rather than names. If any host that is looked up by the router has an
15908 IP address that matches an item in this list, Exim behaves as if that IP
15909 address did not exist. This option allows you to cope with rogue DNS entries
15912 remote.domain.example. A 127.0.0.1
15916 ignore_target_hosts = 127.0.0.1
15918 on the relevant router. If all the hosts found by a &(dnslookup)& router are
15919 discarded in this way, the router declines. In a conventional configuration, an
15920 attempt to mail to such a domain would normally provoke the &"unrouteable
15921 domain"& error, and an attempt to verify an address in the domain would fail.
15922 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
15923 router declines if presented with one of the listed addresses.
15925 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
15926 means of the first or the second of the following settings, respectively:
15928 ignore_target_hosts = 0.0.0.0/0
15929 ignore_target_hosts = <; 0::0/0
15931 The pattern in the first line matches all IPv4 addresses, whereas the pattern
15932 in the second line matches all IPv6 addresses.
15934 This option may also be useful for ignoring link-local and site-local IPv6
15935 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
15936 is expanded before use as a list, it is possible to make it dependent on the
15937 domain that is being routed.
15939 .vindex "&$host_address$&"
15940 During its expansion, &$host_address$& is set to the IP address that is being
15943 .option initgroups routers boolean false
15944 .cindex "additional groups"
15945 .cindex "groups" "additional"
15946 .cindex "local transports" "uid and gid"
15947 .cindex "transport" "local"
15948 If the router queues an address for a transport, and this option is true, and
15949 the uid supplied by the router is not overridden by the transport, the
15950 &[initgroups()]& function is called when running the transport to ensure that
15951 any additional groups associated with the uid are set up. See also &%group%&
15952 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
15956 .option local_part_prefix routers&!? "string list" unset
15957 .cindex "router" "prefix for local part"
15958 .cindex "prefix" "for local part, used in router"
15959 If this option is set, the router is skipped unless the local part starts with
15960 one of the given strings, or &%local_part_prefix_optional%& is true. See
15961 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
15964 The list is scanned from left to right, and the first prefix that matches is
15965 used. A limited form of wildcard is available; if the prefix begins with an
15966 asterisk, it matches the longest possible sequence of arbitrary characters at
15967 the start of the local part. An asterisk should therefore always be followed by
15968 some character that does not occur in normal local parts.
15969 .cindex "multiple mailboxes"
15970 .cindex "mailbox" "multiple"
15971 Wildcarding can be used to set up multiple user mailboxes, as described in
15972 section &<<SECTmulbox>>&.
15974 .vindex "&$local_part$&"
15975 .vindex "&$local_part_prefix$&"
15976 During the testing of the &%local_parts%& option, and while the router is
15977 running, the prefix is removed from the local part, and is available in the
15978 expansion variable &$local_part_prefix$&. When a message is being delivered, if
15979 the router accepts the address, this remains true during subsequent delivery by
15980 a transport. In particular, the local part that is transmitted in the RCPT
15981 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
15982 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
15983 the relevant transport.
15985 When an address is being verified, &%local_part_prefix%& affects only the
15986 behaviour of the router. If the callout feature of verification is in use, this
15987 means that the full address, including the prefix, will be used during the
15990 The prefix facility is commonly used to handle local parts of the form
15991 &%owner-something%&. Another common use is to support local parts of the form
15992 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
15993 to tell a user their forwarding is broken &-- by placing a router like this one
15994 immediately before the router that handles &_.forward_& files:
15998 local_part_prefix = real-
16000 transport = local_delivery
16002 For security, it would probably be a good idea to restrict the use of this
16003 router to locally-generated messages, using a condition such as this:
16005 condition = ${if match {$sender_host_address}\
16006 {\N^(|127\.0\.0\.1)$\N}}
16009 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
16010 both conditions must be met if not optional. Care must be taken if wildcards
16011 are used in both a prefix and a suffix on the same router. Different
16012 separator characters must be used to avoid ambiguity.
16015 .option local_part_prefix_optional routers boolean false
16016 See &%local_part_prefix%& above.
16020 .option local_part_suffix routers&!? "string list" unset
16021 .cindex "router" "suffix for local part"
16022 .cindex "suffix for local part" "used in router"
16023 This option operates in the same way as &%local_part_prefix%&, except that the
16024 local part must end (rather than start) with the given string, the
16025 &%local_part_suffix_optional%& option determines whether the suffix is
16026 mandatory, and the wildcard * character, if present, must be the last
16027 character of the suffix. This option facility is commonly used to handle local
16028 parts of the form &%something-request%& and multiple user mailboxes of the form
16032 .option local_part_suffix_optional routers boolean false
16033 See &%local_part_suffix%& above.
16037 .option local_parts routers&!? "local part list&!!" unset
16038 .cindex "router" "restricting to specific local parts"
16039 .cindex "local part" "checking in router"
16040 The router is run only if the local part of the address matches the list.
16041 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16043 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
16044 string is expanded, it is possible to make it depend on the domain, for
16047 local_parts = dbm;/usr/local/specials/$domain
16049 .vindex "&$local_part_data$&"
16050 If the match is achieved by a lookup, the data that the lookup returned
16051 for the local part is placed in the variable &$local_part_data$& for use in
16052 expansions of the router's private options. You might use this option, for
16053 example, if you have a large number of local virtual domains, and you want to
16054 send all postmaster mail to the same place without having to set up an alias in
16055 each virtual domain:
16059 local_parts = postmaster
16060 data = postmaster@real.domain.example
16064 .option log_as_local routers boolean "see below"
16065 .cindex "log" "delivery line"
16066 .cindex "delivery" "log line format"
16067 Exim has two logging styles for delivery, the idea being to make local
16068 deliveries stand out more visibly from remote ones. In the &"local"& style, the
16069 recipient address is given just as the local part, without a domain. The use of
16070 this style is controlled by this option. It defaults to true for the &(accept)&
16071 router, and false for all the others. This option applies only when a
16072 router assigns an address to a transport. It has no effect on routers that
16073 redirect addresses.
16077 .option more routers boolean&!! true
16078 The result of string expansion for this option must be a valid boolean value,
16079 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
16080 result causes an error, and delivery is deferred. If the expansion is forced to
16081 fail, the default value for the option (true) is used. Other failures cause
16082 delivery to be deferred.
16084 If this option is set false, and the router declines to handle the address, no
16085 further routers are tried, routing fails, and the address is bounced.
16087 However, if the router explicitly passes an address to the following router by
16088 means of the setting
16092 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
16093 does not affect the behaviour if one of the precondition tests fails. In that
16094 case, the address is always passed to the next router.
16096 Note that &%address_data%& is not considered to be a precondition. If its
16097 expansion is forced to fail, the router declines, and the value of &%more%&
16098 controls what happens next.
16101 .option pass_on_timeout routers boolean false
16102 .cindex "timeout" "of router"
16103 .cindex "router" "timeout"
16104 If a router times out during a host lookup, it normally causes deferral of the
16105 address. If &%pass_on_timeout%& is set, the address is passed on to the next
16106 router, overriding &%no_more%&. This may be helpful for systems that are
16107 intermittently connected to the Internet, or those that want to pass to a smart
16108 host any messages that cannot immediately be delivered.
16110 There are occasional other temporary errors that can occur while doing DNS
16111 lookups. They are treated in the same way as a timeout, and this option
16112 applies to all of them.
16116 .option pass_router routers string unset
16117 .cindex "router" "go to after &""pass""&"
16118 Routers that recognize the generic &%self%& option (&(dnslookup)&,
16119 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
16120 routing to continue, and overriding a false setting of &%more%&. When one of
16121 these routers returns &"pass"&, the address is normally handed on to the next
16122 router in sequence. This can be changed by setting &%pass_router%& to the name
16123 of another router. However (unlike &%redirect_router%&) the named router must
16124 be below the current router, to avoid loops. Note that this option applies only
16125 to the special case of &"pass"&. It does not apply when a router returns
16126 &"decline"& because it cannot handle an address.
16130 .option redirect_router routers string unset
16131 .cindex "router" "start at after redirection"
16132 Sometimes an administrator knows that it is pointless to reprocess addresses
16133 generated from alias or forward files with the same router again. For
16134 example, if an alias file translates real names into login ids there is no
16135 point searching the alias file a second time, especially if it is a large file.
16137 The &%redirect_router%& option can be set to the name of any router instance.
16138 It causes the routing of any generated addresses to start at the named router
16139 instead of at the first router. This option has no effect if the router in
16140 which it is set does not generate new addresses.
16144 .option require_files routers&!? "string list&!!" unset
16145 .cindex "file" "requiring for router"
16146 .cindex "router" "requiring file existence"
16147 This option provides a general mechanism for predicating the running of a
16148 router on the existence or non-existence of certain files or directories.
16149 Before running a router, as one of its precondition tests, Exim works its way
16150 through the &%require_files%& list, expanding each item separately.
16152 Because the list is split before expansion, any colons in expansion items must
16153 be doubled, or the facility for using a different list separator must be used.
16154 If any expansion is forced to fail, the item is ignored. Other expansion
16155 failures cause routing of the address to be deferred.
16157 If any expanded string is empty, it is ignored. Otherwise, except as described
16158 below, each string must be a fully qualified file path, optionally preceded by
16159 &"!"&. The paths are passed to the &[stat()]& function to test for the
16160 existence of the files or directories. The router is skipped if any paths not
16161 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
16164 If &[stat()]& cannot determine whether a file exists or not, delivery of
16165 the message is deferred. This can happen when NFS-mounted filesystems are
16168 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
16169 options, so you cannot use it to check for the existence of a file in which to
16170 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
16171 full list of the order in which preconditions are evaluated.) However, as
16172 these options are all expanded, you can use the &%exists%& expansion condition
16173 to make such tests. The &%require_files%& option is intended for checking files
16174 that the router may be going to use internally, or which are needed by a
16175 transport (for example &_.procmailrc_&).
16177 During delivery, the &[stat()]& function is run as root, but there is a
16178 facility for some checking of the accessibility of a file by another user.
16179 This is not a proper permissions check, but just a &"rough"& check that
16180 operates as follows:
16182 If an item in a &%require_files%& list does not contain any forward slash
16183 characters, it is taken to be the user (and optional group, separated by a
16184 comma) to be checked for subsequent files in the list. If no group is specified
16185 but the user is specified symbolically, the gid associated with the uid is
16188 require_files = mail:/some/file
16189 require_files = $local_part:$home/.procmailrc
16191 If a user or group name in a &%require_files%& list does not exist, the
16192 &%require_files%& condition fails.
16194 Exim performs the check by scanning along the components of the file path, and
16195 checking the access for the given uid and gid. It checks for &"x"& access on
16196 directories, and &"r"& access on the final file. Note that this means that file
16197 access control lists, if the operating system has them, are ignored.
16199 &*Warning 1*&: When the router is being run to verify addresses for an
16200 incoming SMTP message, Exim is not running as root, but under its own uid. This
16201 may affect the result of a &%require_files%& check. In particular, &[stat()]&
16202 may yield the error EACCES (&"Permission denied"&). This means that the Exim
16203 user is not permitted to read one of the directories on the file's path.
16205 &*Warning 2*&: Even when Exim is running as root while delivering a message,
16206 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
16207 without root access. In this case, if a check for access by a particular user
16208 is requested, Exim creates a subprocess that runs as that user, and tries the
16209 check again in that process.
16211 The default action for handling an unresolved EACCES is to consider it to
16212 be caused by a configuration error, and routing is deferred because the
16213 existence or non-existence of the file cannot be determined. However, in some
16214 circumstances it may be desirable to treat this condition as if the file did
16215 not exist. If the file name (or the exclamation mark that precedes the file
16216 name for non-existence) is preceded by a plus sign, the EACCES error is treated
16217 as if the file did not exist. For example:
16219 require_files = +/some/file
16221 If the router is not an essential part of verification (for example, it
16222 handles users' &_.forward_& files), another solution is to set the &%verify%&
16223 option false so that the router is skipped when verifying.
16227 .option retry_use_local_part routers boolean "see below"
16228 .cindex "hints database" "retry keys"
16229 .cindex "local part" "in retry keys"
16230 When a delivery suffers a temporary routing failure, a retry record is created
16231 in Exim's hints database. For addresses whose routing depends only on the
16232 domain, the key for the retry record should not involve the local part, but for
16233 other addresses, both the domain and the local part should be included.
16234 Usually, remote routing is of the former kind, and local routing is of the
16237 This option controls whether the local part is used to form the key for retry
16238 hints for addresses that suffer temporary errors while being handled by this
16239 router. The default value is true for any router that has &%check_local_user%&
16240 set, and false otherwise. Note that this option does not apply to hints keys
16241 for transport delays; they are controlled by a generic transport option of the
16244 The setting of &%retry_use_local_part%& applies only to the router on which it
16245 appears. If the router generates child addresses, they are routed
16246 independently; this setting does not become attached to them.
16250 .option router_home_directory routers string&!! unset
16251 .cindex "router" "home directory for"
16252 .cindex "home directory" "for router"
16254 This option sets a home directory for use while the router is running. (Compare
16255 &%transport_home_directory%&, which sets a home directory for later
16256 transporting.) In particular, if used on a &(redirect)& router, this option
16257 sets a value for &$home$& while a filter is running. The value is expanded;
16258 forced expansion failure causes the option to be ignored &-- other failures
16259 cause the router to defer.
16261 Expansion of &%router_home_directory%& happens immediately after the
16262 &%check_local_user%& test (if configured), before any further expansions take
16264 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16266 While the router is running, &%router_home_directory%& overrides the value of
16267 &$home$& that came from &%check_local_user%&.
16269 When a router accepts an address and assigns it to a local transport (including
16270 the cases when a &(redirect)& router generates a pipe, file, or autoreply
16271 delivery), the home directory setting for the transport is taken from the first
16272 of these values that is set:
16275 The &%home_directory%& option on the transport;
16277 The &%transport_home_directory%& option on the router;
16279 The password data if &%check_local_user%& is set on the router;
16281 The &%router_home_directory%& option on the router.
16284 In other words, &%router_home_directory%& overrides the password data for the
16285 router, but not for the transport.
16289 .option self routers string freeze
16290 .cindex "MX record" "pointing to local host"
16291 .cindex "local host" "MX pointing to"
16292 This option applies to those routers that use a recipient address to find a
16293 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
16294 and &(manualroute)& routers.
16295 Certain configurations of the &(queryprogram)& router can also specify a list
16297 Usually such routers are configured to send the message to a remote host via an
16298 &(smtp)& transport. The &%self%& option specifies what happens when the first
16299 host on the list turns out to be the local host.
16300 The way in which Exim checks for the local host is described in section
16301 &<<SECTreclocipadd>>&.
16303 Normally this situation indicates either an error in Exim's configuration (for
16304 example, the router should be configured not to process this domain), or an
16305 error in the DNS (for example, the MX should not point to this host). For this
16306 reason, the default action is to log the incident, defer the address, and
16307 freeze the message. The following alternatives are provided for use in special
16312 Delivery of the message is tried again later, but the message is not frozen.
16314 .vitem "&%reroute%&: <&'domain'&>"
16315 The domain is changed to the given domain, and the address is passed back to
16316 be reprocessed by the routers. No rewriting of headers takes place. This
16317 behaviour is essentially a redirection.
16319 .vitem "&%reroute: rewrite:%& <&'domain'&>"
16320 The domain is changed to the given domain, and the address is passed back to be
16321 reprocessed by the routers. Any headers that contain the original domain are
16326 .vindex "&$self_hostname$&"
16327 The router passes the address to the next router, or to the router named in the
16328 &%pass_router%& option if it is set. This overrides &%no_more%&. During
16329 subsequent routing and delivery, the variable &$self_hostname$& contains the
16330 name of the local host that the router encountered. This can be used to
16331 distinguish between different cases for hosts with multiple names. The
16337 ensures that only those addresses that routed to the local host are passed on.
16338 Without &%no_more%&, addresses that were declined for other reasons would also
16339 be passed to the next router.
16342 Delivery fails and an error report is generated.
16345 .cindex "local host" "sending to"
16346 The anomaly is ignored and the address is queued for the transport. This
16347 setting should be used with extreme caution. For an &(smtp)& transport, it
16348 makes sense only in cases where the program that is listening on the SMTP port
16349 is not this version of Exim. That is, it must be some other MTA, or Exim with a
16350 different configuration file that handles the domain in another way.
16355 .option senders routers&!? "address list&!!" unset
16356 .cindex "router" "checking senders"
16357 If this option is set, the router is skipped unless the message's sender
16358 address matches something on the list.
16359 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16362 There are issues concerning verification when the running of routers is
16363 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
16364 setting, it sets the sender to the null string. When using the &%-bt%& option
16365 to check a configuration file, it is necessary also to use the &%-f%& option to
16366 set an appropriate sender. For incoming mail, the sender is unset when
16367 verifying the sender, but is available when verifying any recipients. If the
16368 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
16372 .option translate_ip_address routers string&!! unset
16373 .cindex "IP address" "translating"
16374 .cindex "packet radio"
16375 .cindex "router" "IP address translation"
16376 There exist some rare networking situations (for example, packet radio) where
16377 it is helpful to be able to translate IP addresses generated by normal routing
16378 mechanisms into other IP addresses, thus performing a kind of manual IP
16379 routing. This should be done only if the normal IP routing of the TCP/IP stack
16380 is inadequate or broken. Because this is an extremely uncommon requirement, the
16381 code to support this option is not included in the Exim binary unless
16382 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
16384 .vindex "&$host_address$&"
16385 The &%translate_ip_address%& string is expanded for every IP address generated
16386 by the router, with the generated address set in &$host_address$&. If the
16387 expansion is forced to fail, no action is taken.
16388 For any other expansion error, delivery of the message is deferred.
16389 If the result of the expansion is an IP address, that replaces the original
16390 address; otherwise the result is assumed to be a host name &-- this is looked
16391 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
16392 produce one or more replacement IP addresses. For example, to subvert all IP
16393 addresses in some specific networks, this could be added to a router:
16395 translate_ip_address = \
16396 ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
16399 The file would contain lines like
16401 10.2.3.128/26 some.host
16402 10.8.4.34/26 10.44.8.15
16404 You should not make use of this facility unless you really understand what you
16409 .option transport routers string&!! unset
16410 This option specifies the transport to be used when a router accepts an address
16411 and sets it up for delivery. A transport is never needed if a router is used
16412 only for verification. The value of the option is expanded at routing time,
16413 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
16414 and result must be the name of one of the configured transports. If it is not,
16415 delivery is deferred.
16417 The &%transport%& option is not used by the &(redirect)& router, but it does
16418 have some private options that set up transports for pipe and file deliveries
16419 (see chapter &<<CHAPredirect>>&).
16423 .option transport_current_directory routers string&!! unset
16424 .cindex "current directory for local transport"
16425 This option associates a current directory with any address that is routed
16426 to a local transport. This can happen either because a transport is
16427 explicitly configured for the router, or because it generates a delivery to a
16428 file or a pipe. During the delivery process (that is, at transport time), this
16429 option string is expanded and is set as the current directory, unless
16430 overridden by a setting on the transport.
16431 If the expansion fails for any reason, including forced failure, an error is
16432 logged, and delivery is deferred.
16433 See chapter &<<CHAPenvironment>>& for details of the local delivery
16439 .option transport_home_directory routers string&!! "see below"
16440 .cindex "home directory" "for local transport"
16441 This option associates a home directory with any address that is routed to a
16442 local transport. This can happen either because a transport is explicitly
16443 configured for the router, or because it generates a delivery to a file or a
16444 pipe. During the delivery process (that is, at transport time), the option
16445 string is expanded and is set as the home directory, unless overridden by a
16446 setting of &%home_directory%& on the transport.
16447 If the expansion fails for any reason, including forced failure, an error is
16448 logged, and delivery is deferred.
16450 If the transport does not specify a home directory, and
16451 &%transport_home_directory%& is not set for the router, the home directory for
16452 the transport is taken from the password data if &%check_local_user%& is set for
16453 the router. Otherwise it is taken from &%router_home_directory%& if that option
16454 is set; if not, no home directory is set for the transport.
16456 See chapter &<<CHAPenvironment>>& for further details of the local delivery
16462 .option unseen routers boolean&!! false
16463 .cindex "router" "carrying on after success"
16464 The result of string expansion for this option must be a valid boolean value,
16465 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
16466 result causes an error, and delivery is deferred. If the expansion is forced to
16467 fail, the default value for the option (false) is used. Other failures cause
16468 delivery to be deferred.
16470 When this option is set true, routing does not cease if the router accepts the
16471 address. Instead, a copy of the incoming address is passed to the next router,
16472 overriding a false setting of &%more%&. There is little point in setting
16473 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
16474 the value of &%unseen%& contains expansion items (and therefore, presumably, is
16475 sometimes true and sometimes false).
16477 .cindex "copy of message (&%unseen%& option)"
16478 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
16479 qualifier in filter files. It can be used to cause copies of messages to be
16480 delivered to some other destination, while also carrying out a normal delivery.
16481 In effect, the current address is made into a &"parent"& that has two children
16482 &-- one that is delivered as specified by this router, and a clone that goes on
16483 to be routed further. For this reason, &%unseen%& may not be combined with the
16484 &%one_time%& option in a &(redirect)& router.
16486 &*Warning*&: Header lines added to the address (or specified for removal) by
16487 this router or by previous routers affect the &"unseen"& copy of the message
16488 only. The clone that continues to be processed by further routers starts with
16489 no added headers and none specified for removal. For a &%redirect%& router, if
16490 a generated address is the same as the incoming address, this can lead to
16491 duplicate addresses with different header modifications. Exim does not do
16492 duplicate deliveries (except, in certain circumstances, to pipes -- see section
16493 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
16494 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
16495 &%redirect%& router may be of help.
16497 Unlike the handling of header modifications, any data that was set by the
16498 &%address_data%& option in the current or previous routers &'is'& passed on to
16499 subsequent routers.
16502 .option user routers string&!! "see below"
16503 .cindex "uid (user id)" "local delivery"
16504 .cindex "local transports" "uid and gid"
16505 .cindex "transport" "local"
16506 .cindex "router" "user for filter processing"
16507 .cindex "filter" "user for processing"
16508 When a router queues an address for a transport, and the transport does not
16509 specify a user, the user given here is used when running the delivery process.
16510 The user may be specified numerically or by name. If expansion fails, the
16511 error is logged and delivery is deferred.
16512 This user is also used by the &(redirect)& router when running a filter file.
16513 The default is unset, except when &%check_local_user%& is set. In this case,
16514 the default is taken from the password information. If the user is specified as
16515 a name, and &%group%& is not set, the group associated with the user is used.
16516 See also &%initgroups%& and &%group%& and the discussion in chapter
16517 &<<CHAPenvironment>>&.
16521 .option verify routers&!? boolean true
16522 Setting this option has the effect of setting &%verify_sender%& and
16523 &%verify_recipient%& to the same value.
16526 .option verify_only routers&!? boolean false
16527 .cindex "EXPN" "with &%verify_only%&"
16529 .cindex "router" "used only when verifying"
16530 If this option is set, the router is used only when verifying an address or
16531 testing with the &%-bv%& option, not when actually doing a delivery, testing
16532 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
16533 restricted to verifying only senders or recipients by means of
16534 &%verify_sender%& and &%verify_recipient%&.
16536 &*Warning*&: When the router is being run to verify addresses for an incoming
16537 SMTP message, Exim is not running as root, but under its own uid. If the router
16538 accesses any files, you need to make sure that they are accessible to the Exim
16542 .option verify_recipient routers&!? boolean true
16543 If this option is false, the router is skipped when verifying recipient
16545 or testing recipient verification using &%-bv%&.
16546 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16550 .option verify_sender routers&!? boolean true
16551 If this option is false, the router is skipped when verifying sender addresses
16552 or testing sender verification using &%-bvs%&.
16553 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16555 .ecindex IIDgenoprou1
16556 .ecindex IIDgenoprou2
16563 . ////////////////////////////////////////////////////////////////////////////
16564 . ////////////////////////////////////////////////////////////////////////////
16566 .chapter "The accept router" "CHID4"
16567 .cindex "&(accept)& router"
16568 .cindex "routers" "&(accept)&"
16569 The &(accept)& router has no private options of its own. Unless it is being
16570 used purely for verification (see &%verify_only%&) a transport is required to
16571 be defined by the generic &%transport%& option. If the preconditions that are
16572 specified by generic options are met, the router accepts the address and queues
16573 it for the given transport. The most common use of this router is for setting
16574 up deliveries to local mailboxes. For example:
16578 domains = mydomain.example
16580 transport = local_delivery
16582 The &%domains%& condition in this example checks the domain of the address, and
16583 &%check_local_user%& checks that the local part is the login of a local user.
16584 When both preconditions are met, the &(accept)& router runs, and queues the
16585 address for the &(local_delivery)& transport.
16592 . ////////////////////////////////////////////////////////////////////////////
16593 . ////////////////////////////////////////////////////////////////////////////
16595 .chapter "The dnslookup router" "CHAPdnslookup"
16596 .scindex IIDdnsrou1 "&(dnslookup)& router"
16597 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
16598 The &(dnslookup)& router looks up the hosts that handle mail for the
16599 recipient's domain in the DNS. A transport must always be set for this router,
16600 unless &%verify_only%& is set.
16602 If SRV support is configured (see &%check_srv%& below), Exim first searches for
16603 SRV records. If none are found, or if SRV support is not configured,
16604 MX records are looked up. If no MX records exist, address records are sought.
16605 However, &%mx_domains%& can be set to disable the direct use of address
16608 MX records of equal priority are sorted by Exim into a random order. Exim then
16609 looks for address records for the host names obtained from MX or SRV records.
16610 When a host has more than one IP address, they are sorted into a random order,
16611 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
16612 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
16613 generic option, the router declines.
16615 Unless they have the highest priority (lowest MX value), MX records that point
16616 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
16617 are discarded, together with any other MX records of equal or lower priority.
16619 .cindex "MX record" "pointing to local host"
16620 .cindex "local host" "MX pointing to"
16621 .oindex "&%self%&" "in &(dnslookup)& router"
16622 If the host pointed to by the highest priority MX record, or looked up as an
16623 address record, is the local host, or matches &%hosts_treat_as_local%&, what
16624 happens is controlled by the generic &%self%& option.
16627 .section "Problems with DNS lookups" "SECTprowitdnsloo"
16628 There have been problems with DNS servers when SRV records are looked up.
16629 Some mis-behaving servers return a DNS error or timeout when a non-existent
16630 SRV record is sought. Similar problems have in the past been reported for
16631 MX records. The global &%dns_again_means_nonexist%& option can help with this
16632 problem, but it is heavy-handed because it is a global option.
16634 For this reason, there are two options, &%srv_fail_domains%& and
16635 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
16636 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
16637 an attempt to look up an SRV or MX record causes one of these results, and the
16638 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
16639 such record"&. In the case of an SRV lookup, this means that the router
16640 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
16641 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
16642 case routing fails.
16647 .section "Private options for dnslookup" "SECID118"
16648 .cindex "options" "&(dnslookup)& router"
16649 The private options for the &(dnslookup)& router are as follows:
16651 .option check_secondary_mx dnslookup boolean false
16652 .cindex "MX record" "checking for secondary"
16653 If this option is set, the router declines unless the local host is found in
16654 (and removed from) the list of hosts obtained by MX lookup. This can be used to
16655 process domains for which the local host is a secondary mail exchanger
16656 differently to other domains. The way in which Exim decides whether a host is
16657 the local host is described in section &<<SECTreclocipadd>>&.
16660 .option check_srv dnslookup string&!! unset
16661 .cindex "SRV record" "enabling use of"
16662 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
16663 addition to MX and address records. The support is disabled by default. To
16664 enable SRV support, set the &%check_srv%& option to the name of the service
16665 required. For example,
16669 looks for SRV records that refer to the normal smtp service. The option is
16670 expanded, so the service name can vary from message to message or address
16671 to address. This might be helpful if SRV records are being used for a
16672 submission service. If the expansion is forced to fail, the &%check_srv%&
16673 option is ignored, and the router proceeds to look for MX records in the
16676 When the expansion succeeds, the router searches first for SRV records for
16677 the given service (it assumes TCP protocol). A single SRV record with a
16678 host name that consists of just a single dot indicates &"no such service for
16679 this domain"&; if this is encountered, the router declines. If other kinds of
16680 SRV record are found, they are used to construct a host list for delivery
16681 according to the rules of RFC 2782. MX records are not sought in this case.
16683 When no SRV records are found, MX records (and address records) are sought in
16684 the traditional way. In other words, SRV records take precedence over MX
16685 records, just as MX records take precedence over address records. Note that
16686 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
16687 defined it. It is apparently believed that MX records are sufficient for email
16688 and that SRV records should not be used for this purpose. However, SRV records
16689 have an additional &"weight"& feature which some people might find useful when
16690 trying to split an SMTP load between hosts of different power.
16692 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
16693 when there is a DNS lookup error.
16697 .option mx_domains dnslookup "domain list&!!" unset
16698 .cindex "MX record" "required to exist"
16699 .cindex "SRV record" "required to exist"
16700 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
16701 record in order to be recognized. (The name of this option could be improved.)
16702 For example, if all the mail hosts in &'fict.example'& are known to have MX
16703 records, except for those in &'discworld.fict.example'&, you could use this
16706 mx_domains = ! *.discworld.fict.example : *.fict.example
16708 This specifies that messages addressed to a domain that matches the list but
16709 has no MX record should be bounced immediately instead of being routed using
16710 the address record.
16713 .option mx_fail_domains dnslookup "domain list&!!" unset
16714 If the DNS lookup for MX records for one of the domains in this list causes a
16715 DNS lookup error, Exim behaves as if no MX records were found. See section
16716 &<<SECTprowitdnsloo>>& for more discussion.
16721 .option qualify_single dnslookup boolean true
16722 .cindex "DNS" "resolver options"
16723 .cindex "DNS" "qualifying single-component names"
16724 When this option is true, the resolver option RES_DEFNAMES is set for DNS
16725 lookups. Typically, but not standardly, this causes the resolver to qualify
16726 single-component names with the default domain. For example, on a machine
16727 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
16728 &'thesaurus.ref.example'& inside the resolver. For details of what your
16729 resolver actually does, consult your man pages for &'resolver'& and
16734 .option rewrite_headers dnslookup boolean true
16735 .cindex "rewriting" "header lines"
16736 .cindex "header lines" "rewriting"
16737 If the domain name in the address that is being processed is not fully
16738 qualified, it may be expanded to its full form by a DNS lookup. For example, if
16739 an address is specified as &'dormouse@teaparty'&, the domain might be
16740 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
16741 occur as a result of setting the &%widen_domains%& option. If
16742 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
16743 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
16744 header lines of the message are rewritten with the full domain name.
16746 This option should be turned off only when it is known that no message is
16747 ever going to be sent outside an environment where the abbreviation makes
16750 When an MX record is looked up in the DNS and matches a wildcard record, name
16751 servers normally return a record containing the name that has been looked up,
16752 making it impossible to detect whether a wildcard was present or not. However,
16753 some name servers have recently been seen to return the wildcard entry. If the
16754 name returned by a DNS lookup begins with an asterisk, it is not used for
16758 .option same_domain_copy_routing dnslookup boolean false
16759 .cindex "address" "copying routing"
16760 Addresses with the same domain are normally routed by the &(dnslookup)& router
16761 to the same list of hosts. However, this cannot be presumed, because the router
16762 options and preconditions may refer to the local part of the address. By
16763 default, therefore, Exim routes each address in a message independently. DNS
16764 servers run caches, so repeated DNS lookups are not normally expensive, and in
16765 any case, personal messages rarely have more than a few recipients.
16767 If you are running mailing lists with large numbers of subscribers at the same
16768 domain, and you are using a &(dnslookup)& router which is independent of the
16769 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
16770 lookups for identical domains in one message. In this case, when &(dnslookup)&
16771 routes an address to a remote transport, any other unrouted addresses in the
16772 message that have the same domain are automatically given the same routing
16773 without processing them independently,
16774 provided the following conditions are met:
16777 No router that processed the address specified &%headers_add%& or
16778 &%headers_remove%&.
16780 The router did not change the address in any way, for example, by &"widening"&
16787 .option search_parents dnslookup boolean false
16788 .cindex "DNS" "resolver options"
16789 When this option is true, the resolver option RES_DNSRCH is set for DNS
16790 lookups. This is different from the &%qualify_single%& option in that it
16791 applies to domains containing dots. Typically, but not standardly, it causes
16792 the resolver to search for the name in the current domain and in parent
16793 domains. For example, on a machine in the &'fict.example'& domain, if looking
16794 up &'teaparty.wonderland'& failed, the resolver would try
16795 &'teaparty.wonderland.fict.example'&. For details of what your resolver
16796 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
16798 Setting this option true can cause problems in domains that have a wildcard MX
16799 record, because any domain that does not have its own MX record matches the
16804 .option srv_fail_domains dnslookup "domain list&!!" unset
16805 If the DNS lookup for SRV records for one of the domains in this list causes a
16806 DNS lookup error, Exim behaves as if no SRV records were found. See section
16807 &<<SECTprowitdnsloo>>& for more discussion.
16812 .option widen_domains dnslookup "string list" unset
16813 .cindex "domain" "partial; widening"
16814 If a DNS lookup fails and this option is set, each of its strings in turn is
16815 added onto the end of the domain, and the lookup is tried again. For example,
16818 widen_domains = fict.example:ref.example
16820 is set and a lookup of &'klingon.dictionary'& fails,
16821 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
16822 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
16823 and &%search_parents%& options can cause some widening to be undertaken inside
16824 the DNS resolver. &%widen_domains%& is not applied to sender addresses
16825 when verifying, unless &%rewrite_headers%& is false (not the default).
16828 .section "Effect of qualify_single and search_parents" "SECID119"
16829 When a domain from an envelope recipient is changed by the resolver as a result
16830 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
16831 corresponding address in the message's header lines unless &%rewrite_headers%&
16832 is set false. Exim then re-routes the address, using the full domain.
16834 These two options affect only the DNS lookup that takes place inside the router
16835 for the domain of the address that is being routed. They do not affect lookups
16836 such as that implied by
16840 that may happen while processing a router precondition before the router is
16841 entered. No widening ever takes place for these lookups.
16842 .ecindex IIDdnsrou1
16843 .ecindex IIDdnsrou2
16853 . ////////////////////////////////////////////////////////////////////////////
16854 . ////////////////////////////////////////////////////////////////////////////
16856 .chapter "The ipliteral router" "CHID5"
16857 .cindex "&(ipliteral)& router"
16858 .cindex "domain literal" "routing"
16859 .cindex "routers" "&(ipliteral)&"
16860 This router has no private options. Unless it is being used purely for
16861 verification (see &%verify_only%&) a transport is required to be defined by the
16862 generic &%transport%& option. The router accepts the address if its domain part
16863 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
16864 router handles the address
16868 by setting up delivery to the host with that IP address. IPv4 domain literals
16869 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
16870 are similar, but the address is preceded by &`ipv6:`&. For example:
16872 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
16874 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
16875 grounds that sooner or later somebody will try it.
16877 .oindex "&%self%&" "in &(ipliteral)& router"
16878 If the IP address matches something in &%ignore_target_hosts%&, the router
16879 declines. If an IP literal turns out to refer to the local host, the generic
16880 &%self%& option determines what happens.
16882 The RFCs require support for domain literals; however, their use is
16883 controversial in today's Internet. If you want to use this router, you must
16884 also set the main configuration option &%allow_domain_literals%&. Otherwise,
16885 Exim will not recognize the domain literal syntax in addresses.
16889 . ////////////////////////////////////////////////////////////////////////////
16890 . ////////////////////////////////////////////////////////////////////////////
16892 .chapter "The iplookup router" "CHID6"
16893 .cindex "&(iplookup)& router"
16894 .cindex "routers" "&(iplookup)&"
16895 The &(iplookup)& router was written to fulfil a specific requirement in
16896 Cambridge University (which in fact no longer exists). For this reason, it is
16897 not included in the binary of Exim by default. If you want to include it, you
16900 ROUTER_IPLOOKUP=yes
16902 in your &_Local/Makefile_& configuration file.
16904 The &(iplookup)& router routes an address by sending it over a TCP or UDP
16905 connection to one or more specific hosts. The host can then return the same or
16906 a different address &-- in effect rewriting the recipient address in the
16907 message's envelope. The new address is then passed on to subsequent routers. If
16908 this process fails, the address can be passed on to other routers, or delivery
16909 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
16910 must not be specified for it.
16912 .cindex "options" "&(iplookup)& router"
16913 .option hosts iplookup string unset
16914 This option must be supplied. Its value is a colon-separated list of host
16915 names. The hosts are looked up using &[gethostbyname()]&
16916 (or &[getipnodebyname()]& when available)
16917 and are tried in order until one responds to the query. If none respond, what
16918 happens is controlled by &%optional%&.
16921 .option optional iplookup boolean false
16922 If &%optional%& is true, if no response is obtained from any host, the address
16923 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
16924 delivery to the address is deferred.
16927 .option port iplookup integer 0
16928 .cindex "port" "&(iplookup)& router"
16929 This option must be supplied. It specifies the port number for the TCP or UDP
16933 .option protocol iplookup string udp
16934 This option can be set to &"udp"& or &"tcp"& to specify which of the two
16935 protocols is to be used.
16938 .option query iplookup string&!! "see below"
16939 This defines the content of the query that is sent to the remote hosts. The
16942 $local_part@$domain $local_part@$domain
16944 The repetition serves as a way of checking that a response is to the correct
16945 query in the default case (see &%response_pattern%& below).
16948 .option reroute iplookup string&!! unset
16949 If this option is not set, the rerouted address is precisely the byte string
16950 returned by the remote host, up to the first white space, if any. If set, the
16951 string is expanded to form the rerouted address. It can include parts matched
16952 in the response by &%response_pattern%& by means of numeric variables such as
16953 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
16954 whether or not a pattern is in use. In all cases, the rerouted address must end
16955 up in the form &'local_part@domain'&.
16958 .option response_pattern iplookup string unset
16959 This option can be set to a regular expression that is applied to the string
16960 returned from the remote host. If the pattern does not match the response, the
16961 router declines. If &%response_pattern%& is not set, no checking of the
16962 response is done, unless the query was defaulted, in which case there is a
16963 check that the text returned after the first white space is the original
16964 address. This checks that the answer that has been received is in response to
16965 the correct question. For example, if the response is just a new domain, the
16966 following could be used:
16968 response_pattern = ^([^@]+)$
16969 reroute = $local_part@$1
16972 .option timeout iplookup time 5s
16973 This specifies the amount of time to wait for a response from the remote
16974 machine. The same timeout is used for the &[connect()]& function for a TCP
16975 call. It does not apply to UDP.
16980 . ////////////////////////////////////////////////////////////////////////////
16981 . ////////////////////////////////////////////////////////////////////////////
16983 .chapter "The manualroute router" "CHID7"
16984 .scindex IIDmanrou1 "&(manualroute)& router"
16985 .scindex IIDmanrou2 "routers" "&(manualroute)&"
16986 .cindex "domain" "manually routing"
16987 The &(manualroute)& router is so-called because it provides a way of manually
16988 routing an address according to its domain. It is mainly used when you want to
16989 route addresses to remote hosts according to your own rules, bypassing the
16990 normal DNS routing that looks up MX records. However, &(manualroute)& can also
16991 route to local transports, a facility that may be useful if you want to save
16992 messages for dial-in hosts in local files.
16994 The &(manualroute)& router compares a list of domain patterns with the domain
16995 it is trying to route. If there is no match, the router declines. Each pattern
16996 has associated with it a list of hosts and some other optional data, which may
16997 include a transport. The combination of a pattern and its data is called a
16998 &"routing rule"&. For patterns that do not have an associated transport, the
16999 generic &%transport%& option must specify a transport, unless the router is
17000 being used purely for verification (see &%verify_only%&).
17003 In the case of verification, matching the domain pattern is sufficient for the
17004 router to accept the address. When actually routing an address for delivery,
17005 an address that matches a domain pattern is queued for the associated
17006 transport. If the transport is not a local one, a host list must be associated
17007 with the pattern; IP addresses are looked up for the hosts, and these are
17008 passed to the transport along with the mail address. For local transports, a
17009 host list is optional. If it is present, it is passed in &$host$& as a single
17012 The list of routing rules can be provided as an inline string in
17013 &%route_list%&, or the data can be obtained by looking up the domain in a file
17014 or database by setting &%route_data%&. Only one of these settings may appear in
17015 any one instance of &(manualroute)&. The format of routing rules is described
17016 below, following the list of private options.
17019 .section "Private options for manualroute" "SECTprioptman"
17021 .cindex "options" "&(manualroute)& router"
17022 The private options for the &(manualroute)& router are as follows:
17024 .option host_all_ignored manualroute string defer
17025 See &%host_find_failed%&.
17027 .option host_find_failed manualroute string freeze
17028 This option controls what happens when &(manualroute)& tries to find an IP
17029 address for a host, and the host does not exist. The option can be set to one
17030 of the following values:
17039 The default (&"freeze"&) assumes that this state is a serious configuration
17040 error. The difference between &"pass"& and &"decline"& is that the former
17041 forces the address to be passed to the next router (or the router defined by
17044 overriding &%no_more%&, whereas the latter passes the address to the next
17045 router only if &%more%& is true.
17047 The value &"ignore"& causes Exim to completely ignore a host whose IP address
17048 cannot be found. If all the hosts in the list are ignored, the behaviour is
17049 controlled by the &%host_all_ignored%& option. This takes the same values
17050 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
17052 The &%host_find_failed%& option applies only to a definite &"does not exist"&
17053 state; if a host lookup gets a temporary error, delivery is deferred unless the
17054 generic &%pass_on_timeout%& option is set.
17057 .option hosts_randomize manualroute boolean false
17058 .cindex "randomized host list"
17059 .cindex "host" "list of; randomized"
17060 If this option is set, the order of the items in a host list in a routing rule
17061 is randomized each time the list is used, unless an option in the routing rule
17062 overrides (see below). Randomizing the order of a host list can be used to do
17063 crude load sharing. However, if more than one mail address is routed by the
17064 same router to the same host list, the host lists are considered to be the same
17065 (even though they may be randomized into different orders) for the purpose of
17066 deciding whether to batch the deliveries into a single SMTP transaction.
17068 When &%hosts_randomize%& is true, a host list may be split
17069 into groups whose order is separately randomized. This makes it possible to
17070 set up MX-like behaviour. The boundaries between groups are indicated by an
17071 item that is just &`+`& in the host list. For example:
17073 route_list = * host1:host2:host3:+:host4:host5
17075 The order of the first three hosts and the order of the last two hosts is
17076 randomized for each use, but the first three always end up before the last two.
17077 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
17078 randomized host list is passed to an &(smtp)& transport that also has
17079 &%hosts_randomize set%&, the list is not re-randomized.
17082 .option route_data manualroute string&!! unset
17083 If this option is set, it must expand to yield the data part of a routing rule.
17084 Typically, the expansion string includes a lookup based on the domain. For
17087 route_data = ${lookup{$domain}dbm{/etc/routes}}
17089 If the expansion is forced to fail, or the result is an empty string, the
17090 router declines. Other kinds of expansion failure cause delivery to be
17094 .option route_list manualroute "string list" unset
17095 This string is a list of routing rules, in the form defined below. Note that,
17096 unlike most string lists, the items are separated by semicolons. This is so
17097 that they may contain colon-separated host lists.
17100 .option same_domain_copy_routing manualroute boolean false
17101 .cindex "address" "copying routing"
17102 Addresses with the same domain are normally routed by the &(manualroute)&
17103 router to the same list of hosts. However, this cannot be presumed, because the
17104 router options and preconditions may refer to the local part of the address. By
17105 default, therefore, Exim routes each address in a message independently. DNS
17106 servers run caches, so repeated DNS lookups are not normally expensive, and in
17107 any case, personal messages rarely have more than a few recipients.
17109 If you are running mailing lists with large numbers of subscribers at the same
17110 domain, and you are using a &(manualroute)& router which is independent of the
17111 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
17112 lookups for identical domains in one message. In this case, when
17113 &(manualroute)& routes an address to a remote transport, any other unrouted
17114 addresses in the message that have the same domain are automatically given the
17115 same routing without processing them independently. However, this is only done
17116 if &%headers_add%& and &%headers_remove%& are unset.
17121 .section "Routing rules in route_list" "SECID120"
17122 The value of &%route_list%& is a string consisting of a sequence of routing
17123 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
17124 entered as two semicolons. Alternatively, the list separator can be changed as
17125 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
17126 Empty rules are ignored. The format of each rule is
17128 <&'domain pattern'&> <&'list of hosts'&> <&'options'&>
17130 The following example contains two rules, each with a simple domain pattern and
17134 dict.ref.example mail-1.ref.example:mail-2.ref.example ; \
17135 thes.ref.example mail-3.ref.example:mail-4.ref.example
17137 The three parts of a rule are separated by white space. The pattern and the
17138 list of hosts can be enclosed in quotes if necessary, and if they are, the
17139 usual quoting rules apply. Each rule in a &%route_list%& must start with a
17140 single domain pattern, which is the only mandatory item in the rule. The
17141 pattern is in the same format as one item in a domain list (see section
17142 &<<SECTdomainlist>>&),
17143 except that it may not be the name of an interpolated file.
17144 That is, it may be wildcarded, or a regular expression, or a file or database
17145 lookup (with semicolons doubled, because of the use of semicolon as a separator
17146 in a &%route_list%&).
17148 The rules in &%route_list%& are searched in order until one of the patterns
17149 matches the domain that is being routed. The list of hosts and then options are
17150 then used as described below. If there is no match, the router declines. When
17151 &%route_list%& is set, &%route_data%& must not be set.
17155 .section "Routing rules in route_data" "SECID121"
17156 The use of &%route_list%& is convenient when there are only a small number of
17157 routing rules. For larger numbers, it is easier to use a file or database to
17158 hold the routing information, and use the &%route_data%& option instead.
17159 The value of &%route_data%& is a list of hosts, followed by (optional) options.
17160 Most commonly, &%route_data%& is set as a string that contains an
17161 expansion lookup. For example, suppose we place two routing rules in a file
17164 dict.ref.example: mail-1.ref.example:mail-2.ref.example
17165 thes.ref.example: mail-3.ref.example:mail-4.ref.example
17167 This data can be accessed by setting
17169 route_data = ${lookup{$domain}lsearch{/the/file/name}}
17171 Failure of the lookup results in an empty string, causing the router to
17172 decline. However, you do not have to use a lookup in &%route_data%&. The only
17173 requirement is that the result of expanding the string is a list of hosts,
17174 possibly followed by options, separated by white space. The list of hosts must
17175 be enclosed in quotes if it contains white space.
17180 .section "Format of the list of hosts" "SECID122"
17181 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
17182 always separately expanded before use. If the expansion fails, the router
17183 declines. The result of the expansion must be a colon-separated list of names
17184 and/or IP addresses, optionally also including ports. The format of each item
17185 in the list is described in the next section. The list separator can be changed
17186 as described in section &<<SECTlistconstruct>>&.
17188 If the list of hosts was obtained from a &%route_list%& item, the following
17189 variables are set during its expansion:
17192 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(manualroute)& router"
17193 If the domain was matched against a regular expression, the numeric variables
17194 &$1$&, &$2$&, etc. may be set. For example:
17196 route_list = ^domain(\d+) host-$1.text.example
17199 &$0$& is always set to the entire domain.
17201 &$1$& is also set when partial matching is done in a file lookup.
17204 .vindex "&$value$&"
17205 If the pattern that matched the domain was a lookup item, the data that was
17206 looked up is available in the expansion variable &$value$&. For example:
17208 route_list = lsearch;;/some/file.routes $value
17212 Note the doubling of the semicolon in the pattern that is necessary because
17213 semicolon is the default route list separator.
17217 .section "Format of one host item" "SECTformatonehostitem"
17218 Each item in the list of hosts is either a host name or an IP address,
17219 optionally with an attached port number. When no port is given, an IP address
17220 is not enclosed in brackets. When a port is specified, it overrides the port
17221 specification on the transport. The port is separated from the name or address
17222 by a colon. This leads to some complications:
17225 Because colon is the default separator for the list of hosts, either
17226 the colon that specifies a port must be doubled, or the list separator must
17227 be changed. The following two examples have the same effect:
17229 route_list = * "host1.tld::1225 : host2.tld::1226"
17230 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
17233 When IPv6 addresses are involved, it gets worse, because they contain
17234 colons of their own. To make this case easier, it is permitted to
17235 enclose an IP address (either v4 or v6) in square brackets if a port
17236 number follows. For example:
17238 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
17242 .section "How the list of hosts is used" "SECThostshowused"
17243 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
17244 the hosts is tried, in the order specified, when carrying out the SMTP
17245 delivery. However, the order can be changed by setting the &%hosts_randomize%&
17246 option, either on the router (see section &<<SECTprioptman>>& above), or on the
17249 Hosts may be listed by name or by IP address. An unadorned name in the list of
17250 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
17251 interpreted as an indirection to a sublist of hosts obtained by looking up MX
17252 records in the DNS. For example:
17254 route_list = * x.y.z:p.q.r/MX:e.f.g
17256 If this feature is used with a port specifier, the port must come last. For
17259 route_list = * dom1.tld/mx::1225
17261 If the &%hosts_randomize%& option is set, the order of the items in the list is
17262 randomized before any lookups are done. Exim then scans the list; for any name
17263 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
17264 be an interface on the local host and the item is not the first in the list,
17265 Exim discards it and any subsequent items. If it is the first item, what
17266 happens is controlled by the
17267 .oindex "&%self%&" "in &(manualroute)& router"
17268 &%self%& option of the router.
17270 A name on the list that is followed by &`/MX`& is replaced with the list of
17271 hosts obtained by looking up MX records for the name. This is always a DNS
17272 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
17273 below) are not relevant here. The order of these hosts is determined by the
17274 preference values in the MX records, according to the usual rules. Because
17275 randomizing happens before the MX lookup, it does not affect the order that is
17276 defined by MX preferences.
17278 If the local host is present in the sublist obtained from MX records, but is
17279 not the most preferred host in that list, it and any equally or less
17280 preferred hosts are removed before the sublist is inserted into the main list.
17282 If the local host is the most preferred host in the MX list, what happens
17283 depends on where in the original list of hosts the &`/MX`& item appears. If it
17284 is not the first item (that is, there are previous hosts in the main list),
17285 Exim discards this name and any subsequent items in the main list.
17287 If the MX item is first in the list of hosts, and the local host is the
17288 most preferred host, what happens is controlled by the &%self%& option of the
17291 DNS failures when lookup up the MX records are treated in the same way as DNS
17292 failures when looking up IP addresses: &%pass_on_timeout%& and
17293 &%host_find_failed%& are used when relevant.
17295 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
17296 whether obtained from an MX lookup or not.
17300 .section "How the options are used" "SECThowoptused"
17301 The options are a sequence of words; in practice no more than three are ever
17302 present. One of the words can be the name of a transport; this overrides the
17303 &%transport%& option on the router for this particular routing rule only. The
17304 other words (if present) control randomization of the list of hosts on a
17305 per-rule basis, and how the IP addresses of the hosts are to be found when
17306 routing to a remote transport. These options are as follows:
17309 &%randomize%&: randomize the order of the hosts in this list, overriding the
17310 setting of &%hosts_randomize%& for this routing rule only.
17312 &%no_randomize%&: do not randomize the order of the hosts in this list,
17313 overriding the setting of &%hosts_randomize%& for this routing rule only.
17315 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
17316 find IP addresses. This function may ultimately cause a DNS lookup, but it may
17317 also look in &_/etc/hosts_& or other sources of information.
17319 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
17320 no address records are found. If there is a temporary DNS error (such as a
17321 timeout), delivery is deferred.
17326 route_list = domain1 host1:host2:host3 randomize bydns;\
17327 domain2 host4:host5
17329 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
17330 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
17331 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
17332 or &[gethostbyname()]&, and the result of the lookup is the result of that
17335 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
17336 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
17337 instead of TRY_AGAIN. That is why the default action is to try a DNS
17338 lookup first. Only if that gives a definite &"no such host"& is the local
17343 If no IP address for a host can be found, what happens is controlled by the
17344 &%host_find_failed%& option.
17347 When an address is routed to a local transport, IP addresses are not looked up.
17348 The host list is passed to the transport in the &$host$& variable.
17352 .section "Manualroute examples" "SECID123"
17353 In some of the examples that follow, the presence of the &%remote_smtp%&
17354 transport, as defined in the default configuration file, is assumed:
17357 .cindex "smart host" "example router"
17358 The &(manualroute)& router can be used to forward all external mail to a
17359 &'smart host'&. If you have set up, in the main part of the configuration, a
17360 named domain list that contains your local domains, for example:
17362 domainlist local_domains = my.domain.example
17364 You can arrange for all other domains to be routed to a smart host by making
17365 your first router something like this:
17368 driver = manualroute
17369 domains = !+local_domains
17370 transport = remote_smtp
17371 route_list = * smarthost.ref.example
17373 This causes all non-local addresses to be sent to the single host
17374 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
17375 they are tried in order
17376 (but you can use &%hosts_randomize%& to vary the order each time).
17377 Another way of configuring the same thing is this:
17380 driver = manualroute
17381 transport = remote_smtp
17382 route_list = !+local_domains smarthost.ref.example
17384 There is no difference in behaviour between these two routers as they stand.
17385 However, they behave differently if &%no_more%& is added to them. In the first
17386 example, the router is skipped if the domain does not match the &%domains%&
17387 precondition; the following router is always tried. If the router runs, it
17388 always matches the domain and so can never decline. Therefore, &%no_more%&
17389 would have no effect. In the second case, the router is never skipped; it
17390 always runs. However, if it doesn't match the domain, it declines. In this case
17391 &%no_more%& would prevent subsequent routers from running.
17394 .cindex "mail hub example"
17395 A &'mail hub'& is a host which receives mail for a number of domains via MX
17396 records in the DNS and delivers it via its own private routing mechanism. Often
17397 the final destinations are behind a firewall, with the mail hub being the one
17398 machine that can connect to machines both inside and outside the firewall. The
17399 &(manualroute)& router is usually used on a mail hub to route incoming messages
17400 to the correct hosts. For a small number of domains, the routing can be inline,
17401 using the &%route_list%& option, but for a larger number a file or database
17402 lookup is easier to manage.
17404 If the domain names are in fact the names of the machines to which the mail is
17405 to be sent by the mail hub, the configuration can be quite simple. For
17409 driver = manualroute
17410 transport = remote_smtp
17411 route_list = *.rhodes.tvs.example $domain
17413 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
17414 whose names are the same as the mail domains. A similar approach can be taken
17415 if the host name can be obtained from the domain name by a string manipulation
17416 that the expansion facilities can handle. Otherwise, a lookup based on the
17417 domain can be used to find the host:
17420 driver = manualroute
17421 transport = remote_smtp
17422 route_data = ${lookup {$domain} cdb {/internal/host/routes}}
17424 The result of the lookup must be the name or IP address of the host (or
17425 hosts) to which the address is to be routed. If the lookup fails, the route
17426 data is empty, causing the router to decline. The address then passes to the
17430 .cindex "batched SMTP output example"
17431 .cindex "SMTP" "batched outgoing; example"
17432 You can use &(manualroute)& to deliver messages to pipes or files in batched
17433 SMTP format for onward transportation by some other means. This is one way of
17434 storing mail for a dial-up host when it is not connected. The route list entry
17435 can be as simple as a single domain name in a configuration like this:
17438 driver = manualroute
17439 transport = batchsmtp_appendfile
17440 route_list = saved.domain.example
17442 though often a pattern is used to pick up more than one domain. If there are
17443 several domains or groups of domains with different transport requirements,
17444 different transports can be listed in the routing information:
17447 driver = manualroute
17449 *.saved.domain1.example $domain batch_appendfile; \
17450 *.saved.domain2.example \
17451 ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
17454 .vindex "&$domain$&"
17456 The first of these just passes the domain in the &$host$& variable, which
17457 doesn't achieve much (since it is also in &$domain$&), but the second does a
17458 file lookup to find a value to pass, causing the router to decline to handle
17459 the address if the lookup fails.
17462 .cindex "UUCP" "example of router for"
17463 Routing mail directly to UUCP software is a specific case of the use of
17464 &(manualroute)& in a gateway to another mail environment. This is an example of
17465 one way it can be done:
17471 command = /usr/local/bin/uux -r - \
17472 ${substr_-5:$host}!rmail ${local_part}
17473 return_fail_output = true
17478 driver = manualroute
17480 ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
17482 The file &_/usr/local/exim/uucphosts_& contains entries like
17484 darksite.ethereal.example: darksite.UUCP
17486 It can be set up more simply without adding and removing &".UUCP"& but this way
17487 makes clear the distinction between the domain name
17488 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
17490 .ecindex IIDmanrou1
17491 .ecindex IIDmanrou2
17500 . ////////////////////////////////////////////////////////////////////////////
17501 . ////////////////////////////////////////////////////////////////////////////
17503 .chapter "The queryprogram router" "CHAPdriverlast"
17504 .scindex IIDquerou1 "&(queryprogram)& router"
17505 .scindex IIDquerou2 "routers" "&(queryprogram)&"
17506 .cindex "routing" "by external program"
17507 The &(queryprogram)& router routes an address by running an external command
17508 and acting on its output. This is an expensive way to route, and is intended
17509 mainly for use in lightly-loaded systems, or for performing experiments.
17510 However, if it is possible to use the precondition options (&%domains%&,
17511 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
17512 be used in special cases, even on a busy host. There are the following private
17514 .cindex "options" "&(queryprogram)& router"
17516 .option command queryprogram string&!! unset
17517 This option must be set. It specifies the command that is to be run. The
17518 command is split up into a command name and arguments, and then each is
17519 expanded separately (exactly as for a &(pipe)& transport, described in chapter
17520 &<<CHAPpipetransport>>&).
17523 .option command_group queryprogram string unset
17524 .cindex "gid (group id)" "in &(queryprogram)& router"
17525 This option specifies a gid to be set when running the command while routing an
17526 address for deliver. It must be set if &%command_user%& specifies a numerical
17527 uid. If it begins with a digit, it is interpreted as the numerical value of the
17528 gid. Otherwise it is looked up using &[getgrnam()]&.
17531 .option command_user queryprogram string unset
17532 .cindex "uid (user id)" "for &(queryprogram)&"
17533 This option must be set. It specifies the uid which is set when running the
17534 command while routing an address for delivery. If the value begins with a digit,
17535 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
17536 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
17537 not set, a value for the gid also.
17539 &*Warning:*& Changing uid and gid is possible only when Exim is running as
17540 root, which it does during a normal delivery in a conventional configuration.
17541 However, when an address is being verified during message reception, Exim is
17542 usually running as the Exim user, not as root. If the &(queryprogram)& router
17543 is called from a non-root process, Exim cannot change uid or gid before running
17544 the command. In this circumstance the command runs under the current uid and
17548 .option current_directory queryprogram string /
17549 This option specifies an absolute path which is made the current directory
17550 before running the command.
17553 .option timeout queryprogram time 1h
17554 If the command does not complete within the timeout period, its process group
17555 is killed and the message is frozen. A value of zero time specifies no
17559 The standard output of the command is connected to a pipe, which is read when
17560 the command terminates. It should consist of a single line of output,
17561 containing up to five fields, separated by white space. The maximum length of
17562 the line is 1023 characters. Longer lines are silently truncated. The first
17563 field is one of the following words (case-insensitive):
17566 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
17569 &'Decline'&: the router declines; pass the address to the next router, unless
17570 &%no_more%& is set.
17572 &'Fail'&: routing failed; do not pass the address to any more routers. Any
17573 subsequent text on the line is an error message. If the router is run as part
17574 of address verification during an incoming SMTP message, the message is
17575 included in the SMTP response.
17577 &'Defer'&: routing could not be completed at this time; try again later. Any
17578 subsequent text on the line is an error message which is logged. It is not
17579 included in any SMTP response.
17581 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
17583 &'Pass'&: pass the address to the next router (or the router specified by
17584 &%pass_router%&), overriding &%no_more%&.
17586 &'Redirect'&: the message is redirected. The remainder of the line is a list of
17587 new addresses, which are routed independently, starting with the first router,
17588 or the router specified by &%redirect_router%&, if set.
17591 When the first word is &'accept'&, the remainder of the line consists of a
17592 number of keyed data values, as follows (split into two lines here, to fit on
17595 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
17596 LOOKUP=byname|bydns DATA=<text>
17598 The data items can be given in any order, and all are optional. If no transport
17599 is included, the transport specified by the generic &%transport%& option is
17600 used. The list of hosts and the lookup type are needed only if the transport is
17601 an &(smtp)& transport that does not itself supply a list of hosts.
17603 The format of the list of hosts is the same as for the &(manualroute)& router.
17604 As well as host names and IP addresses with optional port numbers, as described
17605 in section &<<SECTformatonehostitem>>&, it may contain names followed by
17606 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
17607 (see section &<<SECThostshowused>>&).
17609 If the lookup type is not specified, Exim behaves as follows when trying to
17610 find an IP address for each host: First, a DNS lookup is done. If this yields
17611 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
17612 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
17613 result of the lookup is the result of that call.
17615 .vindex "&$address_data$&"
17616 If the DATA field is set, its value is placed in the &$address_data$&
17617 variable. For example, this return line
17619 accept hosts=x1.y.example:x2.y.example data="rule1"
17621 routes the address to the default transport, passing a list of two hosts. When
17622 the transport runs, the string &"rule1"& is in &$address_data$&.
17623 .ecindex IIDquerou1
17624 .ecindex IIDquerou2
17629 . ////////////////////////////////////////////////////////////////////////////
17630 . ////////////////////////////////////////////////////////////////////////////
17632 .chapter "The redirect router" "CHAPredirect"
17633 .scindex IIDredrou1 "&(redirect)& router"
17634 .scindex IIDredrou2 "routers" "&(redirect)&"
17635 .cindex "alias file" "in a &(redirect)& router"
17636 .cindex "address redirection" "&(redirect)& router"
17637 The &(redirect)& router handles several kinds of address redirection. Its most
17638 common uses are for resolving local part aliases from a central alias file
17639 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
17640 files, but it has many other potential uses. The incoming address can be
17641 redirected in several different ways:
17644 It can be replaced by one or more new addresses which are themselves routed
17647 It can be routed to be delivered to a given file or directory.
17649 It can be routed to be delivered to a specified pipe command.
17651 It can cause an automatic reply to be generated.
17653 It can be forced to fail, optionally with a custom error message.
17655 It can be temporarily deferred, optionally with a custom message.
17657 It can be discarded.
17660 The generic &%transport%& option must not be set for &(redirect)& routers.
17661 However, there are some private options which define transports for delivery to
17662 files and pipes, and for generating autoreplies. See the &%file_transport%&,
17663 &%pipe_transport%& and &%reply_transport%& descriptions below.
17667 .section "Redirection data" "SECID124"
17668 The router operates by interpreting a text string which it obtains either by
17669 expanding the contents of the &%data%& option, or by reading the entire
17670 contents of a file whose name is given in the &%file%& option. These two
17671 options are mutually exclusive. The first is commonly used for handling system
17672 aliases, in a configuration like this:
17676 data = ${lookup{$local_part}lsearch{/etc/aliases}}
17678 If the lookup fails, the expanded string in this example is empty. When the
17679 expansion of &%data%& results in an empty string, the router declines. A forced
17680 expansion failure also causes the router to decline; other expansion failures
17681 cause delivery to be deferred.
17683 A configuration using &%file%& is commonly used for handling users'
17684 &_.forward_& files, like this:
17689 file = $home/.forward
17692 If the file does not exist, or causes no action to be taken (for example, it is
17693 empty or consists only of comments), the router declines. &*Warning*&: This
17694 is not the case when the file contains syntactically valid items that happen to
17695 yield empty addresses, for example, items containing only RFC 2822 address
17700 .section "Forward files and address verification" "SECID125"
17701 .cindex "address redirection" "while verifying"
17702 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
17703 &_.forward_& files, as in the example above. There are two reasons for this:
17706 When Exim is receiving an incoming SMTP message from a remote host, it is
17707 running under the Exim uid, not as root. Exim is unable to change uid to read
17708 the file as the user, and it may not be able to read it as the Exim user. So in
17709 practice the router may not be able to operate.
17711 However, even when the router can operate, the existence of a &_.forward_& file
17712 is unimportant when verifying an address. What should be checked is whether the
17713 local part is a valid user name or not. Cutting out the redirection processing
17714 saves some resources.
17722 .section "Interpreting redirection data" "SECID126"
17723 .cindex "Sieve filter" "specifying in redirection data"
17724 .cindex "filter" "specifying in redirection data"
17725 The contents of the data string, whether obtained from &%data%& or &%file%&,
17726 can be interpreted in two different ways:
17729 If the &%allow_filter%& option is set true, and the data begins with the text
17730 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
17731 &'filtering'& instructions in the form of an Exim or Sieve filter file,
17732 respectively. Details of the syntax and semantics of filter files are described
17733 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
17734 document is intended for use by end users.
17736 Otherwise, the data must be a comma-separated list of redirection items, as
17737 described in the next section.
17740 When a message is redirected to a file (a &"mail folder"&), the file name given
17741 in a non-filter redirection list must always be an absolute path. A filter may
17742 generate a relative path &-- how this is handled depends on the transport's
17743 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
17744 for the &(appendfile)& transport.
17748 .section "Items in a non-filter redirection list" "SECTitenonfilred"
17749 .cindex "address redirection" "non-filter list items"
17750 When the redirection data is not an Exim or Sieve filter, for example, if it
17751 comes from a conventional alias or forward file, it consists of a list of
17752 addresses, file names, pipe commands, or certain special items (see section
17753 &<<SECTspecitredli>>& below). The special items can be individually enabled or
17754 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
17755 depending on their default values. The items in the list are separated by
17756 commas or newlines.
17757 If a comma is required in an item, the entire item must be enclosed in double
17760 Lines starting with a # character are comments, and are ignored, and # may
17761 also appear following a comma, in which case everything between the # and the
17762 next newline character is ignored.
17764 If an item is entirely enclosed in double quotes, these are removed. Otherwise
17765 double quotes are retained because some forms of mail address require their use
17766 (but never to enclose the entire address). In the following description,
17767 &"item"& refers to what remains after any surrounding double quotes have been
17770 .vindex "&$local_part$&"
17771 &*Warning*&: If you use an Exim expansion to construct a redirection address,
17772 and the expansion contains a reference to &$local_part$&, you should make use
17773 of the &%quote_local_part%& expansion operator, in case the local part contains
17774 special characters. For example, to redirect all mail for the domain
17775 &'obsolete.example'&, retaining the existing local part, you could use this
17778 data = ${quote_local_part:$local_part}@newdomain.example
17782 .section "Redirecting to a local mailbox" "SECTredlocmai"
17783 .cindex "routing" "loops in"
17784 .cindex "loop" "while routing, avoidance of"
17785 .cindex "address redirection" "to local mailbox"
17786 A redirection item may safely be the same as the address currently under
17787 consideration. This does not cause a routing loop, because a router is
17788 automatically skipped if any ancestor of the address that is being processed
17789 is the same as the current address and was processed by the current router.
17790 Such an address is therefore passed to the following routers, so it is handled
17791 as if there were no redirection. When making this loop-avoidance test, the
17792 complete local part, including any prefix or suffix, is used.
17794 .cindex "address redirection" "local part without domain"
17795 Specifying the same local part without a domain is a common usage in personal
17796 filter files when the user wants to have messages delivered to the local
17797 mailbox and also forwarded elsewhere. For example, the user whose login is
17798 &'cleo'& might have a &_.forward_& file containing this:
17800 cleo, cleopatra@egypt.example
17802 .cindex "backslash in alias file"
17803 .cindex "alias file" "backslash in"
17804 For compatibility with other MTAs, such unqualified local parts may be
17805 preceded by &"\"&, but this is not a requirement for loop prevention. However,
17806 it does make a difference if more than one domain is being handled
17809 If an item begins with &"\"& and the rest of the item parses as a valid RFC
17810 2822 address that does not include a domain, the item is qualified using the
17811 domain of the incoming address. In the absence of a leading &"\"&, unqualified
17812 addresses are qualified using the value in &%qualify_recipient%&, but you can
17813 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
17815 Care must be taken if there are alias names for local users.
17816 Consider an MTA handling a single local domain where the system alias file
17821 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
17822 messages in the local mailbox, and also forward copies elsewhere. He creates
17825 Sam.Reman, spqr@reme.elsewhere.example
17827 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
17828 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
17829 second time round, because it has previously routed it,
17830 and the following routers presumably cannot handle the alias. The forward file
17831 should really contain
17833 spqr, spqr@reme.elsewhere.example
17835 but because this is such a common error, the &%check_ancestor%& option (see
17836 below) exists to provide a way to get round it. This is normally set on a
17837 &(redirect)& router that is handling users' &_.forward_& files.
17841 .section "Special items in redirection lists" "SECTspecitredli"
17842 In addition to addresses, the following types of item may appear in redirection
17843 lists (that is, in non-filter redirection data):
17846 .cindex "pipe" "in redirection list"
17847 .cindex "address redirection" "to pipe"
17848 An item is treated as a pipe command if it begins with &"|"& and does not parse
17849 as a valid RFC 2822 address that includes a domain. A transport for running the
17850 command must be specified by the &%pipe_transport%& option.
17851 Normally, either the router or the transport specifies a user and a group under
17852 which to run the delivery. The default is to use the Exim user and group.
17854 Single or double quotes can be used for enclosing the individual arguments of
17855 the pipe command; no interpretation of escapes is done for single quotes. If
17856 the command contains a comma character, it is necessary to put the whole item
17857 in double quotes, for example:
17859 "|/some/command ready,steady,go"
17861 since items in redirection lists are terminated by commas. Do not, however,
17862 quote just the command. An item such as
17864 |"/some/command ready,steady,go"
17866 is interpreted as a pipe with a rather strange command name, and no arguments.
17869 .cindex "file" "in redirection list"
17870 .cindex "address redirection" "to file"
17871 An item is interpreted as a path name if it begins with &"/"& and does not
17872 parse as a valid RFC 2822 address that includes a domain. For example,
17874 /home/world/minbari
17876 is treated as a file name, but
17878 /s=molari/o=babylon/@x400gate.way
17880 is treated as an address. For a file name, a transport must be specified using
17881 the &%file_transport%& option. However, if the generated path name ends with a
17882 forward slash character, it is interpreted as a directory name rather than a
17883 file name, and &%directory_transport%& is used instead.
17885 Normally, either the router or the transport specifies a user and a group under
17886 which to run the delivery. The default is to use the Exim user and group.
17888 .cindex "&_/dev/null_&"
17889 However, if a redirection item is the path &_/dev/null_&, delivery to it is
17890 bypassed at a high level, and the log entry shows &"**bypassed**"&
17891 instead of a transport name. In this case the user and group are not used.
17894 .cindex "included address list"
17895 .cindex "address redirection" "included external list"
17896 If an item is of the form
17898 :include:<path name>
17900 a list of further items is taken from the given file and included at that
17901 point. &*Note*&: Such a file can not be a filter file; it is just an
17902 out-of-line addition to the list. The items in the included list are separated
17903 by commas or newlines and are not subject to expansion. If this is the first
17904 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
17905 the alias name. This example is incorrect:
17907 list1 :include:/opt/lists/list1
17909 It must be given as
17911 list1: :include:/opt/lists/list1
17914 .cindex "address redirection" "to black hole"
17915 Sometimes you want to throw away mail to a particular local part. Making the
17916 &%data%& option expand to an empty string does not work, because that causes
17917 the router to decline. Instead, the alias item
17918 .cindex "black hole"
17919 .cindex "abandoning mail"
17920 &':blackhole:'& can be used. It does what its name implies. No delivery is
17921 done, and no error message is generated. This has the same effect as specifing
17922 &_/dev/null_& as a destination, but it can be independently disabled.
17924 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
17925 delivery is done for the original local part, even if other redirection items
17926 are present. If you are generating a multi-item list (for example, by reading a
17927 database) and need the ability to provide a no-op item, you must use
17931 .cindex "delivery" "forcing failure"
17932 .cindex "delivery" "forcing deferral"
17933 .cindex "failing delivery" "forcing"
17934 .cindex "deferred delivery, forcing"
17935 .cindex "customizing" "failure message"
17936 An attempt to deliver a particular address can be deferred or forced to fail by
17937 redirection items of the form
17942 respectively. When a redirection list contains such an item, it applies
17943 to the entire redirection; any other items in the list are ignored. Any
17944 text following &':fail:'& or &':defer:'& is placed in the error text
17945 associated with the failure. For example, an alias file might contain:
17947 X.Employee: :fail: Gone away, no forwarding address
17949 In the case of an address that is being verified from an ACL or as the subject
17951 .cindex "VRFY" "error text, display of"
17952 VRFY command, the text is included in the SMTP error response by
17954 .cindex "EXPN" "error text, display of"
17955 The text is not included in the response to an EXPN command. In non-SMTP cases
17956 the text is included in the error message that Exim generates.
17958 .cindex "SMTP" "error codes"
17959 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
17960 &':fail:'&. However, if the message starts with three digits followed by a
17961 space, optionally followed by an extended code of the form &'n.n.n'&, also
17962 followed by a space, and the very first digit is the same as the default error
17963 code, the code from the message is used instead. If the very first digit is
17964 incorrect, a panic error is logged, and the default code is used. You can
17965 suppress the use of the supplied code in a redirect router by setting the
17966 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
17969 .vindex "&$acl_verify_message$&"
17970 In an ACL, an explicitly provided message overrides the default, but the
17971 default message is available in the variable &$acl_verify_message$& and can
17972 therefore be included in a custom message if this is desired.
17974 Normally the error text is the rest of the redirection list &-- a comma does
17975 not terminate it &-- but a newline does act as a terminator. Newlines are not
17976 normally present in alias expansions. In &(lsearch)& lookups they are removed
17977 as part of the continuation process, but they may exist in other kinds of
17978 lookup and in &':include:'& files.
17980 During routing for message delivery (as opposed to verification), a redirection
17981 containing &':fail:'& causes an immediate failure of the incoming address,
17982 whereas &':defer:'& causes the message to remain on the queue so that a
17983 subsequent delivery attempt can happen at a later time. If an address is
17984 deferred for too long, it will ultimately fail, because the normal retry
17988 .cindex "alias file" "exception to default"
17989 Sometimes it is useful to use a single-key search type with a default (see
17990 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
17991 for exceptions to the default. These can be handled by aliasing them to
17992 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
17993 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
17994 results in an empty redirection list has the same effect.
17998 .section "Duplicate addresses" "SECTdupaddr"
17999 .cindex "duplicate addresses"
18000 .cindex "address duplicate, discarding"
18001 .cindex "pipe" "duplicated"
18002 Exim removes duplicate addresses from the list to which it is delivering, so as
18003 to deliver just one copy to each address. This does not apply to deliveries
18004 routed to pipes by different immediate parent addresses, but an indirect
18005 aliasing scheme of the type
18007 pipe: |/some/command $local_part
18011 does not work with a message that is addressed to both local parts, because
18012 when the second is aliased to the intermediate local part &"pipe"& it gets
18013 discarded as being the same as a previously handled address. However, a scheme
18016 localpart1: |/some/command $local_part
18017 localpart2: |/some/command $local_part
18019 does result in two different pipe deliveries, because the immediate parents of
18020 the pipes are distinct.
18024 .section "Repeated redirection expansion" "SECID128"
18025 .cindex "repeated redirection expansion"
18026 .cindex "address redirection" "repeated for each delivery attempt"
18027 When a message cannot be delivered to all of its recipients immediately,
18028 leading to two or more delivery attempts, redirection expansion is carried out
18029 afresh each time for those addresses whose children were not all previously
18030 delivered. If redirection is being used as a mailing list, this can lead to new
18031 members of the list receiving copies of old messages. The &%one_time%& option
18032 can be used to avoid this.
18035 .section "Errors in redirection lists" "SECID129"
18036 .cindex "address redirection" "errors"
18037 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
18038 error is skipped, and an entry is written to the main log. This may be useful
18039 for mailing lists that are automatically managed. Otherwise, if an error is
18040 detected while generating the list of new addresses, the original address is
18041 deferred. See also &%syntax_errors_to%&.
18045 .section "Private options for the redirect router" "SECID130"
18047 .cindex "options" "&(redirect)& router"
18048 The private options for the &(redirect)& router are as follows:
18051 .option allow_defer redirect boolean false
18052 Setting this option allows the use of &':defer:'& in non-filter redirection
18053 data, or the &%defer%& command in an Exim filter file.
18056 .option allow_fail redirect boolean false
18057 .cindex "failing delivery" "from filter"
18058 If this option is true, the &':fail:'& item can be used in a redirection list,
18059 and the &%fail%& command may be used in an Exim filter file.
18062 .option allow_filter redirect boolean false
18063 .cindex "filter" "enabling use of"
18064 .cindex "Sieve filter" "enabling use of"
18065 Setting this option allows Exim to interpret redirection data that starts with
18066 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
18067 are some features of Exim filter files that some administrators may wish to
18068 lock out; see the &%forbid_filter_%&&'xxx'& options below.
18070 It is also possible to lock out Exim filters or Sieve filters while allowing
18071 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
18074 The filter is run using the uid and gid set by the generic &%user%& and
18075 &%group%& options. These take their defaults from the password data if
18076 &%check_local_user%& is set, so in the normal case of users' personal filter
18077 files, the filter is run as the relevant user. When &%allow_filter%& is set
18078 true, Exim insists that either &%check_local_user%& or &%user%& is set.
18082 .option allow_freeze redirect boolean false
18083 .cindex "freezing messages" "allowing in filter"
18084 Setting this option allows the use of the &%freeze%& command in an Exim filter.
18085 This command is more normally encountered in system filters, and is disabled by
18086 default for redirection filters because it isn't something you usually want to
18087 let ordinary users do.
18091 .option check_ancestor redirect boolean false
18092 This option is concerned with handling generated addresses that are the same
18093 as some address in the list of redirection ancestors of the current address.
18094 Although it is turned off by default in the code, it is set in the default
18095 configuration file for handling users' &_.forward_& files. It is recommended
18096 for this use of the &(redirect)& router.
18098 When &%check_ancestor%& is set, if a generated address (including the domain)
18099 is the same as any ancestor of the current address, it is replaced by a copy of
18100 the current address. This helps in the case where local part A is aliased to B,
18101 and B has a &_.forward_& file pointing back to A. For example, within a single
18102 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
18103 &_&~jb/.forward_& contains:
18105 \Joe.Bloggs, <other item(s)>
18107 Without the &%check_ancestor%& setting, either local part (&"jb"& or
18108 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
18109 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
18110 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
18111 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
18112 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
18113 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
18114 original address. See also the &%repeat_use%& option below.
18117 .option check_group redirect boolean "see below"
18118 When the &%file%& option is used, the group owner of the file is checked only
18119 when this option is set. The permitted groups are those listed in the
18120 &%owngroups%& option, together with the user's default group if
18121 &%check_local_user%& is set. If the file has the wrong group, routing is
18122 deferred. The default setting for this option is true if &%check_local_user%&
18123 is set and the &%modemask%& option permits the group write bit, or if the
18124 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
18128 .option check_owner redirect boolean "see below"
18129 When the &%file%& option is used, the owner of the file is checked only when
18130 this option is set. If &%check_local_user%& is set, the local user is
18131 permitted; otherwise the owner must be one of those listed in the &%owners%&
18132 option. The default value for this option is true if &%check_local_user%& or
18133 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
18136 .option data redirect string&!! unset
18137 This option is mutually exclusive with &%file%&. One or other of them must be
18138 set, but not both. The contents of &%data%& are expanded, and then used as the
18139 list of forwarding items, or as a set of filtering instructions. If the
18140 expansion is forced to fail, or the result is an empty string or a string that
18141 has no effect (consists entirely of comments), the router declines.
18143 When filtering instructions are used, the string must begin with &"#Exim
18144 filter"&, and all comments in the string, including this initial one, must be
18145 terminated with newline characters. For example:
18147 data = #Exim filter\n\
18148 if $h_to: contains Exim then save $home/mail/exim endif
18150 If you are reading the data from a database where newlines cannot be included,
18151 you can use the &${sg}$& expansion item to turn the escape string of your
18152 choice into a newline.
18155 .option directory_transport redirect string&!! unset
18156 A &(redirect)& router sets up a direct delivery to a directory when a path name
18157 ending with a slash is specified as a new &"address"&. The transport used is
18158 specified by this option, which, after expansion, must be the name of a
18159 configured transport. This should normally be an &(appendfile)& transport.
18162 .option file redirect string&!! unset
18163 This option specifies the name of a file that contains the redirection data. It
18164 is mutually exclusive with the &%data%& option. The string is expanded before
18165 use; if the expansion is forced to fail, the router declines. Other expansion
18166 failures cause delivery to be deferred. The result of a successful expansion
18167 must be an absolute path. The entire file is read and used as the redirection
18168 data. If the data is an empty string or a string that has no effect (consists
18169 entirely of comments), the router declines.
18171 .cindex "NFS" "checking for file existence"
18172 If the attempt to open the file fails with a &"does not exist"& error, Exim
18173 runs a check on the containing directory,
18174 unless &%ignore_enotdir%& is true (see below).
18175 If the directory does not appear to exist, delivery is deferred. This can
18176 happen when users' &_.forward_& files are in NFS-mounted directories, and there
18177 is a mount problem. If the containing directory does exist, but the file does
18178 not, the router declines.
18181 .option file_transport redirect string&!! unset
18182 .vindex "&$address_file$&"
18183 A &(redirect)& router sets up a direct delivery to a file when a path name not
18184 ending in a slash is specified as a new &"address"&. The transport used is
18185 specified by this option, which, after expansion, must be the name of a
18186 configured transport. This should normally be an &(appendfile)& transport. When
18187 it is running, the file name is in &$address_file$&.
18190 .option filter_prepend_home redirect boolean true
18191 When this option is true, if a &(save)& command in an Exim filter specifies a
18192 relative path, and &$home$& is defined, it is automatically prepended to the
18193 relative path. If this option is set false, this action does not happen. The
18194 relative path is then passed to the transport unmodified.
18197 .option forbid_blackhole redirect boolean false
18198 If this option is true, the &':blackhole:'& item may not appear in a
18202 .option forbid_exim_filter redirect boolean false
18203 If this option is set true, only Sieve filters are permitted when
18204 &%allow_filter%& is true.
18209 .option forbid_file redirect boolean false
18210 .cindex "delivery" "to file; forbidding"
18211 .cindex "Sieve filter" "forbidding delivery to a file"
18212 .cindex "Sieve filter" "&""keep""& facility; disabling"
18213 If this option is true, this router may not generate a new address that
18214 specifies delivery to a local file or directory, either from a filter or from a
18215 conventional forward file. This option is forced to be true if &%one_time%& is
18216 set. It applies to Sieve filters as well as to Exim filters, but if true, it
18217 locks out the Sieve's &"keep"& facility.
18220 .option forbid_filter_dlfunc redirect boolean false
18221 .cindex "filter" "locking out certain features"
18222 If this option is true, string expansions in Exim filters are not allowed to
18223 make use of the &%dlfunc%& expansion facility to run dynamically loaded
18226 .option forbid_filter_existstest redirect boolean false
18227 .cindex "expansion" "statting a file"
18228 If this option is true, string expansions in Exim filters are not allowed to
18229 make use of the &%exists%& condition or the &%stat%& expansion item.
18231 .option forbid_filter_logwrite redirect boolean false
18232 If this option is true, use of the logging facility in Exim filters is not
18233 permitted. Logging is in any case available only if the filter is being run
18234 under some unprivileged uid (which is normally the case for ordinary users'
18235 &_.forward_& files).
18238 .option forbid_filter_lookup redirect boolean false
18239 If this option is true, string expansions in Exim filter files are not allowed
18240 to make use of &%lookup%& items.
18243 .option forbid_filter_perl redirect boolean false
18244 This option has an effect only if Exim is built with embedded Perl support. If
18245 it is true, string expansions in Exim filter files are not allowed to make use
18246 of the embedded Perl support.
18249 .option forbid_filter_readfile redirect boolean false
18250 If this option is true, string expansions in Exim filter files are not allowed
18251 to make use of &%readfile%& items.
18254 .option forbid_filter_readsocket redirect boolean false
18255 If this option is true, string expansions in Exim filter files are not allowed
18256 to make use of &%readsocket%& items.
18259 .option forbid_filter_reply redirect boolean false
18260 If this option is true, this router may not generate an automatic reply
18261 message. Automatic replies can be generated only from Exim or Sieve filter
18262 files, not from traditional forward files. This option is forced to be true if
18263 &%one_time%& is set.
18266 .option forbid_filter_run redirect boolean false
18267 If this option is true, string expansions in Exim filter files are not allowed
18268 to make use of &%run%& items.
18271 .option forbid_include redirect boolean false
18272 If this option is true, items of the form
18274 :include:<path name>
18276 are not permitted in non-filter redirection lists.
18279 .option forbid_pipe redirect boolean false
18280 .cindex "delivery" "to pipe; forbidding"
18281 If this option is true, this router may not generate a new address which
18282 specifies delivery to a pipe, either from an Exim filter or from a conventional
18283 forward file. This option is forced to be true if &%one_time%& is set.
18286 .option forbid_sieve_filter redirect boolean false
18287 If this option is set true, only Exim filters are permitted when
18288 &%allow_filter%& is true.
18291 .cindex "SMTP" "error codes"
18292 .option forbid_smtp_code redirect boolean false
18293 If this option is set true, any SMTP error codes that are present at the start
18294 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
18295 the default codes (451 and 550, respectively) are always used.
18300 .option hide_child_in_errmsg redirect boolean false
18301 .cindex "bounce message" "redirection details; suppressing"
18302 If this option is true, it prevents Exim from quoting a child address if it
18303 generates a bounce or delay message for it. Instead it says &"an address
18304 generated from <&'the top level address'&>"&. Of course, this applies only to
18305 bounces generated locally. If a message is forwarded to another host, &'its'&
18306 bounce may well quote the generated address.
18309 .option ignore_eacces redirect boolean false
18311 If this option is set and an attempt to open a redirection file yields the
18312 EACCES error (permission denied), the &(redirect)& router behaves as if the
18313 file did not exist.
18316 .option ignore_enotdir redirect boolean false
18318 If this option is set and an attempt to open a redirection file yields the
18319 ENOTDIR error (something on the path is not a directory), the &(redirect)&
18320 router behaves as if the file did not exist.
18322 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
18323 router that has the &%file%& option set discovers that the file does not exist
18324 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
18325 against unmounted NFS directories. If the parent can not be statted, delivery
18326 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
18327 is set, because that option tells Exim to ignore &"something on the path is not
18328 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
18329 that some operating systems give ENOENT where others give ENOTDIR.
18333 .option include_directory redirect string unset
18334 If this option is set, the path names of any &':include:'& items in a
18335 redirection list must start with this directory.
18338 .option modemask redirect "octal integer" 022
18339 This specifies mode bits which must not be set for a file specified by the
18340 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
18343 .option one_time redirect boolean false
18344 .cindex "one-time aliasing/forwarding expansion"
18345 .cindex "alias file" "one-time expansion"
18346 .cindex "forward file" "one-time expansion"
18347 .cindex "mailing lists" "one-time expansion"
18348 .cindex "address redirection" "one-time expansion"
18349 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
18350 files each time it tries to deliver a message causes a problem when one or more
18351 of the generated addresses fails be delivered at the first attempt. The problem
18352 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
18353 but of what happens when the redirection list changes during the time that the
18354 message is on Exim's queue. This is particularly true in the case of mailing
18355 lists, where new subscribers might receive copies of messages that were posted
18356 before they subscribed.
18358 If &%one_time%& is set and any addresses generated by the router fail to
18359 deliver at the first attempt, the failing addresses are added to the message as
18360 &"top level"& addresses, and the parent address that generated them is marked
18361 &"delivered"&. Thus, redirection does not happen again at the next delivery
18364 &*Warning 1*&: Any header line addition or removal that is specified by this
18365 router would be lost if delivery did not succeed at the first attempt. For this
18366 reason, the &%headers_add%& and &%headers_remove%& generic options are not
18367 permitted when &%one_time%& is set.
18369 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
18370 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
18371 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
18373 &*Warning 3*&: The &%unseen%& generic router option may not be set with
18376 The original top-level address is remembered with each of the generated
18377 addresses, and is output in any log messages. However, any intermediate parent
18378 addresses are not recorded. This makes a difference to the log only if
18379 &%all_parents%& log selector is set. It is expected that &%one_time%& will
18380 typically be used for mailing lists, where there is normally just one level of
18384 .option owners redirect "string list" unset
18385 .cindex "ownership" "alias file"
18386 .cindex "ownership" "forward file"
18387 .cindex "alias file" "ownership"
18388 .cindex "forward file" "ownership"
18389 This specifies a list of permitted owners for the file specified by &%file%&.
18390 This list is in addition to the local user when &%check_local_user%& is set.
18391 See &%check_owner%& above.
18394 .option owngroups redirect "string list" unset
18395 This specifies a list of permitted groups for the file specified by &%file%&.
18396 The list is in addition to the local user's primary group when
18397 &%check_local_user%& is set. See &%check_group%& above.
18400 .option pipe_transport redirect string&!! unset
18401 .vindex "&$address_pipe$&"
18402 A &(redirect)& router sets up a direct delivery to a pipe when a string
18403 starting with a vertical bar character is specified as a new &"address"&. The
18404 transport used is specified by this option, which, after expansion, must be the
18405 name of a configured transport. This should normally be a &(pipe)& transport.
18406 When the transport is run, the pipe command is in &$address_pipe$&.
18409 .option qualify_domain redirect string&!! unset
18410 .vindex "&$qualify_recipient$&"
18411 If this option is set, and an unqualified address (one without a domain) is
18412 generated, and that address would normally be qualified by the global setting
18413 in &%qualify_recipient%&, it is instead qualified with the domain specified by
18414 expanding this string. If the expansion fails, the router declines. If you want
18415 to revert to the default, you can have the expansion generate
18416 &$qualify_recipient$&.
18418 This option applies to all unqualified addresses generated by Exim filters,
18419 but for traditional &_.forward_& files, it applies only to addresses that are
18420 not preceded by a backslash. Sieve filters cannot generate unqualified
18423 .option qualify_preserve_domain redirect boolean false
18424 .cindex "domain" "in redirection; preserving"
18425 .cindex "preserving domain in redirection"
18426 .cindex "address redirection" "domain; preserving"
18427 If this option is set, the router's local &%qualify_domain%& option must not be
18428 set (a configuration error occurs if it is). If an unqualified address (one
18429 without a domain) is generated, it is qualified with the domain of the parent
18430 address (the immediately preceding ancestor) instead of the global
18431 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
18432 this applies whether or not the address is preceded by a backslash.
18435 .option repeat_use redirect boolean true
18436 If this option is set false, the router is skipped for a child address that has
18437 any ancestor that was routed by this router. This test happens before any of
18438 the other preconditions are tested. Exim's default anti-looping rules skip
18439 only when the ancestor is the same as the current address. See also
18440 &%check_ancestor%& above and the generic &%redirect_router%& option.
18443 .option reply_transport redirect string&!! unset
18444 A &(redirect)& router sets up an automatic reply when a &%mail%& or
18445 &%vacation%& command is used in a filter file. The transport used is specified
18446 by this option, which, after expansion, must be the name of a configured
18447 transport. This should normally be an &(autoreply)& transport. Other transports
18448 are unlikely to do anything sensible or useful.
18451 .option rewrite redirect boolean true
18452 .cindex "address redirection" "disabling rewriting"
18453 If this option is set false, addresses generated by the router are not
18454 subject to address rewriting. Otherwise, they are treated like new addresses
18455 and are rewritten according to the global rewriting rules.
18458 .option sieve_subaddress redirect string&!! unset
18459 The value of this option is passed to a Sieve filter to specify the
18460 :subaddress part of an address.
18462 .option sieve_useraddress redirect string&!! unset
18463 The value of this option is passed to a Sieve filter to specify the :user part
18464 of an address. However, if it is unset, the entire original local part
18465 (including any prefix or suffix) is used for :user.
18468 .option sieve_vacation_directory redirect string&!! unset
18469 .cindex "Sieve filter" "vacation directory"
18470 To enable the &"vacation"& extension for Sieve filters, you must set
18471 &%sieve_vacation_directory%& to the directory where vacation databases are held
18472 (do not put anything else in that directory), and ensure that the
18473 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
18474 needs their own directory; Exim will create it if necessary.
18478 .option skip_syntax_errors redirect boolean false
18479 .cindex "forward file" "broken"
18480 .cindex "address redirection" "broken files"
18481 .cindex "alias file" "broken"
18482 .cindex "broken alias or forward files"
18483 .cindex "ignoring faulty addresses"
18484 .cindex "skipping faulty addresses"
18485 .cindex "error" "skipping bad syntax"
18486 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
18487 non-filter redirection data are skipped, and each failing address is logged. If
18488 &%syntax_errors_to%& is set, a message is sent to the address it defines,
18489 giving details of the failures. If &%syntax_errors_text%& is set, its contents
18490 are expanded and placed at the head of the error message generated by
18491 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
18492 be the same address as the generic &%errors_to%& option. The
18493 &%skip_syntax_errors%& option is often used when handling mailing lists.
18495 If all the addresses in a redirection list are skipped because of syntax
18496 errors, the router declines to handle the original address, and it is passed to
18497 the following routers.
18499 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
18500 error in the filter causes filtering to be abandoned without any action being
18501 taken. The incident is logged, and the router declines to handle the address,
18502 so it is passed to the following routers.
18504 .cindex "Sieve filter" "syntax errors in"
18505 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
18506 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
18507 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
18509 &%skip_syntax_errors%& can be used to specify that errors in users' forward
18510 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
18511 option, used with an address that does not get redirected, can be used to
18512 notify users of these errors, by means of a router like this:
18518 file = $home/.forward
18519 file_transport = address_file
18520 pipe_transport = address_pipe
18521 reply_transport = address_reply
18524 syntax_errors_to = real-$local_part@$domain
18525 syntax_errors_text = \
18526 This is an automatically generated message. An error has\n\
18527 been found in your .forward file. Details of the error are\n\
18528 reported below. While this error persists, you will receive\n\
18529 a copy of this message for every message that is addressed\n\
18530 to you. If your .forward file is a filter file, or if it is\n\
18531 a non-filter file containing no valid forwarding addresses,\n\
18532 a copy of each incoming message will be put in your normal\n\
18533 mailbox. If a non-filter file contains at least one valid\n\
18534 forwarding address, forwarding to the valid addresses will\n\
18535 happen, and those will be the only deliveries that occur.
18537 You also need a router to ensure that local addresses that are prefixed by
18538 &`real-`& are recognized, but not forwarded or filtered. For example, you could
18539 put this immediately before the &(userforward)& router:
18544 local_part_prefix = real-
18545 transport = local_delivery
18547 For security, it would probably be a good idea to restrict the use of this
18548 router to locally-generated messages, using a condition such as this:
18550 condition = ${if match {$sender_host_address}\
18551 {\N^(|127\.0\.0\.1)$\N}}
18555 .option syntax_errors_text redirect string&!! unset
18556 See &%skip_syntax_errors%& above.
18559 .option syntax_errors_to redirect string unset
18560 See &%skip_syntax_errors%& above.
18561 .ecindex IIDredrou1
18562 .ecindex IIDredrou2
18569 . ////////////////////////////////////////////////////////////////////////////
18570 . ////////////////////////////////////////////////////////////////////////////
18572 .chapter "Environment for running local transports" "CHAPenvironment" &&&
18573 "Environment for local transports"
18574 .scindex IIDenvlotra1 "local transports" "environment for"
18575 .scindex IIDenvlotra2 "environment for local transports"
18576 .scindex IIDenvlotra3 "transport" "local; environment for"
18577 Local transports handle deliveries to files and pipes. (The &(autoreply)&
18578 transport can be thought of as similar to a pipe.) Exim always runs transports
18579 in subprocesses, under specified uids and gids. Typical deliveries to local
18580 mailboxes run under the uid and gid of the local user.
18582 Exim also sets a specific current directory while running the transport; for
18583 some transports a home directory setting is also relevant. The &(pipe)&
18584 transport is the only one that sets up environment variables; see section
18585 &<<SECTpipeenv>>& for details.
18587 The values used for the uid, gid, and the directories may come from several
18588 different places. In many cases, the router that handles the address associates
18589 settings with that address as a result of its &%check_local_user%&, &%group%&,
18590 or &%user%& options. However, values may also be given in the transport's own
18591 configuration, and these override anything that comes from the router.
18595 .section "Concurrent deliveries" "SECID131"
18596 .cindex "concurrent deliveries"
18597 .cindex "simultaneous deliveries"
18598 If two different messages for the same local recipient arrive more or less
18599 simultaneously, the two delivery processes are likely to run concurrently. When
18600 the &(appendfile)& transport is used to write to a file, Exim applies locking
18601 rules to stop concurrent processes from writing to the same file at the same
18604 However, when you use a &(pipe)& transport, it is up to you to arrange any
18605 locking that is needed. Here is a silly example:
18609 command = /bin/sh -c 'cat >>/some/file'
18611 This is supposed to write the message at the end of the file. However, if two
18612 messages arrive at the same time, the file will be scrambled. You can use the
18613 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
18614 file using the same algorithm that Exim itself uses.
18619 .section "Uids and gids" "SECTenvuidgid"
18620 .cindex "local transports" "uid and gid"
18621 .cindex "transport" "local; uid and gid"
18622 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
18623 overrides any group that the router set in the address, even if &%user%& is not
18624 set for the transport. This makes it possible, for example, to run local mail
18625 delivery under the uid of the recipient (set by the router), but in a special
18626 group (set by the transport). For example:
18629 # User/group are set by check_local_user in this router
18633 transport = group_delivery
18636 # This transport overrides the group
18638 driver = appendfile
18639 file = /var/spool/mail/$local_part
18642 If &%user%& is set for a transport, its value overrides what is set in the
18643 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
18644 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
18647 .oindex "&%initgroups%&"
18648 When the uid is taken from the transport's configuration, the &[initgroups()]&
18649 function is called for the groups associated with that uid if the
18650 &%initgroups%& option is set for the transport. When the uid is not specified
18651 by the transport, but is associated with the address by a router, the option
18652 for calling &[initgroups()]& is taken from the router configuration.
18654 .cindex "&(pipe)& transport" "uid for"
18655 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
18656 is set and &%user%& is not set, the uid of the process that called Exim to
18657 receive the message is used, and if &%group%& is not set, the corresponding
18658 original gid is also used.
18660 This is the detailed preference order for obtaining a gid; the first of the
18661 following that is set is used:
18664 A &%group%& setting of the transport;
18666 A &%group%& setting of the router;
18668 A gid associated with a user setting of the router, either as a result of
18669 &%check_local_user%& or an explicit non-numeric &%user%& setting;
18671 The group associated with a non-numeric &%user%& setting of the transport;
18673 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
18674 the uid is the creator's uid;
18676 The Exim gid if the Exim uid is being used as a default.
18679 If, for example, the user is specified numerically on the router and there are
18680 no group settings, no gid is available. In this situation, an error occurs.
18681 This is different for the uid, for which there always is an ultimate default.
18682 The first of the following that is set is used:
18685 A &%user%& setting of the transport;
18687 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
18689 A &%user%& setting of the router;
18691 A &%check_local_user%& setting of the router;
18696 Of course, an error will still occur if the uid that is chosen is on the
18697 &%never_users%& list.
18703 .section "Current and home directories" "SECID132"
18704 .cindex "current directory for local transport"
18705 .cindex "home directory" "for local transport"
18706 .cindex "transport" "local; home directory for"
18707 .cindex "transport" "local; current directory for"
18708 Routers may set current and home directories for local transports by means of
18709 the &%transport_current_directory%& and &%transport_home_directory%& options.
18710 However, if the transport's &%current_directory%& or &%home_directory%& options
18711 are set, they override the router's values. In detail, the home directory
18712 for a local transport is taken from the first of these values that is set:
18715 The &%home_directory%& option on the transport;
18717 The &%transport_home_directory%& option on the router;
18719 The password data if &%check_local_user%& is set on the router;
18721 The &%router_home_directory%& option on the router.
18724 The current directory is taken from the first of these values that is set:
18727 The &%current_directory%& option on the transport;
18729 The &%transport_current_directory%& option on the router.
18733 If neither the router nor the transport sets a current directory, Exim uses the
18734 value of the home directory, if it is set. Otherwise it sets the current
18735 directory to &_/_& before running a local transport.
18739 .section "Expansion variables derived from the address" "SECID133"
18740 .vindex "&$domain$&"
18741 .vindex "&$local_part$&"
18742 .vindex "&$original_domain$&"
18743 Normally a local delivery is handling a single address, and in that case the
18744 variables such as &$domain$& and &$local_part$& are set during local
18745 deliveries. However, in some circumstances more than one address may be handled
18746 at once (for example, while writing batch SMTP for onward transmission by some
18747 other means). In this case, the variables associated with the local part are
18748 never set, &$domain$& is set only if all the addresses have the same domain,
18749 and &$original_domain$& is never set.
18750 .ecindex IIDenvlotra1
18751 .ecindex IIDenvlotra2
18752 .ecindex IIDenvlotra3
18760 . ////////////////////////////////////////////////////////////////////////////
18761 . ////////////////////////////////////////////////////////////////////////////
18763 .chapter "Generic options for transports" "CHAPtransportgeneric"
18764 .scindex IIDgenoptra1 "generic options" "transport"
18765 .scindex IIDgenoptra2 "options" "generic; for transports"
18766 .scindex IIDgenoptra3 "transport" "generic options for"
18767 The following generic options apply to all transports:
18770 .option body_only transports boolean false
18771 .cindex "transport" "body only"
18772 .cindex "message" "transporting body only"
18773 .cindex "body of message" "transporting"
18774 If this option is set, the message's headers are not transported. It is
18775 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
18776 or &(pipe)& transports, the settings of &%message_prefix%& and
18777 &%message_suffix%& should be checked, because this option does not
18778 automatically suppress them.
18781 .option current_directory transports string&!! unset
18782 .cindex "transport" "current directory for"
18783 This specifies the current directory that is to be set while running the
18784 transport, overriding any value that may have been set by the router.
18785 If the expansion fails for any reason, including forced failure, an error is
18786 logged, and delivery is deferred.
18789 .option disable_logging transports boolean false
18790 If this option is set true, nothing is logged for any
18791 deliveries by the transport or for any
18792 transport errors. You should not set this option unless you really, really know
18793 what you are doing.
18796 .option debug_print transports string&!! unset
18797 .cindex "testing" "variables in drivers"
18798 If this option is set and debugging is enabled (see the &%-d%& command line
18799 option), the string is expanded and included in the debugging output when the
18801 If expansion of the string fails, the error message is written to the debugging
18802 output, and Exim carries on processing.
18803 This facility is provided to help with checking out the values of variables and
18804 so on when debugging driver configurations. For example, if a &%headers_add%&
18805 option is not working properly, &%debug_print%& could be used to output the
18806 variables it references. A newline is added to the text if it does not end with
18810 .option delivery_date_add transports boolean false
18811 .cindex "&'Delivery-date:'& header line"
18812 If this option is true, a &'Delivery-date:'& header is added to the message.
18813 This gives the actual time the delivery was made. As this is not a standard
18814 header, Exim has a configuration option (&%delivery_date_remove%&) which
18815 requests its removal from incoming messages, so that delivered messages can
18816 safely be resent to other recipients.
18819 .option driver transports string unset
18820 This specifies which of the available transport drivers is to be used.
18821 There is no default, and this option must be set for every transport.
18824 .option envelope_to_add transports boolean false
18825 .cindex "&'Envelope-to:'& header line"
18826 If this option is true, an &'Envelope-to:'& header is added to the message.
18827 This gives the original address(es) in the incoming envelope that caused this
18828 delivery to happen. More than one address may be present if the transport is
18829 configured to handle several addresses at once, or if more than one original
18830 address was redirected to the same final address. As this is not a standard
18831 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
18832 its removal from incoming messages, so that delivered messages can safely be
18833 resent to other recipients.
18836 .option group transports string&!! "Exim group"
18837 .cindex "transport" "group; specifying"
18838 This option specifies a gid for running the transport process, overriding any
18839 value that the router supplies, and also overriding any value associated with
18840 &%user%& (see below).
18843 .option headers_add transports string&!! unset
18844 .cindex "header lines" "adding in transport"
18845 .cindex "transport" "header lines; adding"
18846 This option specifies a string of text that is expanded and added to the header
18847 portion of a message as it is transported, as described in section
18848 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
18849 routers. If the result of the expansion is an empty string, or if the expansion
18850 is forced to fail, no action is taken. Other expansion failures are treated as
18851 errors and cause the delivery to be deferred.
18855 .option headers_only transports boolean false
18856 .cindex "transport" "header lines only"
18857 .cindex "message" "transporting headers only"
18858 .cindex "header lines" "transporting"
18859 If this option is set, the message's body is not transported. It is mutually
18860 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
18861 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
18862 checked, since this option does not automatically suppress them.
18865 .option headers_remove transports string&!! unset
18866 .cindex "header lines" "removing"
18867 .cindex "transport" "header lines; removing"
18868 This option specifies a string that is expanded into a list of header names;
18869 these headers are omitted from the message as it is transported, as described
18870 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
18871 routers. If the result of the expansion is an empty string, or if the expansion
18872 is forced to fail, no action is taken. Other expansion failures are treated as
18873 errors and cause the delivery to be deferred.
18877 .option headers_rewrite transports string unset
18878 .cindex "transport" "header lines; rewriting"
18879 .cindex "rewriting" "at transport time"
18880 This option allows addresses in header lines to be rewritten at transport time,
18881 that is, as the message is being copied to its destination. The contents of the
18882 option are a colon-separated list of rewriting rules. Each rule is in exactly
18883 the same form as one of the general rewriting rules that are applied when a
18884 message is received. These are described in chapter &<<CHAPrewrite>>&. For
18887 headers_rewrite = a@b c@d f : \
18890 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
18891 &'w@z'& in all address-bearing header lines. The rules are applied to the
18892 header lines just before they are written out at transport time, so they affect
18893 only those copies of the message that pass through the transport. However, only
18894 the message's original header lines, and any that were added by a system
18895 filter, are rewritten. If a router or transport adds header lines, they are not
18896 affected by this option. These rewriting rules are &'not'& applied to the
18897 envelope. You can change the return path using &%return_path%&, but you cannot
18898 change envelope recipients at this time.
18901 .option home_directory transports string&!! unset
18902 .cindex "transport" "home directory for"
18904 This option specifies a home directory setting for a local transport,
18905 overriding any value that may be set by the router. The home directory is
18906 placed in &$home$& while expanding the transport's private options. It is also
18907 used as the current directory if no current directory is set by the
18908 &%current_directory%& option on the transport or the
18909 &%transport_current_directory%& option on the router. If the expansion fails
18910 for any reason, including forced failure, an error is logged, and delivery is
18914 .option initgroups transports boolean false
18915 .cindex "additional groups"
18916 .cindex "groups" "additional"
18917 .cindex "transport" "group; additional"
18918 If this option is true and the uid for the delivery process is provided by the
18919 transport, the &[initgroups()]& function is called when running the transport
18920 to ensure that any additional groups associated with the uid are set up.
18923 .option message_size_limit transports string&!! 0
18924 .cindex "limit" "message size per transport"
18925 .cindex "size" "of message, limit"
18926 .cindex "transport" "message size; limiting"
18927 This option controls the size of messages passed through the transport. It is
18928 expanded before use; the result of the expansion must be a sequence of decimal
18929 digits, optionally followed by K or M. If the expansion fails for any reason,
18930 including forced failure, or if the result is not of the required form,
18931 delivery is deferred. If the value is greater than zero and the size of a
18932 message exceeds this limit, the address is failed. If there is any chance that
18933 the resulting bounce message could be routed to the same transport, you should
18934 ensure that &%return_size_limit%& is less than the transport's
18935 &%message_size_limit%&, as otherwise the bounce message will fail to get
18940 .option rcpt_include_affixes transports boolean false
18941 .cindex "prefix" "for local part, including in envelope"
18942 .cindex "suffix for local part" "including in envelope"
18943 .cindex "local part" "prefix"
18944 .cindex "local part" "suffix"
18945 When this option is false (the default), and an address that has had any
18946 affixes (prefixes or suffixes) removed from the local part is delivered by any
18947 form of SMTP or LMTP, the affixes are not included. For example, if a router
18950 local_part_prefix = *-
18952 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
18955 RCPT TO:<xyz@some.domain>
18957 This is also the case when an ACL-time callout is being used to verify a
18958 recipient address. However, if &%rcpt_include_affixes%& is set true, the
18959 whole local part is included in the RCPT command. This option applies to BSMTP
18960 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
18961 &(lmtp)& and &(smtp)& transports.
18964 .option retry_use_local_part transports boolean "see below"
18965 .cindex "hints database" "retry keys"
18966 When a delivery suffers a temporary failure, a retry record is created
18967 in Exim's hints database. For remote deliveries, the key for the retry record
18968 is based on the name and/or IP address of the failing remote host. For local
18969 deliveries, the key is normally the entire address, including both the local
18970 part and the domain. This is suitable for most common cases of local delivery
18971 temporary failure &-- for example, exceeding a mailbox quota should delay only
18972 deliveries to that mailbox, not to the whole domain.
18974 However, in some special cases you may want to treat a temporary local delivery
18975 as a failure associated with the domain, and not with a particular local part.
18976 (For example, if you are storing all mail for some domain in files.) You can do
18977 this by setting &%retry_use_local_part%& false.
18979 For all the local transports, its default value is true. For remote transports,
18980 the default value is false for tidiness, but changing the value has no effect
18981 on a remote transport in the current implementation.
18984 .option return_path transports string&!! unset
18985 .cindex "envelope sender"
18986 .cindex "transport" "return path; changing"
18987 .cindex "return path" "changing in transport"
18988 If this option is set, the string is expanded at transport time and replaces
18989 the existing return path (envelope sender) value in the copy of the message
18990 that is being delivered. An empty return path is permitted. This feature is
18991 designed for remote deliveries, where the value of this option is used in the
18992 SMTP MAIL command. If you set &%return_path%& for a local transport, the
18993 only effect is to change the address that is placed in the &'Return-path:'&
18994 header line, if one is added to the message (see the next option).
18996 &*Note:*& A changed return path is not logged unless you add
18997 &%return_path_on_delivery%& to the log selector.
18999 .vindex "&$return_path$&"
19000 The expansion can refer to the existing value via &$return_path$&. This is
19001 either the message's envelope sender, or an address set by the
19002 &%errors_to%& option on a router. If the expansion is forced to fail, no
19003 replacement occurs; if it fails for another reason, delivery is deferred. This
19004 option can be used to support VERP (Variable Envelope Return Paths) &-- see
19005 section &<<SECTverp>>&.
19007 &*Note*&: If a delivery error is detected locally, including the case when a
19008 remote server rejects a message at SMTP time, the bounce message is not sent to
19009 the value of this option. It is sent to the previously set errors address.
19010 This defaults to the incoming sender address, but can be changed by setting
19011 &%errors_to%& in a router.
19015 .option return_path_add transports boolean false
19016 .cindex "&'Return-path:'& header line"
19017 If this option is true, a &'Return-path:'& header is added to the message.
19018 Although the return path is normally available in the prefix line of BSD
19019 mailboxes, this is commonly not displayed by MUAs, and so the user does not
19020 have easy access to it.
19022 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
19023 the delivery SMTP server makes the final delivery"&. This implies that this
19024 header should not be present in incoming messages. Exim has a configuration
19025 option, &%return_path_remove%&, which requests removal of this header from
19026 incoming messages, so that delivered messages can safely be resent to other
19030 .option shadow_condition transports string&!! unset
19031 See &%shadow_transport%& below.
19034 .option shadow_transport transports string unset
19035 .cindex "shadow transport"
19036 .cindex "transport" "shadow"
19037 A local transport may set the &%shadow_transport%& option to the name of
19038 another local transport. Shadow remote transports are not supported.
19040 Whenever a delivery to the main transport succeeds, and either
19041 &%shadow_condition%& is unset, or its expansion does not result in the empty
19042 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
19043 passed to the shadow transport, with the same delivery address or addresses. If
19044 expansion fails, no action is taken except that non-forced expansion failures
19045 cause a log line to be written.
19047 The result of the shadow transport is discarded and does not affect the
19048 subsequent processing of the message. Only a single level of shadowing is
19049 provided; the &%shadow_transport%& option is ignored on any transport when it
19050 is running as a shadow. Options concerned with output from pipes are also
19051 ignored. The log line for the successful delivery has an item added on the end,
19054 ST=<shadow transport name>
19056 If the shadow transport did not succeed, the error message is put in
19057 parentheses afterwards. Shadow transports can be used for a number of different
19058 purposes, including keeping more detailed log information than Exim normally
19059 provides, and implementing automatic acknowledgment policies based on message
19060 headers that some sites insist on.
19063 .option transport_filter transports string&!! unset
19064 .cindex "transport" "filter"
19065 .cindex "filter" "transport filter"
19066 This option sets up a filtering (in the Unix shell sense) process for messages
19067 at transport time. It should not be confused with mail filtering as set up by
19068 individual users or via a system filter.
19070 When the message is about to be written out, the command specified by
19071 &%transport_filter%& is started up in a separate, parallel process, and
19072 the entire message, including the header lines, is passed to it on its standard
19073 input (this in fact is done from a third process, to avoid deadlock). The
19074 command must be specified as an absolute path.
19076 The lines of the message that are written to the transport filter are
19077 terminated by newline (&"\n"&). The message is passed to the filter before any
19078 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
19079 lines beginning with a dot, and also before any processing implied by the
19080 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
19081 &(pipe)& transports.
19083 The standard error for the filter process is set to the same destination as its
19084 standard output; this is read and written to the message's ultimate
19085 destination. The process that writes the message to the filter, the
19086 filter itself, and the original process that reads the result and delivers it
19087 are all run in parallel, like a shell pipeline.
19089 The filter can perform any transformations it likes, but of course should take
19090 care not to break RFC 2822 syntax. Exim does not check the result, except to
19091 test for a final newline when SMTP is in use. All messages transmitted over
19092 SMTP must end with a newline, so Exim supplies one if it is missing.
19094 .cindex "content scanning" "per user"
19095 A transport filter can be used to provide content-scanning on a per-user basis
19096 at delivery time if the only required effect of the scan is to modify the
19097 message. For example, a content scan could insert a new header line containing
19098 a spam score. This could be interpreted by a filter in the user's MUA. It is
19099 not possible to discard a message at this stage.
19101 .cindex "SMTP" "SIZE"
19102 A problem might arise if the filter increases the size of a message that is
19103 being sent down an SMTP connection. If the receiving SMTP server has indicated
19104 support for the SIZE parameter, Exim will have sent the size of the message
19105 at the start of the SMTP session. If what is actually sent is substantially
19106 more, the server might reject the message. This can be worked round by setting
19107 the &%size_addition%& option on the &(smtp)& transport, either to allow for
19108 additions to the message, or to disable the use of SIZE altogether.
19110 .vindex "&$pipe_addresses$&"
19111 The value of the &%transport_filter%& option is the command string for starting
19112 the filter, which is run directly from Exim, not under a shell. The string is
19113 parsed by Exim in the same way as a command string for the &(pipe)& transport:
19114 Exim breaks it up into arguments and then expands each argument separately (see
19115 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
19116 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
19117 of arguments, one for each address that applies to this delivery. (This isn't
19118 an ideal name for this feature here, but as it was already implemented for the
19119 &(pipe)& transport, it seemed sensible not to change it.)
19122 .vindex "&$host_address$&"
19123 The expansion variables &$host$& and &$host_address$& are available when the
19124 transport is a remote one. They contain the name and IP address of the host to
19125 which the message is being sent. For example:
19127 transport_filter = /some/directory/transport-filter.pl \
19128 $host $host_address $sender_address $pipe_addresses
19131 Two problems arise if you want to use more complicated expansion items to
19132 generate transport filter commands, both of which due to the fact that the
19133 command is split up &'before'& expansion.
19135 If an expansion item contains white space, you must quote it, so that it is all
19136 part of the same command item. If the entire option setting is one such
19137 expansion item, you have to take care what kind of quoting you use. For
19140 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
19142 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
19143 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
19144 stripped by Exim when it read the option's value. When the value is used, if
19145 the single quotes were missing, the line would be split into two items,
19146 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
19147 Exim tried to expand the first one.
19149 Except for the special case of &$pipe_addresses$& that is mentioned above, an
19150 expansion cannot generate multiple arguments, or a command name followed by
19151 arguments. Consider this example:
19153 transport_filter = ${lookup{$host}lsearch{/a/file}\
19154 {$value}{/bin/cat}}
19156 The result of the lookup is interpreted as the name of the command, even
19157 if it contains white space. The simplest way round this is to use a shell:
19159 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
19160 {$value}{/bin/cat}}
19164 The filter process is run under the same uid and gid as the normal delivery.
19165 For remote deliveries this is the Exim uid/gid by default. The command should
19166 normally yield a zero return code. Transport filters are not supposed to fail.
19167 A non-zero code is taken to mean that the transport filter encountered some
19168 serious problem. Delivery of the message is deferred; the message remains on
19169 the queue and is tried again later. It is not possible to cause a message to be
19170 bounced from a transport filter.
19172 If a transport filter is set on an autoreply transport, the original message is
19173 passed through the filter as it is being copied into the newly generated
19174 message, which happens if the &%return_message%& option is set.
19177 .option transport_filter_timeout transports time 5m
19178 .cindex "transport" "filter, timeout"
19179 When Exim is reading the output of a transport filter, it a applies a timeout
19180 that can be set by this option. Exceeding the timeout is normally treated as a
19181 temporary delivery failure. However, if a transport filter is used with a
19182 &(pipe)& transport, a timeout in the transport filter is treated in the same
19183 way as a timeout in the pipe command itself. By default, a timeout is a hard
19184 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
19185 becomes a temporary error.
19188 .option user transports string&!! "Exim user"
19189 .cindex "uid (user id)" "local delivery"
19190 .cindex "transport" "user, specifying"
19191 This option specifies the user under whose uid the delivery process is to be
19192 run, overriding any uid that may have been set by the router. If the user is
19193 given as a name, the uid is looked up from the password data, and the
19194 associated group is taken as the value of the gid to be used if the &%group%&
19197 For deliveries that use local transports, a user and group are normally
19198 specified explicitly or implicitly (for example, as a result of
19199 &%check_local_user%&) by the router or transport.
19201 .cindex "hints database" "access by remote transport"
19202 For remote transports, you should leave this option unset unless you really are
19203 sure you know what you are doing. When a remote transport is running, it needs
19204 to be able to access Exim's hints databases, because each host may have its own
19206 .ecindex IIDgenoptra1
19207 .ecindex IIDgenoptra2
19208 .ecindex IIDgenoptra3
19215 . ////////////////////////////////////////////////////////////////////////////
19216 . ////////////////////////////////////////////////////////////////////////////
19218 .chapter "Address batching in local transports" "CHAPbatching" &&&
19220 .cindex "transport" "local; address batching in"
19221 The only remote transport (&(smtp)&) is normally configured to handle more than
19222 one address at a time, so that when several addresses are routed to the same
19223 remote host, just one copy of the message is sent. Local transports, however,
19224 normally handle one address at a time. That is, a separate instance of the
19225 transport is run for each address that is routed to the transport. A separate
19226 copy of the message is delivered each time.
19228 .cindex "batched local delivery"
19229 .oindex "&%batch_max%&"
19230 .oindex "&%batch_id%&"
19231 In special cases, it may be desirable to handle several addresses at once in a
19232 local transport, for example:
19235 In an &(appendfile)& transport, when storing messages in files for later
19236 delivery by some other means, a single copy of the message with multiple
19237 recipients saves space.
19239 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
19240 a single copy saves time, and is the normal way LMTP is expected to work.
19242 In a &(pipe)& transport, when passing the message
19243 to a scanner program or
19244 to some other delivery mechanism such as UUCP, multiple recipients may be
19248 These three local transports all have the same options for controlling multiple
19249 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
19250 repeating the information for each transport, these options are described here.
19252 The &%batch_max%& option specifies the maximum number of addresses that can be
19253 delivered together in a single run of the transport. Its default value is one
19254 (no batching). When more than one address is routed to a transport that has a
19255 &%batch_max%& value greater than one, the addresses are delivered in a batch
19256 (that is, in a single run of the transport with multiple recipients), subject
19257 to certain conditions:
19260 .vindex "&$local_part$&"
19261 If any of the transport's options contain a reference to &$local_part$&, no
19262 batching is possible.
19264 .vindex "&$domain$&"
19265 If any of the transport's options contain a reference to &$domain$&, only
19266 addresses with the same domain are batched.
19268 .cindex "customizing" "batching condition"
19269 If &%batch_id%& is set, it is expanded for each address, and only those
19270 addresses with the same expanded value are batched. This allows you to specify
19271 customized batching conditions. Failure of the expansion for any reason,
19272 including forced failure, disables batching, but it does not stop the delivery
19275 Batched addresses must also have the same errors address (where to send
19276 delivery errors), the same header additions and removals, the same user and
19277 group for the transport, and if a host list is present, the first host must
19281 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
19282 both when the file or pipe command is specified in the transport, and when it
19283 is specified by a &(redirect)& router, but all the batched addresses must of
19284 course be routed to the same file or pipe command. These two transports have an
19285 option called &%use_bsmtp%&, which causes them to deliver the message in
19286 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
19287 &%check_string%& and &%escape_string%& options are forced to the values
19290 escape_string = ".."
19292 when batched SMTP is in use. A full description of the batch SMTP mechanism is
19293 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
19294 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
19296 .cindex "&'Envelope-to:'& header line"
19297 If the generic &%envelope_to_add%& option is set for a batching transport, the
19298 &'Envelope-to:'& header that is added to the message contains all the addresses
19299 that are being processed together. If you are using a batching &(appendfile)&
19300 transport without &%use_bsmtp%&, the only way to preserve the recipient
19301 addresses is to set the &%envelope_to_add%& option.
19303 .cindex "&(pipe)& transport" "with multiple addresses"
19304 .vindex "&$pipe_addresses$&"
19305 If you are using a &(pipe)& transport without BSMTP, and setting the
19306 transport's &%command%& option, you can include &$pipe_addresses$& as part of
19307 the command. This is not a true variable; it is a bit of magic that causes each
19308 of the recipient addresses to be inserted into the command as a separate
19309 argument. This provides a way of accessing all the addresses that are being
19310 delivered in the batch. &*Note:*& This is not possible for pipe commands that
19311 are specified by a &(redirect)& router.
19316 . ////////////////////////////////////////////////////////////////////////////
19317 . ////////////////////////////////////////////////////////////////////////////
19319 .chapter "The appendfile transport" "CHAPappendfile"
19320 .scindex IIDapptra1 "&(appendfile)& transport"
19321 .scindex IIDapptra2 "transports" "&(appendfile)&"
19322 .cindex "directory creation"
19323 .cindex "creating directories"
19324 The &(appendfile)& transport delivers a message by appending it to an existing
19325 file, or by creating an entirely new file in a specified directory. Single
19326 files to which messages are appended can be in the traditional Unix mailbox
19327 format, or optionally in the MBX format supported by the Pine MUA and
19328 University of Washington IMAP daemon, &'inter alia'&. When each message is
19329 being delivered as a separate file, &"maildir"& format can optionally be used
19330 to give added protection against failures that happen part-way through the
19331 delivery. A third form of separate-file delivery known as &"mailstore"& is also
19332 supported. For all file formats, Exim attempts to create as many levels of
19333 directory as necessary, provided that &%create_directory%& is set.
19335 The code for the optional formats is not included in the Exim binary by
19336 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
19337 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
19340 .cindex "quota" "system"
19341 Exim recognizes system quota errors, and generates an appropriate message. Exim
19342 also supports its own quota control within the transport, for use when the
19343 system facility is unavailable or cannot be used for some reason.
19345 If there is an error while appending to a file (for example, quota exceeded or
19346 partition filled), Exim attempts to reset the file's length and last
19347 modification time back to what they were before. If there is an error while
19348 creating an entirely new file, the new file is removed.
19350 Before appending to a file, a number of security checks are made, and the
19351 file is locked. A detailed description is given below, after the list of
19354 The &(appendfile)& transport is most commonly used for local deliveries to
19355 users' mailboxes. However, it can also be used as a pseudo-remote transport for
19356 putting messages into files for remote delivery by some means other than Exim.
19357 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
19362 .section "The file and directory options" "SECTfildiropt"
19363 The &%file%& option specifies a single file, to which the message is appended;
19364 the &%directory%& option specifies a directory, in which a new file containing
19365 the message is created. Only one of these two options can be set, and for
19366 normal deliveries to mailboxes, one of them &'must'& be set.
19368 .vindex "&$address_file$&"
19369 .vindex "&$local_part$&"
19370 However, &(appendfile)& is also used for delivering messages to files or
19371 directories whose names (or parts of names) are obtained from alias,
19372 forwarding, or filtering operations (for example, a &%save%& command in a
19373 user's Exim filter). When such a transport is running, &$local_part$& contains
19374 the local part that was aliased or forwarded, and &$address_file$& contains the
19375 name (or partial name) of the file or directory generated by the redirection
19376 operation. There are two cases:
19379 If neither &%file%& nor &%directory%& is set, the redirection operation
19380 must specify an absolute path (one that begins with &`/`&). This is the most
19381 common case when users with local accounts use filtering to sort mail into
19382 different folders. See for example, the &(address_file)& transport in the
19383 default configuration. If the path ends with a slash, it is assumed to be the
19384 name of a directory. A delivery to a directory can also be forced by setting
19385 &%maildir_format%& or &%mailstore_format%&.
19387 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
19388 used to determine the file or directory name for the delivery. Normally, the
19389 contents of &$address_file$& are used in some way in the string expansion.
19393 .cindex "Sieve filter" "configuring &(appendfile)&"
19394 .cindex "Sieve filter" "relative mailbox path handling"
19395 As an example of the second case, consider an environment where users do not
19396 have home directories. They may be permitted to use Exim filter commands of the
19401 or Sieve filter commands of the form:
19403 require "fileinto";
19404 fileinto "folder23";
19406 In this situation, the expansion of &%file%& or &%directory%& in the transport
19407 must transform the relative path into an appropriate absolute file name. In the
19408 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
19409 is used as a result of a &"keep"& action in the filter. This example shows one
19410 way of handling this requirement:
19412 file = ${if eq{$address_file}{inbox} \
19413 {/var/mail/$local_part} \
19414 {${if eq{${substr_0_1:$address_file}}{/} \
19416 {$home/mail/$address_file} \
19420 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
19421 location, absolute paths are used without change, and other folders are in the
19422 &_mail_& directory within the home directory.
19424 &*Note 1*&: While processing an Exim filter, a relative path such as
19425 &_folder23_& is turned into an absolute path if a home directory is known to
19426 the router. In particular, this is the case if &%check_local_user%& is set. If
19427 you want to prevent this happening at routing time, you can set
19428 &%router_home_directory%& empty. This forces the router to pass the relative
19429 path to the transport.
19431 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
19432 the &%file%& or &%directory%& option is still used if it is set.
19437 .section "Private options for appendfile" "SECID134"
19438 .cindex "options" "&(appendfile)& transport"
19442 .option allow_fifo appendfile boolean false
19443 .cindex "fifo (named pipe)"
19444 .cindex "named pipe (fifo)"
19445 .cindex "pipe" "named (fifo)"
19446 Setting this option permits delivery to named pipes (FIFOs) as well as to
19447 regular files. If no process is reading the named pipe at delivery time, the
19448 delivery is deferred.
19451 .option allow_symlink appendfile boolean false
19452 .cindex "symbolic link" "to mailbox"
19453 .cindex "mailbox" "symbolic link"
19454 By default, &(appendfile)& will not deliver if the path name for the file is
19455 that of a symbolic link. Setting this option relaxes that constraint, but there
19456 are security issues involved in the use of symbolic links. Be sure you know
19457 what you are doing if you set this. Details of exactly what this option affects
19458 are included in the discussion which follows this list of options.
19461 .option batch_id appendfile string&!! unset
19462 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
19463 However, batching is automatically disabled for &(appendfile)& deliveries that
19464 happen as a result of forwarding or aliasing or other redirection directly to a
19468 .option batch_max appendfile integer 1
19469 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
19472 .option check_group appendfile boolean false
19473 When this option is set, the group owner of the file defined by the &%file%&
19474 option is checked to see that it is the same as the group under which the
19475 delivery process is running. The default setting is false because the default
19476 file mode is 0600, which means that the group is irrelevant.
19479 .option check_owner appendfile boolean true
19480 When this option is set, the owner of the file defined by the &%file%& option
19481 is checked to ensure that it is the same as the user under which the delivery
19482 process is running.
19485 .option check_string appendfile string "see below"
19486 .cindex "&""From""& line"
19487 As &(appendfile)& writes the message, the start of each line is tested for
19488 matching &%check_string%&, and if it does, the initial matching characters are
19489 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
19490 a literal string, not a regular expression, and the case of any letters it
19491 contains is significant.
19493 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
19494 are forced to &"."& and &".."& respectively, and any settings in the
19495 configuration are ignored. Otherwise, they default to &"From&~"& and
19496 &">From&~"& when the &%file%& option is set, and unset when any of the
19497 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
19499 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
19500 suitable for traditional &"BSD"& mailboxes, where a line beginning with
19501 &"From&~"& indicates the start of a new message. All four options need changing
19502 if another format is used. For example, to deliver to mailboxes in MMDF format:
19503 .cindex "MMDF format mailbox"
19504 .cindex "mailbox" "MMDF format"
19506 check_string = "\1\1\1\1\n"
19507 escape_string = "\1\1\1\1 \n"
19508 message_prefix = "\1\1\1\1\n"
19509 message_suffix = "\1\1\1\1\n"
19511 .option create_directory appendfile boolean true
19512 .cindex "directory creation"
19513 When this option is true, Exim attempts to create any missing superior
19514 directories for the file that it is about to write. A created directory's mode
19515 is given by the &%directory_mode%& option.
19517 The group ownership of a newly created directory is highly dependent on the
19518 operating system (and possibly the file system) that is being used. For
19519 example, in Solaris, if the parent directory has the setgid bit set, its group
19520 is propagated to the child; if not, the currently set group is used. However,
19521 in FreeBSD, the parent's group is always used.
19525 .option create_file appendfile string anywhere
19526 This option constrains the location of files and directories that are created
19527 by this transport. It applies to files defined by the &%file%& option and
19528 directories defined by the &%directory%& option. In the case of maildir
19529 delivery, it applies to the top level directory, not the maildir directories
19532 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
19533 &"belowhome"&. In the second and third cases, a home directory must have been
19534 set for the transport. This option is not useful when an explicit file name is
19535 given for normal mailbox deliveries. It is intended for the case when file
19536 names are generated from users' &_.forward_& files. These are usually handled
19537 by an &(appendfile)& transport called &%address_file%&. See also
19538 &%file_must_exist%&.
19541 .option directory appendfile string&!! unset
19542 This option is mutually exclusive with the &%file%& option, but one of &%file%&
19543 or &%directory%& must be set, unless the delivery is the direct result of a
19544 redirection (see section &<<SECTfildiropt>>&).
19546 When &%directory%& is set, the string is expanded, and the message is delivered
19547 into a new file or files in or below the given directory, instead of being
19548 appended to a single mailbox file. A number of different formats are provided
19549 (see &%maildir_format%& and &%mailstore_format%&), and see section
19550 &<<SECTopdir>>& for further details of this form of delivery.
19553 .option directory_file appendfile string&!! "see below"
19555 .vindex "&$inode$&"
19556 When &%directory%& is set, but neither &%maildir_format%& nor
19557 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
19558 whose name is obtained by expanding this string. The default value is:
19560 q${base62:$tod_epoch}-$inode
19562 This generates a unique name from the current time, in base 62 form, and the
19563 inode of the file. The variable &$inode$& is available only when expanding this
19567 .option directory_mode appendfile "octal integer" 0700
19568 If &(appendfile)& creates any directories as a result of the
19569 &%create_directory%& option, their mode is specified by this option.
19572 .option escape_string appendfile string "see description"
19573 See &%check_string%& above.
19576 .option file appendfile string&!! unset
19577 This option is mutually exclusive with the &%directory%& option, but one of
19578 &%file%& or &%directory%& must be set, unless the delivery is the direct result
19579 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
19580 specifies a single file, to which the message is appended. One or more of
19581 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
19584 .cindex "NFS" "lock file"
19585 .cindex "locking files"
19586 .cindex "lock files"
19587 If you are using more than one host to deliver over NFS into the same
19588 mailboxes, you should always use lock files.
19590 The string value is expanded for each delivery, and must yield an absolute
19591 path. The most common settings of this option are variations on one of these
19594 file = /var/spool/mail/$local_part
19595 file = /home/$local_part/inbox
19598 .cindex "&""sticky""& bit"
19599 In the first example, all deliveries are done into the same directory. If Exim
19600 is configured to use lock files (see &%use_lockfile%& below) it must be able to
19601 create a file in the directory, so the &"sticky"& bit must be turned on for
19602 deliveries to be possible, or alternatively the &%group%& option can be used to
19603 run the delivery under a group id which has write access to the directory.
19607 .option file_format appendfile string unset
19608 .cindex "file" "mailbox; checking existing format"
19609 This option requests the transport to check the format of an existing file
19610 before adding to it. The check consists of matching a specific string at the
19611 start of the file. The value of the option consists of an even number of
19612 colon-separated strings. The first of each pair is the test string, and the
19613 second is the name of a transport. If the transport associated with a matched
19614 string is not the current transport, control is passed over to the other
19615 transport. For example, suppose the standard &(local_delivery)& transport has
19618 file_format = "From : local_delivery :\
19619 \1\1\1\1\n : local_mmdf_delivery"
19621 Mailboxes that begin with &"From"& are still handled by this transport, but if
19622 a mailbox begins with four binary ones followed by a newline, control is passed
19623 to a transport called &%local_mmdf_delivery%&, which presumably is configured
19624 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
19625 is assumed to match the current transport. If the start of a mailbox doesn't
19626 match any string, or if the transport named for a given string is not defined,
19627 delivery is deferred.
19630 .option file_must_exist appendfile boolean false
19631 If this option is true, the file specified by the &%file%& option must exist.
19632 A temporary error occurs if it does not, causing delivery to be deferred.
19633 If this option is false, the file is created if it does not exist.
19636 .option lock_fcntl_timeout appendfile time 0s
19637 .cindex "timeout" "mailbox locking"
19638 .cindex "mailbox" "locking, blocking and non-blocking"
19639 .cindex "locking files"
19640 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
19641 when locking an open mailbox file. If the call fails, the delivery process
19642 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
19643 Non-blocking calls are used so that the file is not kept open during the wait
19644 for the lock; the reason for this is to make it as safe as possible for
19645 deliveries over NFS in the case when processes might be accessing an NFS
19646 mailbox without using a lock file. This should not be done, but
19647 misunderstandings and hence misconfigurations are not unknown.
19649 On a busy system, however, the performance of a non-blocking lock approach is
19650 not as good as using a blocking lock with a timeout. In this case, the waiting
19651 is done inside the system call, and Exim's delivery process acquires the lock
19652 and can proceed as soon as the previous lock holder releases it.
19654 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
19655 timeout, are used. There may still be some retrying: the maximum number of
19658 (lock_retries * lock_interval) / lock_fcntl_timeout
19660 rounded up to the next whole number. In other words, the total time during
19661 which &(appendfile)& is trying to get a lock is roughly the same, unless
19662 &%lock_fcntl_timeout%& is set very large.
19664 You should consider setting this option if you are getting a lot of delayed
19665 local deliveries because of errors of the form
19667 failed to lock mailbox /some/file (fcntl)
19670 .option lock_flock_timeout appendfile time 0s
19671 This timeout applies to file locking when using &[flock()]& (see
19672 &%use_flock%&); the timeout operates in a similar manner to
19673 &%lock_fcntl_timeout%&.
19676 .option lock_interval appendfile time 3s
19677 This specifies the time to wait between attempts to lock the file. See below
19678 for details of locking.
19681 .option lock_retries appendfile integer 10
19682 This specifies the maximum number of attempts to lock the file. A value of zero
19683 is treated as 1. See below for details of locking.
19686 .option lockfile_mode appendfile "octal integer" 0600
19687 This specifies the mode of the created lock file, when a lock file is being
19688 used (see &%use_lockfile%& and &%use_mbx_lock%&).
19691 .option lockfile_timeout appendfile time 30m
19692 .cindex "timeout" "mailbox locking"
19693 When a lock file is being used (see &%use_lockfile%&), if a lock file already
19694 exists and is older than this value, it is assumed to have been left behind by
19695 accident, and Exim attempts to remove it.
19698 .option mailbox_filecount appendfile string&!! unset
19699 .cindex "mailbox" "specifying size of"
19700 .cindex "size" "of mailbox"
19701 If this option is set, it is expanded, and the result is taken as the current
19702 number of files in the mailbox. It must be a decimal number, optionally
19703 followed by K or M. This provides a way of obtaining this information from an
19704 external source that maintains the data.
19707 .option mailbox_size appendfile string&!! unset
19708 .cindex "mailbox" "specifying size of"
19709 .cindex "size" "of mailbox"
19710 If this option is set, it is expanded, and the result is taken as the current
19711 size the mailbox. It must be a decimal number, optionally followed by K or M.
19712 This provides a way of obtaining this information from an external source that
19713 maintains the data. This is likely to be helpful for maildir deliveries where
19714 it is computationally expensive to compute the size of a mailbox.
19718 .option maildir_format appendfile boolean false
19719 .cindex "maildir format" "specifying"
19720 If this option is set with the &%directory%& option, the delivery is into a new
19721 file, in the &"maildir"& format that is used by other mail software. When the
19722 transport is activated directly from a &(redirect)& router (for example, the
19723 &(address_file)& transport in the default configuration), setting
19724 &%maildir_format%& causes the path received from the router to be treated as a
19725 directory, whether or not it ends with &`/`&. This option is available only if
19726 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
19727 &<<SECTmaildirdelivery>>& below for further details.
19730 .option maildir_quota_directory_regex appendfile string "See below"
19731 .cindex "maildir format" "quota; directories included in"
19732 .cindex "quota" "maildir; directories included in"
19733 This option is relevant only when &%maildir_use_size_file%& is set. It defines
19734 a regular expression for specifying directories, relative to the quota
19735 directory (see &%quota_directory%&), that should be included in the quota
19736 calculation. The default value is:
19738 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
19740 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
19741 (directories whose names begin with a dot). If you want to exclude the
19743 folder from the count (as some sites do), you need to change this setting to
19745 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
19747 This uses a negative lookahead in the regular expression to exclude the
19748 directory whose name is &_.Trash_&. When a directory is excluded from quota
19749 calculations, quota processing is bypassed for any messages that are delivered
19750 directly into that directory.
19753 .option maildir_retries appendfile integer 10
19754 This option specifies the number of times to retry when writing a file in
19755 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
19758 .option maildir_tag appendfile string&!! unset
19759 This option applies only to deliveries in maildir format, and is described in
19760 section &<<SECTmaildirdelivery>>& below.
19763 .option maildir_use_size_file appendfile boolean false
19764 .cindex "maildir format" "&_maildirsize_& file"
19765 Setting this option true enables support for &_maildirsize_& files. Exim
19766 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
19767 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
19768 value is zero. See &%maildir_quota_directory_regex%& above and section
19769 &<<SECTmaildirdelivery>>& below for further details.
19771 .option maildirfolder_create_regex appendfile string unset
19772 .cindex "maildir format" "&_maildirfolder_& file"
19773 .cindex "&_maildirfolder_&, creating"
19774 The value of this option is a regular expression. If it is unset, it has no
19775 effect. Otherwise, before a maildir delivery takes place, the pattern is
19776 matched against the name of the maildir directory, that is, the directory
19777 containing the &_new_& and &_tmp_& subdirectories that will be used for the
19778 delivery. If there is a match, Exim checks for the existence of a file called
19779 &_maildirfolder_& in the directory, and creates it if it does not exist.
19780 See section &<<SECTmaildirdelivery>>& for more details.
19783 .option mailstore_format appendfile boolean false
19784 .cindex "mailstore format" "specifying"
19785 If this option is set with the &%directory%& option, the delivery is into two
19786 new files in &"mailstore"& format. The option is available only if
19787 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
19788 below for further details.
19791 .option mailstore_prefix appendfile string&!! unset
19792 This option applies only to deliveries in mailstore format, and is described in
19793 section &<<SECTopdir>>& below.
19796 .option mailstore_suffix appendfile string&!! unset
19797 This option applies only to deliveries in mailstore format, and is described in
19798 section &<<SECTopdir>>& below.
19801 .option mbx_format appendfile boolean false
19802 .cindex "locking files"
19803 .cindex "file" "locking"
19804 .cindex "file" "MBX format"
19805 .cindex "MBX format, specifying"
19806 This option is available only if Exim has been compiled with SUPPORT_MBX
19807 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
19808 the message is appended to the mailbox file in MBX format instead of
19809 traditional Unix format. This format is supported by Pine4 and its associated
19810 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
19812 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
19813 automatically changed by the use of &%mbx_format%&. They should normally be set
19814 empty when using MBX format, so this option almost always appears in this
19821 If none of the locking options are mentioned in the configuration,
19822 &%use_mbx_lock%& is assumed and the other locking options default to false. It
19823 is possible to specify the other kinds of locking with &%mbx_format%&, but
19824 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
19825 interworks with &'c-client'&, providing for shared access to the mailbox. It
19826 should not be used if any program that does not use this form of locking is
19827 going to access the mailbox, nor should it be used if the mailbox file is NFS
19828 mounted, because it works only when the mailbox is accessed from a single host.
19830 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
19831 the standard version of &'c-client'&, because as long as it has a mailbox open
19832 (this means for the whole of a Pine or IMAP session), Exim will not be able to
19833 append messages to it.
19836 .option message_prefix appendfile string&!! "see below"
19837 .cindex "&""From""& line"
19838 The string specified here is expanded and output at the start of every message.
19839 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
19840 in which case it is:
19842 message_prefix = "From ${if def:return_path{$return_path}\
19843 {MAILER-DAEMON}} $tod_bsdinbox\n"
19845 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
19846 &`\n`& to &`\r\n`& in &%message_prefix%&.
19848 .option message_suffix appendfile string&!! "see below"
19849 The string specified here is expanded and output at the end of every message.
19850 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
19851 in which case it is a single newline character. The suffix can be suppressed by
19856 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
19857 &`\n`& to &`\r\n`& in &%message_suffix%&.
19859 .option mode appendfile "octal integer" 0600
19860 If the output file is created, it is given this mode. If it already exists and
19861 has wider permissions, they are reduced to this mode. If it has narrower
19862 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
19863 if the delivery is the result of a &%save%& command in a filter file specifying
19864 a particular mode, the mode of the output file is always forced to take that
19865 value, and this option is ignored.
19868 .option mode_fail_narrower appendfile boolean true
19869 This option applies in the case when an existing mailbox file has a narrower
19870 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
19871 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
19872 continues with the delivery attempt, using the existing mode of the file.
19875 .option notify_comsat appendfile boolean false
19876 If this option is true, the &'comsat'& daemon is notified after every
19877 successful delivery to a user mailbox. This is the daemon that notifies logged
19878 on users about incoming mail.
19881 .option quota appendfile string&!! unset
19882 .cindex "quota" "imposed by Exim"
19883 This option imposes a limit on the size of the file to which Exim is appending,
19884 or to the total space used in the directory tree when the &%directory%& option
19885 is set. In the latter case, computation of the space used is expensive, because
19886 all the files in the directory (and any sub-directories) have to be
19887 individually inspected and their sizes summed. (See &%quota_size_regex%& and
19888 &%maildir_use_size_file%& for ways to avoid this in environments where users
19889 have no shell access to their mailboxes).
19891 As there is no interlock against two simultaneous deliveries into a
19892 multi-file mailbox, it is possible for the quota to be overrun in this case.
19893 For single-file mailboxes, of course, an interlock is a necessity.
19895 A file's size is taken as its &'used'& value. Because of blocking effects, this
19896 may be a lot less than the actual amount of disk space allocated to the file.
19897 If the sizes of a number of files are being added up, the rounding effect can
19898 become quite noticeable, especially on systems that have large block sizes.
19899 Nevertheless, it seems best to stick to the &'used'& figure, because this is
19900 the obvious value which users understand most easily.
19902 The value of the option is expanded, and must then be a numerical value
19903 (decimal point allowed), optionally followed by one of the letters K, M, or G,
19904 for kilobytes, megabytes, or gigabytes. If Exim is running on a system with
19905 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
19908 &*Note*&: A value of zero is interpreted as &"no quota"&.
19910 The expansion happens while Exim is running as root, before it changes uid for
19911 the delivery. This means that files that are inaccessible to the end user can
19912 be used to hold quota values that are looked up in the expansion. When delivery
19913 fails because this quota is exceeded, the handling of the error is as for
19914 system quota failures.
19916 By default, Exim's quota checking mimics system quotas, and restricts the
19917 mailbox to the specified maximum size, though the value is not accurate to the
19918 last byte, owing to separator lines and additional headers that may get added
19919 during message delivery. When a mailbox is nearly full, large messages may get
19920 refused even though small ones are accepted, because the size of the current
19921 message is added to the quota when the check is made. This behaviour can be
19922 changed by setting &%quota_is_inclusive%& false. When this is done, the check
19923 for exceeding the quota does not include the current message. Thus, deliveries
19924 continue until the quota has been exceeded; thereafter, no further messages are
19925 delivered. See also &%quota_warn_threshold%&.
19928 .option quota_directory appendfile string&!! unset
19929 This option defines the directory to check for quota purposes when delivering
19930 into individual files. The default is the delivery directory, or, if a file
19931 called &_maildirfolder_& exists in a maildir directory, the parent of the
19932 delivery directory.
19935 .option quota_filecount appendfile string&!! 0
19936 This option applies when the &%directory%& option is set. It limits the total
19937 number of files in the directory (compare the inode limit in system quotas). It
19938 can only be used if &%quota%& is also set. The value is expanded; an expansion
19939 failure causes delivery to be deferred. A value of zero is interpreted as
19943 .option quota_is_inclusive appendfile boolean true
19944 See &%quota%& above.
19947 .option quota_size_regex appendfile string unset
19948 This option applies when one of the delivery modes that writes a separate file
19949 for each message is being used. When Exim wants to find the size of one of
19950 these files in order to test the quota, it first checks &%quota_size_regex%&.
19951 If this is set to a regular expression that matches the file name, and it
19952 captures one string, that string is interpreted as a representation of the
19953 file's size. The value of &%quota_size_regex%& is not expanded.
19955 This feature is useful only when users have no shell access to their mailboxes
19956 &-- otherwise they could defeat the quota simply by renaming the files. This
19957 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
19958 the file length to the file name. For example:
19960 maildir_tag = ,S=$message_size
19961 quota_size_regex = ,S=(\d+)
19963 An alternative to &$message_size$& is &$message_linecount$&, which contains the
19964 number of lines in the message.
19966 The regular expression should not assume that the length is at the end of the
19967 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
19968 sometimes add other information onto the ends of message file names.
19972 .option quota_warn_message appendfile string&!! "see below"
19973 See below for the use of this option. If it is not set when
19974 &%quota_warn_threshold%& is set, it defaults to
19976 quota_warn_message = "\
19977 To: $local_part@$domain\n\
19978 Subject: Your mailbox\n\n\
19979 This message is automatically created \
19980 by mail delivery software.\n\n\
19981 The size of your mailbox has exceeded \
19982 a warning threshold that is\n\
19983 set by the system administrator.\n"
19987 .option quota_warn_threshold appendfile string&!! 0
19988 .cindex "quota" "warning threshold"
19989 .cindex "mailbox" "size warning"
19990 .cindex "size" "of mailbox"
19991 This option is expanded in the same way as &%quota%& (see above). If the
19992 resulting value is greater than zero, and delivery of the message causes the
19993 size of the file or total space in the directory tree to cross the given
19994 threshold, a warning message is sent. If &%quota%& is also set, the threshold
19995 may be specified as a percentage of it by following the value with a percent
19999 quota_warn_threshold = 75%
20001 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
20002 percent sign is ignored.
20004 The warning message itself is specified by the &%quota_warn_message%& option,
20005 and it must start with a &'To:'& header line containing the recipient(s) of the
20006 warning message. These do not necessarily have to include the recipient(s) of
20007 the original message. A &'Subject:'& line should also normally be supplied. You
20008 can include any other header lines that you want. If you do not include a
20009 &'From:'& line, the default is:
20011 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
20013 .oindex &%errors_reply_to%&
20014 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
20017 The &%quota%& option does not have to be set in order to use this option; they
20018 are independent of one another except when the threshold is specified as a
20022 .option use_bsmtp appendfile boolean false
20023 .cindex "envelope sender"
20024 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
20025 format, with the envelope sender and recipient(s) included as SMTP commands. If
20026 you want to include a leading HELO command with such messages, you can do
20027 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
20028 for details of batch SMTP.
20031 .option use_crlf appendfile boolean false
20032 .cindex "carriage return"
20034 This option causes lines to be terminated with the two-character CRLF sequence
20035 (carriage return, linefeed) instead of just a linefeed character. In the case
20036 of batched SMTP, the byte sequence written to the file is then an exact image
20037 of what would be sent down a real SMTP connection.
20039 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
20040 (which are used to supply the traditional &"From&~"& and blank line separators
20041 in Berkeley-style mailboxes) are written verbatim, so must contain their own
20042 carriage return characters if these are needed. In cases where these options
20043 have non-empty defaults, the values end with a single linefeed, so they must be
20044 changed to end with &`\r\n`& if &%use_crlf%& is set.
20047 .option use_fcntl_lock appendfile boolean "see below"
20048 This option controls the use of the &[fcntl()]& function to lock a file for
20049 exclusive use when a message is being appended. It is set by default unless
20050 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
20051 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
20052 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
20055 .option use_flock_lock appendfile boolean false
20056 This option is provided to support the use of &[flock()]& for file locking, for
20057 the few situations where it is needed. Most modern operating systems support
20058 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
20059 each other. Exim uses &[fcntl()]& locking by default.
20061 This option is required only if you are using an operating system where
20062 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
20063 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
20064 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
20066 .cindex "Solaris" "&[flock()]& support"
20067 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
20068 have it (and some, I think, provide a not quite right version built on top of
20069 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
20070 the ability to use it, and any attempt to do so will cause a configuration
20073 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
20074 is just being mapped onto &[fcntl()]& by the OS).
20077 .option use_lockfile appendfile boolean "see below"
20078 If this option is turned off, Exim does not attempt to create a lock file when
20079 appending to a mailbox file. In this situation, the only locking is by
20080 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
20081 sure that every MUA that is ever going to look at your users' mailboxes uses
20082 &[fcntl()]& rather than a lock file, and even then only when you are not
20083 delivering over NFS from more than one host.
20085 .cindex "NFS" "lock file"
20086 In order to append to an NFS file safely from more than one host, it is
20087 necessary to take out a lock &'before'& opening the file, and the lock file
20088 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
20091 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
20092 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
20093 except when &%mbx_format%& is set.
20096 .option use_mbx_lock appendfile boolean "see below"
20097 This option is available only if Exim has been compiled with SUPPORT_MBX
20098 set in &_Local/Makefile_&. Setting the option specifies that special MBX
20099 locking rules be used. It is set by default if &%mbx_format%& is set and none
20100 of the locking options are mentioned in the configuration. The locking rules
20101 are the same as are used by the &'c-client'& library that underlies Pine and
20102 the IMAP4 and POP daemons that come with it (see the discussion below). The
20103 rules allow for shared access to the mailbox. However, this kind of locking
20104 does not work when the mailbox is NFS mounted.
20106 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
20107 &%use_flock_lock%& to control what kind of locking is used in implementing the
20108 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
20109 without &%use_fcntl_lock%& or &%use_flock_lock%&.
20114 .section "Operational details for appending" "SECTopappend"
20115 .cindex "appending to a file"
20116 .cindex "file" "appending"
20117 Before appending to a file, the following preparations are made:
20120 If the name of the file is &_/dev/null_&, no action is taken, and a success
20124 .cindex "directory creation"
20125 If any directories on the file's path are missing, Exim creates them if the
20126 &%create_directory%& option is set. A created directory's mode is given by the
20127 &%directory_mode%& option.
20130 If &%file_format%& is set, the format of an existing file is checked. If this
20131 indicates that a different transport should be used, control is passed to that
20135 .cindex "file" "locking"
20136 .cindex "locking files"
20137 .cindex "NFS" "lock file"
20138 If &%use_lockfile%& is set, a lock file is built in a way that will work
20139 reliably over NFS, as follows:
20142 Create a &"hitching post"& file whose name is that of the lock file with the
20143 current time, primary host name, and process id added, by opening for writing
20144 as a new file. If this fails with an access error, delivery is deferred.
20146 Close the hitching post file, and hard link it to the lock file name.
20148 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
20149 Unlink the hitching post name.
20151 Otherwise, use &[stat()]& to get information about the hitching post file, and
20152 then unlink hitching post name. If the number of links is exactly two, creation
20153 of the lock file succeeded but something (for example, an NFS server crash and
20154 restart) caused this fact not to be communicated to the &[link()]& call.
20156 If creation of the lock file failed, wait for &%lock_interval%& and try again,
20157 up to &%lock_retries%& times. However, since any program that writes to a
20158 mailbox should complete its task very quickly, it is reasonable to time out old
20159 lock files that are normally the result of user agent and system crashes. If an
20160 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
20161 it before trying again.
20165 A call is made to &[lstat()]& to discover whether the main file exists, and if
20166 so, what its characteristics are. If &[lstat()]& fails for any reason other
20167 than non-existence, delivery is deferred.
20170 .cindex "symbolic link" "to mailbox"
20171 .cindex "mailbox" "symbolic link"
20172 If the file does exist and is a symbolic link, delivery is deferred, unless the
20173 &%allow_symlink%& option is set, in which case the ownership of the link is
20174 checked, and then &[stat()]& is called to find out about the real file, which
20175 is then subjected to the checks below. The check on the top-level link
20176 ownership prevents one user creating a link for another's mailbox in a sticky
20177 directory, though allowing symbolic links in this case is definitely not a good
20178 idea. If there is a chain of symbolic links, the intermediate ones are not
20182 If the file already exists but is not a regular file, or if the file's owner
20183 and group (if the group is being checked &-- see &%check_group%& above) are
20184 different from the user and group under which the delivery is running,
20185 delivery is deferred.
20188 If the file's permissions are more generous than specified, they are reduced.
20189 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
20190 is set false, in which case the delivery is tried using the existing
20194 The file's inode number is saved, and the file is then opened for appending.
20195 If this fails because the file has vanished, &(appendfile)& behaves as if it
20196 hadn't existed (see below). For any other failures, delivery is deferred.
20199 If the file is opened successfully, check that the inode number hasn't
20200 changed, that it is still a regular file, and that the owner and permissions
20201 have not changed. If anything is wrong, defer delivery and freeze the message.
20204 If the file did not exist originally, defer delivery if the &%file_must_exist%&
20205 option is set. Otherwise, check that the file is being created in a permitted
20206 directory if the &%create_file%& option is set (deferring on failure), and then
20207 open for writing as a new file, with the O_EXCL and O_CREAT options,
20208 except when dealing with a symbolic link (the &%allow_symlink%& option must be
20209 set). In this case, which can happen if the link points to a non-existent file,
20210 the file is opened for writing using O_CREAT but not O_EXCL, because
20211 that prevents link following.
20214 .cindex "loop" "while file testing"
20215 If opening fails because the file exists, obey the tests given above for
20216 existing files. However, to avoid looping in a situation where the file is
20217 being continuously created and destroyed, the exists/not-exists loop is broken
20218 after 10 repetitions, and the message is then frozen.
20221 If opening fails with any other error, defer delivery.
20224 .cindex "file" "locking"
20225 .cindex "locking files"
20226 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
20227 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
20228 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
20229 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
20230 file, and an exclusive lock on the file whose name is
20232 /tmp/.<device-number>.<inode-number>
20234 using the device and inode numbers of the open mailbox file, in accordance with
20235 the MBX locking rules. This file is created with a mode that is specified by
20236 the &%lockfile_mode%& option.
20238 If Exim fails to lock the file, there are two possible courses of action,
20239 depending on the value of the locking timeout. This is obtained from
20240 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
20242 If the timeout value is zero, the file is closed, Exim waits for
20243 &%lock_interval%&, and then goes back and re-opens the file as above and tries
20244 to lock it again. This happens up to &%lock_retries%& times, after which the
20245 delivery is deferred.
20247 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
20248 &[flock()]& are used (with the given timeout), so there has already been some
20249 waiting involved by the time locking fails. Nevertheless, Exim does not give up
20250 immediately. It retries up to
20252 (lock_retries * lock_interval) / <timeout>
20254 times (rounded up).
20257 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
20258 and/or &[flock()]& locks) and then deletes the lock file if one was created.
20261 .section "Operational details for delivery to a new file" "SECTopdir"
20262 .cindex "delivery" "to single file"
20263 .cindex "&""From""& line"
20264 When the &%directory%& option is set instead of &%file%&, each message is
20265 delivered into a newly-created file or set of files. When &(appendfile)& is
20266 activated directly from a &(redirect)& router, neither &%file%& nor
20267 &%directory%& is normally set, because the path for delivery is supplied by the
20268 router. (See for example, the &(address_file)& transport in the default
20269 configuration.) In this case, delivery is to a new file if either the path name
20270 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
20272 No locking is required while writing the message to a new file, so the various
20273 locking options of the transport are ignored. The &"From"& line that by default
20274 separates messages in a single file is not normally needed, nor is the escaping
20275 of message lines that start with &"From"&, and there is no need to ensure a
20276 newline at the end of each message. Consequently, the default values for
20277 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
20278 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
20280 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
20281 the files in the delivery directory by default. However, you can specify a
20282 different directory by setting &%quota_directory%&. Also, for maildir
20283 deliveries (see below) the &_maildirfolder_& convention is honoured.
20286 .cindex "maildir format"
20287 .cindex "mailstore format"
20288 There are three different ways in which delivery to individual files can be
20289 done, controlled by the settings of the &%maildir_format%& and
20290 &%mailstore_format%& options. Note that code to support maildir or mailstore
20291 formats is not included in the binary unless SUPPORT_MAILDIR or
20292 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
20294 .cindex "directory creation"
20295 In all three cases an attempt is made to create the directory and any necessary
20296 sub-directories if they do not exist, provided that the &%create_directory%&
20297 option is set (the default). The location of a created directory can be
20298 constrained by setting &%create_file%&. A created directory's mode is given by
20299 the &%directory_mode%& option. If creation fails, or if the
20300 &%create_directory%& option is not set when creation is required, delivery is
20305 .section "Maildir delivery" "SECTmaildirdelivery"
20306 .cindex "maildir format" "description of"
20307 If the &%maildir_format%& option is true, Exim delivers each message by writing
20308 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
20309 directory that is defined by the &%directory%& option (the &"delivery
20310 directory"&). If the delivery is successful, the file is renamed into the
20311 &_new_& subdirectory.
20313 In the file name, <&'stime'&> is the current time of day in seconds, and
20314 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
20315 Exim checks that the time-of-day clock has moved on by at least one microsecond
20316 before terminating the delivery process. This guarantees uniqueness for the
20317 file name. However, as a precaution, Exim calls &[stat()]& for the file before
20318 opening it. If any response other than ENOENT (does not exist) is given,
20319 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
20321 Before Exim carries out a maildir delivery, it ensures that subdirectories
20322 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
20323 do not exist, Exim tries to create them and any superior directories in their
20324 path, subject to the &%create_directory%& and &%create_file%& options. If the
20325 &%maildirfolder_create_regex%& option is set, and the regular expression it
20326 contains matches the delivery directory, Exim also ensures that a file called
20327 &_maildirfolder_& exists in the delivery directory. If a missing directory or
20328 &_maildirfolder_& file cannot be created, delivery is deferred.
20330 These features make it possible to use Exim to create all the necessary files
20331 and directories in a maildir mailbox, including subdirectories for maildir++
20332 folders. Consider this example:
20334 maildir_format = true
20335 directory = /var/mail/$local_part\
20336 ${if eq{$local_part_suffix}{}{}\
20337 {/.${substr_1:$local_part_suffix}}}
20338 maildirfolder_create_regex = /\.[^/]+$
20340 If &$local_part_suffix$& is empty (there was no suffix for the local part),
20341 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
20342 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
20343 not match this name, so Exim will not look for or create the file
20344 &_/var/mail/pimbo/maildirfolder_&, though it will create
20345 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
20347 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
20348 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
20349 does match &%maildirfolder_create_regex%&. In this case, Exim will create
20350 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
20351 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
20353 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
20354 not inadvertently match the toplevel maildir directory, because a
20355 &_maildirfolder_& file at top level would completely break quota calculations.
20357 .cindex "quota" "in maildir delivery"
20358 .cindex "maildir++"
20359 If Exim is required to check a &%quota%& setting before a maildir delivery, and
20360 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
20361 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
20362 Exim assumes the directory is a maildir++ folder directory, which is one level
20363 down from the user's top level mailbox directory. This causes it to start at
20364 the parent directory instead of the current directory when calculating the
20365 amount of space used.
20367 One problem with delivering into a multi-file mailbox is that it is
20368 computationally expensive to compute the size of the mailbox for quota
20369 checking. Various approaches have been taken to reduce the amount of work
20370 needed. The next two sections describe two of them. A third alternative is to
20371 use some external process for maintaining the size data, and use the expansion
20372 of the &%mailbox_size%& option as a way of importing it into Exim.
20377 .section "Using tags to record message sizes" "SECID135"
20378 If &%maildir_tag%& is set, the string is expanded for each delivery.
20379 When the maildir file is renamed into the &_new_& sub-directory, the
20380 tag is added to its name. However, if adding the tag takes the length of the
20381 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
20382 the tag is dropped and the maildir file is created with no tag.
20384 .vindex "&$message_size$&"
20385 Tags can be used to encode the size of files in their names; see
20386 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
20387 happens after the message has been written. The value of the &$message_size$&
20388 variable is set to the number of bytes actually written. If the expansion is
20389 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
20390 be deferred. The expanded tag may contain any printing characters except &"/"&.
20391 Non-printing characters in the string are ignored; if the resulting string is
20392 empty, it is ignored. If it starts with an alphanumeric character, a leading
20397 .section "Using a maildirsize file" "SECID136"
20398 .cindex "quota" "in maildir delivery"
20399 .cindex "maildir format" "&_maildirsize_& file"
20400 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
20401 storing quota and message size information in a file called &_maildirsize_&
20402 within the toplevel maildir directory. If this file does not exist, Exim
20403 creates it, setting the quota from the &%quota%& option of the transport. If
20404 the maildir directory itself does not exist, it is created before any attempt
20405 to write a &_maildirsize_& file.
20407 The &_maildirsize_& file is used to hold information about the sizes of
20408 messages in the maildir, thus speeding up quota calculations. The quota value
20409 in the file is just a cache; if the quota is changed in the transport, the new
20410 value overrides the cached value when the next message is delivered. The cache
20411 is maintained for the benefit of other programs that access the maildir and
20412 need to know the quota.
20414 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
20415 file is maintained (with a zero quota setting), but no quota is imposed.
20417 A regular expression is available for controlling which directories in the
20418 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
20419 See the description of the &%maildir_quota_directory_regex%& option above for
20423 .section "Mailstore delivery" "SECID137"
20424 .cindex "mailstore format" "description of"
20425 If the &%mailstore_format%& option is true, each message is written as two
20426 files in the given directory. A unique base name is constructed from the
20427 message id and the current delivery process, and the files that are written use
20428 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
20429 contains the message's envelope, and the &_.msg_& file contains the message
20430 itself. The base name is placed in the variable &$mailstore_basename$&.
20432 During delivery, the envelope is first written to a file with the suffix
20433 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
20434 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
20435 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
20436 file before accessing either of them. An alternative approach is to wait for
20437 the absence of a &_.tmp_& file.
20439 The envelope file starts with any text defined by the &%mailstore_prefix%&
20440 option, expanded and terminated by a newline if there isn't one. Then follows
20441 the sender address on one line, then all the recipient addresses, one per line.
20442 There can be more than one recipient only if the &%batch_max%& option is set
20443 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
20444 appended to the file, followed by a newline if it does not end with one.
20446 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
20447 failure, it is ignored. Other expansion errors are treated as serious
20448 configuration errors, and delivery is deferred. The variable
20449 &$mailstore_basename$& is available for use during these expansions.
20452 .section "Non-special new file delivery" "SECID138"
20453 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
20454 file is created directly in the named directory. For example, when delivering
20455 messages into files in batched SMTP format for later delivery to some host (see
20456 section &<<SECTbatchSMTP>>&), a setting such as
20458 directory = /var/bsmtp/$host
20460 might be used. A message is written to a file with a temporary name, which is
20461 then renamed when the delivery is complete. The final name is obtained by
20462 expanding the contents of the &%directory_file%& option.
20463 .ecindex IIDapptra1
20464 .ecindex IIDapptra2
20471 . ////////////////////////////////////////////////////////////////////////////
20472 . ////////////////////////////////////////////////////////////////////////////
20474 .chapter "The autoreply transport" "CHID8"
20475 .scindex IIDauttra1 "transports" "&(autoreply)&"
20476 .scindex IIDauttra2 "&(autoreply)& transport"
20477 The &(autoreply)& transport is not a true transport in that it does not cause
20478 the message to be transmitted. Instead, it generates a new mail message as an
20479 automatic reply to the incoming message. &'References:'& and
20480 &'Auto-Submitted:'& header lines are included. These are constructed according
20481 to the rules in RFCs 2822 and 3834, respectively.
20483 If the router that passes the message to this transport does not have the
20484 &%unseen%& option set, the original message (for the current recipient) is not
20485 delivered anywhere. However, when the &%unseen%& option is set on the router
20486 that passes the message to this transport, routing of the address continues, so
20487 another router can set up a normal message delivery.
20490 The &(autoreply)& transport is usually run as the result of mail filtering, a
20491 &"vacation"& message being the standard example. However, it can also be run
20492 directly from a router like any other transport. To reduce the possibility of
20493 message cascades, messages created by the &(autoreply)& transport always have
20494 empty envelope sender addresses, like bounce messages.
20496 The parameters of the message to be sent can be specified in the configuration
20497 by options described below. However, these are used only when the address
20498 passed to the transport does not contain its own reply information. When the
20499 transport is run as a consequence of a
20501 or &%vacation%& command in a filter file, the parameters of the message are
20502 supplied by the filter, and passed with the address. The transport's options
20503 that define the message are then ignored (so they are not usually set in this
20504 case). The message is specified entirely by the filter or by the transport; it
20505 is never built from a mixture of options. However, the &%file_optional%&,
20506 &%mode%&, and &%return_message%& options apply in all cases.
20508 &(Autoreply)& is implemented as a local transport. When used as a result of a
20509 command in a user's filter file, &(autoreply)& normally runs under the uid and
20510 gid of the user, and with appropriate current and home directories (see chapter
20511 &<<CHAPenvironment>>&).
20513 There is a subtle difference between routing a message to a &(pipe)& transport
20514 that generates some text to be returned to the sender, and routing it to an
20515 &(autoreply)& transport. This difference is noticeable only if more than one
20516 address from the same message is so handled. In the case of a pipe, the
20517 separate outputs from the different addresses are gathered up and returned to
20518 the sender in a single message, whereas if &(autoreply)& is used, a separate
20519 message is generated for each address that is passed to it.
20521 Non-printing characters are not permitted in the header lines generated for the
20522 message that &(autoreply)& creates, with the exception of newlines that are
20523 immediately followed by white space. If any non-printing characters are found,
20524 the transport defers.
20525 Whether characters with the top bit set count as printing characters or not is
20526 controlled by the &%print_topbitchars%& global option.
20528 If any of the generic options for manipulating headers (for example,
20529 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
20530 of the original message that is included in the generated message when
20531 &%return_message%& is set. They do not apply to the generated message itself.
20533 .vindex "&$sender_address$&"
20534 If the &(autoreply)& transport receives return code 2 from Exim when it submits
20535 the message, indicating that there were no recipients, it does not treat this
20536 as an error. This means that autoreplies sent to &$sender_address$& when this
20537 is empty (because the incoming message is a bounce message) do not cause
20538 problems. They are just discarded.
20542 .section "Private options for autoreply" "SECID139"
20543 .cindex "options" "&(autoreply)& transport"
20545 .option bcc autoreply string&!! unset
20546 This specifies the addresses that are to receive &"blind carbon copies"& of the
20547 message when the message is specified by the transport.
20550 .option cc autoreply string&!! unset
20551 This specifies recipients of the message and the contents of the &'Cc:'& header
20552 when the message is specified by the transport.
20555 .option file autoreply string&!! unset
20556 The contents of the file are sent as the body of the message when the message
20557 is specified by the transport. If both &%file%& and &%text%& are set, the text
20558 string comes first.
20561 .option file_expand autoreply boolean false
20562 If this is set, the contents of the file named by the &%file%& option are
20563 subjected to string expansion as they are added to the message.
20566 .option file_optional autoreply boolean false
20567 If this option is true, no error is generated if the file named by the &%file%&
20568 option or passed with the address does not exist or cannot be read.
20571 .option from autoreply string&!! unset
20572 This specifies the contents of the &'From:'& header when the message is
20573 specified by the transport.
20576 .option headers autoreply string&!! unset
20577 This specifies additional RFC 2822 headers that are to be added to the message
20578 when the message is specified by the transport. Several can be given by using
20579 &"\n"& to separate them. There is no check on the format.
20582 .option log autoreply string&!! unset
20583 This option names a file in which a record of every message sent is logged when
20584 the message is specified by the transport.
20587 .option mode autoreply "octal integer" 0600
20588 If either the log file or the &"once"& file has to be created, this mode is
20592 .option never_mail autoreply "address list&!!" unset
20593 If any run of the transport creates a message with a recipient that matches any
20594 item in the list, that recipient is quietly discarded. If all recipients are
20595 discarded, no message is created. This applies both when the recipients are
20596 generated by a filter and when they are specified in the transport.
20600 .option once autoreply string&!! unset
20601 This option names a file or DBM database in which a record of each &'To:'&
20602 recipient is kept when the message is specified by the transport. &*Note*&:
20603 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
20605 If &%once%& is unset, or is set to an empty string, the message is always sent.
20606 By default, if &%once%& is set to a non-empty file name, the message
20607 is not sent if a potential recipient is already listed in the database.
20608 However, if the &%once_repeat%& option specifies a time greater than zero, the
20609 message is sent if that much time has elapsed since a message was last sent to
20610 this recipient. A setting of zero time for &%once_repeat%& (the default)
20611 prevents a message from being sent a second time &-- in this case, zero means
20614 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
20615 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
20616 greater than zero, it changes the way Exim implements the &%once%& option.
20617 Instead of using a DBM file to record every recipient it sends to, it uses a
20618 regular file, whose size will never get larger than the given value.
20620 In the file, Exim keeps a linear list of recipient addresses and the times at
20621 which they were sent messages. If the file is full when a new address needs to
20622 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
20623 means that a given recipient may receive multiple messages, but at
20624 unpredictable intervals that depend on the rate of turnover of addresses in the
20625 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
20628 .option once_file_size autoreply integer 0
20629 See &%once%& above.
20632 .option once_repeat autoreply time&!! 0s
20633 See &%once%& above.
20634 After expansion, the value of this option must be a valid time value.
20637 .option reply_to autoreply string&!! unset
20638 This specifies the contents of the &'Reply-To:'& header when the message is
20639 specified by the transport.
20642 .option return_message autoreply boolean false
20643 If this is set, a copy of the original message is returned with the new
20644 message, subject to the maximum size set in the &%return_size_limit%& global
20645 configuration option.
20648 .option subject autoreply string&!! unset
20649 This specifies the contents of the &'Subject:'& header when the message is
20650 specified by the transport. It is tempting to quote the original subject in
20651 automatic responses. For example:
20653 subject = Re: $h_subject:
20655 There is a danger in doing this, however. It may allow a third party to
20656 subscribe your users to an opt-in mailing list, provided that the list accepts
20657 bounce messages as subscription confirmations. Well-managed lists require a
20658 non-bounce message to confirm a subscription, so the danger is relatively
20663 .option text autoreply string&!! unset
20664 This specifies a single string to be used as the body of the message when the
20665 message is specified by the transport. If both &%text%& and &%file%& are set,
20666 the text comes first.
20669 .option to autoreply string&!! unset
20670 This specifies recipients of the message and the contents of the &'To:'& header
20671 when the message is specified by the transport.
20672 .ecindex IIDauttra1
20673 .ecindex IIDauttra2
20678 . ////////////////////////////////////////////////////////////////////////////
20679 . ////////////////////////////////////////////////////////////////////////////
20681 .chapter "The lmtp transport" "CHAPLMTP"
20682 .cindex "transports" "&(lmtp)&"
20683 .cindex "&(lmtp)& transport"
20684 .cindex "LMTP" "over a pipe"
20685 .cindex "LMTP" "over a socket"
20686 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
20688 or by interacting with a Unix domain socket.
20689 This transport is something of a cross between the &(pipe)& and &(smtp)&
20690 transports. Exim also has support for using LMTP over TCP/IP; this is
20691 implemented as an option for the &(smtp)& transport. Because LMTP is expected
20692 to be of minority interest, the default build-time configure in &_src/EDITME_&
20693 has it commented out. You need to ensure that
20697 .cindex "options" "&(lmtp)& transport"
20698 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
20699 included in the Exim binary. The private options of the &(lmtp)& transport are
20702 .option batch_id lmtp string&!! unset
20703 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20706 .option batch_max lmtp integer 1
20707 This limits the number of addresses that can be handled in a single delivery.
20708 Most LMTP servers can handle several addresses at once, so it is normally a
20709 good idea to increase this value. See the description of local delivery
20710 batching in chapter &<<CHAPbatching>>&.
20713 .option command lmtp string&!! unset
20714 This option must be set if &%socket%& is not set. The string is a command which
20715 is run in a separate process. It is split up into a command name and list of
20716 arguments, each of which is separately expanded (so expansion cannot change the
20717 number of arguments). The command is run directly, not via a shell. The message
20718 is passed to the new process using the standard input and output to operate the
20721 .option ignore_quota lmtp boolean false
20722 .cindex "LMTP" "ignoring quota errors"
20723 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
20724 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
20725 in its response to the LHLO command.
20727 .option socket lmtp string&!! unset
20728 This option must be set if &%command%& is not set. The result of expansion must
20729 be the name of a Unix domain socket. The transport connects to the socket and
20730 delivers the message to it using the LMTP protocol.
20733 .option timeout lmtp time 5m
20734 The transport is aborted if the created process or Unix domain socket does not
20735 respond to LMTP commands or message input within this timeout. Delivery
20736 is deferred, and will be tried again later. Here is an example of a typical
20741 command = /some/local/lmtp/delivery/program
20745 This delivers up to 20 addresses at a time, in a mixture of domains if
20746 necessary, running as the user &'exim'&.
20750 . ////////////////////////////////////////////////////////////////////////////
20751 . ////////////////////////////////////////////////////////////////////////////
20753 .chapter "The pipe transport" "CHAPpipetransport"
20754 .scindex IIDpiptra1 "transports" "&(pipe)&"
20755 .scindex IIDpiptra2 "&(pipe)& transport"
20756 The &(pipe)& transport is used to deliver messages via a pipe to a command
20757 running in another process. One example is the use of &(pipe)& as a
20758 pseudo-remote transport for passing messages to some other delivery mechanism
20759 (such as UUCP). Another is the use by individual users to automatically process
20760 their incoming messages. The &(pipe)& transport can be used in one of the
20764 .vindex "&$local_part$&"
20765 A router routes one address to a transport in the normal way, and the
20766 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
20767 contains the local part of the address (as usual), and the command that is run
20768 is specified by the &%command%& option on the transport.
20770 .vindex "&$pipe_addresses$&"
20771 If the &%batch_max%& option is set greater than 1 (the default is 1), the
20772 transport can handle more than one address in a single run. In this case, when
20773 more than one address is routed to the transport, &$local_part$& is not set
20774 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
20775 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
20776 that are routed to the transport.
20778 .vindex "&$address_pipe$&"
20779 A router redirects an address directly to a pipe command (for example, from an
20780 alias or forward file). In this case, &$address_pipe$& contains the text of the
20781 pipe command, and the &%command%& option on the transport is ignored. If only
20782 one address is being transported (&%batch_max%& is not greater than one, or
20783 only one address was redirected to this pipe command), &$local_part$& contains
20784 the local part that was redirected.
20788 The &(pipe)& transport is a non-interactive delivery method. Exim can also
20789 deliver messages over pipes using the LMTP interactive protocol. This is
20790 implemented by the &(lmtp)& transport.
20792 In the case when &(pipe)& is run as a consequence of an entry in a local user's
20793 &_.forward_& file, the command runs under the uid and gid of that user. In
20794 other cases, the uid and gid have to be specified explicitly, either on the
20795 transport or on the router that handles the address. Current and &"home"&
20796 directories are also controllable. See chapter &<<CHAPenvironment>>& for
20797 details of the local delivery environment and chapter &<<CHAPbatching>>&
20798 for a discussion of local delivery batching.
20801 .section "Concurrent delivery" "SECID140"
20802 If two messages arrive at almost the same time, and both are routed to a pipe
20803 delivery, the two pipe transports may be run concurrently. You must ensure that
20804 any pipe commands you set up are robust against this happening. If the commands
20805 write to a file, the &%exim_lock%& utility might be of use.
20810 .section "Returned status and data" "SECID141"
20811 .cindex "&(pipe)& transport" "returned data"
20812 If the command exits with a non-zero return code, the delivery is deemed to
20813 have failed, unless either the &%ignore_status%& option is set (in which case
20814 the return code is treated as zero), or the return code is one of those listed
20815 in the &%temp_errors%& option, which are interpreted as meaning &"try again
20816 later"&. In this case, delivery is deferred. Details of a permanent failure are
20817 logged, but are not included in the bounce message, which merely contains
20818 &"local delivery failed"&.
20820 If the return code is greater than 128 and the command being run is a shell
20821 script, it normally means that the script was terminated by a signal whose
20822 value is the return code minus 128.
20824 If Exim is unable to run the command (that is, if &[execve()]& fails), the
20825 return code is set to 127. This is the value that a shell returns if it is
20826 asked to run a non-existent command. The wording for the log line suggests that
20827 a non-existent command may be the problem.
20829 The &%return_output%& option can affect the result of a pipe delivery. If it is
20830 set and the command produces any output on its standard output or standard
20831 error streams, the command is considered to have failed, even if it gave a zero
20832 return code or if &%ignore_status%& is set. The output from the command is
20833 included as part of the bounce message. The &%return_fail_output%& option is
20834 similar, except that output is returned only when the command exits with a
20835 failure return code, that is, a value other than zero or a code that matches
20840 .section "How the command is run" "SECThowcommandrun"
20841 .cindex "&(pipe)& transport" "path for command"
20842 The command line is (by default) broken down into a command name and arguments
20843 by the &(pipe)& transport itself. The &%allow_commands%& and
20844 &%restrict_to_path%& options can be used to restrict the commands that may be
20847 .cindex "quoting" "in pipe command"
20848 Unquoted arguments are delimited by white space. If an argument appears in
20849 double quotes, backslash is interpreted as an escape character in the usual
20850 way. If an argument appears in single quotes, no escaping is done.
20852 String expansion is applied to the command line except when it comes from a
20853 traditional &_.forward_& file (commands from a filter file are expanded). The
20854 expansion is applied to each argument in turn rather than to the whole line.
20855 For this reason, any string expansion item that contains white space must be
20856 quoted so as to be contained within a single argument. A setting such as
20858 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
20860 will not work, because the expansion item gets split between several
20861 arguments. You have to write
20863 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
20865 to ensure that it is all in one argument. The expansion is done in this way,
20866 argument by argument, so that the number of arguments cannot be changed as a
20867 result of expansion, and quotes or backslashes in inserted variables do not
20868 interact with external quoting. However, this leads to problems if you want to
20869 generate multiple arguments (or the command name plus arguments) from a single
20870 expansion. In this situation, the simplest solution is to use a shell. For
20873 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
20876 .cindex "transport" "filter"
20877 .cindex "filter" "transport filter"
20878 .vindex "&$pipe_addresses$&"
20879 Special handling takes place when an argument consists of precisely the text
20880 &`$pipe_addresses`&. This is not a general expansion variable; the only
20881 place this string is recognized is when it appears as an argument for a pipe or
20882 transport filter command. It causes each address that is being handled to be
20883 inserted in the argument list at that point &'as a separate argument'&. This
20884 avoids any problems with spaces or shell metacharacters, and is of use when a
20885 &(pipe)& transport is handling groups of addresses in a batch.
20887 After splitting up into arguments and expansion, the resulting command is run
20888 in a subprocess directly from the transport, &'not'& under a shell. The
20889 message that is being delivered is supplied on the standard input, and the
20890 standard output and standard error are both connected to a single pipe that is
20891 read by Exim. The &%max_output%& option controls how much output the command
20892 may produce, and the &%return_output%& and &%return_fail_output%& options
20893 control what is done with it.
20895 Not running the command under a shell (by default) lessens the security risks
20896 in cases when a command from a user's filter file is built out of data that was
20897 taken from an incoming message. If a shell is required, it can of course be
20898 explicitly specified as the command to be run. However, there are circumstances
20899 where existing commands (for example, in &_.forward_& files) expect to be run
20900 under a shell and cannot easily be modified. To allow for these cases, there is
20901 an option called &%use_shell%&, which changes the way the &(pipe)& transport
20902 works. Instead of breaking up the command line as just described, it expands it
20903 as a single string and passes the result to &_/bin/sh_&. The
20904 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
20905 with &%use_shell%&, and the whole mechanism is inherently less secure.
20909 .section "Environment variables" "SECTpipeenv"
20910 .cindex "&(pipe)& transport" "environment for command"
20911 .cindex "environment for pipe transport"
20912 The environment variables listed below are set up when the command is invoked.
20913 This list is a compromise for maximum compatibility with other MTAs. Note that
20914 the &%environment%& option can be used to add additional variables to this
20917 &`DOMAIN `& the domain of the address
20918 &`HOME `& the home directory, if set
20919 &`HOST `& the host name when called from a router (see below)
20920 &`LOCAL_PART `& see below
20921 &`LOCAL_PART_PREFIX `& see below
20922 &`LOCAL_PART_SUFFIX `& see below
20923 &`LOGNAME `& see below
20924 &`MESSAGE_ID `& Exim's local ID for the message
20925 &`PATH `& as specified by the &%path%& option below
20926 &`QUALIFY_DOMAIN `& the sender qualification domain
20927 &`RECIPIENT `& the complete recipient address
20928 &`SENDER `& the sender of the message (empty if a bounce)
20929 &`SHELL `& &`/bin/sh`&
20930 &`TZ `& the value of the &%timezone%& option, if set
20931 &`USER `& see below
20933 When a &(pipe)& transport is called directly from (for example) an &(accept)&
20934 router, LOCAL_PART is set to the local part of the address. When it is
20935 called as a result of a forward or alias expansion, LOCAL_PART is set to
20936 the local part of the address that was expanded. In both cases, any affixes are
20937 removed from the local part, and made available in LOCAL_PART_PREFIX and
20938 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
20939 same value as LOCAL_PART for compatibility with other MTAs.
20942 HOST is set only when a &(pipe)& transport is called from a router that
20943 associates hosts with an address, typically when using &(pipe)& as a
20944 pseudo-remote transport. HOST is set to the first host name specified by
20948 If the transport's generic &%home_directory%& option is set, its value is used
20949 for the HOME environment variable. Otherwise, a home directory may be set
20950 by the router's &%transport_home_directory%& option, which defaults to the
20951 user's home directory if &%check_local_user%& is set.
20954 .section "Private options for pipe" "SECID142"
20955 .cindex "options" "&(pipe)& transport"
20959 .option allow_commands pipe "string list&!!" unset
20960 .cindex "&(pipe)& transport" "permitted commands"
20961 The string is expanded, and is then interpreted as a colon-separated list of
20962 permitted commands. If &%restrict_to_path%& is not set, the only commands
20963 permitted are those in the &%allow_commands%& list. They need not be absolute
20964 paths; the &%path%& option is still used for relative paths. If
20965 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
20966 in the &%allow_commands%& list, or a name without any slashes that is found on
20967 the path. In other words, if neither &%allow_commands%& nor
20968 &%restrict_to_path%& is set, there is no restriction on the command, but
20969 otherwise only commands that are permitted by one or the other are allowed. For
20972 allow_commands = /usr/bin/vacation
20974 and &%restrict_to_path%& is not set, the only permitted command is
20975 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
20976 &%use_shell%& is set.
20979 .option batch_id pipe string&!! unset
20980 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20983 .option batch_max pipe integer 1
20984 This limits the number of addresses that can be handled in a single delivery.
20985 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20988 .option check_string pipe string unset
20989 As &(pipe)& writes the message, the start of each line is tested for matching
20990 &%check_string%&, and if it does, the initial matching characters are replaced
20991 by the contents of &%escape_string%&, provided both are set. The value of
20992 &%check_string%& is a literal string, not a regular expression, and the case of
20993 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
20994 of &%check_string%& and &%escape_string%& are forced to values that implement
20995 the SMTP escaping protocol. Any settings made in the configuration file are
20999 .option command pipe string&!! unset
21000 This option need not be set when &(pipe)& is being used to deliver to pipes
21001 obtained directly from address redirections. In other cases, the option must be
21002 set, to provide a command to be run. It need not yield an absolute path (see
21003 the &%path%& option below). The command is split up into separate arguments by
21004 Exim, and each argument is separately expanded, as described in section
21005 &<<SECThowcommandrun>>& above.
21008 .option environment pipe string&!! unset
21009 .cindex "&(pipe)& transport" "environment for command"
21010 .cindex "environment for &(pipe)& transport"
21011 This option is used to add additional variables to the environment in which the
21012 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
21013 a string which is expanded, and then interpreted as a colon-separated list of
21014 environment settings of the form <&'name'&>=<&'value'&>.
21017 .option escape_string pipe string unset
21018 See &%check_string%& above.
21021 .option freeze_exec_fail pipe boolean false
21022 .cindex "exec failure"
21023 .cindex "failure of exec"
21024 .cindex "&(pipe)& transport" "failure of exec"
21025 Failure to exec the command in a pipe transport is by default treated like
21026 any other failure while running the command. However, if &%freeze_exec_fail%&
21027 is set, failure to exec is treated specially, and causes the message to be
21028 frozen, whatever the setting of &%ignore_status%&.
21031 .option ignore_status pipe boolean false
21032 If this option is true, the status returned by the subprocess that is set up to
21033 run the command is ignored, and Exim behaves as if zero had been returned.
21034 Otherwise, a non-zero status or termination by signal causes an error return
21035 from the transport unless the status value is one of those listed in
21036 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
21038 &*Note*&: This option does not apply to timeouts, which do not return a status.
21039 See the &%timeout_defer%& option for how timeouts are handled.
21041 .option log_defer_output pipe boolean false
21042 .cindex "&(pipe)& transport" "logging output"
21043 If this option is set, and the status returned by the command is
21044 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
21045 and any output was produced, the first line of it is written to the main log.
21048 .option log_fail_output pipe boolean false
21049 If this option is set, and the command returns any output, and also ends with a
21050 return code that is neither zero nor one of the return codes listed in
21051 &%temp_errors%& (that is, the delivery failed), the first line of output is
21052 written to the main log. This option and &%log_output%& are mutually exclusive.
21053 Only one of them may be set.
21057 .option log_output pipe boolean false
21058 If this option is set and the command returns any output, the first line of
21059 output is written to the main log, whatever the return code. This option and
21060 &%log_fail_output%& are mutually exclusive. Only one of them may be set.
21064 .option max_output pipe integer 20K
21065 This specifies the maximum amount of output that the command may produce on its
21066 standard output and standard error file combined. If the limit is exceeded, the
21067 process running the command is killed. This is intended as a safety measure to
21068 catch runaway processes. The limit is applied independently of the settings of
21069 the options that control what is done with such output (for example,
21070 &%return_output%&). Because of buffering effects, the amount of output may
21071 exceed the limit by a small amount before Exim notices.
21074 .option message_prefix pipe string&!! "see below"
21075 The string specified here is expanded and output at the start of every message.
21076 The default is unset if &%use_bsmtp%& is set. Otherwise it is
21079 From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
21083 .cindex "&%tmail%&"
21084 .cindex "&""From""& line"
21085 This is required by the commonly used &_/usr/bin/vacation_& program.
21086 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
21087 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
21092 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21093 &`\n`& to &`\r\n`& in &%message_prefix%&.
21096 .option message_suffix pipe string&!! "see below"
21097 The string specified here is expanded and output at the end of every message.
21098 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
21099 The suffix can be suppressed by setting
21103 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21104 &`\n`& to &`\r\n`& in &%message_suffix%&.
21107 .option path pipe string "see below"
21108 This option specifies the string that is set up in the PATH environment
21109 variable of the subprocess. The default is:
21113 If the &%command%& option does not yield an absolute path name, the command is
21114 sought in the PATH directories, in the usual way. &*Warning*&: This does not
21115 apply to a command specified as a transport filter.
21118 .option permit_coredump pipe boolean false
21119 Normally Exim inhibits core-dumps during delivery. If you have a need to get
21120 a core-dump of a pipe command, enable this command. This enables core-dumps
21121 during delivery and affects both the Exim binary and the pipe command run.
21122 It is recommended that this option remain off unless and until you have a need
21123 for it and that this only be enabled when needed, as the risk of excessive
21124 resource consumption can be quite high. Note also that Exim is typically
21125 installed as a setuid binary and most operating systems will inhibit coredumps
21126 of these by default, so further OS-specific action may be required.
21129 .option pipe_as_creator pipe boolean false
21130 .cindex "uid (user id)" "local delivery"
21131 If the generic &%user%& option is not set and this option is true, the delivery
21132 process is run under the uid that was in force when Exim was originally called
21133 to accept the message. If the group id is not otherwise set (via the generic
21134 &%group%& option), the gid that was in force when Exim was originally called to
21135 accept the message is used.
21138 .option restrict_to_path pipe boolean false
21139 When this option is set, any command name not listed in &%allow_commands%& must
21140 contain no slashes. The command is searched for only in the directories listed
21141 in the &%path%& option. This option is intended for use in the case when a pipe
21142 command has been generated from a user's &_.forward_& file. This is usually
21143 handled by a &(pipe)& transport called &%address_pipe%&.
21146 .option return_fail_output pipe boolean false
21147 If this option is true, and the command produced any output and ended with a
21148 return code other than zero or one of the codes listed in &%temp_errors%& (that
21149 is, the delivery failed), the output is returned in the bounce message.
21150 However, if the message has a null sender (that is, it is itself a bounce
21151 message), output from the command is discarded. This option and
21152 &%return_output%& are mutually exclusive. Only one of them may be set.
21156 .option return_output pipe boolean false
21157 If this option is true, and the command produced any output, the delivery is
21158 deemed to have failed whatever the return code from the command, and the output
21159 is returned in the bounce message. Otherwise, the output is just discarded.
21160 However, if the message has a null sender (that is, it is a bounce message),
21161 output from the command is always discarded, whatever the setting of this
21162 option. This option and &%return_fail_output%& are mutually exclusive. Only one
21163 of them may be set.
21167 .option temp_errors pipe "string list" "see below"
21168 .cindex "&(pipe)& transport" "temporary failure"
21169 This option contains either a colon-separated list of numbers, or a single
21170 asterisk. If &%ignore_status%& is false
21171 and &%return_output%& is not set,
21172 and the command exits with a non-zero return code, the failure is treated as
21173 temporary and the delivery is deferred if the return code matches one of the
21174 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
21175 codes are treated as permanent errors. The default setting contains the codes
21176 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
21177 compiled on a system that does not define these macros, it assumes values of 75
21178 and 73, respectively.
21181 .option timeout pipe time 1h
21182 If the command fails to complete within this time, it is killed. This normally
21183 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
21184 specifies no timeout. In order to ensure that any subprocesses created by the
21185 command are also killed, Exim makes the initial process a process group leader,
21186 and kills the whole process group on a timeout. However, this can be defeated
21187 if one of the processes starts a new process group.
21189 .option timeout_defer pipe boolean false
21190 A timeout in a &(pipe)& transport, either in the command that the transport
21191 runs, or in a transport filter that is associated with it, is by default
21192 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
21193 is set true, both kinds of timeout become temporary errors, causing the
21194 delivery to be deferred.
21196 .option umask pipe "octal integer" 022
21197 This specifies the umask setting for the subprocess that runs the command.
21200 .option use_bsmtp pipe boolean false
21201 .cindex "envelope sender"
21202 If this option is set true, the &(pipe)& transport writes messages in &"batch
21203 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
21204 commands. If you want to include a leading HELO command with such messages,
21205 you can do so by setting the &%message_prefix%& option. See section
21206 &<<SECTbatchSMTP>>& for details of batch SMTP.
21208 .option use_classresources pipe boolean false
21209 .cindex "class resources (BSD)"
21210 This option is available only when Exim is running on FreeBSD, NetBSD, or
21211 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
21212 resource limits when a &(pipe)& transport is run to perform a delivery. The
21213 limits for the uid under which the pipe is to run are obtained from the login
21217 .option use_crlf pipe boolean false
21218 .cindex "carriage return"
21220 This option causes lines to be terminated with the two-character CRLF sequence
21221 (carriage return, linefeed) instead of just a linefeed character. In the case
21222 of batched SMTP, the byte sequence written to the pipe is then an exact image
21223 of what would be sent down a real SMTP connection.
21225 The contents of the &%message_prefix%& and &%message_suffix%& options are
21226 written verbatim, so must contain their own carriage return characters if these
21227 are needed. When &%use_bsmtp%& is not set, the default values for both
21228 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
21229 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
21232 .option use_shell pipe boolean false
21233 .vindex "&$pipe_addresses$&"
21234 If this option is set, it causes the command to be passed to &_/bin/sh_&
21235 instead of being run directly from the transport, as described in section
21236 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
21237 where the command is expected to be run under a shell and cannot easily be
21238 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
21239 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
21240 command is expanded as a single string, and handed to &_/bin/sh_& as data for
21245 .section "Using an external local delivery agent" "SECID143"
21246 .cindex "local delivery" "using an external agent"
21247 .cindex "&'procmail'&"
21248 .cindex "external local delivery"
21249 .cindex "delivery" "&'procmail'&"
21250 .cindex "delivery" "by external agent"
21251 The &(pipe)& transport can be used to pass all messages that require local
21252 delivery to a separate local delivery agent such as &%procmail%&. When doing
21253 this, care must be taken to ensure that the pipe is run under an appropriate
21254 uid and gid. In some configurations one wants this to be a uid that is trusted
21255 by the delivery agent to supply the correct sender of the message. It may be
21256 necessary to recompile or reconfigure the delivery agent so that it trusts an
21257 appropriate user. The following is an example transport and router
21258 configuration for &%procmail%&:
21263 command = /usr/local/bin/procmail -d $local_part
21267 check_string = "From "
21268 escape_string = ">From "
21277 transport = procmail_pipe
21279 In this example, the pipe is run as the local user, but with the group set to
21280 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
21281 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
21282 user to supply a correct sender address. If you do not specify either a
21283 &%group%& or a &%user%& option, the pipe command is run as the local user. The
21284 home directory is the user's home directory by default.
21286 &*Note*&: The command that the pipe transport runs does &'not'& begin with
21290 as shown in some &%procmail%& documentation, because Exim does not by default
21291 use a shell to run pipe commands.
21294 The next example shows a transport and a router for a system where local
21295 deliveries are handled by the Cyrus IMAP server.
21298 local_delivery_cyrus:
21300 command = /usr/cyrus/bin/deliver \
21301 -m ${substr_1:$local_part_suffix} -- $local_part
21313 local_part_suffix = .*
21314 transport = local_delivery_cyrus
21316 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
21317 &%return_output%& to cause any text written by Cyrus to be returned to the
21319 .ecindex IIDpiptra1
21320 .ecindex IIDpiptra2
21323 . ////////////////////////////////////////////////////////////////////////////
21324 . ////////////////////////////////////////////////////////////////////////////
21326 .chapter "The smtp transport" "CHAPsmtptrans"
21327 .scindex IIDsmttra1 "transports" "&(smtp)&"
21328 .scindex IIDsmttra2 "&(smtp)& transport"
21329 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
21330 or LMTP protocol. The list of hosts to try can either be taken from the address
21331 that is being processed (having been set up by the router), or specified
21332 explicitly for the transport. Timeout and retry processing (see chapter
21333 &<<CHAPretry>>&) is applied to each IP address independently.
21336 .section "Multiple messages on a single connection" "SECID144"
21337 The sending of multiple messages over a single TCP/IP connection can arise in
21341 If a message contains more than &%max_rcpt%& (see below) addresses that are
21342 routed to the same host, more than one copy of the message has to be sent to
21343 that host. In this situation, multiple copies may be sent in a single run of
21344 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
21345 does when it has too many addresses to send in one message also depends on the
21346 value of the global &%remote_max_parallel%& option. Details are given in
21347 section &<<SECToutSMTPTCP>>&.)
21349 .cindex "hints database" "remembering routing"
21350 When a message has been successfully delivered over a TCP/IP connection, Exim
21351 looks in its hints database to see if there are any other messages awaiting a
21352 connection to the same host. If there are, a new delivery process is started
21353 for one of them, and the current TCP/IP connection is passed on to it. The new
21354 process may in turn send multiple copies and possibly create yet another
21359 For each copy sent over the same TCP/IP connection, a sequence counter is
21360 incremented, and if it ever gets to the value of &%connection_max_messages%&,
21361 no further messages are sent over that connection.
21365 .section "Use of the $host and $host_address variables" "SECID145"
21367 .vindex "&$host_address$&"
21368 At the start of a run of the &(smtp)& transport, the values of &$host$& and
21369 &$host_address$& are the name and IP address of the first host on the host list
21370 passed by the router. However, when the transport is about to connect to a
21371 specific host, and while it is connected to that host, &$host$& and
21372 &$host_address$& are set to the values for that host. These are the values
21373 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
21374 &%serialize_hosts%&, and the various TLS options are expanded.
21377 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
21378 .vindex &$tls_cipher$&
21379 .vindex &$tls_peerdn$&
21380 At the start of a run of the &(smtp)& transport, the values of &$tls_cipher$&
21381 and &$tls_peerdn$& are the values that were set when the message was received.
21382 These are the values that are used for options that are expanded before any
21383 SMTP connections are made. Just before each connection is made, these two
21384 variables are emptied. If TLS is subsequently started, they are set to the
21385 appropriate values for the outgoing connection, and these are the values that
21386 are in force when any authenticators are run and when the
21387 &%authenticated_sender%& option is expanded.
21390 .section "Private options for smtp" "SECID146"
21391 .cindex "options" "&(smtp)& transport"
21392 The private options of the &(smtp)& transport are as follows:
21395 .option address_retry_include_sender smtp boolean true
21396 .cindex "4&'xx'& responses" "retrying after"
21397 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
21398 is the combination of sender and recipient that is delayed in subsequent queue
21399 runs until the retry time is reached. You can delay the recipient without
21400 reference to the sender (which is what earlier versions of Exim did), by
21401 setting &%address_retry_include_sender%& false. However, this can lead to
21402 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
21404 .option allow_localhost smtp boolean false
21405 .cindex "local host" "sending to"
21406 .cindex "fallback" "hosts specified on transport"
21407 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
21408 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
21409 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
21410 the delivery anyway. This should be used only in special cases when the
21411 configuration ensures that no looping will result (for example, a differently
21412 configured Exim is listening on the port to which the message is sent).
21415 .option authenticated_sender smtp string&!! unset
21417 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
21418 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
21419 overriding any existing authenticated sender value. If the string expansion is
21420 forced to fail, the option is ignored. Other expansion failures cause delivery
21421 to be deferred. If the result of expansion is an empty string, that is also
21424 The expansion happens after the outgoing connection has been made and TLS
21425 started, if required. This means that the &$host$&, &$host_address$&,
21426 &$tls_cipher$&, and &$tls_peerdn$& variables are set according to the
21427 particular connection.
21429 If the SMTP session is not authenticated, the expansion of
21430 &%authenticated_sender%& still happens (and can cause the delivery to be
21431 deferred if it fails), but no AUTH= item is added to MAIL commands
21432 unless &%authenticated_sender_force%& is true.
21434 This option allows you to use the &(smtp)& transport in LMTP mode to
21435 deliver mail to Cyrus IMAP and provide the proper local part as the
21436 &"authenticated sender"&, via a setting such as:
21438 authenticated_sender = $local_part
21440 This removes the need for IMAP subfolders to be assigned special ACLs to
21441 allow direct delivery to those subfolders.
21443 Because of expected uses such as that just described for Cyrus (when no
21444 domain is involved), there is no checking on the syntax of the provided
21448 .option authenticated_sender_force smtp boolean false
21449 If this option is set true, the &%authenticated_sender%& option's value
21450 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
21451 authenticated as a client.
21454 .option command_timeout smtp time 5m
21455 This sets a timeout for receiving a response to an SMTP command that has been
21456 sent out. It is also used when waiting for the initial banner line from the
21457 remote host. Its value must not be zero.
21460 .option connect_timeout smtp time 5m
21461 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
21462 to a remote host. A setting of zero allows the system timeout (typically
21463 several minutes) to act. To have any effect, the value of this option must be
21464 less than the system timeout. However, it has been observed that on some
21465 systems there is no system timeout, which is why the default value for this
21466 option is 5 minutes, a value recommended by RFC 1123.
21469 .option connection_max_messages smtp integer 500
21470 .cindex "SMTP" "passed connection"
21471 .cindex "SMTP" "multiple deliveries"
21472 .cindex "multiple SMTP deliveries"
21473 This controls the maximum number of separate message deliveries that are sent
21474 over a single TCP/IP connection. If the value is zero, there is no limit.
21475 For testing purposes, this value can be overridden by the &%-oB%& command line
21479 .option data_timeout smtp time 5m
21480 This sets a timeout for the transmission of each block in the data portion of
21481 the message. As a result, the overall timeout for a message depends on the size
21482 of the message. Its value must not be zero. See also &%final_timeout%&.
21485 .option delay_after_cutoff smtp boolean true
21486 This option controls what happens when all remote IP addresses for a given
21487 domain have been inaccessible for so long that they have passed their retry
21490 In the default state, if the next retry time has not been reached for any of
21491 them, the address is bounced without trying any deliveries. In other words,
21492 Exim delays retrying an IP address after the final cutoff time until a new
21493 retry time is reached, and can therefore bounce an address without ever trying
21494 a delivery, when machines have been down for a long time. Some people are
21495 unhappy at this prospect, so...
21497 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
21498 addresses are past their final cutoff time, Exim tries to deliver to those
21499 IP addresses that have not been tried since the message arrived. If there are
21500 none, of if they all fail, the address is bounced. In other words, it does not
21501 delay when a new message arrives, but immediately tries those expired IP
21502 addresses that haven't been tried since the message arrived. If there is a
21503 continuous stream of messages for the dead hosts, unsetting
21504 &%delay_after_cutoff%& means that there will be many more attempts to deliver
21508 .option dns_qualify_single smtp boolean true
21509 If the &%hosts%& or &%fallback_hosts%& option is being used,
21510 and the &%gethostbyname%& option is false,
21511 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
21512 in chapter &<<CHAPdnslookup>>& for more details.
21515 .option dns_search_parents smtp boolean false
21516 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
21517 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
21518 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
21523 .option fallback_hosts smtp "string list" unset
21524 .cindex "fallback" "hosts specified on transport"
21525 String expansion is not applied to this option. The argument must be a
21526 colon-separated list of host names or IP addresses, optionally also including
21527 port numbers, though the separator can be changed, as described in section
21528 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
21529 item in a &%route_list%& setting for the &(manualroute)& router, as described
21530 in section &<<SECTformatonehostitem>>&.
21532 Fallback hosts can also be specified on routers, which associate them with the
21533 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
21534 &%fallback_hosts%& specified on the transport is used only if the address does
21535 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
21536 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
21537 However, &%hosts_randomize%& does apply to fallback host lists.
21539 If Exim is unable to deliver to any of the hosts for a particular address, and
21540 the errors are not permanent rejections, the address is put on a separate
21541 transport queue with its host list replaced by the fallback hosts, unless the
21542 address was routed via MX records and the current host was in the original MX
21543 list. In that situation, the fallback host list is not used.
21545 Once normal deliveries are complete, the fallback queue is delivered by
21546 re-running the same transports with the new host lists. If several failing
21547 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
21548 copy of the message is sent.
21550 The resolution of the host names on the fallback list is controlled by the
21551 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
21552 both to cases when the host list comes with the address and when it is taken
21553 from &%hosts%&. This option provides a &"use a smart host only if delivery
21557 .option final_timeout smtp time 10m
21558 This is the timeout that applies while waiting for the response to the final
21559 line containing just &"."& that terminates a message. Its value must not be
21562 .option gethostbyname smtp boolean false
21563 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
21564 being used, names are looked up using &[gethostbyname()]&
21565 (or &[getipnodebyname()]& when available)
21566 instead of using the DNS. Of course, that function may in fact use the DNS, but
21567 it may also consult other sources of information such as &_/etc/hosts_&.
21569 .option gnutls_require_kx smtp string unset
21570 This option controls the key exchange mechanisms when GnuTLS is used in an Exim
21571 client. For details, see section &<<SECTreqciphgnu>>&.
21573 .option gnutls_require_mac smtp string unset
21574 This option controls the MAC algorithms when GnuTLS is used in an Exim
21575 client. For details, see section &<<SECTreqciphgnu>>&.
21577 .option gnutls_require_protocols smtp string unset
21578 This option controls the protocols when GnuTLS is used in an Exim
21579 client. For details, see section &<<SECTreqciphgnu>>&.
21581 .option gnutls_compat_mode smtp boolean unset
21582 This option controls whether GnuTLS is used in compatibility mode in an Exim
21583 server. This reduces security slightly, but improves interworking with older
21584 implementations of TLS.
21586 .option helo_data smtp string&!! "see below"
21587 .cindex "HELO" "argument, setting"
21588 .cindex "EHLO" "argument, setting"
21589 .cindex "LHLO argument setting"
21590 The value of this option is expanded after a connection to a another host has
21591 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
21592 command that starts the outgoing SMTP or LMTP session. The default value of the
21597 During the expansion, the variables &$host$& and &$host_address$& are set to
21598 the identity of the remote host, and the variables &$sending_ip_address$& and
21599 &$sending_port$& are set to the local IP address and port number that are being
21600 used. These variables can be used to generate different values for different
21601 servers or different local IP addresses. For example, if you want the string
21602 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
21603 interface address, you could use this:
21605 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
21606 {$primary_hostname}}
21608 The use of &%helo_data%& applies both to sending messages and when doing
21611 .option hosts smtp "string list&!!" unset
21612 Hosts are associated with an address by a router such as &(dnslookup)&, which
21613 finds the hosts by looking up the address domain in the DNS, or by
21614 &(manualroute)&, which has lists of hosts in its configuration. However,
21615 email addresses can be passed to the &(smtp)& transport by any router, and not
21616 all of them can provide an associated list of hosts.
21618 The &%hosts%& option specifies a list of hosts to be used if the address being
21619 processed does not have any hosts associated with it. The hosts specified by
21620 &%hosts%& are also used, whether or not the address has its own hosts, if
21621 &%hosts_override%& is set.
21623 The string is first expanded, before being interpreted as a colon-separated
21624 list of host names or IP addresses, possibly including port numbers. The
21625 separator may be changed to something other than colon, as described in section
21626 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
21627 item in a &%route_list%& setting for the &(manualroute)& router, as described
21628 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
21629 of the &(manualroute)& router is not available here.
21631 If the expansion fails, delivery is deferred. Unless the failure was caused by
21632 the inability to complete a lookup, the error is logged to the panic log as
21633 well as the main log. Host names are looked up either by searching directly for
21634 address records in the DNS or by calling &[gethostbyname()]& (or
21635 &[getipnodebyname()]& when available), depending on the setting of the
21636 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
21637 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
21640 During delivery, the hosts are tried in order, subject to their retry status,
21641 unless &%hosts_randomize%& is set.
21644 .option hosts_avoid_esmtp smtp "host list&!!" unset
21645 .cindex "ESMTP, avoiding use of"
21646 .cindex "HELO" "forcing use of"
21647 .cindex "EHLO" "avoiding use of"
21648 .cindex "PIPELINING" "avoiding the use of"
21649 This option is for use with broken hosts that announce ESMTP facilities (for
21650 example, PIPELINING) and then fail to implement them properly. When a host
21651 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
21652 start of the SMTP session. This means that it cannot use any of the ESMTP
21653 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
21656 .option hosts_avoid_pipelining smtp "host list&!!" unset
21657 .cindex "PIPELINING" "avoiding the use of"
21658 Exim will not use the SMTP PIPELINING extension when delivering to any host
21659 that matches this list, even if the server host advertises PIPELINING support.
21662 .option hosts_avoid_tls smtp "host list&!!" unset
21663 .cindex "TLS" "avoiding for certain hosts"
21664 Exim will not try to start a TLS session when delivering to any host that
21665 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
21668 .option hosts_max_try smtp integer 5
21669 .cindex "host" "maximum number to try"
21670 .cindex "limit" "number of hosts tried"
21671 .cindex "limit" "number of MX tried"
21672 .cindex "MX record" "maximum tried"
21673 This option limits the number of IP addresses that are tried for any one
21674 delivery in cases where there are temporary delivery errors. Section
21675 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
21678 .option hosts_max_try_hardlimit smtp integer 50
21679 This is an additional check on the maximum number of IP addresses that Exim
21680 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
21685 .option hosts_nopass_tls smtp "host list&!!" unset
21686 .cindex "TLS" "passing connection"
21687 .cindex "multiple SMTP deliveries"
21688 .cindex "TLS" "multiple message deliveries"
21689 For any host that matches this list, a connection on which a TLS session has
21690 been started will not be passed to a new delivery process for sending another
21691 message on the same connection. See section &<<SECTmulmessam>>& for an
21692 explanation of when this might be needed.
21695 .option hosts_override smtp boolean false
21696 If this option is set and the &%hosts%& option is also set, any hosts that are
21697 attached to the address are ignored, and instead the hosts specified by the
21698 &%hosts%& option are always used. This option does not apply to
21699 &%fallback_hosts%&.
21702 .option hosts_randomize smtp boolean false
21703 .cindex "randomized host list"
21704 .cindex "host" "list of; randomized"
21705 .cindex "fallback" "randomized hosts"
21706 If this option is set, and either the list of hosts is taken from the
21707 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
21708 were not obtained from MX records (this includes fallback hosts from the
21709 router), and were not randomized by the router, the order of trying the hosts
21710 is randomized each time the transport runs. Randomizing the order of a host
21711 list can be used to do crude load sharing.
21713 When &%hosts_randomize%& is true, a host list may be split into groups whose
21714 order is separately randomized. This makes it possible to set up MX-like
21715 behaviour. The boundaries between groups are indicated by an item that is just
21716 &`+`& in the host list. For example:
21718 hosts = host1:host2:host3:+:host4:host5
21720 The order of the first three hosts and the order of the last two hosts is
21721 randomized for each use, but the first three always end up before the last two.
21722 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
21724 .option hosts_require_auth smtp "host list&!!" unset
21725 .cindex "authentication" "required by client"
21726 This option provides a list of servers for which authentication must succeed
21727 before Exim will try to transfer a message. If authentication fails for
21728 servers which are not in this list, Exim tries to send unauthenticated. If
21729 authentication fails for one of these servers, delivery is deferred. This
21730 temporary error is detectable in the retry rules, so it can be turned into a
21731 hard failure if required. See also &%hosts_try_auth%&, and chapter
21732 &<<CHAPSMTPAUTH>>& for details of authentication.
21735 .option hosts_require_tls smtp "host list&!!" unset
21736 .cindex "TLS" "requiring for certain servers"
21737 Exim will insist on using a TLS session when delivering to any host that
21738 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
21739 &*Note*&: This option affects outgoing mail only. To insist on TLS for
21740 incoming messages, use an appropriate ACL.
21742 .option hosts_try_auth smtp "host list&!!" unset
21743 .cindex "authentication" "optional in client"
21744 This option provides a list of servers to which, provided they announce
21745 authentication support, Exim will attempt to authenticate as a client when it
21746 connects. If authentication fails, Exim will try to transfer the message
21747 unauthenticated. See also &%hosts_require_auth%&, and chapter
21748 &<<CHAPSMTPAUTH>>& for details of authentication.
21750 .option interface smtp "string list&!!" unset
21751 .cindex "bind IP address"
21752 .cindex "IP address" "binding"
21754 .vindex "&$host_address$&"
21755 This option specifies which interface to bind to when making an outgoing SMTP
21756 call. The value is an IP address, not an interface name such as
21757 &`eth0`&. Do not confuse this with the interface address that was used when a
21758 message was received, which is in &$received_ip_address$&, formerly known as
21759 &$interface_address$&. The name was changed to minimize confusion with the
21760 outgoing interface address. There is no variable that contains an outgoing
21761 interface address because, unless it is set by this option, its value is
21764 During the expansion of the &%interface%& option the variables &$host$& and
21765 &$host_address$& refer to the host to which a connection is about to be made
21766 during the expansion of the string. Forced expansion failure, or an empty
21767 string result causes the option to be ignored. Otherwise, after expansion, the
21768 string must be a list of IP addresses, colon-separated by default, but the
21769 separator can be changed in the usual way. For example:
21771 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
21773 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
21774 connection. If none of them are the correct type, the option is ignored. If
21775 &%interface%& is not set, or is ignored, the system's IP functions choose which
21776 interface to use if the host has more than one.
21779 .option keepalive smtp boolean true
21780 .cindex "keepalive" "on outgoing connection"
21781 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
21782 connections. When set, it causes the kernel to probe idle connections
21783 periodically, by sending packets with &"old"& sequence numbers. The other end
21784 of the connection should send a acknowledgment if the connection is still okay
21785 or a reset if the connection has been aborted. The reason for doing this is
21786 that it has the beneficial effect of freeing up certain types of connection
21787 that can get stuck when the remote host is disconnected without tidying up the
21788 TCP/IP call properly. The keepalive mechanism takes several hours to detect
21792 .option lmtp_ignore_quota smtp boolean false
21793 .cindex "LMTP" "ignoring quota errors"
21794 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
21795 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
21796 has advertised support for IGNOREQUOTA in its response to the LHLO command.
21798 .option max_rcpt smtp integer 100
21799 .cindex "RCPT" "maximum number of outgoing"
21800 This option limits the number of RCPT commands that are sent in a single
21801 SMTP message transaction. Each set of addresses is treated independently, and
21802 so can cause parallel connections to the same host if &%remote_max_parallel%&
21806 .option multi_domain smtp boolean true
21807 .vindex "&$domain$&"
21808 When this option is set, the &(smtp)& transport can handle a number of
21809 addresses containing a mixture of different domains provided they all resolve
21810 to the same list of hosts. Turning the option off restricts the transport to
21811 handling only one domain at a time. This is useful if you want to use
21812 &$domain$& in an expansion for the transport, because it is set only when there
21813 is a single domain involved in a remote delivery.
21816 .option port smtp string&!! "see below"
21817 .cindex "port" "sending TCP/IP"
21818 .cindex "TCP/IP" "setting outgoing port"
21819 This option specifies the TCP/IP port on the server to which Exim connects.
21820 &*Note:*& Do not confuse this with the port that was used when a message was
21821 received, which is in &$received_port$&, formerly known as &$interface_port$&.
21822 The name was changed to minimize confusion with the outgoing port. There is no
21823 variable that contains an outgoing port.
21825 If the value of this option begins with a digit it is taken as a port number;
21826 otherwise it is looked up using &[getservbyname()]&. The default value is
21827 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
21828 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
21833 .option protocol smtp string smtp
21834 .cindex "LMTP" "over TCP/IP"
21835 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
21836 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
21837 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
21838 deliveries into closed message stores. Exim also has support for running LMTP
21839 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
21842 .option retry_include_ip_address smtp boolean true
21843 Exim normally includes both the host name and the IP address in the key it
21844 constructs for indexing retry data after a temporary delivery failure. This
21845 means that when one of several IP addresses for a host is failing, it gets
21846 tried periodically (controlled by the retry rules), but use of the other IP
21847 addresses is not affected.
21849 However, in some dialup environments hosts are assigned a different IP address
21850 each time they connect. In this situation the use of the IP address as part of
21851 the retry key leads to undesirable behaviour. Setting this option false causes
21852 Exim to use only the host name. This should normally be done on a separate
21853 instance of the &(smtp)& transport, set up specially to handle the dialup
21857 .option serialize_hosts smtp "host list&!!" unset
21858 .cindex "serializing connections"
21859 .cindex "host" "serializing connections"
21860 Because Exim operates in a distributed manner, if several messages for the same
21861 host arrive at around the same time, more than one simultaneous connection to
21862 the remote host can occur. This is not usually a problem except when there is a
21863 slow link between the hosts. In that situation it may be helpful to restrict
21864 Exim to one connection at a time. This can be done by setting
21865 &%serialize_hosts%& to match the relevant hosts.
21867 .cindex "hints database" "serializing deliveries to a host"
21868 Exim implements serialization by means of a hints database in which a record is
21869 written whenever a process connects to one of the restricted hosts. The record
21870 is deleted when the connection is completed. Obviously there is scope for
21871 records to get left lying around if there is a system or program crash. To
21872 guard against this, Exim ignores any records that are more than six hours old.
21874 If you set up this kind of serialization, you should also arrange to delete the
21875 relevant hints database whenever your system reboots. The names of the files
21876 start with &_misc_& and they are kept in the &_spool/db_& directory. There
21877 may be one or two files, depending on the type of DBM in use. The same files
21878 are used for ETRN serialization.
21881 .option size_addition smtp integer 1024
21882 .cindex "SMTP" "SIZE"
21883 .cindex "message" "size issue for transport filter"
21884 .cindex "size" "of message"
21885 .cindex "transport" "filter"
21886 .cindex "filter" "transport filter"
21887 If a remote SMTP server indicates that it supports the SIZE option of the
21888 MAIL command, Exim uses this to pass over the message size at the start of
21889 an SMTP transaction. It adds the value of &%size_addition%& to the value it
21890 sends, to allow for headers and other text that may be added during delivery by
21891 configuration options or in a transport filter. It may be necessary to increase
21892 this if a lot of text is added to messages.
21894 Alternatively, if the value of &%size_addition%& is set negative, it disables
21895 the use of the SIZE option altogether.
21898 .option tls_certificate smtp string&!! unset
21899 .cindex "TLS" "client certificate, location of"
21900 .cindex "certificate" "client, location of"
21902 .vindex "&$host_address$&"
21903 The value of this option must be the absolute path to a file which contains the
21904 client's certificate, for possible use when sending a message over an encrypted
21905 connection. The values of &$host$& and &$host_address$& are set to the name and
21906 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
21909 &*Note*&: This option must be set if you want Exim to be able to use a TLS
21910 certificate when sending messages as a client. The global option of the same
21911 name specifies the certificate for Exim as a server; it is not automatically
21912 assumed that the same certificate should be used when Exim is operating as a
21916 .option tls_crl smtp string&!! unset
21917 .cindex "TLS" "client certificate revocation list"
21918 .cindex "certificate" "revocation list for client"
21919 This option specifies a certificate revocation list. The expanded value must
21920 be the name of a file that contains a CRL in PEM format.
21923 .option tls_privatekey smtp string&!! unset
21924 .cindex "TLS" "client private key, location of"
21926 .vindex "&$host_address$&"
21927 The value of this option must be the absolute path to a file which contains the
21928 client's private key. This is used when sending a message over an encrypted
21929 connection using a client certificate. The values of &$host$& and
21930 &$host_address$& are set to the name and address of the server during the
21931 expansion. If this option is unset, or the expansion is forced to fail, or the
21932 result is an empty string, the private key is assumed to be in the same file as
21933 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
21936 .option tls_require_ciphers smtp string&!! unset
21937 .cindex "TLS" "requiring specific ciphers"
21938 .cindex "cipher" "requiring specific"
21940 .vindex "&$host_address$&"
21941 The value of this option must be a list of permitted cipher suites, for use
21942 when setting up an outgoing encrypted connection. (There is a global option of
21943 the same name for controlling incoming connections.) The values of &$host$& and
21944 &$host_address$& are set to the name and address of the server during the
21945 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
21946 is used in different ways by OpenSSL and GnuTLS (see sections
21947 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
21948 ciphers is a preference order.
21952 .option tls_tempfail_tryclear smtp boolean true
21953 .cindex "4&'xx'& responses" "to STARTTLS"
21954 When the server host is not in &%hosts_require_tls%&, and there is a problem in
21955 setting up a TLS session, this option determines whether or not Exim should try
21956 to deliver the message unencrypted. If it is set false, delivery to the
21957 current host is deferred; if there are other hosts, they are tried. If this
21958 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
21959 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
21960 TLS negotiation fails, Exim closes the current connection (because it is in an
21961 unknown state), opens a new one to the same host, and then tries the delivery
21965 .option tls_verify_certificates smtp string&!! unset
21966 .cindex "TLS" "server certificate verification"
21967 .cindex "certificate" "verification of server"
21969 .vindex "&$host_address$&"
21970 The value of this option must be the absolute path to a file containing
21971 permitted server certificates, for use when setting up an encrypted connection.
21972 Alternatively, if you are using OpenSSL, you can set
21973 &%tls_verify_certificates%& to the name of a directory containing certificate
21974 files. This does not work with GnuTLS; the option must be set to the name of a
21975 single file if you are using GnuTLS. The values of &$host$& and
21976 &$host_address$& are set to the name and address of the server during the
21977 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
21982 .section "How the limits for the number of hosts to try are used" &&&
21984 .cindex "host" "maximum number to try"
21985 .cindex "limit" "hosts; maximum number tried"
21986 There are two options that are concerned with the number of hosts that are
21987 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
21988 &%hosts_max_try_hardlimit%&.
21991 The &%hosts_max_try%& option limits the number of hosts that are tried
21992 for a single delivery. However, despite the term &"host"& in its name, the
21993 option actually applies to each IP address independently. In other words, a
21994 multihomed host is treated as several independent hosts, just as it is for
21997 Many of the larger ISPs have multiple MX records which often point to
21998 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
21999 created as a result of routing one of these domains.
22001 Trying every single IP address on such a long list does not seem sensible; if
22002 several at the top of the list fail, it is reasonable to assume there is some
22003 problem that is likely to affect all of them. Roughly speaking, the value of
22004 &%hosts_max_try%& is the maximum number that are tried before deferring the
22005 delivery. However, the logic cannot be quite that simple.
22007 Firstly, IP addresses that are skipped because their retry times have not
22008 arrived do not count, and in addition, addresses that are past their retry
22009 limits are also not counted, even when they are tried. This means that when
22010 some IP addresses are past their retry limits, more than the value of
22011 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
22012 that all IP addresses are considered before timing out an email address (but
22013 see below for an exception).
22015 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
22016 list to see if there is a subsequent host with a different (higher valued) MX.
22017 If there is, that host is considered next, and the current IP address is used
22018 but not counted. This behaviour helps in the case of a domain with a retry rule
22019 that hardly ever delays any hosts, as is now explained:
22021 Consider the case of a long list of hosts with one MX value, and a few with a
22022 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
22023 hosts at the top of the list are tried at first. With the default retry rule,
22024 which specifies increasing retry times, the higher MX hosts are eventually
22025 tried when those at the top of the list are skipped because they have not
22026 reached their retry times.
22028 However, it is common practice to put a fixed short retry time on domains for
22029 large ISPs, on the grounds that their servers are rarely down for very long.
22030 Unfortunately, these are exactly the domains that tend to resolve to long lists
22031 of hosts. The short retry time means that the lowest MX hosts are tried every
22032 time. The attempts may be in a different order because of random sorting, but
22033 without the special MX check, the higher MX hosts would never be tried until
22034 all the lower MX hosts had timed out (which might be several days), because
22035 there are always some lower MX hosts that have reached their retry times. With
22036 the special check, Exim considers at least one IP address from each MX value at
22037 every delivery attempt, even if the &%hosts_max_try%& limit has already been
22040 The above logic means that &%hosts_max_try%& is not a hard limit, and in
22041 particular, Exim normally eventually tries all the IP addresses before timing
22042 out an email address. When &%hosts_max_try%& was implemented, this seemed a
22043 reasonable thing to do. Recently, however, some lunatic DNS configurations have
22044 been set up with hundreds of IP addresses for some domains. It can
22045 take a very long time indeed for an address to time out in these cases.
22047 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
22048 Exim never tries more than this number of IP addresses; if it hits this limit
22049 and they are all timed out, the email address is bounced, even though not all
22050 possible IP addresses have been tried.
22051 .ecindex IIDsmttra1
22052 .ecindex IIDsmttra2
22058 . ////////////////////////////////////////////////////////////////////////////
22059 . ////////////////////////////////////////////////////////////////////////////
22061 .chapter "Address rewriting" "CHAPrewrite"
22062 .scindex IIDaddrew "rewriting" "addresses"
22063 There are some circumstances in which Exim automatically rewrites domains in
22064 addresses. The two most common are when an address is given without a domain
22065 (referred to as an &"unqualified address"&) or when an address contains an
22066 abbreviated domain that is expanded by DNS lookup.
22068 Unqualified envelope addresses are accepted only for locally submitted
22069 messages, or for messages that are received from hosts matching
22070 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
22071 appropriate. Unqualified addresses in header lines are qualified if they are in
22072 locally submitted messages, or messages from hosts that are permitted to send
22073 unqualified envelope addresses. Otherwise, unqualified addresses in header
22074 lines are neither qualified nor rewritten.
22076 One situation in which Exim does &'not'& automatically rewrite a domain is
22077 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
22078 such a domain should be rewritten using the &"canonical"& name, and some MTAs
22079 do this. The new RFCs do not contain this suggestion.
22082 .section "Explicitly configured address rewriting" "SECID147"
22083 This chapter describes the rewriting rules that can be used in the
22084 main rewrite section of the configuration file, and also in the generic
22085 &%headers_rewrite%& option that can be set on any transport.
22087 Some people believe that configured address rewriting is a Mortal Sin.
22088 Others believe that life is not possible without it. Exim provides the
22089 facility; you do not have to use it.
22091 The main rewriting rules that appear in the &"rewrite"& section of the
22092 configuration file are applied to addresses in incoming messages, both envelope
22093 addresses and addresses in header lines. Each rule specifies the types of
22094 address to which it applies.
22096 Whether or not addresses in header lines are rewritten depends on the origin of
22097 the headers and the type of rewriting. Global rewriting, that is, rewriting
22098 rules from the rewrite section of the configuration file, is applied only to
22099 those headers that were received with the message. Header lines that are added
22100 by ACLs or by a system filter or by individual routers or transports (which
22101 are specific to individual recipient addresses) are not rewritten by the global
22104 Rewriting at transport time, by means of the &%headers_rewrite%& option,
22105 applies all headers except those added by routers and transports. That is, as
22106 well as the headers that were received with the message, it also applies to
22107 headers that were added by an ACL or a system filter.
22110 In general, rewriting addresses from your own system or domain has some
22111 legitimacy. Rewriting other addresses should be done only with great care and
22112 in special circumstances. The author of Exim believes that rewriting should be
22113 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
22114 Although it can sometimes be used as a routing tool, this is very strongly
22117 There are two commonly encountered circumstances where rewriting is used, as
22118 illustrated by these examples:
22121 The company whose domain is &'hitch.fict.example'& has a number of hosts that
22122 exchange mail with each other behind a firewall, but there is only a single
22123 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
22124 &'hitch.fict.example'& when sending mail off-site.
22126 A host rewrites the local parts of its own users so that, for example,
22127 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
22132 .section "When does rewriting happen?" "SECID148"
22133 .cindex "rewriting" "timing of"
22134 .cindex "&ACL;" "rewriting addresses in"
22135 Configured address rewriting can take place at several different stages of a
22136 message's processing.
22138 .vindex "&$sender_address$&"
22139 At the start of an ACL for MAIL, the sender address may have been rewritten
22140 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
22141 ordinary rewrite rules have yet been applied. If, however, the sender address
22142 is verified in the ACL, it is rewritten before verification, and remains
22143 rewritten thereafter. The subsequent value of &$sender_address$& is the
22144 rewritten address. This also applies if sender verification happens in a
22145 RCPT ACL. Otherwise, when the sender address is not verified, it is
22146 rewritten as soon as a message's header lines have been received.
22148 .vindex "&$domain$&"
22149 .vindex "&$local_part$&"
22150 Similarly, at the start of an ACL for RCPT, the current recipient's address
22151 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
22152 rewrite rules have yet been applied to it. However, the behaviour is different
22153 from the sender address when a recipient is verified. The address is rewritten
22154 for the verification, but the rewriting is not remembered at this stage. The
22155 value of &$local_part$& and &$domain$& after verification are always the same
22156 as they were before (that is, they contain the unrewritten &-- except for
22157 SMTP-time rewriting &-- address).
22159 As soon as a message's header lines have been received, all the envelope
22160 recipient addresses are permanently rewritten, and rewriting is also applied to
22161 the addresses in the header lines (if configured). This happens before adding
22162 any header lines that were specified in MAIL or RCPT ACLs, and
22163 .cindex "&[local_scan()]& function" "address rewriting; timing of"
22164 before the DATA ACL and &[local_scan()]& functions are run.
22166 When an address is being routed, either for delivery or for verification,
22167 rewriting is applied immediately to child addresses that are generated by
22168 redirection, unless &%no_rewrite%& is set on the router.
22170 .cindex "envelope sender" "rewriting at transport time"
22171 .cindex "rewriting" "at transport time"
22172 .cindex "header lines" "rewriting at transport time"
22173 At transport time, additional rewriting of addresses in header lines can be
22174 specified by setting the generic &%headers_rewrite%& option on a transport.
22175 This option contains rules that are identical in form to those in the rewrite
22176 section of the configuration file. They are applied to the original message
22177 header lines and any that were added by ACLs or a system filter. They are not
22178 applied to header lines that are added by routers or the transport.
22180 The outgoing envelope sender can be rewritten by means of the &%return_path%&
22181 transport option. However, it is not possible to rewrite envelope recipients at
22187 .section "Testing the rewriting rules that apply on input" "SECID149"
22188 .cindex "rewriting" "testing"
22189 .cindex "testing" "rewriting"
22190 Exim's input rewriting configuration appears in a part of the run time
22191 configuration file headed by &"begin rewrite"&. It can be tested by the
22192 &%-brw%& command line option. This takes an address (which can be a full RFC
22193 2822 address) as its argument. The output is a list of how the address would be
22194 transformed by the rewriting rules for each of the different places it might
22195 appear in an incoming message, that is, for each different header and for the
22196 envelope sender and recipient fields. For example,
22198 exim -brw ph10@exim.workshop.example
22200 might produce the output
22202 sender: Philip.Hazel@exim.workshop.example
22203 from: Philip.Hazel@exim.workshop.example
22204 to: ph10@exim.workshop.example
22205 cc: ph10@exim.workshop.example
22206 bcc: ph10@exim.workshop.example
22207 reply-to: Philip.Hazel@exim.workshop.example
22208 env-from: Philip.Hazel@exim.workshop.example
22209 env-to: ph10@exim.workshop.example
22211 which shows that rewriting has been set up for that address when used in any of
22212 the source fields, but not when it appears as a recipient address. At the
22213 present time, there is no equivalent way of testing rewriting rules that are
22214 set for a particular transport.
22217 .section "Rewriting rules" "SECID150"
22218 .cindex "rewriting" "rules"
22219 The rewrite section of the configuration file consists of lines of rewriting
22222 <&'source pattern'&> <&'replacement'&> <&'flags'&>
22224 Rewriting rules that are specified for the &%headers_rewrite%& generic
22225 transport option are given as a colon-separated list. Each item in the list
22226 takes the same form as a line in the main rewriting configuration (except that
22227 any colons must be doubled, of course).
22229 The formats of source patterns and replacement strings are described below.
22230 Each is terminated by white space, unless enclosed in double quotes, in which
22231 case normal quoting conventions apply inside the quotes. The flags are single
22232 characters which may appear in any order. Spaces and tabs between them are
22235 For each address that could potentially be rewritten, the rules are scanned in
22236 order, and replacements for the address from earlier rules can themselves be
22237 replaced by later rules (but see the &"q"& and &"R"& flags).
22239 The order in which addresses are rewritten is undefined, may change between
22240 releases, and must not be relied on, with one exception: when a message is
22241 received, the envelope sender is always rewritten first, before any header
22242 lines are rewritten. For example, the replacement string for a rewrite of an
22243 address in &'To:'& must not assume that the message's address in &'From:'& has
22244 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
22245 that the envelope sender has already been rewritten.
22247 .vindex "&$domain$&"
22248 .vindex "&$local_part$&"
22249 The variables &$local_part$& and &$domain$& can be used in the replacement
22250 string to refer to the address that is being rewritten. Note that lookup-driven
22251 rewriting can be done by a rule of the form
22255 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
22256 refer to the address that is being rewritten.
22259 .section "Rewriting patterns" "SECID151"
22260 .cindex "rewriting" "patterns"
22261 .cindex "address list" "in a rewriting pattern"
22262 The source pattern in a rewriting rule is any item which may appear in an
22263 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
22264 single-item address list, which means that it is expanded before being tested
22265 against the address. As always, if you use a regular expression as a pattern,
22266 you must take care to escape dollar and backslash characters, or use the &`\N`&
22267 facility to suppress string expansion within the regular expression.
22269 Domains in patterns should be given in lower case. Local parts in patterns are
22270 case-sensitive. If you want to do case-insensitive matching of local parts, you
22271 can use a regular expression that starts with &`^(?i)`&.
22273 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
22274 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
22275 depending on the type of match which occurred. These can be used in the
22276 replacement string to insert portions of the incoming address. &$0$& always
22277 refers to the complete incoming address. When a regular expression is used, the
22278 numerical variables are set from its capturing subexpressions. For other types
22279 of pattern they are set as follows:
22282 If a local part or domain starts with an asterisk, the numerical variables
22283 refer to the character strings matched by asterisks, with &$1$& associated with
22284 the first asterisk, and &$2$& with the second, if present. For example, if the
22287 *queen@*.fict.example
22289 is matched against the address &'hearts-queen@wonderland.fict.example'& then
22291 $0 = hearts-queen@wonderland.fict.example
22295 Note that if the local part does not start with an asterisk, but the domain
22296 does, it is &$1$& that contains the wild part of the domain.
22299 If the domain part of the pattern is a partial lookup, the wild and fixed parts
22300 of the domain are placed in the next available numerical variables. Suppose,
22301 for example, that the address &'foo@bar.baz.example'& is processed by a
22302 rewriting rule of the form
22304 &`*@partial-dbm;/some/dbm/file`& <&'replacement string'&>
22306 and the key in the file that matches the domain is &`*.baz.example`&. Then
22312 If the address &'foo@baz.example'& is looked up, this matches the same
22313 wildcard file entry, and in this case &$2$& is set to the empty string, but
22314 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
22315 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
22316 whole domain. For non-partial domain lookups, no numerical variables are set.
22320 .section "Rewriting replacements" "SECID152"
22321 .cindex "rewriting" "replacements"
22322 If the replacement string for a rule is a single asterisk, addresses that
22323 match the pattern and the flags are &'not'& rewritten, and no subsequent
22324 rewriting rules are scanned. For example,
22326 hatta@lookingglass.fict.example * f
22328 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
22331 .vindex "&$domain$&"
22332 .vindex "&$local_part$&"
22333 If the replacement string is not a single asterisk, it is expanded, and must
22334 yield a fully qualified address. Within the expansion, the variables
22335 &$local_part$& and &$domain$& refer to the address that is being rewritten.
22336 Any letters they contain retain their original case &-- they are not lower
22337 cased. The numerical variables are set up according to the type of pattern that
22338 matched the address, as described above. If the expansion is forced to fail by
22339 the presence of &"fail"& in a conditional or lookup item, rewriting by the
22340 current rule is abandoned, but subsequent rules may take effect. Any other
22341 expansion failure causes the entire rewriting operation to be abandoned, and an
22342 entry written to the panic log.
22346 .section "Rewriting flags" "SECID153"
22347 There are three different kinds of flag that may appear on rewriting rules:
22350 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
22353 A flag that specifies rewriting at SMTP time: S.
22355 Flags that control the rewriting process: Q, q, R, w.
22358 For rules that are part of the &%headers_rewrite%& generic transport option,
22359 E, F, T, and S are not permitted.
22363 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
22365 .cindex "rewriting" "flags"
22366 If none of the following flag letters, nor the &"S"& flag (see section
22367 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
22368 and to both the sender and recipient fields of the envelope, whereas a
22369 transport-time rewriting rule just applies to all headers. Otherwise, the
22370 rewriting rule is skipped unless the relevant addresses are being processed.
22372 &`E`& rewrite all envelope fields
22373 &`F`& rewrite the envelope From field
22374 &`T`& rewrite the envelope To field
22375 &`b`& rewrite the &'Bcc:'& header
22376 &`c`& rewrite the &'Cc:'& header
22377 &`f`& rewrite the &'From:'& header
22378 &`h`& rewrite all headers
22379 &`r`& rewrite the &'Reply-To:'& header
22380 &`s`& rewrite the &'Sender:'& header
22381 &`t`& rewrite the &'To:'& header
22383 "All headers" means all of the headers listed above that can be selected
22384 individually, plus their &'Resent-'& versions. It does not include
22385 other headers such as &'Subject:'& etc.
22387 You should be particularly careful about rewriting &'Sender:'& headers, and
22388 restrict this to special known cases in your own domains.
22391 .section "The SMTP-time rewriting flag" "SECTrewriteS"
22392 .cindex "SMTP" "rewriting malformed addresses"
22393 .cindex "RCPT" "rewriting argument of"
22394 .cindex "MAIL" "rewriting argument of"
22395 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
22396 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
22397 before any other processing; even before syntax checking. The pattern is
22398 required to be a regular expression, and it is matched against the whole of the
22399 data for the command, including any surrounding angle brackets.
22401 .vindex "&$domain$&"
22402 .vindex "&$local_part$&"
22403 This form of rewrite rule allows for the handling of addresses that are not
22404 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
22405 input). Because the input is not required to be a syntactically valid address,
22406 the variables &$local_part$& and &$domain$& are not available during the
22407 expansion of the replacement string. The result of rewriting replaces the
22408 original address in the MAIL or RCPT command.
22411 .section "Flags controlling the rewriting process" "SECID155"
22412 There are four flags which control the way the rewriting process works. These
22413 take effect only when a rule is invoked, that is, when the address is of the
22414 correct type (matches the flags) and matches the pattern:
22417 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
22418 unqualified local part. It is qualified with &%qualify_recipient%&. In the
22419 absence of &"Q"& the rewritten address must always include a domain.
22421 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
22422 even if no rewriting actually takes place because of a &"fail"& in the
22423 expansion. The &"q"& flag is not effective if the address is of the wrong type
22424 (does not match the flags) or does not match the pattern.
22426 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
22427 address, up to ten times. It can be combined with the &"q"& flag, to stop
22428 rewriting once it fails to match (after at least one successful rewrite).
22430 .cindex "rewriting" "whole addresses"
22431 When an address in a header is rewritten, the rewriting normally applies only
22432 to the working part of the address, with any comments and RFC 2822 &"phrase"&
22433 left unchanged. For example, rewriting might change
22435 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
22439 From: Ford Prefect <prefectf@hitch.fict.example>
22442 Sometimes there is a need to replace the whole address item, and this can be
22443 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
22444 causes an address in a header line to be rewritten, the entire address is
22445 replaced, not just the working part. The replacement must be a complete RFC
22446 2822 address, including the angle brackets if necessary. If text outside angle
22447 brackets contains a character whose value is greater than 126 or less than 32
22448 (except for tab), the text is encoded according to RFC 2047. The character set
22449 is taken from &%headers_charset%&, which defaults to ISO-8859-1.
22451 When the &"w"& flag is set on a rule that causes an envelope address to be
22452 rewritten, all but the working part of the replacement address is discarded.
22456 .section "Rewriting examples" "SECID156"
22457 Here is an example of the two common rewriting paradigms:
22459 *@*.hitch.fict.example $1@hitch.fict.example
22460 *@hitch.fict.example ${lookup{$1}dbm{/etc/realnames}\
22461 {$value}fail}@hitch.fict.example bctfrF
22463 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
22464 the string expansion to fail if the lookup does not succeed. In this context it
22465 has the effect of leaving the original address unchanged, but Exim goes on to
22466 consider subsequent rewriting rules, if any, because the &"q"& flag is not
22467 present in that rule. An alternative to &"fail"& would be to supply &$1$&
22468 explicitly, which would cause the rewritten address to be the same as before,
22469 at the cost of a small bit of processing. Not supplying either of these is an
22470 error, since the rewritten address would then contain no local part.
22472 The first example above replaces the domain with a superior, more general
22473 domain. This may not be desirable for certain local parts. If the rule
22475 root@*.hitch.fict.example *
22477 were inserted before the first rule, rewriting would be suppressed for the
22478 local part &'root'& at any domain ending in &'hitch.fict.example'&.
22480 Rewriting can be made conditional on a number of tests, by making use of
22481 &${if$& in the expansion item. For example, to apply a rewriting rule only to
22482 messages that originate outside the local host:
22484 *@*.hitch.fict.example "${if !eq {$sender_host_address}{}\
22485 {$1@hitch.fict.example}fail}"
22487 The replacement string is quoted in this example because it contains white
22490 .cindex "rewriting" "bang paths"
22491 .cindex "bang paths" "rewriting"
22492 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
22493 an address it treats it as an unqualified local part which it qualifies with
22494 the local qualification domain (if the source of the message is local or if the
22495 remote host is permitted to send unqualified addresses). Rewriting can
22496 sometimes be used to handle simple bang paths with a fixed number of
22497 components. For example, the rule
22499 \N^([^!]+)!(.*)@your.domain.example$\N $2@$1
22501 rewrites a two-component bang path &'host.name!user'& as the domain address
22502 &'user@host.name'&. However, there is a security implication in using this as
22503 a global rewriting rule for envelope addresses. It can provide a backdoor
22504 method for using your system as a relay, because the incoming addresses appear
22505 to be local. If the bang path addresses are received via SMTP, it is safer to
22506 use the &"S"& flag to rewrite them as they are received, so that relay checking
22507 can be done on the rewritten addresses.
22514 . ////////////////////////////////////////////////////////////////////////////
22515 . ////////////////////////////////////////////////////////////////////////////
22517 .chapter "Retry configuration" "CHAPretry"
22518 .scindex IIDretconf1 "retry" "configuration, description of"
22519 .scindex IIDregconf2 "configuration file" "retry section"
22520 The &"retry"& section of the runtime configuration file contains a list of
22521 retry rules that control how often Exim tries to deliver messages that cannot
22522 be delivered at the first attempt. If there are no retry rules (the section is
22523 empty or not present), there are no retries. In this situation, temporary
22524 errors are treated as permanent. The default configuration contains a single,
22525 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
22526 line option can be used to test which retry rule will be used for a given
22527 address, domain and error.
22529 The most common cause of retries is temporary failure to deliver to a remote
22530 host because the host is down, or inaccessible because of a network problem.
22531 Exim's retry processing in this case is applied on a per-host (strictly, per IP
22532 address) basis, not on a per-message basis. Thus, if one message has recently
22533 been delayed, delivery of a new message to the same host is not immediately
22534 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
22535 log selector is set, the message
22536 .cindex "retry" "time not reached"
22537 &"retry time not reached"& is written to the main log whenever a delivery is
22538 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
22539 the handling of errors during remote deliveries.
22541 Retry processing applies to routing as well as to delivering, except as covered
22542 in the next paragraph. The retry rules do not distinguish between these
22543 actions. It is not possible, for example, to specify different behaviour for
22544 failures to route the domain &'snark.fict.example'& and failures to deliver to
22545 the host &'snark.fict.example'&. I didn't think anyone would ever need this
22546 added complication, so did not implement it. However, although they share the
22547 same retry rule, the actual retry times for routing and transporting a given
22548 domain are maintained independently.
22550 When a delivery is not part of a queue run (typically an immediate delivery on
22551 receipt of a message), the routers are always run, and local deliveries are
22552 always attempted, even if retry times are set for them. This makes for better
22553 behaviour if one particular message is causing problems (for example, causing
22554 quota overflow, or provoking an error in a filter file). If such a delivery
22555 suffers a temporary failure, the retry data is updated as normal, and
22556 subsequent delivery attempts from queue runs occur only when the retry time for
22557 the local address is reached.
22559 .section "Changing retry rules" "SECID157"
22560 If you change the retry rules in your configuration, you should consider
22561 whether or not to delete the retry data that is stored in Exim's spool area in
22562 files with names like &_db/retry_&. Deleting any of Exim's hints files is
22563 always safe; that is why they are called &"hints"&.
22565 The hints retry data contains suggested retry times based on the previous
22566 rules. In the case of a long-running problem with a remote host, it might
22567 record the fact that the host has timed out. If your new rules increase the
22568 timeout time for such a host, you should definitely remove the old retry data
22569 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
22570 messages that it should now be retaining.
22574 .section "Format of retry rules" "SECID158"
22575 .cindex "retry" "rules"
22576 Each retry rule occupies one line and consists of three or four parts,
22577 separated by white space: a pattern, an error name, an optional list of sender
22578 addresses, and a list of retry parameters. The pattern and sender lists must be
22579 enclosed in double quotes if they contain white space. The rules are searched
22580 in order until one is found where the pattern, error name, and sender list (if
22581 present) match the failing host or address, the error that occurred, and the
22582 message's sender, respectively.
22585 The pattern is any single item that may appear in an address list (see section
22586 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
22587 which means that it is expanded before being tested against the address that
22588 has been delayed. A negated address list item is permitted. Address
22589 list processing treats a plain domain name as if it were preceded by &"*@"&,
22590 which makes it possible for many retry rules to start with just a domain. For
22593 lookingglass.fict.example * F,24h,30m;
22595 provides a rule for any address in the &'lookingglass.fict.example'& domain,
22598 alice@lookingglass.fict.example * F,24h,30m;
22600 applies only to temporary failures involving the local part &%alice%&.
22601 In practice, almost all rules start with a domain name pattern without a local
22604 .cindex "regular expressions" "in retry rules"
22605 &*Warning*&: If you use a regular expression in a routing rule pattern, it
22606 must match a complete address, not just a domain, because that is how regular
22607 expressions work in address lists.
22609 &`^\Nxyz\d+\.abc\.example$\N * G,1h,10m,2`& &%Wrong%&
22610 &`^\N[^@]+@xyz\d+\.abc\.example$\N * G,1h,10m,2`& &%Right%&
22614 .section "Choosing which retry rule to use for address errors" "SECID159"
22615 When Exim is looking for a retry rule after a routing attempt has failed (for
22616 example, after a DNS timeout), each line in the retry configuration is tested
22617 against the complete address only if &%retry_use_local_part%& is set for the
22618 router. Otherwise, only the domain is used, except when matching against a
22619 regular expression, when the local part of the address is replaced with &"*"&.
22620 A domain on its own can match a domain pattern, or a pattern that starts with
22621 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
22622 &%check_local_user%& is true, and false for other routers.
22624 Similarly, when Exim is looking for a retry rule after a local delivery has
22625 failed (for example, after a mailbox full error), each line in the retry
22626 configuration is tested against the complete address only if
22627 &%retry_use_local_part%& is set for the transport (it defaults true for all
22630 .cindex "4&'xx'& responses" "retry rules for"
22631 However, when Exim is looking for a retry rule after a remote delivery attempt
22632 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
22633 whole address is always used as the key when searching the retry rules. The
22634 rule that is found is used to create a retry time for the combination of the
22635 failing address and the message's sender. It is the combination of sender and
22636 recipient that is delayed in subsequent queue runs until its retry time is
22637 reached. You can delay the recipient without regard to the sender by setting
22638 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
22639 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
22644 .section "Choosing which retry rule to use for host and message errors" &&&
22646 For a temporary error that is not related to an individual address (for
22647 example, a connection timeout), each line in the retry configuration is checked
22648 twice. First, the name of the remote host is used as a domain name (preceded by
22649 &"*@"& when matching a regular expression). If this does not match the line,
22650 the domain from the email address is tried in a similar fashion. For example,
22651 suppose the MX records for &'a.b.c.example'& are
22653 a.b.c.example MX 5 x.y.z.example
22657 and the retry rules are
22659 p.q.r.example * F,24h,30m;
22660 a.b.c.example * F,4d,45m;
22662 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
22663 first rule matches neither the host nor the domain, so Exim looks at the second
22664 rule. This does not match the host, but it does match the domain, so it is used
22665 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
22666 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
22667 first retry rule is used, because it matches the host.
22669 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
22670 first rule to determine retry times, but for all the other hosts for the domain
22671 &'a.b.c.example'&, the second rule is used. The second rule is also used if
22672 routing to &'a.b.c.example'& suffers a temporary failure.
22674 &*Note*&: The host name is used when matching the patterns, not its IP address.
22675 However, if a message is routed directly to an IP address without the use of a
22676 host name, for example, if a &(manualroute)& router contains a setting such as:
22678 route_list = *.a.example 192.168.34.23
22680 then the &"host name"& that is used when searching for a retry rule is the
22681 textual form of the IP address.
22683 .section "Retry rules for specific errors" "SECID161"
22684 .cindex "retry" "specific errors; specifying"
22685 The second field in a retry rule is the name of a particular error, or an
22686 asterisk, which matches any error. The errors that can be tested for are:
22689 .vitem &%auth_failed%&
22690 Authentication failed when trying to send to a host in the
22691 &%hosts_require_auth%& list in an &(smtp)& transport.
22693 .vitem &%data_4xx%&
22694 A 4&'xx'& error was received for an outgoing DATA command, either immediately
22695 after the command, or after sending the message's data.
22697 .vitem &%mail_4xx%&
22698 A 4&'xx'& error was received for an outgoing MAIL command.
22700 .vitem &%rcpt_4xx%&
22701 A 4&'xx'& error was received for an outgoing RCPT command.
22704 For the three 4&'xx'& errors, either the first or both of the x's can be given
22705 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
22706 recognize 452 errors given to RCPT commands for addresses in a certain domain,
22707 and have retries every ten minutes with a one-hour timeout, you could set up a
22708 retry rule of this form:
22710 the.domain.name rcpt_452 F,1h,10m
22712 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
22713 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
22716 .vitem &%lost_connection%&
22717 A server unexpectedly closed the SMTP connection. There may, of course,
22718 legitimate reasons for this (host died, network died), but if it repeats a lot
22719 for the same host, it indicates something odd.
22721 .vitem &%refused_MX%&
22722 A connection to a host obtained from an MX record was refused.
22724 .vitem &%refused_A%&
22725 A connection to a host not obtained from an MX record was refused.
22728 A connection was refused.
22730 .vitem &%timeout_connect_MX%&
22731 A connection attempt to a host obtained from an MX record timed out.
22733 .vitem &%timeout_connect_A%&
22734 A connection attempt to a host not obtained from an MX record timed out.
22736 .vitem &%timeout_connect%&
22737 A connection attempt timed out.
22739 .vitem &%timeout_MX%&
22740 There was a timeout while connecting or during an SMTP session with a host
22741 obtained from an MX record.
22743 .vitem &%timeout_A%&
22744 There was a timeout while connecting or during an SMTP session with a host not
22745 obtained from an MX record.
22748 There was a timeout while connecting or during an SMTP session.
22750 .vitem &%tls_required%&
22751 The server was required to use TLS (it matched &%hosts_require_tls%& in the
22752 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
22753 to STARTTLS, or there was a problem setting up the TLS connection.
22756 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
22759 .vitem &%quota_%&<&'time'&>
22760 .cindex "quota" "error testing in retry rule"
22761 .cindex "retry" "quota error testing"
22762 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
22763 transport, and the mailbox has not been accessed for <&'time'&>. For example,
22764 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
22768 .cindex "mailbox" "time of last read"
22769 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
22770 timeouts when the mailbox is full and is not being read by its owner. Ideally,
22771 it should be based on the last time that the user accessed the mailbox.
22772 However, it is not always possible to determine this. Exim uses the following
22776 If the mailbox is a single file, the time of last access (the &"atime"&) is
22777 used. As no new messages are being delivered (because the mailbox is over
22778 quota), Exim does not access the file, so this is the time of last user access.
22780 .cindex "maildir format" "time of last read"
22781 For a maildir delivery, the time of last modification of the &_new_&
22782 subdirectory is used. As the mailbox is over quota, no new files are created in
22783 the &_new_& subdirectory, because no new messages are being delivered. Any
22784 change to the &_new_& subdirectory is therefore assumed to be the result of an
22785 MUA moving a new message to the &_cur_& directory when it is first read. The
22786 time that is used is therefore the last time that the user read a new message.
22788 For other kinds of multi-file mailbox, the time of last access cannot be
22789 obtained, so a retry rule that uses this type of error field is never matched.
22792 The quota errors apply both to system-enforced quotas and to Exim's own quota
22793 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
22794 when a local delivery is deferred because a partition is full (the ENOSPC
22799 .section "Retry rules for specified senders" "SECID162"
22800 .cindex "retry" "rules; sender-specific"
22801 You can specify retry rules that apply only when the failing message has a
22802 specific sender. In particular, this can be used to define retry rules that
22803 apply only to bounce messages. The third item in a retry rule can be of this
22806 &`senders=`&<&'address list'&>
22808 The retry timings themselves are then the fourth item. For example:
22810 * rcpt_4xx senders=: F,1h,30m
22812 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
22813 host. If the address list contains white space, it must be enclosed in quotes.
22816 a.domain rcpt_452 senders="xb.dom : yc.dom" G,8h,10m,1.5
22818 &*Warning*&: This facility can be unhelpful if it is used for host errors
22819 (which do not depend on the recipient). The reason is that the sender is used
22820 only to match the retry rule. Once the rule has been found for a host error,
22821 its contents are used to set a retry time for the host, and this will apply to
22822 all messages, not just those with specific senders.
22824 When testing retry rules using &%-brt%&, you can supply a sender using the
22825 &%-f%& command line option, like this:
22827 exim -f "" -brt user@dom.ain
22829 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
22830 list is never matched.
22836 .section "Retry parameters" "SECID163"
22837 .cindex "retry" "parameters in rules"
22838 The third (or fourth, if a senders list is present) field in a retry rule is a
22839 sequence of retry parameter sets, separated by semicolons. Each set consists of
22841 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
22843 The letter identifies the algorithm for computing a new retry time; the cutoff
22844 time is the time beyond which this algorithm no longer applies, and the
22845 arguments vary the algorithm's action. The cutoff time is measured from the
22846 time that the first failure for the domain (combined with the local part if
22847 relevant) was detected, not from the time the message was received.
22849 .cindex "retry" "algorithms"
22850 .cindex "retry" "fixed intervals"
22851 .cindex "retry" "increasing intervals"
22852 .cindex "retry" "random intervals"
22853 The available algorithms are:
22856 &'F'&: retry at fixed intervals. There is a single time parameter specifying
22859 &'G'&: retry at geometrically increasing intervals. The first argument
22860 specifies a starting value for the interval, and the second a multiplier, which
22861 is used to increase the size of the interval at each retry.
22863 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
22864 retry, the previous interval is multiplied by the factor in order to get a
22865 maximum for the next interval. The minimum interval is the first argument of
22866 the parameter, and an actual interval is chosen randomly between them. Such a
22867 rule has been found to be helpful in cluster configurations when all the
22868 members of the cluster restart at once, and may therefore synchronize their
22869 queue processing times.
22872 When computing the next retry time, the algorithm definitions are scanned in
22873 order until one whose cutoff time has not yet passed is reached. This is then
22874 used to compute a new retry time that is later than the current time. In the
22875 case of fixed interval retries, this simply means adding the interval to the
22876 current time. For geometrically increasing intervals, retry intervals are
22877 computed from the rule's parameters until one that is greater than the previous
22878 interval is found. The main configuration variable
22879 .cindex "limit" "retry interval"
22880 .cindex "retry" "interval, maximum"
22881 .oindex "&%retry_interval_max%&"
22882 &%retry_interval_max%& limits the maximum interval between retries. It
22883 cannot be set greater than &`24h`&, which is its default value.
22885 A single remote domain may have a number of hosts associated with it, and each
22886 host may have more than one IP address. Retry algorithms are selected on the
22887 basis of the domain name, but are applied to each IP address independently. If,
22888 for example, a host has two IP addresses and one is unusable, Exim will
22889 generate retry times for it and will not try to use it until its next retry
22890 time comes. Thus the good IP address is likely to be tried first most of the
22893 .cindex "hints database" "use for retrying"
22894 Retry times are hints rather than promises. Exim does not make any attempt to
22895 run deliveries exactly at the computed times. Instead, a queue runner process
22896 starts delivery processes for delayed messages periodically, and these attempt
22897 new deliveries only for those addresses that have passed their next retry time.
22898 If a new message arrives for a deferred address, an immediate delivery attempt
22899 occurs only if the address has passed its retry time. In the absence of new
22900 messages, the minimum time between retries is the interval between queue runner
22901 processes. There is not much point in setting retry times of five minutes if
22902 your queue runners happen only once an hour, unless there are a significant
22903 number of incoming messages (which might be the case on a system that is
22904 sending everything to a smart host, for example).
22906 The data in the retry hints database can be inspected by using the
22907 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
22908 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
22909 &'exinext'& utility script can be used to find out what the next retry times
22910 are for the hosts associated with a particular mail domain, and also for local
22911 deliveries that have been deferred.
22914 .section "Retry rule examples" "SECID164"
22915 Here are some example retry rules:
22917 alice@wonderland.fict.example quota_5d F,7d,3h
22918 wonderland.fict.example quota_5d
22919 wonderland.fict.example * F,1h,15m; G,2d,1h,2;
22920 lookingglass.fict.example * F,24h,30m;
22921 * refused_A F,2h,20m;
22922 * * F,2h,15m; G,16h,1h,1.5; F,5d,8h
22924 The first rule sets up special handling for mail to
22925 &'alice@wonderland.fict.example'& when there is an over-quota error and the
22926 mailbox has not been read for at least 5 days. Retries continue every three
22927 hours for 7 days. The second rule handles over-quota errors for all other local
22928 parts at &'wonderland.fict.example'&; the absence of a local part has the same
22929 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
22930 fail are bounced immediately if the mailbox has not been read for at least 5
22933 The third rule handles all other errors at &'wonderland.fict.example'&; retries
22934 happen every 15 minutes for an hour, then with geometrically increasing
22935 intervals until two days have passed since a delivery first failed. After the
22936 first hour there is a delay of one hour, then two hours, then four hours, and
22937 so on (this is a rather extreme example).
22939 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
22940 They happen every 30 minutes for 24 hours only. The remaining two rules handle
22941 all other domains, with special action for connection refusal from hosts that
22942 were not obtained from an MX record.
22944 The final rule in a retry configuration should always have asterisks in the
22945 first two fields so as to provide a general catch-all for any addresses that do
22946 not have their own special handling. This example tries every 15 minutes for 2
22947 hours, then with intervals starting at one hour and increasing by a factor of
22948 1.5 up to 16 hours, then every 8 hours up to 5 days.
22952 .section "Timeout of retry data" "SECID165"
22953 .cindex "timeout" "of retry data"
22954 .oindex "&%retry_data_expire%&"
22955 .cindex "hints database" "data expiry"
22956 .cindex "retry" "timeout of data"
22957 Exim timestamps the data that it writes to its retry hints database. When it
22958 consults the data during a delivery it ignores any that is older than the value
22959 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
22960 been tried for 7 days, Exim will try to deliver to it immediately a message
22961 arrives, and if that fails, it will calculate a retry time as if it were
22962 failing for the first time.
22964 This improves the behaviour for messages routed to rarely-used hosts such as MX
22965 backups. If such a host was down at one time, and happens to be down again when
22966 Exim tries a month later, using the old retry data would imply that it had been
22967 down all the time, which is not a justified assumption.
22969 If a host really is permanently dead, this behaviour causes a burst of retries
22970 every now and again, but only if messages routed to it are rare. If there is a
22971 message at least once every 7 days the retry data never expires.
22976 .section "Long-term failures" "SECID166"
22977 .cindex "delivery failure, long-term"
22978 .cindex "retry" "after long-term failure"
22979 Special processing happens when an email address has been failing for so long
22980 that the cutoff time for the last algorithm is reached. For example, using the
22981 default retry rule:
22983 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
22985 the cutoff time is four days. Reaching the retry cutoff is independent of how
22986 long any specific message has been failing; it is the length of continuous
22987 failure for the recipient address that counts.
22989 When the cutoff time is reached for a local delivery, or for all the IP
22990 addresses associated with a remote delivery, a subsequent delivery failure
22991 causes Exim to give up on the address, and a bounce message is generated.
22992 In order to cater for new messages that use the failing address, a next retry
22993 time is still computed from the final algorithm, and is used as follows:
22995 For local deliveries, one delivery attempt is always made for any subsequent
22996 messages. If this delivery fails, the address fails immediately. The
22997 post-cutoff retry time is not used.
22999 If the delivery is remote, there are two possibilities, controlled by the
23000 .oindex "&%delay_after_cutoff%&"
23001 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
23002 default. Until the post-cutoff retry time for one of the IP addresses is
23003 reached, the failing email address is bounced immediately, without a delivery
23004 attempt taking place. After that time, one new delivery attempt is made to
23005 those IP addresses that are past their retry times, and if that still fails,
23006 the address is bounced and new retry times are computed.
23008 In other words, when all the hosts for a given email address have been failing
23009 for a long time, Exim bounces rather then defers until one of the hosts' retry
23010 times is reached. Then it tries once, and bounces if that attempt fails. This
23011 behaviour ensures that few resources are wasted in repeatedly trying to deliver
23012 to a broken destination, but if the host does recover, Exim will eventually
23015 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
23016 addresses are past their final cutoff time, Exim tries to deliver to those IP
23017 addresses that have not been tried since the message arrived. If there are
23018 no suitable IP addresses, or if they all fail, the address is bounced. In other
23019 words, it does not delay when a new message arrives, but tries the expired
23020 addresses immediately, unless they have been tried since the message arrived.
23021 If there is a continuous stream of messages for the failing domains, setting
23022 &%delay_after_cutoff%& false means that there will be many more attempts to
23023 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
23026 .section "Deliveries that work intermittently" "SECID167"
23027 .cindex "retry" "intermittently working deliveries"
23028 Some additional logic is needed to cope with cases where a host is
23029 intermittently available, or when a message has some attribute that prevents
23030 its delivery when others to the same address get through. In this situation,
23031 because some messages are successfully delivered, the &"retry clock"& for the
23032 host or address keeps getting reset by the successful deliveries, and so
23033 failing messages remain on the queue for ever because the cutoff time is never
23036 Two exceptional actions are applied to prevent this happening. The first
23037 applies to errors that are related to a message rather than a remote host.
23038 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
23039 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
23040 commands, and quota failures. For this type of error, if a message's arrival
23041 time is earlier than the &"first failed"& time for the error, the earlier time
23042 is used when scanning the retry rules to decide when to try next and when to
23043 time out the address.
23045 The exceptional second action applies in all cases. If a message has been on
23046 the queue for longer than the cutoff time of any applicable retry rule for a
23047 given address, a delivery is attempted for that address, even if it is not yet
23048 time, and if this delivery fails, the address is timed out. A new retry time is
23049 not computed in this case, so that other messages for the same address are
23050 considered immediately.
23051 .ecindex IIDretconf1
23052 .ecindex IIDregconf2
23059 . ////////////////////////////////////////////////////////////////////////////
23060 . ////////////////////////////////////////////////////////////////////////////
23062 .chapter "SMTP authentication" "CHAPSMTPAUTH"
23063 .scindex IIDauthconf1 "SMTP" "authentication configuration"
23064 .scindex IIDauthconf2 "authentication"
23065 The &"authenticators"& section of Exim's run time configuration is concerned
23066 with SMTP authentication. This facility is an extension to the SMTP protocol,
23067 described in RFC 2554, which allows a client SMTP host to authenticate itself
23068 to a server. This is a common way for a server to recognize clients that are
23069 permitted to use it as a relay. SMTP authentication is not of relevance to the
23070 transfer of mail between servers that have no managerial connection with each
23073 .cindex "AUTH" "description of"
23074 Very briefly, the way SMTP authentication works is as follows:
23077 The server advertises a number of authentication &'mechanisms'& in response to
23078 the client's EHLO command.
23080 The client issues an AUTH command, naming a specific mechanism. The command
23081 may, optionally, contain some authentication data.
23083 The server may issue one or more &'challenges'&, to which the client must send
23084 appropriate responses. In simple authentication mechanisms, the challenges are
23085 just prompts for user names and passwords. The server does not have to issue
23086 any challenges &-- in some mechanisms the relevant data may all be transmitted
23087 with the AUTH command.
23089 The server either accepts or denies authentication.
23091 If authentication succeeds, the client may optionally make use of the AUTH
23092 option on the MAIL command to pass an authenticated sender in subsequent
23093 mail transactions. Authentication lasts for the remainder of the SMTP
23096 If authentication fails, the client may give up, or it may try a different
23097 authentication mechanism, or it may try transferring mail over the
23098 unauthenticated connection.
23101 If you are setting up a client, and want to know which authentication
23102 mechanisms the server supports, you can use Telnet to connect to port 25 (the
23103 SMTP port) on the server, and issue an EHLO command. The response to this
23104 includes the list of supported mechanisms. For example:
23106 &`$ `&&*&`telnet server.example 25`&*&
23107 &`Trying 192.168.34.25...`&
23108 &`Connected to server.example.`&
23109 &`Escape character is '^]'.`&
23110 &`220 server.example ESMTP Exim 4.20 ...`&
23111 &*&`ehlo client.example`&*&
23112 &`250-server.example Hello client.example [10.8.4.5]`&
23113 &`250-SIZE 52428800`&
23118 The second-last line of this example output shows that the server supports
23119 authentication using the PLAIN mechanism. In Exim, the different authentication
23120 mechanisms are configured by specifying &'authenticator'& drivers. Like the
23121 routers and transports, which authenticators are included in the binary is
23122 controlled by build-time definitions. The following are currently available,
23123 included by setting
23126 AUTH_CYRUS_SASL=yes
23130 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
23131 authentication mechanism (RFC 2195), and the second provides an interface to
23132 the Cyrus SASL authentication library. The third can be configured to support
23133 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
23134 not formally documented, but used by several MUAs. The fourth authenticator
23135 supports Microsoft's &'Secure Password Authentication'& mechanism.
23137 The authenticators are configured using the same syntax as other drivers (see
23138 section &<<SECTfordricon>>&). If no authenticators are required, no
23139 authentication section need be present in the configuration file. Each
23140 authenticator can in principle have both server and client functions. When Exim
23141 is receiving SMTP mail, it is acting as a server; when it is sending out
23142 messages over SMTP, it is acting as a client. Authenticator configuration
23143 options are provided for use in both these circumstances.
23145 To make it clear which options apply to which situation, the prefixes
23146 &%server_%& and &%client_%& are used on option names that are specific to
23147 either the server or the client function, respectively. Server and client
23148 functions are disabled if none of their options are set. If an authenticator is
23149 to be used for both server and client functions, a single definition, using
23150 both sets of options, is required. For example:
23154 public_name = CRAM-MD5
23155 server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
23157 client_secret = secret2
23159 The &%server_%& option is used when Exim is acting as a server, and the
23160 &%client_%& options when it is acting as a client.
23162 Descriptions of the individual authenticators are given in subsequent chapters.
23163 The remainder of this chapter covers the generic options for the
23164 authenticators, followed by general discussion of the way authentication works
23169 .section "Generic options for authenticators" "SECID168"
23170 .cindex "authentication" "generic options"
23171 .cindex "options" "generic; for authenticators"
23173 .option client_condition authenticators string&!! unset
23174 When Exim is authenticating as a client, it skips any authenticator whose
23175 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
23176 used, for example, to skip plain text authenticators when the connection is not
23177 encrypted by a setting such as:
23179 client_condition = ${if !eq{$tls_cipher}{}}
23181 (Older documentation incorrectly states that &$tls_cipher$& contains the cipher
23182 used for incoming messages. In fact, during SMTP delivery, it contains the
23183 cipher used for the delivery.)
23186 .option driver authenticators string unset
23187 This option must always be set. It specifies which of the available
23188 authenticators is to be used.
23191 .option public_name authenticators string unset
23192 This option specifies the name of the authentication mechanism that the driver
23193 implements, and by which it is known to the outside world. These names should
23194 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
23195 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
23196 defaults to the driver's instance name.
23199 .option server_advertise_condition authenticators string&!! unset
23200 When a server is about to advertise an authentication mechanism, the condition
23201 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
23202 mechanism is not advertised.
23203 If the expansion fails, the mechanism is not advertised. If the failure was not
23204 forced, and was not caused by a lookup defer, the incident is logged.
23205 See section &<<SECTauthexiser>>& below for further discussion.
23208 .option server_condition authenticators string&!! unset
23209 This option must be set for a &%plaintext%& server authenticator, where it
23210 is used directly to control authentication. See section &<<SECTplainserver>>&
23213 For the other authenticators, &%server_condition%& can be used as an additional
23214 authentication or authorization mechanism that is applied after the other
23215 authenticator conditions succeed. If it is set, it is expanded when the
23216 authenticator would otherwise return a success code. If the expansion is forced
23217 to fail, authentication fails. Any other expansion failure causes a temporary
23218 error code to be returned. If the result of a successful expansion is an empty
23219 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
23220 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
23221 other result, a temporary error code is returned, with the expanded string as
23225 .option server_debug_print authenticators string&!! unset
23226 If this option is set and authentication debugging is enabled (see the &%-d%&
23227 command line option), the string is expanded and included in the debugging
23228 output when the authenticator is run as a server. This can help with checking
23229 out the values of variables.
23230 If expansion of the string fails, the error message is written to the debugging
23231 output, and Exim carries on processing.
23234 .option server_set_id authenticators string&!! unset
23235 .vindex "&$authenticated_id$&"
23236 When an Exim server successfully authenticates a client, this string is
23237 expanded using data from the authentication, and preserved for any incoming
23238 messages in the variable &$authenticated_id$&. It is also included in the log
23239 lines for incoming messages. For example, a user/password authenticator
23240 configuration might preserve the user name that was used to authenticate, and
23241 refer to it subsequently during delivery of the message.
23242 If expansion fails, the option is ignored.
23245 .option server_mail_auth_condition authenticators string&!! unset
23246 This option allows a server to discard authenticated sender addresses supplied
23247 as part of MAIL commands in SMTP connections that are authenticated by the
23248 driver on which &%server_mail_auth_condition%& is set. The option is not used
23249 as part of the authentication process; instead its (unexpanded) value is
23250 remembered for later use.
23251 How it is used is described in the following section.
23257 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
23258 .cindex "authentication" "sender; authenticated"
23259 .cindex "AUTH" "on MAIL command"
23260 When a client supplied an AUTH= item on a MAIL command, Exim applies
23261 the following checks before accepting it as the authenticated sender of the
23265 If the connection is not using extended SMTP (that is, HELO was used rather
23266 than EHLO), the use of AUTH= is a syntax error.
23268 If the value of the AUTH= parameter is &"<>"&, it is ignored.
23270 .vindex "&$authenticated_sender$&"
23271 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
23272 running, the value of &$authenticated_sender$& is set to the value obtained
23273 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
23274 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
23275 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
23276 given for the MAIL command.
23278 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
23279 is accepted and placed in &$authenticated_sender$& only if the client has
23282 If the AUTH= value was accepted by either of the two previous rules, and
23283 the client has authenticated, and the authenticator has a setting for the
23284 &%server_mail_auth_condition%&, the condition is checked at this point. The
23285 valued that was saved from the authenticator is expanded. If the expansion
23286 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
23287 &$authenticated_sender$& is deleted. If the expansion yields any other value,
23288 the value of &$authenticated_sender$& is retained and passed on with the
23293 When &$authenticated_sender$& is set for a message, it is passed on to other
23294 hosts to which Exim authenticates as a client. Do not confuse this value with
23295 &$authenticated_id$&, which is a string obtained from the authentication
23296 process, and which is not usually a complete email address.
23298 .vindex "&$sender_address$&"
23299 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
23300 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
23301 therefore make use of &$authenticated_sender$&. The converse is not true: the
23302 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
23307 .section "Authentication on an Exim server" "SECTauthexiser"
23308 .cindex "authentication" "on an Exim server"
23309 When Exim receives an EHLO command, it advertises the public names of those
23310 authenticators that are configured as servers, subject to the following
23314 The client host must match &%auth_advertise_hosts%& (default *).
23316 It the &%server_advertise_condition%& option is set, its expansion must not
23317 yield the empty string, &"0"&, &"no"&, or &"false"&.
23320 The order in which the authenticators are defined controls the order in which
23321 the mechanisms are advertised.
23323 Some mail clients (for example, some versions of Netscape) require the user to
23324 provide a name and password for authentication whenever AUTH is advertised,
23325 even though authentication may not in fact be needed (for example, Exim may be
23326 set up to allow unconditional relaying from the client by an IP address check).
23327 You can make such clients more friendly by not advertising AUTH to them.
23328 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
23329 that runs for RCPT) to relay without authentication, you should set
23331 auth_advertise_hosts = ! 10.9.8.0/24
23333 so that no authentication mechanisms are advertised to them.
23335 The &%server_advertise_condition%& controls the advertisement of individual
23336 authentication mechanisms. For example, it can be used to restrict the
23337 advertisement of a particular mechanism to encrypted connections, by a setting
23340 server_advertise_condition = ${if eq{$tls_cipher}{}{no}{yes}}
23342 .vindex "&$tls_cipher$&"
23343 If the session is encrypted, &$tls_cipher$& is not empty, and so the expansion
23344 yields &"yes"&, which allows the advertisement to happen.
23346 When an Exim server receives an AUTH command from a client, it rejects it
23347 immediately if AUTH was not advertised in response to an earlier EHLO
23348 command. This is the case if
23351 The client host does not match &%auth_advertise_hosts%&; or
23353 No authenticators are configured with server options; or
23355 Expansion of &%server_advertise_condition%& blocked the advertising of all the
23356 server authenticators.
23360 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
23361 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
23362 AUTH is accepted from any client host.
23364 If AUTH is not rejected by the ACL, Exim searches its configuration for a
23365 server authentication mechanism that was advertised in response to EHLO and
23366 that matches the one named in the AUTH command. If it finds one, it runs
23367 the appropriate authentication protocol, and authentication either succeeds or
23368 fails. If there is no matching advertised mechanism, the AUTH command is
23369 rejected with a 504 error.
23371 .vindex "&$received_protocol$&"
23372 .vindex "&$sender_host_authenticated$&"
23373 When a message is received from an authenticated host, the value of
23374 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
23375 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
23376 public name) of the authenticator driver that successfully authenticated the
23377 client from which the message was received. This variable is empty if there was
23378 no successful authentication.
23383 .section "Testing server authentication" "SECID169"
23384 .cindex "authentication" "testing a server"
23385 .cindex "AUTH" "testing a server"
23386 .cindex "base64 encoding" "creating authentication test data"
23387 Exim's &%-bh%& option can be useful for testing server authentication
23388 configurations. The data for the AUTH command has to be sent using base64
23389 encoding. A quick way to produce such data for testing is the following Perl
23393 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
23395 .cindex "binary zero" "in authentication data"
23396 This interprets its argument as a Perl string, and then encodes it. The
23397 interpretation as a Perl string allows binary zeros, which are required for
23398 some kinds of authentication, to be included in the data. For example, a
23399 command line to run this script on such data might be
23401 encode '\0user\0password'
23403 Note the use of single quotes to prevent the shell interpreting the
23404 backslashes, so that they can be interpreted by Perl to specify characters
23405 whose code value is zero.
23407 &*Warning 1*&: If either of the user or password strings starts with an octal
23408 digit, you must use three zeros instead of one after the leading backslash. If
23409 you do not, the octal digit that starts your string will be incorrectly
23410 interpreted as part of the code for the first character.
23412 &*Warning 2*&: If there are characters in the strings that Perl interprets
23413 specially, you must use a Perl escape to prevent them being misinterpreted. For
23414 example, a command such as
23416 encode '\0user@domain.com\0pas$$word'
23418 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
23420 If you have the &%mimencode%& command installed, another way to do produce
23421 base64-encoded strings is to run the command
23423 echo -e -n `\0user\0password' | mimencode
23425 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
23426 in the argument, and the &%-n%& option specifies no newline at the end of its
23427 output. However, not all versions of &%echo%& recognize these options, so you
23428 should check your version before relying on this suggestion.
23432 .section "Authentication by an Exim client" "SECID170"
23433 .cindex "authentication" "on an Exim client"
23434 The &(smtp)& transport has two options called &%hosts_require_auth%& and
23435 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
23436 announces support for authentication, and the host matches an entry in either
23437 of these options, Exim (as a client) tries to authenticate as follows:
23440 For each authenticator that is configured as a client, in the order in which
23441 they are defined in the configuration, it searches the authentication
23442 mechanisms announced by the server for one whose name matches the public name
23443 of the authenticator.
23446 .vindex "&$host_address$&"
23447 When it finds one that matches, it runs the authenticator's client code. The
23448 variables &$host$& and &$host_address$& are available for any string expansions
23449 that the client might do. They are set to the server's name and IP address. If
23450 any expansion is forced to fail, the authentication attempt is abandoned, and
23451 Exim moves on to the next authenticator. Otherwise an expansion failure causes
23452 delivery to be deferred.
23454 If the result of the authentication attempt is a temporary error or a timeout,
23455 Exim abandons trying to send the message to the host for the moment. It will
23456 try again later. If there are any backup hosts available, they are tried in the
23459 If the response to authentication is a permanent error (5&'xx'& code), Exim
23460 carries on searching the list of authenticators and tries another one if
23461 possible. If all authentication attempts give permanent errors, or if there are
23462 no attempts because no mechanisms match (or option expansions force failure),
23463 what happens depends on whether the host matches &%hosts_require_auth%& or
23464 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
23465 delivery is deferred. The error can be detected in the retry rules, and thereby
23466 turned into a permanent error if you wish. In the second case, Exim tries to
23467 deliver the message unauthenticated.
23470 .cindex "AUTH" "on MAIL command"
23471 When Exim has authenticated itself to a remote server, it adds the AUTH
23472 parameter to the MAIL commands it sends, if it has an authenticated sender for
23473 the message. If the message came from a remote host, the authenticated sender
23474 is the one that was receiving on an incoming MAIL command, provided that the
23475 incoming connection was authenticated and the &%server_mail_auth%& condition
23476 allowed the authenticated sender to be retained. If a local process calls Exim
23477 to send a message, the sender address that is built from the login name and
23478 &%qualify_domain%& is treated as authenticated. However, if the
23479 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
23480 the authenticated sender that was received with the message.
23481 .ecindex IIDauthconf1
23482 .ecindex IIDauthconf2
23489 . ////////////////////////////////////////////////////////////////////////////
23490 . ////////////////////////////////////////////////////////////////////////////
23492 .chapter "The plaintext authenticator" "CHAPplaintext"
23493 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
23494 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
23495 The &(plaintext)& authenticator can be configured to support the PLAIN and
23496 LOGIN authentication mechanisms, both of which transfer authentication data as
23497 plain (unencrypted) text (though base64 encoded). The use of plain text is a
23498 security risk; you are strongly advised to insist on the use of SMTP encryption
23499 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
23500 use unencrypted plain text, you should not use the same passwords for SMTP
23501 connections as you do for login accounts.
23503 .section "Plaintext options" "SECID171"
23504 .cindex "options" "&(plaintext)& authenticator (server)"
23505 When configured as a server, &(plaintext)& uses the following options:
23507 .option server_condition authenticators string&!! unset
23508 This is actually a global authentication option, but it must be set in order to
23509 configure the &(plaintext)& driver as a server. Its use is described below.
23511 .option server_prompts plaintext string&!! unset
23512 The contents of this option, after expansion, must be a colon-separated list of
23513 prompt strings. If expansion fails, a temporary authentication rejection is
23516 .section "Using plaintext in a server" "SECTplainserver"
23517 .cindex "AUTH" "in &(plaintext)& authenticator"
23518 .cindex "binary zero" "in &(plaintext)& authenticator"
23519 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
23520 "in &(plaintext)& authenticator"
23521 .vindex "&$auth1$&, &$auth2$&, etc"
23522 .cindex "base64 encoding" "in &(plaintext)& authenticator"
23524 When running as a server, &(plaintext)& performs the authentication test by
23525 expanding a string. The data sent by the client with the AUTH command, or in
23526 response to subsequent prompts, is base64 encoded, and so may contain any byte
23527 values when decoded. If any data is supplied with the command, it is treated as
23528 a list of strings, separated by NULs (binary zeros), the first three of which
23529 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
23530 (neither LOGIN nor PLAIN uses more than three strings).
23532 For compatibility with previous releases of Exim, the values are also placed in
23533 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
23534 variables for this purpose is now deprecated, as it can lead to confusion in
23535 string expansions that also use them for other things.
23537 If there are more strings in &%server_prompts%& than the number of strings
23538 supplied with the AUTH command, the remaining prompts are used to obtain more
23539 data. Each response from the client may be a list of NUL-separated strings.
23541 .vindex "&$authenticated_id$&"
23542 Once a sufficient number of data strings have been received,
23543 &%server_condition%& is expanded. If the expansion is forced to fail,
23544 authentication fails. Any other expansion failure causes a temporary error code
23545 to be returned. If the result of a successful expansion is an empty string,
23546 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
23547 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
23548 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
23549 For any other result, a temporary error code is returned, with the expanded
23550 string as the error text.
23552 &*Warning*&: If you use a lookup in the expansion to find the user's
23553 password, be sure to make the authentication fail if the user is unknown.
23554 There are good and bad examples at the end of the next section.
23558 .section "The PLAIN authentication mechanism" "SECID172"
23559 .cindex "PLAIN authentication mechanism"
23560 .cindex "authentication" "PLAIN mechanism"
23561 .cindex "binary zero" "in &(plaintext)& authenticator"
23562 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
23563 sent as one item of data (that is, one combined string containing two NUL
23564 separators). The data is sent either as part of the AUTH command, or
23565 subsequently in response to an empty prompt from the server.
23567 The second and third strings are a user name and a corresponding password.
23568 Using a single fixed user name and password as an example, this could be
23569 configured as follows:
23573 public_name = PLAIN
23575 server_condition = \
23576 ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
23577 server_set_id = $auth2
23579 Note that the default result strings from &%if%& (&"true"& or an empty string)
23580 are exactly what we want here, so they need not be specified. Obviously, if the
23581 password contains expansion-significant characters such as dollar, backslash,
23582 or closing brace, they have to be escaped.
23584 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
23585 the end of a string list are ignored). If all the data comes as part of the
23586 AUTH command, as is commonly the case, the prompt is not used. This
23587 authenticator is advertised in the response to EHLO as
23591 and a client host can authenticate itself by sending the command
23593 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
23595 As this contains three strings (more than the number of prompts), no further
23596 data is required from the client. Alternatively, the client may just send
23600 to initiate authentication, in which case the server replies with an empty
23601 prompt. The client must respond with the combined data string.
23603 The data string is base64 encoded, as required by the RFC. This example,
23604 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
23605 represents a zero byte. This is split up into three strings, the first of which
23606 is empty. The &%server_condition%& option in the authenticator checks that the
23607 second two are &`username`& and &`mysecret`& respectively.
23609 Having just one fixed user name and password, as in this example, is not very
23610 realistic, though for a small organization with only a handful of
23611 authenticating clients it could make sense.
23613 A more sophisticated instance of this authenticator could use the user name in
23614 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
23615 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
23616 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
23617 This is an incorrect example:
23619 server_condition = \
23620 ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
23622 The expansion uses the user name (&$auth2$&) as the key to look up a password,
23623 which it then compares to the supplied password (&$auth3$&). Why is this example
23624 incorrect? It works fine for existing users, but consider what happens if a
23625 non-existent user name is given. The lookup fails, but as no success/failure
23626 strings are given for the lookup, it yields an empty string. Thus, to defeat
23627 the authentication, all a client has to do is to supply a non-existent user
23628 name and an empty password. The correct way of writing this test is:
23630 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
23631 {${if eq{$value}{$auth3}}} {false}}
23633 In this case, if the lookup succeeds, the result is checked; if the lookup
23634 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
23635 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
23636 always fails if its second argument is empty. However, the second way of
23637 writing the test makes the logic clearer.
23640 .section "The LOGIN authentication mechanism" "SECID173"
23641 .cindex "LOGIN authentication mechanism"
23642 .cindex "authentication" "LOGIN mechanism"
23643 The LOGIN authentication mechanism is not documented in any RFC, but is in use
23644 in a number of programs. No data is sent with the AUTH command. Instead, a
23645 user name and password are supplied separately, in response to prompts. The
23646 plaintext authenticator can be configured to support this as in this example:
23650 public_name = LOGIN
23651 server_prompts = User Name : Password
23652 server_condition = \
23653 ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
23654 server_set_id = $auth1
23656 Because of the way plaintext operates, this authenticator accepts data supplied
23657 with the AUTH command (in contravention of the specification of LOGIN), but
23658 if the client does not supply it (as is the case for LOGIN clients), the prompt
23659 strings are used to obtain two data items.
23661 Some clients are very particular about the precise text of the prompts. For
23662 example, Outlook Express is reported to recognize only &"Username:"& and
23663 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
23664 strings. It uses the &%ldapauth%& expansion condition to check the user
23665 name and password by binding to an LDAP server:
23669 public_name = LOGIN
23670 server_prompts = Username:: : Password::
23671 server_condition = ${if and{{
23673 ldapauth{user="cn=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
23674 pass=${quote:$auth2} \
23675 ldap://ldap.example.org/} }} }
23676 server_set_id = uid=$auth1,ou=people,o=example.org
23678 We have to check that the username is not empty before using it, because LDAP
23679 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
23680 operator to correctly quote the DN for authentication. However, the basic
23681 &%quote%& operator, rather than any of the LDAP quoting operators, is the
23682 correct one to use for the password, because quoting is needed only to make
23683 the password conform to the Exim syntax. At the LDAP level, the password is an
23684 uninterpreted string.
23687 .section "Support for different kinds of authentication" "SECID174"
23688 A number of string expansion features are provided for the purpose of
23689 interfacing to different ways of user authentication. These include checking
23690 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
23691 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
23697 .section "Using plaintext in a client" "SECID175"
23698 .cindex "options" "&(plaintext)& authenticator (client)"
23699 The &(plaintext)& authenticator has two client options:
23701 .option client_ignore_invalid_base64 plaintext boolean false
23702 If the client receives a server prompt that is not a valid base64 string,
23703 authentication is abandoned by default. However, if this option is set true,
23704 the error in the challenge is ignored and the client sends the response as
23707 .option client_send plaintext string&!! unset
23708 The string is a colon-separated list of authentication data strings. Each
23709 string is independently expanded before being sent to the server. The first
23710 string is sent with the AUTH command; any more strings are sent in response
23711 to prompts from the server. Before each string is expanded, the value of the
23712 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
23713 with &$auth1$& for the first prompt. Up to three prompts are stored in this
23714 way. Thus, the prompt that is received in response to sending the first string
23715 (with the AUTH command) can be used in the expansion of the second string, and
23716 so on. If an invalid base64 string is received when
23717 &%client_ignore_invalid_base64%& is set, an empty string is put in the
23718 &$auth$&<&'n'&> variable.
23720 &*Note*&: You cannot use expansion to create multiple strings, because
23721 splitting takes priority and happens first.
23723 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
23724 the data, further processing is applied to each string before it is sent. If
23725 there are any single circumflex characters in the string, they are converted to
23726 NULs. Should an actual circumflex be required as data, it must be doubled in
23729 This is an example of a client configuration that implements the PLAIN
23730 authentication mechanism with a fixed user name and password:
23734 public_name = PLAIN
23735 client_send = ^username^mysecret
23737 The lack of colons means that the entire text is sent with the AUTH
23738 command, with the circumflex characters converted to NULs. A similar example
23739 that uses the LOGIN mechanism is:
23743 public_name = LOGIN
23744 client_send = : username : mysecret
23746 The initial colon means that the first string is empty, so no data is sent with
23747 the AUTH command itself. The remaining strings are sent in response to
23749 .ecindex IIDplaiauth1
23750 .ecindex IIDplaiauth2
23755 . ////////////////////////////////////////////////////////////////////////////
23756 . ////////////////////////////////////////////////////////////////////////////
23758 .chapter "The cram_md5 authenticator" "CHID9"
23759 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
23760 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
23761 .cindex "CRAM-MD5 authentication mechanism"
23762 .cindex "authentication" "CRAM-MD5 mechanism"
23763 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
23764 sends a challenge string to the client, and the response consists of a user
23765 name and the CRAM-MD5 digest of the challenge string combined with a secret
23766 string (password) which is known to both server and client. Thus, the secret
23767 is not sent over the network as plain text, which makes this authenticator more
23768 secure than &(plaintext)&. However, the downside is that the secret has to be
23769 available in plain text at either end.
23772 .section "Using cram_md5 as a server" "SECID176"
23773 .cindex "options" "&(cram_md5)& authenticator (server)"
23774 This authenticator has one server option, which must be set to configure the
23775 authenticator as a server:
23777 .option server_secret cram_md5 string&!! unset
23778 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
23779 When the server receives the client's response, the user name is placed in
23780 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
23781 obtain the password for that user. The server then computes the CRAM-MD5 digest
23782 that the client should have sent, and checks that it received the correct
23783 string. If the expansion of &%server_secret%& is forced to fail, authentication
23784 fails. If the expansion fails for some other reason, a temporary error code is
23785 returned to the client.
23787 For compatibility with previous releases of Exim, the user name is also placed
23788 in &$1$&. However, the use of this variables for this purpose is now
23789 deprecated, as it can lead to confusion in string expansions that also use
23790 numeric variables for other things.
23792 For example, the following authenticator checks that the user name given by the
23793 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
23794 user name, authentication fails.
23798 public_name = CRAM-MD5
23799 server_secret = ${if eq{$auth1}{ph10}{secret}fail}
23800 server_set_id = $auth1
23802 .vindex "&$authenticated_id$&"
23803 If authentication succeeds, the setting of &%server_set_id%& preserves the user
23804 name in &$authenticated_id$&. A more typical configuration might look up the
23805 secret string in a file, using the user name as the key. For example:
23809 public_name = CRAM-MD5
23810 server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
23812 server_set_id = $auth1
23814 Note that this expansion explicitly forces failure if the lookup fails
23815 because &$auth1$& contains an unknown user name.
23818 .section "Using cram_md5 as a client" "SECID177"
23819 .cindex "options" "&(cram_md5)& authenticator (client)"
23820 When used as a client, the &(cram_md5)& authenticator has two options:
23824 .option client_name cram_md5 string&!! "the primary host name"
23825 This string is expanded, and the result used as the user name data when
23826 computing the response to the server's challenge.
23829 .option client_secret cram_md5 string&!! unset
23830 This option must be set for the authenticator to work as a client. Its value is
23831 expanded and the result used as the secret string when computing the response.
23835 .vindex "&$host_address$&"
23836 Different user names and secrets can be used for different servers by referring
23837 to &$host$& or &$host_address$& in the options. Forced failure of either
23838 expansion string is treated as an indication that this authenticator is not
23839 prepared to handle this case. Exim moves on to the next configured client
23840 authenticator. Any other expansion failure causes Exim to give up trying to
23841 send the message to the current server.
23843 A simple example configuration of a &(cram_md5)& authenticator, using fixed
23848 public_name = CRAM-MD5
23850 client_secret = secret
23852 .ecindex IIDcramauth1
23853 .ecindex IIDcramauth2
23857 . ////////////////////////////////////////////////////////////////////////////
23858 . ////////////////////////////////////////////////////////////////////////////
23860 .chapter "The cyrus_sasl authenticator" "CHID10"
23861 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
23862 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
23863 .cindex "Cyrus" "SASL library"
23865 The code for this authenticator was provided by Matthew Byng-Maddick of A L
23866 Digital Ltd (&url(http://www.aldigital.co.uk)).
23868 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
23869 library implementation of the RFC 2222 (&"Simple Authentication and Security
23870 Layer"&). This library supports a number of authentication mechanisms,
23871 including PLAIN and LOGIN, but also several others that Exim does not support
23872 directly. In particular, there is support for Kerberos authentication.
23874 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
23875 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
23876 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
23877 name of the driver to determine which mechanism to support.
23879 Where access to some kind of secret file is required, for example in GSSAPI
23880 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
23881 user, and that the Cyrus SASL library has no way of escalating privileges
23882 by default. You may also find you need to set environment variables,
23883 depending on the driver you are using.
23885 The application name provided by Exim is &"exim"&, so various SASL options may
23886 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
23887 Kerberos, note that because of limitations in the GSSAPI interface,
23888 changing the server keytab might need to be communicated down to the Kerberos
23889 layer independently. The mechanism for doing so is dependent upon the Kerberos
23890 implementation. For example, for Heimdal, the environment variable KRB5_KTNAME
23891 may be set to point to an alternative keytab file. Exim will pass this
23892 variable through from its own inherited environment when started as root or the
23893 Exim user. The keytab file needs to be readable by the Exim user.
23896 .section "Using cyrus_sasl as a server" "SECID178"
23897 The &(cyrus_sasl)& authenticator has four private options. It puts the username
23898 (on a successful authentication) into &$auth1$&. For compatibility with
23899 previous releases of Exim, the username is also placed in &$1$&. However, the
23900 use of this variable for this purpose is now deprecated, as it can lead to
23901 confusion in string expansions that also use numeric variables for other
23905 .option server_hostname cyrus_sasl string&!! "see below"
23906 This option selects the hostname that is used when communicating with the
23907 library. The default value is &`$primary_hostname`&. It is up to the underlying
23908 SASL plug-in what it does with this data.
23911 .option server_mech cyrus_sasl string "see below"
23912 This option selects the authentication mechanism this driver should use. The
23913 default is the value of the generic &%public_name%& option. This option allows
23914 you to use a different underlying mechanism from the advertised name. For
23918 driver = cyrus_sasl
23919 public_name = X-ANYTHING
23920 server_mech = CRAM-MD5
23921 server_set_id = $auth1
23924 .option server_realm cyrus_sasl string unset
23925 This specifies the SASL realm that the server claims to be in.
23928 .option server_service cyrus_sasl string &`smtp`&
23929 This is the SASL service that the server claims to implement.
23932 For straightforward cases, you do not need to set any of the authenticator's
23933 private options. All you need to do is to specify an appropriate mechanism as
23934 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
23935 PLAIN, you could have two authenticators as follows:
23938 driver = cyrus_sasl
23939 public_name = CRAM-MD5
23940 server_set_id = $auth1
23943 driver = cyrus_sasl
23944 public_name = PLAIN
23945 server_set_id = $auth2
23947 Cyrus SASL does implement the LOGIN authentication method, even though it is
23948 not a standard method. It is disabled by default in the source distribution,
23949 but it is present in many binary distributions.
23950 .ecindex IIDcyrauth1
23951 .ecindex IIDcyrauth2
23956 . ////////////////////////////////////////////////////////////////////////////
23957 . ////////////////////////////////////////////////////////////////////////////
23958 .chapter "The dovecot authenticator" "CHAPdovecot"
23959 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
23960 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
23961 This authenticator is an interface to the authentication facility of the
23962 Dovecot POP/IMAP server, which can support a number of authentication methods.
23963 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
23964 to use the same mechanisms for SMTP authentication. This is a server
23965 authenticator only. There is only one option:
23967 .option server_socket dovecot string unset
23969 This option must specify the socket that is the interface to Dovecot
23970 authentication. The &%public_name%& option must specify an authentication
23971 mechanism that Dovecot is configured to support. You can have several
23972 authenticators for different mechanisms. For example:
23976 public_name = PLAIN
23977 server_socket = /var/run/dovecot/auth-client
23978 server_set_id = $auth2
23983 server_socket = /var/run/dovecot/auth-client
23984 server_set_id = $auth1
23986 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
23987 &$received_ip_address$& (that is, the connection is local), the &"secured"&
23988 option is passed in the Dovecot authentication command. If, for a TLS
23989 connection, a client certificate has been verified, the &"valid-client-cert"&
23990 option is passed. When authentication succeeds, the identity of the user
23991 who authenticated is placed in &$auth1$&.
23992 .ecindex IIDdcotauth1
23993 .ecindex IIDdcotauth2
23996 . ////////////////////////////////////////////////////////////////////////////
23997 . ////////////////////////////////////////////////////////////////////////////
23999 .chapter "The spa authenticator" "CHAPspa"
24000 .scindex IIDspaauth1 "&(spa)& authenticator"
24001 .scindex IIDspaauth2 "authenticators" "&(spa)&"
24002 .cindex "authentication" "Microsoft Secure Password"
24003 .cindex "authentication" "NTLM"
24004 .cindex "Microsoft Secure Password Authentication"
24005 .cindex "NTLM authentication"
24006 The &(spa)& authenticator provides client support for Microsoft's &'Secure
24007 Password Authentication'& mechanism,
24008 which is also sometimes known as NTLM (NT LanMan). The code for client side of
24009 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
24010 taken from the Samba project (&url(http://www.samba.org)). The code for the
24011 server side was subsequently contributed by Tom Kistner. The mechanism works as
24015 After the AUTH command has been accepted, the client sends an SPA
24016 authentication request based on the user name and optional domain.
24018 The server sends back a challenge.
24020 The client builds a challenge response which makes use of the user's password
24021 and sends it to the server, which then accepts or rejects it.
24024 Encryption is used to protect the password in transit.
24028 .section "Using spa as a server" "SECID179"
24029 .cindex "options" "&(spa)& authenticator (server)"
24030 The &(spa)& authenticator has just one server option:
24032 .option server_password spa string&!! unset
24033 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
24034 This option is expanded, and the result must be the cleartext password for the
24035 authenticating user, whose name is at this point in &$auth1$&. For
24036 compatibility with previous releases of Exim, the user name is also placed in
24037 &$1$&. However, the use of this variable for this purpose is now deprecated, as
24038 it can lead to confusion in string expansions that also use numeric variables
24039 for other things. For example:
24044 server_password = \
24045 ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
24047 If the expansion is forced to fail, authentication fails. Any other expansion
24048 failure causes a temporary error code to be returned.
24054 .section "Using spa as a client" "SECID180"
24055 .cindex "options" "&(spa)& authenticator (client)"
24056 The &(spa)& authenticator has the following client options:
24060 .option client_domain spa string&!! unset
24061 This option specifies an optional domain for the authentication.
24064 .option client_password spa string&!! unset
24065 This option specifies the user's password, and must be set.
24068 .option client_username spa string&!! unset
24069 This option specifies the user name, and must be set. Here is an example of a
24070 configuration of this authenticator for use with the mail servers at
24076 client_username = msn/msn_username
24077 client_password = msn_plaintext_password
24078 client_domain = DOMAIN_OR_UNSET
24080 .ecindex IIDspaauth1
24081 .ecindex IIDspaauth2
24087 . ////////////////////////////////////////////////////////////////////////////
24088 . ////////////////////////////////////////////////////////////////////////////
24090 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
24091 "Encrypted SMTP connections"
24092 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
24093 .scindex IIDencsmtp2 "SMTP" "encryption"
24094 .cindex "TLS" "on SMTP connection"
24097 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
24098 Sockets Layer), is implemented by making use of the OpenSSL library or the
24099 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
24100 cryptographic code in the Exim distribution itself for implementing TLS. In
24101 order to use this feature you must install OpenSSL or GnuTLS, and then build a
24102 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
24103 You also need to understand the basic concepts of encryption at a managerial
24104 level, and in particular, the way that public keys, private keys, and
24105 certificates are used.
24107 RFC 3207 defines how SMTP connections can make use of encryption. Once a
24108 connection is established, the client issues a STARTTLS command. If the
24109 server accepts this, the client and the server negotiate an encryption
24110 mechanism. If the negotiation succeeds, the data that subsequently passes
24111 between them is encrypted.
24113 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
24114 and if so, what cipher suite is in use, whether the client supplied a
24115 certificate, and whether or not that certificate was verified. This makes it
24116 possible for an Exim server to deny or accept certain commands based on the
24119 &*Warning*&: Certain types of firewall and certain anti-virus products can
24120 disrupt TLS connections. You need to turn off SMTP scanning for these products
24121 in order to get TLS to work.
24125 .section "Support for the legacy &""ssmtp""& (aka &""smtps""&) protocol" &&&
24127 .cindex "ssmtp protocol"
24128 .cindex "smtps protocol"
24129 .cindex "SMTP" "ssmtp protocol"
24130 .cindex "SMTP" "smtps protocol"
24131 Early implementations of encrypted SMTP used a different TCP port from normal
24132 SMTP, and expected an encryption negotiation to start immediately, instead of
24133 waiting for a STARTTLS command from the client using the standard SMTP
24134 port. The protocol was called &"ssmtp"& or &"smtps"&, and port 465 was
24135 allocated for this purpose.
24137 This approach was abandoned when encrypted SMTP was standardized, but there are
24138 still some legacy clients that use it. Exim supports these clients by means of
24139 the &%tls_on_connect_ports%& global option. Its value must be a list of port
24140 numbers; the most common use is expected to be:
24142 tls_on_connect_ports = 465
24144 The port numbers specified by this option apply to all SMTP connections, both
24145 via the daemon and via &'inetd'&. You still need to specify all the ports that
24146 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
24147 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
24148 an extra port &-- rather, it specifies different behaviour on a port that is
24151 There is also a &%-tls-on-connect%& command line option. This overrides
24152 &%tls_on_connect_ports%&; it forces the legacy behaviour for all ports.
24159 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
24160 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
24161 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
24162 followed later, when the first versions of GnuTLS were released. To build Exim
24163 to use GnuTLS, you need to set
24167 in Local/Makefile, in addition to
24171 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
24172 include files and libraries for GnuTLS can be found.
24174 There are some differences in usage when using GnuTLS instead of OpenSSL:
24177 The &%tls_verify_certificates%& option must contain the name of a file, not the
24178 name of a directory (for OpenSSL it can be either).
24180 The &%tls_dhparam%& option is ignored, because early versions of GnuTLS had no
24181 facility for varying its Diffie-Hellman parameters. I understand that this has
24182 changed, but Exim has not been updated to provide this facility.
24184 .vindex "&$tls_peerdn$&"
24185 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
24186 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
24187 affects the value of the &$tls_peerdn$& variable.
24189 OpenSSL identifies cipher suites using hyphens as separators, for example:
24190 DES-CBC3-SHA. GnuTLS uses underscores, for example: RSA_ARCFOUR_SHA. What is
24191 more, OpenSSL complains if underscores are present in a cipher list. To make
24192 life simpler, Exim changes underscores to hyphens for OpenSSL and hyphens to
24193 underscores for GnuTLS when processing lists of cipher suites in the
24194 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
24197 The &%tls_require_ciphers%& options operate differently, as described in the
24198 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
24202 .section "GnuTLS parameter computation" "SECID181"
24203 GnuTLS uses D-H parameters that may take a substantial amount of time
24204 to compute. It is unreasonable to re-compute them for every TLS session.
24205 Therefore, Exim keeps this data in a file in its spool directory, called
24206 &_gnutls-params_&. The file is owned by the Exim user and is readable only by
24207 its owner. Every Exim process that start up GnuTLS reads the D-H
24208 parameters from this file. If the file does not exist, the first Exim process
24209 that needs it computes the data and writes it to a temporary file which is
24210 renamed once it is complete. It does not matter if several Exim processes do
24211 this simultaneously (apart from wasting a few resources). Once a file is in
24212 place, new Exim processes immediately start using it.
24214 For maximum security, the parameters that are stored in this file should be
24215 recalculated periodically, the frequency depending on your paranoia level.
24216 Arranging this is easy in principle; just delete the file when you want new
24217 values to be computed. However, there may be a problem. The calculation of new
24218 parameters needs random numbers, and these are obtained from &_/dev/random_&.
24219 If the system is not very active, &_/dev/random_& may delay returning data
24220 until enough randomness (entropy) is available. This may cause Exim to hang for
24221 a substantial amount of time, causing timeouts on incoming connections.
24223 The solution is to generate the parameters externally to Exim. They are stored
24224 in &_gnutls-params_& in PEM format, which means that they can be generated
24225 externally using the &(certtool)& command that is part of GnuTLS.
24227 To replace the parameters with new ones, instead of deleting the file
24228 and letting Exim re-create it, you can generate new parameters using
24229 &(certtool)& and, when this has been done, replace Exim's cache file by
24230 renaming. The relevant commands are something like this:
24234 # chown exim:exim new-params
24235 # chmod 0400 new-params
24236 # certtool --generate-privkey --bits 512 >new-params
24237 # echo "" >>new-params
24238 # certtool --generate-dh-params --bits 1024 >> new-params
24239 # mv new-params gnutls-params
24241 If Exim never has to generate the parameters itself, the possibility of
24242 stalling is removed.
24245 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
24246 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
24247 .oindex "&%tls_require_ciphers%&" "OpenSSL"
24248 There is a function in the OpenSSL library that can be passed a list of cipher
24249 suites before the cipher negotiation takes place. This specifies which ciphers
24250 are acceptable. The list is colon separated and may contain names like
24251 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
24252 directly to this function call. The following quotation from the OpenSSL
24253 documentation specifies what forms of item are allowed in the cipher string:
24256 It can consist of a single cipher suite such as RC4-SHA.
24258 It can represent a list of cipher suites containing a certain algorithm,
24259 or cipher suites of a certain type. For example SHA1 represents all
24260 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
24263 Lists of cipher suites can be combined in a single cipher string using
24264 the + character. This is used as a logical and operation. For example
24265 SHA1+DES represents all cipher suites containing the SHA1 and the DES
24269 Each cipher string can be optionally preceded by one of the characters &`!`&,
24272 If &`!`& is used, the ciphers are permanently deleted from the list. The
24273 ciphers deleted can never reappear in the list even if they are explicitly
24276 If &`-`& is used, the ciphers are deleted from the list, but some or all
24277 of the ciphers can be added again by later options.
24279 If &`+`& is used, the ciphers are moved to the end of the list. This
24280 option does not add any new ciphers; it just moves matching existing ones.
24283 If none of these characters is present, the string is interpreted as
24284 a list of ciphers to be appended to the current preference list. If the list
24285 includes any ciphers already present they will be ignored: that is, they will
24286 not be moved to the end of the list.
24291 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
24293 .cindex "GnuTLS" "specifying parameters for"
24294 .cindex "TLS" "specifying ciphers (GnuTLS)"
24295 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
24296 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
24297 .cindex "TLS" "specifying protocols (GnuTLS)"
24298 .oindex "&%tls_require_ciphers%&" "GnuTLS"
24299 The GnuTLS library allows the caller to specify separate lists of permitted key
24300 exchange methods, main cipher algorithms, MAC algorithms, and protocols.
24301 Unfortunately, these lists are numerical, and the library does not have a
24302 function for turning names into numbers. Consequently, lists of recognized
24303 names have to be built into the application. The permitted key exchange
24304 methods, ciphers, and MAC algorithms may be used in any combination to form a
24305 cipher suite. This is unlike OpenSSL, where complete cipher suite names are
24306 passed to its control function.
24308 For compatibility with OpenSSL, the &%tls_require_ciphers%& option can be set
24309 to complete cipher suite names such as RSA_ARCFOUR_SHA, but for GnuTLS this
24310 option controls only the cipher algorithms. Exim searches each item in the
24311 list for the name of an available algorithm. For example, if the list
24312 contains RSA_AES_SHA, then AES is recognized, and the behaviour is exactly
24313 the same as if just AES were given.
24315 .oindex "&%gnutls_require_kx%&"
24316 .oindex "&%gnutls_require_mac%&"
24317 .oindex "&%gnutls_require_protocols%&"
24318 There are additional options called &%gnutls_require_kx%&,
24319 &%gnutls_require_mac%&, and &%gnutls_require_protocols%& that can be used to
24320 restrict the key exchange methods, MAC algorithms, and protocols, respectively.
24321 These options are ignored if OpenSSL is in use.
24323 All four options are available as global options, controlling how Exim
24324 behaves as a server, and also as options of the &(smtp)& transport, controlling
24325 how Exim behaves as a client. All the values are string expanded. After
24326 expansion, the values must be colon-separated lists, though the separator
24327 can be changed in the usual way.
24329 Each of the four lists starts out with a default set of algorithms. If the
24330 first item in a list does &'not'& start with an exclamation mark, all the
24331 default items are deleted. In this case, only those that are explicitly
24332 specified can be used. If the first item in a list &'does'& start with an
24333 exclamation mark, the defaults are left on the list.
24335 Then, any item that starts with an exclamation mark causes the relevant
24336 entry to be removed from the list, and any item that does not start with an
24337 exclamation mark causes a new entry to be added to the list. Unrecognized
24338 items in the list are ignored. Thus:
24340 tls_require_ciphers = !ARCFOUR
24342 allows all the defaults except ARCFOUR, whereas
24344 tls_require_ciphers = AES : 3DES
24346 allows only cipher suites that use AES or 3DES.
24348 For &%tls_require_ciphers%& the recognized names are AES_256, AES_128, AES
24349 (both of the preceding), 3DES, ARCFOUR_128, ARCFOUR_40, and ARCFOUR (both of
24350 the preceding). The default list does not contain all of these; it just has
24351 AES_256, AES_128, 3DES, and ARCFOUR_128.
24353 For &%gnutls_require_kx%&, the recognized names are DHE_RSA, RSA (which
24354 includes DHE_RSA), DHE_DSS, and DHE (which includes both DHE_RSA and
24355 DHE_DSS). The default list contains RSA, DHE_DSS, DHE_RSA.
24357 For &%gnutls_require_mac%&, the recognized names are SHA (synonym SHA1), and
24358 MD5. The default list contains SHA, MD5.
24360 For &%gnutls_require_protocols%&, the recognized names are TLS1 and SSL3.
24361 The default list contains TLS1, SSL3.
24363 In a server, the order of items in these lists is unimportant. The server
24364 advertises the availability of all the relevant cipher suites. However, in a
24365 client, the order in the &%tls_require_ciphers%& list specifies a preference
24366 order for the cipher algorithms. The first one in the client's list that is
24367 also advertised by the server is tried first. The default order is as listed
24372 .section "Configuring an Exim server to use TLS" "SECID182"
24373 .cindex "TLS" "configuring an Exim server"
24374 When Exim has been built with TLS support, it advertises the availability of
24375 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
24376 but not to any others. The default value of this option is unset, which means
24377 that STARTTLS is not advertised at all. This default is chosen because you
24378 need to set some other options in order to make TLS available, and also it is
24379 sensible for systems that want to use TLS only as a client.
24381 If a client issues a STARTTLS command and there is some configuration
24382 problem in the server, the command is rejected with a 454 error. If the client
24383 persists in trying to issue SMTP commands, all except QUIT are rejected
24386 554 Security failure
24388 If a STARTTLS command is issued within an existing TLS session, it is
24389 rejected with a 554 error code.
24391 To enable TLS operations on a server, you must set &%tls_advertise_hosts%& to
24392 match some hosts. You can, of course, set it to * to match all hosts.
24393 However, this is not all you need to do. TLS sessions to a server won't work
24394 without some further configuration at the server end.
24396 It is rumoured that all existing clients that support TLS/SSL use RSA
24397 encryption. To make this work you need to set, in the server,
24399 tls_certificate = /some/file/name
24400 tls_privatekey = /some/file/name
24402 These options are, in fact, expanded strings, so you can make them depend on
24403 the identity of the client that is connected if you wish. The first file
24404 contains the server's X509 certificate, and the second contains the private key
24405 that goes with it. These files need to be readable by the Exim user, and must
24406 always be given as full path names. They can be the same file if both the
24407 certificate and the key are contained within it. If &%tls_privatekey%& is not
24408 set, or if its expansion is forced to fail or results in an empty string, this
24409 is assumed to be the case. The certificate file may also contain intermediate
24410 certificates that need to be sent to the client to enable it to authenticate
24411 the server's certificate.
24413 If you do not understand about certificates and keys, please try to find a
24414 source of this background information, which is not Exim-specific. (There are a
24415 few comments below in section &<<SECTcerandall>>&.)
24417 &*Note*&: These options do not apply when Exim is operating as a client &--
24418 they apply only in the case of a server. If you need to use a certificate in an
24419 Exim client, you must set the options of the same names in an &(smtp)&
24422 With just these options, an Exim server will be able to use TLS. It does not
24423 require the client to have a certificate (but see below for how to insist on
24424 this). There is one other option that may be needed in other situations. If
24426 tls_dhparam = /some/file/name
24428 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
24429 with the parameters contained in the file. This increases the set of cipher
24430 suites that the server supports. See the command
24434 for a way of generating this data. At present, &%tls_dhparam%& is used only
24435 when Exim is linked with OpenSSL. It is ignored if GnuTLS is being used.
24437 The strings supplied for these three options are expanded every time a client
24438 host connects. It is therefore possible to use different certificates and keys
24439 for different hosts, if you so wish, by making use of the client's IP address
24440 in &$sender_host_address$& to control the expansion. If a string expansion is
24441 forced to fail, Exim behaves as if the option is not set.
24443 .cindex "cipher" "logging"
24444 .cindex "log" "TLS cipher"
24445 .vindex "&$tls_cipher$&"
24446 The variable &$tls_cipher$& is set to the cipher suite that was negotiated for
24447 an incoming TLS connection. It is included in the &'Received:'& header of an
24448 incoming message (by default &-- you can, of course, change this), and it is
24449 also included in the log line that records a message's arrival, keyed by
24450 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
24451 condition can be used to test for specific cipher suites in ACLs.
24452 (For outgoing SMTP deliveries, &$tls_cipher$& is reset &-- see section
24455 Once TLS has been established, the ACLs that run for subsequent SMTP commands
24456 can check the name of the cipher suite and vary their actions accordingly. The
24457 cipher suite names vary, depending on which TLS library is being used. For
24458 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
24459 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
24460 documentation for more details.
24463 .section "Requesting and verifying client certificates" "SECID183"
24464 .cindex "certificate" "verification of client"
24465 .cindex "TLS" "client certificate verification"
24466 If you want an Exim server to request a certificate when negotiating a TLS
24467 session with a client, you must set either &%tls_verify_hosts%& or
24468 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
24469 apply to all TLS connections. For any host that matches one of these options,
24470 Exim requests a certificate as part of the setup of the TLS session. The
24471 contents of the certificate are verified by comparing it with a list of
24472 expected certificates. These must be available in a file or,
24473 for OpenSSL only (not GnuTLS), a directory, identified by
24474 &%tls_verify_certificates%&.
24476 A file can contain multiple certificates, concatenated end to end. If a
24479 each certificate must be in a separate file, with a name (or a symbolic link)
24480 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
24481 certificate. You can compute the relevant hash by running the command
24483 openssl x509 -hash -noout -in /cert/file
24485 where &_/cert/file_& contains a single certificate.
24487 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
24488 what happens if the client does not supply a certificate, or if the certificate
24489 does not match any of the certificates in the collection named by
24490 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
24491 attempt to set up a TLS session is aborted, and the incoming connection is
24492 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
24493 session continues. ACLs that run for subsequent SMTP commands can detect the
24494 fact that no certificate was verified, and vary their actions accordingly. For
24495 example, you can insist on a certificate before accepting a message for
24496 relaying, but not when the message is destined for local delivery.
24498 .vindex "&$tls_peerdn$&"
24499 When a client supplies a certificate (whether it verifies or not), the value of
24500 the Distinguished Name of the certificate is made available in the variable
24501 &$tls_peerdn$& during subsequent processing of the message.
24503 .cindex "log" "distinguished name"
24504 Because it is often a long text string, it is not included in the log line or
24505 &'Received:'& header by default. You can arrange for it to be logged, keyed by
24506 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
24507 &%received_header_text%& to change the &'Received:'& header. When no
24508 certificate is supplied, &$tls_peerdn$& is empty.
24511 .section "Revoked certificates" "SECID184"
24512 .cindex "TLS" "revoked certificates"
24513 .cindex "revocation list"
24514 .cindex "certificate" "revocation list"
24515 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
24516 certificates are revoked. If you have such a list, you can pass it to an Exim
24517 server using the global option called &%tls_crl%& and to an Exim client using
24518 an identically named option for the &(smtp)& transport. In each case, the value
24519 of the option is expanded and must then be the name of a file that contains a
24523 .section "Configuring an Exim client to use TLS" "SECID185"
24524 .cindex "cipher" "logging"
24525 .cindex "log" "TLS cipher"
24526 .cindex "log" "distinguished name"
24527 .cindex "TLS" "configuring an Exim client"
24528 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
24529 deliveries as well as to incoming, the latter one causing logging of the
24530 server certificate's DN. The remaining client configuration for TLS is all
24531 within the &(smtp)& transport.
24533 It is not necessary to set any options to have TLS work in the &(smtp)&
24534 transport. If Exim is built with TLS support, and TLS is advertised by a
24535 server, the &(smtp)& transport always tries to start a TLS session. However,
24536 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
24537 transport) to a list of server hosts for which TLS should not be used.
24539 If you do not want Exim to attempt to send messages unencrypted when an attempt
24540 to set up an encrypted connection fails in any way, you can set
24541 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
24542 those hosts, delivery is always deferred if an encrypted connection cannot be
24543 set up. If there are any other hosts for the address, they are tried in the
24546 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
24547 the message unencrypted. It always does this if the response to STARTTLS is
24548 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
24549 session after a success response code, what happens is controlled by the
24550 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
24551 delivery to this host is deferred, and other hosts (if available) are tried. If
24552 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
24553 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
24554 negotiation fails, Exim closes the current connection (because it is in an
24555 unknown state), opens a new one to the same host, and then tries the delivery
24558 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
24559 transport provide the client with a certificate, which is passed to the server
24560 if it requests it. If the server is Exim, it will request a certificate only if
24561 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
24563 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
24564 must name a file or,
24565 for OpenSSL only (not GnuTLS), a directory, that contains a collection of
24566 expected server certificates. The client verifies the server's certificate
24567 against this collection, taking into account any revoked certificates that are
24568 in the list defined by &%tls_crl%&.
24571 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
24572 list of permitted cipher suites. If either of these checks fails, delivery to
24573 the current host is abandoned, and the &(smtp)& transport tries to deliver to
24574 alternative hosts, if any.
24577 These options must be set in the &(smtp)& transport for Exim to use TLS when it
24578 is operating as a client. Exim does not assume that a server certificate (set
24579 by the global options of the same name) should also be used when operating as a
24583 .vindex "&$host_address$&"
24584 All the TLS options in the &(smtp)& transport are expanded before use, with
24585 &$host$& and &$host_address$& containing the name and address of the server to
24586 which the client is connected. Forced failure of an expansion causes Exim to
24587 behave as if the relevant option were unset.
24589 .vindex &$tls_cipher$&
24590 .vindex &$tls_peerdn$&
24591 Before an SMTP connection is established, the &$tls_cipher$& and &$tls_peerdn$&
24592 variables are emptied. (Until the first connection, they contain the values
24593 that were set when the message was received.) If STARTTLS is subsequently
24594 successfully obeyed, these variables are set to the relevant values for the
24595 outgoing connection.
24599 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
24601 .cindex "multiple SMTP deliveries with TLS"
24602 .cindex "TLS" "multiple message deliveries"
24603 Exim sends multiple messages down the same TCP/IP connection by starting up
24604 an entirely new delivery process for each message, passing the socket from
24605 one process to the next. This implementation does not fit well with the use
24606 of TLS, because there is quite a lot of state information associated with a TLS
24607 connection, not just a socket identification. Passing all the state information
24608 to a new process is not feasible. Consequently, Exim shuts down an existing TLS
24609 session before passing the socket to a new process. The new process may then
24610 try to start a new TLS session, and if successful, may try to re-authenticate
24611 if AUTH is in use, before sending the next message.
24613 The RFC is not clear as to whether or not an SMTP session continues in clear
24614 after TLS has been shut down, or whether TLS may be restarted again later, as
24615 just described. However, if the server is Exim, this shutdown and
24616 reinitialization works. It is not known which (if any) other servers operate
24617 successfully if the client closes a TLS session and continues with unencrypted
24618 SMTP, but there are certainly some that do not work. For such servers, Exim
24619 should not pass the socket to another process, because the failure of the
24620 subsequent attempt to use it would cause Exim to record a temporary host error,
24621 and delay other deliveries to that host.
24623 To test for this case, Exim sends an EHLO command to the server after
24624 closing down the TLS session. If this fails in any way, the connection is
24625 closed instead of being passed to a new delivery process, but no retry
24626 information is recorded.
24628 There is also a manual override; you can set &%hosts_nopass_tls%& on the
24629 &(smtp)& transport to match those hosts for which Exim should not pass
24630 connections to new processes if TLS has been used.
24635 .section "Certificates and all that" "SECTcerandall"
24636 .cindex "certificate" "references to discussion"
24637 In order to understand fully how TLS works, you need to know about
24638 certificates, certificate signing, and certificate authorities. This is not the
24639 place to give a tutorial, especially as I do not know very much about it
24640 myself. Some helpful introduction can be found in the FAQ for the SSL addition
24641 to Apache, currently at
24643 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
24645 Other parts of the &'modssl'& documentation are also helpful, and have
24646 links to further files.
24647 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
24648 0-201-61598-3), contains both introductory and more in-depth descriptions.
24649 Some sample programs taken from the book are available from
24651 &url(http://www.rtfm.com/openssl-examples/)
24655 .section "Certificate chains" "SECID186"
24656 The file named by &%tls_certificate%& may contain more than one
24657 certificate. This is useful in the case where the certificate that is being
24658 sent is validated by an intermediate certificate which the other end does
24659 not have. Multiple certificates must be in the correct order in the file.
24660 First the host's certificate itself, then the first intermediate
24661 certificate to validate the issuer of the host certificate, then the next
24662 intermediate certificate to validate the issuer of the first intermediate
24663 certificate, and so on, until finally (optionally) the root certificate.
24664 The root certificate must already be trusted by the recipient for
24665 validation to succeed, of course, but if it's not preinstalled, sending the
24666 root certificate along with the rest makes it available for the user to
24667 install if the receiving end is a client MUA that can interact with a user.
24670 .section "Self-signed certificates" "SECID187"
24671 .cindex "certificate" "self-signed"
24672 You can create a self-signed certificate using the &'req'& command provided
24673 with OpenSSL, like this:
24675 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
24678 &_file1_& and &_file2_& can be the same file; the key and the certificate are
24679 delimited and so can be identified independently. The &%-days%& option
24680 specifies a period for which the certificate is valid. The &%-nodes%& option is
24681 important: if you do not set it, the key is encrypted with a passphrase
24682 that you are prompted for, and any use that is made of the key causes more
24683 prompting for the passphrase. This is not helpful if you are going to use
24684 this certificate and key in an MTA, where prompting is not possible.
24686 A self-signed certificate made in this way is sufficient for testing, and
24687 may be adequate for all your requirements if you are mainly interested in
24688 encrypting transfers, and not in secure identification.
24690 However, many clients require that the certificate presented by the server be a
24691 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
24692 certificate. In this situation, the self-signed certificate described above
24693 must be installed on the client host as a trusted root &'certification
24694 authority'& (CA), and the certificate used by Exim must be a user certificate
24695 signed with that self-signed certificate.
24697 For information on creating self-signed CA certificates and using them to sign
24698 user certificates, see the &'General implementation overview'& chapter of the
24699 Open-source PKI book, available online at
24700 &url(http://ospkibook.sourceforge.net/).
24701 .ecindex IIDencsmtp1
24702 .ecindex IIDencsmtp2
24706 . ////////////////////////////////////////////////////////////////////////////
24707 . ////////////////////////////////////////////////////////////////////////////
24709 .chapter "Access control lists" "CHAPACL"
24710 .scindex IIDacl "&ACL;" "description"
24711 .cindex "control of incoming mail"
24712 .cindex "message" "controlling incoming"
24713 .cindex "policy control" "access control lists"
24714 Access Control Lists (ACLs) are defined in a separate section of the run time
24715 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
24716 name, terminated by a colon. Here is a complete ACL section that contains just
24717 one very small ACL:
24721 accept hosts = one.host.only
24723 You can have as many lists as you like in the ACL section, and the order in
24724 which they appear does not matter. The lists are self-terminating.
24726 The majority of ACLs are used to control Exim's behaviour when it receives
24727 certain SMTP commands. This applies both to incoming TCP/IP connections, and
24728 when a local process submits a message using SMTP by specifying the &%-bs%&
24729 option. The most common use is for controlling which recipients are accepted
24730 in incoming messages. In addition, you can define an ACL that is used to check
24731 local non-SMTP messages. The default configuration file contains an example of
24732 a realistic ACL for checking RCPT commands. This is discussed in chapter
24733 &<<CHAPdefconfil>>&.
24736 .section "Testing ACLs" "SECID188"
24737 The &%-bh%& command line option provides a way of testing your ACL
24738 configuration locally by running a fake SMTP session with which you interact.
24739 The host &'relay-test.mail-abuse.org'& provides a service for checking your
24740 relaying configuration (see section &<<SECTcheralcon>>& for more details).
24744 .section "Specifying when ACLs are used" "SECID189"
24745 .cindex "&ACL;" "options for specifying"
24746 In order to cause an ACL to be used, you have to name it in one of the relevant
24747 options in the main part of the configuration. These options are:
24748 .cindex "AUTH" "ACL for"
24749 .cindex "DATA" "ACLs for"
24750 .cindex "ETRN" "ACL for"
24751 .cindex "EXPN" "ACL for"
24752 .cindex "HELO" "ACL for"
24753 .cindex "EHLO" "ACL for"
24754 .cindex "MAIL" "ACL for"
24755 .cindex "QUIT, ACL for"
24756 .cindex "RCPT" "ACL for"
24757 .cindex "STARTTLS, ACL for"
24758 .cindex "VRFY" "ACL for"
24759 .cindex "SMTP" "connection, ACL for"
24760 .cindex "non-SMTP messages" "ACLs for"
24761 .cindex "MIME content scanning" "ACL for"
24764 .irow &%acl_not_smtp%& "ACL for non-SMTP messages"
24765 .irow &%acl_not_smtp_mime%& "ACL for non-SMTP MIME parts"
24766 .irow &%acl_not_smtp_start%& "ACL at start of non-SMTP message"
24767 .irow &%acl_smtp_auth%& "ACL for AUTH"
24768 .irow &%acl_smtp_connect%& "ACL for start of SMTP connection"
24769 .irow &%acl_smtp_data%& "ACL after DATA is complete"
24770 .irow &%acl_smtp_etrn%& "ACL for ETRN"
24771 .irow &%acl_smtp_expn%& "ACL for EXPN"
24772 .irow &%acl_smtp_helo%& "ACL for HELO or EHLO"
24773 .irow &%acl_smtp_mail%& "ACL for MAIL"
24774 .irow &%acl_smtp_mailauth%& "ACL for the AUTH parameter of MAIL"
24775 .irow &%acl_smtp_mime%& "ACL for content-scanning MIME parts"
24776 .irow &%acl_smtp_notquit%& "ACL for non-QUIT terminations"
24777 .irow &%acl_smtp_predata%& "ACL at start of DATA command"
24778 .irow &%acl_smtp_quit%& "ACL for QUIT"
24779 .irow &%acl_smtp_rcpt%& "ACL for RCPT"
24780 .irow &%acl_smtp_starttls%& "ACL for STARTTLS"
24781 .irow &%acl_smtp_vrfy%& "ACL for VRFY"
24784 For example, if you set
24786 acl_smtp_rcpt = small_acl
24788 the little ACL defined above is used whenever Exim receives a RCPT command
24789 in an SMTP dialogue. The majority of policy tests on incoming messages can be
24790 done when RCPT commands arrive. A rejection of RCPT should cause the
24791 sending MTA to give up on the recipient address contained in the RCPT
24792 command, whereas rejection at other times may cause the client MTA to keep on
24793 trying to deliver the message. It is therefore recommended that you do as much
24794 testing as possible at RCPT time.
24797 .section "The non-SMTP ACLs" "SECID190"
24798 .cindex "non-SMTP messages" "ACLs for"
24799 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
24800 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
24801 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
24802 the state of the SMTP connection such as encryption and authentication) are not
24803 relevant and are forbidden in these ACLs. However, the sender and recipients
24804 are known, so the &%senders%& and &%sender_domains%& conditions and the
24805 &$sender_address$& and &$recipients$& variables can be used. Variables such as
24806 &$authenticated_sender$& are also available. You can specify added header lines
24807 in any of these ACLs.
24809 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
24810 non-SMTP message, before any of the message has been read. (This is the
24811 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
24812 batched SMTP input, it runs after the DATA command has been reached. The
24813 result of this ACL is ignored; it cannot be used to reject a message. If you
24814 really need to, you could set a value in an ACL variable here and reject based
24815 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
24816 controls, and in particular, it can be used to set
24818 control = suppress_local_fixups
24820 This cannot be used in the other non-SMTP ACLs because by the time they are
24821 run, it is too late.
24823 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
24824 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
24826 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
24827 kind of rejection is treated as permanent, because there is no way of sending a
24828 temporary error for these kinds of message.
24831 .section "The SMTP connect ACL" "SECID191"
24832 .cindex "SMTP" "connection, ACL for"
24833 .oindex &%smtp_banner%&
24834 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
24835 session, after the test specified by &%host_reject_connection%& (which is now
24836 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
24837 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
24838 the message override the banner message that is otherwise specified by the
24839 &%smtp_banner%& option.
24842 .section "The EHLO/HELO ACL" "SECID192"
24843 .cindex "EHLO" "ACL for"
24844 .cindex "HELO" "ACL for"
24845 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
24846 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
24847 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
24848 Note that a client may issue more than one EHLO or HELO command in an SMTP
24849 session, and indeed is required to issue a new EHLO or HELO after successfully
24850 setting up encryption following a STARTTLS command.
24852 If the command is accepted by an &%accept%& verb that has a &%message%&
24853 modifier, the message may not contain more than one line (it will be truncated
24854 at the first newline and a panic logged if it does). Such a message cannot
24855 affect the EHLO options that are listed on the second and subsequent lines of
24859 .section "The DATA ACLs" "SECID193"
24860 .cindex "DATA" "ACLs for"
24861 Two ACLs are associated with the DATA command, because it is two-stage
24862 command, with two responses being sent to the client.
24863 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
24864 is obeyed. This gives you control after all the RCPT commands, but before
24865 the message itself is received. It offers the opportunity to give a negative
24866 response to the DATA command before the data is transmitted. Header lines
24867 added by MAIL or RCPT ACLs are not visible at this time, but any that
24868 are defined here are visible when the &%acl_smtp_data%& ACL is run.
24870 You cannot test the contents of the message, for example, to verify addresses
24871 in the headers, at RCPT time or when the DATA command is received. Such
24872 tests have to appear in the ACL that is run after the message itself has been
24873 received, before the final response to the DATA command is sent. This is
24874 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
24875 associated with the DATA command.
24877 For both of these ACLs, it is not possible to reject individual recipients. An
24878 error response rejects the entire message. Unfortunately, it is known that some
24879 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
24880 before or after the data) correctly &-- they keep the message on their queues
24881 and try again later, but that is their problem, though it does waste some of
24885 .section "The SMTP MIME ACL" "SECID194"
24886 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
24887 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
24890 .section "The QUIT ACL" "SECTQUITACL"
24891 .cindex "QUIT, ACL for"
24892 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
24893 does not affect the response code to QUIT, which is always 221. Thus, the ACL
24894 does not in fact control any access. For this reason, the only verbs that are
24895 permitted are &%accept%& and &%warn%&.
24897 This ACL can be used for tasks such as custom logging at the end of an SMTP
24898 session. For example, you can use ACL variables in other ACLs to count
24899 messages, recipients, etc., and log the totals at QUIT time using one or
24900 more &%logwrite%& modifiers on a &%warn%& verb.
24902 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
24903 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
24905 You do not need to have a final &%accept%&, but if you do, you can use a
24906 &%message%& modifier to specify custom text that is sent as part of the 221
24909 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
24910 failure (for example, failure to open a log file, or when Exim is bombing out
24911 because it has detected an unrecoverable error), all SMTP commands from the
24912 client are given temporary error responses until QUIT is received or the
24913 connection is closed. In these special cases, the QUIT ACL does not run.
24916 .section "The not-QUIT ACL" "SECTNOTQUITACL"
24917 .vindex &$acl_smtp_notquit$&
24918 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
24919 an SMTP session ends without sending QUIT. However, when Exim itself is is bad
24920 trouble, such as being unable to write to its log files, this ACL is not run,
24921 because it might try to do things (such as write to log files) that make the
24922 situation even worse.
24924 Like the QUIT ACL, this ACL is provided to make it possible to do customized
24925 logging or to gather statistics, and its outcome is ignored. The &%delay%&
24926 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
24929 .vindex &$smtp_notquit_reason$&
24930 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
24931 to a string that indicates the reason for the termination of the SMTP
24932 connection. The possible values are:
24934 .irow &`acl-drop`& "Another ACL issued a &%drop%& command"
24935 .irow &`bad-commands`& "Too many unknown or non-mail commands"
24936 .irow &`command-timeout`& "Timeout while reading SMTP commands"
24937 .irow &`connection-lost`& "The SMTP connection has been lost"
24938 .irow &`data-timeout`& "Timeout while reading message data"
24939 .irow &`local-scan-error`& "The &[local_scan()]& function crashed"
24940 .irow &`local-scan-timeout`& "The &[local_scan()]& function timed out"
24941 .irow &`signal-exit`& "SIGTERM or SIGINT"
24942 .irow &`synchronization-error`& "SMTP synchronization error"
24943 .irow &`tls-failed`& "TLS failed to start"
24945 In most cases when an SMTP connection is closed without having received QUIT,
24946 Exim sends an SMTP response message before actually closing the connection.
24947 With the exception of the &`acl-drop`& case, the default message can be
24948 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
24949 &%drop%& verb in another ACL, it is the message from the other ACL that is
24953 .section "Finding an ACL to use" "SECID195"
24954 .cindex "&ACL;" "finding which to use"
24955 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
24956 you can use different ACLs in different circumstances. For example,
24958 acl_smtp_rcpt = ${if ={25}{$interface_port} \
24959 {acl_check_rcpt} {acl_check_rcpt_submit} }
24961 In the default configuration file there are some example settings for
24962 providing an RFC 4409 message submission service on port 587 and a
24963 non-standard &"smtps"& service on port 465. You can use a string
24964 expansion like this to choose an ACL for MUAs on these ports which is
24965 more appropriate for this purpose than the default ACL on port 25.
24967 The expanded string does not have to be the name of an ACL in the
24968 configuration file; there are other possibilities. Having expanded the
24969 string, Exim searches for an ACL as follows:
24972 If the string begins with a slash, Exim uses it as a file name, and reads its
24973 contents as an ACL. The lines are processed in the same way as lines in the
24974 Exim configuration file. In particular, continuation lines are supported, blank
24975 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
24976 If the file does not exist or cannot be read, an error occurs (typically
24977 causing a temporary failure of whatever caused the ACL to be run). For example:
24979 acl_smtp_data = /etc/acls/\
24980 ${lookup{$sender_host_address}lsearch\
24981 {/etc/acllist}{$value}{default}}
24983 This looks up an ACL file to use on the basis of the host's IP address, falling
24984 back to a default if the lookup fails. If an ACL is successfully read from a
24985 file, it is retained in memory for the duration of the Exim process, so that it
24986 can be re-used without having to re-read the file.
24988 If the string does not start with a slash, and does not contain any spaces,
24989 Exim searches the ACL section of the configuration for an ACL whose name
24990 matches the string.
24992 If no named ACL is found, or if the string contains spaces, Exim parses
24993 the string as an inline ACL. This can save typing in cases where you just
24994 want to have something like
24996 acl_smtp_vrfy = accept
24998 in order to allow free use of the VRFY command. Such a string may contain
24999 newlines; it is processed in the same way as an ACL that is read from a file.
25005 .section "ACL return codes" "SECID196"
25006 .cindex "&ACL;" "return codes"
25007 Except for the QUIT ACL, which does not affect the SMTP return code (see
25008 section &<<SECTQUITACL>>& above), the result of running an ACL is either
25009 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
25010 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
25011 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
25012 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
25013 This also causes a 4&'xx'& return code.
25015 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
25016 &"deny"&, because there is no mechanism for passing temporary errors to the
25017 submitters of non-SMTP messages.
25020 ACLs that are relevant to message reception may also return &"discard"&. This
25021 has the effect of &"accept"&, but causes either the entire message or an
25022 individual recipient address to be discarded. In other words, it is a
25023 blackholing facility. Use it with care.
25025 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
25026 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
25027 RCPT ACL is to discard just the one recipient address. If there are no
25028 recipients left when the message's data is received, the DATA ACL is not
25029 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
25030 remaining recipients. The &"discard"& return is not permitted for the
25031 &%acl_smtp_predata%& ACL.
25034 .cindex "&[local_scan()]& function" "when all recipients discarded"
25035 The &[local_scan()]& function is always run, even if there are no remaining
25036 recipients; it may create new recipients.
25040 .section "Unset ACL options" "SECID197"
25041 .cindex "&ACL;" "unset options"
25042 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
25043 all the same. &*Note*&: These defaults apply only when the relevant ACL is
25044 not defined at all. For any defined ACL, the default action when control
25045 reaches the end of the ACL statements is &"deny"&.
25047 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
25048 these two are ACLs that are used only for their side effects. They cannot be
25049 used to accept or reject anything.
25051 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
25052 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
25053 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
25054 when the ACL is not defined is &"accept"&.
25056 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
25057 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
25058 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
25059 messages over an SMTP connection. For an example, see the ACL in the default
25060 configuration file.
25065 .section "Data for message ACLs" "SECID198"
25066 .cindex "&ACL;" "data for message ACL"
25068 .vindex &$local_part$&
25069 .vindex &$sender_address$&
25070 .vindex &$sender_host_address$&
25071 .vindex &$smtp_command$&
25072 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
25073 that contain information about the host and the message's sender (for example,
25074 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
25075 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
25076 &$local_part$& are set from the argument address. The entire SMTP command
25077 is available in &$smtp_command$&.
25079 When an ACL for the AUTH parameter of MAIL is running, the variables that
25080 contain information about the host are set, but &$sender_address$& is not yet
25081 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
25084 .vindex "&$message_size$&"
25085 The &$message_size$& variable is set to the value of the SIZE parameter on
25086 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
25087 that parameter is not given. The value is updated to the true message size by
25088 the time the final DATA ACL is run (after the message data has been
25091 .vindex "&$rcpt_count$&"
25092 .vindex "&$recipients_count$&"
25093 The &$rcpt_count$& variable increases by one for each RCPT command received.
25094 The &$recipients_count$& variable increases by one each time a RCPT command is
25095 accepted, so while an ACL for RCPT is being processed, it contains the number
25096 of previously accepted recipients. At DATA time (for both the DATA ACLs),
25097 &$rcpt_count$& contains the total number of RCPT commands, and
25098 &$recipients_count$& contains the total number of accepted recipients.
25104 .section "Data for non-message ACLs" "SECTdatfornon"
25105 .cindex "&ACL;" "data for non-message ACL"
25106 .vindex &$smtp_command_argument$&
25107 .vindex &$smtp_command$&
25108 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
25109 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
25110 and the entire SMTP command is available in &$smtp_command$&.
25111 These variables can be tested using a &%condition%& condition. For example,
25112 here is an ACL for use with AUTH, which insists that either the session is
25113 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
25114 does not permit authentication methods that use cleartext passwords on
25115 unencrypted connections.
25118 accept encrypted = *
25119 accept condition = ${if eq{${uc:$smtp_command_argument}}\
25121 deny message = TLS encryption or CRAM-MD5 required
25123 (Another way of applying this restriction is to arrange for the authenticators
25124 that use cleartext passwords not to be advertised when the connection is not
25125 encrypted. You can use the generic &%server_advertise_condition%& authenticator
25126 option to do this.)
25130 .section "Format of an ACL" "SECID199"
25131 .cindex "&ACL;" "format of"
25132 .cindex "&ACL;" "verbs, definition of"
25133 An individual ACL consists of a number of statements. Each statement starts
25134 with a verb, optionally followed by a number of conditions and &"modifiers"&.
25135 Modifiers can change the way the verb operates, define error and log messages,
25136 set variables, insert delays, and vary the processing of accepted messages.
25138 If all the conditions are met, the verb is obeyed. The same condition may be
25139 used (with different arguments) more than once in the same statement. This
25140 provides a means of specifying an &"and"& conjunction between conditions. For
25143 deny dnslists = list1.example
25144 dnslists = list2.example
25146 If there are no conditions, the verb is always obeyed. Exim stops evaluating
25147 the conditions and modifiers when it reaches a condition that fails. What
25148 happens then depends on the verb (and in one case, on a special modifier). Not
25149 all the conditions make sense at every testing point. For example, you cannot
25150 test a sender address in the ACL that is run for a VRFY command.
25153 .section "ACL verbs" "SECID200"
25154 The ACL verbs are as follows:
25157 .cindex "&%accept%& ACL verb"
25158 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
25159 of the conditions are not met, what happens depends on whether &%endpass%&
25160 appears among the conditions (for syntax see below). If the failing condition
25161 is before &%endpass%&, control is passed to the next ACL statement; if it is
25162 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
25163 check a RCPT command:
25165 accept domains = +local_domains
25169 If the recipient domain does not match the &%domains%& condition, control
25170 passes to the next statement. If it does match, the recipient is verified, and
25171 the command is accepted if verification succeeds. However, if verification
25172 fails, the ACL yields &"deny"&, because the failing condition is after
25175 The &%endpass%& feature has turned out to be confusing to many people, so its
25176 use is not recommended nowadays. It is always possible to rewrite an ACL so
25177 that &%endpass%& is not needed, and it is no longer used in the default
25180 .cindex "&%message%& ACL modifier" "with &%accept%&"
25181 If a &%message%& modifier appears on an &%accept%& statement, its action
25182 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
25183 (when an &%accept%& verb either accepts or passes control to the next
25184 statement), &%message%& can be used to vary the message that is sent when an
25185 SMTP command is accepted. For example, in a RCPT ACL you could have:
25187 &`accept `&<&'some conditions'&>
25188 &` message = OK, I will allow you through today`&
25190 You can specify an SMTP response code, optionally followed by an &"extended
25191 response code"& at the start of the message, but the first digit must be the
25192 same as would be sent by default, which is 2 for an &%accept%& verb.
25194 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
25195 an error message that is used when access is denied. This behaviour is retained
25196 for backward compatibility, but current &"best practice"& is to avoid the use
25201 .cindex "&%defer%& ACL verb"
25202 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
25203 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
25204 &%defer%& is the same as &%deny%&, because there is no way of sending a
25205 temporary error. For a RCPT command, &%defer%& is much the same as using a
25206 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
25207 be used in any ACL, and even for a recipient it might be a simpler approach.
25211 .cindex "&%deny%& ACL verb"
25212 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
25213 the conditions are not met, control is passed to the next ACL statement. For
25216 deny dnslists = blackholes.mail-abuse.org
25218 rejects commands from hosts that are on a DNS black list.
25222 .cindex "&%discard%& ACL verb"
25223 &%discard%&: This verb behaves like &%accept%&, except that it returns
25224 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
25225 that are concerned with receiving messages. When all the conditions are true,
25226 the sending entity receives a &"success"& response. However, &%discard%& causes
25227 recipients to be discarded. If it is used in an ACL for RCPT, just the one
25228 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
25229 message's recipients are discarded. Recipients that are discarded before DATA
25230 do not appear in the log line when the &%received_recipients%& log selector is set.
25232 If the &%log_message%& modifier is set when &%discard%& operates,
25233 its contents are added to the line that is automatically written to the log.
25234 The &%message%& modifier operates exactly as it does for &%accept%&.
25238 .cindex "&%drop%& ACL verb"
25239 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
25240 forcibly closed after the 5&'xx'& error message has been sent. For example:
25242 drop message = I don't take more than 20 RCPTs
25243 condition = ${if > {$rcpt_count}{20}}
25245 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
25246 The connection is always dropped after sending a 550 response.
25249 .cindex "&%require%& ACL verb"
25250 &%require%&: If all the conditions are met, control is passed to the next ACL
25251 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
25252 example, when checking a RCPT command,
25254 require message = Sender did not verify
25257 passes control to subsequent statements only if the message's sender can be
25258 verified. Otherwise, it rejects the command. Note the positioning of the
25259 &%message%& modifier, before the &%verify%& condition. The reason for this is
25260 discussed in section &<<SECTcondmodproc>>&.
25263 .cindex "&%warn%& ACL verb"
25264 &%warn%&: If all the conditions are true, a line specified by the
25265 &%log_message%& modifier is written to Exim's main log. Control always passes
25266 to the next ACL statement. If any condition is false, the log line is not
25267 written. If an identical log line is requested several times in the same
25268 message, only one copy is actually written to the log. If you want to force
25269 duplicates to be written, use the &%logwrite%& modifier instead.
25271 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
25272 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
25273 &%logwrite%&, and &%add_header%&) that appear before the first failing
25274 condition. There is more about adding header lines in section
25275 &<<SECTaddheadacl>>&.
25277 If any condition on a &%warn%& statement cannot be completed (that is, there is
25278 some sort of defer), the log line specified by &%log_message%& is not written.
25279 This does not include the case of a forced failure from a lookup, which
25280 is considered to be a successful completion. After a defer, no further
25281 conditions or modifiers in the &%warn%& statement are processed. The incident
25282 is logged, and the ACL continues to be processed, from the next statement
25286 .vindex "&$acl_verify_message$&"
25287 When one of the &%warn%& conditions is an address verification that fails, the
25288 text of the verification failure message is in &$acl_verify_message$&. If you
25289 want this logged, you must set it up explicitly. For example:
25291 warn !verify = sender
25292 log_message = sender verify failed: $acl_verify_message
25296 At the end of each ACL there is an implicit unconditional &%deny%&.
25298 As you can see from the examples above, the conditions and modifiers are
25299 written one to a line, with the first one on the same line as the verb, and
25300 subsequent ones on following lines. If you have a very long condition, you can
25301 continue it onto several physical lines by the usual backslash continuation
25302 mechanism. It is conventional to align the conditions vertically.
25306 .section "ACL variables" "SECTaclvariables"
25307 .cindex "&ACL;" "variables"
25308 There are some special variables that can be set during ACL processing. They
25309 can be used to pass information between different ACLs, different invocations
25310 of the same ACL in the same SMTP connection, and between ACLs and the routers,
25311 transports, and filters that are used to deliver a message. The names of these
25312 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
25313 an underscore, but the remainder of the name can be any sequence of
25314 alphanumeric characters and underscores that you choose. There is no limit on
25315 the number of ACL variables. The two sets act as follows:
25317 The values of those variables whose names begin with &$acl_c$& persist
25318 throughout an SMTP connection. They are never reset. Thus, a value that is set
25319 while receiving one message is still available when receiving the next message
25320 on the same SMTP connection.
25322 The values of those variables whose names begin with &$acl_m$& persist only
25323 while a message is being received. They are reset afterwards. They are also
25324 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
25327 When a message is accepted, the current values of all the ACL variables are
25328 preserved with the message and are subsequently made available at delivery
25329 time. The ACL variables are set by a modifier called &%set%&. For example:
25331 accept hosts = whatever
25332 set acl_m4 = some value
25333 accept authenticated = *
25334 set acl_c_auth = yes
25336 &*Note*&: A leading dollar sign is not used when naming a variable that is to
25337 be set. If you want to set a variable without taking any action, you can use a
25338 &%warn%& verb without any other modifiers or conditions.
25340 .oindex &%strict_acl_vars%&
25341 What happens if a syntactically valid but undefined ACL variable is
25342 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
25343 false (the default), an empty string is substituted; if it is true, an
25344 error is generated.
25346 Versions of Exim before 4.64 have a limited set of numbered variables, but
25347 their names are compatible, so there is no problem with upgrading.
25350 .section "Condition and modifier processing" "SECTcondmodproc"
25351 .cindex "&ACL;" "conditions; processing"
25352 .cindex "&ACL;" "modifiers; processing"
25353 An exclamation mark preceding a condition negates its result. For example:
25355 deny domains = *.dom.example
25356 !verify = recipient
25358 causes the ACL to return &"deny"& if the recipient domain ends in
25359 &'dom.example'& and the recipient address cannot be verified. Sometimes
25360 negation can be used on the right-hand side of a condition. For example, these
25361 two statements are equivalent:
25363 deny hosts = !192.168.3.4
25364 deny !hosts = 192.168.3.4
25366 However, for many conditions (&%verify%& being a good example), only left-hand
25367 side negation of the whole condition is possible.
25369 The arguments of conditions and modifiers are expanded. A forced failure
25370 of an expansion causes a condition to be ignored, that is, it behaves as if the
25371 condition is true. Consider these two statements:
25373 accept senders = ${lookup{$host_name}lsearch\
25374 {/some/file}{$value}fail}
25375 accept senders = ${lookup{$host_name}lsearch\
25376 {/some/file}{$value}{}}
25378 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
25379 the returned list is searched, but if the lookup fails the behaviour is
25380 different in the two cases. The &%fail%& in the first statement causes the
25381 condition to be ignored, leaving no further conditions. The &%accept%& verb
25382 therefore succeeds. The second statement, however, generates an empty list when
25383 the lookup fails. No sender can match an empty list, so the condition fails,
25384 and therefore the &%accept%& also fails.
25386 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
25387 specify actions that are taken as the conditions for a statement are checked;
25388 others specify text for messages that are used when access is denied or a
25389 warning is generated. The &%control%& modifier affects the way an incoming
25390 message is handled.
25392 The positioning of the modifiers in an ACL statement important, because the
25393 processing of a verb ceases as soon as its outcome is known. Only those
25394 modifiers that have already been encountered will take effect. For example,
25395 consider this use of the &%message%& modifier:
25397 require message = Can't verify sender
25399 message = Can't verify recipient
25401 message = This message cannot be used
25403 If sender verification fails, Exim knows that the result of the statement is
25404 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
25405 so its text is used as the error message. If sender verification succeeds, but
25406 recipient verification fails, the second message is used. If recipient
25407 verification succeeds, the third message becomes &"current"&, but is never used
25408 because there are no more conditions to cause failure.
25410 For the &%deny%& verb, on the other hand, it is always the last &%message%&
25411 modifier that is used, because all the conditions must be true for rejection to
25412 happen. Specifying more than one &%message%& modifier does not make sense, and
25413 the message can even be specified after all the conditions. For example:
25416 !senders = *@my.domain.example
25417 message = Invalid sender from client host
25419 The &"deny"& result does not happen until the end of the statement is reached,
25420 by which time Exim has set up the message.
25424 .section "ACL modifiers" "SECTACLmodi"
25425 .cindex "&ACL;" "modifiers; list of"
25426 The ACL modifiers are as follows:
25429 .vitem &*add_header*&&~=&~<&'text'&>
25430 This modifier specifies one or more header lines that are to be added to an
25431 incoming message, assuming, of course, that the message is ultimately
25432 accepted. For details, see section &<<SECTaddheadacl>>&.
25434 .vitem &*continue*&&~=&~<&'text'&>
25435 .cindex "&%continue%& ACL modifier"
25436 .cindex "database" "updating in ACL"
25437 This modifier does nothing of itself, and processing of the ACL always
25438 continues with the next condition or modifier. The value of &%continue%& is in
25439 the side effects of expanding its argument. Typically this could be used to
25440 update a database. It is really just a syntactic tidiness, to avoid having to
25441 write rather ugly lines like this:
25443 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
25445 Instead, all you need is
25447 &`continue = `&<&'some expansion'&>
25450 .vitem &*control*&&~=&~<&'text'&>
25451 .cindex "&%control%& ACL modifier"
25452 This modifier affects the subsequent processing of the SMTP connection or of an
25453 incoming message that is accepted. The effect of the first type of control
25454 lasts for the duration of the connection, whereas the effect of the second type
25455 lasts only until the current message has been received. The message-specific
25456 controls always apply to the whole message, not to individual recipients,
25457 even if the &%control%& modifier appears in a RCPT ACL.
25459 As there are now quite a few controls that can be applied, they are described
25460 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
25461 in several different ways. For example:
25463 . ==== As this is a nested list, any displays it contains must be indented
25464 . ==== as otherwise they are too far to the left. That comment applies only
25465 . ==== when xmlto and fop are used; formatting with sdop gets it right either
25469 It can be at the end of an &%accept%& statement:
25471 accept ...some conditions
25472 control = queue_only
25474 In this case, the control is applied when this statement yields &"accept"&, in
25475 other words, when the conditions are all true.
25478 It can be in the middle of an &%accept%& statement:
25480 accept ...some conditions...
25481 control = queue_only
25482 ...some more conditions...
25484 If the first set of conditions are true, the control is applied, even if the
25485 statement does not accept because one of the second set of conditions is false.
25486 In this case, some subsequent statement must yield &"accept"& for the control
25490 It can be used with &%warn%& to apply the control, leaving the
25491 decision about accepting or denying to a subsequent verb. For
25494 warn ...some conditions...
25498 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
25499 &%logwrite%&, so it does not add anything to the message and does not write a
25503 If you want to apply a control unconditionally, you can use it with a
25504 &%require%& verb. For example:
25506 require control = no_multiline_responses
25510 .vitem &*delay*&&~=&~<&'time'&>
25511 .cindex "&%delay%& ACL modifier"
25513 This modifier may appear in any ACL. It causes Exim to wait for the time
25514 interval before proceeding. However, when testing Exim using the &%-bh%&
25515 option, the delay is not actually imposed (an appropriate message is output
25516 instead). The time is given in the usual Exim notation, and the delay happens
25517 as soon as the modifier is processed. In an SMTP session, pending output is
25518 flushed before the delay is imposed.
25520 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
25523 deny ...some conditions...
25526 The delay happens if all the conditions are true, before the statement returns
25527 &"deny"&. Compare this with:
25530 ...some conditions...
25532 which waits for 30s before processing the conditions. The &%delay%& modifier
25533 can also be used with &%warn%& and together with &%control%&:
25535 warn ...some conditions...
25541 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
25542 responses to several commands are no longer buffered and sent in one packet (as
25543 they would normally be) because all output is flushed before imposing the
25544 delay. This optimization is disabled so that a number of small delays do not
25545 appear to the client as one large aggregated delay that might provoke an
25546 unwanted timeout. You can, however, disable output flushing for &%delay%& by
25547 using a &%control%& modifier to set &%no_delay_flush%&.
25551 .cindex "&%endpass%& ACL modifier"
25552 This modifier, which has no argument, is recognized only in &%accept%& and
25553 &%discard%& statements. It marks the boundary between the conditions whose
25554 failure causes control to pass to the next statement, and the conditions whose
25555 failure causes the ACL to return &"deny"&. This concept has proved to be
25556 confusing to some people, so the use of &%endpass%& is no longer recommended as
25557 &"best practice"&. See the description of &%accept%& above for more details.
25560 .vitem &*log_message*&&~=&~<&'text'&>
25561 .cindex "&%log_message%& ACL modifier"
25562 This modifier sets up a message that is used as part of the log message if the
25563 ACL denies access or a &%warn%& statement's conditions are true. For example:
25565 require log_message = wrong cipher suite $tls_cipher
25566 encrypted = DES-CBC3-SHA
25568 &%log_message%& is also used when recipients are discarded by &%discard%&. For
25571 &`discard `&<&'some conditions'&>
25572 &` log_message = Discarded $local_part@$domain because...`&
25574 When access is denied, &%log_message%& adds to any underlying error message
25575 that may exist because of a condition failure. For example, while verifying a
25576 recipient address, a &':fail:'& redirection might have already set up a
25579 The message may be defined before the conditions to which it applies, because
25580 the string expansion does not happen until Exim decides that access is to be
25581 denied. This means that any variables that are set by the condition are
25582 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
25583 variables are set after a DNS black list lookup succeeds. If the expansion of
25584 &%log_message%& fails, or if the result is an empty string, the modifier is
25587 .vindex "&$acl_verify_message$&"
25588 If you want to use a &%warn%& statement to log the result of an address
25589 verification, you can use &$acl_verify_message$& to include the verification
25592 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
25593 the start of the logged message. If the same warning log message is requested
25594 more than once while receiving a single email message, only one copy is
25595 actually logged. If you want to log multiple copies, use &%logwrite%& instead
25596 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
25597 is logged for a successful &%warn%& statement.
25599 If &%log_message%& is not present and there is no underlying error message (for
25600 example, from the failure of address verification), but &%message%& is present,
25601 the &%message%& text is used for logging rejections. However, if any text for
25602 logging contains newlines, only the first line is logged. In the absence of
25603 both &%log_message%& and &%message%&, a default built-in message is used for
25604 logging rejections.
25607 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
25608 .cindex "&%log_reject_target%& ACL modifier"
25609 .cindex "logging in ACL" "specifying which log"
25610 This modifier makes it possible to specify which logs are used for messages
25611 about ACL rejections. Its argument is a colon-separated list of words that can
25612 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
25613 may be empty, in which case a rejection is not logged at all. For example, this
25614 ACL fragment writes no logging information when access is denied:
25616 &`deny `&<&'some conditions'&>
25617 &` log_reject_target =`&
25619 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
25620 permanent and temporary rejections. Its effect lasts for the rest of the
25624 .vitem &*logwrite*&&~=&~<&'text'&>
25625 .cindex "&%logwrite%& ACL modifier"
25626 .cindex "logging in ACL" "immediate"
25627 This modifier writes a message to a log file as soon as it is encountered when
25628 processing an ACL. (Compare &%log_message%&, which, except in the case of
25629 &%warn%& and &%discard%&, is used only if the ACL statement denies
25630 access.) The &%logwrite%& modifier can be used to log special incidents in
25633 &`accept `&<&'some special conditions'&>
25634 &` control = freeze`&
25635 &` logwrite = froze message because ...`&
25637 By default, the message is written to the main log. However, it may begin
25638 with a colon, followed by a comma-separated list of log names, and then
25639 another colon, to specify exactly which logs are to be written. For
25642 logwrite = :main,reject: text for main and reject logs
25643 logwrite = :panic: text for panic log only
25647 .vitem &*message*&&~=&~<&'text'&>
25648 .cindex "&%message%& ACL modifier"
25649 This modifier sets up a text string that is expanded and used as a response
25650 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
25651 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
25652 there is some complication if &%endpass%& is involved; see the description of
25653 &%accept%& for details.)
25655 The expansion of the message happens at the time Exim decides that the ACL is
25656 to end, not at the time it processes &%message%&. If the expansion fails, or
25657 generates an empty string, the modifier is ignored. Here is an example where
25658 &%message%& must be specified first, because the ACL ends with a rejection if
25659 the &%hosts%& condition fails:
25661 require message = Host not recognized
25664 (Once a condition has failed, no further conditions or modifiers are
25667 .cindex "SMTP" "error codes"
25668 .oindex "&%smtp_banner%&
25669 For ACLs that are triggered by SMTP commands, the message is returned as part
25670 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
25671 is meaningful only for SMTP, as no message is returned when a non-SMTP message
25672 is accepted. In the case of the connect ACL, accepting with a message modifier
25673 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
25674 accept message may not contain more than one line (otherwise it will be
25675 truncated at the first newline and a panic logged), and it cannot affect the
25678 When SMTP is involved, the message may begin with an overriding response code,
25679 consisting of three digits optionally followed by an &"extended response code"&
25680 of the form &'n.n.n'&, each code being followed by a space. For example:
25682 deny message = 599 1.2.3 Host not welcome
25683 hosts = 192.168.34.0/24
25685 The first digit of the supplied response code must be the same as would be sent
25686 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
25687 access, but for the predata ACL, note that the default success code is 354, not
25690 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
25691 the message modifier cannot override the 221 response code.
25693 The text in a &%message%& modifier is literal; any quotes are taken as
25694 literals, but because the string is expanded, backslash escapes are processed
25695 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
25698 .vindex "&$acl_verify_message$&"
25699 If &%message%& is used on a statement that verifies an address, the message
25700 specified overrides any message that is generated by the verification process.
25701 However, the original message is available in the variable
25702 &$acl_verify_message$&, so you can incorporate it into your message if you
25703 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
25704 routers to be passed back as part of the SMTP response, you should either not
25705 use a &%message%& modifier, or make use of &$acl_verify_message$&.
25707 For compatibility with previous releases of Exim, a &%message%& modifier that
25708 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
25709 modifier, but this usage is now deprecated. However, &%message%& acts only when
25710 all the conditions are true, wherever it appears in an ACL command, whereas
25711 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
25712 &%warn%& in an ACL that is not concerned with receiving a message, it has no
25716 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
25717 .cindex "&%set%& ACL modifier"
25718 This modifier puts a value into one of the ACL variables (see section
25719 &<<SECTaclvariables>>&).
25726 .section "Use of the control modifier" "SECTcontrols"
25727 .cindex "&%control%& ACL modifier"
25728 The &%control%& modifier supports the following settings:
25731 .vitem &*control&~=&~allow_auth_unadvertised*&
25732 This modifier allows a client host to use the SMTP AUTH command even when it
25733 has not been advertised in response to EHLO. Furthermore, because there are
25734 apparently some really broken clients that do this, Exim will accept AUTH after
25735 HELO (rather than EHLO) when this control is set. It should be used only if you
25736 really need it, and you should limit its use to those broken clients that do
25737 not work without it. For example:
25739 warn hosts = 192.168.34.25
25740 control = allow_auth_unadvertised
25742 Normally, when an Exim server receives an AUTH command, it checks the name of
25743 the authentication mechanism that is given in the command to ensure that it
25744 matches an advertised mechanism. When this control is set, the check that a
25745 mechanism has been advertised is bypassed. Any configured mechanism can be used
25746 by the client. This control is permitted only in the connection and HELO ACLs.
25749 .vitem &*control&~=&~caseful_local_part*& &&&
25750 &*control&~=&~caselower_local_part*&
25751 .cindex "&ACL;" "case of local part in"
25752 .cindex "case of local parts"
25753 .vindex "&$local_part$&"
25754 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
25755 (that is, during RCPT processing). By default, the contents of &$local_part$&
25756 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
25757 any uppercase letters in the original local part are restored in &$local_part$&
25758 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
25761 These controls affect only the current recipient. Moreover, they apply only to
25762 local part handling that takes place directly in the ACL (for example, as a key
25763 in lookups). If a test to verify the recipient is obeyed, the case-related
25764 handling of the local part during the verification is controlled by the router
25765 configuration (see the &%caseful_local_part%& generic router option).
25767 This facility could be used, for example, to add a spam score to local parts
25768 containing upper case letters. For example, using &$acl_m4$& to accumulate the
25771 warn control = caseful_local_part
25772 set acl_m4 = ${eval:\
25774 ${if match{$local_part}{[A-Z]}{1}{0}}\
25776 control = caselower_local_part
25778 Notice that we put back the lower cased version afterwards, assuming that
25779 is what is wanted for subsequent tests.
25781 .vitem &*control&~=&~debug/*&<&'options'&>
25782 .cindex "&ACL;" "enabling debug logging"
25783 .cindex "debugging" "enabling from an ACL"
25784 This control turns on debug logging, almost as though Exim had been invoked
25785 with &`-d`&, with the output going to a new logfile, by default called
25786 &'debuglog'&. The filename can be adjusted with the &'tag'& option, which
25787 may access any variables already defined. The logging may be adjusted with
25788 the &'opts'& option, which takes the same values as the &`-d`& command-line
25789 option. Some examples (which depend on variables that don't exist in all
25793 control = debug/tag=.$sender_host_address
25794 control = debug/opts=+expand+acl
25795 control = debug/tag=.$message_exim_id/opts=+expand
25798 .vitem &*control&~=&~enforce_sync*& &&&
25799 &*control&~=&~no_enforce_sync*&
25800 .cindex "SMTP" "synchronization checking"
25801 .cindex "synchronization checking in SMTP"
25802 These controls make it possible to be selective about when SMTP synchronization
25803 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
25804 state of the switch (it is true by default). See the description of this option
25805 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
25807 The effect of these two controls lasts for the remainder of the SMTP
25808 connection. They can appear in any ACL except the one for the non-SMTP
25809 messages. The most straightforward place to put them is in the ACL defined by
25810 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
25811 before the first synchronization check. The expected use is to turn off the
25812 synchronization checks for badly-behaved hosts that you nevertheless need to
25816 .vitem &*control&~=&~fakedefer/*&<&'message'&>
25817 .cindex "fake defer"
25818 .cindex "defer, fake"
25819 This control works in exactly the same way as &%fakereject%& (described below)
25820 except that it causes an SMTP 450 response after the message data instead of a
25821 550 response. You must take care when using &%fakedefer%& because it causes the
25822 messages to be duplicated when the sender retries. Therefore, you should not
25823 use &%fakedefer%& if the message is to be delivered normally.
25825 .vitem &*control&~=&~fakereject/*&<&'message'&>
25826 .cindex "fake rejection"
25827 .cindex "rejection, fake"
25828 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
25829 words, only when an SMTP message is being received. If Exim accepts the
25830 message, instead the final 250 response, a 550 rejection message is sent.
25831 However, Exim proceeds to deliver the message as normal. The control applies
25832 only to the current message, not to any subsequent ones that may be received in
25833 the same SMTP connection.
25835 The text for the 550 response is taken from the &%control%& modifier. If no
25836 message is supplied, the following is used:
25838 550-Your message has been rejected but is being
25839 550-kept for evaluation.
25840 550-If it was a legitimate message, it may still be
25841 550 delivered to the target recipient(s).
25843 This facility should be used with extreme caution.
25845 .vitem &*control&~=&~freeze*&
25846 .cindex "frozen messages" "forcing in ACL"
25847 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
25848 other words, only when a message is being received. If the message is accepted,
25849 it is placed on Exim's queue and frozen. The control applies only to the
25850 current message, not to any subsequent ones that may be received in the same
25853 This modifier can optionally be followed by &`/no_tell`&. If the global option
25854 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
25855 is told about the freezing), provided all the &*control=freeze*& modifiers that
25856 are obeyed for the current message have the &`/no_tell`& option.
25858 .vitem &*control&~=&~no_delay_flush*&
25859 .cindex "SMTP" "output flushing, disabling for delay"
25860 Exim normally flushes SMTP output before implementing a delay in an ACL, to
25861 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
25862 use. This control, as long as it is encountered before the &%delay%& modifier,
25863 disables such output flushing.
25865 .vitem &*control&~=&~no_callout_flush*&
25866 .cindex "SMTP" "output flushing, disabling for callout"
25867 Exim normally flushes SMTP output before performing a callout in an ACL, to
25868 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
25869 use. This control, as long as it is encountered before the &%verify%& condition
25870 that causes the callout, disables such output flushing.
25872 .vitem &*control&~=&~no_mbox_unspool*&
25873 This control is available when Exim is compiled with the content scanning
25874 extension. Content scanning may require a copy of the current message, or parts
25875 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
25876 or spam scanner. Normally, such copies are deleted when they are no longer
25877 needed. If this control is set, the copies are not deleted. The control applies
25878 only to the current message, not to any subsequent ones that may be received in
25879 the same SMTP connection. It is provided for debugging purposes and is unlikely
25880 to be useful in production.
25882 .vitem &*control&~=&~no_multiline_responses*&
25883 .cindex "multiline responses, suppressing"
25884 This control is permitted for any ACL except the one for non-SMTP messages.
25885 It seems that there are broken clients in use that cannot handle multiline
25886 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
25888 If this control is set, multiline SMTP responses from ACL rejections are
25889 suppressed. One way of doing this would have been to put out these responses as
25890 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
25891 (&"use multiline responses for more"& it says &-- ha!), and some of the
25892 responses might get close to that. So this facility, which is after all only a
25893 sop to broken clients, is implemented by doing two very easy things:
25896 Extra information that is normally output as part of a rejection caused by
25897 sender verification failure is omitted. Only the final line (typically &"sender
25898 verification failed"&) is sent.
25900 If a &%message%& modifier supplies a multiline response, only the first
25904 The setting of the switch can, of course, be made conditional on the
25905 calling host. Its effect lasts until the end of the SMTP connection.
25907 .vitem &*control&~=&~no_pipelining*&
25908 .cindex "PIPELINING" "suppressing advertising"
25909 This control turns off the advertising of the PIPELINING extension to SMTP in
25910 the current session. To be useful, it must be obeyed before Exim sends its
25911 response to an EHLO command. Therefore, it should normally appear in an ACL
25912 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
25913 &%pipelining_advertise_hosts%&.
25915 .vitem &*control&~=&~queue_only*&
25916 .oindex "&%queue_only%&"
25917 .cindex "queueing incoming messages"
25918 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
25919 other words, only when a message is being received. If the message is accepted,
25920 it is placed on Exim's queue and left there for delivery by a subsequent queue
25921 runner. No immediate delivery process is started. In other words, it has the
25922 effect as the &%queue_only%& global option. However, the control applies only
25923 to the current message, not to any subsequent ones that may be received in the
25924 same SMTP connection.
25926 .vitem &*control&~=&~submission/*&<&'options'&>
25927 .cindex "message" "submission"
25928 .cindex "submission mode"
25929 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
25930 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
25931 the current message is a submission from a local MUA. In this case, Exim
25932 operates in &"submission mode"&, and applies certain fixups to the message if
25933 necessary. For example, it adds a &'Date:'& header line if one is not present.
25934 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
25935 late (the message has already been created).
25937 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
25938 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
25939 submission mode; the available options for this control are described there.
25940 The control applies only to the current message, not to any subsequent ones
25941 that may be received in the same SMTP connection.
25943 .vitem &*control&~=&~suppress_local_fixups*&
25944 .cindex "submission fixups, suppressing"
25945 This control applies to locally submitted (non TCP/IP) messages, and is the
25946 complement of &`control = submission`&. It disables the fixups that are
25947 normally applied to locally-submitted messages. Specifically:
25950 Any &'Sender:'& header line is left alone (in this respect, it is a
25951 dynamic version of &%local_sender_retain%&).
25953 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
25955 There is no check that &'From:'& corresponds to the actual sender.
25958 This control may be useful when a remotely-originated message is accepted,
25959 passed to some scanning program, and then re-submitted for delivery. It can be
25960 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
25961 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
25964 &*Note:*& This control applies only to the current message, not to any others
25965 that are being submitted at the same time using &%-bs%& or &%-bS%&.
25969 .section "Summary of message fixup control" "SECTsummesfix"
25970 All four possibilities for message fixups can be specified:
25973 Locally submitted, fixups applied: the default.
25975 Locally submitted, no fixups applied: use
25976 &`control = suppress_local_fixups`&.
25978 Remotely submitted, no fixups applied: the default.
25980 Remotely submitted, fixups applied: use &`control = submission`&.
25985 .section "Adding header lines in ACLs" "SECTaddheadacl"
25986 .cindex "header lines" "adding in an ACL"
25987 .cindex "header lines" "position of added lines"
25988 .cindex "&%message%& ACL modifier"
25989 The &%add_header%& modifier can be used to add one or more extra header lines
25990 to an incoming message, as in this example:
25992 warn dnslists = sbl.spamhaus.org : \
25993 dialup.mail-abuse.org
25994 add_header = X-blacklisted-at: $dnslist_domain
25996 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
25997 MIME, and non-SMTP ACLs (in other words, those that are concerned with
25998 receiving a message). The message must ultimately be accepted for
25999 &%add_header%& to have any significant effect. You can use &%add_header%& with
26000 any ACL verb, including &%deny%& (though this is potentially useful only in a
26003 If the data for the &%add_header%& modifier contains one or more newlines that
26004 are not followed by a space or a tab, it is assumed to contain multiple header
26005 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
26006 front of any line that is not a valid header line.
26008 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
26009 They are added to the message before processing the DATA and MIME ACLs.
26010 However, if an identical header line is requested more than once, only one copy
26011 is actually added to the message. Further header lines may be accumulated
26012 during the DATA and MIME ACLs, after which they are added to the message, again
26013 with duplicates suppressed. Thus, it is possible to add two identical header
26014 lines to an SMTP message, but only if one is added before DATA and one after.
26015 In the case of non-SMTP messages, new headers are accumulated during the
26016 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
26017 message is rejected after DATA or by the non-SMTP ACL, all added header lines
26018 are included in the entry that is written to the reject log.
26020 .cindex "header lines" "added; visibility of"
26021 Header lines are not visible in string expansions until they are added to the
26022 message. It follows that header lines defined in the MAIL, RCPT, and predata
26023 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
26024 header lines that are added by the DATA or MIME ACLs are not visible in those
26025 ACLs. Because of this restriction, you cannot use header lines as a way of
26026 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
26027 this, you can use ACL variables, as described in section
26028 &<<SECTaclvariables>>&.
26030 The &%add_header%& modifier acts immediately it is encountered during the
26031 processing of an ACL. Notice the difference between these two cases:
26033 &`accept add_header = ADDED: some text`&
26034 &` `&<&'some condition'&>
26036 &`accept `&<&'some condition'&>
26037 &` add_header = ADDED: some text`&
26039 In the first case, the header line is always added, whether or not the
26040 condition is true. In the second case, the header line is added only if the
26041 condition is true. Multiple occurrences of &%add_header%& may occur in the same
26042 ACL statement. All those that are encountered before a condition fails are
26045 .cindex "&%warn%& ACL verb"
26046 For compatibility with previous versions of Exim, a &%message%& modifier for a
26047 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
26048 effect only if all the conditions are true, even if it appears before some of
26049 them. Furthermore, only the last occurrence of &%message%& is honoured. This
26050 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
26051 are present on a &%warn%& verb, both are processed according to their
26054 By default, new header lines are added to a message at the end of the existing
26055 header lines. However, you can specify that any particular header line should
26056 be added right at the start (before all the &'Received:'& lines), immediately
26057 after the first block of &'Received:'& lines, or immediately before any line
26058 that is not a &'Received:'& or &'Resent-something:'& header.
26060 This is done by specifying &":at_start:"&, &":after_received:"&, or
26061 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
26062 header line, respectively. (Header text cannot start with a colon, as there has
26063 to be a header name first.) For example:
26065 warn add_header = \
26066 :after_received:X-My-Header: something or other...
26068 If more than one header line is supplied in a single &%add_header%& modifier,
26069 each one is treated independently and can therefore be placed differently. If
26070 you add more than one line at the start, or after the Received: block, they end
26071 up in reverse order.
26073 &*Warning*&: This facility currently applies only to header lines that are
26074 added in an ACL. It does NOT work for header lines that are added in a
26075 system filter or in a router or transport.
26080 .section "ACL conditions" "SECTaclconditions"
26081 .cindex "&ACL;" "conditions; list of"
26082 Some of conditions listed in this section are available only when Exim is
26083 compiled with the content-scanning extension. They are included here briefly
26084 for completeness. More detailed descriptions can be found in the discussion on
26085 content scanning in chapter &<<CHAPexiscan>>&.
26087 Not all conditions are relevant in all circumstances. For example, testing
26088 senders and recipients does not make sense in an ACL that is being run as the
26089 result of the arrival of an ETRN command, and checks on message headers can be
26090 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
26091 can use the same condition (with different parameters) more than once in the
26092 same ACL statement. This provides a way of specifying an &"and"& conjunction.
26093 The conditions are as follows:
26097 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
26098 .cindex "&ACL;" "nested"
26099 .cindex "&ACL;" "indirect"
26100 .cindex "&%acl%& ACL condition"
26101 The possible values of the argument are the same as for the
26102 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
26103 &"accept"& the condition is true; if it returns &"deny"& the condition is
26104 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
26105 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
26106 condition false. This means that further processing of the &%warn%& verb
26107 ceases, but processing of the ACL continues.
26109 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
26110 the connection is dropped. If it returns &"discard"&, the verb must be
26111 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
26112 conditions are tested.
26114 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
26115 loops. This condition allows you to use different ACLs in different
26116 circumstances. For example, different ACLs can be used to handle RCPT commands
26117 for different local users or different local domains.
26119 .vitem &*authenticated&~=&~*&<&'string&~list'&>
26120 .cindex "&%authenticated%& ACL condition"
26121 .cindex "authentication" "ACL checking"
26122 .cindex "&ACL;" "testing for authentication"
26123 If the SMTP connection is not authenticated, the condition is false. Otherwise,
26124 the name of the authenticator is tested against the list. To test for
26125 authentication by any authenticator, you can set
26130 .vitem &*condition&~=&~*&<&'string'&>
26131 .cindex "&%condition%& ACL condition"
26132 .cindex "customizing" "ACL condition"
26133 .cindex "&ACL;" "customized test"
26134 .cindex "&ACL;" "testing, customized"
26135 This feature allows you to make up custom conditions. If the result of
26136 expanding the string is an empty string, the number zero, or one of the strings
26137 &"no"& or &"false"&, the condition is false. If the result is any non-zero
26138 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
26139 any other value, some error is assumed to have occurred, and the ACL returns
26140 &"defer"&. However, if the expansion is forced to fail, the condition is
26141 ignored. The effect is to treat it as true, whether it is positive or
26144 .vitem &*decode&~=&~*&<&'location'&>
26145 .cindex "&%decode%& ACL condition"
26146 This condition is available only when Exim is compiled with the
26147 content-scanning extension, and it is allowed only in the ACL defined by
26148 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
26149 If all goes well, the condition is true. It is false only if there are
26150 problems such as a syntax error or a memory shortage. For more details, see
26151 chapter &<<CHAPexiscan>>&.
26153 .vitem &*demime&~=&~*&<&'extension&~list'&>
26154 .cindex "&%demime%& ACL condition"
26155 This condition is available only when Exim is compiled with the
26156 content-scanning extension. Its use is described in section
26157 &<<SECTdemimecond>>&.
26159 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
26160 .cindex "&%dnslists%& ACL condition"
26161 .cindex "DNS list" "in ACL"
26162 .cindex "black list (DNS)"
26163 .cindex "&ACL;" "testing a DNS list"
26164 This condition checks for entries in DNS black lists. These are also known as
26165 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
26166 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
26167 different variants of this condition to describe briefly here. See sections
26168 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
26170 .vitem &*domains&~=&~*&<&'domain&~list'&>
26171 .cindex "&%domains%& ACL condition"
26172 .cindex "domain" "ACL checking"
26173 .cindex "&ACL;" "testing a recipient domain"
26174 .vindex "&$domain_data$&"
26175 This condition is relevant only after a RCPT command. It checks that the domain
26176 of the recipient address is in the domain list. If percent-hack processing is
26177 enabled, it is done before this test is done. If the check succeeds with a
26178 lookup, the result of the lookup is placed in &$domain_data$& until the next
26181 &*Note carefully*& (because many people seem to fall foul of this): you cannot
26182 use &%domains%& in a DATA ACL.
26185 .vitem &*encrypted&~=&~*&<&'string&~list'&>
26186 .cindex "&%encrypted%& ACL condition"
26187 .cindex "encryption" "checking in an ACL"
26188 .cindex "&ACL;" "testing for encryption"
26189 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
26190 name of the cipher suite in use is tested against the list. To test for
26191 encryption without testing for any specific cipher suite(s), set
26197 .vitem &*hosts&~=&~*&<&'&~host&~list'&>
26198 .cindex "&%hosts%& ACL condition"
26199 .cindex "host" "ACL checking"
26200 .cindex "&ACL;" "testing the client host"
26201 This condition tests that the calling host matches the host list. If you have
26202 name lookups or wildcarded host names and IP addresses in the same host list,
26203 you should normally put the IP addresses first. For example, you could have:
26205 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
26207 The lookup in this example uses the host name for its key. This is implied by
26208 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
26209 and it wouldn't matter which way round you had these two items.)
26211 The reason for the problem with host names lies in the left-to-right way that
26212 Exim processes lists. It can test IP addresses without doing any DNS lookups,
26213 but when it reaches an item that requires a host name, it fails if it cannot
26214 find a host name to compare with the pattern. If the above list is given in the
26215 opposite order, the &%accept%& statement fails for a host whose name cannot be
26216 found, even if its IP address is 10.9.8.7.
26218 If you really do want to do the name check first, and still recognize the IP
26219 address even if the name lookup fails, you can rewrite the ACL like this:
26221 accept hosts = dbm;/etc/friendly/hosts
26222 accept hosts = 10.9.8.7
26224 The default action on failing to find the host name is to assume that the host
26225 is not in the list, so the first &%accept%& statement fails. The second
26226 statement can then check the IP address.
26228 .vindex "&$host_data$&"
26229 If a &%hosts%& condition is satisfied by means of a lookup, the result
26230 of the lookup is made available in the &$host_data$& variable. This
26231 allows you, for example, to set up a statement like this:
26233 deny hosts = net-lsearch;/some/file
26234 message = $host_data
26236 which gives a custom error message for each denied host.
26238 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
26239 .cindex "&%local_parts%& ACL condition"
26240 .cindex "local part" "ACL checking"
26241 .cindex "&ACL;" "testing a local part"
26242 .vindex "&$local_part_data$&"
26243 This condition is relevant only after a RCPT command. It checks that the local
26244 part of the recipient address is in the list. If percent-hack processing is
26245 enabled, it is done before this test. If the check succeeds with a lookup, the
26246 result of the lookup is placed in &$local_part_data$&, which remains set until
26247 the next &%local_parts%& test.
26249 .vitem &*malware&~=&~*&<&'option'&>
26250 .cindex "&%malware%& ACL condition"
26251 .cindex "&ACL;" "virus scanning"
26252 .cindex "&ACL;" "scanning for viruses"
26253 This condition is available only when Exim is compiled with the
26254 content-scanning extension. It causes the incoming message to be scanned for
26255 viruses. For details, see chapter &<<CHAPexiscan>>&.
26257 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
26258 .cindex "&%mime_regex%& ACL condition"
26259 .cindex "&ACL;" "testing by regex matching"
26260 This condition is available only when Exim is compiled with the
26261 content-scanning extension, and it is allowed only in the ACL defined by
26262 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
26263 with any of the regular expressions. For details, see chapter
26266 .vitem &*ratelimit&~=&~*&<&'parameters'&>
26267 .cindex "rate limiting"
26268 This condition can be used to limit the rate at which a user or host submits
26269 messages. Details are given in section &<<SECTratelimiting>>&.
26271 .vitem &*recipients&~=&~*&<&'address&~list'&>
26272 .cindex "&%recipients%& ACL condition"
26273 .cindex "recipient" "ACL checking"
26274 .cindex "&ACL;" "testing a recipient"
26275 This condition is relevant only after a RCPT command. It checks the entire
26276 recipient address against a list of recipients.
26278 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
26279 .cindex "&%regex%& ACL condition"
26280 .cindex "&ACL;" "testing by regex matching"
26281 This condition is available only when Exim is compiled with the
26282 content-scanning extension, and is available only in the DATA, MIME, and
26283 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
26284 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
26286 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
26287 .cindex "&%sender_domains%& ACL condition"
26288 .cindex "sender" "ACL checking"
26289 .cindex "&ACL;" "testing a sender domain"
26290 .vindex "&$domain$&"
26291 .vindex "&$sender_address_domain$&"
26292 This condition tests the domain of the sender of the message against the given
26293 domain list. &*Note*&: The domain of the sender address is in
26294 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
26295 of this condition. This is an exception to the general rule for testing domain
26296 lists. It is done this way so that, if this condition is used in an ACL for a
26297 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
26298 influence the sender checking.
26300 &*Warning*&: It is a bad idea to use this condition on its own as a control on
26301 relaying, because sender addresses are easily, and commonly, forged.
26303 .vitem &*senders&~=&~*&<&'address&~list'&>
26304 .cindex "&%senders%& ACL condition"
26305 .cindex "sender" "ACL checking"
26306 .cindex "&ACL;" "testing a sender"
26307 This condition tests the sender of the message against the given list. To test
26308 for a bounce message, which has an empty sender, set
26312 &*Warning*&: It is a bad idea to use this condition on its own as a control on
26313 relaying, because sender addresses are easily, and commonly, forged.
26315 .vitem &*spam&~=&~*&<&'username'&>
26316 .cindex "&%spam%& ACL condition"
26317 .cindex "&ACL;" "scanning for spam"
26318 This condition is available only when Exim is compiled with the
26319 content-scanning extension. It causes the incoming message to be scanned by
26320 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
26322 .vitem &*verify&~=&~certificate*&
26323 .cindex "&%verify%& ACL condition"
26324 .cindex "TLS" "client certificate verification"
26325 .cindex "certificate" "verification of client"
26326 .cindex "&ACL;" "certificate verification"
26327 .cindex "&ACL;" "testing a TLS certificate"
26328 This condition is true in an SMTP session if the session is encrypted, and a
26329 certificate was received from the client, and the certificate was verified. The
26330 server requests a certificate only if the client matches &%tls_verify_hosts%&
26331 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
26333 .vitem &*verify&~=&~csa*&
26334 .cindex "CSA verification"
26335 This condition checks whether the sending host (the client) is authorized to
26336 send email. Details of how this works are given in section
26337 &<<SECTverifyCSA>>&.
26339 .vitem &*verify&~=&~header_sender/*&<&'options'&>
26340 .cindex "&%verify%& ACL condition"
26341 .cindex "&ACL;" "verifying sender in the header"
26342 .cindex "header lines" "verifying the sender in"
26343 .cindex "sender" "verifying in header"
26344 .cindex "verifying" "sender in header"
26345 This condition is relevant only in an ACL that is run after a message has been
26346 received, that is, in an ACL specified by &%acl_smtp_data%& or
26347 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
26348 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
26349 is loosely thought of as a &"sender"& address (hence the name of the test).
26350 However, an address that appears in one of these headers need not be an address
26351 that accepts bounce messages; only sender addresses in envelopes are required
26352 to accept bounces. Therefore, if you use the callout option on this check, you
26353 might want to arrange for a non-empty address in the MAIL command.
26355 Details of address verification and the options are given later, starting at
26356 section &<<SECTaddressverification>>& (callouts are described in section
26357 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
26358 condition to restrict it to bounce messages only:
26361 message = A valid sender header is required for bounces
26362 !verify = header_sender
26365 .vitem &*verify&~=&~header_syntax*&
26366 .cindex "&%verify%& ACL condition"
26367 .cindex "&ACL;" "verifying header syntax"
26368 .cindex "header lines" "verifying syntax"
26369 .cindex "verifying" "header syntax"
26370 This condition is relevant only in an ACL that is run after a message has been
26371 received, that is, in an ACL specified by &%acl_smtp_data%& or
26372 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
26373 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
26374 and &'Bcc:'&). Unqualified addresses (local parts without domains) are
26375 permitted only in locally generated messages and from hosts that match
26376 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
26379 Note that this condition is a syntax check only. However, a common spamming
26380 ploy used to be to send syntactically invalid headers such as
26384 and this condition can be used to reject such messages, though they are not as
26385 common as they used to be.
26387 .vitem &*verify&~=&~helo*&
26388 .cindex "&%verify%& ACL condition"
26389 .cindex "&ACL;" "verifying HELO/EHLO"
26390 .cindex "HELO" "verifying"
26391 .cindex "EHLO" "verifying"
26392 .cindex "verifying" "EHLO"
26393 .cindex "verifying" "HELO"
26394 This condition is true if a HELO or EHLO command has been received from the
26395 client host, and its contents have been verified. If there has been no previous
26396 attempt to verify the HELO/EHLO contents, it is carried out when this
26397 condition is encountered. See the description of the &%helo_verify_hosts%& and
26398 &%helo_try_verify_hosts%& options for details of how to request verification
26399 independently of this condition.
26401 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
26402 option), this condition is always true.
26405 .vitem &*verify&~=&~not_blind*&
26406 .cindex "verifying" "not blind"
26407 .cindex "bcc recipients, verifying none"
26408 This condition checks that there are no blind (bcc) recipients in the message.
26409 Every envelope recipient must appear either in a &'To:'& header line or in a
26410 &'Cc:'& header line for this condition to be true. Local parts are checked
26411 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
26412 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
26413 used only in a DATA or non-SMTP ACL.
26415 There are, of course, many legitimate messages that make use of blind (bcc)
26416 recipients. This check should not be used on its own for blocking messages.
26419 .vitem &*verify&~=&~recipient/*&<&'options'&>
26420 .cindex "&%verify%& ACL condition"
26421 .cindex "&ACL;" "verifying recipient"
26422 .cindex "recipient" "verifying"
26423 .cindex "verifying" "recipient"
26424 .vindex "&$address_data$&"
26425 This condition is relevant only after a RCPT command. It verifies the current
26426 recipient. Details of address verification are given later, starting at section
26427 &<<SECTaddressverification>>&. After a recipient has been verified, the value
26428 of &$address_data$& is the last value that was set while routing the address.
26429 This applies even if the verification fails. When an address that is being
26430 verified is redirected to a single address, verification continues with the new
26431 address, and in that case, the subsequent value of &$address_data$& is the
26432 value for the child address.
26434 .vitem &*verify&~=&~reverse_host_lookup*&
26435 .cindex "&%verify%& ACL condition"
26436 .cindex "&ACL;" "verifying host reverse lookup"
26437 .cindex "host" "verifying reverse lookup"
26438 This condition ensures that a verified host name has been looked up from the IP
26439 address of the client host. (This may have happened already if the host name
26440 was needed for checking a host list, or if the host matched &%host_lookup%&.)
26441 Verification ensures that the host name obtained from a reverse DNS lookup, or
26442 one of its aliases, does, when it is itself looked up in the DNS, yield the
26443 original IP address.
26445 If this condition is used for a locally generated message (that is, when there
26446 is no client host involved), it always succeeds.
26448 .vitem &*verify&~=&~sender/*&<&'options'&>
26449 .cindex "&%verify%& ACL condition"
26450 .cindex "&ACL;" "verifying sender"
26451 .cindex "sender" "verifying"
26452 .cindex "verifying" "sender"
26453 This condition is relevant only after a MAIL or RCPT command, or after a
26454 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
26455 the message's sender is empty (that is, this is a bounce message), the
26456 condition is true. Otherwise, the sender address is verified.
26458 .vindex "&$address_data$&"
26459 .vindex "&$sender_address_data$&"
26460 If there is data in the &$address_data$& variable at the end of routing, its
26461 value is placed in &$sender_address_data$& at the end of verification. This
26462 value can be used in subsequent conditions and modifiers in the same ACL
26463 statement. It does not persist after the end of the current statement. If you
26464 want to preserve the value for longer, you can save it in an ACL variable.
26466 Details of verification are given later, starting at section
26467 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
26468 to avoid doing it more than once per message.
26470 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
26471 .cindex "&%verify%& ACL condition"
26472 This is a variation of the previous option, in which a modified address is
26473 verified as a sender.
26478 .section "Using DNS lists" "SECTmorednslists"
26479 .cindex "DNS list" "in ACL"
26480 .cindex "black list (DNS)"
26481 .cindex "&ACL;" "testing a DNS list"
26482 In its simplest form, the &%dnslists%& condition tests whether the calling host
26483 is on at least one of a number of DNS lists by looking up the inverted IP
26484 address in one or more DNS domains. (Note that DNS list domains are not mail
26485 domains, so the &`+`& syntax for named lists doesn't work - it is used for
26486 special options instead.) For example, if the calling host's IP
26487 address is 192.168.62.43, and the ACL statement is
26489 deny dnslists = blackholes.mail-abuse.org : \
26490 dialups.mail-abuse.org
26492 the following records are looked up:
26494 43.62.168.192.blackholes.mail-abuse.org
26495 43.62.168.192.dialups.mail-abuse.org
26497 As soon as Exim finds an existing DNS record, processing of the list stops.
26498 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
26499 to test that a host is on more than one list (an &"and"& conjunction), you can
26500 use two separate conditions:
26502 deny dnslists = blackholes.mail-abuse.org
26503 dnslists = dialups.mail-abuse.org
26505 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
26506 behaves as if the host does not match the list item, that is, as if the DNS
26507 record does not exist. If there are further items in the DNS list, they are
26510 This is usually the required action when &%dnslists%& is used with &%deny%&
26511 (which is the most common usage), because it prevents a DNS failure from
26512 blocking mail. However, you can change this behaviour by putting one of the
26513 following special items in the list:
26515 &`+include_unknown `& behave as if the item is on the list
26516 &`+exclude_unknown `& behave as if the item is not on the list (default)
26517 &`+defer_unknown `& give a temporary error
26519 .cindex "&`+include_unknown`&"
26520 .cindex "&`+exclude_unknown`&"
26521 .cindex "&`+defer_unknown`&"
26522 Each of these applies to any subsequent items on the list. For example:
26524 deny dnslists = +defer_unknown : foo.bar.example
26526 Testing the list of domains stops as soon as a match is found. If you want to
26527 warn for one list and block for another, you can use two different statements:
26529 deny dnslists = blackholes.mail-abuse.org
26530 warn message = X-Warn: sending host is on dialups list
26531 dnslists = dialups.mail-abuse.org
26533 DNS list lookups are cached by Exim for the duration of the SMTP session,
26534 so a lookup based on the IP address is done at most once for any incoming
26535 connection. Exim does not share information between multiple incoming
26536 connections (but your local name server cache should be active).
26540 .section "Specifying the IP address for a DNS list lookup" "SECID201"
26541 .cindex "DNS list" "keyed by explicit IP address"
26542 By default, the IP address that is used in a DNS list lookup is the IP address
26543 of the calling host. However, you can specify another IP address by listing it
26544 after the domain name, introduced by a slash. For example:
26546 deny dnslists = black.list.tld/192.168.1.2
26548 This feature is not very helpful with explicit IP addresses; it is intended for
26549 use with IP addresses that are looked up, for example, the IP addresses of the
26550 MX hosts or nameservers of an email sender address. For an example, see section
26551 &<<SECTmulkeyfor>>& below.
26556 .section "DNS lists keyed on domain names" "SECID202"
26557 .cindex "DNS list" "keyed by domain name"
26558 There are some lists that are keyed on domain names rather than inverted IP
26559 addresses (see for example the &'domain based zones'& link at
26560 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
26561 with these lists. You can change the name that is looked up in a DNS list by
26562 listing it after the domain name, introduced by a slash. For example,
26564 deny message = Sender's domain is listed at $dnslist_domain
26565 dnslists = dsn.rfc-ignorant.org/$sender_address_domain
26567 This particular example is useful only in ACLs that are obeyed after the
26568 RCPT or DATA commands, when a sender address is available. If (for
26569 example) the message's sender is &'user@tld.example'& the name that is looked
26570 up by this example is
26572 tld.example.dsn.rfc-ignorant.org
26574 A single &%dnslists%& condition can contain entries for both names and IP
26575 addresses. For example:
26577 deny dnslists = sbl.spamhaus.org : \
26578 dsn.rfc-ignorant.org/$sender_address_domain
26580 The first item checks the sending host's IP address; the second checks a domain
26581 name. The whole condition is true if either of the DNS lookups succeeds.
26586 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
26587 .cindex "DNS list" "multiple keys for"
26588 The syntax described above for looking up explicitly-defined values (either
26589 names or IP addresses) in a DNS blacklist is a simplification. After the domain
26590 name for the DNS list, what follows the slash can in fact be a list of items.
26591 As with all lists in Exim, the default separator is a colon. However, because
26592 this is a sublist within the list of DNS blacklist domains, it is necessary
26593 either to double the separators like this:
26595 dnslists = black.list.tld/name.1::name.2
26597 or to change the separator character, like this:
26599 dnslists = black.list.tld/<;name.1;name.2
26601 If an item in the list is an IP address, it is inverted before the DNS
26602 blacklist domain is appended. If it is not an IP address, no inversion
26603 occurs. Consider this condition:
26605 dnslists = black.list.tld/<;192.168.1.2;a.domain
26607 The DNS lookups that occur are:
26609 2.1.168.192.black.list.tld
26610 a.domain.black.list.tld
26612 Once a DNS record has been found (that matches a specific IP return
26613 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
26614 are done. If there is a temporary DNS error, the rest of the sublist of domains
26615 or IP addresses is tried. A temporary error for the whole dnslists item occurs
26616 only if no other DNS lookup in this sublist succeeds. In other words, a
26617 successful lookup for any of the items in the sublist overrides a temporary
26618 error for a previous item.
26620 The ability to supply a list of items after the slash is in some sense just a
26621 syntactic convenience. These two examples have the same effect:
26623 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
26624 dnslists = black.list.tld/a.domain::b.domain
26626 However, when the data for the list is obtained from a lookup, the second form
26627 is usually much more convenient. Consider this example:
26629 deny message = The mail servers for the domain \
26630 $sender_address_domain \
26631 are listed at $dnslist_domain ($dnslist_value); \
26633 dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
26634 ${lookup dnsdb {>|mxh=\
26635 $sender_address_domain} }} }
26637 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
26638 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
26639 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
26640 of expanding the condition might be something like this:
26642 dnslists = sbl.spahmaus.org/<|192.168.2.3|192.168.5.6|...
26644 Thus, this example checks whether or not the IP addresses of the sender
26645 domain's mail servers are on the Spamhaus black list.
26647 The key that was used for a successful DNS list lookup is put into the variable
26648 &$dnslist_matched$& (see section &<<SECID204>>&).
26653 .section "Data returned by DNS lists" "SECID203"
26654 .cindex "DNS list" "data returned from"
26655 DNS lists are constructed using address records in the DNS. The original RBL
26656 just used the address 127.0.0.1 on the right hand side of each record, but the
26657 RBL+ list and some other lists use a number of values with different meanings.
26658 The values used on the RBL+ list are:
26662 127.1.0.3 DUL and RBL
26664 127.1.0.5 RSS and RBL
26665 127.1.0.6 RSS and DUL
26666 127.1.0.7 RSS and DUL and RBL
26668 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
26669 different values. Some DNS lists may return more than one address record;
26670 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
26673 .section "Variables set from DNS lists" "SECID204"
26674 .cindex "expansion" "variables, set from DNS list"
26675 .cindex "DNS list" "variables set from"
26676 .vindex "&$dnslist_domain$&"
26677 .vindex "&$dnslist_matched$&"
26678 .vindex "&$dnslist_text$&"
26679 .vindex "&$dnslist_value$&"
26680 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
26681 the name of the overall domain that matched (for example,
26682 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
26683 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
26684 the DNS record. When the key is an IP address, it is not reversed in
26685 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
26686 cases, for example:
26688 deny dnslists = spamhaus.example
26690 the key is also available in another variable (in this case,
26691 &$sender_host_address$&). In more complicated cases, however, this is not true.
26692 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
26693 might generate a dnslists lookup like this:
26695 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
26697 If this condition succeeds, the value in &$dnslist_matched$& might be
26698 &`192.168.6.7`& (for example).
26700 If more than one address record is returned by the DNS lookup, all the IP
26701 addresses are included in &$dnslist_value$&, separated by commas and spaces.
26702 The variable &$dnslist_text$& contains the contents of any associated TXT
26703 record. For lists such as RBL+ the TXT record for a merged entry is often not
26704 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
26707 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
26708 &-- although these appear before the condition in the ACL, they are not
26709 expanded until after it has failed. For example:
26711 deny hosts = !+local_networks
26712 message = $sender_host_address is listed \
26714 dnslists = rbl-plus.mail-abuse.example
26719 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
26720 .cindex "DNS list" "matching specific returned data"
26721 You can add an equals sign and an IP address after a &%dnslists%& domain name
26722 in order to restrict its action to DNS records with a matching right hand side.
26725 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
26727 rejects only those hosts that yield 127.0.0.2. Without this additional data,
26728 any address record is considered to be a match. For the moment, we assume
26729 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
26730 describes how multiple records are handled.
26732 More than one IP address may be given for checking, using a comma as a
26733 separator. These are alternatives &-- if any one of them matches, the
26734 &%dnslists%& condition is true. For example:
26736 deny dnslists = a.b.c=127.0.0.2,127.0.0.3
26738 If you want to specify a constraining address list and also specify names or IP
26739 addresses to be looked up, the constraining address list must be specified
26740 first. For example:
26742 deny dnslists = dsn.rfc-ignorant.org\
26743 =127.0.0.2/$sender_address_domain
26746 If the character &`&&`& is used instead of &`=`&, the comparison for each
26747 listed IP address is done by a bitwise &"and"& instead of by an equality test.
26748 In other words, the listed addresses are used as bit masks. The comparison is
26749 true if all the bits in the mask are present in the address that is being
26750 tested. For example:
26752 dnslists = a.b.c&0.0.0.3
26754 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
26755 want to test whether one bit or another bit is present (as opposed to both
26756 being present), you must use multiple values. For example:
26758 dnslists = a.b.c&0.0.0.1,0.0.0.2
26760 matches if the final component of the address is an odd number or two times
26765 .section "Negated DNS matching conditions" "SECID205"
26766 You can supply a negative list of IP addresses as part of a &%dnslists%&
26769 deny dnslists = a.b.c=127.0.0.2,127.0.0.3
26771 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
26772 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
26774 deny dnslists = a.b.c!=127.0.0.2,127.0.0.3
26776 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
26777 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
26778 words, the result of the test is inverted if an exclamation mark appears before
26779 the &`=`& (or the &`&&`&) sign.
26781 &*Note*&: This kind of negation is not the same as negation in a domain,
26782 host, or address list (which is why the syntax is different).
26784 If you are using just one list, the negation syntax does not gain you much. The
26785 previous example is precisely equivalent to
26787 deny dnslists = a.b.c
26788 !dnslists = a.b.c=127.0.0.2,127.0.0.3
26790 However, if you are using multiple lists, the negation syntax is clearer.
26791 Consider this example:
26793 deny dnslists = sbl.spamhaus.org : \
26795 dnsbl.njabl.org!=127.0.0.3 : \
26798 Using only positive lists, this would have to be:
26800 deny dnslists = sbl.spamhaus.org : \
26802 deny dnslists = dnsbl.njabl.org
26803 !dnslists = dnsbl.njabl.org=127.0.0.3
26804 deny dnslists = relays.ordb.org
26806 which is less clear, and harder to maintain.
26811 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
26812 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
26813 thereby providing more than one IP address. When an item in a &%dnslists%& list
26814 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
26815 the match to specific results from the DNS lookup, there are two ways in which
26816 the checking can be handled. For example, consider the condition:
26818 dnslists = a.b.c=127.0.0.1
26820 What happens if the DNS lookup for the incoming IP address yields both
26821 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
26822 condition true because at least one given value was found, or is it false
26823 because at least one of the found values was not listed? And how does this
26824 affect negated conditions? Both possibilities are provided for with the help of
26825 additional separators &`==`& and &`=&&`&.
26828 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
26829 IP addresses matches one of the listed addresses. For the example above, the
26830 condition is true because 127.0.0.1 matches.
26832 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
26833 looked up IP addresses matches one of the listed addresses. If the condition is
26836 dnslists = a.b.c==127.0.0.1
26838 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
26839 false because 127.0.0.2 is not listed. You would need to have:
26841 dnslists = a.b.c==127.0.0.1,127.0.0.2
26843 for the condition to be true.
26846 When &`!`& is used to negate IP address matching, it inverts the result, giving
26847 the precise opposite of the behaviour above. Thus:
26849 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
26850 addresses matches one of the listed addresses. Consider:
26852 dnslists = a.b.c!&0.0.0.1
26854 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
26855 false because 127.0.0.1 matches.
26857 If &`!==`& or &`!=&&`& is used, the condition is true there is at least one
26858 looked up IP address that does not match. Consider:
26860 dnslists = a.b.c!=&0.0.0.1
26862 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
26863 true, because 127.0.0.2 does not match. You would need to have:
26865 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
26867 for the condition to be false.
26869 When the DNS lookup yields only a single IP address, there is no difference
26870 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
26875 .section "Detailed information from merged DNS lists" "SECTmordetinf"
26876 .cindex "DNS list" "information from merged"
26877 When the facility for restricting the matching IP values in a DNS list is used,
26878 the text from the TXT record that is set in &$dnslist_text$& may not reflect
26879 the true reason for rejection. This happens when lists are merged and the IP
26880 address in the A record is used to distinguish them; unfortunately there is
26881 only one TXT record. One way round this is not to use merged lists, but that
26882 can be inefficient because it requires multiple DNS lookups where one would do
26883 in the vast majority of cases when the host of interest is not on any of the
26886 A less inefficient way of solving this problem is available. If
26887 two domain names, comma-separated, are given, the second is used first to
26888 do an initial check, making use of any IP value restrictions that are set.
26889 If there is a match, the first domain is used, without any IP value
26890 restrictions, to get the TXT record. As a byproduct of this, there is also
26891 a check that the IP being tested is indeed on the first list. The first
26892 domain is the one that is put in &$dnslist_domain$&. For example:
26895 rejected because $sender_host_address is blacklisted \
26896 at $dnslist_domain\n$dnslist_text
26898 sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
26899 dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
26901 For the first blacklist item, this starts by doing a lookup in
26902 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
26903 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
26904 value, and as long as something is found, it looks for the corresponding TXT
26905 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
26906 The second blacklist item is processed similarly.
26908 If you are interested in more than one merged list, the same list must be
26909 given several times, but because the results of the DNS lookups are cached,
26910 the DNS calls themselves are not repeated. For example:
26912 reject dnslists = \
26913 http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
26914 socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
26915 misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
26916 dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
26918 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
26919 values matches (or if no record is found), this is the only lookup that is
26920 done. Only if there is a match is one of the more specific lists consulted.
26924 .section "DNS lists and IPv6" "SECTmorednslistslast"
26925 .cindex "IPv6" "DNS black lists"
26926 .cindex "DNS list" "IPv6 usage"
26927 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
26928 nibble by nibble. For example, if the calling host's IP address is
26929 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
26931 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
26932 f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
26934 (split over two lines here to fit on the page). Unfortunately, some of the DNS
26935 lists contain wildcard records, intended for IPv4, that interact badly with
26936 IPv6. For example, the DNS entry
26938 *.3.some.list.example. A 127.0.0.1
26940 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
26941 Unfortunately, it also matches the entire 3::/4 IPv6 network.
26943 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
26944 &%condition%& condition, as in this example:
26946 deny condition = ${if isip4{$sender_host_address}}
26947 dnslists = some.list.example
26950 .section "Rate limiting incoming messages" "SECTratelimiting"
26951 .cindex "rate limiting" "client sending"
26952 .cindex "limiting client sending rates"
26953 .oindex "&%smtp_ratelimit_*%&"
26954 The &%ratelimit%& ACL condition can be used to measure and control the rate at
26955 which clients can send email. This is more powerful than the
26956 &%smtp_ratelimit_*%& options, because those options control the rate of
26957 commands in a single SMTP session only, whereas the &%ratelimit%& condition
26958 works across all connections (concurrent and sequential) from the same client
26959 host. The syntax of the &%ratelimit%& condition is:
26961 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
26963 If the average client sending rate is less than &'m'& messages per time
26964 period &'p'& then the condition is false; otherwise it is true.
26966 As a side-effect, the &%ratelimit%& condition sets the expansion variable
26967 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
26968 configured value of &'m'&, and &$sender_rate_period$& to the configured value
26971 The parameter &'p'& is the smoothing time constant, in the form of an Exim
26972 time interval, for example, &`8h`& for eight hours. A larger time constant
26973 means that it takes Exim longer to forget a client's past behaviour. The
26974 parameter &'m'& is the maximum number of messages that a client is permitted to
26975 send in each time interval. It also specifies the number of messages permitted
26976 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
26977 constant, you can allow a client to send more messages in a burst without
26978 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
26979 both small, messages must be sent at an even rate.
26981 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
26982 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
26983 when deploying the &%ratelimit%& ACL condition. The script prints usage
26984 instructions when it is run with no arguments.
26986 The key is used to look up the data for calculating the client's average
26987 sending rate. This data is stored in Exim's spool directory, alongside the
26988 retry and other hints databases. The default key is &$sender_host_address$&,
26989 which means Exim computes the sending rate of each client host IP address.
26990 By changing the key you can change how Exim identifies clients for the purpose
26991 of ratelimiting. For example, to limit the sending rate of each authenticated
26992 user, independent of the computer they are sending from, set the key to
26993 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
26994 example, &$authenticated_id$& is only meaningful if the client has
26995 authenticated (which you can check with the &%authenticated%& ACL condition).
26997 The lookup key does not have to identify clients: If you want to limit the
26998 rate at which a recipient receives messages, you can use the key
26999 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
27002 Internally, Exim appends the smoothing constant &'p'& and the options onto the
27003 lookup key because they alter the meaning of the stored data. This is not true
27004 for the limit &'m'&, so you can alter the configured maximum rate and Exim will
27005 still remember clients' past behaviour, but if you alter the other ratelimit
27006 parameters Exim forgets past behaviour.
27008 Each &%ratelimit%& condition can have up to three options. One option
27009 specifies what Exim measures the rate of, and the second specifies how Exim
27010 handles excessively fast clients. The third option can be &`noupdate`&, to
27011 disable updating of the ratelimiting database (see section &<<rearatdat>>&).
27012 The options are separated by a slash, like the other parameters. They may
27013 appear in any order.
27015 .section "Ratelimit options for what is being measured" "ratoptmea"
27016 The &%per_conn%& option limits the client's connection rate.
27018 The &%per_mail%& option limits the client's rate of sending messages. This is
27019 the default if none of the &%per_*%& options is specified.
27021 The &%per_byte%& option limits the sender's email bandwidth. Note that it is
27022 best to use this option in the DATA ACL; if it is used in an earlier ACL it
27023 relies on the SIZE parameter specified by the client in its MAIL command,
27024 which may be inaccurate or completely missing. You can follow the limit &'m'&
27025 in the configuration with K, M, or G to specify limits in kilobytes,
27026 megabytes, or gigabytes, respectively.
27028 The &%per_rcpt%& option causes Exim to limit the rate at which
27029 recipients are accepted. To be effective, it would need to be used in
27030 either the &%acl_smtp_rcpt%& or the &%acl_not_smtp%& ACL. In the
27031 &%acl_smtp_rcpt%& ACL, the number of recipients is incremented by one.
27032 In the case of a locally submitted message in the &%acl_not_smtp%& ACL,
27033 the number of recipients is incremented by the &%$recipients_count%&
27034 for the entire message. Note that in either case the rate limiting
27035 engine will see a message with many recipients as a large high-speed
27038 The &%per_cmd%& option causes Exim to recompute the rate every time the
27039 condition is processed. This can be used to limit the SMTP command rate.
27040 This command is essentially an alias of &%per_rcpt%& to make it clear
27041 that the effect is to limit the rate at which individual commands,
27042 rather than recipients, are accepted.
27044 .section "Ratelimit options for handling fast clients" "ratophanfas"
27045 If a client's average rate is greater than the maximum, the rate limiting
27046 engine can react in two possible ways, depending on the presence of the
27047 &%strict%& or &%leaky%& options. This is independent of the other
27048 counter-measures (such as rejecting the message) that may be specified by the
27049 rest of the ACL. The default mode is leaky, which avoids a sender's
27050 over-aggressive retry rate preventing it from getting any email through.
27052 The &%strict%& option means that the client's recorded rate is always
27053 updated. The effect of this is that Exim measures the client's average rate
27054 of attempts to send email, which can be much higher than the maximum it is
27055 actually allowed. If the client is over the limit it may be subjected to
27056 counter-measures by the ACL until it slows down below the maximum rate. If
27057 the client stops attempting to send email for the time specified in the &'p'&
27058 parameter then its computed rate will decay exponentially to 37% of its peak
27059 value. You can work out the time (the number of smoothing periods) that a
27060 client is subjected to counter-measures after an over-limit burst with this
27063 ln(peakrate/maxrate)
27065 The &%leaky%& (default) option means that the client's recorded rate is not
27066 updated if it is above the limit. The effect of this is that Exim measures the
27067 client's average rate of successfully sent email, which cannot be greater than
27068 the maximum allowed. If the client is over the limit it may suffer some
27069 counter-measures (as specified in the ACL), but it will still be able to send
27070 email at the configured maximum rate, whatever the rate of its attempts. This
27071 is generally the better choice if you have clients that retry automatically.
27073 .section "Using rate limiting" "useratlim"
27074 Exim's other ACL facilities are used to define what counter-measures are taken
27075 when the rate limit is exceeded. This might be anything from logging a warning
27076 (for example, while measuring existing sending rates in order to define
27077 policy), through time delays to slow down fast senders, up to rejecting the
27078 message. For example:
27080 # Log all senders' rates
27081 warn ratelimit = 0 / 1h / strict
27082 log_message = Sender rate $sender_rate / $sender_rate_period
27084 # Slow down fast senders; note the need to truncate $sender_rate
27085 # at the decimal point.
27086 warn ratelimit = 100 / 1h / per_rcpt / strict
27087 delay = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
27088 $sender_rate_limit }s
27090 # Keep authenticated users under control
27091 deny authenticated = *
27092 ratelimit = 100 / 1d / strict / $authenticated_id
27094 # System-wide rate limit
27095 defer message = Sorry, too busy. Try again later.
27096 ratelimit = 10 / 1s / $primary_hostname
27098 # Restrict incoming rate from each host, with a default
27099 # set using a macro and special cases looked up in a table.
27100 defer message = Sender rate exceeds $sender_rate_limit \
27101 messages per $sender_rate_period
27102 ratelimit = ${lookup {$sender_host_address} \
27103 cdb {DB/ratelimits.cdb} \
27104 {$value} {RATELIMIT} }
27106 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
27107 especially with the &%per_rcpt%& option, you may suffer from a performance
27108 bottleneck caused by locking on the ratelimit hints database. Apart from
27109 making your ACLs less complicated, you can reduce the problem by using a
27110 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
27111 this means that Exim will lose its hints data after a reboot (including retry
27112 hints, the callout cache, and ratelimit data).
27115 .section "Reading ratelimit data without updating" "rearatdat"
27116 .cindex "rate limitint" "reading data without updating"
27117 If the &%noupdate%& option is present on a &%ratelimit%& ACL condition, Exim
27118 computes the rate and checks the limit as normal, but it does not update the
27119 saved data. This means that, in relevant ACLs, it is possible to lookup the
27120 existence of a specified (or auto-generated) ratelimit key without incrementing
27121 the ratelimit counter for that key. In order for this to be useful, another ACL
27122 entry must set the rate for the same key (otherwise it will always be zero).
27126 deny ratelimit = 100 / 5m / strict / per_cmd / noupdate
27127 log_message = RATE: $sender_rate/$sender_rate_period \
27128 (max $sender_rate_limit)
27131 &'... some other logic and tests...'&
27135 warn ratelimit = 100 / 5m / strict / per_cmd
27136 condition = ${if le{$sender_rate}{$sender_rate_limit}}
27137 logwrite = RATE UPDATE: $sender_rate/$sender_rate_period \
27138 (max $sender_rate_limit)
27140 In this example, the rate is tested and used to deny access (when it is too
27141 high) in the connect ACL, but the actual computation of the remembered rate
27142 happens later, on a per-command basis, in another ACL.
27146 .section "Address verification" "SECTaddressverification"
27147 .cindex "verifying address" "options for"
27148 .cindex "policy control" "address verification"
27149 Several of the &%verify%& conditions described in section
27150 &<<SECTaclconditions>>& cause addresses to be verified. Section
27151 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
27152 The verification conditions can be followed by options that modify the
27153 verification process. The options are separated from the keyword and from each
27154 other by slashes, and some of them contain parameters. For example:
27156 verify = sender/callout
27157 verify = recipient/defer_ok/callout=10s,defer_ok
27159 The first stage of address verification, which always happens, is to run the
27160 address through the routers, in &"verify mode"&. Routers can detect the
27161 difference between verification and routing for delivery, and their actions can
27162 be varied by a number of generic options such as &%verify%& and &%verify_only%&
27163 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
27164 The available options are as follows:
27167 If the &%callout%& option is specified, successful routing to one or more
27168 remote hosts is followed by a &"callout"& to those hosts as an additional
27169 check. Callouts and their sub-options are discussed in the next section.
27171 If there is a defer error while doing verification routing, the ACL
27172 normally returns &"defer"&. However, if you include &%defer_ok%& in the
27173 options, the condition is forced to be true instead. Note that this is a main
27174 verification option as well as a suboption for callouts.
27176 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
27177 discusses the reporting of sender address verification failures.
27179 The &%success_on_redirect%& option causes verification always to succeed
27180 immediately after a successful redirection. By default, if a redirection
27181 generates just one address, that address is also verified. See further
27182 discussion in section &<<SECTredirwhilveri>>&.
27185 .cindex "verifying address" "differentiating failures"
27186 .vindex "&$recipient_verify_failure$&"
27187 .vindex "&$sender_verify_failure$&"
27188 .vindex "&$acl_verify_message$&"
27189 After an address verification failure, &$acl_verify_message$& contains the
27190 error message that is associated with the failure. It can be preserved by
27193 warn !verify = sender
27194 set acl_m0 = $acl_verify_message
27196 If you are writing your own custom rejection message or log message when
27197 denying access, you can use this variable to include information about the
27198 verification failure.
27200 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
27201 appropriate) contains one of the following words:
27204 &%qualify%&: The address was unqualified (no domain), and the message
27205 was neither local nor came from an exempted host.
27207 &%route%&: Routing failed.
27209 &%mail%&: Routing succeeded, and a callout was attempted; rejection
27210 occurred at or before the MAIL command (that is, on initial
27211 connection, HELO, or MAIL).
27213 &%recipient%&: The RCPT command in a callout was rejected.
27215 &%postmaster%&: The postmaster check in a callout was rejected.
27218 The main use of these variables is expected to be to distinguish between
27219 rejections of MAIL and rejections of RCPT in callouts.
27224 .section "Callout verification" "SECTcallver"
27225 .cindex "verifying address" "by callout"
27226 .cindex "callout" "verification"
27227 .cindex "SMTP" "callout verification"
27228 For non-local addresses, routing verifies the domain, but is unable to do any
27229 checking of the local part. There are situations where some means of verifying
27230 the local part is desirable. One way this can be done is to make an SMTP
27231 &'callback'& to a delivery host for the sender address or a &'callforward'& to
27232 a subsequent host for a recipient address, to see if the host accepts the
27233 address. We use the term &'callout'& to cover both cases. Note that for a
27234 sender address, the callback is not to the client host that is trying to
27235 deliver the message, but to one of the hosts that accepts incoming mail for the
27238 Exim does not do callouts by default. If you want them to happen, you must
27239 request them by setting appropriate options on the &%verify%& condition, as
27240 described below. This facility should be used with care, because it can add a
27241 lot of resource usage to the cost of verifying an address. However, Exim does
27242 cache the results of callouts, which helps to reduce the cost. Details of
27243 caching are in section &<<SECTcallvercache>>&.
27245 Recipient callouts are usually used only between hosts that are controlled by
27246 the same administration. For example, a corporate gateway host could use
27247 callouts to check for valid recipients on an internal mailserver. A successful
27248 callout does not guarantee that a real delivery to the address would succeed;
27249 on the other hand, a failing callout does guarantee that a delivery would fail.
27251 If the &%callout%& option is present on a condition that verifies an address, a
27252 second stage of verification occurs if the address is successfully routed to
27253 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
27254 &(manualroute)& router, where the router specifies the hosts. However, if a
27255 router that does not set up hosts routes to an &(smtp)& transport with a
27256 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
27257 &%hosts_override%& set, its hosts are always used, whether or not the router
27258 supplies a host list.
27260 The port that is used is taken from the transport, if it is specified and is a
27261 remote transport. (For routers that do verification only, no transport need be
27262 specified.) Otherwise, the default SMTP port is used. If a remote transport
27263 specifies an outgoing interface, this is used; otherwise the interface is not
27264 specified. Likewise, the text that is used for the HELO command is taken from
27265 the transport's &%helo_data%& option; if there is no transport, the value of
27266 &$smtp_active_hostname$& is used.
27268 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
27269 test whether a bounce message could be delivered to the sender address. The
27270 following SMTP commands are sent:
27272 &`HELO `&<&'local host name'&>
27274 &`RCPT TO:`&<&'the address to be tested'&>
27277 LHLO is used instead of HELO if the transport's &%protocol%& option is
27280 A recipient callout check is similar. By default, it also uses an empty address
27281 for the sender. This default is chosen because most hosts do not make use of
27282 the sender address when verifying a recipient. Using the same address means
27283 that a single cache entry can be used for each recipient. Some sites, however,
27284 do make use of the sender address when verifying. These are catered for by the
27285 &%use_sender%& and &%use_postmaster%& options, described in the next section.
27287 If the response to the RCPT command is a 2&'xx'& code, the verification
27288 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
27289 Exim tries the next host, if any. If there is a problem with all the remote
27290 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
27291 &%callout%& option is given, in which case the condition is forced to succeed.
27293 .cindex "SMTP" "output flushing, disabling for callout"
27294 A callout may take a little time. For this reason, Exim normally flushes SMTP
27295 output before performing a callout in an ACL, to avoid unexpected timeouts in
27296 clients when the SMTP PIPELINING extension is in use. The flushing can be
27297 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
27302 .section "Additional parameters for callouts" "CALLaddparcall"
27303 .cindex "callout" "additional parameters for"
27304 The &%callout%& option can be followed by an equals sign and a number of
27305 optional parameters, separated by commas. For example:
27307 verify = recipient/callout=10s,defer_ok
27309 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
27310 separate verify options, is retained for backwards compatibility, but is now
27311 deprecated. The additional parameters for &%callout%& are as follows:
27315 .vitem <&'a&~time&~interval'&>
27316 .cindex "callout" "timeout, specifying"
27317 This specifies the timeout that applies for the callout attempt to each host.
27320 verify = sender/callout=5s
27322 The default is 30 seconds. The timeout is used for each response from the
27323 remote host. It is also used for the initial connection, unless overridden by
27324 the &%connect%& parameter.
27327 .vitem &*connect&~=&~*&<&'time&~interval'&>
27328 .cindex "callout" "connection timeout, specifying"
27329 This parameter makes it possible to set a different (usually smaller) timeout
27330 for making the SMTP connection. For example:
27332 verify = sender/callout=5s,connect=1s
27334 If not specified, this timeout defaults to the general timeout value.
27336 .vitem &*defer_ok*&
27337 .cindex "callout" "defer, action on"
27338 When this parameter is present, failure to contact any host, or any other kind
27339 of temporary error, is treated as success by the ACL. However, the cache is not
27340 updated in this circumstance.
27342 .vitem &*fullpostmaster*&
27343 .cindex "callout" "full postmaster check"
27344 This operates like the &%postmaster%& option (see below), but if the check for
27345 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
27346 accordance with the specification in RFC 2821. The RFC states that the
27347 unqualified address &'postmaster'& should be accepted.
27350 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
27351 .cindex "callout" "sender when verifying header"
27352 When verifying addresses in header lines using the &%header_sender%&
27353 verification option, Exim behaves by default as if the addresses are envelope
27354 sender addresses from a message. Callout verification therefore tests to see
27355 whether a bounce message could be delivered, by using an empty address in the
27356 MAIL command. However, it is arguable that these addresses might never be used
27357 as envelope senders, and could therefore justifiably reject bounce messages
27358 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
27359 address to use in the MAIL command. For example:
27361 require verify = header_sender/callout=mailfrom=abcd@x.y.z
27363 This parameter is available only for the &%header_sender%& verification option.
27366 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
27367 .cindex "callout" "overall timeout, specifying"
27368 This parameter sets an overall timeout for performing a callout verification.
27371 verify = sender/callout=5s,maxwait=30s
27373 This timeout defaults to four times the callout timeout for individual SMTP
27374 commands. The overall timeout applies when there is more than one host that can
27375 be tried. The timeout is checked before trying the next host. This prevents
27376 very long delays if there are a large number of hosts and all are timing out
27377 (for example, when network connections are timing out).
27380 .vitem &*no_cache*&
27381 .cindex "callout" "cache, suppressing"
27382 .cindex "caching callout, suppressing"
27383 When this parameter is given, the callout cache is neither read nor updated.
27385 .vitem &*postmaster*&
27386 .cindex "callout" "postmaster; checking"
27387 When this parameter is set, a successful callout check is followed by a similar
27388 check for the local part &'postmaster'& at the same domain. If this address is
27389 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
27390 the postmaster check is recorded in a cache record; if it is a failure, this is
27391 used to fail subsequent callouts for the domain without a connection being
27392 made, until the cache record expires.
27394 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
27395 The postmaster check uses an empty sender in the MAIL command by default.
27396 You can use this parameter to do a postmaster check using a different address.
27399 require verify = sender/callout=postmaster_mailfrom=abc@x.y.z
27401 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
27402 one overrides. The &%postmaster%& parameter is equivalent to this example:
27404 require verify = sender/callout=postmaster_mailfrom=
27406 &*Warning*&: The caching arrangements for postmaster checking do not take
27407 account of the sender address. It is assumed that either the empty address or
27408 a fixed non-empty address will be used. All that Exim remembers is that the
27409 postmaster check for the domain succeeded or failed.
27413 .cindex "callout" "&""random""& check"
27414 When this parameter is set, before doing the normal callout check, Exim does a
27415 check for a &"random"& local part at the same domain. The local part is not
27416 really random &-- it is defined by the expansion of the option
27417 &%callout_random_local_part%&, which defaults to
27419 $primary_host_name-$tod_epoch-testing
27421 The idea here is to try to determine whether the remote host accepts all local
27422 parts without checking. If it does, there is no point in doing callouts for
27423 specific local parts. If the &"random"& check succeeds, the result is saved in
27424 a cache record, and used to force the current and subsequent callout checks to
27425 succeed without a connection being made, until the cache record expires.
27427 .vitem &*use_postmaster*&
27428 .cindex "callout" "sender for recipient check"
27429 This parameter applies to recipient callouts only. For example:
27431 deny !verify = recipient/callout=use_postmaster
27433 .vindex "&$qualify_domain$&"
27434 It causes a non-empty postmaster address to be used in the MAIL command when
27435 performing the callout for the recipient, and also for a &"random"& check if
27436 that is configured. The local part of the address is &`postmaster`& and the
27437 domain is the contents of &$qualify_domain$&.
27439 .vitem &*use_sender*&
27440 This option applies to recipient callouts only. For example:
27442 require verify = recipient/callout=use_sender
27444 It causes the message's actual sender address to be used in the MAIL
27445 command when performing the callout, instead of an empty address. There is no
27446 need to use this option unless you know that the called hosts make use of the
27447 sender when checking recipients. If used indiscriminately, it reduces the
27448 usefulness of callout caching.
27451 If you use any of the parameters that set a non-empty sender for the MAIL
27452 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
27453 &%use_sender%&), you should think about possible loops. Recipient checking is
27454 usually done between two hosts that are under the same management, and the host
27455 that receives the callouts is not normally configured to do callouts itself.
27456 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
27457 these circumstances.
27459 However, if you use a non-empty sender address for a callout to an arbitrary
27460 host, there is the likelihood that the remote host will itself initiate a
27461 callout check back to your host. As it is checking what appears to be a message
27462 sender, it is likely to use an empty address in MAIL, thus avoiding a
27463 callout loop. However, to be on the safe side it would be best to set up your
27464 own ACLs so that they do not do sender verification checks when the recipient
27465 is the address you use for header sender or postmaster callout checking.
27467 Another issue to think about when using non-empty senders for callouts is
27468 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
27469 by the sender/recipient combination; thus, for any given recipient, many more
27470 actual callouts are performed than when an empty sender or postmaster is used.
27475 .section "Callout caching" "SECTcallvercache"
27476 .cindex "hints database" "callout cache"
27477 .cindex "callout" "cache, description of"
27478 .cindex "caching" "callout"
27479 Exim caches the results of callouts in order to reduce the amount of resources
27480 used, unless you specify the &%no_cache%& parameter with the &%callout%&
27481 option. A hints database called &"callout"& is used for the cache. Two
27482 different record types are used: one records the result of a callout check for
27483 a specific address, and the other records information that applies to the
27484 entire domain (for example, that it accepts the local part &'postmaster'&).
27486 When an original callout fails, a detailed SMTP error message is given about
27487 the failure. However, for subsequent failures use the cache data, this message
27490 The expiry times for negative and positive address cache records are
27491 independent, and can be set by the global options &%callout_negative_expire%&
27492 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
27494 If a host gives a negative response to an SMTP connection, or rejects any
27495 commands up to and including
27499 (but not including the MAIL command with a non-empty address),
27500 any callout attempt is bound to fail. Exim remembers such failures in a
27501 domain cache record, which it uses to fail callouts for the domain without
27502 making new connections, until the domain record times out. There are two
27503 separate expiry times for domain cache records:
27504 &%callout_domain_negative_expire%& (default 3h) and
27505 &%callout_domain_positive_expire%& (default 7d).
27507 Domain records expire when the negative expiry time is reached if callouts
27508 cannot be made for the domain, or if the postmaster check failed.
27509 Otherwise, they expire when the positive expiry time is reached. This
27510 ensures that, for example, a host that stops accepting &"random"& local parts
27511 will eventually be noticed.
27513 The callout caching mechanism is based on the domain of the address that is
27514 being tested. If the domain routes to several hosts, it is assumed that their
27515 behaviour will be the same.
27519 .section "Sender address verification reporting" "SECTsenaddver"
27520 .cindex "verifying" "suppressing error details"
27521 See section &<<SECTaddressverification>>& for a general discussion of
27522 verification. When sender verification fails in an ACL, the details of the
27523 failure are given as additional output lines before the 550 response to the
27524 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
27527 MAIL FROM:<xyz@abc.example>
27529 RCPT TO:<pqr@def.example>
27530 550-Verification failed for <xyz@abc.example>
27531 550-Called: 192.168.34.43
27532 550-Sent: RCPT TO:<xyz@abc.example>
27533 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
27534 550 Sender verification failed
27536 If more than one RCPT command fails in the same way, the details are given
27537 only for the first of them. However, some administrators do not want to send
27538 out this much information. You can suppress the details by adding
27539 &`/no_details`& to the ACL statement that requests sender verification. For
27542 verify = sender/no_details
27545 .section "Redirection while verifying" "SECTredirwhilveri"
27546 .cindex "verifying" "redirection while"
27547 .cindex "address redirection" "while verifying"
27548 A dilemma arises when a local address is redirected by aliasing or forwarding
27549 during verification: should the generated addresses themselves be verified,
27550 or should the successful expansion of the original address be enough to verify
27551 it? By default, Exim takes the following pragmatic approach:
27554 When an incoming address is redirected to just one child address, verification
27555 continues with the child address, and if that fails to verify, the original
27556 verification also fails.
27558 When an incoming address is redirected to more than one child address,
27559 verification does not continue. A success result is returned.
27562 This seems the most reasonable behaviour for the common use of aliasing as a
27563 way of redirecting different local parts to the same mailbox. It means, for
27564 example, that a pair of alias entries of the form
27567 aw123: :fail: Gone away, no forwarding address
27569 work as expected, with both local parts causing verification failure. When a
27570 redirection generates more than one address, the behaviour is more like a
27571 mailing list, where the existence of the alias itself is sufficient for
27572 verification to succeed.
27574 It is possible, however, to change the default behaviour so that all successful
27575 redirections count as successful verifications, however many new addresses are
27576 generated. This is specified by the &%success_on_redirect%& verification
27577 option. For example:
27579 require verify = recipient/success_on_redirect/callout=10s
27581 In this example, verification succeeds if a router generates a new address, and
27582 the callout does not occur, because no address was routed to a remote host.
27584 When verification is being tested via the &%-bv%& option, the treatment of
27585 redirections is as just described, unless the &%-v%& or any debugging option is
27586 also specified. In that case, full verification is done for every generated
27587 address and a report is output for each of them.
27591 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
27592 .cindex "CSA" "verifying"
27593 Client SMTP Authorization is a system that allows a site to advertise
27594 which machines are and are not permitted to send email. This is done by placing
27595 special SRV records in the DNS; these are looked up using the client's HELO
27596 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
27597 Authorization checks in Exim are performed by the ACL condition:
27601 This fails if the client is not authorized. If there is a DNS problem, or if no
27602 valid CSA SRV record is found, or if the client is authorized, the condition
27603 succeeds. These three cases can be distinguished using the expansion variable
27604 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
27605 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
27606 be likely to cause problems for legitimate email.
27608 The error messages produced by the CSA code include slightly more
27609 detail. If &$csa_status$& is &"defer"&, this may be because of problems
27610 looking up the CSA SRV record, or problems looking up the CSA target
27611 address record. There are four reasons for &$csa_status$& being &"fail"&:
27614 The client's host name is explicitly not authorized.
27616 The client's IP address does not match any of the CSA target IP addresses.
27618 The client's host name is authorized but it has no valid target IP addresses
27619 (for example, the target's addresses are IPv6 and the client is using IPv4).
27621 The client's host name has no CSA SRV record but a parent domain has asserted
27622 that all subdomains must be explicitly authorized.
27625 The &%csa%& verification condition can take an argument which is the domain to
27626 use for the DNS query. The default is:
27628 verify = csa/$sender_helo_name
27630 This implementation includes an extension to CSA. If the query domain
27631 is an address literal such as [192.0.2.95], or if it is a bare IP
27632 address, Exim searches for CSA SRV records in the reverse DNS as if
27633 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
27636 verify = csa/$sender_host_address
27638 In fact, this is the check that Exim performs if the client does not say HELO.
27639 This extension can be turned off by setting the main configuration option
27640 &%dns_csa_use_reverse%& to be false.
27642 If a CSA SRV record is not found for the domain itself, a search
27643 is performed through its parent domains for a record which might be
27644 making assertions about subdomains. The maximum depth of this search is limited
27645 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
27646 default. Exim does not look for CSA SRV records in a top level domain, so the
27647 default settings handle HELO domains as long as seven
27648 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
27649 of legitimate HELO domains.
27651 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
27652 direct SRV lookups, this is not sufficient because of the extra parent domain
27653 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
27654 addresses into lookups in the reverse DNS space. The result of a successful
27657 ${lookup dnsdb {csa=$sender_helo_name}}
27659 has two space-separated fields: an authorization code and a target host name.
27660 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
27661 authorization required but absent, or &"?"& for unknown.
27666 .section "Bounce address tag validation" "SECTverifyPRVS"
27667 .cindex "BATV, verifying"
27668 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
27669 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
27670 Genuine incoming bounce messages should therefore always be addressed to
27671 recipients that have a valid tag. This scheme is a way of detecting unwanted
27672 bounce messages caused by sender address forgeries (often called &"collateral
27673 spam"&), because the recipients of such messages do not include valid tags.
27675 There are two expansion items to help with the implementation of the BATV
27676 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
27677 the original envelope sender address by using a simple key to add a hash of the
27678 address and some time-based randomizing information. The &%prvs%& expansion
27679 item creates a signed address, and the &%prvscheck%& expansion item checks one.
27680 The syntax of these expansion items is described in section
27681 &<<SECTexpansionitems>>&.
27683 As an example, suppose the secret per-address keys are stored in an MySQL
27684 database. A query to look up the key for an address could be defined as a macro
27687 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
27688 WHERE sender='${quote_mysql:$prvscheck_address}'\
27691 Suppose also that the senders who make use of BATV are defined by an address
27692 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
27695 # Bounces: drop unsigned addresses for BATV senders
27696 deny message = This address does not send an unsigned reverse path
27698 recipients = +batv_senders
27700 # Bounces: In case of prvs-signed address, check signature.
27701 deny message = Invalid reverse path signature.
27703 condition = ${prvscheck {$local_part@$domain}\
27704 {PRVSCHECK_SQL}{1}}
27705 !condition = $prvscheck_result
27707 The first statement rejects recipients for bounce messages that are addressed
27708 to plain BATV sender addresses, because it is known that BATV senders do not
27709 send out messages with plain sender addresses. The second statement rejects
27710 recipients that are prvs-signed, but with invalid signatures (either because
27711 the key is wrong, or the signature has timed out).
27713 A non-prvs-signed address is not rejected by the second statement, because the
27714 &%prvscheck%& expansion yields an empty string if its first argument is not a
27715 prvs-signed address, thus causing the &%condition%& condition to be false. If
27716 the first argument is a syntactically valid prvs-signed address, the yield is
27717 the third string (in this case &"1"&), whether or not the cryptographic and
27718 timeout checks succeed. The &$prvscheck_result$& variable contains the result
27719 of the checks (empty for failure, &"1"& for success).
27721 There is one more issue you must consider when implementing prvs-signing:
27722 you have to ensure that the routers accept prvs-signed addresses and
27723 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
27724 router to remove the signature with a configuration along these lines:
27728 data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
27730 This works because, if the third argument of &%prvscheck%& is empty, the result
27731 of the expansion of a prvs-signed address is the decoded value of the original
27732 address. This router should probably be the first of your routers that handles
27735 To create BATV-signed addresses in the first place, a transport of this form
27738 external_smtp_batv:
27740 return_path = ${prvs {$return_path} \
27741 {${lookup mysql{SELECT \
27742 secret FROM batv_prvs WHERE \
27743 sender='${quote_mysql:$sender_address}'} \
27746 If no key can be found for the existing return path, no signing takes place.
27750 .section "Using an ACL to control relaying" "SECTrelaycontrol"
27751 .cindex "&ACL;" "relay control"
27752 .cindex "relaying" "control by ACL"
27753 .cindex "policy control" "relay control"
27754 An MTA is said to &'relay'& a message if it receives it from some host and
27755 delivers it directly to another host as a result of a remote address contained
27756 within it. Redirecting a local address via an alias or forward file and then
27757 passing the message on to another host is not relaying,
27758 .cindex "&""percent hack""&"
27759 but a redirection as a result of the &"percent hack"& is.
27761 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
27762 A host which is acting as a gateway or an MX backup is concerned with incoming
27763 relaying from arbitrary hosts to a specific set of domains. On the other hand,
27764 a host which is acting as a smart host for a number of clients is concerned
27765 with outgoing relaying from those clients to the Internet at large. Often the
27766 same host is fulfilling both functions,
27768 . as illustrated in the diagram below,
27770 but in principle these two kinds of relaying are entirely independent. What is
27771 not wanted is the transmission of mail from arbitrary remote hosts through your
27772 system to arbitrary domains.
27775 You can implement relay control by means of suitable statements in the ACL that
27776 runs for each RCPT command. For convenience, it is often easiest to use
27777 Exim's named list facility to define the domains and hosts involved. For
27778 example, suppose you want to do the following:
27781 Deliver a number of domains to mailboxes on the local host (or process them
27782 locally in some other way). Let's say these are &'my.dom1.example'& and
27783 &'my.dom2.example'&.
27785 Relay mail for a number of other domains for which you are the secondary MX.
27786 These might be &'friend1.example'& and &'friend2.example'&.
27788 Relay mail from the hosts on your local LAN, to whatever domains are involved.
27789 Suppose your LAN is 192.168.45.0/24.
27793 In the main part of the configuration, you put the following definitions:
27795 domainlist local_domains = my.dom1.example : my.dom2.example
27796 domainlist relay_domains = friend1.example : friend2.example
27797 hostlist relay_hosts = 192.168.45.0/24
27799 Now you can use these definitions in the ACL that is run for every RCPT
27803 accept domains = +local_domains : +relay_domains
27804 accept hosts = +relay_hosts
27806 The first statement accepts any RCPT command that contains an address in
27807 the local or relay domains. For any other domain, control passes to the second
27808 statement, which accepts the command only if it comes from one of the relay
27809 hosts. In practice, you will probably want to make your ACL more sophisticated
27810 than this, for example, by including sender and recipient verification. The
27811 default configuration includes a more comprehensive example, which is described
27812 in chapter &<<CHAPdefconfil>>&.
27816 .section "Checking a relay configuration" "SECTcheralcon"
27817 .cindex "relaying" "checking control of"
27818 You can check the relay characteristics of your configuration in the same way
27819 that you can test any ACL behaviour for an incoming SMTP connection, by using
27820 the &%-bh%& option to run a fake SMTP session with which you interact.
27822 For specifically testing for unwanted relaying, the host
27823 &'relay-test.mail-abuse.org'& provides a useful service. If you telnet to this
27824 host from the host on which Exim is running, using the normal telnet port, you
27825 will see a normal telnet connection message and then quite a long delay. Be
27826 patient. The remote host is making an SMTP connection back to your host, and
27827 trying a number of common probes to test for open relay vulnerability. The
27828 results of the tests will eventually appear on your terminal.
27833 . ////////////////////////////////////////////////////////////////////////////
27834 . ////////////////////////////////////////////////////////////////////////////
27836 .chapter "Content scanning at ACL time" "CHAPexiscan"
27837 .scindex IIDcosca "content scanning" "at ACL time"
27838 The extension of Exim to include content scanning at ACL time, formerly known
27839 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
27840 was integrated into the main source for Exim release 4.50, and Tom continues to
27841 maintain it. Most of the wording of this chapter is taken from Tom's
27844 It is also possible to scan the content of messages at other times. The
27845 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
27846 scanning after all the ACLs have run. A transport filter can be used to scan
27847 messages at delivery time (see the &%transport_filter%& option, described in
27848 chapter &<<CHAPtransportgeneric>>&).
27850 If you want to include the ACL-time content-scanning features when you compile
27851 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
27852 &_Local/Makefile_&. When you do that, the Exim binary is built with:
27855 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
27856 for all MIME parts for SMTP and non-SMTP messages, respectively.
27858 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
27859 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
27860 run at the end of message reception (the &%acl_smtp_data%& ACL).
27862 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
27863 of messages, or parts of messages, for debugging purposes.
27865 Additional expansion variables that are set in the new ACL and by the new
27868 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
27871 There is another content-scanning configuration option for &_Local/Makefile_&,
27872 called WITH_OLD_DEMIME. If this is set, the old, deprecated &%demime%& ACL
27873 condition is compiled, in addition to all the other content-scanning features.
27875 Content-scanning is continually evolving, and new features are still being
27876 added. While such features are still unstable and liable to incompatible
27877 changes, they are made available in Exim by setting options whose names begin
27878 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
27879 this manual. You can find out about them by reading the file called
27880 &_doc/experimental.txt_&.
27882 All the content-scanning facilities work on a MBOX copy of the message that is
27883 temporarily created in a file called:
27885 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
27887 The &_.eml_& extension is a friendly hint to virus scanners that they can
27888 expect an MBOX-like structure inside that file. The file is created when the
27889 first content scanning facility is called. Subsequent calls to content
27890 scanning conditions open the same file again. The directory is recursively
27891 removed when the &%acl_smtp_data%& ACL has finished running, unless
27893 control = no_mbox_unspool
27895 has been encountered. When the MIME ACL decodes files, they are put into the
27896 same directory by default.
27900 .section "Scanning for viruses" "SECTscanvirus"
27901 .cindex "virus scanning"
27902 .cindex "content scanning" "for viruses"
27903 .cindex "content scanning" "the &%malware%& condition"
27904 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
27905 It supports a &"generic"& interface to scanners called via the shell, and
27906 specialized interfaces for &"daemon"& type virus scanners, which are resident
27907 in memory and thus are much faster.
27909 .oindex "&%av_scanner%&"
27910 You can set the &%av_scanner%& option in first part of the Exim configuration
27911 file to specify which scanner to use, together with any additional options that
27912 are needed. The basic syntax is as follows:
27914 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
27916 If you do not set &%av_scanner%&, it defaults to
27918 av_scanner = sophie:/var/run/sophie
27920 If the value of &%av_scanner%& starts with a dollar character, it is expanded
27921 before use. The following scanner types are supported in this release:
27924 .vitem &%aveserver%&
27925 .cindex "virus scanners" "Kaspersky"
27926 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
27927 at &url(http://www.kaspersky.com). This scanner type takes one option,
27928 which is the path to the daemon's UNIX socket. The default is shown in this
27931 av_scanner = aveserver:/var/run/aveserver
27935 .cindex "virus scanners" "clamd"
27936 This daemon-type scanner is GPL and free. You can get it at
27937 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
27938 unpack MIME containers, so it used to be recommended to unpack MIME attachments
27939 in the MIME ACL. This no longer believed to be necessary. One option is
27940 required: either the path and name of a UNIX socket file, or a hostname or IP
27941 number, and a port, separated by space, as in the second of these examples:
27943 av_scanner = clamd:/opt/clamd/socket
27944 av_scanner = clamd:192.0.2.3 1234
27945 av_scanner = clamd:192.0.2.3 1234:local
27947 If the value of av_scanner points to a UNIX socket file or contains the local
27948 keyword, then the ClamAV interface will pass a filename containing the data
27949 to be scanned, which will should normally result in less I/O happening and be
27950 more efficient. Normally in the TCP case, the data is streamed to ClamAV as
27951 Exim does not assume that there is a common filesystem with the remote host.
27952 There is an option WITH_OLD_CLAMAV_STREAM in &_src/EDITME_& available, should
27953 you be running a version of ClamAV prior to 0.95.
27954 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
27955 contributing the code for this scanner.
27958 .cindex "virus scanners" "command line interface"
27959 This is the keyword for the generic command line scanner interface. It can be
27960 used to attach virus scanners that are invoked from the shell. This scanner
27961 type takes 3 mandatory options:
27964 The full path and name of the scanner binary, with all command line options,
27965 and a placeholder (&`%s`&) for the directory to scan.
27968 A regular expression to match against the STDOUT and STDERR output of the
27969 virus scanner. If the expression matches, a virus was found. You must make
27970 absolutely sure that this expression matches on &"virus found"&. This is called
27971 the &"trigger"& expression.
27974 Another regular expression, containing exactly one pair of parentheses, to
27975 match the name of the virus found in the scanners output. This is called the
27976 &"name"& expression.
27979 For example, Sophos Sweep reports a virus on a line like this:
27981 Virus 'W32/Magistr-B' found in file ./those.bat
27983 For the trigger expression, we can match the phrase &"found in file"&. For the
27984 name expression, we want to extract the W32/Magistr-B string, so we can match
27985 for the single quotes left and right of it. Altogether, this makes the
27986 configuration setting:
27988 av_scanner = cmdline:\
27989 /path/to/sweep -ss -all -rec -archive %s:\
27990 found in file:'(.+)'
27993 .cindex "virus scanners" "DrWeb"
27994 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface takes one
27995 argument, either a full path to a UNIX socket, or an IP address and port
27996 separated by white space, as in these examples:
27998 av_scanner = drweb:/var/run/drwebd.sock
27999 av_scanner = drweb:192.168.2.20 31337
28001 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
28002 is used. Thanks to Alex Miller for contributing the code for this scanner.
28005 .cindex "virus scanners" "F-Secure"
28006 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
28007 argument which is the path to a UNIX socket. For example:
28009 av_scanner = fsecure:/path/to/.fsav
28011 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
28012 Thelmen for contributing the code for this scanner.
28014 .vitem &%kavdaemon%&
28015 .cindex "virus scanners" "Kaspersky"
28016 This is the scanner daemon of Kaspersky Version 4. This version of the
28017 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
28018 scanner type takes one option, which is the path to the daemon's UNIX socket.
28021 av_scanner = kavdaemon:/opt/AVP/AvpCtl
28023 The default path is &_/var/run/AvpCtl_&.
28026 .cindex "virus scanners" "mksd"
28027 This is a daemon type scanner that is aimed mainly at Polish users, though some
28028 parts of documentation are now available in English. You can get it at
28029 &url(http://linux.mks.com.pl/). The only option for this scanner type is
28030 the maximum number of processes used simultaneously to scan the attachments,
28031 provided that the demime facility is employed and also provided that mksd has
28032 been run with at least the same number of child processes. For example:
28034 av_scanner = mksd:2
28036 You can safely omit this option (the default value is 1).
28039 .cindex "virus scanners" "Sophos and Sophie"
28040 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
28041 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
28042 for this scanner type is the path to the UNIX socket that Sophie uses for
28043 client communication. For example:
28045 av_scanner = sophie:/tmp/sophie
28047 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
28051 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
28052 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
28055 The &%av_scanner%& option is expanded each time &%malware%& is called. This
28056 makes it possible to use different scanners. See further below for an example.
28057 The &%malware%& condition caches its results, so when you use it multiple times
28058 for the same message, the actual scanning process is only carried out once.
28059 However, using expandable items in &%av_scanner%& disables this caching, in
28060 which case each use of the &%malware%& condition causes a new scan of the
28063 The &%malware%& condition takes a right-hand argument that is expanded before
28064 use. It can then be one of
28067 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
28068 The condition succeeds if a virus was found, and fail otherwise. This is the
28071 &"false"& or &"0"& or an empty string, in which case no scanning is done and
28072 the condition fails immediately.
28074 A regular expression, in which case the message is scanned for viruses. The
28075 condition succeeds if a virus is found and its name matches the regular
28076 expression. This allows you to take special actions on certain types of virus.
28079 You can append &`/defer_ok`& to the &%malware%& condition to accept messages
28080 even if there is a problem with the virus scanner. Otherwise, such a problem
28081 causes the ACL to defer.
28083 .vindex "&$malware_name$&"
28084 When a virus is found, the condition sets up an expansion variable called
28085 &$malware_name$& that contains the name of the virus. You can use it in a
28086 &%message%& modifier that specifies the error returned to the sender, and/or in
28089 If your virus scanner cannot unpack MIME and TNEF containers itself, you should
28090 use the &%demime%& condition (see section &<<SECTdemimecond>>&) before the
28091 &%malware%& condition.
28093 Beware the interaction of Exim's &%message_size_limit%& with any size limits
28094 imposed by your anti-virus scanner.
28096 Here is a very simple scanning example:
28098 deny message = This message contains malware ($malware_name)
28102 The next example accepts messages when there is a problem with the scanner:
28104 deny message = This message contains malware ($malware_name)
28106 malware = */defer_ok
28108 The next example shows how to use an ACL variable to scan with both sophie and
28109 aveserver. It assumes you have set:
28111 av_scanner = $acl_m0
28113 in the main Exim configuration.
28115 deny message = This message contains malware ($malware_name)
28116 set acl_m0 = sophie
28119 deny message = This message contains malware ($malware_name)
28120 set acl_m0 = aveserver
28125 .section "Scanning with SpamAssassin" "SECTscanspamass"
28126 .cindex "content scanning" "for spam"
28127 .cindex "spam scanning"
28128 .cindex "SpamAssassin"
28129 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
28130 score and a report for the message. You can get SpamAssassin at
28131 &url(http://www.spamassassin.org), or, if you have a working Perl
28132 installation, you can use CPAN by running:
28134 perl -MCPAN -e 'install Mail::SpamAssassin'
28136 SpamAssassin has its own set of configuration files. Please review its
28137 documentation to see how you can tweak it. The default installation should work
28140 .oindex "&%spamd_address%&"
28141 After having installed and configured SpamAssassin, start the &%spamd%& daemon.
28142 By default, it listens on 127.0.0.1, TCP port 783. If you use another host or
28143 port for &%spamd%&, you must set the &%spamd_address%& option in the global
28144 part of the Exim configuration as follows (example):
28146 spamd_address = 192.168.99.45 387
28148 You do not need to set this option if you use the default. As of version 2.60,
28149 &%spamd%& also supports communication over UNIX sockets. If you want to use
28150 these, supply &%spamd_address%& with an absolute file name instead of a
28153 spamd_address = /var/run/spamd_socket
28155 You can have multiple &%spamd%& servers to improve scalability. These can
28156 reside on other hardware reachable over the network. To specify multiple
28157 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
28158 option, separated with colons:
28160 spamd_address = 192.168.2.10 783 : \
28161 192.168.2.11 783 : \
28164 Up to 32 &%spamd%& servers are supported. The servers are queried in a random
28165 fashion. When a server fails to respond to the connection attempt, all other
28166 servers are tried until one succeeds. If no server responds, the &%spam%&
28169 &*Warning*&: It is not possible to use the UNIX socket connection method with
28170 multiple &%spamd%& servers.
28172 The &%spamd_address%& variable is expanded before use if it starts with
28173 a dollar sign. In this case, the expansion may return a string that is
28174 used as the list so that multiple spamd servers can be the result of an
28177 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
28178 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
28180 deny message = This message was classified as SPAM
28183 The right-hand side of the &%spam%& condition specifies a name. This is
28184 relevant if you have set up multiple SpamAssassin profiles. If you do not want
28185 to scan using a specific profile, but rather use the SpamAssassin system-wide
28186 default profile, you can scan for an unknown name, or simply use &"nobody"&.
28187 However, you must put something on the right-hand side.
28189 The name allows you to use per-domain or per-user antispam profiles in
28190 principle, but this is not straightforward in practice, because a message may
28191 have multiple recipients, not necessarily all in the same domain. Because the
28192 &%spam%& condition has to be called from a DATA ACL in order to be able to
28193 read the contents of the message, the variables &$local_part$& and &$domain$&
28196 The right-hand side of the &%spam%& condition is expanded before being used, so
28197 you can put lookups or conditions there. When the right-hand side evaluates to
28198 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
28201 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
28202 large ones may cause significant performance degradation. As most spam messages
28203 are quite small, it is recommended that you do not scan the big ones. For
28206 deny message = This message was classified as SPAM
28207 condition = ${if < {$message_size}{10K}}
28211 The &%spam%& condition returns true if the threshold specified in the user's
28212 SpamAssassin profile has been matched or exceeded. If you want to use the
28213 &%spam%& condition for its side effects (see the variables below), you can make
28214 it always return &"true"& by appending &`:true`& to the username.
28216 .cindex "spam scanning" "returned variables"
28217 When the &%spam%& condition is run, it sets up a number of expansion
28218 variables. These variables are saved with the received message, thus they are
28219 available for use at delivery time.
28222 .vitem &$spam_score$&
28223 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
28224 for inclusion in log or reject messages.
28226 .vitem &$spam_score_int$&
28227 The spam score of the message, multiplied by ten, as an integer value. For
28228 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
28229 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
28230 The integer value is useful for numeric comparisons in conditions.
28233 .vitem &$spam_bar$&
28234 A string consisting of a number of &"+"& or &"-"& characters, representing the
28235 integer part of the spam score value. A spam score of 4.4 would have a
28236 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
28237 headers, since MUAs can match on such strings.
28239 .vitem &$spam_report$&
28240 A multiline text table, containing the full SpamAssassin report for the
28241 message. Useful for inclusion in headers or reject messages.
28244 The &%spam%& condition caches its results unless expansion in
28245 spamd_address was used. If you call it again with the same user name, it
28246 does not scan again, but rather returns the same values as before.
28248 The &%spam%& condition returns DEFER if there is any error while running
28249 the message through SpamAssassin or if the expansion of spamd_address
28250 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
28251 statement block), append &`/defer_ok`& to the right-hand side of the
28252 spam condition, like this:
28254 deny message = This message was classified as SPAM
28255 spam = joe/defer_ok
28257 This causes messages to be accepted even if there is a problem with &%spamd%&.
28259 Here is a longer, commented example of the use of the &%spam%&
28262 # put headers in all messages (no matter if spam or not)
28263 warn spam = nobody:true
28264 add_header = X-Spam-Score: $spam_score ($spam_bar)
28265 add_header = X-Spam-Report: $spam_report
28267 # add second subject line with *SPAM* marker when message
28268 # is over threshold
28270 add_header = Subject: *SPAM* $h_Subject:
28272 # reject spam at high scores (> 12)
28273 deny message = This message scored $spam_score spam points.
28275 condition = ${if >{$spam_score_int}{120}{1}{0}}
28280 .section "Scanning MIME parts" "SECTscanmimepart"
28281 .cindex "content scanning" "MIME parts"
28282 .cindex "MIME content scanning"
28283 .oindex "&%acl_smtp_mime%&"
28284 .oindex "&%acl_not_smtp_mime%&"
28285 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
28286 each MIME part of an SMTP message, including multipart types, in the sequence
28287 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
28288 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
28289 options may both refer to the same ACL if you want the same processing in both
28292 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
28293 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
28294 the case of a non-SMTP message. However, a MIME ACL is called only if the
28295 message contains a &'Content-Type:'& header line. When a call to a MIME
28296 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
28297 result code is sent to the client. In the case of an SMTP message, the
28298 &%acl_smtp_data%& ACL is not called when this happens.
28300 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
28301 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
28302 condition to match against the raw MIME part. You can also use the
28303 &%mime_regex%& condition to match against the decoded MIME part (see section
28304 &<<SECTscanregex>>&).
28306 At the start of a MIME ACL, a number of variables are set from the header
28307 information for the relevant MIME part. These are described below. The contents
28308 of the MIME part are not by default decoded into a disk file except for MIME
28309 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
28310 part into a disk file, you can use the &%decode%& condition. The general
28313 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
28315 The right hand side is expanded before use. After expansion,
28319 &"0"& or &"false"&, in which case no decoding is done.
28321 The string &"default"&. In that case, the file is put in the temporary
28322 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
28323 a sequential file name consisting of the message id and a sequence number. The
28324 full path and name is available in &$mime_decoded_filename$& after decoding.
28326 A full path name starting with a slash. If the full name is an existing
28327 directory, it is used as a replacement for the default directory. The filename
28328 is then sequentially assigned. If the path does not exist, it is used as
28329 the full path and file name.
28331 If the string does not start with a slash, it is used as the
28332 filename, and the default path is then used.
28334 The &%decode%& condition normally succeeds. It is only false for syntax
28335 errors or unusual circumstances such as memory shortages. You can easily decode
28336 a file with its original, proposed filename using
28338 decode = $mime_filename
28340 However, you should keep in mind that &$mime_filename$& might contain
28341 anything. If you place files outside of the default path, they are not
28342 automatically unlinked.
28344 For RFC822 attachments (these are messages attached to messages, with a
28345 content-type of &"message/rfc822"&), the ACL is called again in the same manner
28346 as for the primary message, only that the &$mime_is_rfc822$& expansion
28347 variable is set (see below). Attached messages are always decoded to disk
28348 before being checked, and the files are unlinked once the check is done.
28350 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
28351 used to match regular expressions against raw and decoded MIME parts,
28352 respectively. They are described in section &<<SECTscanregex>>&.
28354 .cindex "MIME content scanning" "returned variables"
28355 The following list describes all expansion variables that are
28356 available in the MIME ACL:
28359 .vitem &$mime_boundary$&
28360 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
28361 have a boundary string, which is stored in this variable. If the current part
28362 has no boundary parameter in the &'Content-Type:'& header, this variable
28363 contains the empty string.
28365 .vitem &$mime_charset$&
28366 This variable contains the character set identifier, if one was found in the
28367 &'Content-Type:'& header. Examples for charset identifiers are:
28373 Please note that this value is not normalized, so you should do matches
28374 case-insensitively.
28376 .vitem &$mime_content_description$&
28377 This variable contains the normalized content of the &'Content-Description:'&
28378 header. It can contain a human-readable description of the parts content. Some
28379 implementations repeat the filename for attachments here, but they are usually
28380 only used for display purposes.
28382 .vitem &$mime_content_disposition$&
28383 This variable contains the normalized content of the &'Content-Disposition:'&
28384 header. You can expect strings like &"attachment"& or &"inline"& here.
28386 .vitem &$mime_content_id$&
28387 This variable contains the normalized content of the &'Content-ID:'& header.
28388 This is a unique ID that can be used to reference a part from another part.
28390 .vitem &$mime_content_size$&
28391 This variable is set only after the &%decode%& modifier (see above) has been
28392 successfully run. It contains the size of the decoded part in kilobytes. The
28393 size is always rounded up to full kilobytes, so only a completely empty part
28394 has a &$mime_content_size$& of zero.
28396 .vitem &$mime_content_transfer_encoding$&
28397 This variable contains the normalized content of the
28398 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
28399 type. Typical values are &"base64"& and &"quoted-printable"&.
28401 .vitem &$mime_content_type$&
28402 If the MIME part has a &'Content-Type:'& header, this variable contains its
28403 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
28404 are some examples of popular MIME types, as they may appear in this variable:
28408 application/octet-stream
28412 If the MIME part has no &'Content-Type:'& header, this variable contains the
28415 .vitem &$mime_decoded_filename$&
28416 This variable is set only after the &%decode%& modifier (see above) has been
28417 successfully run. It contains the full path and file name of the file
28418 containing the decoded data.
28423 .vitem &$mime_filename$&
28424 This is perhaps the most important of the MIME variables. It contains a
28425 proposed filename for an attachment, if one was found in either the
28426 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
28427 RFC2047 decoded, but no additional sanity checks are done. If no filename was
28428 found, this variable contains the empty string.
28430 .vitem &$mime_is_coverletter$&
28431 This variable attempts to differentiate the &"cover letter"& of an e-mail from
28432 attached data. It can be used to clamp down on flashy or unnecessarily encoded
28433 content in the cover letter, while not restricting attachments at all.
28435 The variable contains 1 (true) for a MIME part believed to be part of the
28436 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
28440 The outermost MIME part of a message is always a cover letter.
28443 If a multipart/alternative or multipart/related MIME part is a cover letter,
28444 so are all MIME subparts within that multipart.
28447 If any other multipart is a cover letter, the first subpart is a cover letter,
28448 and the rest are attachments.
28451 All parts contained within an attachment multipart are attachments.
28454 As an example, the following will ban &"HTML mail"& (including that sent with
28455 alternative plain text), while allowing HTML files to be attached. HTML
28456 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
28458 deny message = HTML mail is not accepted here
28459 !condition = $mime_is_rfc822
28460 condition = $mime_is_coverletter
28461 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
28463 .vitem &$mime_is_multipart$&
28464 This variable has the value 1 (true) when the current part has the main type
28465 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
28466 Since multipart entities only serve as containers for other parts, you may not
28467 want to carry out specific actions on them.
28469 .vitem &$mime_is_rfc822$&
28470 This variable has the value 1 (true) if the current part is not a part of the
28471 checked message itself, but part of an attached message. Attached message
28472 decoding is fully recursive.
28474 .vitem &$mime_part_count$&
28475 This variable is a counter that is raised for each processed MIME part. It
28476 starts at zero for the very first part (which is usually a multipart). The
28477 counter is per-message, so it is reset when processing RFC822 attachments (see
28478 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
28479 complete, so you can use it in the DATA ACL to determine the number of MIME
28480 parts of a message. For non-MIME messages, this variable contains the value -1.
28485 .section "Scanning with regular expressions" "SECTscanregex"
28486 .cindex "content scanning" "with regular expressions"
28487 .cindex "regular expressions" "content scanning with"
28488 You can specify your own custom regular expression matches on the full body of
28489 the message, or on individual MIME parts.
28491 The &%regex%& condition takes one or more regular expressions as arguments and
28492 matches them against the full message (when called in the DATA ACL) or a raw
28493 MIME part (when called in the MIME ACL). The &%regex%& condition matches
28494 linewise, with a maximum line length of 32K characters. That means you cannot
28495 have multiline matches with the &%regex%& condition.
28497 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
28498 to 32K of decoded content (the whole content at once, not linewise). If the
28499 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
28500 is decoded automatically when &%mime_regex%& is executed (using default path
28501 and filename values). If the decoded data is larger than 32K, only the first
28502 32K characters are checked.
28504 The regular expressions are passed as a colon-separated list. To include a
28505 literal colon, you must double it. Since the whole right-hand side string is
28506 expanded before being used, you must also escape dollar signs and backslashes
28507 with more backslashes, or use the &`\N`& facility to disable expansion.
28508 Here is a simple example that contains two regular expressions:
28510 deny message = contains blacklisted regex ($regex_match_string)
28511 regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
28513 The conditions returns true if any one of the regular expressions matches. The
28514 &$regex_match_string$& expansion variable is then set up and contains the
28515 matching regular expression.
28517 &*Warning*&: With large messages, these conditions can be fairly
28523 .section "The demime condition" "SECTdemimecond"
28524 .cindex "content scanning" "MIME checking"
28525 .cindex "MIME content scanning"
28526 The &%demime%& ACL condition provides MIME unpacking, sanity checking and file
28527 extension blocking. It is usable only in the DATA and non-SMTP ACLs. The
28528 &%demime%& condition uses a simpler interface to MIME decoding than the MIME
28529 ACL functionality, but provides no additional facilities. Please note that this
28530 condition is deprecated and kept only for backward compatibility. You must set
28531 the WITH_OLD_DEMIME option in &_Local/Makefile_& at build time to be able to
28532 use the &%demime%& condition.
28534 The &%demime%& condition unpacks MIME containers in the message. It detects
28535 errors in MIME containers and can match file extensions found in the message
28536 against a list. Using this facility produces files containing the unpacked MIME
28537 parts of the message in the temporary scan directory. If you do antivirus
28538 scanning, it is recommended that you use the &%demime%& condition before the
28539 antivirus (&%malware%&) condition.
28541 On the right-hand side of the &%demime%& condition you can pass a
28542 colon-separated list of file extensions that it should match against. For
28545 deny message = Found blacklisted file attachment
28546 demime = vbs:com:bat:pif:prf:lnk
28548 If one of the file extensions is found, the condition is true, otherwise it is
28549 false. If there is a temporary error while demimeing (for example, &"disk
28550 full"&), the condition defers, and the message is temporarily rejected (unless
28551 the condition is on a &%warn%& verb).
28553 The right-hand side is expanded before being treated as a list, so you can have
28554 conditions and lookups there. If it expands to an empty string, &"false"&, or
28555 zero (&"0"&), no demimeing is done and the condition is false.
28557 The &%demime%& condition set the following variables:
28560 .vitem &$demime_errorlevel$&
28561 .vindex "&$demime_errorlevel$&"
28562 When an error is detected in a MIME container, this variable contains the
28563 severity of the error, as an integer number. The higher the value, the more
28564 severe the error (the current maximum value is 3). If this variable is unset or
28565 zero, no error occurred.
28567 .vitem &$demime_reason$&
28568 .vindex "&$demime_reason$&"
28569 When &$demime_errorlevel$& is greater than zero, this variable contains a
28570 human-readable text string describing the MIME error that occurred.
28574 .vitem &$found_extension$&
28575 .vindex "&$found_extension$&"
28576 When the &%demime%& condition is true, this variable contains the file
28577 extension it found.
28580 Both &$demime_errorlevel$& and &$demime_reason$& are set by the first call of
28581 the &%demime%& condition, and are not changed on subsequent calls.
28583 If you do not want to check for file extensions, but rather use the &%demime%&
28584 condition for unpacking or error checking purposes, pass &"*"& as the
28585 right-hand side value. Here is a more elaborate example of how to use this
28588 # Reject messages with serious MIME container errors
28589 deny message = Found MIME error ($demime_reason).
28591 condition = ${if >{$demime_errorlevel}{2}{1}{0}}
28593 # Reject known virus spreading file extensions.
28594 # Accepting these is pretty much braindead.
28595 deny message = contains $found_extension file (blacklisted).
28596 demime = com:vbs:bat:pif:scr
28598 # Freeze .exe and .doc files. Postmaster can
28599 # examine them and eventually thaw them.
28600 deny log_message = Another $found_extension file.
28609 . ////////////////////////////////////////////////////////////////////////////
28610 . ////////////////////////////////////////////////////////////////////////////
28612 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
28613 "Local scan function"
28614 .scindex IIDlosca "&[local_scan()]& function" "description of"
28615 .cindex "customizing" "input scan using C function"
28616 .cindex "policy control" "by local scan function"
28617 In these days of email worms, viruses, and ever-increasing spam, some sites
28618 want to apply a lot of checking to messages before accepting them.
28620 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
28621 passing messages to external virus and spam scanning software. You can also do
28622 a certain amount in Exim itself through string expansions and the &%condition%&
28623 condition in the ACL that runs after the SMTP DATA command or the ACL for
28624 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
28626 To allow for further customization to a site's own requirements, there is the
28627 possibility of linking Exim with a private message scanning function, written
28628 in C. If you want to run code that is written in something other than C, you
28629 can of course use a little C stub to call it.
28631 The local scan function is run once for every incoming message, at the point
28632 when Exim is just about to accept the message.
28633 It can therefore be used to control non-SMTP messages from local processes as
28634 well as messages arriving via SMTP.
28636 Exim applies a timeout to calls of the local scan function, and there is an
28637 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
28638 Zero means &"no timeout"&.
28639 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
28640 before calling the local scan function, so that the most common types of crash
28641 are caught. If the timeout is exceeded or one of those signals is caught, the
28642 incoming message is rejected with a temporary error if it is an SMTP message.
28643 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
28644 code. The incident is logged on the main and reject logs.
28648 .section "Building Exim to use a local scan function" "SECID207"
28649 .cindex "&[local_scan()]& function" "building Exim to use"
28650 To make use of the local scan function feature, you must tell Exim where your
28651 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
28652 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
28653 directory, so you might set
28655 LOCAL_SCAN_SOURCE=Local/local_scan.c
28657 for example. The function must be called &[local_scan()]&. It is called by
28658 Exim after it has received a message, when the success return code is about to
28659 be sent. This is after all the ACLs have been run. The return code from your
28660 function controls whether the message is actually accepted or not. There is a
28661 commented template function (that just accepts the message) in the file
28662 _src/local_scan.c_.
28664 If you want to make use of Exim's run time configuration file to set options
28665 for your &[local_scan()]& function, you must also set
28667 LOCAL_SCAN_HAS_OPTIONS=yes
28669 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
28674 .section "API for local_scan()" "SECTapiforloc"
28675 .cindex "&[local_scan()]& function" "API description"
28676 You must include this line near the start of your code:
28678 #include "local_scan.h"
28680 This header file defines a number of variables and other values, and the
28681 prototype for the function itself. Exim is coded to use unsigned char values
28682 almost exclusively, and one of the things this header defines is a shorthand
28683 for &`unsigned char`& called &`uschar`&.
28684 It also contains the following macro definitions, to simplify casting character
28685 strings and pointers to character strings:
28687 #define CS (char *)
28688 #define CCS (const char *)
28689 #define CSS (char **)
28690 #define US (unsigned char *)
28691 #define CUS (const unsigned char *)
28692 #define USS (unsigned char **)
28694 The function prototype for &[local_scan()]& is:
28696 extern int local_scan(int fd, uschar **return_text);
28698 The arguments are as follows:
28701 &%fd%& is a file descriptor for the file that contains the body of the message
28702 (the -D file). The file is open for reading and writing, but updating it is not
28703 recommended. &*Warning*&: You must &'not'& close this file descriptor.
28705 The descriptor is positioned at character 19 of the file, which is the first
28706 character of the body itself, because the first 19 characters are the message
28707 id followed by &`-D`& and a newline. If you rewind the file, you should use the
28708 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
28709 case this changes in some future version.
28711 &%return_text%& is an address which you can use to return a pointer to a text
28712 string at the end of the function. The value it points to on entry is NULL.
28715 The function must return an &%int%& value which is one of the following macros:
28718 .vitem &`LOCAL_SCAN_ACCEPT`&
28719 .vindex "&$local_scan_data$&"
28720 The message is accepted. If you pass back a string of text, it is saved with
28721 the message, and made available in the variable &$local_scan_data$&. No
28722 newlines are permitted (if there are any, they are turned into spaces) and the
28723 maximum length of text is 1000 characters.
28725 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
28726 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
28727 queued without immediate delivery, and is frozen.
28729 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
28730 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
28731 queued without immediate delivery.
28733 .vitem &`LOCAL_SCAN_REJECT`&
28734 The message is rejected; the returned text is used as an error message which is
28735 passed back to the sender and which is also logged. Newlines are permitted &--
28736 they cause a multiline response for SMTP rejections, but are converted to
28737 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
28740 .vitem &`LOCAL_SCAN_TEMPREJECT`&
28741 The message is temporarily rejected; the returned text is used as an error
28742 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
28745 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
28746 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
28747 message is not written to the reject log. It has the effect of unsetting the
28748 &%rejected_header%& log selector for just this rejection. If
28749 &%rejected_header%& is already unset (see the discussion of the
28750 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
28751 same as LOCAL_SCAN_REJECT.
28753 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
28754 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
28755 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
28758 If the message is not being received by interactive SMTP, rejections are
28759 reported by writing to &%stderr%& or by sending an email, as configured by the
28760 &%-oe%& command line options.
28764 .section "Configuration options for local_scan()" "SECTconoptloc"
28765 .cindex "&[local_scan()]& function" "configuration options"
28766 It is possible to have option settings in the main configuration file
28767 that set values in static variables in the &[local_scan()]& module. If you
28768 want to do this, you must have the line
28770 LOCAL_SCAN_HAS_OPTIONS=yes
28772 in your &_Local/Makefile_& when you build Exim. (This line is in
28773 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
28774 file, you must define static variables to hold the option values, and a table
28777 The table must be a vector called &%local_scan_options%&, of type
28778 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
28779 and a pointer to the variable that holds the value. The entries must appear in
28780 alphabetical order. Following &%local_scan_options%& you must also define a
28781 variable called &%local_scan_options_count%& that contains the number of
28782 entries in the table. Here is a short example, showing two kinds of option:
28784 static int my_integer_option = 42;
28785 static uschar *my_string_option = US"a default string";
28787 optionlist local_scan_options[] = {
28788 { "my_integer", opt_int, &my_integer_option },
28789 { "my_string", opt_stringptr, &my_string_option }
28792 int local_scan_options_count =
28793 sizeof(local_scan_options)/sizeof(optionlist);
28795 The values of the variables can now be changed from Exim's runtime
28796 configuration file by including a local scan section as in this example:
28800 my_string = some string of text...
28802 The available types of option data are as follows:
28805 .vitem &*opt_bool*&
28806 This specifies a boolean (true/false) option. The address should point to a
28807 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
28808 that are defined as &"1"& and &"0"&, respectively. If you want to detect
28809 whether such a variable has been set at all, you can initialize it to
28810 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
28813 .vitem &*opt_fixed*&
28814 This specifies a fixed point number, such as is used for load averages.
28815 The address should point to a variable of type &`int`&. The value is stored
28816 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
28819 This specifies an integer; the address should point to a variable of type
28820 &`int`&. The value may be specified in any of the integer formats accepted by
28823 .vitem &*opt_mkint*&
28824 This is the same as &%opt_int%&, except that when such a value is output in a
28825 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
28826 printed with the suffix K or M.
28828 .vitem &*opt_octint*&
28829 This also specifies an integer, but the value is always interpreted as an
28830 octal integer, whether or not it starts with the digit zero, and it is
28831 always output in octal.
28833 .vitem &*opt_stringptr*&
28834 This specifies a string value; the address must be a pointer to a
28835 variable that points to a string (for example, of type &`uschar *`&).
28837 .vitem &*opt_time*&
28838 This specifies a time interval value. The address must point to a variable of
28839 type &`int`&. The value that is placed there is a number of seconds.
28842 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
28843 out the values of all the &[local_scan()]& options.
28847 .section "Available Exim variables" "SECID208"
28848 .cindex "&[local_scan()]& function" "available Exim variables"
28849 The header &_local_scan.h_& gives you access to a number of C variables. These
28850 are the only ones that are guaranteed to be maintained from release to release.
28851 Note, however, that you can obtain the value of any Exim expansion variable,
28852 including &$recipients$&, by calling &'expand_string()'&. The exported
28853 C variables are as follows:
28856 .vitem &*int&~body_linecount*&
28857 This variable contains the number of lines in the message's body.
28859 .vitem &*int&~body_zerocount*&
28860 This variable contains the number of binary zero bytes in the message's body.
28862 .vitem &*unsigned&~int&~debug_selector*&
28863 This variable is set to zero when no debugging is taking place. Otherwise, it
28864 is a bitmap of debugging selectors. Two bits are identified for use in
28865 &[local_scan()]&; they are defined as macros:
28868 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
28869 testing option that is not privileged &-- any caller may set it. All the
28870 other selector bits can be set only by admin users.
28873 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
28874 by the &`+local_scan`& debug selector. It is not included in the default set
28878 Thus, to write to the debugging output only when &`+local_scan`& has been
28879 selected, you should use code like this:
28881 if ((debug_selector & D_local_scan) != 0)
28882 debug_printf("xxx", ...);
28884 .vitem &*uschar&~*expand_string_message*&
28885 After a failing call to &'expand_string()'& (returned value NULL), the
28886 variable &%expand_string_message%& contains the error message, zero-terminated.
28888 .vitem &*header_line&~*header_list*&
28889 A pointer to a chain of header lines. The &%header_line%& structure is
28892 .vitem &*header_line&~*header_last*&
28893 A pointer to the last of the header lines.
28895 .vitem &*uschar&~*headers_charset*&
28896 The value of the &%headers_charset%& configuration option.
28898 .vitem &*BOOL&~host_checking*&
28899 This variable is TRUE during a host checking session that is initiated by the
28900 &%-bh%& command line option.
28902 .vitem &*uschar&~*interface_address*&
28903 The IP address of the interface that received the message, as a string. This
28904 is NULL for locally submitted messages.
28906 .vitem &*int&~interface_port*&
28907 The port on which this message was received. When testing with the &%-bh%&
28908 command line option, the value of this variable is -1 unless a port has been
28909 specified via the &%-oMi%& option.
28911 .vitem &*uschar&~*message_id*&
28912 This variable contains Exim's message id for the incoming message (the value of
28913 &$message_exim_id$&) as a zero-terminated string.
28915 .vitem &*uschar&~*received_protocol*&
28916 The name of the protocol by which the message was received.
28918 .vitem &*int&~recipients_count*&
28919 The number of accepted recipients.
28921 .vitem &*recipient_item&~*recipients_list*&
28922 .cindex "recipient" "adding in local scan"
28923 .cindex "recipient" "removing in local scan"
28924 The list of accepted recipients, held in a vector of length
28925 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
28926 can add additional recipients by calling &'receive_add_recipient()'& (see
28927 below). You can delete recipients by removing them from the vector and
28928 adjusting the value in &%recipients_count%&. In particular, by setting
28929 &%recipients_count%& to zero you remove all recipients. If you then return the
28930 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
28931 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
28932 and then call &'receive_add_recipient()'& as often as needed.
28934 .vitem &*uschar&~*sender_address*&
28935 The envelope sender address. For bounce messages this is the empty string.
28937 .vitem &*uschar&~*sender_host_address*&
28938 The IP address of the sending host, as a string. This is NULL for
28939 locally-submitted messages.
28941 .vitem &*uschar&~*sender_host_authenticated*&
28942 The name of the authentication mechanism that was used, or NULL if the message
28943 was not received over an authenticated SMTP connection.
28945 .vitem &*uschar&~*sender_host_name*&
28946 The name of the sending host, if known.
28948 .vitem &*int&~sender_host_port*&
28949 The port on the sending host.
28951 .vitem &*BOOL&~smtp_input*&
28952 This variable is TRUE for all SMTP input, including BSMTP.
28954 .vitem &*BOOL&~smtp_batched_input*&
28955 This variable is TRUE for BSMTP input.
28957 .vitem &*int&~store_pool*&
28958 The contents of this variable control which pool of memory is used for new
28959 requests. See section &<<SECTmemhanloc>>& for details.
28963 .section "Structure of header lines" "SECID209"
28964 The &%header_line%& structure contains the members listed below.
28965 You can add additional header lines by calling the &'header_add()'& function
28966 (see below). You can cause header lines to be ignored (deleted) by setting
28971 .vitem &*struct&~header_line&~*next*&
28972 A pointer to the next header line, or NULL for the last line.
28974 .vitem &*int&~type*&
28975 A code identifying certain headers that Exim recognizes. The codes are printing
28976 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
28977 Notice in particular that any header line whose type is * is not transmitted
28978 with the message. This flagging is used for header lines that have been
28979 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
28980 lines.) Effectively, * means &"deleted"&.
28982 .vitem &*int&~slen*&
28983 The number of characters in the header line, including the terminating and any
28986 .vitem &*uschar&~*text*&
28987 A pointer to the text of the header. It always ends with a newline, followed by
28988 a zero byte. Internal newlines are preserved.
28993 .section "Structure of recipient items" "SECID210"
28994 The &%recipient_item%& structure contains these members:
28997 .vitem &*uschar&~*address*&
28998 This is a pointer to the recipient address as it was received.
29000 .vitem &*int&~pno*&
29001 This is used in later Exim processing when top level addresses are created by
29002 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
29003 and must always contain -1 at this stage.
29005 .vitem &*uschar&~*errors_to*&
29006 If this value is not NULL, bounce messages caused by failing to deliver to the
29007 recipient are sent to the address it contains. In other words, it overrides the
29008 envelope sender for this one recipient. (Compare the &%errors_to%& generic
29009 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
29010 an unqualified address, Exim qualifies it using the domain from
29011 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
29012 is NULL for all recipients.
29017 .section "Available Exim functions" "SECID211"
29018 .cindex "&[local_scan()]& function" "available Exim functions"
29019 The header &_local_scan.h_& gives you access to a number of Exim functions.
29020 These are the only ones that are guaranteed to be maintained from release to
29024 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
29025 &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
29027 This function creates a child process that runs the command specified by
29028 &%argv%&. The environment for the process is specified by &%envp%&, which can
29029 be NULL if no environment variables are to be passed. A new umask is supplied
29030 for the process in &%newumask%&.
29032 Pipes to the standard input and output of the new process are set up
29033 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
29034 standard error is cloned to the standard output. If there are any file
29035 descriptors &"in the way"& in the new process, they are closed. If the final
29036 argument is TRUE, the new process is made into a process group leader.
29038 The function returns the pid of the new process, or -1 if things go wrong.
29040 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
29041 This function waits for a child process to terminate, or for a timeout (in
29042 seconds) to expire. A timeout value of zero means wait as long as it takes. The
29043 return value is as follows:
29048 The process terminated by a normal exit and the value is the process
29054 The process was terminated by a signal and the value is the negation of the
29060 The process timed out.
29064 The was some other error in wait(); &%errno%& is still set.
29067 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
29068 This function provide you with a means of submitting a new message to
29069 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
29070 want, but this packages it all up for you.) The function creates a pipe,
29071 forks a subprocess that is running
29073 exim -t -oem -oi -f <>
29075 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
29076 that is connected to the standard input. The yield of the function is the PID
29077 of the subprocess. You can then write a message to the file descriptor, with
29078 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
29080 When you have finished, call &'child_close()'& to wait for the process to
29081 finish and to collect its ending status. A timeout value of zero is usually
29082 fine in this circumstance. Unless you have made a mistake with the recipient
29083 addresses, you should get a return code of zero.
29086 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
29087 *sender_authentication)*&
29088 This function is a more sophisticated version of &'child_open()'&. The command
29091 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
29093 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
29096 .vitem &*void&~debug_printf(char&~*,&~...)*&
29097 This is Exim's debugging function, with arguments as for &'(printf()'&. The
29098 output is written to the standard error stream. If no debugging is selected,
29099 calls to &'debug_printf()'& have no effect. Normally, you should make calls
29100 conditional on the &`local_scan`& debug selector by coding like this:
29102 if ((debug_selector & D_local_scan) != 0)
29103 debug_printf("xxx", ...);
29106 .vitem &*uschar&~*expand_string(uschar&~*string)*&
29107 This is an interface to Exim's string expansion code. The return value is the
29108 expanded string, or NULL if there was an expansion failure.
29109 The C variable &%expand_string_message%& contains an error message after an
29110 expansion failure. If expansion does not change the string, the return value is
29111 the pointer to the input string. Otherwise, the return value points to a new
29112 block of memory that was obtained by a call to &'store_get()'&. See section
29113 &<<SECTmemhanloc>>& below for a discussion of memory handling.
29115 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
29116 This function allows you to an add additional header line at the end of the
29117 existing ones. The first argument is the type, and should normally be a space
29118 character. The second argument is a format string and any number of
29119 substitution arguments as for &[sprintf()]&. You may include internal newlines
29120 if you want, and you must ensure that the string ends with a newline.
29122 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
29123 BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
29124 This function adds a new header line at a specified point in the header
29125 chain. The header itself is specified as for &'header_add()'&.
29127 If &%name%& is NULL, the new header is added at the end of the chain if
29128 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
29129 NULL, the header lines are searched for the first non-deleted header that
29130 matches the name. If one is found, the new header is added before it if
29131 &%after%& is false. If &%after%& is true, the new header is added after the
29132 found header and any adjacent subsequent ones with the same name (even if
29133 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
29134 option controls where the header is added. If it is true, addition is at the
29135 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
29136 headers, or at the top if there are no &'Received:'& headers, you could use
29138 header_add_at_position(TRUE, US"Received", TRUE,
29139 ' ', "X-xxx: ...");
29141 Normally, there is always at least one non-deleted &'Received:'& header, but
29142 there may not be if &%received_header_text%& expands to an empty string.
29145 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
29146 This function removes header lines. If &%occurrence%& is zero or negative, all
29147 occurrences of the header are removed. If occurrence is greater than zero, that
29148 particular instance of the header is removed. If no header(s) can be found that
29149 match the specification, the function does nothing.
29152 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
29153 int&~length,&~BOOL&~notdel)*&"
29154 This function tests whether the given header has the given name. It is not just
29155 a string comparison, because white space is permitted between the name and the
29156 colon. If the &%notdel%& argument is true, a false return is forced for all
29157 &"deleted"& headers; otherwise they are not treated specially. For example:
29159 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
29161 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
29162 .cindex "base64 encoding" "functions for &[local_scan()]& use"
29163 This function base64-encodes a string, which is passed by address and length.
29164 The text may contain bytes of any value, including zero. The result is passed
29165 back in dynamic memory that is obtained by calling &'store_get()'&. It is
29168 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
29169 This function decodes a base64-encoded string. Its arguments are a
29170 zero-terminated base64-encoded string and the address of a variable that is set
29171 to point to the result, which is in dynamic memory. The length of the decoded
29172 string is the yield of the function. If the input is invalid base64 data, the
29173 yield is -1. A zero byte is added to the end of the output string to make it
29174 easy to interpret as a C string (assuming it contains no zeros of its own). The
29175 added zero byte is not included in the returned count.
29177 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
29178 This function checks for a match in a domain list. Domains are always
29179 matched caselessly. The return value is one of the following:
29181 &`OK `& match succeeded
29182 &`FAIL `& match failed
29183 &`DEFER `& match deferred
29185 DEFER is usually caused by some kind of lookup defer, such as the
29186 inability to contact a database.
29188 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
29190 This function checks for a match in a local part list. The third argument
29191 controls case-sensitivity. The return values are as for
29192 &'lss_match_domain()'&.
29194 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
29196 This function checks for a match in an address list. The third argument
29197 controls the case-sensitivity of the local part match. The domain is always
29198 matched caselessly. The return values are as for &'lss_match_domain()'&.
29200 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
29202 This function checks for a match in a host list. The most common usage is
29205 lss_match_host(sender_host_name, sender_host_address, ...)
29207 .vindex "&$sender_host_address$&"
29208 An empty address field matches an empty item in the host list. If the host name
29209 is NULL, the name corresponding to &$sender_host_address$& is automatically
29210 looked up if a host name is required to match an item in the list. The return
29211 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
29212 returns ERROR in the case when it had to look up a host name, but the lookup
29215 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
29217 This function writes to Exim's log files. The first argument should be zero (it
29218 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
29219 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
29220 them. It specifies to which log or logs the message is written. The remaining
29221 arguments are a format and relevant insertion arguments. The string should not
29222 contain any newlines, not even at the end.
29225 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
29226 This function adds an additional recipient to the message. The first argument
29227 is the recipient address. If it is unqualified (has no domain), it is qualified
29228 with the &%qualify_recipient%& domain. The second argument must always be -1.
29230 This function does not allow you to specify a private &%errors_to%& address (as
29231 described with the structure of &%recipient_item%& above), because it pre-dates
29232 the addition of that field to the structure. However, it is easy to add such a
29233 value afterwards. For example:
29235 receive_add_recipient(US"monitor@mydom.example", -1);
29236 recipients_list[recipients_count-1].errors_to =
29237 US"postmaster@mydom.example";
29240 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
29241 This is a convenience function to remove a named recipient from the list of
29242 recipients. It returns true if a recipient was removed, and false if no
29243 matching recipient could be found. The argument must be a complete email
29250 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
29251 &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
29252 This function decodes strings that are encoded according to RFC 2047. Typically
29253 these are the contents of header lines. First, each &"encoded word"& is decoded
29254 from the Q or B encoding into a byte-string. Then, if provided with the name of
29255 a charset encoding, and if the &[iconv()]& function is available, an attempt is
29256 made to translate the result to the named character set. If this fails, the
29257 binary string is returned with an error message.
29259 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
29260 maximum MIME word length is enforced. The third argument is the target
29261 encoding, or NULL if no translation is wanted.
29263 .cindex "binary zero" "in RFC 2047 decoding"
29264 .cindex "RFC 2047" "binary zero in"
29265 If a binary zero is encountered in the decoded string, it is replaced by the
29266 contents of the &%zeroval%& argument. For use with Exim headers, the value must
29267 not be 0 because header lines are handled as zero-terminated strings.
29269 The function returns the result of processing the string, zero-terminated; if
29270 &%lenptr%& is not NULL, the length of the result is set in the variable to
29271 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
29273 If an error is encountered, the function returns NULL and uses the &%error%&
29274 argument to return an error message. The variable pointed to by &%error%& is
29275 set to NULL if there is no error; it may be set non-NULL even when the function
29276 returns a non-NULL value if decoding was successful, but there was a problem
29280 .vitem &*int&~smtp_fflush(void)*&
29281 This function is used in conjunction with &'smtp_printf()'&, as described
29284 .vitem &*void&~smtp_printf(char&~*,&~...)*&
29285 The arguments of this function are like &[printf()]&; it writes to the SMTP
29286 output stream. You should use this function only when there is an SMTP output
29287 stream, that is, when the incoming message is being received via interactive
29288 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
29289 is FALSE. If you want to test for an incoming message from another host (as
29290 opposed to a local process that used the &%-bs%& command line option), you can
29291 test the value of &%sender_host_address%&, which is non-NULL when a remote host
29294 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
29295 output function, so it can be used for all forms of SMTP connection.
29297 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
29298 must start with an appropriate response code: 550 if you are going to return
29299 LOCAL_SCAN_REJECT, 451 if you are going to return
29300 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
29301 initial lines of a multi-line response, the code must be followed by a hyphen
29302 to indicate that the line is not the final response line. You must also ensure
29303 that the lines you write terminate with CRLF. For example:
29305 smtp_printf("550-this is some extra info\r\n");
29306 return LOCAL_SCAN_REJECT;
29308 Note that you can also create multi-line responses by including newlines in
29309 the data returned via the &%return_text%& argument. The added value of using
29310 &'smtp_printf()'& is that, for instance, you could introduce delays between
29311 multiple output lines.
29313 The &'smtp_printf()'& function does not return any error indication, because it
29314 does not automatically flush pending output, and therefore does not test
29315 the state of the stream. (In the main code of Exim, flushing and error
29316 detection is done when Exim is ready for the next SMTP input command.) If
29317 you want to flush the output and check for an error (for example, the
29318 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
29319 arguments. It flushes the output stream, and returns a non-zero value if there
29322 .vitem &*void&~*store_get(int)*&
29323 This function accesses Exim's internal store (memory) manager. It gets a new
29324 chunk of memory whose size is given by the argument. Exim bombs out if it ever
29325 runs out of memory. See the next section for a discussion of memory handling.
29327 .vitem &*void&~*store_get_perm(int)*&
29328 This function is like &'store_get()'&, but it always gets memory from the
29329 permanent pool. See the next section for a discussion of memory handling.
29331 .vitem &*uschar&~*string_copy(uschar&~*string)*&
29334 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
29337 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
29338 These three functions create strings using Exim's dynamic memory facilities.
29339 The first makes a copy of an entire string. The second copies up to a maximum
29340 number of characters, indicated by the second argument. The third uses a format
29341 and insertion arguments to create a new string. In each case, the result is a
29342 pointer to a new string in the current memory pool. See the next section for
29348 .section "More about Exim's memory handling" "SECTmemhanloc"
29349 .cindex "&[local_scan()]& function" "memory handling"
29350 No function is provided for freeing memory, because that is never needed.
29351 The dynamic memory that Exim uses when receiving a message is automatically
29352 recycled if another message is received by the same process (this applies only
29353 to incoming SMTP connections &-- other input methods can supply only one
29354 message at a time). After receiving the last message, a reception process
29357 Because it is recycled, the normal dynamic memory cannot be used for holding
29358 data that must be preserved over a number of incoming messages on the same SMTP
29359 connection. However, Exim in fact uses two pools of dynamic memory; the second
29360 one is not recycled, and can be used for this purpose.
29362 If you want to allocate memory that remains available for subsequent messages
29363 in the same SMTP connection, you should set
29365 store_pool = POOL_PERM
29367 before calling the function that does the allocation. There is no need to
29368 restore the value if you do not need to; however, if you do want to revert to
29369 the normal pool, you can either restore the previous value of &%store_pool%& or
29370 set it explicitly to POOL_MAIN.
29372 The pool setting applies to all functions that get dynamic memory, including
29373 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
29374 There is also a convenience function called &'store_get_perm()'& that gets a
29375 block of memory from the permanent pool while preserving the value of
29382 . ////////////////////////////////////////////////////////////////////////////
29383 . ////////////////////////////////////////////////////////////////////////////
29385 .chapter "System-wide message filtering" "CHAPsystemfilter"
29386 .scindex IIDsysfil1 "filter" "system filter"
29387 .scindex IIDsysfil2 "filtering all mail"
29388 .scindex IIDsysfil3 "system filter"
29389 The previous chapters (on ACLs and the local scan function) describe checks
29390 that can be applied to messages before they are accepted by a host. There is
29391 also a mechanism for checking messages once they have been received, but before
29392 they are delivered. This is called the &'system filter'&.
29394 The system filter operates in a similar manner to users' filter files, but it
29395 is run just once per message (however many recipients the message has).
29396 It should not normally be used as a substitute for routing, because &%deliver%&
29397 commands in a system router provide new envelope recipient addresses.
29398 The system filter must be an Exim filter. It cannot be a Sieve filter.
29400 The system filter is run at the start of a delivery attempt, before any routing
29401 is done. If a message fails to be completely delivered at the first attempt,
29402 the system filter is run again at the start of every retry.
29403 If you want your filter to do something only once per message, you can make use
29404 of the &%first_delivery%& condition in an &%if%& command in the filter to
29405 prevent it happening on retries.
29407 .vindex "&$domain$&"
29408 .vindex "&$local_part$&"
29409 &*Warning*&: Because the system filter runs just once, variables that are
29410 specific to individual recipient addresses, such as &$local_part$& and
29411 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
29412 you want to run a centrally-specified filter for each recipient address
29413 independently, you can do so by setting up a suitable &(redirect)& router, as
29414 described in section &<<SECTperaddfil>>& below.
29417 .section "Specifying a system filter" "SECID212"
29418 .cindex "uid (user id)" "system filter"
29419 .cindex "gid (group id)" "system filter"
29420 The name of the file that contains the system filter must be specified by
29421 setting &%system_filter%&. If you want the filter to run under a uid and gid
29422 other than root, you must also set &%system_filter_user%& and
29423 &%system_filter_group%& as appropriate. For example:
29425 system_filter = /etc/mail/exim.filter
29426 system_filter_user = exim
29428 If a system filter generates any deliveries directly to files or pipes (via the
29429 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
29430 specified by setting &%system_filter_file_transport%& and
29431 &%system_filter_pipe_transport%&, respectively. Similarly,
29432 &%system_filter_reply_transport%& must be set to handle any messages generated
29433 by the &%reply%& command.
29436 .section "Testing a system filter" "SECID213"
29437 You can run simple tests of a system filter in the same way as for a user
29438 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
29439 are permitted only in system filters are recognized.
29441 If you want to test the combined effect of a system filter and a user filter,
29442 you can use both &%-bF%& and &%-bf%& on the same command line.
29446 .section "Contents of a system filter" "SECID214"
29447 The language used to specify system filters is the same as for users' filter
29448 files. It is described in the separate end-user document &'Exim's interface to
29449 mail filtering'&. However, there are some additional features that are
29450 available only in system filters; these are described in subsequent sections.
29451 If they are encountered in a user's filter file or when testing with &%-bf%&,
29454 .cindex "frozen messages" "manual thaw; testing in filter"
29455 There are two special conditions which, though available in users' filter
29456 files, are designed for use in system filters. The condition &%first_delivery%&
29457 is true only for the first attempt at delivering a message, and
29458 &%manually_thawed%& is true only if the message has been frozen, and
29459 subsequently thawed by an admin user. An explicit forced delivery counts as a
29460 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
29462 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
29463 specify an &"unseen"& (non-significant) delivery, and that delivery does not
29464 succeed, it will not be tried again.
29465 If you want Exim to retry an unseen delivery until it succeeds, you should
29466 arrange to set it up every time the filter runs.
29468 When a system filter finishes running, the values of the variables &$n0$& &--
29469 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
29470 users' filter files. Thus a system filter can, for example, set up &"scores"&
29471 to which users' filter files can refer.
29475 .section "Additional variable for system filters" "SECID215"
29476 .vindex "&$recipients$&"
29477 The expansion variable &$recipients$&, containing a list of all the recipients
29478 of the message (separated by commas and white space), is available in system
29479 filters. It is not available in users' filters for privacy reasons.
29483 .section "Defer, freeze, and fail commands for system filters" "SECID216"
29484 .cindex "freezing messages"
29485 .cindex "message" "freezing"
29486 .cindex "message" "forced failure"
29487 .cindex "&%fail%&" "in system filter"
29488 .cindex "&%freeze%& in system filter"
29489 .cindex "&%defer%& in system filter"
29490 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
29491 always available in system filters, but are not normally enabled in users'
29492 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
29493 for the &(redirect)& router.) These commands can optionally be followed by the
29494 word &%text%& and a string containing an error message, for example:
29496 fail text "this message looks like spam to me"
29498 The keyword &%text%& is optional if the next character is a double quote.
29500 The &%defer%& command defers delivery of the original recipients of the
29501 message. The &%fail%& command causes all the original recipients to be failed,
29502 and a bounce message to be created. The &%freeze%& command suspends all
29503 delivery attempts for the original recipients. In all cases, any new deliveries
29504 that are specified by the filter are attempted as normal after the filter has
29507 The &%freeze%& command is ignored if the message has been manually unfrozen and
29508 not manually frozen since. This means that automatic freezing by a system
29509 filter can be used as a way of checking out suspicious messages. If a message
29510 is found to be all right, manually unfreezing it allows it to be delivered.
29512 .cindex "log" "&%fail%& command log line"
29513 .cindex "&%fail%&" "log line; reducing"
29514 The text given with a fail command is used as part of the bounce message as
29515 well as being written to the log. If the message is quite long, this can fill
29516 up a lot of log space when such failures are common. To reduce the size of the
29517 log message, Exim interprets the text in a special way if it starts with the
29518 two characters &`<<`& and contains &`>>`& later. The text between these two
29519 strings is written to the log, and the rest of the text is used in the bounce
29520 message. For example:
29522 fail "<<filter test 1>>Your message is rejected \
29523 because it contains attachments that we are \
29524 not prepared to receive."
29527 .cindex "loop" "caused by &%fail%&"
29528 Take great care with the &%fail%& command when basing the decision to fail on
29529 the contents of the message, because the bounce message will of course include
29530 the contents of the original message and will therefore trigger the &%fail%&
29531 command again (causing a mail loop) unless steps are taken to prevent this.
29532 Testing the &%error_message%& condition is one way to prevent this. You could
29535 if $message_body contains "this is spam" and not error_message
29536 then fail text "spam is not wanted here" endif
29538 though of course that might let through unwanted bounce messages. The
29539 alternative is clever checking of the body and/or headers to detect bounces
29540 generated by the filter.
29542 The interpretation of a system filter file ceases after a
29544 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
29545 set up earlier in the filter file are honoured, so you can use a sequence such
29551 to send a specified message when the system filter is freezing (or deferring or
29552 failing) a message. The normal deliveries for the message do not, of course,
29557 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
29558 .cindex "header lines" "adding; in system filter"
29559 .cindex "header lines" "removing; in system filter"
29560 .cindex "filter" "header lines; adding/removing"
29561 Two filter commands that are available only in system filters are:
29563 headers add <string>
29564 headers remove <string>
29566 The argument for the &%headers add%& is a string that is expanded and then
29567 added to the end of the message's headers. It is the responsibility of the
29568 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
29569 space is ignored, and if the string is otherwise empty, or if the expansion is
29570 forced to fail, the command has no effect.
29572 You can use &"\n"& within the string, followed by white space, to specify
29573 continued header lines. More than one header may be added in one command by
29574 including &"\n"& within the string without any following white space. For
29577 headers add "X-header-1: ....\n \
29578 continuation of X-header-1 ...\n\
29581 Note that the header line continuation white space after the first newline must
29582 be placed before the backslash that continues the input string, because white
29583 space after input continuations is ignored.
29585 The argument for &%headers remove%& is a colon-separated list of header names.
29586 This command applies only to those headers that are stored with the message;
29587 those that are added at delivery time (such as &'Envelope-To:'& and
29588 &'Return-Path:'&) cannot be removed by this means. If there is more than one
29589 header with the same name, they are all removed.
29591 The &%headers%& command in a system filter makes an immediate change to the set
29592 of header lines that was received with the message (with possible additions
29593 from ACL processing). Subsequent commands in the system filter operate on the
29594 modified set, which also forms the basis for subsequent message delivery.
29595 Unless further modified during routing or transporting, this set of headers is
29596 used for all recipients of the message.
29598 During routing and transporting, the variables that refer to the contents of
29599 header lines refer only to those lines that are in this set. Thus, header lines
29600 that are added by a system filter are visible to users' filter files and to all
29601 routers and transports. This contrasts with the manipulation of header lines by
29602 routers and transports, which is not immediate, but which instead is saved up
29603 until the message is actually being written (see section
29604 &<<SECTheadersaddrem>>&).
29606 If the message is not delivered at the first attempt, header lines that were
29607 added by the system filter are stored with the message, and so are still
29608 present at the next delivery attempt. Header lines that were removed are still
29609 present, but marked &"deleted"& so that they are not transported with the
29610 message. For this reason, it is usual to make the &%headers%& command
29611 conditional on &%first_delivery%& so that the set of header lines is not
29612 modified more than once.
29614 Because header modification in a system filter acts immediately, you have to
29615 use an indirect approach if you want to modify the contents of a header line.
29618 headers add "Old-Subject: $h_subject:"
29619 headers remove "Subject"
29620 headers add "Subject: new subject (was: $h_old-subject:)"
29621 headers remove "Old-Subject"
29626 .section "Setting an errors address in a system filter" "SECID217"
29627 .cindex "envelope sender"
29628 In a system filter, if a &%deliver%& command is followed by
29630 errors_to <some address>
29632 in order to change the envelope sender (and hence the error reporting) for that
29633 delivery, any address may be specified. (In a user filter, only the current
29634 user's address can be set.) For example, if some mail is being monitored, you
29637 unseen deliver monitor@spying.example errors_to root@local.example
29639 to take a copy which would not be sent back to the normal error reporting
29640 address if its delivery failed.
29644 .section "Per-address filtering" "SECTperaddfil"
29645 .vindex "&$domain$&"
29646 .vindex "&$local_part$&"
29647 In contrast to the system filter, which is run just once per message for each
29648 delivery attempt, it is also possible to set up a system-wide filtering
29649 operation that runs once for each recipient address. In this case, variables
29650 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
29651 filter file could be made dependent on them. This is an example of a router
29652 which implements such a filter:
29657 domains = +local_domains
29658 file = /central/filters/$local_part
29663 The filter is run in a separate process under its own uid. Therefore, either
29664 &%check_local_user%& must be set (as above), in which case the filter is run as
29665 the local user, or the &%user%& option must be used to specify which user to
29666 use. If both are set, &%user%& overrides.
29668 Care should be taken to ensure that none of the commands in the filter file
29669 specify a significant delivery if the message is to go on to be delivered to
29670 its intended recipient. The router will not then claim to have dealt with the
29671 address, so it will be passed on to subsequent routers to be delivered in the
29673 .ecindex IIDsysfil1
29674 .ecindex IIDsysfil2
29675 .ecindex IIDsysfil3
29682 . ////////////////////////////////////////////////////////////////////////////
29683 . ////////////////////////////////////////////////////////////////////////////
29685 .chapter "Message processing" "CHAPmsgproc"
29686 .scindex IIDmesproc "message" "general processing"
29687 Exim performs various transformations on the sender and recipient addresses of
29688 all messages that it handles, and also on the messages' header lines. Some of
29689 these are optional and configurable, while others always take place. All of
29690 this processing, except rewriting as a result of routing, and the addition or
29691 removal of header lines while delivering, happens when a message is received,
29692 before it is placed on Exim's queue.
29694 Some of the automatic processing takes place by default only for
29695 &"locally-originated"& messages. This adjective is used to describe messages
29696 that are not received over TCP/IP, but instead are passed to an Exim process on
29697 its standard input. This includes the interactive &"local SMTP"& case that is
29698 set up by the &%-bs%& command line option.
29700 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
29701 or ::1) are not considered to be locally-originated. Exim does not treat the
29702 loopback interface specially in any way.
29704 If you want the loopback interface to be treated specially, you must ensure
29705 that there are appropriate entries in your ACLs.
29710 .section "Submission mode for non-local messages" "SECTsubmodnon"
29711 .cindex "message" "submission"
29712 .cindex "submission mode"
29713 Processing that happens automatically for locally-originated messages (unless
29714 &%suppress_local_fixups%& is set) can also be requested for messages that are
29715 received over TCP/IP. The term &"submission mode"& is used to describe this
29716 state. Submission mode is set by the modifier
29718 control = submission
29720 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
29721 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
29722 a local submission, and is normally used when the source of the message is
29723 known to be an MUA running on a client host (as opposed to an MTA). For
29724 example, to set submission mode for messages originating on the IPv4 loopback
29725 interface, you could include the following in the MAIL ACL:
29727 warn hosts = 127.0.0.1
29728 control = submission
29730 .cindex "&%sender_retain%& submission option"
29731 There are some options that can be used when setting submission mode. A slash
29732 is used to separate options. For example:
29734 control = submission/sender_retain
29736 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
29737 true and &%local_from_check%& false for the current incoming message. The first
29738 of these allows an existing &'Sender:'& header in the message to remain, and
29739 the second suppresses the check to ensure that &'From:'& matches the
29740 authenticated sender. With this setting, Exim still fixes up messages by adding
29741 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
29742 attempt to check sender authenticity in header lines.
29744 When &%sender_retain%& is not set, a submission mode setting may specify a
29745 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
29748 control = submission/domain=some.domain
29750 The domain may be empty. How this value is used is described in sections
29751 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
29752 that allows you to specify the user's full name for inclusion in a created
29753 &'Sender:'& or &'From:'& header line. For example:
29755 accept authenticated = *
29756 control = submission/domain=wonderland.example/\
29757 name=${lookup {$authenticated_id} \
29758 lsearch {/etc/exim/namelist}}
29760 Because the name may contain any characters, including slashes, the &%name%&
29761 option must be given last. The remainder of the string is used as the name. For
29762 the example above, if &_/etc/exim/namelist_& contains:
29764 bigegg: Humpty Dumpty
29766 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
29769 Sender: Humpty Dumpty <bigegg@wonderland.example>
29771 .cindex "return path" "in submission mode"
29772 By default, submission mode forces the return path to the same address as is
29773 used to create the &'Sender:'& header. However, if &%sender_retain%& is
29774 specified, the return path is also left unchanged.
29776 &*Note*&: The changes caused by submission mode take effect after the predata
29777 ACL. This means that any sender checks performed before the fix-ups use the
29778 untrusted sender address specified by the user, not the trusted sender address
29779 specified by submission mode. Although this might be slightly unexpected, it
29780 does mean that you can configure ACL checks to spot that a user is trying to
29781 spoof another's address.
29783 .section "Line endings" "SECTlineendings"
29784 .cindex "line endings"
29785 .cindex "carriage return"
29787 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
29788 linefeed) is the line ending for messages transmitted over the Internet using
29789 SMTP over TCP/IP. However, within individual operating systems, different
29790 conventions are used. For example, Unix-like systems use just LF, but others
29791 use CRLF or just CR.
29793 Exim was designed for Unix-like systems, and internally, it stores messages
29794 using the system's convention of a single LF as a line terminator. When
29795 receiving a message, all line endings are translated to this standard format.
29796 Originally, it was thought that programs that passed messages directly to an
29797 MTA within an operating system would use that system's convention. Experience
29798 has shown that this is not the case; for example, there are Unix applications
29799 that use CRLF in this circumstance. For this reason, and for compatibility with
29800 other MTAs, the way Exim handles line endings for all messages is now as
29804 LF not preceded by CR is treated as a line ending.
29806 CR is treated as a line ending; if it is immediately followed by LF, the LF
29809 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
29810 nor a local message in the state where a line containing only a dot is a
29813 If a bare CR is encountered within a header line, an extra space is added after
29814 the line terminator so as not to end the header line. The reasoning behind this
29815 is that bare CRs in header lines are most likely either to be mistakes, or
29816 people trying to play silly games.
29818 If the first header line received in a message ends with CRLF, a subsequent
29819 bare LF in a header line is treated in the same way as a bare CR in a header
29827 .section "Unqualified addresses" "SECID218"
29828 .cindex "unqualified addresses"
29829 .cindex "address" "qualification"
29830 By default, Exim expects every envelope address it receives from an external
29831 host to be fully qualified. Unqualified addresses cause negative responses to
29832 SMTP commands. However, because SMTP is used as a means of transporting
29833 messages from MUAs running on personal workstations, there is sometimes a
29834 requirement to accept unqualified addresses from specific hosts or IP networks.
29836 Exim has two options that separately control which hosts may send unqualified
29837 sender or recipient addresses in SMTP commands, namely
29838 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
29839 cases, if an unqualified address is accepted, it is qualified by adding the
29840 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
29842 .oindex "&%qualify_domain%&"
29843 .oindex "&%qualify_recipient%&"
29844 Unqualified addresses in header lines are automatically qualified for messages
29845 that are locally originated, unless the &%-bnq%& option is given on the command
29846 line. For messages received over SMTP, unqualified addresses in header lines
29847 are qualified only if unqualified addresses are permitted in SMTP commands. In
29848 other words, such qualification is also controlled by
29849 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
29854 .section "The UUCP From line" "SECID219"
29855 .cindex "&""From""& line"
29856 .cindex "UUCP" "&""From""& line"
29857 .cindex "sender" "address"
29858 .oindex "&%uucp_from_pattern%&"
29859 .oindex "&%uucp_from_sender%&"
29860 .cindex "envelope sender"
29861 .cindex "Sendmail compatibility" "&""From""& line"
29862 Messages that have come from UUCP (and some other applications) often begin
29863 with a line containing the envelope sender and a timestamp, following the word
29864 &"From"&. Examples of two common formats are:
29866 From a.oakley@berlin.mus Fri Jan 5 12:35 GMT 1996
29867 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
29869 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
29870 Exim recognizes such lines at the start of messages that are submitted to it
29871 via the command line (that is, on the standard input). It does not recognize
29872 such lines in incoming SMTP messages, unless the sending host matches
29873 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
29874 and &%ignore_fromline_local%& is set. The recognition is controlled by a
29875 regular expression that is defined by the &%uucp_from_pattern%& option, whose
29876 default value matches the two common cases shown above and puts the address
29877 that follows &"From"& into &$1$&.
29879 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
29880 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
29881 a trusted user, the message's sender address is constructed by expanding the
29882 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
29883 then parsed as an RFC 2822 address. If there is no domain, the local part is
29884 qualified with &%qualify_domain%& unless it is the empty string. However, if
29885 the command line &%-f%& option is used, it overrides the &"From"& line.
29887 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
29888 sender address is not changed. This is also the case for incoming SMTP messages
29889 that are permitted to contain &"From"& lines.
29891 Only one &"From"& line is recognized. If there is more than one, the second is
29892 treated as a data line that starts the body of the message, as it is not valid
29893 as a header line. This also happens if a &"From"& line is present in an
29894 incoming SMTP message from a source that is not permitted to send them.
29898 .section "Resent- header lines" "SECID220"
29899 .cindex "&%Resent-%& header lines"
29900 RFC 2822 makes provision for sets of header lines starting with the string
29901 &`Resent-`& to be added to a message when it is resent by the original
29902 recipient to somebody else. These headers are &'Resent-Date:'&,
29903 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
29904 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
29907 &'Resent fields are strictly informational. They MUST NOT be used in the normal
29908 processing of replies or other such automatic actions on messages.'&
29911 This leaves things a bit vague as far as other processing actions such as
29912 address rewriting are concerned. Exim treats &%Resent-%& header lines as
29916 A &'Resent-From:'& line that just contains the login id of the submitting user
29917 is automatically rewritten in the same way as &'From:'& (see below).
29919 If there's a rewriting rule for a particular header line, it is also applied to
29920 &%Resent-%& header lines of the same type. For example, a rule that rewrites
29921 &'From:'& also rewrites &'Resent-From:'&.
29923 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
29926 For a locally-submitted message,
29927 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
29928 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
29929 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
29930 included in log lines in this case.
29932 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
29933 &%Resent-%& header lines are present.
29939 .section "The Auto-Submitted: header line" "SECID221"
29940 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
29941 includes the header line:
29943 Auto-Submitted: auto-replied
29946 .section "The Bcc: header line" "SECID222"
29947 .cindex "&'Bcc:'& header line"
29948 If Exim is called with the &%-t%& option, to take recipient addresses from a
29949 message's header, it removes any &'Bcc:'& header line that may exist (after
29950 extracting its addresses). If &%-t%& is not present on the command line, any
29951 existing &'Bcc:'& is not removed.
29954 .section "The Date: header line" "SECID223"
29955 .cindex "&'Date:'& header line"
29956 If a locally-generated or submission-mode message has no &'Date:'& header line,
29957 Exim adds one, using the current date and time, unless the
29958 &%suppress_local_fixups%& control has been specified.
29960 .section "The Delivery-date: header line" "SECID224"
29961 .cindex "&'Delivery-date:'& header line"
29962 .oindex "&%delivery_date_remove%&"
29963 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
29964 set. Exim can be configured to add them to the final delivery of messages. (See
29965 the generic &%delivery_date_add%& transport option.) They should not be present
29966 in messages in transit. If the &%delivery_date_remove%& configuration option is
29967 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
29971 .section "The Envelope-to: header line" "SECID225"
29972 .cindex "&'Envelope-to:'& header line"
29973 .oindex "&%envelope_to_remove%&"
29974 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
29975 Exim can be configured to add them to the final delivery of messages. (See the
29976 generic &%envelope_to_add%& transport option.) They should not be present in
29977 messages in transit. If the &%envelope_to_remove%& configuration option is set
29978 (the default), Exim removes &'Envelope-to:'& header lines from incoming
29982 .section "The From: header line" "SECTthefrohea"
29983 .cindex "&'From:'& header line"
29984 .cindex "Sendmail compatibility" "&""From""& line"
29985 .cindex "message" "submission"
29986 .cindex "submission mode"
29987 If a submission-mode message does not contain a &'From:'& header line, Exim
29988 adds one if either of the following conditions is true:
29991 The envelope sender address is not empty (that is, this is not a bounce
29992 message). The added header line copies the envelope sender address.
29994 .vindex "&$authenticated_id$&"
29995 The SMTP session is authenticated and &$authenticated_id$& is not empty.
29997 .vindex "&$qualify_domain$&"
29998 If no domain is specified by the submission control, the local part is
29999 &$authenticated_id$& and the domain is &$qualify_domain$&.
30001 If a non-empty domain is specified by the submission control, the local
30002 part is &$authenticated_id$&, and the domain is the specified domain.
30004 If an empty domain is specified by the submission control,
30005 &$authenticated_id$& is assumed to be the complete address.
30009 A non-empty envelope sender takes precedence.
30011 If a locally-generated incoming message does not contain a &'From:'& header
30012 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
30013 containing the sender's address. The calling user's login name and full name
30014 are used to construct the address, as described in section &<<SECTconstr>>&.
30015 They are obtained from the password data by calling &[getpwuid()]& (but see the
30016 &%unknown_login%& configuration option). The address is qualified with
30017 &%qualify_domain%&.
30019 For compatibility with Sendmail, if an incoming, non-SMTP message has a
30020 &'From:'& header line containing just the unqualified login name of the calling
30021 user, this is replaced by an address containing the user's login name and full
30022 name as described in section &<<SECTconstr>>&.
30025 .section "The Message-ID: header line" "SECID226"
30026 .cindex "&'Message-ID:'& header line"
30027 .cindex "message" "submission"
30028 .oindex "&%message_id_header_text%&"
30029 If a locally-generated or submission-mode incoming message does not contain a
30030 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
30031 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
30032 to the message. If there are any &'Resent-:'& headers in the message, it
30033 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
30034 message id, preceded by the letter E to ensure it starts with a letter, and
30035 followed by @ and the primary host name. Additional information can be included
30036 in this header line by setting the &%message_id_header_text%& and/or
30037 &%message_id_header_domain%& options.
30040 .section "The Received: header line" "SECID227"
30041 .cindex "&'Received:'& header line"
30042 A &'Received:'& header line is added at the start of every message. The
30043 contents are defined by the &%received_header_text%& configuration option, and
30044 Exim automatically adds a semicolon and a timestamp to the configured string.
30046 The &'Received:'& header is generated as soon as the message's header lines
30047 have been received. At this stage, the timestamp in the &'Received:'& header
30048 line is the time that the message started to be received. This is the value
30049 that is seen by the DATA ACL and by the &[local_scan()]& function.
30051 Once a message is accepted, the timestamp in the &'Received:'& header line is
30052 changed to the time of acceptance, which is (apart from a small delay while the
30053 -H spool file is written) the earliest time at which delivery could start.
30056 .section "The References: header line" "SECID228"
30057 .cindex "&'References:'& header line"
30058 Messages created by the &(autoreply)& transport include a &'References:'&
30059 header line. This is constructed according to the rules that are described in
30060 section 3.64 of RFC 2822 (which states that replies should contain such a
30061 header line), and section 3.14 of RFC 3834 (which states that automatic
30062 responses are not different in this respect). However, because some mail
30063 processing software does not cope well with very long header lines, no more
30064 than 12 message IDs are copied from the &'References:'& header line in the
30065 incoming message. If there are more than 12, the first one and then the final
30066 11 are copied, before adding the message ID of the incoming message.
30070 .section "The Return-path: header line" "SECID229"
30071 .cindex "&'Return-path:'& header line"
30072 .oindex "&%return_path_remove%&"
30073 &'Return-path:'& header lines are defined as something an MTA may insert when
30074 it does the final delivery of messages. (See the generic &%return_path_add%&
30075 transport option.) Therefore, they should not be present in messages in
30076 transit. If the &%return_path_remove%& configuration option is set (the
30077 default), Exim removes &'Return-path:'& header lines from incoming messages.
30081 .section "The Sender: header line" "SECTthesenhea"
30082 .cindex "&'Sender:'& header line"
30083 .cindex "message" "submission"
30084 For a locally-originated message from an untrusted user, Exim may remove an
30085 existing &'Sender:'& header line, and it may add a new one. You can modify
30086 these actions by setting the &%local_sender_retain%& option true, the
30087 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
30090 When a local message is received from an untrusted user and
30091 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
30092 control has not been set, a check is made to see if the address given in the
30093 &'From:'& header line is the correct (local) sender of the message. The address
30094 that is expected has the login name as the local part and the value of
30095 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
30096 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
30097 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
30098 line is added to the message.
30100 If you set &%local_from_check%& false, this checking does not occur. However,
30101 the removal of an existing &'Sender:'& line still happens, unless you also set
30102 &%local_sender_retain%& to be true. It is not possible to set both of these
30103 options true at the same time.
30105 .cindex "submission mode"
30106 By default, no processing of &'Sender:'& header lines is done for messages
30107 received over TCP/IP or for messages submitted by trusted users. However, when
30108 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
30109 not specified on the submission control, the following processing takes place:
30111 .vindex "&$authenticated_id$&"
30112 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
30113 authenticated, and &$authenticated_id$& is not empty, a sender address is
30114 created as follows:
30117 .vindex "&$qualify_domain$&"
30118 If no domain is specified by the submission control, the local part is
30119 &$authenticated_id$& and the domain is &$qualify_domain$&.
30121 If a non-empty domain is specified by the submission control, the local part
30122 is &$authenticated_id$&, and the domain is the specified domain.
30124 If an empty domain is specified by the submission control,
30125 &$authenticated_id$& is assumed to be the complete address.
30128 This address is compared with the address in the &'From:'& header line. If they
30129 are different, a &'Sender:'& header line containing the created address is
30130 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
30131 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
30133 .cindex "return path" "created from &'Sender:'&"
30134 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
30135 the message (the envelope sender address) is changed to be the same address,
30136 except in the case of submission mode when &%sender_retain%& is specified.
30140 .section "Adding and removing header lines in routers and transports" &&&
30141 "SECTheadersaddrem"
30142 .cindex "header lines" "adding; in router or transport"
30143 .cindex "header lines" "removing; in router or transport"
30144 When a message is delivered, the addition and removal of header lines can be
30145 specified in a system filter, or on any of the routers and transports that
30146 process the message. Section &<<SECTaddremheasys>>& contains details about
30147 modifying headers in a system filter. Header lines can also be added in an ACL
30148 as a message is received (see section &<<SECTaddheadacl>>&).
30150 In contrast to what happens in a system filter, header modifications that are
30151 specified on routers and transports apply only to the particular recipient
30152 addresses that are being processed by those routers and transports. These
30153 changes do not actually take place until a copy of the message is being
30154 transported. Therefore, they do not affect the basic set of header lines, and
30155 they do not affect the values of the variables that refer to header lines.
30157 &*Note*&: In particular, this means that any expansions in the configuration of
30158 the transport cannot refer to the modified header lines, because such
30159 expansions all occur before the message is actually transported.
30161 For both routers and transports, the result of expanding a &%headers_add%&
30162 option must be in the form of one or more RFC 2822 header lines, separated by
30163 newlines (coded as &"\n"&). For example:
30165 headers_add = X-added-header: added by $primary_hostname\n\
30166 X-added-second: another added header line
30168 Exim does not check the syntax of these added header lines.
30170 The result of expanding &%headers_remove%& must consist of a colon-separated
30171 list of header names. This is confusing, because header names themselves are
30172 often terminated by colons. In this case, the colons are the list separators,
30173 not part of the names. For example:
30175 headers_remove = return-receipt-to:acknowledge-to
30177 When &%headers_add%& or &%headers_remove%& is specified on a router, its value
30178 is expanded at routing time, and then associated with all addresses that are
30179 accepted by that router, and also with any new addresses that it generates. If
30180 an address passes through several routers as a result of aliasing or
30181 forwarding, the changes are cumulative.
30183 .oindex "&%unseen%&"
30184 However, this does not apply to multiple routers that result from the use of
30185 the &%unseen%& option. Any header modifications that were specified by the
30186 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
30188 Addresses that end up with different &%headers_add%& or &%headers_remove%&
30189 settings cannot be delivered together in a batch, so a transport is always
30190 dealing with a set of addresses that have the same header-processing
30193 The transport starts by writing the original set of header lines that arrived
30194 with the message, possibly modified by the system filter. As it writes out
30195 these lines, it consults the list of header names that were attached to the
30196 recipient address(es) by &%headers_remove%& options in routers, and it also
30197 consults the transport's own &%headers_remove%& option. Header lines whose
30198 names are on either of these lists are not written out. If there are multiple
30199 instances of any listed header, they are all skipped.
30201 After the remaining original header lines have been written, new header
30202 lines that were specified by routers' &%headers_add%& options are written, in
30203 the order in which they were attached to the address. These are followed by any
30204 header lines specified by the transport's &%headers_add%& option.
30206 This way of handling header line modifications in routers and transports has
30207 the following consequences:
30210 The original set of header lines, possibly modified by the system filter,
30211 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
30212 to it, at all times.
30214 Header lines that are added by a router's
30215 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
30216 expansion syntax in subsequent routers or the transport.
30218 Conversely, header lines that are specified for removal by &%headers_remove%&
30219 in a router remain visible to subsequent routers and the transport.
30221 Headers added to an address by &%headers_add%& in a router cannot be removed by
30222 a later router or by a transport.
30224 An added header can refer to the contents of an original header that is to be
30225 removed, even it has the same name as the added header. For example:
30227 headers_remove = subject
30228 headers_add = Subject: new subject (was: $h_subject:)
30232 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
30233 for a &(redirect)& router that has the &%one_time%& option set.
30239 .section "Constructed addresses" "SECTconstr"
30240 .cindex "address" "constructed"
30241 .cindex "constructed address"
30242 When Exim constructs a sender address for a locally-generated message, it uses
30245 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
30249 Zaphod Beeblebrox <zaphod@end.univ.example>
30251 The user name is obtained from the &%-F%& command line option if set, or
30252 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
30253 &"gecos"& field from the password entry. If the &"gecos"& field contains an
30254 ampersand character, this is replaced by the login name with the first letter
30255 upper cased, as is conventional in a number of operating systems. See the
30256 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
30257 The &%unknown_username%& option can be used to specify user names in cases when
30258 there is no password file entry.
30261 In all cases, the user name is made to conform to RFC 2822 by quoting all or
30262 parts of it if necessary. In addition, if it contains any non-printing
30263 characters, it is encoded as described in RFC 2047, which defines a way of
30264 including non-ASCII characters in header lines. The value of the
30265 &%headers_charset%& option specifies the name of the encoding that is used (the
30266 characters are assumed to be in this encoding). The setting of
30267 &%print_topbitchars%& controls whether characters with the top bit set (that
30268 is, with codes greater than 127) count as printing characters or not.
30272 .section "Case of local parts" "SECID230"
30273 .cindex "case of local parts"
30274 .cindex "local part" "case of"
30275 RFC 2822 states that the case of letters in the local parts of addresses cannot
30276 be assumed to be non-significant. Exim preserves the case of local parts of
30277 addresses, but by default it uses a lower-cased form when it is routing,
30278 because on most Unix systems, usernames are in lower case and case-insensitive
30279 routing is required. However, any particular router can be made to use the
30280 original case for local parts by setting the &%caseful_local_part%& generic
30283 .cindex "mixed-case login names"
30284 If you must have mixed-case user names on your system, the best way to proceed,
30285 assuming you want case-independent handling of incoming email, is to set up
30286 your first router to convert incoming local parts in your domains to the
30287 correct case by means of a file lookup. For example:
30291 domains = +local_domains
30292 data = ${lookup{$local_part}cdb\
30293 {/etc/usercased.cdb}{$value}fail}\
30296 For this router, the local part is forced to lower case by the default action
30297 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
30298 up a new local part in the correct case. If you then set &%caseful_local_part%&
30299 on any subsequent routers which process your domains, they will operate on
30300 local parts with the correct case in a case-sensitive manner.
30304 .section "Dots in local parts" "SECID231"
30305 .cindex "dot" "in local part"
30306 .cindex "local part" "dots in"
30307 RFC 2822 forbids empty components in local parts. That is, an unquoted local
30308 part may not begin or end with a dot, nor have two consecutive dots in the
30309 middle. However, it seems that many MTAs do not enforce this, so Exim permits
30310 empty components for compatibility.
30314 .section "Rewriting addresses" "SECID232"
30315 .cindex "rewriting" "addresses"
30316 Rewriting of sender and recipient addresses, and addresses in headers, can
30317 happen automatically, or as the result of configuration options, as described
30318 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
30319 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
30321 Automatic rewriting includes qualification, as mentioned above. The other case
30322 in which it can happen is when an incomplete non-local domain is given. The
30323 routing process may cause this to be expanded into the full domain name. For
30324 example, a header such as
30328 might get rewritten as
30330 To: hare@teaparty.wonderland.fict.example
30332 Rewriting as a result of routing is the one kind of message processing that
30333 does not happen at input time, as it cannot be done until the address has
30336 Strictly, one should not do &'any'& deliveries of a message until all its
30337 addresses have been routed, in case any of the headers get changed as a
30338 result of routing. However, doing this in practice would hold up many
30339 deliveries for unreasonable amounts of time, just because one address could not
30340 immediately be routed. Exim therefore does not delay other deliveries when
30341 routing of one or more addresses is deferred.
30342 .ecindex IIDmesproc
30346 . ////////////////////////////////////////////////////////////////////////////
30347 . ////////////////////////////////////////////////////////////////////////////
30349 .chapter "SMTP processing" "CHAPSMTP"
30350 .scindex IIDsmtpproc1 "SMTP" "processing details"
30351 .scindex IIDsmtpproc2 "LMTP" "processing details"
30352 Exim supports a number of different ways of using the SMTP protocol, and its
30353 LMTP variant, which is an interactive protocol for transferring messages into a
30354 closed mail store application. This chapter contains details of how SMTP is
30355 processed. For incoming mail, the following are available:
30358 SMTP over TCP/IP (Exim daemon or &'inetd'&);
30360 SMTP over the standard input and output (the &%-bs%& option);
30362 Batched SMTP on the standard input (the &%-bS%& option).
30365 For mail delivery, the following are available:
30368 SMTP over TCP/IP (the &(smtp)& transport);
30370 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
30373 LMTP over a pipe to a process running in the local host (the &(lmtp)&
30376 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
30377 the &%use_bsmtp%& option set).
30380 &'Batched SMTP'& is the name for a process in which batches of messages are
30381 stored in or read from files (or pipes), in a format in which SMTP commands are
30382 used to contain the envelope information.
30386 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
30387 .cindex "SMTP" "outgoing over TCP/IP"
30388 .cindex "outgoing SMTP over TCP/IP"
30389 .cindex "LMTP" "over TCP/IP"
30390 .cindex "outgoing LMTP over TCP/IP"
30393 .cindex "SIZE option on MAIL command"
30394 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
30395 The &%protocol%& option selects which protocol is to be used, but the actual
30396 processing is the same in both cases.
30398 If, in response to its EHLO command, Exim is told that the SIZE
30399 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
30400 command. The value of <&'n'&> is the message size plus the value of the
30401 &%size_addition%& option (default 1024) to allow for additions to the message
30402 such as per-transport header lines, or changes made in a
30403 .cindex "transport" "filter"
30404 .cindex "filter" "transport filter"
30405 transport filter. If &%size_addition%& is set negative, the use of SIZE is
30408 If the remote server advertises support for PIPELINING, Exim uses the
30409 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
30410 required for the transaction.
30412 If the remote server advertises support for the STARTTLS command, and Exim
30413 was built to support TLS encryption, it tries to start a TLS session unless the
30414 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
30416 If the remote server advertises support for the AUTH command, Exim scans
30417 the authenticators configuration for any suitable client settings, as described
30418 in chapter &<<CHAPSMTPAUTH>>&.
30420 .cindex "carriage return"
30422 Responses from the remote host are supposed to be terminated by CR followed by
30423 LF. However, there are known to be hosts that do not send CR characters, so in
30424 order to be able to interwork with such hosts, Exim treats LF on its own as a
30427 If a message contains a number of different addresses, all those with the same
30428 characteristics (for example, the same envelope sender) that resolve to the
30429 same set of hosts, in the same order, are sent in a single SMTP transaction,
30430 even if they are for different domains, unless there are more than the setting
30431 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
30432 they are split into groups containing no more than &%max_rcpt%&s addresses
30433 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
30434 in parallel sessions. The order of hosts with identical MX values is not
30435 significant when checking whether addresses can be batched in this way.
30437 When the &(smtp)& transport suffers a temporary failure that is not
30438 message-related, Exim updates its transport-specific database, which contains
30439 records indexed by host name that remember which messages are waiting for each
30440 particular host. It also updates the retry database with new retry times.
30442 .cindex "hints database" "retry keys"
30443 Exim's retry hints are based on host name plus IP address, so if one address of
30444 a multi-homed host is broken, it will soon be skipped most of the time.
30445 See the next section for more detail about error handling.
30447 .cindex "SMTP" "passed connection"
30448 .cindex "SMTP" "batching over TCP/IP"
30449 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
30450 looks in the hints database for the transport to see if there are any queued
30451 messages waiting for the host to which it is connected. If it finds one, it
30452 creates a new Exim process using the &%-MC%& option (which can only be used by
30453 a process running as root or the Exim user) and passes the TCP/IP socket to it
30454 so that it can deliver another message using the same socket. The new process
30455 does only those deliveries that are routed to the connected host, and may in
30456 turn pass the socket on to a third process, and so on.
30458 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
30459 limit the number of messages sent down a single TCP/IP connection.
30461 .cindex "asterisk" "after IP address"
30462 The second and subsequent messages delivered down an existing connection are
30463 identified in the main log by the addition of an asterisk after the closing
30464 square bracket of the IP address.
30469 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
30470 .cindex "error" "in outgoing SMTP"
30471 .cindex "SMTP" "errors in outgoing"
30472 .cindex "host" "error"
30473 Three different kinds of error are recognized for outgoing SMTP: host errors,
30474 message errors, and recipient errors.
30477 .vitem "&*Host errors*&"
30478 A host error is not associated with a particular message or with a
30479 particular recipient of a message. The host errors are:
30482 Connection refused or timed out,
30484 Any error response code on connection,
30486 Any error response code to EHLO or HELO,
30488 Loss of connection at any time, except after &"."&,
30490 I/O errors at any time,
30492 Timeouts during the session, other than in response to MAIL, RCPT or
30493 the &"."& at the end of the data.
30496 For a host error, a permanent error response on connection, or in response to
30497 EHLO, causes all addresses routed to the host to be failed. Any other host
30498 error causes all addresses to be deferred, and retry data to be created for the
30499 host. It is not tried again, for any message, until its retry time arrives. If
30500 the current set of addresses are not all delivered in this run (to some
30501 alternative host), the message is added to the list of those waiting for this
30502 host, so if it is still undelivered when a subsequent successful delivery is
30503 made to the host, it will be sent down the same SMTP connection.
30505 .vitem "&*Message errors*&"
30506 .cindex "message" "error"
30507 A message error is associated with a particular message when sent to a
30508 particular host, but not with a particular recipient of the message. The
30509 message errors are:
30512 Any error response code to MAIL, DATA, or the &"."& that terminates
30515 Timeout after MAIL,
30517 Timeout or loss of connection after the &"."& that terminates the data. A
30518 timeout after the DATA command itself is treated as a host error, as is loss of
30519 connection at any other time.
30522 For a message error, a permanent error response (5&'xx'&) causes all addresses
30523 to be failed, and a delivery error report to be returned to the sender. A
30524 temporary error response (4&'xx'&), or one of the timeouts, causes all
30525 addresses to be deferred. Retry data is not created for the host, but instead,
30526 a retry record for the combination of host plus message id is created. The
30527 message is not added to the list of those waiting for this host. This ensures
30528 that the failing message will not be sent to this host again until the retry
30529 time arrives. However, other messages that are routed to the host are not
30530 affected, so if it is some property of the message that is causing the error,
30531 it will not stop the delivery of other mail.
30533 If the remote host specified support for the SIZE parameter in its response
30534 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
30535 over-large message will cause a message error because the error arrives as a
30538 .vitem "&*Recipient errors*&"
30539 .cindex "recipient" "error"
30540 A recipient error is associated with a particular recipient of a message. The
30541 recipient errors are:
30544 Any error response to RCPT,
30546 Timeout after RCPT.
30549 For a recipient error, a permanent error response (5&'xx'&) causes the
30550 recipient address to be failed, and a bounce message to be returned to the
30551 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
30552 address to be deferred, and routing retry data to be created for it. This is
30553 used to delay processing of the address in subsequent queue runs, until its
30554 routing retry time arrives. This applies to all messages, but because it
30555 operates only in queue runs, one attempt will be made to deliver a new message
30556 to the failing address before the delay starts to operate. This ensures that,
30557 if the failure is really related to the message rather than the recipient
30558 (&"message too big for this recipient"& is a possible example), other messages
30559 have a chance of getting delivered. If a delivery to the address does succeed,
30560 the retry information gets cleared, so all stuck messages get tried again, and
30561 the retry clock is reset.
30563 The message is not added to the list of those waiting for this host. Use of the
30564 host for other messages is unaffected, and except in the case of a timeout,
30565 other recipients are processed independently, and may be successfully delivered
30566 in the current SMTP session. After a timeout it is of course impossible to
30567 proceed with the session, so all addresses get deferred. However, those other
30568 than the one that failed do not suffer any subsequent retry delays. Therefore,
30569 if one recipient is causing trouble, the others have a chance of getting
30570 through when a subsequent delivery attempt occurs before the failing
30571 recipient's retry time.
30574 In all cases, if there are other hosts (or IP addresses) available for the
30575 current set of addresses (for example, from multiple MX records), they are
30576 tried in this run for any undelivered addresses, subject of course to their
30577 own retry data. In other words, recipient error retry data does not take effect
30578 until the next delivery attempt.
30580 Some hosts have been observed to give temporary error responses to every
30581 MAIL command at certain times (&"insufficient space"& has been seen). It
30582 would be nice if such circumstances could be recognized, and defer data for the
30583 host itself created, but this is not possible within the current Exim design.
30584 What actually happens is that retry data for every (host, message) combination
30587 The reason that timeouts after MAIL and RCPT are treated specially is that
30588 these can sometimes arise as a result of the remote host's verification
30589 procedures. Exim makes this assumption, and treats them as if a temporary error
30590 response had been received. A timeout after &"."& is treated specially because
30591 it is known that some broken implementations fail to recognize the end of the
30592 message if the last character of the last line is a binary zero. Thus, it is
30593 helpful to treat this case as a message error.
30595 Timeouts at other times are treated as host errors, assuming a problem with the
30596 host, or the connection to it. If a timeout after MAIL, RCPT,
30597 or &"."& is really a connection problem, the assumption is that at the next try
30598 the timeout is likely to occur at some other point in the dialogue, causing it
30599 then to be treated as a host error.
30601 There is experimental evidence that some MTAs drop the connection after the
30602 terminating &"."& if they do not like the contents of the message for some
30603 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
30604 should be given. That is why Exim treats this case as a message rather than a
30605 host error, in order not to delay other messages to the same host.
30610 .section "Incoming SMTP messages over TCP/IP" "SECID233"
30611 .cindex "SMTP" "incoming over TCP/IP"
30612 .cindex "incoming SMTP over TCP/IP"
30615 Incoming SMTP messages can be accepted in one of two ways: by running a
30616 listening daemon, or by using &'inetd'&. In the latter case, the entry in
30617 &_/etc/inetd.conf_& should be like this:
30619 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
30621 Exim distinguishes between this case and the case of a locally running user
30622 agent using the &%-bs%& option by checking whether or not the standard input is
30623 a socket. When it is, either the port must be privileged (less than 1024), or
30624 the caller must be root or the Exim user. If any other user passes a socket
30625 with an unprivileged port number, Exim prints a message on the standard error
30626 stream and exits with an error code.
30628 By default, Exim does not make a log entry when a remote host connects or
30629 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
30630 unexpected. It can be made to write such log entries by setting the
30631 &%smtp_connection%& log selector.
30633 .cindex "carriage return"
30635 Commands from the remote host are supposed to be terminated by CR followed by
30636 LF. However, there are known to be hosts that do not send CR characters. In
30637 order to be able to interwork with such hosts, Exim treats LF on its own as a
30639 Furthermore, because common code is used for receiving messages from all
30640 sources, a CR on its own is also interpreted as a line terminator. However, the
30641 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
30643 .cindex "EHLO" "invalid data"
30644 .cindex "HELO" "invalid data"
30645 One area that sometimes gives rise to problems concerns the EHLO or
30646 HELO commands. Some clients send syntactically invalid versions of these
30647 commands, which Exim rejects by default. (This is nothing to do with verifying
30648 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
30649 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
30650 match the broken hosts that send invalid commands.
30652 .cindex "SIZE option on MAIL command"
30653 .cindex "MAIL" "SIZE option"
30654 The amount of disk space available is checked whenever SIZE is received on
30655 a MAIL command, independently of whether &%message_size_limit%& or
30656 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
30657 false. A temporary error is given if there is not enough space. If
30658 &%check_spool_space%& is set, the check is for that amount of space plus the
30659 value given with SIZE, that is, it checks that the addition of the incoming
30660 message will not reduce the space below the threshold.
30662 When a message is successfully received, Exim includes the local message id in
30663 its response to the final &"."& that terminates the data. If the remote host
30664 logs this text it can help with tracing what has happened to a message.
30666 The Exim daemon can limit the number of simultaneous incoming connections it is
30667 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
30668 number of simultaneous incoming connections from a single remote host (see the
30669 &%smtp_accept_max_per_host%& option). Additional connection attempts are
30670 rejected using the SMTP temporary error code 421.
30672 The Exim daemon does not rely on the SIGCHLD signal to detect when a
30673 subprocess has finished, as this can get lost at busy times. Instead, it looks
30674 for completed subprocesses every time it wakes up. Provided there are other
30675 things happening (new incoming calls, starts of queue runs), completed
30676 processes will be noticed and tidied away. On very quiet systems you may
30677 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
30678 it will be noticed when the daemon next wakes up.
30680 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
30681 and can also be set up to reject SMTP calls from non-reserved hosts at times of
30682 high system load &-- for details see the &%smtp_accept_reserve%&,
30683 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
30684 applies in both the daemon and &'inetd'& cases.
30686 Exim normally starts a delivery process for each message received, though this
30687 can be varied by means of the &%-odq%& command line option and the
30688 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
30689 number of simultaneously running delivery processes started in this way from
30690 SMTP input can be limited by the &%smtp_accept_queue%& and
30691 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
30692 subsequently received messages are just put on the input queue without starting
30693 a delivery process.
30695 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
30696 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
30697 started up from the &'inetd'& daemon, because in that case each connection is
30698 handled by an entirely independent Exim process. Control by load average is,
30699 however, available with &'inetd'&.
30701 Exim can be configured to verify addresses in incoming SMTP commands as they
30702 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
30703 to rewrite addresses at this time &-- before any syntax checking is done. See
30704 section &<<SECTrewriteS>>&.
30706 Exim can also be configured to limit the rate at which a client host submits
30707 MAIL and RCPT commands in a single SMTP session. See the
30708 &%smtp_ratelimit_hosts%& option.
30712 .section "Unrecognized SMTP commands" "SECID234"
30713 .cindex "SMTP" "unrecognized commands"
30714 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
30715 commands during a single SMTP connection, it drops the connection after sending
30716 the error response to the last command. The default value for
30717 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
30718 abuse that subvert web servers into making connections to SMTP ports; in these
30719 circumstances, a number of non-SMTP lines are sent first.
30722 .section "Syntax and protocol errors in SMTP commands" "SECID235"
30723 .cindex "SMTP" "syntax errors"
30724 .cindex "SMTP" "protocol errors"
30725 A syntax error is detected if an SMTP command is recognized, but there is
30726 something syntactically wrong with its data, for example, a malformed email
30727 address in a RCPT command. Protocol errors include invalid command
30728 sequencing such as RCPT before MAIL. If Exim receives more than
30729 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
30730 drops the connection after sending the error response to the last command. The
30731 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
30732 broken clients that loop sending bad commands (yes, it has been seen).
30736 .section "Use of non-mail SMTP commands" "SECID236"
30737 .cindex "SMTP" "non-mail commands"
30738 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
30739 DATA. Exim counts such commands, and drops the connection if there are too
30740 many of them in a single SMTP session. This action catches some
30741 denial-of-service attempts and things like repeated failing AUTHs, or a mad
30742 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
30743 defines what &"too many"& means. Its default value is 10.
30745 When a new message is expected, one occurrence of RSET is not counted. This
30746 allows a client to send one RSET between messages (this is not necessary,
30747 but some clients do it). Exim also allows one uncounted occurrence of HELO
30748 or EHLO, and one occurrence of STARTTLS between messages. After
30749 starting up a TLS session, another EHLO is expected, and so it too is not
30752 The first occurrence of AUTH in a connection, or immediately following
30753 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
30754 RCPT, DATA, and QUIT are counted.
30756 You can control which hosts are subject to the limit set by
30757 &%smtp_accept_max_nonmail%& by setting
30758 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
30759 the limit apply to all hosts. This option means that you can exclude any
30760 specific badly-behaved hosts that you have to live with.
30765 .section "The VRFY and EXPN commands" "SECID237"
30766 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
30767 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
30768 appropriate) in order to decide whether the command should be accepted or not.
30769 If no ACL is defined, the command is rejected.
30771 .cindex "VRFY" "processing"
30772 When VRFY is accepted, it runs exactly the same code as when Exim is
30773 called with the &%-bv%& option.
30775 .cindex "EXPN" "processing"
30776 When EXPN is accepted, a single-level expansion of the address is done.
30777 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
30778 than a verification (the &%-bv%& option). If an unqualified local part is given
30779 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
30780 of VRFY and EXPN commands are logged on the main and reject logs, and
30781 VRFY verification failures are logged on the main log for consistency with
30786 .section "The ETRN command" "SECTETRN"
30787 .cindex "ETRN" "processing"
30788 RFC 1985 describes an SMTP command called ETRN that is designed to
30789 overcome the security problems of the TURN command (which has fallen into
30790 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
30791 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
30792 should be accepted or not. If no ACL is defined, the command is rejected.
30794 The ETRN command is concerned with &"releasing"& messages that are awaiting
30795 delivery to certain hosts. As Exim does not organize its message queue by host,
30796 the only form of ETRN that is supported by default is the one where the
30797 text starts with the &"#"& prefix, in which case the remainder of the text is
30798 specific to the SMTP server. A valid ETRN command causes a run of Exim with
30799 the &%-R%& option to happen, with the remainder of the ETRN text as its
30800 argument. For example,
30808 which causes a delivery attempt on all messages with undelivered addresses
30809 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
30810 default), Exim prevents the simultaneous execution of more than one queue run
30811 for the same argument string as a result of an ETRN command. This stops
30812 a misbehaving client from starting more than one queue runner at once.
30814 .cindex "hints database" "ETRN serialization"
30815 Exim implements the serialization by means of a hints database in which a
30816 record is written whenever a process is started by ETRN, and deleted when
30817 the process completes. However, Exim does not keep the SMTP session waiting for
30818 the ETRN process to complete. Once ETRN is accepted, the client is sent
30819 a &"success"& return code. Obviously there is scope for hints records to get
30820 left lying around if there is a system or program crash. To guard against this,
30821 Exim ignores any records that are more than six hours old.
30823 .oindex "&%smtp_etrn_command%&"
30824 For more control over what ETRN does, the &%smtp_etrn_command%& option can
30825 used. This specifies a command that is run whenever ETRN is received,
30826 whatever the form of its argument. For
30829 smtp_etrn_command = /etc/etrn_command $domain \
30830 $sender_host_address
30832 .vindex "&$domain$&"
30833 The string is split up into arguments which are independently expanded. The
30834 expansion variable &$domain$& is set to the argument of the ETRN command,
30835 and no syntax checking is done on the contents of this argument. Exim does not
30836 wait for the command to complete, so its status code is not checked. Exim runs
30837 under its own uid and gid when receiving incoming SMTP, so it is not possible
30838 for it to change them before running the command.
30842 .section "Incoming local SMTP" "SECID238"
30843 .cindex "SMTP" "local incoming"
30844 Some user agents use SMTP to pass messages to their local MTA using the
30845 standard input and output, as opposed to passing the envelope on the command
30846 line and writing the message to the standard input. This is supported by the
30847 &%-bs%& option. This form of SMTP is handled in the same way as incoming
30848 messages over TCP/IP (including the use of ACLs), except that the envelope
30849 sender given in a MAIL command is ignored unless the caller is trusted. In
30850 an ACL you can detect this form of SMTP input by testing for an empty host
30851 identification. It is common to have this as the first line in the ACL that
30852 runs for RCPT commands:
30856 This accepts SMTP messages from local processes without doing any other tests.
30860 .section "Outgoing batched SMTP" "SECTbatchSMTP"
30861 .cindex "SMTP" "batched outgoing"
30862 .cindex "batched SMTP output"
30863 Both the &(appendfile)& and &(pipe)& transports can be used for handling
30864 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
30865 be output in BSMTP format. No SMTP responses are possible for this form of
30866 delivery. All it is doing is using SMTP commands as a way of transmitting the
30867 envelope along with the message.
30869 The message is written to the file or pipe preceded by the SMTP commands
30870 MAIL and RCPT, and followed by a line containing a single dot. Lines in
30871 the message that start with a dot have an extra dot added. The SMTP command
30872 HELO is not normally used. If it is required, the &%message_prefix%& option
30873 can be used to specify it.
30875 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
30876 one recipient address at a time by default. However, you can arrange for them
30877 to handle several addresses at once by setting the &%batch_max%& option. When
30878 this is done for BSMTP, messages may contain multiple RCPT commands. See
30879 chapter &<<CHAPbatching>>& for more details.
30882 When one or more addresses are routed to a BSMTP transport by a router that
30883 sets up a host list, the name of the first host on the list is available to the
30884 transport in the variable &$host$&. Here is an example of such a transport and
30889 driver = manualroute
30890 transport = smtp_appendfile
30891 route_list = domain.example batch.host.example
30895 driver = appendfile
30896 directory = /var/bsmtp/$host
30901 This causes messages addressed to &'domain.example'& to be written in BSMTP
30902 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
30903 message (unless there are more than 1000 recipients).
30907 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
30908 .cindex "SMTP" "batched incoming"
30909 .cindex "batched SMTP input"
30910 The &%-bS%& command line option causes Exim to accept one or more messages by
30911 reading SMTP on the standard input, but to generate no responses. If the caller
30912 is trusted, the senders in the MAIL commands are believed; otherwise the
30913 sender is always the caller of Exim. Unqualified senders and receivers are not
30914 rejected (there seems little point) but instead just get qualified. HELO
30915 and EHLO act as RSET; VRFY, EXPN, ETRN and HELP, act
30916 as NOOP; QUIT quits.
30918 No policy checking is done for BSMTP input. That is, no ACL is run at anytime.
30919 In this respect it is like non-SMTP local input.
30921 If an error is detected while reading a message, including a missing &"."& at
30922 the end, Exim gives up immediately. It writes details of the error to the
30923 standard output in a stylized way that the calling program should be able to
30924 make some use of automatically, for example:
30926 554 Unexpected end of file
30927 Transaction started in line 10
30928 Error detected in line 14
30930 It writes a more verbose version, for human consumption, to the standard error
30933 An error was detected while processing a file of BSMTP input.
30934 The error message was:
30936 501 '>' missing at end of address
30938 The SMTP transaction started in line 10.
30939 The error was detected in line 12.
30940 The SMTP command at fault was:
30942 rcpt to:<malformed@in.com.plete
30944 1 previous message was successfully processed.
30945 The rest of the batch was abandoned.
30947 The return code from Exim is zero only if there were no errors. It is 1 if some
30948 messages were accepted before an error was detected, and 2 if no messages were
30950 .ecindex IIDsmtpproc1
30951 .ecindex IIDsmtpproc2
30955 . ////////////////////////////////////////////////////////////////////////////
30956 . ////////////////////////////////////////////////////////////////////////////
30958 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
30959 "Customizing messages"
30960 When a message fails to be delivered, or remains on the queue for more than a
30961 configured amount of time, Exim sends a message to the original sender, or
30962 to an alternative configured address. The text of these messages is built into
30963 the code of Exim, but it is possible to change it, either by adding a single
30964 string, or by replacing each of the paragraphs by text supplied in a file.
30966 The &'From:'& and &'To:'& header lines are automatically generated; you can
30967 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
30968 option. Exim also adds the line
30970 Auto-Submitted: auto-generated
30972 to all warning and bounce messages,
30975 .section "Customizing bounce messages" "SECID239"
30976 .cindex "customizing" "bounce message"
30977 .cindex "bounce message" "customizing"
30978 If &%bounce_message_text%& is set, its contents are included in the default
30979 message immediately after &"This message was created automatically by mail
30980 delivery software."& The string is not expanded. It is not used if
30981 &%bounce_message_file%& is set.
30983 When &%bounce_message_file%& is set, it must point to a template file for
30984 constructing error messages. The file consists of a series of text items,
30985 separated by lines consisting of exactly four asterisks. If the file cannot be
30986 opened, default text is used and a message is written to the main and panic
30987 logs. If any text item in the file is empty, default text is used for that
30990 .vindex "&$bounce_recipient$&"
30991 .vindex "&$bounce_return_size_limit$&"
30992 Each item of text that is read from the file is expanded, and there are two
30993 expansion variables which can be of use here: &$bounce_recipient$& is set to
30994 the recipient of an error message while it is being created, and
30995 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
30996 option, rounded to a whole number.
30998 The items must appear in the file in the following order:
31001 The first item is included in the headers, and should include at least a
31002 &'Subject:'& header. Exim does not check the syntax of these headers.
31004 The second item forms the start of the error message. After it, Exim lists the
31005 failing addresses with their error messages.
31007 The third item is used to introduce any text from pipe transports that is to be
31008 returned to the sender. It is omitted if there is no such text.
31010 The fourth item is used to introduce the copy of the message that is returned
31011 as part of the error report.
31013 The fifth item is added after the fourth one if the returned message is
31014 truncated because it is bigger than &%return_size_limit%&.
31016 The sixth item is added after the copy of the original message.
31019 The default state (&%bounce_message_file%& unset) is equivalent to the
31020 following file, in which the sixth item is empty. The &'Subject:'& and some
31021 other lines have been split in order to fit them on the page:
31023 Subject: Mail delivery failed
31024 ${if eq{$sender_address}{$bounce_recipient}
31025 {: returning message to sender}}
31027 This message was created automatically by mail delivery software.
31029 A message ${if eq{$sender_address}{$bounce_recipient}
31030 {that you sent }{sent by
31034 }}could not be delivered to all of its recipients.
31035 This is a permanent error. The following address(es) failed:
31037 The following text was generated during the delivery attempt(s):
31039 ------ This is a copy of the message, including all the headers.
31042 ------ The body of the message is $message_size characters long;
31044 ------ $bounce_return_size_limit or so are included here.
31047 .section "Customizing warning messages" "SECTcustwarn"
31048 .cindex "customizing" "warning message"
31049 .cindex "warning of delay" "customizing the message"
31050 The option &%warn_message_file%& can be pointed at a template file for use when
31051 warnings about message delays are created. In this case there are only three
31055 The first item is included in the headers, and should include at least a
31056 &'Subject:'& header. Exim does not check the syntax of these headers.
31058 The second item forms the start of the warning message. After it, Exim lists
31059 the delayed addresses.
31061 The third item then ends the message.
31064 The default state is equivalent to the following file, except that some lines
31065 have been split here, in order to fit them on the page:
31067 Subject: Warning: message $message_exim_id delayed
31068 $warn_message_delay
31070 This message was created automatically by mail delivery software.
31072 A message ${if eq{$sender_address}{$warn_message_recipients}
31073 {that you sent }{sent by
31077 }}has not been delivered to all of its recipients after
31078 more than $warn_message_delay on the queue on $primary_hostname.
31080 The message identifier is: $message_exim_id
31081 The subject of the message is: $h_subject
31082 The date of the message is: $h_date
31084 The following address(es) have not yet been delivered:
31086 No action is required on your part. Delivery attempts will
31087 continue for some time, and this warning may be repeated at
31088 intervals if the message remains undelivered. Eventually the
31089 mail delivery software will give up, and when that happens,
31090 the message will be returned to you.
31092 .vindex "&$warn_message_delay$&"
31093 .vindex "&$warn_message_recipients$&"
31094 However, in the default state the subject and date lines are omitted if no
31095 appropriate headers exist. During the expansion of this file,
31096 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
31097 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
31098 of recipients for the warning message. There may be more than one if there are
31099 multiple addresses with different &%errors_to%& settings on the routers that
31105 . ////////////////////////////////////////////////////////////////////////////
31106 . ////////////////////////////////////////////////////////////////////////////
31108 .chapter "Some common configuration settings" "CHAPcomconreq"
31109 This chapter discusses some configuration settings that seem to be fairly
31110 common. More examples and discussion can be found in the Exim book.
31114 .section "Sending mail to a smart host" "SECID240"
31115 .cindex "smart host" "example router"
31116 If you want to send all mail for non-local domains to a &"smart host"&, you
31117 should replace the default &(dnslookup)& router with a router which does the
31118 routing explicitly:
31120 send_to_smart_host:
31121 driver = manualroute
31122 route_list = !+local_domains smart.host.name
31123 transport = remote_smtp
31125 You can use the smart host's IP address instead of the name if you wish.
31126 If you are using Exim only to submit messages to a smart host, and not for
31127 receiving incoming messages, you can arrange for it to do the submission
31128 synchronously by setting the &%mua_wrapper%& option (see chapter
31129 &<<CHAPnonqueueing>>&).
31134 .section "Using Exim to handle mailing lists" "SECTmailinglists"
31135 .cindex "mailing lists"
31136 Exim can be used to run simple mailing lists, but for large and/or complicated
31137 requirements, the use of additional specialized mailing list software such as
31138 Majordomo or Mailman is recommended.
31140 The &(redirect)& router can be used to handle mailing lists where each list
31141 is maintained in a separate file, which can therefore be managed by an
31142 independent manager. The &%domains%& router option can be used to run these
31143 lists in a separate domain from normal mail. For example:
31147 domains = lists.example
31148 file = /usr/lists/$local_part
31151 errors_to = $local_part-request@lists.example
31154 This router is skipped for domains other than &'lists.example'&. For addresses
31155 in that domain, it looks for a file that matches the local part. If there is no
31156 such file, the router declines, but because &%no_more%& is set, no subsequent
31157 routers are tried, and so the whole delivery fails.
31159 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
31160 expanded into a file name or a pipe delivery, which is usually inappropriate in
31163 .oindex "&%errors_to%&"
31164 The &%errors_to%& option specifies that any delivery errors caused by addresses
31165 taken from a mailing list are to be sent to the given address rather than the
31166 original sender of the message. However, before acting on this, Exim verifies
31167 the error address, and ignores it if verification fails.
31169 For example, using the configuration above, mail sent to
31170 &'dicts@lists.example'& is passed on to those addresses contained in
31171 &_/usr/lists/dicts_&, with error reports directed to
31172 &'dicts-request@lists.example'&, provided that this address can be verified.
31173 There could be a file called &_/usr/lists/dicts-request_& containing
31174 the address(es) of this particular list's manager(s), but other approaches,
31175 such as setting up an earlier router (possibly using the &%local_part_prefix%&
31176 or &%local_part_suffix%& options) to handle addresses of the form
31177 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
31181 .section "Syntax errors in mailing lists" "SECID241"
31182 .cindex "mailing lists" "syntax errors in"
31183 If an entry in redirection data contains a syntax error, Exim normally defers
31184 delivery of the original address. That means that a syntax error in a mailing
31185 list holds up all deliveries to the list. This may not be appropriate when a
31186 list is being maintained automatically from data supplied by users, and the
31187 addresses are not rigorously checked.
31189 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
31190 entries that fail to parse, noting the incident in the log. If in addition
31191 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
31192 whenever a broken address is skipped. It is usually appropriate to set
31193 &%syntax_errors_to%& to the same address as &%errors_to%&.
31197 .section "Re-expansion of mailing lists" "SECID242"
31198 .cindex "mailing lists" "re-expansion of"
31199 Exim remembers every individual address to which a message has been delivered,
31200 in order to avoid duplication, but it normally stores only the original
31201 recipient addresses with a message. If all the deliveries to a mailing list
31202 cannot be done at the first attempt, the mailing list is re-expanded when the
31203 delivery is next tried. This means that alterations to the list are taken into
31204 account at each delivery attempt, so addresses that have been added to
31205 the list since the message arrived will therefore receive a copy of the
31206 message, even though it pre-dates their subscription.
31208 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
31209 on the &(redirect)& router. If this is done, any addresses generated by the
31210 router that fail to deliver at the first attempt are added to the message as
31211 &"top level"& addresses, and the parent address that generated them is marked
31212 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
31213 subsequent delivery attempts. The disadvantage of this is that if any of the
31214 failing addresses are incorrect, correcting them in the file has no effect on
31215 pre-existing messages.
31217 The original top-level address is remembered with each of the generated
31218 addresses, and is output in any log messages. However, any intermediate parent
31219 addresses are not recorded. This makes a difference to the log only if the
31220 &%all_parents%& selector is set, but for mailing lists there is normally only
31221 one level of expansion anyway.
31225 .section "Closed mailing lists" "SECID243"
31226 .cindex "mailing lists" "closed"
31227 The examples so far have assumed open mailing lists, to which anybody may
31228 send mail. It is also possible to set up closed lists, where mail is accepted
31229 from specified senders only. This is done by making use of the generic
31230 &%senders%& option to restrict the router that handles the list.
31232 The following example uses the same file as a list of recipients and as a list
31233 of permitted senders. It requires three routers:
31237 domains = lists.example
31238 local_part_suffix = -request
31239 file = /usr/lists/$local_part$local_part_suffix
31244 domains = lists.example
31245 senders = ${if exists {/usr/lists/$local_part}\
31246 {lsearch;/usr/lists/$local_part}{*}}
31247 file = /usr/lists/$local_part
31250 errors_to = $local_part-request@lists.example
31255 domains = lists.example
31257 data = :fail: $local_part@lists.example is a closed mailing list
31259 All three routers have the same &%domains%& setting, so for any other domains,
31260 they are all skipped. The first router runs only if the local part ends in
31261 &%-request%&. It handles messages to the list manager(s) by means of an open
31264 The second router runs only if the &%senders%& precondition is satisfied. It
31265 checks for the existence of a list that corresponds to the local part, and then
31266 checks that the sender is on the list by means of a linear search. It is
31267 necessary to check for the existence of the file before trying to search it,
31268 because otherwise Exim thinks there is a configuration error. If the file does
31269 not exist, the expansion of &%senders%& is *, which matches all senders. This
31270 means that the router runs, but because there is no list, declines, and
31271 &%no_more%& ensures that no further routers are run. The address fails with an
31272 &"unrouteable address"& error.
31274 The third router runs only if the second router is skipped, which happens when
31275 a mailing list exists, but the sender is not on it. This router forcibly fails
31276 the address, giving a suitable error message.
31281 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
31283 .cindex "Variable Envelope Return Paths"
31284 .cindex "envelope sender"
31285 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
31286 are a way of helping mailing list administrators discover which subscription
31287 address is the cause of a particular delivery failure. The idea is to encode
31288 the original recipient address in the outgoing envelope sender address, so that
31289 if the message is forwarded by another host and then subsequently bounces, the
31290 original recipient can be extracted from the recipient address of the bounce.
31292 .oindex &%errors_to%&
31293 .oindex &%return_path%&
31294 Envelope sender addresses can be modified by Exim using two different
31295 facilities: the &%errors_to%& option on a router (as shown in previous mailing
31296 list examples), or the &%return_path%& option on a transport. The second of
31297 these is effective only if the message is successfully delivered to another
31298 host; it is not used for errors detected on the local host (see the description
31299 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
31300 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
31306 ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
31307 {$1-request+$local_part=$domain@your.dom.example}fail}
31309 This has the effect of rewriting the return path (envelope sender) on outgoing
31310 SMTP messages, if the local part of the original return path ends in
31311 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
31312 local part and domain of the recipient into the return path. Suppose, for
31313 example, that a message whose return path has been set to
31314 &'somelist-request@your.dom.example'& is sent to
31315 &'subscriber@other.dom.example'&. In the transport, the return path is
31318 somelist-request+subscriber=other.dom.example@your.dom.example
31320 .vindex "&$local_part$&"
31321 For this to work, you must tell Exim to send multiple copies of messages that
31322 have more than one recipient, so that each copy has just one recipient. This is
31323 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
31324 might be sent to several different recipients in the same domain, in which case
31325 &$local_part$& is not available in the transport, because it is not unique.
31327 Unless your host is doing nothing but mailing list deliveries, you should
31328 probably use a separate transport for the VERP deliveries, so as not to use
31329 extra resources in making one-per-recipient copies for other deliveries. This
31330 can easily be done by expanding the &%transport%& option in the router:
31334 domains = ! +local_domains
31336 ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
31337 {verp_smtp}{remote_smtp}}
31340 If you want to change the return path using &%errors_to%& in a router instead
31341 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
31342 routers that handle mailing list addresses. This will ensure that all delivery
31343 errors, including those detected on the local host, are sent to the VERP
31346 On a host that does no local deliveries and has no manual routing, only the
31347 &(dnslookup)& router needs to be changed. A special transport is not needed for
31348 SMTP deliveries. Every mailing list recipient has its own return path value,
31349 and so Exim must hand them to the transport one at a time. Here is an example
31350 of a &(dnslookup)& router that implements VERP:
31354 domains = ! +local_domains
31355 transport = remote_smtp
31357 ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
31358 {$1-request+$local_part=$domain@your.dom.example}fail}
31361 Before you start sending out messages with VERPed return paths, you must also
31362 configure Exim to accept the bounce messages that come back to those paths.
31363 Typically this is done by setting a &%local_part_suffix%& option for a
31364 router, and using this to route the messages to wherever you want to handle
31367 The overhead incurred in using VERP depends very much on the size of the
31368 message, the number of recipient addresses that resolve to the same remote
31369 host, and the speed of the connection over which the message is being sent. If
31370 a lot of addresses resolve to the same host and the connection is slow, sending
31371 a separate copy of the message for each address may take substantially longer
31372 than sending a single copy with many recipients (for which VERP cannot be
31380 .section "Virtual domains" "SECTvirtualdomains"
31381 .cindex "virtual domains"
31382 .cindex "domain" "virtual"
31383 The phrase &'virtual domain'& is unfortunately used with two rather different
31387 A domain for which there are no real mailboxes; all valid local parts are
31388 aliases for other email addresses. Common examples are organizational
31389 top-level domains and &"vanity"& domains.
31391 One of a number of independent domains that are all handled by the same host,
31392 with mailboxes on that host, but where the mailbox owners do not necessarily
31393 have login accounts on that host.
31396 The first usage is probably more common, and does seem more &"virtual"& than
31397 the second. This kind of domain can be handled in Exim with a straightforward
31398 aliasing router. One approach is to create a separate alias file for each
31399 virtual domain. Exim can test for the existence of the alias file to determine
31400 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
31401 to a router of this form:
31405 domains = dsearch;/etc/mail/virtual
31406 data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
31409 The &%domains%& option specifies that the router is to be skipped, unless there
31410 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
31411 domain that is being processed. When the router runs, it looks up the local
31412 part in the file to find a new address (or list of addresses). The &%no_more%&
31413 setting ensures that if the lookup fails (leading to &%data%& being an empty
31414 string), Exim gives up on the address without trying any subsequent routers.
31416 This one router can handle all the virtual domains because the alias file names
31417 follow a fixed pattern. Permissions can be arranged so that appropriate people
31418 can edit the different alias files. A successful aliasing operation results in
31419 a new envelope recipient address, which is then routed from scratch.
31421 The other kind of &"virtual"& domain can also be handled in a straightforward
31422 way. One approach is to create a file for each domain containing a list of
31423 valid local parts, and use it in a router like this:
31427 domains = dsearch;/etc/mail/domains
31428 local_parts = lsearch;/etc/mail/domains/$domain
31429 transport = my_mailboxes
31431 The address is accepted if there is a file for the domain, and the local part
31432 can be found in the file. The &%domains%& option is used to check for the
31433 file's existence because &%domains%& is tested before the &%local_parts%&
31434 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
31435 because that option is tested after &%local_parts%&. The transport is as
31439 driver = appendfile
31440 file = /var/mail/$domain/$local_part
31443 This uses a directory of mailboxes for each domain. The &%user%& setting is
31444 required, to specify which uid is to be used for writing to the mailboxes.
31446 The configuration shown here is just one example of how you might support this
31447 requirement. There are many other ways this kind of configuration can be set
31448 up, for example, by using a database instead of separate files to hold all the
31449 information about the domains.
31453 .section "Multiple user mailboxes" "SECTmulbox"
31454 .cindex "multiple mailboxes"
31455 .cindex "mailbox" "multiple"
31456 .cindex "local part" "prefix"
31457 .cindex "local part" "suffix"
31458 Heavy email users often want to operate with multiple mailboxes, into which
31459 incoming mail is automatically sorted. A popular way of handling this is to
31460 allow users to use multiple sender addresses, so that replies can easily be
31461 identified. Users are permitted to add prefixes or suffixes to their local
31462 parts for this purpose. The wildcard facility of the generic router options
31463 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
31464 example, consider this router:
31469 file = $home/.forward
31470 local_part_suffix = -*
31471 local_part_suffix_optional
31474 .vindex "&$local_part_suffix$&"
31475 It runs a user's &_.forward_& file for all local parts of the form
31476 &'username-*'&. Within the filter file the user can distinguish different
31477 cases by testing the variable &$local_part_suffix$&. For example:
31479 if $local_part_suffix contains -special then
31480 save /home/$local_part/Mail/special
31483 If the filter file does not exist, or does not deal with such addresses, they
31484 fall through to subsequent routers, and, assuming no subsequent use of the
31485 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
31486 control over which suffixes are valid.
31488 Alternatively, a suffix can be used to trigger the use of a different
31489 &_.forward_& file &-- which is the way a similar facility is implemented in
31495 file = $home/.forward$local_part_suffix
31496 local_part_suffix = -*
31497 local_part_suffix_optional
31500 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
31501 example, &_.forward-special_& is used. Once again, if the appropriate file
31502 does not exist, or does not deal with the address, it is passed on to
31503 subsequent routers, which could, if required, look for an unqualified
31504 &_.forward_& file to use as a default.
31508 .section "Simplified vacation processing" "SECID244"
31509 .cindex "vacation processing"
31510 The traditional way of running the &'vacation'& program is for a user to set up
31511 a pipe command in a &_.forward_& file
31512 (see section &<<SECTspecitredli>>& for syntax details).
31513 This is prone to error by inexperienced users. There are two features of Exim
31514 that can be used to make this process simpler for users:
31517 A local part prefix such as &"vacation-"& can be specified on a router which
31518 can cause the message to be delivered directly to the &'vacation'& program, or
31519 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
31520 &_.forward_& file are then much simpler. For example:
31522 spqr, vacation-spqr
31525 The &%require_files%& generic router option can be used to trigger a
31526 vacation delivery by checking for the existence of a certain file in the
31527 user's home directory. The &%unseen%& generic option should also be used, to
31528 ensure that the original delivery also proceeds. In this case, all the user has
31529 to do is to create a file called, say, &_.vacation_&, containing a vacation
31533 Another advantage of both these methods is that they both work even when the
31534 use of arbitrary pipes by users is locked out.
31538 .section "Taking copies of mail" "SECID245"
31539 .cindex "message" "copying every"
31540 Some installations have policies that require archive copies of all messages to
31541 be made. A single copy of each message can easily be taken by an appropriate
31542 command in a system filter, which could, for example, use a different file for
31543 each day's messages.
31545 There is also a shadow transport mechanism that can be used to take copies of
31546 messages that are successfully delivered by local transports, one copy per
31547 delivery. This could be used, &'inter alia'&, to implement automatic
31548 notification of delivery by sites that insist on doing such things.
31552 .section "Intermittently connected hosts" "SECID246"
31553 .cindex "intermittently connected hosts"
31554 It has become quite common (because it is cheaper) for hosts to connect to the
31555 Internet periodically rather than remain connected all the time. The normal
31556 arrangement is that mail for such hosts accumulates on a system that is
31557 permanently connected.
31559 Exim was designed for use on permanently connected hosts, and so it is not
31560 particularly well-suited to use in an intermittently connected environment.
31561 Nevertheless there are some features that can be used.
31564 .section "Exim on the upstream server host" "SECID247"
31565 It is tempting to arrange for incoming mail for the intermittently connected
31566 host to remain on Exim's queue until the client connects. However, this
31567 approach does not scale very well. Two different kinds of waiting message are
31568 being mixed up in the same queue &-- those that cannot be delivered because of
31569 some temporary problem, and those that are waiting for their destination host
31570 to connect. This makes it hard to manage the queue, as well as wasting
31571 resources, because each queue runner scans the entire queue.
31573 A better approach is to separate off those messages that are waiting for an
31574 intermittently connected host. This can be done by delivering these messages
31575 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
31576 format, from where they are transmitted by other software when their
31577 destination connects. This makes it easy to collect all the mail for one host
31578 in a single directory, and to apply local timeout rules on a per-message basis
31581 On a very small scale, leaving the mail on Exim's queue can be made to work. If
31582 you are doing this, you should configure Exim with a long retry period for the
31583 intermittent host. For example:
31585 cheshire.wonderland.fict.example * F,5d,24h
31587 This stops a lot of failed delivery attempts from occurring, but Exim remembers
31588 which messages it has queued up for that host. Once the intermittent host comes
31589 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
31590 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
31591 causes all the queued up messages to be delivered, often down a single SMTP
31592 connection. While the host remains connected, any new messages get delivered
31595 If the connecting hosts do not have fixed IP addresses, that is, if a host is
31596 issued with a different IP address each time it connects, Exim's retry
31597 mechanisms on the holding host get confused, because the IP address is normally
31598 used as part of the key string for holding retry information. This can be
31599 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
31600 Since this has disadvantages for permanently connected hosts, it is best to
31601 arrange a separate transport for the intermittently connected ones.
31605 .section "Exim on the intermittently connected client host" "SECID248"
31606 The value of &%smtp_accept_queue_per_connection%& should probably be
31607 increased, or even set to zero (that is, disabled) on the intermittently
31608 connected host, so that all incoming messages down a single connection get
31609 delivered immediately.
31611 .cindex "SMTP" "passed connection"
31612 .cindex "SMTP" "multiple deliveries"
31613 .cindex "multiple SMTP deliveries"
31614 Mail waiting to be sent from an intermittently connected host will probably
31615 not have been routed, because without a connection DNS lookups are not
31616 possible. This means that if a normal queue run is done at connection time,
31617 each message is likely to be sent in a separate SMTP session. This can be
31618 avoided by starting the queue run with a command line option beginning with
31619 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
31620 first pass, routing is done but no deliveries take place. The second pass is a
31621 normal queue run; since all the messages have been previously routed, those
31622 destined for the same host are likely to get sent as multiple deliveries in a
31623 single SMTP connection.
31627 . ////////////////////////////////////////////////////////////////////////////
31628 . ////////////////////////////////////////////////////////////////////////////
31630 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
31631 "Exim as a non-queueing client"
31632 .cindex "client, non-queueing"
31633 .cindex "smart host" "suppressing queueing"
31634 On a personal computer, it is a common requirement for all
31635 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
31636 configured to operate that way, for all the popular operating systems.
31637 However, there are some MUAs for Unix-like systems that cannot be so
31638 configured: they submit messages using the command line interface of
31639 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
31642 If the personal computer runs continuously, there is no problem, because it can
31643 run a conventional MTA that handles delivery to the smart host, and deal with
31644 any delays via its queueing mechanism. However, if the computer does not run
31645 continuously or runs different operating systems at different times, queueing
31646 email is not desirable.
31648 There is therefore a requirement for something that can provide the
31649 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
31650 any queueing or retrying facilities. Furthermore, the delivery to the smart
31651 host should be synchronous, so that if it fails, the sending MUA is immediately
31652 informed. In other words, we want something that extends an MUA that submits
31653 to a local MTA via the command line so that it behaves like one that submits
31654 to a remote smart host using TCP/SMTP.
31656 There are a number of applications (for example, there is one called &'ssmtp'&)
31657 that do this job. However, people have found them to be lacking in various
31658 ways. For instance, you might want to allow aliasing and forwarding to be done
31659 before sending a message to the smart host.
31661 Exim already had the necessary infrastructure for doing this job. Just a few
31662 tweaks were needed to make it behave as required, though it is somewhat of an
31663 overkill to use a fully-featured MTA for this purpose.
31665 .oindex "&%mua_wrapper%&"
31666 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
31667 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
31668 assumes that it is being used to &"wrap"& a command-line MUA in the manner
31669 just described. As well as setting &%mua_wrapper%&, you also need to provide a
31670 compatible router and transport configuration. Typically there will be just one
31671 router and one transport, sending everything to a smart host.
31673 When run in MUA wrapping mode, the behaviour of Exim changes in the
31677 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
31678 In other words, the only way to submit messages is via the command line.
31680 Each message is synchronously delivered as soon as it is received (&%-odi%& is
31681 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
31682 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
31683 does not finish until the delivery attempt is complete. If the delivery is
31684 successful, a zero return code is given.
31686 Address redirection is permitted, but the final routing for all addresses must
31687 be to the same remote transport, and to the same list of hosts. Furthermore,
31688 the return address (envelope sender) must be the same for all recipients, as
31689 must any added or deleted header lines. In other words, it must be possible to
31690 deliver the message in a single SMTP transaction, however many recipients there
31693 If these conditions are not met, or if routing any address results in a
31694 failure or defer status, or if Exim is unable to deliver all the recipients
31695 successfully to one of the smart hosts, delivery of the entire message fails.
31697 Because no queueing is allowed, all failures are treated as permanent; there
31698 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
31699 smart host. Furthermore, because only a single yes/no response can be given to
31700 the caller, it is not possible to deliver to some recipients and not others. If
31701 there is an error (temporary or permanent) for any recipient, all are failed.
31703 If more than one smart host is listed, Exim will try another host after a
31704 connection failure or a timeout, in the normal way. However, if this kind of
31705 failure happens for all the hosts, the delivery fails.
31707 When delivery fails, an error message is written to the standard error stream
31708 (as well as to Exim's log), and Exim exits to the caller with a return code
31709 value 1. The message is expunged from Exim's spool files. No bounce messages
31710 are ever generated.
31712 No retry data is maintained, and any retry rules are ignored.
31714 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
31715 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
31716 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
31719 The overall effect is that Exim makes a single synchronous attempt to deliver
31720 the message, failing if there is any kind of problem. Because no local
31721 deliveries are done and no daemon can be run, Exim does not need root
31722 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
31723 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
31724 the advantages and disadvantages of running without root privilege.
31729 . ////////////////////////////////////////////////////////////////////////////
31730 . ////////////////////////////////////////////////////////////////////////////
31732 .chapter "Log files" "CHAPlog"
31733 .scindex IIDloggen "log" "general description"
31734 .cindex "log" "types of"
31735 Exim writes three different logs, referred to as the main log, the reject log,
31740 The main log records the arrival of each message and each delivery in a single
31741 line in each case. The format is as compact as possible, in an attempt to keep
31742 down the size of log files. Two-character flag sequences make it easy to pick
31743 out these lines. A number of other events are recorded in the main log. Some of
31744 them are optional, in which case the &%log_selector%& option controls whether
31745 they are included or not. A Perl script called &'eximstats'&, which does simple
31746 analysis of main log files, is provided in the Exim distribution (see section
31747 &<<SECTmailstat>>&).
31749 .cindex "reject log"
31750 The reject log records information from messages that are rejected as a result
31751 of a configuration option (that is, for policy reasons).
31752 The first line of each rejection is a copy of the line that is also written to
31753 the main log. Then, if the message's header has been read at the time the log
31754 is written, its contents are written to this log. Only the original header
31755 lines are available; header lines added by ACLs are not logged. You can use the
31756 reject log to check that your policy controls are working correctly; on a busy
31757 host this may be easier than scanning the main log for rejection messages. You
31758 can suppress the writing of the reject log by setting &%write_rejectlog%&
31761 .cindex "panic log"
31762 .cindex "system log"
31763 When certain serious errors occur, Exim writes entries to its panic log. If the
31764 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
31765 are usually written to the main log as well, but can get lost amid the mass of
31766 other entries. The panic log should be empty under normal circumstances. It is
31767 therefore a good idea to check it (or to have a &'cron'& script check it)
31768 regularly, in order to become aware of any problems. When Exim cannot open its
31769 panic log, it tries as a last resort to write to the system log (syslog). This
31770 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
31771 message itself is written at priority LOG_CRIT.
31774 Every log line starts with a timestamp, in the format shown in the following
31775 example. Note that many of the examples shown in this chapter are line-wrapped.
31776 In the log file, this would be all on one line:
31778 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
31781 By default, the timestamps are in the local timezone. There are two
31782 ways of changing this:
31785 You can set the &%timezone%& option to a different time zone; in particular, if
31790 the timestamps will be in UTC (aka GMT).
31792 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
31795 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
31799 .cindex "log" "process ids in"
31800 .cindex "pid (process id)" "in log lines"
31801 Exim does not include its process id in log lines by default, but you can
31802 request that it does so by specifying the &`pid`& log selector (see section
31803 &<<SECTlogselector>>&). When this is set, the process id is output, in square
31804 brackets, immediately after the time and date.
31809 .section "Where the logs are written" "SECTwhelogwri"
31810 .cindex "log" "destination"
31811 .cindex "log" "to file"
31812 .cindex "log" "to syslog"
31814 The logs may be written to local files, or to syslog, or both. However, it
31815 should be noted that many syslog implementations use UDP as a transport, and
31816 are therefore unreliable in the sense that messages are not guaranteed to
31817 arrive at the loghost, nor is the ordering of messages necessarily maintained.
31818 It has also been reported that on large log files (tens of megabytes) you may
31819 need to tweak syslog to prevent it syncing the file with each write &-- on
31820 Linux this has been seen to make syslog take 90% plus of CPU time.
31822 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
31823 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
31824 configuration. This latter string is expanded, so it can contain, for example,
31825 references to the host name:
31827 log_file_path = /var/log/$primary_hostname/exim_%slog
31829 It is generally advisable, however, to set the string in &_Local/Makefile_&
31830 rather than at run time, because then the setting is available right from the
31831 start of Exim's execution. Otherwise, if there's something it wants to log
31832 before it has read the configuration file (for example, an error in the
31833 configuration file) it will not use the path you want, and may not be able to
31836 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
31837 list, currently limited to at most two items. This is one option where the
31838 facility for changing a list separator may not be used. The list must always be
31839 colon-separated. If an item in the list is &"syslog"& then syslog is used;
31840 otherwise the item must either be an absolute path, containing &`%s`& at the
31841 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
31842 implying the use of a default path.
31844 When Exim encounters an empty item in the list, it searches the list defined by
31845 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
31846 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
31847 mean &"use the path specified at build time"&. It no such item exists, log
31848 files are written in the &_log_& subdirectory of the spool directory. This is
31849 equivalent to the setting:
31851 log_file_path = $spool_directory/log/%slog
31853 If you do not specify anything at build time or run time, that is where the
31856 A log file path may also contain &`%D`& if datestamped log file names are in
31857 use &-- see section &<<SECTdatlogfil>>& below.
31859 Here are some examples of possible settings:
31861 &`LOG_FILE_PATH=syslog `& syslog only
31862 &`LOG_FILE_PATH=:syslog `& syslog and default path
31863 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
31864 &`LOG_FILE_PATH=/usr/log/exim_%s `& specified path only
31866 If there are more than two paths in the list, the first is used and a panic
31871 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
31872 .cindex "log" "cycling local files"
31873 .cindex "cycling logs"
31874 .cindex "&'exicyclog'&"
31875 .cindex "log" "local files; writing to"
31876 Some operating systems provide centralized and standardized methods for cycling
31877 log files. For those that do not, a utility script called &'exicyclog'& is
31878 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
31879 main and reject logs each time it is called. The maximum number of old logs to
31880 keep can be set. It is suggested this script is run as a daily &'cron'& job.
31882 An Exim delivery process opens the main log when it first needs to write to it,
31883 and it keeps the file open in case subsequent entries are required &-- for
31884 example, if a number of different deliveries are being done for the same
31885 message. However, remote SMTP deliveries can take a long time, and this means
31886 that the file may be kept open long after it is renamed if &'exicyclog'& or
31887 something similar is being used to rename log files on a regular basis. To
31888 ensure that a switch of log files is noticed as soon as possible, Exim calls
31889 &[stat()]& on the main log's name before reusing an open file, and if the file
31890 does not exist, or its inode has changed, the old file is closed and Exim
31891 tries to open the main log from scratch. Thus, an old log file may remain open
31892 for quite some time, but no Exim processes should write to it once it has been
31897 .section "Datestamped log files" "SECTdatlogfil"
31898 .cindex "log" "datestamped files"
31899 Instead of cycling the main and reject log files by renaming them
31900 periodically, some sites like to use files whose names contain a datestamp,
31901 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_&.
31902 Exim has support for this way of working. It is enabled by setting the
31903 &%log_file_path%& option to a path that includes &`%D`& at the point where the
31904 datestamp is required. For example:
31906 log_file_path = /var/spool/exim/log/%slog-%D
31907 log_file_path = /var/log/exim-%s-%D.log
31908 log_file_path = /var/spool/exim/log/%D-%slog
31910 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
31911 examples of names generated by the above examples:
31913 /var/spool/exim/log/mainlog-20021225
31914 /var/log/exim-reject-20021225.log
31915 /var/spool/exim/log/20021225-mainlog
31917 When this form of log file is specified, Exim automatically switches to new
31918 files at midnight. It does not make any attempt to compress old logs; you
31919 will need to write your own script if you require this. You should not
31920 run &'exicyclog'& with this form of logging.
31922 The location of the panic log is also determined by &%log_file_path%&, but it
31923 is not datestamped, because rotation of the panic log does not make sense.
31924 When generating the name of the panic log, &`%D`& is removed from the string.
31925 In addition, if it immediately follows a slash, a following non-alphanumeric
31926 character is removed; otherwise a preceding non-alphanumeric character is
31927 removed. Thus, the three examples above would give these panic log names:
31929 /var/spool/exim/log/paniclog
31930 /var/log/exim-panic.log
31931 /var/spool/exim/log/paniclog
31935 .section "Logging to syslog" "SECID249"
31936 .cindex "log" "syslog; writing to"
31937 The use of syslog does not change what Exim logs or the format of its messages,
31938 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
31939 Exim's log lines are omitted when these lines are sent to syslog. Apart from
31940 that, the same strings are written to syslog as to log files. The syslog
31941 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
31942 by default, but you can change these by setting the &%syslog_facility%& and
31943 &%syslog_processname%& options, respectively. If Exim was compiled with
31944 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
31945 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
31946 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
31947 the time and host name to each line.
31948 The three log streams are mapped onto syslog priorities as follows:
31951 &'mainlog'& is mapped to LOG_INFO
31953 &'rejectlog'& is mapped to LOG_NOTICE
31955 &'paniclog'& is mapped to LOG_ALERT
31958 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
31959 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
31960 these are routed by syslog to the same place. You can suppress this duplication
31961 by setting &%syslog_duplication%& false.
31963 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
31964 entries contain multiple lines when headers are included. To cope with both
31965 these cases, entries written to syslog are split into separate &[syslog()]&
31966 calls at each internal newline, and also after a maximum of
31967 870 data characters. (This allows for a total syslog line length of 1024, when
31968 additions such as timestamps are added.) If you are running a syslog
31969 replacement that can handle lines longer than the 1024 characters allowed by
31970 RFC 3164, you should set
31972 SYSLOG_LONG_LINES=yes
31974 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
31975 lines, but it still splits at internal newlines in &'reject'& log entries.
31977 To make it easy to re-assemble split lines later, each component of a split
31978 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
31979 where <&'n'&> is the component number and <&'m'&> is the total number of
31980 components in the entry. The / delimiter is used when the line was split
31981 because it was too long; if it was split because of an internal newline, the \
31982 delimiter is used. For example, supposing the length limit to be 50 instead of
31983 870, the following would be the result of a typical rejection message to
31984 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
31985 name, and pid as added by syslog:
31987 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
31988 [2/5] [127.0.0.1] (ph10): syntax error in 'From' header
31989 [3/5] when scanning for sender: missing or malformed lo
31990 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
31993 The same error might cause the following lines to be written to &"rejectlog"&
31996 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
31997 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
31998 [3/18] er when scanning for sender: missing or malformed
31999 [4/18] local part in "<>" (envelope sender is <ph10@cam
32001 [6\18] Recipients: ph10@some.domain.cam.example
32002 [7\18] P Received: from [127.0.0.1] (ident=ph10)
32003 [8\18] by xxxxx.cam.example with smtp (Exim 4.00)
32004 [9\18] id 16RdAL-0006pc-00
32005 [10/18] for ph10@cam.example; Mon, 16 Sep 2002 16:
32006 [11\18] 09:43 +0100
32008 [13\18] Subject: this is a test header
32009 [18\18] X-something: this is another header
32010 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
32013 [18/18] Date: Mon, 16 Sep 2002 16:09:43 +0100
32015 Log lines that are neither too long nor contain newlines are written to syslog
32016 without modification.
32018 If only syslog is being used, the Exim monitor is unable to provide a log tail
32019 display, unless syslog is routing &'mainlog'& to a file on the local host and
32020 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
32025 .section "Log line flags" "SECID250"
32026 One line is written to the main log for each message received, and for each
32027 successful, unsuccessful, and delayed delivery. These lines can readily be
32028 picked out by the distinctive two-character flags that immediately follow the
32029 timestamp. The flags are:
32031 &`<=`& message arrival
32032 &`=>`& normal message delivery
32033 &`->`& additional address in same delivery
32034 &`*>`& delivery suppressed by &%-N%&
32035 &`**`& delivery failed; address bounced
32036 &`==`& delivery deferred; temporary problem
32040 .section "Logging message reception" "SECID251"
32041 .cindex "log" "reception line"
32042 The format of the single-line entry in the main log that is written for every
32043 message received is shown in the basic example below, which is split over
32044 several lines in order to fit it on the page:
32046 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
32047 H=mailer.fict.example [192.168.123.123] U=exim
32048 P=smtp S=5678 id=<incoming message id>
32050 The address immediately following &"<="& is the envelope sender address. A
32051 bounce message is shown with the sender address &"<>"&, and if it is locally
32052 generated, this is followed by an item of the form
32056 which is a reference to the message that caused the bounce to be sent.
32060 For messages from other hosts, the H and U fields identify the remote host and
32061 record the RFC 1413 identity of the user that sent the message, if one was
32062 received. The number given in square brackets is the IP address of the sending
32063 host. If there is a single, unparenthesized host name in the H field, as
32064 above, it has been verified to correspond to the IP address (see the
32065 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
32066 by the remote host in the SMTP HELO or EHLO command, and has not been
32067 verified. If verification yields a different name to that given for HELO or
32068 EHLO, the verified name appears first, followed by the HELO or EHLO
32069 name in parentheses.
32071 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
32072 without brackets, in the HELO or EHLO command, leading to entries in
32073 the log containing text like these examples:
32075 H=(10.21.32.43) [192.168.8.34]
32076 H=([10.21.32.43]) [192.168.8.34]
32078 This can be confusing. Only the final address in square brackets can be relied
32081 For locally generated messages (that is, messages not received over TCP/IP),
32082 the H field is omitted, and the U field contains the login name of the caller
32085 .cindex "authentication" "logging"
32086 .cindex "AUTH" "logging"
32087 For all messages, the P field specifies the protocol used to receive the
32088 message. This is the value that is stored in &$received_protocol$&. In the case
32089 of incoming SMTP messages, the value indicates whether or not any SMTP
32090 extensions (ESMTP), encryption, or authentication were used. If the SMTP
32091 session was encrypted, there is an additional X field that records the cipher
32092 suite that was used.
32094 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
32095 hosts that have authenticated themselves using the SMTP AUTH command. The first
32096 value is used when the SMTP connection was encrypted (&"secure"&). In this case
32097 there is an additional item A= followed by the name of the authenticator that
32098 was used. If an authenticated identification was set up by the authenticator's
32099 &%server_set_id%& option, this is logged too, separated by a colon from the
32100 authenticator name.
32102 .cindex "size" "of message"
32103 The id field records the existing message id, if present. The size of the
32104 received message is given by the S field. When the message is delivered,
32105 headers may be removed or added, so that the size of delivered copies of the
32106 message may not correspond with this value (and indeed may be different to each
32109 The &%log_selector%& option can be used to request the logging of additional
32110 data when a message is received. See section &<<SECTlogselector>>& below.
32114 .section "Logging deliveries" "SECID252"
32115 .cindex "log" "delivery line"
32116 The format of the single-line entry in the main log that is written for every
32117 delivery is shown in one of the examples below, for local and remote
32118 deliveries, respectively. Each example has been split into two lines in order
32119 to fit it on the page:
32121 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
32122 <marv@hitch.fict.example> R=localuser T=local_delivery
32123 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
32124 monk@holistic.fict.example R=dnslookup T=remote_smtp
32125 H=holistic.fict.example [192.168.234.234]
32127 For ordinary local deliveries, the original address is given in angle brackets
32128 after the final delivery address, which might be a pipe or a file. If
32129 intermediate address(es) exist between the original and the final address, the
32130 last of these is given in parentheses after the final address. The R and T
32131 fields record the router and transport that were used to process the address.
32133 If a shadow transport was run after a successful local delivery, the log line
32134 for the successful delivery has an item added on the end, of the form
32136 &`ST=<`&&'shadow transport name'&&`>`&
32138 If the shadow transport did not succeed, the error message is put in
32139 parentheses afterwards.
32141 .cindex "asterisk" "after IP address"
32142 When more than one address is included in a single delivery (for example, two
32143 SMTP RCPT commands in one transaction) the second and subsequent addresses are
32144 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
32145 down a single SMTP connection, an asterisk follows the IP address in the log
32146 lines for the second and subsequent messages.
32148 The generation of a reply message by a filter file gets logged as a
32149 &"delivery"& to the addressee, preceded by &">"&.
32151 The &%log_selector%& option can be used to request the logging of additional
32152 data when a message is delivered. See section &<<SECTlogselector>>& below.
32155 .section "Discarded deliveries" "SECID253"
32156 .cindex "discarded messages"
32157 .cindex "message" "discarded"
32158 .cindex "delivery" "discarded; logging"
32159 When a message is discarded as a result of the command &"seen finish"& being
32160 obeyed in a filter file which generates no deliveries, a log entry of the form
32162 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
32163 <low.club@bridge.example> R=userforward
32165 is written, to record why no deliveries are logged. When a message is discarded
32166 because it is aliased to &":blackhole:"& the log line is like this:
32168 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
32169 <hole@nowhere.example> R=blackhole_router
32173 .section "Deferred deliveries" "SECID254"
32174 When a delivery is deferred, a line of the following form is logged:
32176 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
32177 R=dnslookup T=smtp defer (146): Connection refused
32179 In the case of remote deliveries, the error is the one that was given for the
32180 last IP address that was tried. Details of individual SMTP failures are also
32181 written to the log, so the above line would be preceded by something like
32183 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
32184 mail1.endrest.example [192.168.239.239]: Connection refused
32186 When a deferred address is skipped because its retry time has not been reached,
32187 a message is written to the log, but this can be suppressed by setting an
32188 appropriate value in &%log_selector%&.
32192 .section "Delivery failures" "SECID255"
32193 .cindex "delivery" "failure; logging"
32194 If a delivery fails because an address cannot be routed, a line of the
32195 following form is logged:
32197 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
32198 <jim@trek99.example>: unknown mail domain
32200 If a delivery fails at transport time, the router and transport are shown, and
32201 the response from the remote host is included, as in this example:
32203 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
32204 R=dnslookup T=remote_smtp: SMTP error from remote mailer
32205 after pipelined RCPT TO:<ace400@pb.example>: host
32206 pbmail3.py.example [192.168.63.111]: 553 5.3.0
32207 <ace400@pb.example>...Addressee unknown
32209 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
32210 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
32211 disabling PIPELINING. The log lines for all forms of delivery failure are
32212 flagged with &`**`&.
32216 .section "Fake deliveries" "SECID256"
32217 .cindex "delivery" "fake; logging"
32218 If a delivery does not actually take place because the &%-N%& option has been
32219 used to suppress it, a normal delivery line is written to the log, except that
32220 &"=>"& is replaced by &"*>"&.
32224 .section "Completion" "SECID257"
32227 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
32229 is written to the main log when a message is about to be removed from the spool
32230 at the end of its processing.
32235 .section "Summary of Fields in Log Lines" "SECID258"
32236 .cindex "log" "summary of fields"
32237 A summary of the field identifiers that are used in log lines is shown in
32238 the following table:
32240 &`A `& authenticator name (and optional id)
32241 &`C `& SMTP confirmation on delivery
32242 &` `& command list for &"no mail in SMTP session"&
32243 &`CV `& certificate verification status
32244 &`D `& duration of &"no mail in SMTP session"&
32245 &`DN `& distinguished name from peer certificate
32246 &`DT `& on &`=>`& lines: time taken for a delivery
32247 &`F `& sender address (on delivery lines)
32248 &`H `& host name and IP address
32249 &`I `& local interface used
32250 &`id `& message id for incoming message
32251 &`P `& on &`<=`& lines: protocol used
32252 &` `& on &`=>`& and &`**`& lines: return path
32253 &`QT `& on &`=>`& lines: time spent on queue so far
32254 &` `& on &"Completed"& lines: time spent on queue
32255 &`R `& on &`<=`& lines: reference for local bounce
32256 &` `& on &`=>`& &`**`& and &`==`& lines: router name
32257 &`S `& size of message
32258 &`ST `& shadow transport name
32259 &`T `& on &`<=`& lines: message subject (topic)
32260 &` `& on &`=>`& &`**`& and &`==`& lines: transport name
32261 &`U `& local user or RFC 1413 identity
32262 &`X `& TLS cipher suite
32266 .section "Other log entries" "SECID259"
32267 Various other types of log entry are written from time to time. Most should be
32268 self-explanatory. Among the more common are:
32271 .cindex "retry" "time not reached"
32272 &'retry time not reached'&&~&~An address previously suffered a temporary error
32273 during routing or local delivery, and the time to retry has not yet arrived.
32274 This message is not written to an individual message log file unless it happens
32275 during the first delivery attempt.
32277 &'retry time not reached for any host'&&~&~An address previously suffered
32278 temporary errors during remote delivery, and the retry time has not yet arrived
32279 for any of the hosts to which it is routed.
32281 .cindex "spool directory" "file locked"
32282 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
32283 some other Exim process is already working on the message. This can be quite
32284 common if queue running processes are started at frequent intervals. The
32285 &'exiwhat'& utility script can be used to find out what Exim processes are
32288 .cindex "error" "ignored"
32289 &'error ignored'&&~&~There are several circumstances that give rise to this
32292 Exim failed to deliver a bounce message whose age was greater than
32293 &%ignore_bounce_errors_after%&. The bounce was discarded.
32295 A filter file set up a delivery using the &"noerror"& option, and the delivery
32296 failed. The delivery was discarded.
32298 A delivery set up by a router configured with
32299 . ==== As this is a nested list, any displays it contains must be indented
32300 . ==== as otherwise they are too far to the left.
32304 failed. The delivery was discarded.
32312 .section "Reducing or increasing what is logged" "SECTlogselector"
32313 .cindex "log" "selectors"
32314 By setting the &%log_selector%& global option, you can disable some of Exim's
32315 default logging, or you can request additional logging. The value of
32316 &%log_selector%& is made up of names preceded by plus or minus characters. For
32319 log_selector = +arguments -retry_defer
32321 The list of optional log items is in the following table, with the default
32322 selection marked by asterisks:
32324 &`*acl_warn_skipped `& skipped &%warn%& statement in ACL
32325 &` address_rewrite `& address rewriting
32326 &` all_parents `& all parents in => lines
32327 &` arguments `& command line arguments
32328 &`*connection_reject `& connection rejections
32329 &`*delay_delivery `& immediate delivery delayed
32330 &` deliver_time `& time taken to perform delivery
32331 &` delivery_size `& add &`S=`&&'nnn'& to => lines
32332 &`*dnslist_defer `& defers of DNS list (aka RBL) lookups
32333 &`*etrn `& ETRN commands
32334 &`*host_lookup_failed `& as it says
32335 &` ident_timeout `& timeout for ident connection
32336 &` incoming_interface `& incoming interface on <= lines
32337 &` incoming_port `& incoming port on <= lines
32338 &`*lost_incoming_connection `& as it says (includes timeouts)
32339 &` outgoing_port `& add remote port to => lines
32340 &`*queue_run `& start and end queue runs
32341 &` queue_time `& time on queue for one recipient
32342 &` queue_time_overall `& time on queue for whole message
32343 &` pid `& Exim process id
32344 &` received_recipients `& recipients on <= lines
32345 &` received_sender `& sender on <= lines
32346 &`*rejected_header `& header contents on reject log
32347 &`*retry_defer `& &"retry time not reached"&
32348 &` return_path_on_delivery `& put return path on => and ** lines
32349 &` sender_on_delivery `& add sender to => lines
32350 &`*sender_verify_fail `& sender verification failures
32351 &`*size_reject `& rejection because too big
32352 &`*skip_delivery `& delivery skipped in a queue run
32353 &` smtp_confirmation `& SMTP confirmation on => lines
32354 &` smtp_connection `& SMTP connections
32355 &` smtp_incomplete_transaction`& incomplete SMTP transactions
32356 &` smtp_no_mail `& session with no MAIL commands
32357 &` smtp_protocol_error `& SMTP protocol errors
32358 &` smtp_syntax_error `& SMTP syntax errors
32359 &` subject `& contents of &'Subject:'& on <= lines
32360 &` tls_certificate_verified `& certificate verification status
32361 &`*tls_cipher `& TLS cipher suite on <= and => lines
32362 &` tls_peerdn `& TLS peer DN on <= and => lines
32363 &` unknown_in_list `& DNS lookup failed in list match
32365 &` all `& all of the above
32367 More details on each of these items follows:
32370 .cindex "&%warn%& ACL verb" "log when skipping"
32371 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
32372 its conditions cannot be evaluated, a log line to this effect is written if
32373 this log selector is set.
32375 .cindex "log" "rewriting"
32376 .cindex "rewriting" "logging"
32377 &%address_rewrite%&: This applies both to global rewrites and per-transport
32378 rewrites, but not to rewrites in filters run as an unprivileged user (because
32379 such users cannot access the log).
32381 .cindex "log" "full parentage"
32382 &%all_parents%&: Normally only the original and final addresses are logged on
32383 delivery lines; with this selector, intermediate parents are given in
32384 parentheses between them.
32386 .cindex "log" "Exim arguments"
32387 .cindex "Exim arguments, logging"
32388 &%arguments%&: This causes Exim to write the arguments with which it was called
32389 to the main log, preceded by the current working directory. This is a debugging
32390 feature, added to make it easier to find out how certain MUAs call
32391 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
32392 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
32393 that are empty or that contain white space are quoted. Non-printing characters
32394 are shown as escape sequences. This facility cannot log unrecognized arguments,
32395 because the arguments are checked before the configuration file is read. The
32396 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
32397 between the caller and Exim.
32399 .cindex "log" "connection rejections"
32400 &%connection_reject%&: A log entry is written whenever an incoming SMTP
32401 connection is rejected, for whatever reason.
32403 .cindex "log" "delayed delivery"
32404 .cindex "delayed delivery, logging"
32405 &%delay_delivery%&: A log entry is written whenever a delivery process is not
32406 started for an incoming message because the load is too high or too many
32407 messages were received on one connection. Logging does not occur if no delivery
32408 process is started because &%queue_only%& is set or &%-odq%& was used.
32410 .cindex "log" "delivery duration"
32411 &%deliver_time%&: For each delivery, the amount of real time it has taken to
32412 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
32414 .cindex "log" "message size on delivery"
32415 .cindex "size" "of message"
32416 &%delivery_size%&: For each delivery, the size of message delivered is added to
32417 the &"=>"& line, tagged with S=.
32419 .cindex "log" "dnslist defer"
32420 .cindex "DNS list" "logging defer"
32421 .cindex "black list (DNS)"
32422 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
32423 DNS black list suffers a temporary error.
32425 .cindex "log" "ETRN commands"
32426 .cindex "ETRN" "logging"
32427 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
32428 is run to determine whether or not it is actually accepted. An invalid ETRN
32429 command, or one received within a message transaction is not logged by this
32430 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
32432 .cindex "log" "host lookup failure"
32433 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
32434 any addresses, or when a lookup of an IP address fails to find a host name, a
32435 log line is written. This logging does not apply to direct DNS lookups when
32436 routing email addresses, but it does apply to &"byname"& lookups.
32438 .cindex "log" "ident timeout"
32439 .cindex "RFC 1413" "logging timeout"
32440 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
32441 client's ident port times out.
32443 .cindex "log" "incoming interface"
32444 .cindex "interface" "logging"
32445 &%incoming_interface%&: The interface on which a message was received is added
32446 to the &"<="& line as an IP address in square brackets, tagged by I= and
32447 followed by a colon and the port number. The local interface and port are also
32448 added to other SMTP log lines, for example &"SMTP connection from"&, and to
32451 .cindex "log" "incoming remote port"
32452 .cindex "port" "logging remote"
32453 .cindex "TCP/IP" "logging incoming remote port"
32454 .vindex "&$sender_fullhost$&"
32455 .vindex "&$sender_rcvhost$&"
32456 &%incoming_port%&: The remote port number from which a message was received is
32457 added to log entries and &'Received:'& header lines, following the IP address
32458 in square brackets, and separated from it by a colon. This is implemented by
32459 changing the value that is put in the &$sender_fullhost$& and
32460 &$sender_rcvhost$& variables. Recording the remote port number has become more
32461 important with the widening use of NAT (see RFC 2505).
32463 .cindex "log" "dropped connection"
32464 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
32465 connection is unexpectedly dropped.
32467 .cindex "log" "outgoing remote port"
32468 .cindex "port" "logging outgoint remote"
32469 .cindex "TCP/IP" "logging ougtoing remote port"
32470 &%outgoing_port%&: The remote port number is added to delivery log lines (those
32471 containing => tags) following the IP address. This option is not included in
32472 the default setting, because for most ordinary configurations, the remote port
32473 number is always 25 (the SMTP port).
32475 .cindex "log" "process ids in"
32476 .cindex "pid (process id)" "in log lines"
32477 &%pid%&: The current process id is added to every log line, in square brackets,
32478 immediately after the time and date.
32480 .cindex "log" "queue run"
32481 .cindex "queue runner" "logging"
32482 &%queue_run%&: The start and end of every queue run are logged.
32484 .cindex "log" "queue time"
32485 &%queue_time%&: The amount of time the message has been in the queue on the
32486 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
32487 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
32488 includes reception time as well as the delivery time for the current address.
32489 This means that it may be longer than the difference between the arrival and
32490 delivery log line times, because the arrival log line is not written until the
32491 message has been successfully received.
32493 &%queue_time_overall%&: The amount of time the message has been in the queue on
32494 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
32495 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
32496 message, so it includes reception time as well as the total delivery time.
32498 .cindex "log" "recipients"
32499 &%received_recipients%&: The recipients of a message are listed in the main log
32500 as soon as the message is received. The list appears at the end of the log line
32501 that is written when a message is received, preceded by the word &"for"&. The
32502 addresses are listed after they have been qualified, but before any rewriting
32504 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
32507 .cindex "log" "sender reception"
32508 &%received_sender%&: The unrewritten original sender of a message is added to
32509 the end of the log line that records the message's arrival, after the word
32510 &"from"& (before the recipients if &%received_recipients%& is also set).
32512 .cindex "log" "header lines for rejection"
32513 &%rejected_header%&: If a message's header has been received at the time a
32514 rejection is written to the reject log, the complete header is added to the
32515 log. Header logging can be turned off individually for messages that are
32516 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
32518 .cindex "log" "retry defer"
32519 &%retry_defer%&: A log line is written if a delivery is deferred because a
32520 retry time has not yet been reached. However, this &"retry time not reached"&
32521 message is always omitted from individual message logs after the first delivery
32524 .cindex "log" "return path"
32525 &%return_path_on_delivery%&: The return path that is being transmitted with
32526 the message is included in delivery and bounce lines, using the tag P=.
32527 This is omitted if no delivery actually happens, for example, if routing fails,
32528 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
32530 .cindex "log" "sender on delivery"
32531 &%sender_on_delivery%&: The message's sender address is added to every delivery
32532 and bounce line, tagged by F= (for &"from"&).
32533 This is the original sender that was received with the message; it is not
32534 necessarily the same as the outgoing return path.
32536 .cindex "log" "sender verify failure"
32537 &%sender_verify_fail%&: If this selector is unset, the separate log line that
32538 gives details of a sender verification failure is not written. Log lines for
32539 the rejection of SMTP commands contain just &"sender verify failed"&, so some
32542 .cindex "log" "size rejection"
32543 &%size_reject%&: A log line is written whenever a message is rejected because
32546 .cindex "log" "frozen messages; skipped"
32547 .cindex "frozen messages" "logging skipping"
32548 &%skip_delivery%&: A log line is written whenever a message is skipped during a
32549 queue run because it is frozen or because another process is already delivering
32551 .cindex "&""spool file is locked""&"
32552 The message that is written is &"spool file is locked"&.
32554 .cindex "log" "smtp confirmation"
32555 .cindex "SMTP" "logging confirmation"
32556 &%smtp_confirmation%&: The response to the final &"."& in the SMTP dialogue for
32557 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
32558 A number of MTAs (including Exim) return an identifying string in this
32561 .cindex "log" "SMTP connections"
32562 .cindex "SMTP" "logging connections"
32563 &%smtp_connection%&: A log line is written whenever an SMTP connection is
32564 established or closed, unless the connection is from a host that matches
32565 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
32566 only when the closure is unexpected.) This applies to connections from local
32567 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
32568 dropped in the middle of a message, a log line is always written, whether or
32569 not this selector is set, but otherwise nothing is written at the start and end
32570 of connections unless this selector is enabled.
32572 For TCP/IP connections to an Exim daemon, the current number of connections is
32573 included in the log message for each new connection, but note that the count is
32574 reset if the daemon is restarted.
32575 Also, because connections are closed (and the closure is logged) in
32576 subprocesses, the count may not include connections that have been closed but
32577 whose termination the daemon has not yet noticed. Thus, while it is possible to
32578 match up the opening and closing of connections in the log, the value of the
32579 logged counts may not be entirely accurate.
32581 .cindex "log" "SMTP transaction; incomplete"
32582 .cindex "SMTP" "logging incomplete transactions"
32583 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
32584 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
32585 and the message sender plus any accepted recipients are included in the log
32586 line. This can provide evidence of dictionary attacks.
32588 .cindex "log" "non-MAIL SMTP sessions"
32589 .cindex "MAIL" "logging session without"
32590 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
32591 connection terminates without having issued a MAIL command. This includes both
32592 the case when the connection is dropped, and the case when QUIT is used. It
32593 does not include cases where the connection is rejected right at the start (by
32594 an ACL, or because there are too many connections, or whatever). These cases
32595 already have their own log lines.
32597 The log line that is written contains the identity of the client in the usual
32598 way, followed by D= and a time, which records the duration of the connection.
32599 If the connection was authenticated, this fact is logged exactly as it is for
32600 an incoming message, with an A= item. If the connection was encrypted, CV=,
32601 DN=, and X= items may appear as they do for an incoming message, controlled by
32602 the same logging options.
32604 Finally, if any SMTP commands were issued during the connection, a C= item
32605 is added to the line, listing the commands that were used. For example,
32609 shows that the client issued QUIT straight after EHLO. If there were fewer
32610 than 20 commands, they are all listed. If there were more than 20 commands,
32611 the last 20 are listed, preceded by &"..."&. However, with the default
32612 setting of 10 for &%smtp_accep_max_nonmail%&, the connection will in any case
32613 have been aborted before 20 non-mail commands are processed.
32615 .cindex "log" "SMTP protocol error"
32616 .cindex "SMTP" "logging protocol error"
32617 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
32618 encountered. Exim does not have perfect detection of all protocol errors
32619 because of transmission delays and the use of pipelining. If PIPELINING has
32620 been advertised to a client, an Exim server assumes that the client will use
32621 it, and therefore it does not count &"expected"& errors (for example, RCPT
32622 received after rejecting MAIL) as protocol errors.
32624 .cindex "SMTP" "logging syntax errors"
32625 .cindex "SMTP" "syntax errors; logging"
32626 .cindex "SMTP" "unknown command; logging"
32627 .cindex "log" "unknown SMTP command"
32628 .cindex "log" "SMTP syntax error"
32629 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
32630 encountered. An unrecognized command is treated as a syntax error. For an
32631 external connection, the host identity is given; for an internal connection
32632 using &%-bs%& the sender identification (normally the calling user) is given.
32634 .cindex "log" "subject"
32635 .cindex "subject, logging"
32636 &%subject%&: The subject of the message is added to the arrival log line,
32637 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
32638 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
32639 specifies whether characters with values greater than 127 should be logged
32640 unchanged, or whether they should be rendered as escape sequences.
32642 .cindex "log" "certificate verification"
32643 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
32644 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
32645 verified, and &`CV=no`& if not.
32647 .cindex "log" "TLS cipher"
32648 .cindex "TLS" "logging cipher"
32649 &%tls_cipher%&: When a message is sent or received over an encrypted
32650 connection, the cipher suite used is added to the log line, preceded by X=.
32652 .cindex "log" "TLS peer DN"
32653 .cindex "TLS" "logging peer DN"
32654 &%tls_peerdn%&: When a message is sent or received over an encrypted
32655 connection, and a certificate is supplied by the remote host, the peer DN is
32656 added to the log line, preceded by DN=.
32658 .cindex "log" "DNS failure in list"
32659 &%unknown_in_list%&: This setting causes a log entry to be written when the
32660 result of a list match is failure because a DNS lookup failed.
32664 .section "Message log" "SECID260"
32665 .cindex "message" "log file for"
32666 .cindex "log" "message log; description of"
32667 .cindex "&_msglog_& directory"
32668 .oindex "&%preserve_message_logs%&"
32669 In addition to the general log files, Exim writes a log file for each message
32670 that it handles. The names of these per-message logs are the message ids, and
32671 they are kept in the &_msglog_& sub-directory of the spool directory. Each
32672 message log contains copies of the log lines that apply to the message. This
32673 makes it easier to inspect the status of an individual message without having
32674 to search the main log. A message log is deleted when processing of the message
32675 is complete, unless &%preserve_message_logs%& is set, but this should be used
32676 only with great care because they can fill up your disk very quickly.
32678 On a heavily loaded system, it may be desirable to disable the use of
32679 per-message logs, in order to reduce disk I/O. This can be done by setting the
32680 &%message_logs%& option false.
32686 . ////////////////////////////////////////////////////////////////////////////
32687 . ////////////////////////////////////////////////////////////////////////////
32689 .chapter "Exim utilities" "CHAPutils"
32690 .scindex IIDutils "utilities"
32691 A number of utility scripts and programs are supplied with Exim and are
32692 described in this chapter. There is also the Exim Monitor, which is covered in
32693 the next chapter. The utilities described here are:
32695 .itable none 0 0 3 7* left 15* left 40* left
32696 .irow &<<SECTfinoutwha>>& &'exiwhat'& &&&
32697 "list what Exim processes are doing"
32698 .irow &<<SECTgreptheque>>& &'exiqgrep'& "grep the queue"
32699 .irow &<<SECTsumtheque>>& &'exiqsumm'& "summarize the queue"
32700 .irow &<<SECTextspeinf>>& &'exigrep'& "search the main log"
32701 .irow &<<SECTexipick>>& &'exipick'& "select messages on &&&
32703 .irow &<<SECTcyclogfil>>& &'exicyclog'& "cycle (rotate) log files"
32704 .irow &<<SECTmailstat>>& &'eximstats'& &&&
32705 "extract statistics from the log"
32706 .irow &<<SECTcheckaccess>>& &'exim_checkaccess'& &&&
32707 "check address acceptance from given IP"
32708 .irow &<<SECTdbmbuild>>& &'exim_dbmbuild'& "build a DBM file"
32709 .irow &<<SECTfinindret>>& &'exinext'& "extract retry information"
32710 .irow &<<SECThindatmai>>& &'exim_dumpdb'& "dump a hints database"
32711 .irow &<<SECThindatmai>>& &'exim_tidydb'& "clean up a hints database"
32712 .irow &<<SECThindatmai>>& &'exim_fixdb'& "patch a hints database"
32713 .irow &<<SECTmailboxmaint>>& &'exim_lock'& "lock a mailbox file"
32716 Another utility that might be of use to sites with many MTAs is Tom Kistner's
32717 &'exilog'&. It provides log visualizations across multiple Exim servers. See
32718 &url(http://duncanthrax.net/exilog/) for details.
32723 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
32724 .cindex "&'exiwhat'&"
32725 .cindex "process, querying"
32727 On operating systems that can restart a system call after receiving a signal
32728 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
32729 a line describing what it is doing to the file &_exim-process.info_& in the
32730 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
32731 processes it can find, having first emptied the file. It then waits for one
32732 second to allow the Exim processes to react before displaying the results. In
32733 order to run &'exiwhat'& successfully you have to have sufficient privilege to
32734 send the signal to the Exim processes, so it is normally run as root.
32736 &*Warning*&: This is not an efficient process. It is intended for occasional
32737 use by system administrators. It is not sensible, for example, to set up a
32738 script that sends SIGUSR1 signals to Exim processes at short intervals.
32741 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
32742 varies in different operating systems. Not only are different options used,
32743 but the format of the output is different. For this reason, there are some
32744 system configuration options that configure exactly how &'exiwhat'& works. If
32745 it doesn't seem to be working for you, check the following compile-time
32748 &`EXIWHAT_PS_CMD `& the command for running &'ps'&
32749 &`EXIWHAT_PS_ARG `& the argument for &'ps'&
32750 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
32751 &`EXIWHAT_KILL_ARG `& the argument for the &'kill'& command
32753 An example of typical output from &'exiwhat'& is
32755 164 daemon: -q1h, listening on port 25
32756 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
32757 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
32758 [10.19.42.42] (editor@ref.example)
32759 10592 handling incoming call from [192.168.243.242]
32760 10628 accepting a local non-SMTP message
32762 The first number in the output line is the process number. The third line has
32763 been split here, in order to fit it on the page.
32767 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
32768 .cindex "&'exiqgrep'&"
32769 .cindex "queue" "grepping"
32770 This utility is a Perl script contributed by Matt Hubbard. It runs
32774 to obtain a queue listing with undelivered recipients only, and then greps the
32775 output to select messages that match given criteria. The following selection
32776 options are available:
32779 .vitem &*-f*&&~<&'regex'&>
32780 Match the sender address. The field that is tested is enclosed in angle
32781 brackets, so you can test for bounce messages with
32785 .vitem &*-r*&&~<&'regex'&>
32786 Match a recipient address. The field that is tested is not enclosed in angle
32789 .vitem &*-s*&&~<&'regex'&>
32790 Match against the size field.
32792 .vitem &*-y*&&~<&'seconds'&>
32793 Match messages that are younger than the given time.
32795 .vitem &*-o*&&~<&'seconds'&>
32796 Match messages that are older than the given time.
32799 Match only frozen messages.
32802 Match only non-frozen messages.
32805 The following options control the format of the output:
32809 Display only the count of matching messages.
32812 Long format &-- display the full message information as output by Exim. This is
32816 Display message ids only.
32819 Brief format &-- one line per message.
32822 Display messages in reverse order.
32825 There is one more option, &%-h%&, which outputs a list of options.
32829 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
32830 .cindex "&'exiqsumm'&"
32831 .cindex "queue" "summary"
32832 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
32833 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
32834 running a command such as
32836 exim -bp | exiqsumm
32838 The output consists of one line for each domain that has messages waiting for
32839 it, as in the following example:
32841 3 2322 74m 66m msn.com.example
32843 Each line lists the number of pending deliveries for a domain, their total
32844 volume, and the length of time that the oldest and the newest messages have
32845 been waiting. Note that the number of pending deliveries is greater than the
32846 number of messages when messages have more than one recipient.
32848 A summary line is output at the end. By default the output is sorted on the
32849 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
32850 the output to be sorted by oldest message and by count of messages,
32851 respectively. There are also three options that split the messages for each
32852 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
32853 separates frozen messages, and &%-s%& separates messages according to their
32856 The output of &'exim -bp'& contains the original addresses in the message, so
32857 this also applies to the output from &'exiqsumm'&. No domains from addresses
32858 generated by aliasing or forwarding are included (unless the &%one_time%&
32859 option of the &(redirect)& router has been used to convert them into &"top
32860 level"& addresses).
32865 .section "Extracting specific information from the log (exigrep)" &&&
32867 .cindex "&'exigrep'&"
32868 .cindex "log" "extracts; grepping for"
32869 The &'exigrep'& utility is a Perl script that searches one or more main log
32870 files for entries that match a given pattern. When it finds a match, it
32871 extracts all the log entries for the relevant message, not just those that
32872 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
32873 given message, or all mail for a given user, or for a given host, for example.
32874 The input files can be in Exim log format or syslog format.
32875 If a matching log line is not associated with a specific message, it is
32876 included in &'exigrep'&'s output without any additional lines. The usage is:
32878 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
32880 If no log file names are given on the command line, the standard input is read.
32882 The &%-t%& argument specifies a number of seconds. It adds an additional
32883 condition for message selection. Messages that are complete are shown only if
32884 they spent more than <&'n'&> seconds on the queue.
32886 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
32887 makes it case-sensitive. This may give a performance improvement when searching
32888 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
32889 option; with &%-I%& they do not. In both cases it is possible to change the
32890 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
32892 The &%-l%& option means &"literal"&, that is, treat all characters in the
32893 pattern as standing for themselves. Otherwise the pattern must be a Perl
32894 regular expression.
32896 The &%-v%& option inverts the matching condition. That is, a line is selected
32897 if it does &'not'& match the pattern.
32899 If the location of a &'zcat'& command is known from the definition of
32900 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
32901 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
32904 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
32905 .cindex "&'exipick'&"
32906 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
32907 lists messages from the queue according to a variety of criteria. For details
32908 of &'exipick'&'s facilities, visit the web page at
32909 &url(http://www.exim.org/eximwiki/ToolExipickManPage) or run &'exipick'& with
32910 the &%--help%& option.
32913 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
32914 .cindex "log" "cycling local files"
32915 .cindex "cycling logs"
32916 .cindex "&'exicyclog'&"
32917 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
32918 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
32919 you are using log files with datestamps in their names (see section
32920 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
32921 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
32922 There are two command line options for &'exicyclog'&:
32924 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
32925 default that is set when Exim is built. The default default is 10.
32927 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
32928 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
32929 overriding the script's default, which is to find the setting from Exim's
32933 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
32934 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
32935 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
32936 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
32937 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
32938 logs are handled similarly.
32940 If the limit is greater than 99, the script uses 3-digit numbers such as
32941 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
32942 to one that is greater, or &'vice versa'&, you will have to fix the names of
32943 any existing log files.
32945 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
32946 the end are deleted. All files with numbers greater than 01 are compressed,
32947 using a compression command which is configured by the COMPRESS_COMMAND
32948 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
32949 root &%crontab%& entry of the form
32951 1 0 * * * su exim -c /usr/exim/bin/exicyclog
32953 assuming you have used the name &"exim"& for the Exim user. You can run
32954 &'exicyclog'& as root if you wish, but there is no need.
32958 .section "Mail statistics (eximstats)" "SECTmailstat"
32959 .cindex "statistics"
32960 .cindex "&'eximstats'&"
32961 A Perl script called &'eximstats'& is provided for extracting statistical
32962 information from log files. The output is either plain text, or HTML.
32963 Exim log files are also supported by the &'Lire'& system produced by the
32964 LogReport Foundation &url(http://www.logreport.org).
32966 The &'eximstats'& script has been hacked about quite a bit over time. The
32967 latest version is the result of some extensive revision by Steve Campbell. A
32968 lot of information is given by default, but there are options for suppressing
32969 various parts of it. Following any options, the arguments to the script are a
32970 list of files, which should be main log files. For example:
32972 eximstats -nr /var/spool/exim/log/mainlog.01
32974 By default, &'eximstats'& extracts information about the number and volume of
32975 messages received from or delivered to various hosts. The information is sorted
32976 both by message count and by volume, and the top fifty hosts in each category
32977 are listed on the standard output. Similar information, based on email
32978 addresses or domains instead of hosts can be requested by means of various
32979 options. For messages delivered and received locally, similar statistics are
32980 also produced per user.
32982 The output also includes total counts and statistics about delivery errors, and
32983 histograms showing the number of messages received and deliveries made in each
32984 hour of the day. A delivery with more than one address in its envelope (for
32985 example, an SMTP transaction with more than one RCPT command) is counted
32986 as a single delivery by &'eximstats'&.
32988 Though normally more deliveries than receipts are reported (as messages may
32989 have multiple recipients), it is possible for &'eximstats'& to report more
32990 messages received than delivered, even though the queue is empty at the start
32991 and end of the period in question. If an incoming message contains no valid
32992 recipients, no deliveries are recorded for it. A bounce message is handled as
32993 an entirely separate message.
32995 &'eximstats'& always outputs a grand total summary giving the volume and number
32996 of messages received and deliveries made, and the number of hosts involved in
32997 each case. It also outputs the number of messages that were delayed (that is,
32998 not completely delivered at the first attempt), and the number that had at
32999 least one address that failed.
33001 The remainder of the output is in sections that can be independently disabled
33002 or modified by various options. It consists of a summary of deliveries by
33003 transport, histograms of messages received and delivered per time interval
33004 (default per hour), information about the time messages spent on the queue,
33005 a list of relayed messages, lists of the top fifty sending hosts, local
33006 senders, destination hosts, and destination local users by count and by volume,
33007 and a list of delivery errors that occurred.
33009 The relay information lists messages that were actually relayed, that is, they
33010 came from a remote host and were directly delivered to some other remote host,
33011 without being processed (for example, for aliasing or forwarding) locally.
33013 There are quite a few options for &'eximstats'& to control exactly what it
33014 outputs. These are documented in the Perl script itself, and can be extracted
33015 by running the command &(perldoc)& on the script. For example:
33017 perldoc /usr/exim/bin/eximstats
33020 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
33021 .cindex "&'exim_checkaccess'&"
33022 .cindex "policy control" "checking access"
33023 .cindex "checking access"
33024 The &%-bh%& command line argument allows you to run a fake SMTP session with
33025 debugging output, in order to check what Exim is doing when it is applying
33026 policy controls to incoming SMTP mail. However, not everybody is sufficiently
33027 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
33028 sometimes you just want to answer the question &"Does this address have
33029 access?"& without bothering with any further details.
33031 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
33032 two arguments, an IP address and an email address:
33034 exim_checkaccess 10.9.8.7 A.User@a.domain.example
33036 The utility runs a call to Exim with the &%-bh%& option, to test whether the
33037 given email address would be accepted in a RCPT command in a TCP/IP
33038 connection from the host with the given IP address. The output of the utility
33039 is either the word &"accepted"&, or the SMTP error response, for example:
33042 550 Relay not permitted
33044 When running this test, the utility uses &`<>`& as the envelope sender address
33045 for the MAIL command, but you can change this by providing additional
33046 options. These are passed directly to the Exim command. For example, to specify
33047 that the test is to be run with the sender address &'himself@there.example'&
33050 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
33051 -f himself@there.example
33053 Note that these additional Exim command line items must be given after the two
33054 mandatory arguments.
33056 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
33057 while running its checks. You can run checks that include callouts by using
33058 &%-bhc%&, but this is not yet available in a &"packaged"& form.
33062 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
33063 .cindex "DBM" "building dbm files"
33064 .cindex "building DBM files"
33065 .cindex "&'exim_dbmbuild'&"
33066 .cindex "lower casing"
33067 .cindex "binary zero" "in lookup key"
33068 The &'exim_dbmbuild'& program reads an input file containing keys and data in
33069 the format used by the &(lsearch)& lookup (see section
33070 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
33071 names as keys and the remainder of the information as data. The lower-casing
33072 can be prevented by calling the program with the &%-nolc%& option.
33074 A terminating zero is included as part of the key string. This is expected by
33075 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
33076 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
33077 strings or the data strings. The &(dbmnz)& lookup type can be used with such
33080 The program requires two arguments: the name of the input file (which can be a
33081 single hyphen to indicate the standard input), and the name of the output file.
33082 It creates the output under a temporary name, and then renames it if all went
33086 If the native DB interface is in use (USE_DB is set in a compile-time
33087 configuration file &-- this is common in free versions of Unix) the two file
33088 names must be different, because in this mode the Berkeley DB functions create
33089 a single output file using exactly the name given. For example,
33091 exim_dbmbuild /etc/aliases /etc/aliases.db
33093 reads the system alias file and creates a DBM version of it in
33094 &_/etc/aliases.db_&.
33096 In systems that use the &'ndbm'& routines (mostly proprietary versions of
33097 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
33098 environment, the suffixes are added to the second argument of
33099 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
33100 when the Berkeley functions are used in compatibility mode (though this is not
33101 recommended), because in that case it adds a &_.db_& suffix to the file name.
33103 If a duplicate key is encountered, the program outputs a warning, and when it
33104 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
33105 option is used. By default, only the first of a set of duplicates is used &--
33106 this makes it compatible with &(lsearch)& lookups. There is an option
33107 &%-lastdup%& which causes it to use the data for the last duplicate instead.
33108 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
33109 &%stderr%&. For other errors, where it doesn't actually make a new file, the
33115 .section "Finding individual retry times (exinext)" "SECTfinindret"
33116 .cindex "retry" "times"
33117 .cindex "&'exinext'&"
33118 A utility called &'exinext'& (mostly a Perl script) provides the ability to
33119 fish specific information out of the retry database. Given a mail domain (or a
33120 complete address), it looks up the hosts for that domain, and outputs any retry
33121 information for the hosts or for the domain. At present, the retry information
33122 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
33123 output. For example:
33125 $ exinext piglet@milne.fict.example
33126 kanga.milne.example:192.168.8.1 error 146: Connection refused
33127 first failed: 21-Feb-1996 14:57:34
33128 last tried: 21-Feb-1996 14:57:34
33129 next try at: 21-Feb-1996 15:02:34
33130 roo.milne.example:192.168.8.3 error 146: Connection refused
33131 first failed: 20-Jan-1996 13:12:08
33132 last tried: 21-Feb-1996 11:42:03
33133 next try at: 21-Feb-1996 19:42:03
33134 past final cutoff time
33136 You can also give &'exinext'& a local part, without a domain, and it
33137 will give any retry information for that local part in your default domain.
33138 A message id can be used to obtain retry information pertaining to a specific
33139 message. This exists only when an attempt to deliver a message to a remote host
33140 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
33141 &'exinext'& is not particularly efficient, but then it is not expected to be
33144 The &'exinext'& utility calls Exim to find out information such as the location
33145 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
33146 passed on to the &'exim'& commands. The first specifies an alternate Exim
33147 configuration file, and the second sets macros for use within the configuration
33148 file. These features are mainly to help in testing, but might also be useful in
33149 environments where more than one configuration file is in use.
33153 .section "Hints database maintenance" "SECThindatmai"
33154 .cindex "hints database" "maintenance"
33155 .cindex "maintaining Exim's hints database"
33156 Three utility programs are provided for maintaining the DBM files that Exim
33157 uses to contain its delivery hint information. Each program requires two
33158 arguments. The first specifies the name of Exim's spool directory, and the
33159 second is the name of the database it is to operate on. These are as follows:
33162 &'retry'&: the database of retry information
33164 &'wait-'&<&'transport name'&>: databases of information about messages waiting
33167 &'callout'&: the callout cache
33169 &'ratelimit'&: the data for implementing the ratelimit ACL condition
33171 &'misc'&: other hints data
33174 The &'misc'& database is used for
33177 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
33179 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
33180 &(smtp)& transport)
33185 .section "exim_dumpdb" "SECID261"
33186 .cindex "&'exim_dumpdb'&"
33187 The entire contents of a database are written to the standard output by the
33188 &'exim_dumpdb'& program, which has no options or arguments other than the
33189 spool and database names. For example, to dump the retry database:
33191 exim_dumpdb /var/spool/exim retry
33193 Two lines of output are produced for each entry:
33195 T:mail.ref.example:192.168.242.242 146 77 Connection refused
33196 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
33198 The first item on the first line is the key of the record. It starts with one
33199 of the letters R, or T, depending on whether it refers to a routing or
33200 transport retry. For a local delivery, the next part is the local address; for
33201 a remote delivery it is the name of the remote host, followed by its failing IP
33202 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
33203 transport). If the remote port is not the standard one (port 25), it is added
33204 to the IP address. Then there follows an error code, an additional error code,
33205 and a textual description of the error.
33207 The three times on the second line are the time of first failure, the time of
33208 the last delivery attempt, and the computed time for the next attempt. The line
33209 ends with an asterisk if the cutoff time for the last retry rule has been
33212 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
33213 consists of a host name followed by a list of ids for messages that are or were
33214 waiting to be delivered to that host. If there are a very large number for any
33215 one host, continuation records, with a sequence number added to the host name,
33216 may be seen. The data in these records is often out of date, because a message
33217 may be routed to several alternative hosts, and Exim makes no effort to keep
33222 .section "exim_tidydb" "SECID262"
33223 .cindex "&'exim_tidydb'&"
33224 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
33225 database. If run with no options, it removes all records that are more than 30
33226 days old. The age is calculated from the date and time that the record was last
33227 updated. Note that, in the case of the retry database, it is &'not'& the time
33228 since the first delivery failure. Information about a host that has been down
33229 for more than 30 days will remain in the database, provided that the record is
33230 updated sufficiently often.
33232 The cutoff date can be altered by means of the &%-t%& option, which must be
33233 followed by a time. For example, to remove all records older than a week from
33234 the retry database:
33236 exim_tidydb -t 7d /var/spool/exim retry
33238 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
33239 message ids. In the former these appear as data in records keyed by host &--
33240 they were messages that were waiting for that host &-- and in the latter they
33241 are the keys for retry information for messages that have suffered certain
33242 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
33243 message ids in database records are those of messages that are still on the
33244 queue. Message ids for messages that no longer exist are removed from
33245 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
33246 For the &'retry'& database, records whose keys are non-existent message ids are
33247 removed. The &'exim_tidydb'& utility outputs comments on the standard output
33248 whenever it removes information from the database.
33250 Certain records are automatically removed by Exim when they are no longer
33251 needed, but others are not. For example, if all the MX hosts for a domain are
33252 down, a retry record is created for each one. If the primary MX host comes back
33253 first, its record is removed when Exim successfully delivers to it, but the
33254 records for the others remain because Exim has not tried to use those hosts.
33256 It is important, therefore, to run &'exim_tidydb'& periodically on all the
33257 hints databases. You should do this at a quiet time of day, because it requires
33258 a database to be locked (and therefore inaccessible to Exim) while it does its
33259 work. Removing records from a DBM file does not normally make the file smaller,
33260 but all the common DBM libraries are able to re-use the space that is released.
33261 After an initial phase of increasing in size, the databases normally reach a
33262 point at which they no longer get any bigger, as long as they are regularly
33265 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
33266 databases is likely to keep on increasing.
33271 .section "exim_fixdb" "SECID263"
33272 .cindex "&'exim_fixdb'&"
33273 The &'exim_fixdb'& program is a utility for interactively modifying databases.
33274 Its main use is for testing Exim, but it might also be occasionally useful for
33275 getting round problems in a live system. It has no options, and its interface
33276 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
33277 key of a database record can then be entered, and the data for that record is
33280 If &"d"& is typed at the next prompt, the entire record is deleted. For all
33281 except the &'retry'& database, that is the only operation that can be carried
33282 out. For the &'retry'& database, each field is output preceded by a number, and
33283 data for individual fields can be changed by typing the field number followed
33284 by new data, for example:
33288 resets the time of the next delivery attempt. Time values are given as a
33289 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
33290 used as optional separators.
33295 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
33296 .cindex "mailbox" "maintenance"
33297 .cindex "&'exim_lock'&"
33298 .cindex "locking mailboxes"
33299 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
33300 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
33301 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
33302 a user agent while investigating a problem. The utility requires the name of
33303 the file as its first argument. If the locking is successful, the second
33304 argument is run as a command (using C's &[system()]& function); if there is no
33305 second argument, the value of the SHELL environment variable is used; if this
33306 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
33307 is unlocked and the utility ends. The following options are available:
33311 Use &[fcntl()]& locking on the open mailbox.
33314 Use &[flock()]& locking on the open mailbox, provided the operating system
33317 .vitem &%-interval%&
33318 This must be followed by a number, which is a number of seconds; it sets the
33319 interval to sleep between retries (default 3).
33321 .vitem &%-lockfile%&
33322 Create a lock file before opening the mailbox.
33325 Lock the mailbox using MBX rules.
33328 Suppress verification output.
33330 .vitem &%-retries%&
33331 This must be followed by a number; it sets the number of times to try to get
33332 the lock (default 10).
33334 .vitem &%-restore_time%&
33335 This option causes &%exim_lock%& to restore the modified and read times to the
33336 locked file before exiting. This allows you to access a locked mailbox (for
33337 example, to take a backup copy) without disturbing the times that the user
33340 .vitem &%-timeout%&
33341 This must be followed by a number, which is a number of seconds; it sets a
33342 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
33343 default), a non-blocking call is used.
33346 Generate verbose output.
33349 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
33350 default is to create a lock file and also to use &[fcntl()]& locking on the
33351 mailbox, which is the same as Exim's default. The use of &%-flock%& or
33352 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
33353 requires that the directory containing the file be writeable. Locking by lock
33354 file does not last for ever; Exim assumes that a lock file is expired if it is
33355 more than 30 minutes old.
33357 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
33358 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
33359 to be taken out on the open mailbox, and an exclusive lock on the file
33360 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
33361 number of the mailbox file. When the locking is released, if an exclusive lock
33362 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
33364 The default output contains verification of the locking that takes place. The
33365 &%-v%& option causes some additional information to be given. The &%-q%& option
33366 suppresses all output except error messages.
33370 exim_lock /var/spool/mail/spqr
33372 runs an interactive shell while the file is locked, whereas
33374 &`exim_lock -q /var/spool/mail/spqr <<End`&
33375 <&'some commands'&>
33378 runs a specific non-interactive sequence of commands while the file is locked,
33379 suppressing all verification output. A single command can be run by a command
33382 exim_lock -q /var/spool/mail/spqr \
33383 "cp /var/spool/mail/spqr /some/where"
33385 Note that if a command is supplied, it must be entirely contained within the
33386 second argument &-- hence the quotes.
33390 . ////////////////////////////////////////////////////////////////////////////
33391 . ////////////////////////////////////////////////////////////////////////////
33393 .chapter "The Exim monitor" "CHAPeximon"
33394 .scindex IIDeximon "Exim monitor" "description"
33395 .cindex "X-windows"
33396 .cindex "&'eximon'&"
33397 .cindex "Local/eximon.conf"
33398 .cindex "&_exim_monitor/EDITME_&"
33399 The Exim monitor is an application which displays in an X window information
33400 about the state of Exim's queue and what Exim is doing. An admin user can
33401 perform certain operations on messages from this GUI interface; however all
33402 such facilities are also available from the command line, and indeed, the
33403 monitor itself makes use of the command line to perform any actions requested.
33407 .section "Running the monitor" "SECID264"
33408 The monitor is started by running the script called &'eximon'&. This is a shell
33409 script that sets up a number of environment variables, and then runs the
33410 binary called &_eximon.bin_&. The default appearance of the monitor window can
33411 be changed by editing the &_Local/eximon.conf_& file created by editing
33412 &_exim_monitor/EDITME_&. Comments in that file describe what the various
33413 parameters are for.
33415 The parameters that get built into the &'eximon'& script can be overridden for
33416 a particular invocation by setting up environment variables of the same names,
33417 preceded by &`EXIMON_`&. For example, a shell command such as
33419 EXIMON_LOG_DEPTH=400 eximon
33421 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
33422 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
33423 overrides the Exim log file configuration. This makes it possible to have
33424 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
33425 syslog messages are routed to a file on the local host.
33427 X resources can be used to change the appearance of the window in the normal
33428 way. For example, a resource setting of the form
33430 Eximon*background: gray94
33432 changes the colour of the background to light grey rather than white. The
33433 stripcharts are drawn with both the data lines and the reference lines in
33434 black. This means that the reference lines are not visible when on top of the
33435 data. However, their colour can be changed by setting a resource called
33436 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
33437 For example, if your X server is running Unix, you could set up lighter
33438 reference lines in the stripcharts by obeying
33441 Eximon*highlight: gray
33444 .cindex "admin user"
33445 In order to see the contents of messages on the queue, and to operate on them,
33446 &'eximon'& must either be run as root or by an admin user.
33448 The monitor's window is divided into three parts. The first contains one or
33449 more stripcharts and two action buttons, the second contains a &"tail"& of the
33450 main log file, and the third is a display of the queue of messages awaiting
33451 delivery, with two more action buttons. The following sections describe these
33452 different parts of the display.
33457 .section "The stripcharts" "SECID265"
33458 .cindex "stripchart"
33459 The first stripchart is always a count of messages on the queue. Its name can
33460 be configured by setting QUEUE_STRIPCHART_NAME in the
33461 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
33462 configuration script by regular expression matches on log file entries, making
33463 it possible to display, for example, counts of messages delivered to certain
33464 hosts or using certain transports. The supplied defaults display counts of
33465 received and delivered messages, and of local and SMTP deliveries. The default
33466 period between stripchart updates is one minute; this can be adjusted by a
33467 parameter in the &_Local/eximon.conf_& file.
33469 The stripchart displays rescale themselves automatically as the value they are
33470 displaying changes. There are always 10 horizontal lines in each chart; the
33471 title string indicates the value of each division when it is greater than one.
33472 For example, &"x2"& means that each division represents a value of 2.
33474 It is also possible to have a stripchart which shows the percentage fullness of
33475 a particular disk partition, which is useful when local deliveries are confined
33476 to a single partition.
33478 .cindex "&%statvfs%& function"
33479 This relies on the availability of the &[statvfs()]& function or equivalent in
33480 the operating system. Most, but not all versions of Unix that support Exim have
33481 this. For this particular stripchart, the top of the chart always represents
33482 100%, and the scale is given as &"x10%"&. This chart is configured by setting
33483 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
33484 &_Local/eximon.conf_& file.
33489 .section "Main action buttons" "SECID266"
33490 .cindex "size" "of monitor window"
33491 .cindex "Exim monitor" "window size"
33492 .cindex "window size"
33493 Below the stripcharts there is an action button for quitting the monitor. Next
33494 to this is another button marked &"Size"&. They are placed here so that
33495 shrinking the window to its default minimum size leaves just the queue count
33496 stripchart and these two buttons visible. Pressing the &"Size"& button causes
33497 the window to expand to its maximum size, unless it is already at the maximum,
33498 in which case it is reduced to its minimum.
33500 When expanding to the maximum, if the window cannot be fully seen where it
33501 currently is, it is moved back to where it was the last time it was at full
33502 size. When it is expanding from its minimum size, the old position is
33503 remembered, and next time it is reduced to the minimum it is moved back there.
33505 The idea is that you can keep a reduced window just showing one or two
33506 stripcharts at a convenient place on your screen, easily expand it to show
33507 the full window when required, and just as easily put it back to what it was.
33508 The idea is copied from what the &'twm'& window manager does for its
33509 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
33510 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
33512 Normally, the monitor starts up with the window at its full size, but it can be
33513 built so that it starts up with the window at its smallest size, by setting
33514 START_SMALL=yes in &_Local/eximon.conf_&.
33518 .section "The log display" "SECID267"
33519 .cindex "log" "tail of; in monitor"
33520 The second section of the window is an area in which a display of the tail of
33521 the main log is maintained.
33522 To save space on the screen, the timestamp on each log line is shortened by
33523 removing the date and, if &%log_timezone%& is set, the timezone.
33524 The log tail is not available when the only destination for logging data is
33525 syslog, unless the syslog lines are routed to a local file whose name is passed
33526 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
33528 The log sub-window has a scroll bar at its lefthand side which can be used to
33529 move back to look at earlier text, and the up and down arrow keys also have a
33530 scrolling effect. The amount of log that is kept depends on the setting of
33531 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
33532 to use. When this is full, the earlier 50% of data is discarded &-- this is
33533 much more efficient than throwing it away line by line. The sub-window also has
33534 a horizontal scroll bar for accessing the ends of long log lines. This is the
33535 only means of horizontal scrolling; the right and left arrow keys are not
33536 available. Text can be cut from this part of the window using the mouse in the
33537 normal way. The size of this subwindow is controlled by parameters in the
33538 configuration file &_Local/eximon.conf_&.
33540 Searches of the text in the log window can be carried out by means of the ^R
33541 and ^S keystrokes, which default to a reverse and a forward search,
33542 respectively. The search covers only the text that is displayed in the window.
33543 It cannot go further back up the log.
33545 The point from which the search starts is indicated by a caret marker. This is
33546 normally at the end of the text in the window, but can be positioned explicitly
33547 by pointing and clicking with the left mouse button, and is moved automatically
33548 by a successful search. If new text arrives in the window when it is scrolled
33549 back, the caret remains where it is, but if the window is not scrolled back,
33550 the caret is moved to the end of the new text.
33552 Pressing ^R or ^S pops up a window into which the search text can be typed.
33553 There are buttons for selecting forward or reverse searching, for carrying out
33554 the search, and for cancelling. If the &"Search"& button is pressed, the search
33555 happens and the window remains so that further searches can be done. If the
33556 &"Return"& key is pressed, a single search is done and the window is closed. If
33557 ^C is typed the search is cancelled.
33559 The searching facility is implemented using the facilities of the Athena text
33560 widget. By default this pops up a window containing both &"search"& and
33561 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
33562 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
33563 However, the linkers in BSDI and HP-UX seem unable to handle an externally
33564 provided version of &%TextPop%& when the remaining parts of the text widget
33565 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
33566 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
33567 on these systems, at the expense of having unwanted items in the search popup
33572 .section "The queue display" "SECID268"
33573 .cindex "queue" "display in monitor"
33574 The bottom section of the monitor window contains a list of all messages that
33575 are on the queue, which includes those currently being received or delivered,
33576 as well as those awaiting delivery. The size of this subwindow is controlled by
33577 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
33578 at which it is updated is controlled by another parameter in the same file &--
33579 the default is 5 minutes, since queue scans can be quite expensive. However,
33580 there is an &"Update"& action button just above the display which can be used
33581 to force an update of the queue display at any time.
33583 When a host is down for some time, a lot of pending mail can build up for it,
33584 and this can make it hard to deal with other messages on the queue. To help
33585 with this situation there is a button next to &"Update"& called &"Hide"&. If
33586 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
33587 type anything in here and press &"Return"&, the text is added to a chain of
33588 such texts, and if every undelivered address in a message matches at least one
33589 of the texts, the message is not displayed.
33591 If there is an address that does not match any of the texts, all the addresses
33592 are displayed as normal. The matching happens on the ends of addresses so, for
33593 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
33594 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
33595 has been set up, a button called &"Unhide"& is displayed. If pressed, it
33596 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
33597 a hide request is automatically cancelled after one hour.
33599 While the dialogue box is displayed, you can't press any buttons or do anything
33600 else to the monitor window. For this reason, if you want to cut text from the
33601 queue display to use in the dialogue box, you have to do the cutting before
33602 pressing the &"Hide"& button.
33604 The queue display contains, for each unhidden queued message, the length of
33605 time it has been on the queue, the size of the message, the message id, the
33606 message sender, and the first undelivered recipient, all on one line. If it is
33607 a bounce message, the sender is shown as &"<>"&. If there is more than one
33608 recipient to which the message has not yet been delivered, subsequent ones are
33609 listed on additional lines, up to a maximum configured number, following which
33610 an ellipsis is displayed. Recipients that have already received the message are
33613 .cindex "frozen messages" "display"
33614 If a message is frozen, an asterisk is displayed at the left-hand side.
33616 The queue display has a vertical scroll bar, and can also be scrolled by means
33617 of the arrow keys. Text can be cut from it using the mouse in the normal way.
33618 The text searching facilities, as described above for the log window, are also
33619 available, but the caret is always moved to the end of the text when the queue
33620 display is updated.
33624 .section "The queue menu" "SECID269"
33625 .cindex "queue" "menu in monitor"
33626 If the &%shift%& key is held down and the left button is clicked when the mouse
33627 pointer is over the text for any message, an action menu pops up, and the first
33628 line of the queue display for the message is highlighted. This does not affect
33631 If you want to use some other event for popping up the menu, you can set the
33632 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
33633 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
33634 value set in this parameter is a standard X event description. For example, to
33635 run eximon using &%ctrl%& rather than &%shift%& you could use
33637 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
33639 The title of the menu is the message id, and it contains entries which act as
33643 &'message log'&: The contents of the message log for the message are displayed
33644 in a new text window.
33646 &'headers'&: Information from the spool file that contains the envelope
33647 information and headers is displayed in a new text window. See chapter
33648 &<<CHAPspool>>& for a description of the format of spool files.
33650 &'body'&: The contents of the spool file containing the body of the message are
33651 displayed in a new text window. There is a default limit of 20,000 bytes to the
33652 amount of data displayed. This can be changed by setting the BODY_MAX
33653 option at compile time, or the EXIMON_BODY_MAX option at run time.
33655 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
33656 delivery of the message. This causes an automatic thaw if the message is
33657 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
33658 a new text window. The delivery is run in a separate process, to avoid holding
33659 up the monitor while the delivery proceeds.
33661 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
33662 that the message be frozen.
33664 .cindex "thawing messages"
33665 .cindex "unfreezing messages"
33666 .cindex "frozen messages" "thawing"
33667 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
33668 that the message be thawed.
33670 .cindex "delivery" "forcing failure"
33671 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
33672 that Exim gives up trying to deliver the message. A bounce message is generated
33673 for any remaining undelivered addresses.
33675 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
33676 that the message be deleted from the system without generating a bounce
33679 &'add recipient'&: A dialog box is displayed into which a recipient address can
33680 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
33681 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
33682 Otherwise it must be entered as a fully qualified address. Pressing RETURN
33683 causes a call to Exim to be made using the &%-Mar%& option to request that an
33684 additional recipient be added to the message, unless the entry box is empty, in
33685 which case no action is taken.
33687 &'mark delivered'&: A dialog box is displayed into which a recipient address
33688 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
33689 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
33690 Otherwise it must be entered as a fully qualified address. Pressing RETURN
33691 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
33692 recipient address as already delivered, unless the entry box is empty, in which
33693 case no action is taken.
33695 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
33696 mark all recipient addresses as already delivered.
33698 &'edit sender'&: A dialog box is displayed initialized with the current
33699 sender's address. Pressing RETURN causes a call to Exim to be made using the
33700 &%-Mes%& option to replace the sender address, unless the entry box is empty,
33701 in which case no action is taken. If you want to set an empty sender (as in
33702 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
33703 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
33704 the address is qualified with that domain.
33707 When a delivery is forced, a window showing the &%-v%& output is displayed. In
33708 other cases when a call to Exim is made, if there is any output from Exim (in
33709 particular, if the command fails) a window containing the command and the
33710 output is displayed. Otherwise, the results of the action are normally apparent
33711 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
33712 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
33713 if no output is generated.
33715 The queue display is automatically updated for actions such as freezing and
33716 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
33717 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
33718 force an update of the display after one of these actions.
33720 In any text window that is displayed as result of a menu action, the normal
33721 cut-and-paste facility is available, and searching can be carried out using ^R
33722 and ^S, as described above for the log tail window.
33729 . ////////////////////////////////////////////////////////////////////////////
33730 . ////////////////////////////////////////////////////////////////////////////
33732 .chapter "Security considerations" "CHAPsecurity"
33733 .scindex IIDsecurcon "security" "discussion of"
33734 This chapter discusses a number of issues concerned with security, some of
33735 which are also covered in other parts of this manual.
33737 For reasons that this author does not understand, some people have promoted
33738 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
33739 existence of this chapter in the documentation. However, the intent of the
33740 chapter is simply to describe the way Exim works in relation to certain
33741 security concerns, not to make any specific claims about the effectiveness of
33742 its security as compared with other MTAs.
33744 What follows is a description of the way Exim is supposed to be. Best efforts
33745 have been made to try to ensure that the code agrees with the theory, but an
33746 absence of bugs can never be guaranteed. Any that are reported will get fixed
33747 as soon as possible.
33750 .section "Building a more &""hardened""& Exim" "SECID286"
33751 .cindex "security" "build-time features"
33752 There are a number of build-time options that can be set in &_Local/Makefile_&
33753 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
33754 Exim administrator who does not have the root password, or by someone who has
33755 penetrated the Exim (but not the root) account. These options are as follows:
33758 ALT_CONFIG_PREFIX can be set to a string that is required to match the
33759 start of any file names used with the &%-C%& option. When it is set, these file
33760 names are also not allowed to contain the sequence &"/../"&. (However, if the
33761 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
33762 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
33763 default setting for &%ALT_CONFIG_PREFIX%&.
33765 If the permitted configuration files are confined to a directory to
33766 which only root has access, this guards against someone who has broken
33767 into the Exim account from running a privileged Exim with an arbitrary
33768 configuration file, and using it to break into other accounts.
33770 If ALT_CONFIG_ROOT_ONLY is defined, root privilege is retained for &%-C%&
33771 and &%-D%& only if the caller of Exim is root. Without it, the Exim user may
33772 also use &%-C%& and &%-D%& and retain privilege. Setting this option locks out
33773 the possibility of testing a configuration using &%-C%& right through message
33774 reception and delivery, even if the caller is root. The reception works, but by
33775 that time, Exim is running as the Exim user, so when it re-execs to regain
33776 privilege for the delivery, the use of &%-C%& causes privilege to be lost.
33777 However, root can test reception and delivery using two separate commands.
33778 ALT_CONFIG_ROOT_ONLY is not set by default.
33780 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
33783 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
33784 never to be used for any deliveries. This is like the &%never_users%& runtime
33785 option, but it cannot be overridden; the runtime option adds additional users
33786 to the list. The default setting is &"root"&; this prevents a non-root user who
33787 is permitted to modify the runtime file from using Exim as a way to get root.
33793 .section "Root privilege" "SECID270"
33795 .cindex "root privilege"
33796 The Exim binary is normally setuid to root, which means that it gains root
33797 privilege (runs as root) when it starts execution. In some special cases (for
33798 example, when the daemon is not in use and there are no local deliveries), it
33799 may be possible to run Exim setuid to some user other than root. This is
33800 discussed in the next section. However, in most installations, root privilege
33801 is required for two things:
33804 To set up a socket connected to the standard SMTP port (25) when initialising
33805 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
33808 To be able to change uid and gid in order to read users' &_.forward_& files and
33809 perform local deliveries as the receiving user or as specified in the
33813 It is not necessary to be root to do any of the other things Exim does, such as
33814 receiving messages and delivering them externally over SMTP, and it is
33815 obviously more secure if Exim does not run as root except when necessary.
33816 For this reason, a user and group for Exim to use must be defined in
33817 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
33818 group"&. Their values can be changed by the run time configuration, though this
33819 is not recommended. Often a user called &'exim'& is used, but some sites use
33820 &'mail'& or another user name altogether.
33822 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
33823 abdication; the process cannot regain root afterwards. Prior to release 4.00,
33824 &[seteuid()]& was used in some circumstances, but this is no longer the case.
33826 After a new Exim process has interpreted its command line options, it changes
33827 uid and gid in the following cases:
33832 If the &%-C%& option is used to specify an alternate configuration file, or if
33833 the &%-D%& option is used to define macro values for the configuration, and the
33834 calling process is not running as root or the Exim user, the uid and gid are
33835 changed to those of the calling process.
33836 However, if ALT_CONFIG_ROOT_ONLY is defined in &_Local/Makefile_&, only
33837 root callers may use &%-C%& and &%-D%& without losing privilege, and if
33838 DISABLE_D_OPTION is set, the &%-D%& option may not be used at all.
33843 If the expansion test option (&%-be%&) or one of the filter testing options
33844 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
33847 If the process is not a daemon process or a queue runner process or a delivery
33848 process or a process for testing address routing (started with &%-bt%&), the
33849 uid and gid are changed to the Exim user and group. This means that Exim always
33850 runs under its own uid and gid when receiving messages. This also applies when
33851 testing address verification
33854 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
33857 For a daemon, queue runner, delivery, or address testing process, the uid
33858 remains as root at this stage, but the gid is changed to the Exim group.
33861 The processes that initially retain root privilege behave as follows:
33864 A daemon process changes the gid to the Exim group and the uid to the Exim
33865 user after setting up one or more listening sockets. The &[initgroups()]&
33866 function is called, so that if the Exim user is in any additional groups, they
33867 will be used during message reception.
33869 A queue runner process retains root privilege throughout its execution. Its
33870 job is to fork a controlled sequence of delivery processes.
33872 A delivery process retains root privilege throughout most of its execution,
33873 but any actual deliveries (that is, the transports themselves) are run in
33874 subprocesses which always change to a non-root uid and gid. For local
33875 deliveries this is typically the uid and gid of the owner of the mailbox; for
33876 remote deliveries, the Exim uid and gid are used. Once all the delivery
33877 subprocesses have been run, a delivery process changes to the Exim uid and gid
33878 while doing post-delivery tidying up such as updating the retry database and
33879 generating bounce and warning messages.
33881 While the recipient addresses in a message are being routed, the delivery
33882 process runs as root. However, if a user's filter file has to be processed,
33883 this is done in a subprocess that runs under the individual user's uid and
33884 gid. A system filter is run as root unless &%system_filter_user%& is set.
33886 A process that is testing addresses (the &%-bt%& option) runs as root so that
33887 the routing is done in the same environment as a message delivery.
33893 .section "Running Exim without privilege" "SECTrunexiwitpri"
33894 .cindex "privilege, running without"
33895 .cindex "unprivileged running"
33896 .cindex "root privilege" "running without"
33897 Some installations like to run Exim in an unprivileged state for more of its
33898 operation, for added security. Support for this mode of operation is provided
33899 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
33900 gid are changed to the Exim user and group at the start of a delivery process
33901 (and also queue runner and address testing processes). This means that address
33902 routing is no longer run as root, and the deliveries themselves cannot change
33906 .cindex "daemon" "restarting"
33907 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
33908 that the daemon can still be started in the usual way, and it can respond
33909 correctly to SIGHUP because the re-invocation regains root privilege.
33911 An alternative approach is to make Exim setuid to the Exim user and also setgid
33912 to the Exim group. If you do this, the daemon must be started from a root
33913 process. (Calling Exim from a root process makes it behave in the way it does
33914 when it is setuid root.) However, the daemon cannot restart itself after a
33915 SIGHUP signal because it cannot regain privilege.
33917 It is still useful to set &%deliver_drop_privilege%& in this case, because it
33918 stops Exim from trying to re-invoke itself to do a delivery after a message has
33919 been received. Such a re-invocation is a waste of resources because it has no
33922 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
33923 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
33924 to the Exim user seems a clean approach, but there is one complication:
33926 In this style of operation, Exim is running with the real uid and gid set to
33927 those of the calling process, and the effective uid/gid set to Exim's values.
33928 Ideally, any association with the calling process' uid/gid should be dropped,
33929 that is, the real uid/gid should be reset to the effective values so as to
33930 discard any privileges that the caller may have. While some operating systems
33931 have a function that permits this action for a non-root effective uid, quite a
33932 number of them do not. Because of this lack of standardization, Exim does not
33933 address this problem at this time.
33935 For this reason, the recommended approach for &"mostly unprivileged"& running
33936 is to keep the Exim binary setuid to root, and to set
33937 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
33938 be used in the most straightforward way.
33940 If you configure Exim not to run delivery processes as root, there are a
33941 number of restrictions on what you can do:
33944 You can deliver only as the Exim user/group. You should explicitly use the
33945 &%user%& and &%group%& options to override routers or local transports that
33946 normally deliver as the recipient. This makes sure that configurations that
33947 work in this mode function the same way in normal mode. Any implicit or
33948 explicit specification of another user causes an error.
33950 Use of &_.forward_& files is severely restricted, such that it is usually
33951 not worthwhile to include them in the configuration.
33953 Users who wish to use &_.forward_& would have to make their home directory and
33954 the file itself accessible to the Exim user. Pipe and append-to-file entries,
33955 and their equivalents in Exim filters, cannot be used. While they could be
33956 enabled in the Exim user's name, that would be insecure and not very useful.
33958 Unless the local user mailboxes are all owned by the Exim user (possible in
33959 some POP3 or IMAP-only environments):
33962 They must be owned by the Exim group and be writeable by that group. This
33963 implies you must set &%mode%& in the appendfile configuration, as well as the
33964 mode of the mailbox files themselves.
33966 You must set &%no_check_owner%&, since most or all of the files will not be
33967 owned by the Exim user.
33969 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
33970 on a newly created mailbox when unprivileged. This also implies that new
33971 mailboxes need to be created manually.
33976 These restrictions severely restrict what can be done in local deliveries.
33977 However, there are no restrictions on remote deliveries. If you are running a
33978 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
33979 gives more security at essentially no cost.
33981 If you are using the &%mua_wrapper%& facility (see chapter
33982 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
33987 .section "Delivering to local files" "SECID271"
33988 Full details of the checks applied by &(appendfile)& before it writes to a file
33989 are given in chapter &<<CHAPappendfile>>&.
33993 .section "IPv4 source routing" "SECID272"
33994 .cindex "source routing" "in IP packets"
33995 .cindex "IP source routing"
33996 Many operating systems suppress IP source-routed packets in the kernel, but
33997 some cannot be made to do this, so Exim does its own check. It logs incoming
33998 IPv4 source-routed TCP calls, and then drops them. Things are all different in
33999 IPv6. No special checking is currently done.
34003 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
34004 Support for these SMTP commands is disabled by default. If required, they can
34005 be enabled by defining suitable ACLs.
34010 .section "Privileged users" "SECID274"
34011 .cindex "trusted users"
34012 .cindex "admin user"
34013 .cindex "privileged user"
34014 .cindex "user" "trusted"
34015 .cindex "user" "admin"
34016 Exim recognizes two sets of users with special privileges. Trusted users are
34017 able to submit new messages to Exim locally, but supply their own sender
34018 addresses and information about a sending host. For other users submitting
34019 local messages, Exim sets up the sender address from the uid, and doesn't
34020 permit a remote host to be specified.
34023 However, an untrusted user is permitted to use the &%-f%& command line option
34024 in the special form &%-f <>%& to indicate that a delivery failure for the
34025 message should not cause an error report. This affects the message's envelope,
34026 but it does not affect the &'Sender:'& header. Untrusted users may also be
34027 permitted to use specific forms of address with the &%-f%& option by setting
34028 the &%untrusted_set_sender%& option.
34030 Trusted users are used to run processes that receive mail messages from some
34031 other mail domain and pass them on to Exim for delivery either locally, or over
34032 the Internet. Exim trusts a caller that is running as root, as the Exim user,
34033 as any user listed in the &%trusted_users%& configuration option, or under any
34034 group listed in the &%trusted_groups%& option.
34036 Admin users are permitted to do things to the messages on Exim's queue. They
34037 can freeze or thaw messages, cause them to be returned to their senders, remove
34038 them entirely, or modify them in various ways. In addition, admin users can run
34039 the Exim monitor and see all the information it is capable of providing, which
34040 includes the contents of files on the spool.
34044 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
34045 delivery of messages on its queue is restricted to admin users. This
34046 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
34047 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
34048 queue is also restricted to admin users. This restriction can be relaxed by
34049 setting &%no_queue_list_requires_admin%&.
34051 Exim recognizes an admin user if the calling process is running as root or as
34052 the Exim user or if any of the groups associated with the calling process is
34053 the Exim group. It is not necessary actually to be running under the Exim
34054 group. However, if admin users who are not root or the Exim user are to access
34055 the contents of files on the spool via the Exim monitor (which runs
34056 unprivileged), Exim must be built to allow group read access to its spool
34061 .section "Spool files" "SECID275"
34062 .cindex "spool directory" "files"
34063 Exim's spool directory and everything it contains is owned by the Exim user and
34064 set to the Exim group. The mode for spool files is defined in the
34065 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
34066 any user who is a member of the Exim group can access these files.
34070 .section "Use of argv[0]" "SECID276"
34071 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
34072 of specific strings, Exim assumes certain options. For example, calling Exim
34073 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
34074 to calling it with the option &%-bS%&. There are no security implications in
34079 .section "Use of %f formatting" "SECID277"
34080 The only use made of &"%f"& by Exim is in formatting load average values. These
34081 are actually stored in integer variables as 1000 times the load average.
34082 Consequently, their range is limited and so therefore is the length of the
34087 .section "Embedded Exim path" "SECID278"
34088 Exim uses its own path name, which is embedded in the code, only when it needs
34089 to re-exec in order to regain root privilege. Therefore, it is not root when it
34090 does so. If some bug allowed the path to get overwritten, it would lead to an
34091 arbitrary program's being run as exim, not as root.
34095 .section "Use of sprintf()" "SECID279"
34096 .cindex "&[sprintf()]&"
34097 A large number of occurrences of &"sprintf"& in the code are actually calls to
34098 &'string_sprintf()'&, a function that returns the result in malloc'd store.
34099 The intermediate formatting is done into a large fixed buffer by a function
34100 that runs through the format string itself, and checks the length of each
34101 conversion before performing it, thus preventing buffer overruns.
34103 The remaining uses of &[sprintf()]& happen in controlled circumstances where
34104 the output buffer is known to be sufficiently long to contain the converted
34109 .section "Use of debug_printf() and log_write()" "SECID280"
34110 Arbitrary strings are passed to both these functions, but they do their
34111 formatting by calling the function &'string_vformat()'&, which runs through
34112 the format string itself, and checks the length of each conversion.
34116 .section "Use of strcat() and strcpy()" "SECID281"
34117 These are used only in cases where the output buffer is known to be large
34118 enough to hold the result.
34119 .ecindex IIDsecurcon
34124 . ////////////////////////////////////////////////////////////////////////////
34125 . ////////////////////////////////////////////////////////////////////////////
34127 .chapter "Format of spool files" "CHAPspool"
34128 .scindex IIDforspo1 "format" "spool files"
34129 .scindex IIDforspo2 "spool directory" "format of files"
34130 .scindex IIDforspo3 "spool files" "format of"
34131 .cindex "spool files" "editing"
34132 A message on Exim's queue consists of two files, whose names are the message id
34133 followed by -D and -H, respectively. The data portion of the message is kept in
34134 the -D file on its own. The message's envelope, status, and headers are all
34135 kept in the -H file, whose format is described in this chapter. Each of these
34136 two files contains the final component of its own name as its first line. This
34137 is insurance against disk crashes where the directory is lost but the files
34138 themselves are recoverable.
34140 Some people are tempted into editing -D files in order to modify messages. You
34141 need to be extremely careful if you do this; it is not recommended and you are
34142 on your own if you do it. Here are some of the pitfalls:
34145 You must ensure that Exim does not try to deliver the message while you are
34146 fiddling with it. The safest way is to take out a write lock on the -D file,
34147 which is what Exim itself does, using &[fcntl()]&. If you update the file in
34148 place, the lock will be retained. If you write a new file and rename it, the
34149 lock will be lost at the instant of rename.
34151 .vindex "&$body_linecount$&"
34152 If you change the number of lines in the file, the value of
34153 &$body_linecount$&, which is stored in the -H file, will be incorrect. At
34154 present, this value is not used by Exim, but there is no guarantee that this
34155 will always be the case.
34157 If the message is in MIME format, you must take care not to break it.
34159 If the message is cryptographically signed, any change will invalidate the
34162 All in all, modifying -D files is fraught with danger.
34164 Files whose names end with -J may also be seen in the &_input_& directory (or
34165 its subdirectories when &%split_spool_directory%& is set). These are journal
34166 files, used to record addresses to which the message has been delivered during
34167 the course of a delivery attempt. If there are still undelivered recipients at
34168 the end, the -H file is updated, and the -J file is deleted. If, however, there
34169 is some kind of crash (for example, a power outage) before this happens, the -J
34170 file remains in existence. When Exim next processes the message, it notices the
34171 -J file and uses it to update the -H file before starting the next delivery
34174 .section "Format of the -H file" "SECID282"
34175 .cindex "uid (user id)" "in spool file"
34176 .cindex "gid (group id)" "in spool file"
34177 The second line of the -H file contains the login name for the uid of the
34178 process that called Exim to read the message, followed by the numerical uid and
34179 gid. For a locally generated message, this is normally the user who sent the
34180 message. For a message received over TCP/IP via the daemon, it is
34181 normally the Exim user.
34183 The third line of the file contains the address of the message's sender as
34184 transmitted in the envelope, contained in angle brackets. The sender address is
34185 empty for bounce messages. For incoming SMTP mail, the sender address is given
34186 in the MAIL command. For locally generated mail, the sender address is
34187 created by Exim from the login name of the current user and the configured
34188 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
34189 leading &"From&~"& line if the caller is trusted, or if the supplied address is
34190 &"<>"& or an address that matches &%untrusted_set_senders%&.
34192 The fourth line contains two numbers. The first is the time that the message
34193 was received, in the conventional Unix form &-- the number of seconds since the
34194 start of the epoch. The second number is a count of the number of messages
34195 warning of delayed delivery that have been sent to the sender.
34197 There follow a number of lines starting with a hyphen. These can appear in any
34198 order, and are omitted when not relevant:
34201 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
34202 This item is obsolete, and is not generated from Exim release 4.61 onwards;
34203 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
34204 recognized, to provide backward compatibility. In the old format, a line of
34205 this form is present for every ACL variable that is not empty. The number
34206 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
34207 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
34208 the data string for the variable. The string itself starts at the beginning of
34209 the next line, and is followed by a newline character. It may contain internal
34212 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
34213 A line of this form is present for every ACL connection variable that is
34214 defined. Note that there is a space between &%-aclc%& and the rest of the name.
34215 The length is the length of the data string for the variable. The string itself
34216 starts at the beginning of the next line, and is followed by a newline
34217 character. It may contain internal newlines.
34219 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
34220 A line of this form is present for every ACL message variable that is defined.
34221 Note that there is a space between &%-aclm%& and the rest of the name. The
34222 length is the length of the data string for the variable. The string itself
34223 starts at the beginning of the next line, and is followed by a newline
34224 character. It may contain internal newlines.
34226 .vitem "&%-active_hostname%&&~<&'hostname'&>"
34227 This is present if, when the message was received over SMTP, the value of
34228 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
34230 .vitem &%-allow_unqualified_recipient%&
34231 This is present if unqualified recipient addresses are permitted in header
34232 lines (to stop such addresses from being qualified if rewriting occurs at
34233 transport time). Local messages that were input using &%-bnq%& and remote
34234 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
34236 .vitem &%-allow_unqualified_sender%&
34237 This is present if unqualified sender addresses are permitted in header lines
34238 (to stop such addresses from being qualified if rewriting occurs at transport
34239 time). Local messages that were input using &%-bnq%& and remote messages from
34240 hosts that match &%sender_unqualified_hosts%& set this flag.
34242 .vitem "&%-auth_id%&&~<&'text'&>"
34243 The id information for a message received on an authenticated SMTP connection
34244 &-- the value of the &$authenticated_id$& variable.
34246 .vitem "&%-auth_sender%&&~<&'address'&>"
34247 The address of an authenticated sender &-- the value of the
34248 &$authenticated_sender$& variable.
34250 .vitem "&%-body_linecount%&&~<&'number'&>"
34251 This records the number of lines in the body of the message, and is always
34254 .vitem "&%-body_zerocount%&&~<&'number'&>"
34255 This records the number of binary zero bytes in the body of the message, and is
34256 present if the number is greater than zero.
34258 .vitem &%-deliver_firsttime%&
34259 This is written when a new message is first added to the spool. When the spool
34260 file is updated after a deferral, it is omitted.
34262 .vitem "&%-frozen%&&~<&'time'&>"
34263 .cindex "frozen messages" "spool data"
34264 The message is frozen, and the freezing happened at <&'time'&>.
34266 .vitem "&%-helo_name%&&~<&'text'&>"
34267 This records the host name as specified by a remote host in a HELO or EHLO
34270 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
34271 This records the IP address of the host from which the message was received and
34272 the remote port number that was used. It is omitted for locally generated
34275 .vitem "&%-host_auth%&&~<&'text'&>"
34276 If the message was received on an authenticated SMTP connection, this records
34277 the name of the authenticator &-- the value of the
34278 &$sender_host_authenticated$& variable.
34280 .vitem &%-host_lookup_failed%&
34281 This is present if an attempt to look up the sending host's name from its IP
34282 address failed. It corresponds to the &$host_lookup_failed$& variable.
34284 .vitem "&%-host_name%&&~<&'text'&>"
34285 .cindex "reverse DNS lookup"
34286 .cindex "DNS" "reverse lookup"
34287 This records the name of the remote host from which the message was received,
34288 if the host name was looked up from the IP address when the message was being
34289 received. It is not present if no reverse lookup was done.
34291 .vitem "&%-ident%&&~<&'text'&>"
34292 For locally submitted messages, this records the login of the originating user,
34293 unless it was a trusted user and the &%-oMt%& option was used to specify an
34294 ident value. For messages received over TCP/IP, this records the ident string
34295 supplied by the remote host, if any.
34297 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
34298 This records the IP address of the local interface and the port number through
34299 which a message was received from a remote host. It is omitted for locally
34300 generated messages.
34303 The message is from a local sender.
34305 .vitem &%-localerror%&
34306 The message is a locally-generated bounce message.
34308 .vitem "&%-local_scan%&&~<&'string'&>"
34309 This records the data string that was returned by the &[local_scan()]& function
34310 when the message was received &-- the value of the &$local_scan_data$&
34311 variable. It is omitted if no data was returned.
34313 .vitem &%-manual_thaw%&
34314 The message was frozen but has been thawed manually, that is, by an explicit
34315 Exim command rather than via the auto-thaw process.
34318 A testing delivery process was started using the &%-N%& option to suppress any
34319 actual deliveries, but delivery was deferred. At any further delivery attempts,
34322 .vitem &%-received_protocol%&
34323 This records the value of the &$received_protocol$& variable, which contains
34324 the name of the protocol by which the message was received.
34326 .vitem &%-sender_set_untrusted%&
34327 The envelope sender of this message was set by an untrusted local caller (used
34328 to ensure that the caller is displayed in queue listings).
34330 .vitem "&%-spam_score_int%&&~<&'number'&>"
34331 If a message was scanned by SpamAssassin, this is present. It records the value
34332 of &$spam_score_int$&.
34334 .vitem &%-tls_certificate_verified%&
34335 A TLS certificate was received from the client that sent this message, and the
34336 certificate was verified by the server.
34338 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
34339 When the message was received over an encrypted connection, this records the
34340 name of the cipher suite that was used.
34342 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
34343 When the message was received over an encrypted connection, and a certificate
34344 was received from the client, this records the Distinguished Name from that
34348 Following the options there is a list of those addresses to which the message
34349 is not to be delivered. This set of addresses is initialized from the command
34350 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
34351 is set; otherwise it starts out empty. Whenever a successful delivery is made,
34352 the address is added to this set. The addresses are kept internally as a
34353 balanced binary tree, and it is a representation of that tree which is written
34354 to the spool file. If an address is expanded via an alias or forward file, the
34355 original address is added to the tree when deliveries to all its child
34356 addresses are complete.
34358 If the tree is empty, there is a single line in the spool file containing just
34359 the text &"XX"&. Otherwise, each line consists of two letters, which are either
34360 Y or N, followed by an address. The address is the value for the node of the
34361 tree, and the letters indicate whether the node has a left branch and/or a
34362 right branch attached to it, respectively. If branches exist, they immediately
34363 follow. Here is an example of a three-node tree:
34365 YY darcy@austen.fict.example
34366 NN alice@wonderland.fict.example
34367 NN editor@thesaurus.ref.example
34369 After the non-recipients tree, there is a list of the message's recipients.
34370 This is a simple list, preceded by a count. It includes all the original
34371 recipients of the message, including those to whom the message has already been
34372 delivered. In the simplest case, the list contains one address per line. For
34376 editor@thesaurus.ref.example
34377 darcy@austen.fict.example
34379 alice@wonderland.fict.example
34381 However, when a child address has been added to the top-level addresses as a
34382 result of the use of the &%one_time%& option on a &(redirect)& router, each
34383 line is of the following form:
34385 <&'top-level address'&> <&'errors_to address'&> &&&
34386 <&'length'&>,<&'parent number'&>#<&'flag bits'&>
34388 The 01 flag bit indicates the presence of the three other fields that follow
34389 the top-level address. Other bits may be used in future to support additional
34390 fields. The <&'parent number'&> is the offset in the recipients list of the
34391 original parent of the &"one time"& address. The first two fields are the
34392 envelope sender that is associated with this address and its length. If the
34393 length is zero, there is no special envelope sender (there are then two space
34394 characters in the line). A non-empty field can arise from a &(redirect)& router
34395 that has an &%errors_to%& setting.
34398 A blank line separates the envelope and status information from the headers
34399 which follow. A header may occupy several lines of the file, and to save effort
34400 when reading it in, each header is preceded by a number and an identifying
34401 character. The number is the number of characters in the header, including any
34402 embedded newlines and the terminating newline. The character is one of the
34406 .row <&'blank'&> "header in which Exim has no special interest"
34407 .row &`B`& "&'Bcc:'& header"
34408 .row &`C`& "&'Cc:'& header"
34409 .row &`F`& "&'From:'& header"
34410 .row &`I`& "&'Message-id:'& header"
34411 .row &`P`& "&'Received:'& header &-- P for &""postmark""&"
34412 .row &`R`& "&'Reply-To:'& header"
34413 .row &`S`& "&'Sender:'& header"
34414 .row &`T`& "&'To:'& header"
34415 .row &`*`& "replaced or deleted header"
34418 Deleted or replaced (rewritten) headers remain in the spool file for debugging
34419 purposes. They are not transmitted when the message is delivered. Here is a
34420 typical set of headers:
34422 111P Received: by hobbit.fict.example with local (Exim 4.00)
34423 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
34424 049 Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
34425 038* X-rewrote-sender: bb@hobbit.fict.example
34426 042* From: Bilbo Baggins <bb@hobbit.fict.example>
34427 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
34428 099* To: alice@wonderland.fict.example, rdo@foundation,
34429 darcy@austen.fict.example, editor@thesaurus.ref.example
34430 104T To: alice@wonderland.fict.example, rdo@foundation.example,
34431 darcy@austen.fict.example, editor@thesaurus.ref.example
34432 038 Date: Fri, 11 May 2001 10:28:59 +0100
34434 The asterisked headers indicate that the envelope sender, &'From:'& header, and
34435 &'To:'& header have been rewritten, the last one because routing expanded the
34436 unqualified domain &'foundation'&.
34437 .ecindex IIDforspo1
34438 .ecindex IIDforspo2
34439 .ecindex IIDforspo3
34441 . ////////////////////////////////////////////////////////////////////////////
34442 . ////////////////////////////////////////////////////////////////////////////
34444 .chapter "Support for DKIM (DomainKeys Identified Mail) - RFC4871" "CHID12" &&&
34448 Since version 4.70, DKIM support is compiled into Exim by default. It can be
34449 disabled by setting DISABLE_DKIM=yes in Local/Makefile.
34451 Exim's DKIM implementation allows to
34453 Sign outgoing messages: This function is implemented in the SMTP transport.
34454 It can co-exist with all other Exim features, including transport filters.
34456 Verify signatures in incoming messages: This is implemented by an additional
34457 ACL (acl_smtp_dkim), which can be called several times per message, with
34458 different signature contexts.
34461 In typical Exim style, the verification implementation does not include any
34462 default "policy". Instead it enables you to build your own policy using
34463 Exim's standard controls.
34465 Please note that verification of DKIM signatures in incoming mail is turned
34466 on by default for logging purposes. For each signature in incoming email,
34467 exim will log a line displaying the most important signature details, and the
34468 signature status. Here is an example:
34470 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]
34472 You might want to turn off DKIM verification processing entirely for internal
34473 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
34474 control modifier. This should typically be done in the RCPT ACL, at points
34475 where you accept mail from relay sources (internal hosts or authenticated
34479 .section "Signing outgoing messages" "SECID513"
34480 .cindex "DKIM" "signing"
34482 Signing is implemented by setting private options on the SMTP transport.
34483 These options take (expandable) strings as arguments.
34485 .option dkim_domain smtp string&!! unset
34487 The domain you want to sign with. The result of this expanded
34488 option is put into the &%$dkim_domain%& expansion variable.
34490 .option dkim_selector smtp string&!! unset
34492 This sets the key selector string. You can use the &%$dkim_domain%& expansion
34493 variable to look up a matching selector. The result is put in the expansion
34494 variable &%$dkim_selector%& which should be used in the &%dkim_private_key%&
34495 option along with &%$dkim_domain%&.
34497 .option dkim_private_key smtp string&!! unset
34499 This sets the private key to use. You can use the &%$dkim_domain%& and
34500 &%$dkim_selector%& expansion variables to determine the private key to use.
34501 The result can either
34503 be a valid RSA private key in ASCII armor, including line breaks.
34505 start with a slash, in which case it is treated as a file that contains
34508 be "0", "false" or the empty string, in which case the message will not
34509 be signed. This case will not result in an error, even if &%dkim_strict%&
34513 .option dkim_canon smtp string&!! unset
34515 This option sets the canonicalization method used when signing a message.
34516 The DKIM RFC currently supports two methods: "simple" and "relaxed".
34517 The option defaults to "relaxed" when unset. Note: the current implementation
34518 only supports using the same canonicalization method for both headers and body.
34520 .option dkim_strict smtp string&!! unset
34522 This option defines how Exim behaves when signing a message that
34523 should be signed fails for some reason. When the expansion evaluates to
34524 either "1" or "true", Exim will defer. Otherwise Exim will send the message
34525 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
34528 .option dkim_sign_headers smtp string&!! unset
34530 When set, this option must expand to (or be specified as) a colon-separated
34531 list of header names. Headers with these names will be included in the message
34532 signature. When unspecified, the header names recommended in RFC4871 will be
34536 .section "Verifying DKIM signatures in incoming mail" "SECID514"
34537 .cindex "DKIM" "verification"
34539 Verification of DKIM signatures in incoming email is implemented via the
34540 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
34541 syntactically(!) correct signature in the incoming message.
34543 To evaluate the signature in the ACL a large number of expansion variables
34544 containing the signature status and its details are set up during the
34545 runtime of the ACL.
34547 Calling the ACL only for existing signatures is not sufficient to build
34548 more advanced policies. For that reason, the global option
34549 &%dkim_verify_signers%&, and a global expansion variable
34550 &%$dkim_signers%& exist.
34552 The global option &%dkim_verify_signers%& can be set to a colon-separated
34553 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
34554 called. It is expanded when the message has been received. At this point,
34555 the expansion variable &%$dkim_signers%& already contains a colon-separated
34556 list of signer domains and identities for the message. When
34557 &%dkim_verify_signers%& is not specified in the main configuration,
34560 dkim_verify_signers = $dkim_signers
34562 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
34563 DKIM signature in the message. Current DKIM verifiers may want to explicitly
34564 call the ACL for known domains or identities. This would be achieved as follows:
34566 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
34568 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
34569 and "ebay.com", plus all domains and identities that have signatures in the message.
34570 You can also be more creative in constructing your policy. For example:
34572 dkim_verify_signers = $sender_address_domain:$dkim_signers
34575 If a domain or identity is listed several times in the (expanded) value of
34576 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
34579 Inside the &%acl_smtp_dkim%&, the following expansion variables are
34580 available (from most to least important):
34583 .vitem &%$dkim_cur_signer%&
34584 The signer that is being evaluated in this ACL run. This can be a domain or
34585 an identity. This is one of the list items from the expanded main option
34586 &%dkim_verify_signers%& (see above).
34587 .vitem &%$dkim_verify_status%&
34588 A string describing the general status of the signature. One of
34590 &%none%&: There is no signature in the message for the current domain or
34591 identity (as reflected by &%$dkim_cur_signer%&).
34593 &%invalid%&: The signature could not be verified due to a processing error.
34594 More detail is available in &%$dkim_verify_reason%&.
34596 &%fail%&: Verification of the signature failed. More detail is
34597 available in &%$dkim_verify_reason%&.
34599 &%pass%&: The signature passed verification. It is valid.
34601 .vitem &%$dkim_verify_reason%&
34602 A string giving a litte bit more detail when &%$dkim_verify_status%& is either
34603 "fail" or "invalid". One of
34605 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
34606 key for the domain could not be retrieved. This may be a temporary problem.
34608 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
34609 record for the domain is syntactically invalid.
34611 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
34612 body hash does not match the one specified in the signature header. This
34613 means that the message body was modified in transit.
34615 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
34616 could not be verified. This may mean that headers were modified,
34617 re-written or otherwise changed in a way which is incompatible with
34618 DKIM verification. It may of course also mean that the signature is forged.
34620 .vitem &%$dkim_domain%&
34621 The signing domain. IMPORTANT: This variable is only populated if there is
34622 an actual signature in the message for the current domain or identity (as
34623 reflected by &%$dkim_cur_signer%&).
34624 .vitem &%$dkim_identity%&
34625 The signing identity, if present. IMPORTANT: This variable is only populated
34626 if there is an actual signature in the message for the current domain or
34627 identity (as reflected by &%$dkim_cur_signer%&).
34628 .vitem &%$dkim_selector%&
34629 The key record selector string.
34630 .vitem &%$dkim_algo%&
34631 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
34632 .vitem &%$dkim_canon_body%&
34633 The body canonicalization method. One of 'relaxed' or 'simple'.
34634 .vitem &%dkim_canon_headers%&
34635 The header canonicalization method. One of 'relaxed' or 'simple'.
34636 .vitem &%$dkim_copiedheaders%&
34637 A transcript of headers and their values which are included in the signature
34638 (copied from the 'z=' tag of the signature).
34639 .vitem &%$dkim_bodylength%&
34640 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
34641 limit was set by the signer, "9999999999999" is returned. This makes sure
34642 that this variable always expands to an integer value.
34643 .vitem &%$dkim_created%&
34644 UNIX timestamp reflecting the date and time when the signature was created.
34645 When this was not specified by the signer, "0" is returned.
34646 .vitem &%$dkim_expires%&
34647 UNIX timestamp reflecting the date and time when the signer wants the
34648 signature to be treated as "expired". When this was not specified by the
34649 signer, "9999999999999" is returned. This makes it possible to do useful
34650 integer size comparisons against this value.
34651 .vitem &%$dkim_headernames%&
34652 A colon-separated list of names of headers included in the signature.
34653 .vitem &%$dkim_key_testing%&
34654 "1" if the key record has the "testing" flag set, "0" if not.
34655 .vitem &%$dkim_key_nosubdomaining%&
34656 "1" if the key record forbids subdomaining, "0" otherwise.
34657 .vitem &%$dkim_key_srvtype%&
34658 Service type (tag s=) from the key record. Defaults to "*" if not specified
34660 .vitem &%$dkim_key_granularity%&
34661 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
34663 .vitem &%$dkim_key_notes%&
34664 Notes from the key record (tag n=).
34667 In addition, two ACL conditions are provided:
34670 .vitem &%dkim_signers%&
34671 ACL condition that checks a colon-separated list of domains or identities
34672 for a match against the domain or identity that the ACL is currently verifying
34673 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
34674 verb to a group of domains or identities. For example:
34677 # Warn when message apparently from GMail has no signature at all
34678 warn log_message = GMail sender without DKIM signature
34679 sender_domains = gmail.com
34680 dkim_signers = gmail.com
34684 .vitem &%dkim_status%&
34685 ACL condition that checks a colon-separated list of possible DKIM verification
34686 results agains the actual result of verification. This is typically used
34687 to restrict an ACL verb to a list of verification outcomes, like:
34690 deny message = Message from Paypal with invalid or missing signature
34691 sender_domains = paypal.com:paypal.de
34692 dkim_signers = paypal.com:paypal.de
34693 dkim_status = none:invalid:fail
34696 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
34697 see the documentation of the &%$dkim_verify_status%& expansion variable above
34698 for more information of what they mean.
34701 . ////////////////////////////////////////////////////////////////////////////
34702 . ////////////////////////////////////////////////////////////////////////////
34704 .chapter "Adding new drivers or lookup types" "CHID13" &&&
34705 "Adding drivers or lookups"
34706 .cindex "adding drivers"
34707 .cindex "new drivers, adding"
34708 .cindex "drivers" "adding new"
34709 The following actions have to be taken in order to add a new router, transport,
34710 authenticator, or lookup type to Exim:
34713 Choose a name for the driver or lookup type that does not conflict with any
34714 existing name; I will use &"newdriver"& in what follows.
34716 Add to &_src/EDITME_& the line:
34718 <&'type'&>&`_NEWDRIVER=yes`&
34720 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
34721 code is not to be included in the binary by default, comment this line out. You
34722 should also add any relevant comments about the driver or lookup type.
34724 Add to &_src/config.h.defaults_& the line:
34726 #define <type>_NEWDRIVER
34729 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
34730 and create a table entry as is done for all the other drivers and lookup types.
34732 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
34733 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
34734 driver or lookup type and add it to the definition of OBJ.
34736 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
34739 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
34740 as for other drivers and lookups.
34743 Then all you need to do is write the code! A good way to start is to make a
34744 proforma by copying an existing module of the same type, globally changing all
34745 occurrences of the name, and cutting out most of the code. Note that any
34746 options you create must be listed in alphabetical order, because the tables are
34747 searched using a binary chop procedure.
34749 There is a &_README_& file in each of the sub-directories of &_src_& describing
34750 the interface that is expected.
34755 . ////////////////////////////////////////////////////////////////////////////
34756 . ////////////////////////////////////////////////////////////////////////////
34758 . /////////////////////////////////////////////////////////////////////////////
34759 . These lines are processing instructions for the Simple DocBook Processor that
34760 . Philip Hazel has developed as a less cumbersome way of making PostScript and
34761 . PDFs than using xmlto and fop. They will be ignored by all other XML
34763 . /////////////////////////////////////////////////////////////////////////////
34768 foot_right_recto="&chaptertitle;"
34769 foot_right_verso="&chaptertitle;"
34773 .makeindex "Options index" "option"
34774 .makeindex "Variables index" "variable"
34775 .makeindex "Concept index" "concept"
34778 . /////////////////////////////////////////////////////////////////////////////
34779 . /////////////////////////////////////////////////////////////////////////////