659a469bf1e30a90530b5d65003c0926f82193ef
[users/jgh/exim.git] / doc / doc-docbook / spec.xfpt
1 . $Cambridge: exim/doc/doc-docbook/spec.xfpt,v 1.88 2010/06/14 18:51:09 pdp Exp $
2 .
3 . /////////////////////////////////////////////////////////////////////////////
4 . This is the primary source of the Exim Manual. It is an xfpt document that is
5 . converted into DocBook XML for subsequent conversion into printing and online
6 . formats. The markup used herein is "standard" xfpt markup, with some extras.
7 . The markup is summarized in a file called Markup.txt.
8 .
9 . WARNING: When you use the .new macro, make sure it appears *before* any
10 . adjacent index items; otherwise you get an empty "paragraph" which causes
11 . unwanted vertical space.
12 . /////////////////////////////////////////////////////////////////////////////
13
14 .include stdflags
15 .include stdmacs
16
17 . /////////////////////////////////////////////////////////////////////////////
18 . This outputs the standard DocBook boilerplate.
19 . /////////////////////////////////////////////////////////////////////////////
20
21 .docbook
22
23 . /////////////////////////////////////////////////////////////////////////////
24 . These lines are processing instructions for the Simple DocBook Processor that
25 . Philip Hazel has developed as a less cumbersome way of making PostScript and
26 . PDFs than using xmlto and fop. They will be ignored by all other XML
27 . processors.
28 . /////////////////////////////////////////////////////////////////////////////
29
30 .literal xml
31 <?sdop
32   foot_right_recto="&chaptertitle; (&chapternumber;)"
33   foot_right_verso="&chaptertitle; (&chapternumber;)"
34   toc_chapter_blanks="yes,yes"
35   table_warn_overflow="overprint"
36 ?>
37 .literal off
38
39 . /////////////////////////////////////////////////////////////////////////////
40 . This generate the outermost <book> element that wraps then entire document.
41 . /////////////////////////////////////////////////////////////////////////////
42
43 .book
44
45 . /////////////////////////////////////////////////////////////////////////////
46 . These definitions set some parameters and save some typing. Remember that
47 . the <bookinfo> element must also be updated for each new edition.
48 . /////////////////////////////////////////////////////////////////////////////
49
50 .set previousversion "4.72"
51 .set version "4.74"
52
53 .set ACL "access control lists (ACLs)"
54 .set I   "&nbsp;&nbsp;&nbsp;&nbsp;"
55
56
57 . /////////////////////////////////////////////////////////////////////////////
58 . Additional xfpt markup used by this document, over and above the default
59 . provided in the xfpt library.
60 . /////////////////////////////////////////////////////////////////////////////
61
62 . --- Override the &$ flag to automatically insert a $ with the variable name
63
64 .flag &$  $&   "<varname>$"  "</varname>"
65
66 . --- Short flags for daggers in option headings. They will always be inside
67 . --- an italic string, but we want the daggers to be roman.
68
69 .flag &!!      "</emphasis>&dagger;<emphasis>"
70 .flag &!?      "</emphasis>&Dagger;<emphasis>"
71
72 . --- A macro for an Exim option definition heading, generating a one-line
73 . --- table with four columns. For cases when the option name is given with
74 . --- a space, so that it can be split, a fifth argument is used for the
75 . --- index entry.
76
77 .macro option
78 .arg 5
79 .oindex "&%$5%&"
80 .endarg
81 .arg -5
82 .oindex "&%$1%&"
83 .endarg
84 .itable all 0 0 4 8* left 6* center 6* center 6* right
85 .row "&%$1%&" "Use: &'$2'&" "Type: &'$3'&" "Default: &'$4'&"
86 .endtable
87 .endmacro
88
89 . --- A macro for the common 2-column tables. The width of the first column
90 . --- is suitable for the many tables at the start of the main options chapter;
91 . --- the small number of other 2-column tables override it.
92
93 .macro table2 196pt 254pt
94 .itable none 0 0 2 $1 left $2 left
95 .endmacro
96
97 . --- A macro that generates .row, but puts &I; at the start of the first
98 . --- argument, thus indenting it. Assume a minimum of two arguments, and
99 . --- allow up to four arguments, which is as many as we'll ever need.
100
101 .macro irow
102 .arg 4
103 .row "&I;$1" "$2" "$3" "$4"
104 .endarg
105 .arg -4
106 .arg 3
107 .row "&I;$1" "$2" "$3"
108 .endarg
109 .arg -3
110 .row "&I;$1" "$2"
111 .endarg
112 .endarg
113 .endmacro
114
115 . --- Macros for option, variable, and concept index entries. For a "range"
116 . --- style of entry, use .scindex for the start and .ecindex for the end. The
117 . --- first argument of .scindex and the only argument of .ecindex must be the
118 . --- ID that ties them together.
119
120 .macro cindex
121 &<indexterm role="concept">&
122 &<primary>&$1&</primary>&
123 .arg 2
124 &<secondary>&$2&</secondary>&
125 .endarg
126 &</indexterm>&
127 .endmacro
128
129 .macro scindex
130 &<indexterm role="concept" id="$1" class="startofrange">&
131 &<primary>&$2&</primary>&
132 .arg 3
133 &<secondary>&$3&</secondary>&
134 .endarg
135 &</indexterm>&
136 .endmacro
137
138 .macro ecindex
139 &<indexterm role="concept" startref="$1" class="endofrange"/>&
140 .endmacro
141
142 .macro oindex
143 &<indexterm role="option">&
144 &<primary>&$1&</primary>&
145 .arg 2
146 &<secondary>&$2&</secondary>&
147 .endarg
148 &</indexterm>&
149 .endmacro
150
151 .macro vindex
152 &<indexterm role="variable">&
153 &<primary>&$1&</primary>&
154 .arg 2
155 &<secondary>&$2&</secondary>&
156 .endarg
157 &</indexterm>&
158 .endmacro
159
160 .macro index
161 .echo "** Don't use .index; use .cindex or .oindex or .vindex"
162 .endmacro
163 . ////////////////////////////////////////////////////////////////////////////
164
165
166 . ////////////////////////////////////////////////////////////////////////////
167 . The <bookinfo> element is removed from the XML before processing for Ascii
168 . output formats.
169 . ////////////////////////////////////////////////////////////////////////////
170
171 .literal xml
172 <bookinfo>
173 <title>Specification of the Exim Mail Transfer Agent</title>
174 <titleabbrev>The Exim MTA</titleabbrev>
175 <date>21 Jan 2011</date>
176 <author><firstname>Exim</firstname><surname>Maintainers</surname></author>
177 <authorinitials>EM</authorinitials>
178 <revhistory><revision>
179   <revnumber>4.74</revnumber>
180   <date>21 Jan 2011</date>
181   <authorinitials>EM</authorinitials>
182 </revision></revhistory>
183 <copyright><year>2011</year><holder>University of Cambridge</holder></copyright>
184 </bookinfo>
185 .literal off
186
187
188 . /////////////////////////////////////////////////////////////////////////////
189 . This chunk of literal XML implements index entries of the form "x, see y" and
190 . "x, see also y". However, the DocBook DTD doesn't allow <indexterm> entries
191 . at the top level, so we have to put the .chapter directive first.
192 . /////////////////////////////////////////////////////////////////////////////
193
194 .chapter "Introduction" "CHID1"
195 .literal xml
196
197 <indexterm role="variable">
198   <primary>$1, $2, etc.</primary>
199   <see><emphasis>numerical variables</emphasis></see>
200 </indexterm>
201 <indexterm role="concept">
202   <primary>address</primary>
203   <secondary>rewriting</secondary>
204   <see><emphasis>rewriting</emphasis></see>
205 </indexterm>
206 <indexterm role="concept">
207   <primary>Bounce Address Tag Validation</primary>
208   <see><emphasis>BATV</emphasis></see>
209 </indexterm>
210 <indexterm role="concept">
211   <primary>Client SMTP Authorization</primary>
212   <see><emphasis>CSA</emphasis></see>
213 </indexterm>
214 <indexterm role="concept">
215   <primary>CR character</primary>
216   <see><emphasis>carriage return</emphasis></see>
217 </indexterm>
218 <indexterm role="concept">
219   <primary>CRL</primary>
220   <see><emphasis>certificate revocation list</emphasis></see>
221 </indexterm>
222 <indexterm role="concept">
223   <primary>delivery</primary>
224   <secondary>failure report</secondary>
225   <see><emphasis>bounce message</emphasis></see>
226 </indexterm>
227 <indexterm role="concept">
228   <primary>dialup</primary>
229   <see><emphasis>intermittently connected hosts</emphasis></see>
230 </indexterm>
231 <indexterm role="concept">
232   <primary>exiscan</primary>
233   <see><emphasis>content scanning</emphasis></see>
234 </indexterm>
235 <indexterm role="concept">
236   <primary>failover</primary>
237   <see><emphasis>fallback</emphasis></see>
238 </indexterm>
239 <indexterm role="concept">
240   <primary>fallover</primary>
241   <see><emphasis>fallback</emphasis></see>
242 </indexterm>
243 <indexterm role="concept">
244   <primary>filter</primary>
245   <secondary>Sieve</secondary>
246   <see><emphasis>Sieve filter</emphasis></see>
247 </indexterm>
248 <indexterm role="concept">
249   <primary>ident</primary>
250   <see><emphasis>RFC 1413</emphasis></see>
251 </indexterm>
252 <indexterm role="concept">
253   <primary>LF character</primary>
254   <see><emphasis>linefeed</emphasis></see>
255 </indexterm>
256 <indexterm role="concept">
257   <primary>maximum</primary>
258   <seealso><emphasis>limit</emphasis></seealso>
259 </indexterm>
260 <indexterm role="concept">
261   <primary>monitor</primary>
262   <see><emphasis>Exim monitor</emphasis></see>
263 </indexterm>
264 <indexterm role="concept">
265   <primary>no_<emphasis>xxx</emphasis></primary>
266   <see>entry for xxx</see>
267 </indexterm>
268 <indexterm role="concept">
269   <primary>NUL</primary>
270   <see><emphasis>binary zero</emphasis></see>
271 </indexterm>
272 <indexterm role="concept">
273   <primary>passwd file</primary>
274   <see><emphasis>/etc/passwd</emphasis></see>
275 </indexterm>
276 <indexterm role="concept">
277   <primary>process id</primary>
278   <see><emphasis>pid</emphasis></see>
279 </indexterm>
280 <indexterm role="concept">
281   <primary>RBL</primary>
282   <see><emphasis>DNS list</emphasis></see>
283 </indexterm>
284 <indexterm role="concept">
285   <primary>redirection</primary>
286   <see><emphasis>address redirection</emphasis></see>
287 </indexterm>
288 <indexterm role="concept">
289   <primary>return path</primary>
290   <seealso><emphasis>envelope sender</emphasis></seealso>
291 </indexterm>
292 <indexterm role="concept">
293   <primary>scanning</primary>
294   <see><emphasis>content scanning</emphasis></see>
295 </indexterm>
296 <indexterm role="concept">
297   <primary>SSL</primary>
298   <see><emphasis>TLS</emphasis></see>
299 </indexterm>
300 <indexterm role="concept">
301   <primary>string</primary>
302   <secondary>expansion</secondary>
303   <see><emphasis>expansion</emphasis></see>
304 </indexterm>
305 <indexterm role="concept">
306   <primary>top bit</primary>
307   <see><emphasis>8-bit characters</emphasis></see>
308 </indexterm>
309 <indexterm role="concept">
310   <primary>variables</primary>
311   <see><emphasis>expansion, variables</emphasis></see>
312 </indexterm>
313 <indexterm role="concept">
314   <primary>zero, binary</primary>
315   <see><emphasis>binary zero</emphasis></see>
316 </indexterm>
317
318 .literal off
319
320
321 . /////////////////////////////////////////////////////////////////////////////
322 . This is the real start of the first chapter. See the comment above as to why
323 . we can't have the .chapter line here.
324 . chapter "Introduction"
325 . /////////////////////////////////////////////////////////////////////////////
326
327 Exim is a mail transfer agent (MTA) for hosts that are running Unix or
328 Unix-like operating systems. It was designed on the assumption that it would be
329 run on hosts that are permanently connected to the Internet. However, it can be
330 used on intermittently connected hosts with suitable configuration adjustments.
331
332 Configuration files currently exist for the following operating systems: AIX,
333 BSD/OS (aka BSDI), Darwin (Mac OS X), DGUX, Dragonfly, FreeBSD, GNU/Hurd,
334 GNU/Linux, HI-OSF (Hitachi), HI-UX, HP-UX, IRIX, MIPS RISCOS, NetBSD, OpenBSD,
335 OpenUNIX, QNX, SCO, SCO SVR4.2 (aka UNIX-SV), Solaris (aka SunOS5), SunOS4,
336 Tru64-Unix (formerly Digital UNIX, formerly DEC-OSF1), Ultrix, and Unixware.
337 Some of these operating systems are no longer current and cannot easily be
338 tested, so the configuration files may no longer work in practice.
339
340 There are also configuration files for compiling Exim in the Cygwin environment
341 that can be installed on systems running Windows. However, this document does
342 not contain any information about running Exim in the Cygwin environment.
343
344 The terms and conditions for the use and distribution of Exim are contained in
345 the file &_NOTICE_&. Exim is distributed under the terms of the GNU General
346 Public Licence, a copy of which may be found in the file &_LICENCE_&.
347
348 The use, supply or promotion of Exim for the purpose of sending bulk,
349 unsolicited electronic mail is incompatible with the basic aims of the program,
350 which revolve around the free provision of a service that enhances the quality
351 of personal communications. The author of Exim regards indiscriminate
352 mass-mailing as an antisocial, irresponsible abuse of the Internet.
353
354 Exim owes a great deal to Smail 3 and its author, Ron Karr. Without the
355 experience of running and working on the Smail 3 code, I could never have
356 contemplated starting to write a new MTA. Many of the ideas and user interfaces
357 were originally taken from Smail 3, though the actual code of Exim is entirely
358 new, and has developed far beyond the initial concept.
359
360 Many people, both in Cambridge and around the world, have contributed to the
361 development and the testing of Exim, and to porting it to various operating
362 systems. I am grateful to them all. The distribution now contains a file called
363 &_ACKNOWLEDGMENTS_&, in which I have started recording the names of
364 contributors.
365
366
367 .section "Exim documentation" "SECID1"
368 . Keep this example change bar when updating the documentation!
369
370 .new
371 .cindex "documentation"
372 This edition of the Exim specification applies to version &version; of Exim.
373 Substantive changes from the &previousversion; edition are marked in some
374 renditions of the document; this paragraph is so marked if the rendition is
375 capable of showing a change indicator.
376 .wen
377
378 This document is very much a reference manual; it is not a tutorial. The reader
379 is expected to have some familiarity with the SMTP mail transfer protocol and
380 with general Unix system administration. Although there are some discussions
381 and examples in places, the information is mostly organized in a way that makes
382 it easy to look up, rather than in a natural order for sequential reading.
383 Furthermore, the manual aims to cover every aspect of Exim in detail, including
384 a number of rarely-used, special-purpose features that are unlikely to be of
385 very wide interest.
386
387 .cindex "books about Exim"
388 An &"easier"& discussion of Exim which provides more in-depth explanatory,
389 introductory, and tutorial material can be found in a book entitled &'The Exim
390 SMTP Mail Server'& (second edition, 2007), published by UIT Cambridge
391 (&url(http://www.uit.co.uk/exim-book/)).
392
393 This book also contains a chapter that gives a general introduction to SMTP and
394 Internet mail. Inevitably, however, the book is unlikely to be fully up-to-date
395 with the latest release of Exim. (Note that the earlier book about Exim,
396 published by O'Reilly, covers Exim 3, and many things have changed in Exim 4.)
397
398 .cindex "Debian" "information sources"
399 If you are using a Debian distribution of Exim, you will find information about
400 Debian-specific features in the file
401 &_/usr/share/doc/exim4-base/README.Debian_&.
402 The command &(man update-exim.conf)& is another source of Debian-specific
403 information.
404
405 .cindex "&_doc/NewStuff_&"
406 .cindex "&_doc/ChangeLog_&"
407 .cindex "change log"
408 As the program develops, there may be features in newer versions that have not
409 yet made it into this document, which is updated only when the most significant
410 digit of the fractional part of the version number changes. Specifications of
411 new features that are not yet in this manual are placed in the file
412 &_doc/NewStuff_& in the Exim distribution.
413
414 Some features may be classified as &"experimental"&. These may change
415 incompatibly while they are developing, or even be withdrawn. For this reason,
416 they are not documented in this manual. Information about experimental features
417 can be found in the file &_doc/experimental.txt_&.
418
419 All changes to the program (whether new features, bug fixes, or other kinds of
420 change) are noted briefly in the file called &_doc/ChangeLog_&.
421
422 .cindex "&_doc/spec.txt_&"
423 This specification itself is available as an ASCII file in &_doc/spec.txt_& so
424 that it can easily be searched with a text editor. Other files in the &_doc_&
425 directory are:
426
427 .table2 100pt
428 .row &_OptionLists.txt_&     "list of all options in alphabetical order"
429 .row &_dbm.discuss.txt_&     "discussion about DBM libraries"
430 .row &_exim.8_&              "a man page of Exim's command line options"
431 .row &_experimental.txt_&    "documentation of experimental features"
432 .row &_filter.txt_&          "specification of the filter language"
433 .row &_Exim3.upgrade_&       "upgrade notes from release 2 to release 3"
434 .row &_Exim4.upgrade_&       "upgrade notes from release 3 to release 4"
435 .endtable
436
437 The main specification and the specification of the filtering language are also
438 available in other formats (HTML, PostScript, PDF, and Texinfo). Section
439 &<<SECTavail>>& below tells you how to get hold of these.
440
441
442
443 .section "FTP and web sites" "SECID2"
444 .cindex "web site"
445 .cindex "FTP site"
446 The primary site for Exim source distributions is currently the University of
447 Cambridge's FTP site, whose contents are described in &'Where to find the Exim
448 distribution'& below. In addition, there is a web site and an FTP site at
449 &%exim.org%&. These are now also hosted at the University of Cambridge. The
450 &%exim.org%& site was previously hosted for a number of years by Energis
451 Squared, formerly Planet Online Ltd, whose support I gratefully acknowledge.
452
453 .cindex "wiki"
454 .cindex "FAQ"
455 As well as Exim distribution tar files, the Exim web site contains a number of
456 differently formatted versions of the documentation. A recent addition to the
457 online information is the Exim wiki (&url(http://wiki.exim.org)),
458 which contains what used to be a separate FAQ, as well as various other
459 examples, tips, and know-how that have been contributed by Exim users.
460
461 .cindex Bugzilla
462 An Exim Bugzilla exists at &url(http://bugs.exim.org). You can use
463 this to report bugs, and also to add items to the wish list. Please search
464 first to check that you are not duplicating a previous entry.
465
466
467
468 .section "Mailing lists" "SECID3"
469 .cindex "mailing lists" "for Exim users"
470 The following Exim mailing lists exist:
471
472 .table2 140pt
473 .row &'exim-users@exim.org'&      "General discussion list"
474 .row &'exim-dev@exim.org'&        "Discussion of bugs, enhancements, etc."
475 .row &'exim-announce@exim.org'&   "Moderated, low volume announcements list"
476 .row &'exim-future@exim.org'&     "Discussion of long-term development"
477 .endtable
478
479 You can subscribe to these lists, change your existing subscriptions, and view
480 or search the archives via the mailing lists link on the Exim home page.
481 .cindex "Debian" "mailing list for"
482 If you are using a Debian distribution of Exim, you may wish to subscribe to
483 the Debian-specific mailing list &'pkg-exim4-users@lists.alioth.debian.org'&
484 via this web page:
485 .display
486 &url(http://lists.alioth.debian.org/mailman/listinfo/pkg-exim4-users)
487 .endd
488 Please ask Debian-specific questions on this list and not on the general Exim
489 lists.
490
491 .section "Exim training" "SECID4"
492 .cindex "training courses"
493 Training courses in Cambridge (UK) used to be run annually by the author of
494 Exim, before he retired. At the time of writing, there are no plans to run
495 further Exim courses in Cambridge. However, if that changes, relevant
496 information will be posted at &url(http://www-tus.csx.cam.ac.uk/courses/exim/).
497
498 .section "Bug reports" "SECID5"
499 .cindex "bug reports"
500 .cindex "reporting bugs"
501 Reports of obvious bugs can be emailed to &'bugs@exim.org'& or reported
502 via the Bugzilla (&url(http://bugs.exim.org)). However, if you are unsure
503 whether some behaviour is a bug or not, the best thing to do is to post a
504 message to the &'exim-dev'& mailing list and have it discussed.
505
506
507
508 .section "Where to find the Exim distribution" "SECTavail"
509 .cindex "FTP site"
510 .cindex "distribution" "ftp site"
511 The master ftp site for the Exim distribution is
512 .display
513 &*ftp://ftp.csx.cam.ac.uk/pub/software/email/exim*&
514 .endd
515 This is mirrored by
516 .display
517 &*ftp://ftp.exim.org/pub/exim*&
518 .endd
519 The file references that follow are relative to the &_exim_& directories at
520 these sites. There are now quite a number of independent mirror sites around
521 the world. Those that I know about are listed in the file called &_Mirrors_&.
522
523 Within the &_exim_& directory there are subdirectories called &_exim3_& (for
524 previous Exim 3 distributions), &_exim4_& (for the latest Exim 4
525 distributions), and &_Testing_& for testing versions. In the &_exim4_&
526 subdirectory, the current release can always be found in files called
527 .display
528 &_exim-n.nn.tar.gz_&
529 &_exim-n.nn.tar.bz2_&
530 .endd
531 where &'n.nn'& is the highest such version number in the directory. The two
532 files contain identical data; the only difference is the type of compression.
533 The &_.bz2_& file is usually a lot smaller than the &_.gz_& file.
534
535 .cindex "distribution" "signing details"
536 .cindex "distribution" "public key"
537 .cindex "public key for signed distribution"
538 The distributions are currently signed with Nigel Metheringham's GPG key. The
539 corresponding public key is available from a number of keyservers, and there is
540 also a copy in the file &_nigel-pubkey.asc_&. The signatures for the tar bundles are
541 in:
542 .display
543 &_exim-n.nn.tar.gz.asc_&
544 &_exim-n.nn.tar.bz2.asc_&
545 .endd
546 For each released version, the log of changes is made separately available in a
547 separate file in the directory &_ChangeLogs_& so that it is possible to
548 find out what has changed without having to download the entire distribution.
549
550 .cindex "documentation" "available formats"
551 The main distribution contains ASCII versions of this specification and other
552 documentation; other formats of the documents are available in separate files
553 inside the &_exim4_& directory of the FTP site:
554 .display
555 &_exim-html-n.nn.tar.gz_&
556 &_exim-pdf-n.nn.tar.gz_&
557 &_exim-postscript-n.nn.tar.gz_&
558 &_exim-texinfo-n.nn.tar.gz_&
559 .endd
560 These tar files contain only the &_doc_& directory, not the complete
561 distribution, and are also available in &_.bz2_& as well as &_.gz_& forms.
562
563
564 .section "Limitations" "SECID6"
565 .ilist
566 .cindex "limitations of Exim"
567 .cindex "bang paths" "not handled by Exim"
568 Exim is designed for use as an Internet MTA, and therefore handles addresses in
569 RFC 2822 domain format only. It cannot handle UUCP &"bang paths"&, though
570 simple two-component bang paths can be converted by a straightforward rewriting
571 configuration. This restriction does not prevent Exim from being interfaced to
572 UUCP as a transport mechanism, provided that domain addresses are used.
573 .next
574 .cindex "domainless addresses"
575 .cindex "address" "without domain"
576 Exim insists that every address it handles has a domain attached. For incoming
577 local messages, domainless addresses are automatically qualified with a
578 configured domain value. Configuration options specify from which remote
579 systems unqualified addresses are acceptable. These are then qualified on
580 arrival.
581 .next
582 .cindex "transport" "external"
583 .cindex "external transports"
584 The only external transport mechanisms that are currently implemented are SMTP
585 and LMTP over a TCP/IP network (including support for IPv6). However, a pipe
586 transport is available, and there are facilities for writing messages to files
587 and pipes, optionally in &'batched SMTP'& format; these facilities can be used
588 to send messages to other transport mechanisms such as UUCP, provided they can
589 handle domain-style addresses. Batched SMTP input is also catered for.
590 .next
591 Exim is not designed for storing mail for dial-in hosts. When the volumes of
592 such mail are large, it is better to get the messages &"delivered"& into files
593 (that is, off Exim's queue) and subsequently passed on to the dial-in hosts by
594 other means.
595 .next
596 Although Exim does have basic facilities for scanning incoming messages, these
597 are not comprehensive enough to do full virus or spam scanning. Such operations
598 are best carried out using additional specialized software packages. If you
599 compile Exim with the content-scanning extension, straightforward interfaces to
600 a number of common scanners are provided.
601 .endlist
602
603
604 .section "Run time configuration" "SECID7"
605 Exim's run time configuration is held in a single text file that is divided
606 into a number of sections. The entries in this file consist of keywords and
607 values, in the style of Smail 3 configuration files. A default configuration
608 file which is suitable for simple online installations is provided in the
609 distribution, and is described in chapter &<<CHAPdefconfil>>& below.
610
611
612 .section "Calling interface" "SECID8"
613 .cindex "Sendmail compatibility" "command line interface"
614 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
615 can be a straight replacement for &_/usr/lib/sendmail_& or
616 &_/usr/sbin/sendmail_& when sending mail, but you do not need to know anything
617 about Sendmail in order to run Exim. For actions other than sending messages,
618 Sendmail-compatible options also exist, but those that produce output (for
619 example, &%-bp%&, which lists the messages on the queue) do so in Exim's own
620 format. There are also some additional options that are compatible with Smail
621 3, and some further options that are new to Exim. Chapter &<<CHAPcommandline>>&
622 documents all Exim's command line options. This information is automatically
623 made into the man page that forms part of the Exim distribution.
624
625 Control of messages on the queue can be done via certain privileged command
626 line options. There is also an optional monitor program called &'eximon'&,
627 which displays current information in an X window, and which contains a menu
628 interface to Exim's command line administration options.
629
630
631
632 .section "Terminology" "SECID9"
633 .cindex "terminology definitions"
634 .cindex "body of message" "definition of"
635 The &'body'& of a message is the actual data that the sender wants to transmit.
636 It is the last part of a message, and is separated from the &'header'& (see
637 below) by a blank line.
638
639 .cindex "bounce message" "definition of"
640 When a message cannot be delivered, it is normally returned to the sender in a
641 delivery failure message or a &"non-delivery report"& (NDR). The term
642 &'bounce'& is commonly used for this action, and the error reports are often
643 called &'bounce messages'&. This is a convenient shorthand for &"delivery
644 failure error report"&. Such messages have an empty sender address in the
645 message's &'envelope'& (see below) to ensure that they cannot themselves give
646 rise to further bounce messages.
647
648 The term &'default'& appears frequently in this manual. It is used to qualify a
649 value which is used in the absence of any setting in the configuration. It may
650 also qualify an action which is taken unless a configuration setting specifies
651 otherwise.
652
653 The term &'defer'& is used when the delivery of a message to a specific
654 destination cannot immediately take place for some reason (a remote host may be
655 down, or a user's local mailbox may be full). Such deliveries are &'deferred'&
656 until a later time.
657
658 The word &'domain'& is sometimes used to mean all but the first component of a
659 host's name. It is &'not'& used in that sense here, where it normally refers to
660 the part of an email address following the @ sign.
661
662 .cindex "envelope, definition of"
663 .cindex "sender" "definition of"
664 A message in transit has an associated &'envelope'&, as well as a header and a
665 body. The envelope contains a sender address (to which bounce messages should
666 be delivered), and any number of recipient addresses. References to the
667 sender or the recipients of a message usually mean the addresses in the
668 envelope. An MTA uses these addresses for delivery, and for returning bounce
669 messages, not the addresses that appear in the header lines.
670
671 .cindex "message" "header, definition of"
672 .cindex "header section" "definition of"
673 The &'header'& of a message is the first part of a message's text, consisting
674 of a number of lines, each of which has a name such as &'From:'&, &'To:'&,
675 &'Subject:'&, etc. Long header lines can be split over several text lines by
676 indenting the continuations. The header is separated from the body by a blank
677 line.
678
679 .cindex "local part" "definition of"
680 .cindex "domain" "definition of"
681 The term &'local part'&, which is taken from RFC 2822, is used to refer to that
682 part of an email address that precedes the @ sign. The part that follows the
683 @ sign is called the &'domain'& or &'mail domain'&.
684
685 .cindex "local delivery" "definition of"
686 .cindex "remote delivery, definition of"
687 The terms &'local delivery'& and &'remote delivery'& are used to distinguish
688 delivery to a file or a pipe on the local host from delivery by SMTP over
689 TCP/IP to another host. As far as Exim is concerned, all hosts other than the
690 host it is running on are &'remote'&.
691
692 .cindex "return path" "definition of"
693 &'Return path'& is another name that is used for the sender address in a
694 message's envelope.
695
696 .cindex "queue" "definition of"
697 The term &'queue'& is used to refer to the set of messages awaiting delivery,
698 because this term is in widespread use in the context of MTAs. However, in
699 Exim's case the reality is more like a pool than a queue, because there is
700 normally no ordering of waiting messages.
701
702 .cindex "queue runner" "definition of"
703 The term &'queue runner'& is used to describe a process that scans the queue
704 and attempts to deliver those messages whose retry times have come. This term
705 is used by other MTAs, and also relates to the command &%runq%&, but in Exim
706 the waiting messages are normally processed in an unpredictable order.
707
708 .cindex "spool directory" "definition of"
709 The term &'spool directory'& is used for a directory in which Exim keeps the
710 messages on its queue &-- that is, those that it is in the process of
711 delivering. This should not be confused with the directory in which local
712 mailboxes are stored, which is called a &"spool directory"& by some people. In
713 the Exim documentation, &"spool"& is always used in the first sense.
714
715
716
717
718
719
720 . ////////////////////////////////////////////////////////////////////////////
721 . ////////////////////////////////////////////////////////////////////////////
722
723 .chapter "Incorporated code" "CHID2"
724 .cindex "incorporated code"
725 .cindex "regular expressions" "library"
726 .cindex "PCRE"
727 A number of pieces of external code are included in the Exim distribution.
728
729 .ilist
730 Regular expressions are supported in the main Exim program and in the
731 Exim monitor using the freely-distributable PCRE library, copyright
732 &copy; University of Cambridge. The source to PCRE is no longer shipped with
733 Exim, so you will need to use the version of PCRE shipped with your system,
734 or obtain and install the full version of the library from
735 &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre).
736 .next
737 .cindex "cdb" "acknowledgment"
738 Support for the cdb (Constant DataBase) lookup method is provided by code
739 contributed by Nigel Metheringham of (at the time he contributed it) Planet
740 Online Ltd. The implementation is completely contained within the code of Exim.
741 It does not link against an external cdb library. The code contains the
742 following statements:
743
744 .blockquote
745 Copyright &copy; 1998 Nigel Metheringham, Planet Online Ltd
746
747 This program is free software; you can redistribute it and/or modify it under
748 the terms of the GNU General Public License as published by the Free Software
749 Foundation; either version 2 of the License, or (at your option) any later
750 version.
751 This code implements Dan Bernstein's Constant DataBase (cdb) spec. Information,
752 the spec and sample code for cdb can be obtained from
753 &url(http://www.pobox.com/~djb/cdb.html). This implementation borrows
754 some code from Dan Bernstein's implementation (which has no license
755 restrictions applied to it).
756 .endblockquote
757 .next
758 .cindex "SPA authentication"
759 .cindex "Samba project"
760 .cindex "Microsoft Secure Password Authentication"
761 Client support for Microsoft's &'Secure Password Authentication'& is provided
762 by code contributed by Marc Prud'hommeaux. Server support was contributed by
763 Tom Kistner. This includes code taken from the Samba project, which is released
764 under the Gnu GPL.
765 .next
766 .cindex "Cyrus"
767 .cindex "&'pwcheck'& daemon"
768 .cindex "&'pwauthd'& daemon"
769 Support for calling the Cyrus &'pwcheck'& and &'saslauthd'& daemons is provided
770 by code taken from the Cyrus-SASL library and adapted by Alexander S.
771 Sabourenkov. The permission notice appears below, in accordance with the
772 conditions expressed therein.
773
774 .blockquote
775 Copyright &copy; 2001 Carnegie Mellon University.  All rights reserved.
776
777 Redistribution and use in source and binary forms, with or without
778 modification, are permitted provided that the following conditions
779 are met:
780
781 .olist
782 Redistributions of source code must retain the above copyright
783 notice, this list of conditions and the following disclaimer.
784 .next
785 Redistributions in binary form must reproduce the above copyright
786 notice, this list of conditions and the following disclaimer in
787 the documentation and/or other materials provided with the
788 distribution.
789 .next
790 The name &"Carnegie Mellon University"& must not be used to
791 endorse or promote products derived from this software without
792 prior written permission. For permission or any other legal
793 details, please contact
794 .display
795               Office of Technology Transfer
796               Carnegie Mellon University
797               5000 Forbes Avenue
798               Pittsburgh, PA  15213-3890
799               (412) 268-4387, fax: (412) 268-7395
800               tech-transfer@andrew.cmu.edu
801 .endd
802 .next
803 Redistributions of any form whatsoever must retain the following
804 acknowledgment:
805
806 &"This product includes software developed by Computing Services
807 at Carnegie Mellon University (&url(http://www.cmu.edu/computing/)."&
808
809 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
810 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
811 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
812 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
813 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
814 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
815 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
816 .endlist
817 .endblockquote
818
819 .next
820 .cindex "Exim monitor" "acknowledgment"
821 .cindex "X-windows"
822 .cindex "Athena"
823 The Exim Monitor program, which is an X-Window application, includes
824 modified versions of the Athena StripChart and TextPop widgets.
825 This code is copyright by DEC and MIT, and their permission notice appears
826 below, in accordance with the conditions expressed therein.
827
828 .blockquote
829 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
830 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
831
832 All Rights Reserved
833
834 Permission to use, copy, modify, and distribute this software and its
835 documentation for any purpose and without fee is hereby granted,
836 provided that the above copyright notice appear in all copies and that
837 both that copyright notice and this permission notice appear in
838 supporting documentation, and that the names of Digital or MIT not be
839 used in advertising or publicity pertaining to distribution of the
840 software without specific, written prior permission.
841
842 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
843 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
844 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
845 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
846 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
847 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
848 SOFTWARE.
849 .endblockquote
850
851 .next
852 Many people have contributed code fragments, some large, some small, that were
853 not covered by any specific licence requirements. It is assumed that the
854 contributors are happy to see their code incorporated into Exim under the GPL.
855 .endlist
856
857
858
859
860
861 . ////////////////////////////////////////////////////////////////////////////
862 . ////////////////////////////////////////////////////////////////////////////
863
864 .chapter "How Exim receives and delivers mail" "CHID11" &&&
865          "Receiving and delivering mail"
866
867
868 .section "Overall philosophy" "SECID10"
869 .cindex "design philosophy"
870 Exim is designed to work efficiently on systems that are permanently connected
871 to the Internet and are handling a general mix of mail. In such circumstances,
872 most messages can be delivered immediately. Consequently, Exim does not
873 maintain independent queues of messages for specific domains or hosts, though
874 it does try to send several messages in a single SMTP connection after a host
875 has been down, and it also maintains per-host retry information.
876
877
878 .section "Policy control" "SECID11"
879 .cindex "policy control" "overview"
880 Policy controls are now an important feature of MTAs that are connected to the
881 Internet. Perhaps their most important job is to stop MTAs being abused as
882 &"open relays"& by misguided individuals who send out vast amounts of
883 unsolicited junk, and want to disguise its source. Exim provides flexible
884 facilities for specifying policy controls on incoming mail:
885
886 .ilist
887 .cindex "&ACL;" "introduction"
888 Exim 4 (unlike previous versions of Exim) implements policy controls on
889 incoming mail by means of &'Access Control Lists'& (ACLs). Each list is a
890 series of statements that may either grant or deny access. ACLs can be used at
891 several places in the SMTP dialogue while receiving a message from a remote
892 host. However, the most common places are after each RCPT command, and at the
893 very end of the message. The sysadmin can specify conditions for accepting or
894 rejecting individual recipients or the entire message, respectively, at these
895 two points (see chapter &<<CHAPACL>>&). Denial of access results in an SMTP
896 error code.
897 .next
898 An ACL is also available for locally generated, non-SMTP messages. In this
899 case, the only available actions are to accept or deny the entire message.
900 .next
901 When Exim is compiled with the content-scanning extension, facilities are
902 provided in the ACL mechanism for passing the message to external virus and/or
903 spam scanning software. The result of such a scan is passed back to the ACL,
904 which can then use it to decide what to do with the message.
905 .next
906 When a message has been received, either from a remote host or from the local
907 host, but before the final acknowledgment has been sent, a locally supplied C
908 function called &[local_scan()]& can be run to inspect the message and decide
909 whether to accept it or not (see chapter &<<CHAPlocalscan>>&). If the message
910 is accepted, the list of recipients can be modified by the function.
911 .next
912 Using the &[local_scan()]& mechanism is another way of calling external scanner
913 software. The &%SA-Exim%& add-on package works this way. It does not require
914 Exim to be compiled with the content-scanning extension.
915 .next
916 After a message has been accepted, a further checking mechanism is available in
917 the form of the &'system filter'& (see chapter &<<CHAPsystemfilter>>&). This
918 runs at the start of every delivery process.
919 .endlist
920
921
922
923 .section "User filters" "SECID12"
924 .cindex "filter" "introduction"
925 .cindex "Sieve filter"
926 In a conventional Exim configuration, users are able to run private filters by
927 setting up appropriate &_.forward_& files in their home directories. See
928 chapter &<<CHAPredirect>>& (about the &(redirect)& router) for the
929 configuration needed to support this, and the separate document entitled
930 &'Exim's interfaces to mail filtering'& for user details. Two different kinds
931 of filtering are available:
932
933 .ilist
934 Sieve filters are written in the standard filtering language that is defined
935 by RFC 3028.
936 .next
937 Exim filters are written in a syntax that is unique to Exim, but which is more
938 powerful than Sieve, which it pre-dates.
939 .endlist
940
941 User filters are run as part of the routing process, described below.
942
943
944
945 .section "Message identification" "SECTmessiden"
946 .cindex "message ids" "details of format"
947 .cindex "format" "of message id"
948 .cindex "id of message"
949 .cindex "base62"
950 .cindex "base36"
951 .cindex "Darwin"
952 .cindex "Cygwin"
953 Every message handled by Exim is given a &'message id'& which is sixteen
954 characters long. It is divided into three parts, separated by hyphens, for
955 example &`16VDhn-0001bo-D3`&. Each part is a sequence of letters and digits,
956 normally encoding numbers in base 62. However, in the Darwin operating
957 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
958 (avoiding the use of lower case letters) is used instead, because the message
959 id is used to construct file names, and the names of files in those systems are
960 not always case-sensitive.
961
962 .cindex "pid (process id)" "re-use of"
963 The detail of the contents of the message id have changed as Exim has evolved.
964 Earlier versions relied on the operating system not re-using a process id (pid)
965 within one second. On modern operating systems, this assumption can no longer
966 be made, so the algorithm had to be changed. To retain backward compatibility,
967 the format of the message id was retained, which is why the following rules are
968 somewhat eccentric:
969
970 .ilist
971 The first six characters of the message id are the time at which the message
972 started to be received, to a granularity of one second. That is, this field
973 contains the number of seconds since the start of the epoch (the normal Unix
974 way of representing the date and time of day).
975 .next
976 After the first hyphen, the next six characters are the id of the process that
977 received the message.
978 .next
979 There are two different possibilities for the final two characters:
980 .olist
981 .oindex "&%localhost_number%&"
982 If &%localhost_number%& is not set, this value is the fractional part of the
983 time of reception, normally in units of 1/2000 of a second, but for systems
984 that must use base 36 instead of base 62 (because of case-insensitive file
985 systems), the units are 1/1000 of a second.
986 .next
987 If &%localhost_number%& is set, it is multiplied by 200 (100) and added to
988 the fractional part of the time, which in this case is in units of 1/200
989 (1/100) of a second.
990 .endlist
991 .endlist
992
993 After a message has been received, Exim waits for the clock to tick at the
994 appropriate resolution before proceeding, so that if another message is
995 received by the same process, or by another process with the same (re-used)
996 pid, it is guaranteed that the time will be different. In most cases, the clock
997 will already have ticked while the message was being received.
998
999
1000 .section "Receiving mail" "SECID13"
1001 .cindex "receiving mail"
1002 .cindex "message" "reception"
1003 The only way Exim can receive mail from another host is using SMTP over
1004 TCP/IP, in which case the sender and recipient addresses are transferred using
1005 SMTP commands. However, from a locally running process (such as a user's MUA),
1006 there are several possibilities:
1007
1008 .ilist
1009 If the process runs Exim with the &%-bm%& option, the message is read
1010 non-interactively (usually via a pipe), with the recipients taken from the
1011 command line, or from the body of the message if &%-t%& is also used.
1012 .next
1013 If the process runs Exim with the &%-bS%& option, the message is also read
1014 non-interactively, but in this case the recipients are listed at the start of
1015 the message in a series of SMTP RCPT commands, terminated by a DATA
1016 command. This is so-called &"batch SMTP"& format,
1017 but it isn't really SMTP. The SMTP commands are just another way of passing
1018 envelope addresses in a non-interactive submission.
1019 .next
1020 If the process runs Exim with the &%-bs%& option, the message is read
1021 interactively, using the SMTP protocol. A two-way pipe is normally used for
1022 passing data between the local process and the Exim process.
1023 This is &"real"& SMTP and is handled in the same way as SMTP over TCP/IP. For
1024 example, the ACLs for SMTP commands are used for this form of submission.
1025 .next
1026 A local process may also make a TCP/IP call to the host's loopback address
1027 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1028 does not treat the loopback address specially. It treats all such connections
1029 in the same way as connections from other hosts.
1030 .endlist
1031
1032
1033 .cindex "message sender, constructed by Exim"
1034 .cindex "sender" "constructed by Exim"
1035 In the three cases that do not involve TCP/IP, the sender address is
1036 constructed from the login name of the user that called Exim and a default
1037 qualification domain (which can be set by the &%qualify_domain%& configuration
1038 option). For local or batch SMTP, a sender address that is passed using the
1039 SMTP MAIL command is ignored. However, the system administrator may allow
1040 certain users (&"trusted users"&) to specify a different sender address
1041 unconditionally, or all users to specify certain forms of different sender
1042 address. The &%-f%& option or the SMTP MAIL command is used to specify these
1043 different addresses. See section &<<SECTtrustedadmin>>& for details of trusted
1044 users, and the &%untrusted_set_sender%& option for a way of allowing untrusted
1045 users to change sender addresses.
1046
1047 Messages received by either of the non-interactive mechanisms are subject to
1048 checking by the non-SMTP ACL, if one is defined. Messages received using SMTP
1049 (either over TCP/IP, or interacting with a local process) can be checked by a
1050 number of ACLs that operate at different times during the SMTP session. Either
1051 individual recipients, or the entire message, can be rejected if local policy
1052 requirements are not met. The &[local_scan()]& function (see chapter
1053 &<<CHAPlocalscan>>&) is run for all incoming messages.
1054
1055 Exim can be configured not to start a delivery process when a message is
1056 received; this can be unconditional, or depend on the number of incoming SMTP
1057 connections or the system load. In these situations, new messages wait on the
1058 queue until a queue runner process picks them up. However, in standard
1059 configurations under normal conditions, delivery is started as soon as a
1060 message is received.
1061
1062
1063
1064
1065
1066 .section "Handling an incoming message" "SECID14"
1067 .cindex "spool directory" "files that hold a message"
1068 .cindex "file" "how a message is held"
1069 When Exim accepts a message, it writes two files in its spool directory. The
1070 first contains the envelope information, the current status of the message, and
1071 the header lines, and the second contains the body of the message. The names of
1072 the two spool files consist of the message id, followed by &`-H`& for the
1073 file containing the envelope and header, and &`-D`& for the data file.
1074
1075 .cindex "spool directory" "&_input_& sub-directory"
1076 By default all these message files are held in a single directory called
1077 &_input_& inside the general Exim spool directory. Some operating systems do
1078 not perform very well if the number of files in a directory gets large; to
1079 improve performance in such cases, the &%split_spool_directory%& option can be
1080 used. This causes Exim to split up the input files into 62 sub-directories
1081 whose names are single letters or digits. When this is done, the queue is
1082 processed one sub-directory at a time instead of all at once, which can improve
1083 overall performance even when there are not enough files in each directory to
1084 affect file system performance.
1085
1086 The envelope information consists of the address of the message's sender and
1087 the addresses of the recipients. This information is entirely separate from
1088 any addresses contained in the header lines. The status of the message includes
1089 a list of recipients who have already received the message. The format of the
1090 first spool file is described in chapter &<<CHAPspool>>&.
1091
1092 .cindex "rewriting" "addresses"
1093 Address rewriting that is specified in the rewrite section of the configuration
1094 (see chapter &<<CHAPrewrite>>&) is done once and for all on incoming addresses,
1095 both in the header lines and the envelope, at the time the message is accepted.
1096 If during the course of delivery additional addresses are generated (for
1097 example, via aliasing), these new addresses are rewritten as soon as they are
1098 generated. At the time a message is actually delivered (transported) further
1099 rewriting can take place; because this is a transport option, it can be
1100 different for different forms of delivery. It is also possible to specify the
1101 addition or removal of certain header lines at the time the message is
1102 delivered (see chapters &<<CHAProutergeneric>>& and
1103 &<<CHAPtransportgeneric>>&).
1104
1105
1106
1107 .section "Life of a message" "SECID15"
1108 .cindex "message" "life of"
1109 .cindex "message" "frozen"
1110 A message remains in the spool directory until it is completely delivered to
1111 its recipients or to an error address, or until it is deleted by an
1112 administrator or by the user who originally created it. In cases when delivery
1113 cannot proceed &-- for example, when a message can neither be delivered to its
1114 recipients nor returned to its sender, the message is marked &"frozen"& on the
1115 spool, and no more deliveries are attempted.
1116
1117 .cindex "frozen messages" "thawing"
1118 .cindex "message" "thawing frozen"
1119 An administrator can &"thaw"& such messages when the problem has been
1120 corrected, and can also freeze individual messages by hand if necessary. In
1121 addition, an administrator can force a delivery error, causing a bounce message
1122 to be sent.
1123
1124 .oindex "&%timeout_frozen_after%&"
1125 .oindex "&%ignore_bounce_errors_after%&"
1126 There are options called &%ignore_bounce_errors_after%& and
1127 &%timeout_frozen_after%&, which discard frozen messages after a certain time.
1128 The first applies only to frozen bounces, the second to any frozen messages.
1129
1130 .cindex "message" "log file for"
1131 .cindex "log" "file for each message"
1132 While Exim is working on a message, it writes information about each delivery
1133 attempt to its main log file. This includes successful, unsuccessful, and
1134 delayed deliveries for each recipient (see chapter &<<CHAPlog>>&). The log
1135 lines are also written to a separate &'message log'& file for each message.
1136 These logs are solely for the benefit of the administrator, and are normally
1137 deleted along with the spool files when processing of a message is complete.
1138 The use of individual message logs can be disabled by setting
1139 &%no_message_logs%&; this might give an improvement in performance on very busy
1140 systems.
1141
1142 .cindex "journal file"
1143 .cindex "file" "journal"
1144 All the information Exim itself needs to set up a delivery is kept in the first
1145 spool file, along with the header lines. When a successful delivery occurs, the
1146 address is immediately written at the end of a journal file, whose name is the
1147 message id followed by &`-J`&. At the end of a delivery run, if there are some
1148 addresses left to be tried again later, the first spool file (the &`-H`& file)
1149 is updated to indicate which these are, and the journal file is then deleted.
1150 Updating the spool file is done by writing a new file and renaming it, to
1151 minimize the possibility of data loss.
1152
1153 Should the system or the program crash after a successful delivery but before
1154 the spool file has been updated, the journal is left lying around. The next
1155 time Exim attempts to deliver the message, it reads the journal file and
1156 updates the spool file before proceeding. This minimizes the chances of double
1157 deliveries caused by crashes.
1158
1159
1160
1161 .section "Processing an address for delivery" "SECTprocaddress"
1162 .cindex "drivers" "definition of"
1163 .cindex "router" "definition of"
1164 .cindex "transport" "definition of"
1165 The main delivery processing elements of Exim are called &'routers'& and
1166 &'transports'&, and collectively these are known as &'drivers'&. Code for a
1167 number of them is provided in the source distribution, and compile-time options
1168 specify which ones are included in the binary. Run time options specify which
1169 ones are actually used for delivering messages.
1170
1171 .cindex "drivers" "instance definition"
1172 Each driver that is specified in the run time configuration is an &'instance'&
1173 of that particular driver type. Multiple instances are allowed; for example,
1174 you can set up several different &(smtp)& transports, each with different
1175 option values that might specify different ports or different timeouts. Each
1176 instance has its own identifying name. In what follows we will normally use the
1177 instance name when discussing one particular instance (that is, one specific
1178 configuration of the driver), and the generic driver name when discussing
1179 the driver's features in general.
1180
1181 A &'router'& is a driver that operates on an address, either determining how
1182 its delivery should happen, by assigning it to a specific transport, or
1183 converting the address into one or more new addresses (for example, via an
1184 alias file). A router may also explicitly choose to fail an address, causing it
1185 to be bounced.
1186
1187 A &'transport'& is a driver that transmits a copy of the message from Exim's
1188 spool to some destination. There are two kinds of transport: for a &'local'&
1189 transport, the destination is a file or a pipe on the local host, whereas for a
1190 &'remote'& transport the destination is some other host. A message is passed
1191 to a specific transport as a result of successful routing. If a message has
1192 several recipients, it may be passed to a number of different transports.
1193
1194 .cindex "preconditions" "definition of"
1195 An address is processed by passing it to each configured router instance in
1196 turn, subject to certain preconditions, until a router accepts the address or
1197 specifies that it should be bounced. We will describe this process in more
1198 detail shortly. First, as a simple example, we consider how each recipient
1199 address in a message is processed in a small configuration of three routers.
1200
1201 To make this a more concrete example, it is described in terms of some actual
1202 routers, but remember, this is only an example. You can configure Exim's
1203 routers in many different ways, and there may be any number of routers in a
1204 configuration.
1205
1206 The first router that is specified in a configuration is often one that handles
1207 addresses in domains that are not recognized specially by the local host. These
1208 are typically addresses for arbitrary domains on the Internet. A precondition
1209 is set up which looks for the special domains known to the host (for example,
1210 its own domain name), and the router is run for addresses that do &'not'&
1211 match. Typically, this is a router that looks up domains in the DNS in order to
1212 find the hosts to which this address routes. If it succeeds, the address is
1213 assigned to a suitable SMTP transport; if it does not succeed, the router is
1214 configured to fail the address.
1215
1216 The second router is reached only when the domain is recognized as one that
1217 &"belongs"& to the local host. This router does redirection &-- also known as
1218 aliasing and forwarding. When it generates one or more new addresses from the
1219 original, each of them is routed independently from the start. Otherwise, the
1220 router may cause an address to fail, or it may simply decline to handle the
1221 address, in which case the address is passed to the next router.
1222
1223 The final router in many configurations is one that checks to see if the
1224 address belongs to a local mailbox. The precondition may involve a check to
1225 see if the local part is the name of a login account, or it may look up the
1226 local part in a file or a database. If its preconditions are not met, or if
1227 the router declines, we have reached the end of the routers. When this happens,
1228 the address is bounced.
1229
1230
1231
1232 .section "Processing an address for verification" "SECID16"
1233 .cindex "router" "for verification"
1234 .cindex "verifying address" "overview"
1235 As well as being used to decide how to deliver to an address, Exim's routers
1236 are also used for &'address verification'&. Verification can be requested as
1237 one of the checks to be performed in an ACL for incoming messages, on both
1238 sender and recipient addresses, and it can be tested using the &%-bv%& and
1239 &%-bvs%& command line options.
1240
1241 When an address is being verified, the routers are run in &"verify mode"&. This
1242 does not affect the way the routers work, but it is a state that can be
1243 detected. By this means, a router can be skipped or made to behave differently
1244 when verifying. A common example is a configuration in which the first router
1245 sends all messages to a message-scanning program, unless they have been
1246 previously scanned. Thus, the first router accepts all addresses without any
1247 checking, making it useless for verifying. Normally, the &%no_verify%& option
1248 would be set for such a router, causing it to be skipped in verify mode.
1249
1250
1251
1252
1253 .section "Running an individual router" "SECTrunindrou"
1254 .cindex "router" "running details"
1255 .cindex "preconditions" "checking"
1256 .cindex "router" "result of running"
1257 As explained in the example above, a number of preconditions are checked before
1258 running a router. If any are not met, the router is skipped, and the address is
1259 passed to the next router. When all the preconditions on a router &'are'& met,
1260 the router is run. What happens next depends on the outcome, which is one of
1261 the following:
1262
1263 .ilist
1264 &'accept'&: The router accepts the address, and either assigns it to a
1265 transport, or generates one or more &"child"& addresses. Processing the
1266 original address ceases,
1267 .oindex "&%unseen%&"
1268 unless the &%unseen%& option is set on the router. This option
1269 can be used to set up multiple deliveries with different routing (for example,
1270 for keeping archive copies of messages). When &%unseen%& is set, the address is
1271 passed to the next router. Normally, however, an &'accept'& return marks the
1272 end of routing.
1273
1274 Any child addresses generated by the router are processed independently,
1275 starting with the first router by default. It is possible to change this by
1276 setting the &%redirect_router%& option to specify which router to start at for
1277 child addresses. Unlike &%pass_router%& (see below) the router specified by
1278 &%redirect_router%& may be anywhere in the router configuration.
1279 .next
1280 &'pass'&: The router recognizes the address, but cannot handle it itself. It
1281 requests that the address be passed to another router. By default the address
1282 is passed to the next router, but this can be changed by setting the
1283 &%pass_router%& option. However, (unlike &%redirect_router%&) the named router
1284 must be below the current router (to avoid loops).
1285 .next
1286 &'decline'&: The router declines to accept the address because it does not
1287 recognize it at all. By default, the address is passed to the next router, but
1288 this can be prevented by setting the &%no_more%& option. When &%no_more%& is
1289 set, all the remaining routers are skipped. In effect, &%no_more%& converts
1290 &'decline'& into &'fail'&.
1291 .next
1292 &'fail'&: The router determines that the address should fail, and queues it for
1293 the generation of a bounce message. There is no further processing of the
1294 original address unless &%unseen%& is set on the router.
1295 .next
1296 &'defer'&: The router cannot handle the address at the present time. (A
1297 database may be offline, or a DNS lookup may have timed out.) No further
1298 processing of the address happens in this delivery attempt. It is tried again
1299 next time the message is considered for delivery.
1300 .next
1301 &'error'&: There is some error in the router (for example, a syntax error in
1302 its configuration). The action is as for defer.
1303 .endlist
1304
1305 If an address reaches the end of the routers without having been accepted by
1306 any of them, it is bounced as unrouteable. The default error message in this
1307 situation is &"unrouteable address"&, but you can set your own message by
1308 making use of the &%cannot_route_message%& option. This can be set for any
1309 router; the value from the last router that &"saw"& the address is used.
1310
1311 Sometimes while routing you want to fail a delivery when some conditions are
1312 met but others are not, instead of passing the address on for further routing.
1313 You can do this by having a second router that explicitly fails the delivery
1314 when the relevant conditions are met. The &(redirect)& router has a &"fail"&
1315 facility for this purpose.
1316
1317
1318 .section "Duplicate addresses" "SECID17"
1319 .cindex "case of local parts"
1320 .cindex "address duplicate, discarding"
1321 .cindex "duplicate addresses"
1322 Once routing is complete, Exim scans the addresses that are assigned to local
1323 and remote transports, and discards any duplicates that it finds. During this
1324 check, local parts are treated as case-sensitive. This happens only when
1325 actually delivering a message; when testing routers with &%-bt%&, all the
1326 routed addresses are shown.
1327
1328
1329
1330 .section "Router preconditions" "SECTrouprecon"
1331 .cindex "router" "preconditions, order of processing"
1332 .cindex "preconditions" "order of processing"
1333 The preconditions that are tested for each router are listed below, in the
1334 order in which they are tested. The individual configuration options are
1335 described in more detail in chapter &<<CHAProutergeneric>>&.
1336
1337 .ilist
1338 The &%local_part_prefix%& and &%local_part_suffix%& options can specify that
1339 the local parts handled by the router may or must have certain prefixes and/or
1340 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1341 skipped. These conditions are tested first. When an affix is present, it is
1342 removed from the local part before further processing, including the evaluation
1343 of any other conditions.
1344 .next
1345 Routers can be designated for use only when not verifying an address, that is,
1346 only when routing it for delivery (or testing its delivery routing). If the
1347 &%verify%& option is set false, the router is skipped when Exim is verifying an
1348 address.
1349 Setting the &%verify%& option actually sets two options, &%verify_sender%& and
1350 &%verify_recipient%&, which independently control the use of the router for
1351 sender and recipient verification. You can set these options directly if
1352 you want a router to be used for only one type of verification.
1353 .next
1354 If the &%address_test%& option is set false, the router is skipped when Exim is
1355 run with the &%-bt%& option to test an address routing. This can be helpful
1356 when the first router sends all new messages to a scanner of some sort; it
1357 makes it possible to use &%-bt%& to test subsequent delivery routing without
1358 having to simulate the effect of the scanner.
1359 .next
1360 Routers can be designated for use only when verifying an address, as
1361 opposed to routing it for delivery. The &%verify_only%& option controls this.
1362 .next
1363 Individual routers can be explicitly skipped when running the routers to
1364 check an address given in the SMTP EXPN command (see the &%expn%& option).
1365 .next
1366 If the &%domains%& option is set, the domain of the address must be in the set
1367 of domains that it defines.
1368 .next
1369 .vindex "&$local_part_prefix$&"
1370 .vindex "&$local_part$&"
1371 .vindex "&$local_part_suffix$&"
1372 If the &%local_parts%& option is set, the local part of the address must be in
1373 the set of local parts that it defines. If &%local_part_prefix%& or
1374 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1375 part before this check. If you want to do precondition tests on local parts
1376 that include affixes, you can do so by using a &%condition%& option (see below)
1377 that uses the variables &$local_part$&, &$local_part_prefix$&, and
1378 &$local_part_suffix$& as necessary.
1379 .next
1380 .vindex "&$local_user_uid$&"
1381 .vindex "&$local_user_gid$&"
1382 .vindex "&$home$&"
1383 If the &%check_local_user%& option is set, the local part must be the name of
1384 an account on the local host. If this check succeeds, the uid and gid of the
1385 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1386 user's home directory is placed in &$home$&; these values can be used in the
1387 remaining preconditions.
1388 .next
1389 If the &%router_home_directory%& option is set, it is expanded at this point,
1390 because it overrides the value of &$home$&. If this expansion were left till
1391 later, the value of &$home$& as set by &%check_local_user%& would be used in
1392 subsequent tests. Having two different values of &$home$& in the same router
1393 could lead to confusion.
1394 .next
1395 If the &%senders%& option is set, the envelope sender address must be in the
1396 set of addresses that it defines.
1397 .next
1398 If the &%require_files%& option is set, the existence or non-existence of
1399 specified files is tested.
1400 .next
1401 .cindex "customizing" "precondition"
1402 If the &%condition%& option is set, it is evaluated and tested. This option
1403 uses an expanded string to allow you to set up your own custom preconditions.
1404 Expanded strings are described in chapter &<<CHAPexpand>>&.
1405 .endlist
1406
1407
1408 Note that &%require_files%& comes near the end of the list, so you cannot use
1409 it to check for the existence of a file in which to lookup up a domain, local
1410 part, or sender. However, as these options are all expanded, you can use the
1411 &%exists%& expansion condition to make such tests within each condition. The
1412 &%require_files%& option is intended for checking files that the router may be
1413 going to use internally, or which are needed by a specific transport (for
1414 example, &_.procmailrc_&).
1415
1416
1417
1418 .section "Delivery in detail" "SECID18"
1419 .cindex "delivery" "in detail"
1420 When a message is to be delivered, the sequence of events is as follows:
1421
1422 .ilist
1423 If a system-wide filter file is specified, the message is passed to it. The
1424 filter may add recipients to the message, replace the recipients, discard the
1425 message, cause a new message to be generated, or cause the message delivery to
1426 fail. The format of the system filter file is the same as for Exim user filter
1427 files, described in the separate document entitled &'Exim's interfaces to mail
1428 filtering'&.
1429 .cindex "Sieve filter" "not available for system filter"
1430 (&*Note*&: Sieve cannot be used for system filter files.)
1431
1432 Some additional features are available in system filters &-- see chapter
1433 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1434 filter only once per delivery attempt, however many recipients it has. However,
1435 if there are several delivery attempts because one or more addresses could not
1436 be immediately delivered, the system filter is run each time. The filter
1437 condition &%first_delivery%& can be used to detect the first run of the system
1438 filter.
1439 .next
1440 Each recipient address is offered to each configured router in turn, subject to
1441 its preconditions, until one is able to handle it. If no router can handle the
1442 address, that is, if they all decline, the address is failed. Because routers
1443 can be targeted at particular domains, several locally handled domains can be
1444 processed entirely independently of each other.
1445 .next
1446 .cindex "routing" "loops in"
1447 .cindex "loop" "while routing"
1448 A router that accepts an address may assign it to a local or a remote
1449 transport. However, the transport is not run at this time. Instead, the address
1450 is placed on a list for the particular transport, which will be run later.
1451 Alternatively, the router may generate one or more new addresses (typically
1452 from alias, forward, or filter files). New addresses are fed back into this
1453 process from the top, but in order to avoid loops, a router ignores any address
1454 which has an identically-named ancestor that was processed by itself.
1455 .next
1456 When all the routing has been done, addresses that have been successfully
1457 handled are passed to their assigned transports. When local transports are
1458 doing real local deliveries, they handle only one address at a time, but if a
1459 local transport is being used as a pseudo-remote transport (for example, to
1460 collect batched SMTP messages for transmission by some other means) multiple
1461 addresses can be handled. Remote transports can always handle more than one
1462 address at a time, but can be configured not to do so, or to restrict multiple
1463 addresses to the same domain.
1464 .next
1465 Each local delivery to a file or a pipe runs in a separate process under a
1466 non-privileged uid, and these deliveries are run one at a time. Remote
1467 deliveries also run in separate processes, normally under a uid that is private
1468 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1469 run in parallel. The maximum number of simultaneous remote deliveries for any
1470 one message is set by the &%remote_max_parallel%& option.
1471 The order in which deliveries are done is not defined, except that all local
1472 deliveries happen before any remote deliveries.
1473 .next
1474 .cindex "queue runner"
1475 When it encounters a local delivery during a queue run, Exim checks its retry
1476 database to see if there has been a previous temporary delivery failure for the
1477 address before running the local transport. If there was a previous failure,
1478 Exim does not attempt a new delivery until the retry time for the address is
1479 reached. However, this happens only for delivery attempts that are part of a
1480 queue run. Local deliveries are always attempted when delivery immediately
1481 follows message reception, even if retry times are set for them. This makes for
1482 better behaviour if one particular message is causing problems (for example,
1483 causing quota overflow, or provoking an error in a filter file).
1484 .next
1485 .cindex "delivery" "retry in remote transports"
1486 Remote transports do their own retry handling, since an address may be
1487 deliverable to one of a number of hosts, each of which may have a different
1488 retry time. If there have been previous temporary failures and no host has
1489 reached its retry time, no delivery is attempted, whether in a queue run or
1490 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1491 .next
1492 If there were any permanent errors, a bounce message is returned to an
1493 appropriate address (the sender in the common case), with details of the error
1494 for each failing address. Exim can be configured to send copies of bounce
1495 messages to other addresses.
1496 .next
1497 .cindex "delivery" "deferral"
1498 If one or more addresses suffered a temporary failure, the message is left on
1499 the queue, to be tried again later. Delivery of these addresses is said to be
1500 &'deferred'&.
1501 .next
1502 When all the recipient addresses have either been delivered or bounced,
1503 handling of the message is complete. The spool files and message log are
1504 deleted, though the message log can optionally be preserved if required.
1505 .endlist
1506
1507
1508
1509
1510 .section "Retry mechanism" "SECID19"
1511 .cindex "delivery" "retry mechanism"
1512 .cindex "retry" "description of mechanism"
1513 .cindex "queue runner"
1514 Exim's mechanism for retrying messages that fail to get delivered at the first
1515 attempt is the queue runner process. You must either run an Exim daemon that
1516 uses the &%-q%& option with a time interval to start queue runners at regular
1517 intervals, or use some other means (such as &'cron'&) to start them. If you do
1518 not arrange for queue runners to be run, messages that fail temporarily at the
1519 first attempt will remain on your queue for ever. A queue runner process works
1520 its way through the queue, one message at a time, trying each delivery that has
1521 passed its retry time.
1522 You can run several queue runners at once.
1523
1524 Exim uses a set of configured rules to determine when next to retry the failing
1525 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1526 should give up trying to deliver to the address, at which point it generates a
1527 bounce message. If no retry rules are set for a particular host, address, and
1528 error combination, no retries are attempted, and temporary errors are treated
1529 as permanent.
1530
1531
1532
1533 .section "Temporary delivery failure" "SECID20"
1534 .cindex "delivery" "temporary failure"
1535 There are many reasons why a message may not be immediately deliverable to a
1536 particular address. Failure to connect to a remote machine (because it, or the
1537 connection to it, is down) is one of the most common. Temporary failures may be
1538 detected during routing as well as during the transport stage of delivery.
1539 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1540 is on a file system where the user is over quota. Exim can be configured to
1541 impose its own quotas on local mailboxes; where system quotas are set they will
1542 also apply.
1543
1544 .new
1545 If a host is unreachable for a period of time, a number of messages may be
1546 waiting for it by the time it recovers, and sending them in a single SMTP
1547 connection is clearly beneficial. Whenever a delivery to a remote host is
1548 deferred,
1549 .cindex "hints database"
1550 Exim makes a note in its hints database, and whenever a successful
1551 SMTP delivery has happened, it looks to see if any other messages are waiting
1552 for the same host. If any are found, they are sent over the same SMTP
1553 connection, subject to a configuration limit as to the maximum number in any
1554 one connection.
1555 .wen
1556
1557
1558
1559 .section "Permanent delivery failure" "SECID21"
1560 .cindex "delivery" "permanent failure"
1561 .cindex "bounce message" "when generated"
1562 When a message cannot be delivered to some or all of its intended recipients, a
1563 bounce message is generated. Temporary delivery failures turn into permanent
1564 errors when their timeout expires. All the addresses that fail in a given
1565 delivery attempt are listed in a single message. If the original message has
1566 many recipients, it is possible for some addresses to fail in one delivery
1567 attempt and others to fail subsequently, giving rise to more than one bounce
1568 message. The wording of bounce messages can be customized by the administrator.
1569 See chapter &<<CHAPemsgcust>>& for details.
1570
1571 .cindex "&'X-Failed-Recipients:'& header line"
1572 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1573 failed addresses, for the benefit of programs that try to analyse such messages
1574 automatically.
1575
1576 .cindex "bounce message" "recipient of"
1577 A bounce message is normally sent to the sender of the original message, as
1578 obtained from the message's envelope. For incoming SMTP messages, this is the
1579 address given in the MAIL command. However, when an address is expanded via a
1580 forward or alias file, an alternative address can be specified for delivery
1581 failures of the generated addresses. For a mailing list expansion (see section
1582 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1583 of the list.
1584
1585
1586
1587 .section "Failures to deliver bounce messages" "SECID22"
1588 .cindex "bounce message" "failure to deliver"
1589 If a bounce message (either locally generated or received from a remote host)
1590 itself suffers a permanent delivery failure, the message is left on the queue,
1591 but it is frozen, awaiting the attention of an administrator. There are options
1592 that can be used to make Exim discard such failed messages, or to keep them
1593 for only a short time (see &%timeout_frozen_after%& and
1594 &%ignore_bounce_errors_after%&).
1595
1596
1597
1598
1599
1600 . ////////////////////////////////////////////////////////////////////////////
1601 . ////////////////////////////////////////////////////////////////////////////
1602
1603 .chapter "Building and installing Exim" "CHID3"
1604 .scindex IIDbuex "building Exim"
1605
1606 .section "Unpacking" "SECID23"
1607 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1608 creates a directory with the name of the current release (for example,
1609 &_exim-&version;_&) into which the following files are placed:
1610
1611 .table2 140pt
1612 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1613 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1614   documented"
1615 .irow &_LICENCE_&         "the GNU General Public Licence"
1616 .irow &_Makefile_&        "top-level make file"
1617 .irow &_NOTICE_&          "conditions for the use of Exim"
1618 .irow &_README_&          "list of files, directories and simple build &&&
1619   instructions"
1620 .endtable
1621
1622 Other files whose names begin with &_README_& may also be present. The
1623 following subdirectories are created:
1624
1625 .table2 140pt
1626 .irow &_Local_&           "an empty directory for local configuration files"
1627 .irow &_OS_&              "OS-specific files"
1628 .irow &_doc_&             "documentation files"
1629 .irow &_exim_monitor_&    "source files for the Exim monitor"
1630 .irow &_scripts_&         "scripts used in the build process"
1631 .irow &_src_&             "remaining source files"
1632 .irow &_util_&            "independent utilities"
1633 .endtable
1634
1635 The main utility programs are contained in the &_src_& directory, and are built
1636 with the Exim binary. The &_util_& directory contains a few optional scripts
1637 that may be useful to some sites.
1638
1639
1640 .section "Multiple machine architectures and operating systems" "SECID24"
1641 .cindex "building Exim" "multiple OS/architectures"
1642 The building process for Exim is arranged to make it easy to build binaries for
1643 a number of different architectures and operating systems from the same set of
1644 source files. Compilation does not take place in the &_src_& directory.
1645 Instead, a &'build directory'& is created for each architecture and operating
1646 system.
1647 .cindex "symbolic link" "to build directory"
1648 Symbolic links to the sources are installed in this directory, which is where
1649 the actual building takes place. In most cases, Exim can discover the machine
1650 architecture and operating system for itself, but the defaults can be
1651 overridden if necessary.
1652
1653
1654 .section "PCRE library" "SECTpcre"
1655 .cindex "PCRE library"
1656 Exim no longer has an embedded PCRE library as the vast majority of
1657 modern systems include PCRE as a system library, although you may need
1658 to install the PCRE or PCRE development package for your operating
1659 system. If your system has a normal PCRE installation the Exim build
1660 process will need no further configuration. If the library or the
1661 headers are in an unusual location you will need to set the PCRE_LIBS
1662 and INCLUDE directives appropriately. If your operating system has no
1663 PCRE support then you will need to obtain and build the current PCRE
1664 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1665
1666 .section "DBM libraries" "SECTdb"
1667 .cindex "DBM libraries" "discussion of"
1668 .cindex "hints database" "DBM files used for"
1669 Even if you do not use any DBM files in your configuration, Exim still needs a
1670 DBM library in order to operate, because it uses indexed files for its hints
1671 databases. Unfortunately, there are a number of DBM libraries in existence, and
1672 different operating systems often have different ones installed.
1673
1674 .cindex "Solaris" "DBM library for"
1675 .cindex "IRIX, DBM library for"
1676 .cindex "BSD, DBM library for"
1677 .cindex "Linux, DBM library for"
1678 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1679 Linux distribution, the DBM configuration should happen automatically, and you
1680 may be able to ignore this section. Otherwise, you may have to learn more than
1681 you would like about DBM libraries from what follows.
1682
1683 .cindex "&'ndbm'& DBM library"
1684 Licensed versions of Unix normally contain a library of DBM functions operating
1685 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1686 versions of Unix seem to vary in what they contain as standard. In particular,
1687 some early versions of Linux have no default DBM library, and different
1688 distributors have chosen to bundle different libraries with their packaged
1689 versions. However, the more recent releases seem to have standardized on the
1690 Berkeley DB library.
1691
1692 Different DBM libraries have different conventions for naming the files they
1693 use. When a program opens a file called &_dbmfile_&, there are several
1694 possibilities:
1695
1696 .olist
1697 A traditional &'ndbm'& implementation, such as that supplied as part of
1698 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1699 .next
1700 .cindex "&'gdbm'& DBM library"
1701 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1702 compatibility interface it makes two different hard links to it with names
1703 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1704 file name is used unmodified.
1705 .next
1706 .cindex "Berkeley DB library"
1707 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1708 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1709 programmer exactly the same as the traditional &'ndbm'& implementation.
1710 .next
1711 If the Berkeley package is used in its native mode, it operates on a single
1712 file called &_dbmfile_&; the programmer's interface is somewhat different to
1713 the traditional &'ndbm'& interface.
1714 .next
1715 To complicate things further, there are several very different versions of the
1716 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1717 2.&'x'& and 3.&'x'& were current for a while, but the latest versions are now
1718 numbered 4.&'x'&. Maintenance of some of the earlier releases has ceased. All
1719 versions of Berkeley DB can be obtained from
1720 &url(http://www.sleepycat.com/).
1721 .next
1722 .cindex "&'tdb'& DBM library"
1723 Yet another DBM library, called &'tdb'&, is available from
1724 &url(http://download.sourceforge.net/tdb). It has its own interface, and also
1725 operates on a single file.
1726 .endlist
1727
1728 .cindex "USE_DB"
1729 .cindex "DBM libraries" "configuration for building"
1730 Exim and its utilities can be compiled to use any of these interfaces. In order
1731 to use any version of the Berkeley DB package in native mode, you must set
1732 USE_DB in an appropriate configuration file (typically
1733 &_Local/Makefile_&). For example:
1734 .code
1735 USE_DB=yes
1736 .endd
1737 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1738 error is diagnosed if you set more than one of these.
1739
1740 At the lowest level, the build-time configuration sets none of these options,
1741 thereby assuming an interface of type (1). However, some operating system
1742 configuration files (for example, those for the BSD operating systems and
1743 Linux) assume type (4) by setting USE_DB as their default, and the
1744 configuration files for Cygwin set USE_GDBM. Anything you set in
1745 &_Local/Makefile_&, however, overrides these system defaults.
1746
1747 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1748 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1749 in one of these lines:
1750 .code
1751 DBMLIB = -ldb
1752 DBMLIB = -ltdb
1753 .endd
1754 Settings like that will work if the DBM library is installed in the standard
1755 place. Sometimes it is not, and the library's header file may also not be in
1756 the default path. You may need to set INCLUDE to specify where the header
1757 file is, and to specify the path to the library more fully in DBMLIB, as in
1758 this example:
1759 .code
1760 INCLUDE=-I/usr/local/include/db-4.1
1761 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1762 .endd
1763 There is further detailed discussion about the various DBM libraries in the
1764 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1765
1766
1767
1768 .section "Pre-building configuration" "SECID25"
1769 .cindex "building Exim" "pre-building configuration"
1770 .cindex "configuration for building Exim"
1771 .cindex "&_Local/Makefile_&"
1772 .cindex "&_src/EDITME_&"
1773 Before building Exim, a local configuration file that specifies options
1774 independent of any operating system has to be created with the name
1775 &_Local/Makefile_&. A template for this file is supplied as the file
1776 &_src/EDITME_&, and it contains full descriptions of all the option settings
1777 therein. These descriptions are therefore not repeated here. If you are
1778 building Exim for the first time, the simplest thing to do is to copy
1779 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1780
1781 There are three settings that you must supply, because Exim will not build
1782 without them. They are the location of the run time configuration file
1783 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1784 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1785 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1786 a colon-separated list of file names; Exim uses the first of them that exists.
1787
1788 There are a few other parameters that can be specified either at build time or
1789 at run time, to enable the same binary to be used on a number of different
1790 machines. However, if the locations of Exim's spool directory and log file
1791 directory (if not within the spool directory) are fixed, it is recommended that
1792 you specify them in &_Local/Makefile_& instead of at run time, so that errors
1793 detected early in Exim's execution (such as a malformed configuration file) can
1794 be logged.
1795
1796 .cindex "content scanning" "specifying at build time"
1797 Exim's interfaces for calling virus and spam scanning software directly from
1798 access control lists are not compiled by default. If you want to include these
1799 facilities, you need to set
1800 .code
1801 WITH_CONTENT_SCAN=yes
1802 .endd
1803 in your &_Local/Makefile_&. For details of the facilities themselves, see
1804 chapter &<<CHAPexiscan>>&.
1805
1806
1807 .cindex "&_Local/eximon.conf_&"
1808 .cindex "&_exim_monitor/EDITME_&"
1809 If you are going to build the Exim monitor, a similar configuration process is
1810 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1811 your installation and saved under the name &_Local/eximon.conf_&. If you are
1812 happy with the default settings described in &_exim_monitor/EDITME_&,
1813 &_Local/eximon.conf_& can be empty, but it must exist.
1814
1815 This is all the configuration that is needed in straightforward cases for known
1816 operating systems. However, the building process is set up so that it is easy
1817 to override options that are set by default or by operating-system-specific
1818 configuration files, for example to change the name of the C compiler, which
1819 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1820 do this.
1821
1822
1823
1824 .section "Support for iconv()" "SECID26"
1825 .cindex "&[iconv()]& support"
1826 .cindex "RFC 2047"
1827 The contents of header lines in messages may be encoded according to the rules
1828 described RFC 2047. This makes it possible to transmit characters that are not
1829 in the ASCII character set, and to label them as being in a particular
1830 character set. When Exim is inspecting header lines by means of the &%$h_%&
1831 mechanism, it decodes them, and translates them into a specified character set
1832 (default ISO-8859-1). The translation is possible only if the operating system
1833 supports the &[iconv()]& function.
1834
1835 However, some of the operating systems that supply &[iconv()]& do not support
1836 very many conversions. The GNU &%libiconv%& library (available from
1837 &url(http://www.gnu.org/software/libiconv/)) can be installed on such
1838 systems to remedy this deficiency, as well as on systems that do not supply
1839 &[iconv()]& at all. After installing &%libiconv%&, you should add
1840 .code
1841 HAVE_ICONV=yes
1842 .endd
1843 to your &_Local/Makefile_& and rebuild Exim.
1844
1845
1846
1847 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1848 .cindex "TLS" "including support for TLS"
1849 .cindex "encryption" "including support for"
1850 .cindex "SUPPORT_TLS"
1851 .cindex "OpenSSL" "building Exim with"
1852 .cindex "GnuTLS" "building Exim with"
1853 Exim can be built to support encrypted SMTP connections, using the STARTTLS
1854 command as per RFC 2487. It can also support legacy clients that expect to
1855 start a TLS session immediately on connection to a non-standard port (see the
1856 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1857 line option).
1858
1859 If you want to build Exim with TLS support, you must first install either the
1860 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1861 implementing SSL.
1862
1863 If OpenSSL is installed, you should set
1864 .code
1865 SUPPORT_TLS=yes
1866 TLS_LIBS=-lssl -lcrypto
1867 .endd
1868 in &_Local/Makefile_&. You may also need to specify the locations of the
1869 OpenSSL library and include files. For example:
1870 .code
1871 SUPPORT_TLS=yes
1872 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1873 TLS_INCLUDE=-I/usr/local/openssl/include/
1874 .endd
1875 .cindex "USE_GNUTLS"
1876 If GnuTLS is installed, you should set
1877 .code
1878 SUPPORT_TLS=yes
1879 USE_GNUTLS=yes
1880 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1881 .endd
1882 in &_Local/Makefile_&, and again you may need to specify the locations of the
1883 library and include files. For example:
1884 .code
1885 SUPPORT_TLS=yes
1886 USE_GNUTLS=yes
1887 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1888 TLS_INCLUDE=-I/usr/gnu/include
1889 .endd
1890 You do not need to set TLS_INCLUDE if the relevant directory is already
1891 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1892 given in chapter &<<CHAPTLS>>&.
1893
1894
1895
1896
1897 .new
1898 .section "Use of tcpwrappers" "SECID27"
1899
1900 .cindex "tcpwrappers, building Exim to support"
1901 .cindex "USE_TCP_WRAPPERS"
1902 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1903 .cindex "tcp_wrappers_daemon_name"
1904 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1905 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1906 alternative to Exim's own checking facilities for installations that are
1907 already making use of &'tcpwrappers'& for other purposes. To do this, you
1908 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1909 &_tcpd.h_& to be available at compile time, and also ensure that the library
1910 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1911 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1912 you might have
1913 .code
1914 USE_TCP_WRAPPERS=yes
1915 CFLAGS=-O -I/usr/local/include
1916 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1917 .endd
1918 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1919 files is &"exim"&. For example, the line
1920 .code
1921 exim : LOCAL  192.168.1.  .friendly.domain.example
1922 .endd
1923 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1924 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1925 All other connections are denied. The daemon name used by &'tcpwrappers'&
1926 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
1927 in &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
1928 configure file. Consult the &'tcpwrappers'& documentation for
1929 further details.
1930 .wen
1931
1932
1933 .section "Including support for IPv6" "SECID28"
1934 .cindex "IPv6" "including support for"
1935 Exim contains code for use on systems that have IPv6 support. Setting
1936 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
1937 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
1938 where the IPv6 support is not fully integrated into the normal include and
1939 library files.
1940
1941 Two different types of DNS record for handling IPv6 addresses have been
1942 defined. AAAA records (analogous to A records for IPv4) are in use, and are
1943 currently seen as the mainstream. Another record type called A6 was proposed
1944 as better than AAAA because it had more flexibility. However, it was felt to be
1945 over-complex, and its status was reduced to &"experimental"&. It is not known
1946 if anyone is actually using A6 records. Exim has support for A6 records, but
1947 this is included only if you set &`SUPPORT_A6=YES`& in &_Local/Makefile_&. The
1948 support has not been tested for some time.
1949
1950
1951
1952 .new
1953 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
1954 .cindex "lookup modules"
1955 .cindex "dynamic modules"
1956 .cindex ".so building"
1957 On some platforms, Exim supports not compiling all lookup types directly into
1958 the main binary, instead putting some into external modules which can be loaded
1959 on demand.
1960 This permits packagers to build Exim with support for lookups with extensive
1961 library dependencies without requiring all users to install all of those
1962 dependencies.
1963 Most, but not all, lookup types can be built this way.
1964
1965 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
1966 installed; Exim will only load modules from that directory, as a security
1967 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
1968 for your OS; see &_OS/Makefile-Linux_& for an example.
1969 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
1970 see &_src/EDITME_& for details.
1971
1972 Then, for each module to be loaded dynamically, define the relevant
1973 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
1974 For example, this will build in lsearch but load sqlite and mysql support
1975 on demand:
1976 .code
1977 LOOKUP_LSEARCH=yes
1978 LOOKUP_SQLITE=2
1979 LOOKUP_MYSQL=2
1980 .endd
1981 .wen
1982
1983 .section "The building process" "SECID29"
1984 .cindex "build directory"
1985 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
1986 created, run &'make'& at the top level. It determines the architecture and
1987 operating system types, and creates a build directory if one does not exist.
1988 For example, on a Sun system running Solaris 8, the directory
1989 &_build-SunOS5-5.8-sparc_& is created.
1990 .cindex "symbolic link" "to source files"
1991 Symbolic links to relevant source files are installed in the build directory.
1992
1993 &*Warning*&: The &%-j%& (parallel) flag must not be used with &'make'&; the
1994 building process fails if it is set.
1995
1996 If this is the first time &'make'& has been run, it calls a script that builds
1997 a make file inside the build directory, using the configuration files from the
1998 &_Local_& directory. The new make file is then passed to another instance of
1999 &'make'&. This does the real work, building a number of utility scripts, and
2000 then compiling and linking the binaries for the Exim monitor (if configured), a
2001 number of utility programs, and finally Exim itself. The command &`make
2002 makefile`& can be used to force a rebuild of the make file in the build
2003 directory, should this ever be necessary.
2004
2005 If you have problems building Exim, check for any comments there may be in the
2006 &_README_& file concerning your operating system, and also take a look at the
2007 FAQ, where some common problems are covered.
2008
2009
2010
2011 .section 'Output from &"make"&' "SECID283"
2012 The output produced by the &'make'& process for compile lines is often very
2013 unreadable, because these lines can be very long. For this reason, the normal
2014 output is suppressed by default, and instead output similar to that which
2015 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2016 each module that is being compiled or linked. However, it is still possible to
2017 get the full output, by calling &'make'& like this:
2018 .code
2019 FULLECHO='' make -e
2020 .endd
2021 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2022 command reflection in &'make'&. When you ask for the full output, it is
2023 given in addition to the short output.
2024
2025
2026
2027 .section "Overriding build-time options for Exim" "SECToverride"
2028 .cindex "build-time options, overriding"
2029 The main make file that is created at the beginning of the building process
2030 consists of the concatenation of a number of files which set configuration
2031 values, followed by a fixed set of &'make'& instructions. If a value is set
2032 more than once, the last setting overrides any previous ones. This provides a
2033 convenient way of overriding defaults. The files that are concatenated are, in
2034 order:
2035 .display
2036 &_OS/Makefile-Default_&
2037 &_OS/Makefile-_&<&'ostype'&>
2038 &_Local/Makefile_&
2039 &_Local/Makefile-_&<&'ostype'&>
2040 &_Local/Makefile-_&<&'archtype'&>
2041 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2042 &_OS/Makefile-Base_&
2043 .endd
2044 .cindex "&_Local/Makefile_&"
2045 .cindex "building Exim" "operating system type"
2046 .cindex "building Exim" "architecture type"
2047 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2048 architecture type. &_Local/Makefile_& is required to exist, and the building
2049 process fails if it is absent. The other three &_Local_& files are optional,
2050 and are often not needed.
2051
2052 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2053 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2054 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2055 values are used, thereby providing a means of forcing particular settings.
2056 Otherwise, the scripts try to get values from the &%uname%& command. If this
2057 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2058 of &'ad hoc'& transformations are then applied, to produce the standard names
2059 that Exim expects. You can run these scripts directly from the shell in order
2060 to find out what values are being used on your system.
2061
2062
2063 &_OS/Makefile-Default_& contains comments about the variables that are set
2064 therein. Some (but not all) are mentioned below. If there is something that
2065 needs changing, review the contents of this file and the contents of the make
2066 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2067 default values are.
2068
2069
2070 .cindex "building Exim" "overriding default settings"
2071 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2072 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2073 need to change the original files. Instead, you should make the changes by
2074 putting the new values in an appropriate &_Local_& file. For example,
2075 .cindex "Tru64-Unix build-time settings"
2076 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2077 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2078 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2079 called with the option &%-std1%&, to make it recognize some of the features of
2080 Standard C that Exim uses. (Most other compilers recognize Standard C by
2081 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2082 containing the lines
2083 .code
2084 CC=cc
2085 CFLAGS=-std1
2086 .endd
2087 If you are compiling for just one operating system, it may be easier to put
2088 these lines directly into &_Local/Makefile_&.
2089
2090 Keeping all your local configuration settings separate from the distributed
2091 files makes it easy to transfer them to new versions of Exim simply by copying
2092 the contents of the &_Local_& directory.
2093
2094
2095 .cindex "NIS lookup type" "including support for"
2096 .cindex "NIS+ lookup type" "including support for"
2097 .cindex "LDAP" "including support for"
2098 .cindex "lookup" "inclusion in binary"
2099 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2100 lookup, but not all systems have these components installed, so the default is
2101 not to include the relevant code in the binary. All the different kinds of file
2102 and database lookup that Exim supports are implemented as separate code modules
2103 which are included only if the relevant compile-time options are set. In the
2104 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2105 .code
2106 LOOKUP_LDAP=yes
2107 LOOKUP_NIS=yes
2108 LOOKUP_NISPLUS=yes
2109 .endd
2110 and similar settings apply to the other lookup types. They are all listed in
2111 &_src/EDITME_&. In many cases the relevant include files and interface
2112 libraries need to be installed before compiling Exim.
2113 .cindex "cdb" "including support for"
2114 However, there are some optional lookup types (such as cdb) for which
2115 the code is entirely contained within Exim, and no external include
2116 files or libraries are required. When a lookup type is not included in the
2117 binary, attempts to configure Exim to use it cause run time configuration
2118 errors.
2119
2120 .cindex "Perl" "including support for"
2121 Exim can be linked with an embedded Perl interpreter, allowing Perl
2122 subroutines to be called during string expansion. To enable this facility,
2123 .code
2124 EXIM_PERL=perl.o
2125 .endd
2126 must be defined in &_Local/Makefile_&. Details of this facility are given in
2127 chapter &<<CHAPperl>>&.
2128
2129 .cindex "X11 libraries, location of"
2130 The location of the X11 libraries is something that varies a lot between
2131 operating systems, and there may be different versions of X11 to cope
2132 with. Exim itself makes no use of X11, but if you are compiling the Exim
2133 monitor, the X11 libraries must be available.
2134 The following three variables are set in &_OS/Makefile-Default_&:
2135 .code
2136 X11=/usr/X11R6
2137 XINCLUDE=-I$(X11)/include
2138 XLFLAGS=-L$(X11)/lib
2139 .endd
2140 These are overridden in some of the operating-system configuration files. For
2141 example, in &_OS/Makefile-SunOS5_& there is
2142 .code
2143 X11=/usr/openwin
2144 XINCLUDE=-I$(X11)/include
2145 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2146 .endd
2147 If you need to override the default setting for your operating system, place a
2148 definition of all three of these variables into your
2149 &_Local/Makefile-<ostype>_& file.
2150
2151 .cindex "EXTRALIBS"
2152 If you need to add any extra libraries to the link steps, these can be put in a
2153 variable called EXTRALIBS, which appears in all the link commands, but by
2154 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2155 command for linking the main Exim binary, and not for any associated utilities.
2156
2157 .cindex "DBM libraries" "configuration for building"
2158 There is also DBMLIB, which appears in the link commands for binaries that
2159 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2160 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2161 binary, and which can be used, for example, to include additional X11
2162 libraries.
2163
2164 .cindex "configuration file" "editing"
2165 The make file copes with rebuilding Exim correctly if any of the configuration
2166 files are edited. However, if an optional configuration file is deleted, it is
2167 necessary to touch the associated non-optional file (that is,
2168 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2169
2170
2171 .section "OS-specific header files" "SECID30"
2172 .cindex "&_os.h_&"
2173 .cindex "building Exim" "OS-specific C header files"
2174 The &_OS_& directory contains a number of files with names of the form
2175 &_os.h-<ostype>_&. These are system-specific C header files that should not
2176 normally need to be changed. There is a list of macro settings that are
2177 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2178 are porting Exim to a new operating system.
2179
2180
2181
2182 .section "Overriding build-time options for the monitor" "SECID31"
2183 .cindex "building Eximon"
2184 A similar process is used for overriding things when building the Exim monitor,
2185 where the files that are involved are
2186 .display
2187 &_OS/eximon.conf-Default_&
2188 &_OS/eximon.conf-_&<&'ostype'&>
2189 &_Local/eximon.conf_&
2190 &_Local/eximon.conf-_&<&'ostype'&>
2191 &_Local/eximon.conf-_&<&'archtype'&>
2192 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2193 .endd
2194 .cindex "&_Local/eximon.conf_&"
2195 As with Exim itself, the final three files need not exist, and in this case the
2196 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2197 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2198 variables of the same name, preceded by EXIMON_. For example, setting
2199 EXIMON_LOG_DEPTH in the environment overrides the value of
2200 LOG_DEPTH at run time.
2201 .ecindex IIDbuex
2202
2203
2204 .section "Installing Exim binaries and scripts" "SECID32"
2205 .cindex "installing Exim"
2206 .cindex "BIN_DIRECTORY"
2207 The command &`make install`& runs the &(exim_install)& script with no
2208 arguments. The script copies binaries and utility scripts into the directory
2209 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2210 .cindex "setuid" "installing Exim with"
2211 The install script copies files only if they are newer than the files they are
2212 going to replace. The Exim binary is required to be owned by root and have the
2213 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2214 install`& as root so that it can set up the Exim binary in this way. However, in
2215 some special situations (for example, if a host is doing no local deliveries)
2216 it may be possible to run Exim without making the binary setuid root (see
2217 chapter &<<CHAPsecurity>>& for details).
2218
2219 .cindex "CONFIGURE_FILE"
2220 Exim's run time configuration file is named by the CONFIGURE_FILE setting
2221 in &_Local/Makefile_&. If this names a single file, and the file does not
2222 exist, the default configuration file &_src/configure.default_& is copied there
2223 by the installation script. If a run time configuration file already exists, it
2224 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2225 alternative files, no default is installed.
2226
2227 .cindex "system aliases file"
2228 .cindex "&_/etc/aliases_&"
2229 One change is made to the default configuration file when it is installed: the
2230 default configuration contains a router that references a system aliases file.
2231 The path to this file is set to the value specified by
2232 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2233 If the system aliases file does not exist, the installation script creates it,
2234 and outputs a comment to the user.
2235
2236 The created file contains no aliases, but it does contain comments about the
2237 aliases a site should normally have. Mail aliases have traditionally been
2238 kept in &_/etc/aliases_&. However, some operating systems are now using
2239 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2240 Exim's configuration if necessary.
2241
2242 The default configuration uses the local host's name as the only local domain,
2243 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2244 running as the local user. System aliases and &_.forward_& files in users' home
2245 directories are supported, but no NIS or NIS+ support is configured. Domains
2246 other than the name of the local host are routed using the DNS, with delivery
2247 over SMTP.
2248
2249 It is possible to install Exim for special purposes (such as building a binary
2250 distribution) in a private part of the file system. You can do this by a
2251 command such as
2252 .code
2253 make DESTDIR=/some/directory/ install
2254 .endd
2255 This has the effect of pre-pending the specified directory to all the file
2256 paths, except the name of the system aliases file that appears in the default
2257 configuration. (If a default alias file is created, its name &'is'& modified.)
2258 For backwards compatibility, ROOT is used if DESTDIR is not set,
2259 but this usage is deprecated.
2260
2261 .cindex "installing Exim" "what is not installed"
2262 Running &'make install'& does not copy the Exim 4 conversion script
2263 &'convert4r4'&. You will probably run this only once if you are
2264 upgrading from Exim 3. None of the documentation files in the &_doc_&
2265 directory are copied, except for the info files when you have set
2266 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2267
2268 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2269 to their names. The Exim binary itself, however, is handled differently. It is
2270 installed under a name that includes the version number and the compile number,
2271 for example &_exim-&version;-1_&. The script then arranges for a symbolic link
2272 called &_exim_& to point to the binary. If you are updating a previous version
2273 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2274 from the directory (as seen by other processes).
2275
2276 .cindex "installing Exim" "testing the script"
2277 If you want to see what the &'make install'& will do before running it for
2278 real, you can pass the &%-n%& option to the installation script by this
2279 command:
2280 .code
2281 make INSTALL_ARG=-n install
2282 .endd
2283 The contents of the variable INSTALL_ARG are passed to the installation
2284 script. You do not need to be root to run this test. Alternatively, you can run
2285 the installation script directly, but this must be from within the build
2286 directory. For example, from the top-level Exim directory you could use this
2287 command:
2288 .code
2289 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2290 .endd
2291 .cindex "installing Exim" "install script options"
2292 There are two other options that can be supplied to the installation script.
2293
2294 .ilist
2295 &%-no_chown%& bypasses the call to change the owner of the installed binary
2296 to root, and the call to make it a setuid binary.
2297 .next
2298 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2299 installed binary.
2300 .endlist
2301
2302 INSTALL_ARG can be used to pass these options to the script. For example:
2303 .code
2304 make INSTALL_ARG=-no_symlink install
2305 .endd
2306 The installation script can also be given arguments specifying which files are
2307 to be copied. For example, to install just the Exim binary, and nothing else,
2308 without creating the symbolic link, you could use:
2309 .code
2310 make INSTALL_ARG='-no_symlink exim' install
2311 .endd
2312
2313
2314
2315 .section "Installing info documentation" "SECTinsinfdoc"
2316 .cindex "installing Exim" "&'info'& documentation"
2317 Not all systems use the GNU &'info'& system for documentation, and for this
2318 reason, the Texinfo source of Exim's documentation is not included in the main
2319 distribution. Instead it is available separately from the ftp site (see section
2320 &<<SECTavail>>&).
2321
2322 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2323 source of the documentation is found in the source tree, running &`make
2324 install`& automatically builds the info files and installs them.
2325
2326
2327
2328 .section "Setting up the spool directory" "SECID33"
2329 .cindex "spool directory" "creating"
2330 When it starts up, Exim tries to create its spool directory if it does not
2331 exist. The Exim uid and gid are used for the owner and group of the spool
2332 directory. Sub-directories are automatically created in the spool directory as
2333 necessary.
2334
2335
2336
2337
2338 .section "Testing" "SECID34"
2339 .cindex "testing" "installation"
2340 Having installed Exim, you can check that the run time configuration file is
2341 syntactically valid by running the following command, which assumes that the
2342 Exim binary directory is within your PATH environment variable:
2343 .code
2344 exim -bV
2345 .endd
2346 If there are any errors in the configuration file, Exim outputs error messages.
2347 Otherwise it outputs the version number and build date,
2348 the DBM library that is being used, and information about which drivers and
2349 other optional code modules are included in the binary.
2350 Some simple routing tests can be done by using the address testing option. For
2351 example,
2352 .display
2353 &`exim -bt`& <&'local username'&>
2354 .endd
2355 should verify that it recognizes a local mailbox, and
2356 .display
2357 &`exim -bt`& <&'remote address'&>
2358 .endd
2359 a remote one. Then try getting it to deliver mail, both locally and remotely.
2360 This can be done by passing messages directly to Exim, without going through a
2361 user agent. For example:
2362 .code
2363 exim -v postmaster@your.domain.example
2364 From: user@your.domain.example
2365 To: postmaster@your.domain.example
2366 Subject: Testing Exim
2367
2368 This is a test message.
2369 ^D
2370 .endd
2371 The &%-v%& option causes Exim to output some verification of what it is doing.
2372 In this case you should see copies of three log lines, one for the message's
2373 arrival, one for its delivery, and one containing &"Completed"&.
2374
2375 .cindex "delivery" "problems with"
2376 If you encounter problems, look at Exim's log files (&'mainlog'& and
2377 &'paniclog'&) to see if there is any relevant information there. Another source
2378 of information is running Exim with debugging turned on, by specifying the
2379 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2380 with debugging turned on by a command of the form
2381 .display
2382 &`exim -d -M`& <&'exim-message-id'&>
2383 .endd
2384 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2385 produces rather a lot of output, but you can cut this down to specific areas.
2386 For example, if you use &%-d-all+route%& only the debugging information
2387 relevant to routing is included. (See the &%-d%& option in chapter
2388 &<<CHAPcommandline>>& for more details.)
2389
2390 .cindex '&"sticky"& bit'
2391 .cindex "lock files"
2392 One specific problem that has shown up on some sites is the inability to do
2393 local deliveries into a shared mailbox directory, because it does not have the
2394 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2395 writing to a mailbox file, and if it cannot create the lock file, the delivery
2396 is deferred. You can get round this either by setting the &"sticky bit"& on the
2397 directory, or by setting a specific group for local deliveries and allowing
2398 that group to create files in the directory (see the comments above the
2399 &(local_delivery)& transport in the default configuration file). Another
2400 approach is to configure Exim not to use lock files, but just to rely on
2401 &[fcntl()]& locking instead. However, you should do this only if all user
2402 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2403 see chapter &<<CHAPappendfile>>&.
2404
2405 One thing that cannot be tested on a system that is already running an MTA is
2406 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2407 &%-oX%& option can be used to run an Exim daemon that listens on some other
2408 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2409 &'exim_checkaccess'& utility can be used to check out policy controls on
2410 incoming SMTP mail.
2411
2412 Testing a new version on a system that is already running Exim can most easily
2413 be done by building a binary with a different CONFIGURE_FILE setting. From
2414 within the run time configuration, all other file and directory names
2415 that Exim uses can be altered, in order to keep it entirely clear of the
2416 production version.
2417
2418
2419 .section "Replacing another MTA with Exim" "SECID35"
2420 .cindex "replacing another MTA"
2421 Building and installing Exim for the first time does not of itself put it in
2422 general use. The name by which the system's MTA is called by mail user agents
2423 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2424 operating system), and it is necessary to make this name point to the &'exim'&
2425 binary in order to get the user agents to pass messages to Exim. This is
2426 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2427 or &_/usr/lib/sendmail_&
2428 .cindex "symbolic link" "to &'exim'& binary"
2429 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2430 privilege and executable status from the old MTA. It is then necessary to stop
2431 and restart the mailer daemon, if one is running.
2432
2433 .cindex "FreeBSD, MTA indirection"
2434 .cindex "&_/etc/mail/mailer.conf_&"
2435 Some operating systems have introduced alternative ways of switching MTAs. For
2436 example, if you are running FreeBSD, you need to edit the file
2437 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2438 described. A typical example of the contents of this file for running Exim is
2439 as follows:
2440 .code
2441 sendmail            /usr/exim/bin/exim
2442 send-mail           /usr/exim/bin/exim
2443 mailq               /usr/exim/bin/exim -bp
2444 newaliases          /usr/bin/true
2445 .endd
2446 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2447 your Exim installation is &"live"&. Check it by sending a message from your
2448 favourite user agent.
2449
2450 You should consider what to tell your users about the change of MTA. Exim may
2451 have different capabilities to what was previously running, and there are
2452 various operational differences such as the text of messages produced by
2453 command line options and in bounce messages. If you allow your users to make
2454 use of Exim's filtering capabilities, you should make the document entitled
2455 &'Exim's interface to mail filtering'& available to them.
2456
2457
2458
2459 .section "Upgrading Exim" "SECID36"
2460 .cindex "upgrading Exim"
2461 If you are already running Exim on your host, building and installing a new
2462 version automatically makes it available to MUAs, or any other programs that
2463 call the MTA directly. However, if you are running an Exim daemon, you do need
2464 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2465 new binary. You do not need to stop processing mail in order to install a new
2466 version of Exim. The install script does not modify an existing runtime
2467 configuration file.
2468
2469
2470
2471
2472 .section "Stopping the Exim daemon on Solaris" "SECID37"
2473 .cindex "Solaris" "stopping Exim on"
2474 The standard command for stopping the mailer daemon on Solaris is
2475 .code
2476 /etc/init.d/sendmail stop
2477 .endd
2478 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2479 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2480 for the text &"sendmail"&; this is not present because the actual program name
2481 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2482 solution is to replace the line that finds the process id with something like
2483 .code
2484 pid=`cat /var/spool/exim/exim-daemon.pid`
2485 .endd
2486 to obtain the daemon's pid directly from the file that Exim saves it in.
2487
2488 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2489 still be received from local processes, and if automatic delivery is configured
2490 (the normal case), deliveries will still occur.
2491
2492
2493
2494
2495 . ////////////////////////////////////////////////////////////////////////////
2496 . ////////////////////////////////////////////////////////////////////////////
2497
2498 .chapter "The Exim command line" "CHAPcommandline"
2499 .scindex IIDclo1 "command line" "options"
2500 .scindex IIDclo2 "options" "command line"
2501 Exim's command line takes the standard Unix form of a sequence of options,
2502 each starting with a hyphen character, followed by a number of arguments. The
2503 options are compatible with the main options of Sendmail, and there are also
2504 some additional options, some of which are compatible with Smail 3. Certain
2505 combinations of options do not make sense, and provoke an error if used.
2506 The form of the arguments depends on which options are set.
2507
2508
2509 .section "Setting options by program name" "SECID38"
2510 .cindex "&'mailq'&"
2511 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2512 were present before any other options.
2513 The &%-bp%& option requests a listing of the contents of the mail queue on the
2514 standard output.
2515 This feature is for compatibility with some systems that contain a command of
2516 that name in one of the standard libraries, symbolically linked to
2517 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2518
2519 .cindex "&'rsmtp'&"
2520 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2521 were present before any other options, for compatibility with Smail. The
2522 &%-bS%& option is used for reading in a number of messages in batched SMTP
2523 format.
2524
2525 .cindex "&'rmail'&"
2526 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2527 &%-oee%& options were present before any other options, for compatibility with
2528 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2529
2530 .cindex "&'runq'&"
2531 .cindex "queue runner"
2532 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2533 were present before any other options, for compatibility with Smail. The &%-q%&
2534 option causes a single queue runner process to be started.
2535
2536 .cindex "&'newaliases'&"
2537 .cindex "alias file" "building"
2538 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2539 If Exim is called under the name &'newaliases'& it behaves as if the option
2540 &%-bi%& were present before any other options, for compatibility with Sendmail.
2541 This option is used for rebuilding Sendmail's alias file. Exim does not have
2542 the concept of a single alias file, but can be configured to run a given
2543 command if called with the &%-bi%& option.
2544
2545
2546 .section "Trusted and admin users" "SECTtrustedadmin"
2547 Some Exim options are available only to &'trusted users'& and others are
2548 available only to &'admin users'&. In the description below, the phrases &"Exim
2549 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2550 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2551 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2552
2553 .ilist
2554 .cindex "trusted users" "definition of"
2555 .cindex "user" "trusted definition of"
2556 The trusted users are root, the Exim user, any user listed in the
2557 &%trusted_users%& configuration option, and any user whose current group or any
2558 supplementary group is one of those listed in the &%trusted_groups%&
2559 configuration option. Note that the Exim group is not automatically trusted.
2560
2561 .cindex '&"From"& line'
2562 .cindex "envelope sender"
2563 Trusted users are always permitted to use the &%-f%& option or a leading
2564 &"From&~"& line to specify the envelope sender of a message that is passed to
2565 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2566 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2567 users to set envelope senders.
2568
2569 .cindex "&'From:'& header line"
2570 .cindex "&'Sender:'& header line"
2571 For a trusted user, there is never any check on the contents of the &'From:'&
2572 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2573 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2574
2575 Trusted users may also specify a host name, host address, interface address,
2576 protocol name, ident value, and authentication data when submitting a message
2577 locally. Thus, they are able to insert messages into Exim's queue locally that
2578 have the characteristics of messages received from a remote host. Untrusted
2579 users may in some circumstances use &%-f%&, but can never set the other values
2580 that are available to trusted users.
2581 .next
2582 .cindex "user" "admin definition of"
2583 .cindex "admin user" "definition of"
2584 The admin users are root, the Exim user, and any user that is a member of the
2585 Exim group or of any group listed in the &%admin_groups%& configuration option.
2586 The current group does not have to be one of these groups.
2587
2588 Admin users are permitted to list the queue, and to carry out certain
2589 operations on messages, for example, to force delivery failures. It is also
2590 necessary to be an admin user in order to see the full information provided by
2591 the Exim monitor, and full debugging output.
2592
2593 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2594 Exim to attempt delivery of messages on its queue is restricted to admin users.
2595 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2596 option false (that is, specifying &%no_prod_requires_admin%&).
2597
2598 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2599 is restricted to admin users unless &%queue_list_requires_admin%& is set
2600 false.
2601 .endlist
2602
2603
2604 &*Warning*&: If you configure your system so that admin users are able to
2605 edit Exim's configuration file, you are giving those users an easy way of
2606 getting root. There is further discussion of this issue at the start of chapter
2607 &<<CHAPconf>>&.
2608
2609
2610
2611
2612 .section "Command line options" "SECID39"
2613 Exim's command line options are described in alphabetical order below. If none
2614 of the options that specifies a specific action (such as starting the daemon or
2615 a queue runner, or testing an address, or receiving a message in a specific
2616 format, or listing the queue) are present, and there is at least one argument
2617 on the command line, &%-bm%& (accept a local message on the standard input,
2618 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2619 outputs a brief message about itself and exits.
2620
2621 . ////////////////////////////////////////////////////////////////////////////
2622 . Insert a stylized XML comment here, to identify the start of the command line
2623 . options. This is for the benefit of the Perl script that automatically
2624 . creates a man page for the options.
2625 . ////////////////////////////////////////////////////////////////////////////
2626
2627 .literal xml
2628 <!-- === Start of command line options === -->
2629 .literal off
2630
2631
2632 .vlist
2633 .vitem &%--%&
2634 .oindex "--"
2635 .cindex "options" "command line; terminating"
2636 This is a pseudo-option whose only purpose is to terminate the options and
2637 therefore to cause subsequent command line items to be treated as arguments
2638 rather than options, even if they begin with hyphens.
2639
2640 .vitem &%--help%&
2641 .oindex "&%--help%&"
2642 This option causes Exim to output a few sentences stating what it is.
2643 The same output is generated if the Exim binary is called with no options and
2644 no arguments.
2645
2646 .new
2647 .vitem &%--version%&
2648 .oindex "&%--version%&"
2649 This option is an alias for &%-bV%& and causes version information to be
2650 displayed.
2651 .wen
2652
2653 .vitem &%-B%&<&'type'&>
2654 .oindex "&%-B%&"
2655 .cindex "8-bit characters"
2656 .cindex "Sendmail compatibility" "8-bit characters"
2657 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2658 clean; it ignores this option.
2659
2660 .vitem &%-bd%&
2661 .oindex "&%-bd%&"
2662 .cindex "daemon"
2663 .cindex "SMTP" "listener"
2664 .cindex "queue runner"
2665 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2666 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2667 that the daemon should also initiate periodic queue runs.
2668
2669 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2670 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2671 disconnect from the controlling terminal. When running this way, it can be
2672 stopped by pressing ctrl-C.
2673
2674 By default, Exim listens for incoming connections to the standard SMTP port on
2675 all the host's running interfaces. However, it is possible to listen on other
2676 ports, on multiple ports, and only on specific interfaces. Chapter
2677 &<<CHAPinterfaces>>& contains a description of the options that control this.
2678
2679 When a listening daemon
2680 .cindex "daemon" "process id (pid)"
2681 .cindex "pid (process id)" "of daemon"
2682 is started without the use of &%-oX%& (that is, without overriding the normal
2683 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2684 in Exim's spool directory. This location can be overridden by setting
2685 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2686 running as root.
2687
2688 When &%-oX%& is used on the command line to start a listening daemon, the
2689 process id is not written to the normal pid file path. However, &%-oP%& can be
2690 used to specify a path on the command line if a pid file is required.
2691
2692 The SIGHUP signal
2693 .cindex "SIGHUP"
2694 .cindex "daemon" "restarting"
2695 can be used to cause the daemon to re-execute itself. This should be done
2696 whenever Exim's configuration file, or any file that is incorporated into it by
2697 means of the &%.include%& facility, is changed, and also whenever a new version
2698 of Exim is installed. It is not necessary to do this when other files that are
2699 referenced from the configuration (for example, alias files) are changed,
2700 because these are reread each time they are used.
2701
2702 .vitem &%-bdf%&
2703 .oindex "&%-bdf%&"
2704 This option has the same effect as &%-bd%& except that it never disconnects
2705 from the controlling terminal, even when no debugging is specified.
2706
2707 .vitem &%-be%&
2708 .oindex "&%-be%&"
2709 .cindex "testing" "string expansion"
2710 .cindex "expansion" "testing"
2711 Run Exim in expansion testing mode. Exim discards its root privilege, to
2712 prevent ordinary users from using this mode to read otherwise inaccessible
2713 files. If no arguments are given, Exim runs interactively, prompting for lines
2714 of data. Otherwise, it processes each argument in turn.
2715
2716 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2717 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2718 used without command line arguments. If successful, it uses the &[readline()]&
2719 function, which provides extensive line-editing facilities, for reading the
2720 test data. A line history is supported.
2721
2722 Long expansion expressions can be split over several lines by using backslash
2723 continuations. As in Exim's run time configuration, white space at the start of
2724 continuation lines is ignored. Each argument or data line is passed through the
2725 string expansion mechanism, and the result is output. Variable values from the
2726 configuration file (for example, &$qualify_domain$&) are available, but no
2727 message-specific values (such as &$sender_domain$&) are set, because no message
2728 is being processed (but see &%-bem%& and &%-Mset%&).
2729
2730 &*Note*&: If you use this mechanism to test lookups, and you change the data
2731 files or databases you are using, you must exit and restart Exim before trying
2732 the same lookup again. Otherwise, because each Exim process caches the results
2733 of lookups, you will just get the same result as before.
2734
2735 .vitem &%-bem%&&~<&'filename'&>
2736 .oindex "&%-bem%&"
2737 .cindex "testing" "string expansion"
2738 .cindex "expansion" "testing"
2739 This option operates like &%-be%& except that it must be followed by the name
2740 of a file. For example:
2741 .code
2742 exim -bem /tmp/testmessage
2743 .endd
2744 The file is read as a message (as if receiving a locally-submitted non-SMTP
2745 message) before any of the test expansions are done. Thus, message-specific
2746 variables such as &$message_size$& and &$header_from:$& are available. However,
2747 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2748 recipients are read from the headers in the normal way, and are shown in the
2749 &$recipients$& variable. Note that recipients cannot be given on the command
2750 line, because further arguments are taken as strings to expand (just like
2751 &%-be%&).
2752
2753 .vitem &%-bF%&&~<&'filename'&>
2754 .oindex "&%-bF%&"
2755 .cindex "system filter" "testing"
2756 .cindex "testing" "system filter"
2757 This option is the same as &%-bf%& except that it assumes that the filter being
2758 tested is a system filter. The additional commands that are available only in
2759 system filters are recognized.
2760
2761 .vitem &%-bf%&&~<&'filename'&>
2762 .oindex "&%-bf%&"
2763 .cindex "filter" "testing"
2764 .cindex "testing" "filter file"
2765 .cindex "forward file" "testing"
2766 .cindex "testing" "forward file"
2767 .cindex "Sieve filter" "testing"
2768 This option runs Exim in user filter testing mode; the file is the filter file
2769 to be tested, and a test message must be supplied on the standard input. If
2770 there are no message-dependent tests in the filter, an empty file can be
2771 supplied.
2772
2773 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2774 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2775 filter and a user filter in the same run. For example:
2776 .code
2777 exim -bF /system/filter -bf /user/filter </test/message
2778 .endd
2779 This is helpful when the system filter adds header lines or sets filter
2780 variables that are used by the user filter.
2781
2782 If the test filter file does not begin with one of the special lines
2783 .code
2784 # Exim filter
2785 # Sieve filter
2786 .endd
2787 it is taken to be a normal &_.forward_& file, and is tested for validity under
2788 that interpretation. See sections &<<SECTitenonfilred>>& to
2789 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2790 redirection lists.
2791
2792 The result of an Exim command that uses &%-bf%&, provided no errors are
2793 detected, is a list of the actions that Exim would try to take if presented
2794 with the message for real. More details of filter testing are given in the
2795 separate document entitled &'Exim's interfaces to mail filtering'&.
2796
2797 When testing a filter file,
2798 .cindex "&""From""& line"
2799 .cindex "envelope sender"
2800 .oindex "&%-f%&" "for filter testing"
2801 the envelope sender can be set by the &%-f%& option,
2802 or by a &"From&~"& line at the start of the test message. Various parameters
2803 that would normally be taken from the envelope recipient address of the message
2804 can be set by means of additional command line options (see the next four
2805 options).
2806
2807 .vitem &%-bfd%&&~<&'domain'&>
2808 .oindex "&%-bfd%&"
2809 .vindex "&$qualify_domain$&"
2810 This sets the domain of the recipient address when a filter file is being
2811 tested by means of the &%-bf%& option. The default is the value of
2812 &$qualify_domain$&.
2813
2814 .vitem &%-bfl%&&~<&'local&~part'&>
2815 .oindex "&%-bfl%&"
2816 This sets the local part of the recipient address when a filter file is being
2817 tested by means of the &%-bf%& option. The default is the username of the
2818 process that calls Exim. A local part should be specified with any prefix or
2819 suffix stripped, because that is how it appears to the filter when a message is
2820 actually being delivered.
2821
2822 .vitem &%-bfp%&&~<&'prefix'&>
2823 .oindex "&%-bfp%&"
2824 This sets the prefix of the local part of the recipient address when a filter
2825 file is being tested by means of the &%-bf%& option. The default is an empty
2826 prefix.
2827
2828 .vitem &%-bfs%&&~<&'suffix'&>
2829 .oindex "&%-bfs%&"
2830 This sets the suffix of the local part of the recipient address when a filter
2831 file is being tested by means of the &%-bf%& option. The default is an empty
2832 suffix.
2833
2834 .vitem &%-bh%&&~<&'IP&~address'&>
2835 .oindex "&%-bh%&"
2836 .cindex "testing" "incoming SMTP"
2837 .cindex "SMTP" "testing incoming"
2838 .cindex "testing" "relay control"
2839 .cindex "relaying" "testing configuration"
2840 .cindex "policy control" "testing"
2841 .cindex "debugging" "&%-bh%& option"
2842 This option runs a fake SMTP session as if from the given IP address, using the
2843 standard input and output. The IP address may include a port number at the end,
2844 after a full stop. For example:
2845 .code
2846 exim -bh 10.9.8.7.1234
2847 exim -bh fe80::a00:20ff:fe86:a061.5678
2848 .endd
2849 When an IPv6 address is given, it is converted into canonical form. In the case
2850 of the second example above, the value of &$sender_host_address$& after
2851 conversion to the canonical form is
2852 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2853
2854 Comments as to what is going on are written to the standard error file. These
2855 include lines beginning with &"LOG"& for anything that would have been logged.
2856 This facility is provided for testing configuration options for incoming
2857 messages, to make sure they implement the required policy. For example, you can
2858 test your relay controls using &%-bh%&.
2859
2860 &*Warning 1*&:
2861 .cindex "RFC 1413"
2862 You can test features of the configuration that rely on ident (RFC 1413)
2863 information by using the &%-oMt%& option. However, Exim cannot actually perform
2864 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2865 connection.
2866
2867 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2868 are also skipped when testing using &%-bh%&. If you want these callouts to
2869 occur, use &%-bhc%& instead.
2870
2871 Messages supplied during the testing session are discarded, and nothing is
2872 written to any of the real log files. There may be pauses when DNS (and other)
2873 lookups are taking place, and of course these may time out. The &%-oMi%& option
2874 can be used to specify a specific IP interface and port if this is important,
2875 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2876 session were authenticated.
2877
2878 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2879 output just states whether a given recipient address from a given host is
2880 acceptable or not. See section &<<SECTcheckaccess>>&.
2881
2882 Features such as authentication and encryption, where the client input is not
2883 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2884 specialized SMTP test program such as
2885 &url(http://jetmore.org/john/code/#swaks,swaks).
2886
2887 .vitem &%-bhc%&&~<&'IP&~address'&>
2888 .oindex "&%-bhc%&"
2889 This option operates in the same way as &%-bh%&, except that address
2890 verification callouts are performed if required. This includes consulting and
2891 updating the callout cache database.
2892
2893 .vitem &%-bi%&
2894 .oindex "&%-bi%&"
2895 .cindex "alias file" "building"
2896 .cindex "building alias file"
2897 .cindex "Sendmail compatibility" "&%-bi%& option"
2898 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2899 Exim does not have the concept of a single alias file, and so it cannot mimic
2900 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2901 tend to appear in various scripts such as NIS make files, so the option must be
2902 recognized.
2903
2904 If &%-bi%& is encountered, the command specified by the &%bi_command%&
2905 configuration option is run, under the uid and gid of the caller of Exim. If
2906 the &%-oA%& option is used, its value is passed to the command as an argument.
2907 The command set by &%bi_command%& may not contain arguments. The command can
2908 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
2909 if this is required. If the &%bi_command%& option is not set, calling Exim with
2910 &%-bi%& is a no-op.
2911
2912 .vitem &%-bm%&
2913 .oindex "&%-bm%&"
2914 .cindex "local message reception"
2915 This option runs an Exim receiving process that accepts an incoming,
2916 locally-generated message on the current input. The recipients are given as the
2917 command arguments (except when &%-t%& is also present &-- see below). Each
2918 argument can be a comma-separated list of RFC 2822 addresses. This is the
2919 default option for selecting the overall action of an Exim call; it is assumed
2920 if no other conflicting option is present.
2921
2922 If any addresses in the message are unqualified (have no domain), they are
2923 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
2924 options, as appropriate. The &%-bnq%& option (see below) provides a way of
2925 suppressing this for special cases.
2926
2927 Policy checks on the contents of local messages can be enforced by means of
2928 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
2929
2930 .cindex "return code" "for &%-bm%&"
2931 The return code is zero if the message is successfully accepted. Otherwise, the
2932 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
2933
2934 The format
2935 .cindex "message" "format"
2936 .cindex "format" "message"
2937 .cindex "&""From""& line"
2938 .cindex "UUCP" "&""From""& line"
2939 .cindex "Sendmail compatibility" "&""From""& line"
2940 of the message must be as defined in RFC 2822, except that, for
2941 compatibility with Sendmail and Smail, a line in one of the forms
2942 .code
2943 From sender Fri Jan  5 12:55 GMT 1997
2944 From sender Fri, 5 Jan 97 12:55:01
2945 .endd
2946 (with the weekday optional, and possibly with additional text after the date)
2947 is permitted to appear at the start of the message. There appears to be no
2948 authoritative specification of the format of this line. Exim recognizes it by
2949 matching against the regular expression defined by the &%uucp_from_pattern%&
2950 option, which can be changed if necessary.
2951
2952 .oindex "&%-f%&" "overriding &""From""& line"
2953 The specified sender is treated as if it were given as the argument to the
2954 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
2955 preference to the address taken from the message. The caller of Exim must be a
2956 trusted user for the sender of a message to be set in this way.
2957
2958 .vitem &%-bnq%&
2959 .oindex "&%-bnq%&"
2960 .cindex "address qualification, suppressing"
2961 By default, Exim automatically qualifies unqualified addresses (those
2962 without domains) that appear in messages that are submitted locally (that
2963 is, not over TCP/IP). This qualification applies both to addresses in
2964 envelopes, and addresses in header lines. Sender addresses are qualified using
2965 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
2966 defaults to the value of &%qualify_domain%&).
2967
2968 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
2969 being used to re-submit messages that originally came from remote hosts after
2970 content scanning, you probably do not want to qualify unqualified addresses in
2971 header lines. (Such lines will be present only if you have not enabled a header
2972 syntax check in the appropriate ACL.)
2973
2974 The &%-bnq%& option suppresses all qualification of unqualified addresses in
2975 messages that originate on the local host. When this is used, unqualified
2976 addresses in the envelope provoke errors (causing message rejection) and
2977 unqualified addresses in header lines are left alone.
2978
2979
2980 .vitem &%-bP%&
2981 .oindex "&%-bP%&"
2982 .cindex "configuration options" "extracting"
2983 .cindex "options" "configuration &-- extracting"
2984 If this option is given with no arguments, it causes the values of all Exim's
2985 main configuration options to be written to the standard output. The values
2986 of one or more specific options can be requested by giving their names as
2987 arguments, for example:
2988 .code
2989 exim -bP qualify_domain hold_domains
2990 .endd
2991 .cindex "hiding configuration option values"
2992 .cindex "configuration options" "hiding value of"
2993 .cindex "options" "hiding value of"
2994 However, any option setting that is preceded by the word &"hide"& in the
2995 configuration file is not shown in full, except to an admin user. For other
2996 users, the output is as in this example:
2997 .code
2998 mysql_servers = <value not displayable>
2999 .endd
3000 If &%configure_file%& is given as an argument, the name of the run time
3001 configuration file is output.
3002 If a list of configuration files was supplied, the value that is output here
3003 is the name of the file that was actually used.
3004
3005 .cindex "daemon" "process id (pid)"
3006 .cindex "pid (process id)" "of daemon"
3007 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3008 directories where log files and daemon pid files are written are output,
3009 respectively. If these values are unset, log files are written in a
3010 sub-directory of the spool directory called &%log%&, and the pid file is
3011 written directly into the spool directory.
3012
3013 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3014 .code
3015 exim -bP +local_domains
3016 .endd
3017 it searches for a matching named list of any type (domain, host, address, or
3018 local part) and outputs what it finds.
3019
3020 .cindex "options" "router &-- extracting"
3021 .cindex "options" "transport &-- extracting"
3022 .cindex "options" "authenticator &-- extracting"
3023 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3024 followed by the name of an appropriate driver instance, the option settings for
3025 that driver are output. For example:
3026 .code
3027 exim -bP transport local_delivery
3028 .endd
3029 The generic driver options are output first, followed by the driver's private
3030 options. A list of the names of drivers of a particular type can be obtained by
3031 using one of the words &%router_list%&, &%transport_list%&, or
3032 &%authenticator_list%&, and a complete list of all drivers with their option
3033 settings can be obtained by using &%routers%&, &%transports%&, or
3034 &%authenticators%&.
3035
3036 .cindex "options" "macro &-- extracting"
3037 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3038 are available, similarly to the drivers.  Because macros are sometimes used
3039 for storing passwords, this option is restricted.
3040 The output format is one item per line.
3041
3042 .vitem &%-bp%&
3043 .oindex "&%-bp%&"
3044 .cindex "queue" "listing messages on"
3045 .cindex "listing" "messages on the queue"
3046 This option requests a listing of the contents of the mail queue on the
3047 standard output. If the &%-bp%& option is followed by a list of message ids,
3048 just those messages are listed. By default, this option can be used only by an
3049 admin user. However, the &%queue_list_requires_admin%& option can be set false
3050 to allow any user to see the queue.
3051
3052 Each message on the queue is displayed as in the following example:
3053 .code
3054 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3055           red.king@looking-glass.fict.example
3056           <other addresses>
3057 .endd
3058 .cindex "message" "size in queue listing"
3059 .cindex "size" "of message"
3060 The first line contains the length of time the message has been on the queue
3061 (in this case 25 minutes), the size of the message (2.9K), the unique local
3062 identifier for the message, and the message sender, as contained in the
3063 envelope. For bounce messages, the sender address is empty, and appears as
3064 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3065 the default sender address, the user's login name is shown in parentheses
3066 before the sender address.
3067
3068 .cindex "frozen messages" "in queue listing"
3069 If the message is frozen (attempts to deliver it are suspended) then the text
3070 &"*** frozen ***"& is displayed at the end of this line.
3071
3072 The recipients of the message (taken from the envelope, not the headers) are
3073 displayed on subsequent lines. Those addresses to which the message has already
3074 been delivered are marked with the letter D. If an original address gets
3075 expanded into several addresses via an alias or forward file, the original is
3076 displayed with a D only when deliveries for all of its child addresses are
3077 complete.
3078
3079
3080 .vitem &%-bpa%&
3081 .oindex "&%-bpa%&"
3082 This option operates like &%-bp%&, but in addition it shows delivered addresses
3083 that were generated from the original top level address(es) in each message by
3084 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3085 of just &"D"&.
3086
3087
3088 .vitem &%-bpc%&
3089 .oindex "&%-bpc%&"
3090 .cindex "queue" "count of messages on"
3091 This option counts the number of messages on the queue, and writes the total
3092 to the standard output. It is restricted to admin users, unless
3093 &%queue_list_requires_admin%& is set false.
3094
3095
3096 .vitem &%-bpr%&
3097 .oindex "&%-bpr%&"
3098 This option operates like &%-bp%&, but the output is not sorted into
3099 chronological order of message arrival. This can speed it up when there are
3100 lots of messages on the queue, and is particularly useful if the output is
3101 going to be post-processed in a way that doesn't need the sorting.
3102
3103 .vitem &%-bpra%&
3104 .oindex "&%-bpra%&"
3105 This option is a combination of &%-bpr%& and &%-bpa%&.
3106
3107 .vitem &%-bpru%&
3108 .oindex "&%-bpru%&"
3109 This option is a combination of &%-bpr%& and &%-bpu%&.
3110
3111
3112 .vitem &%-bpu%&
3113 .oindex "&%-bpu%&"
3114 This option operates like &%-bp%& but shows only undelivered top-level
3115 addresses for each message displayed. Addresses generated by aliasing or
3116 forwarding are not shown, unless the message was deferred after processing by a
3117 router with the &%one_time%& option set.
3118
3119
3120 .vitem &%-brt%&
3121 .oindex "&%-brt%&"
3122 .cindex "testing" "retry configuration"
3123 .cindex "retry" "configuration testing"
3124 This option is for testing retry rules, and it must be followed by up to three
3125 arguments. It causes Exim to look for a retry rule that matches the values
3126 and to write it to the standard output. For example:
3127 .code
3128 exim -brt bach.comp.mus.example
3129 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3130 .endd
3131 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3132 argument, which is required, can be a complete address in the form
3133 &'local_part@domain'&, or it can be just a domain name. If the second argument
3134 contains a dot, it is interpreted as an optional second domain name; if no
3135 retry rule is found for the first argument, the second is tried. This ties in
3136 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3137 rule is found that matches the host, one that matches the mail domain is
3138 sought. Finally, an argument that is the name of a specific delivery error, as
3139 used in setting up retry rules, can be given. For example:
3140 .code
3141 exim -brt haydn.comp.mus.example quota_3d
3142 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3143 .endd
3144
3145 .vitem &%-brw%&
3146 .oindex "&%-brw%&"
3147 .cindex "testing" "rewriting"
3148 .cindex "rewriting" "testing"
3149 This option is for testing address rewriting rules, and it must be followed by
3150 a single argument, consisting of either a local part without a domain, or a
3151 complete address with a fully qualified domain. Exim outputs how this address
3152 would be rewritten for each possible place it might appear. See chapter
3153 &<<CHAPrewrite>>& for further details.
3154
3155 .vitem &%-bS%&
3156 .oindex "&%-bS%&"
3157 .cindex "SMTP" "batched incoming"
3158 .cindex "batched SMTP input"
3159 This option is used for batched SMTP input, which is an alternative interface
3160 for non-interactive local message submission. A number of messages can be
3161 submitted in a single run. However, despite its name, this is not really SMTP
3162 input. Exim reads each message's envelope from SMTP commands on the standard
3163 input, but generates no responses. If the caller is trusted, or
3164 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3165 believed; otherwise the sender is always the caller of Exim.
3166
3167 The message itself is read from the standard input, in SMTP format (leading
3168 dots doubled), terminated by a line containing just a single dot. An error is
3169 provoked if the terminating dot is missing. A further message may then follow.
3170
3171 As for other local message submissions, the contents of incoming batch SMTP
3172 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3173 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3174 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3175
3176 Some other SMTP commands are recognized in the input. HELO and EHLO act
3177 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3178 QUIT quits, ignoring the rest of the standard input.
3179
3180 .cindex "return code" "for &%-bS%&"
3181 If any error is encountered, reports are written to the standard output and
3182 error streams, and Exim gives up immediately. The return code is 0 if no error
3183 was detected; it is 1 if one or more messages were accepted before the error
3184 was detected; otherwise it is 2.
3185
3186 More details of input using batched SMTP are given in section
3187 &<<SECTincomingbatchedSMTP>>&.
3188
3189 .vitem &%-bs%&
3190 .oindex "&%-bs%&"
3191 .cindex "SMTP" "local input"
3192 .cindex "local SMTP input"
3193 This option causes Exim to accept one or more messages by reading SMTP commands
3194 on the standard input, and producing SMTP replies on the standard output. SMTP
3195 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3196 Some user agents use this interface as a way of passing locally-generated
3197 messages to the MTA.
3198
3199 In
3200 .cindex "sender" "source of"
3201 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3202 set, the senders of messages are taken from the SMTP MAIL commands.
3203 Otherwise the content of these commands is ignored and the sender is set up as
3204 the calling user. Unqualified addresses are automatically qualified using
3205 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3206 &%-bnq%& option is used.
3207
3208 .cindex "inetd"
3209 The
3210 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3211 using a listening daemon. Exim can distinguish the two cases by checking
3212 whether the standard input is a TCP/IP socket. When Exim is called from
3213 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3214 above concerning senders and qualification do not apply. In this situation,
3215 Exim behaves in exactly the same way as it does when receiving a message via
3216 the listening daemon.
3217
3218 .new
3219 .vitem &%-bmalware%&&~<&'filename'&>
3220 .oindex "&%-bmalware%&"
3221 .cindex "testing", "malware"
3222 .cindex "malware scan test"
3223 This debugging option causes Exim to scan the given file,
3224 using the malware scanning framework.  The option of &%av_scanner%& influences
3225 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3226 the expansion should have defaults which apply to this invocation.  ACLs are
3227 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3228 will never be populated and &%-bmalware%& will fail.
3229
3230 Exim will have changed working directory before resolving the filename, so
3231 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3232 user when it tries to open the file, rather than as the invoking user.
3233 This option requires admin privileges.
3234
3235 The &%-bmalware%& option will not be extended to be more generally useful,
3236 there are better tools for file-scanning.  This option exists to help
3237 administrators verify their Exim and AV scanner configuration.
3238 .wen
3239
3240 .vitem &%-bt%&
3241 .oindex "&%-bt%&"
3242 .cindex "testing" "addresses"
3243 .cindex "address" "testing"
3244 This option runs Exim in address testing mode, in which each argument is taken
3245 as a recipient address to be tested for deliverability. The results are
3246 written to the standard output. If a test fails, and the caller is not an admin
3247 user, no details of the failure are output, because these might contain
3248 sensitive information such as usernames and passwords for database lookups.
3249
3250 If no arguments are given, Exim runs in an interactive manner, prompting with a
3251 right angle bracket for addresses to be tested.
3252
3253 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3254 &[readline()]& function, because it is running as &'root'& and there are
3255 security issues.
3256
3257 Each address is handled as if it were the recipient address of a message
3258 (compare the &%-bv%& option). It is passed to the routers and the result is
3259 written to the standard output. However, any router that has
3260 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3261 genuine routing tests if your first router passes everything to a scanner
3262 program.
3263
3264 .cindex "return code" "for &%-bt%&"
3265 The return code is 2 if any address failed outright; it is 1 if no address
3266 failed outright but at least one could not be resolved for some reason. Return
3267 code 0 is given only when all addresses succeed.
3268
3269 .cindex "duplicate addresses"
3270 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3271 addresses after routing is complete, so that only one delivery takes place.
3272 This does not happen when testing with &%-bt%&; the full results of routing are
3273 always shown.
3274
3275 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3276 routers in the configuration makes any tests on the sender address of a
3277 message,
3278 .oindex "&%-f%&" "for address testing"
3279 you can use the &%-f%& option to set an appropriate sender when running
3280 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3281 default qualifying domain. However, if you have set up (for example) routers
3282 whose behaviour depends on the contents of an incoming message, you cannot test
3283 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3284 doing such tests.
3285
3286 .new
3287 .vitem &%-bV%&
3288 .oindex "&%-bV%&"
3289 .cindex "version number of Exim"
3290 This option causes Exim to write the current version number, compilation
3291 number, and compilation date of the &'exim'& binary to the standard output.
3292 It also lists the DBM library that is being used, the optional modules (such as
3293 specific lookup types), the drivers that are included in the binary, and the
3294 name of the run time configuration file that is in use.
3295 .wen
3296 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3297 configuration file. However, this is a static check only. It cannot check
3298 values that are to be expanded. For example, although a misspelt ACL verb is
3299 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3300 alone to discover (for example) all the typos in the configuration; some
3301 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3302 dynamic testing facilities.
3303
3304 .vitem &%-bv%&
3305 .oindex "&%-bv%&"
3306 .cindex "verifying address" "using &%-bv%&"
3307 .cindex "address" "verification"
3308 This option runs Exim in address verification mode, in which each argument is
3309 taken as a recipient address to be verified by the routers. (This does
3310 not involve any verification callouts). During normal operation, verification
3311 happens mostly as a consequence processing a &%verify%& condition in an ACL
3312 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3313 including callouts, see the &%-bh%& and &%-bhc%& options.
3314
3315 If verification fails, and the caller is not an admin user, no details of the
3316 failure are output, because these might contain sensitive information such as
3317 usernames and passwords for database lookups.
3318
3319 If no arguments are given, Exim runs in an interactive manner, prompting with a
3320 right angle bracket for addresses to be verified.
3321
3322 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3323 &[readline()]& function, because it is running as &'exim'& and there are
3324 security issues.
3325
3326 Verification differs from address testing (the &%-bt%& option) in that routers
3327 that have &%no_verify%& set are skipped, and if the address is accepted by a
3328 router that has &%fail_verify%& set, verification fails. The address is
3329 verified as a recipient if &%-bv%& is used; to test verification for a sender
3330 address, &%-bvs%& should be used.
3331
3332 If the &%-v%& option is not set, the output consists of a single line for each
3333 address, stating whether it was verified or not, and giving a reason in the
3334 latter case. Without &%-v%&, generating more than one address by redirection
3335 causes verification to end successfully, without considering the generated
3336 addresses. However, if just one address is generated, processing continues,
3337 and the generated address must verify successfully for the overall verification
3338 to succeed.
3339
3340 When &%-v%& is set, more details are given of how the address has been handled,
3341 and in the case of address redirection, all the generated addresses are also
3342 considered. Verification may succeed for some and fail for others.
3343
3344 The
3345 .cindex "return code" "for &%-bv%&"
3346 return code is 2 if any address failed outright; it is 1 if no address
3347 failed outright but at least one could not be resolved for some reason. Return
3348 code 0 is given only when all addresses succeed.
3349
3350 If any of the routers in the configuration makes any tests on the sender
3351 address of a message, you should use the &%-f%& option to set an appropriate
3352 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3353 calling user at the default qualifying domain.
3354
3355 .vitem &%-bvs%&
3356 .oindex "&%-bvs%&"
3357 This option acts like &%-bv%&, but verifies the address as a sender rather
3358 than a recipient address. This affects any rewriting and qualification that
3359 might happen.
3360
3361 .vitem &%-C%&&~<&'filelist'&>
3362 .oindex "&%-C%&"
3363 .cindex "configuration file" "alternate"
3364 .cindex "CONFIGURE_FILE"
3365 .cindex "alternate configuration file"
3366 This option causes Exim to find the run time configuration file from the given
3367 list instead of from the list specified by the CONFIGURE_FILE
3368 compile-time setting. Usually, the list will consist of just a single file
3369 name, but it can be a colon-separated list of names. In this case, the first
3370 file that exists is used. Failure to open an existing file stops Exim from
3371 proceeding any further along the list, and an error is generated.
3372
3373 .new
3374 When this option is used by a caller other than root, and the list is different
3375 from the compiled-in list, Exim gives up its root privilege immediately, and
3376 runs with the real and effective uid and gid set to those of the caller.
3377 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3378 file contains a list of full pathnames, one per line, for configuration files
3379 which are trusted. Root privilege is retained for any configuration file so
3380 listed, as long as the caller is the Exim user (or the user specified in the
3381 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3382 not writeable by inappropriate users or groups.
3383
3384 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3385 configuration using &%-C%& right through message reception and delivery,
3386 even if the caller is root. The reception works, but by that time, Exim is
3387 running as the Exim user, so when it re-executes to regain privilege for the
3388 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3389 test reception and delivery using two separate commands (one to put a message
3390 on the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3391 .wen
3392 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3393 prefix string with which any file named in a &%-C%& command line option
3394 must start. In addition, the file name must not contain the sequence &`/../`&.
3395 However, if the value of the &%-C%& option is identical to the value of
3396 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3397 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3398 unset, any file name can be used with &%-C%&.
3399
3400 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3401 to a directory to which only root has access. This prevents someone who has
3402 broken into the Exim account from running a privileged Exim with an arbitrary
3403 configuration file.
3404
3405 The &%-C%& facility is useful for ensuring that configuration files are
3406 syntactically correct, but cannot be used for test deliveries, unless the
3407 caller is privileged, or unless it is an exotic configuration that does not
3408 require privilege. No check is made on the owner or group of the files
3409 specified by this option.
3410
3411
3412 .vitem &%-D%&<&'macro'&>=<&'value'&>
3413 .oindex "&%-D%&"
3414 .cindex "macro" "setting on command line"
3415 This option can be used to override macro definitions in the configuration file
3416 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3417 unprivileged caller, it causes Exim to give up its root privilege.
3418 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3419 completely disabled, and its use causes an immediate error exit.
3420
3421 .new
3422 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3423 colon-separated list of macros which are considered safe and, if &%-D%& only
3424 supplies macros from this list, and the values are acceptable, then Exim will
3425 not give up root privilege if the caller is root, the Exim run-time user, or
3426 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3427 to be removed in the future.  Acceptable values for the macros satisfy the
3428 regexp: &`^[A-Za-z0-9_/.-]*$`&
3429 .wen
3430 The entire option (including equals sign if present) must all be within one
3431 command line item. &%-D%& can be used to set the value of a macro to the empty
3432 string, in which case the equals sign is optional. These two commands are
3433 synonymous:
3434 .code
3435 exim -DABC  ...
3436 exim -DABC= ...
3437 .endd
3438 To include spaces in a macro definition item, quotes must be used. If you use
3439 quotes, spaces are permitted around the macro name and the equals sign. For
3440 example:
3441 .code
3442 exim '-D ABC = something' ...
3443 .endd
3444 &%-D%& may be repeated up to 10 times on a command line.
3445
3446
3447 .vitem &%-d%&<&'debug&~options'&>
3448 .oindex "&%-d%&"
3449 .cindex "debugging" "list of selectors"
3450 .cindex "debugging" "&%-d%& option"
3451 This option causes debugging information to be written to the standard
3452 error stream. It is restricted to admin users because debugging output may show
3453 database queries that contain password information. Also, the details of users'
3454 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3455 writes an error message to the standard error stream and exits with a non-zero
3456 return code.
3457
3458 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3459 standard debugging data is output. This can be reduced, or increased to include
3460 some more rarely needed information, by directly following &%-d%& with a string
3461 made up of names preceded by plus or minus characters. These add or remove sets
3462 of debugging data, respectively. For example, &%-d+filter%& adds filter
3463 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3464 no spaces are allowed in the debug setting. The available debugging categories
3465 are:
3466 .display
3467 &`acl            `& ACL interpretation
3468 &`auth           `& authenticators
3469 &`deliver        `& general delivery logic
3470 &`dns            `& DNS lookups (see also resolver)
3471 &`dnsbl          `& DNS black list (aka RBL) code
3472 &`exec           `& arguments for &[execv()]& calls
3473 &`expand         `& detailed debugging for string expansions
3474 &`filter         `& filter handling
3475 &`hints_lookup   `& hints data lookups
3476 &`host_lookup    `& all types of name-to-IP address handling
3477 &`ident          `& ident lookup
3478 &`interface      `& lists of local interfaces
3479 &`lists          `& matching things in lists
3480 &`load           `& system load checks
3481 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3482                     &<<CHAPlocalscan>>&)
3483 &`lookup         `& general lookup code and all lookups
3484 &`memory         `& memory handling
3485 &`pid            `& add pid to debug output lines
3486 &`process_info   `& setting info for the process log
3487 &`queue_run      `& queue runs
3488 &`receive        `& general message reception logic
3489 &`resolver       `& turn on the DNS resolver's debugging output
3490 &`retry          `& retry handling
3491 &`rewrite        `& address rewriting
3492 &`route          `& address routing
3493 &`timestamp      `& add timestamp to debug output lines
3494 &`tls            `& TLS logic
3495 &`transport      `& transports
3496 &`uid            `& changes of uid/gid and looking up uid/gid
3497 &`verify         `& address verification logic
3498 &`all            `& almost all of the above (see below), and also &%-v%&
3499 .endd
3500 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3501 for &`-all`&. The reason for this is that &`+all`& is something that people
3502 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3503 is included, an awful lot of output that is very rarely of interest is
3504 generated, so it now has to be explicitly requested. However, &`-all`& does
3505 turn everything off.
3506
3507 .cindex "resolver, debugging output"
3508 .cindex "DNS resolver, debugging output"
3509 The &`resolver`& option produces output only if the DNS resolver was compiled
3510 with DEBUG enabled. This is not the case in some operating systems. Also,
3511 unfortunately, debugging output from the DNS resolver is written to stdout
3512 rather than stderr.
3513
3514 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3515 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3516 However, the &`pid`& selector is forced when debugging is turned on for a
3517 daemon, which then passes it on to any re-executed Exims. Exim also
3518 automatically adds the pid to debug lines when several remote deliveries are
3519 run in parallel.
3520
3521 The &`timestamp`& selector causes the current time to be inserted at the start
3522 of all debug output lines. This can be useful when trying to track down delays
3523 in processing.
3524
3525 If the &%debug_print%& option is set in any driver, it produces output whenever
3526 any debugging is selected, or if &%-v%& is used.
3527
3528 .vitem &%-dd%&<&'debug&~options'&>
3529 .oindex "&%-dd%&"
3530 This option behaves exactly like &%-d%& except when used on a command that
3531 starts a daemon process. In that case, debugging is turned off for the
3532 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3533 behaviour of the daemon without creating as much output as full debugging does.
3534
3535 .vitem &%-dropcr%&
3536 .oindex "&%-dropcr%&"
3537 This is an obsolete option that is now a no-op. It used to affect the way Exim
3538 handled CR and LF characters in incoming messages. What happens now is
3539 described in section &<<SECTlineendings>>&.
3540
3541 .vitem &%-E%&
3542 .oindex "&%-E%&"
3543 .cindex "bounce message" "generating"
3544 This option specifies that an incoming message is a locally-generated delivery
3545 failure report. It is used internally by Exim when handling delivery failures
3546 and is not intended for external use. Its only effect is to stop Exim
3547 generating certain messages to the postmaster, as otherwise message cascades
3548 could occur in some situations. As part of the same option, a message id may
3549 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3550 new message contains the id, following &"R="&, as a cross-reference.
3551
3552 .vitem &%-e%&&'x'&
3553 .oindex "&%-e%&&'x'&"
3554 There are a number of Sendmail options starting with &%-oe%& which seem to be
3555 called by various programs without the leading &%o%& in the option. For
3556 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3557 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3558
3559 .vitem &%-F%&&~<&'string'&>
3560 .oindex "&%-F%&"
3561 .cindex "sender" "name"
3562 .cindex "name" "of sender"
3563 This option sets the sender's full name for use when a locally-generated
3564 message is being accepted. In the absence of this option, the user's &'gecos'&
3565 entry from the password data is used. As users are generally permitted to alter
3566 their &'gecos'& entries, no security considerations are involved. White space
3567 between &%-F%& and the <&'string'&> is optional.
3568
3569 .vitem &%-f%&&~<&'address'&>
3570 .oindex "&%-f%&"
3571 .cindex "sender" "address"
3572 .cindex "address" "sender"
3573 .cindex "trusted users"
3574 .cindex "envelope sender"
3575 .cindex "user" "trusted"
3576 This option sets the address of the envelope sender of a locally-generated
3577 message (also known as the return path). The option can normally be used only
3578 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3579 users to use it.
3580
3581 Processes running as root or the Exim user are always trusted. Other
3582 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3583 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3584 of a local message is set to the caller's login name at the default qualify
3585 domain.
3586
3587 There is one exception to the restriction on the use of &%-f%&: an empty sender
3588 can be specified by any user, trusted or not, to create a message that can
3589 never provoke a bounce. An empty sender can be specified either as an empty
3590 string, or as a pair of angle brackets with nothing between them, as in these
3591 examples of shell commands:
3592 .code
3593 exim -f '<>' user@domain
3594 exim -f "" user@domain
3595 .endd
3596 In addition, the use of &%-f%& is not restricted when testing a filter file
3597 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3598 &%-bv%& options.
3599
3600 Allowing untrusted users to change the sender address does not of itself make
3601 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3602 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3603 though this can be overridden by setting &%no_local_from_check%&.
3604
3605 White
3606 .cindex "&""From""& line"
3607 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3608 given as two arguments or one combined argument). The sender of a
3609 locally-generated message can also be set (when permitted) by an initial
3610 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3611 if &%-f%& is also present, it overrides &"From&~"&.
3612
3613 .vitem &%-G%&
3614 .oindex "&%-G%&"
3615 .cindex "Sendmail compatibility" "&%-G%& option ignored"
3616 This is a Sendmail option which is ignored by Exim.
3617
3618 .vitem &%-h%&&~<&'number'&>
3619 .oindex "&%-h%&"
3620 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3621 This option is accepted for compatibility with Sendmail, but has no effect. (In
3622 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3623 headers.)
3624
3625 .vitem &%-i%&
3626 .oindex "&%-i%&"
3627 .cindex "Solaris" "&'mail'& command"
3628 .cindex "dot" "in incoming non-SMTP message"
3629 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3630 line by itself should not terminate an incoming, non-SMTP message. I can find
3631 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3632 command in Solaris 2.4 uses it. See also &%-ti%&.
3633
3634 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3635 .oindex "&%-M%&"
3636 .cindex "forcing delivery"
3637 .cindex "delivery" "forcing attempt"
3638 .cindex "frozen messages" "forcing delivery"
3639 This option requests Exim to run a delivery attempt on each message in turn. If
3640 any of the messages are frozen, they are automatically thawed before the
3641 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3642 and &%hold_domains%& are ignored.
3643
3644 Retry
3645 .cindex "hints database" "overriding retry hints"
3646 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3647 the normal retry time has not yet been reached. This option requires the caller
3648 to be an admin user. However, there is an option called &%prod_requires_admin%&
3649 which can be set false to relax this restriction (and also the same requirement
3650 for the &%-q%&, &%-R%&, and &%-S%& options).
3651
3652 The deliveries happen synchronously, that is, the original Exim process does
3653 not terminate until all the delivery attempts have finished. No output is
3654 produced unless there is a serious error. If you want to see what is happening,
3655 use the &%-v%& option as well, or inspect Exim's main log.
3656
3657 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3658 .oindex "&%-Mar%&"
3659 .cindex "message" "adding recipients"
3660 .cindex "recipient" "adding"
3661 This option requests Exim to add the addresses to the list of recipients of the
3662 message (&"ar"& for &"add recipients"&). The first argument must be a message
3663 id, and the remaining ones must be email addresses. However, if the message is
3664 active (in the middle of a delivery attempt), it is not altered. This option
3665 can be used only by an admin user.
3666
3667 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3668         &~<&'message&~id'&>"
3669 .oindex "&%-MC%&"
3670 .cindex "SMTP" "passed connection"
3671 .cindex "SMTP" "multiple deliveries"
3672 .cindex "multiple SMTP deliveries"
3673 This option is not intended for use by external callers. It is used internally
3674 by Exim to invoke another instance of itself to deliver a waiting message using
3675 an existing SMTP connection, which is passed as the standard input. Details are
3676 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3677 must be root or the Exim user in order to use it.
3678
3679 .vitem &%-MCA%&
3680 .oindex "&%-MCA%&"
3681 This option is not intended for use by external callers. It is used internally
3682 by Exim in conjunction with the &%-MC%& option. It signifies that the
3683 connection to the remote host has been authenticated.
3684
3685 .vitem &%-MCP%&
3686 .oindex "&%-MCP%&"
3687 This option is not intended for use by external callers. It is used internally
3688 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3689 which Exim is connected supports pipelining.
3690
3691 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3692 .oindex "&%-MCQ%&"
3693 This option is not intended for use by external callers. It is used internally
3694 by Exim in conjunction with the &%-MC%& option when the original delivery was
3695 started by a queue runner. It passes on the process id of the queue runner,
3696 together with the file descriptor number of an open pipe. Closure of the pipe
3697 signals the final completion of the sequence of processes that are passing
3698 messages through the same SMTP connection.
3699
3700 .vitem &%-MCS%&
3701 .oindex "&%-MCS%&"
3702 This option is not intended for use by external callers. It is used internally
3703 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3704 SMTP SIZE option should be used on messages delivered down the existing
3705 connection.
3706
3707 .vitem &%-MCT%&
3708 .oindex "&%-MCT%&"
3709 This option is not intended for use by external callers. It is used internally
3710 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3711 host to which Exim is connected supports TLS encryption.
3712
3713 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3714 .oindex "&%-Mc%&"
3715 .cindex "hints database" "not overridden by &%-Mc%&"
3716 .cindex "delivery" "manually started &-- not forced"
3717 This option requests Exim to run a delivery attempt on each message in turn,
3718 but unlike the &%-M%& option, it does check for retry hints, and respects any
3719 that are found. This option is not very useful to external callers. It is
3720 provided mainly for internal use by Exim when it needs to re-invoke itself in
3721 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3722 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3723 respects retry times and other options such as &%hold_domains%& that are
3724 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3725 If you want to run a specific delivery as if in a queue run, you should use
3726 &%-q%& with a message id argument. A distinction between queue run deliveries
3727 and other deliveries is made in one or two places.
3728
3729 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3730 .oindex "&%-Mes%&"
3731 .cindex "message" "changing sender"
3732 .cindex "sender" "changing"
3733 This option requests Exim to change the sender address in the message to the
3734 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3735 &"edit sender"&). There must be exactly two arguments. The first argument must
3736 be a message id, and the second one an email address. However, if the message
3737 is active (in the middle of a delivery attempt), its status is not altered.
3738 This option can be used only by an admin user.
3739
3740 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3741 .oindex "&%-Mf%&"
3742 .cindex "freezing messages"
3743 .cindex "message" "manually freezing"
3744 This option requests Exim to mark each listed message as &"frozen"&. This
3745 prevents any delivery attempts taking place until the message is &"thawed"&,
3746 either manually or as a result of the &%auto_thaw%& configuration option.
3747 However, if any of the messages are active (in the middle of a delivery
3748 attempt), their status is not altered. This option can be used only by an admin
3749 user.
3750
3751 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3752 .oindex "&%-Mg%&"
3753 .cindex "giving up on messages"
3754 .cindex "message" "abandoning delivery attempts"
3755 .cindex "delivery" "abandoning further attempts"
3756 This option requests Exim to give up trying to deliver the listed messages,
3757 including any that are frozen. However, if any of the messages are active,
3758 their status is not altered. For non-bounce messages, a delivery error message
3759 is sent to the sender, containing the text &"cancelled by administrator"&.
3760 Bounce messages are just discarded. This option can be used only by an admin
3761 user.
3762
3763 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3764 .oindex "&%-Mmad%&"
3765 .cindex "delivery" "cancelling all"
3766 This option requests Exim to mark all the recipient addresses in the messages
3767 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3768 message is active (in the middle of a delivery attempt), its status is not
3769 altered. This option can be used only by an admin user.
3770
3771 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3772 .oindex "&%-Mmd%&"
3773 .cindex "delivery" "cancelling by address"
3774 .cindex "recipient" "removing"
3775 .cindex "removing recipients"
3776 This option requests Exim to mark the given addresses as already delivered
3777 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3778 the remaining ones must be email addresses. These are matched to recipient
3779 addresses in the message in a case-sensitive manner. If the message is active
3780 (in the middle of a delivery attempt), its status is not altered. This option
3781 can be used only by an admin user.
3782
3783 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3784 .oindex "&%-Mrm%&"
3785 .cindex "removing messages"
3786 .cindex "abandoning mail"
3787 .cindex "message" "manually discarding"
3788 This option requests Exim to remove the given messages from the queue. No
3789 bounce messages are sent; each message is simply forgotten. However, if any of
3790 the messages are active, their status is not altered. This option can be used
3791 only by an admin user or by the user who originally caused the message to be
3792 placed on the queue.
3793
3794 .vitem &%-Mset%&&~<&'message&~id'&>
3795 .oindex "&%-Mset%&
3796 .cindex "testing" "string expansion"
3797 .cindex "expansion" "testing"
3798 This option is useful only in conjunction with &%-be%& (that is, when testing
3799 string expansions). Exim loads the given message from its spool before doing
3800 the test expansions, thus setting message-specific variables such as
3801 &$message_size$& and the header variables. The &$recipients$& variable is made
3802 available. This feature is provided to make it easier to test expansions that
3803 make use of these variables. However, this option can be used only by an admin
3804 user. See also &%-bem%&.
3805
3806 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3807 .oindex "&%-Mt%&"
3808 .cindex "thawing messages"
3809 .cindex "unfreezing messages"
3810 .cindex "frozen messages" "thawing"
3811 .cindex "message" "thawing frozen"
3812 This option requests Exim to &"thaw"& any of the listed messages that are
3813 &"frozen"&, so that delivery attempts can resume. However, if any of the
3814 messages are active, their status is not altered. This option can be used only
3815 by an admin user.
3816
3817 .vitem &%-Mvb%&&~<&'message&~id'&>
3818 .oindex "&%-Mvb%&"
3819 .cindex "listing" "message body"
3820 .cindex "message" "listing body of"
3821 This option causes the contents of the message body (-D) spool file to be
3822 written to the standard output. This option can be used only by an admin user.
3823
3824 .new
3825 .vitem &%-Mvc%&&~<&'message&~id'&>
3826 .oindex "&%-Mvc%&"
3827 .cindex "message" "listing in RFC 2822 format"
3828 .cindex "listing" "message in RFC 2822 format"
3829 This option causes a copy of the complete message (header lines plus body) to
3830 be written to the standard output in RFC 2822 format. This option can be used
3831 only by an admin user.
3832 .wen
3833 .vitem &%-Mvh%&&~<&'message&~id'&>
3834 .oindex "&%-Mvh%&"
3835 .cindex "listing" "message headers"
3836 .cindex "header lines" "listing"
3837 .cindex "message" "listing header lines"
3838 This option causes the contents of the message headers (-H) spool file to be
3839 written to the standard output. This option can be used only by an admin user.
3840
3841 .vitem &%-Mvl%&&~<&'message&~id'&>
3842 .oindex "&%-Mvl%&"
3843 .cindex "listing" "message log"
3844 .cindex "message" "listing message log"
3845 This option causes the contents of the message log spool file to be written to
3846 the standard output. This option can be used only by an admin user.
3847
3848 .vitem &%-m%&
3849 .oindex "&%-m%&"
3850 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
3851 treats it that way too.
3852
3853 .vitem &%-N%&
3854 .oindex "&%-N%&"
3855 .cindex "debugging" "&%-N%& option"
3856 .cindex "debugging" "suppressing delivery"
3857 This is a debugging option that inhibits delivery of a message at the transport
3858 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
3859 it just doesn't actually transport the message, but instead behaves as if it
3860 had successfully done so. However, it does not make any updates to the retry
3861 database, and the log entries for deliveries are flagged with &"*>"& rather
3862 than &"=>"&.
3863
3864 Because &%-N%& discards any message to which it applies, only root or the Exim
3865 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
3866 words, an ordinary user can use it only when supplying an incoming message to
3867 which it will apply. Although transportation never fails when &%-N%& is set, an
3868 address may be deferred because of a configuration problem on a transport, or a
3869 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
3870 the message, and applies to any subsequent delivery attempts that may happen
3871 for that message.
3872
3873 .vitem &%-n%&
3874 .oindex "&%-n%&"
3875 .cindex "Sendmail compatibility" "&%-n%& option ignored"
3876 This option is interpreted by Sendmail to mean &"no aliasing"&. It is ignored
3877 by Exim.
3878
3879 .vitem &%-O%&&~<&'data'&>
3880 .oindex "&%-O%&"
3881 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
3882 Exim.
3883
3884 .vitem &%-oA%&&~<&'file&~name'&>
3885 .oindex "&%-oA%&"
3886 .cindex "Sendmail compatibility" "&%-oA%& option"
3887 This option is used by Sendmail in conjunction with &%-bi%& to specify an
3888 alternative alias file name. Exim handles &%-bi%& differently; see the
3889 description above.
3890
3891 .vitem &%-oB%&&~<&'n'&>
3892 .oindex "&%-oB%&"
3893 .cindex "SMTP" "passed connection"
3894 .cindex "SMTP" "multiple deliveries"
3895 .cindex "multiple SMTP deliveries"
3896 This is a debugging option which limits the maximum number of messages that can
3897 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
3898 transport. If <&'n'&> is omitted, the limit is set to 1.
3899
3900 .vitem &%-odb%&
3901 .oindex "&%-odb%&"
3902 .cindex "background delivery"
3903 .cindex "delivery" "in the background"
3904 This option applies to all modes in which Exim accepts incoming messages,
3905 including the listening daemon. It requests &"background"& delivery of such
3906 messages, which means that the accepting process automatically starts a
3907 delivery process for each message received, but does not wait for the delivery
3908 processes to finish.
3909
3910 When all the messages have been received, the reception process exits,
3911 leaving the delivery processes to finish in their own time. The standard output
3912 and error streams are closed at the start of each delivery process.
3913 This is the default action if none of the &%-od%& options are present.
3914
3915 If one of the queueing options in the configuration file
3916 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
3917 overrides it if &%queue_only_override%& is set true, which is the default
3918 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
3919
3920 .vitem &%-odf%&
3921 .oindex "&%-odf%&"
3922 .cindex "foreground delivery"
3923 .cindex "delivery" "in the foreground"
3924 This option requests &"foreground"& (synchronous) delivery when Exim has
3925 accepted a locally-generated message. (For the daemon it is exactly the same as
3926 &%-odb%&.) A delivery process is automatically started to deliver the message,
3927 and Exim waits for it to complete before proceeding.
3928
3929 The original Exim reception process does not finish until the delivery
3930 process for the final message has ended. The standard error stream is left open
3931 during deliveries.
3932
3933 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
3934 false and one of the queueing options in the configuration file is in effect.
3935
3936 If there is a temporary delivery error during foreground delivery, the
3937 message is left on the queue for later delivery, and the original reception
3938 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
3939 restricted configuration that never queues messages.
3940
3941
3942 .vitem &%-odi%&
3943 .oindex "&%-odi%&"
3944 This option is synonymous with &%-odf%&. It is provided for compatibility with
3945 Sendmail.
3946
3947 .vitem &%-odq%&
3948 .oindex "&%-odq%&"
3949 .cindex "non-immediate delivery"
3950 .cindex "delivery" "suppressing immediate"
3951 .cindex "queueing incoming messages"
3952 This option applies to all modes in which Exim accepts incoming messages,
3953 including the listening daemon. It specifies that the accepting process should
3954 not automatically start a delivery process for each message received. Messages
3955 are placed on the queue, and remain there until a subsequent queue runner
3956 process encounters them. There are several configuration options (such as
3957 &%queue_only%&) that can be used to queue incoming messages under certain
3958 conditions. This option overrides all of them and also &%-odqs%&. It always
3959 forces queueing.
3960
3961 .vitem &%-odqs%&
3962 .oindex "&%-odqs%&"
3963 .cindex "SMTP" "delaying delivery"
3964 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
3965 However, like &%-odb%& and &%-odi%&, this option has no effect if
3966 &%queue_only_override%& is false and one of the queueing options in the
3967 configuration file is in effect.
3968
3969 When &%-odqs%& does operate, a delivery process is started for each incoming
3970 message, in the background by default, but in the foreground if &%-odi%& is
3971 also present. The recipient addresses are routed, and local deliveries are done
3972 in the normal way. However, if any SMTP deliveries are required, they are not
3973 done at this time, so the message remains on the queue until a subsequent queue
3974 runner process encounters it. Because routing was done, Exim knows which
3975 messages are waiting for which hosts, and so a number of messages for the same
3976 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
3977 configuration option has the same effect for specific domains. See also the
3978 &%-qq%& option.
3979
3980 .vitem &%-oee%&
3981 .oindex "&%-oee%&"
3982 .cindex "error" "reporting"
3983 If an error is detected while a non-SMTP message is being received (for
3984 example, a malformed address), the error is reported to the sender in a mail
3985 message.
3986
3987 .cindex "return code" "for &%-oee%&"
3988 Provided
3989 this error message is successfully sent, the Exim receiving process
3990 exits with a return code of zero. If not, the return code is 2 if the problem
3991 is that the original message has no recipients, or 1 any other error. This is
3992 the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
3993
3994 .vitem &%-oem%&
3995 .oindex "&%-oem%&"
3996 .cindex "error" "reporting"
3997 .cindex "return code" "for &%-oem%&"
3998 This is the same as &%-oee%&, except that Exim always exits with a non-zero
3999 return code, whether or not the error message was successfully sent.
4000 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4001
4002 .vitem &%-oep%&
4003 .oindex "&%-oep%&"
4004 .cindex "error" "reporting"
4005 If an error is detected while a non-SMTP message is being received, the
4006 error is reported by writing a message to the standard error file (stderr).
4007 .cindex "return code" "for &%-oep%&"
4008 The return code is 1 for all errors.
4009
4010 .vitem &%-oeq%&
4011 .oindex "&%-oeq%&"
4012 .cindex "error" "reporting"
4013 This option is supported for compatibility with Sendmail, but has the same
4014 effect as &%-oep%&.
4015
4016 .vitem &%-oew%&
4017 .oindex "&%-oew%&"
4018 .cindex "error" "reporting"
4019 This option is supported for compatibility with Sendmail, but has the same
4020 effect as &%-oem%&.
4021
4022 .vitem &%-oi%&
4023 .oindex "&%-oi%&"
4024 .cindex "dot" "in incoming non-SMTP message"
4025 This option, which has the same effect as &%-i%&, specifies that a dot on a
4026 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4027 single dot does terminate, though Exim does no special processing for other
4028 lines that start with a dot. This option is set by default if Exim is called as
4029 &'rmail'&. See also &%-ti%&.
4030
4031 .vitem &%-oitrue%&
4032 .oindex "&%-oitrue%&"
4033 This option is treated as synonymous with &%-oi%&.
4034
4035 .vitem &%-oMa%&&~<&'host&~address'&>
4036 .oindex "&%-oMa%&"
4037 .cindex "sender" "host address, specifying for local message"
4038 A number of options starting with &%-oM%& can be used to set values associated
4039 with remote hosts on locally-submitted messages (that is, messages not received
4040 over TCP/IP). These options can be used by any caller in conjunction with the
4041 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4042 other circumstances, they are ignored unless the caller is trusted.
4043
4044 The &%-oMa%& option sets the sender host address. This may include a port
4045 number at the end, after a full stop (period). For example:
4046 .code
4047 exim -bs -oMa 10.9.8.7.1234
4048 .endd
4049 An alternative syntax is to enclose the IP address in square brackets,
4050 followed by a colon and the port number:
4051 .code
4052 exim -bs -oMa [10.9.8.7]:1234
4053 .endd
4054 The IP address is placed in the &$sender_host_address$& variable, and the
4055 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4056 are present on the command line, the sender host IP address is taken from
4057 whichever one is last.
4058
4059 .vitem &%-oMaa%&&~<&'name'&>
4060 .oindex "&%-oMaa%&"
4061 .cindex "authentication" "name, specifying for local message"
4062 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4063 option sets the value of &$sender_host_authenticated$& (the authenticator
4064 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4065 This option can be used with &%-bh%& and &%-bs%& to set up an
4066 authenticated SMTP session without actually using the SMTP AUTH command.
4067
4068 .vitem &%-oMai%&&~<&'string'&>
4069 .oindex "&%-oMai%&"
4070 .cindex "authentication" "id, specifying for local message"
4071 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4072 option sets the value of &$authenticated_id$& (the id that was authenticated).
4073 This overrides the default value (the caller's login id, except with &%-bh%&,
4074 where there is no default) for messages from local sources. See chapter
4075 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4076
4077 .vitem &%-oMas%&&~<&'address'&>
4078 .oindex "&%-oMas%&"
4079 .cindex "authentication" "sender, specifying for local message"
4080 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4081 option sets the authenticated sender value in &$authenticated_sender$&. It
4082 overrides the sender address that is created from the caller's login id for
4083 messages from local sources, except when &%-bh%& is used, when there is no
4084 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4085 specified on a MAIL command overrides this value. See chapter
4086 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4087
4088 .vitem &%-oMi%&&~<&'interface&~address'&>
4089 .oindex "&%-oMi%&"
4090 .cindex "interface" "address, specifying for local message"
4091 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4092 option sets the IP interface address value. A port number may be included,
4093 using the same syntax as for &%-oMa%&. The interface address is placed in
4094 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4095
4096 .vitem &%-oMr%&&~<&'protocol&~name'&>
4097 .oindex "&%-oMr%&"
4098 .cindex "protocol, specifying for local message"
4099 .vindex "&$received_protocol$&"
4100 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4101 option sets the received protocol value that is stored in
4102 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4103 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4104 SMTP protocol names (see the description of &$received_protocol$& in section
4105 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4106 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4107 be set by &%-oMr%&.
4108
4109 .vitem &%-oMs%&&~<&'host&~name'&>
4110 .oindex "&%-oMs%&"
4111 .cindex "sender" "host name, specifying for local message"
4112 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4113 option sets the sender host name in &$sender_host_name$&. When this option is
4114 present, Exim does not attempt to look up a host name from an IP address; it
4115 uses the name it is given.
4116
4117 .vitem &%-oMt%&&~<&'ident&~string'&>
4118 .oindex "&%-oMt%&"
4119 .cindex "sender" "ident string, specifying for local message"
4120 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4121 option sets the sender ident value in &$sender_ident$&. The default setting for
4122 local callers is the login id of the calling process, except when &%-bh%& is
4123 used, when there is no default.
4124
4125 .vitem &%-om%&
4126 .oindex "&%-om%&"
4127 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4128 In Sendmail, this option means &"me too"&, indicating that the sender of a
4129 message should receive a copy of the message if the sender appears in an alias
4130 expansion. Exim always does this, so the option does nothing.
4131
4132 .vitem &%-oo%&
4133 .oindex "&%-oo%&"
4134 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4135 This option is ignored. In Sendmail it specifies &"old style headers"&,
4136 whatever that means.
4137
4138 .vitem &%-oP%&&~<&'path'&>
4139 .oindex "&%-oP%&"
4140 .cindex "pid (process id)" "of daemon"
4141 .cindex "daemon" "process id (pid)"
4142 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4143 value. The option specifies the file to which the process id of the daemon is
4144 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4145 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4146 because in those cases, the normal pid file is not used.
4147
4148 .vitem &%-or%&&~<&'time'&>
4149 .oindex "&%-or%&"
4150 .cindex "timeout" "for non-SMTP input"
4151 This option sets a timeout value for incoming non-SMTP messages. If it is not
4152 set, Exim will wait forever for the standard input. The value can also be set
4153 by the &%receive_timeout%& option. The format used for specifying times is
4154 described in section &<<SECTtimeformat>>&.
4155
4156 .vitem &%-os%&&~<&'time'&>
4157 .oindex "&%-os%&"
4158 .cindex "timeout" "for SMTP input"
4159 .cindex "SMTP" "input timeout"
4160 This option sets a timeout value for incoming SMTP messages. The timeout
4161 applies to each SMTP command and block of data. The value can also be set by
4162 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4163 for specifying times is described in section &<<SECTtimeformat>>&.
4164
4165 .vitem &%-ov%&
4166 .oindex "&%-ov%&"
4167 This option has exactly the same effect as &%-v%&.
4168
4169 .vitem &%-oX%&&~<&'number&~or&~string'&>
4170 .oindex "&%-oX%&"
4171 .cindex "TCP/IP" "setting listening ports"
4172 .cindex "TCP/IP" "setting listening interfaces"
4173 .cindex "port" "receiving TCP/IP"
4174 This option is relevant only when the &%-bd%& (start listening daemon) option
4175 is also given. It controls which ports and interfaces the daemon uses. Details
4176 of the syntax, and how it interacts with configuration file options, are given
4177 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4178 file is written unless &%-oP%& is also present to specify a pid file name.
4179
4180 .vitem &%-pd%&
4181 .oindex "&%-pd%&"
4182 .cindex "Perl" "starting the interpreter"
4183 This option applies when an embedded Perl interpreter is linked with Exim (see
4184 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4185 option, forcing the starting of the interpreter to be delayed until it is
4186 needed.
4187
4188 .vitem &%-ps%&
4189 .oindex "&%-ps%&"
4190 .cindex "Perl" "starting the interpreter"
4191 This option applies when an embedded Perl interpreter is linked with Exim (see
4192 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4193 option, forcing the starting of the interpreter to occur as soon as Exim is
4194 started.
4195
4196 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4197 .oindex "&%-p%&"
4198 For compatibility with Sendmail, this option is equivalent to
4199 .display
4200 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4201 .endd
4202 It sets the incoming protocol and host name (for trusted callers). The
4203 host name and its colon can be omitted when only the protocol is to be set.
4204 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4205 to embedded Perl. It is therefore impossible to set a protocol value of &`p`&
4206 or &`s`& using this option (but that does not seem a real limitation).
4207
4208 .vitem &%-q%&
4209 .oindex "&%-q%&"
4210 .cindex "queue runner" "starting manually"
4211 This option is normally restricted to admin users. However, there is a
4212 configuration option called &%prod_requires_admin%& which can be set false to
4213 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4214 and &%-S%& options).
4215
4216 .cindex "queue runner" "description of operation"
4217 The &%-q%& option starts one queue runner process. This scans the queue of
4218 waiting messages, and runs a delivery process for each one in turn. It waits
4219 for each delivery process to finish before starting the next one. A delivery
4220 process may not actually do any deliveries if the retry times for the addresses
4221 have not been reached. Use &%-qf%& (see below) if you want to override this.
4222
4223 If
4224 .cindex "SMTP" "passed connection"
4225 .cindex "SMTP" "multiple deliveries"
4226 .cindex "multiple SMTP deliveries"
4227 the delivery process spawns other processes to deliver other messages down
4228 passed SMTP connections, the queue runner waits for these to finish before
4229 proceeding.
4230
4231 When all the queued messages have been considered, the original queue runner
4232 process terminates. In other words, a single pass is made over the waiting
4233 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4234 this to be repeated periodically.
4235
4236 Exim processes the waiting messages in an unpredictable order. It isn't very
4237 random, but it is likely to be different each time, which is all that matters.
4238 If one particular message screws up a remote MTA, other messages to the same
4239 MTA have a chance of getting through if they get tried first.
4240
4241 It is possible to cause the messages to be processed in lexical message id
4242 order, which is essentially the order in which they arrived, by setting the
4243 &%queue_run_in_order%& option, but this is not recommended for normal use.
4244
4245 .vitem &%-q%&<&'qflags'&>
4246 The &%-q%& option may be followed by one or more flag letters that change its
4247 behaviour. They are all optional, but if more than one is present, they must
4248 appear in the correct order. Each flag is described in a separate item below.
4249
4250 .vitem &%-qq...%&
4251 .oindex "&%-qq%&"
4252 .cindex "queue" "double scanning"
4253 .cindex "queue" "routing"
4254 .cindex "routing" "whole queue before delivery"
4255 An option starting with &%-qq%& requests a two-stage queue run. In the first
4256 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4257 every domain. Addresses are routed, local deliveries happen, but no remote
4258 transports are run.
4259
4260 .cindex "hints database" "remembering routing"
4261 The hints database that remembers which messages are waiting for specific hosts
4262 is updated, as if delivery to those hosts had been deferred. After this is
4263 complete, a second, normal queue scan happens, with routing and delivery taking
4264 place as normal. Messages that are routed to the same host should mostly be
4265 delivered down a single SMTP
4266 .cindex "SMTP" "passed connection"
4267 .cindex "SMTP" "multiple deliveries"
4268 .cindex "multiple SMTP deliveries"
4269 connection because of the hints that were set up during the first queue scan.
4270 This option may be useful for hosts that are connected to the Internet
4271 intermittently.
4272
4273 .vitem &%-q[q]i...%&
4274 .oindex "&%-qi%&"
4275 .cindex "queue" "initial delivery"
4276 If the &'i'& flag is present, the queue runner runs delivery processes only for
4277 those messages that haven't previously been tried. (&'i'& stands for &"initial
4278 delivery"&.) This can be helpful if you are putting messages on the queue using
4279 &%-odq%& and want a queue runner just to process the new messages.
4280
4281 .vitem &%-q[q][i]f...%&
4282 .oindex "&%-qf%&"
4283 .cindex "queue" "forcing delivery"
4284 .cindex "delivery" "forcing in queue run"
4285 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4286 message, whereas without &'f'& only those non-frozen addresses that have passed
4287 their retry times are tried.
4288
4289 .vitem &%-q[q][i]ff...%&
4290 .oindex "&%-qff%&"
4291 .cindex "frozen messages" "forcing delivery"
4292 If &'ff'& is present, a delivery attempt is forced for every message, whether
4293 frozen or not.
4294
4295 .vitem &%-q[q][i][f[f]]l%&
4296 .oindex "&%-ql%&"
4297 .cindex "queue" "local deliveries only"
4298 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4299 be done. If a message requires any remote deliveries, it remains on the queue
4300 for later delivery.
4301
4302 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4303 .cindex "queue" "delivering specific messages"
4304 When scanning the queue, Exim can be made to skip over messages whose ids are
4305 lexically less than a given value by following the &%-q%& option with a
4306 starting message id. For example:
4307 .code
4308 exim -q 0t5C6f-0000c8-00
4309 .endd
4310 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4311 second message id is given, messages whose ids are lexically greater than it
4312 are also skipped. If the same id is given twice, for example,
4313 .code
4314 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4315 .endd
4316 just one delivery process is started, for that message. This differs from
4317 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4318 that it counts as a delivery from a queue run. Note that the selection
4319 mechanism does not affect the order in which the messages are scanned. There
4320 are also other ways of selecting specific sets of messages for delivery in a
4321 queue run &-- see &%-R%& and &%-S%&.
4322
4323 .vitem &%-q%&<&'qflags'&><&'time'&>
4324 .cindex "queue runner" "starting periodically"
4325 .cindex "periodic queue running"
4326 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4327 starting a queue runner process at intervals specified by the given time value
4328 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4329 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4330 single daemon process handles both functions. A common way of starting up a
4331 combined daemon at system boot time is to use a command such as
4332 .code
4333 /usr/exim/bin/exim -bd -q30m
4334 .endd
4335 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4336 process every 30 minutes.
4337
4338 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4339 pid file is written unless one is explicitly requested by the &%-oP%& option.
4340
4341 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4342 .oindex "&%-qR%&"
4343 This option is synonymous with &%-R%&. It is provided for Sendmail
4344 compatibility.
4345
4346 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4347 .oindex "&%-qS%&"
4348 This option is synonymous with &%-S%&.
4349
4350 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4351 .oindex "&%-R%&"
4352 .cindex "queue runner" "for specific recipients"
4353 .cindex "delivery" "to given domain"
4354 .cindex "domain" "delivery to"
4355 The <&'rsflags'&> may be empty, in which case the white space before the string
4356 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4357 which are the possible values for <&'rsflags'&>. White space is required if
4358 <&'rsflags'&> is not empty.
4359
4360 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4361 perform a single queue run, except that, when scanning the messages on the
4362 queue, Exim processes only those that have at least one undelivered recipient
4363 address containing the given string, which is checked in a case-independent
4364 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4365 regular expression; otherwise it is a literal string.
4366
4367 If you want to do periodic queue runs for messages with specific recipients,
4368 you can combine &%-R%& with &%-q%& and a time value. For example:
4369 .code
4370 exim -q25m -R @special.domain.example
4371 .endd
4372 This example does a queue run for messages with recipients in the given domain
4373 every 25 minutes. Any additional flags that are specified with &%-q%& are
4374 applied to each queue run.
4375
4376 Once a message is selected for delivery by this mechanism, all its addresses
4377 are processed. For the first selected message, Exim overrides any retry
4378 information and forces a delivery attempt for each undelivered address. This
4379 means that if delivery of any address in the first message is successful, any
4380 existing retry information is deleted, and so delivery attempts for that
4381 address in subsequently selected messages (which are processed without forcing)
4382 will run. However, if delivery of any address does not succeed, the retry
4383 information is updated, and in subsequently selected messages, the failing
4384 address will be skipped.
4385
4386 .cindex "frozen messages" "forcing delivery"
4387 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4388 all selected messages, not just the first; frozen messages are included when
4389 &'ff'& is present.
4390
4391 The &%-R%& option makes it straightforward to initiate delivery of all messages
4392 to a given domain after a host has been down for some time. When the SMTP
4393 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4394 effect is to run Exim with the &%-R%& option, but it can be configured to run
4395 an arbitrary command instead.
4396
4397 .vitem &%-r%&
4398 .oindex "&%-r%&"
4399 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4400
4401 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4402 .oindex "&%-S%&"
4403 .cindex "delivery" "from given sender"
4404 .cindex "queue runner" "for specific senders"
4405 This option acts like &%-R%& except that it checks the string against each
4406 message's sender instead of against the recipients. If &%-R%& is also set, both
4407 conditions must be met for a message to be selected. If either of the options
4408 has &'f'& or &'ff'& in its flags, the associated action is taken.
4409
4410 .vitem &%-Tqt%&&~<&'times'&>
4411 .oindex "&%-Tqt%&"
4412 This an option that is exclusively for use by the Exim testing suite. It is not
4413 recognized when Exim is run normally. It allows for the setting up of explicit
4414 &"queue times"& so that various warning/retry features can be tested.
4415
4416 .vitem &%-t%&
4417 .oindex "&%-t%&"
4418 .cindex "recipient" "extracting from header lines"
4419 .cindex "&'Bcc:'& header line"
4420 .cindex "&'Cc:'& header line"
4421 .cindex "&'To:'& header line"
4422 When Exim is receiving a locally-generated, non-SMTP message on its standard
4423 input, the &%-t%& option causes the recipients of the message to be obtained
4424 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4425 from the command arguments. The addresses are extracted before any rewriting
4426 takes place and the &'Bcc:'& header line, if present, is then removed.
4427
4428 .cindex "Sendmail compatibility" "&%-t%& option"
4429 If the command has any arguments, they specify addresses to which the message
4430 is &'not'& to be delivered. That is, the argument addresses are removed from
4431 the recipients list obtained from the headers. This is compatible with Smail 3
4432 and in accordance with the documented behaviour of several versions of
4433 Sendmail, as described in man pages on a number of operating systems (e.g.
4434 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4435 argument addresses to those obtained from the headers, and the O'Reilly
4436 Sendmail book documents it that way. Exim can be made to add argument addresses
4437 instead of subtracting them by setting the option
4438 &%extract_addresses_remove_arguments%& false.
4439
4440 .cindex "&%Resent-%& header lines" "with &%-t%&"
4441 If there are any &%Resent-%& header lines in the message, Exim extracts
4442 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4443 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4444 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4445 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4446
4447 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4448 message is resent several times). The RFC also specifies that they should be
4449 added at the front of the message, and separated by &'Received:'& lines. It is
4450 not at all clear how &%-t%& should operate in the present of multiple sets,
4451 nor indeed exactly what constitutes a &"set"&.
4452 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4453 are often added at the end of the header, and if a message is resent more than
4454 once, it is common for the original set of &%Resent-%& headers to be renamed as
4455 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4456
4457 .vitem &%-ti%&
4458 .oindex "&%-ti%&"
4459 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4460 compatibility with Sendmail.
4461
4462 .vitem &%-tls-on-connect%&
4463 .oindex "&%-tls-on-connect%&"
4464 .cindex "TLS" "use without STARTTLS"
4465 .cindex "TLS" "automatic start"
4466 This option is available when Exim is compiled with TLS support. It forces all
4467 incoming SMTP connections to behave as if the incoming port is listed in the
4468 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4469 &<<CHAPTLS>>& for further details.
4470
4471
4472 .vitem &%-U%&
4473 .oindex "&%-U%&"
4474 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4475 Sendmail uses this option for &"initial message submission"&, and its
4476 documentation states that in future releases, it may complain about
4477 syntactically invalid messages rather than fixing them when this flag is not
4478 set. Exim ignores this option.
4479
4480 .vitem &%-v%&
4481 .oindex "&%-v%&"
4482 This option causes Exim to write information to the standard error stream,
4483 describing what it is doing. In particular, it shows the log lines for
4484 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4485 dialogue is shown. Some of the log lines shown may not actually be written to
4486 the log if the setting of &%log_selector%& discards them. Any relevant
4487 selectors are shown with each log line. If none are shown, the logging is
4488 unconditional.
4489
4490 .vitem &%-x%&
4491 .oindex "&%-x%&"
4492 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4493 National Language Support extended characters in the body of the mail item"&).
4494 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4495 this option.
4496 .endlist
4497
4498 .ecindex IIDclo1
4499 .ecindex IIDclo2
4500
4501
4502 . ////////////////////////////////////////////////////////////////////////////
4503 . Insert a stylized DocBook comment here, to identify the end of the command
4504 . line options. This is for the benefit of the Perl script that automatically
4505 . creates a man page for the options.
4506 . ////////////////////////////////////////////////////////////////////////////
4507
4508 .literal xml
4509 <!-- === End of command line options === -->
4510 .literal off
4511
4512
4513
4514
4515
4516 . ////////////////////////////////////////////////////////////////////////////
4517 . ////////////////////////////////////////////////////////////////////////////
4518
4519
4520 .chapter "The Exim run time configuration file" "CHAPconf" &&&
4521          "The runtime configuration file"
4522
4523 .cindex "run time configuration"
4524 .cindex "configuration file" "general description"
4525 .cindex "CONFIGURE_FILE"
4526 .cindex "configuration file" "errors in"
4527 .cindex "error" "in configuration file"
4528 .cindex "return code" "for bad configuration"
4529 Exim uses a single run time configuration file that is read whenever an Exim
4530 binary is executed. Note that in normal operation, this happens frequently,
4531 because Exim is designed to operate in a distributed manner, without central
4532 control.
4533
4534 If a syntax error is detected while reading the configuration file, Exim
4535 writes a message on the standard error, and exits with a non-zero return code.
4536 The message is also written to the panic log. &*Note*&: Only simple syntax
4537 errors can be detected at this time. The values of any expanded options are
4538 not checked until the expansion happens, even when the expansion does not
4539 actually alter the string.
4540
4541 The name of the configuration file is compiled into the binary for security
4542 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4543 most configurations, this specifies a single file. However, it is permitted to
4544 give a colon-separated list of file names, in which case Exim uses the first
4545 existing file in the list.
4546
4547 .new
4548 .cindex "EXIM_USER"
4549 .cindex "EXIM_GROUP"
4550 .cindex "CONFIGURE_OWNER"
4551 .cindex "CONFIGURE_GROUP"
4552 .cindex "configuration file" "ownership"
4553 .cindex "ownership" "configuration file"
4554 The run time configuration file must be owned by root or by the user that is
4555 specified at compile time by the CONFIGURE_OWNER option (if set). The
4556 configuration file must not be world-writeable, or group-writeable unless its
4557 group is the root group or the one specified at compile time by the
4558 CONFIGURE_GROUP option.
4559
4560 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4561 to root, anybody who is able to edit the run time configuration file has an
4562 easy way to run commands as root. If you specify a user or group in the
4563 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4564 who are members of that group will trivially be able to obtain root privileges.
4565
4566 Up to Exim version 4.72, the run time configuration file was also permitted to
4567 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4568 since it offered a simple privilege escalation for any attacker who managed to
4569 compromise the Exim user account.
4570 .wen
4571 A default configuration file, which will work correctly in simple situations,
4572 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4573 defines just one file name, the installation process copies the default
4574 configuration to a new file of that name if it did not previously exist. If
4575 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4576 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4577 configuration.
4578
4579
4580
4581 .new
4582 .section "Using a different configuration file" "SECID40"
4583 .cindex "configuration file" "alternate"
4584 A one-off alternate configuration can be specified by the &%-C%& command line
4585 option, which may specify a single file or a list of files. However, when
4586 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4587 unless the argument for &%-C%& is identical to the built-in value from
4588 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4589 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4590 is useful mainly for checking the syntax of configuration files before
4591 installing them. No owner or group checks are done on a configuration file
4592 specified by &%-C%&, if root privilege has been dropped.
4593
4594 Even the Exim user is not trusted to specify an arbitrary configuration file
4595 with the &%-C%& option to be used with root privileges, unless that file is
4596 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4597 testing a configuration using &%-C%& right through message reception and
4598 delivery, even if the caller is root. The reception works, but by that time,
4599 Exim is running as the Exim user, so when it re-execs to regain privilege for
4600 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4601 can test reception and delivery using two separate commands (one to put a
4602 message on the queue, using &%-odq%&, and another to do the delivery, using
4603 &%-M%&).
4604 .wen
4605 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4606 prefix string with which any file named in a &%-C%& command line option must
4607 start. In addition, the file name must not contain the sequence &"&`/../`&"&.
4608 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any file
4609 name can be used with &%-C%&.
4610
4611 One-off changes to a configuration can be specified by the &%-D%& command line
4612 option, which defines and overrides values for macros used inside the
4613 configuration file. However, like &%-C%&, the use of this option by a
4614 non-privileged user causes Exim to discard its root privilege.
4615 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4616 completely disabled, and its use causes an immediate error exit.
4617
4618 .new
4619 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4620 to declare certain macro names trusted, such that root privilege will not
4621 necessarily be discarded.
4622 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4623 considered safe and, if &%-D%& only supplies macros from this list, and the
4624 values are acceptable, then Exim will not give up root privilege if the caller
4625 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4626 transition mechanism and is expected to be removed in the future.  Acceptable
4627 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4628 .wen
4629
4630 Some sites may wish to use the same Exim binary on different machines that
4631 share a file system, but to use different configuration files on each machine.
4632 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4633 looks for a file whose name is the configuration file name followed by a dot
4634 and the machine's node name, as obtained from the &[uname()]& function. If this
4635 file does not exist, the standard name is tried. This processing occurs for
4636 each file name in the list given by CONFIGURE_FILE or &%-C%&.
4637
4638 In some esoteric situations different versions of Exim may be run under
4639 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4640 help with this. See the comments in &_src/EDITME_& for details.
4641
4642
4643
4644 .section "Configuration file format" "SECTconffilfor"
4645 .cindex "configuration file" "format of"
4646 .cindex "format" "configuration file"
4647 Exim's configuration file is divided into a number of different parts. General
4648 option settings must always appear at the start of the file. The other parts
4649 are all optional, and may appear in any order. Each part other than the first
4650 is introduced by the word &"begin"& followed by the name of the part. The
4651 optional parts are:
4652
4653 .ilist
4654 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4655 &<<CHAPACL>>&).
4656 .next
4657 .cindex "AUTH" "configuration"
4658 &'authenticators'&: Configuration settings for the authenticator drivers. These
4659 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4660 .next
4661 &'routers'&: Configuration settings for the router drivers. Routers process
4662 addresses and determine how the message is to be delivered (see chapters
4663 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4664 .next
4665 &'transports'&: Configuration settings for the transport drivers. Transports
4666 define mechanisms for copying messages to destinations (see chapters
4667 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4668 .next
4669 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4670 If there is no retry section, or if it is empty (that is, no retry rules are
4671 defined), Exim will not retry deliveries. In this situation, temporary errors
4672 are treated the same as permanent errors. Retry rules are discussed in chapter
4673 &<<CHAPretry>>&.
4674 .next
4675 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4676 when new addresses are generated during delivery. Rewriting is discussed in
4677 chapter &<<CHAPrewrite>>&.
4678 .next
4679 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4680 want to use this feature, you must set
4681 .code
4682 LOCAL_SCAN_HAS_OPTIONS=yes
4683 .endd
4684 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4685 facility are given in chapter &<<CHAPlocalscan>>&.
4686 .endlist
4687
4688 .cindex "configuration file" "leading white space in"
4689 .cindex "configuration file" "trailing white space in"
4690 .cindex "white space" "in configuration file"
4691 Leading and trailing white space in configuration lines is always ignored.
4692
4693 Blank lines in the file, and lines starting with a # character (ignoring
4694 leading white space) are treated as comments and are ignored. &*Note*&: A
4695 # character other than at the beginning of a line is not treated specially,
4696 and does not introduce a comment.
4697
4698 Any non-comment line can be continued by ending it with a backslash. Note that
4699 the general rule for white space means that trailing white space after the
4700 backslash and leading white space at the start of continuation
4701 lines is ignored. Comment lines beginning with # (but not empty lines) may
4702 appear in the middle of a sequence of continuation lines.
4703
4704 A convenient way to create a configuration file is to start from the
4705 default, which is supplied in &_src/configure.default_&, and add, delete, or
4706 change settings as required.
4707
4708 The ACLs, retry rules, and rewriting rules have their own syntax which is
4709 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4710 respectively. The other parts of the configuration file have some syntactic
4711 items in common, and these are described below, from section &<<SECTcos>>&
4712 onwards. Before that, the inclusion, macro, and conditional facilities are
4713 described.
4714
4715
4716
4717 .section "File inclusions in the configuration file" "SECID41"
4718 .cindex "inclusions in configuration file"
4719 .cindex "configuration file" "including other files"
4720 .cindex "&`.include`& in configuration file"
4721 .cindex "&`.include_if_exists`& in configuration file"
4722 You can include other files inside Exim's run time configuration file by
4723 using this syntax:
4724 .display
4725 &`.include`& <&'file name'&>
4726 &`.include_if_exists`& <&'file name'&>
4727 .endd
4728 on a line by itself. Double quotes round the file name are optional. If you use
4729 the first form, a configuration error occurs if the file does not exist; the
4730 second form does nothing for non-existent files. In all cases, an absolute file
4731 name is required.
4732
4733 Includes may be nested to any depth, but remember that Exim reads its
4734 configuration file often, so it is a good idea to keep them to a minimum.
4735 If you change the contents of an included file, you must HUP the daemon,
4736 because an included file is read only when the configuration itself is read.
4737
4738 The processing of inclusions happens early, at a physical line level, so, like
4739 comment lines, an inclusion can be used in the middle of an option setting,
4740 for example:
4741 .code
4742 hosts_lookup = a.b.c \
4743                .include /some/file
4744 .endd
4745 Include processing happens after macro processing (see below). Its effect is to
4746 process the lines of the included file as if they occurred inline where the
4747 inclusion appears.
4748
4749
4750
4751 .section "Macros in the configuration file" "SECTmacrodefs"
4752 .cindex "macro" "description of"
4753 .cindex "configuration file" "macros"
4754 If a line in the main part of the configuration (that is, before the first
4755 &"begin"& line) begins with an upper case letter, it is taken as a macro
4756 definition, and must be of the form
4757 .display
4758 <&'name'&> = <&'rest of line'&>
4759 .endd
4760 The name must consist of letters, digits, and underscores, and need not all be
4761 in upper case, though that is recommended. The rest of the line, including any
4762 continuations, is the replacement text, and has leading and trailing white
4763 space removed. Quotes are not removed. The replacement text can never end with
4764 a backslash character, but this doesn't seem to be a serious limitation.
4765
4766 Macros may also be defined between router, transport, authenticator, or ACL
4767 definitions. They may not, however, be defined within an individual driver or
4768 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
4769
4770 .section "Macro substitution" "SECID42"
4771 Once a macro is defined, all subsequent lines in the file (and any included
4772 files) are scanned for the macro name; if there are several macros, the line is
4773 scanned for each in turn, in the order in which the macros are defined. The
4774 replacement text is not re-scanned for the current macro, though it is scanned
4775 for subsequently defined macros. For this reason, a macro name may not contain
4776 the name of a previously defined macro as a substring. You could, for example,
4777 define
4778 .display
4779 &`ABCD_XYZ = `&<&'something'&>
4780 &`ABCD = `&<&'something else'&>
4781 .endd
4782 but putting the definitions in the opposite order would provoke a configuration
4783 error. Macro expansion is applied to individual physical lines from the file,
4784 before checking for line continuation or file inclusion (see above). If a line
4785 consists solely of a macro name, and the expansion of the macro is empty, the
4786 line is ignored. A macro at the start of a line may turn the line into a
4787 comment line or a &`.include`& line.
4788
4789
4790 .section "Redefining macros" "SECID43"
4791 Once defined, the value of a macro can be redefined later in the configuration
4792 (or in an included file). Redefinition is specified by using &'=='& instead of
4793 &'='&. For example:
4794 .code
4795 MAC =  initial value
4796 ...
4797 MAC == updated value
4798 .endd
4799 Redefinition does not alter the order in which the macros are applied to the
4800 subsequent lines of the configuration file. It is still the same order in which
4801 the macros were originally defined. All that changes is the macro's value.
4802 Redefinition makes it possible to accumulate values. For example:
4803 .code
4804 MAC =  initial value
4805 ...
4806 MAC == MAC and something added
4807 .endd
4808 This can be helpful in situations where the configuration file is built
4809 from a number of other files.
4810
4811 .section "Overriding macro values" "SECID44"
4812 The values set for macros in the configuration file can be overridden by the
4813 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
4814 used, unless called by root or the Exim user. A definition on the command line
4815 using the &%-D%& option causes all definitions and redefinitions within the
4816 file to be ignored.
4817
4818
4819
4820 .section "Example of macro usage" "SECID45"
4821 As an example of macro usage, consider a configuration where aliases are looked
4822 up in a MySQL database. It helps to keep the file less cluttered if long
4823 strings such as SQL statements are defined separately as macros, for example:
4824 .code
4825 ALIAS_QUERY = select mailbox from user where \
4826               login='${quote_mysql:$local_part}';
4827 .endd
4828 This can then be used in a &(redirect)& router setting like this:
4829 .code
4830 data = ${lookup mysql{ALIAS_QUERY}}
4831 .endd
4832 In earlier versions of Exim macros were sometimes used for domain, host, or
4833 address lists. In Exim 4 these are handled better by named lists &-- see
4834 section &<<SECTnamedlists>>&.
4835
4836
4837 .section "Conditional skips in the configuration file" "SECID46"
4838 .cindex "configuration file" "conditional skips"
4839 .cindex "&`.ifdef`&"
4840 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
4841 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
4842 portions of the configuration file. The processing happens whenever the file is
4843 read (that is, when an Exim binary starts to run).
4844
4845 The implementation is very simple. Instances of the first four directives must
4846 be followed by text that includes the names of one or macros. The condition
4847 that is tested is whether or not any macro substitution has taken place in the
4848 line. Thus:
4849 .code
4850 .ifdef AAA
4851 message_size_limit = 50M
4852 .else
4853 message_size_limit = 100M
4854 .endif
4855 .endd
4856 sets a message size limit of 50M if the macro &`AAA`& is defined, and 100M
4857 otherwise. If there is more than one macro named on the line, the condition
4858 is true if any of them are defined. That is, it is an &"or"& condition. To
4859 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
4860
4861 Although you can use a macro expansion to generate one of these directives,
4862 it is not very useful, because the condition &"there was a macro substitution
4863 in this line"& will always be true.
4864
4865 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
4866 to clarify complicated nestings.
4867
4868
4869
4870 .section "Common option syntax" "SECTcos"
4871 .cindex "common option syntax"
4872 .cindex "syntax of common options"
4873 .cindex "configuration file" "common option syntax"
4874 For the main set of options, driver options, and &[local_scan()]& options,
4875 each setting is on a line by itself, and starts with a name consisting of
4876 lower-case letters and underscores. Many options require a data value, and in
4877 these cases the name must be followed by an equals sign (with optional white
4878 space) and then the value. For example:
4879 .code
4880 qualify_domain = mydomain.example.com
4881 .endd
4882 .cindex "hiding configuration option values"
4883 .cindex "configuration options" "hiding value of"
4884 .cindex "options" "hiding value of"
4885 Some option settings may contain sensitive data, for example, passwords for
4886 accessing databases. To stop non-admin users from using the &%-bP%& command
4887 line option to read these values, you can precede the option settings with the
4888 word &"hide"&. For example:
4889 .code
4890 hide mysql_servers = localhost/users/admin/secret-password
4891 .endd
4892 For non-admin users, such options are displayed like this:
4893 .code
4894 mysql_servers = <value not displayable>
4895 .endd
4896 If &"hide"& is used on a driver option, it hides the value of that option on
4897 all instances of the same driver.
4898
4899 The following sections describe the syntax used for the different data types
4900 that are found in option settings.
4901
4902
4903 .section "Boolean options" "SECID47"
4904 .cindex "format" "boolean"
4905 .cindex "boolean configuration values"
4906 .oindex "&%no_%&&'xxx'&"
4907 .oindex "&%not_%&&'xxx'&"
4908 Options whose type is given as boolean are on/off switches. There are two
4909 different ways of specifying such options: with and without a data value. If
4910 the option name is specified on its own without data, the switch is turned on;
4911 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
4912 boolean options may be followed by an equals sign and one of the words
4913 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
4914 the following two settings have exactly the same effect:
4915 .code
4916 queue_only
4917 queue_only = true
4918 .endd
4919 The following two lines also have the same (opposite) effect:
4920 .code
4921 no_queue_only
4922 queue_only = false
4923 .endd
4924 You can use whichever syntax you prefer.
4925
4926
4927
4928
4929 .section "Integer values" "SECID48"
4930 .cindex "integer configuration values"
4931 .cindex "format" "integer"
4932 If an option's type is given as &"integer"&, the value can be given in decimal,
4933 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
4934 number is assumed. Otherwise, it is treated as an octal number unless it starts
4935 with the characters &"0x"&, in which case the remainder is interpreted as a
4936 hexadecimal number.
4937
4938 If an integer value is followed by the letter K, it is multiplied by 1024; if
4939 it is followed by the letter M, it is multiplied by 1024x1024. When the values
4940 of integer option settings are output, values which are an exact multiple of
4941 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
4942 and M. The printing style is independent of the actual input format that was
4943 used.
4944
4945
4946 .section "Octal integer values" "SECID49"
4947 .cindex "integer format"
4948 .cindex "format" "octal integer"
4949 If an option's type is given as &"octal integer"&, its value is always
4950 interpreted as an octal number, whether or not it starts with the digit zero.
4951 Such options are always output in octal.
4952
4953
4954 .section "Fixed point numbers" "SECID50"
4955 .cindex "fixed point configuration values"
4956 .cindex "format" "fixed point"
4957 If an option's type is given as &"fixed-point"&, its value must be a decimal
4958 integer, optionally followed by a decimal point and up to three further digits.
4959
4960
4961
4962 .section "Time intervals" "SECTtimeformat"
4963 .cindex "time interval" "specifying in configuration"
4964 .cindex "format" "time interval"
4965 A time interval is specified as a sequence of numbers, each followed by one of
4966 the following letters, with no intervening white space:
4967
4968 .table2 30pt
4969 .irow &%s%& seconds
4970 .irow &%m%& minutes
4971 .irow &%h%& hours
4972 .irow &%d%& days
4973 .irow &%w%& weeks
4974 .endtable
4975
4976 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
4977 intervals are output in the same format. Exim does not restrict the values; it
4978 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
4979
4980
4981
4982 .section "String values" "SECTstrings"
4983 .cindex "string" "format of configuration values"
4984 .cindex "format" "string"
4985 If an option's type is specified as &"string"&, the value can be specified with
4986 or without double-quotes. If it does not start with a double-quote, the value
4987 consists of the remainder of the line plus any continuation lines, starting at
4988 the first character after any leading white space, with trailing white space
4989 removed, and with no interpretation of the characters in the string. Because
4990 Exim removes comment lines (those beginning with #) at an early stage, they can
4991 appear in the middle of a multi-line string. The following two settings are
4992 therefore equivalent:
4993 .code
4994 trusted_users = uucp:mail
4995 trusted_users = uucp:\
4996                 # This comment line is ignored
4997                 mail
4998 .endd
4999 .cindex "string" "quoted"
5000 .cindex "escape characters in quoted strings"
5001 If a string does start with a double-quote, it must end with a closing
5002 double-quote, and any backslash characters other than those used for line
5003 continuation are interpreted as escape characters, as follows:
5004
5005 .table2 100pt
5006 .irow &`\\`&                     "single backslash"
5007 .irow &`\n`&                     "newline"
5008 .irow &`\r`&                     "carriage return"
5009 .irow &`\t`&                     "tab"
5010 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5011 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5012                                    character"
5013 .endtable
5014
5015 If a backslash is followed by some other character, including a double-quote
5016 character, that character replaces the pair.
5017
5018 Quoting is necessary only if you want to make use of the backslash escapes to
5019 insert special characters, or if you need to specify a value with leading or
5020 trailing spaces. These cases are rare, so quoting is almost never needed in
5021 current versions of Exim. In versions of Exim before 3.14, quoting was required
5022 in order to continue lines, so you may come across older configuration files
5023 and examples that apparently quote unnecessarily.
5024
5025
5026 .section "Expanded strings" "SECID51"
5027 .cindex "expansion" "definition of"
5028 Some strings in the configuration file are subjected to &'string expansion'&,
5029 by which means various parts of the string may be changed according to the
5030 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5031 is as just described; in particular, the handling of backslashes in quoted
5032 strings is done as part of the input process, before expansion takes place.
5033 However, backslash is also an escape character for the expander, so any
5034 backslashes that are required for that reason must be doubled if they are
5035 within a quoted configuration string.
5036
5037
5038 .section "User and group names" "SECID52"
5039 .cindex "user name" "format of"
5040 .cindex "format" "user name"
5041 .cindex "groups" "name format"
5042 .cindex "format" "group name"
5043 User and group names are specified as strings, using the syntax described
5044 above, but the strings are interpreted specially. A user or group name must
5045 either consist entirely of digits, or be a name that can be looked up using the
5046 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5047
5048
5049 .section "List construction" "SECTlistconstruct"
5050 .cindex "list" "syntax of in configuration"
5051 .cindex "format" "list item in configuration"
5052 .cindex "string" "list, definition of"
5053 The data for some configuration options is a list of items, with colon as the
5054 default separator. Many of these options are shown with type &"string list"& in
5055 the descriptions later in this document. Others are listed as &"domain list"&,
5056 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5057 are all the same; however, those other than &"string list"& are subject to
5058 particular kinds of interpretation, as described in chapter
5059 &<<CHAPdomhosaddlists>>&.
5060
5061 In all these cases, the entire list is treated as a single string as far as the
5062 input syntax is concerned. The &%trusted_users%& setting in section
5063 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5064 in a list, it must be entered as two colons. Leading and trailing white space
5065 on each item in a list is ignored. This makes it possible to include items that
5066 start with a colon, and in particular, certain forms of IPv6 address. For
5067 example, the list
5068 .code
5069 local_interfaces = 127.0.0.1 : ::::1
5070 .endd
5071 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5072
5073 &*Note*&: Although leading and trailing white space is ignored in individual
5074 list items, it is not ignored when parsing the list. The space after the first
5075 colon in the example above is necessary. If it were not there, the list would
5076 be interpreted as the two items 127.0.0.1:: and 1.
5077
5078 .section "Changing list separators" "SECID53"
5079 .cindex "list separator" "changing"
5080 .cindex "IPv6" "addresses in lists"
5081 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5082 introduced to allow the separator character to be changed. If a list begins
5083 with a left angle bracket, followed by any punctuation character, that
5084 character is used instead of colon as the list separator. For example, the list
5085 above can be rewritten to use a semicolon separator like this:
5086 .code
5087 local_interfaces = <; 127.0.0.1 ; ::1
5088 .endd
5089 This facility applies to all lists, with the exception of the list in
5090 &%log_file_path%&. It is recommended that the use of non-colon separators be
5091 confined to circumstances where they really are needed.
5092
5093 .cindex "list separator" "newline as"
5094 .cindex "newline" "as list separator"
5095 It is also possible to use newline and other control characters (those with
5096 code values less than 32, plus DEL) as separators in lists. Such separators
5097 must be provided literally at the time the list is processed. For options that
5098 are string-expanded, you can write the separator using a normal escape
5099 sequence. This will be processed by the expander before the string is
5100 interpreted as a list. For example, if a newline-separated list of domains is
5101 generated by a lookup, you can process it directly by a line such as this:
5102 .code
5103 domains = <\n ${lookup mysql{.....}}
5104 .endd
5105 This avoids having to change the list separator in such data. You are unlikely
5106 to want to use a control character as a separator in an option that is not
5107 expanded, because the value is literal text. However, it can be done by giving
5108 the value in quotes. For example:
5109 .code
5110 local_interfaces = "<\n 127.0.0.1 \n ::1"
5111 .endd
5112 Unlike printing character separators, which can be included in list items by
5113 doubling, it is not possible to include a control character as data when it is
5114 set as the separator. Two such characters in succession are interpreted as
5115 enclosing an empty list item.
5116
5117
5118
5119 .section "Empty items in lists" "SECTempitelis"
5120 .cindex "list" "empty item in"
5121 An empty item at the end of a list is always ignored. In other words, trailing
5122 separator characters are ignored. Thus, the list in
5123 .code
5124 senders = user@domain :
5125 .endd
5126 contains only a single item. If you want to include an empty string as one item
5127 in a list, it must not be the last item. For example, this list contains three
5128 items, the second of which is empty:
5129 .code
5130 senders = user1@domain : : user2@domain
5131 .endd
5132 &*Note*&: There must be white space between the two colons, as otherwise they
5133 are interpreted as representing a single colon data character (and the list
5134 would then contain just one item). If you want to specify a list that contains
5135 just one, empty item, you can do it as in this example:
5136 .code
5137 senders = :
5138 .endd
5139 In this case, the first item is empty, and the second is discarded because it
5140 is at the end of the list.
5141
5142
5143
5144
5145 .section "Format of driver configurations" "SECTfordricon"
5146 .cindex "drivers" "configuration format"
5147 There are separate parts in the configuration for defining routers, transports,
5148 and authenticators. In each part, you are defining a number of driver
5149 instances, each with its own set of options. Each driver instance is defined by
5150 a sequence of lines like this:
5151 .display
5152 <&'instance name'&>:
5153   <&'option'&>
5154   ...
5155   <&'option'&>
5156 .endd
5157 In the following example, the instance name is &(localuser)&, and it is
5158 followed by three options settings:
5159 .code
5160 localuser:
5161   driver = accept
5162   check_local_user
5163   transport = local_delivery
5164 .endd
5165 For each driver instance, you specify which Exim code module it uses &-- by the
5166 setting of the &%driver%& option &-- and (optionally) some configuration
5167 settings. For example, in the case of transports, if you want a transport to
5168 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5169 a local file you would use the &(appendfile)& driver. Each of the drivers is
5170 described in detail in its own separate chapter later in this manual.
5171
5172 You can have several routers, transports, or authenticators that are based on
5173 the same underlying driver (each must have a different instance name).
5174
5175 The order in which routers are defined is important, because addresses are
5176 passed to individual routers one by one, in order. The order in which
5177 transports are defined does not matter at all. The order in which
5178 authenticators are defined is used only when Exim, as a client, is searching
5179 them to find one that matches an authentication mechanism offered by the
5180 server.
5181
5182 .cindex "generic options"
5183 .cindex "options" "generic &-- definition of"
5184 Within a driver instance definition, there are two kinds of option: &'generic'&
5185 and &'private'&. The generic options are those that apply to all drivers of the
5186 same type (that is, all routers, all transports or all authenticators). The
5187 &%driver%& option is a generic option that must appear in every definition.
5188 .cindex "private options"
5189 The private options are special for each driver, and none need appear, because
5190 they all have default values.
5191
5192 The options may appear in any order, except that the &%driver%& option must
5193 precede any private options, since these depend on the particular driver. For
5194 this reason, it is recommended that &%driver%& always be the first option.
5195
5196 Driver instance names, which are used for reference in log entries and
5197 elsewhere, can be any sequence of letters, digits, and underscores (starting
5198 with a letter) and must be unique among drivers of the same type. A router and
5199 a transport (for example) can each have the same name, but no two router
5200 instances can have the same name. The name of a driver instance should not be
5201 confused with the name of the underlying driver module. For example, the
5202 configuration lines:
5203 .code
5204 remote_smtp:
5205   driver = smtp
5206 .endd
5207 create an instance of the &(smtp)& transport driver whose name is
5208 &(remote_smtp)&. The same driver code can be used more than once, with
5209 different instance names and different option settings each time. A second
5210 instance of the &(smtp)& transport, with different options, might be defined
5211 thus:
5212 .code
5213 special_smtp:
5214   driver = smtp
5215   port = 1234
5216   command_timeout = 10s
5217 .endd
5218 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5219 these transport instances from routers, and these names would appear in log
5220 lines.
5221
5222 Comment lines may be present in the middle of driver specifications. The full
5223 list of option settings for any particular driver instance, including all the
5224 defaulted values, can be extracted by making use of the &%-bP%& command line
5225 option.
5226
5227
5228
5229
5230
5231
5232 . ////////////////////////////////////////////////////////////////////////////
5233 . ////////////////////////////////////////////////////////////////////////////
5234
5235 .chapter "The default configuration file" "CHAPdefconfil"
5236 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5237 .cindex "default" "configuration file &""walk through""&"
5238 The default configuration file supplied with Exim as &_src/configure.default_&
5239 is sufficient for a host with simple mail requirements. As an introduction to
5240 the way Exim is configured, this chapter &"walks through"& the default
5241 configuration, giving brief explanations of the settings. Detailed descriptions
5242 of the options are given in subsequent chapters. The default configuration file
5243 itself contains extensive comments about ways you might want to modify the
5244 initial settings. However, note that there are many options that are not
5245 mentioned at all in the default configuration.
5246
5247
5248
5249 .section "Main configuration settings" "SECTdefconfmain"
5250 The main (global) configuration option settings must always come first in the
5251 file. The first thing you'll see in the file, after some initial comments, is
5252 the line
5253 .code
5254 # primary_hostname =
5255 .endd
5256 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5257 to know the official, fully qualified name of your host, and this is where you
5258 can specify it. However, in most cases you do not need to set this option. When
5259 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5260
5261 The first three non-comment configuration lines are as follows:
5262 .code
5263 domainlist local_domains = @
5264 domainlist relay_to_domains =
5265 hostlist   relay_from_hosts = 127.0.0.1
5266 .endd
5267 These are not, in fact, option settings. They are definitions of two named
5268 domain lists and one named host list. Exim allows you to give names to lists of
5269 domains, hosts, and email addresses, in order to make it easier to manage the
5270 configuration file (see section &<<SECTnamedlists>>&).
5271
5272 The first line defines a domain list called &'local_domains'&; this is used
5273 later in the configuration to identify domains that are to be delivered
5274 on the local host.
5275
5276 .cindex "@ in a domain list"
5277 There is just one item in this list, the string &"@"&. This is a special form
5278 of entry which means &"the name of the local host"&. Thus, if the local host is
5279 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5280 be delivered locally. Because the local host's name is referenced indirectly,
5281 the same configuration file can be used on different hosts.
5282
5283 The second line defines a domain list called &'relay_to_domains'&, but the
5284 list itself is empty. Later in the configuration we will come to the part that
5285 controls mail relaying through the local host; it allows relaying to any
5286 domains in this list. By default, therefore, no relaying on the basis of a mail
5287 domain is permitted.
5288
5289 The third line defines a host list called &'relay_from_hosts'&. This list is
5290 used later in the configuration to permit relaying from any host or IP address
5291 that matches the list. The default contains just the IP address of the IPv4
5292 loopback interface, which means that processes on the local host are able to
5293 submit mail for relaying by sending it over TCP/IP to that interface. No other
5294 hosts are permitted to submit messages for relaying.
5295
5296 Just to be sure there's no misunderstanding: at this point in the configuration
5297 we aren't actually setting up any controls. We are just defining some domains
5298 and hosts that will be used in the controls that are specified later.
5299
5300 The next two configuration lines are genuine option settings:
5301 .code
5302 acl_smtp_rcpt = acl_check_rcpt
5303 acl_smtp_data = acl_check_data
5304 .endd
5305 These options specify &'Access Control Lists'& (ACLs) that are to be used
5306 during an incoming SMTP session for every recipient of a message (every RCPT
5307 command), and after the contents of the message have been received,
5308 respectively. The names of the lists are &'acl_check_rcpt'& and
5309 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5310 section of the configuration. The RCPT ACL controls which recipients are
5311 accepted for an incoming message &-- if a configuration does not provide an ACL
5312 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5313 contents of a message to be checked.
5314
5315 Two commented-out option settings are next:
5316 .code
5317 # av_scanner = clamd:/tmp/clamd
5318 # spamd_address = 127.0.0.1 783
5319 .endd
5320 These are example settings that can be used when Exim is compiled with the
5321 content-scanning extension. The first specifies the interface to the virus
5322 scanner, and the second specifies the interface to SpamAssassin. Further
5323 details are given in chapter &<<CHAPexiscan>>&.
5324
5325 Three more commented-out option settings follow:
5326 .code
5327 # tls_advertise_hosts = *
5328 # tls_certificate = /etc/ssl/exim.crt
5329 # tls_privatekey = /etc/ssl/exim.pem
5330 .endd
5331 These are example settings that can be used when Exim is compiled with
5332 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5333 first one specifies the list of clients that are allowed to use TLS when
5334 connecting to this server; in this case the wildcard means all clients. The
5335 other options specify where Exim should find its TLS certificate and private
5336 key, which together prove the server's identity to any clients that connect.
5337 More details are given in chapter &<<CHAPTLS>>&.
5338
5339 Another two commented-out option settings follow:
5340 .code
5341 # daemon_smtp_ports = 25 : 465 : 587
5342 # tls_on_connect_ports = 465
5343 .endd
5344 .cindex "port" "465 and 587"
5345 .cindex "port" "for message submission"
5346 .cindex "message" "submission, ports for"
5347 .cindex "ssmtp protocol"
5348 .cindex "smtps protocol"
5349 .cindex "SMTP" "ssmtp protocol"
5350 .cindex "SMTP" "smtps protocol"
5351 These options provide better support for roaming users who wish to use this
5352 server for message submission. They are not much use unless you have turned on
5353 TLS (as described in the previous paragraph) and authentication (about which
5354 more in section &<<SECTdefconfauth>>&). The usual SMTP port 25 is often blocked
5355 on end-user networks, so RFC 4409 specifies that message submission should use
5356 port 587 instead. However some software (notably Microsoft Outlook) cannot be
5357 configured to use port 587 correctly, so these settings also enable the
5358 non-standard &"smtps"& (aka &"ssmtp"&) port 465 (see section
5359 &<<SECTsupobssmt>>&).
5360
5361 Two more commented-out options settings follow:
5362 .code
5363 # qualify_domain =
5364 # qualify_recipient =
5365 .endd
5366 The first of these specifies a domain that Exim uses when it constructs a
5367 complete email address from a local login name. This is often needed when Exim
5368 receives a message from a local process. If you do not set &%qualify_domain%&,
5369 the value of &%primary_hostname%& is used. If you set both of these options,
5370 you can have different qualification domains for sender and recipient
5371 addresses. If you set only the first one, its value is used in both cases.
5372
5373 .cindex "domain literal" "recognizing format"
5374 The following line must be uncommented if you want Exim to recognize
5375 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5376 (an IP address within square brackets) instead of a named domain.
5377 .code
5378 # allow_domain_literals
5379 .endd
5380 The RFCs still require this form, but many people think that in the modern
5381 Internet it makes little sense to permit mail to be sent to specific hosts by
5382 quoting their IP addresses. This ancient format has been used by people who
5383 try to abuse hosts by using them for unwanted relaying. However, some
5384 people believe there are circumstances (for example, messages addressed to
5385 &'postmaster'&) where domain literals are still useful.
5386
5387 The next configuration line is a kind of trigger guard:
5388 .code
5389 never_users = root
5390 .endd
5391 It specifies that no delivery must ever be run as the root user. The normal
5392 convention is to set up &'root'& as an alias for the system administrator. This
5393 setting is a guard against slips in the configuration.
5394 The list of users specified by &%never_users%& is not, however, the complete
5395 list; the build-time configuration in &_Local/Makefile_& has an option called
5396 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5397 contents of &%never_users%& are added to this list. By default
5398 FIXED_NEVER_USERS also specifies root.
5399
5400 When a remote host connects to Exim in order to send mail, the only information
5401 Exim has about the host's identity is its IP address. The next configuration
5402 line,
5403 .code
5404 host_lookup = *
5405 .endd
5406 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5407 in order to get a host name. This improves the quality of the logging
5408 information, but if you feel it is too expensive, you can remove it entirely,
5409 or restrict the lookup to hosts on &"nearby"& networks.
5410 Note that it is not always possible to find a host name from an IP address,
5411 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5412 unreachable.
5413
5414 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5415 1413 (hence their names):
5416 .code
5417 rfc1413_hosts = *
5418 rfc1413_query_timeout = 5s
5419 .endd
5420 These settings cause Exim to make ident callbacks for all incoming SMTP calls.
5421 You can limit the hosts to which these calls are made, or change the timeout
5422 that is used. If you set the timeout to zero, all ident calls are disabled.
5423 Although they are cheap and can provide useful information for tracing problem
5424 messages, some hosts and firewalls have problems with ident calls. This can
5425 result in a timeout instead of an immediate refused connection, leading to
5426 delays on starting up an incoming SMTP session.
5427
5428 When Exim receives messages over SMTP connections, it expects all addresses to
5429 be fully qualified with a domain, as required by the SMTP definition. However,
5430 if you are running a server to which simple clients submit messages, you may
5431 find that they send unqualified addresses. The two commented-out options:
5432 .code
5433 # sender_unqualified_hosts =
5434 # recipient_unqualified_hosts =
5435 .endd
5436 show how you can specify hosts that are permitted to send unqualified sender
5437 and recipient addresses, respectively.
5438
5439 The &%percent_hack_domains%& option is also commented out:
5440 .code
5441 # percent_hack_domains =
5442 .endd
5443 It provides a list of domains for which the &"percent hack"& is to operate.
5444 This is an almost obsolete form of explicit email routing. If you do not know
5445 anything about it, you can safely ignore this topic.
5446
5447 The last two settings in the main part of the default configuration are
5448 concerned with messages that have been &"frozen"& on Exim's queue. When a
5449 message is frozen, Exim no longer continues to try to deliver it. Freezing
5450 occurs when a bounce message encounters a permanent failure because the sender
5451 address of the original message that caused the bounce is invalid, so the
5452 bounce cannot be delivered. This is probably the most common case, but there
5453 are also other conditions that cause freezing, and frozen messages are not
5454 always bounce messages.
5455 .code
5456 ignore_bounce_errors_after = 2d
5457 timeout_frozen_after = 7d
5458 .endd
5459 The first of these options specifies that failing bounce messages are to be
5460 discarded after 2 days on the queue. The second specifies that any frozen
5461 message (whether a bounce message or not) is to be timed out (and discarded)
5462 after a week. In this configuration, the first setting ensures that no failing
5463 bounce message ever lasts a week.
5464
5465
5466
5467 .section "ACL configuration" "SECID54"
5468 .cindex "default" "ACLs"
5469 .cindex "&ACL;" "default configuration"
5470 In the default configuration, the ACL section follows the main configuration.
5471 It starts with the line
5472 .code
5473 begin acl
5474 .endd
5475 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5476 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5477 and &%acl_smtp_data%& above.
5478
5479 .cindex "RCPT" "ACL for"
5480 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5481 RCPT command specifies one of the message's recipients. The ACL statements
5482 are considered in order, until the recipient address is either accepted or
5483 rejected. The RCPT command is then accepted or rejected, according to the
5484 result of the ACL processing.
5485 .code
5486 acl_check_rcpt:
5487 .endd
5488 This line, consisting of a name terminated by a colon, marks the start of the
5489 ACL, and names it.
5490 .code
5491 accept  hosts = :
5492 .endd
5493 This ACL statement accepts the recipient if the sending host matches the list.
5494 But what does that strange list mean? It doesn't actually contain any host
5495 names or IP addresses. The presence of the colon puts an empty item in the
5496 list; Exim matches this only if the incoming message did not come from a remote
5497 host, because in that case, the remote hostname is empty. The colon is
5498 important. Without it, the list itself is empty, and can never match anything.
5499
5500 What this statement is doing is to accept unconditionally all recipients in
5501 messages that are submitted by SMTP from local processes using the standard
5502 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5503 manner.
5504 .code
5505 deny    message       = Restricted characters in address
5506         domains       = +local_domains
5507         local_parts   = ^[.] : ^.*[@%!/|]
5508
5509 deny    message       = Restricted characters in address
5510         domains       = !+local_domains
5511         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5512 .endd
5513 These statements are concerned with local parts that contain any of the
5514 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5515 Although these characters are entirely legal in local parts (in the case of
5516 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5517 in Internet mail addresses.
5518
5519 The first three have in the past been associated with explicitly routed
5520 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5521 option). Addresses containing these characters are regularly tried by spammers
5522 in an attempt to bypass relaying restrictions, and also by open relay testing
5523 programs. Unless you really need them it is safest to reject these characters
5524 at this early stage. This configuration is heavy-handed in rejecting these
5525 characters for all messages it accepts from remote hosts. This is a deliberate
5526 policy of being as safe as possible.
5527
5528 The first rule above is stricter, and is applied to messages that are addressed
5529 to one of the local domains handled by this host. This is implemented by the
5530 first condition, which restricts it to domains that are listed in the
5531 &'local_domains'& domain list. The &"+"& character is used to indicate a
5532 reference to a named list. In this configuration, there is just one domain in
5533 &'local_domains'&, but in general there may be many.
5534
5535 The second condition on the first statement uses two regular expressions to
5536 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5537 or &"|"&. If you have local accounts that include these characters, you will
5538 have to modify this rule.
5539
5540 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5541 allows them because they have been encountered in practice. (Consider the
5542 common convention of local parts constructed as
5543 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5544 the author of Exim, who has no second initial.) However, a local part starting
5545 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5546 file name (for example, for a mailing list). This is also true for local parts
5547 that contain slashes. A pipe symbol can also be troublesome if the local part
5548 is incorporated unthinkingly into a shell command line.
5549
5550 The second rule above applies to all other domains, and is less strict. This
5551 allows your own users to send outgoing messages to sites that use slashes
5552 and vertical bars in their local parts. It blocks local parts that begin
5553 with a dot, slash, or vertical bar, but allows these characters within the
5554 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5555 and &"!"& is blocked, as before. The motivation here is to prevent your users
5556 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5557 .code
5558 accept  local_parts   = postmaster
5559         domains       = +local_domains
5560 .endd
5561 This statement, which has two conditions, accepts an incoming address if the
5562 local part is &'postmaster'& and the domain is one of those listed in the
5563 &'local_domains'& domain list. The &"+"& character is used to indicate a
5564 reference to a named list. In this configuration, there is just one domain in
5565 &'local_domains'&, but in general there may be many.
5566
5567 The presence of this statement means that mail to postmaster is never blocked
5568 by any of the subsequent tests. This can be helpful while sorting out problems
5569 in cases where the subsequent tests are incorrectly denying access.
5570 .code
5571 require verify        = sender
5572 .endd
5573 This statement requires the sender address to be verified before any subsequent
5574 ACL statement can be used. If verification fails, the incoming recipient
5575 address is refused. Verification consists of trying to route the address, to
5576 see if a bounce message could be delivered to it. In the case of remote
5577 addresses, basic verification checks only the domain, but &'callouts'& can be
5578 used for more verification if required. Section &<<SECTaddressverification>>&
5579 discusses the details of address verification.
5580 .code
5581 accept  hosts         = +relay_from_hosts
5582         control       = submission
5583 .endd
5584 This statement accepts the address if the message is coming from one of the
5585 hosts that are defined as being allowed to relay through this host. Recipient
5586 verification is omitted here, because in many cases the clients are dumb MUAs
5587 that do not cope well with SMTP error responses. For the same reason, the
5588 second line specifies &"submission mode"& for messages that are accepted. This
5589 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5590 messages that are deficient in some way, for example, because they lack a
5591 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5592 probably add recipient verification here, and disable submission mode.
5593 .code
5594 accept  authenticated = *
5595         control       = submission
5596 .endd
5597 This statement accepts the address if the client host has authenticated itself.
5598 Submission mode is again specified, on the grounds that such messages are most
5599 likely to come from MUAs. The default configuration does not define any
5600 authenticators, though it does include some nearly complete commented-out
5601 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5602 fact authenticate until you complete the authenticator definitions.
5603 .code
5604 require message = relay not permitted
5605         domains = +local_domains : +relay_domains
5606 .endd
5607 This statement rejects the address if its domain is neither a local domain nor
5608 one of the domains for which this host is a relay.
5609 .code
5610 require verify = recipient
5611 .endd
5612 This statement requires the recipient address to be verified; if verification
5613 fails, the address is rejected.
5614 .code
5615 # deny    message     = rejected because $sender_host_address \
5616 #                       is in a black list at $dnslist_domain\n\
5617 #                       $dnslist_text
5618 #         dnslists    = black.list.example
5619 #
5620 # warn    dnslists    = black.list.example
5621 #         add_header  = X-Warning: $sender_host_address is in \
5622 #                       a black list at $dnslist_domain
5623 #         log_message = found in $dnslist_domain
5624 .endd
5625 These commented-out lines are examples of how you could configure Exim to check
5626 sending hosts against a DNS black list. The first statement rejects messages
5627 from blacklisted hosts, whereas the second just inserts a warning header
5628 line.
5629 .code
5630 # require verify = csa
5631 .endd
5632 This commented-out line is an example of how you could turn on client SMTP
5633 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5634 records.
5635 .code
5636 accept
5637 .endd
5638 The final statement in the first ACL unconditionally accepts any recipient
5639 address that has successfully passed all the previous tests.
5640 .code
5641 acl_check_data:
5642 .endd
5643 This line marks the start of the second ACL, and names it. Most of the contents
5644 of this ACL are commented out:
5645 .code
5646 # deny    malware   = *
5647 #         message   = This message contains a virus \
5648 #                     ($malware_name).
5649 .endd
5650 These lines are examples of how to arrange for messages to be scanned for
5651 viruses when Exim has been compiled with the content-scanning extension, and a
5652 suitable virus scanner is installed. If the message is found to contain a
5653 virus, it is rejected with the given custom error message.
5654 .code
5655 # warn    spam      = nobody
5656 #         message   = X-Spam_score: $spam_score\n\
5657 #                     X-Spam_score_int: $spam_score_int\n\
5658 #                     X-Spam_bar: $spam_bar\n\
5659 #                     X-Spam_report: $spam_report
5660 .endd
5661 These lines are an example of how to arrange for messages to be scanned by
5662 SpamAssassin when Exim has been compiled with the content-scanning extension,
5663 and SpamAssassin has been installed. The SpamAssassin check is run with
5664 &`nobody`& as its user parameter, and the results are added to the message as a
5665 series of extra header line. In this case, the message is not rejected,
5666 whatever the spam score.
5667 .code
5668 accept
5669 .endd
5670 This final line in the DATA ACL accepts the message unconditionally.
5671
5672
5673 .section "Router configuration" "SECID55"
5674 .cindex "default" "routers"
5675 .cindex "routers" "default"
5676 The router configuration comes next in the default configuration, introduced
5677 by the line
5678 .code
5679 begin routers
5680 .endd
5681 Routers are the modules in Exim that make decisions about where to send
5682 messages. An address is passed to each router in turn, until it is either
5683 accepted, or failed. This means that the order in which you define the routers
5684 matters. Each router is fully described in its own chapter later in this
5685 manual. Here we give only brief overviews.
5686 .code
5687 # domain_literal:
5688 #   driver = ipliteral
5689 #   domains = !+local_domains
5690 #   transport = remote_smtp
5691 .endd
5692 .cindex "domain literal" "default router"
5693 This router is commented out because the majority of sites do not want to
5694 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
5695 you uncomment this router, you also need to uncomment the setting of
5696 &%allow_domain_literals%& in the main part of the configuration.
5697 .code
5698 dnslookup:
5699   driver = dnslookup
5700   domains = ! +local_domains
5701   transport = remote_smtp
5702   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
5703   no_more
5704 .endd
5705 The first uncommented router handles addresses that do not involve any local
5706 domains. This is specified by the line
5707 .code
5708 domains = ! +local_domains
5709 .endd
5710 The &%domains%& option lists the domains to which this router applies, but the
5711 exclamation mark is a negation sign, so the router is used only for domains
5712 that are not in the domain list called &'local_domains'& (which was defined at
5713 the start of the configuration). The plus sign before &'local_domains'&
5714 indicates that it is referring to a named list. Addresses in other domains are
5715 passed on to the following routers.
5716
5717 The name of the router driver is &(dnslookup)&,
5718 and is specified by the &%driver%& option. Do not be confused by the fact that
5719 the name of this router instance is the same as the name of the driver. The
5720 instance name is arbitrary, but the name set in the &%driver%& option must be
5721 one of the driver modules that is in the Exim binary.
5722
5723 The &(dnslookup)& router routes addresses by looking up their domains in the
5724 DNS in order to obtain a list of hosts to which the address is routed. If the
5725 router succeeds, the address is queued for the &(remote_smtp)& transport, as
5726 specified by the &%transport%& option. If the router does not find the domain
5727 in the DNS, no further routers are tried because of the &%no_more%& setting, so
5728 the address fails and is bounced.
5729
5730 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
5731 be entirely ignored. This option is present because a number of cases have been
5732 encountered where MX records in the DNS point to host names
5733 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
5734 Completely ignoring these IP addresses causes Exim to fail to route the
5735 email address, so it bounces. Otherwise, Exim would log a routing problem, and
5736 continue to try to deliver the message periodically until the address timed
5737 out.
5738 .code
5739 system_aliases:
5740   driver = redirect
5741   allow_fail
5742   allow_defer
5743   data = ${lookup{$local_part}lsearch{/etc/aliases}}
5744 # user = exim
5745   file_transport = address_file
5746   pipe_transport = address_pipe
5747 .endd
5748 Control reaches this and subsequent routers only for addresses in the local
5749 domains. This router checks to see whether the local part is defined as an
5750 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
5751 data that it looks up from that file. If no data is found for the local part,
5752 the value of the &%data%& option is empty, causing the address to be passed to
5753 the next router.
5754
5755 &_/etc/aliases_& is a conventional name for the system aliases file that is
5756 often used. That is why it is referenced by from the default configuration
5757 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
5758 &_Local/Makefile_& before building Exim.
5759 .code
5760 userforward:
5761   driver = redirect
5762   check_local_user
5763 # local_part_suffix = +* : -*
5764 # local_part_suffix_optional
5765   file = $home/.forward
5766 # allow_filter
5767   no_verify
5768   no_expn
5769   check_ancestor
5770   file_transport = address_file
5771   pipe_transport = address_pipe
5772   reply_transport = address_reply
5773 .endd
5774 This is the most complicated router in the default configuration. It is another
5775 redirection router, but this time it is looking for forwarding data set up by
5776 individual users. The &%check_local_user%& setting specifies a check that the
5777 local part of the address is the login name of a local user. If it is not, the
5778 router is skipped. The two commented options that follow &%check_local_user%&,
5779 namely:
5780 .code
5781 # local_part_suffix = +* : -*
5782 # local_part_suffix_optional
5783 .endd
5784 .vindex "&$local_part_suffix$&"
5785 show how you can specify the recognition of local part suffixes. If the first
5786 is uncommented, a suffix beginning with either a plus or a minus sign, followed
5787 by any sequence of characters, is removed from the local part and placed in the
5788 variable &$local_part_suffix$&. The second suffix option specifies that the
5789 presence of a suffix in the local part is optional. When a suffix is present,
5790 the check for a local login uses the local part with the suffix removed.
5791
5792 When a local user account is found, the file called &_.forward_& in the user's
5793 home directory is consulted. If it does not exist, or is empty, the router
5794 declines. Otherwise, the contents of &_.forward_& are interpreted as
5795 redirection data (see chapter &<<CHAPredirect>>& for more details).
5796
5797 .cindex "Sieve filter" "enabling in default router"
5798 Traditional &_.forward_& files contain just a list of addresses, pipes, or
5799 files. Exim supports this by default. However, if &%allow_filter%& is set (it
5800 is commented out by default), the contents of the file are interpreted as a set
5801 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
5802 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
5803 separate document entitled &'Exim's interfaces to mail filtering'&.
5804
5805 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
5806 verifying addresses, or when running as a consequence of an SMTP EXPN command.
5807 There are two reasons for doing this:
5808
5809 .olist
5810 Whether or not a local user has a &_.forward_& file is not really relevant when
5811 checking an address for validity; it makes sense not to waste resources doing
5812 unnecessary work.
5813 .next
5814 More importantly, when Exim is verifying addresses or handling an EXPN
5815 command during an SMTP session, it is running as the Exim user, not as root.
5816 The group is the Exim group, and no additional groups are set up.
5817 It may therefore not be possible for Exim to read users' &_.forward_& files at
5818 this time.
5819 .endlist
5820
5821 The setting of &%check_ancestor%& prevents the router from generating a new
5822 address that is the same as any previous address that was redirected. (This
5823 works round a problem concerning a bad interaction between aliasing and
5824 forwarding &-- see section &<<SECTredlocmai>>&).
5825
5826 The final three option settings specify the transports that are to be used when
5827 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
5828 auto-reply, respectively. For example, if a &_.forward_& file contains
5829 .code
5830 a.nother@elsewhere.example, /home/spqr/archive
5831 .endd
5832 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
5833 transport.
5834 .code
5835 localuser:
5836   driver = accept
5837   check_local_user
5838 # local_part_suffix = +* : -*
5839 # local_part_suffix_optional
5840   transport = local_delivery
5841 .endd
5842 The final router sets up delivery into local mailboxes, provided that the local
5843 part is the name of a local login, by accepting the address and assigning it to
5844 the &(local_delivery)& transport. Otherwise, we have reached the end of the
5845 routers, so the address is bounced. The commented suffix settings fulfil the
5846 same purpose as they do for the &(userforward)& router.
5847
5848
5849 .section "Transport configuration" "SECID56"
5850 .cindex "default" "transports"
5851 .cindex "transports" "default"
5852 Transports define mechanisms for actually delivering messages. They operate
5853 only when referenced from routers, so the order in which they are defined does
5854 not matter. The transports section of the configuration starts with
5855 .code
5856 begin transports
5857 .endd
5858 One remote transport and four local transports are defined.
5859 .code
5860 remote_smtp:
5861   driver = smtp
5862 .endd
5863 This transport is used for delivering messages over SMTP connections. All its
5864 options are defaulted. The list of remote hosts comes from the router.
5865 .code
5866 local_delivery:
5867   driver = appendfile
5868   file = /var/mail/$local_part
5869   delivery_date_add
5870   envelope_to_add
5871   return_path_add
5872 # group = mail
5873 # mode = 0660
5874 .endd
5875 This &(appendfile)& transport is used for local delivery to user mailboxes in
5876 traditional BSD mailbox format. By default it runs under the uid and gid of the
5877 local user, which requires the sticky bit to be set on the &_/var/mail_&
5878 directory. Some systems use the alternative approach of running mail deliveries
5879 under a particular group instead of using the sticky bit. The commented options
5880 show how this can be done.
5881
5882 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
5883 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
5884 similarly-named options above.
5885 .code
5886 address_pipe:
5887   driver = pipe
5888   return_output
5889 .endd
5890 This transport is used for handling deliveries to pipes that are generated by
5891 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
5892 option specifies that any output generated by the pipe is to be returned to the
5893 sender.
5894 .code
5895 address_file:
5896   driver = appendfile
5897   delivery_date_add
5898   envelope_to_add
5899   return_path_add
5900 .endd
5901 This transport is used for handling deliveries to files that are generated by
5902 redirection. The name of the file is not specified in this instance of
5903 &(appendfile)&, because it comes from the &(redirect)& router.
5904 .code
5905 address_reply:
5906   driver = autoreply
5907 .endd
5908 This transport is used for handling automatic replies generated by users'
5909 filter files.
5910
5911
5912
5913 .section "Default retry rule" "SECID57"
5914 .cindex "retry" "default rule"
5915 .cindex "default" "retry rule"
5916 The retry section of the configuration file contains rules which affect the way
5917 Exim retries deliveries that cannot be completed at the first attempt. It is
5918 introduced by the line
5919 .code
5920 begin retry
5921 .endd
5922 In the default configuration, there is just one rule, which applies to all
5923 errors:
5924 .code
5925 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
5926 .endd
5927 This causes any temporarily failing address to be retried every 15 minutes for
5928 2 hours, then at intervals starting at one hour and increasing by a factor of
5929 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
5930 is not delivered after 4 days of temporary failure, it is bounced.
5931
5932 If the retry section is removed from the configuration, or is empty (that is,
5933 if no retry rules are defined), Exim will not retry deliveries. This turns
5934 temporary errors into permanent errors.
5935
5936
5937 .section "Rewriting configuration" "SECID58"
5938 The rewriting section of the configuration, introduced by
5939 .code
5940 begin rewrite
5941 .endd
5942 contains rules for rewriting addresses in messages as they arrive. There are no
5943 rewriting rules in the default configuration file.
5944
5945
5946
5947 .section "Authenticators configuration" "SECTdefconfauth"
5948 .cindex "AUTH" "configuration"
5949 The authenticators section of the configuration, introduced by
5950 .code
5951 begin authenticators
5952 .endd
5953 defines mechanisms for the use of the SMTP AUTH command. The default
5954 configuration file contains two commented-out example authenticators
5955 which support plaintext username/password authentication using the
5956 standard PLAIN mechanism and the traditional but non-standard LOGIN
5957 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
5958 to support most MUA software.
5959
5960 The example PLAIN authenticator looks like this:
5961 .code
5962 #PLAIN:
5963 #  driver                  = plaintext
5964 #  server_set_id           = $auth2
5965 #  server_prompts          = :
5966 #  server_condition        = Authentication is not yet configured
5967 #  server_advertise_condition = ${if def:tls_cipher }
5968 .endd
5969 And the example LOGIN authenticator looks like this:
5970 .code
5971 #LOGIN:
5972 #  driver                  = plaintext
5973 #  server_set_id           = $auth1
5974 #  server_prompts          = <| Username: | Password:
5975 #  server_condition        = Authentication is not yet configured
5976 #  server_advertise_condition = ${if def:tls_cipher }
5977 .endd
5978
5979 The &%server_set_id%& option makes Exim remember the authenticated username
5980 in &$authenticated_id$&, which can be used later in ACLs or routers. The
5981 &%server_prompts%& option configures the &(plaintext)& authenticator so
5982 that it implements the details of the specific authentication mechanism,
5983 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
5984 when Exim offers authentication to clients; in the examples, this is only
5985 when TLS or SSL has been started, so to enable the authenticators you also
5986 need to add support for TLS as described in &<<SECTdefconfmain>>&.
5987
5988 The &%server_condition%& setting defines how to verify that the username and
5989 password are correct. In the examples it just produces an error message.
5990 To make the authenticators work, you can use a string expansion
5991 expression like one of the examples in &<<CHAPplaintext>>&.
5992
5993 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
5994 usercode and password are in different positions.  &<<CHAPplaintext>>&
5995 covers both.
5996
5997 .ecindex IIDconfiwal
5998
5999
6000
6001 . ////////////////////////////////////////////////////////////////////////////
6002 . ////////////////////////////////////////////////////////////////////////////
6003
6004 .chapter "Regular expressions" "CHAPregexp"
6005
6006 .cindex "regular expressions" "library"
6007 .cindex "PCRE"
6008 Exim supports the use of regular expressions in many of its options. It
6009 uses the PCRE regular expression library; this provides regular expression
6010 matching that is compatible with Perl 5. The syntax and semantics of
6011 regular expressions is discussed in many Perl reference books, and also in
6012 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6013 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6014
6015 The documentation for the syntax and semantics of the regular expressions that
6016 are supported by PCRE is included in the PCRE distribution, and no further
6017 description is included here. The PCRE functions are called from Exim using
6018 the default option settings (that is, with no PCRE options set), except that
6019 the PCRE_CASELESS option is set when the matching is required to be
6020 case-insensitive.
6021
6022 In most cases, when a regular expression is required in an Exim configuration,
6023 it has to start with a circumflex, in order to distinguish it from plain text
6024 or an &"ends with"& wildcard. In this example of a configuration setting, the
6025 second item in the colon-separated list is a regular expression.
6026 .code
6027 domains = a.b.c : ^\\d{3} : *.y.z : ...
6028 .endd
6029 The doubling of the backslash is required because of string expansion that
6030 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6031 of this issue, and a way of avoiding the need for doubling backslashes. The
6032 regular expression that is eventually used in this example contains just one
6033 backslash. The circumflex is included in the regular expression, and has the
6034 normal effect of &"anchoring"& it to the start of the string that is being
6035 matched.
6036
6037 There are, however, two cases where a circumflex is not required for the
6038 recognition of a regular expression: these are the &%match%& condition in a
6039 string expansion, and the &%matches%& condition in an Exim filter file. In
6040 these cases, the relevant string is always treated as a regular expression; if
6041 it does not start with a circumflex, the expression is not anchored, and can
6042 match anywhere in the subject string.
6043
6044 In all cases, if you want a regular expression to match at the end of a string,
6045 you must code the $ metacharacter to indicate this. For example:
6046 .code
6047 domains = ^\\d{3}\\.example
6048 .endd
6049 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6050 You need to use:
6051 .code
6052 domains = ^\\d{3}\\.example\$
6053 .endd
6054 if you want &'example'& to be the top-level domain. The backslash before the
6055 $ is needed because string expansion also interprets dollar characters.
6056
6057
6058
6059 . ////////////////////////////////////////////////////////////////////////////
6060 . ////////////////////////////////////////////////////////////////////////////
6061
6062 .chapter "File and database lookups" "CHAPfdlookup"
6063 .scindex IIDfidalo1 "file" "lookups"
6064 .scindex IIDfidalo2 "database" "lookups"
6065 .cindex "lookup" "description of"
6066 Exim can be configured to look up data in files or databases as it processes
6067 messages. Two different kinds of syntax are used:
6068
6069 .olist
6070 A string that is to be expanded may contain explicit lookup requests. These
6071 cause parts of the string to be replaced by data that is obtained from the
6072 lookup. Lookups of this type are conditional expansion items. Different results
6073 can be defined for the cases of lookup success and failure. See chapter
6074 &<<CHAPexpand>>&, where string expansions are described in detail.
6075 .next
6076 Lists of domains, hosts, and email addresses can contain lookup requests as a
6077 way of avoiding excessively long linear lists. In this case, the data that is
6078 returned by the lookup is often (but not always) discarded; whether the lookup
6079 succeeds or fails is what really counts. These kinds of list are described in
6080 chapter &<<CHAPdomhosaddlists>>&.
6081 .endlist
6082
6083 String expansions, lists, and lookups interact with each other in such a way
6084 that there is no order in which to describe any one of them that does not
6085 involve references to the others. Each of these three chapters makes more sense
6086 if you have read the other two first. If you are reading this for the first
6087 time, be aware that some of it will make a lot more sense after you have read
6088 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6089
6090 .section "Examples of different lookup syntax" "SECID60"
6091 It is easy to confuse the two different kinds of lookup, especially as the
6092 lists that may contain the second kind are always expanded before being
6093 processed as lists. Therefore, they may also contain lookups of the first kind.
6094 Be careful to distinguish between the following two examples:
6095 .code
6096 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6097 domains = lsearch;/some/file
6098 .endd
6099 The first uses a string expansion, the result of which must be a domain list.
6100 No strings have been specified for a successful or a failing lookup; the
6101 defaults in this case are the looked-up data and an empty string, respectively.
6102 The expansion takes place before the string is processed as a list, and the
6103 file that is searched could contain lines like this:
6104 .code
6105 192.168.3.4: domain1:domain2:...
6106 192.168.1.9: domain3:domain4:...
6107 .endd
6108 When the lookup succeeds, the result of the expansion is a list of domains (and
6109 possibly other types of item that are allowed in domain lists).
6110
6111 In the second example, the lookup is a single item in a domain list. It causes
6112 Exim to use a lookup to see if the domain that is being processed can be found
6113 in the file. The file could contains lines like this:
6114 .code
6115 domain1:
6116 domain2:
6117 .endd
6118 Any data that follows the keys is not relevant when checking that the domain
6119 matches the list item.
6120
6121 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6122 Consider a file containing lines like this:
6123 .code
6124 192.168.5.6: lsearch;/another/file
6125 .endd
6126 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6127 first &%domains%& setting above generates the second setting, which therefore
6128 causes a second lookup to occur.
6129
6130 The rest of this chapter describes the different lookup types that are
6131 available. Any of them can be used in any part of the configuration where a
6132 lookup is permitted.
6133
6134
6135 .section "Lookup types" "SECID61"
6136 .cindex "lookup" "types of"
6137 .cindex "single-key lookup" "definition of"
6138 Two different types of data lookup are implemented:
6139
6140 .ilist
6141 The &'single-key'& type requires the specification of a file in which to look,
6142 and a single key to search for. The key must be a non-empty string for the
6143 lookup to succeed. The lookup type determines how the file is searched.
6144 .next
6145 .cindex "query-style lookup" "definition of"
6146 The &'query-style'& type accepts a generalized database query. No particular
6147 key value is assumed by Exim for query-style lookups. You can use whichever
6148 Exim variables you need to construct the database query.
6149 .endlist
6150
6151 The code for each lookup type is in a separate source file that is included in
6152 the binary of Exim only if the corresponding compile-time option is set. The
6153 default settings in &_src/EDITME_& are:
6154 .code
6155 LOOKUP_DBM=yes
6156 LOOKUP_LSEARCH=yes
6157 .endd
6158 which means that only linear searching and DBM lookups are included by default.
6159 For some types of lookup (e.g. SQL databases), you need to install appropriate
6160 libraries and header files before building Exim.
6161
6162
6163
6164
6165 .section "Single-key lookup types" "SECTsinglekeylookups"
6166 .cindex "lookup" "single-key types"
6167 .cindex "single-key lookup" "list of types"
6168 The following single-key lookup types are implemented:
6169
6170 .ilist
6171 .cindex "cdb" "description of"
6172 .cindex "lookup" "cdb"
6173 .cindex "binary zero" "in lookup key"
6174 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6175 string without a terminating binary zero. The cdb format is designed for
6176 indexed files that are read frequently and never updated, except by total
6177 re-creation. As such, it is particularly suitable for large files containing
6178 aliases or other indexed data referenced by an MTA. Information about cdb can
6179 be found in several places:
6180 .display
6181 &url(http://www.pobox.com/~djb/cdb.html)
6182 &url(ftp://ftp.corpit.ru/pub/tinycdb/)
6183 &url(http://packages.debian.org/stable/utils/freecdb.html)
6184 .endd
6185 A cdb distribution is not needed in order to build Exim with cdb support,
6186 because the code for reading cdb files is included directly in Exim itself.
6187 However, no means of building or testing cdb files is provided with Exim, so
6188 you need to obtain a cdb distribution in order to do this.
6189 .next
6190 .cindex "DBM" "lookup type"
6191 .cindex "lookup" "dbm"
6192 .cindex "binary zero" "in lookup key"
6193 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6194 DBM file by looking up the record with the given key. A terminating binary
6195 zero is included in the key that is passed to the DBM library. See section
6196 &<<SECTdb>>& for a discussion of DBM libraries.
6197
6198 .cindex "Berkeley DB library" "file format"
6199 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6200 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6201 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6202 the DB_UNKNOWN option. This enables it to handle any of the types of database
6203 that the library supports, and can be useful for accessing DBM files created by
6204 other applications. (For earlier DB versions, DB_HASH is always used.)
6205 .next
6206 .cindex "lookup" "dbmnz"
6207 .cindex "lookup" "dbm &-- terminating zero"
6208 .cindex "binary zero" "in lookup key"
6209 .cindex "Courier"
6210 .cindex "&_/etc/userdbshadow.dat_&"
6211 .cindex "dmbnz lookup type"
6212 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6213 is not included in the key that is passed to the DBM library. You may need this
6214 if you want to look up data in files that are created by or shared with some
6215 other application that does not use terminating zeros. For example, you need to
6216 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6217 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6218 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6219 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6220 .next
6221 .cindex "lookup" "dsearch"
6222 .cindex "dsearch lookup type"
6223 &(dsearch)&: The given file must be a directory; this is searched for an entry
6224 whose name is the key by calling the &[lstat()]& function. The key may not
6225 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6226 the lookup is the name of the entry, which may be a file, directory,
6227 symbolic link, or any other kind of directory entry. An example of how this
6228 lookup can be used to support virtual domains is given in section
6229 &<<SECTvirtualdomains>>&.
6230 .next
6231 .cindex "lookup" "iplsearch"
6232 .cindex "iplsearch lookup type"
6233 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6234 terminated by a colon or white space or the end of the line. The keys in the
6235 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6236 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6237 being interpreted as a key terminator. For example:
6238 .code
6239 1.2.3.4:           data for 1.2.3.4
6240 192.168.0.0/16:    data for 192.168.0.0/16
6241 "abcd::cdab":      data for abcd::cdab
6242 "abcd:abcd::/32"   data for abcd:abcd::/32
6243 .endd
6244 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6245 file is searched linearly, using the CIDR masks where present, until a matching
6246 key is found. The first key that matches is used; there is no attempt to find a
6247 &"best"& match. Apart from the way the keys are matched, the processing for
6248 &(iplsearch)& is the same as for &(lsearch)&.
6249
6250 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6251 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6252 lookup types support only literal keys.
6253
6254 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6255 the implicit key is the host's IP address rather than its name (see section
6256 &<<SECThoslispatsikey>>&).
6257 .next
6258 .cindex "linear search"
6259 .cindex "lookup" "lsearch"
6260 .cindex "lsearch lookup type"
6261 .cindex "case sensitivity" "in lsearch lookup"
6262 &(lsearch)&: The given file is a text file that is searched linearly for a
6263 line beginning with the search key, terminated by a colon or white space or the
6264 end of the line. The search is case-insensitive; that is, upper and lower case
6265 letters are treated as the same. The first occurrence of the key that is found
6266 in the file is used.
6267
6268 White space between the key and the colon is permitted. The remainder of the
6269 line, with leading and trailing white space removed, is the data. This can be
6270 continued onto subsequent lines by starting them with any amount of white
6271 space, but only a single space character is included in the data at such a
6272 junction. If the data begins with a colon, the key must be terminated by a
6273 colon, for example:
6274 .code
6275 baduser:  :fail:
6276 .endd
6277 Empty lines and lines beginning with # are ignored, even if they occur in the
6278 middle of an item. This is the traditional textual format of alias files. Note
6279 that the keys in an &(lsearch)& file are literal strings. There is no
6280 wildcarding of any kind.
6281
6282 .cindex "lookup" "lsearch &-- colons in keys"
6283 .cindex "white space" "in lsearch key"
6284 In most &(lsearch)& files, keys are not required to contain colons or #
6285 characters, or white space. However, if you need this feature, it is available.
6286 If a key begins with a doublequote character, it is terminated only by a
6287 matching quote (or end of line), and the normal escaping rules apply to its
6288 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6289 quoted keys (exactly as for unquoted keys). There is no special handling of
6290 quotes for the data part of an &(lsearch)& line.
6291
6292 .next
6293 .cindex "NIS lookup type"
6294 .cindex "lookup" "NIS"
6295 .cindex "binary zero" "in lookup key"
6296 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6297 the given key, without a terminating binary zero. There is a variant called
6298 &(nis0)& which does include the terminating binary zero in the key. This is
6299 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6300 aliases; the full map names must be used.
6301
6302 .next
6303 .cindex "wildlsearch lookup type"
6304 .cindex "lookup" "wildlsearch"
6305 .cindex "nwildlsearch lookup type"
6306 .cindex "lookup" "nwildlsearch"
6307 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6308 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6309 the file may be wildcarded. The difference between these two lookup types is
6310 that for &(wildlsearch)&, each key in the file is string-expanded before being
6311 used, whereas for &(nwildlsearch)&, no expansion takes place.
6312
6313 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6314 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6315 file that are regular expressions can be made case-sensitive by the use of
6316 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6317
6318 . ==== As this is a nested list, any displays it contains must be indented
6319 . ==== as otherwise they are too far to the left.
6320
6321 .olist
6322 The string may begin with an asterisk to mean &"ends with"&. For example:
6323 .code
6324     *.a.b.c       data for anything.a.b.c
6325     *fish         data for anythingfish
6326 .endd
6327 .next
6328 The string may begin with a circumflex to indicate a regular expression. For
6329 example, for &(wildlsearch)&:
6330 .code
6331     ^\N\d+\.a\.b\N    data for <digits>.a.b
6332 .endd
6333 Note the use of &`\N`& to disable expansion of the contents of the regular
6334 expression. If you are using &(nwildlsearch)&, where the keys are not
6335 string-expanded, the equivalent entry is:
6336 .code
6337     ^\d+\.a\.b        data for <digits>.a.b
6338 .endd
6339 The case-insensitive flag is set at the start of compiling the regular
6340 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6341 For example, to make the entire pattern case-sensitive:
6342 .code
6343     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6344 .endd
6345
6346 If the regular expression contains white space or colon characters, you must
6347 either quote it (see &(lsearch)& above), or represent these characters in other
6348 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6349 colon. This may be easier than quoting, because if you quote, you have to
6350 escape all the backslashes inside the quotes.
6351
6352 &*Note*&: It is not possible to capture substrings in a regular expression
6353 match for later use, because the results of all lookups are cached. If a lookup
6354 is repeated, the result is taken from the cache, and no actual pattern matching
6355 takes place. The values of all the numeric variables are unset after a
6356 &((n)wildlsearch)& match.
6357
6358 .next
6359 Although I cannot see it being of much use, the general matching function that
6360 is used to implement &((n)wildlsearch)& means that the string may begin with a
6361 lookup name terminated by a semicolon, and followed by lookup data. For
6362 example:
6363 .code
6364     cdb;/some/file  data for keys that match the file
6365 .endd
6366 The data that is obtained from the nested lookup is discarded.
6367 .endlist olist
6368
6369 Keys that do not match any of these patterns are interpreted literally. The
6370 continuation rules for the data are the same as for &(lsearch)&, and keys may
6371 be followed by optional colons.
6372
6373 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6374 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6375 lookup types support only literal keys.
6376 .endlist ilist
6377
6378
6379 .section "Query-style lookup types" "SECID62"
6380 .cindex "lookup" "query-style types"
6381 .cindex "query-style lookup" "list of types"
6382 The supported query-style lookup types are listed below. Further details about
6383 many of them are given in later sections.
6384
6385 .ilist
6386 .cindex "DNS" "as a lookup type"
6387 .cindex "lookup" "DNS"
6388 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6389 are given in the supplied query. The resulting data is the contents of the
6390 records. See section &<<SECTdnsdb>>&.
6391 .next
6392 .cindex "InterBase lookup type"
6393 .cindex "lookup" "InterBase"
6394 &(ibase)&: This does a lookup in an InterBase database.
6395 .next
6396 .cindex "LDAP" "lookup type"
6397 .cindex "lookup" "LDAP"
6398 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6399 returns attributes from a single entry. There is a variant called &(ldapm)&
6400 that permits values from multiple entries to be returned. A third variant
6401 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6402 any attribute values. See section &<<SECTldap>>&.
6403 .next
6404 .cindex "MySQL" "lookup type"
6405 .cindex "lookup" "MySQL"
6406 &(mysql)&: The format of the query is an SQL statement that is passed to a
6407 MySQL database. See section &<<SECTsql>>&.
6408 .next
6409 .cindex "NIS+ lookup type"
6410 .cindex "lookup" "NIS+"
6411 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6412 the field to be returned. See section &<<SECTnisplus>>&.
6413 .next
6414 .cindex "Oracle" "lookup type"
6415 .cindex "lookup" "Oracle"
6416 &(oracle)&: The format of the query is an SQL statement that is passed to an
6417 Oracle database. See section &<<SECTsql>>&.
6418 .next
6419 .cindex "lookup" "passwd"
6420 .cindex "passwd lookup type"
6421 .cindex "&_/etc/passwd_&"
6422 &(passwd)& is a query-style lookup with queries that are just user names. The
6423 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6424 success, the result string is the same as you would get from an &(lsearch)&
6425 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6426 password value. For example:
6427 .code
6428 *:42:42:King Rat:/home/kr:/bin/bash
6429 .endd
6430 .next
6431 .cindex "PostgreSQL lookup type"
6432 .cindex "lookup" "PostgreSQL"
6433 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6434 PostgreSQL database. See section &<<SECTsql>>&.
6435
6436 .next
6437 .cindex "sqlite lookup type"
6438 .cindex "lookup" "sqlite"
6439 &(sqlite)&: The format of the query is a file name followed by an SQL statement
6440 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6441
6442 .next
6443 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6444 not likely to be useful in normal operation.
6445 .next
6446 .cindex "whoson lookup type"
6447 .cindex "lookup" "whoson"
6448 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6449 allows a server to check whether a particular (dynamically allocated) IP
6450 address is currently allocated to a known (trusted) user and, optionally, to
6451 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6452 at one time for &"POP before SMTP"& authentication, but that approach has been
6453 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6454 &"POP before SMTP"& checking using ACL statements such as
6455 .code
6456 require condition = \
6457   ${lookup whoson {$sender_host_address}{yes}{no}}
6458 .endd
6459 The query consists of a single IP address. The value returned is the name of
6460 the authenticated user, which is stored in the variable &$value$&. However, in
6461 this example, the data in &$value$& is not used; the result of the lookup is
6462 one of the fixed strings &"yes"& or &"no"&.
6463 .endlist
6464
6465
6466
6467 .section "Temporary errors in lookups" "SECID63"
6468 .cindex "lookup" "temporary error in"
6469 Lookup functions can return temporary error codes if the lookup cannot be
6470 completed. For example, an SQL or LDAP database might be unavailable. For this
6471 reason, it is not advisable to use a lookup that might do this for critical
6472 options such as a list of local domains.
6473
6474 When a lookup cannot be completed in a router or transport, delivery
6475 of the message (to the relevant address) is deferred, as for any other
6476 temporary error. In other circumstances Exim may assume the lookup has failed,
6477 or may give up altogether.
6478
6479
6480
6481 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
6482 .cindex "wildcard lookups"
6483 .cindex "lookup" "default values"
6484 .cindex "lookup" "wildcard"
6485 .cindex "lookup" "* added to type"
6486 .cindex "default" "in single-key lookups"
6487 In this context, a &"default value"& is a value specified by the administrator
6488 that is to be used if a lookup fails.
6489
6490 &*Note:*& This section applies only to single-key lookups. For query-style
6491 lookups, the facilities of the query language must be used. An attempt to
6492 specify a default for a query-style lookup provokes an error.
6493
6494 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
6495 and the initial lookup fails, the key &"*"& is looked up in the file to
6496 provide a default value. See also the section on partial matching below.
6497
6498 .cindex "*@ with single-key lookup"
6499 .cindex "lookup" "*@ added to type"
6500 .cindex "alias file" "per-domain default"
6501 Alternatively, if &"*@"& is added to a single-key lookup type (for example
6502 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
6503 character, a second lookup is done with everything before the last @ replaced
6504 by *. This makes it possible to provide per-domain defaults in alias files
6505 that include the domains in the keys. If the second lookup fails (or doesn't
6506 take place because there is no @ in the key), &"*"& is looked up.
6507 For example, a &(redirect)& router might contain:
6508 .code
6509 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
6510 .endd
6511 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
6512 looks up these keys, in this order:
6513 .code
6514 jane@eyre.example
6515 *@eyre.example
6516 *
6517 .endd
6518 The data is taken from whichever key it finds first. &*Note*&: In an
6519 &(lsearch)& file, this does not mean the first of these keys in the file. A
6520 complete scan is done for each key, and only if it is not found at all does
6521 Exim move on to try the next key.
6522
6523
6524
6525 .section "Partial matching in single-key lookups" "SECTpartiallookup"
6526 .cindex "partial matching"
6527 .cindex "wildcard lookups"
6528 .cindex "lookup" "partial matching"
6529 .cindex "lookup" "wildcard"
6530 .cindex "asterisk" "in search type"
6531 The normal operation of a single-key lookup is to search the file for an exact
6532 match with the given key. However, in a number of situations where domains are
6533 being looked up, it is useful to be able to do partial matching. In this case,
6534 information in the file that has a key starting with &"*."& is matched by any
6535 domain that ends with the components that follow the full stop. For example, if
6536 a key in a DBM file is
6537 .code
6538 *.dates.fict.example
6539 .endd
6540 then when partial matching is enabled this is matched by (amongst others)
6541 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
6542 by &'dates.fict.example'&, if that does not appear as a separate key in the
6543 file.
6544
6545 &*Note*&: Partial matching is not available for query-style lookups. It is
6546 also not available for any lookup items in address lists (see section
6547 &<<SECTaddresslist>>&).
6548
6549 Partial matching is implemented by doing a series of separate lookups using
6550 keys constructed by modifying the original subject key. This means that it can
6551 be used with any of the single-key lookup types, provided that
6552 partial matching keys
6553 beginning with a special prefix (default &"*."&) are included in the data file.
6554 Keys in the file that do not begin with the prefix are matched only by
6555 unmodified subject keys when partial matching is in use.
6556
6557 Partial matching is requested by adding the string &"partial-"& to the front of
6558 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
6559 is done, the subject key is first looked up unmodified; if that fails, &"*."&
6560 is added at the start of the subject key, and it is looked up again. If that
6561 fails, further lookups are tried with dot-separated components removed from the
6562 start of the subject key, one-by-one, and &"*."& added on the front of what
6563 remains.
6564
6565 A minimum number of two non-* components are required. This can be adjusted
6566 by including a number before the hyphen in the search type. For example,
6567 &%partial3-lsearch%& specifies a minimum of three non-* components in the
6568 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
6569 subject key is &'2250.dates.fict.example'& then the following keys are looked
6570 up when the minimum number of non-* components is two:
6571 .code
6572 2250.dates.fict.example
6573 *.2250.dates.fict.example
6574 *.dates.fict.example
6575 *.fict.example
6576 .endd
6577 As soon as one key in the sequence is successfully looked up, the lookup
6578 finishes.
6579
6580 .cindex "lookup" "partial matching &-- changing prefix"
6581 .cindex "prefix" "for partial matching"
6582 The use of &"*."& as the partial matching prefix is a default that can be
6583 changed. The motivation for this feature is to allow Exim to operate with file
6584 formats that are used by other MTAs. A different prefix can be supplied in
6585 parentheses instead of the hyphen after &"partial"&. For example:
6586 .code
6587 domains = partial(.)lsearch;/some/file
6588 .endd
6589 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
6590 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
6591 components is unchanged). The prefix may consist of any punctuation characters
6592 other than a closing parenthesis. It may be empty, for example:
6593 .code
6594 domains = partial1()cdb;/some/file
6595 .endd
6596 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
6597 &`a.b.c`&, &`b.c`&, and &`c`&.
6598
6599 If &"partial0"& is specified, what happens at the end (when the lookup with
6600 just one non-wild component has failed, and the original key is shortened right
6601 down to the null string) depends on the prefix:
6602
6603 .ilist
6604 If the prefix has zero length, the whole lookup fails.
6605 .next
6606 If the prefix has length 1, a lookup for just the prefix is done. For
6607 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
6608 .next
6609 Otherwise, if the prefix ends in a dot, the dot is removed, and the
6610 remainder is looked up. With the default prefix, therefore, the final lookup is
6611 for &"*"& on its own.
6612 .next
6613 Otherwise, the whole prefix is looked up.
6614 .endlist
6615
6616
6617 If the search type ends in &"*"& or &"*@"& (see section
6618 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
6619 this implies happens after all partial lookups have failed. If &"partial0"& is
6620 specified, adding &"*"& to the search type has no effect with the default
6621 prefix, because the &"*"& key is already included in the sequence of partial
6622 lookups. However, there might be a use for lookup types such as
6623 &"partial0(.)lsearch*"&.
6624
6625 The use of &"*"& in lookup partial matching differs from its use as a wildcard
6626 in domain lists and the like. Partial matching works only in terms of
6627 dot-separated components; a key such as &`*fict.example`&
6628 in a database file is useless, because the asterisk in a partial matching
6629 subject key is always followed by a dot.
6630
6631
6632
6633
6634 .section "Lookup caching" "SECID64"
6635 .cindex "lookup" "caching"
6636 .cindex "caching" "lookup data"
6637 Exim caches all lookup results in order to avoid needless repetition of
6638 lookups. However, because (apart from the daemon) Exim operates as a collection
6639 of independent, short-lived processes, this caching applies only within a
6640 single Exim process. There is no inter-process lookup caching facility.
6641
6642 For single-key lookups, Exim keeps the relevant files open in case there is
6643 another lookup that needs them. In some types of configuration this can lead to
6644 many files being kept open for messages with many recipients. To avoid hitting
6645 the operating system limit on the number of simultaneously open files, Exim
6646 closes the least recently used file when it needs to open more files than its
6647 own internal limit, which can be changed via the &%lookup_open_max%& option.
6648
6649 The single-key lookup files are closed and the lookup caches are flushed at
6650 strategic points during delivery &-- for example, after all routing is
6651 complete.
6652
6653
6654
6655
6656 .section "Quoting lookup data" "SECID65"
6657 .cindex "lookup" "quoting"
6658 .cindex "quoting" "in lookups"
6659 When data from an incoming message is included in a query-style lookup, there
6660 is the possibility of special characters in the data messing up the syntax of
6661 the query. For example, a NIS+ query that contains
6662 .code
6663 [name=$local_part]
6664 .endd
6665 will be broken if the local part happens to contain a closing square bracket.
6666 For NIS+, data can be enclosed in double quotes like this:
6667 .code
6668 [name="$local_part"]
6669 .endd
6670 but this still leaves the problem of a double quote in the data. The rule for
6671 NIS+ is that double quotes must be doubled. Other lookup types have different
6672 rules, and to cope with the differing requirements, an expansion operator
6673 of the following form is provided:
6674 .code
6675 ${quote_<lookup-type>:<string>}
6676 .endd
6677 For example, the safest way to write the NIS+ query is
6678 .code
6679 [name="${quote_nisplus:$local_part}"]
6680 .endd
6681 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
6682 operator can be used for all lookup types, but has no effect for single-key
6683 lookups, since no quoting is ever needed in their key strings.
6684
6685
6686
6687
6688 .section "More about dnsdb" "SECTdnsdb"
6689 .cindex "dnsdb lookup"
6690 .cindex "lookup" "dnsdb"
6691 .cindex "DNS" "as a lookup type"
6692 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
6693 of a record type and a domain name, separated by an equals sign. For example,
6694 an expansion string could contain:
6695 .code
6696 ${lookup dnsdb{mx=a.b.example}{$value}fail}
6697 .endd
6698 If the lookup succeeds, the result is placed in &$value$&, which in this case
6699 is used on its own as the result. If the lookup does not succeed, the
6700 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
6701 &<<SECTforexpfai>>& for an explanation of what this means.
6702
6703 The supported DNS record types are A, CNAME, MX, NS, PTR, SRV, and TXT, and,
6704 when Exim is compiled with IPv6 support, AAAA (and A6 if that is also
6705 configured). If no type is given, TXT is assumed. When the type is PTR,
6706 the data can be an IP address, written as normal; inversion and the addition of
6707 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
6708 .code
6709 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
6710 .endd
6711 If the data for a PTR record is not a syntactically valid IP address, it is not
6712 altered and nothing is added.
6713
6714 .cindex "MX record" "in &(dnsdb)& lookup"
6715 .cindex "SRV record" "in &(dnsdb)& lookup"
6716 For an MX lookup, both the preference value and the host name are returned for
6717 each record, separated by a space. For an SRV lookup, the priority, weight,
6718 port, and host name are returned for each record, separated by spaces.
6719
6720 For any record type, if multiple records are found (or, for A6 lookups, if a
6721 single record leads to multiple addresses), the data is returned as a
6722 concatenation, with newline as the default separator. The order, of course,
6723 depends on the DNS resolver. You can specify a different separator character
6724 between multiple records by putting a right angle-bracket followed immediately
6725 by the new separator at the start of the query. For example:
6726 .code
6727 ${lookup dnsdb{>: a=host1.example}}
6728 .endd
6729 It is permitted to specify a space as the separator character. Further
6730 white space is ignored.
6731
6732 .cindex "TXT record" "in &(dnsdb)& lookup"
6733 For TXT records with multiple items of data, only the first item is returned,
6734 unless a separator for them is specified using a comma after the separator
6735 character followed immediately by the TXT record item separator. To concatenate
6736 items without a separator, use a semicolon instead.
6737 .code
6738 ${lookup dnsdb{>\n,: txt=a.b.example}}
6739 ${lookup dnsdb{>\n; txt=a.b.example}}
6740 .endd
6741 It is permitted to specify a space as the separator character. Further
6742 white space is ignored.
6743
6744 .section "Pseudo dnsdb record types" "SECID66"
6745 .cindex "MX record" "in &(dnsdb)& lookup"
6746 By default, both the preference value and the host name are returned for
6747 each MX record, separated by a space. If you want only host names, you can use
6748 the pseudo-type MXH:
6749 .code
6750 ${lookup dnsdb{mxh=a.b.example}}
6751 .endd
6752 In this case, the preference values are omitted, and just the host names are
6753 returned.
6754
6755 .cindex "name server for enclosing domain"
6756 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
6757 records on the given domain, but if none are found, it removes the first
6758 component of the domain name, and tries again. This process continues until NS
6759 records are found or there are no more components left (or there is a DNS
6760 error). In other words, it may return the name servers for a top-level domain,
6761 but it never returns the root name servers. If there are no NS records for the
6762 top-level domain, the lookup fails. Consider these examples:
6763 .code
6764 ${lookup dnsdb{zns=xxx.quercite.com}}
6765 ${lookup dnsdb{zns=xxx.edu}}
6766 .endd
6767 Assuming that in each case there are no NS records for the full domain name,
6768 the first returns the name servers for &%quercite.com%&, and the second returns
6769 the name servers for &%edu%&.
6770
6771 You should be careful about how you use this lookup because, unless the
6772 top-level domain does not exist, the lookup always returns some host names. The
6773 sort of use to which this might be put is for seeing if the name servers for a
6774 given domain are on a blacklist. You can probably assume that the name servers
6775 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
6776 such a list.
6777
6778 .cindex "CSA" "in &(dnsdb)& lookup"
6779 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
6780 records according to the CSA rules, which are described in section
6781 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
6782 not sufficient because of the extra parent domain search behaviour of CSA. The
6783 result of a successful lookup such as:
6784 .code
6785 ${lookup dnsdb {csa=$sender_helo_name}}
6786 .endd
6787 has two space-separated fields: an authorization code and a target host name.
6788 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
6789 authorization required but absent, or &"?"& for unknown.
6790
6791
6792 .section "Multiple dnsdb lookups" "SECID67"
6793 In the previous sections, &(dnsdb)& lookups for a single domain are described.
6794 However, you can specify a list of domains or IP addresses in a single
6795 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
6796 the default separator, but with the ability to change this. For example:
6797 .code
6798 ${lookup dnsdb{one.domain.com:two.domain.com}}
6799 ${lookup dnsdb{a=one.host.com:two.host.com}}
6800 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
6801 .endd
6802 In order to retain backwards compatibility, there is one special case: if
6803 the lookup type is PTR and no change of separator is specified, Exim looks
6804 to see if the rest of the string is precisely one IPv6 address. In this
6805 case, it does not treat it as a list.
6806
6807 The data from each lookup is concatenated, with newline separators by default,
6808 in the same way that multiple DNS records for a single item are handled. A
6809 different separator can be specified, as described above.
6810
6811 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
6812 temporary DNS error for any of them, the behaviour is controlled by
6813 an optional keyword followed by a comma that may appear before the record
6814 type. The possible keywords are &"defer_strict"&, &"defer_never"&, and
6815 &"defer_lax"&. With &"strict"& behaviour, any temporary DNS error causes the
6816 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
6817 ignored, and the behaviour is as if the DNS lookup failed to find anything.
6818 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
6819 error causes the whole lookup to defer only if none of the other lookups
6820 succeed. The default is &"lax"&, so the following lookups are equivalent:
6821 .code
6822 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
6823 ${lookup dnsdb{a=one.host.com:two.host.com}}
6824 .endd
6825 Thus, in the default case, as long as at least one of the DNS lookups
6826 yields some data, the lookup succeeds.
6827
6828
6829
6830
6831 .section "More about LDAP" "SECTldap"
6832 .cindex "LDAP" "lookup, more about"
6833 .cindex "lookup" "LDAP"
6834 .cindex "Solaris" "LDAP"
6835 The original LDAP implementation came from the University of Michigan; this has
6836 become &"Open LDAP"&, and there are now two different releases. Another
6837 implementation comes from Netscape, and Solaris 7 and subsequent releases
6838 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
6839 the lookup function level, their error handling is different. For this reason
6840 it is necessary to set a compile-time variable when building Exim with LDAP, to
6841 indicate which LDAP library is in use. One of the following should appear in
6842 your &_Local/Makefile_&:
6843 .code
6844 LDAP_LIB_TYPE=UMICHIGAN
6845 LDAP_LIB_TYPE=OPENLDAP1
6846 LDAP_LIB_TYPE=OPENLDAP2
6847 LDAP_LIB_TYPE=NETSCAPE
6848 LDAP_LIB_TYPE=SOLARIS
6849 .endd
6850 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
6851 same interface as the University of Michigan version.
6852
6853 There are three LDAP lookup types in Exim. These behave slightly differently in
6854 the way they handle the results of a query:
6855
6856 .ilist
6857 &(ldap)& requires the result to contain just one entry; if there are more, it
6858 gives an error.
6859 .next
6860 &(ldapdn)& also requires the result to contain just one entry, but it is the
6861 Distinguished Name that is returned rather than any attribute values.
6862 .next
6863 &(ldapm)& permits the result to contain more than one entry; the attributes
6864 from all of them are returned.
6865 .endlist
6866
6867
6868 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
6869 Exim behaves as if the entry did not exist, and the lookup fails. The format of
6870 the data returned by a successful lookup is described in the next section.
6871 First we explain how LDAP queries are coded.
6872
6873
6874 .section "Format of LDAP queries" "SECTforldaque"
6875 .cindex "LDAP" "query format"
6876 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
6877 the configuration of a &(redirect)& router one might have this setting:
6878 .code
6879 data = ${lookup ldap \
6880   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
6881   c=UK?mailbox?base?}}
6882 .endd
6883 .cindex "LDAP" "with TLS"
6884 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
6885 secure (encrypted) LDAP connections. The second of these ensures that an
6886 encrypted TLS connection is used.
6887
6888
6889 .section "LDAP quoting" "SECID68"
6890 .cindex "LDAP" "quoting"
6891 Two levels of quoting are required in LDAP queries, the first for LDAP itself
6892 and the second because the LDAP query is represented as a URL. Furthermore,
6893 within an LDAP query, two different kinds of quoting are required. For this
6894 reason, there are two different LDAP-specific quoting operators.
6895
6896 The &%quote_ldap%& operator is designed for use on strings that are part of
6897 filter specifications. Conceptually, it first does the following conversions on
6898 the string:
6899 .code
6900 *   =>   \2A
6901 (   =>   \28
6902 )   =>   \29
6903 \   =>   \5C
6904 .endd
6905 in accordance with RFC 2254. The resulting string is then quoted according
6906 to the rules for URLs, that is, all non-alphanumeric characters except
6907 .code
6908 ! $ ' - . _ ( ) * +
6909 .endd
6910 are converted to their hex values, preceded by a percent sign. For example:
6911 .code
6912 ${quote_ldap: a(bc)*, a<yz>; }
6913 .endd
6914 yields
6915 .code
6916 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
6917 .endd
6918 Removing the URL quoting, this is (with a leading and a trailing space):
6919 .code
6920 a\28bc\29\2A, a<yz>;
6921 .endd
6922 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
6923 base DN specifications in queries. Conceptually, it first converts the string
6924 by inserting a backslash in front of any of the following characters:
6925 .code
6926 , + " \ < > ;
6927 .endd
6928 It also inserts a backslash before any leading spaces or # characters, and
6929 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
6930 is then quoted according to the rules for URLs. For example:
6931 .code
6932 ${quote_ldap_dn: a(bc)*, a<yz>; }
6933 .endd
6934 yields
6935 .code
6936 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
6937 .endd
6938 Removing the URL quoting, this is (with a trailing space):
6939 .code
6940 \ a(bc)*\, a\<yz\>\;\
6941 .endd
6942 There are some further comments about quoting in the section on LDAP
6943 authentication below.
6944
6945
6946 .section "LDAP connections" "SECID69"
6947 .cindex "LDAP" "connections"
6948 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
6949 is in use, via a Unix domain socket. The example given above does not specify
6950 an LDAP server. A server that is reached by TCP/IP can be specified in a query
6951 by starting it with
6952 .code
6953 ldap://<hostname>:<port>/...
6954 .endd
6955 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
6956 used. When no server is specified in a query, a list of default servers is
6957 taken from the &%ldap_default_servers%& configuration option. This supplies a
6958 colon-separated list of servers which are tried in turn until one successfully
6959 handles a query, or there is a serious error. Successful handling either
6960 returns the requested data, or indicates that it does not exist. Serious errors
6961 are syntactical, or multiple values when only a single value is expected.
6962 Errors which cause the next server to be tried are connection failures, bind
6963 failures, and timeouts.
6964
6965 For each server name in the list, a port number can be given. The standard way
6966 of specifying a host and port is to use a colon separator (RFC 1738). Because
6967 &%ldap_default_servers%& is a colon-separated list, such colons have to be
6968 doubled. For example
6969 .code
6970 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
6971 .endd
6972 If &%ldap_default_servers%& is unset, a URL with no server name is passed
6973 to the LDAP library with no server name, and the library's default (normally
6974 the local host) is used.
6975
6976 If you are using the OpenLDAP library, you can connect to an LDAP server using
6977 a Unix domain socket instead of a TCP/IP connection. This is specified by using
6978 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
6979 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
6980 not available.
6981
6982 For this type of connection, instead of a host name for the server, a pathname
6983 for the socket is required, and the port number is not relevant. The pathname
6984 can be specified either as an item in &%ldap_default_servers%&, or inline in
6985 the query. In the former case, you can have settings such as
6986 .code
6987 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
6988 .endd
6989 When the pathname is given in the query, you have to escape the slashes as
6990 &`%2F`& to fit in with the LDAP URL syntax. For example:
6991 .code
6992 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
6993 .endd
6994 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
6995 a pathname, it uses the Unix domain socket code, even if the query actually
6996 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
6997 socket connection. This behaviour means that you can use a setting of
6998 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
6999 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7000 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7001 backup host.
7002
7003 If an explicit &`ldapi`& type is given in a query when a host name is
7004 specified, an error is diagnosed. However, if there are more items in
7005 &%ldap_default_servers%&, they are tried. In other words:
7006
7007 .ilist
7008 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7009 interface.
7010 .next
7011 Using &`ldapi`& with a host name causes an error.
7012 .endlist
7013
7014
7015 Using &`ldapi`& with no host or path in the query, and no setting of
7016 &%ldap_default_servers%&, does whatever the library does by default.
7017
7018
7019
7020 .section "LDAP authentication and control information" "SECID70"
7021 .cindex "LDAP" "authentication"
7022 The LDAP URL syntax provides no way of passing authentication and other control
7023 information to the server. To make this possible, the URL in an LDAP query may
7024 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7025 spaces. If a value contains spaces it must be enclosed in double quotes, and
7026 when double quotes are used, backslash is interpreted in the usual way inside
7027 them. The following names are recognized:
7028 .display
7029 &`DEREFERENCE`&  set the dereferencing parameter
7030 &`NETTIME    `&  set a timeout for a network operation
7031 &`USER       `&  set the DN, for authenticating the LDAP bind
7032 &`PASS       `&  set the password, likewise
7033 &`REFERRALS  `&  set the referrals parameter
7034 &`SIZE       `&  set the limit for the number of entries returned
7035 &`TIME       `&  set the maximum waiting time for a query
7036 .endd
7037 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7038 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7039 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7040 library from trying to follow referrals issued by the LDAP server.
7041
7042 The name CONNECT is an obsolete name for NETTIME, retained for
7043 backwards compatibility. This timeout (specified as a number of seconds) is
7044 enforced from the client end for operations that can be carried out over a
7045 network. Specifically, it applies to network connections and calls to the
7046 &'ldap_result()'& function. If the value is greater than zero, it is used if
7047 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7048 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7049 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7050 Netscape SDK; for OpenLDAP no action is taken.
7051
7052 The TIME parameter (also a number of seconds) is passed to the server to
7053 set a server-side limit on the time taken to complete a search.
7054
7055
7056 Here is an example of an LDAP query in an Exim lookup that uses some of these
7057 values. This is a single line, folded to fit on the page:
7058 .code
7059 ${lookup ldap
7060   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7061   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7062   {$value}fail}
7063 .endd
7064 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7065 any of the auxiliary data. Exim configuration settings that include lookups
7066 which contain password information should be preceded by &"hide"& to prevent
7067 non-admin users from using the &%-bP%& option to see their values.
7068
7069 The auxiliary data items may be given in any order. The default is no
7070 connection timeout (the system timeout is used), no user or password, no limit
7071 on the number of entries returned, and no time limit on queries.
7072
7073 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7074 removes any URL quoting that it may contain before passing it LDAP. Apparently
7075 some libraries do this for themselves, but some do not. Removing the URL
7076 quoting has two advantages:
7077
7078 .ilist
7079 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7080 DNs as with DNs inside actual queries.
7081 .next
7082 It permits spaces inside USER= DNs.
7083 .endlist
7084
7085 For example, a setting such as
7086 .code
7087 USER=cn=${quote_ldap_dn:$1}
7088 .endd
7089 should work even if &$1$& contains spaces.
7090
7091 Expanded data for the PASS= value should be quoted using the &%quote%&
7092 expansion operator, rather than the LDAP quote operators. The only reason this
7093 field needs quoting is to ensure that it conforms to the Exim syntax, which
7094 does not allow unquoted spaces. For example:
7095 .code
7096 PASS=${quote:$3}
7097 .endd
7098 The LDAP authentication mechanism can be used to check passwords as part of
7099 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7100 &<<CHAPexpand>>&.
7101
7102
7103
7104 .section "Format of data returned by LDAP" "SECID71"
7105 .cindex "LDAP" "returned data formats"
7106 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7107 as a sequence of values, for example
7108 .code
7109 cn=manager, o=University of Cambridge, c=UK
7110 .endd
7111 The &(ldap)& lookup type generates an error if more than one entry matches the
7112 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7113 the result between the data from different entries. It is possible for multiple
7114 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7115 you know that whatever values are returned all came from a single entry in the
7116 directory.
7117
7118 In the common case where you specify a single attribute in your LDAP query, the
7119 result is not quoted, and does not contain the attribute name. If the attribute
7120 has multiple values, they are separated by commas.
7121
7122 If you specify multiple attributes, the result contains space-separated, quoted
7123 strings, each preceded by the attribute name and an equals sign. Within the
7124 quotes, the quote character, backslash, and newline are escaped with
7125 backslashes, and commas are used to separate multiple values for the attribute.
7126 Apart from the escaping, the string within quotes takes the same form as the
7127 output when a single attribute is requested. Specifying no attributes is the
7128 same as specifying all of an entry's attributes.
7129
7130 Here are some examples of the output format. The first line of each pair is an
7131 LDAP query, and the second is the data that is returned. The attribute called
7132 &%attr1%& has two values, whereas &%attr2%& has only one value:
7133 .code
7134 ldap:///o=base?attr1?sub?(uid=fred)
7135 value1.1, value1.2
7136
7137 ldap:///o=base?attr2?sub?(uid=fred)
7138 value two
7139
7140 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7141 attr1="value1.1, value1.2" attr2="value two"
7142
7143 ldap:///o=base??sub?(uid=fred)
7144 objectClass="top" attr1="value1.1, value1.2" attr2="value two"
7145 .endd
7146 The &%extract%& operator in string expansions can be used to pick out
7147 individual fields from data that consists of &'key'&=&'value'& pairs. You can
7148 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7149 results of LDAP lookups.
7150
7151
7152
7153
7154 .section "More about NIS+" "SECTnisplus"
7155 .cindex "NIS+ lookup type"
7156 .cindex "lookup" "NIS+"
7157 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7158 and field name. If this is given, the result of a successful query is the
7159 contents of the named field; otherwise the result consists of a concatenation
7160 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7161 values containing spaces are quoted. For example, the query
7162 .code
7163 [name=mg1456],passwd.org_dir
7164 .endd
7165 might return the string
7166 .code
7167 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7168 home=/home/mg1456 shell=/bin/bash shadow=""
7169 .endd
7170 (split over two lines here to fit on the page), whereas
7171 .code
7172 [name=mg1456],passwd.org_dir:gcos
7173 .endd
7174 would just return
7175 .code
7176 Martin Guerre
7177 .endd
7178 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7179 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7180 operator is to double any quote characters within the text.
7181
7182
7183
7184 .section "SQL lookups" "SECTsql"
7185 .cindex "SQL lookup types"
7186 .cindex "MySQL" "lookup type"
7187 .cindex "PostgreSQL lookup type"
7188 .cindex "lookup" "MySQL"
7189 .cindex "lookup" "PostgreSQL"
7190 .cindex "Oracle" "lookup type"
7191 .cindex "lookup" "Oracle"
7192 .cindex "InterBase lookup type"
7193 .cindex "lookup" "InterBase"
7194 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, and SQLite
7195 databases. Queries for these databases contain SQL statements, so an example
7196 might be
7197 .code
7198 ${lookup mysql{select mailbox from users where id='userx'}\
7199   {$value}fail}
7200 .endd
7201 If the result of the query contains more than one field, the data for each
7202 field in the row is returned, preceded by its name, so the result of
7203 .code
7204 ${lookup pgsql{select home,name from users where id='userx'}\
7205   {$value}}
7206 .endd
7207 might be
7208 .code
7209 home=/home/userx name="Mister X"
7210 .endd
7211 Empty values and values containing spaces are double quoted, with embedded
7212 quotes escaped by a backslash. If the result of the query contains just one
7213 field, the value is passed back verbatim, without a field name, for example:
7214 .code
7215 Mister X
7216 .endd
7217 If the result of the query yields more than one row, it is all concatenated,
7218 with a newline between the data for each row.
7219
7220
7221 .section "More about MySQL, PostgreSQL, Oracle, and InterBase" "SECID72"
7222 .cindex "MySQL" "lookup type"
7223 .cindex "PostgreSQL lookup type"
7224 .cindex "lookup" "MySQL"
7225 .cindex "lookup" "PostgreSQL"
7226 .cindex "Oracle" "lookup type"
7227 .cindex "lookup" "Oracle"
7228 .cindex "InterBase lookup type"
7229 .cindex "lookup" "InterBase"
7230 If any MySQL, PostgreSQL, Oracle, or InterBase lookups are used, the
7231 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, or &%ibase_servers%&
7232 option (as appropriate) must be set to a colon-separated list of server
7233 information.
7234 (For MySQL and PostgreSQL only, the global option need not be set if all
7235 queries contain their own server information &-- see section
7236 &<<SECTspeserque>>&.) Each item in the list is a slash-separated list of four
7237 items: host name, database name, user name, and password. In the case of
7238 Oracle, the host name field is used for the &"service name"&, and the database
7239 name field is not used and should be empty. For example:
7240 .code
7241 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7242 .endd
7243 Because password data is sensitive, you should always precede the setting with
7244 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7245 option. Here is an example where two MySQL servers are listed:
7246 .code
7247 hide mysql_servers = localhost/users/root/secret:\
7248                      otherhost/users/root/othersecret
7249 .endd
7250 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7251 because this is a colon-separated list, the colon has to be doubled. For each
7252 query, these parameter groups are tried in order until a connection is made and
7253 a query is successfully processed. The result of a query may be that no data is
7254 found, but that is still a successful query. In other words, the list of
7255 servers provides a backup facility, not a list of different places to look.
7256
7257 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7258 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7259 respectively, and the characters single-quote, double-quote, and backslash
7260 itself are escaped with backslashes. The &%quote_pgsql%& expansion operator, in
7261 addition, escapes the percent and underscore characters. This cannot be done
7262 for MySQL because these escapes are not recognized in contexts where these
7263 characters are not special.
7264
7265 .section "Specifying the server in the query" "SECTspeserque"
7266 For MySQL and PostgreSQL lookups (but not currently for Oracle and InterBase),
7267 it is possible to specify a list of servers with an individual query. This is
7268 done by starting the query with
7269 .display
7270 &`servers=`&&'server1:server2:server3:...'&&`;`&
7271 .endd
7272 Each item in the list may take one of two forms:
7273 .olist
7274 If it contains no slashes it is assumed to be just a host name. The appropriate
7275 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7276 of the same name, and the remaining parameters (database, user, password) are
7277 taken from there.
7278 .next
7279 If it contains any slashes, it is taken as a complete parameter set.
7280 .endlist
7281 The list of servers is used in exactly the same way as the global list.
7282 Once a connection to a server has happened and a query has been
7283 successfully executed, processing of the lookup ceases.
7284
7285 This feature is intended for use in master/slave situations where updates
7286 are occurring and you want to update the master rather than a slave. If the
7287 master is in the list as a backup for reading, you might have a global setting
7288 like this:
7289 .code
7290 mysql_servers = slave1/db/name/pw:\
7291                 slave2/db/name/pw:\
7292                 master/db/name/pw
7293 .endd
7294 In an updating lookup, you could then write:
7295 .code
7296 ${lookup mysql{servers=master; UPDATE ...} }
7297 .endd
7298 That query would then be sent only to the master server. If, on the other hand,
7299 the master is not to be used for reading, and so is not present in the global
7300 option, you can still update it by a query of this form:
7301 .code
7302 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7303 .endd
7304
7305
7306 .section "Special MySQL features" "SECID73"
7307 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7308 causes a connection to the server on the local host by means of a Unix domain
7309 socket. An alternate socket can be specified in parentheses. The full syntax of
7310 each item in &%mysql_servers%& is:
7311 .display
7312 <&'hostname'&>::<&'port'&>(<&'socket name'&>)/<&'database'&>/&&&
7313   <&'user'&>/<&'password'&>
7314 .endd
7315 Any of the three sub-parts of the first field can be omitted. For normal use on
7316 the local host it can be left blank or set to just &"localhost"&.
7317
7318 No database need be supplied &-- but if it is absent here, it must be given in
7319 the queries.
7320
7321 If a MySQL query is issued that does not request any data (an insert, update,
7322 or delete command), the result of the lookup is the number of rows affected.
7323
7324 &*Warning*&: This can be misleading. If an update does not actually change
7325 anything (for example, setting a field to the value it already has), the result
7326 is zero because no rows are affected.
7327
7328
7329 .section "Special PostgreSQL features" "SECID74"
7330 PostgreSQL lookups can also use Unix domain socket connections to the database.
7331 This is usually faster and costs less CPU time than a TCP/IP connection.
7332 However it can be used only if the mail server runs on the same machine as the
7333 database server. A configuration line for PostgreSQL via Unix domain sockets
7334 looks like this:
7335 .code
7336 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7337 .endd
7338 In other words, instead of supplying a host name, a path to the socket is
7339 given. The path name is enclosed in parentheses so that its slashes aren't
7340 visually confused with the delimiters for the other server parameters.
7341
7342 If a PostgreSQL query is issued that does not request any data (an insert,
7343 update, or delete command), the result of the lookup is the number of rows
7344 affected.
7345
7346 .section "More about SQLite" "SECTsqlite"
7347 .cindex "lookup" "SQLite"
7348 .cindex "sqlite lookup type"
7349 SQLite is different to the other SQL lookups because a file name is required in
7350 addition to the SQL query. An SQLite database is a single file, and there is no
7351 daemon as in the other SQL databases. The interface to Exim requires the name
7352 of the file, as an absolute path, to be given at the start of the query. It is
7353 separated from the query by white space. This means that the path name cannot
7354 contain white space. Here is a lookup expansion example:
7355 .code
7356 ${lookup sqlite {/some/thing/sqlitedb \
7357   select name from aliases where id='userx';}}
7358 .endd
7359 In a list, the syntax is similar. For example:
7360 .code
7361 domainlist relay_domains = sqlite;/some/thing/sqlitedb \
7362    select * from relays where ip='$sender_host_address';
7363 .endd
7364 The only character affected by the &%quote_sqlite%& operator is a single
7365 quote, which it doubles.
7366
7367 The SQLite library handles multiple simultaneous accesses to the database
7368 internally. Multiple readers are permitted, but only one process can
7369 update at once. Attempts to access the database while it is being updated
7370 are rejected after a timeout period, during which the SQLite library
7371 waits for the lock to be released. In Exim, the default timeout is set
7372 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7373 option.
7374 .ecindex IIDfidalo1
7375 .ecindex IIDfidalo2
7376
7377
7378 . ////////////////////////////////////////////////////////////////////////////
7379 . ////////////////////////////////////////////////////////////////////////////
7380
7381 .chapter "Domain, host, address, and local part lists" &&&
7382          "CHAPdomhosaddlists" &&&
7383          "Domain, host, and address lists"
7384 .scindex IIDdohoadli "lists of domains; hosts; etc."
7385 A number of Exim configuration options contain lists of domains, hosts,
7386 email addresses, or local parts. For example, the &%hold_domains%& option
7387 contains a list of domains whose delivery is currently suspended. These lists
7388 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7389 arguments to expansion conditions such as &%match_domain%&.
7390
7391 Each item in one of these lists is a pattern to be matched against a domain,
7392 host, email address, or local part, respectively. In the sections below, the
7393 different types of pattern for each case are described, but first we cover some
7394 general facilities that apply to all four kinds of list.
7395
7396
7397
7398 .section "Expansion of lists" "SECID75"
7399 .cindex "expansion" "of lists"
7400 Each list is expanded as a single string before it is used. The result of
7401 expansion must be a list, possibly containing empty items, which is split up
7402 into separate items for matching. By default, colon is the separator character,
7403 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7404 &<<SECTempitelis>>& for details of the list syntax; the second of these
7405 discusses the way to specify empty list items.
7406
7407
7408 If the string expansion is forced to fail, Exim behaves as if the item it is
7409 testing (domain, host, address, or local part) is not in the list. Other
7410 expansion failures cause temporary errors.
7411
7412 If an item in a list is a regular expression, backslashes, dollars and possibly
7413 other special characters in the expression must be protected against
7414 misinterpretation by the string expander. The easiest way to do this is to use
7415 the &`\N`& expansion feature to indicate that the contents of the regular
7416 expression should not be expanded. For example, in an ACL you might have:
7417 .code
7418 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7419                ${lookup{$domain}lsearch{/badsenders/bydomain}}
7420 .endd
7421 The first item is a regular expression that is protected from expansion by
7422 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7423 senders based on the receiving domain.
7424
7425
7426
7427
7428 .section "Negated items in lists" "SECID76"
7429 .cindex "list" "negation"
7430 .cindex "negation" "in lists"
7431 Items in a list may be positive or negative. Negative items are indicated by a
7432 leading exclamation mark, which may be followed by optional white space. A list
7433 defines a set of items (domains, etc). When Exim processes one of these lists,
7434 it is trying to find out whether a domain, host, address, or local part
7435 (respectively) is in the set that is defined by the list. It works like this:
7436
7437 The list is scanned from left to right. If a positive item is matched, the
7438 subject that is being checked is in the set; if a negative item is matched, the
7439 subject is not in the set. If the end of the list is reached without the
7440 subject having matched any of the patterns, it is in the set if the last item
7441 was a negative one, but not if it was a positive one. For example, the list in
7442 .code
7443 domainlist relay_domains = !a.b.c : *.b.c
7444 .endd
7445 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7446 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7447 list is positive. However, if the setting were
7448 .code
7449 domainlist relay_domains = !a.b.c
7450 .endd
7451 then all domains other than &'a.b.c'& would match because the last item in the
7452 list is negative. In other words, a list that ends with a negative item behaves
7453 as if it had an extra item &`:*`& on the end.
7454
7455 Another way of thinking about positive and negative items in lists is to read
7456 the connector as &"or"& after a positive item and as &"and"& after a negative
7457 item.
7458
7459
7460
7461 .section "File names in lists" "SECTfilnamlis"
7462 .cindex "list" "file name in"
7463 If an item in a domain, host, address, or local part list is an absolute file
7464 name (beginning with a slash character), each line of the file is read and
7465 processed as if it were an independent item in the list, except that further
7466 file names are not allowed,
7467 and no expansion of the data from the file takes place.
7468 Empty lines in the file are ignored, and the file may also contain comment
7469 lines:
7470
7471 .ilist
7472 For domain and host lists, if a # character appears anywhere in a line of the
7473 file, it and all following characters are ignored.
7474 .next
7475 Because local parts may legitimately contain # characters, a comment in an
7476 address list or local part list file is recognized only if # is preceded by
7477 white space or the start of the line. For example:
7478 .code
7479 not#comment@x.y.z   # but this is a comment
7480 .endd
7481 .endlist
7482
7483 Putting a file name in a list has the same effect as inserting each line of the
7484 file as an item in the list (blank lines and comments excepted). However, there
7485 is one important difference: the file is read each time the list is processed,
7486 so if its contents vary over time, Exim's behaviour changes.
7487
7488 If a file name is preceded by an exclamation mark, the sense of any match
7489 within the file is inverted. For example, if
7490 .code
7491 hold_domains = !/etc/nohold-domains
7492 .endd
7493 and the file contains the lines
7494 .code
7495 !a.b.c
7496 *.b.c
7497 .endd
7498 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
7499 any domain matching &`*.b.c`& is not.
7500
7501
7502
7503 .section "An lsearch file is not an out-of-line list" "SECID77"
7504 As will be described in the sections that follow, lookups can be used in lists
7505 to provide indexed methods of checking list membership. There has been some
7506 confusion about the way &(lsearch)& lookups work in lists. Because
7507 an &(lsearch)& file contains plain text and is scanned sequentially, it is
7508 sometimes thought that it is allowed to contain wild cards and other kinds of
7509 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
7510 always fixed strings, just as for any other single-key lookup type.
7511
7512 If you want to use a file to contain wild-card patterns that form part of a
7513 list, just give the file name on its own, without a search type, as described
7514 in the previous section. You could also use the &(wildlsearch)& or
7515 &(nwildlsearch)&, but there is no advantage in doing this.
7516
7517
7518
7519
7520 .section "Named lists" "SECTnamedlists"
7521 .cindex "named lists"
7522 .cindex "list" "named"
7523 A list of domains, hosts, email addresses, or local parts can be given a name
7524 which is then used to refer to the list elsewhere in the configuration. This is
7525 particularly convenient if the same list is required in several different
7526 places. It also allows lists to be given meaningful names, which can improve
7527 the readability of the configuration. For example, it is conventional to define
7528 a domain list called &'local_domains'& for all the domains that are handled
7529 locally on a host, using a configuration line such as
7530 .code
7531 domainlist local_domains = localhost:my.dom.example
7532 .endd
7533 Named lists are referenced by giving their name preceded by a plus sign, so,
7534 for example, a router that is intended to handle local domains would be
7535 configured with the line
7536 .code
7537 domains = +local_domains
7538 .endd
7539 The first router in a configuration is often one that handles all domains
7540 except the local ones, using a configuration with a negated item like this:
7541 .code
7542 dnslookup:
7543   driver = dnslookup
7544   domains = ! +local_domains
7545   transport = remote_smtp
7546   no_more
7547 .endd
7548 The four kinds of named list are created by configuration lines starting with
7549 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
7550 respectively. Then there follows the name that you are defining, followed by an
7551 equals sign and the list itself. For example:
7552 .code
7553 hostlist    relay_hosts = 192.168.23.0/24 : my.friend.example
7554 addresslist bad_senders = cdb;/etc/badsenders
7555 .endd
7556 A named list may refer to other named lists:
7557 .code
7558 domainlist  dom1 = first.example : second.example
7559 domainlist  dom2 = +dom1 : third.example
7560 domainlist  dom3 = fourth.example : +dom2 : fifth.example
7561 .endd
7562 &*Warning*&: If the last item in a referenced list is a negative one, the
7563 effect may not be what you intended, because the negation does not propagate
7564 out to the higher level. For example, consider:
7565 .code
7566 domainlist  dom1 = !a.b
7567 domainlist  dom2 = +dom1 : *.b
7568 .endd
7569 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
7570 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
7571 means it matches the second list as well. The effect is not the same as
7572 .code
7573 domainlist  dom2 = !a.b : *.b
7574 .endd
7575 where &'x.y'& does not match. It's best to avoid negation altogether in
7576 referenced lists if you can.
7577
7578 Named lists may have a performance advantage. When Exim is routing an
7579 address or checking an incoming message, it caches the result of tests on named
7580 lists. So, if you have a setting such as
7581 .code
7582 domains = +local_domains
7583 .endd
7584 on several of your routers
7585 or in several ACL statements,
7586 the actual test is done only for the first one. However, the caching works only
7587 if there are no expansions within the list itself or any sublists that it
7588 references. In other words, caching happens only for lists that are known to be
7589 the same each time they are referenced.
7590
7591 By default, there may be up to 16 named lists of each type. This limit can be
7592 extended by changing a compile-time variable. The use of domain and host lists
7593 is recommended for concepts such as local domains, relay domains, and relay
7594 hosts. The default configuration is set up like this.
7595
7596
7597
7598 .section "Named lists compared with macros" "SECID78"
7599 .cindex "list" "named compared with macro"
7600 .cindex "macro" "compared with named list"
7601 At first sight, named lists might seem to be no different from macros in the
7602 configuration file. However, macros are just textual substitutions. If you
7603 write
7604 .code
7605 ALIST = host1 : host2
7606 auth_advertise_hosts = !ALIST
7607 .endd
7608 it probably won't do what you want, because that is exactly the same as
7609 .code
7610 auth_advertise_hosts = !host1 : host2
7611 .endd
7612 Notice that the second host name is not negated. However, if you use a host
7613 list, and write
7614 .code
7615 hostlist alist = host1 : host2
7616 auth_advertise_hosts = ! +alist
7617 .endd
7618 the negation applies to the whole list, and so that is equivalent to
7619 .code
7620 auth_advertise_hosts = !host1 : !host2
7621 .endd
7622
7623
7624 .section "Named list caching" "SECID79"
7625 .cindex "list" "caching of named"
7626 .cindex "caching" "named lists"
7627 While processing a message, Exim caches the result of checking a named list if
7628 it is sure that the list is the same each time. In practice, this means that
7629 the cache operates only if the list contains no $ characters, which guarantees
7630 that it will not change when it is expanded. Sometimes, however, you may have
7631 an expanded list that you know will be the same each time within a given
7632 message. For example:
7633 .code
7634 domainlist special_domains = \
7635            ${lookup{$sender_host_address}cdb{/some/file}}
7636 .endd
7637 This provides a list of domains that depends only on the sending host's IP
7638 address. If this domain list is referenced a number of times (for example,
7639 in several ACL lines, or in several routers) the result of the check is not
7640 cached by default, because Exim does not know that it is going to be the
7641 same list each time.
7642
7643 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
7644 cache the result anyway. For example:
7645 .code
7646 domainlist_cache special_domains = ${lookup{...
7647 .endd
7648 If you do this, you should be absolutely sure that caching is going to do
7649 the right thing in all cases. When in doubt, leave it out.
7650
7651
7652
7653 .section "Domain lists" "SECTdomainlist"
7654 .cindex "domain list" "patterns for"
7655 .cindex "list" "domain list"
7656 Domain lists contain patterns that are to be matched against a mail domain.
7657 The following types of item may appear in domain lists:
7658
7659 .ilist
7660 .cindex "primary host name"
7661 .cindex "host name" "matched in domain list"
7662 .oindex "&%primary_hostname%&"
7663 .cindex "domain list" "matching primary host name"
7664 .cindex "@ in a domain list"
7665 If a pattern consists of a single @ character, it matches the local host name,
7666 as set by the &%primary_hostname%& option (or defaulted). This makes it
7667 possible to use the same configuration file on several different hosts that
7668 differ only in their names.
7669 .next
7670 .cindex "@[] in a domain list"
7671 .cindex "domain list" "matching local IP interfaces"
7672 .cindex "domain literal"
7673 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
7674 in square brackets (as in an email address that contains a domain literal), but
7675 only if that IP address is recognized as local for email routing purposes. The
7676 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
7677 control which of a host's several IP addresses are treated as local.
7678 In today's Internet, the use of domain literals is controversial.
7679 .next
7680 .cindex "@mx_any"
7681 .cindex "@mx_primary"
7682 .cindex "@mx_secondary"
7683 .cindex "domain list" "matching MX pointers to local host"
7684 If a pattern consists of the string &`@mx_any`& it matches any domain that
7685 has an MX record pointing to the local host or to any host that is listed in
7686 .oindex "&%hosts_treat_as_local%&"
7687 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
7688 are similar, except that the first matches only when a primary MX target is the
7689 local host, and the second only when no primary MX target is the local host,
7690 but a secondary MX target is. &"Primary"& means an MX record with the lowest
7691 preference value &-- there may of course be more than one of them.
7692
7693 The MX lookup that takes place when matching a pattern of this type is
7694 performed with the resolver options for widening names turned off. Thus, for
7695 example, a single-component domain will &'not'& be expanded by adding the
7696 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
7697 options of the &(dnslookup)& router for a discussion of domain widening.
7698
7699 Sometimes you may want to ignore certain IP addresses when using one of these
7700 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
7701 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
7702 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
7703 on a router). For example:
7704 .code
7705 domains = @mx_any/ignore=127.0.0.1
7706 .endd
7707 This example matches any domain that has an MX record pointing to one of
7708 the local host's IP addresses other than 127.0.0.1.
7709
7710 The list of IP addresses is in fact processed by the same code that processes
7711 host lists, so it may contain CIDR-coded network specifications and it may also
7712 contain negative items.
7713
7714 Because the list of IP addresses is a sublist within a domain list, you have to
7715 be careful about delimiters if there is more than one address. Like any other
7716 list, the default delimiter can be changed. Thus, you might have:
7717 .code
7718 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
7719           an.other.domain : ...
7720 .endd
7721 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
7722 involved, it is easiest to change the delimiter for the main list as well:
7723 .code
7724 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
7725           an.other.domain ? ...
7726 .endd
7727 .next
7728 .cindex "asterisk" "in domain list"
7729 .cindex "domain list" "asterisk in"
7730 .cindex "domain list" "matching &""ends with""&"
7731 If a pattern starts with an asterisk, the remaining characters of the pattern
7732 are compared with the terminating characters of the domain. The use of &"*"& in
7733 domain lists differs from its use in partial matching lookups. In a domain
7734 list, the character following the asterisk need not be a dot, whereas partial
7735 matching works only in terms of dot-separated components. For example, a domain
7736 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
7737 &'cipher.key.ex'&.
7738
7739 .next
7740 .cindex "regular expressions" "in domain list"
7741 .cindex "domain list" "matching regular expression"
7742 If a pattern starts with a circumflex character, it is treated as a regular
7743 expression, and matched against the domain using a regular expression matching
7744 function. The circumflex is treated as part of the regular expression.
7745 Email domains are case-independent, so this regular expression match is by
7746 default case-independent, but you can make it case-dependent by starting it
7747 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
7748 are given in chapter &<<CHAPregexp>>&.
7749
7750 &*Warning*&: Because domain lists are expanded before being processed, you
7751 must escape any backslash and dollar characters in the regular expression, or
7752 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
7753 it is not to be expanded (unless you really do want to build a regular
7754 expression by expansion, of course).
7755 .next
7756 .cindex "lookup" "in domain list"
7757 .cindex "domain list" "matching by lookup"
7758 If a pattern starts with the name of a single-key lookup type followed by a
7759 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
7760 must be a file name in a suitable format for the lookup type. For example, for
7761 &"cdb;"& it must be an absolute path:
7762 .code
7763 domains = cdb;/etc/mail/local_domains.cdb
7764 .endd
7765 The appropriate type of lookup is done on the file using the domain name as the
7766 key. In most cases, the data that is looked up is not used; Exim is interested
7767 only in whether or not the key is present in the file. However, when a lookup
7768 is used for the &%domains%& option on a router
7769 or a &%domains%& condition in an ACL statement, the data is preserved in the
7770 &$domain_data$& variable and can be referred to in other router options or
7771 other statements in the same ACL.
7772
7773 .next
7774 Any of the single-key lookup type names may be preceded by
7775 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
7776 .code
7777 domains = partial-dbm;/partial/domains
7778 .endd
7779 This causes partial matching logic to be invoked; a description of how this
7780 works is given in section &<<SECTpartiallookup>>&.
7781
7782 .next
7783 .cindex "asterisk" "in lookup type"
7784 Any of the single-key lookup types may be followed by an asterisk. This causes
7785 a default lookup for a key consisting of a single asterisk to be done if the
7786 original lookup fails. This is not a useful feature when using a domain list to
7787 select particular domains (because any domain would match), but it might have
7788 value if the result of the lookup is being used via the &$domain_data$&
7789 expansion variable.
7790 .next
7791 If the pattern starts with the name of a query-style lookup type followed by a
7792 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
7793 pattern must be an appropriate query for the lookup type, as described in
7794 chapter &<<CHAPfdlookup>>&. For example:
7795 .code
7796 hold_domains = mysql;select domain from holdlist \
7797   where domain = '$domain';
7798 .endd
7799 In most cases, the data that is looked up is not used (so for an SQL query, for
7800 example, it doesn't matter what field you select). Exim is interested only in
7801 whether or not the query succeeds. However, when a lookup is used for the
7802 &%domains%& option on a router, the data is preserved in the &$domain_data$&
7803 variable and can be referred to in other options.
7804 .next
7805 .cindex "domain list" "matching literal domain name"
7806 If none of the above cases apply, a caseless textual comparison is made
7807 between the pattern and the domain.
7808 .endlist
7809
7810 Here is an example that uses several different kinds of pattern:
7811 .code
7812 domainlist funny_domains = \
7813   @ : \
7814   lib.unseen.edu : \
7815   *.foundation.fict.example : \
7816   \N^[1-2]\d{3}\.fict\.example$\N : \
7817   partial-dbm;/opt/data/penguin/book : \
7818   nis;domains.byname : \
7819   nisplus;[name=$domain,status=local],domains.org_dir
7820 .endd
7821 There are obvious processing trade-offs among the various matching modes. Using
7822 an asterisk is faster than a regular expression, and listing a few names
7823 explicitly probably is too. The use of a file or database lookup is expensive,
7824 but may be the only option if hundreds of names are required. Because the
7825 patterns are tested in order, it makes sense to put the most commonly matched
7826 patterns earlier.
7827
7828
7829
7830 .section "Host lists" "SECThostlist"
7831 .cindex "host list" "patterns in"
7832 .cindex "list" "host list"
7833 Host lists are used to control what remote hosts are allowed to do. For
7834 example, some hosts may be allowed to use the local host as a relay, and some
7835 may be permitted to use the SMTP ETRN command. Hosts can be identified in
7836 two different ways, by name or by IP address. In a host list, some types of
7837 pattern are matched to a host name, and some are matched to an IP address.
7838 You need to be particularly careful with this when single-key lookups are
7839 involved, to ensure that the right value is being used as the key.
7840
7841
7842 .section "Special host list patterns" "SECID80"
7843 .cindex "empty item in hosts list"
7844 .cindex "host list" "empty string in"
7845 If a host list item is the empty string, it matches only when no remote host is
7846 involved. This is the case when a message is being received from a local
7847 process using SMTP on the standard input, that is, when a TCP/IP connection is
7848 not used.
7849
7850 .cindex "asterisk" "in host list"
7851 The special pattern &"*"& in a host list matches any host or no host. Neither
7852 the IP address nor the name is actually inspected.
7853
7854
7855
7856 .section "Host list patterns that match by IP address" "SECThoslispatip"
7857 .cindex "host list" "matching IP addresses"
7858 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
7859 the incoming address actually appears in the IPv6 host as
7860 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
7861 list, it is converted into a traditional IPv4 address first. (Not all operating
7862 systems accept IPv4 calls on IPv6 sockets, as there have been some security
7863 concerns.)
7864
7865 The following types of pattern in a host list check the remote host by
7866 inspecting its IP address:
7867
7868 .ilist
7869 If the pattern is a plain domain name (not a regular expression, not starting
7870 with *, not a lookup of any kind), Exim calls the operating system function
7871 to find the associated IP address(es). Exim uses the newer
7872 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
7873 This typically causes a forward DNS lookup of the name. The result is compared
7874 with the IP address of the subject host.
7875
7876 If there is a temporary problem (such as a DNS timeout) with the host name
7877 lookup, a temporary error occurs. For example, if the list is being used in an
7878 ACL condition, the ACL gives a &"defer"& response, usually leading to a
7879 temporary SMTP error code. If no IP address can be found for the host name,
7880 what happens is described in section &<<SECTbehipnot>>& below.
7881
7882 .next
7883 .cindex "@ in a host list"
7884 If the pattern is &"@"&, the primary host name is substituted and used as a
7885 domain name, as just described.
7886
7887 .next
7888 If the pattern is an IP address, it is matched against the IP address of the
7889 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
7890 IPv6 addresses can be given in colon-separated format, but the colons have to
7891 be doubled so as not to be taken as item separators when the default list
7892 separator is used. IPv6 addresses are recognized even when Exim is compiled
7893 without IPv6 support. This means that if they appear in a host list on an
7894 IPv4-only host, Exim will not treat them as host names. They are just addresses
7895 that can never match a client host.
7896
7897 .next
7898 .cindex "@[] in a host list"
7899 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
7900 the local host. For example, if the local host is an IPv4 host with one
7901 interface address 10.45.23.56, these two ACL statements have the same effect:
7902 .code
7903 accept hosts = 127.0.0.1 : 10.45.23.56
7904 accept hosts = @[]
7905 .endd
7906 .next
7907 .cindex "CIDR notation"
7908 If the pattern is an IP address followed by a slash and a mask length (for
7909 example 10.11.42.0/24), it is matched against the IP address of the subject
7910 host under the given mask. This allows, an entire network of hosts to be
7911 included (or excluded) by a single item. The mask uses CIDR notation; it
7912 specifies the number of address bits that must match, starting from the most
7913 significant end of the address.
7914
7915 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
7916 of a range of addresses. It is the number of bits in the network portion of the
7917 address. The above example specifies a 24-bit netmask, so it matches all 256
7918 addresses in the 10.11.42.0 network. An item such as
7919 .code
7920 192.168.23.236/31
7921 .endd
7922 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
7923 32 for an IPv4 address is the same as no mask at all; just a single address
7924 matches.
7925
7926 Here is another example which shows an IPv4 and an IPv6 network:
7927 .code
7928 recipient_unqualified_hosts = 192.168.0.0/16: \
7929                               3ffe::ffff::836f::::/48
7930 .endd
7931 The doubling of list separator characters applies only when these items
7932 appear inline in a host list. It is not required when indirecting via a file.
7933 For example:
7934 .code
7935 recipient_unqualified_hosts = /opt/exim/unqualnets
7936 .endd
7937 could make use of a file containing
7938 .code
7939 172.16.0.0/12
7940 3ffe:ffff:836f::/48
7941 .endd
7942 to have exactly the same effect as the previous example. When listing IPv6
7943 addresses inline, it is usually more convenient to use the facility for
7944 changing separator characters. This list contains the same two networks:
7945 .code
7946 recipient_unqualified_hosts = <; 172.16.0.0/12; \
7947                                  3ffe:ffff:836f::/48
7948 .endd
7949 The separator is changed to semicolon by the leading &"<;"& at the start of the
7950 list.
7951 .endlist
7952
7953
7954
7955 .section "Host list patterns for single-key lookups by host address" &&&
7956          "SECThoslispatsikey"
7957 .cindex "host list" "lookup of IP address"
7958 When a host is to be identified by a single-key lookup of its complete IP
7959 address, the pattern takes this form:
7960 .display
7961 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
7962 .endd
7963 For example:
7964 .code
7965 hosts_lookup = net-cdb;/hosts-by-ip.db
7966 .endd
7967 The text form of the IP address of the subject host is used as the lookup key.
7968 IPv6 addresses are converted to an unabbreviated form, using lower case
7969 letters, with dots as separators because colon is the key terminator in
7970 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
7971 quoting the keys, but this is a facility that was added later.] The data
7972 returned by the lookup is not used.
7973
7974 .cindex "IP address" "masking"
7975 .cindex "host list" "masked IP address"
7976 Single-key lookups can also be performed using masked IP addresses, using
7977 patterns of this form:
7978 .display
7979 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
7980 .endd
7981 For example:
7982 .code
7983 net24-dbm;/networks.db
7984 .endd
7985 The IP address of the subject host is masked using <&'number'&> as the mask
7986 length. A textual string is constructed from the masked value, followed by the
7987 mask, and this is used as the lookup key. For example, if the host's IP address
7988 is 192.168.34.6, the key that is looked up for the above example is
7989 &"192.168.34.0/24"&.
7990
7991 When an IPv6 address is converted to a string, dots are normally used instead
7992 of colons, so that keys in &(lsearch)& files need not contain colons (which
7993 terminate &(lsearch)& keys). This was implemented some time before the ability
7994 to quote keys was made available in &(lsearch)& files. However, the more
7995 recently implemented &(iplsearch)& files do require colons in IPv6 keys
7996 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
7997 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
7998 converted using colons and not dots. In all cases, full, unabbreviated IPv6
7999 addresses are always used.
8000
8001 Ideally, it would be nice to tidy up this anomalous situation by changing to
8002 colons in all cases, given that quoting is now available for &(lsearch)&.
8003 However, this would be an incompatible change that might break some existing
8004 configurations.
8005
8006 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8007 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8008 the former case the key strings include the mask value, whereas in the latter
8009 case the IP address is used on its own.
8010
8011
8012
8013 .section "Host list patterns that match by host name" "SECThoslispatnam"
8014 .cindex "host" "lookup failures"
8015 .cindex "unknown host name"
8016 .cindex "host list" "matching host name"
8017 There are several types of pattern that require Exim to know the name of the
8018 remote host. These are either wildcard patterns or lookups by name. (If a
8019 complete hostname is given without any wildcarding, it is used to find an IP
8020 address to match against, as described in the section &<<SECThoslispatip>>&
8021 above.)
8022
8023 If the remote host name is not already known when Exim encounters one of these
8024 patterns, it has to be found from the IP address.
8025 Although many sites on the Internet are conscientious about maintaining reverse
8026 DNS data for their hosts, there are also many that do not do this.
8027 Consequently, a name cannot always be found, and this may lead to unwanted
8028 effects. Take care when configuring host lists with wildcarded name patterns.
8029 Consider what will happen if a name cannot be found.
8030
8031 Because of the problems of determining host names from IP addresses, matching
8032 against host names is not as common as matching against IP addresses.
8033
8034 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8035 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8036 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8037 are done can be changed by setting the &%host_lookup_order%& option. For
8038 security, once Exim has found one or more names, it looks up the IP addresses
8039 for these names and compares them with the IP address that it started with.
8040 Only those names whose IP addresses match are accepted. Any other names are
8041 discarded. If no names are left, Exim behaves as if the host name cannot be
8042 found. In the most common case there is only one name and one IP address.
8043
8044 There are some options that control what happens if a host name cannot be
8045 found. These are described in section &<<SECTbehipnot>>& below.
8046
8047 .cindex "host" "alias for"
8048 .cindex "alias for host"
8049 As a result of aliasing, hosts may have more than one name. When processing any
8050 of the following types of pattern, all the host's names are checked:
8051
8052 .ilist
8053 .cindex "asterisk" "in host list"
8054 If a pattern starts with &"*"& the remainder of the item must match the end of
8055 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8056 &'.b.c'&. This special simple form is provided because this is a very common
8057 requirement. Other kinds of wildcarding require the use of a regular
8058 expression.
8059 .next
8060 .cindex "regular expressions" "in host list"
8061 .cindex "host list" "regular expression in"
8062 If the item starts with &"^"& it is taken to be a regular expression which is
8063 matched against the host name. Host names are case-independent, so this regular
8064 expression match is by default case-independent, but you can make it
8065 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8066 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8067 example,
8068 .code
8069 ^(a|b)\.c\.d$
8070 .endd
8071 is a regular expression that matches either of the two hosts &'a.c.d'& or
8072 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8073 that backslash and dollar characters are not misinterpreted as part of the
8074 string expansion. The simplest way to do this is to use &`\N`& to mark that
8075 part of the string as non-expandable. For example:
8076 .code
8077 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8078 .endd
8079 &*Warning*&: If you want to match a complete host name, you must include the
8080 &`$`& terminating metacharacter in the regular expression, as in the above
8081 example. Without it, a match at the start of the host name is all that is
8082 required.
8083 .endlist
8084
8085
8086
8087
8088 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8089 .cindex "host" "lookup failures, permanent"
8090 While processing a host list, Exim may need to look up an IP address from a
8091 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8092 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8093 behaviour when it fails to find the information it is seeking is the same.
8094
8095 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8096 apply to temporary DNS errors, whose handling is described in the next section.
8097
8098 .cindex "&`+include_unknown`&"
8099 .cindex "&`+ignore_unknown`&"
8100 By default, Exim behaves as if the host does not match the list. This may not
8101 always be what you want to happen. To change Exim's behaviour, the special
8102 items &`+include_unknown`& or &`+ignore_unknown`& may appear in the list (at
8103 top level &-- they are not recognized in an indirected file).
8104
8105 .ilist
8106 If any item that follows &`+include_unknown`& requires information that
8107 cannot found, Exim behaves as if the host does match the list. For example,
8108 .code
8109 host_reject_connection = +include_unknown:*.enemy.ex
8110 .endd
8111 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8112 any hosts whose name it cannot find.
8113
8114 .next
8115 If any item that follows &`+ignore_unknown`& requires information that cannot
8116 be found, Exim ignores that item and proceeds to the rest of the list. For
8117 example:
8118 .code
8119 accept hosts = +ignore_unknown : friend.example : \
8120                192.168.4.5
8121 .endd
8122 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8123 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8124 name can be found for 192.168.4.5, it is rejected.
8125 .endlist
8126
8127 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8128 list. The effect of each one lasts until the next, or until the end of the
8129 list.
8130
8131
8132 .section "Temporary DNS errors when looking up host information" &&&
8133          "SECTtemdnserr"
8134 .cindex "host" "lookup failures, temporary"
8135 .cindex "&`+include_defer`&"
8136 .cindex "&`+ignore_defer`&"
8137 A temporary DNS lookup failure normally causes a defer action (except when
8138 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8139 host lists can include &`+ignore_defer`& and &`+include_defer`&, analagous to
8140 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8141 section. These options should be used with care, probably only in non-critical
8142 host lists such as whitelists.
8143
8144
8145
8146 .section "Host list patterns for single-key lookups by host name" &&&
8147          "SECThoslispatnamsk"
8148 .cindex "unknown host name"
8149 .cindex "host list" "matching host name"
8150 If a pattern is of the form
8151 .display
8152 <&'single-key-search-type'&>;<&'search-data'&>
8153 .endd
8154 for example
8155 .code
8156 dbm;/host/accept/list
8157 .endd
8158 a single-key lookup is performed, using the host name as its key. If the
8159 lookup succeeds, the host matches the item. The actual data that is looked up
8160 is not used.
8161
8162 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8163 keys in the file, not IP addresses. If you want to do lookups based on IP
8164 addresses, you must precede the search type with &"net-"& (see section
8165 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8166 two items in the same list, one doing an address lookup and one doing a name
8167 lookup, both using the same file.
8168
8169
8170
8171 .section "Host list patterns for query-style lookups" "SECID81"
8172 If a pattern is of the form
8173 .display
8174 <&'query-style-search-type'&>;<&'query'&>
8175 .endd
8176 the query is obeyed, and if it succeeds, the host matches the item. The actual
8177 data that is looked up is not used. The variables &$sender_host_address$& and
8178 &$sender_host_name$& can be used in the query. For example:
8179 .code
8180 hosts_lookup = pgsql;\
8181   select ip from hostlist where ip='$sender_host_address'
8182 .endd
8183 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8184 can use the &%sg%& expansion item to change this if you need to. If you want to
8185 use masked IP addresses in database queries, you can use the &%mask%& expansion
8186 operator.
8187
8188 If the query contains a reference to &$sender_host_name$&, Exim automatically
8189 looks up the host name if has not already done so. (See section
8190 &<<SECThoslispatnam>>& for comments on finding host names.)
8191
8192 Historical note: prior to release 4.30, Exim would always attempt to find a
8193 host name before running the query, unless the search type was preceded by
8194 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8195 still recognized for query-style lookups, but its presence or absence has no
8196 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8197 See section &<<SECThoslispatsikey>>&.)
8198
8199
8200
8201 .section "Mixing wildcarded host names and addresses in host lists" &&&
8202          "SECTmixwilhos"
8203 .cindex "host list" "mixing names and addresses in"
8204 If you have name lookups or wildcarded host names and IP addresses in the same
8205 host list, you should normally put the IP addresses first. For example, in an
8206 ACL you could have:
8207 .code
8208 accept hosts = 10.9.8.7 : *.friend.example
8209 .endd
8210 The reason for this lies in the left-to-right way that Exim processes lists.
8211 It can test IP addresses without doing any DNS lookups, but when it reaches an
8212 item that requires a host name, it fails if it cannot find a host name to
8213 compare with the pattern. If the above list is given in the opposite order, the
8214 &%accept%& statement fails for a host whose name cannot be found, even if its
8215 IP address is 10.9.8.7.
8216
8217 If you really do want to do the name check first, and still recognize the IP
8218 address, you can rewrite the ACL like this:
8219 .code
8220 accept hosts = *.friend.example
8221 accept hosts = 10.9.8.7
8222 .endd
8223 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8224 &<<CHAPACL>>& for details of ACLs.
8225
8226
8227
8228
8229
8230 .section "Address lists" "SECTaddresslist"
8231 .cindex "list" "address list"
8232 .cindex "address list" "empty item"
8233 .cindex "address list" "patterns"
8234 Address lists contain patterns that are matched against mail addresses. There
8235 is one special case to be considered: the sender address of a bounce message is
8236 always empty. You can test for this by providing an empty item in an address
8237 list. For example, you can set up a router to process bounce messages by
8238 using this option setting:
8239 .code
8240 senders = :
8241 .endd
8242 The presence of the colon creates an empty item. If you do not provide any
8243 data, the list is empty and matches nothing. The empty sender can also be
8244 detected by a regular expression that matches an empty string,
8245 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8246
8247 Non-empty items in an address list can be straightforward email addresses. For
8248 example:
8249 .code
8250 senders = jbc@askone.example : hs@anacreon.example
8251 .endd
8252 A certain amount of wildcarding is permitted. If a pattern contains an @
8253 character, but is not a regular expression and does not begin with a
8254 semicolon-terminated lookup type (described below), the local part of the
8255 subject address is compared with the local part of the pattern, which may start
8256 with an asterisk. If the local parts match, the domain is checked in exactly
8257 the same way as for a pattern in a domain list. For example, the domain can be
8258 wildcarded, refer to a named list, or be a lookup:
8259 .code
8260 deny senders = *@*.spamming.site:\
8261                *@+hostile_domains:\
8262                bozo@partial-lsearch;/list/of/dodgy/sites:\
8263                *@dbm;/bad/domains.db
8264 .endd
8265 .cindex "local part" "starting with !"
8266 .cindex "address list" "local part starting with !"
8267 If a local part that begins with an exclamation mark is required, it has to be
8268 specified using a regular expression, because otherwise the exclamation mark is
8269 treated as a sign of negation, as is standard in lists.
8270
8271 If a non-empty pattern that is not a regular expression or a lookup does not
8272 contain an @ character, it is matched against the domain part of the subject
8273 address. The only two formats that are recognized this way are a literal
8274 domain, or a domain pattern that starts with *. In both these cases, the effect
8275 is the same as if &`*@`& preceded the pattern. For example:
8276 .code
8277 deny senders = enemy.domain : *.enemy.domain
8278 .endd
8279
8280 The following kinds of more complicated address list pattern can match any
8281 address, including the empty address that is characteristic of bounce message
8282 senders:
8283
8284 .ilist
8285 .cindex "regular expressions" "in address list"
8286 .cindex "address list" "regular expression in"
8287 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8288 done against the complete address, with the pattern as the regular expression.
8289 You must take care that backslash and dollar characters are not misinterpreted
8290 as part of the string expansion. The simplest way to do this is to use &`\N`&
8291 to mark that part of the string as non-expandable. For example:
8292 .code
8293 deny senders = \N^.*this.*@example\.com$\N : \
8294                \N^\d{8}.+@spamhaus.example$\N : ...
8295 .endd
8296 The &`\N`& sequences are removed by the expansion, so these items do indeed
8297 start with &"^"& by the time they are being interpreted as address patterns.
8298
8299 .next
8300 .cindex "address list" "lookup for complete address"
8301 Complete addresses can be looked up by using a pattern that starts with a
8302 lookup type terminated by a semicolon, followed by the data for the lookup. For
8303 example:
8304 .code
8305 deny senders = cdb;/etc/blocked.senders : \
8306   mysql;select address from blocked where \
8307   address='${quote_mysql:$sender_address}'
8308 .endd
8309 Both query-style and single-key lookup types can be used. For a single-key
8310 lookup type, Exim uses the complete address as the key. However, empty keys are
8311 not supported for single-key lookups, so a match against the empty address
8312 always fails. This restriction does not apply to query-style lookups.
8313
8314 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8315 cannot be used, and is ignored if specified, with an entry being written to the
8316 panic log.
8317 .cindex "*@ with single-key lookup"
8318 However, you can configure lookup defaults, as described in section
8319 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8320 default. For example, with this lookup:
8321 .code
8322 accept senders = lsearch*@;/some/file
8323 .endd
8324 the file could contains lines like this:
8325 .code
8326 user1@domain1.example
8327 *@domain2.example
8328 .endd
8329 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8330 that are tried is:
8331 .code
8332 nimrod@jaeger.example
8333 *@jaeger.example
8334 *
8335 .endd
8336 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8337 would mean that every address matches, thus rendering the test useless.
8338
8339 &*Warning 2*&: Do not confuse these two kinds of item:
8340 .code
8341 deny recipients = dbm*@;/some/file
8342 deny recipients = *@dbm;/some/file
8343 .endd
8344 The first does a whole address lookup, with defaulting, as just described,
8345 because it starts with a lookup type. The second matches the local part and
8346 domain independently, as described in a bullet point below.
8347 .endlist
8348
8349
8350 The following kinds of address list pattern can match only non-empty addresses.
8351 If the subject address is empty, a match against any of these pattern types
8352 always fails.
8353
8354
8355 .ilist
8356 .cindex "@@ with single-key lookup"
8357 .cindex "address list" "@@ lookup type"
8358 .cindex "address list" "split local part and domain"
8359 If a pattern starts with &"@@"& followed by a single-key lookup item
8360 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8361 split into a local part and a domain. The domain is looked up in the file. If
8362 it is not found, there is no match. If it is found, the data that is looked up
8363 from the file is treated as a colon-separated list of local part patterns, each
8364 of which is matched against the subject local part in turn.
8365
8366 .cindex "asterisk" "in address list"
8367 The lookup may be a partial one, and/or one involving a search for a default
8368 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8369 patterns that are looked up can be regular expressions or begin with &"*"&, or
8370 even be further lookups. They may also be independently negated. For example,
8371 with
8372 .code
8373 deny senders = @@dbm;/etc/reject-by-domain
8374 .endd
8375 the data from which the DBM file is built could contain lines like
8376 .code
8377 baddomain.com:  !postmaster : *
8378 .endd
8379 to reject all senders except &%postmaster%& from that domain.
8380
8381 .cindex "local part" "starting with !"
8382 If a local part that actually begins with an exclamation mark is required, it
8383 has to be specified using a regular expression. In &(lsearch)& files, an entry
8384 may be split over several lines by indenting the second and subsequent lines,
8385 but the separating colon must still be included at line breaks. White space
8386 surrounding the colons is ignored. For example:
8387 .code
8388 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
8389 spammer3 : spammer4
8390 .endd
8391 As in all colon-separated lists in Exim, a colon can be included in an item by
8392 doubling.
8393
8394 If the last item in the list starts with a right angle-bracket, the remainder
8395 of the item is taken as a new key to look up in order to obtain a continuation
8396 list of local parts. The new key can be any sequence of characters. Thus one
8397 might have entries like
8398 .code
8399 aol.com: spammer1 : spammer 2 : >*
8400 xyz.com: spammer3 : >*
8401 *:       ^\d{8}$
8402 .endd
8403 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8404 local parts for all domains, in addition to the specific local parts listed for
8405 each domain. Of course, using this feature costs another lookup each time a
8406 chain is followed, but the effort needed to maintain the data is reduced.
8407
8408 .cindex "loop" "in lookups"
8409 It is possible to construct loops using this facility, and in order to catch
8410 them, the chains may be no more than fifty items long.
8411
8412 .next
8413 The @@<&'lookup'&> style of item can also be used with a query-style
8414 lookup, but in this case, the chaining facility is not available. The lookup
8415 can only return a single list of local parts.
8416 .endlist
8417
8418 &*Warning*&: There is an important difference between the address list items
8419 in these two examples:
8420 .code
8421 senders = +my_list
8422 senders = *@+my_list
8423 .endd
8424 In the first one, &`my_list`& is a named address list, whereas in the second
8425 example it is a named domain list.
8426
8427
8428
8429
8430 .section "Case of letters in address lists" "SECTcasletadd"
8431 .cindex "case of local parts"
8432 .cindex "address list" "case forcing"
8433 .cindex "case forcing in address lists"
8434 Domains in email addresses are always handled caselessly, but for local parts
8435 case may be significant on some systems (see &%caseful_local_part%& for how
8436 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8437 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8438 blocking lists should be done in a case-independent manner. Since most address
8439 lists in Exim are used for this kind of control, Exim attempts to do this by
8440 default.
8441
8442 The domain portion of an address is always lowercased before matching it to an
8443 address list. The local part is lowercased by default, and any string
8444 comparisons that take place are done caselessly. This means that the data in
8445 the address list itself, in files included as plain file names, and in any file
8446 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8447 keys in files that are looked up by a search type other than &(lsearch)& (which
8448 works caselessly) must be in lower case, because these lookups are not
8449 case-independent.
8450
8451 .cindex "&`+caseful`&"
8452 To allow for the possibility of caseful address list matching, if an item in
8453 an address list is the string &"+caseful"&, the original case of the local
8454 part is restored for any comparisons that follow, and string comparisons are no
8455 longer case-independent. This does not affect the domain, which remains in
8456 lower case. However, although independent matches on the domain alone are still
8457 performed caselessly, regular expressions that match against an entire address
8458 become case-sensitive after &"+caseful"& has been seen.
8459
8460
8461
8462 .section "Local part lists" "SECTlocparlis"
8463 .cindex "list" "local part list"
8464 .cindex "local part" "list"
8465 Case-sensitivity in local part lists is handled in the same way as for address
8466 lists, as just described. The &"+caseful"& item can be used if required. In a
8467 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
8468 set false, the subject is lowercased and the matching is initially
8469 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
8470 matching in the local part list, but not elsewhere in the router. If
8471 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
8472 option is case-sensitive from the start.
8473
8474 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
8475 comments are handled in the same way as address lists &-- they are recognized
8476 only if the # is preceded by white space or the start of the line.
8477 Otherwise, local part lists are matched in the same way as domain lists, except
8478 that the special items that refer to the local host (&`@`&, &`@[]`&,
8479 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
8480 Refer to section &<<SECTdomainlist>>& for details of the other available item
8481 types.
8482 .ecindex IIDdohoadli
8483
8484
8485
8486
8487 . ////////////////////////////////////////////////////////////////////////////
8488 . ////////////////////////////////////////////////////////////////////////////
8489
8490 .chapter "String expansions" "CHAPexpand"
8491 .scindex IIDstrexp "expansion" "of strings"
8492 Many strings in Exim's run time configuration are expanded before use. Some of
8493 them are expanded every time they are used; others are expanded only once.
8494
8495 When a string is being expanded it is copied verbatim from left to right except
8496 when a dollar or backslash character is encountered. A dollar specifies the
8497 start of a portion of the string that is interpreted and replaced as described
8498 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
8499 escape character, as described in the following section.
8500
8501
8502
8503 .section "Literal text in expanded strings" "SECTlittext"
8504 .cindex "expansion" "including literal text"
8505 An uninterpreted dollar can be included in an expanded string by putting a
8506 backslash in front of it. A backslash can be used to prevent any special
8507 character being treated specially in an expansion, including backslash itself.
8508 If the string appears in quotes in the configuration file, two backslashes are
8509 required because the quotes themselves cause interpretation of backslashes when
8510 the string is read in (see section &<<SECTstrings>>&).
8511
8512 .cindex "expansion" "non-expandable substrings"
8513 A portion of the string can specified as non-expandable by placing it between
8514 two occurrences of &`\N`&. This is particularly useful for protecting regular
8515 expressions, which often contain backslashes and dollar signs. For example:
8516 .code
8517 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
8518 .endd
8519 On encountering the first &`\N`&, the expander copies subsequent characters
8520 without interpretation until it reaches the next &`\N`& or the end of the
8521 string.
8522
8523
8524
8525 .section "Character escape sequences in expanded strings" "SECID82"
8526 .cindex "expansion" "escape sequences"
8527 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
8528 expanded string is recognized as an escape sequence for the character newline,
8529 carriage return, or tab, respectively. A backslash followed by up to three
8530 octal digits is recognized as an octal encoding for a single character, and a
8531 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
8532 encoding.
8533
8534 These escape sequences are also recognized in quoted strings when they are read
8535 in. Their interpretation in expansions as well is useful for unquoted strings,
8536 and for other cases such as looked-up strings that are then expanded.
8537
8538
8539 .section "Testing string expansions" "SECID83"
8540 .cindex "expansion" "testing"
8541 .cindex "testing" "string expansion"
8542 .oindex "&%-be%&"
8543 Many expansions can be tested by calling Exim with the &%-be%& option. This
8544 takes the command arguments, or lines from the standard input if there are no
8545 arguments, runs them through the string expansion code, and writes the results
8546 to the standard output. Variables based on configuration values are set up, but
8547 since no message is being processed, variables such as &$local_part$& have no
8548 value. Nevertheless the &%-be%& option can be useful for checking out file and
8549 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
8550 and &%nhash%&.
8551
8552 Exim gives up its root privilege when it is called with the &%-be%& option, and
8553 instead runs under the uid and gid it was called with, to prevent users from
8554 using &%-be%& for reading files to which they do not have access.
8555
8556 .oindex "&%-bem%&"
8557 If you want to test expansions that include variables whose values are taken
8558 from a message, there are two other options that can be used. The &%-bem%&
8559 option is like &%-be%& except that it is followed by a file name. The file is
8560 read as a message before doing the test expansions. For example:
8561 .code
8562 exim -bem /tmp/test.message '$h_subject:'
8563 .endd
8564 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
8565 Exim message identifier. For example:
8566 .code
8567 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
8568 .endd
8569 This loads the message from Exim's spool before doing the test expansions, and
8570 is therefore restricted to admin users.
8571
8572
8573 .section "Forced expansion failure" "SECTforexpfai"
8574 .cindex "expansion" "forced failure"
8575 A number of expansions that are described in the following section have
8576 alternative &"true"& and &"false"& substrings, enclosed in brace characters
8577 (which are sometimes called &"curly brackets"&). Which of the two strings is
8578 used depends on some condition that is evaluated as part of the expansion. If,
8579 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
8580 the entire string expansion fails in a way that can be detected by the code
8581 that requested the expansion. This is called &"forced expansion failure"&, and
8582 its consequences depend on the circumstances. In some cases it is no different
8583 from any other expansion failure, but in others a different action may be
8584 taken. Such variations are mentioned in the documentation of the option that is
8585 being expanded.
8586
8587
8588
8589
8590 .section "Expansion items" "SECTexpansionitems"
8591 The following items are recognized in expanded strings. White space may be used
8592 between sub-items that are keywords or substrings enclosed in braces inside an
8593 outer set of braces, to improve readability. &*Warning*&: Within braces,
8594 white space is significant.
8595
8596 .vlist
8597 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
8598 .cindex "expansion" "variables"
8599 Substitute the contents of the named variable, for example:
8600 .code
8601 $local_part
8602 ${domain}
8603 .endd
8604 The second form can be used to separate the name from subsequent alphanumeric
8605 characters. This form (using braces) is available only for variables; it does
8606 &'not'& apply to message headers. The names of the variables are given in
8607 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
8608 given, the expansion fails.
8609
8610 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
8611 .cindex "expansion" "operators"
8612 The string is first itself expanded, and then the operation specified by
8613 <&'op'&> is applied to it. For example:
8614 .code
8615 ${lc:$local_part}
8616 .endd
8617 The string starts with the first character after the colon, which may be
8618 leading white space. A list of operators is given in section &<<SECTexpop>>&
8619 below. The operator notation is used for simple expansion items that have just
8620 one argument, because it reduces the number of braces and therefore makes the
8621 string easier to understand.
8622
8623 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
8624 This item inserts &"basic"& header lines. It is described with the &%header%&
8625 expansion item below.
8626
8627 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
8628        {*&<&'arg'&>&*}...}*&"
8629 .cindex &%dlfunc%&
8630 This expansion dynamically loads and then calls a locally-written C function.
8631 This functionality is available only if Exim is compiled with
8632 .code
8633 EXPAND_DLFUNC=yes
8634 .endd
8635 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
8636 object so that it doesn't reload the same object file in the same Exim process
8637 (but of course Exim does start new processes frequently).
8638
8639 There may be from zero to eight arguments to the function. When compiling
8640 a local function that is to be called in this way, &_local_scan.h_& should be
8641 included. The Exim variables and functions that are defined by that API
8642 are also available for dynamically loaded functions. The function itself
8643 must have the following type:
8644 .code
8645 int dlfunction(uschar **yield, int argc, uschar *argv[])
8646 .endd
8647 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
8648 function should return one of the following values:
8649
8650 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
8651 into the expanded string that is being built.
8652
8653 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
8654 from &'yield'&, if it is set.
8655
8656 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
8657 taken from &'yield'& if it is set.
8658
8659 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
8660
8661 When compiling a function that is to be used in this way with gcc,
8662 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
8663 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
8664
8665 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
8666        {*&<&'string3'&>&*}}*&"
8667 .cindex "expansion" "extracting substrings by key"
8668 .cindex "&%extract%&" "substrings by key"
8669 The key and <&'string1'&> are first expanded separately. Leading and trailing
8670 white space is removed from the key (but not from any of the strings). The key
8671 must not consist entirely of digits. The expanded <&'string1'&> must be of the
8672 form:
8673 .display
8674 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
8675 .endd
8676 .vindex "&$value$&"
8677 where the equals signs and spaces (but not both) are optional. If any of the
8678 values contain white space, they must be enclosed in double quotes, and any
8679 values that are enclosed in double quotes are subject to escape processing as
8680 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
8681 for the value that corresponds to the key. The search is case-insensitive. If
8682 the key is found, <&'string2'&> is expanded, and replaces the whole item;
8683 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
8684 variable &$value$& contains the value that has been extracted. Afterwards, it
8685 is restored to any previous value it might have had.
8686
8687 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
8688 key is not found. If {<&'string2'&>} is also omitted, the value that was
8689 extracted is used. Thus, for example, these two expansions are identical, and
8690 yield &"2001"&:
8691 .code
8692 ${extract{gid}{uid=1984 gid=2001}}
8693 ${extract{gid}{uid=1984 gid=2001}{$value}}
8694 .endd
8695 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
8696 appear, for example:
8697 .code
8698 ${extract{Z}{A=... B=...}{$value} fail }
8699 .endd
8700 This forces an expansion failure (see section &<<SECTforexpfai>>&);
8701 {<&'string2'&>} must be present for &"fail"& to be recognized.
8702
8703
8704 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
8705         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
8706 .cindex "expansion" "extracting substrings by number"
8707 .cindex "&%extract%&" "substrings by number"
8708 The <&'number'&> argument must consist entirely of decimal digits,
8709 apart from leading and trailing white space, which is ignored.
8710 This is what distinguishes this form of &%extract%& from the previous kind. It
8711 behaves in the same way, except that, instead of extracting a named field, it
8712 extracts from <&'string1'&> the field whose number is given as the first
8713 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
8714 <&'string3'&> as before.
8715
8716 The fields in the string are separated by any one of the characters in the
8717 separator string. These may include space or tab characters.
8718 The first field is numbered one. If the number is negative, the fields are
8719 counted from the end of the string, with the rightmost one numbered -1. If the
8720 number given is zero, the entire string is returned. If the modulus of the
8721 number is greater than the number of fields in the string, the result is the
8722 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
8723 provided. For example:
8724 .code
8725 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
8726 .endd
8727 yields &"42"&, and
8728 .code
8729 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
8730 .endd
8731 yields &"99"&. Two successive separators mean that the field between them is
8732 empty (for example, the fifth field above).
8733
8734
8735 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
8736 .cindex "list" "selecting by condition"
8737 .cindex "expansion" "selecting from list by condition"
8738 .vindex "&$item$&"
8739 After expansion, <&'string'&> is interpreted as a list, colon-separated by
8740 default, but the separator can be changed in the usual way. For each item
8741 in this list, its value is place in &$item$&, and then the condition is
8742 evaluated. If the condition is true, &$item$& is added to the output as an
8743 item in a new list; if the condition is false, the item is discarded. The
8744 separator used for the output list is the same as the one used for the
8745 input, but a separator setting is not included in the output. For example:
8746 .code
8747 ${filter{a:b:c}{!eq{$item}{b}}
8748 .endd
8749 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
8750 to what it was before. See also the &*map*& and &*reduce*& expansion items.
8751
8752
8753 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
8754 .cindex "hash function" "textual"
8755 .cindex "expansion" "textual hash"
8756 This is a textual hashing function, and was the first to be implemented in
8757 early versions of Exim. In current releases, there are other hashing functions
8758 (numeric, MD5, and SHA-1), which are described below.
8759
8760 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
8761 <&'n'&>. If you are using fixed values for these numbers, that is, if
8762 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
8763 use the simpler operator notation that avoids some of the braces:
8764 .code
8765 ${hash_<n>_<m>:<string>}
8766 .endd
8767 The second number is optional (in both notations). If <&'n'&> is greater than
8768 or equal to the length of the string, the expansion item returns the string.
8769 Otherwise it computes a new string of length <&'n'&> by applying a hashing
8770 function to the string. The new string consists of characters taken from the
8771 first <&'m'&> characters of the string
8772 .code
8773 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
8774 .endd
8775 If <&'m'&> is not present the value 26 is used, so that only lower case
8776 letters appear. For example:
8777 .display
8778 &`$hash{3}{monty}}           `&   yields  &`jmg`&
8779 &`$hash{5}{monty}}           `&   yields  &`monty`&
8780 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
8781 .endd
8782
8783 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
8784         &*$h_*&<&'header&~name'&>&*:*&" &&&
8785        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
8786         &*$bh_*&<&'header&~name'&>&*:*&" &&&
8787        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
8788         &*$rh_*&<&'header&~name'&>&*:*&"
8789 .cindex "expansion" "header insertion"
8790 .vindex "&$header_$&"
8791 .vindex "&$bheader_$&"
8792 .vindex "&$rheader_$&"
8793 .cindex "header lines" "in expansion strings"
8794 .cindex "header lines" "character sets"
8795 .cindex "header lines" "decoding"
8796 Substitute the contents of the named message header line, for example
8797 .code
8798 $header_reply-to:
8799 .endd
8800 The newline that terminates a header line is not included in the expansion, but
8801 internal newlines (caused by splitting the header line over several physical
8802 lines) may be present.
8803
8804 The difference between &%rheader%&, &%bheader%&, and &%header%& is in the way
8805 the data in the header line is interpreted.
8806
8807 .ilist
8808 .cindex "white space" "in header lines"
8809 &%rheader%& gives the original &"raw"& content of the header line, with no
8810 processing at all, and without the removal of leading and trailing white space.
8811
8812 .next
8813 .cindex "base64 encoding" "in header lines"
8814 &%bheader%& removes leading and trailing white space, and then decodes base64
8815 or quoted-printable MIME &"words"& within the header text, but does no
8816 character set translation. If decoding of what looks superficially like a MIME
8817 &"word"& fails, the raw string is returned. If decoding
8818 .cindex "binary zero" "in header line"
8819 produces a binary zero character, it is replaced by a question mark &-- this is
8820 what Exim does for binary zeros that are actually received in header lines.
8821
8822 .next
8823 &%header%& tries to translate the string as decoded by &%bheader%& to a
8824 standard character set. This is an attempt to produce the same string as would
8825 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
8826 returned. Translation is attempted only on operating systems that support the
8827 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
8828 a system Makefile or in &_Local/Makefile_&.
8829 .endlist ilist
8830
8831 In a filter file, the target character set for &%header%& can be specified by a
8832 command of the following form:
8833 .code
8834 headers charset "UTF-8"
8835 .endd
8836 This command affects all references to &$h_$& (or &$header_$&) expansions in
8837 subsequently obeyed filter commands. In the absence of this command, the target
8838 character set in a filter is taken from the setting of the &%headers_charset%&
8839 option in the runtime configuration. The value of this option defaults to the
8840 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
8841 ISO-8859-1.
8842
8843 Header names follow the syntax of RFC 2822, which states that they may contain
8844 any printing characters except space and colon. Consequently, curly brackets
8845 &'do not'& terminate header names, and should not be used to enclose them as
8846 if they were variables. Attempting to do so causes a syntax error.
8847
8848 Only header lines that are common to all copies of a message are visible to
8849 this mechanism. These are the original header lines that are received with the
8850 message, and any that are added by an ACL statement or by a system
8851 filter. Header lines that are added to a particular copy of a message by a
8852 router or transport are not accessible.
8853
8854 For incoming SMTP messages, no header lines are visible in ACLs that are obeyed
8855 before the DATA ACL, because the header structure is not set up until the
8856 message is received. Header lines that are added in a RCPT ACL (for example)
8857 are saved until the message's incoming header lines are available, at which
8858 point they are added. When a DATA ACL is running, however, header lines added
8859 by earlier ACLs are visible.
8860
8861 Upper case and lower case letters are synonymous in header names. If the
8862 following character is white space, the terminating colon may be omitted, but
8863 this is not recommended, because you may then forget it when it is needed. When
8864 white space terminates the header name, it is included in the expanded string.
8865 If the message does not contain the given header, the expansion item is
8866 replaced by an empty string. (See the &%def%& condition in section
8867 &<<SECTexpcond>>& for a means of testing for the existence of a header.)
8868
8869 If there is more than one header with the same name, they are all concatenated
8870 to form the substitution string, up to a maximum length of 64K. Unless
8871 &%rheader%& is being used, leading and trailing white space is removed from
8872 each header before concatenation, and a completely empty header is ignored. A
8873 newline character is then inserted between non-empty headers, but there is no
8874 newline at the very end. For the &%header%& and &%bheader%& expansion, for
8875 those headers that contain lists of addresses, a comma is also inserted at the
8876 junctions between headers. This does not happen for the &%rheader%& expansion.
8877
8878
8879 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
8880 .cindex "expansion" "hmac hashing"
8881 .cindex &%hmac%&
8882 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
8883 shared secret and some text into a message authentication code, as specified in
8884 RFC 2104. This differs from &`${md5:secret_text...}`& or
8885 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
8886 cryptographic hash, allowing for authentication that is not possible with MD5
8887 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
8888 present. For example:
8889 .code
8890 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
8891 .endd
8892 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
8893 produces:
8894 .code
8895 dd97e3ba5d1a61b5006108f8c8252953
8896 .endd
8897 As an example of how this might be used, you might put in the main part of
8898 an Exim configuration:
8899 .code
8900 SPAMSCAN_SECRET=cohgheeLei2thahw
8901 .endd
8902 In a router or a transport you could then have:
8903 .code
8904 headers_add = \
8905   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
8906   ${hmac{md5}{SPAMSCAN_SECRET}\
8907   {${primary_hostname},${message_exim_id},$h_message-id:}}
8908 .endd
8909 Then given a message, you can check where it was scanned by looking at the
8910 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
8911 this header line is authentic by recomputing the authentication code from the
8912 host name, message ID and the &'Message-id:'& header line. This can be done
8913 using Exim's &%-be%& option, or by other means, for example by using the
8914 &'hmac_md5_hex()'& function in Perl.
8915
8916
8917 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
8918 .cindex "expansion" "conditional"
8919 .cindex "&%if%&, expansion item"
8920 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
8921 item; otherwise <&'string2'&> is used. The available conditions are described
8922 in section &<<SECTexpcond>>& below. For example:
8923 .code
8924 ${if eq {$local_part}{postmaster} {yes}{no} }
8925 .endd
8926 The second string need not be present; if it is not and the condition is not
8927 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
8928 be present instead of the second string (without any curly brackets). In this
8929 case, the expansion is forced to fail if the condition is not true (see section
8930 &<<SECTforexpfai>>&).
8931
8932 If both strings are omitted, the result is the string &`true`& if the condition
8933 is true, and the empty string if the condition is false. This makes it less
8934 cumbersome to write custom ACL and router conditions. For example, instead of
8935 .code
8936 condition = ${if >{$acl_m4}{3}{true}{false}}
8937 .endd
8938 you can use
8939 .code
8940 condition = ${if >{$acl_m4}{3}}
8941 .endd
8942
8943 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
8944 .cindex "expansion" "string truncation"
8945 .cindex "&%length%& expansion item"
8946 The &%length%& item is used to extract the initial portion of a string. Both
8947 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
8948 you are using a fixed value for the number, that is, if <&'string1'&> does not
8949 change when expanded, you can use the simpler operator notation that avoids
8950 some of the braces:
8951 .code
8952 ${length_<n>:<string>}
8953 .endd
8954 The result of this item is either the first <&'n'&> characters or the whole
8955 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
8956 &%strlen%&, which gives the length of a string.
8957
8958
8959 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
8960         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
8961 This is the first of one of two different types of lookup item, which are both
8962 described in the next item.
8963
8964 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
8965         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
8966 .cindex "expansion" "lookup in"
8967 .cindex "file" "lookups"
8968 .cindex "lookup" "in expanded string"
8969 The two forms of lookup item specify data lookups in files and databases, as
8970 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
8971 lookups, and the second is used for query-style lookups. The <&'key'&>,
8972 <&'file'&>, and <&'query'&> strings are expanded before use.
8973
8974 If there is any white space in a lookup item which is part of a filter command,
8975 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
8976 other place where white space is significant, the lookup item must be enclosed
8977 in double quotes. The use of data lookups in users' filter files may be locked
8978 out by the system administrator.
8979
8980 .vindex "&$value$&"
8981 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
8982 During its expansion, the variable &$value$& contains the data returned by the
8983 lookup. Afterwards it reverts to the value it had previously (at the outer
8984 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
8985 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
8986 string on failure. If <&'string2'&> is provided, it can itself be a nested
8987 lookup, thus providing a mechanism for looking up a default value when the
8988 original lookup fails.
8989
8990 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
8991 data for the outer lookup while the parameters of the second lookup are
8992 expanded, and also while <&'string2'&> of the second lookup is expanded, should
8993 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
8994 appear, and in this case, if the lookup fails, the entire expansion is forced
8995 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
8996 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
8997 successful lookup, and nothing in the case of failure.
8998
8999 For single-key lookups, the string &"partial"& is permitted to precede the
9000 search type in order to do partial matching, and * or *@ may follow a search
9001 type to request default lookups if the key does not match (see sections
9002 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9003
9004 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9005 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9006 and non-wild parts of the key during the expansion of the replacement text.
9007 They return to their previous values at the end of the lookup item.
9008
9009 This example looks up the postmaster alias in the conventional alias file:
9010 .code
9011 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9012 .endd
9013 This example uses NIS+ to look up the full name of the user corresponding to
9014 the local part of an address, forcing the expansion to fail if it is not found:
9015 .code
9016 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9017   {$value}fail}
9018 .endd
9019
9020
9021 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9022 .cindex "expansion" "list creation"
9023 .vindex "&$item$&"
9024 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9025 default, but the separator can be changed in the usual way. For each item
9026 in this list, its value is place in &$item$&, and then <&'string2'&> is
9027 expanded and added to the output as an item in a new list. The separator used
9028 for the output list is the same as the one used for the input, but a separator
9029 setting is not included in the output. For example:
9030 .code
9031 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
9032 .endd
9033 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
9034 value of &$item$& is restored to what it was before. See also the &*filter*&
9035 and &*reduce*& expansion items.
9036
9037 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9038 .cindex "expansion" "numeric hash"
9039 .cindex "hash function" "numeric"
9040 The three strings are expanded; the first two must yield numbers. Call them
9041 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9042 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9043 can use the simpler operator notation that avoids some of the braces:
9044 .code
9045 ${nhash_<n>_<m>:<string>}
9046 .endd
9047 The second number is optional (in both notations). If there is only one number,
9048 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
9049 processed by a div/mod hash function that returns two numbers, separated by a
9050 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
9051 example,
9052 .code
9053 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
9054 .endd
9055 returns the string &"6/33"&.
9056
9057
9058
9059 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
9060 .cindex "Perl" "use in expanded string"
9061 .cindex "expansion" "calling Perl from"
9062 This item is available only if Exim has been built to include an embedded Perl
9063 interpreter. The subroutine name and the arguments are first separately
9064 expanded, and then the Perl subroutine is called with those arguments. No
9065 additional arguments need be given; the maximum number permitted, including the
9066 name of the subroutine, is nine.
9067
9068 The return value of the subroutine is inserted into the expanded string, unless
9069 the return value is &%undef%&. In that case, the expansion fails in the same
9070 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
9071 Whatever you return is evaluated in a scalar context. For example, if you
9072 return the name of a Perl vector, the return value is the size of the vector,
9073 not its contents.
9074
9075 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
9076 with the error message that was passed to &%die%&. More details of the embedded
9077 Perl facility are given in chapter &<<CHAPperl>>&.
9078
9079 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
9080 out the use of this expansion item in filter files.
9081
9082
9083 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9084 .cindex "&%prvs%& expansion item"
9085 The first argument is a complete email address and the second is secret
9086 keystring. The third argument, specifying a key number, is optional. If absent,
9087 it defaults to 0. The result of the expansion is a prvs-signed email address,
9088 to be typically used with the &%return_path%& option on an &(smtp)& transport
9089 as part of a bounce address tag validation (BATV) scheme. For more discussion
9090 and an example, see section &<<SECTverifyPRVS>>&.
9091
9092 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
9093         {*&<&'string'&>&*}}*&"
9094 .cindex "&%prvscheck%& expansion item"
9095 This expansion item is the complement of the &%prvs%& item. It is used for
9096 checking prvs-signed addresses. If the expansion of the first argument does not
9097 yield a syntactically valid prvs-signed address, the whole item expands to the
9098 empty string. When the first argument does expand to a syntactically valid
9099 prvs-signed address, the second argument is expanded, with the prvs-decoded
9100 version of the address and the key number extracted from the address in the
9101 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9102
9103 These two variables can be used in the expansion of the second argument to
9104 retrieve the secret. The validity of the prvs-signed address is then checked
9105 against the secret. The result is stored in the variable &$prvscheck_result$&,
9106 which is empty for failure or &"1"& for success.
9107
9108 The third argument is optional; if it is missing, it defaults to an empty
9109 string. This argument is now expanded. If the result is an empty string, the
9110 result of the expansion is the decoded version of the address. This is the case
9111 whether or not the signature was valid. Otherwise, the result of the expansion
9112 is the expansion of the third argument.
9113
9114 All three variables can be used in the expansion of the third argument.
9115 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9116 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9117
9118 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9119 .cindex "expansion" "inserting an entire file"
9120 .cindex "file" "inserting into expansion"
9121 .cindex "&%readfile%& expansion item"
9122 The file name and end-of-line string are first expanded separately. The file is
9123 then read, and its contents replace the entire item. All newline characters in
9124 the file are replaced by the end-of-line string if it is present. Otherwise,
9125 newlines are left in the string.
9126 String expansion is not applied to the contents of the file. If you want this,
9127 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9128 the string expansion fails.
9129
9130 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9131 locks out the use of this expansion item in filter files.
9132
9133
9134
9135 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9136         {*&<&'timeout'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9137 .cindex "expansion" "inserting from a socket"
9138 .cindex "socket, use of in expansion"
9139 .cindex "&%readsocket%& expansion item"
9140 This item inserts data from a Unix domain or Internet socket into the expanded
9141 string. The minimal way of using it uses just two arguments, as in these
9142 examples:
9143 .code
9144 ${readsocket{/socket/name}{request string}}
9145 ${readsocket{inet:some.host:1234}{request string}}
9146 .endd
9147 For a Unix domain socket, the first substring must be the path to the socket.
9148 For an Internet socket, the first substring must contain &`inet:`& followed by
9149 a host name or IP address, followed by a colon and a port, which can be a
9150 number or the name of a TCP port in &_/etc/services_&. An IP address may
9151 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9152 example:
9153 .code
9154 ${readsocket{inet:[::1]:1234}{request string}}
9155 .endd
9156 Only a single host name may be given, but if looking it up yields more than
9157 one IP address, they are each tried in turn until a connection is made. For
9158 both kinds of socket, Exim makes a connection, writes the request string
9159 (unless it is an empty string) and reads from the socket until an end-of-file
9160 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9161 extend what can be done. Firstly, you can vary the timeout. For example:
9162 .code
9163 ${readsocket{/socket/name}{request string}{3s}}
9164 .endd
9165 A fourth argument allows you to change any newlines that are in the data
9166 that is read, in the same way as for &%readfile%& (see above). This example
9167 turns them into spaces:
9168 .code
9169 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9170 .endd
9171 As with all expansions, the substrings are expanded before the processing
9172 happens. Errors in these sub-expansions cause the expansion to fail. In
9173 addition, the following errors can occur:
9174
9175 .ilist
9176 Failure to create a socket file descriptor;
9177 .next
9178 Failure to connect the socket;
9179 .next
9180 Failure to write the request string;
9181 .next
9182 Timeout on reading from the socket.
9183 .endlist
9184
9185 By default, any of these errors causes the expansion to fail. However, if
9186 you supply a fifth substring, it is expanded and used when any of the above
9187 errors occurs. For example:
9188 .code
9189 ${readsocket{/socket/name}{request string}{3s}{\n}\
9190   {socket failure}}
9191 .endd
9192 You can test for the existence of a Unix domain socket by wrapping this
9193 expansion in &`${if exists`&, but there is a race condition between that test
9194 and the actual opening of the socket, so it is safer to use the fifth argument
9195 if you want to be absolutely sure of avoiding an expansion error for a
9196 non-existent Unix domain socket, or a failure to connect to an Internet socket.
9197
9198 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
9199 locks out the use of this expansion item in filter files.
9200
9201
9202 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9203 .cindex "expansion" "reducing a list to a scalar"
9204 .cindex "list" "reducing to a scalar"
9205 .vindex "&$value$&"
9206 .vindex "&$item$&"
9207 This operation reduces a list to a single, scalar string. After expansion,
9208 <&'string1'&> is interpreted as a list, colon-separated by default, but the
9209 separator can be changed in the usual way. Then <&'string2'&> is expanded and
9210 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
9211 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
9212 them. The result of that expansion is assigned to &$value$& before the next
9213 iteration. When the end of the list is reached, the final value of &$value$& is
9214 added to the expansion output. The &*reduce*& expansion item can be used in a
9215 number of ways. For example, to add up a list of numbers:
9216 .code
9217 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
9218 .endd
9219 The result of that expansion would be &`6`&. The maximum of a list of numbers
9220 can be found:
9221 .code
9222 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
9223 .endd
9224 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
9225 restored to what they were before. See also the &*filter*& and &*map*&
9226 expansion items.
9227
9228 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
9229 This item inserts &"raw"& header lines. It is described with the &%header%&
9230 expansion item above.
9231
9232 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
9233         {*&<&'string2'&>&*}}*&"
9234 .cindex "expansion" "running a command"
9235 .cindex "&%run%& expansion item"
9236 The command and its arguments are first expanded separately, and then the
9237 command is run in a separate process, but under the same uid and gid. As in
9238 other command executions from Exim, a shell is not used by default. If you want
9239 a shell, you must explicitly code it.
9240
9241 The standard input for the command exists, but is empty. The standard output
9242 and standard error are set to the same file descriptor.
9243 .cindex "return code" "from &%run%& expansion"
9244 .vindex "&$value$&"
9245 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
9246 and replaces the entire item; during this expansion, the standard output/error
9247 from the command is in the variable &$value$&. If the command fails,
9248 <&'string2'&>, if present, is expanded and used. Once again, during the
9249 expansion, the standard output/error from the command is in the variable
9250 &$value$&.
9251
9252 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
9253 can be the word &"fail"& (not in braces) to force expansion failure if the
9254 command does not succeed. If both strings are omitted, the result is contents
9255 of the standard output/error on success, and nothing on failure.
9256
9257 .vindex "&$runrc$&"
9258 The return code from the command is put in the variable &$runrc$&, and this
9259 remains set afterwards, so in a filter file you can do things like this:
9260 .code
9261 if "${run{x y z}{}}$runrc" is 1 then ...
9262   elif $runrc is 2 then ...
9263   ...
9264 endif
9265 .endd
9266 If execution of the command fails (for example, the command does not exist),
9267 the return code is 127 &-- the same code that shells use for non-existent
9268 commands.
9269
9270 &*Warning*&: In a router or transport, you cannot assume the order in which
9271 option values are expanded, except for those preconditions whose order of
9272 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
9273 by the expansion of one option, and use it in another.
9274
9275 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
9276 out the use of this expansion item in filter files.
9277
9278
9279 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
9280 .cindex "expansion" "string substitution"
9281 .cindex "&%sg%& expansion item"
9282 This item works like Perl's substitution operator (s) with the global (/g)
9283 option; hence its name. However, unlike the Perl equivalent, Exim does not
9284 modify the subject string; instead it returns the modified string for insertion
9285 into the overall expansion. The item takes three arguments: the subject string,
9286 a regular expression, and a substitution string. For example:
9287 .code
9288 ${sg{abcdefabcdef}{abc}{xyz}}
9289 .endd
9290 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
9291 if any $ or \ characters are required in the regular expression or in the
9292 substitution string, they have to be escaped. For example:
9293 .code
9294 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
9295 .endd
9296 yields &"defabc"&, and
9297 .code
9298 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
9299 .endd
9300 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
9301 the regular expression from string expansion.
9302
9303
9304
9305 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9306 .cindex "&%substr%& expansion item"
9307 .cindex "substring extraction"
9308 .cindex "expansion" "substring extraction"
9309 The three strings are expanded; the first two must yield numbers. Call them
9310 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9311 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9312 can use the simpler operator notation that avoids some of the braces:
9313 .code
9314 ${substr_<n>_<m>:<string>}
9315 .endd
9316 The second number is optional (in both notations).
9317 If it is absent in the simpler format, the preceding underscore must also be
9318 omitted.
9319
9320 The &%substr%& item can be used to extract more general substrings than
9321 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
9322 length required. For example
9323 .code
9324 ${substr{3}{2}{$local_part}}
9325 .endd
9326 If the starting offset is greater than the string length the result is the
9327 null string; if the length plus starting offset is greater than the string
9328 length, the result is the right-hand part of the string, starting from the
9329 given offset. The first character in the string has offset zero.
9330
9331 The &%substr%& expansion item can take negative offset values to count
9332 from the right-hand end of its operand. The last character is offset -1, the
9333 second-last is offset -2, and so on. Thus, for example,
9334 .code
9335 ${substr{-5}{2}{1234567}}
9336 .endd
9337 yields &"34"&. If the absolute value of a negative offset is greater than the
9338 length of the string, the substring starts at the beginning of the string, and
9339 the length is reduced by the amount of overshoot. Thus, for example,
9340 .code
9341 ${substr{-5}{2}{12}}
9342 .endd
9343 yields an empty string, but
9344 .code
9345 ${substr{-3}{2}{12}}
9346 .endd
9347 yields &"1"&.
9348
9349 When the second number is omitted from &%substr%&, the remainder of the string
9350 is taken if the offset is positive. If it is negative, all characters in the
9351 string preceding the offset point are taken. For example, an offset of -1 and
9352 no length, as in these semantically identical examples:
9353 .code
9354 ${substr_-1:abcde}
9355 ${substr{-1}{abcde}}
9356 .endd
9357 yields all but the last character of the string, that is, &"abcd"&.
9358
9359
9360
9361 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
9362         {*&<&'replacements'&>&*}}*&"
9363 .cindex "expansion" "character translation"
9364 .cindex "&%tr%& expansion item"
9365 This item does single-character translation on its subject string. The second
9366 argument is a list of characters to be translated in the subject string. Each
9367 matching character is replaced by the corresponding character from the
9368 replacement list. For example
9369 .code
9370 ${tr{abcdea}{ac}{13}}
9371 .endd
9372 yields &`1b3de1`&. If there are duplicates in the second character string, the
9373 last occurrence is used. If the third string is shorter than the second, its
9374 last character is replicated. However, if it is empty, no translation takes
9375 place.
9376 .endlist
9377
9378
9379
9380 .section "Expansion operators" "SECTexpop"
9381 .cindex "expansion" "operators"
9382 For expansion items that perform transformations on a single argument string,
9383 the &"operator"& notation is used because it is simpler and uses fewer braces.
9384 The substring is first expanded before the operation is applied to it. The
9385 following operations can be performed:
9386
9387 .vlist
9388 .vitem &*${address:*&<&'string'&>&*}*&
9389 .cindex "expansion" "RFC 2822 address handling"
9390 .cindex "&%address%& expansion item"
9391 The string is interpreted as an RFC 2822 address, as it might appear in a
9392 header line, and the effective address is extracted from it. If the string does
9393 not parse successfully, the result is empty.
9394
9395
9396 .vitem &*${addresses:*&<&'string'&>&*}*&
9397 .cindex "expansion" "RFC 2822 address handling"
9398 .cindex "&%addresses%& expansion item"
9399 The string (after expansion) is interpreted as a list of addresses in RFC
9400 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
9401 operative address (&'local-part@domain'&) is extracted from each item, and the
9402 result of the expansion is a colon-separated list, with appropriate
9403 doubling of colons should any happen to be present in the email addresses.
9404 Syntactically invalid RFC2822 address items are omitted from the output.
9405
9406 It is possible to specify a character other than colon for the output
9407 separator by starting the string with > followed by the new separator
9408 character. For example:
9409 .code
9410 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
9411 .endd
9412 expands to &`ceo@up.stairs&&sec@base.ment`&. Compare the &*address*& (singular)
9413 expansion item, which extracts the working address from a single RFC2822
9414 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
9415 processing lists.
9416
9417
9418 .vitem &*${base62:*&<&'digits'&>&*}*&
9419 .cindex "&%base62%& expansion item"
9420 .cindex "expansion" "conversion to base 62"
9421 The string must consist entirely of decimal digits. The number is converted to
9422 base 62 and output as a string of six characters, including leading zeros. In
9423 the few operating environments where Exim uses base 36 instead of base 62 for
9424 its message identifiers (because those systems do not have case-sensitive file
9425 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
9426 be absolutely clear: this is &'not'& base64 encoding.
9427
9428 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
9429 .cindex "&%base62d%& expansion item"
9430 .cindex "expansion" "conversion to base 62"
9431 The string must consist entirely of base-62 digits, or, in operating
9432 environments where Exim uses base 36 instead of base 62 for its message
9433 identifiers, base-36 digits. The number is converted to decimal and output as a
9434 string.
9435
9436 .vitem &*${domain:*&<&'string'&>&*}*&
9437 .cindex "domain" "extraction"
9438 .cindex "expansion" "domain extraction"
9439 The string is interpreted as an RFC 2822 address and the domain is extracted
9440 from it. If the string does not parse successfully, the result is empty.
9441
9442
9443 .vitem &*${escape:*&<&'string'&>&*}*&
9444 .cindex "expansion" "escaping non-printing characters"
9445 .cindex "&%escape%& expansion item"
9446 If the string contains any non-printing characters, they are converted to
9447 escape sequences starting with a backslash. Whether characters with the most
9448 significant bit set (so-called &"8-bit characters"&) count as printing or not
9449 is controlled by the &%print_topbitchars%& option.
9450
9451
9452 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
9453 .cindex "expansion" "expression evaluation"
9454 .cindex "expansion" "arithmetic expression"
9455 .cindex "&%eval%& expansion item"
9456 These items supports simple arithmetic and bitwise logical operations in
9457 expansion strings. The string (after expansion) must be a conventional
9458 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
9459 logical operators, and parentheses. All operations are carried out using
9460 integer arithmetic. The operator priorities are as follows (the same as in the
9461 C programming language):
9462 .table2 70pt 300pt
9463 .irow &'highest:'& "not (~), negate (-)"
9464 .irow ""   "multiply (*), divide (/), remainder (%)"
9465 .irow ""   "plus (+), minus (-)"
9466 .irow ""   "shift-left (<<), shift-right (>>)"
9467 .irow ""   "and (&&)"
9468 .irow ""   "xor (^)"
9469 .irow &'lowest:'&  "or (|)"
9470 .endtable
9471 Binary operators with the same priority are evaluated from left to right. White
9472 space is permitted before or after operators.
9473
9474 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
9475 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
9476 decimal, even if they start with a leading zero; hexadecimal numbers are not
9477 permitted. This can be useful when processing numbers extracted from dates or
9478 times, which often do have leading zeros.
9479
9480 A number may be followed by &"K"& or &"M"& to multiply it by 1024 or 1024*1024,
9481 respectively. Negative numbers are supported. The result of the computation is
9482 a decimal representation of the answer (without &"K"& or &"M"&). For example:
9483
9484 .display
9485 &`${eval:1+1}            `&  yields 2
9486 &`${eval:1+2*3}          `&  yields 7
9487 &`${eval:(1+2)*3}        `&  yields 9
9488 &`${eval:2+42%5}         `&  yields 4
9489 &`${eval:0xc&amp;5}          `&  yields 4
9490 &`${eval:0xc|5}          `&  yields 13
9491 &`${eval:0xc^5}          `&  yields 9
9492 &`${eval:0xc>>1}         `&  yields 6
9493 &`${eval:0xc<<1}         `&  yields 24
9494 &`${eval:~255&amp;0x1234}    `&  yields 4608
9495 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
9496 .endd
9497
9498 As a more realistic example, in an ACL you might have
9499 .code
9500 deny   message = Too many bad recipients
9501        condition =                    \
9502          ${if and {                   \
9503            {>{$rcpt_count}{10}}       \
9504            {                          \
9505            <                          \
9506              {$recipients_count}      \
9507              {${eval:$rcpt_count/2}}  \
9508            }                          \
9509          }{yes}{no}}
9510 .endd
9511 The condition is true if there have been more than 10 RCPT commands and
9512 fewer than half of them have resulted in a valid recipient.
9513
9514
9515 .vitem &*${expand:*&<&'string'&>&*}*&
9516 .cindex "expansion" "re-expansion of substring"
9517 The &%expand%& operator causes a string to be expanded for a second time. For
9518 example,
9519 .code
9520 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
9521 .endd
9522 first looks up a string in a file while expanding the operand for &%expand%&,
9523 and then re-expands what it has found.
9524
9525
9526 .vitem &*${from_utf8:*&<&'string'&>&*}*&
9527 .cindex "Unicode"
9528 .cindex "UTF-8" "conversion from"
9529 .cindex "expansion" "UTF-8 conversion"
9530 .cindex "&%from_utf8%& expansion item"
9531 The world is slowly moving towards Unicode, although there are no standards for
9532 email yet. However, other applications (including some databases) are starting
9533 to store data in Unicode, using UTF-8 encoding. This operator converts from a
9534 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
9535 converted to underscores. The input must be a valid UTF-8 string. If it is not,
9536 the result is an undefined sequence of bytes.
9537
9538 Unicode code points with values less than 256 are compatible with ASCII and
9539 ISO-8859-1 (also known as Latin-1).
9540 For example, character 169 is the copyright symbol in both cases, though the
9541 way it is encoded is different. In UTF-8, more than one byte is needed for
9542 characters with code values greater than 127, whereas ISO-8859-1 is a
9543 single-byte encoding (but thereby limited to 256 characters). This makes
9544 translation from UTF-8 to ISO-8859-1 straightforward.
9545
9546
9547 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
9548 .cindex "hash function" "textual"
9549 .cindex "expansion" "textual hash"
9550 The &%hash%& operator is a simpler interface to the hashing function that can
9551 be used when the two parameters are fixed numbers (as opposed to strings that
9552 change when expanded). The effect is the same as
9553 .code
9554 ${hash{<n>}{<m>}{<string>}}
9555 .endd
9556 See the description of the general &%hash%& item above for details. The
9557 abbreviation &%h%& can be used when &%hash%& is used as an operator.
9558
9559
9560
9561 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
9562 .cindex "base64 encoding" "conversion from hex"
9563 .cindex "expansion" "hex to base64"
9564 .cindex "&%hex2b64%& expansion item"
9565 This operator converts a hex string into one that is base64 encoded. This can
9566 be useful for processing the output of the MD5 and SHA-1 hashing functions.
9567
9568
9569 .vitem &*${lc:*&<&'string'&>&*}*&
9570 .cindex "case forcing in strings"
9571 .cindex "string" "case forcing"
9572 .cindex "lower casing"
9573 .cindex "expansion" "case forcing"
9574 .cindex "&%lc%& expansion item"
9575 This forces the letters in the string into lower-case, for example:
9576 .code
9577 ${lc:$local_part}
9578 .endd
9579
9580 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
9581 .cindex "expansion" "string truncation"
9582 .cindex "&%length%& expansion item"
9583 The &%length%& operator is a simpler interface to the &%length%& function that
9584 can be used when the parameter is a fixed number (as opposed to a string that
9585 changes when expanded). The effect is the same as
9586 .code
9587 ${length{<number>}{<string>}}
9588 .endd
9589 See the description of the general &%length%& item above for details. Note that
9590 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
9591 when &%length%& is used as an operator.
9592
9593
9594 .vitem &*${local_part:*&<&'string'&>&*}*&
9595 .cindex "expansion" "local part extraction"
9596 .cindex "&%local_part%& expansion item"
9597 The string is interpreted as an RFC 2822 address and the local part is
9598 extracted from it. If the string does not parse successfully, the result is
9599 empty.
9600
9601
9602 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
9603 .cindex "masked IP address"
9604 .cindex "IP address" "masking"
9605 .cindex "CIDR notation"
9606 .cindex "expansion" "IP address masking"
9607 .cindex "&%mask%& expansion item"
9608 If the form of the string to be operated on is not an IP address followed by a
9609 slash and an integer (that is, a network address in CIDR notation), the
9610 expansion fails. Otherwise, this operator converts the IP address to binary,
9611 masks off the least significant bits according to the bit count, and converts
9612 the result back to text, with mask appended. For example,
9613 .code
9614 ${mask:10.111.131.206/28}
9615 .endd
9616 returns the string &"10.111.131.192/28"&. Since this operation is expected to
9617 be mostly used for looking up masked addresses in files, the result for an IPv6
9618 address uses dots to separate components instead of colons, because colon
9619 terminates a key string in lsearch files. So, for example,
9620 .code
9621 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
9622 .endd
9623 returns the string
9624 .code
9625 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
9626 .endd
9627 Letters in IPv6 addresses are always output in lower case.
9628
9629
9630 .vitem &*${md5:*&<&'string'&>&*}*&
9631 .cindex "MD5 hash"
9632 .cindex "expansion" "MD5 hash"
9633 .cindex "&%md5%& expansion item"
9634 The &%md5%& operator computes the MD5 hash value of the string, and returns it
9635 as a 32-digit hexadecimal number, in which any letters are in lower case.
9636
9637
9638 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
9639 .cindex "expansion" "numeric hash"
9640 .cindex "hash function" "numeric"
9641 The &%nhash%& operator is a simpler interface to the numeric hashing function
9642 that can be used when the two parameters are fixed numbers (as opposed to
9643 strings that change when expanded). The effect is the same as
9644 .code
9645 ${nhash{<n>}{<m>}{<string>}}
9646 .endd
9647 See the description of the general &%nhash%& item above for details.
9648
9649
9650 .vitem &*${quote:*&<&'string'&>&*}*&
9651 .cindex "quoting" "in string expansions"
9652 .cindex "expansion" "quoting"
9653 .cindex "&%quote%& expansion item"
9654 The &%quote%& operator puts its argument into double quotes if it
9655 is an empty string or
9656 contains anything other than letters, digits, underscores, dots, and hyphens.
9657 Any occurrences of double quotes and backslashes are escaped with a backslash.
9658 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
9659 respectively For example,
9660 .code
9661 ${quote:ab"*"cd}
9662 .endd
9663 becomes
9664 .code
9665 "ab\"*\"cd"
9666 .endd
9667 The place where this is useful is when the argument is a substitution from a
9668 variable or a message header.
9669
9670 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
9671 .cindex "&%quote_local_part%& expansion item"
9672 This operator is like &%quote%&, except that it quotes the string only if
9673 required to do so by the rules of RFC 2822 for quoting local parts. For
9674 example, a plus sign would not cause quoting (but it would for &%quote%&).
9675 If you are creating a new email address from the contents of &$local_part$&
9676 (or any other unknown data), you should always use this operator.
9677
9678
9679 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
9680 .cindex "quoting" "lookup-specific"
9681 This operator applies lookup-specific quoting rules to the string. Each
9682 query-style lookup type has its own quoting rules which are described with
9683 the lookups in chapter &<<CHAPfdlookup>>&. For example,
9684 .code
9685 ${quote_ldap:two * two}
9686 .endd
9687 returns
9688 .code
9689 two%20%5C2A%20two
9690 .endd
9691 For single-key lookup types, no quoting is ever necessary and this operator
9692 yields an unchanged string.
9693
9694
9695 .vitem &*${randint:*&<&'n'&>&*}*&
9696 .cindex "random number"
9697 This operator returns a somewhat random number which is less than the
9698 supplied number and is at least 0.  The quality of this randomness depends
9699 on how Exim was built; the values are not suitable for keying material.
9700 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
9701 Otherwise, the implementation may be arc4random(), random() seeded by
9702 srandomdev() or srandom(), or a custom implementation even weaker than
9703 random().
9704
9705
9706 .new
9707 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
9708 .cindex "expansion" "IP address"
9709 This operator reverses an IP address; for IPv4 addresses, the result is in
9710 dotted-quad decimal form, while for IPv6 addreses the result is in
9711 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
9712 for DNS.  For example,
9713 .code
9714 ${reverse_ip:192.0.2.4} and ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.3}
9715 .endd
9716 returns
9717 .code
9718 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
9719 .endd
9720 .wen
9721
9722
9723 .vitem &*${rfc2047:*&<&'string'&>&*}*&
9724 .cindex "expansion" "RFC 2047"
9725 .cindex "RFC 2047" "expansion operator"
9726 .cindex "&%rfc2047%& expansion item"
9727 This operator encodes text according to the rules of RFC 2047. This is an
9728 encoding that is used in header lines to encode non-ASCII characters. It is
9729 assumed that the input string is in the encoding specified by the
9730 &%headers_charset%& option, which defaults to ISO-8859-1. If the string
9731 contains only characters in the range 33&--126, and no instances of the
9732 characters
9733 .code
9734 ? = ( ) < > @ , ; : \ " . [ ] _
9735 .endd
9736 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
9737 string, using as many &"encoded words"& as necessary to encode all the
9738 characters.
9739
9740
9741 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
9742 .cindex "expansion" "RFC 2047"
9743 .cindex "RFC 2047" "decoding"
9744 .cindex "&%rfc2047d%& expansion item"
9745 This operator decodes strings that are encoded as per RFC 2047. Binary zero
9746 bytes are replaced by question marks. Characters are converted into the
9747 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
9748 not recognized unless &%check_rfc2047_length%& is set false.
9749
9750 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
9751 access a header line, RFC 2047 decoding is done automatically. You do not need
9752 to use this operator as well.
9753
9754
9755
9756 .vitem &*${rxquote:*&<&'string'&>&*}*&
9757 .cindex "quoting" "in regular expressions"
9758 .cindex "regular expressions" "quoting"
9759 .cindex "&%rxquote%& expansion item"
9760 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
9761 characters in its argument. This is useful when substituting the values of
9762 variables or headers inside regular expressions.
9763
9764
9765 .vitem &*${sha1:*&<&'string'&>&*}*&
9766 .cindex "SHA-1 hash"
9767 .cindex "expansion" "SHA-1 hashing"
9768 .cindex "&%sha2%& expansion item"
9769 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
9770 it as a 40-digit hexadecimal number, in which any letters are in upper case.
9771
9772
9773 .vitem &*${stat:*&<&'string'&>&*}*&
9774 .cindex "expansion" "statting a file"
9775 .cindex "file" "extracting characteristics"
9776 .cindex "&%stat%& expansion item"
9777 The string, after expansion, must be a file path. A call to the &[stat()]&
9778 function is made for this path. If &[stat()]& fails, an error occurs and the
9779 expansion fails. If it succeeds, the data from the stat replaces the item, as a
9780 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
9781 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
9782 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
9783 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
9784 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
9785 can extract individual fields using the &%extract%& expansion item.
9786
9787 The use of the &%stat%& expansion in users' filter files can be locked out by
9788 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
9789 systems for files larger than 2GB.
9790
9791 .vitem &*${str2b64:*&<&'string'&>&*}*&
9792 .cindex "expansion" "base64 encoding"
9793 .cindex "base64 encoding" "in string expansion"
9794 .cindex "&%str2b64%& expansion item"
9795 This operator converts a string into one that is base64 encoded.
9796
9797
9798
9799 .vitem &*${strlen:*&<&'string'&>&*}*&
9800 .cindex "expansion" "string length"
9801 .cindex "string" "length in expansion"
9802 .cindex "&%strlen%& expansion item"
9803 The item is replace by the length of the expanded string, expressed as a
9804 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
9805
9806
9807 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
9808 .cindex "&%substr%& expansion item"
9809 .cindex "substring extraction"
9810 .cindex "expansion" "substring expansion"
9811 The &%substr%& operator is a simpler interface to the &%substr%& function that
9812 can be used when the two parameters are fixed numbers (as opposed to strings
9813 that change when expanded). The effect is the same as
9814 .code
9815 ${substr{<start>}{<length>}{<string>}}
9816 .endd
9817 See the description of the general &%substr%& item above for details. The
9818 abbreviation &%s%& can be used when &%substr%& is used as an operator.
9819
9820 .vitem &*${time_eval:*&<&'string'&>&*}*&
9821 .cindex "&%time_eval%& expansion item"
9822 .cindex "time interval" "decoding"
9823 This item converts an Exim time interval such as &`2d4h5m`& into a number of
9824 seconds.
9825
9826 .vitem &*${time_interval:*&<&'string'&>&*}*&
9827 .cindex "&%time_interval%& expansion item"
9828 .cindex "time interval" "formatting"
9829 The argument (after sub-expansion) must be a sequence of decimal digits that
9830 represents an interval of time as a number of seconds. It is converted into a
9831 number of larger units and output in Exim's normal time format, for example,
9832 &`1w3d4h2m6s`&.
9833
9834 .vitem &*${uc:*&<&'string'&>&*}*&
9835 .cindex "case forcing in strings"
9836 .cindex "string" "case forcing"
9837 .cindex "upper casing"
9838 .cindex "expansion" "case forcing"
9839 .cindex "&%uc%& expansion item"
9840 This forces the letters in the string into upper-case.
9841 .endlist
9842
9843
9844
9845
9846
9847
9848 .section "Expansion conditions" "SECTexpcond"
9849 .scindex IIDexpcond "expansion" "conditions"
9850 The following conditions are available for testing by the &%${if%& construct
9851 while expanding strings:
9852
9853 .vlist
9854 .vitem &*!*&<&'condition'&>
9855 .cindex "expansion" "negating a condition"
9856 .cindex "negation" "in expansion condition"
9857 Preceding any condition with an exclamation mark negates the result of the
9858 condition.
9859
9860 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
9861 .cindex "numeric comparison"
9862 .cindex "expansion" "numeric comparison"
9863 There are a number of symbolic operators for doing numeric comparisons. They
9864 are:
9865 .display
9866 &`=   `&   equal
9867 &`==  `&   equal
9868 &`>   `&   greater
9869 &`>=  `&   greater or equal
9870 &`<   `&   less
9871 &`<=  `&   less or equal
9872 .endd
9873 For example:
9874 .code
9875 ${if >{$message_size}{10M} ...
9876 .endd
9877 Note that the general negation operator provides for inequality testing. The
9878 two strings must take the form of optionally signed decimal integers,
9879 optionally followed by one of the letters &"K"& or &"M"& (in either upper or
9880 lower case), signifying multiplication by 1024 or 1024*1024, respectively.
9881 As a special case, the numerical value of an empty string is taken as
9882 zero.
9883
9884
9885 .new
9886 .vitem &*bool&~{*&<&'string'&>&*}*&
9887 .cindex "expansion" "boolean parsing"
9888 .cindex "&%bool%& expansion condition"
9889 This condition turns a string holding a true or false representation into
9890 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
9891 (case-insensitively); also positive integer numbers map to true if non-zero,
9892 false if zero.  Leading and trailing whitespace is ignored.
9893 All other string values will result in expansion failure.
9894
9895 When combined with ACL variables, this expansion condition will let you
9896 make decisions in one place and act on those decisions in another place.
9897 For example:
9898 .code
9899 ${if bool{$acl_m_privileged_sender} ...
9900 .endd
9901 .wen
9902
9903
9904 .new
9905 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
9906 .cindex "expansion" "boolean parsing"
9907 .cindex "&%bool_lax%& expansion condition"
9908 Like &%bool%&, this condition turns a string into a boolean state.  But
9909 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
9910 loose definition that the Router &%condition%& option uses.  The empty string
9911 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
9912 true.  Leading and trailing whitespace is ignored.
9913
9914 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
9915 .wen
9916 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
9917 .cindex "expansion" "encrypted comparison"
9918 .cindex "encrypted strings, comparing"
9919 .cindex "&%crypteq%& expansion condition"
9920 This condition is included in the Exim binary if it is built to support any
9921 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
9922 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
9923 included in the binary.
9924
9925 The &%crypteq%& condition has two arguments. The first is encrypted and
9926 compared against the second, which is already encrypted. The second string may
9927 be in the LDAP form for storing encrypted strings, which starts with the
9928 encryption type in curly brackets, followed by the data. If the second string
9929 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
9930 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
9931 Typically this will be a field from a password file. An example of an encrypted
9932 string in LDAP form is:
9933 .code
9934 {md5}CY9rzUYh03PK3k6DJie09g==
9935 .endd
9936 If such a string appears directly in an expansion, the curly brackets have to
9937 be quoted, because they are part of the expansion syntax. For example:
9938 .code
9939 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
9940 .endd
9941 The following encryption types (whose names are matched case-independently) are
9942 supported:
9943
9944 .ilist
9945 .cindex "MD5 hash"
9946 .cindex "base64 encoding" "in encrypted password"
9947 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
9948 printable characters to compare with the remainder of the second string. If the
9949 length of the comparison string is 24, Exim assumes that it is base64 encoded
9950 (as in the above example). If the length is 32, Exim assumes that it is a
9951 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
9952 comparison fails.
9953
9954 .next
9955 .cindex "SHA-1 hash"
9956 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
9957 printable characters to compare with the remainder of the second string. If the
9958 length of the comparison string is 28, Exim assumes that it is base64 encoded.
9959 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
9960 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
9961
9962 .next
9963 .cindex "&[crypt()]&"
9964 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
9965 only the first eight characters of the password. However, in modern operating
9966 systems this is no longer true, and in many cases the entire password is used,
9967 whatever its length.
9968
9969 .next
9970 .cindex "&[crypt16()]&"
9971 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
9972 use up to 16 characters of the password in some operating systems. Again, in
9973 modern operating systems, more characters may be used.
9974 .endlist
9975 Exim has its own version of &[crypt16()]&, which is just a double call to
9976 &[crypt()]&. For operating systems that have their own version, setting
9977 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
9978 operating system version instead of its own. This option is set by default in
9979 the OS-dependent &_Makefile_& for those operating systems that are known to
9980 support &[crypt16()]&.
9981
9982 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
9983 it was not using the same algorithm as some operating systems' versions. It
9984 turns out that as well as &[crypt16()]& there is a function called
9985 &[bigcrypt()]& in some operating systems. This may or may not use the same
9986 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
9987
9988 However, since there is now a move away from the traditional &[crypt()]&
9989 functions towards using SHA1 and other algorithms, tidying up this area of
9990 Exim is seen as very low priority.
9991
9992 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
9993 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
9994 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
9995 default is &`{crypt}`&. Whatever the default, you can always use either
9996 function by specifying it explicitly in curly brackets.
9997
9998 .vitem &*def:*&<&'variable&~name'&>
9999 .cindex "expansion" "checking for empty variable"
10000 .cindex "&%def%& expansion condition"
10001 The &%def%& condition must be followed by the name of one of the expansion
10002 variables defined in section &<<SECTexpvar>>&. The condition is true if the
10003 variable does not contain the empty string. For example:
10004 .code
10005 ${if def:sender_ident {from $sender_ident}}
10006 .endd
10007 Note that the variable name is given without a leading &%$%& character. If the
10008 variable does not exist, the expansion fails.
10009
10010 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
10011         &~&*def:h_*&<&'header&~name'&>&*:*&"
10012 .cindex "expansion" "checking header line existence"
10013 This condition is true if a message is being processed and the named header
10014 exists in the message. For example,
10015 .code
10016 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
10017 .endd
10018 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
10019 the header name must be terminated by a colon if white space does not follow.
10020
10021 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10022        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10023 .cindex "string" "comparison"
10024 .cindex "expansion" "string comparison"
10025 .cindex "&%eq%& expansion condition"
10026 .cindex "&%eqi%& expansion condition"
10027 The two substrings are first expanded. The condition is true if the two
10028 resulting strings are identical. For &%eq%& the comparison includes the case of
10029 letters, whereas for &%eqi%& the comparison is case-independent.
10030
10031 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
10032 .cindex "expansion" "file existence test"
10033 .cindex "file" "existence test"
10034 .cindex "&%exists%&, expansion condition"
10035 The substring is first expanded and then interpreted as an absolute path. The
10036 condition is true if the named file (or directory) exists. The existence test
10037 is done by calling the &[stat()]& function. The use of the &%exists%& test in
10038 users' filter files may be locked out by the system administrator.
10039
10040 .vitem &*first_delivery*&
10041 .cindex "delivery" "first"
10042 .cindex "first delivery"
10043 .cindex "expansion" "first delivery test"
10044 .cindex "&%first_delivery%& expansion condition"
10045 This condition, which has no data, is true during a message's first delivery
10046 attempt. It is false during any subsequent delivery attempts.
10047
10048
10049 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
10050        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
10051 .cindex "list" "iterative conditions"
10052 .cindex "expansion" "&*forall*& condition"
10053 .cindex "expansion" "&*forany*& condition"
10054 .vindex "&$item$&"
10055 These conditions iterate over a list. The first argument is expanded to form
10056 the list. By default, the list separator is a colon, but it can be changed by
10057 the normal method. The second argument is interpreted as a condition that is to
10058 be applied to each item in the list in turn. During the interpretation of the
10059 condition, the current list item is placed in a variable called &$item$&.
10060 .ilist
10061 For &*forany*&, interpretation stops if the condition is true for any item, and
10062 the result of the whole condition is true. If the condition is false for all
10063 items in the list, the overall condition is false.
10064 .next
10065 For &*forall*&, interpretation stops if the condition is false for any item,
10066 and the result of the whole condition is false. If the condition is true for
10067 all items in the list, the overall condition is true.
10068 .endlist
10069 Note that negation of &*forany*& means that the condition must be false for all
10070 items for the overall condition to succeed, and negation of &*forall*& means
10071 that the condition must be false for at least one item. In this example, the
10072 list separator is changed to a comma:
10073 .code
10074 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
10075 .endd
10076 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
10077 being processed, to enable these expansion items to be nested.
10078
10079
10080 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10081        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10082 .cindex "string" "comparison"
10083 .cindex "expansion" "string comparison"
10084 .cindex "&%ge%& expansion condition"
10085 .cindex "&%gei%& expansion condition"
10086 The two substrings are first expanded. The condition is true if the first
10087 string is lexically greater than or equal to the second string. For &%ge%& the
10088 comparison includes the case of letters, whereas for &%gei%& the comparison is
10089 case-independent.
10090
10091 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10092        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10093 .cindex "string" "comparison"
10094 .cindex "expansion" "string comparison"
10095 .cindex "&%gt%& expansion condition"
10096 .cindex "&%gti%& expansion condition"
10097 The two substrings are first expanded. The condition is true if the first
10098 string is lexically greater than the second string. For &%gt%& the comparison
10099 includes the case of letters, whereas for &%gti%& the comparison is
10100 case-independent.
10101
10102 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
10103        &*isip4&~{*&<&'string'&>&*}*& &&&
10104        &*isip6&~{*&<&'string'&>&*}*&
10105 .cindex "IP address" "testing string format"
10106 .cindex "string" "testing for IP address"
10107 .cindex "&%isip%& expansion condition"
10108 .cindex "&%isip4%& expansion condition"
10109 .cindex "&%isip6%& expansion condition"
10110 The substring is first expanded, and then tested to see if it has the form of
10111 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
10112 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
10113
10114 For an IPv4 address, the test is for four dot-separated components, each of
10115 which consists of from one to three digits. For an IPv6 address, up to eight
10116 colon-separated components are permitted, each containing from one to four
10117 hexadecimal digits. There may be fewer than eight components if an empty
10118 component (adjacent colons) is present. Only one empty component is permitted.
10119
10120 &*Note*&: The checks are just on the form of the address; actual numerical
10121 values are not considered. Thus, for example, 999.999.999.999 passes the IPv4
10122 check. The main use of these tests is to distinguish between IP addresses and
10123 host names, or between IPv4 and IPv6 addresses. For example, you could use
10124 .code
10125 ${if isip4{$sender_host_address}...
10126 .endd
10127 to test which IP version an incoming SMTP connection is using.
10128
10129 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
10130 .cindex "LDAP" "use for authentication"
10131 .cindex "expansion" "LDAP authentication test"
10132 .cindex "&%ldapauth%& expansion condition"
10133 This condition supports user authentication using LDAP. See section
10134 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
10135 queries. For this use, the query must contain a user name and password. The
10136 query itself is not used, and can be empty. The condition is true if the
10137 password is not empty, and the user name and password are accepted by the LDAP
10138 server. An empty password is rejected without calling LDAP because LDAP binds
10139 with an empty password are considered anonymous regardless of the username, and
10140 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
10141 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
10142 this can be used.
10143
10144
10145 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10146        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10147 .cindex "string" "comparison"
10148 .cindex "expansion" "string comparison"
10149 .cindex "&%le%& expansion condition"
10150 .cindex "&%lei%& expansion condition"
10151 The two substrings are first expanded. The condition is true if the first
10152 string is lexically less than or equal to the second string. For &%le%& the
10153 comparison includes the case of letters, whereas for &%lei%& the comparison is
10154 case-independent.
10155
10156 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10157        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10158 .cindex "string" "comparison"
10159 .cindex "expansion" "string comparison"
10160 .cindex "&%lt%& expansion condition"
10161 .cindex "&%lti%& expansion condition"
10162 The two substrings are first expanded. The condition is true if the first
10163 string is lexically less than the second string. For &%lt%& the comparison
10164 includes the case of letters, whereas for &%lti%& the comparison is
10165 case-independent.
10166
10167
10168 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10169 .cindex "expansion" "regular expression comparison"
10170 .cindex "regular expressions" "match in expanded string"
10171 .cindex "&%match%& expansion condition"
10172 The two substrings are first expanded. The second is then treated as a regular
10173 expression and applied to the first. Because of the pre-expansion, if the
10174 regular expression contains dollar, or backslash characters, they must be
10175 escaped. Care must also be taken if the regular expression contains braces
10176 (curly brackets). A closing brace must be escaped so that it is not taken as a
10177 premature termination of <&'string2'&>. The easiest approach is to use the
10178 &`\N`& feature to disable expansion of the regular expression.
10179 For example,
10180 .code
10181 ${if match {$local_part}{\N^\d{3}\N} ...
10182 .endd
10183 If the whole expansion string is in double quotes, further escaping of
10184 backslashes is also required.
10185
10186 The condition is true if the regular expression match succeeds.
10187 The regular expression is not required to begin with a circumflex
10188 metacharacter, but if there is no circumflex, the expression is not anchored,
10189 and it may match anywhere in the subject, not just at the start. If you want
10190 the pattern to match at the end of the subject, you must include the &`$`&
10191 metacharacter at an appropriate point.
10192
10193 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
10194 At the start of an &%if%& expansion the values of the numeric variable
10195 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
10196 succeeds causes them to be reset to the substrings of that condition and they
10197 will have these values during the expansion of the success string. At the end
10198 of the &%if%& expansion, the previous values are restored. After testing a
10199 combination of conditions using &%or%&, the subsequent values of the numeric
10200 variables are those of the condition that succeeded.
10201
10202 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10203 .cindex "&%match_address%& expansion condition"
10204 See &*match_local_part*&.
10205
10206 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10207 .cindex "&%match_domain%& expansion condition"
10208 See &*match_local_part*&.
10209
10210 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10211 .cindex "&%match_ip%& expansion condition"
10212 This condition matches an IP address to a list of IP address patterns. It must
10213 be followed by two argument strings. The first (after expansion) must be an IP
10214 address or an empty string. The second (after expansion) is a restricted host
10215 list that can match only an IP address, not a host name. For example:
10216 .code
10217 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
10218 .endd
10219 The specific types of host list item that are permitted in the list are:
10220
10221 .ilist
10222 An IP address, optionally with a CIDR mask.
10223 .next
10224 A single asterisk, which matches any IP address.
10225 .next
10226 An empty item, which matches only if the IP address is empty. This could be
10227 useful for testing for a locally submitted message or one from specific hosts
10228 in a single test such as
10229 . ==== As this is a nested list, any displays it contains must be indented
10230 . ==== as otherwise they are too far to the left. This comment applies to
10231 . ==== the use of xmlto plus fop. There's no problem when formatting with
10232 . ==== sdop, with or without the extra indent.
10233 .code
10234   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
10235 .endd
10236 where the first item in the list is the empty string.
10237 .next
10238 The item @[] matches any of the local host's interface addresses.
10239 .next
10240 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
10241 even if &`net-`& is not specified. There is never any attempt to turn the IP
10242 address into a host name. The most common type of linear search for
10243 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
10244 masks. For example:
10245 .code
10246   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
10247 .endd
10248 It is of course possible to use other kinds of lookup, and in such a case, you
10249 do need to specify the &`net-`& prefix if you want to specify a specific
10250 address mask, for example:
10251 .code
10252   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
10253 .endd
10254 However, unless you are combining a &%match_ip%& condition with others, it is
10255 just as easy to use the fact that a lookup is itself a condition, and write:
10256 .code
10257   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
10258 .endd
10259 .endlist ilist
10260
10261 Consult section &<<SECThoslispatip>>& for further details of these patterns.
10262
10263 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10264 .cindex "domain list" "in expansion condition"
10265 .cindex "address list" "in expansion condition"
10266 .cindex "local part" "list, in expansion condition"
10267 .cindex "&%match_local_part%& expansion condition"
10268 This condition, together with &%match_address%& and &%match_domain%&, make it
10269 possible to test domain, address, and local part lists within expansions. Each
10270 condition requires two arguments: an item and a list to match. A trivial
10271 example is:
10272 .code
10273 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
10274 .endd
10275 In each case, the second argument may contain any of the allowable items for a
10276 list of the appropriate type. Also, because the second argument (after
10277 expansion) is a standard form of list, it is possible to refer to a named list.
10278 Thus, you can use conditions like this:
10279 .code
10280 ${if match_domain{$domain}{+local_domains}{...
10281 .endd
10282 .cindex "&`+caseful`&"
10283 For address lists, the matching starts off caselessly, but the &`+caseful`&
10284 item can be used, as in all address lists, to cause subsequent items to
10285 have their local parts matched casefully. Domains are always matched
10286 caselessly.
10287
10288 &*Note*&: Host lists are &'not'& supported in this way. This is because
10289 hosts have two identities: a name and an IP address, and it is not clear
10290 how to specify cleanly how such a test would work. However, IP addresses can be
10291 matched using &%match_ip%&.
10292
10293 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
10294 .cindex "PAM authentication"
10295 .cindex "AUTH" "with PAM"
10296 .cindex "Solaris" "PAM support"
10297 .cindex "expansion" "PAM authentication test"
10298 .cindex "&%pam%& expansion condition"
10299 &'Pluggable Authentication Modules'&
10300 (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is
10301 available in the latest releases of Solaris and in some GNU/Linux
10302 distributions. The Exim support, which is intended for use in conjunction with
10303 the SMTP AUTH command, is available only if Exim is compiled with
10304 .code
10305 SUPPORT_PAM=yes
10306 .endd
10307 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
10308 in some releases of GNU/Linux &%-ldl%& is also needed.
10309
10310 The argument string is first expanded, and the result must be a
10311 colon-separated list of strings. Leading and trailing white space is ignored.
10312 The PAM module is initialized with the service name &"exim"& and the user name
10313 taken from the first item in the colon-separated data string (<&'string1'&>).
10314 The remaining items in the data string are passed over in response to requests
10315 from the authentication function. In the simple case there will only be one
10316 request, for a password, so the data consists of just two strings.
10317
10318 There can be problems if any of the strings are permitted to contain colon
10319 characters. In the usual way, these have to be doubled to avoid being taken as
10320 separators. If the data is being inserted from a variable, the &%sg%& expansion
10321 item can be used to double any existing colons. For example, the configuration
10322 of a LOGIN authenticator might contain this setting:
10323 .code
10324 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
10325 .endd
10326 For a PLAIN authenticator you could use:
10327 .code
10328 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
10329 .endd
10330 In some operating systems, PAM authentication can be done only from a process
10331 running as root. Since Exim is running as the Exim user when receiving
10332 messages, this means that PAM cannot be used directly in those systems.
10333 A patched version of the &'pam_unix'& module that comes with the
10334 Linux PAM package is available from &url(http://www.e-admin.de/pam_exim/).
10335 The patched module allows one special uid/gid combination, in addition to root,
10336 to authenticate. If you build the patched module to allow the Exim user and
10337 group, PAM can then be used from an Exim authenticator.
10338
10339
10340 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
10341 .cindex "&'pwcheck'& daemon"
10342 .cindex "Cyrus"
10343 .cindex "expansion" "&'pwcheck'& authentication test"
10344 .cindex "&%pwcheck%& expansion condition"
10345 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
10346 This is one way of making it possible for passwords to be checked by a process
10347 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
10348 deprecated. Its replacement is &'saslauthd'& (see below).
10349
10350 The pwcheck support is not included in Exim by default. You need to specify
10351 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
10352 building Exim. For example:
10353 .code
10354 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
10355 .endd
10356 You do not need to install the full Cyrus software suite in order to use
10357 the pwcheck daemon. You can compile and install just the daemon alone
10358 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
10359 access to the &_/var/pwcheck_& directory.
10360
10361 The &%pwcheck%& condition takes one argument, which must be the user name and
10362 password, separated by a colon. For example, in a LOGIN authenticator
10363 configuration, you might have this:
10364 .code
10365 server_condition = ${if pwcheck{$auth1:$auth2}}
10366 .endd
10367 Again, for a PLAIN authenticator configuration, this would be:
10368 .code
10369 server_condition = ${if pwcheck{$auth2:$auth3}}
10370 .endd
10371 .vitem &*queue_running*&
10372 .cindex "queue runner" "detecting when delivering from"
10373 .cindex "expansion" "queue runner test"
10374 .cindex "&%queue_running%& expansion condition"
10375 This condition, which has no data, is true during delivery attempts that are
10376 initiated by queue runner processes, and false otherwise.
10377
10378
10379 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
10380 .cindex "Radius"
10381 .cindex "expansion" "Radius authentication"
10382 .cindex "&%radius%& expansion condition"
10383 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
10384 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
10385 the Radius client configuration file in order to build Exim with Radius
10386 support.
10387
10388 With just that one setting, Exim expects to be linked with the &%radiusclient%&
10389 library, using the original API. If you are using release 0.4.0 or later of
10390 this library, you need to set
10391 .code
10392 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
10393 .endd
10394 in &_Local/Makefile_& when building Exim. You can also link Exim with the
10395 &%libradius%& library that comes with FreeBSD. To do this, set
10396 .code
10397 RADIUS_LIB_TYPE=RADLIB
10398 .endd
10399 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
10400 You may also have to supply a suitable setting in EXTRALIBS so that the
10401 Radius library can be found when Exim is linked.
10402
10403 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
10404 Radius client library, which calls the Radius server. The condition is true if
10405 the authentication is successful. For example:
10406 .code
10407 server_condition = ${if radius{<arguments>}}
10408 .endd
10409
10410
10411 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
10412         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
10413 .cindex "&'saslauthd'& daemon"
10414 .cindex "Cyrus"
10415 .cindex "expansion" "&'saslauthd'& authentication test"
10416 .cindex "&%saslauthd%& expansion condition"
10417 This condition supports user authentication using the Cyrus &'saslauthd'&
10418 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
10419 Using this daemon is one way of making it possible for passwords to be checked
10420 by a process that is not running as root.
10421
10422 The saslauthd support is not included in Exim by default. You need to specify
10423 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
10424 building Exim. For example:
10425 .code
10426 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
10427 .endd
10428 You do not need to install the full Cyrus software suite in order to use
10429 the saslauthd daemon. You can compile and install just the daemon alone
10430 from the Cyrus SASL library.
10431
10432 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
10433 two are mandatory. For example:
10434 .code
10435 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
10436 .endd
10437 The service and the realm are optional (which is why the arguments are enclosed
10438 in their own set of braces). For details of the meaning of the service and
10439 realm, and how to run the daemon, consult the Cyrus documentation.
10440 .endlist vlist
10441
10442
10443
10444 .section "Combining expansion conditions" "SECID84"
10445 .cindex "expansion" "combining conditions"
10446 Several conditions can be tested at once by combining them using the &%and%&
10447 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
10448 conditions on their own, and precede their lists of sub-conditions. Each
10449 sub-condition must be enclosed in braces within the overall braces that contain
10450 the list. No repetition of &%if%& is used.
10451
10452
10453 .vlist
10454 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
10455 .cindex "&""or""& expansion condition"
10456 .cindex "expansion" "&""or""& of conditions"
10457 The sub-conditions are evaluated from left to right. The condition is true if
10458 any one of the sub-conditions is true.
10459 For example,
10460 .code
10461 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
10462 .endd
10463 When a true sub-condition is found, the following ones are parsed but not
10464 evaluated. If there are several &"match"& sub-conditions the values of the
10465 numeric variables afterwards are taken from the first one that succeeds.
10466
10467 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
10468 .cindex "&""and""& expansion condition"
10469 .cindex "expansion" "&""and""& of conditions"
10470 The sub-conditions are evaluated from left to right. The condition is true if
10471 all of the sub-conditions are true. If there are several &"match"&
10472 sub-conditions, the values of the numeric variables afterwards are taken from
10473 the last one. When a false sub-condition is found, the following ones are
10474 parsed but not evaluated.
10475 .endlist
10476 .ecindex IIDexpcond
10477
10478
10479
10480
10481 .section "Expansion variables" "SECTexpvar"
10482 .cindex "expansion" "variables, list of"
10483 This section contains an alphabetical list of all the expansion variables. Some
10484 of them are available only when Exim is compiled with specific options such as
10485 support for TLS or the content scanning extension.
10486
10487 .vlist
10488 .vitem "&$0$&, &$1$&, etc"
10489 .cindex "numerical variables (&$1$& &$2$& etc)"
10490 When a &%match%& expansion condition succeeds, these variables contain the
10491 captured substrings identified by the regular expression during subsequent
10492 processing of the success string of the containing &%if%& expansion item.
10493 However, they do not retain their values afterwards; in fact, their previous
10494 values are restored at the end of processing an &%if%& item. The numerical
10495 variables may also be set externally by some other matching process which
10496 precedes the expansion of the string. For example, the commands available in
10497 Exim filter files include an &%if%& command with its own regular expression
10498 matching condition.
10499
10500 .vitem "&$acl_c...$&"
10501 Values can be placed in these variables by the &%set%& modifier in an ACL. They
10502 can be given any name that starts with &$acl_c$& and is at least six characters
10503 long, but the sixth character must be either a digit or an underscore. For
10504 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
10505 variables persist throughout the lifetime of an SMTP connection. They can be
10506 used to pass information between ACLs and between different invocations of the
10507 same ACL. When a message is received, the values of these variables are saved
10508 with the message, and can be accessed by filters, routers, and transports
10509 during subsequent delivery.
10510
10511 .vitem "&$acl_m...$&"
10512 These variables are like the &$acl_c...$& variables, except that their values
10513 are reset after a message has been received. Thus, if several messages are
10514 received in one SMTP connection, &$acl_m...$& values are not passed on from one
10515 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
10516 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
10517 message is received, the values of these variables are saved with the message,
10518 and can be accessed by filters, routers, and transports during subsequent
10519 delivery.
10520
10521 .vitem &$acl_verify_message$&
10522 .vindex "&$acl_verify_message$&"
10523 After an address verification has failed, this variable contains the failure
10524 message. It retains its value for use in subsequent modifiers. The message can
10525 be preserved by coding like this:
10526 .code
10527 warn !verify = sender
10528      set acl_m0 = $acl_verify_message
10529 .endd
10530 You can use &$acl_verify_message$& during the expansion of the &%message%& or
10531 &%log_message%& modifiers, to include information about the verification
10532 failure.
10533
10534 .vitem &$address_data$&
10535 .vindex "&$address_data$&"
10536 This variable is set by means of the &%address_data%& option in routers. The
10537 value then remains with the address while it is processed by subsequent routers
10538 and eventually a transport. If the transport is handling multiple addresses,
10539 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
10540 for more details. &*Note*&: The contents of &$address_data$& are visible in
10541 user filter files.
10542
10543 If &$address_data$& is set when the routers are called from an ACL to verify
10544 a recipient address, the final value is still in the variable for subsequent
10545 conditions and modifiers of the ACL statement. If routing the address caused it
10546 to be redirected to just one address, the child address is also routed as part
10547 of the verification, and in this case the final value of &$address_data$& is
10548 from the child's routing.
10549
10550 If &$address_data$& is set when the routers are called from an ACL to verify a
10551 sender address, the final value is also preserved, but this time in
10552 &$sender_address_data$&, to distinguish it from data from a recipient
10553 address.
10554
10555 In both cases (recipient and sender verification), the value does not persist
10556 after the end of the current ACL statement. If you want to preserve
10557 these values for longer, you can save them in ACL variables.
10558
10559 .vitem &$address_file$&
10560 .vindex "&$address_file$&"
10561 When, as a result of aliasing, forwarding, or filtering, a message is directed
10562 to a specific file, this variable holds the name of the file when the transport
10563 is running. At other times, the variable is empty. For example, using the
10564 default configuration, if user &%r2d2%& has a &_.forward_& file containing
10565 .code
10566 /home/r2d2/savemail
10567 .endd
10568 then when the &(address_file)& transport is running, &$address_file$&
10569 contains the text string &`/home/r2d2/savemail`&.
10570 .cindex "Sieve filter" "value of &$address_file$&"
10571 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
10572 then up to the transport configuration to generate an appropriate absolute path
10573 to the relevant file.
10574
10575 .vitem &$address_pipe$&
10576 .vindex "&$address_pipe$&"
10577 When, as a result of aliasing or forwarding, a message is directed to a pipe,
10578 this variable holds the pipe command when the transport is running.
10579
10580 .vitem "&$auth1$& &-- &$auth3$&"
10581 .vindex "&$auth1$&, &$auth2$&, etc"
10582 These variables are used in SMTP authenticators (see chapters
10583 &<<CHAPplaintext>>&&--&<<CHAPspa>>&). Elsewhere, they are empty.
10584
10585 .vitem &$authenticated_id$&
10586 .cindex "authentication" "id"
10587 .vindex "&$authenticated_id$&"
10588 When a server successfully authenticates a client it may be configured to
10589 preserve some of the authentication information in the variable
10590 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
10591 user/password authenticator configuration might preserve the user name for use
10592 in the routers. Note that this is not the same information that is saved in
10593 &$sender_host_authenticated$&.
10594 When a message is submitted locally (that is, not over a TCP connection)
10595 the value of &$authenticated_id$& is normally the login name of the calling
10596 process. However, a trusted user can override this by means of the &%-oMai%&
10597 command line option.
10598
10599
10600
10601
10602 .vitem &$authenticated_sender$&
10603 .cindex "sender" "authenticated"
10604 .cindex "authentication" "sender"
10605 .cindex "AUTH" "on MAIL command"
10606 .vindex "&$authenticated_sender$&"
10607 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
10608 SMTP MAIL command if it believes the sender is sufficiently trusted, as
10609 described in section &<<SECTauthparamail>>&. Unless the data is the string
10610 &"<>"&, it is set as the authenticated sender of the message, and the value is
10611 available during delivery in the &$authenticated_sender$& variable. If the
10612 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
10613
10614 .vindex "&$qualify_domain$&"
10615 When a message is submitted locally (that is, not over a TCP connection), the
10616 value of &$authenticated_sender$& is an address constructed from the login
10617 name of the calling process and &$qualify_domain$&, except that a trusted user
10618 can override this by means of the &%-oMas%& command line option.
10619
10620
10621 .vitem &$authentication_failed$&
10622 .cindex "authentication" "failure"
10623 .vindex "&$authentication_failed$&"
10624 This variable is set to &"1"& in an Exim server if a client issues an AUTH
10625 command that does not succeed. Otherwise it is set to &"0"&. This makes it
10626 possible to distinguish between &"did not try to authenticate"&
10627 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
10628 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
10629 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
10630 negative response to an AUTH command, including (for example) an attempt to use
10631 an undefined mechanism.
10632
10633 .vitem &$body_linecount$&
10634 .cindex "message body" "line count"
10635 .cindex "body of message" "line count"
10636 .vindex "&$body_linecount$&"
10637 When a message is being received or delivered, this variable contains the
10638 number of lines in the message's body. See also &$message_linecount$&.
10639
10640 .vitem &$body_zerocount$&
10641 .cindex "message body" "binary zero count"
10642 .cindex "body of message" "binary zero count"
10643 .cindex "binary zero" "in message body"
10644 .vindex "&$body_zerocount$&"
10645 When a message is being received or delivered, this variable contains the
10646 number of binary zero bytes in the message's body.
10647
10648 .vitem &$bounce_recipient$&
10649 .vindex "&$bounce_recipient$&"
10650 This is set to the recipient address of a bounce message while Exim is creating
10651 it. It is useful if a customized bounce message text file is in use (see
10652 chapter &<<CHAPemsgcust>>&).
10653
10654 .vitem &$bounce_return_size_limit$&
10655 .vindex "&$bounce_return_size_limit$&"
10656 This contains the value set in the &%bounce_return_size_limit%& option, rounded
10657 up to a multiple of 1000. It is useful when a customized error message text
10658 file is in use (see chapter &<<CHAPemsgcust>>&).
10659
10660 .vitem &$caller_gid$&
10661 .cindex "gid (group id)" "caller"
10662 .vindex "&$caller_gid$&"
10663 The real group id under which the process that called Exim was running. This is
10664 not the same as the group id of the originator of a message (see
10665 &$originator_gid$&). If Exim re-execs itself, this variable in the new
10666 incarnation normally contains the Exim gid.
10667
10668 .vitem &$caller_uid$&
10669 .cindex "uid (user id)" "caller"
10670 .vindex "&$caller_uid$&"
10671 The real user id under which the process that called Exim was running. This is
10672 not the same as the user id of the originator of a message (see
10673 &$originator_uid$&). If Exim re-execs itself, this variable in the new
10674 incarnation normally contains the Exim uid.
10675
10676 .vitem &$compile_date$&
10677 .vindex "&$compile_date$&"
10678 The date on which the Exim binary was compiled.
10679
10680 .vitem &$compile_number$&
10681 .vindex "&$compile_number$&"
10682 The building process for Exim keeps a count of the number
10683 of times it has been compiled. This serves to distinguish different
10684 compilations of the same version of the program.
10685
10686 .vitem &$demime_errorlevel$&
10687 .vindex "&$demime_errorlevel$&"
10688 This variable is available when Exim is compiled with
10689 the content-scanning extension and the obsolete &%demime%& condition. For
10690 details, see section &<<SECTdemimecond>>&.
10691
10692 .vitem &$demime_reason$&
10693 .vindex "&$demime_reason$&"
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>>&.
10697
10698 .vitem &$dnslist_domain$& &&&
10699        &$dnslist_matched$& &&&
10700        &$dnslist_text$& &&&
10701        &$dnslist_value$&
10702 .vindex "&$dnslist_domain$&"
10703 .vindex "&$dnslist_matched$&"
10704 .vindex "&$dnslist_text$&"
10705 .vindex "&$dnslist_value$&"
10706 .cindex "black list (DNS)"
10707 When a DNS (black) list lookup succeeds, these variables are set to contain
10708 the following data from the lookup: the list's domain name, the key that was
10709 looked up, the contents of any associated TXT record, and the value from the
10710 main A record. See section &<<SECID204>>& for more details.
10711
10712 .vitem &$domain$&
10713 .vindex "&$domain$&"
10714 When an address is being routed, or delivered on its own, this variable
10715 contains the domain. Uppercase letters in the domain are converted into lower
10716 case for &$domain$&.
10717
10718 Global address rewriting happens when a message is received, so the value of
10719 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
10720 is set during user filtering, but not during system filtering, because a
10721 message may have many recipients and the system filter is called just once.
10722
10723 When more than one address is being delivered at once (for example, several
10724 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
10725 have the same domain. Transports can be restricted to handling only one domain
10726 at a time if the value of &$domain$& is required at transport time &-- this is
10727 the default for local transports. For further details of the environment in
10728 which local transports are run, see chapter &<<CHAPenvironment>>&.
10729
10730 .oindex "&%delay_warning_condition%&"
10731 At the end of a delivery, if all deferred addresses have the same domain, it is
10732 set in &$domain$& during the expansion of &%delay_warning_condition%&.
10733
10734 The &$domain$& variable is also used in some other circumstances:
10735
10736 .ilist
10737 When an ACL is running for a RCPT command, &$domain$& contains the domain of
10738 the recipient address. The domain of the &'sender'& address is in
10739 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
10740 normally set during the running of the MAIL ACL. However, if the sender address
10741 is verified with a callout during the MAIL ACL, the sender domain is placed in
10742 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
10743 the &(smtp)& transport.
10744
10745 .next
10746 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
10747 &$domain$& contains the domain portion of the address that is being rewritten;
10748 it can be used in the expansion of the replacement address, for example, to
10749 rewrite domains by file lookup.
10750
10751 .next
10752 With one important exception, whenever a domain list is being scanned,
10753 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
10754 a &%sender_domains%& condition in an ACL is being processed, the subject domain
10755 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
10756 that, in a RCPT ACL, the sender domain list can be dependent on the
10757 recipient domain (which is what is in &$domain$& at this time).
10758
10759 .next
10760 .cindex "ETRN" "value of &$domain$&"
10761 .oindex "&%smtp_etrn_command%&"
10762 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
10763 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
10764 .endlist
10765
10766
10767 .vitem &$domain_data$&
10768 .vindex "&$domain_data$&"
10769 When the &%domains%& option on a router matches a domain by
10770 means of a lookup, the data read by the lookup is available during the running
10771 of the router as &$domain_data$&. In addition, if the driver routes the
10772 address to a transport, the value is available in that transport. If the
10773 transport is handling multiple addresses, the value from the first address is
10774 used.
10775
10776 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
10777 domain by means of a lookup. The data read by the lookup is available during
10778 the rest of the ACL statement. In all other situations, this variable expands
10779 to nothing.
10780
10781 .vitem &$exim_gid$&
10782 .vindex "&$exim_gid$&"
10783 This variable contains the numerical value of the Exim group id.
10784
10785 .vitem &$exim_path$&
10786 .vindex "&$exim_path$&"
10787 This variable contains the path to the Exim binary.
10788
10789 .vitem &$exim_uid$&
10790 .vindex "&$exim_uid$&"
10791 This variable contains the numerical value of the Exim user id.
10792
10793 .vitem &$found_extension$&
10794 .vindex "&$found_extension$&"
10795 This variable is available when Exim is compiled with the
10796 content-scanning extension and the obsolete &%demime%& condition. For details,
10797 see section &<<SECTdemimecond>>&.
10798
10799 .vitem &$header_$&<&'name'&>
10800 This is not strictly an expansion variable. It is expansion syntax for
10801 inserting the message header line with the given name. Note that the name must
10802 be terminated by colon or white space, because it may contain a wide variety of
10803 characters. Note also that braces must &'not'& be used.
10804
10805 .vitem &$home$&
10806 .vindex "&$home$&"
10807 When the &%check_local_user%& option is set for a router, the user's home
10808 directory is placed in &$home$& when the check succeeds. In particular, this
10809 means it is set during the running of users' filter files. A router may also
10810 explicitly set a home directory for use by a transport; this can be overridden
10811 by a setting on the transport itself.
10812
10813 When running a filter test via the &%-bf%& option, &$home$& is set to the value
10814 of the environment variable HOME.
10815
10816 .vitem &$host$&
10817 .vindex "&$host$&"
10818 If a router assigns an address to a transport (any transport), and passes a
10819 list of hosts with the address, the value of &$host$& when the transport starts
10820 to run is the name of the first host on the list. Note that this applies both
10821 to local and remote transports.
10822
10823 .cindex "transport" "filter"
10824 .cindex "filter" "transport filter"
10825 For the &(smtp)& transport, if there is more than one host, the value of
10826 &$host$& changes as the transport works its way through the list. In
10827 particular, when the &(smtp)& transport is expanding its options for encryption
10828 using TLS, or for specifying a transport filter (see chapter
10829 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
10830 is connected.
10831
10832 When used in the client part of an authenticator configuration (see chapter
10833 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
10834 client is connected.
10835
10836
10837 .vitem &$host_address$&
10838 .vindex "&$host_address$&"
10839 This variable is set to the remote host's IP address whenever &$host$& is set
10840 for a remote connection. It is also set to the IP address that is being checked
10841 when the &%ignore_target_hosts%& option is being processed.
10842
10843 .vitem &$host_data$&
10844 .vindex "&$host_data$&"
10845 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
10846 result of the lookup is made available in the &$host_data$& variable. This
10847 allows you, for example, to do things like this:
10848 .code
10849 deny  hosts = net-lsearch;/some/file
10850 message = $host_data
10851 .endd
10852 .vitem &$host_lookup_deferred$&
10853 .cindex "host name" "lookup, failure of"
10854 .vindex "&$host_lookup_deferred$&"
10855 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
10856 message comes from a remote host and there is an attempt to look up the host's
10857 name from its IP address, and the attempt is not successful, one of these
10858 variables is set to &"1"&.
10859
10860 .ilist
10861 If the lookup receives a definite negative response (for example, a DNS lookup
10862 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
10863
10864 .next
10865 If there is any kind of problem during the lookup, such that Exim cannot
10866 tell whether or not the host name is defined (for example, a timeout for a DNS
10867 lookup), &$host_lookup_deferred$& is set to &"1"&.
10868 .endlist ilist
10869
10870 Looking up a host's name from its IP address consists of more than just a
10871 single reverse lookup. Exim checks that a forward lookup of at least one of the
10872 names it receives from a reverse lookup yields the original IP address. If this
10873 is not the case, Exim does not accept the looked up name(s), and
10874 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
10875 IP address (for example, the existence of a PTR record in the DNS) is not
10876 sufficient on its own for the success of a host name lookup. If the reverse
10877 lookup succeeds, but there is a lookup problem such as a timeout when checking
10878 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
10879 &"1"&. See also &$sender_host_name$&.
10880
10881 .vitem &$host_lookup_failed$&
10882 .vindex "&$host_lookup_failed$&"
10883 See &$host_lookup_deferred$&.
10884
10885
10886 .vitem &$inode$&
10887 .vindex "&$inode$&"
10888 The only time this variable is set is while expanding the &%directory_file%&
10889 option in the &(appendfile)& transport. The variable contains the inode number
10890 of the temporary file which is about to be renamed. It can be used to construct
10891 a unique name for the file.
10892
10893 .vitem &$interface_address$&
10894 .vindex "&$interface_address$&"
10895 This is an obsolete name for &$received_ip_address$&.
10896
10897 .vitem &$interface_port$&
10898 .vindex "&$interface_port$&"
10899 This is an obsolete name for &$received_port$&.
10900
10901 .vitem &$item$&
10902 .vindex "&$item$&"
10903 This variable is used during the expansion of &*forall*& and &*forany*&
10904 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
10905 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
10906 empty.
10907
10908 .vitem &$ldap_dn$&
10909 .vindex "&$ldap_dn$&"
10910 This variable, which is available only when Exim is compiled with LDAP support,
10911 contains the DN from the last entry in the most recently successful LDAP
10912 lookup.
10913
10914 .vitem &$load_average$&
10915 .vindex "&$load_average$&"
10916 This variable contains the system load average, multiplied by 1000 so that it
10917 is an integer. For example, if the load average is 0.21, the value of the
10918 variable is 210. The value is recomputed every time the variable is referenced.
10919
10920 .vitem &$local_part$&
10921 .vindex "&$local_part$&"
10922 When an address is being routed, or delivered on its own, this
10923 variable contains the local part. When a number of addresses are being
10924 delivered together (for example, multiple RCPT commands in an SMTP
10925 session), &$local_part$& is not set.
10926
10927 Global address rewriting happens when a message is received, so the value of
10928 &$local_part$& during routing and delivery is the value after rewriting.
10929 &$local_part$& is set during user filtering, but not during system filtering,
10930 because a message may have many recipients and the system filter is called just
10931 once.
10932
10933 .vindex "&$local_part_prefix$&"
10934 .vindex "&$local_part_suffix$&"
10935 If a local part prefix or suffix has been recognized, it is not included in the
10936 value of &$local_part$& during routing and subsequent delivery. The values of
10937 any prefix or suffix are in &$local_part_prefix$& and
10938 &$local_part_suffix$&, respectively.
10939
10940 When a message is being delivered to a file, pipe, or autoreply transport as a
10941 result of aliasing or forwarding, &$local_part$& is set to the local part of
10942 the parent address, not to the file name or command (see &$address_file$& and
10943 &$address_pipe$&).
10944
10945 When an ACL is running for a RCPT command, &$local_part$& contains the
10946 local part of the recipient address.
10947
10948 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
10949 &$local_part$& contains the local part of the address that is being rewritten;
10950 it can be used in the expansion of the replacement address, for example.
10951
10952 In all cases, all quoting is removed from the local part. For example, for both
10953 the addresses
10954 .code
10955 "abc:xyz"@test.example
10956 abc\:xyz@test.example
10957 .endd
10958 the value of &$local_part$& is
10959 .code
10960 abc:xyz
10961 .endd
10962 If you use &$local_part$& to create another address, you should always wrap it
10963 inside a quoting operator. For example, in a &(redirect)& router you could
10964 have:
10965 .code
10966 data = ${quote_local_part:$local_part}@new.domain.example
10967 .endd
10968 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
10969 to process local parts in a case-dependent manner in a router, you can set the
10970 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
10971
10972 .vitem &$local_part_data$&
10973 .vindex "&$local_part_data$&"
10974 When the &%local_parts%& option on a router matches a local part by means of a
10975 lookup, the data read by the lookup is available during the running of the
10976 router as &$local_part_data$&. In addition, if the driver routes the address
10977 to a transport, the value is available in that transport. If the transport is
10978 handling multiple addresses, the value from the first address is used.
10979
10980 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
10981 matches a local part by means of a lookup. The data read by the lookup is
10982 available during the rest of the ACL statement. In all other situations, this
10983 variable expands to nothing.
10984
10985 .vitem &$local_part_prefix$&
10986 .vindex "&$local_part_prefix$&"
10987 When an address is being routed or delivered, and a
10988 specific prefix for the local part was recognized, it is available in this
10989 variable, having been removed from &$local_part$&.
10990
10991 .vitem &$local_part_suffix$&
10992 .vindex "&$local_part_suffix$&"
10993 When an address is being routed or delivered, and a
10994 specific suffix for the local part was recognized, it is available in this
10995 variable, having been removed from &$local_part$&.
10996
10997 .vitem &$local_scan_data$&
10998 .vindex "&$local_scan_data$&"
10999 This variable contains the text returned by the &[local_scan()]& function when
11000 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
11001
11002 .vitem &$local_user_gid$&
11003 .vindex "&$local_user_gid$&"
11004 See &$local_user_uid$&.
11005
11006 .vitem &$local_user_uid$&
11007 .vindex "&$local_user_uid$&"
11008 This variable and &$local_user_gid$& are set to the uid and gid after the
11009 &%check_local_user%& router precondition succeeds. This means that their values
11010 are available for the remaining preconditions (&%senders%&, &%require_files%&,
11011 and &%condition%&), for the &%address_data%& expansion, and for any
11012 router-specific expansions. At all other times, the values in these variables
11013 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
11014
11015 .vitem &$localhost_number$&
11016 .vindex "&$localhost_number$&"
11017 This contains the expanded value of the
11018 &%localhost_number%& option. The expansion happens after the main options have
11019 been read.
11020
11021 .vitem &$log_inodes$&
11022 .vindex "&$log_inodes$&"
11023 The number of free inodes in the disk partition where Exim's
11024 log files are being written. The value is recalculated whenever the variable is
11025 referenced. If the relevant file system does not have the concept of inodes,
11026 the value of is -1. See also the &%check_log_inodes%& option.
11027
11028 .vitem &$log_space$&
11029 .vindex "&$log_space$&"
11030 The amount of free space (as a number of kilobytes) in the disk
11031 partition where Exim's log files are being written. The value is recalculated
11032 whenever the variable is referenced. If the operating system does not have the
11033 ability to find the amount of free space (only true for experimental systems),
11034 the space value is -1. See also the &%check_log_space%& option.
11035
11036
11037 .vitem &$mailstore_basename$&
11038 .vindex "&$mailstore_basename$&"
11039 This variable is set only when doing deliveries in &"mailstore"& format in the
11040 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
11041 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
11042 contains the basename of the files that are being written, that is, the name
11043 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
11044 variable is empty.
11045
11046 .vitem &$malware_name$&
11047 .vindex "&$malware_name$&"
11048 This variable is available when Exim is compiled with the
11049 content-scanning extension. It is set to the name of the virus that was found
11050 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
11051
11052 .vitem &$max_received_linelength$&
11053 .vindex "&$max_received_linelength$&"
11054 .cindex "maximum" "line length"
11055 .cindex "line length" "maximum"
11056 This variable contains the number of bytes in the longest line that was
11057 received as part of the message, not counting the line termination
11058 character(s).
11059
11060 .vitem &$message_age$&
11061 .cindex "message" "age of"
11062 .vindex "&$message_age$&"
11063 This variable is set at the start of a delivery attempt to contain the number
11064 of seconds since the message was received. It does not change during a single
11065 delivery attempt.
11066
11067 .vitem &$message_body$&
11068 .cindex "body of message" "expansion variable"
11069 .cindex "message body" "in expansion"
11070 .cindex "binary zero" "in message body"
11071 .vindex "&$message_body$&"
11072 .oindex "&%message_body_visible%&"
11073 This variable contains the initial portion of a message's body while it is
11074 being delivered, and is intended mainly for use in filter files. The maximum
11075 number of characters of the body that are put into the variable is set by the
11076 &%message_body_visible%& configuration option; the default is 500.
11077
11078 .oindex "&%message_body_newlines%&"
11079 By default, newlines are converted into spaces in &$message_body$&, to make it
11080 easier to search for phrases that might be split over a line break. However,
11081 this can be disabled by setting &%message_body_newlines%& to be true. Binary
11082 zeros are always converted into spaces.
11083
11084 .vitem &$message_body_end$&
11085 .cindex "body of message" "expansion variable"
11086 .cindex "message body" "in expansion"
11087 .vindex "&$message_body_end$&"
11088 This variable contains the final portion of a message's
11089 body while it is being delivered. The format and maximum size are as for
11090 &$message_body$&.
11091
11092 .vitem &$message_body_size$&
11093 .cindex "body of message" "size"
11094 .cindex "message body" "size"
11095 .vindex "&$message_body_size$&"
11096 When a message is being delivered, this variable contains the size of the body
11097 in bytes. The count starts from the character after the blank line that
11098 separates the body from the header. Newlines are included in the count. See
11099 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
11100
11101 .vitem &$message_exim_id$&
11102 .vindex "&$message_exim_id$&"
11103 When a message is being received or delivered, this variable contains the
11104 unique message id that is generated and used by Exim to identify the message.
11105 An id is not created for a message until after its header has been successfully
11106 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
11107 line; it is the local id that Exim assigns to the message, for example:
11108 &`1BXTIK-0001yO-VA`&.
11109
11110 .vitem &$message_headers$&
11111 .vindex &$message_headers$&
11112 This variable contains a concatenation of all the header lines when a message
11113 is being processed, except for lines added by routers or transports. The header
11114 lines are separated by newline characters. Their contents are decoded in the
11115 same way as a header line that is inserted by &%bheader%&.
11116
11117 .vitem &$message_headers_raw$&
11118 .vindex &$message_headers_raw$&
11119 This variable is like &$message_headers$& except that no processing of the
11120 contents of header lines is done.
11121
11122 .vitem &$message_id$&
11123 This is an old name for &$message_exim_id$&, which is now deprecated.
11124
11125 .vitem &$message_linecount$&
11126 .vindex "&$message_linecount$&"
11127 This variable contains the total number of lines in the header and body of the
11128 message. Compare &$body_linecount$&, which is the count for the body only.
11129 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
11130 number of lines received. Before delivery happens (that is, before filters,
11131 routers, and transports run) the count is increased to include the
11132 &'Received:'& header line that Exim standardly adds, and also any other header
11133 lines that are added by ACLs. The blank line that separates the message header
11134 from the body is not counted. Here is an example of the use of this variable in
11135 a DATA ACL:
11136 .code
11137 deny message   = Too many lines in message header
11138      condition = \
11139       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
11140 .endd
11141 In the MAIL and RCPT ACLs, the value is zero because at that stage the
11142 message has not yet been received.
11143
11144 .vitem &$message_size$&
11145 .cindex "size" "of message"
11146 .cindex "message" "size"
11147 .vindex "&$message_size$&"
11148 When a message is being processed, this variable contains its size in bytes. In
11149 most cases, the size includes those headers that were received with the
11150 message, but not those (such as &'Envelope-to:'&) that are added to individual
11151 deliveries as they are written. However, there is one special case: during the
11152 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
11153 doing a delivery in maildir format, the value of &$message_size$& is the
11154 precise size of the file that has been written. See also
11155 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
11156
11157 .cindex "RCPT" "value of &$message_size$&"
11158 While running a per message ACL (mail/rcpt/predata), &$message_size$&
11159 contains the size supplied on the MAIL command, or -1 if no size was given. The
11160 value may not, of course, be truthful.
11161
11162 .vitem &$mime_$&&'xxx'&
11163 A number of variables whose names start with &$mime$& are
11164 available when Exim is compiled with the content-scanning extension. For
11165 details, see section &<<SECTscanmimepart>>&.
11166
11167 .vitem "&$n0$& &-- &$n9$&"
11168 These variables are counters that can be incremented by means
11169 of the &%add%& command in filter files.
11170
11171 .vitem &$original_domain$&
11172 .vindex "&$domain$&"
11173 .vindex "&$original_domain$&"
11174 When a top-level address is being processed for delivery, this contains the
11175 same value as &$domain$&. However, if a &"child"& address (for example,
11176 generated by an alias, forward, or filter file) is being processed, this
11177 variable contains the domain of the original address (lower cased). This
11178 differs from &$parent_domain$& only when there is more than one level of
11179 aliasing or forwarding. When more than one address is being delivered in a
11180 single transport run, &$original_domain$& is not set.
11181
11182 If a new address is created by means of a &%deliver%& command in a system
11183 filter, it is set up with an artificial &"parent"& address. This has the local
11184 part &'system-filter'& and the default qualify domain.
11185
11186 .vitem &$original_local_part$&
11187 .vindex "&$local_part$&"
11188 .vindex "&$original_local_part$&"
11189 When a top-level address is being processed for delivery, this contains the
11190 same value as &$local_part$&, unless a prefix or suffix was removed from the
11191 local part, because &$original_local_part$& always contains the full local
11192 part. When a &"child"& address (for example, generated by an alias, forward, or
11193 filter file) is being processed, this variable contains the full local part of
11194 the original address.
11195
11196 If the router that did the redirection processed the local part
11197 case-insensitively, the value in &$original_local_part$& is in lower case.
11198 This variable differs from &$parent_local_part$& only when there is more than
11199 one level of aliasing or forwarding. When more than one address is being
11200 delivered in a single transport run, &$original_local_part$& is not set.
11201
11202 If a new address is created by means of a &%deliver%& command in a system
11203 filter, it is set up with an artificial &"parent"& address. This has the local
11204 part &'system-filter'& and the default qualify domain.
11205
11206 .vitem &$originator_gid$&
11207 .cindex "gid (group id)" "of originating user"
11208 .cindex "sender" "gid"
11209 .vindex "&$caller_gid$&"
11210 .vindex "&$originator_gid$&"
11211 This variable contains the value of &$caller_gid$& that was set when the
11212 message was received. For messages received via the command line, this is the
11213 gid of the sending user. For messages received by SMTP over TCP/IP, this is
11214 normally the gid of the Exim user.
11215
11216 .vitem &$originator_uid$&
11217 .cindex "uid (user id)" "of originating user"
11218 .cindex "sender" "uid"
11219 .vindex "&$caller_uid$&"
11220 .vindex "&$originaltor_uid$&"
11221 The value of &$caller_uid$& that was set when the message was received. For
11222 messages received via the command line, this is the uid of the sending user.
11223 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
11224 user.
11225
11226 .vitem &$parent_domain$&
11227 .vindex "&$parent_domain$&"
11228 This variable is similar to &$original_domain$& (see
11229 above), except that it refers to the immediately preceding parent address.
11230
11231 .vitem &$parent_local_part$&
11232 .vindex "&$parent_local_part$&"
11233 This variable is similar to &$original_local_part$&
11234 (see above), except that it refers to the immediately preceding parent address.
11235
11236 .vitem &$pid$&
11237 .cindex "pid (process id)" "of current process"
11238 .vindex "&$pid$&"
11239 This variable contains the current process id.
11240
11241 .vitem &$pipe_addresses$&
11242 .cindex "filter" "transport filter"
11243 .cindex "transport" "filter"
11244 .vindex "&$pipe_addresses$&"
11245 This is not an expansion variable, but is mentioned here because the string
11246 &`$pipe_addresses`& is handled specially in the command specification for the
11247 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
11248 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
11249 It cannot be used in general expansion strings, and provokes an &"unknown
11250 variable"& error if encountered.
11251
11252 .vitem &$primary_hostname$&
11253 .vindex "&$primary_hostname$&"
11254 This variable contains the value set by &%primary_hostname%& in the
11255 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
11256 a single-component name, Exim calls &[gethostbyname()]& (or
11257 &[getipnodebyname()]& where available) in an attempt to acquire a fully
11258 qualified host name. See also &$smtp_active_hostname$&.
11259
11260
11261 .vitem &$prvscheck_address$&
11262 This variable is used in conjunction with the &%prvscheck%& expansion item,
11263 which is described in sections &<<SECTexpansionitems>>& and
11264 &<<SECTverifyPRVS>>&.
11265
11266 .vitem &$prvscheck_keynum$&
11267 This variable is used in conjunction with the &%prvscheck%& expansion item,
11268 which is described in sections &<<SECTexpansionitems>>& and
11269 &<<SECTverifyPRVS>>&.
11270
11271 .vitem &$prvscheck_result$&
11272 This variable is used in conjunction with the &%prvscheck%& expansion item,
11273 which is described in sections &<<SECTexpansionitems>>& and
11274 &<<SECTverifyPRVS>>&.
11275
11276 .vitem &$qualify_domain$&
11277 .vindex "&$qualify_domain$&"
11278 The value set for the &%qualify_domain%& option in the configuration file.
11279
11280 .vitem &$qualify_recipient$&
11281 .vindex "&$qualify_recipient$&"
11282 The value set for the &%qualify_recipient%& option in the configuration file,
11283 or if not set, the value of &$qualify_domain$&.
11284
11285 .vitem &$rcpt_count$&
11286 .vindex "&$rcpt_count$&"
11287 When a message is being received by SMTP, this variable contains the number of
11288 RCPT commands received for the current message. If this variable is used in a
11289 RCPT ACL, its value includes the current command.
11290
11291 .vitem &$rcpt_defer_count$&
11292 .vindex "&$rcpt_defer_count$&"
11293 .cindex "4&'xx'& responses" "count of"
11294 When a message is being received by SMTP, this variable contains the number of
11295 RCPT commands in the current message that have previously been rejected with a
11296 temporary (4&'xx'&) response.
11297
11298 .vitem &$rcpt_fail_count$&
11299 .vindex "&$rcpt_fail_count$&"
11300 When a message is being received by SMTP, this variable contains the number of
11301 RCPT commands in the current message that have previously been rejected with a
11302 permanent (5&'xx'&) response.
11303
11304 .vitem &$received_count$&
11305 .vindex "&$received_count$&"
11306 This variable contains the number of &'Received:'& header lines in the message,
11307 including the one added by Exim (so its value is always greater than zero). It
11308 is available in the DATA ACL, the non-SMTP ACL, and while routing and
11309 delivering.
11310
11311 .vitem &$received_for$&
11312 .vindex "&$received_for$&"
11313 If there is only a single recipient address in an incoming message, this
11314 variable contains that address when the &'Received:'& header line is being
11315 built. The value is copied after recipient rewriting has happened, but before
11316 the &[local_scan()]& function is run.
11317
11318 .vitem &$received_ip_address$&
11319 .vindex "&$received_ip_address$&"
11320 As soon as an Exim server starts processing an incoming TCP/IP connection, this
11321 variable is set to the address of the local IP interface, and &$received_port$&
11322 is set to the local port number. (The remote IP address and port are in
11323 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
11324 the port value is -1 unless it has been set using the &%-oMi%& command line
11325 option.
11326
11327 As well as being useful in ACLs (including the &"connect"& ACL), these variable
11328 could be used, for example, to make the file name for a TLS certificate depend
11329 on which interface and/or port is being used for the incoming connection. The
11330 values of &$received_ip_address$& and &$received_port$& are saved with any
11331 messages that are received, thus making these variables available at delivery
11332 time.
11333
11334 &*Note:*& There are no equivalent variables for outgoing connections, because
11335 the values are unknown (unless they are explicitly set by options of the
11336 &(smtp)& transport).
11337
11338 .vitem &$received_port$&
11339 .vindex "&$received_port$&"
11340 See &$received_ip_address$&.
11341
11342 .vitem &$received_protocol$&
11343 .vindex "&$received_protocol$&"
11344 When a message is being processed, this variable contains the name of the
11345 protocol by which it was received. Most of the names used by Exim are defined
11346 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
11347 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
11348 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
11349 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
11350 connection and the client was successfully authenticated.
11351
11352 Exim uses the protocol name &"smtps"& for the case when encryption is
11353 automatically set up on connection without the use of STARTTLS (see
11354 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
11355 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
11356 where the client initially uses EHLO, sets up an encrypted connection using
11357 STARTTLS, and then uses HELO afterwards.
11358
11359 The &%-oMr%& option provides a way of specifying a custom protocol name for
11360 messages that are injected locally by trusted callers. This is commonly used to
11361 identify messages that are being re-injected after some kind of scanning.
11362
11363 .vitem &$received_time$&
11364 .vindex "&$received_time$&"
11365 This variable contains the date and time when the current message was received,
11366 as a number of seconds since the start of the Unix epoch.
11367
11368 .vitem &$recipient_data$&
11369 .vindex "&$recipient_data$&"
11370 This variable is set after an indexing lookup success in an ACL &%recipients%&
11371 condition. It contains the data from the lookup, and the value remains set
11372 until the next &%recipients%& test. Thus, you can do things like this:
11373 .display
11374 &`require recipients  = cdb*@;/some/file`&
11375 &`deny    `&&'some further test involving'& &`$recipient_data`&
11376 .endd
11377 &*Warning*&: This variable is set only when a lookup is used as an indexing
11378 method in the address list, using the semicolon syntax as in the example above.
11379 The variable is not set for a lookup that is used as part of the string
11380 expansion that all such lists undergo before being interpreted.
11381
11382 .vitem &$recipient_verify_failure$&
11383 .vindex "&$recipient_verify_failure$&"
11384 In an ACL, when a recipient verification fails, this variable contains
11385 information about the failure. It is set to one of the following words:
11386
11387 .ilist
11388 &"qualify"&: The address was unqualified (no domain), and the message
11389 was neither local nor came from an exempted host.
11390
11391 .next
11392 &"route"&: Routing failed.
11393
11394 .next
11395 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
11396 or before the MAIL command (that is, on initial connection, HELO, or
11397 MAIL).
11398
11399 .next
11400 &"recipient"&: The RCPT command in a callout was rejected.
11401 .next
11402
11403 &"postmaster"&: The postmaster check in a callout was rejected.
11404 .endlist
11405
11406 The main use of this variable is expected to be to distinguish between
11407 rejections of MAIL and rejections of RCPT.
11408
11409 .vitem &$recipients$&
11410 .vindex "&$recipients$&"
11411 This variable contains a list of envelope recipients for a message. A comma and
11412 a space separate the addresses in the replacement text. However, the variable
11413 is not generally available, to prevent exposure of Bcc recipients in
11414 unprivileged users' filter files. You can use &$recipients$& only in these
11415 cases:
11416
11417 .olist
11418 In a system filter file.
11419 .next
11420 In the ACLs associated with the DATA command and with non-SMTP messages, that
11421 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
11422 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
11423 &%acl_not_smtp_mime%&.
11424 .next
11425 From within a &[local_scan()]& function.
11426 .endlist
11427
11428
11429 .vitem &$recipients_count$&
11430 .vindex "&$recipients_count$&"
11431 When a message is being processed, this variable contains the number of
11432 envelope recipients that came with the message. Duplicates are not excluded
11433 from the count. While a message is being received over SMTP, the number
11434 increases for each accepted recipient. It can be referenced in an ACL.
11435
11436
11437 .vitem &$regex_match_string$&
11438 .vindex "&$regex_match_string$&"
11439 This variable is set to contain the matching regular expression after a
11440 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
11441
11442
11443 .vitem &$reply_address$&
11444 .vindex "&$reply_address$&"
11445 When a message is being processed, this variable contains the contents of the
11446 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
11447 contents of the &'From:'& header line. Apart from the removal of leading
11448 white space, the value is not processed in any way. In particular, no RFC 2047
11449 decoding or character code translation takes place.
11450
11451 .vitem &$return_path$&
11452 .vindex "&$return_path$&"
11453 When a message is being delivered, this variable contains the return path &--
11454 the sender field that will be sent as part of the envelope. It is not enclosed
11455 in <> characters. At the start of routing an address, &$return_path$& has the
11456 same value as &$sender_address$&, but if, for example, an incoming message to a
11457 mailing list has been expanded by a router which specifies a different address
11458 for bounce messages, &$return_path$& subsequently contains the new bounce
11459 address, whereas &$sender_address$& always contains the original sender address
11460 that was received with the message. In other words, &$sender_address$& contains
11461 the incoming envelope sender, and &$return_path$& contains the outgoing
11462 envelope sender.
11463
11464 .vitem &$return_size_limit$&
11465 .vindex "&$return_size_limit$&"
11466 This is an obsolete name for &$bounce_return_size_limit$&.
11467
11468 .vitem &$runrc$&
11469 .cindex "return code" "from &%run%& expansion"
11470 .vindex "&$runrc$&"
11471 This variable contains the return code from a command that is run by the
11472 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
11473 assume the order in which option values are expanded, except for those
11474 preconditions whose order of testing is documented. Therefore, you cannot
11475 reliably expect to set &$runrc$& by the expansion of one option, and use it in
11476 another.
11477
11478 .vitem &$self_hostname$&
11479 .oindex "&%self%&" "value of host name"
11480 .vindex "&$self_hostname$&"
11481 When an address is routed to a supposedly remote host that turns out to be the
11482 local host, what happens is controlled by the &%self%& generic router option.
11483 One of its values causes the address to be passed to another router. When this
11484 happens, &$self_hostname$& is set to the name of the local host that the
11485 original router encountered. In other circumstances its contents are null.
11486
11487 .vitem &$sender_address$&
11488 .vindex "&$sender_address$&"
11489 When a message is being processed, this variable contains the sender's address
11490 that was received in the message's envelope. The case of letters in the address
11491 is retained, in both the local part and the domain. For bounce messages, the
11492 value of this variable is the empty string. See also &$return_path$&.
11493
11494 .vitem &$sender_address_data$&
11495 .vindex "&$address_data$&"
11496 .vindex "&$sender_address_data$&"
11497 If &$address_data$& is set when the routers are called from an ACL to verify a
11498 sender address, the final value is preserved in &$sender_address_data$&, to
11499 distinguish it from data from a recipient address. The value does not persist
11500 after the end of the current ACL statement. If you want to preserve it for
11501 longer, you can save it in an ACL variable.
11502
11503 .vitem &$sender_address_domain$&
11504 .vindex "&$sender_address_domain$&"
11505 The domain portion of &$sender_address$&.
11506
11507 .vitem &$sender_address_local_part$&
11508 .vindex "&$sender_address_local_part$&"
11509 The local part portion of &$sender_address$&.
11510
11511 .vitem &$sender_data$&
11512 .vindex "&$sender_data$&"
11513 This variable is set after a lookup success in an ACL &%senders%& condition or
11514 in a router &%senders%& option. It contains the data from the lookup, and the
11515 value remains set until the next &%senders%& test. Thus, you can do things like
11516 this:
11517 .display
11518 &`require senders      = cdb*@;/some/file`&
11519 &`deny    `&&'some further test involving'& &`$sender_data`&
11520 .endd
11521 &*Warning*&: This variable is set only when a lookup is used as an indexing
11522 method in the address list, using the semicolon syntax as in the example above.
11523 The variable is not set for a lookup that is used as part of the string
11524 expansion that all such lists undergo before being interpreted.
11525
11526 .vitem &$sender_fullhost$&
11527 .vindex "&$sender_fullhost$&"
11528 When a message is received from a remote host, this variable contains the host
11529 name and IP address in a single string. It ends with the IP address in square
11530 brackets, followed by a colon and a port number if the logging of ports is
11531 enabled. The format of the rest of the string depends on whether the host
11532 issued a HELO or EHLO SMTP command, and whether the host name was verified by
11533 looking up its IP address. (Looking up the IP address can be forced by the
11534 &%host_lookup%& option, independent of verification.) A plain host name at the
11535 start of the string is a verified host name; if this is not present,
11536 verification either failed or was not requested. A host name in parentheses is
11537 the argument of a HELO or EHLO command. This is omitted if it is identical to
11538 the verified host name or to the host's IP address in square brackets.
11539
11540 .vitem &$sender_helo_name$&
11541 .vindex "&$sender_helo_name$&"
11542 When a message is received from a remote host that has issued a HELO or EHLO
11543 command, the argument of that command is placed in this variable. It is also
11544 set if HELO or EHLO is used when a message is received using SMTP locally via
11545 the &%-bs%& or &%-bS%& options.
11546
11547 .vitem &$sender_host_address$&
11548 .vindex "&$sender_host_address$&"
11549 When a message is received from a remote host, this variable contains that
11550 host's IP address. For locally submitted messages, it is empty.
11551
11552 .vitem &$sender_host_authenticated$&
11553 .vindex "&$sender_host_authenticated$&"
11554 This variable contains the name (not the public name) of the authenticator
11555 driver that successfully authenticated the client from which the message was
11556 received. It is empty if there was no successful authentication. See also
11557 &$authenticated_id$&.
11558
11559 .vitem &$sender_host_name$&
11560 .vindex "&$sender_host_name$&"
11561 When a message is received from a remote host, this variable contains the
11562 host's name as obtained by looking up its IP address. For messages received by
11563 other means, this variable is empty.
11564
11565 .vindex "&$host_lookup_failed$&"
11566 If the host name has not previously been looked up, a reference to
11567 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
11568 A looked up name is accepted only if it leads back to the original IP address
11569 via a forward lookup. If either the reverse or the forward lookup fails to find
11570 any data, or if the forward lookup does not yield the original IP address,
11571 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
11572
11573 .vindex "&$host_lookup_deferred$&"
11574 However, if either of the lookups cannot be completed (for example, there is a
11575 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
11576 &$host_lookup_failed$& remains set to &"0"&.
11577
11578 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
11579 host name again if there is a subsequent reference to &$sender_host_name$&
11580 in the same Exim process, but it does try again if &$host_lookup_deferred$&
11581 is set to &"1"&.
11582
11583 Exim does not automatically look up every calling host's name. If you want
11584 maximum efficiency, you should arrange your configuration so that it avoids
11585 these lookups altogether. The lookup happens only if one or more of the
11586 following are true:
11587
11588 .ilist
11589 A string containing &$sender_host_name$& is expanded.
11590 .next
11591 The calling host matches the list in &%host_lookup%&. In the default
11592 configuration, this option is set to *, so it must be changed if lookups are
11593 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
11594 .next
11595 Exim needs the host name in order to test an item in a host list. The items
11596 that require this are described in sections &<<SECThoslispatnam>>& and
11597 &<<SECThoslispatnamsk>>&.
11598 .next
11599 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
11600 In this case, the host name is required to compare with the name quoted in any
11601 EHLO or HELO commands that the client issues.
11602 .next
11603 The remote host issues a EHLO or HELO command that quotes one of the
11604 domains in &%helo_lookup_domains%&. The default value of this option is
11605 . ==== As this is a nested list, any displays it contains must be indented
11606 . ==== as otherwise they are too far to the left.
11607 .code
11608   helo_lookup_domains = @ : @[]
11609 .endd
11610 which causes a lookup if a remote host (incorrectly) gives the server's name or
11611 IP address in an EHLO or HELO command.
11612 .endlist
11613
11614
11615 .vitem &$sender_host_port$&
11616 .vindex "&$sender_host_port$&"
11617 When a message is received from a remote host, this variable contains the port
11618 number that was used on the remote host.
11619
11620 .vitem &$sender_ident$&
11621 .vindex "&$sender_ident$&"
11622 When a message is received from a remote host, this variable contains the
11623 identification received in response to an RFC 1413 request. When a message has
11624 been received locally, this variable contains the login name of the user that
11625 called Exim.
11626
11627 .vitem &$sender_rate_$&&'xxx'&
11628 A number of variables whose names begin &$sender_rate_$& are set as part of the
11629 &%ratelimit%& ACL condition. Details are given in section
11630 &<<SECTratelimiting>>&.
11631
11632 .vitem &$sender_rcvhost$&
11633 .cindex "DNS" "reverse lookup"
11634 .cindex "reverse DNS lookup"
11635 .vindex "&$sender_rcvhost$&"
11636 This is provided specifically for use in &'Received:'& headers. It starts with
11637 either the verified host name (as obtained from a reverse DNS lookup) or, if
11638 there is no verified host name, the IP address in square brackets. After that
11639 there may be text in parentheses. When the first item is a verified host name,
11640 the first thing in the parentheses is the IP address in square brackets,
11641 followed by a colon and a port number if port logging is enabled. When the
11642 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
11643 the parentheses.
11644
11645 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
11646 was used and its argument was not identical to the real host name or IP
11647 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
11648 all three items are present in the parentheses, a newline and tab are inserted
11649 into the string, to improve the formatting of the &'Received:'& header.
11650
11651 .vitem &$sender_verify_failure$&
11652 .vindex "&$sender_verify_failure$&"
11653 In an ACL, when a sender verification fails, this variable contains information
11654 about the failure. The details are the same as for
11655 &$recipient_verify_failure$&.
11656
11657 .vitem &$sending_ip_address$&
11658 .vindex "&$sending_ip_address$&"
11659 This variable is set whenever an outgoing SMTP connection to another host has
11660 been set up. It contains the IP address of the local interface that is being
11661 used. This is useful if a host that has more than one IP address wants to take
11662 on different personalities depending on which one is being used. For incoming
11663 connections, see &$received_ip_address$&.
11664
11665 .vitem &$sending_port$&
11666 .vindex "&$sending_port$&"
11667 This variable is set whenever an outgoing SMTP connection to another host has
11668 been set up. It contains the local port that is being used. For incoming
11669 connections, see &$received_port$&.
11670
11671 .vitem &$smtp_active_hostname$&
11672 .vindex "&$smtp_active_hostname$&"
11673 During an incoming SMTP session, this variable contains the value of the active
11674 host name, as specified by the &%smtp_active_hostname%& option. The value of
11675 &$smtp_active_hostname$& is saved with any message that is received, so its
11676 value can be consulted during routing and delivery.
11677
11678 .vitem &$smtp_command$&
11679 .vindex "&$smtp_command$&"
11680 During the processing of an incoming SMTP command, this variable contains the
11681 entire command. This makes it possible to distinguish between HELO and EHLO in
11682 the HELO ACL, and also to distinguish between commands such as these:
11683 .code
11684 MAIL FROM:<>
11685 MAIL FROM: <>
11686 .endd
11687 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
11688 command, the address in &$smtp_command$& is the original address before any
11689 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
11690 the address after SMTP-time rewriting.
11691
11692 .vitem &$smtp_command_argument$&
11693 .cindex "SMTP" "command, argument for"
11694 .vindex "&$smtp_command_argument$&"
11695 While an ACL is running to check an SMTP command, this variable contains the
11696 argument, that is, the text that follows the command name, with leading white
11697 space removed. Following the introduction of &$smtp_command$&, this variable is
11698 somewhat redundant, but is retained for backwards compatibility.
11699
11700 .vitem &$smtp_count_at_connection_start$&
11701 .vindex "&$smtp_count_at_connection_start$&"
11702 This variable is set greater than zero only in processes spawned by the Exim
11703 daemon for handling incoming SMTP connections. The name is deliberately long,
11704 in order to emphasize what the contents are. When the daemon accepts a new
11705 connection, it increments this variable. A copy of the variable is passed to
11706 the child process that handles the connection, but its value is fixed, and
11707 never changes. It is only an approximation of how many incoming connections
11708 there actually are, because many other connections may come and go while a
11709 single connection is being processed. When a child process terminates, the
11710 daemon decrements its copy of the variable.
11711
11712 .vitem "&$sn0$& &-- &$sn9$&"
11713 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
11714 that were current at the end of the system filter file. This allows a system
11715 filter file to set values that can be tested in users' filter files. For
11716 example, a system filter could set a value indicating how likely it is that a
11717 message is junk mail.
11718
11719 .vitem &$spam_$&&'xxx'&
11720 A number of variables whose names start with &$spam$& are available when Exim
11721 is compiled with the content-scanning extension. For details, see section
11722 &<<SECTscanspamass>>&.
11723
11724
11725 .vitem &$spool_directory$&
11726 .vindex "&$spool_directory$&"
11727 The name of Exim's spool directory.
11728
11729 .vitem &$spool_inodes$&
11730 .vindex "&$spool_inodes$&"
11731 The number of free inodes in the disk partition where Exim's spool files are
11732 being written. The value is recalculated whenever the variable is referenced.
11733 If the relevant file system does not have the concept of inodes, the value of
11734 is -1. See also the &%check_spool_inodes%& option.
11735
11736 .vitem &$spool_space$&
11737 .vindex "&$spool_space$&"
11738 The amount of free space (as a number of kilobytes) in the disk partition where
11739 Exim's spool files are being written. The value is recalculated whenever the
11740 variable is referenced. If the operating system does not have the ability to
11741 find the amount of free space (only true for experimental systems), the space
11742 value is -1. For example, to check in an ACL that there is at least 50
11743 megabytes free on the spool, you could write:
11744 .code
11745 condition = ${if > {$spool_space}{50000}}
11746 .endd
11747 See also the &%check_spool_space%& option.
11748
11749
11750 .vitem &$thisaddress$&
11751 .vindex "&$thisaddress$&"
11752 This variable is set only during the processing of the &%foranyaddress%&
11753 command in a filter file. Its use is explained in the description of that
11754 command, which can be found in the separate document entitled &'Exim's
11755 interfaces to mail filtering'&.
11756
11757 .vitem &$tls_certificate_verified$&
11758 .vindex "&$tls_certificate_verified$&"
11759 This variable is set to &"1"& if a TLS certificate was verified when the
11760 message was received, and &"0"& otherwise.
11761
11762 .vitem &$tls_cipher$&
11763 .vindex "&$tls_cipher$&"
11764 When a message is received from a remote host over an encrypted SMTP
11765 connection, this variable is set to the cipher suite that was negotiated, for
11766 example DES-CBC3-SHA. In other circumstances, in particular, for message
11767 received over unencrypted connections, the variable is empty. Testing
11768 &$tls_cipher$& for emptiness is one way of distinguishing between encrypted and
11769 non-encrypted connections during ACL processing.
11770
11771 The &$tls_cipher$& variable retains its value during message delivery, except
11772 when an outward SMTP delivery takes place via the &(smtp)& transport. In this
11773 case, &$tls_cipher$& is cleared before any outgoing SMTP connection is made,
11774 and then set to the outgoing cipher suite if one is negotiated. See chapter
11775 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
11776 details of the &(smtp)& transport.
11777
11778 .vitem &$tls_peerdn$&
11779 .vindex "&$tls_peerdn$&"
11780 When a message is received from a remote host over an encrypted SMTP
11781 connection, and Exim is configured to request a certificate from the client,
11782 the value of the Distinguished Name of the certificate is made available in the
11783 &$tls_peerdn$& during subsequent processing. Like &$tls_cipher$&, the
11784 value is retained during message delivery, except during outbound SMTP
11785 deliveries.
11786
11787 .vitem &$tod_bsdinbox$&
11788 .vindex "&$tod_bsdinbox$&"
11789 The time of day and the date, in the format required for BSD-style mailbox
11790 files, for example: Thu Oct 17 17:14:09 1995.
11791
11792 .vitem &$tod_epoch$&
11793 .vindex "&$tod_epoch$&"
11794 The time and date as a number of seconds since the start of the Unix epoch.
11795
11796 .vitem &$tod_full$&
11797 .vindex "&$tod_full$&"
11798 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
11799 +0100. The timezone is always given as a numerical offset from UTC, with
11800 positive values used for timezones that are ahead (east) of UTC, and negative
11801 values for those that are behind (west).
11802
11803 .vitem &$tod_log$&
11804 .vindex "&$tod_log$&"
11805 The time and date in the format used for writing Exim's log files, for example:
11806 1995-10-12 15:32:29, but without a timezone.
11807
11808 .vitem &$tod_logfile$&
11809 .vindex "&$tod_logfile$&"
11810 This variable contains the date in the format yyyymmdd. This is the format that
11811 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
11812 flag.
11813
11814 .vitem &$tod_zone$&
11815 .vindex "&$tod_zone$&"
11816 This variable contains the numerical value of the local timezone, for example:
11817 -0500.
11818
11819 .vitem &$tod_zulu$&
11820 .vindex "&$tod_zulu$&"
11821 This variable contains the UTC date and time in &"Zulu"& format, as specified
11822 by ISO 8601, for example: 20030221154023Z.
11823
11824 .vitem &$value$&
11825 .vindex "&$value$&"
11826 This variable contains the result of an expansion lookup, extraction operation,
11827 or external command, as described above. It is also used during a
11828 &*reduce*& expansion.
11829
11830 .vitem &$version_number$&
11831 .vindex "&$version_number$&"
11832 The version number of Exim.
11833
11834 .vitem &$warn_message_delay$&
11835 .vindex "&$warn_message_delay$&"
11836 This variable is set only during the creation of a message warning about a
11837 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
11838
11839 .vitem &$warn_message_recipients$&
11840 .vindex "&$warn_message_recipients$&"
11841 This variable is set only during the creation of a message warning about a
11842 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
11843 .endlist
11844 .ecindex IIDstrexp
11845
11846
11847
11848 . ////////////////////////////////////////////////////////////////////////////
11849 . ////////////////////////////////////////////////////////////////////////////
11850
11851 .chapter "Embedded Perl" "CHAPperl"
11852 .scindex IIDperl "Perl" "calling from Exim"
11853 Exim can be built to include an embedded Perl interpreter. When this is done,
11854 Perl subroutines can be called as part of the string expansion process. To make
11855 use of the Perl support, you need version 5.004 or later of Perl installed on
11856 your system. To include the embedded interpreter in the Exim binary, include
11857 the line
11858 .code
11859 EXIM_PERL = perl.o
11860 .endd
11861 in your &_Local/Makefile_& and then build Exim in the normal way.
11862
11863
11864 .section "Setting up so Perl can be used" "SECID85"
11865 .oindex "&%perl_startup%&"
11866 Access to Perl subroutines is via a global configuration option called
11867 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
11868 no &%perl_startup%& option in the Exim configuration file then no Perl
11869 interpreter is started and there is almost no overhead for Exim (since none of
11870 the Perl library will be paged in unless used). If there is a &%perl_startup%&
11871 option then the associated value is taken to be Perl code which is executed in
11872 a newly created Perl interpreter.
11873
11874 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
11875 need backslashes before any characters to escape special meanings. The option
11876 should usually be something like
11877 .code
11878 perl_startup = do '/etc/exim.pl'
11879 .endd
11880 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
11881 use from Exim. Exim can be configured either to start up a Perl interpreter as
11882 soon as it is entered, or to wait until the first time it is needed. Starting
11883 the interpreter at the beginning ensures that it is done while Exim still has
11884 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
11885 fact used in a particular run. Also, note that this does not mean that Exim is
11886 necessarily running as root when Perl is called at a later time. By default,
11887 the interpreter is started only when it is needed, but this can be changed in
11888 two ways:
11889
11890 .ilist
11891 .oindex "&%perl_at_start%&"
11892 Setting &%perl_at_start%& (a boolean option) in the configuration requests
11893 a startup when Exim is entered.
11894 .next
11895 The command line option &%-ps%& also requests a startup when Exim is entered,
11896 overriding the setting of &%perl_at_start%&.
11897 .endlist
11898
11899 There is also a command line option &%-pd%& (for delay) which suppresses the
11900 initial startup, even if &%perl_at_start%& is set.
11901
11902
11903 .section "Calling Perl subroutines" "SECID86"
11904 When the configuration file includes a &%perl_startup%& option you can make use
11905 of the string expansion item to call the Perl subroutines that are defined
11906 by the &%perl_startup%& code. The operator is used in any of the following
11907 forms:
11908 .code
11909 ${perl{foo}}
11910 ${perl{foo}{argument}}
11911 ${perl{foo}{argument1}{argument2} ... }
11912 .endd
11913 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
11914 arguments may be passed. Passing more than this results in an expansion failure
11915 with an error message of the form
11916 .code
11917 Too many arguments passed to Perl subroutine "foo" (max is 8)
11918 .endd
11919 The return value of the Perl subroutine is evaluated in a scalar context before
11920 it is passed back to Exim to be inserted into the expanded string. If the
11921 return value is &'undef'&, the expansion is forced to fail in the same way as
11922 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
11923 by obeying Perl's &%die%& function, the expansion fails with the error message
11924 that was passed to &%die%&.
11925
11926
11927 .section "Calling Exim functions from Perl" "SECID87"
11928 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
11929 is available to call back into Exim's string expansion function. For example,
11930 the Perl code
11931 .code
11932 my $lp = Exim::expand_string('$local_part');
11933 .endd
11934 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
11935 Note those are single quotes and not double quotes to protect against
11936 &$local_part$& being interpolated as a Perl variable.
11937
11938 If the string expansion is forced to fail by a &"fail"& item, the result of
11939 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
11940 expansion string, the Perl call from the original expansion string fails with
11941 an appropriate error message, in the same way as if &%die%& were used.
11942
11943 .cindex "debugging" "from embedded Perl"
11944 .cindex "log" "writing from embedded Perl"
11945 Two other Exim functions are available for use from within Perl code.
11946 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
11947 debugging is enabled. If you want a newline at the end, you must supply it.
11948 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
11949 timestamp. In this case, you should not supply a terminating newline.
11950
11951
11952 .section "Use of standard output and error by Perl" "SECID88"
11953 .cindex "Perl" "standard output and error"
11954 You should not write to the standard error or output streams from within your
11955 Perl code, as it is not defined how these are set up. In versions of Exim
11956 before 4.50, it is possible for the standard output or error to refer to the
11957 SMTP connection during message reception via the daemon. Writing to this stream
11958 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
11959 error streams are connected to &_/dev/null_& in the daemon. The chaos is
11960 avoided, but the output is lost.
11961
11962 .cindex "Perl" "use of &%warn%&"
11963 The Perl &%warn%& statement writes to the standard error stream by default.
11964 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
11965 you have no control. When Exim starts up the Perl interpreter, it arranges for
11966 output from the &%warn%& statement to be written to the Exim main log. You can
11967 change this by including appropriate Perl magic somewhere in your Perl code.
11968 For example, to discard &%warn%& output completely, you need this:
11969 .code
11970 $SIG{__WARN__} = sub { };
11971 .endd
11972 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
11973 example, the code for the subroutine is empty, so it does nothing, but you can
11974 include any Perl code that you like. The text of the &%warn%& message is passed
11975 as the first subroutine argument.
11976 .ecindex IIDperl
11977
11978
11979 . ////////////////////////////////////////////////////////////////////////////
11980 . ////////////////////////////////////////////////////////////////////////////
11981
11982 .chapter "Starting the daemon and the use of network interfaces" &&&
11983          "CHAPinterfaces" &&&
11984          "Starting the daemon"
11985 .cindex "daemon" "starting"
11986 .cindex "interface" "listening"
11987 .cindex "network interface"
11988 .cindex "interface" "network"
11989 .cindex "IP address" "for listening"
11990 .cindex "daemon" "listening IP addresses"
11991 .cindex "TCP/IP" "setting listening interfaces"
11992 .cindex "TCP/IP" "setting listening ports"
11993 A host that is connected to a TCP/IP network may have one or more physical
11994 hardware network interfaces. Each of these interfaces may be configured as one
11995 or more &"logical"& interfaces, which are the entities that a program actually
11996 works with. Each of these logical interfaces is associated with an IP address.
11997 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
11998 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
11999 knowledge about the host's interfaces for use in three different circumstances:
12000
12001 .olist
12002 When a listening daemon is started, Exim needs to know which interfaces
12003 and ports to listen on.
12004 .next
12005 When Exim is routing an address, it needs to know which IP addresses
12006 are associated with local interfaces. This is required for the correct
12007 processing of MX lists by removing the local host and others with the
12008 same or higher priority values. Also, Exim needs to detect cases
12009 when an address is routed to an IP address that in fact belongs to the
12010 local host. Unless the &%self%& router option or the &%allow_localhost%&
12011 option of the smtp transport is set (as appropriate), this is treated
12012 as an error situation.
12013 .next
12014 When Exim connects to a remote host, it may need to know which interface to use
12015 for the outgoing connection.
12016 .endlist
12017
12018
12019 Exim's default behaviour is likely to be appropriate in the vast majority
12020 of cases. If your host has only one interface, and you want all its IP
12021 addresses to be treated in the same way, and you are using only the
12022 standard SMTP port, you should not need to take any special action. The
12023 rest of this chapter does not apply to you.
12024
12025 In a more complicated situation you may want to listen only on certain
12026 interfaces, or on different ports, and for this reason there are a number of
12027 options that can be used to influence Exim's behaviour. The rest of this
12028 chapter describes how they operate.
12029
12030 When a message is received over TCP/IP, the interface and port that were
12031 actually used are set in &$received_ip_address$& and &$received_port$&.
12032
12033
12034
12035 .section "Starting a listening daemon" "SECID89"
12036 When a listening daemon is started (by means of the &%-bd%& command line
12037 option), the interfaces and ports on which it listens are controlled by the
12038 following options:
12039
12040 .ilist
12041 &%daemon_smtp_ports%& contains a list of default ports. (For backward
12042 compatibility, this option can also be specified in the singular.)
12043 .next
12044 &%local_interfaces%& contains list of interface IP addresses on which to
12045 listen. Each item may optionally also specify a port.
12046 .endlist
12047
12048 The default list separator in both cases is a colon, but this can be changed as
12049 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
12050 it is usually best to change the separator to avoid having to double all the
12051 colons. For example:
12052 .code
12053 local_interfaces = <; 127.0.0.1 ; \
12054                       192.168.23.65 ; \
12055                       ::1 ; \
12056                       3ffe:ffff:836f::fe86:a061
12057 .endd
12058 There are two different formats for specifying a port along with an IP address
12059 in &%local_interfaces%&:
12060
12061 .olist
12062 The port is added onto the address with a dot separator. For example, to listen
12063 on port 1234 on two different IP addresses:
12064 .code
12065 local_interfaces = <; 192.168.23.65.1234 ; \
12066                       3ffe:ffff:836f::fe86:a061.1234
12067 .endd
12068 .next
12069 The IP address is enclosed in square brackets, and the port is added
12070 with a colon separator, for example:
12071 .code
12072 local_interfaces = <; [192.168.23.65]:1234 ; \
12073                       [3ffe:ffff:836f::fe86:a061]:1234
12074 .endd
12075 .endlist
12076
12077 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
12078 default setting contains just one port:
12079 .code
12080 daemon_smtp_ports = smtp
12081 .endd
12082 If more than one port is listed, each interface that does not have its own port
12083 specified listens on all of them. Ports that are listed in
12084 &%daemon_smtp_ports%& can be identified either by name (defined in
12085 &_/etc/services_&) or by number. However, when ports are given with individual
12086 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
12087
12088
12089
12090 .section "Special IP listening addresses" "SECID90"
12091 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
12092 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
12093 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
12094 instead of setting up separate listening sockets for each interface. The
12095 default value of &%local_interfaces%& is
12096 .code
12097 local_interfaces = 0.0.0.0
12098 .endd
12099 when Exim is built without IPv6 support; otherwise it is:
12100 .code
12101 local_interfaces = <; ::0 ; 0.0.0.0
12102 .endd
12103 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
12104
12105
12106
12107 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
12108 The &%-oX%& command line option can be used to override the values of
12109 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
12110 instance. Another way of doing this would be to use macros and the &%-D%&
12111 option. However, &%-oX%& can be used by any admin user, whereas modification of
12112 the runtime configuration by &%-D%& is allowed only when the caller is root or
12113 exim.
12114
12115 The value of &%-oX%& is a list of items. The default colon separator can be
12116 changed in the usual way if required. If there are any items that do not
12117 contain dots or colons (that is, are not IP addresses), the value of
12118 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
12119 items that do contain dots or colons, the value of &%local_interfaces%& is
12120 replaced by those items. Thus, for example,
12121 .code
12122 -oX 1225
12123 .endd
12124 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
12125 whereas
12126 .code
12127 -oX 192.168.34.5.1125
12128 .endd
12129 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
12130 (However, since &%local_interfaces%& now contains no items without ports, the
12131 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
12132
12133
12134
12135 .section "Support for the obsolete SSMTP (or SMTPS) protocol" "SECTsupobssmt"
12136 .cindex "ssmtp protocol"
12137 .cindex "smtps protocol"
12138 .cindex "SMTP" "ssmtp protocol"
12139 .cindex "SMTP" "smtps protocol"
12140 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
12141 before the STARTTLS command was standardized for SMTP. Some legacy clients
12142 still use this protocol. If the &%tls_on_connect_ports%& option is set to a
12143 list of port numbers, connections to those ports must use SSMTP. The most
12144 common use of this option is expected to be
12145 .code
12146 tls_on_connect_ports = 465
12147 .endd
12148 because 465 is the usual port number used by the legacy clients. There is also
12149 a command line option &%-tls-on-connect%&, which forces all ports to behave in
12150 this way when a daemon is started.
12151
12152 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
12153 daemon to listen on those ports. You must still specify them in
12154 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
12155 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
12156 connections via the daemon.)
12157
12158
12159
12160
12161 .section "IPv6 address scopes" "SECID92"
12162 .cindex "IPv6" "address scopes"
12163 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
12164 can, in principle, have the same link-local IPv6 address on different
12165 interfaces. Thus, additional information is needed, over and above the IP
12166 address, to distinguish individual interfaces. A convention of using a
12167 percent sign followed by something (often the interface name) has been
12168 adopted in some cases, leading to addresses like this:
12169 .code
12170 fe80::202:b3ff:fe03:45c1%eth0
12171 .endd
12172 To accommodate this usage, a percent sign followed by an arbitrary string is
12173 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
12174 to convert a textual IPv6 address for actual use. This function recognizes the
12175 percent convention in operating systems that support it, and it processes the
12176 address appropriately. Unfortunately, some older libraries have problems with
12177 &[getaddrinfo()]&. If
12178 .code
12179 IPV6_USE_INET_PTON=yes
12180 .endd
12181 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
12182 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
12183 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
12184 function.) Of course, this means that the additional functionality of
12185 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
12186
12187 .section "Disabling IPv6" "SECID93"
12188 .cindex "IPv6" "disabling"
12189 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
12190 run on a host whose kernel does not support IPv6. The binary will fall back to
12191 using IPv4, but it may waste resources looking up AAAA records, and trying to
12192 connect to IPv6 addresses, causing delays to mail delivery. If you set the
12193 .oindex "&%disable_ipv6%&"
12194 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
12195 activities take place. AAAA records are never looked up, and any IPv6 addresses
12196 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
12197 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
12198 to handle IPv6 literal addresses.
12199
12200 On the other hand, when IPv6 is in use, there may be times when you want to
12201 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
12202 option to globally suppress the lookup of AAAA records for specified domains,
12203 and you can use the &%ignore_target_hosts%& generic router option to ignore
12204 IPv6 addresses in an individual router.
12205
12206
12207
12208 .section "Examples of starting a listening daemon" "SECID94"
12209 The default case in an IPv6 environment is
12210 .code
12211 daemon_smtp_ports = smtp
12212 local_interfaces = <; ::0 ; 0.0.0.0
12213 .endd
12214 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
12215 Either one or two sockets may be used, depending on the characteristics of
12216 the TCP/IP stack. (This is complicated and messy; for more information,
12217 read the comments in the &_daemon.c_& source file.)
12218
12219 To specify listening on ports 25 and 26 on all interfaces:
12220 .code
12221 daemon_smtp_ports = 25 : 26
12222 .endd
12223 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
12224 .code
12225 local_interfaces = <; ::0.25     ; ::0.26 \
12226                       0.0.0.0.25 ; 0.0.0.0.26
12227 .endd
12228 To listen on the default port on all IPv4 interfaces, and on port 26 on the
12229 IPv4 loopback address only:
12230 .code
12231 local_interfaces = 0.0.0.0 : 127.0.0.1.26
12232 .endd
12233 To specify listening on the default port on specific interfaces only:
12234 .code
12235 local_interfaces = 192.168.34.67 : 192.168.34.67
12236 .endd
12237 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
12238
12239
12240
12241 .section "Recognizing the local host" "SECTreclocipadd"
12242 The &%local_interfaces%& option is also used when Exim needs to determine
12243 whether or not an IP address refers to the local host. That is, the IP
12244 addresses of all the interfaces on which a daemon is listening are always
12245 treated as local.
12246
12247 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
12248 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
12249 available interfaces from the operating system, and extracts the relevant
12250 (that is, IPv4 or IPv6) addresses to use for checking.
12251
12252 Some systems set up large numbers of virtual interfaces in order to provide
12253 many virtual web servers. In this situation, you may want to listen for
12254 email on only a few of the available interfaces, but nevertheless treat all
12255 interfaces as local when routing. You can do this by setting
12256 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
12257 &"all"& wildcard values. These addresses are recognized as local, but are not
12258 used for listening. Consider this example:
12259 .code
12260 local_interfaces = <; 127.0.0.1 ; ::1 ; \
12261                       192.168.53.235 ; \
12262                       3ffe:2101:12:1:a00:20ff:fe86:a061
12263
12264 extra_local_interfaces = <; ::0 ; 0.0.0.0
12265 .endd
12266 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
12267 address, but all available interface addresses are treated as local when
12268 Exim is routing.
12269
12270 In some environments the local host name may be in an MX list, but with an IP
12271 address that is not assigned to any local interface. In other cases it may be
12272 desirable to treat other host names as if they referred to the local host. Both
12273 these cases can be handled by setting the &%hosts_treat_as_local%& option.
12274 This contains host names rather than IP addresses. When a host is referenced
12275 during routing, either via an MX record or directly, it is treated as the local
12276 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
12277 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
12278
12279
12280
12281 .section "Delivering to a remote host" "SECID95"
12282 Delivery to a remote host is handled by the smtp transport. By default, it
12283 allows the system's TCP/IP functions to choose which interface to use (if
12284 there is more than one) when connecting to a remote host. However, the
12285 &%interface%& option can be set to specify which interface is used. See the
12286 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
12287 details.
12288
12289
12290
12291
12292 . ////////////////////////////////////////////////////////////////////////////
12293 . ////////////////////////////////////////////////////////////////////////////
12294
12295 .chapter "Main configuration" "CHAPmainconfig"
12296 .scindex IIDconfima "configuration file" "main section"
12297 .scindex IIDmaiconf "main configuration"
12298 The first part of the run time configuration file contains three types of item:
12299
12300 .ilist
12301 Macro definitions: These lines start with an upper case letter. See section
12302 &<<SECTmacrodefs>>& for details of macro processing.
12303 .next
12304 Named list definitions: These lines start with one of the words &"domainlist"&,
12305 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
12306 section &<<SECTnamedlists>>&.
12307 .next
12308 Main configuration settings: Each setting occupies one line of the file
12309 (with possible continuations). If any setting is preceded by the word
12310 &"hide"&, the &%-bP%& command line option displays its value to admin users
12311 only. See section &<<SECTcos>>& for a description of the syntax of these option
12312 settings.
12313 .endlist
12314
12315 This chapter specifies all the main configuration options, along with their
12316 types and default values. For ease of finding a particular option, they appear
12317 in alphabetical order in section &<<SECTalomo>>& below. However, because there
12318 are now so many options, they are first listed briefly in functional groups, as
12319 an aid to finding the name of the option you are looking for. Some options are
12320 listed in more than one group.
12321
12322 .section "Miscellaneous" "SECID96"
12323 .table2
12324 .row &%bi_command%&                  "to run for &%-bi%& command line option"
12325 .row &%disable_ipv6%&                "do no IPv6 processing"
12326 .row &%keep_malformed%&              "for broken files &-- should not happen"
12327 .row &%localhost_number%&            "for unique message ids in clusters"
12328 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
12329 .row &%message_body_visible%&        "how much to show in &$message_body$&"
12330 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
12331 .row &%print_topbitchars%&           "top-bit characters are printing"
12332 .row &%timezone%&                    "force time zone"
12333 .endtable
12334
12335
12336 .section "Exim parameters" "SECID97"
12337 .table2
12338 .row &%exim_group%&                  "override compiled-in value"
12339 .row &%exim_path%&                   "override compiled-in value"
12340 .row &%exim_user%&                   "override compiled-in value"
12341 .row &%primary_hostname%&            "default from &[uname()]&"
12342 .row &%split_spool_directory%&       "use multiple directories"
12343 .row &%spool_directory%&             "override compiled-in value"
12344 .endtable
12345
12346
12347
12348 .section "Privilege controls" "SECID98"
12349 .table2
12350 .row &%admin_groups%&                "groups that are Exim admin users"
12351 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
12352 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
12353 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
12354 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
12355 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
12356 .row &%never_users%&                 "do not run deliveries as these"
12357 .row &%prod_requires_admin%&         "forced delivery requires admin user"
12358 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
12359 .row &%trusted_groups%&              "groups that are trusted"
12360 .row &%trusted_users%&               "users that are trusted"
12361 .endtable
12362
12363
12364
12365 .section "Logging" "SECID99"
12366 .table2
12367 .row &%hosts_connection_nolog%&      "exemption from connect logging"
12368 .row &%log_file_path%&               "override compiled-in value"
12369 .row &%log_selector%&                "set/unset optional logging"
12370 .row &%log_timezone%&                "add timezone to log lines"
12371 .row &%message_logs%&                "create per-message logs"
12372 .row &%preserve_message_logs%&       "after message completion"
12373 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
12374 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
12375 .row &%syslog_facility%&             "set syslog &""facility""& field"
12376 .row &%syslog_processname%&          "set syslog &""ident""& field"
12377 .row &%syslog_timestamp%&            "timestamp syslog lines"
12378 .row &%write_rejectlog%&             "control use of message log"
12379 .endtable
12380
12381
12382
12383 .section "Frozen messages" "SECID100"
12384 .table2
12385 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
12386 .row &%freeze_tell%&                 "send message when freezing"
12387 .row &%move_frozen_messages%&        "to another directory"
12388 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
12389 .endtable
12390
12391
12392
12393 .section "Data lookups" "SECID101"
12394 .table2
12395 .row &%ibase_servers%&               "InterBase servers"
12396 .row &%ldap_default_servers%&        "used if no server in query"
12397 .row &%ldap_version%&                "set protocol version"
12398 .row &%lookup_open_max%&             "lookup files held open"
12399 .row &%mysql_servers%&               "default MySQL servers"
12400 .row &%oracle_servers%&              "Oracle servers"
12401 .row &%pgsql_servers%&               "default PostgreSQL servers"
12402 .row &%sqlite_lock_timeout%&         "as it says"
12403 .endtable
12404
12405
12406
12407 .section "Message ids" "SECID102"
12408 .table2
12409 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
12410 .row &%message_id_header_text%&      "ditto"
12411 .endtable
12412
12413
12414
12415 .section "Embedded Perl Startup" "SECID103"
12416 .table2
12417 .row &%perl_at_start%&               "always start the interpreter"
12418 .row &%perl_startup%&                "code to obey when starting Perl"
12419 .endtable
12420
12421
12422
12423 .section "Daemon" "SECID104"
12424 .table2
12425 .row &%daemon_smtp_ports%&           "default ports"
12426 .row &%daemon_startup_retries%&      "number of times to retry"
12427 .row &%daemon_startup_sleep%&        "time to sleep between tries"
12428 .row &%extra_local_interfaces%&      "not necessarily listened on"
12429 .row &%local_interfaces%&            "on which to listen, with optional ports"
12430 .row &%pid_file_path%&               "override compiled-in value"
12431 .row &%queue_run_max%&               "maximum simultaneous queue runners"
12432 .endtable
12433
12434
12435
12436 .section "Resource control" "SECID105"
12437 .table2
12438 .row &%check_log_inodes%&            "before accepting a message"
12439 .row &%check_log_space%&             "before accepting a message"
12440 .row &%check_spool_inodes%&          "before accepting a message"
12441 .row &%check_spool_space%&           "before accepting a message"
12442 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
12443 .row &%queue_only_load%&             "queue incoming if load high"
12444 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
12445 .row &%queue_run_max%&               "maximum simultaneous queue runners"
12446 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
12447 .row &%smtp_accept_max%&             "simultaneous incoming connections"
12448 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
12449 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
12450 .row &%smtp_accept_max_per_connection%& "messages per connection"
12451 .row &%smtp_accept_max_per_host%&    "connections from one host"
12452 .row &%smtp_accept_queue%&           "queue mail if more connections"
12453 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
12454                                            connection"
12455 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
12456 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
12457 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
12458 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
12459 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
12460 .endtable
12461
12462
12463
12464 .section "Policy controls" "SECID106"
12465 .table2
12466 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
12467 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
12468 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
12469 .row &%acl_smtp_auth%&               "ACL for AUTH"
12470 .row &%acl_smtp_connect%&            "ACL for connection"
12471 .row &%acl_smtp_data%&               "ACL for DATA"
12472 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
12473 .row &%acl_smtp_etrn%&               "ACL for ETRN"
12474 .row &%acl_smtp_expn%&               "ACL for EXPN"
12475 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
12476 .row &%acl_smtp_mail%&               "ACL for MAIL"
12477 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
12478 .row &%acl_smtp_mime%&               "ACL for MIME parts"
12479 .row &%acl_smtp_predata%&            "ACL for start of data"
12480 .row &%acl_smtp_quit%&               "ACL for QUIT"
12481 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
12482 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
12483 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
12484 .row &%av_scanner%&                  "specify virus scanner"
12485 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
12486                                       words""&"
12487 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
12488 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
12489 .row &%header_maxsize%&              "total size of message header"
12490 .row &%header_line_maxsize%&         "individual header line limit"
12491 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
12492 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
12493 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
12494 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
12495 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
12496 .row &%host_lookup%&                 "host name looked up for these hosts"
12497 .row &%host_lookup_order%&           "order of DNS and local name lookups"
12498 .row &%host_reject_connection%&      "reject connection from these hosts"
12499 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
12500 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
12501 .row &%message_size_limit%&          "for all messages"
12502 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
12503 .row &%spamd_address%&               "set interface to SpamAssassin"
12504 .row &%strict_acl_vars%&             "object to unset ACL variables"
12505 .endtable
12506
12507
12508
12509 .section "Callout cache" "SECID107"
12510 .table2
12511 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
12512                                          item"
12513 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
12514                                          item"
12515 .row &%callout_negative_expire%&     "timeout for negative address cache item"
12516 .row &%callout_positive_expire%&     "timeout for positive address cache item"
12517 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
12518 .endtable
12519
12520
12521
12522 .section "TLS" "SECID108"
12523 .table2
12524 .row &%gnutls_require_kx%&           "control GnuTLS key exchanges"
12525 .row &%gnutls_require_mac%&          "control GnuTLS MAC algorithms"
12526 .row &%gnutls_require_protocols%&    "control GnuTLS protocols"
12527 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
12528 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
12529 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
12530 .row &%tls_certificate%&             "location of server certificate"
12531 .row &%tls_crl%&                     "certificate revocation list"
12532 .row &%tls_dhparam%&                 "DH parameters for server"
12533 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
12534 .row &%tls_privatekey%&              "location of server private key"
12535 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
12536 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
12537 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
12538 .row &%tls_verify_certificates%&     "expected client certificates"
12539 .row &%tls_verify_hosts%&            "insist on client certificate verify"
12540 .endtable
12541
12542
12543
12544 .section "Local user handling" "SECID109"
12545 .table2
12546 .row &%finduser_retries%&            "useful in NIS environments"
12547 .row &%gecos_name%&                  "used when creating &'Sender:'&"
12548 .row &%gecos_pattern%&               "ditto"
12549 .row &%max_username_length%&         "for systems that truncate"
12550 .row &%unknown_login%&               "used when no login name found"
12551 .row &%unknown_username%&            "ditto"
12552 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
12553 .row &%uucp_from_sender%&            "ditto"
12554 .endtable
12555
12556
12557
12558 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
12559 .table2
12560 .row &%header_maxsize%&              "total size of message header"
12561 .row &%header_line_maxsize%&         "individual header line limit"
12562 .row &%message_size_limit%&          "applies to all messages"
12563 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
12564 .row &%received_header_text%&        "expanded to make &'Received:'&"
12565 .row &%received_headers_max%&        "for mail loop detection"
12566 .row &%recipients_max%&              "limit per message"
12567 .row &%recipients_max_reject%&       "permanently reject excess recipients"
12568 .endtable
12569
12570
12571
12572
12573 .section "Non-SMTP incoming messages" "SECID111"
12574 .table2
12575 .row &%receive_timeout%&             "for non-SMTP messages"
12576 .endtable
12577
12578
12579
12580
12581
12582 .section "Incoming SMTP messages" "SECID112"
12583 See also the &'Policy controls'& section above.
12584
12585 .table2
12586 .row &%host_lookup%&                 "host name looked up for these hosts"
12587 .row &%host_lookup_order%&           "order of DNS and local name lookups"
12588 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
12589 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
12590 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
12591 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
12592 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
12593 .row &%smtp_accept_max%&             "simultaneous incoming connections"
12594 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
12595 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
12596 .row &%smtp_accept_max_per_connection%& "messages per connection"
12597 .row &%smtp_accept_max_per_host%&    "connections from one host"
12598 .row &%smtp_accept_queue%&           "queue mail if more connections"
12599 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
12600                                            connection"
12601 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
12602 .row &%smtp_active_hostname%&        "host name to use in messages"
12603 .row &%smtp_banner%&                 "text for welcome banner"
12604 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
12605 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
12606 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
12607 .row &%smtp_etrn_command%&           "what to run for ETRN"
12608 .row &%smtp_etrn_serialize%&         "only one at once"
12609 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
12610 .row &%smtp_max_unknown_commands%&   "before dropping connection"
12611 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
12612 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
12613 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
12614 .row &%smtp_receive_timeout%&        "per command or data line"
12615 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
12616 .row &%smtp_return_error_details%&   "give detail on rejections"
12617 .endtable
12618
12619
12620
12621 .section "SMTP extensions" "SECID113"
12622 .table2
12623 .row &%accept_8bitmime%&             "advertise 8BITMIME"
12624 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
12625 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
12626 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
12627 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
12628 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
12629 .endtable
12630
12631
12632
12633 .section "Processing messages" "SECID114"
12634 .table2
12635 .row &%allow_domain_literals%&       "recognize domain literal syntax"
12636 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
12637 .row &%allow_utf8_domains%&          "in addresses"
12638 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
12639                                       words""&"
12640 .row &%delivery_date_remove%&        "from incoming messages"
12641 .row &%envelope_to_remove%&          "from incoming messages"
12642 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
12643 .row &%headers_charset%&             "default for translations"
12644 .row &%qualify_domain%&              "default for senders"
12645 .row &%qualify_recipient%&           "default for recipients"
12646 .row &%return_path_remove%&          "from incoming messages"
12647 .row &%strip_excess_angle_brackets%& "in addresses"
12648 .row &%strip_trailing_dot%&          "at end of addresses"
12649 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
12650 .endtable
12651
12652
12653
12654 .section "System filter" "SECID115"
12655 .table2
12656 .row &%system_filter%&               "locate system filter"
12657 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
12658                                             directory"
12659 .row &%system_filter_file_transport%& "transport for delivery to a file"
12660 .row &%system_filter_group%&         "group for filter running"
12661 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
12662 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
12663 .row &%system_filter_user%&          "user for filter running"
12664 .endtable
12665
12666
12667
12668 .section "Routing and delivery" "SECID116"
12669 .table2
12670 .row &%disable_ipv6%&                "do no IPv6 processing"
12671 .row &%dns_again_means_nonexist%&    "for broken domains"
12672 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
12673 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
12674 .row &%dns_retrans%&                 "parameter for resolver"
12675 .row &%dns_retry%&                   "parameter for resolver"
12676 .row &%hold_domains%&                "hold delivery for these domains"
12677 .row &%local_interfaces%&            "for routing checks"
12678 .row &%queue_domains%&               "no immediate delivery for these"
12679 .row &%queue_only%&                  "no immediate delivery at all"
12680 .row &%queue_only_file%&             "no immediate delivery if file exists"
12681 .row &%queue_only_load%&             "no immediate delivery if load is high"
12682 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
12683 .row &%queue_only_override%&         "allow command line to override"
12684 .row &%queue_run_in_order%&          "order of arrival"
12685 .row &%queue_run_max%&               "of simultaneous queue runners"
12686 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
12687 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
12688 .row &%remote_sort_domains%&         "order of remote deliveries"
12689 .row &%retry_data_expire%&           "timeout for retry data"
12690 .row &%retry_interval_max%&          "safety net for retry rules"
12691 .endtable
12692
12693
12694
12695 .section "Bounce and warning messages" "SECID117"
12696 .table2
12697 .row &%bounce_message_file%&         "content of bounce"
12698 .row &%bounce_message_text%&         "content of bounce"
12699 .row &%bounce_return_body%&          "include body if returning message"
12700 .row &%bounce_return_message%&       "include original message in bounce"
12701 .row &%bounce_return_size_limit%&    "limit on returned message"
12702 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
12703 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
12704 .row &%errors_copy%&                 "copy bounce messages"
12705 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
12706 .row &%delay_warning%&               "time schedule"
12707 .row &%delay_warning_condition%&     "condition for warning messages"
12708 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
12709 .row &%smtp_return_error_details%&   "give detail on rejections"
12710 .row &%warn_message_file%&           "content of warning message"
12711 .endtable
12712
12713
12714
12715 .section "Alphabetical list of main options" "SECTalomo"
12716 Those options that undergo string expansion before use are marked with
12717 &dagger;.
12718
12719 .option accept_8bitmime main boolean false
12720 .cindex "8BITMIME"
12721 .cindex "8-bit characters"
12722 This option causes Exim to send 8BITMIME in its response to an SMTP
12723 EHLO command, and to accept the BODY= parameter on MAIL commands.
12724 However, though Exim is 8-bit clean, it is not a protocol converter, and it
12725 takes no steps to do anything special with messages received by this route.
12726 Consequently, this option is turned off by default.
12727
12728 .option acl_not_smtp main string&!! unset
12729 .cindex "&ACL;" "for non-SMTP messages"
12730 .cindex "non-SMTP messages" "ACLs for"
12731 This option defines the ACL that is run when a non-SMTP message has been
12732 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
12733 further details.
12734
12735 .option acl_not_smtp_mime main string&!! unset
12736 This option defines the ACL that is run for individual MIME parts of non-SMTP
12737 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
12738 SMTP messages.
12739
12740 .option acl_not_smtp_start main string&!! unset
12741 .cindex "&ACL;" "at start of non-SMTP message"
12742 .cindex "non-SMTP messages" "ACLs for"
12743 This option defines the ACL that is run before Exim starts reading a
12744 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
12745
12746 .option acl_smtp_auth main string&!! unset
12747 .cindex "&ACL;" "setting up for SMTP commands"
12748 .cindex "AUTH" "ACL for"
12749 This option defines the ACL that is run when an SMTP AUTH command is
12750 received. See chapter &<<CHAPACL>>& for further details.
12751
12752 .option acl_smtp_connect main string&!! unset
12753 .cindex "&ACL;" "on SMTP connection"
12754 This option defines the ACL that is run when an SMTP connection is received.
12755 See chapter &<<CHAPACL>>& for further details.
12756
12757 .option acl_smtp_data main string&!! unset
12758 .cindex "DATA" "ACL for"
12759 This option defines the ACL that is run after an SMTP DATA command has been
12760 processed and the message itself has been received, but before the final
12761 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
12762
12763 .option acl_smtp_etrn main string&!! unset
12764 .cindex "ETRN" "ACL for"
12765 This option defines the ACL that is run when an SMTP ETRN command is
12766 received. See chapter &<<CHAPACL>>& for further details.
12767
12768 .option acl_smtp_expn main string&!! unset
12769 .cindex "EXPN" "ACL for"
12770 This option defines the ACL that is run when an SMTP EXPN command is
12771 received. See chapter &<<CHAPACL>>& for further details.
12772
12773 .option acl_smtp_helo main string&!! unset
12774 .cindex "EHLO" "ACL for"
12775 .cindex "HELO" "ACL for"
12776 This option defines the ACL that is run when an SMTP EHLO or HELO
12777 command is received. See chapter &<<CHAPACL>>& for further details.
12778
12779
12780 .option acl_smtp_mail main string&!! unset
12781 .cindex "MAIL" "ACL for"
12782 This option defines the ACL that is run when an SMTP MAIL command is
12783 received. See chapter &<<CHAPACL>>& for further details.
12784
12785 .option acl_smtp_mailauth main string&!! unset
12786 .cindex "AUTH" "on MAIL command"
12787 This option defines the ACL that is run when there is an AUTH parameter on
12788 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
12789 &<<CHAPSMTPAUTH>>& for details of authentication.
12790
12791 .option acl_smtp_mime main string&!! unset
12792 .cindex "MIME content scanning" "ACL for"
12793 This option is available when Exim is built with the content-scanning
12794 extension. It defines the ACL that is run for each MIME part in a message. See
12795 section &<<SECTscanmimepart>>& for details.
12796
12797 .option acl_smtp_predata main string&!! unset
12798 This option defines the ACL that is run when an SMTP DATA command is
12799 received, before the message itself is received. See chapter &<<CHAPACL>>& for
12800 further details.
12801
12802 .option acl_smtp_quit main string&!! unset
12803 .cindex "QUIT, ACL for"
12804 This option defines the ACL that is run when an SMTP QUIT command is
12805 received. See chapter &<<CHAPACL>>& for further details.
12806
12807 .option acl_smtp_rcpt main string&!! unset
12808 .cindex "RCPT" "ACL for"
12809 This option defines the ACL that is run when an SMTP RCPT command is
12810 received. See chapter &<<CHAPACL>>& for further details.
12811
12812 .option acl_smtp_starttls main string&!! unset
12813 .cindex "STARTTLS, ACL for"
12814 This option defines the ACL that is run when an SMTP STARTTLS command is
12815 received. See chapter &<<CHAPACL>>& for further details.
12816
12817 .option acl_smtp_vrfy main string&!! unset
12818 .cindex "VRFY" "ACL for"
12819 This option defines the ACL that is run when an SMTP VRFY command is
12820 received. See chapter &<<CHAPACL>>& for further details.
12821
12822 .option admin_groups main "string list&!!" unset
12823 .cindex "admin user"
12824 This option is expanded just once, at the start of Exim's processing. If the
12825 current group or any of the supplementary groups of an Exim caller is in this
12826 colon-separated list, the caller has admin privileges. If all your system
12827 programmers are in a specific group, for example, you can give them all Exim
12828 admin privileges by putting that group in &%admin_groups%&. However, this does
12829 not permit them to read Exim's spool files (whose group owner is the Exim gid).
12830 To permit this, you have to add individuals to the Exim group.
12831
12832 .option allow_domain_literals main boolean false
12833 .cindex "domain literal"
12834 If this option is set, the RFC 2822 domain literal format is permitted in
12835 email addresses. The option is not set by default, because the domain literal
12836 format is not normally required these days, and few people know about it. It
12837 has, however, been exploited by mail abusers.
12838
12839 Unfortunately, it seems that some DNS black list maintainers are using this
12840 format to report black listing to postmasters. If you want to accept messages
12841 addressed to your hosts by IP address, you need to set
12842 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
12843 domains (defined in the named domain list &%local_domains%& in the default
12844 configuration). This &"magic string"& matches the domain literal form of all
12845 the local host's IP addresses.
12846
12847
12848 .option allow_mx_to_ip main boolean false
12849 .cindex "MX record" "pointing to IP address"
12850 It appears that more and more DNS zone administrators are breaking the rules
12851 and putting domain names that look like IP addresses on the right hand side of
12852 MX records. Exim follows the rules and rejects this, giving an error message
12853 that explains the mis-configuration. However, some other MTAs support this
12854 practice, so to avoid &"Why can't Exim do this?"& complaints,
12855 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
12856 recommended, except when you have no other choice.
12857
12858 .option allow_utf8_domains main boolean false
12859 .cindex "domain" "UTF-8 characters in"
12860 .cindex "UTF-8" "in domain name"
12861 Lots of discussion is going on about internationalized domain names. One
12862 camp is strongly in favour of just using UTF-8 characters, and it seems
12863 that at least two other MTAs permit this. This option allows Exim users to
12864 experiment if they wish.
12865
12866 If it is set true, Exim's domain parsing function allows valid
12867 UTF-8 multicharacters to appear in domain name components, in addition to
12868 letters, digits, and hyphens. However, just setting this option is not
12869 enough; if you want to look up these domain names in the DNS, you must also
12870 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
12871 suitable setting is:
12872 .code
12873 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
12874   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
12875 .endd
12876 Alternatively, you can just disable this feature by setting
12877 .code
12878 dns_check_names_pattern =
12879 .endd
12880 That is, set the option to an empty string so that no check is done.
12881
12882
12883 .option auth_advertise_hosts main "host list&!!" *
12884 .cindex "authentication" "advertising"
12885 .cindex "AUTH" "advertising"
12886 If any server authentication mechanisms are configured, Exim advertises them in
12887 response to an EHLO command only if the calling host matches this list.
12888 Otherwise, Exim does not advertise AUTH.
12889 Exim does not accept AUTH commands from clients to which it has not
12890 advertised the availability of AUTH. The advertising of individual
12891 authentication mechanisms can be controlled by the use of the
12892 &%server_advertise_condition%& generic authenticator option on the individual
12893 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
12894
12895 Certain mail clients (for example, Netscape) require the user to provide a name
12896 and password for authentication if AUTH is advertised, even though it may
12897 not be needed (the host may accept messages from hosts on its local LAN without
12898 authentication, for example). The &%auth_advertise_hosts%& option can be used
12899 to make these clients more friendly by excluding them from the set of hosts to
12900 which Exim advertises AUTH.
12901
12902 .cindex "AUTH" "advertising when encrypted"
12903 If you want to advertise the availability of AUTH only when the connection
12904 is encrypted using TLS, you can make use of the fact that the value of this
12905 option is expanded, with a setting like this:
12906 .code
12907 auth_advertise_hosts = ${if eq{$tls_cipher}{}{}{*}}
12908 .endd
12909 .vindex "&$tls_cipher$&"
12910 If &$tls_cipher$& is empty, the session is not encrypted, and the result of
12911 the expansion is empty, thus matching no hosts. Otherwise, the result of the
12912 expansion is *, which matches all hosts.
12913
12914
12915 .option auto_thaw main time 0s
12916 .cindex "thawing messages"
12917 .cindex "unfreezing messages"
12918 If this option is set to a time greater than zero, a queue runner will try a
12919 new delivery attempt on any frozen message, other than a bounce message, if
12920 this much time has passed since it was frozen. This may result in the message
12921 being re-frozen if nothing has changed since the last attempt. It is a way of
12922 saying &"keep on trying, even though there are big problems"&.
12923
12924 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
12925 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
12926 thought to be very useful any more, and its use should probably be avoided.
12927
12928 .new
12929 .option av_scanner main string "see below"
12930 This option is available if Exim is built with the content-scanning extension.
12931 It specifies which anti-virus scanner to use. The default value is:
12932 .code
12933 sophie:/var/run/sophie
12934 .endd
12935 If the value of &%av_scanner%& starts with a dollar character, it is expanded
12936 before use. See section &<<SECTscanvirus>>& for further details.
12937 .wen
12938
12939
12940 .option bi_command main string unset
12941 .oindex "&%-bi%&"
12942 This option supplies the name of a command that is run when Exim is called with
12943 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
12944 just the command name, it is not a complete command line. If an argument is
12945 required, it must come from the &%-oA%& command line option.
12946
12947
12948 .option bounce_message_file main string unset
12949 .cindex "bounce message" "customizing"
12950 .cindex "customizing" "bounce message"
12951 This option defines a template file containing paragraphs of text to be used
12952 for constructing bounce messages.  Details of the file's contents are given in
12953 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
12954
12955
12956 .option bounce_message_text main string unset
12957 When this option is set, its contents are included in the default bounce
12958 message immediately after &"This message was created automatically by mail
12959 delivery software."& It is not used if &%bounce_message_file%& is set.
12960
12961 .option bounce_return_body main boolean true
12962 .cindex "bounce message" "including body"
12963 This option controls whether the body of an incoming message is included in a
12964 bounce message when &%bounce_return_message%& is true. The default setting
12965 causes the entire message, both header and body, to be returned (subject to the
12966 value of &%bounce_return_size_limit%&). If this option is false, only the
12967 message header is included. In the case of a non-SMTP message containing an
12968 error that is detected during reception, only those header lines preceding the
12969 point at which the error was detected are returned.
12970 .cindex "bounce message" "including original"
12971
12972 .option bounce_return_message main boolean true
12973 If this option is set false, none of the original message is included in
12974 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
12975 &%bounce_return_body%&.
12976
12977
12978 .option bounce_return_size_limit main integer 100K
12979 .cindex "size" "of bounce, limit"
12980 .cindex "bounce message" "size limit"
12981 .cindex "limit" "bounce message size"
12982 This option sets a limit in bytes on the size of messages that are returned to
12983 senders as part of bounce messages when &%bounce_return_message%& is true. The
12984 limit should be less than the value of the global &%message_size_limit%& and of
12985 any &%message_size_limit%& settings on transports, to allow for the bounce text
12986 that Exim generates. If this option is set to zero there is no limit.
12987
12988 When the body of any message that is to be included in a bounce message is
12989 greater than the limit, it is truncated, and a comment pointing this out is
12990 added at the top. The actual cutoff may be greater than the value given, owing
12991 to the use of buffering for transferring the message in chunks (typically 8K in
12992 size). The idea is to save bandwidth on those undeliverable 15-megabyte
12993 messages.
12994
12995 .option bounce_sender_authentication main string unset
12996 .cindex "bounce message" "sender authentication"
12997 .cindex "authentication" "bounce message"
12998 .cindex "AUTH" "on bounce message"
12999 This option provides an authenticated sender address that is sent with any
13000 bounce messages generated by Exim that are sent over an authenticated SMTP
13001 connection. A typical setting might be:
13002 .code
13003 bounce_sender_authentication = mailer-daemon@my.domain.example
13004 .endd
13005 which would cause bounce messages to be sent using the SMTP command:
13006 .code
13007 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
13008 .endd
13009 The value of &%bounce_sender_authentication%& must always be a complete email
13010 address.
13011
13012 .option callout_domain_negative_expire main time 3h
13013 .cindex "caching" "callout timeouts"
13014 .cindex "callout" "caching timeouts"
13015 This option specifies the expiry time for negative callout cache data for a
13016 domain. See section &<<SECTcallver>>& for details of callout verification, and
13017 section &<<SECTcallvercache>>& for details of the caching.
13018
13019
13020 .option callout_domain_positive_expire main time 7d
13021 This option specifies the expiry time for positive callout cache data for a
13022 domain. See section &<<SECTcallver>>& for details of callout verification, and
13023 section &<<SECTcallvercache>>& for details of the caching.
13024
13025
13026 .option callout_negative_expire main time 2h
13027 This option specifies the expiry time for negative callout cache data for an
13028 address. See section &<<SECTcallver>>& for details of callout verification, and
13029 section &<<SECTcallvercache>>& for details of the caching.
13030
13031
13032 .option callout_positive_expire main time 24h
13033 This option specifies the expiry time for positive callout cache data for an
13034 address. See section &<<SECTcallver>>& for details of callout verification, and
13035 section &<<SECTcallvercache>>& for details of the caching.
13036
13037
13038 .option callout_random_local_part main string&!! "see below"
13039 This option defines the &"random"& local part that can be used as part of
13040 callout verification. The default value is
13041 .code
13042 $primary_host_name-$tod_epoch-testing
13043 .endd
13044 See section &<<CALLaddparcall>>& for details of how this value is used.
13045
13046
13047 .option check_log_inodes main integer 0
13048 See &%check_spool_space%& below.
13049
13050
13051 .option check_log_space main integer 0
13052 See &%check_spool_space%& below.
13053
13054 .oindex "&%check_rfc2047_length%&"
13055 .cindex "RFC 2047" "disabling length check"
13056 .option check_rfc2047_length main boolean true
13057 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
13058 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
13059 word; strings to be encoded that exceed this length are supposed to use
13060 multiple encoded words. By default, Exim does not recognize encoded words that
13061 exceed the maximum length. However, it seems that some software, in violation
13062 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
13063 set false, Exim recognizes encoded words of any length.
13064
13065
13066 .option check_spool_inodes main integer 0
13067 See &%check_spool_space%& below.
13068
13069
13070 .option check_spool_space main integer 0
13071 .cindex "checking disk space"
13072 .cindex "disk space, checking"
13073 .cindex "spool directory" "checking space"
13074 The four &%check_...%& options allow for checking of disk resources before a
13075 message is accepted.
13076
13077 .vindex "&$log_inodes$&"
13078 .vindex "&$log_space$&"
13079 .vindex "&$spool_inodes$&"
13080 .vindex "&$spool_space$&"
13081 When any of these options are set, they apply to all incoming messages. If you
13082 want to apply different checks to different kinds of message, you can do so by
13083 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
13084 &$spool_space$& in an ACL with appropriate additional conditions.
13085
13086
13087 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
13088 either value is greater than zero, for example:
13089 .code
13090 check_spool_space = 10M
13091 check_spool_inodes = 100
13092 .endd
13093 The spool partition is the one that contains the directory defined by
13094 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
13095 transit.
13096
13097 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
13098 files are written if either is greater than zero. These should be set only if
13099 &%log_file_path%& and &%spool_directory%& refer to different partitions.
13100
13101 If there is less space or fewer inodes than requested, Exim refuses to accept
13102 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
13103 error response to the MAIL command. If ESMTP is in use and there was a
13104 SIZE parameter on the MAIL command, its value is added to the
13105 &%check_spool_space%& value, and the check is performed even if
13106 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
13107
13108 The values for &%check_spool_space%& and &%check_log_space%& are held as a
13109 number of kilobytes. If a non-multiple of 1024 is specified, it is rounded up.
13110
13111 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
13112 failure a message is written to stderr and Exim exits with a non-zero code, as
13113 it obviously cannot send an error message of any kind.
13114
13115 .option daemon_smtp_ports main string &`smtp`&
13116 .cindex "port" "for daemon"
13117 .cindex "TCP/IP" "setting listening ports"
13118 This option specifies one or more default SMTP ports on which the Exim daemon
13119 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
13120 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
13121
13122 .option daemon_startup_retries main integer 9
13123 .cindex "daemon startup, retrying"
13124 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
13125 the daemon at startup when it cannot immediately bind a listening socket
13126 (typically because the socket is already in use): &%daemon_startup_retries%&
13127 defines the number of retries after the first failure, and
13128 &%daemon_startup_sleep%& defines the length of time to wait between retries.
13129
13130 .option daemon_startup_sleep main time 30s
13131 See &%daemon_startup_retries%&.
13132
13133 .option delay_warning main "time list" 24h
13134 .cindex "warning of delay"
13135 .cindex "delay warning, specifying"
13136 When a message is delayed, Exim sends a warning message to the sender at
13137 intervals specified by this option. The data is a colon-separated list of times
13138 after which to send warning messages. If the value of the option is an empty
13139 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
13140 message has been on the queue for longer than the last time, the last interval
13141 between the times is used to compute subsequent warning times. For example,
13142 with
13143 .code
13144 delay_warning = 4h:8h:24h
13145 .endd
13146 the first message is sent after 4 hours, the second after 8 hours, and
13147 the third one after 24 hours. After that, messages are sent every 16 hours,
13148 because that is the interval between the last two times on the list. If you set
13149 just one time, it specifies the repeat interval. For example, with:
13150 .code
13151 delay_warning = 6h
13152 .endd
13153 messages are repeated every six hours. To stop warnings after a given time, set
13154 a very large time at the end of the list. For example:
13155 .code
13156 delay_warning = 2h:12h:99d
13157 .endd
13158
13159 .option delay_warning_condition main string&!! "see below"
13160 .vindex "&$domain$&"
13161 The string is expanded at the time a warning message might be sent. If all the
13162 deferred addresses have the same domain, it is set in &$domain$& during the
13163 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
13164 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
13165 &"false"& (the comparison being done caselessly) then the warning message is
13166 not sent. The default is:
13167 .code
13168 delay_warning_condition = ${if or {\
13169   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
13170   { match{$h_precedence:}{(?i)bulk|list|junk} }\
13171   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
13172   } {no}{yes}}
13173 .endd
13174 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
13175 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
13176 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
13177 &"auto-replied"& in an &'Auto-Submitted:'& header.
13178
13179 .option deliver_drop_privilege main boolean false
13180 .cindex "unprivileged delivery"
13181 .cindex "delivery" "unprivileged"
13182 If this option is set true, Exim drops its root privilege at the start of a
13183 delivery process, and runs as the Exim user throughout. This severely restricts
13184 the kinds of local delivery that are possible, but is viable in certain types
13185 of configuration. There is a discussion about the use of root privilege in
13186 chapter &<<CHAPsecurity>>&.
13187
13188 .option deliver_queue_load_max main fixed-point unset
13189 .cindex "load average"
13190 .cindex "queue runner" "abandoning"
13191 When this option is set, a queue run is abandoned if the system load average
13192 becomes greater than the value of the option. The option has no effect on
13193 ancient operating systems on which Exim cannot determine the load average.
13194 See also &%queue_only_load%& and &%smtp_load_reserve%&.
13195
13196
13197 .option delivery_date_remove main boolean true
13198 .cindex "&'Delivery-date:'& header line"
13199 Exim's transports have an option for adding a &'Delivery-date:'& header to a
13200 message when it is delivered, in exactly the same way as &'Return-path:'& is
13201 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
13202 should not be present in incoming messages, and this option causes them to be
13203 removed at the time the message is received, to avoid any problems that might
13204 occur when a delivered message is subsequently sent on to some other recipient.
13205
13206 .option disable_fsync main boolean false
13207 .cindex "&[fsync()]&, disabling"
13208 This option is available only if Exim was built with the compile-time option
13209 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
13210 a runtime configuration generates an &"unknown option"& error. You should not
13211 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
13212 really, really, really understand what you are doing. &'No pre-compiled
13213 distributions of Exim should ever make this option available.'&
13214
13215 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
13216 updated files' data to be written to disc before continuing. Unexpected events
13217 such as crashes and power outages may cause data to be lost or scrambled.
13218 Here be Dragons. &*Beware.*&
13219
13220
13221 .option disable_ipv6 main boolean false
13222 .cindex "IPv6" "disabling"
13223 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
13224 activities take place. AAAA records are never looked up, and any IPv6 addresses
13225 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
13226 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13227 to handle IPv6 literal addresses.
13228
13229
13230 .option dns_again_means_nonexist main "domain list&!!" unset
13231 .cindex "DNS" "&""try again""& response; overriding"
13232 DNS lookups give a &"try again"& response for the DNS errors
13233 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
13234 keep trying to deliver a message, or to give repeated temporary errors to
13235 incoming mail. Sometimes the effect is caused by a badly set up name server and
13236 may persist for a long time. If a domain which exhibits this problem matches
13237 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
13238 This option should be used with care. You can make it apply to reverse lookups
13239 by a setting such as this:
13240 .code
13241 dns_again_means_nonexist = *.in-addr.arpa
13242 .endd
13243 This option applies to all DNS lookups that Exim does. It also applies when the
13244 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
13245 since these are most likely to be caused by DNS lookup problems. The
13246 &(dnslookup)& router has some options of its own for controlling what happens
13247 when lookups for MX or SRV records give temporary errors. These more specific
13248 options are applied after this global option.
13249
13250 .option dns_check_names_pattern main string "see below"
13251 .cindex "DNS" "pre-check of name syntax"
13252 When this option is set to a non-empty string, it causes Exim to check domain
13253 names for characters that are not allowed in host names before handing them to
13254 the DNS resolver, because some resolvers give temporary errors for names that
13255 contain unusual characters. If a domain name contains any unwanted characters,
13256 a &"not found"& result is forced, and the resolver is not called. The check is
13257 done by matching the domain name against a regular expression, which is the
13258 value of this option. The default pattern is
13259 .code
13260 dns_check_names_pattern = \
13261   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
13262 .endd
13263 which permits only letters, digits, slashes, and hyphens in components, but
13264 they must start and end with a letter or digit. Slashes are not, in fact,
13265 permitted in host names, but they are found in certain NS records (which can be
13266 accessed in Exim by using a &%dnsdb%& lookup). If you set
13267 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
13268 empty string.
13269
13270 .option dns_csa_search_limit main integer 5
13271 This option controls the depth of parental searching for CSA SRV records in the
13272 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
13273
13274 .option dns_csa_use_reverse main boolean true
13275 This option controls whether or not an IP address, given as a CSA domain, is
13276 reversed and looked up in the reverse DNS, as described in more detail in
13277 section &<<SECTverifyCSA>>&.
13278
13279 .option dns_ipv4_lookup main "domain list&!!" unset
13280 .cindex "IPv6" "DNS lookup for AAAA records"
13281 .cindex "DNS" "IPv6 lookup for AAAA records"
13282 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
13283 looks for IPv6 address records (AAAA records) as well as IPv4 address records
13284 (A records) when trying to find IP addresses for hosts, unless the host's
13285 domain matches this list.
13286
13287 This is a fudge to help with name servers that give big delays or otherwise do
13288 not work for the AAAA record type. In due course, when the world's name
13289 servers have all been upgraded, there should be no need for this option.
13290
13291
13292 .option dns_retrans main time 0s
13293 .cindex "DNS" "resolver options"
13294 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
13295 retransmission and retry parameters for DNS lookups. Values of zero (the
13296 defaults) leave the system default settings unchanged. The first value is the
13297 time between retries, and the second is the number of retries. It isn't
13298 totally clear exactly how these settings affect the total time a DNS lookup may
13299 take. I haven't found any documentation about timeouts on DNS lookups; these
13300 parameter values are available in the external resolver interface structure,
13301 but nowhere does it seem to describe how they are used or what you might want
13302 to set in them.
13303
13304
13305 .option dns_retry main integer 0
13306 See &%dns_retrans%& above.
13307
13308
13309 .option drop_cr main boolean false
13310 This is an obsolete option that is now a no-op. It used to affect the way Exim
13311 handled CR and LF characters in incoming messages. What happens now is
13312 described in section &<<SECTlineendings>>&.
13313
13314 .option dsn_from main "string&!!" "see below"
13315 .cindex "&'From:'& header line" "in bounces"
13316 .cindex "bounce messages" "&'From:'& line, specifying"
13317 This option can be used to vary the contents of &'From:'& header lines in
13318 bounces and other automatically generated messages (&"Delivery Status
13319 Notifications"& &-- hence the name of the option). The default setting is:
13320 .code
13321 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
13322 .endd
13323 The value is expanded every time it is needed. If the expansion fails, a
13324 panic is logged, and the default value is used.
13325
13326 .option envelope_to_remove main boolean true
13327 .cindex "&'Envelope-to:'& header line"
13328 Exim's transports have an option for adding an &'Envelope-to:'& header to a
13329 message when it is delivered, in exactly the same way as &'Return-path:'& is
13330 handled. &'Envelope-to:'& records the original recipient address from the
13331 messages's envelope that caused the delivery to happen. Such headers should not
13332 be present in incoming messages, and this option causes them to be removed at
13333 the time the message is received, to avoid any problems that might occur when a
13334 delivered message is subsequently sent on to some other recipient.
13335
13336
13337 .option errors_copy main "string list&!!" unset
13338 .cindex "bounce message" "copy to other address"
13339 .cindex "copy of bounce message"
13340 Setting this option causes Exim to send bcc copies of bounce messages that it
13341 generates to other addresses. &*Note*&: This does not apply to bounce messages
13342 coming from elsewhere. The value of the option is a colon-separated list of
13343 items. Each item consists of a pattern, terminated by white space, followed by
13344 a comma-separated list of email addresses. If a pattern contains spaces, it
13345 must be enclosed in double quotes.
13346
13347 Each pattern is processed in the same way as a single item in an address list
13348 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
13349 the bounce message, the message is copied to the addresses on the list. The
13350 items are scanned in order, and once a matching one is found, no further items
13351 are examined. For example:
13352 .code
13353 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
13354               rqps@mydomain   hostmaster@mydomain.example,\
13355                               postmaster@mydomain.example
13356 .endd
13357 .vindex "&$domain$&"
13358 .vindex "&$local_part$&"
13359 The address list is expanded before use. The expansion variables &$local_part$&
13360 and &$domain$& are set from the original recipient of the error message, and if
13361 there was any wildcard matching in the pattern, the expansion
13362 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
13363 variables &$0$&, &$1$&, etc. are set in the normal way.
13364
13365
13366 .option errors_reply_to main string unset
13367 .cindex "bounce message" "&'Reply-to:'& in"
13368 By default, Exim's bounce and delivery warning messages contain the header line
13369 .display
13370 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
13371 .endd
13372 .oindex &%quota_warn_message%&
13373 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
13374 A warning message that is generated by the &%quota_warn_message%& option in an
13375 &(appendfile)& transport may contain its own &'From:'& header line that
13376 overrides the default.
13377
13378 Experience shows that people reply to bounce messages. If the
13379 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
13380 and warning messages. For example:
13381 .code
13382 errors_reply_to = postmaster@my.domain.example
13383 .endd
13384 The value of the option is not expanded. It must specify a valid RFC 2822
13385 address. However, if a warning message that is generated by the
13386 &%quota_warn_message%& option in an &(appendfile)& transport contain its
13387 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
13388 not used.
13389
13390
13391 .option exim_group main string "compile-time configured"
13392 .cindex "gid (group id)" "Exim's own"
13393 .cindex "Exim group"
13394 This option changes the gid under which Exim runs when it gives up root
13395 privilege. The default value is compiled into the binary. The value of this
13396 option is used only when &%exim_user%& is also set. Unless it consists entirely
13397 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
13398 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
13399 security issues.
13400
13401
13402 .option exim_path main string "see below"
13403 .cindex "Exim binary, path name"
13404 This option specifies the path name of the Exim binary, which is used when Exim
13405 needs to re-exec itself. The default is set up to point to the file &'exim'& in
13406 the directory configured at compile time by the BIN_DIRECTORY setting. It
13407 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
13408 other place.
13409 &*Warning*&: Do not use a macro to define the value of this option, because
13410 you will break those Exim utilities that scan the configuration file to find
13411 where the binary is. (They then use the &%-bP%& option to extract option
13412 settings such as the value of &%spool_directory%&.)
13413
13414
13415 .option exim_user main string "compile-time configured"
13416 .cindex "uid (user id)" "Exim's own"
13417 .cindex "Exim user"
13418 This option changes the uid under which Exim runs when it gives up root
13419 privilege. The default value is compiled into the binary. Ownership of the run
13420 time configuration file and the use of the &%-C%& and &%-D%& command line
13421 options is checked against the values in the binary, not what is set here.
13422
13423 Unless it consists entirely of digits, the string is looked up using
13424 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
13425 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
13426 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
13427
13428
13429 .option extra_local_interfaces main "string list" unset
13430 This option defines network interfaces that are to be considered local when
13431 routing, but which are not used for listening by the daemon. See section
13432 &<<SECTreclocipadd>>& for details.
13433
13434
13435 . Allow this long option name to split; give it unsplit as a fifth argument
13436 . for the automatic .oindex that is generated by .option.
13437
13438 .option "extract_addresses_remove_ &~&~arguments" main boolean true &&&
13439          extract_addresses_remove_arguments
13440 .oindex "&%-t%&"
13441 .cindex "command line" "addresses with &%-t%&"
13442 .cindex "Sendmail compatibility" "&%-t%& option"
13443 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
13444 are present on the command line when the &%-t%& option is used to build an
13445 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
13446 line addresses are removed from the recipients list. This is also how Smail
13447 behaves. However, other Sendmail documentation (the O'Reilly book) states that
13448 command line addresses are added to those obtained from the header lines. When
13449 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
13450 argument headers. If it is set false, Exim adds rather than removes argument
13451 addresses.
13452
13453
13454 .option finduser_retries main integer 0
13455 .cindex "NIS, retrying user lookups"
13456 On systems running NIS or other schemes in which user and group information is
13457 distributed from a remote system, there can be times when &[getpwnam()]& and
13458 related functions fail, even when given valid data, because things time out.
13459 Unfortunately these failures cannot be distinguished from genuine &"not found"&
13460 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
13461 many extra times to find a user or a group, waiting for one second between
13462 retries.
13463
13464 .cindex "&_/etc/passwd_&" "multiple reading of"
13465 You should not set this option greater than zero if your user information is in
13466 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
13467 search the file multiple times for non-existent users, and also cause delay.
13468
13469
13470
13471 .option freeze_tell main "string list, comma separated" unset
13472 .cindex "freezing messages" "sending a message when freezing"
13473 On encountering certain errors, or when configured to do so in a system filter,
13474 ACL, or special router, Exim freezes a message. This means that no further
13475 delivery attempts take place until an administrator thaws the message, or the
13476 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
13477 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
13478 warning message whenever it freezes something, unless the message it is
13479 freezing is a locally-generated bounce message. (Without this exception there
13480 is the possibility of looping.) The warning message is sent to the addresses
13481 supplied as the comma-separated value of this option. If several of the
13482 message's addresses cause freezing, only a single message is sent. If the
13483 freezing was automatic, the reason(s) for freezing can be found in the message
13484 log. If you configure freezing in a filter or ACL, you must arrange for any
13485 logging that you require.
13486
13487
13488 .option gecos_name main string&!! unset
13489 .cindex "HP-UX"
13490 .cindex "&""gecos""& field, parsing"
13491 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
13492 password file to hold other information in addition to users' real names. Exim
13493 looks up this field for use when it is creating &'Sender:'& or &'From:'&
13494 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
13495 of the field are used unchanged, except that, if an ampersand is encountered,
13496 it is replaced by the user's login name with the first character forced to
13497 upper case, since this is a convention that is observed on many systems.
13498
13499 When these options are set, &%gecos_pattern%& is treated as a regular
13500 expression that is to be applied to the field (again with && replaced by the
13501 login name), and if it matches, &%gecos_name%& is expanded and used as the
13502 user's name.
13503
13504 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
13505 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
13506 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
13507 name terminates at the first comma, the following can be used:
13508 .code
13509 gecos_pattern = ([^,]*)
13510 gecos_name = $1
13511 .endd
13512
13513 .option gecos_pattern main string unset
13514 See &%gecos_name%& above.
13515
13516
13517 .option gnutls_require_kx main string unset
13518 This option controls the key exchange mechanisms when GnuTLS is used in an Exim
13519 server. For details, see section &<<SECTreqciphgnu>>&.
13520
13521 .option gnutls_require_mac main string unset
13522 This option controls the MAC algorithms when GnuTLS is used in an Exim
13523 server. For details, see section &<<SECTreqciphgnu>>&.
13524
13525 .option gnutls_require_protocols main string unset
13526 This option controls the protocols when GnuTLS is used in an Exim
13527 server. For details, see section &<<SECTreqciphgnu>>&.
13528
13529 .option gnutls_compat_mode main boolean unset
13530 This option controls whether GnuTLS is used in compatibility mode in an Exim
13531 server. This reduces security slightly, but improves interworking with older
13532 implementations of TLS.
13533
13534 .option headers_charset main string "see below"
13535 This option sets a default character set for translating from encoded MIME
13536 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
13537 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
13538 ultimate default is ISO-8859-1. For more details see the description of header
13539 insertions in section &<<SECTexpansionitems>>&.
13540
13541
13542
13543 .option header_maxsize main integer "see below"
13544 .cindex "header section" "maximum size of"
13545 .cindex "limit" "size of message header section"
13546 This option controls the overall maximum size of a message's header
13547 section. The default is the value of HEADER_MAXSIZE in
13548 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
13549 sections are rejected.
13550
13551
13552 .option header_line_maxsize main integer 0
13553 .cindex "header lines" "maximum size of"
13554 .cindex "limit" "size of one header line"
13555 This option limits the length of any individual header line in a message, after
13556 all the continuations have been joined together. Messages with individual
13557 header lines that are longer than the limit are rejected. The default value of
13558 zero means &"no limit"&.
13559
13560
13561
13562
13563 .option helo_accept_junk_hosts main "host list&!!" unset
13564 .cindex "HELO" "accepting junk data"
13565 .cindex "EHLO" "accepting junk data"
13566 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
13567 mail, and gives an error response for invalid data. Unfortunately, there are
13568 some SMTP clients that send syntactic junk. They can be accommodated by setting
13569 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
13570 if you want to do semantic checking.
13571 See also &%helo_allow_chars%& for a way of extending the permitted character
13572 set.
13573
13574
13575 .option helo_allow_chars main string unset
13576 .cindex "HELO" "underscores in"
13577 .cindex "EHLO" "underscores in"
13578 .cindex "underscore in EHLO/HELO"
13579 This option can be set to a string of rogue characters that are permitted in
13580 all EHLO and HELO names in addition to the standard letters, digits,
13581 hyphens, and dots. If you really must allow underscores, you can set
13582 .code
13583 helo_allow_chars = _
13584 .endd
13585 Note that the value is one string, not a list.
13586
13587
13588 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
13589 .cindex "HELO" "forcing reverse lookup"
13590 .cindex "EHLO" "forcing reverse lookup"
13591 If the domain given by a client in a HELO or EHLO command matches this
13592 list, a reverse lookup is done in order to establish the host's true name. The
13593 default forces a lookup if the client host gives the server's name or any of
13594 its IP addresses (in brackets), something that broken clients have been seen to
13595 do.
13596
13597
13598 .option helo_try_verify_hosts main "host list&!!" unset
13599 .cindex "HELO verifying" "optional"
13600 .cindex "EHLO" "verifying, optional"
13601 By default, Exim just checks the syntax of HELO and EHLO commands (see
13602 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
13603 to do more extensive checking of the data supplied by these commands. The ACL
13604 condition &`verify = helo`& is provided to make this possible.
13605 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
13606 to force the check to occur. From release 4.53 onwards, this is no longer
13607 necessary. If the check has not been done before &`verify = helo`& is
13608 encountered, it is done at that time. Consequently, this option is obsolete.
13609 Its specification is retained here for backwards compatibility.
13610
13611 When an EHLO or HELO command is received, if the calling host matches
13612 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
13613 EHLO command either:
13614
13615 .ilist
13616 is an IP literal matching the calling address of the host, or
13617 .next
13618 .cindex "DNS" "reverse lookup"
13619 .cindex "reverse DNS lookup"
13620 matches the host name that Exim obtains by doing a reverse lookup of the
13621 calling host address, or
13622 .next
13623 when looked up using &[gethostbyname()]& (or &[getipnodebyname()]& when
13624 available) yields the calling host address.
13625 .endlist
13626
13627 However, the EHLO or HELO command is not rejected if any of the checks
13628 fail. Processing continues, but the result of the check is remembered, and can
13629 be detected later in an ACL by the &`verify = helo`& condition.
13630
13631 .option helo_verify_hosts main "host list&!!" unset
13632 .cindex "HELO verifying" "mandatory"
13633 .cindex "EHLO" "verifying, mandatory"
13634 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
13635 backwards compatibility. For hosts that match this option, Exim checks the host
13636 name given in the HELO or EHLO in the same way as for
13637 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
13638 rejected with a 550 error, and entries are written to the main and reject logs.
13639 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
13640 error.
13641
13642 .option hold_domains main "domain list&!!" unset
13643 .cindex "domain" "delaying delivery"
13644 .cindex "delivery" "delaying certain domains"
13645 This option allows mail for particular domains to be held on the queue
13646 manually. The option is overridden if a message delivery is forced with the
13647 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
13648 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
13649 item in &%hold_domains%&, no routing or delivery for that address is done, and
13650 it is deferred every time the message is looked at.
13651
13652 This option is intended as a temporary operational measure for delaying the
13653 delivery of mail while some problem is being sorted out, or some new
13654 configuration tested. If you just want to delay the processing of some
13655 domains until a queue run occurs, you should use &%queue_domains%& or
13656 &%queue_smtp_domains%&, not &%hold_domains%&.
13657
13658 A setting of &%hold_domains%& does not override Exim's code for removing
13659 messages from the queue if they have been there longer than the longest retry
13660 time in any retry rule. If you want to hold messages for longer than the normal
13661 retry times, insert a dummy retry rule with a long retry time.
13662
13663
13664 .option host_lookup main "host list&!!" unset
13665 .cindex "host name" "lookup, forcing"
13666 Exim does not look up the name of a calling host from its IP address unless it
13667 is required to compare against some host list, or the host matches
13668 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
13669 option (which normally contains IP addresses rather than host names). The
13670 default configuration file contains
13671 .code
13672 host_lookup = *
13673 .endd
13674 which causes a lookup to happen for all hosts. If the expense of these lookups
13675 is felt to be too great, the setting can be changed or removed.
13676
13677 After a successful reverse lookup, Exim does a forward lookup on the name it
13678 has obtained, to verify that it yields the IP address that it started with. If
13679 this check fails, Exim behaves as if the name lookup failed.
13680
13681 .vindex "&$host_lookup_failed$&"
13682 .vindex "&$sender_host_name$&"
13683 After any kind of failure, the host name (in &$sender_host_name$&) remains
13684 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
13685 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
13686 &`verify = reverse_host_lookup`& in ACLs.
13687
13688
13689 .option host_lookup_order main "string list" &`bydns:byaddr`&
13690 This option specifies the order of different lookup methods when Exim is trying
13691 to find a host name from an IP address. The default is to do a DNS lookup
13692 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
13693 if that fails. You can change the order of these lookups, or omit one entirely,
13694 if you want.
13695
13696 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
13697 multiple PTR records in the DNS and the IP address is not listed in
13698 &_/etc/hosts_&. Different operating systems give different results in this
13699 case. That is why the default tries a DNS lookup first.
13700
13701
13702
13703 .option host_reject_connection main "host list&!!" unset
13704 .cindex "host" "rejecting connections from"
13705 If this option is set, incoming SMTP calls from the hosts listed are rejected
13706 as soon as the connection is made.
13707 This option is obsolete, and retained only for backward compatibility, because
13708 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
13709 connections immediately.
13710
13711 The ability to give an immediate rejection (either by this option or using an
13712 ACL) is provided for use in unusual cases. Many hosts will just try again,
13713 sometimes without much delay. Normally, it is better to use an ACL to reject
13714 incoming messages at a later stage, such as after RCPT commands. See
13715 chapter &<<CHAPACL>>&.
13716
13717
13718 .option hosts_connection_nolog main "host list&!!" unset
13719 .cindex "host" "not logging connections from"
13720 This option defines a list of hosts for which connection logging does not
13721 happen, even though the &%smtp_connection%& log selector is set. For example,
13722 you might want not to log SMTP connections from local processes, or from
13723 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
13724 the daemon; you should therefore strive to restrict its value to a short inline
13725 list of IP addresses and networks. To disable logging SMTP connections from
13726 local processes, you must create a host list with an empty item. For example:
13727 .code
13728 hosts_connection_nolog = :
13729 .endd
13730 If the &%smtp_connection%& log selector is not set, this option has no effect.
13731
13732
13733
13734 .option hosts_treat_as_local main "domain list&!!" unset
13735 .cindex "local host" "domains treated as"
13736 .cindex "host" "treated as local"
13737 If this option is set, any host names that match the domain list are treated as
13738 if they were the local host when Exim is scanning host lists obtained from MX
13739 records
13740 or other sources. Note that the value of this option is a domain list, not a
13741 host list, because it is always used to check host names, not IP addresses.
13742
13743 This option also applies when Exim is matching the special items
13744 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
13745 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
13746 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
13747 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
13748 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
13749 interfaces and recognizing the local host.
13750
13751
13752 .option ibase_servers main "string list" unset
13753 .cindex "InterBase" "server list"
13754 This option provides a list of InterBase servers and associated connection data,
13755 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
13756 The option is available only if Exim has been built with InterBase support.
13757
13758
13759
13760 .option ignore_bounce_errors_after main time 10w
13761 .cindex "bounce message" "discarding"
13762 .cindex "discarding bounce message"
13763 This option affects the processing of bounce messages that cannot be delivered,
13764 that is, those that suffer a permanent delivery failure. (Bounce messages that
13765 suffer temporary delivery failures are of course retried in the usual way.)
13766
13767 After a permanent delivery failure, bounce messages are frozen,
13768 because there is no sender to whom they can be returned. When a frozen bounce
13769 message has been on the queue for more than the given time, it is unfrozen at
13770 the next queue run, and a further delivery is attempted. If delivery fails
13771 again, the bounce message is discarded. This makes it possible to keep failed
13772 bounce messages around for a shorter time than the normal maximum retry time
13773 for frozen messages. For example,
13774 .code
13775 ignore_bounce_errors_after = 12h
13776 .endd
13777 retries failed bounce message deliveries after 12 hours, discarding any further
13778 failures. If the value of this option is set to a zero time period, bounce
13779 failures are discarded immediately. Setting a very long time (as in the default
13780 value) has the effect of disabling this option. For ways of automatically
13781 dealing with other kinds of frozen message, see &%auto_thaw%& and
13782 &%timeout_frozen_after%&.
13783
13784
13785 .option ignore_fromline_hosts main "host list&!!" unset
13786 .cindex "&""From""& line"
13787 .cindex "UUCP" "&""From""& line"
13788 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
13789 the headers of a message. By default this is treated as the start of the
13790 message's body, which means that any following headers are not recognized as
13791 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
13792 match those hosts that insist on sending it. If the sender is actually a local
13793 process rather than a remote host, and is using &%-bs%& to inject the messages,
13794 &%ignore_fromline_local%& must be set to achieve this effect.
13795
13796
13797 .option ignore_fromline_local main boolean false
13798 See &%ignore_fromline_hosts%& above.
13799
13800
13801 .option keep_malformed main time 4d
13802 This option specifies the length of time to keep messages whose spool files
13803 have been corrupted in some way. This should, of course, never happen. At the
13804 next attempt to deliver such a message, it gets removed. The incident is
13805 logged.
13806
13807
13808 .option ldap_default_servers main "string list" unset
13809 .cindex "LDAP" "default servers"
13810 This option provides a list of LDAP servers which are tried in turn when an
13811 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
13812 details of LDAP queries. This option is available only when Exim has been built
13813 with LDAP support.
13814
13815
13816 .option ldap_version main integer unset
13817 .cindex "LDAP" "protocol version, forcing"
13818 This option can be used to force Exim to set a specific protocol version for
13819 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
13820 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
13821 the LDAP headers; otherwise it is 2. This option is available only when Exim
13822 has been built with LDAP support.
13823
13824
13825
13826 .option local_from_check main boolean true
13827 .cindex "&'Sender:'& header line" "disabling addition of"
13828 .cindex "&'From:'& header line" "disabling checking of"
13829 When a message is submitted locally (that is, not over a TCP/IP connection) by
13830 an untrusted user, Exim removes any existing &'Sender:'& header line, and
13831 checks that the &'From:'& header line matches the login of the calling user and
13832 the domain specified by &%qualify_domain%&.
13833
13834 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
13835 locally submitted message is automatically qualified by Exim, unless the
13836 &%-bnq%& command line option is used.
13837
13838 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
13839 on the local part. If the &'From:'& header line does not match, Exim adds a
13840 &'Sender:'& header with an address constructed from the calling user's login
13841 and the default qualify domain.
13842
13843 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
13844 and no &'Sender:'& header is ever added. If, in addition, you want to retain
13845 &'Sender:'& header lines supplied by untrusted users, you must also set
13846 &%local_sender_retain%& to be true.
13847
13848 .cindex "envelope sender"
13849 These options affect only the header lines in the message. The envelope sender
13850 is still forced to be the login id at the qualify domain unless
13851 &%untrusted_set_sender%& permits the user to supply an envelope sender.
13852
13853 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
13854 request similar header line checking. See section &<<SECTthesenhea>>&, which
13855 has more details about &'Sender:'& processing.
13856
13857
13858
13859
13860 .option local_from_prefix main string unset
13861 When Exim checks the &'From:'& header line of locally submitted messages for
13862 matching the login id (see &%local_from_check%& above), it can be configured to
13863 ignore certain prefixes and suffixes in the local part of the address. This is
13864 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
13865 appropriate lists, in the same form as the &%local_part_prefix%& and
13866 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
13867 example, if
13868 .code
13869 local_from_prefix = *-
13870 .endd
13871 is set, a &'From:'& line containing
13872 .code
13873 From: anything-user@your.domain.example
13874 .endd
13875 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
13876 matches the actual sender address that is constructed from the login name and
13877 qualify domain.
13878
13879
13880 .option local_from_suffix main string unset
13881 See &%local_from_prefix%& above.
13882
13883
13884 .option local_interfaces main "string list" "see below"
13885 This option controls which network interfaces are used by the daemon for
13886 listening; they are also used to identify the local host when routing. Chapter
13887 &<<CHAPinterfaces>>& contains a full description of this option and the related
13888 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
13889 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
13890 &%local_interfaces%& is
13891 .code
13892 local_interfaces = 0.0.0.0
13893 .endd
13894 when Exim is built without IPv6 support; otherwise it is
13895 .code
13896 local_interfaces = <; ::0 ; 0.0.0.0
13897 .endd
13898
13899 .option local_scan_timeout main time 5m
13900 .cindex "timeout" "for &[local_scan()]& function"
13901 .cindex "&[local_scan()]& function" "timeout"
13902 This timeout applies to the &[local_scan()]& function (see chapter
13903 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
13904 the incoming message is rejected with a temporary error if it is an SMTP
13905 message. For a non-SMTP message, the message is dropped and Exim ends with a
13906 non-zero code. The incident is logged on the main and reject logs.
13907
13908
13909
13910 .option local_sender_retain main boolean false
13911 .cindex "&'Sender:'& header line" "retaining from local submission"
13912 When a message is submitted locally (that is, not over a TCP/IP connection) by
13913 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
13914 do not want this to happen, you must set &%local_sender_retain%&, and you must
13915 also set &%local_from_check%& to be false (Exim will complain if you do not).
13916 See also the ACL modifier &`control = suppress_local_fixups`&. Section
13917 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
13918
13919
13920
13921
13922 .option localhost_number main string&!! unset
13923 .cindex "host" "locally unique number for"
13924 .cindex "message ids" "with multiple hosts"
13925 .vindex "&$localhost_number$&"
13926 Exim's message ids are normally unique only within the local host. If
13927 uniqueness among a set of hosts is required, each host must set a different
13928 value for the &%localhost_number%& option. The string is expanded immediately
13929 after reading the configuration file (so that a number can be computed from the
13930 host name, for example) and the result of the expansion must be a number in the
13931 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
13932 systems). This is available in subsequent string expansions via the variable
13933 &$localhost_number$&. When &%localhost_number is set%&, the final two
13934 characters of the message id, instead of just being a fractional part of the
13935 time, are computed from the time and the local host number as described in
13936 section &<<SECTmessiden>>&.
13937
13938
13939
13940 .option log_file_path main "string list&!!" "set at compile time"
13941 .cindex "log" "file path for"
13942 This option sets the path which is used to determine the names of Exim's log
13943 files, or indicates that logging is to be to syslog, or both. It is expanded
13944 when Exim is entered, so it can, for example, contain a reference to the host
13945 name. If no specific path is set for the log files at compile or run time, they
13946 are written in a sub-directory called &_log_& in Exim's spool directory.
13947 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
13948 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
13949 used. If this string is fixed at your installation (contains no expansion
13950 variables) it is recommended that you do not set this option in the
13951 configuration file, but instead supply the path using LOG_FILE_PATH in
13952 &_Local/Makefile_& so that it is available to Exim for logging errors detected
13953 early on &-- in particular, failure to read the configuration file.
13954
13955
13956 .option log_selector main string unset
13957 .cindex "log" "selectors"
13958 This option can be used to reduce or increase the number of things that Exim
13959 writes to its log files. Its argument is made up of names preceded by plus or
13960 minus characters. For example:
13961 .code
13962 log_selector = +arguments -retry_defer
13963 .endd
13964 A list of possible names and what they control is given in the chapter on
13965 logging, in section &<<SECTlogselector>>&.
13966
13967
13968 .option log_timezone main boolean false
13969 .cindex "log" "timezone for entries"
13970 .vindex "&$tod_log$&"
13971 .vindex "&$tod_zone$&"
13972 By default, the timestamps on log lines are in local time without the
13973 timezone. This means that if your timezone changes twice a year, the timestamps
13974 in log lines are ambiguous for an hour when the clocks go back. One way of
13975 avoiding this problem is to set the timezone to UTC. An alternative is to set
13976 &%log_timezone%& true. This turns on the addition of the timezone offset to
13977 timestamps in log lines. Turning on this option can add quite a lot to the size
13978 of log files because each line is extended by 6 characters. Note that the
13979 &$tod_log$& variable contains the log timestamp without the zone, but there is
13980 another variable called &$tod_zone$& that contains just the timezone offset.
13981
13982
13983 .option lookup_open_max main integer 25
13984 .cindex "too many open files"
13985 .cindex "open files, too many"
13986 .cindex "file" "too many open"
13987 .cindex "lookup" "maximum open files"
13988 .cindex "limit" "open files for lookups"
13989 This option limits the number of simultaneously open files for single-key
13990 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
13991 Exim normally keeps these files open during routing, because often the same
13992 file is required several times. If the limit is reached, Exim closes the least
13993 recently used file. Note that if you are using the &'ndbm'& library, it
13994 actually opens two files for each logical DBM database, though it still counts
13995 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
13996 open files"& errors with NDBM, you need to reduce the value of
13997 &%lookup_open_max%&.
13998
13999
14000 .option max_username_length main integer 0
14001 .cindex "length of login name"
14002 .cindex "user name" "maximum length"
14003 .cindex "limit" "user name length"
14004 Some operating systems are broken in that they truncate long arguments to
14005 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
14006 this option is set greater than zero, any attempt to call &[getpwnam()]& with
14007 an argument that is longer behaves as if &[getpwnam()]& failed.
14008
14009
14010 .option message_body_newlines main bool false
14011 .cindex "message body" "newlines in variables"
14012 .cindex "newline" "in message body variables"
14013 .vindex "&$message_body$&"
14014 .vindex "&$message_body_end$&"
14015 By default, newlines in the message body are replaced by spaces when setting
14016 the &$message_body$& and &$message_body_end$& expansion variables. If this
14017 option is set true, this no longer happens.
14018
14019
14020 .option message_body_visible main integer 500
14021 .cindex "body of message" "visible size"
14022 .cindex "message body" "visible size"
14023 .vindex "&$message_body$&"
14024 .vindex "&$message_body_end$&"
14025 This option specifies how much of a message's body is to be included in the
14026 &$message_body$& and &$message_body_end$& expansion variables.
14027
14028
14029 .option message_id_header_domain main string&!! unset
14030 .cindex "&'Message-ID:'& header line"
14031 If this option is set, the string is expanded and used as the right hand side
14032 (domain) of the &'Message-ID:'& header that Exim creates if a
14033 locally-originated incoming message does not have one. &"Locally-originated"&
14034 means &"not received over TCP/IP."&
14035 Otherwise, the primary host name is used.
14036 Only letters, digits, dot and hyphen are accepted; any other characters are
14037 replaced by hyphens. If the expansion is forced to fail, or if the result is an
14038 empty string, the option is ignored.
14039
14040
14041 .option message_id_header_text main string&!! unset
14042 If this variable is set, the string is expanded and used to augment the text of
14043 the &'Message-id:'& header that Exim creates if a locally-originated incoming
14044 message does not have one. The text of this header is required by RFC 2822 to
14045 take the form of an address. By default, Exim uses its internal message id as
14046 the local part, and the primary host name as the domain. If this option is set,
14047 it is expanded, and provided the expansion is not forced to fail, and does not
14048 yield an empty string, the result is inserted into the header immediately
14049 before the @, separated from the internal message id by a dot. Any characters
14050 that are illegal in an address are automatically converted into hyphens. This
14051 means that variables such as &$tod_log$& can be used, because the spaces and
14052 colons will become hyphens.
14053
14054
14055 .option message_logs main boolean true
14056 .cindex "message logs" "disabling"
14057 .cindex "log" "message log; disabling"
14058 If this option is turned off, per-message log files are not created in the
14059 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
14060 Exim, by reducing the number of files involved in handling a message from a
14061 minimum of four (header spool file, body spool file, delivery journal, and
14062 per-message log) to three. The other major I/O activity is Exim's main log,
14063 which is not affected by this option.
14064
14065
14066 .option message_size_limit main string&!! 50M
14067 .cindex "message" "size limit"
14068 .cindex "limit" "message size"
14069 .cindex "size" "of message, limit"
14070 This option limits the maximum size of message that Exim will process. The
14071 value is expanded for each incoming connection so, for example, it can be made
14072 to depend on the IP address of the remote host for messages arriving via
14073 TCP/IP. After expansion, the value must be a sequence of decimal digits,
14074 optionally followed by K or M.
14075
14076 &*Note*&: This limit cannot be made to depend on a message's sender or any
14077 other properties of an individual message, because it has to be advertised in
14078 the server's response to EHLO. String expansion failure causes a temporary
14079 error. A value of zero means no limit, but its use is not recommended. See also
14080 &%bounce_return_size_limit%&.
14081
14082 Incoming SMTP messages are failed with a 552 error if the limit is
14083 exceeded; locally-generated messages either get a stderr message or a delivery
14084 failure message to the sender, depending on the &%-oe%& setting. Rejection of
14085 an oversized message is logged in both the main and the reject logs. See also
14086 the generic transport option &%message_size_limit%&, which limits the size of
14087 message that an individual transport can process.
14088
14089 .new
14090 If you use a virus-scanner and set this option to to a value larger than the
14091 maximum size that your virus-scanner is configured to support, you may get
14092 failures triggered by large mails.  The right size to configure for the
14093 virus-scanner depends upon what data is passed and the options in use but it's
14094 probably safest to just set it to a little larger than this value.  Eg, with a
14095 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
14096 some problems may result.
14097 .wen
14098
14099
14100 .option move_frozen_messages main boolean false
14101 .cindex "frozen messages" "moving"
14102 This option, which is available only if Exim has been built with the setting
14103 .code
14104 SUPPORT_MOVE_FROZEN_MESSAGES=yes
14105 .endd
14106 in &_Local/Makefile_&, causes frozen messages and their message logs to be
14107 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
14108 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
14109 standard utilities for handling such moved messages, and they do not show up in
14110 lists generated by &%-bp%& or by the Exim monitor.
14111
14112
14113 .option mua_wrapper main boolean false
14114 Setting this option true causes Exim to run in a very restrictive mode in which
14115 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
14116 contains a full description of this facility.
14117
14118
14119
14120 .option mysql_servers main "string list" unset
14121 .cindex "MySQL" "server list"
14122 This option provides a list of MySQL servers and associated connection data, to
14123 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
14124 option is available only if Exim has been built with MySQL support.
14125
14126
14127 .option never_users main "string list&!!" unset
14128 This option is expanded just once, at the start of Exim's processing. Local
14129 message deliveries are normally run in processes that are setuid to the
14130 recipient, and remote deliveries are normally run under Exim's own uid and gid.
14131 It is usually desirable to prevent any deliveries from running as root, as a
14132 safety precaution.
14133
14134 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
14135 list of users that must not be used for local deliveries. This list is fixed in
14136 the binary and cannot be overridden by the configuration file. By default, it
14137 contains just the single user name &"root"&. The &%never_users%& runtime option
14138 can be used to add more users to the fixed list.
14139
14140 If a message is to be delivered as one of the users on the fixed list or the
14141 &%never_users%& list, an error occurs, and delivery is deferred. A common
14142 example is
14143 .code
14144 never_users = root:daemon:bin
14145 .endd
14146 Including root is redundant if it is also on the fixed list, but it does no
14147 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
14148 transport driver.
14149
14150
14151 .new
14152 .option openssl_options main "string list" +dont_insert_empty_fragments
14153 .cindex "OpenSSL "compatibility options"
14154 This option allows an administrator to adjust the SSL options applied
14155 by OpenSSL to connections.  It is given as a space-separated list of items,
14156 each one to be +added or -subtracted from the current value.  The default
14157 value is one option which happens to have been set historically.  You can
14158 remove all options with:
14159 .code
14160 openssl_options = -all
14161 .endd
14162 This option is only available if Exim is built against OpenSSL.  The values
14163 available for this option vary according to the age of your OpenSSL install.
14164 The &"all"& value controls a subset of flags which are available, typically
14165 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
14166 list the values known on your system and Exim should support all the
14167 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
14168 names lose the leading &"SSL_OP_"& and are lower-cased.
14169
14170 Note that adjusting the options can have severe impact upon the security of
14171 SSL as used by Exim.  It is possible to disable safety checks and shoot
14172 yourself in the foot in various unpleasant ways.  This option should not be
14173 adjusted lightly.  An unrecognised item will be detected at by invoking Exim
14174 with the &%-bV%& flag.
14175
14176 An example:
14177 .code
14178 openssl_options = -all +microsoft_big_sslv3_buffer
14179 .endd
14180 .wen
14181
14182
14183 .option oracle_servers main "string list" unset
14184 .cindex "Oracle" "server list"
14185 This option provides a list of Oracle servers and associated connection data,
14186 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
14187 The option is available only if Exim has been built with Oracle support.
14188
14189
14190 .option percent_hack_domains main "domain list&!!" unset
14191 .cindex "&""percent hack""&"
14192 .cindex "source routing" "in email address"
14193 .cindex "address" "source-routed"
14194 The &"percent hack"& is the convention whereby a local part containing a
14195 percent sign is re-interpreted as a new email address, with the percent
14196 replaced by @. This is sometimes called &"source routing"&, though that term is
14197 also applied to RFC 2822 addresses that begin with an @ character. If this
14198 option is set, Exim implements the percent facility for those domains listed,
14199 but no others. This happens before an incoming SMTP address is tested against
14200 an ACL.
14201
14202 &*Warning*&: The &"percent hack"& has often been abused by people who are
14203 trying to get round relaying restrictions. For this reason, it is best avoided
14204 if at all possible. Unfortunately, a number of less security-conscious MTAs
14205 implement it unconditionally. If you are running Exim on a gateway host, and
14206 routing mail through to internal MTAs without processing the local parts, it is
14207 a good idea to reject recipient addresses with percent characters in their
14208 local parts. Exim's default configuration does this.
14209
14210
14211 .option perl_at_start main boolean false
14212 This option is available only when Exim is built with an embedded Perl
14213 interpreter. See chapter &<<CHAPperl>>& for details of its use.
14214
14215
14216 .option perl_startup main string unset
14217 This option is available only when Exim is built with an embedded Perl
14218 interpreter. See chapter &<<CHAPperl>>& for details of its use.
14219
14220
14221 .option pgsql_servers main "string list" unset
14222 .cindex "PostgreSQL lookup type" "server list"
14223 This option provides a list of PostgreSQL servers and associated connection
14224 data, to be used in conjunction with &(pgsql)& lookups (see section
14225 &<<SECID72>>&). The option is available only if Exim has been built with
14226 PostgreSQL support.
14227
14228
14229 .option pid_file_path main string&!! "set at compile time"
14230 .cindex "daemon" "pid file path"
14231 .cindex "pid file, path for"
14232 This option sets the name of the file to which the Exim daemon writes its
14233 process id. The string is expanded, so it can contain, for example, references
14234 to the host name:
14235 .code
14236 pid_file_path = /var/log/$primary_hostname/exim.pid
14237 .endd
14238 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
14239 spool directory.
14240 The value set by the option can be overridden by the &%-oP%& command line
14241 option. A pid file is not written if a &"non-standard"& daemon is run by means
14242 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
14243
14244
14245 .option pipelining_advertise_hosts main "host list&!!" *
14246 .cindex "PIPELINING" "suppressing advertising"
14247 This option can be used to suppress the advertisement of the SMTP
14248 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
14249 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
14250 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
14251 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
14252 that clients will use it; &"out of order"& commands that are &"expected"& do
14253 not count as protocol errors (see &%smtp_max_synprot_errors%&).
14254
14255
14256 .option preserve_message_logs main boolean false
14257 .cindex "message logs" "preserving"
14258 If this option is set, message log files are not deleted when messages are
14259 completed. Instead, they are moved to a sub-directory of the spool directory
14260 called &_msglog.OLD_&, where they remain available for statistical or debugging
14261 purposes. This is a dangerous option to set on systems with any appreciable
14262 volume of mail. Use with care!
14263
14264
14265 .option primary_hostname main string "see below"
14266 .cindex "name" "of local host"
14267 .cindex "host" "name of local"
14268 .cindex "local host" "name of"
14269 .vindex "&$primary_hostname$&"
14270 This specifies the name of the current host. It is used in the default EHLO or
14271 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
14272 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
14273 The value is also used by default in some SMTP response messages from an Exim
14274 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
14275
14276 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
14277 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
14278 contains only one component, Exim passes it to &[gethostbyname()]& (or
14279 &[getipnodebyname()]& when available) in order to obtain the fully qualified
14280 version. The variable &$primary_hostname$& contains the host name, whether set
14281 explicitly by this option, or defaulted.
14282
14283
14284 .option print_topbitchars main boolean false
14285 .cindex "printing characters"
14286 .cindex "8-bit characters"
14287 By default, Exim considers only those characters whose codes lie in the range
14288 32&--126 to be printing characters. In a number of circumstances (for example,
14289 when writing log entries) non-printing characters are converted into escape
14290 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
14291 is set, code values of 128 and above are also considered to be printing
14292 characters.
14293
14294 This option also affects the header syntax checks performed by the
14295 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
14296 the user's full name when constructing From: and Sender: addresses (as
14297 described in section &<<SECTconstr>>&). Setting this option can cause
14298 Exim to generate eight bit message headers that do not conform to the
14299 standards.
14300
14301
14302 .option process_log_path main string unset
14303 .cindex "process log path"
14304 .cindex "log" "process log"
14305 .cindex "&'exiwhat'&"
14306 This option sets the name of the file to which an Exim process writes its
14307 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
14308 utility script. If this option is unset, the file called &_exim-process.info_&
14309 in Exim's spool directory is used. The ability to specify the name explicitly
14310 can be useful in environments where two different Exims are running, using
14311 different spool directories.
14312
14313
14314 .option prod_requires_admin main boolean true
14315 .oindex "&%-M%&"
14316 .oindex "&%-R%&"
14317 .oindex "&%-q%&"
14318 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
14319 admin user unless &%prod_requires_admin%& is set false. See also
14320 &%queue_list_requires_admin%&.
14321
14322
14323 .option qualify_domain main string "see below"
14324 .cindex "domain" "for qualifying addresses"
14325 .cindex "address" "qualification"
14326 This option specifies the domain name that is added to any envelope sender
14327 addresses that do not have a domain qualification. It also applies to
14328 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
14329 are accepted by default only for locally-generated messages. Qualification is
14330 also applied to addresses in header lines such as &'From:'& and &'To:'& for
14331 locally-generated messages, unless the &%-bnq%& command line option is used.
14332
14333 Messages from external sources must always contain fully qualified addresses,
14334 unless the sending host matches &%sender_unqualified_hosts%& or
14335 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
14336 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
14337 necessary. Internally, Exim always works with fully qualified envelope
14338 addresses. If &%qualify_domain%& is not set, it defaults to the
14339 &%primary_hostname%& value.
14340
14341
14342 .option qualify_recipient main string "see below"
14343 This option allows you to specify a different domain for qualifying recipient
14344 addresses to the one that is used for senders. See &%qualify_domain%& above.
14345
14346
14347
14348 .option queue_domains main "domain list&!!" unset
14349 .cindex "domain" "specifying non-immediate delivery"
14350 .cindex "queueing incoming messages"
14351 .cindex "message" "queueing certain domains"
14352 This option lists domains for which immediate delivery is not required.
14353 A delivery process is started whenever a message is received, but only those
14354 domains that do not match are processed. All other deliveries wait until the
14355 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
14356
14357
14358 .option queue_list_requires_admin main boolean true
14359 .oindex "&%-bp%&"
14360 The &%-bp%& command-line option, which lists the messages that are on the
14361 queue, requires the caller to be an admin user unless
14362 &%queue_list_requires_admin%& is set false. See also &%prod_requires_admin%&.
14363
14364
14365 .option queue_only main boolean false
14366 .cindex "queueing incoming messages"
14367 .cindex "message" "queueing unconditionally"
14368 If &%queue_only%& is set, a delivery process is not automatically started
14369 whenever a message is received. Instead, the message waits on the queue for the
14370 next queue run. Even if &%queue_only%& is false, incoming messages may not get
14371 delivered immediately when certain conditions (such as heavy load) occur.
14372
14373 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
14374 and &%-odi%& command line options override &%queue_only%& unless
14375 &%queue_only_override%& is set false. See also &%queue_only_file%&,
14376 &%queue_only_load%&, and &%smtp_accept_queue%&.
14377
14378
14379 .option queue_only_file main string unset
14380 .cindex "queueing incoming messages"
14381 .cindex "message" "queueing by file existence"
14382 This option can be set to a colon-separated list of absolute path names, each
14383 one optionally preceded by &"smtp"&. When Exim is receiving a message,
14384 it tests for the existence of each listed path using a call to &[stat()]&. For
14385 each path that exists, the corresponding queueing option is set.
14386 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
14387 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
14388 .code
14389 queue_only_file = smtp/some/file
14390 .endd
14391 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
14392 &_/some/file_& exists.
14393
14394
14395 .option queue_only_load main fixed-point unset
14396 .cindex "load average"
14397 .cindex "queueing incoming messages"
14398 .cindex "message" "queueing by load"
14399 If the system load average is higher than this value, incoming messages from
14400 all sources are queued, and no automatic deliveries are started. If this
14401 happens during local or remote SMTP input, all subsequent messages received on
14402 the same SMTP connection are queued by default, whatever happens to the load in
14403 the meantime, but this can be changed by setting &%queue_only_load_latch%&
14404 false.
14405
14406 Deliveries will subsequently be performed by queue runner processes. This
14407 option has no effect on ancient operating systems on which Exim cannot
14408 determine the load average. See also &%deliver_queue_load_max%& and
14409 &%smtp_load_reserve%&.
14410
14411
14412 .option queue_only_load_latch main boolean true
14413 .cindex "load average" "re-evaluating per message"
14414 When this option is true (the default), once one message has been queued
14415 because the load average is higher than the value set by &%queue_only_load%&,
14416 all subsequent messages received on the same SMTP connection are also queued.
14417 This is a deliberate choice; even though the load average may fall below the
14418 threshold, it doesn't seem right to deliver later messages on the same
14419 connection when not delivering earlier ones. However, there are special
14420 circumstances such as very long-lived connections from scanning appliances
14421 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
14422 should be set false. This causes the value of the load average to be
14423 re-evaluated for each message.
14424
14425
14426 .option queue_only_override main boolean true
14427 .cindex "queueing incoming messages"
14428 When this option is true, the &%-od%&&'x'& command line options override the
14429 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
14430 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
14431 to override; they are accepted, but ignored.
14432
14433
14434 .option queue_run_in_order main boolean false
14435 .cindex "queue runner" "processing messages in order"
14436 If this option is set, queue runs happen in order of message arrival instead of
14437 in an arbitrary order. For this to happen, a complete list of the entire queue
14438 must be set up before the deliveries start. When the queue is all held in a
14439 single directory (the default), a single list is created for both the ordered
14440 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
14441 single list is not created when &%queue_run_in_order%& is false. In this case,
14442 the sub-directories are processed one at a time (in a random order), and this
14443 avoids setting up one huge list for the whole queue. Thus, setting
14444 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
14445 when the queue is large, because of the extra work in setting up the single,
14446 large list. In most situations, &%queue_run_in_order%& should not be set.
14447
14448
14449
14450 .option queue_run_max main integer 5
14451 .cindex "queue runner" "maximum number of"
14452 This controls the maximum number of queue runner processes that an Exim daemon
14453 can run simultaneously. This does not mean that it starts them all at once,
14454 but rather that if the maximum number are still running when the time comes to
14455 start another one, it refrains from starting another one. This can happen with
14456 very large queues and/or very sluggish deliveries. This option does not,
14457 however, interlock with other processes, so additional queue runners can be
14458 started by other means, or by killing and restarting the daemon.
14459
14460 Setting this option to zero does not suppress queue runs; rather, it disables
14461 the limit, allowing any number of simultaneous queue runner processes to be
14462 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
14463 the daemon's command line.
14464
14465 .option queue_smtp_domains main "domain list&!!" unset
14466 .cindex "queueing incoming messages"
14467 .cindex "message" "queueing remote deliveries"
14468 When this option is set, a delivery process is started whenever a message is
14469 received, routing is performed, and local deliveries take place.
14470 However, if any SMTP deliveries are required for domains that match
14471 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
14472 message waits on the queue for the next queue run. Since routing of the message
14473 has taken place, Exim knows to which remote hosts it must be delivered, and so
14474 when the queue run happens, multiple messages for the same host are delivered
14475 over a single SMTP connection. The &%-odqs%& command line option causes all
14476 SMTP deliveries to be queued in this way, and is equivalent to setting
14477 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
14478 &%queue_domains%&.
14479
14480
14481 .option receive_timeout main time 0s
14482 .cindex "timeout" "for non-SMTP input"
14483 This option sets the timeout for accepting a non-SMTP message, that is, the
14484 maximum time that Exim waits when reading a message on the standard input. If
14485 the value is zero, it will wait for ever. This setting is overridden by the
14486 &%-or%& command line option. The timeout for incoming SMTP messages is
14487 controlled by &%smtp_receive_timeout%&.
14488
14489 .option received_header_text main string&!! "see below"
14490 .cindex "customizing" "&'Received:'& header"
14491 .cindex "&'Received:'& header line" "customizing"
14492 This string defines the contents of the &'Received:'& message header that is
14493 added to each message, except for the timestamp, which is automatically added
14494 on at the end (preceded by a semicolon). The string is expanded each time it is
14495 used. If the expansion yields an empty string, no &'Received:'& header line is
14496 added to the message. Otherwise, the string should start with the text
14497 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
14498 header lines. The default setting is:
14499
14500 .code
14501 received_header_text = Received: \
14502   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
14503   {${if def:sender_ident \
14504   {from ${quote_local_part:$sender_ident} }}\
14505   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
14506   by $primary_hostname \
14507   ${if def:received_protocol {with $received_protocol}} \
14508   ${if def:tls_cipher {($tls_cipher)\n\t}}\
14509   (Exim $version_number)\n\t\
14510   ${if def:sender_address \
14511   {(envelope-from <$sender_address>)\n\t}}\
14512   id $message_exim_id\
14513   ${if def:received_for {\n\tfor $received_for}}
14514 .endd
14515
14516 The reference to the TLS cipher is omitted when Exim is built without TLS
14517 support. The use of conditional expansions ensures that this works for both
14518 locally generated messages and messages received from remote hosts, giving
14519 header lines such as the following:
14520 .code
14521 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
14522 by marley.carol.example with esmtp (Exim 4.00)
14523 (envelope-from <bob@carol.example>)
14524 id 16IOWa-00019l-00
14525 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
14526 Received: by scrooge.carol.example with local (Exim 4.00)
14527 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
14528 .endd
14529 Until the body of the message has been received, the timestamp is the time when
14530 the message started to be received. Once the body has arrived, and all policy
14531 checks have taken place, the timestamp is updated to the time at which the
14532 message was accepted.
14533
14534
14535 .option received_headers_max main integer 30
14536 .cindex "loop" "prevention"
14537 .cindex "mail loop prevention"
14538 .cindex "&'Received:'& header line" "counting"
14539 When a message is to be delivered, the number of &'Received:'& headers is
14540 counted, and if it is greater than this parameter, a mail loop is assumed to
14541 have occurred, the delivery is abandoned, and an error message is generated.
14542 This applies to both local and remote deliveries.
14543
14544
14545 .option recipient_unqualified_hosts main "host list&!!" unset
14546 .cindex "unqualified addresses"
14547 .cindex "host" "unqualified addresses from"
14548 This option lists those hosts from which Exim is prepared to accept unqualified
14549 recipient addresses in message envelopes. The addresses are made fully
14550 qualified by the addition of the &%qualify_recipient%& value. This option also
14551 affects message header lines. Exim does not reject unqualified recipient
14552 addresses in headers, but it qualifies them only if the message came from a
14553 host that matches &%recipient_unqualified_hosts%&,
14554 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
14555 option was not set.
14556
14557
14558 .option recipients_max main integer 0
14559 .cindex "limit" "number of recipients"
14560 .cindex "recipient" "maximum number"
14561 If this option is set greater than zero, it specifies the maximum number of
14562 original recipients for any message. Additional recipients that are generated
14563 by aliasing or forwarding do not count. SMTP messages get a 452 response for
14564 all recipients over the limit; earlier recipients are delivered as normal.
14565 Non-SMTP messages with too many recipients are failed, and no deliveries are
14566 done.
14567
14568 .cindex "RCPT" "maximum number of incoming"
14569 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
14570 RCPT commands in a single message.
14571
14572
14573 .option recipients_max_reject main boolean false
14574 If this option is set true, Exim rejects SMTP messages containing too many
14575 recipients by giving 552 errors to the surplus RCPT commands, and a 554
14576 error to the eventual DATA command. Otherwise (the default) it gives a 452
14577 error to the surplus RCPT commands and accepts the message on behalf of the
14578 initial set of recipients. The remote server should then re-send the message
14579 for the remaining recipients at a later time.
14580
14581
14582 .option remote_max_parallel main integer 2
14583 .cindex "delivery" "parallelism for remote"
14584 This option controls parallel delivery of one message to a number of remote
14585 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
14586 does all the remote deliveries for a message one by one. Otherwise, if a single
14587 message has to be delivered to more than one remote host, or if several copies
14588 have to be sent to the same remote host, up to &%remote_max_parallel%&
14589 deliveries are done simultaneously. If more than &%remote_max_parallel%&
14590 deliveries are required, the maximum number of processes are started, and as
14591 each one finishes, another is begun. The order of starting processes is the
14592 same as if sequential delivery were being done, and can be controlled by the
14593 &%remote_sort_domains%& option. If parallel delivery takes place while running
14594 with debugging turned on, the debugging output from each delivery process is
14595 tagged with its process id.
14596
14597 This option controls only the maximum number of parallel deliveries for one
14598 message in one Exim delivery process. Because Exim has no central queue
14599 manager, there is no way of controlling the total number of simultaneous
14600 deliveries if the configuration allows a delivery attempt as soon as a message
14601 is received.
14602
14603 .cindex "number of deliveries"
14604 .cindex "delivery" "maximum number of"
14605 If you want to control the total number of deliveries on the system, you
14606 need to set the &%queue_only%& option. This ensures that all incoming messages
14607 are added to the queue without starting a delivery process. Then set up an Exim
14608 daemon to start queue runner processes at appropriate intervals (probably
14609 fairly often, for example, every minute), and limit the total number of queue
14610 runners by setting the &%queue_run_max%& parameter. Because each queue runner
14611 delivers only one message at a time, the maximum number of deliveries that can
14612 then take place at once is &%queue_run_max%& multiplied by
14613 &%remote_max_parallel%&.
14614
14615 If it is purely remote deliveries you want to control, use
14616 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
14617 doing the SMTP routing before queueing, so that several messages for the same
14618 host will eventually get delivered down the same connection.
14619
14620
14621 .option remote_sort_domains main "domain list&!!" unset
14622 .cindex "sorting remote deliveries"
14623 .cindex "delivery" "sorting remote"
14624 When there are a number of remote deliveries for a message, they are sorted by
14625 domain into the order given by this list. For example,
14626 .code
14627 remote_sort_domains = *.cam.ac.uk:*.uk
14628 .endd
14629 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
14630 then to those in the &%uk%& domain, then to any others.
14631
14632
14633 .option retry_data_expire main time 7d
14634 .cindex "hints database" "data expiry"
14635 This option sets a &"use before"& time on retry information in Exim's hints
14636 database. Any older retry data is ignored. This means that, for example, once a
14637 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
14638 past failures.
14639
14640
14641 .option retry_interval_max main time 24h
14642 .cindex "retry" "limit on interval"
14643 .cindex "limit" "on retry interval"
14644 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
14645 intervals between delivery attempts for messages that cannot be delivered
14646 straight away. This option sets an overall limit to the length of time between
14647 retries. It cannot be set greater than 24 hours; any attempt to do so forces
14648 the default value.
14649
14650
14651 .option return_path_remove main boolean true
14652 .cindex "&'Return-path:'& header line" "removing"
14653 RFC 2821, section 4.4, states that an SMTP server must insert a
14654 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
14655 The &'Return-path:'& header preserves the sender address as received in the
14656 MAIL command. This description implies that this header should not be present
14657 in an incoming message. If &%return_path_remove%& is true, any existing
14658 &'Return-path:'& headers are removed from messages at the time they are
14659 received. Exim's transports have options for adding &'Return-path:'& headers at
14660 the time of delivery. They are normally used only for final local deliveries.
14661
14662
14663 .option return_size_limit main integer 100K
14664 This option is an obsolete synonym for &%bounce_return_size_limit%&.
14665
14666
14667 .option rfc1413_hosts main "host list&!!" *
14668 .cindex "RFC 1413"
14669 .cindex "host" "for RFC 1413 calls"
14670 RFC 1413 identification calls are made to any client host which matches an item
14671 in the list.
14672
14673 .option rfc1413_query_timeout main time 5s
14674 .cindex "RFC 1413" "query timeout"
14675 .cindex "timeout" "for RFC 1413 call"
14676 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
14677 no RFC 1413 calls are ever made.
14678
14679
14680 .option sender_unqualified_hosts main "host list&!!" unset
14681 .cindex "unqualified addresses"
14682 .cindex "host" "unqualified addresses from"
14683 This option lists those hosts from which Exim is prepared to accept unqualified
14684 sender addresses. The addresses are made fully qualified by the addition of
14685 &%qualify_domain%&. This option also affects message header lines. Exim does
14686 not reject unqualified addresses in headers that contain sender addresses, but
14687 it qualifies them only if the message came from a host that matches
14688 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
14689 using TCP/IP), and the &%-bnq%& option was not set.
14690
14691
14692 .option smtp_accept_keepalive main boolean true
14693 .cindex "keepalive" "on incoming connection"
14694 This option controls the setting of the SO_KEEPALIVE option on incoming
14695 TCP/IP socket connections. When set, it causes the kernel to probe idle
14696 connections periodically, by sending packets with &"old"& sequence numbers. The
14697 other end of the connection should send an acknowledgment if the connection is
14698 still okay or a reset if the connection has been aborted. The reason for doing
14699 this is that it has the beneficial effect of freeing up certain types of
14700 connection that can get stuck when the remote host is disconnected without
14701 tidying up the TCP/IP call properly. The keepalive mechanism takes several
14702 hours to detect unreachable hosts.
14703
14704
14705
14706 .option smtp_accept_max main integer 20
14707 .cindex "limit" "incoming SMTP connections"
14708 .cindex "SMTP" "incoming connection count"
14709 .cindex "inetd"
14710 This option specifies the maximum number of simultaneous incoming SMTP calls
14711 that Exim will accept. It applies only to the listening daemon; there is no
14712 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
14713 value is set to zero, no limit is applied. However, it is required to be
14714 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
14715 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
14716
14717 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
14718 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
14719 that limit has not been reached for the client host, &%smtp_accept_reserve%&
14720 and &%smtp_load_reserve%& are then checked before accepting the connection.
14721
14722
14723 .option smtp_accept_max_nonmail main integer 10
14724 .cindex "limit" "non-mail SMTP commands"
14725 .cindex "SMTP" "limiting non-mail commands"
14726 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
14727 the connection if there are too many. This option defines &"too many"&. The
14728 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
14729 client looping sending EHLO, for example. The check is applied only if the
14730 client host matches &%smtp_accept_max_nonmail_hosts%&.
14731
14732 When a new message is expected, one occurrence of RSET is not counted. This
14733 allows a client to send one RSET between messages (this is not necessary,
14734 but some clients do it). Exim also allows one uncounted occurrence of HELO
14735 or EHLO, and one occurrence of STARTTLS between messages. After
14736 starting up a TLS session, another EHLO is expected, and so it too is not
14737 counted. The first occurrence of AUTH in a connection, or immediately
14738 following STARTTLS is not counted. Otherwise, all commands other than
14739 MAIL, RCPT, DATA, and QUIT are counted.
14740
14741
14742 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
14743 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
14744 check by setting this option. The default value makes it apply to all hosts. By
14745 changing the value, you can exclude any badly-behaved hosts that you have to
14746 live with.
14747
14748
14749 . Allow this long option name to split; give it unsplit as a fifth argument
14750 . for the automatic .oindex that is generated by .option.
14751
14752 .option "smtp_accept_max_per_ &~&~connection" main integer 1000 &&&
14753          smtp_accept_max_per_connection
14754 .cindex "SMTP" "limiting incoming message count"
14755 .cindex "limit" "messages per SMTP connection"
14756 The value of this option limits the number of MAIL commands that Exim is
14757 prepared to accept over a single SMTP connection, whether or not each command
14758 results in the transfer of a message. After the limit is reached, a 421
14759 response is given to subsequent MAIL commands. This limit is a safety
14760 precaution against a client that goes mad (incidents of this type have been
14761 seen).
14762
14763
14764 .option smtp_accept_max_per_host main string&!! unset
14765 .cindex "limit" "SMTP connections from one host"
14766 .cindex "host" "limiting SMTP connections from"
14767 This option restricts the number of simultaneous IP connections from a single
14768 host (strictly, from a single IP address) to the Exim daemon. The option is
14769 expanded, to enable different limits to be applied to different hosts by
14770 reference to &$sender_host_address$&. Once the limit is reached, additional
14771 connection attempts from the same host are rejected with error code 421. This
14772 is entirely independent of &%smtp_accept_reserve%&. The option's default value
14773 of zero imposes no limit. If this option is set greater than zero, it is
14774 required that &%smtp_accept_max%& be non-zero.
14775
14776 &*Warning*&: When setting this option you should not use any expansion
14777 constructions that take an appreciable amount of time. The expansion and test
14778 happen in the main daemon loop, in order to reject additional connections
14779 without forking additional processes (otherwise a denial-of-service attack
14780 could cause a vast number or processes to be created). While the daemon is
14781 doing this processing, it cannot accept any other incoming connections.
14782
14783
14784
14785 .option smtp_accept_queue main integer 0
14786 .cindex "SMTP" "incoming connection count"
14787 .cindex "queueing incoming messages"
14788 .cindex "message" "queueing by SMTP connection count"
14789 If the number of simultaneous incoming SMTP connections being handled via the
14790 listening daemon exceeds this value, messages received by SMTP are just placed
14791 on the queue; no delivery processes are started automatically. The count is
14792 fixed at the start of an SMTP connection. It cannot be updated in the
14793 subprocess that receives messages, and so the queueing or not queueing applies
14794 to all messages received in the same connection.
14795
14796 A value of zero implies no limit, and clearly any non-zero value is useful only
14797 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
14798 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
14799 various &%-od%&&'x'& command line options.
14800
14801
14802 . Allow this long option name to split; give it unsplit as a fifth argument
14803 . for the automatic .oindex that is generated by .option.
14804
14805 .option "smtp_accept_queue_per_ &~&~connection" main integer 10 &&&
14806          smtp_accept_queue_per_connection
14807 .cindex "queueing incoming messages"
14808 .cindex "message" "queueing by message count"
14809 This option limits the number of delivery processes that Exim starts
14810 automatically when receiving messages via SMTP, whether via the daemon or by
14811 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
14812 and the number of messages received in a single SMTP session exceeds this
14813 number, subsequent messages are placed on the queue, but no delivery processes
14814 are started. This helps to limit the number of Exim processes when a server
14815 restarts after downtime and there is a lot of mail waiting for it on other
14816 systems. On large systems, the default should probably be increased, and on
14817 dial-in client systems it should probably be set to zero (that is, disabled).
14818
14819
14820 .option smtp_accept_reserve main integer 0
14821 .cindex "SMTP" "incoming call count"
14822 .cindex "host" "reserved"
14823 When &%smtp_accept_max%& is set greater than zero, this option specifies a
14824 number of SMTP connections that are reserved for connections from the hosts
14825 that are specified in &%smtp_reserve_hosts%&. The value set in
14826 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
14827 restricted to this number of connections; the option specifies a minimum number
14828 of connection slots for them, not a maximum. It is a guarantee that this group
14829 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
14830 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
14831 individual host.
14832
14833 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
14834 set to 5, once there are 45 active connections (from any hosts), new
14835 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
14836 provided the other criteria for acceptance are met.
14837
14838
14839 .option smtp_active_hostname main string&!! unset
14840 .cindex "host" "name in SMTP responses"
14841 .cindex "SMTP" "host name in responses"
14842 .vindex "&$primary_hostname$&"
14843 This option is provided for multi-homed servers that want to masquerade as
14844 several different hosts. At the start of an incoming SMTP connection, its value
14845 is expanded and used instead of the value of &$primary_hostname$& in SMTP
14846 responses. For example, it is used as domain name in the response to an
14847 incoming HELO or EHLO command.
14848
14849 .vindex "&$smtp_active_hostname$&"
14850 The active hostname is placed in the &$smtp_active_hostname$& variable, which
14851 is saved with any messages that are received. It is therefore available for use
14852 in routers and transports when the message is later delivered.
14853
14854 If this option is unset, or if its expansion is forced to fail, or if the
14855 expansion results in an empty string, the value of &$primary_hostname$& is
14856 used. Other expansion failures cause a message to be written to the main and
14857 panic logs, and the SMTP command receives a temporary error. Typically, the
14858 value of &%smtp_active_hostname%& depends on the incoming interface address.
14859 For example:
14860 .code
14861 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
14862   {cox.mydomain}{box.mydomain}}
14863 .endd
14864
14865 Although &$smtp_active_hostname$& is primarily concerned with incoming
14866 messages, it is also used as the default for HELO commands in callout
14867 verification if there is no remote transport from which to obtain a
14868 &%helo_data%& value.
14869
14870 .option smtp_banner main string&!! "see below"
14871 .cindex "SMTP" "welcome banner"
14872 .cindex "banner for SMTP"
14873 .cindex "welcome banner for SMTP"
14874 .cindex "customizing" "SMTP banner"
14875 This string, which is expanded every time it is used, is output as the initial
14876 positive response to an SMTP connection. The default setting is:
14877 .code
14878 smtp_banner = $smtp_active_hostname ESMTP Exim \
14879   $version_number $tod_full
14880 .endd
14881 Failure to expand the string causes a panic error. If you want to create a
14882 multiline response to the initial SMTP connection, use &"\n"& in the string at
14883 appropriate points, but not at the end. Note that the 220 code is not included
14884 in this string. Exim adds it automatically (several times in the case of a
14885 multiline response).
14886
14887
14888 .option smtp_check_spool_space main boolean true
14889 .cindex "checking disk space"
14890 .cindex "disk space, checking"
14891 .cindex "spool directory" "checking space"
14892 When this option is set, if an incoming SMTP session encounters the SIZE
14893 option on a MAIL command, it checks that there is enough space in the
14894 spool directory's partition to accept a message of that size, while still
14895 leaving free the amount specified by &%check_spool_space%& (even if that value
14896 is zero). If there isn't enough space, a temporary error code is returned.
14897
14898
14899 .option smtp_connect_backlog main integer 20
14900 .cindex "connection backlog"
14901 .cindex "SMTP" "connection backlog"
14902 .cindex "backlog of connections"
14903 This option specifies a maximum number of waiting SMTP connections. Exim passes
14904 this value to the TCP/IP system when it sets up its listener. Once this number
14905 of connections are waiting for the daemon's attention, subsequent connection
14906 attempts are refused at the TCP/IP level. At least, that is what the manuals
14907 say; in some circumstances such connection attempts have been observed to time
14908 out instead. For large systems it is probably a good idea to increase the
14909 value (to 50, say). It also gives some protection against denial-of-service
14910 attacks by SYN flooding.
14911
14912
14913 .option smtp_enforce_sync main boolean true
14914 .cindex "SMTP" "synchronization checking"
14915 .cindex "synchronization checking in SMTP"
14916 The SMTP protocol specification requires the client to wait for a response from
14917 the server at certain points in the dialogue. Without PIPELINING these
14918 synchronization points are after every command; with PIPELINING they are
14919 fewer, but they still exist.
14920
14921 Some spamming sites send out a complete set of SMTP commands without waiting
14922 for any response. Exim protects against this by rejecting a message if the
14923 client has sent further input when it should not have. The error response &"554
14924 SMTP synchronization error"& is sent, and the connection is dropped. Testing
14925 for this error cannot be perfect because of transmission delays (unexpected
14926 input may be on its way but not yet received when Exim checks). However, it
14927 does detect many instances.
14928
14929 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
14930 If you want to disable the check selectively (for example, only for certain
14931 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
14932 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
14933
14934
14935
14936 .option smtp_etrn_command main string&!! unset
14937 .cindex "ETRN" "command to be run"
14938 .vindex "&$domain$&"
14939 If this option is set, the given command is run whenever an SMTP ETRN
14940 command is received from a host that is permitted to issue such commands (see
14941 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
14942 are independently expanded. The expansion variable &$domain$& is set to the
14943 argument of the ETRN command, and no syntax checking is done on it. For
14944 example:
14945 .code
14946 smtp_etrn_command = /etc/etrn_command $domain \
14947                     $sender_host_address
14948 .endd
14949 A new process is created to run the command, but Exim does not wait for it to
14950 complete. Consequently, its status cannot be checked. If the command cannot be
14951 run, a line is written to the panic log, but the ETRN caller still receives
14952 a 250 success response. Exim is normally running under its own uid when
14953 receiving SMTP, so it is not possible for it to change the uid before running
14954 the command.
14955
14956
14957 .option smtp_etrn_serialize main boolean true
14958 .cindex "ETRN" "serializing"
14959 When this option is set, it prevents the simultaneous execution of more than
14960 one identical command as a result of ETRN in an SMTP connection. See
14961 section &<<SECTETRN>>& for details.
14962
14963
14964 .option smtp_load_reserve main fixed-point unset
14965 .cindex "load average"
14966 If the system load average ever gets higher than this, incoming SMTP calls are
14967 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
14968 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
14969 the load is over the limit. The option has no effect on ancient operating
14970 systems on which Exim cannot determine the load average. See also
14971 &%deliver_queue_load_max%& and &%queue_only_load%&.
14972
14973
14974
14975 .option smtp_max_synprot_errors main integer 3
14976 .cindex "SMTP" "limiting syntax and protocol errors"
14977 .cindex "limit" "SMTP syntax and protocol errors"
14978 Exim rejects SMTP commands that contain syntax or protocol errors. In
14979 particular, a syntactically invalid email address, as in this command:
14980 .code
14981 RCPT TO:<abc xyz@a.b.c>
14982 .endd
14983 causes immediate rejection of the command, before any other tests are done.
14984 (The ACL cannot be run if there is no valid address to set up for it.) An
14985 example of a protocol error is receiving RCPT before MAIL. If there are
14986 too many syntax or protocol errors in one SMTP session, the connection is
14987 dropped. The limit is set by this option.
14988
14989 .cindex "PIPELINING" "expected errors"
14990 When the PIPELINING extension to SMTP is in use, some protocol errors are
14991 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
14992 Exim assumes that PIPELINING will be used if it advertises it (see
14993 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
14994 not count towards the limit.
14995
14996
14997
14998 .option smtp_max_unknown_commands main integer 3
14999 .cindex "SMTP" "limiting unknown commands"
15000 .cindex "limit" "unknown SMTP commands"
15001 If there are too many unrecognized commands in an incoming SMTP session, an
15002 Exim server drops the connection. This is a defence against some kinds of abuse
15003 that subvert web
15004 clients
15005 into making connections to SMTP ports; in these circumstances, a number of
15006 non-SMTP command lines are sent first.
15007
15008
15009
15010 .option smtp_ratelimit_hosts main "host list&!!" unset
15011 .cindex "SMTP" "rate limiting"
15012 .cindex "limit" "rate of message arrival"
15013 .cindex "RCPT" "rate limiting"
15014 Some sites find it helpful to be able to limit the rate at which certain hosts
15015 can send them messages, and the rate at which an individual message can specify
15016 recipients.
15017
15018 Exim has two rate-limiting facilities. This section describes the older
15019 facility, which can limit rates within a single connection. The newer
15020 &%ratelimit%& ACL condition can limit rates across all connections. See section
15021 &<<SECTratelimiting>>& for details of the newer facility.
15022
15023 When a host matches &%smtp_ratelimit_hosts%&, the values of
15024 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
15025 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
15026 respectively. Each option, if set, must contain a set of four comma-separated
15027 values:
15028
15029 .ilist
15030 A threshold, before which there is no rate limiting.
15031 .next
15032 An initial time delay. Unlike other times in Exim, numbers with decimal
15033 fractional parts are allowed here.
15034 .next
15035 A factor by which to increase the delay each time.
15036 .next
15037 A maximum value for the delay. This should normally be less than 5 minutes,
15038 because after that time, the client is liable to timeout the SMTP command.
15039 .endlist
15040
15041 For example, these settings have been used successfully at the site which
15042 first suggested this feature, for controlling mail from their customers:
15043 .code
15044 smtp_ratelimit_mail = 2,0.5s,1.05,4m
15045 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
15046 .endd
15047 The first setting specifies delays that are applied to MAIL commands after
15048 two have been received over a single connection. The initial delay is 0.5
15049 seconds, increasing by a factor of 1.05 each time. The second setting applies
15050 delays to RCPT commands when more than four occur in a single message.
15051
15052
15053 .option smtp_ratelimit_mail main string unset
15054 See &%smtp_ratelimit_hosts%& above.
15055
15056
15057 .option smtp_ratelimit_rcpt main string unset
15058 See &%smtp_ratelimit_hosts%& above.
15059
15060
15061 .option smtp_receive_timeout main time 5m
15062 .cindex "timeout" "for SMTP input"
15063 .cindex "SMTP" "input timeout"
15064 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
15065 input, including batch SMTP. If a line of input (either an SMTP command or a
15066 data line) is not received within this time, the SMTP connection is dropped and
15067 the message is abandoned.
15068 A line is written to the log containing one of the following messages:
15069 .code
15070 SMTP command timeout on connection from...
15071 SMTP data timeout on connection from...
15072 .endd
15073 The former means that Exim was expecting to read an SMTP command; the latter
15074 means that it was in the DATA phase, reading the contents of a message.
15075
15076
15077 .oindex "&%-os%&"
15078 The value set by this option can be overridden by the
15079 &%-os%& command-line option. A setting of zero time disables the timeout, but
15080 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
15081 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
15082 timeout is controlled by &%receive_timeout%& and &%-or%&.
15083
15084
15085 .option smtp_reserve_hosts main "host list&!!" unset
15086 This option defines hosts for which SMTP connections are reserved; see
15087 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
15088
15089
15090 .option smtp_return_error_details main boolean false
15091 .cindex "SMTP" "details policy failures"
15092 .cindex "policy control" "rejection, returning details"
15093 In the default state, Exim uses bland messages such as
15094 &"Administrative prohibition"& when it rejects SMTP commands for policy
15095 reasons. Many sysadmins like this because it gives away little information
15096 to spammers. However, some other sysadmins who are applying strict checking
15097 policies want to give out much fuller information about failures. Setting
15098 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
15099 example, instead of &"Administrative prohibition"&, it might give:
15100 .code
15101 550-Rejected after DATA: '>' missing at end of address:
15102 550 failing address in "From" header is: <user@dom.ain
15103 .endd
15104
15105 .option spamd_address main string "see below"
15106 This option is available when Exim is compiled with the content-scanning
15107 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
15108 The default value is
15109 .code
15110 127.0.0.1 783
15111 .endd
15112 See section &<<SECTscanspamass>>& for more details.
15113
15114
15115
15116 .option split_spool_directory main boolean false
15117 .cindex "multiple spool directories"
15118 .cindex "spool directory" "split"
15119 .cindex "directories, multiple"
15120 If this option is set, it causes Exim to split its input directory into 62
15121 subdirectories, each with a single alphanumeric character as its name. The
15122 sixth character of the message id is used to allocate messages to
15123 subdirectories; this is the least significant base-62 digit of the time of
15124 arrival of the message.
15125
15126 Splitting up the spool in this way may provide better performance on systems
15127 where there are long mail queues, by reducing the number of files in any one
15128 directory. The msglog directory is also split up in a similar way to the input
15129 directory; however, if &%preserve_message_logs%& is set, all old msglog files
15130 are still placed in the single directory &_msglog.OLD_&.
15131
15132 It is not necessary to take any special action for existing messages when
15133 changing &%split_spool_directory%&. Exim notices messages that are in the
15134 &"wrong"& place, and continues to process them. If the option is turned off
15135 after a period of being on, the subdirectories will eventually empty and be
15136 automatically deleted.
15137
15138 When &%split_spool_directory%& is set, the behaviour of queue runner processes
15139 changes. Instead of creating a list of all messages in the queue, and then
15140 trying to deliver each one in turn, it constructs a list of those in one
15141 sub-directory and tries to deliver them, before moving on to the next
15142 sub-directory. The sub-directories are processed in a random order. This
15143 spreads out the scanning of the input directories, and uses less memory. It is
15144 particularly beneficial when there are lots of messages on the queue. However,
15145 if &%queue_run_in_order%& is set, none of this new processing happens. The
15146 entire queue has to be scanned and sorted before any deliveries can start.
15147
15148
15149 .option spool_directory main string&!! "set at compile time"
15150 .cindex "spool directory" "path to"
15151 This defines the directory in which Exim keeps its spool, that is, the messages
15152 it is waiting to deliver. The default value is taken from the compile-time
15153 configuration setting, if there is one. If not, this option must be set. The
15154 string is expanded, so it can contain, for example, a reference to
15155 &$primary_hostname$&.
15156
15157 If the spool directory name is fixed on your installation, it is recommended
15158 that you set it at build time rather than from this option, particularly if the
15159 log files are being written to the spool directory (see &%log_file_path%&).
15160 Otherwise log files cannot be used for errors that are detected early on, such
15161 as failures in the configuration file.
15162
15163 By using this option to override the compiled-in path, it is possible to run
15164 tests of Exim without using the standard spool.
15165
15166 .option sqlite_lock_timeout main time 5s
15167 .cindex "sqlite lookup type" "lock timeout"
15168 This option controls the timeout that the &(sqlite)& lookup uses when trying to
15169 access an SQLite database. See section &<<SECTsqlite>>& for more details.
15170
15171 .option strict_acl_vars main boolean false
15172 .cindex "&ACL;" "variables, handling unset"
15173 This option controls what happens if a syntactically valid but undefined ACL
15174 variable is referenced. If it is false (the default), an empty string
15175 is substituted; if it is true, an error is generated. See section
15176 &<<SECTaclvariables>>& for details of ACL variables.
15177
15178 .option strip_excess_angle_brackets main boolean false
15179 .cindex "angle brackets, excess"
15180 If this option is set, redundant pairs of angle brackets round &"route-addr"&
15181 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
15182 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
15183 passed on to another MTA, the excess angle brackets are not passed on. If this
15184 option is not set, multiple pairs of angle brackets cause a syntax error.
15185
15186
15187 .option strip_trailing_dot main boolean false
15188 .cindex "trailing dot on domain"
15189 .cindex "dot" "trailing on domain"
15190 If this option is set, a trailing dot at the end of a domain in an address is
15191 ignored. If this is in the envelope and the message is passed on to another
15192 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
15193 domain causes a syntax error.
15194 However, addresses in header lines are checked only when an ACL requests header
15195 syntax checking.
15196
15197
15198 .option syslog_duplication main boolean true
15199 .cindex "syslog" "duplicate log lines; suppressing"
15200 When Exim is logging to syslog, it writes the log lines for its three
15201 separate logs at different syslog priorities so that they can in principle
15202 be separated on the logging hosts. Some installations do not require this
15203 separation, and in those cases, the duplication of certain log lines is a
15204 nuisance. If &%syslog_duplication%& is set false, only one copy of any
15205 particular log line is written to syslog. For lines that normally go to
15206 both the main log and the reject log, the reject log version (possibly
15207 containing message header lines) is written, at LOG_NOTICE priority.
15208 Lines that normally go to both the main and the panic log are written at
15209 the LOG_ALERT priority.
15210
15211
15212 .option syslog_facility main string unset
15213 .cindex "syslog" "facility; setting"
15214 This option sets the syslog &"facility"& name, used when Exim is logging to
15215 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
15216 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
15217 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
15218 details of Exim's logging.
15219
15220
15221
15222 .option syslog_processname main string &`exim`&
15223 .cindex "syslog" "process name; setting"
15224 This option sets the syslog &"ident"& name, used when Exim is logging to
15225 syslog. The value must be no longer than 32 characters. See chapter
15226 &<<CHAPlog>>& for details of Exim's logging.
15227
15228
15229
15230 .option syslog_timestamp main boolean true
15231 .cindex "syslog" "timestamps"
15232 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
15233 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
15234 details of Exim's logging.
15235
15236
15237 .option system_filter main string&!! unset
15238 .cindex "filter" "system filter"
15239 .cindex "system filter" "specifying"
15240 .cindex "Sieve filter" "not available for system filter"
15241 This option specifies an Exim filter file that is applied to all messages at
15242 the start of each delivery attempt, before any routing is done. System filters
15243 must be Exim filters; they cannot be Sieve filters. If the system filter
15244 generates any deliveries to files or pipes, or any new mail messages, the
15245 appropriate &%system_filter_..._transport%& option(s) must be set, to define
15246 which transports are to be used. Details of this facility are given in chapter
15247 &<<CHAPsystemfilter>>&.
15248
15249
15250 .option system_filter_directory_transport main string&!! unset
15251 .vindex "&$address_file$&"
15252 This sets the name of the transport driver that is to be used when the
15253 &%save%& command in a system message filter specifies a path ending in &"/"&,
15254 implying delivery of each message into a separate file in some directory.
15255 During the delivery, the variable &$address_file$& contains the path name.
15256
15257
15258 .option system_filter_file_transport main string&!! unset
15259 .cindex "file" "transport for system filter"
15260 This sets the name of the transport driver that is to be used when the &%save%&
15261 command in a system message filter specifies a path not ending in &"/"&. During
15262 the delivery, the variable &$address_file$& contains the path name.
15263
15264 .option system_filter_group main string unset
15265 .cindex "gid (group id)" "system filter"
15266 This option is used only when &%system_filter_user%& is also set. It sets the
15267 gid under which the system filter is run, overriding any gid that is associated
15268 with the user. The value may be numerical or symbolic.
15269
15270 .option system_filter_pipe_transport main string&!! unset
15271 .cindex "&(pipe)& transport" "for system filter"
15272 .vindex "&$address_pipe$&"
15273 This specifies the transport driver that is to be used when a &%pipe%& command
15274 is used in a system filter. During the delivery, the variable &$address_pipe$&
15275 contains the pipe command.
15276
15277
15278 .option system_filter_reply_transport main string&!! unset
15279 .cindex "&(autoreply)& transport" "for system filter"
15280 This specifies the transport driver that is to be used when a &%mail%& command
15281 is used in a system filter.
15282
15283 .new
15284 .option system_filter_user main string unset
15285 .cindex "uid (user id)" "system filter"
15286 If this option is set to root, the system filter is run in the main Exim
15287 delivery process, as root.  Otherwise, the system filter runs in a separate
15288 process, as the given user, defaulting to the Exim run-time user.
15289 Unless the string consists entirely of digits, it
15290 is looked up in the password data. Failure to find the named user causes a
15291 configuration error. The gid is either taken from the password data, or
15292 specified by &%system_filter_group%&. When the uid is specified numerically,
15293 &%system_filter_group%& is required to be set.
15294
15295 If the system filter generates any pipe, file, or reply deliveries, the uid
15296 under which the filter is run is used when transporting them, unless a
15297 transport option overrides.
15298 .wen
15299
15300
15301 .option tcp_nodelay main boolean true
15302 .cindex "daemon" "TCP_NODELAY on sockets"
15303 .cindex "Nagle algorithm"
15304 .cindex "TCP_NODELAY on listening sockets"
15305 If this option is set false, it stops the Exim daemon setting the
15306 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
15307 turns off the &"Nagle algorithm"&, which is a way of improving network
15308 performance in interactive (character-by-character) situations. Turning it off
15309 should improve Exim's performance a bit, so that is what happens by default.
15310 However, it appears that some broken clients cannot cope, and time out. Hence
15311 this option. It affects only those sockets that are set up for listening by the
15312 daemon. Sockets created by the smtp transport for delivering mail always set
15313 TCP_NODELAY.
15314
15315
15316 .option timeout_frozen_after main time 0s
15317 .cindex "frozen messages" "timing out"
15318 .cindex "timeout" "frozen messages"
15319 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
15320 message of any kind that has been on the queue for longer than the given time
15321 is automatically cancelled at the next queue run. If the frozen message is a
15322 bounce message, it is just discarded; otherwise, a bounce is sent to the
15323 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
15324 If you want to timeout frozen bounce messages earlier than other kinds of
15325 frozen message, see &%ignore_bounce_errors_after%&.
15326
15327 &*Note:*& the default value of zero means no timeouts; with this setting,
15328 frozen messages remain on the queue forever (except for any frozen bounce
15329 messages that are released by &%ignore_bounce_errors_after%&).
15330
15331
15332 .option timezone main string unset
15333 .cindex "timezone, setting"
15334 The value of &%timezone%& is used to set the environment variable TZ while
15335 running Exim (if it is different on entry). This ensures that all timestamps
15336 created by Exim are in the required timezone. If you want all your timestamps
15337 to be in UTC (aka GMT) you should set
15338 .code
15339 timezone = UTC
15340 .endd
15341 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
15342 or, if that is not set, from the value of the TZ environment variable when Exim
15343 is built. If &%timezone%& is set to the empty string, either at build or run
15344 time, any existing TZ variable is removed from the environment when Exim
15345 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
15346 unfortunately not all, operating systems.
15347
15348
15349 .option tls_advertise_hosts main "host list&!!" unset
15350 .cindex "TLS" "advertising"
15351 .cindex "encryption" "on SMTP connection"
15352 .cindex "SMTP" "encrypted connection"
15353 When Exim is built with support for TLS encrypted connections, the availability
15354 of the STARTTLS command to set up an encrypted session is advertised in
15355 response to EHLO only to those client hosts that match this option. See
15356 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
15357
15358
15359 .option tls_certificate main string&!! unset
15360 .cindex "TLS" "server certificate; location of"
15361 .cindex "certificate" "server, location of"
15362 The value of this option is expanded, and must then be the absolute path to a
15363 file which contains the server's certificates. The server's private key is also
15364 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
15365 &<<CHAPTLS>>& for further details.
15366
15367 &*Note*&: The certificates defined by this option are used only when Exim is
15368 receiving incoming messages as a server. If you want to supply certificates for
15369 use when sending messages as a client, you must set the &%tls_certificate%&
15370 option in the relevant &(smtp)& transport.
15371
15372
15373 .option tls_crl main string&!! unset
15374 .cindex "TLS" "server certificate revocation list"
15375 .cindex "certificate" "revocation list for server"
15376 This option specifies a certificate revocation list. The expanded value must
15377 be the name of a file that contains a CRL in PEM format.
15378
15379
15380 .option tls_dhparam main string&!! unset
15381 .cindex "TLS" "D-H parameters for server"
15382 The value of this option is expanded, and must then be the absolute path to
15383 a file which contains the server's DH parameter values.
15384 This is used only for OpenSSL. When Exim is linked with GnuTLS, this option is
15385 ignored. See section &<<SECTopenvsgnu>>& for further details.
15386
15387
15388 .option tls_on_connect_ports main "string list" unset
15389 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
15390 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
15391 set up without waiting for the client to issue a STARTTLS command. For
15392 further details, see section &<<SECTsupobssmt>>&.
15393
15394
15395
15396 .option tls_privatekey main string&!! unset
15397 .cindex "TLS" "server private key; location of"
15398 The value of this option is expanded, and must then be the absolute path to a
15399 file which contains the server's private key. If this option is unset, or if
15400 the expansion is forced to fail, or the result is an empty string, the private
15401 key is assumed to be in the same file as the server's certificates. See chapter
15402 &<<CHAPTLS>>& for further details.
15403
15404
15405 .option tls_remember_esmtp main boolean false
15406 .cindex "TLS" "esmtp state; remembering"
15407 .cindex "TLS" "broken clients"
15408 If this option is set true, Exim violates the RFCs by remembering that it is in
15409 &"esmtp"& state after successfully negotiating a TLS session. This provides
15410 support for broken clients that fail to send a new EHLO after starting a
15411 TLS session.
15412
15413
15414 .option tls_require_ciphers main string&!! unset
15415 .cindex "TLS" "requiring specific ciphers"
15416 .cindex "cipher" "requiring specific"
15417 This option controls which ciphers can be used for incoming TLS connections.
15418 The &(smtp)& transport has an option of the same name for controlling outgoing
15419 connections. This option is expanded for each connection, so can be varied for
15420 different clients if required. The value of this option must be a list of
15421 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
15422 in somewhat different ways. If GnuTLS is being used, the client controls the
15423 preference order of the available ciphers. Details are given in sections
15424 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
15425
15426
15427 .option tls_try_verify_hosts main "host list&!!" unset
15428 .cindex "TLS" "client certificate verification"
15429 .cindex "certificate" "verification of client"
15430 See &%tls_verify_hosts%& below.
15431
15432
15433 .option tls_verify_certificates main string&!! unset
15434 .cindex "TLS" "client certificate verification"
15435 .cindex "certificate" "verification of client"
15436 The value of this option is expanded, and must then be the absolute path to
15437 a file containing permitted certificates for clients that
15438 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&. Alternatively, if you
15439 are using OpenSSL, you can set &%tls_verify_certificates%& to the name of a
15440 directory containing certificate files. This does not work with GnuTLS; the
15441 option must be set to the name of a single file if you are using GnuTLS.
15442
15443 .new
15444 These certificates should be for the certificate authorities trusted, rather
15445 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
15446 the value is a file then the certificates are sent by Exim as a server to
15447 connecting clients, defining the list of accepted certificate authorities.
15448 Thus the values defined should be considered public data.  To avoid this,
15449 use OpenSSL with a directory.
15450 .wen
15451
15452 .option tls_verify_hosts main "host list&!!" unset
15453 .cindex "TLS" "client certificate verification"
15454 .cindex "certificate" "verification of client"
15455 This option, along with &%tls_try_verify_hosts%&, controls the checking of
15456 certificates from clients. The expected certificates are defined by
15457 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
15458 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
15459 &%tls_verify_certificates%& is not set.
15460
15461 Any client that matches &%tls_verify_hosts%& is constrained by
15462 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
15463 present one of the listed certificates. If it does not, the connection is
15464 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
15465 the host to use TLS. It can still send SMTP commands through unencrypted
15466 connections. Forcing a client to use TLS has to be done separately using an
15467 ACL to reject inappropriate commands when the connection is not encrypted.
15468
15469 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
15470 matches this option (but not &%tls_verify_hosts%&), Exim requests a
15471 certificate and checks it against &%tls_verify_certificates%&, but does not
15472 abort the connection if there is no certificate or if it does not match. This
15473 state can be detected in an ACL, which makes it possible to implement policies
15474 such as &"accept for relay only if a verified certificate has been received,
15475 but accept for local delivery if encrypted, even without a verified
15476 certificate"&.
15477
15478 Client hosts that match neither of these lists are not asked to present
15479 certificates.
15480
15481
15482 .option trusted_groups main "string list&!!" unset
15483 .cindex "trusted groups"
15484 .cindex "groups" "trusted"
15485 This option is expanded just once, at the start of Exim's processing. If this
15486 option is set, any process that is running in one of the listed groups, or
15487 which has one of them as a supplementary group, is trusted. The groups can be
15488 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
15489 details of what trusted callers are permitted to do. If neither
15490 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
15491 are trusted.
15492
15493 .option trusted_users main "string list&!!" unset
15494 .cindex "trusted users"
15495 .cindex "user" "trusted"
15496 This option is expanded just once, at the start of Exim's processing. If this
15497 option is set, any process that is running as one of the listed users is
15498 trusted. The users can be specified numerically or by name. See section
15499 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
15500 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
15501 Exim user are trusted.
15502
15503 .option unknown_login main string&!! unset
15504 .cindex "uid (user id)" "unknown caller"
15505 .vindex "&$caller_uid$&"
15506 This is a specialized feature for use in unusual configurations. By default, if
15507 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
15508 gives up. The &%unknown_login%& option can be used to set a login name to be
15509 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
15510 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
15511 is used for the user's real name (gecos field), unless this has been set by the
15512 &%-F%& option.
15513
15514 .option unknown_username main string unset
15515 See &%unknown_login%&.
15516
15517 .option untrusted_set_sender main "address list&!!" unset
15518 .cindex "trusted users"
15519 .cindex "sender" "setting by untrusted user"
15520 .cindex "untrusted user setting sender"
15521 .cindex "user" "untrusted setting sender"
15522 .cindex "envelope sender"
15523 When an untrusted user submits a message to Exim using the standard input, Exim
15524 normally creates an envelope sender address from the user's login and the
15525 default qualification domain. Data from the &%-f%& option (for setting envelope
15526 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
15527 is used) is ignored.
15528
15529 However, untrusted users are permitted to set an empty envelope sender address,
15530 to declare that a message should never generate any bounces. For example:
15531 .code
15532 exim -f '<>' user@domain.example
15533 .endd
15534 .vindex "&$sender_ident$&"
15535 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
15536 other envelope sender addresses in a controlled way. When it is set, untrusted
15537 users are allowed to set envelope sender addresses that match any of the
15538 patterns in the list. Like all address lists, the string is expanded. The
15539 identity of the user is in &$sender_ident$&, so you can, for example, restrict
15540 users to setting senders that start with their login ids
15541 followed by a hyphen
15542 by a setting like this:
15543 .code
15544 untrusted_set_sender = ^$sender_ident-
15545 .endd
15546 If you want to allow untrusted users to set envelope sender addresses without
15547 restriction, you can use
15548 .code
15549 untrusted_set_sender = *
15550 .endd
15551 The &%untrusted_set_sender%& option applies to all forms of local input, but
15552 only to the setting of the envelope sender. It does not permit untrusted users
15553 to use the other options which trusted user can use to override message
15554 parameters. Furthermore, it does not stop Exim from removing an existing
15555 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
15556 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
15557 overriding these actions. The handling of the &'Sender:'& header is also
15558 described in section &<<SECTthesenhea>>&.
15559
15560 The log line for a message's arrival shows the envelope sender following
15561 &"<="&. For local messages, the user's login always follows, after &"U="&. In
15562 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
15563 envelope sender address, the user's login is shown in parentheses after the
15564 sender address.
15565
15566
15567 .option uucp_from_pattern main string "see below"
15568 .cindex "&""From""& line"
15569 .cindex "UUCP" "&""From""& line"
15570 Some applications that pass messages to an MTA via a command line interface use
15571 an initial line starting with &"From&~"& to pass the envelope sender. In
15572 particular, this is used by UUCP software. Exim recognizes such a line by means
15573 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
15574 matches, the sender address is constructed by expanding the contents of
15575 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
15576 default pattern recognizes lines in the following two forms:
15577 .code
15578 From ph10 Fri Jan  5 12:35 GMT 1996
15579 From ph10 Fri, 7 Jan 97 14:00:00 GMT
15580 .endd
15581 The pattern can be seen by running
15582 .code
15583 exim -bP uucp_from_pattern
15584 .endd
15585 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
15586 year in the second case. The first word after &"From&~"& is matched in the
15587 regular expression by a parenthesized subpattern. The default value for
15588 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
15589 (&"ph10"& in the example above) as the message's sender. See also
15590 &%ignore_fromline_hosts%&.
15591
15592
15593 .option uucp_from_sender main string&!! &`$1`&
15594 See &%uucp_from_pattern%& above.
15595
15596
15597 .option warn_message_file main string unset
15598 .cindex "warning of delay" "customizing the message"
15599 .cindex "customizing" "warning message"
15600 This option defines a template file containing paragraphs of text to be used
15601 for constructing the warning message which is sent by Exim when a message has
15602 been on the queue for a specified amount of time, as specified by
15603 &%delay_warning%&. Details of the file's contents are given in chapter
15604 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
15605
15606
15607 .option write_rejectlog main boolean true
15608 .cindex "reject log" "disabling"
15609 If this option is set false, Exim no longer writes anything to the reject log.
15610 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
15611 .ecindex IIDconfima
15612 .ecindex IIDmaiconf
15613
15614
15615
15616
15617 . ////////////////////////////////////////////////////////////////////////////
15618 . ////////////////////////////////////////////////////////////////////////////
15619
15620 .chapter "Generic options for routers" "CHAProutergeneric"
15621 .scindex IIDgenoprou1 "options" "generic; for routers"
15622 .scindex IIDgenoprou2 "generic options" "router"
15623 This chapter describes the generic options that apply to all routers.
15624 Those that are preconditions are marked with &Dagger; in the &"use"& field.
15625
15626 For a general description of how a router operates, see sections
15627 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
15628 which the preconditions are tested. The order of expansion of the options that
15629 provide data for a transport is: &%errors_to%&, &%headers_add%&,
15630 &%headers_remove%&, &%transport%&.
15631
15632
15633
15634 .option address_data routers string&!! unset
15635 .cindex "router" "data attached to address"
15636 The string is expanded just before the router is run, that is, after all the
15637 precondition tests have succeeded. If the expansion is forced to fail, the
15638 router declines, the value of &%address_data%& remains unchanged, and the
15639 &%more%& option controls what happens next. Other expansion failures cause
15640 delivery of the address to be deferred.
15641
15642 .vindex "&$address_data$&"
15643 When the expansion succeeds, the value is retained with the address, and can be
15644 accessed using the variable &$address_data$& in the current router, subsequent
15645 routers, and the eventual transport.
15646
15647 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
15648 that runs a user's filter file, the contents of &$address_data$& are accessible
15649 in the filter. This is not normally a problem, because such data is usually
15650 either not confidential or it &"belongs"& to the current user, but if you do
15651 put confidential data into &$address_data$& you need to remember this point.
15652
15653 Even if the router declines or passes, the value of &$address_data$& remains
15654 with the address, though it can be changed by another &%address_data%& setting
15655 on a subsequent router. If a router generates child addresses, the value of
15656 &$address_data$& propagates to them. This also applies to the special kind of
15657 &"child"& that is generated by a router with the &%unseen%& option.
15658
15659 The idea of &%address_data%& is that you can use it to look up a lot of data
15660 for the address once, and then pick out parts of the data later. For example,
15661 you could use a single LDAP lookup to return a string of the form
15662 .code
15663 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
15664 .endd
15665 In the transport you could pick out the mailbox by a setting such as
15666 .code
15667 file = ${extract{mailbox}{$address_data}}
15668 .endd
15669 This makes the configuration file less messy, and also reduces the number of
15670 lookups (though Exim does cache lookups).
15671
15672 .vindex "&$sender_address_data$&"
15673 .vindex "&$address_data$&"
15674 The &%address_data%& facility is also useful as a means of passing information
15675 from one router to another, and from a router to a transport. In addition, if
15676 &$address_data$& is set by a router when verifying a recipient address from an
15677 ACL, it remains available for use in the rest of the ACL statement. After
15678 verifying a sender, the value is transferred to &$sender_address_data$&.
15679
15680
15681
15682 .option address_test routers&!? boolean true
15683 .oindex "&%-bt%&"
15684 .cindex "router" "skipping when address testing"
15685 If this option is set false, the router is skipped when routing is being tested
15686 by means of the &%-bt%& command line option. This can be a convenience when
15687 your first router sends messages to an external scanner, because it saves you
15688 having to set the &"already scanned"& indicator when testing real address
15689 routing.
15690
15691
15692
15693 .option cannot_route_message routers string&!! unset
15694 .cindex "router" "customizing &""cannot route""& message"
15695 .cindex "customizing" "&""cannot route""& message"
15696 This option specifies a text message that is used when an address cannot be
15697 routed because Exim has run out of routers. The default message is
15698 &"Unrouteable address"&. This option is useful only on routers that have
15699 &%more%& set false, or on the very last router in a configuration, because the
15700 value that is used is taken from the last router that is considered. This
15701 includes a router that is skipped because its preconditions are not met, as
15702 well as a router that declines. For example, using the default configuration,
15703 you could put:
15704 .code
15705 cannot_route_message = Remote domain not found in DNS
15706 .endd
15707 on the first router, which is a &(dnslookup)& router with &%more%& set false,
15708 and
15709 .code
15710 cannot_route_message = Unknown local user
15711 .endd
15712 on the final router that checks for local users. If string expansion fails for
15713 this option, the default message is used. Unless the expansion failure was
15714 explicitly forced, a message about the failure is written to the main and panic
15715 logs, in addition to the normal message about the routing failure.
15716
15717
15718 .option caseful_local_part routers boolean false
15719 .cindex "case of local parts"
15720 .cindex "router" "case of local parts"
15721 By default, routers handle the local parts of addresses in a case-insensitive
15722 manner, though the actual case is preserved for transmission with the message.
15723 If you want the case of letters to be significant in a router, you must set
15724 this option true. For individual router options that contain address or local
15725 part lists (for example, &%local_parts%&), case-sensitive matching can be
15726 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
15727 more details.
15728
15729 .vindex "&$local_part$&"
15730 .vindex "&$original_local_part$&"
15731 .vindex "&$parent_local_part$&"
15732 The value of the &$local_part$& variable is forced to lower case while a
15733 router is running unless &%caseful_local_part%& is set. When a router assigns
15734 an address to a transport, the value of &$local_part$& when the transport runs
15735 is the same as it was in the router. Similarly, when a router generates child
15736 addresses by aliasing or forwarding, the values of &$original_local_part$&
15737 and &$parent_local_part$& are those that were used by the redirecting router.
15738
15739 This option applies to the processing of an address by a router. When a
15740 recipient address is being processed in an ACL, there is a separate &%control%&
15741 modifier that can be used to specify case-sensitive processing within the ACL
15742 (see section &<<SECTcontrols>>&).
15743
15744
15745
15746 .option check_local_user routers&!? boolean false
15747 .cindex "local user, checking in router"
15748 .cindex "router" "checking for local user"
15749 .cindex "&_/etc/passwd_&"
15750 .vindex "&$home$&"
15751 When this option is true, Exim checks that the local part of the recipient
15752 address (with affixes removed if relevant) is the name of an account on the
15753 local system. The check is done by calling the &[getpwnam()]& function rather
15754 than trying to read &_/etc/passwd_& directly. This means that other methods of
15755 holding password data (such as NIS) are supported. If the local part is a local
15756 user, &$home$& is set from the password data, and can be tested in other
15757 preconditions that are evaluated after this one (the order of evaluation is
15758 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
15759 overridden by &%router_home_directory%&. If the local part is not a local user,
15760 the router is skipped.
15761
15762 If you want to check that the local part is either the name of a local user
15763 or matches something else, you cannot combine &%check_local_user%& with a
15764 setting of &%local_parts%&, because that specifies the logical &'and'& of the
15765 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
15766 setting to achieve this. For example:
15767 .code
15768 local_parts = passwd;$local_part : lsearch;/etc/other/users
15769 .endd
15770 Note, however, that the side effects of &%check_local_user%& (such as setting
15771 up a home directory) do not occur when a &(passwd)& lookup is used in a
15772 &%local_parts%& (or any other) precondition.
15773
15774
15775
15776 .option condition routers&!? string&!! unset
15777 .cindex "router" "customized precondition"
15778 This option specifies a general precondition test that has to succeed for the
15779 router to be called. The &%condition%& option is the last precondition to be
15780 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
15781 result is a forced failure, or an empty string, or one of the strings &"0"& or
15782 &"no"& or &"false"& (checked without regard to the case of the letters), the
15783 router is skipped, and the address is offered to the next one.
15784
15785 If the result is any other value, the router is run (as this is the last
15786 precondition to be evaluated, all the other preconditions must be true).
15787
15788 .new
15789 This option is unique in that multiple &%condition%& options may be present.
15790 All &%condition%& options must succeed.
15791 .wen
15792
15793 .new
15794 The &%condition%& option provides a means of applying custom conditions to the
15795 running of routers. Note that in the case of a simple conditional expansion,
15796 the default expansion values are exactly what is wanted. For example:
15797 .code
15798 condition = ${if >{$message_age}{600}}
15799 .endd
15800 Because of the default behaviour of the string expansion, this is equivalent to
15801 .code
15802 condition = ${if >{$message_age}{600}{true}{}}
15803 .endd
15804
15805 A multiple condition example, which succeeds:
15806 .code
15807 condition = ${if >{$message_age}{600}}
15808 condition = ${if !eq{${lc:$local_part}}{postmaster}}
15809 condition = foobar
15810 .endd
15811
15812 If the expansion fails (other than forced failure) delivery is deferred. Some
15813 of the other precondition options are common special cases that could in fact
15814 be specified using &%condition%&.
15815 .wen
15816
15817
15818 .option debug_print routers string&!! unset
15819 .cindex "testing" "variables in drivers"
15820 If this option is set and debugging is enabled (see the &%-d%& command line
15821 option), the string is expanded and included in the debugging output.
15822 If expansion of the string fails, the error message is written to the debugging
15823 output, and Exim carries on processing.
15824 This option is provided to help with checking out the values of variables and
15825 so on when debugging router configurations. For example, if a &%condition%&
15826 option appears not to be working, &%debug_print%& can be used to output the
15827 variables it references. The output happens after checks for &%domains%&,
15828 &%local_parts%&, and &%check_local_user%& but before any other preconditions
15829 are tested. A newline is added to the text if it does not end with one.
15830
15831
15832
15833 .option disable_logging routers boolean false
15834 If this option is set true, nothing is logged for any routing errors
15835 or for any deliveries caused by this router. You should not set this option
15836 unless you really, really know what you are doing. See also the generic
15837 transport option of the same name.
15838
15839
15840 .option domains routers&!? "domain list&!!" unset
15841 .cindex "router" "restricting to specific domains"
15842 .vindex "&$domain_data$&"
15843 If this option is set, the router is skipped unless the current domain matches
15844 the list. If the match is achieved by means of a file lookup, the data that the
15845 lookup returned for the domain is placed in &$domain_data$& for use in string
15846 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
15847 a list of the order in which preconditions are evaluated.
15848
15849
15850
15851 .option driver routers string unset
15852 This option must always be set. It specifies which of the available routers is
15853 to be used.
15854
15855
15856
15857 .option errors_to routers string&!! unset
15858 .cindex "envelope sender"
15859 .cindex "router" "changing address for errors"
15860 If a router successfully handles an address, it may assign the address to a
15861 transport for delivery or it may generate child addresses. In both cases, if
15862 there is a delivery problem during later processing, the resulting bounce
15863 message is sent to the address that results from expanding this string,
15864 provided that the address verifies successfully. The &%errors_to%& option is
15865 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
15866
15867 The &%errors_to%& setting associated with an address can be overridden if it
15868 subsequently passes through other routers that have their own &%errors_to%&
15869 settings, or if the message is delivered by a transport with a &%return_path%&
15870 setting.
15871
15872 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
15873 the expansion fails to verify, the errors address associated with the incoming
15874 address is used. At top level, this is the envelope sender. A non-forced
15875 expansion failure causes delivery to be deferred.
15876
15877 If an address for which &%errors_to%& has been set ends up being delivered over
15878 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
15879 any bounces that are generated by other MTAs on the delivery route are also
15880 sent there. You can set &%errors_to%& to the empty string by either of these
15881 settings:
15882 .code
15883 errors_to =
15884 errors_to = ""
15885 .endd
15886 An expansion item that yields an empty string has the same effect. If you do
15887 this, a locally detected delivery error for addresses processed by this router
15888 no longer gives rise to a bounce message; the error is discarded. If the
15889 address is delivered to a remote host, the return path is set to &`<>`&, unless
15890 overridden by the &%return_path%& option on the transport.
15891
15892 .vindex "&$address_data$&"
15893 If for some reason you want to discard local errors, but use a non-empty
15894 MAIL command for remote delivery, you can preserve the original return
15895 path in &$address_data$& in the router, and reinstate it in the transport by
15896 setting &%return_path%&.
15897
15898 The most common use of &%errors_to%& is to direct mailing list bounces to the
15899 manager of the list, as described in section &<<SECTmailinglists>>&, or to
15900 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
15901
15902
15903
15904 .option expn routers&!? boolean true
15905 .cindex "address" "testing"
15906 .cindex "testing" "addresses"
15907 .cindex "EXPN" "router skipping"
15908 .cindex "router" "skipping for EXPN"
15909 If this option is turned off, the router is skipped when testing an address
15910 as a result of processing an SMTP EXPN command. You might, for example,
15911 want to turn it off on a router for users' &_.forward_& files, while leaving it
15912 on for the system alias file.
15913 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
15914 are evaluated.
15915
15916 The use of the SMTP EXPN command is controlled by an ACL (see chapter
15917 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
15918 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
15919
15920
15921
15922 .option fail_verify routers boolean false
15923 .cindex "router" "forcing verification failure"
15924 Setting this option has the effect of setting both &%fail_verify_sender%& and
15925 &%fail_verify_recipient%& to the same value.
15926
15927
15928
15929 .option fail_verify_recipient routers boolean false
15930 If this option is true and an address is accepted by this router when
15931 verifying a recipient, verification fails.
15932
15933
15934
15935 .option fail_verify_sender routers boolean false
15936 If this option is true and an address is accepted by this router when
15937 verifying a sender, verification fails.
15938
15939
15940
15941 .option fallback_hosts routers "string list" unset
15942 .cindex "router" "fallback hosts"
15943 .cindex "fallback" "hosts specified on router"
15944 String expansion is not applied to this option. The argument must be a
15945 colon-separated list of host names or IP addresses. The list separator can be
15946 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
15947 each name or address. In fact, the format of each item is exactly the same as
15948 defined for the list of hosts in a &(manualroute)& router (see section
15949 &<<SECTformatonehostitem>>&).
15950
15951 If a router queues an address for a remote transport, this host list is
15952 associated with the address, and used instead of the transport's fallback host
15953 list. If &%hosts_randomize%& is set on the transport, the order of the list is
15954 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
15955 transport for further details.
15956
15957
15958 .option group routers string&!! "see below"
15959 .cindex "gid (group id)" "local delivery"
15960 .cindex "local transports" "uid and gid"
15961 .cindex "transport" "local"
15962 .cindex "router" "setting group"
15963 When a router queues an address for a transport, and the transport does not
15964 specify a group, the group given here is used when running the delivery
15965 process.
15966 The group may be specified numerically or by name. If expansion fails, the
15967 error is logged and delivery is deferred.
15968 The default is unset, unless &%check_local_user%& is set, when the default
15969 is taken from the password information. See also &%initgroups%& and &%user%&
15970 and the discussion in chapter &<<CHAPenvironment>>&.
15971
15972
15973
15974 .option headers_add routers string&!! unset
15975 .cindex "header lines" "adding"
15976 .cindex "router" "adding header lines"
15977 This option specifies a string of text that is expanded at routing time, and
15978 associated with any addresses that are accepted by the router. However, this
15979 option has no effect when an address is just being verified. The way in which
15980 the text is used to add header lines at transport time is described in section
15981 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
15982 message is in the process of being transported. This means that references to
15983 header lines in string expansions in the transport's configuration do not
15984 &"see"& the added header lines.
15985
15986 The &%headers_add%& option is expanded after &%errors_to%&, but before
15987 &%headers_remove%& and &%transport%&. If the expanded string is empty, or if
15988 the expansion is forced to fail, the option has no effect. Other expansion
15989 failures are treated as configuration errors.
15990
15991 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
15992 router that has the &%one_time%& option set.
15993
15994 .cindex "duplicate addresses"
15995 .oindex "&%unseen%&"
15996 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
15997 additions are deleted when the address is passed on to subsequent routers.
15998 For a &%redirect%& router, if a generated address is the same as the incoming
15999 address, this can lead to duplicate addresses with different header
16000 modifications. Exim does not do duplicate deliveries (except, in certain
16001 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
16002 which of the duplicates is discarded, so this ambiguous situation should be
16003 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
16004
16005
16006
16007 .option headers_remove routers string&!! unset
16008 .cindex "header lines" "removing"
16009 .cindex "router" "removing header lines"
16010 This option specifies a string of text that is expanded at routing time, and
16011 associated with any addresses that are accepted by the router. However, this
16012 option has no effect when an address is just being verified. The way in which
16013 the text is used to remove header lines at transport time is described in
16014 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
16015 the message is in the process of being transported. This means that references
16016 to header lines in string expansions in the transport's configuration still
16017 &"see"& the original header lines.
16018
16019 The &%headers_remove%& option is expanded after &%errors_to%& and
16020 &%headers_add%&, but before &%transport%&. If the expansion is forced to fail,
16021 the option has no effect. Other expansion failures are treated as configuration
16022 errors.
16023
16024 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
16025 router that has the &%one_time%& option set.
16026
16027 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
16028 removal requests are deleted when the address is passed on to subsequent
16029 routers, and this can lead to problems with duplicates -- see the similar
16030 warning for &%headers_add%& above.
16031
16032
16033 .option ignore_target_hosts routers "host list&!!" unset
16034 .cindex "IP address" "discarding"
16035 .cindex "router" "discarding IP addresses"
16036 Although this option is a host list, it should normally contain IP address
16037 entries rather than names. If any host that is looked up by the router has an
16038 IP address that matches an item in this list, Exim behaves as if that IP
16039 address did not exist. This option allows you to cope with rogue DNS entries
16040 like
16041 .code
16042 remote.domain.example.  A  127.0.0.1
16043 .endd
16044 by setting
16045 .code
16046 ignore_target_hosts = 127.0.0.1
16047 .endd
16048 on the relevant router. If all the hosts found by a &(dnslookup)& router are
16049 discarded in this way, the router declines. In a conventional configuration, an
16050 attempt to mail to such a domain would normally provoke the &"unrouteable
16051 domain"& error, and an attempt to verify an address in the domain would fail.
16052 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
16053 router declines if presented with one of the listed addresses.
16054
16055 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
16056 means of the first or the second of the following settings, respectively:
16057 .code
16058 ignore_target_hosts = 0.0.0.0/0
16059 ignore_target_hosts = <; 0::0/0
16060 .endd
16061 The pattern in the first line matches all IPv4 addresses, whereas the pattern
16062 in the second line matches all IPv6 addresses.
16063
16064 This option may also be useful for ignoring link-local and site-local IPv6
16065 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
16066 is expanded before use as a list, it is possible to make it dependent on the
16067 domain that is being routed.
16068
16069 .vindex "&$host_address$&"
16070 During its expansion, &$host_address$& is set to the IP address that is being
16071 checked.
16072
16073 .option initgroups routers boolean false
16074 .cindex "additional groups"
16075 .cindex "groups" "additional"
16076 .cindex "local transports" "uid and gid"
16077 .cindex "transport" "local"
16078 If the router queues an address for a transport, and this option is true, and
16079 the uid supplied by the router is not overridden by the transport, the
16080 &[initgroups()]& function is called when running the transport to ensure that
16081 any additional groups associated with the uid are set up. See also &%group%&
16082 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
16083
16084
16085
16086 .option local_part_prefix routers&!? "string list" unset
16087 .cindex "router" "prefix for local part"
16088 .cindex "prefix" "for local part, used in router"
16089 If this option is set, the router is skipped unless the local part starts with
16090 one of the given strings, or &%local_part_prefix_optional%& is true. See
16091 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
16092 evaluated.
16093
16094 The list is scanned from left to right, and the first prefix that matches is
16095 used. A limited form of wildcard is available; if the prefix begins with an
16096 asterisk, it matches the longest possible sequence of arbitrary characters at
16097 the start of the local part. An asterisk should therefore always be followed by
16098 some character that does not occur in normal local parts.
16099 .cindex "multiple mailboxes"
16100 .cindex "mailbox" "multiple"
16101 Wildcarding can be used to set up multiple user mailboxes, as described in
16102 section &<<SECTmulbox>>&.
16103
16104 .vindex "&$local_part$&"
16105 .vindex "&$local_part_prefix$&"
16106 During the testing of the &%local_parts%& option, and while the router is
16107 running, the prefix is removed from the local part, and is available in the
16108 expansion variable &$local_part_prefix$&. When a message is being delivered, if
16109 the router accepts the address, this remains true during subsequent delivery by
16110 a transport. In particular, the local part that is transmitted in the RCPT
16111 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
16112 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
16113 the relevant transport.
16114
16115 When an address is being verified, &%local_part_prefix%& affects only the
16116 behaviour of the router. If the callout feature of verification is in use, this
16117 means that the full address, including the prefix, will be used during the
16118 callout.
16119
16120 The prefix facility is commonly used to handle local parts of the form
16121 &%owner-something%&. Another common use is to support local parts of the form
16122 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
16123 to tell a user their forwarding is broken &-- by placing a router like this one
16124 immediately before the router that handles &_.forward_& files:
16125 .code
16126 real_localuser:
16127   driver = accept
16128   local_part_prefix = real-
16129   check_local_user
16130   transport = local_delivery
16131 .endd
16132 For security, it would probably be a good idea to restrict the use of this
16133 router to locally-generated messages, using a condition such as this:
16134 .code
16135   condition = ${if match {$sender_host_address}\
16136                          {\N^(|127\.0\.0\.1)$\N}}
16137 .endd
16138
16139 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
16140 both conditions must be met if not optional. Care must be taken if wildcards
16141 are used in both a prefix and a suffix on the same router. Different
16142 separator characters must be used to avoid ambiguity.
16143
16144
16145 .option local_part_prefix_optional routers boolean false
16146 See &%local_part_prefix%& above.
16147
16148
16149
16150 .option local_part_suffix routers&!? "string list" unset
16151 .cindex "router" "suffix for local part"
16152 .cindex "suffix for local part" "used in router"
16153 This option operates in the same way as &%local_part_prefix%&, except that the
16154 local part must end (rather than start) with the given string, the
16155 &%local_part_suffix_optional%& option determines whether the suffix is
16156 mandatory, and the wildcard * character, if present, must be the last
16157 character of the suffix. This option facility is commonly used to handle local
16158 parts of the form &%something-request%& and multiple user mailboxes of the form
16159 &%username-foo%&.
16160
16161
16162 .option local_part_suffix_optional routers boolean false
16163 See &%local_part_suffix%& above.
16164
16165
16166
16167 .option local_parts routers&!? "local part list&!!" unset
16168 .cindex "router" "restricting to specific local parts"
16169 .cindex "local part" "checking in router"
16170 The router is run only if the local part of the address matches the list.
16171 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16172 are evaluated, and
16173 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
16174 string is expanded, it is possible to make it depend on the domain, for
16175 example:
16176 .code
16177 local_parts = dbm;/usr/local/specials/$domain
16178 .endd
16179 .vindex "&$local_part_data$&"
16180 If the match is achieved by a lookup, the data that the lookup returned
16181 for the local part is placed in the variable &$local_part_data$& for use in
16182 expansions of the router's private options. You might use this option, for
16183 example, if you have a large number of local virtual domains, and you want to
16184 send all postmaster mail to the same place without having to set up an alias in
16185 each virtual domain:
16186 .code
16187 postmaster:
16188   driver = redirect
16189   local_parts = postmaster
16190   data = postmaster@real.domain.example
16191 .endd
16192
16193
16194 .option log_as_local routers boolean "see below"
16195 .cindex "log" "delivery line"
16196 .cindex "delivery" "log line format"
16197 Exim has two logging styles for delivery, the idea being to make local
16198 deliveries stand out more visibly from remote ones. In the &"local"& style, the
16199 recipient address is given just as the local part, without a domain. The use of
16200 this style is controlled by this option. It defaults to true for the &(accept)&
16201 router, and false for all the others. This option applies only when a
16202 router assigns an address to a transport. It has no effect on routers that
16203 redirect addresses.
16204
16205
16206
16207 .option more routers boolean&!! true
16208 The result of string expansion for this option must be a valid boolean value,
16209 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
16210 result causes an error, and delivery is deferred. If the expansion is forced to
16211 fail, the default value for the option (true) is used. Other failures cause
16212 delivery to be deferred.
16213
16214 If this option is set false, and the router declines to handle the address, no
16215 further routers are tried, routing fails, and the address is bounced.
16216 .oindex "&%self%&"
16217 However, if the router explicitly passes an address to the following router by
16218 means of the setting
16219 .code
16220 self = pass
16221 .endd
16222 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
16223 does not affect the behaviour if one of the precondition tests fails. In that
16224 case, the address is always passed to the next router.
16225
16226 Note that &%address_data%& is not considered to be a precondition. If its
16227 expansion is forced to fail, the router declines, and the value of &%more%&
16228 controls what happens next.
16229
16230
16231 .option pass_on_timeout routers boolean false
16232 .cindex "timeout" "of router"
16233 .cindex "router" "timeout"
16234 If a router times out during a host lookup, it normally causes deferral of the
16235 address. If &%pass_on_timeout%& is set, the address is passed on to the next
16236 router, overriding &%no_more%&. This may be helpful for systems that are
16237 intermittently connected to the Internet, or those that want to pass to a smart
16238 host any messages that cannot immediately be delivered.
16239
16240 There are occasional other temporary errors that can occur while doing DNS
16241 lookups. They are treated in the same way as a timeout, and this option
16242 applies to all of them.
16243
16244
16245
16246 .option pass_router routers string unset
16247 .cindex "router" "go to after &""pass""&"
16248 Routers that recognize the generic &%self%& option (&(dnslookup)&,
16249 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
16250 routing to continue, and overriding a false setting of &%more%&. When one of
16251 these routers returns &"pass"&, the address is normally handed on to the next
16252 router in sequence. This can be changed by setting &%pass_router%& to the name
16253 of another router. However (unlike &%redirect_router%&) the named router must
16254 be below the current router, to avoid loops. Note that this option applies only
16255 to the special case of &"pass"&. It does not apply when a router returns
16256 &"decline"& because it cannot handle an address.
16257
16258
16259
16260 .option redirect_router routers string unset
16261 .cindex "router" "start at after redirection"
16262 Sometimes an administrator knows that it is pointless to reprocess addresses
16263 generated from alias or forward files with the same router again. For
16264 example, if an alias file translates real names into login ids there is no
16265 point searching the alias file a second time, especially if it is a large file.
16266
16267 The &%redirect_router%& option can be set to the name of any router instance.
16268 It causes the routing of any generated addresses to start at the named router
16269 instead of at the first router. This option has no effect if the router in
16270 which it is set does not generate new addresses.
16271
16272
16273
16274 .option require_files routers&!? "string list&!!" unset
16275 .cindex "file" "requiring for router"
16276 .cindex "router" "requiring file existence"
16277 This option provides a general mechanism for predicating the running of a
16278 router on the existence or non-existence of certain files or directories.
16279 Before running a router, as one of its precondition tests, Exim works its way
16280 through the &%require_files%& list, expanding each item separately.
16281
16282 Because the list is split before expansion, any colons in expansion items must
16283 be doubled, or the facility for using a different list separator must be used.
16284 If any expansion is forced to fail, the item is ignored. Other expansion
16285 failures cause routing of the address to be deferred.
16286
16287 If any expanded string is empty, it is ignored. Otherwise, except as described
16288 below, each string must be a fully qualified file path, optionally preceded by
16289 &"!"&. The paths are passed to the &[stat()]& function to test for the
16290 existence of the files or directories. The router is skipped if any paths not
16291 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
16292
16293 .cindex "NFS"
16294 If &[stat()]& cannot determine whether a file exists or not, delivery of
16295 the message is deferred. This can happen when NFS-mounted filesystems are
16296 unavailable.
16297
16298 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
16299 options, so you cannot use it to check for the existence of a file in which to
16300 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
16301 full list of the order in which preconditions are evaluated.) However, as
16302 these options are all expanded, you can use the &%exists%& expansion condition
16303 to make such tests. The &%require_files%& option is intended for checking files
16304 that the router may be going to use internally, or which are needed by a
16305 transport (for example &_.procmailrc_&).
16306
16307 During delivery, the &[stat()]& function is run as root, but there is a
16308 facility for some checking of the accessibility of a file by another user.
16309 This is not a proper permissions check, but just a &"rough"& check that
16310 operates as follows:
16311
16312 If an item in a &%require_files%& list does not contain any forward slash
16313 characters, it is taken to be the user (and optional group, separated by a
16314 comma) to be checked for subsequent files in the list. If no group is specified
16315 but the user is specified symbolically, the gid associated with the uid is
16316 used. For example:
16317 .code
16318 require_files = mail:/some/file
16319 require_files = $local_part:$home/.procmailrc
16320 .endd
16321 If a user or group name in a &%require_files%& list does not exist, the
16322 &%require_files%& condition fails.
16323
16324 Exim performs the check by scanning along the components of the file path, and
16325 checking the access for the given uid and gid. It checks for &"x"& access on
16326 directories, and &"r"& access on the final file. Note that this means that file
16327 access control lists, if the operating system has them, are ignored.
16328
16329 &*Warning 1*&: When the router is being run to verify addresses for an
16330 incoming SMTP message, Exim is not running as root, but under its own uid. This
16331 may affect the result of a &%require_files%& check. In particular, &[stat()]&
16332 may yield the error EACCES (&"Permission denied"&). This means that the Exim
16333 user is not permitted to read one of the directories on the file's path.
16334
16335 &*Warning 2*&: Even when Exim is running as root while delivering a message,
16336 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
16337 without root access. In this case, if a check for access by a particular user
16338 is requested, Exim creates a subprocess that runs as that user, and tries the
16339 check again in that process.
16340
16341 The default action for handling an unresolved EACCES is to consider it to
16342 be caused by a configuration error, and routing is deferred because the
16343 existence or non-existence of the file cannot be determined. However, in some
16344 circumstances it may be desirable to treat this condition as if the file did
16345 not exist. If the file name (or the exclamation mark that precedes the file
16346 name for non-existence) is preceded by a plus sign, the EACCES error is treated
16347 as if the file did not exist. For example:
16348 .code
16349 require_files = +/some/file
16350 .endd
16351 If the router is not an essential part of verification (for example, it
16352 handles users' &_.forward_& files), another solution is to set the &%verify%&
16353 option false so that the router is skipped when verifying.
16354
16355
16356
16357 .option retry_use_local_part routers boolean "see below"
16358 .cindex "hints database" "retry keys"
16359 .cindex "local part" "in retry keys"
16360 When a delivery suffers a temporary routing failure, a retry record is created
16361 in Exim's hints database. For addresses whose routing depends only on the
16362 domain, the key for the retry record should not involve the local part, but for
16363 other addresses, both the domain and the local part should be included.
16364 Usually, remote routing is of the former kind, and local routing is of the
16365 latter kind.
16366
16367 This option controls whether the local part is used to form the key for retry
16368 hints for addresses that suffer temporary errors while being handled by this
16369 router. The default value is true for any router that has &%check_local_user%&
16370 set, and false otherwise. Note that this option does not apply to hints keys
16371 for transport delays; they are controlled by a generic transport option of the
16372 same name.
16373
16374 The setting of &%retry_use_local_part%& applies only to the router on which it
16375 appears. If the router generates child addresses, they are routed
16376 independently; this setting does not become attached to them.
16377
16378
16379
16380 .option router_home_directory routers string&!! unset
16381 .cindex "router" "home directory for"
16382 .cindex "home directory" "for router"
16383 .vindex "&$home$&"
16384 This option sets a home directory for use while the router is running. (Compare
16385 &%transport_home_directory%&, which sets a home directory for later
16386 transporting.) In particular, if used on a &(redirect)& router, this option
16387 sets a value for &$home$& while a filter is running. The value is expanded;
16388 forced expansion failure causes the option to be ignored &-- other failures
16389 cause the router to defer.
16390
16391 Expansion of &%router_home_directory%& happens immediately after the
16392 &%check_local_user%& test (if configured), before any further expansions take
16393 place.
16394 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16395 are evaluated.)
16396 While the router is running, &%router_home_directory%& overrides the value of
16397 &$home$& that came from &%check_local_user%&.
16398
16399 When a router accepts an address and assigns it to a local transport (including
16400 the cases when a &(redirect)& router generates a pipe, file, or autoreply
16401 delivery), the home directory setting for the transport is taken from the first
16402 of these values that is set:
16403
16404 .ilist
16405 The &%home_directory%& option on the transport;
16406 .next
16407 The &%transport_home_directory%& option on the router;
16408 .next
16409 The password data if &%check_local_user%& is set on the router;
16410 .next
16411 The &%router_home_directory%& option on the router.
16412 .endlist
16413
16414 In other words, &%router_home_directory%& overrides the password data for the
16415 router, but not for the transport.
16416
16417
16418
16419 .option self routers string freeze
16420 .cindex "MX record" "pointing to local host"
16421 .cindex "local host" "MX pointing to"
16422 This option applies to those routers that use a recipient address to find a
16423 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
16424 and &(manualroute)& routers.
16425 Certain configurations of the &(queryprogram)& router can also specify a list
16426 of remote hosts.
16427 Usually such routers are configured to send the message to a remote host via an
16428 &(smtp)& transport. The &%self%& option specifies what happens when the first
16429 host on the list turns out to be the local host.
16430 The way in which Exim checks for the local host is described in section
16431 &<<SECTreclocipadd>>&.
16432
16433 Normally this situation indicates either an error in Exim's configuration (for
16434 example, the router should be configured not to process this domain), or an
16435 error in the DNS (for example, the MX should not point to this host). For this
16436 reason, the default action is to log the incident, defer the address, and
16437 freeze the message. The following alternatives are provided for use in special
16438 cases:
16439
16440 .vlist
16441 .vitem &%defer%&
16442 Delivery of the message is tried again later, but the message is not frozen.
16443
16444 .vitem "&%reroute%&: <&'domain'&>"
16445 The domain is changed to the given domain, and the address is passed back to
16446 be reprocessed by the routers. No rewriting of headers takes place. This
16447 behaviour is essentially a redirection.
16448
16449 .vitem "&%reroute: rewrite:%& <&'domain'&>"
16450 The domain is changed to the given domain, and the address is passed back to be
16451 reprocessed by the routers. Any headers that contain the original domain are
16452 rewritten.
16453
16454 .vitem &%pass%&
16455 .oindex "&%more%&"
16456 .vindex "&$self_hostname$&"
16457 The router passes the address to the next router, or to the router named in the
16458 &%pass_router%& option if it is set. This overrides &%no_more%&. During
16459 subsequent routing and delivery, the variable &$self_hostname$& contains the
16460 name of the local host that the router encountered. This can be used to
16461 distinguish between different cases for hosts with multiple names. The
16462 combination
16463 .code
16464 self = pass
16465 no_more
16466 .endd
16467 ensures that only those addresses that routed to the local host are passed on.
16468 Without &%no_more%&, addresses that were declined for other reasons would also
16469 be passed to the next router.
16470
16471 .vitem &%fail%&
16472 Delivery fails and an error report is generated.
16473
16474 .vitem &%send%&
16475 .cindex "local host" "sending to"
16476 The anomaly is ignored and the address is queued for the transport. This
16477 setting should be used with extreme caution. For an &(smtp)& transport, it
16478 makes sense only in cases where the program that is listening on the SMTP port
16479 is not this version of Exim. That is, it must be some other MTA, or Exim with a
16480 different configuration file that handles the domain in another way.
16481 .endlist
16482
16483
16484
16485 .option senders routers&!? "address list&!!" unset
16486 .cindex "router" "checking senders"
16487 If this option is set, the router is skipped unless the message's sender
16488 address matches something on the list.
16489 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16490 are evaluated.
16491
16492 There are issues concerning verification when the running of routers is
16493 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
16494 setting, it sets the sender to the null string. When using the &%-bt%& option
16495 to check a configuration file, it is necessary also to use the &%-f%& option to
16496 set an appropriate sender. For incoming mail, the sender is unset when
16497 verifying the sender, but is available when verifying any recipients. If the
16498 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
16499 matters.
16500
16501
16502 .option translate_ip_address routers string&!! unset
16503 .cindex "IP address" "translating"
16504 .cindex "packet radio"
16505 .cindex "router" "IP address translation"
16506 There exist some rare networking situations (for example, packet radio) where
16507 it is helpful to be able to translate IP addresses generated by normal routing
16508 mechanisms into other IP addresses, thus performing a kind of manual IP
16509 routing. This should be done only if the normal IP routing of the TCP/IP stack
16510 is inadequate or broken. Because this is an extremely uncommon requirement, the
16511 code to support this option is not included in the Exim binary unless
16512 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
16513
16514 .vindex "&$host_address$&"
16515 The &%translate_ip_address%& string is expanded for every IP address generated
16516 by the router, with the generated address set in &$host_address$&. If the
16517 expansion is forced to fail, no action is taken.
16518 For any other expansion error, delivery of the message is deferred.
16519 If the result of the expansion is an IP address, that replaces the original
16520 address; otherwise the result is assumed to be a host name &-- this is looked
16521 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
16522 produce one or more replacement IP addresses. For example, to subvert all IP
16523 addresses in some specific networks, this could be added to a router:
16524 .code
16525 translate_ip_address = \
16526   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
16527     {$value}fail}}
16528 .endd
16529 The file would contain lines like
16530 .code
16531 10.2.3.128/26    some.host
16532 10.8.4.34/26     10.44.8.15
16533 .endd
16534 You should not make use of this facility unless you really understand what you
16535 are doing.
16536
16537
16538
16539 .option transport routers string&!! unset
16540 This option specifies the transport to be used when a router accepts an address
16541 and sets it up for delivery. A transport is never needed if a router is used
16542 only for verification. The value of the option is expanded at routing time,
16543 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
16544 and result must be the name of one of the configured transports. If it is not,
16545 delivery is deferred.
16546
16547 The &%transport%& option is not used by the &(redirect)& router, but it does
16548 have some private options that set up transports for pipe and file deliveries
16549 (see chapter &<<CHAPredirect>>&).
16550
16551
16552
16553 .option transport_current_directory routers string&!! unset
16554 .cindex "current directory for local transport"
16555 This option associates a current directory with any address that is routed
16556 to a local transport. This can happen either because a transport is
16557 explicitly configured for the router, or because it generates a delivery to a
16558 file or a pipe. During the delivery process (that is, at transport time), this
16559 option string is expanded and is set as the current directory, unless
16560 overridden by a setting on the transport.
16561 If the expansion fails for any reason, including forced failure, an error is
16562 logged, and delivery is deferred.
16563 See chapter &<<CHAPenvironment>>& for details of the local delivery
16564 environment.
16565
16566
16567
16568
16569 .option transport_home_directory routers string&!! "see below"
16570 .cindex "home directory" "for local transport"
16571 This option associates a home directory with any address that is routed to a
16572 local transport. This can happen either because a transport is explicitly
16573 configured for the router, or because it generates a delivery to a file or a
16574 pipe. During the delivery process (that is, at transport time), the option
16575 string is expanded and is set as the home directory, unless overridden by a
16576 setting of &%home_directory%& on the transport.
16577 If the expansion fails for any reason, including forced failure, an error is
16578 logged, and delivery is deferred.
16579
16580 If the transport does not specify a home directory, and
16581 &%transport_home_directory%& is not set for the router, the home directory for
16582 the transport is taken from the password data if &%check_local_user%& is set for
16583 the router. Otherwise it is taken from &%router_home_directory%& if that option
16584 is set; if not, no home directory is set for the transport.
16585
16586 See chapter &<<CHAPenvironment>>& for further details of the local delivery
16587 environment.
16588
16589
16590
16591
16592 .option unseen routers boolean&!! false
16593 .cindex "router" "carrying on after success"
16594 The result of string expansion for this option must be a valid boolean value,
16595 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
16596 result causes an error, and delivery is deferred. If the expansion is forced to
16597 fail, the default value for the option (false) is used. Other failures cause
16598 delivery to be deferred.
16599
16600 When this option is set true, routing does not cease if the router accepts the
16601 address. Instead, a copy of the incoming address is passed to the next router,
16602 overriding a false setting of &%more%&. There is little point in setting
16603 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
16604 the value of &%unseen%& contains expansion items (and therefore, presumably, is
16605 sometimes true and sometimes false).
16606
16607 .cindex "copy of message (&%unseen%& option)"
16608 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
16609 qualifier in filter files. It can be used to cause copies of messages to be
16610 delivered to some other destination, while also carrying out a normal delivery.
16611 In effect, the current address is made into a &"parent"& that has two children
16612 &-- one that is delivered as specified by this router, and a clone that goes on
16613 to be routed further. For this reason, &%unseen%& may not be combined with the
16614 &%one_time%& option in a &(redirect)& router.
16615
16616 &*Warning*&: Header lines added to the address (or specified for removal) by
16617 this router or by previous routers affect the &"unseen"& copy of the message
16618 only. The clone that continues to be processed by further routers starts with
16619 no added headers and none specified for removal. For a &%redirect%& router, if
16620 a generated address is the same as the incoming address, this can lead to
16621 duplicate addresses with different header modifications. Exim does not do
16622 duplicate deliveries (except, in certain circumstances, to pipes -- see section
16623 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
16624 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
16625 &%redirect%& router may be of help.
16626
16627 Unlike the handling of header modifications, any data that was set by the
16628 &%address_data%& option in the current or previous routers &'is'& passed on to
16629 subsequent routers.
16630
16631
16632 .option user routers string&!! "see below"
16633 .cindex "uid (user id)" "local delivery"
16634 .cindex "local transports" "uid and gid"
16635 .cindex "transport" "local"
16636 .cindex "router" "user for filter processing"
16637 .cindex "filter" "user for processing"
16638 When a router queues an address for a transport, and the transport does not
16639 specify a user, the user given here is used when running the delivery process.
16640 The user may be specified numerically or by name. If expansion fails, the
16641 error is logged and delivery is deferred.
16642 This user is also used by the &(redirect)& router when running a filter file.
16643 The default is unset, except when &%check_local_user%& is set. In this case,
16644 the default is taken from the password information. If the user is specified as
16645 a name, and &%group%& is not set, the group associated with the user is used.
16646 See also &%initgroups%& and &%group%& and the discussion in chapter
16647 &<<CHAPenvironment>>&.
16648
16649
16650
16651 .option verify routers&!? boolean true
16652 Setting this option has the effect of setting &%verify_sender%& and
16653 &%verify_recipient%& to the same value.
16654
16655
16656 .option verify_only routers&!? boolean false
16657 .cindex "EXPN" "with &%verify_only%&"
16658 .oindex "&%-bv%&"
16659 .cindex "router" "used only when verifying"
16660 If this option is set, the router is used only when verifying an address or
16661 testing with the &%-bv%& option, not when actually doing a delivery, testing
16662 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
16663 restricted to verifying only senders or recipients by means of
16664 &%verify_sender%& and &%verify_recipient%&.
16665
16666 &*Warning*&: When the router is being run to verify addresses for an incoming
16667 SMTP message, Exim is not running as root, but under its own uid. If the router
16668 accesses any files, you need to make sure that they are accessible to the Exim
16669 user or group.
16670
16671
16672 .option verify_recipient routers&!? boolean true
16673 If this option is false, the router is skipped when verifying recipient
16674 addresses
16675 or testing recipient verification using &%-bv%&.
16676 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16677 are evaluated.
16678
16679
16680 .option verify_sender routers&!? boolean true
16681 If this option is false, the router is skipped when verifying sender addresses
16682 or testing sender verification using &%-bvs%&.
16683 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16684 are evaluated.
16685 .ecindex IIDgenoprou1
16686 .ecindex IIDgenoprou2
16687
16688
16689
16690
16691
16692
16693 . ////////////////////////////////////////////////////////////////////////////
16694 . ////////////////////////////////////////////////////////////////////////////
16695
16696 .chapter "The accept router" "CHID4"
16697 .cindex "&(accept)& router"
16698 .cindex "routers" "&(accept)&"
16699 The &(accept)& router has no private options of its own. Unless it is being
16700 used purely for verification (see &%verify_only%&) a transport is required to
16701 be defined by the generic &%transport%& option. If the preconditions that are
16702 specified by generic options are met, the router accepts the address and queues
16703 it for the given transport. The most common use of this router is for setting
16704 up deliveries to local mailboxes. For example:
16705 .code
16706 localusers:
16707   driver = accept
16708   domains = mydomain.example
16709   check_local_user
16710   transport = local_delivery
16711 .endd
16712 The &%domains%& condition in this example checks the domain of the address, and
16713 &%check_local_user%& checks that the local part is the login of a local user.
16714 When both preconditions are met, the &(accept)& router runs, and queues the
16715 address for the &(local_delivery)& transport.
16716
16717
16718
16719
16720
16721
16722 . ////////////////////////////////////////////////////////////////////////////
16723 . ////////////////////////////////////////////////////////////////////////////
16724
16725 .chapter "The dnslookup router" "CHAPdnslookup"
16726 .scindex IIDdnsrou1 "&(dnslookup)& router"
16727 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
16728 The &(dnslookup)& router looks up the hosts that handle mail for the
16729 recipient's domain in the DNS. A transport must always be set for this router,
16730 unless &%verify_only%& is set.
16731
16732 If SRV support is configured (see &%check_srv%& below), Exim first searches for
16733 SRV records. If none are found, or if SRV support is not configured,
16734 MX records are looked up. If no MX records exist, address records are sought.
16735 However, &%mx_domains%& can be set to disable the direct use of address
16736 records.
16737
16738 MX records of equal priority are sorted by Exim into a random order. Exim then
16739 looks for address records for the host names obtained from MX or SRV records.
16740 When a host has more than one IP address, they are sorted into a random order,
16741 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
16742 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
16743 generic option, the router declines.
16744
16745 Unless they have the highest priority (lowest MX value), MX records that point
16746 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
16747 are discarded, together with any other MX records of equal or lower priority.
16748
16749 .cindex "MX record" "pointing to local host"
16750 .cindex "local host" "MX pointing to"
16751 .oindex "&%self%&" "in &(dnslookup)& router"
16752 If the host pointed to by the highest priority MX record, or looked up as an
16753 address record, is the local host, or matches &%hosts_treat_as_local%&, what
16754 happens is controlled by the generic &%self%& option.
16755
16756
16757 .section "Problems with DNS lookups" "SECTprowitdnsloo"
16758 There have been problems with DNS servers when SRV records are looked up.
16759 Some mis-behaving servers return a DNS error or timeout when a non-existent
16760 SRV record is sought. Similar problems have in the past been reported for
16761 MX records. The global &%dns_again_means_nonexist%& option can help with this
16762 problem, but it is heavy-handed because it is a global option.
16763
16764 For this reason, there are two options, &%srv_fail_domains%& and
16765 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
16766 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
16767 an attempt to look up an SRV or MX record causes one of these results, and the
16768 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
16769 such record"&. In the case of an SRV lookup, this means that the router
16770 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
16771 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
16772 case routing fails.
16773
16774
16775
16776
16777 .section "Private options for dnslookup" "SECID118"
16778 .cindex "options" "&(dnslookup)& router"
16779 The private options for the &(dnslookup)& router are as follows:
16780
16781 .option check_secondary_mx dnslookup boolean false
16782 .cindex "MX record" "checking for secondary"
16783 If this option is set, the router declines unless the local host is found in
16784 (and removed from) the list of hosts obtained by MX lookup. This can be used to
16785 process domains for which the local host is a secondary mail exchanger
16786 differently to other domains. The way in which Exim decides whether a host is
16787 the local host is described in section &<<SECTreclocipadd>>&.
16788
16789
16790 .option check_srv dnslookup string&!! unset
16791 .cindex "SRV record" "enabling use of"
16792 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
16793 addition to MX and address records. The support is disabled by default. To
16794 enable SRV support, set the &%check_srv%& option to the name of the service
16795 required. For example,
16796 .code
16797 check_srv = smtp
16798 .endd
16799 looks for SRV records that refer to the normal smtp service. The option is
16800 expanded, so the service name can vary from message to message or address
16801 to address. This might be helpful if SRV records are being used for a
16802 submission service. If the expansion is forced to fail, the &%check_srv%&
16803 option is ignored, and the router proceeds to look for MX records in the
16804 normal way.
16805
16806 When the expansion succeeds, the router searches first for SRV records for
16807 the given service (it assumes TCP protocol). A single SRV record with a
16808 host name that consists of just a single dot indicates &"no such service for
16809 this domain"&; if this is encountered, the router declines. If other kinds of
16810 SRV record are found, they are used to construct a host list for delivery
16811 according to the rules of RFC 2782. MX records are not sought in this case.
16812
16813 When no SRV records are found, MX records (and address records) are sought in
16814 the traditional way. In other words, SRV records take precedence over MX
16815 records, just as MX records take precedence over address records. Note that
16816 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
16817 defined it. It is apparently believed that MX records are sufficient for email
16818 and that SRV records should not be used for this purpose. However, SRV records
16819 have an additional &"weight"& feature which some people might find useful when
16820 trying to split an SMTP load between hosts of different power.
16821
16822 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
16823 when there is a DNS lookup error.
16824
16825
16826
16827 .option mx_domains dnslookup "domain list&!!" unset
16828 .cindex "MX record" "required to exist"
16829 .cindex "SRV record" "required to exist"
16830 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
16831 record in order to be recognized. (The name of this option could be improved.)
16832 For example, if all the mail hosts in &'fict.example'& are known to have MX
16833 records, except for those in &'discworld.fict.example'&, you could use this
16834 setting:
16835 .code
16836 mx_domains = ! *.discworld.fict.example : *.fict.example
16837 .endd
16838 This specifies that messages addressed to a domain that matches the list but
16839 has no MX record should be bounced immediately instead of being routed using
16840 the address record.
16841
16842
16843 .option mx_fail_domains dnslookup "domain list&!!" unset
16844 If the DNS lookup for MX records for one of the domains in this list causes a
16845 DNS lookup error, Exim behaves as if no MX records were found. See section
16846 &<<SECTprowitdnsloo>>& for more discussion.
16847
16848
16849
16850
16851 .option qualify_single dnslookup boolean true
16852 .cindex "DNS" "resolver options"
16853 .cindex "DNS" "qualifying single-component names"
16854 When this option is true, the resolver option RES_DEFNAMES is set for DNS
16855 lookups. Typically, but not standardly, this causes the resolver to qualify
16856 single-component names with the default domain. For example, on a machine
16857 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
16858 &'thesaurus.ref.example'& inside the resolver. For details of what your
16859 resolver actually does, consult your man pages for &'resolver'& and
16860 &'resolv.conf'&.
16861
16862
16863
16864 .option rewrite_headers dnslookup boolean true
16865 .cindex "rewriting" "header lines"
16866 .cindex "header lines" "rewriting"
16867 If the domain name in the address that is being processed is not fully
16868 qualified, it may be expanded to its full form by a DNS lookup. For example, if
16869 an address is specified as &'dormouse@teaparty'&, the domain might be
16870 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
16871 occur as a result of setting the &%widen_domains%& option. If
16872 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
16873 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
16874 header lines of the message are rewritten with the full domain name.
16875
16876 This option should be turned off only when it is known that no message is
16877 ever going to be sent outside an environment where the abbreviation makes
16878 sense.
16879
16880 When an MX record is looked up in the DNS and matches a wildcard record, name
16881 servers normally return a record containing the name that has been looked up,
16882 making it impossible to detect whether a wildcard was present or not. However,
16883 some name servers have recently been seen to return the wildcard entry. If the
16884 name returned by a DNS lookup begins with an asterisk, it is not used for
16885 header rewriting.
16886
16887
16888 .option same_domain_copy_routing dnslookup boolean false
16889 .cindex "address" "copying routing"
16890 Addresses with the same domain are normally routed by the &(dnslookup)& router
16891 to the same list of hosts. However, this cannot be presumed, because the router
16892 options and preconditions may refer to the local part of the address. By
16893 default, therefore, Exim routes each address in a message independently. DNS
16894 servers run caches, so repeated DNS lookups are not normally expensive, and in
16895 any case, personal messages rarely have more than a few recipients.
16896
16897 If you are running mailing lists with large numbers of subscribers at the same
16898 domain, and you are using a &(dnslookup)& router which is independent of the
16899 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
16900 lookups for identical domains in one message. In this case, when &(dnslookup)&
16901 routes an address to a remote transport, any other unrouted addresses in the
16902 message that have the same domain are automatically given the same routing
16903 without processing them independently,
16904 provided the following conditions are met:
16905
16906 .ilist
16907 No router that processed the address specified &%headers_add%& or
16908 &%headers_remove%&.
16909 .next
16910 The router did not change the address in any way, for example, by &"widening"&
16911 the domain.
16912 .endlist
16913
16914
16915
16916
16917 .option search_parents dnslookup boolean false
16918 .cindex "DNS" "resolver options"
16919 When this option is true, the resolver option RES_DNSRCH is set for DNS
16920 lookups. This is different from the &%qualify_single%& option in that it
16921 applies to domains containing dots. Typically, but not standardly, it causes
16922 the resolver to search for the name in the current domain and in parent
16923 domains. For example, on a machine in the &'fict.example'& domain, if looking
16924 up &'teaparty.wonderland'& failed, the resolver would try
16925 &'teaparty.wonderland.fict.example'&. For details of what your resolver
16926 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
16927
16928 Setting this option true can cause problems in domains that have a wildcard MX
16929 record, because any domain that does not have its own MX record matches the
16930 local wildcard.
16931
16932
16933
16934 .option srv_fail_domains dnslookup "domain list&!!" unset
16935 If the DNS lookup for SRV records for one of the domains in this list causes a
16936 DNS lookup error, Exim behaves as if no SRV records were found. See section
16937 &<<SECTprowitdnsloo>>& for more discussion.
16938
16939
16940
16941
16942 .option widen_domains dnslookup "string list" unset
16943 .cindex "domain" "partial; widening"
16944 If a DNS lookup fails and this option is set, each of its strings in turn is
16945 added onto the end of the domain, and the lookup is tried again. For example,
16946 if
16947 .code
16948 widen_domains = fict.example:ref.example
16949 .endd
16950 is set and a lookup of &'klingon.dictionary'& fails,
16951 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
16952 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
16953 and &%search_parents%& options can cause some widening to be undertaken inside
16954 the DNS resolver. &%widen_domains%& is not applied to sender addresses
16955 when verifying, unless &%rewrite_headers%& is false (not the default).
16956
16957
16958 .section "Effect of qualify_single and search_parents" "SECID119"
16959 When a domain from an envelope recipient is changed by the resolver as a result
16960 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
16961 corresponding address in the message's header lines unless &%rewrite_headers%&
16962 is set false. Exim then re-routes the address, using the full domain.
16963
16964 These two options affect only the DNS lookup that takes place inside the router
16965 for the domain of the address that is being routed. They do not affect lookups
16966 such as that implied by
16967 .code
16968 domains = @mx_any
16969 .endd
16970 that may happen while processing a router precondition before the router is
16971 entered. No widening ever takes place for these lookups.
16972 .ecindex IIDdnsrou1
16973 .ecindex IIDdnsrou2
16974
16975
16976
16977
16978
16979
16980
16981
16982
16983 . ////////////////////////////////////////////////////////////////////////////
16984 . ////////////////////////////////////////////////////////////////////////////
16985
16986 .chapter "The ipliteral router" "CHID5"
16987 .cindex "&(ipliteral)& router"
16988 .cindex "domain literal" "routing"
16989 .cindex "routers" "&(ipliteral)&"
16990 This router has no private options. Unless it is being used purely for
16991 verification (see &%verify_only%&) a transport is required to be defined by the
16992 generic &%transport%& option. The router accepts the address if its domain part
16993 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
16994 router handles the address
16995 .code
16996 root@[192.168.1.1]
16997 .endd
16998 by setting up delivery to the host with that IP address. IPv4 domain literals
16999 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
17000 are similar, but the address is preceded by &`ipv6:`&. For example:
17001 .code
17002 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
17003 .endd
17004 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
17005 grounds that sooner or later somebody will try it.
17006
17007 .oindex "&%self%&" "in &(ipliteral)& router"
17008 If the IP address matches something in &%ignore_target_hosts%&, the router
17009 declines. If an IP literal turns out to refer to the local host, the generic
17010 &%self%& option determines what happens.
17011
17012 The RFCs require support for domain literals; however, their use is
17013 controversial in today's Internet. If you want to use this router, you must
17014 also set the main configuration option &%allow_domain_literals%&. Otherwise,
17015 Exim will not recognize the domain literal syntax in addresses.
17016
17017
17018
17019 . ////////////////////////////////////////////////////////////////////////////
17020 . ////////////////////////////////////////////////////////////////////////////
17021
17022 .chapter "The iplookup router" "CHID6"
17023 .cindex "&(iplookup)& router"
17024 .cindex "routers" "&(iplookup)&"
17025 The &(iplookup)& router was written to fulfil a specific requirement in
17026 Cambridge University (which in fact no longer exists). For this reason, it is
17027 not included in the binary of Exim by default. If you want to include it, you
17028 must set
17029 .code
17030 ROUTER_IPLOOKUP=yes
17031 .endd
17032 in your &_Local/Makefile_& configuration file.
17033
17034 The &(iplookup)& router routes an address by sending it over a TCP or UDP
17035 connection to one or more specific hosts. The host can then return the same or
17036 a different address &-- in effect rewriting the recipient address in the
17037 message's envelope. The new address is then passed on to subsequent routers. If
17038 this process fails, the address can be passed on to other routers, or delivery
17039 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
17040 must not be specified for it.
17041
17042 .cindex "options" "&(iplookup)& router"
17043 .option hosts iplookup string unset
17044 This option must be supplied. Its value is a colon-separated list of host
17045 names. The hosts are looked up using &[gethostbyname()]&
17046 (or &[getipnodebyname()]& when available)
17047 and are tried in order until one responds to the query. If none respond, what
17048 happens is controlled by &%optional%&.
17049
17050
17051 .option optional iplookup boolean false
17052 If &%optional%& is true, if no response is obtained from any host, the address
17053 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
17054 delivery to the address is deferred.
17055
17056
17057 .option port iplookup integer 0
17058 .cindex "port" "&(iplookup)& router"
17059 This option must be supplied. It specifies the port number for the TCP or UDP
17060 call.
17061
17062
17063 .option protocol iplookup string udp
17064 This option can be set to &"udp"& or &"tcp"& to specify which of the two
17065 protocols is to be used.
17066
17067
17068 .option query iplookup string&!! "see below"
17069 This defines the content of the query that is sent to the remote hosts. The
17070 default value is:
17071 .code
17072 $local_part@$domain $local_part@$domain
17073 .endd
17074 The repetition serves as a way of checking that a response is to the correct
17075 query in the default case (see &%response_pattern%& below).
17076
17077
17078 .option reroute iplookup string&!! unset
17079 If this option is not set, the rerouted address is precisely the byte string
17080 returned by the remote host, up to the first white space, if any. If set, the
17081 string is expanded to form the rerouted address. It can include parts matched
17082 in the response by &%response_pattern%& by means of numeric variables such as
17083 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
17084 whether or not a pattern is in use. In all cases, the rerouted address must end
17085 up in the form &'local_part@domain'&.
17086
17087
17088 .option response_pattern iplookup string unset
17089 This option can be set to a regular expression that is applied to the string
17090 returned from the remote host. If the pattern does not match the response, the
17091 router declines. If &%response_pattern%& is not set, no checking of the
17092 response is done, unless the query was defaulted, in which case there is a
17093 check that the text returned after the first white space is the original
17094 address. This checks that the answer that has been received is in response to
17095 the correct question. For example, if the response is just a new domain, the
17096 following could be used:
17097 .code
17098 response_pattern = ^([^@]+)$
17099 reroute = $local_part@$1
17100 .endd
17101
17102 .option timeout iplookup time 5s
17103 This specifies the amount of time to wait for a response from the remote
17104 machine. The same timeout is used for the &[connect()]& function for a TCP
17105 call. It does not apply to UDP.
17106
17107
17108
17109
17110 . ////////////////////////////////////////////////////////////////////////////
17111 . ////////////////////////////////////////////////////////////////////////////
17112
17113 .chapter "The manualroute router" "CHID7"
17114 .scindex IIDmanrou1 "&(manualroute)& router"
17115 .scindex IIDmanrou2 "routers" "&(manualroute)&"
17116 .cindex "domain" "manually routing"
17117 The &(manualroute)& router is so-called because it provides a way of manually
17118 routing an address according to its domain. It is mainly used when you want to
17119 route addresses to remote hosts according to your own rules, bypassing the
17120 normal DNS routing that looks up MX records. However, &(manualroute)& can also
17121 route to local transports, a facility that may be useful if you want to save
17122 messages for dial-in hosts in local files.
17123
17124 The &(manualroute)& router compares a list of domain patterns with the domain
17125 it is trying to route. If there is no match, the router declines. Each pattern
17126 has associated with it a list of hosts and some other optional data, which may
17127 include a transport. The combination of a pattern and its data is called a
17128 &"routing rule"&. For patterns that do not have an associated transport, the
17129 generic &%transport%& option must specify a transport, unless the router is
17130 being used purely for verification (see &%verify_only%&).
17131
17132 .vindex "&$host$&"
17133 In the case of verification, matching the domain pattern is sufficient for the
17134 router to accept the address. When actually routing an address for delivery,
17135 an address that matches a domain pattern is queued for the associated
17136 transport. If the transport is not a local one, a host list must be associated
17137 with the pattern; IP addresses are looked up for the hosts, and these are
17138 passed to the transport along with the mail address. For local transports, a
17139 host list is optional. If it is present, it is passed in &$host$& as a single
17140 text string.
17141
17142 The list of routing rules can be provided as an inline string in
17143 &%route_list%&, or the data can be obtained by looking up the domain in a file
17144 or database by setting &%route_data%&. Only one of these settings may appear in
17145 any one instance of &(manualroute)&. The format of routing rules is described
17146 below, following the list of private options.
17147
17148
17149 .section "Private options for manualroute" "SECTprioptman"
17150
17151 .cindex "options" "&(manualroute)& router"
17152 The private options for the &(manualroute)& router are as follows:
17153
17154 .option host_all_ignored manualroute string defer
17155 See &%host_find_failed%&.
17156
17157 .option host_find_failed manualroute string freeze
17158 This option controls what happens when &(manualroute)& tries to find an IP
17159 address for a host, and the host does not exist. The option can be set to one
17160 of the following values:
17161 .code
17162 decline
17163 defer
17164 fail
17165 freeze
17166 ignore
17167 pass
17168 .endd
17169 The default (&"freeze"&) assumes that this state is a serious configuration
17170 error. The difference between &"pass"& and &"decline"& is that the former
17171 forces the address to be passed to the next router (or the router defined by
17172 &%pass_router%&),
17173 .oindex "&%more%&"
17174 overriding &%no_more%&, whereas the latter passes the address to the next
17175 router only if &%more%& is true.
17176
17177 The value &"ignore"& causes Exim to completely ignore a host whose IP address
17178 cannot be found. If all the hosts in the list are ignored, the behaviour is
17179 controlled by the &%host_all_ignored%& option. This takes the same values
17180 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
17181
17182 The &%host_find_failed%& option applies only to a definite &"does not exist"&
17183 state; if a host lookup gets a temporary error, delivery is deferred unless the
17184 generic &%pass_on_timeout%& option is set.
17185
17186
17187 .option hosts_randomize manualroute boolean false
17188 .cindex "randomized host list"
17189 .cindex "host" "list of; randomized"
17190 If this option is set, the order of the items in a host list in a routing rule
17191 is randomized each time the list is used, unless an option in the routing rule
17192 overrides (see below). Randomizing the order of a host list can be used to do
17193 crude load sharing. However, if more than one mail address is routed by the
17194 same router to the same host list, the host lists are considered to be the same
17195 (even though they may be randomized into different orders) for the purpose of
17196 deciding whether to batch the deliveries into a single SMTP transaction.
17197
17198 When &%hosts_randomize%& is true, a host list may be split
17199 into groups whose order is separately randomized. This makes it possible to
17200 set up MX-like behaviour. The boundaries between groups are indicated by an
17201 item that is just &`+`& in the host list. For example:
17202 .code
17203 route_list = * host1:host2:host3:+:host4:host5
17204 .endd
17205 The order of the first three hosts and the order of the last two hosts is
17206 randomized for each use, but the first three always end up before the last two.
17207 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
17208 randomized host list is passed to an &(smtp)& transport that also has
17209 &%hosts_randomize set%&, the list is not re-randomized.
17210
17211
17212 .option route_data manualroute string&!! unset
17213 If this option is set, it must expand to yield the data part of a routing rule.
17214 Typically, the expansion string includes a lookup based on the domain. For
17215 example:
17216 .code
17217 route_data = ${lookup{$domain}dbm{/etc/routes}}
17218 .endd
17219 If the expansion is forced to fail, or the result is an empty string, the
17220 router declines. Other kinds of expansion failure cause delivery to be
17221 deferred.
17222
17223
17224 .option route_list manualroute "string list" unset
17225 This string is a list of routing rules, in the form defined below. Note that,
17226 unlike most string lists, the items are separated by semicolons. This is so
17227 that they may contain colon-separated host lists.
17228
17229
17230 .option same_domain_copy_routing manualroute boolean false
17231 .cindex "address" "copying routing"
17232 Addresses with the same domain are normally routed by the &(manualroute)&
17233 router to the same list of hosts. However, this cannot be presumed, because the
17234 router options and preconditions may refer to the local part of the address. By
17235 default, therefore, Exim routes each address in a message independently. DNS
17236 servers run caches, so repeated DNS lookups are not normally expensive, and in
17237 any case, personal messages rarely have more than a few recipients.
17238
17239 If you are running mailing lists with large numbers of subscribers at the same
17240 domain, and you are using a &(manualroute)& router which is independent of the
17241 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
17242 lookups for identical domains in one message. In this case, when
17243 &(manualroute)& routes an address to a remote transport, any other unrouted
17244 addresses in the message that have the same domain are automatically given the
17245 same routing without processing them independently. However, this is only done
17246 if &%headers_add%& and &%headers_remove%& are unset.
17247
17248
17249
17250
17251 .section "Routing rules in route_list" "SECID120"
17252 The value of &%route_list%& is a string consisting of a sequence of routing
17253 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
17254 entered as two semicolons. Alternatively, the list separator can be changed as
17255 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
17256 Empty rules are ignored. The format of each rule is
17257 .display
17258 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
17259 .endd
17260 The following example contains two rules, each with a simple domain pattern and
17261 no options:
17262 .code
17263 route_list = \
17264   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
17265   thes.ref.example  mail-3.ref.example:mail-4.ref.example
17266 .endd
17267 The three parts of a rule are separated by white space. The pattern and the
17268 list of hosts can be enclosed in quotes if necessary, and if they are, the
17269 usual quoting rules apply. Each rule in a &%route_list%& must start with a
17270 single domain pattern, which is the only mandatory item in the rule. The
17271 pattern is in the same format as one item in a domain list (see section
17272 &<<SECTdomainlist>>&),
17273 except that it may not be the name of an interpolated file.
17274 That is, it may be wildcarded, or a regular expression, or a file or database
17275 lookup (with semicolons doubled, because of the use of semicolon as a separator
17276 in a &%route_list%&).
17277
17278 The rules in &%route_list%& are searched in order until one of the patterns
17279 matches the domain that is being routed. The list of hosts and then options are
17280 then used as described below. If there is no match, the router declines. When
17281 &%route_list%& is set, &%route_data%& must not be set.
17282
17283
17284
17285 .section "Routing rules in route_data" "SECID121"
17286 The use of &%route_list%& is convenient when there are only a small number of
17287 routing rules. For larger numbers, it is easier to use a file or database to
17288 hold the routing information, and use the &%route_data%& option instead.
17289 The value of &%route_data%& is a list of hosts, followed by (optional) options.
17290 Most commonly, &%route_data%& is set as a string that contains an
17291 expansion lookup. For example, suppose we place two routing rules in a file
17292 like this:
17293 .code
17294 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
17295 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
17296 .endd
17297 This data can be accessed by setting
17298 .code
17299 route_data = ${lookup{$domain}lsearch{/the/file/name}}
17300 .endd
17301 Failure of the lookup results in an empty string, causing the router to
17302 decline. However, you do not have to use a lookup in &%route_data%&. The only
17303 requirement is that the result of expanding the string is a list of hosts,
17304 possibly followed by options, separated by white space. The list of hosts must
17305 be enclosed in quotes if it contains white space.
17306
17307
17308
17309
17310 .section "Format of the list of hosts" "SECID122"
17311 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
17312 always separately expanded before use. If the expansion fails, the router
17313 declines. The result of the expansion must be a colon-separated list of names
17314 and/or IP addresses, optionally also including ports. The format of each item
17315 in the list is described in the next section. The list separator can be changed
17316 as described in section &<<SECTlistconstruct>>&.
17317
17318 If the list of hosts was obtained from a &%route_list%& item, the following
17319 variables are set during its expansion:
17320
17321 .ilist
17322 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
17323 If the domain was matched against a regular expression, the numeric variables
17324 &$1$&, &$2$&, etc. may be set. For example:
17325 .code
17326 route_list = ^domain(\d+)   host-$1.text.example
17327 .endd
17328 .next
17329 &$0$& is always set to the entire domain.
17330 .next
17331 &$1$& is also set when partial matching is done in a file lookup.
17332
17333 .next
17334 .vindex "&$value$&"
17335 If the pattern that matched the domain was a lookup item, the data that was
17336 looked up is available in the expansion variable &$value$&. For example:
17337 .code
17338 route_list = lsearch;;/some/file.routes  $value
17339 .endd
17340 .endlist
17341
17342 Note the doubling of the semicolon in the pattern that is necessary because
17343 semicolon is the default route list separator.
17344
17345
17346
17347 .section "Format of one host item" "SECTformatonehostitem"
17348 Each item in the list of hosts is either a host name or an IP address,
17349 optionally with an attached port number. When no port is given, an IP address
17350 is not enclosed in brackets. When a port is specified, it overrides the port
17351 specification on the transport. The port is separated from the name or address
17352 by a colon. This leads to some complications:
17353
17354 .ilist
17355 Because colon is the default separator for the list of hosts, either
17356 the colon that specifies a port must be doubled, or the list separator must
17357 be changed. The following two examples have the same effect:
17358 .code
17359 route_list = * "host1.tld::1225 : host2.tld::1226"
17360 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
17361 .endd
17362 .next
17363 When IPv6 addresses are involved, it gets worse, because they contain
17364 colons of their own. To make this case easier, it is permitted to
17365 enclose an IP address (either v4 or v6) in square brackets if a port
17366 number follows. For example:
17367 .code
17368 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
17369 .endd
17370 .endlist
17371
17372 .section "How the list of hosts is used" "SECThostshowused"
17373 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
17374 the hosts is tried, in the order specified, when carrying out the SMTP
17375 delivery. However, the order can be changed by setting the &%hosts_randomize%&
17376 option, either on the router (see section &<<SECTprioptman>>& above), or on the
17377 transport.
17378
17379 Hosts may be listed by name or by IP address. An unadorned name in the list of
17380 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
17381 interpreted as an indirection to a sublist of hosts obtained by looking up MX
17382 records in the DNS. For example:
17383 .code
17384 route_list = *  x.y.z:p.q.r/MX:e.f.g
17385 .endd
17386 If this feature is used with a port specifier, the port must come last. For
17387 example:
17388 .code
17389 route_list = *  dom1.tld/mx::1225
17390 .endd
17391 If the &%hosts_randomize%& option is set, the order of the items in the list is
17392 randomized before any lookups are done. Exim then scans the list; for any name
17393 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
17394 be an interface on the local host and the item is not the first in the list,
17395 Exim discards it and any subsequent items. If it is the first item, what
17396 happens is controlled by the
17397 .oindex "&%self%&" "in &(manualroute)& router"
17398 &%self%& option of the router.
17399
17400 A name on the list that is followed by &`/MX`& is replaced with the list of
17401 hosts obtained by looking up MX records for the name. This is always a DNS
17402 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
17403 below) are not relevant here. The order of these hosts is determined by the
17404 preference values in the MX records, according to the usual rules. Because
17405 randomizing happens before the MX lookup, it does not affect the order that is
17406 defined by MX preferences.
17407
17408 If the local host is present in the sublist obtained from MX records, but is
17409 not the most preferred host in that list, it and any equally or less
17410 preferred hosts are removed before the sublist is inserted into the main list.
17411
17412 If the local host is the most preferred host in the MX list, what happens
17413 depends on where in the original list of hosts the &`/MX`& item appears. If it
17414 is not the first item (that is, there are previous hosts in the main list),
17415 Exim discards this name and any subsequent items in the main list.
17416
17417 If the MX item is first in the list of hosts, and the local host is the
17418 most preferred host, what happens is controlled by the &%self%& option of the
17419 router.
17420
17421 DNS failures when lookup up the MX records are treated in the same way as DNS
17422 failures when looking up IP addresses: &%pass_on_timeout%& and
17423 &%host_find_failed%& are used when relevant.
17424
17425 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
17426 whether obtained from an MX lookup or not.
17427
17428
17429
17430 .section "How the options are used" "SECThowoptused"
17431 The options are a sequence of words; in practice no more than three are ever
17432 present. One of the words can be the name of a transport; this overrides the
17433 &%transport%& option on the router for this particular routing rule only. The
17434 other words (if present) control randomization of the list of hosts on a
17435 per-rule basis, and how the IP addresses of the hosts are to be found when
17436 routing to a remote transport. These options are as follows:
17437
17438 .ilist
17439 &%randomize%&: randomize the order of the hosts in this list, overriding the
17440 setting of &%hosts_randomize%& for this routing rule only.
17441 .next
17442 &%no_randomize%&: do not randomize the order of the hosts in this list,
17443 overriding the setting of &%hosts_randomize%& for this routing rule only.
17444 .next
17445 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
17446 find IP addresses. This function may ultimately cause a DNS lookup, but it may
17447 also look in &_/etc/hosts_& or other sources of information.
17448 .next
17449 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
17450 no address records are found. If there is a temporary DNS error (such as a
17451 timeout), delivery is deferred.
17452 .endlist
17453
17454 For example:
17455 .code
17456 route_list = domain1  host1:host2:host3  randomize bydns;\
17457              domain2  host4:host5
17458 .endd
17459 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
17460 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
17461 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
17462 or &[gethostbyname()]&, and the result of the lookup is the result of that
17463 call.
17464
17465 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
17466 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
17467 instead of TRY_AGAIN. That is why the default action is to try a DNS
17468 lookup first. Only if that gives a definite &"no such host"& is the local
17469 function called.
17470
17471
17472
17473 If no IP address for a host can be found, what happens is controlled by the
17474 &%host_find_failed%& option.
17475
17476 .vindex "&$host$&"
17477 When an address is routed to a local transport, IP addresses are not looked up.
17478 The host list is passed to the transport in the &$host$& variable.
17479
17480
17481
17482 .section "Manualroute examples" "SECID123"
17483 In some of the examples that follow, the presence of the &%remote_smtp%&
17484 transport, as defined in the default configuration file, is assumed:
17485
17486 .ilist
17487 .cindex "smart host" "example router"
17488 The &(manualroute)& router can be used to forward all external mail to a
17489 &'smart host'&. If you have set up, in the main part of the configuration, a
17490 named domain list that contains your local domains, for example:
17491 .code
17492 domainlist local_domains = my.domain.example
17493 .endd
17494 You can arrange for all other domains to be routed to a smart host by making
17495 your first router something like this:
17496 .code
17497 smart_route:
17498   driver = manualroute
17499   domains = !+local_domains
17500   transport = remote_smtp
17501   route_list = * smarthost.ref.example
17502 .endd
17503 This causes all non-local addresses to be sent to the single host
17504 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
17505 they are tried in order
17506 (but you can use &%hosts_randomize%& to vary the order each time).
17507 Another way of configuring the same thing is this:
17508 .code
17509 smart_route:
17510   driver = manualroute
17511   transport = remote_smtp
17512   route_list = !+local_domains  smarthost.ref.example
17513 .endd
17514 There is no difference in behaviour between these two routers as they stand.
17515 However, they behave differently if &%no_more%& is added to them. In the first
17516 example, the router is skipped if the domain does not match the &%domains%&
17517 precondition; the following router is always tried. If the router runs, it
17518 always matches the domain and so can never decline. Therefore, &%no_more%&
17519 would have no effect. In the second case, the router is never skipped; it
17520 always runs. However, if it doesn't match the domain, it declines. In this case
17521 &%no_more%& would prevent subsequent routers from running.
17522
17523 .next
17524 .cindex "mail hub example"
17525 A &'mail hub'& is a host which receives mail for a number of domains via MX
17526 records in the DNS and delivers it via its own private routing mechanism. Often
17527 the final destinations are behind a firewall, with the mail hub being the one
17528 machine that can connect to machines both inside and outside the firewall. The
17529 &(manualroute)& router is usually used on a mail hub to route incoming messages
17530 to the correct hosts. For a small number of domains, the routing can be inline,
17531 using the &%route_list%& option, but for a larger number a file or database
17532 lookup is easier to manage.
17533
17534 If the domain names are in fact the names of the machines to which the mail is
17535 to be sent by the mail hub, the configuration can be quite simple. For
17536 example:
17537 .code
17538 hub_route:
17539   driver = manualroute
17540   transport = remote_smtp
17541   route_list = *.rhodes.tvs.example  $domain
17542 .endd
17543 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
17544 whose names are the same as the mail domains. A similar approach can be taken
17545 if the host name can be obtained from the domain name by a string manipulation
17546 that the expansion facilities can handle. Otherwise, a lookup based on the
17547 domain can be used to find the host:
17548 .code
17549 through_firewall:
17550   driver = manualroute
17551   transport = remote_smtp
17552   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
17553 .endd
17554 The result of the lookup must be the name or IP address of the host (or
17555 hosts) to which the address is to be routed. If the lookup fails, the route
17556 data is empty, causing the router to decline. The address then passes to the
17557 next router.
17558
17559 .next
17560 .cindex "batched SMTP output example"
17561 .cindex "SMTP" "batched outgoing; example"
17562 You can use &(manualroute)& to deliver messages to pipes or files in batched
17563 SMTP format for onward transportation by some other means. This is one way of
17564 storing mail for a dial-up host when it is not connected. The route list entry
17565 can be as simple as a single domain name in a configuration like this:
17566 .code
17567 save_in_file:
17568   driver = manualroute
17569   transport = batchsmtp_appendfile
17570   route_list = saved.domain.example
17571 .endd
17572 though often a pattern is used to pick up more than one domain. If there are
17573 several domains or groups of domains with different transport requirements,
17574 different transports can be listed in the routing information:
17575 .code
17576 save_in_file:
17577   driver = manualroute
17578   route_list = \
17579     *.saved.domain1.example  $domain  batch_appendfile; \
17580     *.saved.domain2.example  \
17581       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
17582       batch_pipe
17583 .endd
17584 .vindex "&$domain$&"
17585 .vindex "&$host$&"
17586 The first of these just passes the domain in the &$host$& variable, which
17587 doesn't achieve much (since it is also in &$domain$&), but the second does a
17588 file lookup to find a value to pass, causing the router to decline to handle
17589 the address if the lookup fails.
17590
17591 .next
17592 .cindex "UUCP" "example of router for"
17593 Routing mail directly to UUCP software is a specific case of the use of
17594 &(manualroute)& in a gateway to another mail environment. This is an example of
17595 one way it can be done:
17596 .code
17597 # Transport
17598 uucp:
17599   driver = pipe
17600   user = nobody
17601   command = /usr/local/bin/uux -r - \
17602     ${substr_-5:$host}!rmail ${local_part}
17603   return_fail_output = true
17604
17605 # Router
17606 uucphost:
17607   transport = uucp
17608   driver = manualroute
17609   route_data = \
17610     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
17611 .endd
17612 The file &_/usr/local/exim/uucphosts_& contains entries like
17613 .code
17614 darksite.ethereal.example:           darksite.UUCP
17615 .endd
17616 It can be set up more simply without adding and removing &".UUCP"& but this way
17617 makes clear the distinction between the domain name
17618 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
17619 .endlist
17620 .ecindex IIDmanrou1
17621 .ecindex IIDmanrou2
17622
17623
17624
17625
17626
17627
17628
17629
17630 . ////////////////////////////////////////////////////////////////////////////
17631 . ////////////////////////////////////////////////////////////////////////////
17632
17633 .chapter "The queryprogram router" "CHAPdriverlast"
17634 .scindex IIDquerou1 "&(queryprogram)& router"
17635 .scindex IIDquerou2 "routers" "&(queryprogram)&"
17636 .cindex "routing" "by external program"
17637 The &(queryprogram)& router routes an address by running an external command
17638 and acting on its output. This is an expensive way to route, and is intended
17639 mainly for use in lightly-loaded systems, or for performing experiments.
17640 However, if it is possible to use the precondition options (&%domains%&,
17641 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
17642 be used in special cases, even on a busy host. There are the following private
17643 options:
17644 .cindex "options" "&(queryprogram)& router"
17645
17646 .option command queryprogram string&!! unset
17647 This option must be set. It specifies the command that is to be run. The
17648 command is split up into a command name and arguments, and then each is
17649 expanded separately (exactly as for a &(pipe)& transport, described in chapter
17650 &<<CHAPpipetransport>>&).
17651
17652
17653 .option command_group queryprogram string unset
17654 .cindex "gid (group id)" "in &(queryprogram)& router"
17655 This option specifies a gid to be set when running the command while routing an
17656 address for deliver. It must be set if &%command_user%& specifies a numerical
17657 uid. If it begins with a digit, it is interpreted as the numerical value of the
17658 gid. Otherwise it is looked up using &[getgrnam()]&.
17659
17660
17661 .option command_user queryprogram string unset
17662 .cindex "uid (user id)" "for &(queryprogram)&"
17663 This option must be set. It specifies the uid which is set when running the
17664 command while routing an address for delivery. If the value begins with a digit,
17665 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
17666 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
17667 not set, a value for the gid also.
17668
17669 &*Warning:*& Changing uid and gid is possible only when Exim is running as
17670 root, which it does during a normal delivery in a conventional configuration.
17671 However, when an address is being verified during message reception, Exim is
17672 usually running as the Exim user, not as root. If the &(queryprogram)& router
17673 is called from a non-root process, Exim cannot change uid or gid before running
17674 the command. In this circumstance the command runs under the current uid and
17675 gid.
17676
17677
17678 .option current_directory queryprogram string /
17679 This option specifies an absolute path which is made the current directory
17680 before running the command.
17681
17682
17683 .option timeout queryprogram time 1h
17684 If the command does not complete within the timeout period, its process group
17685 is killed and the message is frozen. A value of zero time specifies no
17686 timeout.
17687
17688
17689 The standard output of the command is connected to a pipe, which is read when
17690 the command terminates. It should consist of a single line of output,
17691 containing up to five fields, separated by white space. The maximum length of
17692 the line is 1023 characters. Longer lines are silently truncated. The first
17693 field is one of the following words (case-insensitive):
17694
17695 .ilist
17696 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
17697 below).
17698 .next
17699 &'Decline'&: the router declines; pass the address to the next router, unless
17700 &%no_more%& is set.
17701 .next
17702 &'Fail'&: routing failed; do not pass the address to any more routers. Any
17703 subsequent text on the line is an error message. If the router is run as part
17704 of address verification during an incoming SMTP message, the message is
17705 included in the SMTP response.
17706 .next
17707 &'Defer'&: routing could not be completed at this time; try again later. Any
17708 subsequent text on the line is an error message which is logged. It is not
17709 included in any SMTP response.
17710 .next
17711 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
17712 .next
17713 &'Pass'&: pass the address to the next router (or the router specified by
17714 &%pass_router%&), overriding &%no_more%&.
17715 .next
17716 &'Redirect'&: the message is redirected. The remainder of the line is a list of
17717 new addresses, which are routed independently, starting with the first router,
17718 or the router specified by &%redirect_router%&, if set.
17719 .endlist
17720
17721 When the first word is &'accept'&, the remainder of the line consists of a
17722 number of keyed data values, as follows (split into two lines here, to fit on
17723 the page):
17724 .code
17725 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
17726 LOOKUP=byname|bydns DATA=<text>
17727 .endd
17728 The data items can be given in any order, and all are optional. If no transport
17729 is included, the transport specified by the generic &%transport%& option is
17730 used. The list of hosts and the lookup type are needed only if the transport is
17731 an &(smtp)& transport that does not itself supply a list of hosts.
17732
17733 The format of the list of hosts is the same as for the &(manualroute)& router.
17734 As well as host names and IP addresses with optional port numbers, as described
17735 in section &<<SECTformatonehostitem>>&, it may contain names followed by
17736 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
17737 (see section &<<SECThostshowused>>&).
17738
17739 If the lookup type is not specified, Exim behaves as follows when trying to
17740 find an IP address for each host: First, a DNS lookup is done. If this yields
17741 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
17742 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
17743 result of the lookup is the result of that call.
17744
17745 .vindex "&$address_data$&"
17746 If the DATA field is set, its value is placed in the &$address_data$&
17747 variable. For example, this return line
17748 .code
17749 accept hosts=x1.y.example:x2.y.example data="rule1"
17750 .endd
17751 routes the address to the default transport, passing a list of two hosts. When
17752 the transport runs, the string &"rule1"& is in &$address_data$&.
17753 .ecindex IIDquerou1
17754 .ecindex IIDquerou2
17755
17756
17757
17758
17759 . ////////////////////////////////////////////////////////////////////////////
17760 . ////////////////////////////////////////////////////////////////////////////
17761
17762 .chapter "The redirect router" "CHAPredirect"
17763 .scindex IIDredrou1 "&(redirect)& router"
17764 .scindex IIDredrou2 "routers" "&(redirect)&"
17765 .cindex "alias file" "in a &(redirect)& router"
17766 .cindex "address redirection" "&(redirect)& router"
17767 The &(redirect)& router handles several kinds of address redirection. Its most
17768 common uses are for resolving local part aliases from a central alias file
17769 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
17770 files, but it has many other potential uses. The incoming address can be
17771 redirected in several different ways:
17772
17773 .ilist
17774 It can be replaced by one or more new addresses which are themselves routed
17775 independently.
17776 .next
17777 It can be routed to be delivered to a given file or directory.
17778 .next
17779 It can be routed to be delivered to a specified pipe command.
17780 .next
17781 It can cause an automatic reply to be generated.
17782 .next
17783 It can be forced to fail, optionally with a custom error message.
17784 .next
17785 It can be temporarily deferred, optionally with a custom message.
17786 .next
17787 It can be discarded.
17788 .endlist
17789
17790 The generic &%transport%& option must not be set for &(redirect)& routers.
17791 However, there are some private options which define transports for delivery to
17792 files and pipes, and for generating autoreplies. See the &%file_transport%&,
17793 &%pipe_transport%& and &%reply_transport%& descriptions below.
17794
17795
17796
17797 .section "Redirection data" "SECID124"
17798 The router operates by interpreting a text string which it obtains either by
17799 expanding the contents of the &%data%& option, or by reading the entire
17800 contents of a file whose name is given in the &%file%& option. These two
17801 options are mutually exclusive. The first is commonly used for handling system
17802 aliases, in a configuration like this:
17803 .code
17804 system_aliases:
17805   driver = redirect
17806   data = ${lookup{$local_part}lsearch{/etc/aliases}}
17807 .endd
17808 If the lookup fails, the expanded string in this example is empty. When the
17809 expansion of &%data%& results in an empty string, the router declines. A forced
17810 expansion failure also causes the router to decline; other expansion failures
17811 cause delivery to be deferred.
17812
17813 A configuration using &%file%& is commonly used for handling users'
17814 &_.forward_& files, like this:
17815 .code
17816 userforward:
17817   driver = redirect
17818   check_local_user
17819   file = $home/.forward
17820   no_verify
17821 .endd
17822 If the file does not exist, or causes no action to be taken (for example, it is
17823 empty or consists only of comments), the router declines. &*Warning*&: This
17824 is not the case when the file contains syntactically valid items that happen to
17825 yield empty addresses, for example, items containing only RFC 2822 address
17826 comments.
17827
17828
17829
17830 .section "Forward files and address verification" "SECID125"
17831 .cindex "address redirection" "while verifying"
17832 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
17833 &_.forward_& files, as in the example above. There are two reasons for this:
17834
17835 .ilist
17836 When Exim is receiving an incoming SMTP message from a remote host, it is
17837 running under the Exim uid, not as root. Exim is unable to change uid to read
17838 the file as the user, and it may not be able to read it as the Exim user. So in
17839 practice the router may not be able to operate.
17840 .next
17841 However, even when the router can operate, the existence of a &_.forward_& file
17842 is unimportant when verifying an address. What should be checked is whether the
17843 local part is a valid user name or not. Cutting out the redirection processing
17844 saves some resources.
17845 .endlist
17846
17847
17848
17849
17850
17851
17852 .section "Interpreting redirection data" "SECID126"
17853 .cindex "Sieve filter" "specifying in redirection data"
17854 .cindex "filter" "specifying in redirection data"
17855 The contents of the data string, whether obtained from &%data%& or &%file%&,
17856 can be interpreted in two different ways:
17857
17858 .ilist
17859 If the &%allow_filter%& option is set true, and the data begins with the text
17860 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
17861 &'filtering'& instructions in the form of an Exim or Sieve filter file,
17862 respectively. Details of the syntax and semantics of filter files are described
17863 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
17864 document is intended for use by end users.
17865 .next
17866 Otherwise, the data must be a comma-separated list of redirection items, as
17867 described in the next section.
17868 .endlist
17869
17870 When a message is redirected to a file (a &"mail folder"&), the file name given
17871 in a non-filter redirection list must always be an absolute path. A filter may
17872 generate a relative path &-- how this is handled depends on the transport's
17873 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
17874 for the &(appendfile)& transport.
17875
17876
17877
17878 .section "Items in a non-filter redirection list" "SECTitenonfilred"
17879 .cindex "address redirection" "non-filter list items"
17880 When the redirection data is not an Exim or Sieve filter, for example, if it
17881 comes from a conventional alias or forward file, it consists of a list of
17882 addresses, file names, pipe commands, or certain special items (see section
17883 &<<SECTspecitredli>>& below). The special items can be individually enabled or
17884 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
17885 depending on their default values. The items in the list are separated by
17886 commas or newlines.
17887 If a comma is required in an item, the entire item must be enclosed in double
17888 quotes.
17889
17890 Lines starting with a # character are comments, and are ignored, and # may
17891 also appear following a comma, in which case everything between the # and the
17892 next newline character is ignored.
17893
17894 If an item is entirely enclosed in double quotes, these are removed. Otherwise
17895 double quotes are retained because some forms of mail address require their use
17896 (but never to enclose the entire address). In the following description,
17897 &"item"& refers to what remains after any surrounding double quotes have been
17898 removed.
17899
17900 .vindex "&$local_part$&"
17901 &*Warning*&: If you use an Exim expansion to construct a redirection address,
17902 and the expansion contains a reference to &$local_part$&, you should make use
17903 of the &%quote_local_part%& expansion operator, in case the local part contains
17904 special characters. For example, to redirect all mail for the domain
17905 &'obsolete.example'&, retaining the existing local part, you could use this
17906 setting:
17907 .code
17908 data = ${quote_local_part:$local_part}@newdomain.example
17909 .endd
17910
17911
17912 .section "Redirecting to a local mailbox" "SECTredlocmai"
17913 .cindex "routing" "loops in"
17914 .cindex "loop" "while routing, avoidance of"
17915 .cindex "address redirection" "to local mailbox"
17916 A redirection item may safely be the same as the address currently under
17917 consideration. This does not cause a routing loop, because a router is
17918 automatically skipped if any ancestor of the address that is being processed
17919 is the same as the current address and was processed by the current router.
17920 Such an address is therefore passed to the following routers, so it is handled
17921 as if there were no redirection. When making this loop-avoidance test, the
17922 complete local part, including any prefix or suffix, is used.
17923
17924 .cindex "address redirection" "local part without domain"
17925 Specifying the same local part without a domain is a common usage in personal
17926 filter files when the user wants to have messages delivered to the local
17927 mailbox and also forwarded elsewhere. For example, the user whose login is
17928 &'cleo'& might have a &_.forward_& file containing this:
17929 .code
17930 cleo, cleopatra@egypt.example
17931 .endd
17932 .cindex "backslash in alias file"
17933 .cindex "alias file" "backslash in"
17934 For compatibility with other MTAs, such unqualified local parts may be
17935 preceded by &"\"&, but this is not a requirement for loop prevention. However,
17936 it does make a difference if more than one domain is being handled
17937 synonymously.
17938
17939 If an item begins with &"\"& and the rest of the item parses as a valid RFC
17940 2822 address that does not include a domain, the item is qualified using the
17941 domain of the incoming address. In the absence of a leading &"\"&, unqualified
17942 addresses are qualified using the value in &%qualify_recipient%&, but you can
17943 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
17944
17945 Care must be taken if there are alias names for local users.
17946 Consider an MTA handling a single local domain where the system alias file
17947 contains:
17948 .code
17949 Sam.Reman: spqr
17950 .endd
17951 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
17952 messages in the local mailbox, and also forward copies elsewhere. He creates
17953 this forward file:
17954 .code
17955 Sam.Reman, spqr@reme.elsewhere.example
17956 .endd
17957 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
17958 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
17959 second time round, because it has previously routed it,
17960 and the following routers presumably cannot handle the alias. The forward file
17961 should really contain
17962 .code
17963 spqr, spqr@reme.elsewhere.example
17964 .endd
17965 but because this is such a common error, the &%check_ancestor%& option (see
17966 below) exists to provide a way to get round it. This is normally set on a
17967 &(redirect)& router that is handling users' &_.forward_& files.
17968
17969
17970
17971 .section "Special items in redirection lists" "SECTspecitredli"
17972 In addition to addresses, the following types of item may appear in redirection
17973 lists (that is, in non-filter redirection data):
17974
17975 .ilist
17976 .cindex "pipe" "in redirection list"
17977 .cindex "address redirection" "to pipe"
17978 An item is treated as a pipe command if it begins with &"|"& and does not parse
17979 as a valid RFC 2822 address that includes a domain. A transport for running the
17980 command must be specified by the &%pipe_transport%& option.
17981 Normally, either the router or the transport specifies a user and a group under
17982 which to run the delivery. The default is to use the Exim user and group.
17983
17984 Single or double quotes can be used for enclosing the individual arguments of
17985 the pipe command; no interpretation of escapes is done for single quotes. If
17986 the command contains a comma character, it is necessary to put the whole item
17987 in double quotes, for example:
17988 .code
17989 "|/some/command ready,steady,go"
17990 .endd
17991 since items in redirection lists are terminated by commas. Do not, however,
17992 quote just the command. An item such as
17993 .code
17994 |"/some/command ready,steady,go"
17995 .endd
17996 is interpreted as a pipe with a rather strange command name, and no arguments.
17997
17998 .next
17999 .cindex "file" "in redirection list"
18000 .cindex "address redirection" "to file"
18001 An item is interpreted as a path name if it begins with &"/"& and does not
18002 parse as a valid RFC 2822 address that includes a domain. For example,
18003 .code
18004 /home/world/minbari
18005 .endd
18006 is treated as a file name, but
18007 .code
18008 /s=molari/o=babylon/@x400gate.way
18009 .endd
18010 is treated as an address. For a file name, a transport must be specified using
18011 the &%file_transport%& option. However, if the generated path name ends with a
18012 forward slash character, it is interpreted as a directory name rather than a
18013 file name, and &%directory_transport%& is used instead.
18014
18015 Normally, either the router or the transport specifies a user and a group under
18016 which to run the delivery. The default is to use the Exim user and group.
18017
18018 .cindex "&_/dev/null_&"
18019 However, if a redirection item is the path &_/dev/null_&, delivery to it is
18020 bypassed at a high level, and the log entry shows &"**bypassed**"&
18021 instead of a transport name. In this case the user and group are not used.
18022
18023 .next
18024 .cindex "included address list"
18025 .cindex "address redirection" "included external list"
18026 If an item is of the form
18027 .code
18028 :include:<path name>
18029 .endd
18030 a list of further items is taken from the given file and included at that
18031 point. &*Note*&: Such a file can not be a filter file; it is just an
18032 out-of-line addition to the list. The items in the included list are separated
18033 by commas or newlines and are not subject to expansion. If this is the first
18034 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
18035 the alias name. This example is incorrect:
18036 .code
18037 list1    :include:/opt/lists/list1
18038 .endd
18039 It must be given as
18040 .code
18041 list1:   :include:/opt/lists/list1
18042 .endd
18043 .next
18044 .cindex "address redirection" "to black hole"
18045 Sometimes you want to throw away mail to a particular local part. Making the
18046 &%data%& option expand to an empty string does not work, because that causes
18047 the router to decline. Instead, the alias item
18048 .cindex "black hole"
18049 .cindex "abandoning mail"
18050 &':blackhole:'& can be used. It does what its name implies. No delivery is
18051 done, and no error message is generated. This has the same effect as specifing
18052 &_/dev/null_& as a destination, but it can be independently disabled.
18053
18054 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
18055 delivery is done for the original local part, even if other redirection items
18056 are present. If you are generating a multi-item list (for example, by reading a
18057 database) and need the ability to provide a no-op item, you must use
18058 &_/dev/null_&.
18059
18060 .next
18061 .cindex "delivery" "forcing failure"
18062 .cindex "delivery" "forcing deferral"
18063 .cindex "failing delivery" "forcing"
18064 .cindex "deferred delivery, forcing"
18065 .cindex "customizing" "failure message"
18066 An attempt to deliver a particular address can be deferred or forced to fail by
18067 redirection items of the form
18068 .code
18069 :defer:
18070 :fail:
18071 .endd
18072 respectively. When a redirection list contains such an item, it applies
18073 to the entire redirection; any other items in the list are ignored. Any
18074 text following &':fail:'& or &':defer:'& is placed in the error text
18075 associated with the failure. For example, an alias file might contain:
18076 .code
18077 X.Employee:  :fail: Gone away, no forwarding address
18078 .endd
18079 In the case of an address that is being verified from an ACL or as the subject
18080 of a
18081 .cindex "VRFY" "error text, display of"
18082 VRFY command, the text is included in the SMTP error response by
18083 default.
18084 .cindex "EXPN" "error text, display of"
18085 The text is not included in the response to an EXPN command. In non-SMTP cases
18086 the text is included in the error message that Exim generates.
18087
18088 .cindex "SMTP" "error codes"
18089 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
18090 &':fail:'&. However, if the message starts with three digits followed by a
18091 space, optionally followed by an extended code of the form &'n.n.n'&, also
18092 followed by a space, and the very first digit is the same as the default error
18093 code, the code from the message is used instead. If the very first digit is
18094 incorrect, a panic error is logged, and the default code is used. You can
18095 suppress the use of the supplied code in a redirect router by setting the
18096 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
18097 ignored.
18098
18099 .vindex "&$acl_verify_message$&"
18100 In an ACL, an explicitly provided message overrides the default, but the
18101 default message is available in the variable &$acl_verify_message$& and can
18102 therefore be included in a custom message if this is desired.
18103
18104 Normally the error text is the rest of the redirection list &-- a comma does
18105 not terminate it &-- but a newline does act as a terminator. Newlines are not
18106 normally present in alias expansions. In &(lsearch)& lookups they are removed
18107 as part of the continuation process, but they may exist in other kinds of
18108 lookup and in &':include:'& files.
18109
18110 During routing for message delivery (as opposed to verification), a redirection
18111 containing &':fail:'& causes an immediate failure of the incoming address,
18112 whereas &':defer:'& causes the message to remain on the queue so that a
18113 subsequent delivery attempt can happen at a later time. If an address is
18114 deferred for too long, it will ultimately fail, because the normal retry
18115 rules still apply.
18116
18117 .next
18118 .cindex "alias file" "exception to default"
18119 Sometimes it is useful to use a single-key search type with a default (see
18120 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
18121 for exceptions to the default. These can be handled by aliasing them to
18122 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
18123 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
18124 results in an empty redirection list has the same effect.
18125 .endlist
18126
18127
18128 .section "Duplicate addresses" "SECTdupaddr"
18129 .cindex "duplicate addresses"
18130 .cindex "address duplicate, discarding"
18131 .cindex "pipe" "duplicated"
18132 Exim removes duplicate addresses from the list to which it is delivering, so as
18133 to deliver just one copy to each address. This does not apply to deliveries
18134 routed to pipes by different immediate parent addresses, but an indirect
18135 aliasing scheme of the type
18136 .code
18137 pipe:       |/some/command $local_part
18138 localpart1: pipe
18139 localpart2: pipe
18140 .endd
18141 does not work with a message that is addressed to both local parts, because
18142 when the second is aliased to the intermediate local part &"pipe"& it gets
18143 discarded as being the same as a previously handled address. However, a scheme
18144 such as
18145 .code
18146 localpart1: |/some/command $local_part
18147 localpart2: |/some/command $local_part
18148 .endd
18149 does result in two different pipe deliveries, because the immediate parents of
18150 the pipes are distinct.
18151
18152
18153
18154 .section "Repeated redirection expansion" "SECID128"
18155 .cindex "repeated redirection expansion"
18156 .cindex "address redirection" "repeated for each delivery attempt"
18157 When a message cannot be delivered to all of its recipients immediately,
18158 leading to two or more delivery attempts, redirection expansion is carried out
18159 afresh each time for those addresses whose children were not all previously
18160 delivered. If redirection is being used as a mailing list, this can lead to new
18161 members of the list receiving copies of old messages. The &%one_time%& option
18162 can be used to avoid this.
18163
18164
18165 .section "Errors in redirection lists" "SECID129"
18166 .cindex "address redirection" "errors"
18167 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
18168 error is skipped, and an entry is written to the main log. This may be useful
18169 for mailing lists that are automatically managed. Otherwise, if an error is
18170 detected while generating the list of new addresses, the original address is
18171 deferred. See also &%syntax_errors_to%&.
18172
18173
18174
18175 .section "Private options for the redirect router" "SECID130"
18176
18177 .cindex "options" "&(redirect)& router"
18178 The private options for the &(redirect)& router are as follows:
18179
18180
18181 .option allow_defer redirect boolean false
18182 Setting this option allows the use of &':defer:'& in non-filter redirection
18183 data, or the &%defer%& command in an Exim filter file.
18184
18185
18186 .option allow_fail redirect boolean false
18187 .cindex "failing delivery" "from filter"
18188 If this option is true, the &':fail:'& item can be used in a redirection list,
18189 and the &%fail%& command may be used in an Exim filter file.
18190
18191
18192 .option allow_filter redirect boolean false
18193 .cindex "filter" "enabling use of"
18194 .cindex "Sieve filter" "enabling use of"
18195 Setting this option allows Exim to interpret redirection data that starts with
18196 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
18197 are some features of Exim filter files that some administrators may wish to
18198 lock out; see the &%forbid_filter_%&&'xxx'& options below.
18199
18200 It is also possible to lock out Exim filters or Sieve filters while allowing
18201 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
18202
18203
18204 The filter is run using the uid and gid set by the generic &%user%& and
18205 &%group%& options. These take their defaults from the password data if
18206 &%check_local_user%& is set, so in the normal case of users' personal filter
18207 files, the filter is run as the relevant user. When &%allow_filter%& is set
18208 true, Exim insists that either &%check_local_user%& or &%user%& is set.
18209
18210
18211
18212 .option allow_freeze redirect boolean false
18213 .cindex "freezing messages" "allowing in filter"
18214 Setting this option allows the use of the &%freeze%& command in an Exim filter.
18215 This command is more normally encountered in system filters, and is disabled by
18216 default for redirection filters because it isn't something you usually want to
18217 let ordinary users do.
18218
18219
18220
18221 .option check_ancestor redirect boolean false
18222 This option is concerned with handling generated addresses that are the same
18223 as some address in the list of redirection ancestors of the current address.
18224 Although it is turned off by default in the code, it is set in the default
18225 configuration file for handling users' &_.forward_& files. It is recommended
18226 for this use of the &(redirect)& router.
18227
18228 When &%check_ancestor%& is set, if a generated address (including the domain)
18229 is the same as any ancestor of the current address, it is replaced by a copy of
18230 the current address. This helps in the case where local part A is aliased to B,
18231 and B has a &_.forward_& file pointing back to A. For example, within a single
18232 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
18233 &_&~jb/.forward_& contains:
18234 .code
18235 \Joe.Bloggs, <other item(s)>
18236 .endd
18237 Without the &%check_ancestor%& setting, either local part (&"jb"& or
18238 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
18239 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
18240 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
18241 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
18242 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
18243 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
18244 original address. See also the &%repeat_use%& option below.
18245
18246
18247 .option check_group redirect boolean "see below"
18248 When the &%file%& option is used, the group owner of the file is checked only
18249 when this option is set. The permitted groups are those listed in the
18250 &%owngroups%& option, together with the user's default group if
18251 &%check_local_user%& is set. If the file has the wrong group, routing is
18252 deferred. The default setting for this option is true if &%check_local_user%&
18253 is set and the &%modemask%& option permits the group write bit, or if the
18254 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
18255
18256
18257
18258 .option check_owner redirect boolean "see below"
18259 When the &%file%& option is used, the owner of the file is checked only when
18260 this option is set. If &%check_local_user%& is set, the local user is
18261 permitted; otherwise the owner must be one of those listed in the &%owners%&
18262 option. The default value for this option is true if &%check_local_user%& or
18263 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
18264
18265
18266 .option data redirect string&!! unset
18267 This option is mutually exclusive with &%file%&. One or other of them must be
18268 set, but not both. The contents of &%data%& are expanded, and then used as the
18269 list of forwarding items, or as a set of filtering instructions. If the
18270 expansion is forced to fail, or the result is an empty string or a string that
18271 has no effect (consists entirely of comments), the router declines.
18272
18273 When filtering instructions are used, the string must begin with &"#Exim
18274 filter"&, and all comments in the string, including this initial one, must be
18275 terminated with newline characters. For example:
18276 .code
18277 data = #Exim filter\n\
18278        if $h_to: contains Exim then save $home/mail/exim endif
18279 .endd
18280 If you are reading the data from a database where newlines cannot be included,
18281 you can use the &${sg}$& expansion item to turn the escape string of your
18282 choice into a newline.
18283
18284
18285 .option directory_transport redirect string&!! unset
18286 A &(redirect)& router sets up a direct delivery to a directory when a path name
18287 ending with a slash is specified as a new &"address"&. The transport used is
18288 specified by this option, which, after expansion, must be the name of a
18289 configured transport. This should normally be an &(appendfile)& transport.
18290
18291
18292 .option file redirect string&!! unset
18293 This option specifies the name of a file that contains the redirection data. It
18294 is mutually exclusive with the &%data%& option. The string is expanded before
18295 use; if the expansion is forced to fail, the router declines. Other expansion
18296 failures cause delivery to be deferred. The result of a successful expansion
18297 must be an absolute path. The entire file is read and used as the redirection
18298 data. If the data is an empty string or a string that has no effect (consists
18299 entirely of comments), the router declines.
18300
18301 .cindex "NFS" "checking for file existence"
18302 If the attempt to open the file fails with a &"does not exist"& error, Exim
18303 runs a check on the containing directory,
18304 unless &%ignore_enotdir%& is true (see below).
18305 If the directory does not appear to exist, delivery is deferred. This can
18306 happen when users' &_.forward_& files are in NFS-mounted directories, and there
18307 is a mount problem. If the containing directory does exist, but the file does
18308 not, the router declines.
18309
18310
18311 .option file_transport redirect string&!! unset
18312 .vindex "&$address_file$&"
18313 A &(redirect)& router sets up a direct delivery to a file when a path name not
18314 ending in a slash is specified as a new &"address"&. The transport used is
18315 specified by this option, which, after expansion, must be the name of a
18316 configured transport. This should normally be an &(appendfile)& transport. When
18317 it is running, the file name is in &$address_file$&.
18318
18319
18320 .option filter_prepend_home redirect boolean true
18321 When this option is true, if a &(save)& command in an Exim filter specifies a
18322 relative path, and &$home$& is defined, it is automatically prepended to the
18323 relative path. If this option is set false, this action does not happen. The
18324 relative path is then passed to the transport unmodified.
18325
18326
18327 .option forbid_blackhole redirect boolean false
18328 If this option is true, the &':blackhole:'& item may not appear in a
18329 redirection list.
18330
18331
18332 .option forbid_exim_filter redirect boolean false
18333 If this option is set true, only Sieve filters are permitted when
18334 &%allow_filter%& is true.
18335
18336
18337
18338
18339 .option forbid_file redirect boolean false
18340 .cindex "delivery" "to file; forbidding"
18341 .cindex "Sieve filter" "forbidding delivery to a file"
18342 .cindex "Sieve filter" "&""keep""& facility; disabling"
18343 If this option is true, this router may not generate a new address that
18344 specifies delivery to a local file or directory, either from a filter or from a
18345 conventional forward file. This option is forced to be true if &%one_time%& is
18346 set. It applies to Sieve filters as well as to Exim filters, but if true, it
18347 locks out the Sieve's &"keep"& facility.
18348
18349
18350 .option forbid_filter_dlfunc redirect boolean false
18351 .cindex "filter" "locking out certain features"
18352 If this option is true, string expansions in Exim filters are not allowed to
18353 make use of the &%dlfunc%& expansion facility to run dynamically loaded
18354 functions.
18355
18356 .option forbid_filter_existstest redirect boolean false
18357 .cindex "expansion" "statting a file"
18358 If this option is true, string expansions in Exim filters are not allowed to
18359 make use of the &%exists%& condition or the &%stat%& expansion item.
18360
18361 .option forbid_filter_logwrite redirect boolean false
18362 If this option is true, use of the logging facility in Exim filters is not
18363 permitted. Logging is in any case available only if the filter is being run
18364 under some unprivileged uid (which is normally the case for ordinary users'
18365 &_.forward_& files).
18366
18367
18368 .option forbid_filter_lookup redirect boolean false
18369 If this option is true, string expansions in Exim filter files are not allowed
18370 to make use of &%lookup%& items.
18371
18372
18373 .option forbid_filter_perl redirect boolean false
18374 This option has an effect only if Exim is built with embedded Perl support. If
18375 it is true, string expansions in Exim filter files are not allowed to make use
18376 of the embedded Perl support.
18377
18378
18379 .option forbid_filter_readfile redirect boolean false
18380 If this option is true, string expansions in Exim filter files are not allowed
18381 to make use of &%readfile%& items.
18382
18383
18384 .option forbid_filter_readsocket redirect boolean false
18385 If this option is true, string expansions in Exim filter files are not allowed
18386 to make use of &%readsocket%& items.
18387
18388
18389 .option forbid_filter_reply redirect boolean false
18390 If this option is true, this router may not generate an automatic reply
18391 message. Automatic replies can be generated only from Exim or Sieve filter
18392 files, not from traditional forward files. This option is forced to be true if
18393 &%one_time%& is set.
18394
18395
18396 .option forbid_filter_run redirect boolean false
18397 If this option is true, string expansions in Exim filter files are not allowed
18398 to make use of &%run%& items.
18399
18400
18401 .option forbid_include redirect boolean false
18402 If this option is true, items of the form
18403 .code
18404 :include:<path name>
18405 .endd
18406 are not permitted in non-filter redirection lists.
18407
18408
18409 .option forbid_pipe redirect boolean false
18410 .cindex "delivery" "to pipe; forbidding"
18411 If this option is true, this router may not generate a new address which
18412 specifies delivery to a pipe, either from an Exim filter or from a conventional
18413 forward file. This option is forced to be true if &%one_time%& is set.
18414
18415
18416 .option forbid_sieve_filter redirect boolean false
18417 If this option is set true, only Exim filters are permitted when
18418 &%allow_filter%& is true.
18419
18420
18421 .cindex "SMTP" "error codes"
18422 .option forbid_smtp_code redirect boolean false
18423 If this option is set true, any SMTP error codes that are present at the start
18424 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
18425 the default codes (451 and 550, respectively) are always used.
18426
18427
18428
18429
18430 .option hide_child_in_errmsg redirect boolean false
18431 .cindex "bounce message" "redirection details; suppressing"
18432 If this option is true, it prevents Exim from quoting a child address if it
18433 generates a bounce or delay message for it. Instead it says &"an address
18434 generated from <&'the top level address'&>"&. Of course, this applies only to
18435 bounces generated locally. If a message is forwarded to another host, &'its'&
18436 bounce may well quote the generated address.
18437
18438
18439 .option ignore_eacces redirect boolean false
18440 .cindex "EACCES"
18441 If this option is set and an attempt to open a redirection file yields the
18442 EACCES error (permission denied), the &(redirect)& router behaves as if the
18443 file did not exist.
18444
18445
18446 .option ignore_enotdir redirect boolean false
18447 .cindex "ENOTDIR"
18448 If this option is set and an attempt to open a redirection file yields the
18449 ENOTDIR error (something on the path is not a directory), the &(redirect)&
18450 router behaves as if the file did not exist.
18451
18452 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
18453 router that has the &%file%& option set discovers that the file does not exist
18454 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
18455 against unmounted NFS directories. If the parent can not be statted, delivery
18456 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
18457 is set, because that option tells Exim to ignore &"something on the path is not
18458 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
18459 that some operating systems give ENOENT where others give ENOTDIR.
18460
18461
18462
18463 .option include_directory redirect string unset
18464 If this option is set, the path names of any &':include:'& items in a
18465 redirection list must start with this directory.
18466
18467
18468 .option modemask redirect "octal integer" 022
18469 This specifies mode bits which must not be set for a file specified by the
18470 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
18471
18472
18473 .option one_time redirect boolean false
18474 .cindex "one-time aliasing/forwarding expansion"
18475 .cindex "alias file" "one-time expansion"
18476 .cindex "forward file" "one-time expansion"
18477 .cindex "mailing lists" "one-time expansion"
18478 .cindex "address redirection" "one-time expansion"
18479 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
18480 files each time it tries to deliver a message causes a problem when one or more
18481 of the generated addresses fails be delivered at the first attempt. The problem
18482 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
18483 but of what happens when the redirection list changes during the time that the
18484 message is on Exim's queue. This is particularly true in the case of mailing
18485 lists, where new subscribers might receive copies of messages that were posted
18486 before they subscribed.
18487
18488 If &%one_time%& is set and any addresses generated by the router fail to
18489 deliver at the first attempt, the failing addresses are added to the message as
18490 &"top level"& addresses, and the parent address that generated them is marked
18491 &"delivered"&. Thus, redirection does not happen again at the next delivery
18492 attempt.
18493
18494 &*Warning 1*&: Any header line addition or removal that is specified by this
18495 router would be lost if delivery did not succeed at the first attempt. For this
18496 reason, the &%headers_add%& and &%headers_remove%& generic options are not
18497 permitted when &%one_time%& is set.
18498
18499 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
18500 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
18501 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
18502
18503 &*Warning 3*&: The &%unseen%& generic router option may not be set with
18504 &%one_time%&.
18505
18506 The original top-level address is remembered with each of the generated
18507 addresses, and is output in any log messages. However, any intermediate parent
18508 addresses are not recorded. This makes a difference to the log only if
18509 &%all_parents%& log selector is set. It is expected that &%one_time%& will
18510 typically be used for mailing lists, where there is normally just one level of
18511 expansion.
18512
18513
18514 .option owners redirect "string list" unset
18515 .cindex "ownership" "alias file"
18516 .cindex "ownership" "forward file"
18517 .cindex "alias file" "ownership"
18518 .cindex "forward file" "ownership"
18519 This specifies a list of permitted owners for the file specified by &%file%&.
18520 This list is in addition to the local user when &%check_local_user%& is set.
18521 See &%check_owner%& above.
18522
18523
18524 .option owngroups redirect "string list" unset
18525 This specifies a list of permitted groups for the file specified by &%file%&.
18526 The list is in addition to the local user's primary group when
18527 &%check_local_user%& is set. See &%check_group%& above.
18528
18529
18530 .option pipe_transport redirect string&!! unset
18531 .vindex "&$address_pipe$&"
18532 A &(redirect)& router sets up a direct delivery to a pipe when a string
18533 starting with a vertical bar character is specified as a new &"address"&. The
18534 transport used is specified by this option, which, after expansion, must be the
18535 name of a configured transport. This should normally be a &(pipe)& transport.
18536 When the transport is run, the pipe command is in &$address_pipe$&.
18537
18538
18539 .option qualify_domain redirect string&!! unset
18540 .vindex "&$qualify_recipient$&"
18541 If this option is set, and an unqualified address (one without a domain) is
18542 generated, and that address would normally be qualified by the global setting
18543 in &%qualify_recipient%&, it is instead qualified with the domain specified by
18544 expanding this string. If the expansion fails, the router declines. If you want
18545 to revert to the default, you can have the expansion generate
18546 &$qualify_recipient$&.
18547
18548 This option applies to all unqualified addresses generated by Exim filters,
18549 but for traditional &_.forward_& files, it applies only to addresses that are
18550 not preceded by a backslash. Sieve filters cannot generate unqualified
18551 addresses.
18552
18553 .option qualify_preserve_domain redirect boolean false
18554 .cindex "domain" "in redirection; preserving"
18555 .cindex "preserving domain in redirection"
18556 .cindex "address redirection" "domain; preserving"
18557 If this option is set, the router's local &%qualify_domain%& option must not be
18558 set (a configuration error occurs if it is). If an unqualified address (one
18559 without a domain) is generated, it is qualified with the domain of the parent
18560 address (the immediately preceding ancestor) instead of the global
18561 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
18562 this applies whether or not the address is preceded by a backslash.
18563
18564
18565 .option repeat_use redirect boolean true
18566 If this option is set false, the router is skipped for a child address that has
18567 any ancestor that was routed by this router. This test happens before any of
18568 the other preconditions are tested. Exim's default anti-looping rules skip
18569 only when the ancestor is the same as the current address. See also
18570 &%check_ancestor%& above and the generic &%redirect_router%& option.
18571
18572
18573 .option reply_transport redirect string&!! unset
18574 A &(redirect)& router sets up an automatic reply when a &%mail%& or
18575 &%vacation%& command is used in a filter file. The transport used is specified
18576 by this option, which, after expansion, must be the name of a configured
18577 transport. This should normally be an &(autoreply)& transport. Other transports
18578 are unlikely to do anything sensible or useful.
18579
18580
18581 .option rewrite redirect boolean true
18582 .cindex "address redirection" "disabling rewriting"
18583 If this option is set false, addresses generated by the router are not
18584 subject to address rewriting. Otherwise, they are treated like new addresses
18585 and are rewritten according to the global rewriting rules.
18586
18587
18588 .option sieve_subaddress redirect string&!! unset
18589 The value of this option is passed to a Sieve filter to specify the
18590 :subaddress part of an address.
18591
18592 .option sieve_useraddress redirect string&!! unset
18593 The value of this option is passed to a Sieve filter to specify the :user part
18594 of an address. However, if it is unset, the entire original local part
18595 (including any prefix or suffix) is used for :user.
18596
18597
18598 .option sieve_vacation_directory redirect string&!! unset
18599 .cindex "Sieve filter" "vacation directory"
18600 To enable the &"vacation"& extension for Sieve filters, you must set
18601 &%sieve_vacation_directory%& to the directory where vacation databases are held
18602 (do not put anything else in that directory), and ensure that the
18603 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
18604 needs their own directory; Exim will create it if necessary.
18605
18606
18607
18608 .option skip_syntax_errors redirect boolean false
18609 .cindex "forward file" "broken"
18610 .cindex "address redirection" "broken files"
18611 .cindex "alias file" "broken"
18612 .cindex "broken alias or forward files"
18613 .cindex "ignoring faulty addresses"
18614 .cindex "skipping faulty addresses"
18615 .cindex "error" "skipping bad syntax"
18616 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
18617 non-filter redirection data are skipped, and each failing address is logged. If
18618 &%syntax_errors_to%& is set, a message is sent to the address it defines,
18619 giving details of the failures. If &%syntax_errors_text%& is set, its contents
18620 are expanded and placed at the head of the error message generated by
18621 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
18622 be the same address as the generic &%errors_to%& option. The
18623 &%skip_syntax_errors%& option is often used when handling mailing lists.
18624
18625 If all the addresses in a redirection list are skipped because of syntax
18626 errors, the router declines to handle the original address, and it is passed to
18627 the following routers.
18628
18629 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
18630 error in the filter causes filtering to be abandoned without any action being
18631 taken. The incident is logged, and the router declines to handle the address,
18632 so it is passed to the following routers.
18633
18634 .cindex "Sieve filter" "syntax errors in"
18635 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
18636 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
18637 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
18638
18639 &%skip_syntax_errors%& can be used to specify that errors in users' forward
18640 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
18641 option, used with an address that does not get redirected, can be used to
18642 notify users of these errors, by means of a router like this:
18643 .code
18644 userforward:
18645   driver = redirect
18646   allow_filter
18647   check_local_user
18648   file = $home/.forward
18649   file_transport = address_file
18650   pipe_transport = address_pipe
18651   reply_transport = address_reply
18652   no_verify
18653   skip_syntax_errors
18654   syntax_errors_to = real-$local_part@$domain
18655   syntax_errors_text = \
18656    This is an automatically generated message. An error has\n\
18657    been found in your .forward file. Details of the error are\n\
18658    reported below. While this error persists, you will receive\n\
18659    a copy of this message for every message that is addressed\n\
18660    to you. If your .forward file is a filter file, or if it is\n\
18661    a non-filter file containing no valid forwarding addresses,\n\
18662    a copy of each incoming message will be put in your normal\n\
18663    mailbox. If a non-filter file contains at least one valid\n\
18664    forwarding address, forwarding to the valid addresses will\n\
18665    happen, and those will be the only deliveries that occur.
18666 .endd
18667 You also need a router to ensure that local addresses that are prefixed by
18668 &`real-`& are recognized, but not forwarded or filtered. For example, you could
18669 put this immediately before the &(userforward)& router:
18670 .code
18671 real_localuser:
18672   driver = accept
18673   check_local_user
18674   local_part_prefix = real-
18675   transport = local_delivery
18676 .endd
18677 For security, it would probably be a good idea to restrict the use of this
18678 router to locally-generated messages, using a condition such as this:
18679 .code
18680   condition = ${if match {$sender_host_address}\
18681                          {\N^(|127\.0\.0\.1)$\N}}
18682 .endd
18683
18684
18685 .option syntax_errors_text redirect string&!! unset
18686 See &%skip_syntax_errors%& above.
18687
18688
18689 .option syntax_errors_to redirect string unset
18690 See &%skip_syntax_errors%& above.
18691 .ecindex IIDredrou1
18692 .ecindex IIDredrou2
18693
18694
18695
18696
18697
18698
18699 . ////////////////////////////////////////////////////////////////////////////
18700 . ////////////////////////////////////////////////////////////////////////////
18701
18702 .chapter "Environment for running local transports" "CHAPenvironment" &&&
18703          "Environment for local transports"
18704 .scindex IIDenvlotra1 "local transports" "environment for"
18705 .scindex IIDenvlotra2 "environment for local transports"
18706 .scindex IIDenvlotra3 "transport" "local; environment for"
18707 Local transports handle deliveries to files and pipes. (The &(autoreply)&
18708 transport can be thought of as similar to a pipe.) Exim always runs transports
18709 in subprocesses, under specified uids and gids. Typical deliveries to local
18710 mailboxes run under the uid and gid of the local user.
18711
18712 Exim also sets a specific current directory while running the transport; for
18713 some transports a home directory setting is also relevant. The &(pipe)&
18714 transport is the only one that sets up environment variables; see section
18715 &<<SECTpipeenv>>& for details.
18716
18717 The values used for the uid, gid, and the directories may come from several
18718 different places. In many cases, the router that handles the address associates
18719 settings with that address as a result of its &%check_local_user%&, &%group%&,
18720 or &%user%& options. However, values may also be given in the transport's own
18721 configuration, and these override anything that comes from the router.
18722
18723
18724
18725 .section "Concurrent deliveries" "SECID131"
18726 .cindex "concurrent deliveries"
18727 .cindex "simultaneous deliveries"
18728 If two different messages for the same local recipient arrive more or less
18729 simultaneously, the two delivery processes are likely to run concurrently. When
18730 the &(appendfile)& transport is used to write to a file, Exim applies locking
18731 rules to stop concurrent processes from writing to the same file at the same
18732 time.
18733
18734 However, when you use a &(pipe)& transport, it is up to you to arrange any
18735 locking that is needed. Here is a silly example:
18736 .code
18737 my_transport:
18738   driver = pipe
18739   command = /bin/sh -c 'cat >>/some/file'
18740 .endd
18741 This is supposed to write the message at the end of the file. However, if two
18742 messages arrive at the same time, the file will be scrambled. You can use the
18743 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
18744 file using the same algorithm that Exim itself uses.
18745
18746
18747
18748
18749 .section "Uids and gids" "SECTenvuidgid"
18750 .cindex "local transports" "uid and gid"
18751 .cindex "transport" "local; uid and gid"
18752 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
18753 overrides any group that the router set in the address, even if &%user%& is not
18754 set for the transport. This makes it possible, for example, to run local mail
18755 delivery under the uid of the recipient (set by the router), but in a special
18756 group (set by the transport). For example:
18757 .code
18758 # Routers ...
18759 # User/group are set by check_local_user in this router
18760 local_users:
18761   driver = accept
18762   check_local_user
18763   transport = group_delivery
18764
18765 # Transports ...
18766 # This transport overrides the group
18767 group_delivery:
18768   driver = appendfile
18769   file = /var/spool/mail/$local_part
18770   group = mail
18771 .endd
18772 If &%user%& is set for a transport, its value overrides what is set in the
18773 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
18774 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
18775 set.
18776
18777 .oindex "&%initgroups%&"
18778 When the uid is taken from the transport's configuration, the &[initgroups()]&
18779 function is called for the groups associated with that uid if the
18780 &%initgroups%& option is set for the transport. When the uid is not specified
18781 by the transport, but is associated with the address by a router, the option
18782 for calling &[initgroups()]& is taken from the router configuration.
18783
18784 .cindex "&(pipe)& transport" "uid for"
18785 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
18786 is set and &%user%& is not set, the uid of the process that called Exim to
18787 receive the message is used, and if &%group%& is not set, the corresponding
18788 original gid is also used.
18789
18790 This is the detailed preference order for obtaining a gid; the first of the
18791 following that is set is used:
18792
18793 .ilist
18794 A &%group%& setting of the transport;
18795 .next
18796 A &%group%& setting of the router;
18797 .next
18798 A gid associated with a user setting of the router, either as a result of
18799 &%check_local_user%& or an explicit non-numeric &%user%& setting;
18800 .next
18801 The group associated with a non-numeric &%user%& setting of the transport;
18802 .next
18803 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
18804 the uid is the creator's uid;
18805 .next
18806 The Exim gid if the Exim uid is being used as a default.
18807 .endlist
18808
18809 If, for example, the user is specified numerically on the router and there are
18810 no group settings, no gid is available. In this situation, an error occurs.
18811 This is different for the uid, for which there always is an ultimate default.
18812 The first of the following that is set is used:
18813
18814 .ilist
18815 A &%user%& setting of the transport;
18816 .next
18817 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
18818 .next
18819 A &%user%& setting of the router;
18820 .next
18821 A &%check_local_user%& setting of the router;
18822 .next
18823 The Exim uid.
18824 .endlist
18825
18826 Of course, an error will still occur if the uid that is chosen is on the
18827 &%never_users%& list.
18828
18829
18830
18831
18832
18833 .section "Current and home directories" "SECID132"
18834 .cindex "current directory for local transport"
18835 .cindex "home directory" "for local transport"
18836 .cindex "transport" "local; home directory for"
18837 .cindex "transport" "local; current directory for"
18838 Routers may set current and home directories for local transports by means of
18839 the &%transport_current_directory%& and &%transport_home_directory%& options.
18840 However, if the transport's &%current_directory%& or &%home_directory%& options
18841 are set, they override the router's values. In detail, the home directory
18842 for a local transport is taken from the first of these values that is set:
18843
18844 .ilist
18845 The &%home_directory%& option on the transport;
18846 .next
18847 The &%transport_home_directory%& option on the router;
18848 .next
18849 The password data if &%check_local_user%& is set on the router;
18850 .next
18851 The &%router_home_directory%& option on the router.
18852 .endlist
18853
18854 The current directory is taken from the first of these values that is set:
18855
18856 .ilist
18857 The &%current_directory%& option on the transport;
18858 .next
18859 The &%transport_current_directory%& option on the router.
18860 .endlist
18861
18862
18863 If neither the router nor the transport sets a current directory, Exim uses the
18864 value of the home directory, if it is set. Otherwise it sets the current
18865 directory to &_/_& before running a local transport.
18866
18867
18868
18869 .section "Expansion variables derived from the address" "SECID133"
18870 .vindex "&$domain$&"
18871 .vindex "&$local_part$&"
18872 .vindex "&$original_domain$&"
18873 Normally a local delivery is handling a single address, and in that case the
18874 variables such as &$domain$& and &$local_part$& are set during local
18875 deliveries. However, in some circumstances more than one address may be handled
18876 at once (for example, while writing batch SMTP for onward transmission by some
18877 other means). In this case, the variables associated with the local part are
18878 never set, &$domain$& is set only if all the addresses have the same domain,
18879 and &$original_domain$& is never set.
18880 .ecindex IIDenvlotra1
18881 .ecindex IIDenvlotra2
18882 .ecindex IIDenvlotra3
18883
18884
18885
18886
18887
18888
18889
18890 . ////////////////////////////////////////////////////////////////////////////
18891 . ////////////////////////////////////////////////////////////////////////////
18892
18893 .chapter "Generic options for transports" "CHAPtransportgeneric"
18894 .scindex IIDgenoptra1 "generic options" "transport"
18895 .scindex IIDgenoptra2 "options" "generic; for transports"
18896 .scindex IIDgenoptra3 "transport" "generic options for"
18897 The following generic options apply to all transports:
18898
18899
18900 .option body_only transports boolean false
18901 .cindex "transport" "body only"
18902 .cindex "message" "transporting body only"
18903 .cindex "body of message" "transporting"
18904 If this option is set, the message's headers are not transported. It is
18905 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
18906 or &(pipe)& transports, the settings of &%message_prefix%& and
18907 &%message_suffix%& should be checked, because this option does not
18908 automatically suppress them.
18909
18910
18911 .option current_directory transports string&!! unset
18912 .cindex "transport" "current directory for"
18913 This specifies the current directory that is to be set while running the
18914 transport, overriding any value that may have been set by the router.
18915 If the expansion fails for any reason, including forced failure, an error is
18916 logged, and delivery is deferred.
18917
18918
18919 .option disable_logging transports boolean false
18920 If this option is set true, nothing is logged for any
18921 deliveries by the transport or for any
18922 transport errors. You should not set this option unless you really, really know
18923 what you are doing.
18924
18925
18926 .option debug_print transports string&!! unset
18927 .cindex "testing" "variables in drivers"
18928 If this option is set and debugging is enabled (see the &%-d%& command line
18929 option), the string is expanded and included in the debugging output when the
18930 transport is run.
18931 If expansion of the string fails, the error message is written to the debugging
18932 output, and Exim carries on processing.
18933 This facility is provided to help with checking out the values of variables and
18934 so on when debugging driver configurations. For example, if a &%headers_add%&
18935 option is not working properly, &%debug_print%& could be used to output the
18936 variables it references. A newline is added to the text if it does not end with
18937 one.
18938
18939
18940 .option delivery_date_add transports boolean false
18941 .cindex "&'Delivery-date:'& header line"
18942 If this option is true, a &'Delivery-date:'& header is added to the message.
18943 This gives the actual time the delivery was made. As this is not a standard
18944 header, Exim has a configuration option (&%delivery_date_remove%&) which
18945 requests its removal from incoming messages, so that delivered messages can
18946 safely be resent to other recipients.
18947
18948
18949 .option driver transports string unset
18950 This specifies which of the available transport drivers is to be used.
18951 There is no default, and this option must be set for every transport.
18952
18953
18954 .option envelope_to_add transports boolean false
18955 .cindex "&'Envelope-to:'& header line"
18956 If this option is true, an &'Envelope-to:'& header is added to the message.
18957 This gives the original address(es) in the incoming envelope that caused this
18958 delivery to happen. More than one address may be present if the transport is
18959 configured to handle several addresses at once, or if more than one original
18960 address was redirected to the same final address. As this is not a standard
18961 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
18962 its removal from incoming messages, so that delivered messages can safely be
18963 resent to other recipients.
18964
18965
18966 .option group transports string&!! "Exim group"
18967 .cindex "transport" "group; specifying"
18968 This option specifies a gid for running the transport process, overriding any
18969 value that the router supplies, and also overriding any value associated with
18970 &%user%& (see below).
18971
18972
18973 .option headers_add transports string&!! unset
18974 .cindex "header lines" "adding in transport"
18975 .cindex "transport" "header lines; adding"
18976 This option specifies a string of text that is expanded and added to the header
18977 portion of a message as it is transported, as described in section
18978 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
18979 routers. If the result of the expansion is an empty string, or if the expansion
18980 is forced to fail, no action is taken. Other expansion failures are treated as
18981 errors and cause the delivery to be deferred.
18982
18983
18984
18985 .option headers_only transports boolean false
18986 .cindex "transport" "header lines only"
18987 .cindex "message" "transporting headers only"
18988 .cindex "header lines" "transporting"
18989 If this option is set, the message's body is not transported. It is mutually
18990 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
18991 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
18992 checked, since this option does not automatically suppress them.
18993
18994
18995 .option headers_remove transports string&!! unset
18996 .cindex "header lines" "removing"
18997 .cindex "transport" "header lines; removing"
18998 This option specifies a string that is expanded into a list of header names;
18999 these headers are omitted from the message as it is transported, as described
19000 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
19001 routers. If the result of the expansion is an empty string, or if the expansion
19002 is forced to fail, no action is taken. Other expansion failures are treated as
19003 errors and cause the delivery to be deferred.
19004
19005
19006
19007 .option headers_rewrite transports string unset
19008 .cindex "transport" "header lines; rewriting"
19009 .cindex "rewriting" "at transport time"
19010 This option allows addresses in header lines to be rewritten at transport time,
19011 that is, as the message is being copied to its destination. The contents of the
19012 option are a colon-separated list of rewriting rules. Each rule is in exactly
19013 the same form as one of the general rewriting rules that are applied when a
19014 message is received. These are described in chapter &<<CHAPrewrite>>&. For
19015 example,
19016 .code
19017 headers_rewrite = a@b c@d f : \
19018                   x@y w@z
19019 .endd
19020 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
19021 &'w@z'& in all address-bearing header lines. The rules are applied to the
19022 header lines just before they are written out at transport time, so they affect
19023 only those copies of the message that pass through the transport. However, only
19024 the message's original header lines, and any that were added by a system
19025 filter, are rewritten. If a router or transport adds header lines, they are not
19026 affected by this option. These rewriting rules are &'not'& applied to the
19027 envelope. You can change the return path using &%return_path%&, but you cannot
19028 change envelope recipients at this time.
19029
19030
19031 .option home_directory transports string&!! unset
19032 .cindex "transport" "home directory for"
19033 .vindex "&$home$&"
19034 This option specifies a home directory setting for a local transport,
19035 overriding any value that may be set by the router. The home directory is
19036 placed in &$home$& while expanding the transport's private options. It is also
19037 used as the current directory if no current directory is set by the
19038 &%current_directory%& option on the transport or the
19039 &%transport_current_directory%& option on the router. If the expansion fails
19040 for any reason, including forced failure, an error is logged, and delivery is
19041 deferred.
19042
19043
19044 .option initgroups transports boolean false
19045 .cindex "additional groups"
19046 .cindex "groups" "additional"
19047 .cindex "transport" "group; additional"
19048 If this option is true and the uid for the delivery process is provided by the
19049 transport, the &[initgroups()]& function is called when running the transport
19050 to ensure that any additional groups associated with the uid are set up.
19051
19052
19053 .option message_size_limit transports string&!! 0
19054 .cindex "limit" "message size per transport"
19055 .cindex "size" "of message, limit"
19056 .cindex "transport" "message size; limiting"
19057 This option controls the size of messages passed through the transport. It is
19058 expanded before use; the result of the expansion must be a sequence of decimal
19059 digits, optionally followed by K or M. If the expansion fails for any reason,
19060 including forced failure, or if the result is not of the required form,
19061 delivery is deferred. If the value is greater than zero and the size of a
19062 message exceeds this limit, the address is failed. If there is any chance that
19063 the resulting bounce message could be routed to the same transport, you should
19064 ensure that &%return_size_limit%& is less than the transport's
19065 &%message_size_limit%&, as otherwise the bounce message will fail to get
19066 delivered.
19067
19068
19069
19070 .option rcpt_include_affixes transports boolean false
19071 .cindex "prefix" "for local part, including in envelope"
19072 .cindex "suffix for local part" "including in envelope"
19073 .cindex "local part" "prefix"
19074 .cindex "local part" "suffix"
19075 When this option is false (the default), and an address that has had any
19076 affixes (prefixes or suffixes) removed from the local part is delivered by any
19077 form of SMTP or LMTP, the affixes are not included. For example, if a router
19078 that contains
19079 .code
19080 local_part_prefix = *-
19081 .endd
19082 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
19083 is delivered with
19084 .code
19085 RCPT TO:<xyz@some.domain>
19086 .endd
19087 This is also the case when an ACL-time callout is being used to verify a
19088 recipient address. However, if &%rcpt_include_affixes%& is set true, the
19089 whole local part is included in the RCPT command. This option applies to BSMTP
19090 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
19091 &(lmtp)& and &(smtp)& transports.
19092
19093
19094 .option retry_use_local_part transports boolean "see below"
19095 .cindex "hints database" "retry keys"
19096 When a delivery suffers a temporary failure, a retry record is created
19097 in Exim's hints database. For remote deliveries, the key for the retry record
19098 is based on the name and/or IP address of the failing remote host. For local
19099 deliveries, the key is normally the entire address, including both the local
19100 part and the domain. This is suitable for most common cases of local delivery
19101 temporary failure &-- for example, exceeding a mailbox quota should delay only
19102 deliveries to that mailbox, not to the whole domain.
19103
19104 However, in some special cases you may want to treat a temporary local delivery
19105 as a failure associated with the domain, and not with a particular local part.
19106 (For example, if you are storing all mail for some domain in files.) You can do
19107 this by setting &%retry_use_local_part%& false.
19108
19109 For all the local transports, its default value is true. For remote transports,
19110 the default value is false for tidiness, but changing the value has no effect
19111 on a remote transport in the current implementation.
19112
19113
19114 .option return_path transports string&!! unset
19115 .cindex "envelope sender"
19116 .cindex "transport" "return path; changing"
19117 .cindex "return path" "changing in transport"
19118 If this option is set, the string is expanded at transport time and replaces
19119 the existing return path (envelope sender) value in the copy of the message
19120 that is being delivered. An empty return path is permitted. This feature is
19121 designed for remote deliveries, where the value of this option is used in the
19122 SMTP MAIL command. If you set &%return_path%& for a local transport, the
19123 only effect is to change the address that is placed in the &'Return-path:'&
19124 header line, if one is added to the message (see the next option).
19125
19126 &*Note:*& A changed return path is not logged unless you add
19127 &%return_path_on_delivery%& to the log selector.
19128
19129 .vindex "&$return_path$&"
19130 The expansion can refer to the existing value via &$return_path$&. This is
19131 either the message's envelope sender, or an address set by the
19132 &%errors_to%& option on a router. If the expansion is forced to fail, no
19133 replacement occurs; if it fails for another reason, delivery is deferred. This
19134 option can be used to support VERP (Variable Envelope Return Paths) &-- see
19135 section &<<SECTverp>>&.
19136
19137 &*Note*&: If a delivery error is detected locally, including the case when a
19138 remote server rejects a message at SMTP time, the bounce message is not sent to
19139 the value of this option. It is sent to the previously set errors address.
19140 This defaults to the incoming sender address, but can be changed by setting
19141 &%errors_to%& in a router.
19142
19143
19144
19145 .option return_path_add transports boolean false
19146 .cindex "&'Return-path:'& header line"
19147 If this option is true, a &'Return-path:'& header is added to the message.
19148 Although the return path is normally available in the prefix line of BSD
19149 mailboxes, this is commonly not displayed by MUAs, and so the user does not
19150 have easy access to it.
19151
19152 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
19153 the delivery SMTP server makes the final delivery"&. This implies that this
19154 header should not be present in incoming messages. Exim has a configuration
19155 option, &%return_path_remove%&, which requests removal of this header from
19156 incoming messages, so that delivered messages can safely be resent to other
19157 recipients.
19158
19159
19160 .option shadow_condition transports string&!! unset
19161 See &%shadow_transport%& below.
19162
19163
19164 .option shadow_transport transports string unset
19165 .cindex "shadow transport"
19166 .cindex "transport" "shadow"
19167 A local transport may set the &%shadow_transport%& option to the name of
19168 another local transport. Shadow remote transports are not supported.
19169
19170 Whenever a delivery to the main transport succeeds, and either
19171 &%shadow_condition%& is unset, or its expansion does not result in the empty
19172 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
19173 passed to the shadow transport, with the same delivery address or addresses. If
19174 expansion fails, no action is taken except that non-forced expansion failures
19175 cause a log line to be written.
19176
19177 The result of the shadow transport is discarded and does not affect the
19178 subsequent processing of the message. Only a single level of shadowing is
19179 provided; the &%shadow_transport%& option is ignored on any transport when it
19180 is running as a shadow. Options concerned with output from pipes are also
19181 ignored. The log line for the successful delivery has an item added on the end,
19182 of the form
19183 .code
19184 ST=<shadow transport name>
19185 .endd
19186 If the shadow transport did not succeed, the error message is put in
19187 parentheses afterwards. Shadow transports can be used for a number of different
19188 purposes, including keeping more detailed log information than Exim normally
19189 provides, and implementing automatic acknowledgment policies based on message
19190 headers that some sites insist on.
19191
19192
19193 .option transport_filter transports string&!! unset
19194 .cindex "transport" "filter"
19195 .cindex "filter" "transport filter"
19196 This option sets up a filtering (in the Unix shell sense) process for messages
19197 at transport time. It should not be confused with mail filtering as set up by
19198 individual users or via a system filter.
19199
19200 When the message is about to be written out, the command specified by
19201 &%transport_filter%& is started up in a separate, parallel process, and
19202 the entire message, including the header lines, is passed to it on its standard
19203 input (this in fact is done from a third process, to avoid deadlock). The
19204 command must be specified as an absolute path.
19205
19206 The lines of the message that are written to the transport filter are
19207 terminated by newline (&"\n"&). The message is passed to the filter before any
19208 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
19209 lines beginning with a dot, and also before any processing implied by the
19210 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
19211 &(pipe)& transports.
19212
19213 The standard error for the filter process is set to the same destination as its
19214 standard output; this is read and written to the message's ultimate
19215 destination. The process that writes the message to the filter, the
19216 filter itself, and the original process that reads the result and delivers it
19217 are all run in parallel, like a shell pipeline.
19218
19219 The filter can perform any transformations it likes, but of course should take
19220 care not to break RFC 2822 syntax. Exim does not check the result, except to
19221 test for a final newline when SMTP is in use. All messages transmitted over
19222 SMTP must end with a newline, so Exim supplies one if it is missing.
19223
19224 .cindex "content scanning" "per user"
19225 A transport filter can be used to provide content-scanning on a per-user basis
19226 at delivery time if the only required effect of the scan is to modify the
19227 message. For example, a content scan could insert a new header line containing
19228 a spam score. This could be interpreted by a filter in the user's MUA. It is
19229 not possible to discard a message at this stage.
19230
19231 .cindex "SMTP" "SIZE"
19232 A problem might arise if the filter increases the size of a message that is
19233 being sent down an SMTP connection. If the receiving SMTP server has indicated
19234 support for the SIZE parameter, Exim will have sent the size of the message
19235 at the start of the SMTP session. If what is actually sent is substantially
19236 more, the server might reject the message. This can be worked round by setting
19237 the &%size_addition%& option on the &(smtp)& transport, either to allow for
19238 additions to the message, or to disable the use of SIZE altogether.
19239
19240 .vindex "&$pipe_addresses$&"
19241 The value of the &%transport_filter%& option is the command string for starting
19242 the filter, which is run directly from Exim, not under a shell. The string is
19243 parsed by Exim in the same way as a command string for the &(pipe)& transport:
19244 Exim breaks it up into arguments and then expands each argument separately (see
19245 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
19246 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
19247 of arguments, one for each address that applies to this delivery. (This isn't
19248 an ideal name for this feature here, but as it was already implemented for the
19249 &(pipe)& transport, it seemed sensible not to change it.)
19250
19251 .vindex "&$host$&"
19252 .vindex "&$host_address$&"
19253 The expansion variables &$host$& and &$host_address$& are available when the
19254 transport is a remote one. They contain the name and IP address of the host to
19255 which the message is being sent. For example:
19256 .code
19257 transport_filter = /some/directory/transport-filter.pl \
19258   $host $host_address $sender_address $pipe_addresses
19259 .endd
19260
19261 Two problems arise if you want to use more complicated expansion items to
19262 generate transport filter commands, both of which due to the fact that the
19263 command is split up &'before'& expansion.
19264 .ilist
19265 If an expansion item contains white space, you must quote it, so that it is all
19266 part of the same command item. If the entire option setting is one such
19267 expansion item, you have to take care what kind of quoting you use. For
19268 example:
19269 .code
19270 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
19271 .endd
19272 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
19273 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
19274 stripped by Exim when it read the option's value. When the value is used, if
19275 the single quotes were missing, the line would be split into two items,
19276 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
19277 Exim tried to expand the first one.
19278 .next
19279 Except for the special case of &$pipe_addresses$& that is mentioned above, an
19280 expansion cannot generate multiple arguments, or a command name followed by
19281 arguments. Consider this example:
19282 .code
19283 transport_filter = ${lookup{$host}lsearch{/a/file}\
19284                     {$value}{/bin/cat}}
19285 .endd
19286 The result of the lookup is interpreted as the name of the command, even
19287 if it contains white space. The simplest way round this is to use a shell:
19288 .code
19289 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
19290                                {$value}{/bin/cat}}
19291 .endd
19292 .endlist
19293
19294 The filter process is run under the same uid and gid as the normal delivery.
19295 For remote deliveries this is the Exim uid/gid by default. The command should
19296 normally yield a zero return code. Transport filters are not supposed to fail.
19297 A non-zero code is taken to mean that the transport filter encountered some
19298 serious problem. Delivery of the message is deferred; the message remains on
19299 the queue and is tried again later. It is not possible to cause a message to be
19300 bounced from a transport filter.
19301
19302 If a transport filter is set on an autoreply transport, the original message is
19303 passed through the filter as it is being copied into the newly generated
19304 message, which happens if the &%return_message%& option is set.
19305
19306
19307 .option transport_filter_timeout transports time 5m
19308 .cindex "transport" "filter, timeout"
19309 When Exim is reading the output of a transport filter, it a applies a timeout
19310 that can be set by this option. Exceeding the timeout is normally treated as a
19311 temporary delivery failure. However, if a transport filter is used with a
19312 &(pipe)& transport, a timeout in the transport filter is treated in the same
19313 way as a timeout in the pipe command itself. By default, a timeout is a hard
19314 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
19315 becomes a temporary error.
19316
19317
19318 .option user transports string&!! "Exim user"
19319 .cindex "uid (user id)" "local delivery"
19320 .cindex "transport" "user, specifying"
19321 This option specifies the user under whose uid the delivery process is to be
19322 run, overriding any uid that may have been set by the router. If the user is
19323 given as a name, the uid is looked up from the password data, and the
19324 associated group is taken as the value of the gid to be used if the &%group%&
19325 option is not set.
19326
19327 For deliveries that use local transports, a user and group are normally
19328 specified explicitly or implicitly (for example, as a result of
19329 &%check_local_user%&) by the router or transport.
19330
19331 .cindex "hints database" "access by remote transport"
19332 For remote transports, you should leave this option unset unless you really are
19333 sure you know what you are doing. When a remote transport is running, it needs
19334 to be able to access Exim's hints databases, because each host may have its own
19335 retry data.
19336 .ecindex IIDgenoptra1
19337 .ecindex IIDgenoptra2
19338 .ecindex IIDgenoptra3
19339
19340
19341
19342
19343
19344
19345 . ////////////////////////////////////////////////////////////////////////////
19346 . ////////////////////////////////////////////////////////////////////////////
19347
19348 .chapter "Address batching in local transports" "CHAPbatching" &&&
19349          "Address batching"
19350 .cindex "transport" "local; address batching in"
19351 The only remote transport (&(smtp)&) is normally configured to handle more than
19352 one address at a time, so that when several addresses are routed to the same
19353 remote host, just one copy of the message is sent. Local transports, however,
19354 normally handle one address at a time. That is, a separate instance of the
19355 transport is run for each address that is routed to the transport. A separate
19356 copy of the message is delivered each time.
19357
19358 .cindex "batched local delivery"
19359 .oindex "&%batch_max%&"
19360 .oindex "&%batch_id%&"
19361 In special cases, it may be desirable to handle several addresses at once in a
19362 local transport, for example:
19363
19364 .ilist
19365 In an &(appendfile)& transport, when storing messages in files for later
19366 delivery by some other means, a single copy of the message with multiple
19367 recipients saves space.
19368 .next
19369 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
19370 a single copy saves time, and is the normal way LMTP is expected to work.
19371 .next
19372 In a &(pipe)& transport, when passing the message
19373 to a scanner program or
19374 to some other delivery mechanism such as UUCP, multiple recipients may be
19375 acceptable.
19376 .endlist
19377
19378 These three local transports all have the same options for controlling multiple
19379 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
19380 repeating the information for each transport, these options are described here.
19381
19382 The &%batch_max%& option specifies the maximum number of addresses that can be
19383 delivered together in a single run of the transport. Its default value is one
19384 (no batching). When more than one address is routed to a transport that has a
19385 &%batch_max%& value greater than one, the addresses are delivered in a batch
19386 (that is, in a single run of the transport with multiple recipients), subject
19387 to certain conditions:
19388
19389 .ilist
19390 .vindex "&$local_part$&"
19391 If any of the transport's options contain a reference to &$local_part$&, no
19392 batching is possible.
19393 .next
19394 .vindex "&$domain$&"
19395 If any of the transport's options contain a reference to &$domain$&, only
19396 addresses with the same domain are batched.
19397 .next
19398 .cindex "customizing" "batching condition"
19399 If &%batch_id%& is set, it is expanded for each address, and only those
19400 addresses with the same expanded value are batched. This allows you to specify
19401 customized batching conditions. Failure of the expansion for any reason,
19402 including forced failure, disables batching, but it does not stop the delivery
19403 from taking place.
19404 .next
19405 Batched addresses must also have the same errors address (where to send
19406 delivery errors), the same header additions and removals, the same user and
19407 group for the transport, and if a host list is present, the first host must
19408 be the same.
19409 .endlist
19410
19411 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
19412 both when the file or pipe command is specified in the transport, and when it
19413 is specified by a &(redirect)& router, but all the batched addresses must of
19414 course be routed to the same file or pipe command. These two transports have an
19415 option called &%use_bsmtp%&, which causes them to deliver the message in
19416 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
19417 &%check_string%& and &%escape_string%& options are forced to the values
19418 .code
19419 check_string = "."
19420 escape_string = ".."
19421 .endd
19422 when batched SMTP is in use. A full description of the batch SMTP mechanism is
19423 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
19424 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
19425
19426 .cindex "&'Envelope-to:'& header line"
19427 If the generic &%envelope_to_add%& option is set for a batching transport, the
19428 &'Envelope-to:'& header that is added to the message contains all the addresses
19429 that are being processed together. If you are using a batching &(appendfile)&
19430 transport without &%use_bsmtp%&, the only way to preserve the recipient
19431 addresses is to set the &%envelope_to_add%& option.
19432
19433 .cindex "&(pipe)& transport" "with multiple addresses"
19434 .vindex "&$pipe_addresses$&"
19435 If you are using a &(pipe)& transport without BSMTP, and setting the
19436 transport's &%command%& option, you can include &$pipe_addresses$& as part of
19437 the command. This is not a true variable; it is a bit of magic that causes each
19438 of the recipient addresses to be inserted into the command as a separate
19439 argument. This provides a way of accessing all the addresses that are being
19440 delivered in the batch. &*Note:*& This is not possible for pipe commands that
19441 are specified by a &(redirect)& router.
19442
19443
19444
19445
19446 . ////////////////////////////////////////////////////////////////////////////
19447 . ////////////////////////////////////////////////////////////////////////////
19448
19449 .chapter "The appendfile transport" "CHAPappendfile"
19450 .scindex IIDapptra1 "&(appendfile)& transport"
19451 .scindex IIDapptra2 "transports" "&(appendfile)&"
19452 .cindex "directory creation"
19453 .cindex "creating directories"
19454 The &(appendfile)& transport delivers a message by appending it to an existing
19455 file, or by creating an entirely new file in a specified directory. Single
19456 files to which messages are appended can be in the traditional Unix mailbox
19457 format, or optionally in the MBX format supported by the Pine MUA and
19458 University of Washington IMAP daemon, &'inter alia'&. When each message is
19459 being delivered as a separate file, &"maildir"& format can optionally be used
19460 to give added protection against failures that happen part-way through the
19461 delivery. A third form of separate-file delivery known as &"mailstore"& is also
19462 supported. For all file formats, Exim attempts to create as many levels of
19463 directory as necessary, provided that &%create_directory%& is set.
19464
19465 The code for the optional formats is not included in the Exim binary by
19466 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
19467 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
19468 included.
19469
19470 .cindex "quota" "system"
19471 Exim recognizes system quota errors, and generates an appropriate message. Exim
19472 also supports its own quota control within the transport, for use when the
19473 system facility is unavailable or cannot be used for some reason.
19474
19475 If there is an error while appending to a file (for example, quota exceeded or
19476 partition filled), Exim attempts to reset the file's length and last
19477 modification time back to what they were before. If there is an error while
19478 creating an entirely new file, the new file is removed.
19479
19480 Before appending to a file, a number of security checks are made, and the
19481 file is locked. A detailed description is given below, after the list of
19482 private options.
19483
19484 The &(appendfile)& transport is most commonly used for local deliveries to
19485 users' mailboxes. However, it can also be used as a pseudo-remote transport for
19486 putting messages into files for remote delivery by some means other than Exim.
19487 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
19488 option).
19489
19490
19491
19492 .section "The file and directory options" "SECTfildiropt"
19493 The &%file%& option specifies a single file, to which the message is appended;
19494 the &%directory%& option specifies a directory, in which a new file containing
19495 the message is created. Only one of these two options can be set, and for
19496 normal deliveries to mailboxes, one of them &'must'& be set.
19497
19498 .vindex "&$address_file$&"
19499 .vindex "&$local_part$&"
19500 However, &(appendfile)& is also used for delivering messages to files or
19501 directories whose names (or parts of names) are obtained from alias,
19502 forwarding, or filtering operations (for example, a &%save%& command in a
19503 user's Exim filter). When such a transport is running, &$local_part$& contains
19504 the local part that was aliased or forwarded, and &$address_file$& contains the
19505 name (or partial name) of the file or directory generated by the redirection
19506 operation. There are two cases:
19507
19508 .ilist
19509 If neither &%file%& nor &%directory%& is set, the redirection operation
19510 must specify an absolute path (one that begins with &`/`&). This is the most
19511 common case when users with local accounts use filtering to sort mail into
19512 different folders. See for example, the &(address_file)& transport in the
19513 default configuration. If the path ends with a slash, it is assumed to be the
19514 name of a directory. A delivery to a directory can also be forced by setting
19515 &%maildir_format%& or &%mailstore_format%&.
19516 .next
19517 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
19518 used to determine the file or directory name for the delivery. Normally, the
19519 contents of &$address_file$& are used in some way in the string expansion.
19520 .endlist
19521
19522
19523 .cindex "Sieve filter" "configuring &(appendfile)&"
19524 .cindex "Sieve filter" "relative mailbox path handling"
19525 As an example of the second case, consider an environment where users do not
19526 have home directories. They may be permitted to use Exim filter commands of the
19527 form:
19528 .code
19529 save folder23
19530 .endd
19531 or Sieve filter commands of the form:
19532 .code
19533 require "fileinto";
19534 fileinto "folder23";
19535 .endd
19536 In this situation, the expansion of &%file%& or &%directory%& in the transport
19537 must transform the relative path into an appropriate absolute file name. In the
19538 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
19539 is used as a result of a &"keep"& action in the filter. This example shows one
19540 way of handling this requirement:
19541 .code
19542 file = ${if eq{$address_file}{inbox} \
19543             {/var/mail/$local_part} \
19544             {${if eq{${substr_0_1:$address_file}}{/} \
19545                   {$address_file} \
19546                   {$home/mail/$address_file} \
19547             }} \
19548        }
19549 .endd
19550 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
19551 location, absolute paths are used without change, and other folders are in the
19552 &_mail_& directory within the home directory.
19553
19554 &*Note 1*&: While processing an Exim filter, a relative path such as
19555 &_folder23_& is turned into an absolute path if a home directory is known to
19556 the router. In particular, this is the case if &%check_local_user%& is set. If
19557 you want to prevent this happening at routing time, you can set
19558 &%router_home_directory%& empty. This forces the router to pass the relative
19559 path to the transport.
19560
19561 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
19562 the &%file%& or &%directory%& option is still used if it is set.
19563
19564
19565
19566
19567 .section "Private options for appendfile" "SECID134"
19568 .cindex "options" "&(appendfile)& transport"
19569
19570
19571
19572 .option allow_fifo appendfile boolean false
19573 .cindex "fifo (named pipe)"
19574 .cindex "named pipe (fifo)"
19575 .cindex "pipe" "named (fifo)"
19576 Setting this option permits delivery to named pipes (FIFOs) as well as to
19577 regular files. If no process is reading the named pipe at delivery time, the
19578 delivery is deferred.
19579
19580
19581 .option allow_symlink appendfile boolean false
19582 .cindex "symbolic link" "to mailbox"
19583 .cindex "mailbox" "symbolic link"
19584 By default, &(appendfile)& will not deliver if the path name for the file is
19585 that of a symbolic link. Setting this option relaxes that constraint, but there
19586 are security issues involved in the use of symbolic links. Be sure you know
19587 what you are doing if you set this. Details of exactly what this option affects
19588 are included in the discussion which follows this list of options.
19589
19590
19591 .option batch_id appendfile string&!! unset
19592 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
19593 However, batching is automatically disabled for &(appendfile)& deliveries that
19594 happen as a result of forwarding or aliasing or other redirection directly to a
19595 file.
19596
19597
19598 .option batch_max appendfile integer 1
19599 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
19600
19601
19602 .option check_group appendfile boolean false
19603 When this option is set, the group owner of the file defined by the &%file%&
19604 option is checked to see that it is the same as the group under which the
19605 delivery process is running. The default setting is false because the default
19606 file mode is 0600, which means that the group is irrelevant.
19607
19608
19609 .option check_owner appendfile boolean true
19610 When this option is set, the owner of the file defined by the &%file%& option
19611 is checked to ensure that it is the same as the user under which the delivery
19612 process is running.
19613
19614
19615 .option check_string appendfile string "see below"
19616 .cindex "&""From""& line"
19617 As &(appendfile)& writes the message, the start of each line is tested for
19618 matching &%check_string%&, and if it does, the initial matching characters are
19619 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
19620 a literal string, not a regular expression, and the case of any letters it
19621 contains is significant.
19622
19623 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
19624 are forced to &"."& and &".."& respectively, and any settings in the
19625 configuration are ignored. Otherwise, they default to &"From&~"& and
19626 &">From&~"& when the &%file%& option is set, and unset when any of the
19627 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
19628
19629 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
19630 suitable for traditional &"BSD"& mailboxes, where a line beginning with
19631 &"From&~"& indicates the start of a new message. All four options need changing
19632 if another format is used. For example, to deliver to mailboxes in MMDF format:
19633 .cindex "MMDF format mailbox"
19634 .cindex "mailbox" "MMDF format"
19635 .code
19636 check_string = "\1\1\1\1\n"
19637 escape_string = "\1\1\1\1 \n"
19638 message_prefix = "\1\1\1\1\n"
19639 message_suffix = "\1\1\1\1\n"
19640 .endd
19641 .option create_directory appendfile boolean true
19642 .cindex "directory creation"
19643 When this option is true, Exim attempts to create any missing superior
19644 directories for the file that it is about to write. A created directory's mode
19645 is given by the &%directory_mode%& option.
19646
19647 The group ownership of a newly created directory is highly dependent on the
19648 operating system (and possibly the file system) that is being used. For
19649 example, in Solaris, if the parent directory has the setgid bit set, its group
19650 is propagated to the child; if not, the currently set group is used. However,
19651 in FreeBSD, the parent's group is always used.
19652
19653
19654
19655 .option create_file appendfile string anywhere
19656 This option constrains the location of files and directories that are created
19657 by this transport. It applies to files defined by the &%file%& option and
19658 directories defined by the &%directory%& option. In the case of maildir
19659 delivery, it applies to the top level directory, not the maildir directories
19660 beneath.
19661
19662 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
19663 &"belowhome"&. In the second and third cases, a home directory must have been
19664 set for the transport. This option is not useful when an explicit file name is
19665 given for normal mailbox deliveries. It is intended for the case when file
19666 names are generated from users' &_.forward_& files. These are usually handled
19667 by an &(appendfile)& transport called &%address_file%&. See also
19668 &%file_must_exist%&.
19669
19670
19671 .option directory appendfile string&!! unset
19672 This option is mutually exclusive with the &%file%& option, but one of &%file%&
19673 or &%directory%& must be set, unless the delivery is the direct result of a
19674 redirection (see section &<<SECTfildiropt>>&).
19675
19676 When &%directory%& is set, the string is expanded, and the message is delivered
19677 into a new file or files in or below the given directory, instead of being
19678 appended to a single mailbox file. A number of different formats are provided
19679 (see &%maildir_format%& and &%mailstore_format%&), and see section
19680 &<<SECTopdir>>& for further details of this form of delivery.
19681
19682
19683 .option directory_file appendfile string&!! "see below"
19684 .cindex "base62"
19685 .vindex "&$inode$&"
19686 When &%directory%& is set, but neither &%maildir_format%& nor
19687 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
19688 whose name is obtained by expanding this string. The default value is:
19689 .code
19690 q${base62:$tod_epoch}-$inode
19691 .endd
19692 This generates a unique name from the current time, in base 62 form, and the
19693 inode of the file. The variable &$inode$& is available only when expanding this
19694 option.
19695
19696
19697 .option directory_mode appendfile "octal integer" 0700
19698 If &(appendfile)& creates any directories as a result of the
19699 &%create_directory%& option, their mode is specified by this option.
19700
19701
19702 .option escape_string appendfile string "see description"
19703 See &%check_string%& above.
19704
19705
19706 .option file appendfile string&!! unset
19707 This option is mutually exclusive with the &%directory%& option, but one of
19708 &%file%& or &%directory%& must be set, unless the delivery is the direct result
19709 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
19710 specifies a single file, to which the message is appended. One or more of
19711 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
19712 &%file%&.
19713
19714 .cindex "NFS" "lock file"
19715 .cindex "locking files"
19716 .cindex "lock files"
19717 If you are using more than one host to deliver over NFS into the same
19718 mailboxes, you should always use lock files.
19719
19720 The string value is expanded for each delivery, and must yield an absolute
19721 path. The most common settings of this option are variations on one of these
19722 examples:
19723 .code
19724 file = /var/spool/mail/$local_part
19725 file = /home/$local_part/inbox
19726 file = $home/inbox
19727 .endd
19728 .cindex "&""sticky""& bit"
19729 In the first example, all deliveries are done into the same directory. If Exim
19730 is configured to use lock files (see &%use_lockfile%& below) it must be able to
19731 create a file in the directory, so the &"sticky"& bit must be turned on for
19732 deliveries to be possible, or alternatively the &%group%& option can be used to
19733 run the delivery under a group id which has write access to the directory.
19734
19735
19736
19737 .option file_format appendfile string unset
19738 .cindex "file" "mailbox; checking existing format"
19739 This option requests the transport to check the format of an existing file
19740 before adding to it. The check consists of matching a specific string at the
19741 start of the file. The value of the option consists of an even number of
19742 colon-separated strings. The first of each pair is the test string, and the
19743 second is the name of a transport. If the transport associated with a matched
19744 string is not the current transport, control is passed over to the other
19745 transport. For example, suppose the standard &(local_delivery)& transport has
19746 this added to it:
19747 .code
19748 file_format = "From       : local_delivery :\
19749                \1\1\1\1\n : local_mmdf_delivery"
19750 .endd
19751 Mailboxes that begin with &"From"& are still handled by this transport, but if
19752 a mailbox begins with four binary ones followed by a newline, control is passed
19753 to a transport called &%local_mmdf_delivery%&, which presumably is configured
19754 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
19755 is assumed to match the current transport. If the start of a mailbox doesn't
19756 match any string, or if the transport named for a given string is not defined,
19757 delivery is deferred.
19758
19759
19760 .option file_must_exist appendfile boolean false
19761 If this option is true, the file specified by the &%file%& option must exist.
19762 A temporary error occurs if it does not, causing delivery to be deferred.
19763 If this option is false, the file is created if it does not exist.
19764
19765
19766 .option lock_fcntl_timeout appendfile time 0s
19767 .cindex "timeout" "mailbox locking"
19768 .cindex "mailbox" "locking, blocking and non-blocking"
19769 .cindex "locking files"
19770 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
19771 when locking an open mailbox file. If the call fails, the delivery process
19772 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
19773 Non-blocking calls are used so that the file is not kept open during the wait
19774 for the lock; the reason for this is to make it as safe as possible for
19775 deliveries over NFS in the case when processes might be accessing an NFS
19776 mailbox without using a lock file. This should not be done, but
19777 misunderstandings and hence misconfigurations are not unknown.
19778
19779 On a busy system, however, the performance of a non-blocking lock approach is
19780 not as good as using a blocking lock with a timeout. In this case, the waiting
19781 is done inside the system call, and Exim's delivery process acquires the lock
19782 and can proceed as soon as the previous lock holder releases it.
19783
19784 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
19785 timeout, are used. There may still be some retrying: the maximum number of
19786 retries is
19787 .code
19788 (lock_retries * lock_interval) / lock_fcntl_timeout
19789 .endd
19790 rounded up to the next whole number. In other words, the total time during
19791 which &(appendfile)& is trying to get a lock is roughly the same, unless
19792 &%lock_fcntl_timeout%& is set very large.
19793
19794 You should consider setting this option if you are getting a lot of delayed
19795 local deliveries because of errors of the form
19796 .code
19797 failed to lock mailbox /some/file (fcntl)
19798 .endd
19799
19800 .option lock_flock_timeout appendfile time 0s
19801 This timeout applies to file locking when using &[flock()]& (see
19802 &%use_flock%&); the timeout operates in a similar manner to
19803 &%lock_fcntl_timeout%&.
19804
19805
19806 .option lock_interval appendfile time 3s
19807 This specifies the time to wait between attempts to lock the file. See below
19808 for details of locking.
19809
19810
19811 .option lock_retries appendfile integer 10
19812 This specifies the maximum number of attempts to lock the file. A value of zero
19813 is treated as 1. See below for details of locking.
19814
19815
19816 .option lockfile_mode appendfile "octal integer" 0600
19817 This specifies the mode of the created lock file, when a lock file is being
19818 used (see &%use_lockfile%& and &%use_mbx_lock%&).
19819
19820
19821 .option lockfile_timeout appendfile time 30m
19822 .cindex "timeout" "mailbox locking"
19823 When a lock file is being used (see &%use_lockfile%&), if a lock file already
19824 exists and is older than this value, it is assumed to have been left behind by
19825 accident, and Exim attempts to remove it.
19826
19827
19828 .option mailbox_filecount appendfile string&!! unset
19829 .cindex "mailbox" "specifying size of"
19830 .cindex "size" "of mailbox"
19831 If this option is set, it is expanded, and the result is taken as the current
19832 number of files in the mailbox. It must be a decimal number, optionally
19833 followed by K or M. This provides a way of obtaining this information from an
19834 external source that maintains the data.
19835
19836
19837 .option mailbox_size appendfile string&!! unset
19838 .cindex "mailbox" "specifying size of"
19839 .cindex "size" "of mailbox"
19840 If this option is set, it is expanded, and the result is taken as the current
19841 size the mailbox. It must be a decimal number, optionally followed by K or M.
19842 This provides a way of obtaining this information from an external source that
19843 maintains the data. This is likely to be helpful for maildir deliveries where
19844 it is computationally expensive to compute the size of a mailbox.
19845
19846
19847
19848 .option maildir_format appendfile boolean false
19849 .cindex "maildir format" "specifying"
19850 If this option is set with the &%directory%& option, the delivery is into a new
19851 file, in the &"maildir"& format that is used by other mail software. When the
19852 transport is activated directly from a &(redirect)& router (for example, the
19853 &(address_file)& transport in the default configuration), setting
19854 &%maildir_format%& causes the path received from the router to be treated as a
19855 directory, whether or not it ends with &`/`&. This option is available only if
19856 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
19857 &<<SECTmaildirdelivery>>& below for further details.
19858
19859
19860 .option maildir_quota_directory_regex appendfile string "See below"
19861 .cindex "maildir format" "quota; directories included in"
19862 .cindex "quota" "maildir; directories included in"
19863 This option is relevant only when &%maildir_use_size_file%& is set. It defines
19864 a regular expression for specifying directories, relative to the quota
19865 directory (see &%quota_directory%&), that should be included in the quota
19866 calculation. The default value is:
19867 .code
19868 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
19869 .endd
19870 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
19871 (directories whose names begin with a dot). If you want to exclude the
19872 &_Trash_&
19873 folder from the count (as some sites do), you need to change this setting to
19874 .code
19875 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
19876 .endd
19877 This uses a negative lookahead in the regular expression to exclude the
19878 directory whose name is &_.Trash_&. When a directory is excluded from quota
19879 calculations, quota processing is bypassed for any messages that are delivered
19880 directly into that directory.
19881
19882
19883 .option maildir_retries appendfile integer 10
19884 This option specifies the number of times to retry when writing a file in
19885 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
19886
19887
19888 .option maildir_tag appendfile string&!! unset
19889 This option applies only to deliveries in maildir format, and is described in
19890 section &<<SECTmaildirdelivery>>& below.
19891
19892
19893 .option maildir_use_size_file appendfile boolean false
19894 .cindex "maildir format" "&_maildirsize_& file"
19895 Setting this option true enables support for &_maildirsize_& files. Exim
19896 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
19897 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
19898 value is zero. See &%maildir_quota_directory_regex%& above and section
19899 &<<SECTmaildirdelivery>>& below for further details.
19900
19901 .option maildirfolder_create_regex appendfile string unset
19902 .cindex "maildir format" "&_maildirfolder_& file"
19903 .cindex "&_maildirfolder_&, creating"
19904 The value of this option is a regular expression. If it is unset, it has no
19905 effect. Otherwise, before a maildir delivery takes place, the pattern is
19906 matched against the name of the maildir directory, that is, the directory
19907 containing the &_new_& and &_tmp_& subdirectories that will be used for the
19908 delivery. If there is a match, Exim checks for the existence of a file called
19909 &_maildirfolder_& in the directory, and creates it if it does not exist.
19910 See section &<<SECTmaildirdelivery>>& for more details.
19911
19912
19913 .option mailstore_format appendfile boolean false
19914 .cindex "mailstore format" "specifying"
19915 If this option is set with the &%directory%& option, the delivery is into two
19916 new files in  &"mailstore"& format. The option is available only if
19917 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
19918 below for further details.
19919
19920
19921 .option mailstore_prefix appendfile string&!! unset
19922 This option applies only to deliveries in mailstore format, and is described in
19923 section &<<SECTopdir>>& below.
19924
19925
19926 .option mailstore_suffix appendfile string&!! unset
19927 This option applies only to deliveries in mailstore format, and is described in
19928 section &<<SECTopdir>>& below.
19929
19930
19931 .option mbx_format appendfile boolean false
19932 .cindex "locking files"
19933 .cindex "file" "locking"
19934 .cindex "file" "MBX format"
19935 .cindex "MBX format, specifying"
19936 This option is available only if Exim has been compiled with SUPPORT_MBX
19937 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
19938 the message is appended to the mailbox file in MBX format instead of
19939 traditional Unix format. This format is supported by Pine4 and its associated
19940 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
19941
19942 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
19943 automatically changed by the use of &%mbx_format%&. They should normally be set
19944 empty when using MBX format, so this option almost always appears in this
19945 combination:
19946 .code
19947 mbx_format = true
19948 message_prefix =
19949 message_suffix =
19950 .endd
19951 If none of the locking options are mentioned in the configuration,
19952 &%use_mbx_lock%& is assumed and the other locking options default to false. It
19953 is possible to specify the other kinds of locking with &%mbx_format%&, but
19954 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
19955 interworks with &'c-client'&, providing for shared access to the mailbox. It
19956 should not be used if any program that does not use this form of locking is
19957 going to access the mailbox, nor should it be used if the mailbox file is NFS
19958 mounted, because it works only when the mailbox is accessed from a single host.
19959
19960 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
19961 the standard version of &'c-client'&, because as long as it has a mailbox open
19962 (this means for the whole of a Pine or IMAP session), Exim will not be able to
19963 append messages to it.
19964
19965
19966 .option message_prefix appendfile string&!! "see below"
19967 .cindex "&""From""& line"
19968 The string specified here is expanded and output at the start of every message.
19969 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
19970 in which case it is:
19971 .code
19972 message_prefix = "From ${if def:return_path{$return_path}\
19973   {MAILER-DAEMON}} $tod_bsdinbox\n"
19974 .endd
19975 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
19976 &`\n`& to &`\r\n`& in &%message_prefix%&.
19977
19978 .option message_suffix appendfile string&!! "see below"
19979 The string specified here is expanded and output at the end of every message.
19980 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
19981 in which case it is a single newline character. The suffix can be suppressed by
19982 setting
19983 .code
19984 message_suffix =
19985 .endd
19986 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
19987 &`\n`& to &`\r\n`& in &%message_suffix%&.
19988
19989 .option mode appendfile "octal integer" 0600
19990 If the output file is created, it is given this mode. If it already exists and
19991 has wider permissions, they are reduced to this mode. If it has narrower
19992 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
19993 if the delivery is the result of a &%save%& command in a filter file specifying
19994 a particular mode, the mode of the output file is always forced to take that
19995 value, and this option is ignored.
19996
19997
19998 .option mode_fail_narrower appendfile boolean true
19999 This option applies in the case when an existing mailbox file has a narrower
20000 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
20001 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
20002 continues with the delivery attempt, using the existing mode of the file.
20003
20004
20005 .option notify_comsat appendfile boolean false
20006 If this option is true, the &'comsat'& daemon is notified after every
20007 successful delivery to a user mailbox. This is the daemon that notifies logged
20008 on users about incoming mail.
20009
20010
20011 .option quota appendfile string&!! unset
20012 .cindex "quota" "imposed by Exim"
20013 This option imposes a limit on the size of the file to which Exim is appending,
20014 or to the total space used in the directory tree when the &%directory%& option
20015 is set. In the latter case, computation of the space used is expensive, because
20016 all the files in the directory (and any sub-directories) have to be
20017 individually inspected and their sizes summed. (See &%quota_size_regex%& and
20018 &%maildir_use_size_file%& for ways to avoid this in environments where users
20019 have no shell access to their mailboxes).
20020
20021 As there is no interlock against two simultaneous deliveries into a
20022 multi-file mailbox, it is possible for the quota to be overrun in this case.
20023 For single-file mailboxes, of course, an interlock is a necessity.
20024
20025 A file's size is taken as its &'used'& value. Because of blocking effects, this
20026 may be a lot less than the actual amount of disk space allocated to the file.
20027 If the sizes of a number of files are being added up, the rounding effect can
20028 become quite noticeable, especially on systems that have large block sizes.
20029 Nevertheless, it seems best to stick to the &'used'& figure, because this is
20030 the obvious value which users understand most easily.
20031
20032 The value of the option is expanded, and must then be a numerical value
20033 (decimal point allowed), optionally followed by one of the letters K, M, or G,
20034 for kilobytes, megabytes, or gigabytes. If Exim is running on a system with
20035 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
20036 be handled.
20037
20038 &*Note*&: A value of zero is interpreted as &"no quota"&.
20039
20040 The expansion happens while Exim is running as root, before it changes uid for
20041 the delivery. This means that files that are inaccessible to the end user can
20042 be used to hold quota values that are looked up in the expansion. When delivery
20043 fails because this quota is exceeded, the handling of the error is as for
20044 system quota failures.
20045
20046 By default, Exim's quota checking mimics system quotas, and restricts the
20047 mailbox to the specified maximum size, though the value is not accurate to the
20048 last byte, owing to separator lines and additional headers that may get added
20049 during message delivery. When a mailbox is nearly full, large messages may get
20050 refused even though small ones are accepted, because the size of the current
20051 message is added to the quota when the check is made. This behaviour can be
20052 changed by setting &%quota_is_inclusive%& false. When this is done, the check
20053 for exceeding the quota does not include the current message. Thus, deliveries
20054 continue until the quota has been exceeded; thereafter, no further messages are
20055 delivered. See also &%quota_warn_threshold%&.
20056
20057
20058 .option quota_directory appendfile string&!! unset
20059 This option defines the directory to check for quota purposes when delivering
20060 into individual files. The default is the delivery directory, or, if a file
20061 called &_maildirfolder_& exists in a maildir directory, the parent of the
20062 delivery directory.
20063
20064
20065 .option quota_filecount appendfile string&!! 0
20066 This option applies when the &%directory%& option is set. It limits the total
20067 number of files in the directory (compare the inode limit in system quotas). It
20068 can only be used if &%quota%& is also set. The value is expanded; an expansion
20069 failure causes delivery to be deferred. A value of zero is interpreted as
20070 &"no quota"&.
20071
20072
20073 .option quota_is_inclusive appendfile boolean true
20074 See &%quota%& above.
20075
20076
20077 .option quota_size_regex appendfile string unset
20078 This option applies when one of the delivery modes that writes a separate file
20079 for each message is being used. When Exim wants to find the size of one of
20080 these files in order to test the quota, it first checks &%quota_size_regex%&.
20081 If this is set to a regular expression that matches the file name, and it
20082 captures one string, that string is interpreted as a representation of the
20083 file's size. The value of &%quota_size_regex%& is not expanded.
20084
20085 This feature is useful only when users have no shell access to their mailboxes
20086 &-- otherwise they could defeat the quota simply by renaming the files. This
20087 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
20088 the file length to the file name. For example:
20089 .code
20090 maildir_tag = ,S=$message_size
20091 quota_size_regex = ,S=(\d+)
20092 .endd
20093 An alternative to &$message_size$& is &$message_linecount$&, which contains the
20094 number of lines in the message.
20095
20096 The regular expression should not assume that the length is at the end of the
20097 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
20098 sometimes add other information onto the ends of message file names.
20099
20100
20101
20102 .option quota_warn_message appendfile string&!! "see below"
20103 See below for the use of this option. If it is not set when
20104 &%quota_warn_threshold%& is set, it defaults to
20105 .code
20106 quota_warn_message = "\
20107   To: $local_part@$domain\n\
20108   Subject: Your mailbox\n\n\
20109   This message is automatically created \
20110   by mail delivery software.\n\n\
20111   The size of your mailbox has exceeded \
20112   a warning threshold that is\n\
20113   set by the system administrator.\n"
20114 .endd
20115
20116
20117 .option quota_warn_threshold appendfile string&!! 0
20118 .cindex "quota" "warning threshold"
20119 .cindex "mailbox" "size warning"
20120 .cindex "size" "of mailbox"
20121 This option is expanded in the same way as &%quota%& (see above). If the
20122 resulting value is greater than zero, and delivery of the message causes the
20123 size of the file or total space in the directory tree to cross the given
20124 threshold, a warning message is sent. If &%quota%& is also set, the threshold
20125 may be specified as a percentage of it by following the value with a percent
20126 sign. For example:
20127 .code
20128 quota = 10M
20129 quota_warn_threshold = 75%
20130 .endd
20131 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
20132 percent sign is ignored.
20133
20134 The warning message itself is specified by the &%quota_warn_message%& option,
20135 and it must start with a &'To:'& header line containing the recipient(s) of the
20136 warning message. These do not necessarily have to include the recipient(s) of
20137 the original message. A &'Subject:'& line should also normally be supplied. You
20138 can include any other header lines that you want. If you do not include a
20139 &'From:'& line, the default is:
20140 .code
20141 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
20142 .endd
20143 .oindex &%errors_reply_to%&
20144 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
20145 option.
20146
20147 The &%quota%& option does not have to be set in order to use this option; they
20148 are independent of one another except when the threshold is specified as a
20149 percentage.
20150
20151
20152 .option use_bsmtp appendfile boolean false
20153 .cindex "envelope sender"
20154 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
20155 format, with the envelope sender and recipient(s) included as SMTP commands. If
20156 you want to include a leading HELO command with such messages, you can do
20157 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
20158 for details of batch SMTP.
20159
20160
20161 .option use_crlf appendfile boolean false
20162 .cindex "carriage return"
20163 .cindex "linefeed"
20164 This option causes lines to be terminated with the two-character CRLF sequence
20165 (carriage return, linefeed) instead of just a linefeed character. In the case
20166 of batched SMTP, the byte sequence written to the file is then an exact image
20167 of what would be sent down a real SMTP connection.
20168
20169 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
20170 (which are used to supply the traditional &"From&~"& and blank line separators
20171 in Berkeley-style mailboxes) are written verbatim, so must contain their own
20172 carriage return characters if these are needed. In cases where these options
20173 have non-empty defaults, the values end with a single linefeed, so they must be
20174 changed to end with &`\r\n`& if &%use_crlf%& is set.
20175
20176
20177 .option use_fcntl_lock appendfile boolean "see below"
20178 This option controls the use of the &[fcntl()]& function to lock a file for
20179 exclusive use when a message is being appended. It is set by default unless
20180 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
20181 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
20182 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
20183
20184
20185 .option use_flock_lock appendfile boolean false
20186 This option is provided to support the use of &[flock()]& for file locking, for
20187 the few situations where it is needed. Most modern operating systems support
20188 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
20189 each other. Exim uses &[fcntl()]& locking by default.
20190
20191 This option is required only if you are using an operating system where
20192 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
20193 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
20194 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
20195
20196 .cindex "Solaris" "&[flock()]& support"
20197 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
20198 have it (and some, I think, provide a not quite right version built on top of
20199 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
20200 the ability to use it, and any attempt to do so will cause a configuration
20201 error.
20202
20203 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
20204 is just being mapped onto &[fcntl()]& by the OS).
20205
20206
20207 .option use_lockfile appendfile boolean "see below"
20208 If this option is turned off, Exim does not attempt to create a lock file when
20209 appending to a mailbox file. In this situation, the only locking is by
20210 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
20211 sure that every MUA that is ever going to look at your users' mailboxes uses
20212 &[fcntl()]& rather than a lock file, and even then only when you are not
20213 delivering over NFS from more than one host.
20214
20215 .cindex "NFS" "lock file"
20216 In order to append to an NFS file safely from more than one host, it is
20217 necessary to take out a lock &'before'& opening the file, and the lock file
20218 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
20219 file corruption.
20220
20221 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
20222 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
20223 except when &%mbx_format%& is set.
20224
20225
20226 .option use_mbx_lock appendfile boolean "see below"
20227 This option is available only if Exim has been compiled with SUPPORT_MBX
20228 set in &_Local/Makefile_&. Setting the option specifies that special MBX
20229 locking rules be used. It is set by default if &%mbx_format%& is set and none
20230 of the locking options are mentioned in the configuration. The locking rules
20231 are the same as are used by the &'c-client'& library that underlies Pine and
20232 the IMAP4 and POP daemons that come with it (see the discussion below). The
20233 rules allow for shared access to the mailbox. However, this kind of locking
20234 does not work when the mailbox is NFS mounted.
20235
20236 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
20237 &%use_flock_lock%& to control what kind of locking is used in implementing the
20238 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
20239 without &%use_fcntl_lock%& or &%use_flock_lock%&.
20240
20241
20242
20243
20244 .section "Operational details for appending" "SECTopappend"
20245 .cindex "appending to a file"
20246 .cindex "file" "appending"
20247 Before appending to a file, the following preparations are made:
20248
20249 .ilist
20250 If the name of the file is &_/dev/null_&, no action is taken, and a success
20251 return is given.
20252
20253 .next
20254 .cindex "directory creation"
20255 If any directories on the file's path are missing, Exim creates them if the
20256 &%create_directory%& option is set. A created directory's mode is given by the
20257 &%directory_mode%& option.
20258
20259 .next
20260 If &%file_format%& is set, the format of an existing file is checked. If this
20261 indicates that a different transport should be used, control is passed to that
20262 transport.
20263
20264 .next
20265 .cindex "file" "locking"
20266 .cindex "locking files"
20267 .cindex "NFS" "lock file"
20268 If &%use_lockfile%& is set, a lock file is built in a way that will work
20269 reliably over NFS, as follows:
20270
20271 .olist
20272 Create a &"hitching post"& file whose name is that of the lock file with the
20273 current time, primary host name, and process id added, by opening for writing
20274 as a new file. If this fails with an access error, delivery is deferred.
20275 .next
20276 Close the hitching post file, and hard link it to the lock file name.
20277 .next
20278 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
20279 Unlink the hitching post name.
20280 .next
20281 Otherwise, use &[stat()]& to get information about the hitching post file, and
20282 then unlink hitching post name. If the number of links is exactly two, creation
20283 of the lock file succeeded but something (for example, an NFS server crash and
20284 restart) caused this fact not to be communicated to the &[link()]& call.
20285 .next
20286 If creation of the lock file failed, wait for &%lock_interval%& and try again,
20287 up to &%lock_retries%& times. However, since any program that writes to a
20288 mailbox should complete its task very quickly, it is reasonable to time out old
20289 lock files that are normally the result of user agent and system crashes. If an
20290 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
20291 it before trying again.
20292 .endlist olist
20293
20294 .next
20295 A call is made to &[lstat()]& to discover whether the main file exists, and if
20296 so, what its characteristics are. If &[lstat()]& fails for any reason other
20297 than non-existence, delivery is deferred.
20298
20299 .next
20300 .cindex "symbolic link" "to mailbox"
20301 .cindex "mailbox" "symbolic link"
20302 If the file does exist and is a symbolic link, delivery is deferred, unless the
20303 &%allow_symlink%& option is set, in which case the ownership of the link is
20304 checked, and then &[stat()]& is called to find out about the real file, which
20305 is then subjected to the checks below. The check on the top-level link
20306 ownership prevents one user creating a link for another's mailbox in a sticky
20307 directory, though allowing symbolic links in this case is definitely not a good
20308 idea. If there is a chain of symbolic links, the intermediate ones are not
20309 checked.
20310
20311 .next
20312 If the file already exists but is not a regular file, or if the file's owner
20313 and group (if the group is being checked &-- see &%check_group%& above) are
20314 different from the user and group under which the delivery is running,
20315 delivery is deferred.
20316
20317 .next
20318 If the file's permissions are more generous than specified, they are reduced.
20319 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
20320 is set false, in which case the delivery is tried using the existing
20321 permissions.
20322
20323 .next
20324 The file's inode number is saved, and the file is then opened for appending.
20325 If this fails because the file has vanished, &(appendfile)& behaves as if it
20326 hadn't existed (see below). For any other failures, delivery is deferred.
20327
20328 .next
20329 If the file is opened successfully, check that the inode number hasn't
20330 changed, that it is still a regular file, and that the owner and permissions
20331 have not changed. If anything is wrong, defer delivery and freeze the message.
20332
20333 .next
20334 If the file did not exist originally, defer delivery if the &%file_must_exist%&
20335 option is set. Otherwise, check that the file is being created in a permitted
20336 directory if the &%create_file%& option is set (deferring on failure), and then
20337 open for writing as a new file, with the O_EXCL and O_CREAT options,
20338 except when dealing with a symbolic link (the &%allow_symlink%& option must be
20339 set). In this case, which can happen if the link points to a non-existent file,
20340 the file is opened for writing using O_CREAT but not O_EXCL, because
20341 that prevents link following.
20342
20343 .next
20344 .cindex "loop" "while file testing"
20345 If opening fails because the file exists, obey the tests given above for
20346 existing files. However, to avoid looping in a situation where the file is
20347 being continuously created and destroyed, the exists/not-exists loop is broken
20348 after 10 repetitions, and the message is then frozen.
20349
20350 .next
20351 If opening fails with any other error, defer delivery.
20352
20353 .next
20354 .cindex "file" "locking"
20355 .cindex "locking files"
20356 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
20357 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
20358 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
20359 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
20360 file, and an exclusive lock on the file whose name is
20361 .code
20362 /tmp/.<device-number>.<inode-number>
20363 .endd
20364 using the device and inode numbers of the open mailbox file, in accordance with
20365 the MBX locking rules. This file is created with a mode that is specified by
20366 the &%lockfile_mode%& option.
20367
20368 If Exim fails to lock the file, there are two possible courses of action,
20369 depending on the value of the locking timeout. This is obtained from
20370 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
20371
20372 If the timeout value is zero, the file is closed, Exim waits for
20373 &%lock_interval%&, and then goes back and re-opens the file as above and tries
20374 to lock it again. This happens up to &%lock_retries%& times, after which the
20375 delivery is deferred.
20376
20377 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
20378 &[flock()]& are used (with the given timeout), so there has already been some
20379 waiting involved by the time locking fails. Nevertheless, Exim does not give up
20380 immediately. It retries up to
20381 .code
20382 (lock_retries * lock_interval) / <timeout>
20383 .endd
20384 times (rounded up).
20385 .endlist
20386
20387 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
20388 and/or &[flock()]& locks) and then deletes the lock file if one was created.
20389
20390
20391 .section "Operational details for delivery to a new file" "SECTopdir"
20392 .cindex "delivery" "to single file"
20393 .cindex "&""From""& line"
20394 When the &%directory%& option is set instead of &%file%&, each message is
20395 delivered into a newly-created file or set of files. When &(appendfile)& is
20396 activated directly from a &(redirect)& router, neither &%file%& nor
20397 &%directory%& is normally set, because the path for delivery is supplied by the
20398 router. (See for example, the &(address_file)& transport in the default
20399 configuration.) In this case, delivery is to a new file if either the path name
20400 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
20401
20402 No locking is required while writing the message to a new file, so the various
20403 locking options of the transport are ignored. The &"From"& line that by default
20404 separates messages in a single file is not normally needed, nor is the escaping
20405 of message lines that start with &"From"&, and there is no need to ensure a
20406 newline at the end of each message. Consequently, the default values for
20407 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
20408 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
20409
20410 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
20411 the files in the delivery directory by default. However, you can specify a
20412 different directory by setting &%quota_directory%&. Also, for maildir
20413 deliveries (see below) the &_maildirfolder_& convention is honoured.
20414
20415
20416 .cindex "maildir format"
20417 .cindex "mailstore format"
20418 There are three different ways in which delivery to individual files can be
20419 done, controlled by the settings of the &%maildir_format%& and
20420 &%mailstore_format%& options. Note that code to support maildir or mailstore
20421 formats is not included in the binary unless SUPPORT_MAILDIR or
20422 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
20423
20424 .cindex "directory creation"
20425 In all three cases an attempt is made to create the directory and any necessary
20426 sub-directories if they do not exist, provided that the &%create_directory%&
20427 option is set (the default). The location of a created directory can be
20428 constrained by setting &%create_file%&. A created directory's mode is given by
20429 the &%directory_mode%& option. If creation fails, or if the
20430 &%create_directory%& option is not set when creation is required, delivery is
20431 deferred.
20432
20433
20434
20435 .section "Maildir delivery" "SECTmaildirdelivery"
20436 .cindex "maildir format" "description of"
20437 If the &%maildir_format%& option is true, Exim delivers each message by writing
20438 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
20439 directory that is defined by the &%directory%& option (the &"delivery
20440 directory"&). If the delivery is successful, the file is renamed into the
20441 &_new_& subdirectory.
20442
20443 In the file name, <&'stime'&> is the current time of day in seconds, and
20444 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
20445 Exim checks that the time-of-day clock has moved on by at least one microsecond
20446 before terminating the delivery process. This guarantees uniqueness for the
20447 file name. However, as a precaution, Exim calls &[stat()]& for the file before
20448 opening it. If any response other than ENOENT (does not exist) is given,
20449 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
20450
20451 Before Exim carries out a maildir delivery, it ensures that subdirectories
20452 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
20453 do not exist, Exim tries to create them and any superior directories in their
20454 path, subject to the &%create_directory%& and &%create_file%& options. If the
20455 &%maildirfolder_create_regex%& option is set, and the regular expression it
20456 contains matches the delivery directory, Exim also ensures that a file called
20457 &_maildirfolder_& exists in the delivery directory. If a missing directory or
20458 &_maildirfolder_& file cannot be created, delivery is deferred.
20459
20460 These features make it possible to use Exim to create all the necessary files
20461 and directories in a maildir mailbox, including subdirectories for maildir++
20462 folders. Consider this example:
20463 .code
20464 maildir_format = true
20465 directory = /var/mail/$local_part\
20466            ${if eq{$local_part_suffix}{}{}\
20467            {/.${substr_1:$local_part_suffix}}}
20468 maildirfolder_create_regex = /\.[^/]+$
20469 .endd
20470 If &$local_part_suffix$& is empty (there was no suffix for the local part),
20471 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
20472 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
20473 not match this name, so Exim will not look for or create the file
20474 &_/var/mail/pimbo/maildirfolder_&, though it will create
20475 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
20476
20477 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
20478 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
20479 does match &%maildirfolder_create_regex%&. In this case, Exim will create
20480 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
20481 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
20482
20483 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
20484 not inadvertently match the toplevel maildir directory, because a
20485 &_maildirfolder_& file at top level would completely break quota calculations.
20486
20487 .cindex "quota" "in maildir delivery"
20488 .cindex "maildir++"
20489 If Exim is required to check a &%quota%& setting before a maildir delivery, and
20490 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
20491 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
20492 Exim assumes the directory is a maildir++ folder directory, which is one level
20493 down from the user's top level mailbox directory. This causes it to start at
20494 the parent directory instead of the current directory when calculating the
20495 amount of space used.
20496
20497 One problem with delivering into a multi-file mailbox is that it is
20498 computationally expensive to compute the size of the mailbox for quota
20499 checking. Various approaches have been taken to reduce the amount of work
20500 needed. The next two sections describe two of them. A third alternative is to
20501 use some external process for maintaining the size data, and use the expansion
20502 of the &%mailbox_size%& option as a way of importing it into Exim.
20503
20504
20505
20506
20507 .section "Using tags to record message sizes" "SECID135"
20508 If &%maildir_tag%& is set, the string is expanded for each delivery.
20509 When the maildir file is renamed into the &_new_& sub-directory, the
20510 tag is added to its name. However, if adding the tag takes the length of the
20511 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
20512 the tag is dropped and the maildir file is created with no tag.
20513
20514 .vindex "&$message_size$&"
20515 Tags can be used to encode the size of files in their names; see
20516 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
20517 happens after the message has been written. The value of the &$message_size$&
20518 variable is set to the number of bytes actually written. If the expansion is
20519 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
20520 be deferred. The expanded tag may contain any printing characters except &"/"&.
20521 Non-printing characters in the string are ignored; if the resulting string is
20522 empty, it is ignored. If it starts with an alphanumeric character, a leading
20523 colon is inserted.
20524
20525
20526
20527 .section "Using a maildirsize file" "SECID136"
20528 .cindex "quota" "in maildir delivery"
20529 .cindex "maildir format" "&_maildirsize_& file"
20530 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
20531 storing quota and message size information in a file called &_maildirsize_&
20532 within the toplevel maildir directory. If this file does not exist, Exim
20533 creates it, setting the quota from the &%quota%& option of the transport. If
20534 the maildir directory itself does not exist, it is created before any attempt
20535 to write a &_maildirsize_& file.
20536
20537 The &_maildirsize_& file is used to hold information about the sizes of
20538 messages in the maildir, thus speeding up quota calculations. The quota value
20539 in the file is just a cache; if the quota is changed in the transport, the new
20540 value overrides the cached value when the next message is delivered. The cache
20541 is maintained for the benefit of other programs that access the maildir and
20542 need to know the quota.
20543
20544 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
20545 file is maintained (with a zero quota setting), but no quota is imposed.
20546
20547 A regular expression is available for controlling which directories in the
20548 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
20549 See the description of the &%maildir_quota_directory_regex%& option above for
20550 details.
20551
20552
20553 .section "Mailstore delivery" "SECID137"
20554 .cindex "mailstore format" "description of"
20555 If the &%mailstore_format%& option is true, each message is written as two
20556 files in the given directory. A unique base name is constructed from the
20557 message id and the current delivery process, and the files that are written use
20558 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
20559 contains the message's envelope, and the &_.msg_& file contains the message
20560 itself. The base name is placed in the variable &$mailstore_basename$&.
20561
20562 During delivery, the envelope is first written to a file with the suffix
20563 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
20564 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
20565 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
20566 file before accessing either of them. An alternative approach is to wait for
20567 the absence of a &_.tmp_& file.
20568
20569 The envelope file starts with any text defined by the &%mailstore_prefix%&
20570 option, expanded and terminated by a newline if there isn't one. Then follows
20571 the sender address on one line, then all the recipient addresses, one per line.
20572 There can be more than one recipient only if the &%batch_max%& option is set
20573 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
20574 appended to the file, followed by a newline if it does not end with one.
20575
20576 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
20577 failure, it is ignored. Other expansion errors are treated as serious
20578 configuration errors, and delivery is deferred. The variable
20579 &$mailstore_basename$& is available for use during these expansions.
20580
20581
20582 .section "Non-special new file delivery" "SECID138"
20583 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
20584 file is created directly in the named directory. For example, when delivering
20585 messages into files in batched SMTP format for later delivery to some host (see
20586 section &<<SECTbatchSMTP>>&), a setting such as
20587 .code
20588 directory = /var/bsmtp/$host
20589 .endd
20590 might be used. A message is written to a file with a temporary name, which is
20591 then renamed when the delivery is complete. The final name is obtained by
20592 expanding the contents of the &%directory_file%& option.
20593 .ecindex IIDapptra1
20594 .ecindex IIDapptra2
20595
20596
20597
20598
20599
20600
20601 . ////////////////////////////////////////////////////////////////////////////
20602 . ////////////////////////////////////////////////////////////////////////////
20603
20604 .chapter "The autoreply transport" "CHID8"
20605 .scindex IIDauttra1 "transports" "&(autoreply)&"
20606 .scindex IIDauttra2 "&(autoreply)& transport"
20607 The &(autoreply)& transport is not a true transport in that it does not cause
20608 the message to be transmitted. Instead, it generates a new mail message as an
20609 automatic reply to the incoming message. &'References:'& and
20610 &'Auto-Submitted:'& header lines are included. These are constructed according
20611 to the rules in RFCs 2822 and 3834, respectively.
20612
20613 If the router that passes the message to this transport does not have the
20614 &%unseen%& option set, the original message (for the current recipient) is not
20615 delivered anywhere. However, when the &%unseen%& option is set on the router
20616 that passes the message to this transport, routing of the address continues, so
20617 another router can set up a normal message delivery.
20618
20619
20620 The &(autoreply)& transport is usually run as the result of mail filtering, a
20621 &"vacation"& message being the standard example. However, it can also be run
20622 directly from a router like any other transport. To reduce the possibility of
20623 message cascades, messages created by the &(autoreply)& transport always have
20624 empty envelope sender addresses, like bounce messages.
20625
20626 The parameters of the message to be sent can be specified in the configuration
20627 by options described below. However, these are used only when the address
20628 passed to the transport does not contain its own reply information. When the
20629 transport is run as a consequence of a
20630 &%mail%&
20631 or &%vacation%& command in a filter file, the parameters of the message are
20632 supplied by the filter, and passed with the address. The transport's options
20633 that define the message are then ignored (so they are not usually set in this
20634 case). The message is specified entirely by the filter or by the transport; it
20635 is never built from a mixture of options. However, the &%file_optional%&,
20636 &%mode%&, and &%return_message%& options apply in all cases.
20637
20638 &(Autoreply)& is implemented as a local transport. When used as a result of a
20639 command in a user's filter file, &(autoreply)& normally runs under the uid and
20640 gid of the user, and with appropriate current and home directories (see chapter
20641 &<<CHAPenvironment>>&).
20642
20643 There is a subtle difference between routing a message to a &(pipe)& transport
20644 that generates some text to be returned to the sender, and routing it to an
20645 &(autoreply)& transport. This difference is noticeable only if more than one
20646 address from the same message is so handled. In the case of a pipe, the
20647 separate outputs from the different addresses are gathered up and returned to
20648 the sender in a single message, whereas if &(autoreply)& is used, a separate
20649 message is generated for each address that is passed to it.
20650
20651 Non-printing characters are not permitted in the header lines generated for the
20652 message that &(autoreply)& creates, with the exception of newlines that are
20653 immediately followed by white space. If any non-printing characters are found,
20654 the transport defers.
20655 Whether characters with the top bit set count as printing characters or not is
20656 controlled by the &%print_topbitchars%& global option.
20657
20658 If any of the generic options for manipulating headers (for example,
20659 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
20660 of the original message that is included in the generated message when
20661 &%return_message%& is set. They do not apply to the generated message itself.
20662
20663 .vindex "&$sender_address$&"
20664 If the &(autoreply)& transport receives return code 2 from Exim when it submits
20665 the message, indicating that there were no recipients, it does not treat this
20666 as an error. This means that autoreplies sent to &$sender_address$& when this
20667 is empty (because the incoming message is a bounce message) do not cause
20668 problems. They are just discarded.
20669
20670
20671
20672 .section "Private options for autoreply" "SECID139"
20673 .cindex "options" "&(autoreply)& transport"
20674
20675 .option bcc autoreply string&!! unset
20676 This specifies the addresses that are to receive &"blind carbon copies"& of the
20677 message when the message is specified by the transport.
20678
20679
20680 .option cc autoreply string&!! unset
20681 This specifies recipients of the message and the contents of the &'Cc:'& header
20682 when the message is specified by the transport.
20683
20684
20685 .option file autoreply string&!! unset
20686 The contents of the file are sent as the body of the message when the message
20687 is specified by the transport. If both &%file%& and &%text%& are set, the text
20688 string comes first.
20689
20690
20691 .option file_expand autoreply boolean false
20692 If this is set, the contents of the file named by the &%file%& option are
20693 subjected to string expansion as they are added to the message.
20694
20695
20696 .option file_optional autoreply boolean false
20697 If this option is true, no error is generated if the file named by the &%file%&
20698 option or passed with the address does not exist or cannot be read.
20699
20700
20701 .option from autoreply string&!! unset
20702 This specifies the contents of the &'From:'& header when the message is
20703 specified by the transport.
20704
20705
20706 .option headers autoreply string&!! unset
20707 This specifies additional RFC 2822 headers that are to be added to the message
20708 when the message is specified by the transport. Several can be given by using
20709 &"\n"& to separate them. There is no check on the format.
20710
20711
20712 .option log autoreply string&!! unset
20713 This option names a file in which a record of every message sent is logged when
20714 the message is specified by the transport.
20715
20716
20717 .option mode autoreply "octal integer" 0600
20718 If either the log file or the &"once"& file has to be created, this mode is
20719 used.
20720
20721
20722 .option never_mail autoreply "address list&!!" unset
20723 If any run of the transport creates a message with a recipient that matches any
20724 item in the list, that recipient is quietly discarded. If all recipients are
20725 discarded, no message is created. This applies both when the recipients are
20726 generated by a filter and when they are specified in the transport.
20727
20728
20729
20730 .option once autoreply string&!! unset
20731 This option names a file or DBM database in which a record of each &'To:'&
20732 recipient is kept when the message is specified by the transport. &*Note*&:
20733 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
20734
20735 If &%once%& is unset, or is set to an empty string, the message is always sent.
20736 By default, if &%once%& is set to a non-empty file name, the message
20737 is not sent if a potential recipient is already listed in the database.
20738 However, if the &%once_repeat%& option specifies a time greater than zero, the
20739 message is sent if that much time has elapsed since a message was last sent to
20740 this recipient. A setting of zero time for &%once_repeat%& (the default)
20741 prevents a message from being sent a second time &-- in this case, zero means
20742 infinity.
20743
20744 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
20745 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
20746 greater than zero, it changes the way Exim implements the &%once%& option.
20747 Instead of using a DBM file to record every recipient it sends to, it uses a
20748 regular file, whose size will never get larger than the given value.
20749
20750 In the file, Exim keeps a linear list of recipient addresses and the times at
20751 which they were sent messages. If the file is full when a new address needs to
20752 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
20753 means that a given recipient may receive multiple messages, but at
20754 unpredictable intervals that depend on the rate of turnover of addresses in the
20755 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
20756
20757
20758 .option once_file_size autoreply integer 0
20759 See &%once%& above.
20760
20761
20762 .option once_repeat autoreply time&!! 0s
20763 See &%once%& above.
20764 After expansion, the value of this option must be a valid time value.
20765
20766
20767 .option reply_to autoreply string&!! unset
20768 This specifies the contents of the &'Reply-To:'& header when the message is
20769 specified by the transport.
20770
20771
20772 .option return_message autoreply boolean false
20773 If this is set, a copy of the original message is returned with the new
20774 message, subject to the maximum size set in the &%return_size_limit%& global
20775 configuration option.
20776
20777
20778 .option subject autoreply string&!! unset
20779 This specifies the contents of the &'Subject:'& header when the message is
20780 specified by the transport. It is tempting to quote the original subject in
20781 automatic responses. For example:
20782 .code
20783 subject = Re: $h_subject:
20784 .endd
20785 There is a danger in doing this, however. It may allow a third party to
20786 subscribe your users to an opt-in mailing list, provided that the list accepts
20787 bounce messages as subscription confirmations. Well-managed lists require a
20788 non-bounce message to confirm a subscription, so the danger is relatively
20789 small.
20790
20791
20792
20793 .option text autoreply string&!! unset
20794 This specifies a single string to be used as the body of the message when the
20795 message is specified by the transport. If both &%text%& and &%file%& are set,
20796 the text comes first.
20797
20798
20799 .option to autoreply string&!! unset
20800 This specifies recipients of the message and the contents of the &'To:'& header
20801 when the message is specified by the transport.
20802 .ecindex IIDauttra1
20803 .ecindex IIDauttra2
20804
20805
20806
20807
20808 . ////////////////////////////////////////////////////////////////////////////
20809 . ////////////////////////////////////////////////////////////////////////////
20810
20811 .chapter "The lmtp transport" "CHAPLMTP"
20812 .cindex "transports" "&(lmtp)&"
20813 .cindex "&(lmtp)& transport"
20814 .cindex "LMTP" "over a pipe"
20815 .cindex "LMTP" "over a socket"
20816 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
20817 specified command
20818 or by interacting with a Unix domain socket.
20819 This transport is something of a cross between the &(pipe)& and &(smtp)&
20820 transports. Exim also has support for using LMTP over TCP/IP; this is
20821 implemented as an option for the &(smtp)& transport. Because LMTP is expected
20822 to be of minority interest, the default build-time configure in &_src/EDITME_&
20823 has it commented out. You need to ensure that
20824 .code
20825 TRANSPORT_LMTP=yes
20826 .endd
20827 .cindex "options" "&(lmtp)& transport"
20828 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
20829 included in the Exim binary. The private options of the &(lmtp)& transport are
20830 as follows:
20831
20832 .option batch_id lmtp string&!! unset
20833 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20834
20835
20836 .option batch_max lmtp integer 1
20837 This limits the number of addresses that can be handled in a single delivery.
20838 Most LMTP servers can handle several addresses at once, so it is normally a
20839 good idea to increase this value. See the description of local delivery
20840 batching in chapter &<<CHAPbatching>>&.
20841
20842
20843 .option command lmtp string&!! unset
20844 This option must be set if &%socket%& is not set. The string is a command which
20845 is run in a separate process. It is split up into a command name and list of
20846 arguments, each of which is separately expanded (so expansion cannot change the
20847 number of arguments). The command is run directly, not via a shell. The message
20848 is passed to the new process using the standard input and output to operate the
20849 LMTP protocol.
20850
20851 .option ignore_quota lmtp boolean false
20852 .cindex "LMTP" "ignoring quota errors"
20853 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
20854 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
20855 in its response to the LHLO command.
20856
20857 .option socket lmtp string&!! unset
20858 This option must be set if &%command%& is not set. The result of expansion must
20859 be the name of a Unix domain socket. The transport connects to the socket and
20860 delivers the message to it using the LMTP protocol.
20861
20862
20863 .option timeout lmtp time 5m
20864 The transport is aborted if the created process or Unix domain socket does not
20865 respond to LMTP commands or message input within this timeout. Delivery
20866 is deferred, and will be tried again later. Here is an example of a typical
20867 LMTP transport:
20868 .code
20869 lmtp:
20870   driver = lmtp
20871   command = /some/local/lmtp/delivery/program
20872   batch_max = 20
20873   user = exim
20874 .endd
20875 This delivers up to 20 addresses at a time, in a mixture of domains if
20876 necessary, running as the user &'exim'&.
20877
20878
20879
20880 . ////////////////////////////////////////////////////////////////////////////
20881 . ////////////////////////////////////////////////////////////////////////////
20882
20883 .chapter "The pipe transport" "CHAPpipetransport"
20884 .scindex IIDpiptra1 "transports" "&(pipe)&"
20885 .scindex IIDpiptra2 "&(pipe)& transport"
20886 The &(pipe)& transport is used to deliver messages via a pipe to a command
20887 running in another process. One example is the use of &(pipe)& as a
20888 pseudo-remote transport for passing messages to some other delivery mechanism
20889 (such as UUCP). Another is the use by individual users to automatically process
20890 their incoming messages. The &(pipe)& transport can be used in one of the
20891 following ways:
20892
20893 .ilist
20894 .vindex "&$local_part$&"
20895 A router routes one address to a transport in the normal way, and the
20896 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
20897 contains the local part of the address (as usual), and the command that is run
20898 is specified by the &%command%& option on the transport.
20899 .next
20900 .vindex "&$pipe_addresses$&"
20901 If the &%batch_max%& option is set greater than 1 (the default is 1), the
20902 transport can handle more than one address in a single run. In this case, when
20903 more than one address is routed to the transport, &$local_part$& is not set
20904 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
20905 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
20906 that are routed to the transport.
20907 .next
20908 .vindex "&$address_pipe$&"
20909 A router redirects an address directly to a pipe command (for example, from an
20910 alias or forward file). In this case, &$address_pipe$& contains the text of the
20911 pipe command, and the &%command%& option on the transport is ignored. If only
20912 one address is being transported (&%batch_max%& is not greater than one, or
20913 only one address was redirected to this pipe command), &$local_part$& contains
20914 the local part that was redirected.
20915 .endlist
20916
20917
20918 The &(pipe)& transport is a non-interactive delivery method. Exim can also
20919 deliver messages over pipes using the LMTP interactive protocol. This is
20920 implemented by the &(lmtp)& transport.
20921
20922 In the case when &(pipe)& is run as a consequence of an entry in a local user's
20923 &_.forward_& file, the command runs under the uid and gid of that user. In
20924 other cases, the uid and gid have to be specified explicitly, either on the
20925 transport or on the router that handles the address. Current and &"home"&
20926 directories are also controllable. See chapter &<<CHAPenvironment>>& for
20927 details of the local delivery environment and chapter &<<CHAPbatching>>&
20928 for a discussion of local delivery batching.
20929
20930
20931 .section "Concurrent delivery" "SECID140"
20932 If two messages arrive at almost the same time, and both are routed to a pipe
20933 delivery, the two pipe transports may be run concurrently. You must ensure that
20934 any pipe commands you set up are robust against this happening. If the commands
20935 write to a file, the &%exim_lock%& utility might be of use.
20936
20937
20938
20939
20940 .section "Returned status and data" "SECID141"
20941 .cindex "&(pipe)& transport" "returned data"
20942 If the command exits with a non-zero return code, the delivery is deemed to
20943 have failed, unless either the &%ignore_status%& option is set (in which case
20944 the return code is treated as zero), or the return code is one of those listed
20945 in the &%temp_errors%& option, which are interpreted as meaning &"try again
20946 later"&. In this case, delivery is deferred. Details of a permanent failure are
20947 logged, but are not included in the bounce message, which merely contains
20948 &"local delivery failed"&.
20949
20950 If the return code is greater than 128 and the command being run is a shell
20951 script, it normally means that the script was terminated by a signal whose
20952 value is the return code minus 128.
20953
20954 If Exim is unable to run the command (that is, if &[execve()]& fails), the
20955 return code is set to 127. This is the value that a shell returns if it is
20956 asked to run a non-existent command. The wording for the log line suggests that
20957 a non-existent command may be the problem.
20958
20959 The &%return_output%& option can affect the result of a pipe delivery. If it is
20960 set and the command produces any output on its standard output or standard
20961 error streams, the command is considered to have failed, even if it gave a zero
20962 return code or if &%ignore_status%& is set. The output from the command is
20963 included as part of the bounce message. The &%return_fail_output%& option is
20964 similar, except that output is returned only when the command exits with a
20965 failure return code, that is, a value other than zero or a code that matches
20966 &%temp_errors%&.
20967
20968
20969
20970 .section "How the command is run" "SECThowcommandrun"
20971 .cindex "&(pipe)& transport" "path for command"
20972 The command line is (by default) broken down into a command name and arguments
20973 by the &(pipe)& transport itself. The &%allow_commands%& and
20974 &%restrict_to_path%& options can be used to restrict the commands that may be
20975 run.
20976
20977 .cindex "quoting" "in pipe command"
20978 Unquoted arguments are delimited by white space. If an argument appears in
20979 double quotes, backslash is interpreted as an escape character in the usual
20980 way. If an argument appears in single quotes, no escaping is done.
20981
20982 String expansion is applied to the command line except when it comes from a
20983 traditional &_.forward_& file (commands from a filter file are expanded). The
20984 expansion is applied to each argument in turn rather than to the whole line.
20985 For this reason, any string expansion item that contains white space must be
20986 quoted so as to be contained within a single argument. A setting such as
20987 .code
20988 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
20989 .endd
20990 will not work, because the expansion item gets split between several
20991 arguments. You have to write
20992 .code
20993 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
20994 .endd
20995 to ensure that it is all in one argument. The expansion is done in this way,
20996 argument by argument, so that the number of arguments cannot be changed as a
20997 result of expansion, and quotes or backslashes in inserted variables do not
20998 interact with external quoting. However, this leads to problems if you want to
20999 generate multiple arguments (or the command name plus arguments) from a single
21000 expansion. In this situation, the simplest solution is to use a shell. For
21001 example:
21002 .code
21003 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
21004 .endd
21005
21006 .cindex "transport" "filter"
21007 .cindex "filter" "transport filter"
21008 .vindex "&$pipe_addresses$&"
21009 Special handling takes place when an argument consists of precisely the text
21010 &`$pipe_addresses`&. This is not a general expansion variable; the only
21011 place this string is recognized is when it appears as an argument for a pipe or
21012 transport filter command. It causes each address that is being handled to be
21013 inserted in the argument list at that point &'as a separate argument'&. This
21014 avoids any problems with spaces or shell metacharacters, and is of use when a
21015 &(pipe)& transport is handling groups of addresses in a batch.
21016
21017 After splitting up into arguments and expansion, the resulting command is run
21018 in a subprocess directly from the transport, &'not'& under a shell. The
21019 message that is being delivered is supplied on the standard input, and the
21020 standard output and standard error are both connected to a single pipe that is
21021 read by Exim. The &%max_output%& option controls how much output the command
21022 may produce, and the &%return_output%& and &%return_fail_output%& options
21023 control what is done with it.
21024
21025 Not running the command under a shell (by default) lessens the security risks
21026 in cases when a command from a user's filter file is built out of data that was
21027 taken from an incoming message. If a shell is required, it can of course be
21028 explicitly specified as the command to be run. However, there are circumstances
21029 where existing commands (for example, in &_.forward_& files) expect to be run
21030 under a shell and cannot easily be modified. To allow for these cases, there is
21031 an option called &%use_shell%&, which changes the way the &(pipe)& transport
21032 works. Instead of breaking up the command line as just described, it expands it
21033 as a single string and passes the result to &_/bin/sh_&. The
21034 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
21035 with &%use_shell%&, and the whole mechanism is inherently less secure.
21036
21037
21038
21039 .section "Environment variables" "SECTpipeenv"
21040 .cindex "&(pipe)& transport" "environment for command"
21041 .cindex "environment for pipe transport"
21042 The environment variables listed below are set up when the command is invoked.
21043 This list is a compromise for maximum compatibility with other MTAs. Note that
21044 the &%environment%& option can be used to add additional variables to this
21045 environment.
21046 .display
21047 &`DOMAIN            `&   the domain of the address
21048 &`HOME              `&   the home directory, if set
21049 &`HOST              `&   the host name when called from a router (see below)
21050 &`LOCAL_PART        `&   see below
21051 &`LOCAL_PART_PREFIX `&   see below
21052 &`LOCAL_PART_SUFFIX `&   see below
21053 &`LOGNAME           `&   see below
21054 &`MESSAGE_ID        `&   Exim's local ID for the message
21055 &`PATH              `&   as specified by the &%path%& option below
21056 &`QUALIFY_DOMAIN    `&   the sender qualification domain
21057 &`RECIPIENT         `&   the complete recipient address
21058 &`SENDER            `&   the sender of the message (empty if a bounce)
21059 &`SHELL             `&   &`/bin/sh`&
21060 &`TZ                `&   the value of the &%timezone%& option, if set
21061 &`USER              `&   see below
21062 .endd
21063 When a &(pipe)& transport is called directly from (for example) an &(accept)&
21064 router, LOCAL_PART is set to the local part of the address. When it is
21065 called as a result of a forward or alias expansion, LOCAL_PART is set to
21066 the local part of the address that was expanded. In both cases, any affixes are
21067 removed from the local part, and made available in LOCAL_PART_PREFIX and
21068 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
21069 same value as LOCAL_PART for compatibility with other MTAs.
21070
21071 .cindex "HOST"
21072 HOST is set only when a &(pipe)& transport is called from a router that
21073 associates hosts with an address, typically when using &(pipe)& as a
21074 pseudo-remote transport. HOST is set to the first host name specified by
21075 the router.
21076
21077 .cindex "HOME"
21078 If the transport's generic &%home_directory%& option is set, its value is used
21079 for the HOME environment variable. Otherwise, a home directory may be set
21080 by the router's &%transport_home_directory%& option, which defaults to the
21081 user's home directory if &%check_local_user%& is set.
21082
21083
21084 .section "Private options for pipe" "SECID142"
21085 .cindex "options" "&(pipe)& transport"
21086
21087
21088
21089 .option allow_commands pipe "string list&!!" unset
21090 .cindex "&(pipe)& transport" "permitted commands"
21091 The string is expanded, and is then interpreted as a colon-separated list of
21092 permitted commands. If &%restrict_to_path%& is not set, the only commands
21093 permitted are those in the &%allow_commands%& list. They need not be absolute
21094 paths; the &%path%& option is still used for relative paths. If
21095 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
21096 in the &%allow_commands%& list, or a name without any slashes that is found on
21097 the path. In other words, if neither &%allow_commands%& nor
21098 &%restrict_to_path%& is set, there is no restriction on the command, but
21099 otherwise only commands that are permitted by one or the other are allowed. For
21100 example, if
21101 .code
21102 allow_commands = /usr/bin/vacation
21103 .endd
21104 and &%restrict_to_path%& is not set, the only permitted command is
21105 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
21106 &%use_shell%& is set.
21107
21108
21109 .option batch_id pipe string&!! unset
21110 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21111
21112
21113 .option batch_max pipe integer 1
21114 This limits the number of addresses that can be handled in a single delivery.
21115 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21116
21117
21118 .option check_string pipe string unset
21119 As &(pipe)& writes the message, the start of each line is tested for matching
21120 &%check_string%&, and if it does, the initial matching characters are replaced
21121 by the contents of &%escape_string%&, provided both are set. The value of
21122 &%check_string%& is a literal string, not a regular expression, and the case of
21123 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
21124 of &%check_string%& and &%escape_string%& are forced to values that implement
21125 the SMTP escaping protocol. Any settings made in the configuration file are
21126 ignored.
21127
21128
21129 .option command pipe string&!! unset
21130 This option need not be set when &(pipe)& is being used to deliver to pipes
21131 obtained directly from address redirections. In other cases, the option must be
21132 set, to provide a command to be run. It need not yield an absolute path (see
21133 the &%path%& option below). The command is split up into separate arguments by
21134 Exim, and each argument is separately expanded, as described in section
21135 &<<SECThowcommandrun>>& above.
21136
21137
21138 .option environment pipe string&!! unset
21139 .cindex "&(pipe)& transport" "environment for command"
21140 .cindex "environment for &(pipe)& transport"
21141 This option is used to add additional variables to the environment in which the
21142 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
21143 a string which is expanded, and then interpreted as a colon-separated list of
21144 environment settings of the form <&'name'&>=<&'value'&>.
21145
21146
21147 .option escape_string pipe string unset
21148 See &%check_string%& above.
21149
21150
21151 .option freeze_exec_fail pipe boolean false
21152 .cindex "exec failure"
21153 .cindex "failure of exec"
21154 .cindex "&(pipe)& transport" "failure of exec"
21155 Failure to exec the command in a pipe transport is by default treated like
21156 any other failure while running the command. However, if &%freeze_exec_fail%&
21157 is set, failure to exec is treated specially, and causes the message to be
21158 frozen, whatever the setting of &%ignore_status%&.
21159
21160
21161 .option ignore_status pipe boolean false
21162 If this option is true, the status returned by the subprocess that is set up to
21163 run the command is ignored, and Exim behaves as if zero had been returned.
21164 Otherwise, a non-zero status or termination by signal causes an error return
21165 from the transport unless the status value is one of those listed in
21166 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
21167
21168 &*Note*&: This option does not apply to timeouts, which do not return a status.
21169 See the &%timeout_defer%& option for how timeouts are handled.
21170
21171 .option log_defer_output pipe boolean false
21172 .cindex "&(pipe)& transport" "logging output"
21173 If this option is set, and the status returned by the command is
21174 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
21175 and any output was produced, the first line of it is written to the main log.
21176
21177
21178 .option log_fail_output pipe boolean false
21179 If this option is set, and the command returns any output, and also ends with a
21180 return code that is neither zero nor one of the return codes listed in
21181 &%temp_errors%& (that is, the delivery failed), the first line of output is
21182 written to the main log. This option and &%log_output%& are mutually exclusive.
21183 Only one of them may be set.
21184
21185
21186
21187 .option log_output pipe boolean false
21188 If this option is set and the command returns any output, the first line of
21189 output is written to the main log, whatever the return code. This option and
21190 &%log_fail_output%& are mutually exclusive. Only one of them may be set.
21191
21192
21193
21194 .option max_output pipe integer 20K
21195 This specifies the maximum amount of output that the command may produce on its
21196 standard output and standard error file combined. If the limit is exceeded, the
21197 process running the command is killed. This is intended as a safety measure to
21198 catch runaway processes. The limit is applied independently of the settings of
21199 the options that control what is done with such output (for example,
21200 &%return_output%&). Because of buffering effects, the amount of output may
21201 exceed the limit by a small amount before Exim notices.
21202
21203
21204 .option message_prefix pipe string&!! "see below"
21205 The string specified here is expanded and output at the start of every message.
21206 The default is unset if &%use_bsmtp%& is set. Otherwise it is
21207 .code
21208 message_prefix = \
21209   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
21210   ${tod_bsdinbox}\n
21211 .endd
21212 .cindex "Cyrus"
21213 .cindex "&%tmail%&"
21214 .cindex "&""From""& line"
21215 This is required by the commonly used &_/usr/bin/vacation_& program.
21216 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
21217 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
21218 setting
21219 .code
21220 message_prefix =
21221 .endd
21222 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21223 &`\n`& to &`\r\n`& in &%message_prefix%&.
21224
21225
21226 .option message_suffix pipe string&!! "see below"
21227 The string specified here is expanded and output at the end of every message.
21228 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
21229 The suffix can be suppressed by setting
21230 .code
21231 message_suffix =
21232 .endd
21233 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21234 &`\n`& to &`\r\n`& in &%message_suffix%&.
21235
21236
21237 .option path pipe string "see below"
21238 This option specifies the string that is set up in the PATH environment
21239 variable of the subprocess. The default is:
21240 .code
21241 /bin:/usr/bin
21242 .endd
21243 If the &%command%& option does not yield an absolute path name, the command is
21244 sought in the PATH directories, in the usual way. &*Warning*&: This does not
21245 apply to a command specified as a transport filter.
21246
21247
21248 .new
21249 .option permit_coredump pipe boolean false
21250 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
21251 a core-dump of a pipe command, enable this command.  This enables core-dumps
21252 during delivery and affects both the Exim binary and the pipe command run.
21253 It is recommended that this option remain off unless and until you have a need
21254 for it and that this only be enabled when needed, as the risk of excessive
21255 resource consumption can be quite high.  Note also that Exim is typically
21256 installed as a setuid binary and most operating systems will inhibit coredumps
21257 of these by default, so further OS-specific action may be required.
21258 .wen
21259
21260
21261 .option pipe_as_creator pipe boolean false
21262 .cindex "uid (user id)" "local delivery"
21263 If the generic &%user%& option is not set and this option is true, the delivery
21264 process is run under the uid that was in force when Exim was originally called
21265 to accept the message. If the group id is not otherwise set (via the generic
21266 &%group%& option), the gid that was in force when Exim was originally called to
21267 accept the message is used.
21268
21269
21270 .option restrict_to_path pipe boolean false
21271 When this option is set, any command name not listed in &%allow_commands%& must
21272 contain no slashes. The command is searched for only in the directories listed
21273 in the &%path%& option. This option is intended for use in the case when a pipe
21274 command has been generated from a user's &_.forward_& file. This is usually
21275 handled by a &(pipe)& transport called &%address_pipe%&.
21276
21277
21278 .option return_fail_output pipe boolean false
21279 If this option is true, and the command produced any output and ended with a
21280 return code other than zero or one of the codes listed in &%temp_errors%& (that
21281 is, the delivery failed), the output is returned in the bounce message.
21282 However, if the message has a null sender (that is, it is itself a bounce
21283 message), output from the command is discarded. This option and
21284 &%return_output%& are mutually exclusive. Only one of them may be set.
21285
21286
21287
21288 .option return_output pipe boolean false
21289 If this option is true, and the command produced any output, the delivery is
21290 deemed to have failed whatever the return code from the command, and the output
21291 is returned in the bounce message. Otherwise, the output is just discarded.
21292 However, if the message has a null sender (that is, it is a bounce message),
21293 output from the command is always discarded, whatever the setting of this
21294 option. This option and &%return_fail_output%& are mutually exclusive. Only one
21295 of them may be set.
21296
21297
21298
21299 .option temp_errors pipe "string list" "see below"
21300 .cindex "&(pipe)& transport" "temporary failure"
21301 This option contains either a colon-separated list of numbers, or a single
21302 asterisk. If &%ignore_status%& is false
21303 and &%return_output%& is not set,
21304 and the command exits with a non-zero return code, the failure is treated as
21305 temporary and the delivery is deferred if the return code matches one of the
21306 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
21307 codes are treated as permanent errors. The default setting contains the codes
21308 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
21309 compiled on a system that does not define these macros, it assumes values of 75
21310 and 73, respectively.
21311
21312
21313 .option timeout pipe time 1h
21314 If the command fails to complete within this time, it is killed. This normally
21315 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
21316 specifies no timeout. In order to ensure that any subprocesses created by the
21317 command are also killed, Exim makes the initial process a process group leader,
21318 and kills the whole process group on a timeout. However, this can be defeated
21319 if one of the processes starts a new process group.
21320
21321 .option timeout_defer pipe boolean false
21322 A timeout in a &(pipe)& transport, either in the command that the transport
21323 runs, or in a transport filter that is associated with it, is by default
21324 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
21325 is set true, both kinds of timeout become temporary errors, causing the
21326 delivery to be deferred.
21327
21328 .option umask pipe "octal integer" 022
21329 This specifies the umask setting for the subprocess that runs the command.
21330
21331
21332 .option use_bsmtp pipe boolean false
21333 .cindex "envelope sender"
21334 If this option is set true, the &(pipe)& transport writes messages in &"batch
21335 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
21336 commands. If you want to include a leading HELO command with such messages,
21337 you can do so by setting the &%message_prefix%& option. See section
21338 &<<SECTbatchSMTP>>& for details of batch SMTP.
21339
21340 .option use_classresources pipe boolean false
21341 .cindex "class resources (BSD)"
21342 This option is available only when Exim is running on FreeBSD, NetBSD, or
21343 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
21344 resource limits when a &(pipe)& transport is run to perform a delivery. The
21345 limits for the uid under which the pipe is to run are obtained from the login
21346 class database.
21347
21348
21349 .option use_crlf pipe boolean false
21350 .cindex "carriage return"
21351 .cindex "linefeed"
21352 This option causes lines to be terminated with the two-character CRLF sequence
21353 (carriage return, linefeed) instead of just a linefeed character. In the case
21354 of batched SMTP, the byte sequence written to the pipe is then an exact image
21355 of what would be sent down a real SMTP connection.
21356
21357 The contents of the &%message_prefix%& and &%message_suffix%& options are
21358 written verbatim, so must contain their own carriage return characters if these
21359 are needed. When &%use_bsmtp%& is not set, the default values for both
21360 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
21361 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
21362
21363
21364 .option use_shell pipe boolean false
21365 .vindex "&$pipe_addresses$&"
21366 If this option is set, it causes the command to be passed to &_/bin/sh_&
21367 instead of being run directly from the transport, as described in section
21368 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
21369 where the command is expected to be run under a shell and cannot easily be
21370 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
21371 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
21372 command is expanded as a single string, and handed to &_/bin/sh_& as data for
21373 its &%-c%& option.
21374
21375
21376
21377 .section "Using an external local delivery agent" "SECID143"
21378 .cindex "local delivery" "using an external agent"
21379 .cindex "&'procmail'&"
21380 .cindex "external local delivery"
21381 .cindex "delivery" "&'procmail'&"
21382 .cindex "delivery" "by external agent"
21383 The &(pipe)& transport can be used to pass all messages that require local
21384 delivery to a separate local delivery agent such as &%procmail%&. When doing
21385 this, care must be taken to ensure that the pipe is run under an appropriate
21386 uid and gid. In some configurations one wants this to be a uid that is trusted
21387 by the delivery agent to supply the correct sender of the message. It may be
21388 necessary to recompile or reconfigure the delivery agent so that it trusts an
21389 appropriate user. The following is an example transport and router
21390 configuration for &%procmail%&:
21391 .code
21392 # transport
21393 procmail_pipe:
21394   driver = pipe
21395   command = /usr/local/bin/procmail -d $local_part
21396   return_path_add
21397   delivery_date_add
21398   envelope_to_add
21399   check_string = "From "
21400   escape_string = ">From "
21401   umask = 077
21402   user = $local_part
21403   group = mail
21404
21405 # router
21406 procmail:
21407   driver = accept
21408   check_local_user
21409   transport = procmail_pipe
21410 .endd
21411 In this example, the pipe is run as the local user, but with the group set to
21412 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
21413 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
21414 user to supply a correct sender address. If you do not specify either a
21415 &%group%& or a &%user%& option, the pipe command is run as the local user. The
21416 home directory is the user's home directory by default.
21417
21418 &*Note*&: The command that the pipe transport runs does &'not'& begin with
21419 .code
21420 IFS=" "
21421 .endd
21422 as shown in some &%procmail%& documentation, because Exim does not by default
21423 use a shell to run pipe commands.
21424
21425 .cindex "Cyrus"
21426 The next example shows a transport and a router for a system where local
21427 deliveries are handled by the Cyrus IMAP server.
21428 .code
21429 # transport
21430 local_delivery_cyrus:
21431   driver = pipe
21432   command = /usr/cyrus/bin/deliver \
21433             -m ${substr_1:$local_part_suffix} -- $local_part
21434   user = cyrus
21435   group = mail
21436   return_output
21437   log_output
21438   message_prefix =
21439   message_suffix =
21440
21441 # router
21442 local_user_cyrus:
21443   driver = accept
21444   check_local_user
21445   local_part_suffix = .*
21446   transport = local_delivery_cyrus
21447 .endd
21448 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
21449 &%return_output%& to cause any text written by Cyrus to be returned to the
21450 sender.
21451 .ecindex IIDpiptra1
21452 .ecindex IIDpiptra2
21453
21454
21455 . ////////////////////////////////////////////////////////////////////////////
21456 . ////////////////////////////////////////////////////////////////////////////
21457
21458 .chapter "The smtp transport" "CHAPsmtptrans"
21459 .scindex IIDsmttra1 "transports" "&(smtp)&"
21460 .scindex IIDsmttra2 "&(smtp)& transport"
21461 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
21462 or LMTP protocol. The list of hosts to try can either be taken from the address
21463 that is being processed (having been set up by the router), or specified
21464 explicitly for the transport. Timeout and retry processing (see chapter
21465 &<<CHAPretry>>&) is applied to each IP address independently.
21466
21467
21468 .section "Multiple messages on a single connection" "SECID144"
21469 The sending of multiple messages over a single TCP/IP connection can arise in
21470 two ways:
21471
21472 .ilist
21473 If a message contains more than &%max_rcpt%& (see below) addresses that are
21474 routed to the same host, more than one copy of the message has to be sent to
21475 that host. In this situation, multiple copies may be sent in a single run of
21476 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
21477 does when it has too many addresses to send in one message also depends on the
21478 value of the global &%remote_max_parallel%& option. Details are given in
21479 section &<<SECToutSMTPTCP>>&.)
21480 .next
21481 .cindex "hints database" "remembering routing"
21482 When a message has been successfully delivered over a TCP/IP connection, Exim
21483 looks in its hints database to see if there are any other messages awaiting a
21484 connection to the same host. If there are, a new delivery process is started
21485 for one of them, and the current TCP/IP connection is passed on to it. The new
21486 process may in turn send multiple copies and possibly create yet another
21487 process.
21488 .endlist
21489
21490
21491 For each copy sent over the same TCP/IP connection, a sequence counter is
21492 incremented, and if it ever gets to the value of &%connection_max_messages%&,
21493 no further messages are sent over that connection.
21494
21495
21496
21497 .section "Use of the $host and $host_address variables" "SECID145"
21498 .vindex "&$host$&"
21499 .vindex "&$host_address$&"
21500 At the start of a run of the &(smtp)& transport, the values of &$host$& and
21501 &$host_address$& are the name and IP address of the first host on the host list
21502 passed by the router. However, when the transport is about to connect to a
21503 specific host, and while it is connected to that host, &$host$& and
21504 &$host_address$& are set to the values for that host. These are the values
21505 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
21506 &%serialize_hosts%&, and the various TLS options are expanded.
21507
21508
21509 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
21510 .vindex &$tls_cipher$&
21511 .vindex &$tls_peerdn$&
21512 At the start of a run of the &(smtp)& transport, the values of &$tls_cipher$&
21513 and &$tls_peerdn$& are the values that were set when the message was received.
21514 These are the values that are used for options that are expanded before any
21515 SMTP connections are made. Just before each connection is made, these two
21516 variables are emptied. If TLS is subsequently started, they are set to the
21517 appropriate values for the outgoing connection, and these are the values that
21518 are in force when any authenticators are run and when the
21519 &%authenticated_sender%& option is expanded.
21520
21521
21522 .section "Private options for smtp" "SECID146"
21523 .cindex "options" "&(smtp)& transport"
21524 The private options of the &(smtp)& transport are as follows:
21525
21526
21527 .option address_retry_include_sender smtp boolean true
21528 .cindex "4&'xx'& responses" "retrying after"
21529 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
21530 is the combination of sender and recipient that is delayed in subsequent queue
21531 runs until the retry time is reached. You can delay the recipient without
21532 reference to the sender (which is what earlier versions of Exim did), by
21533 setting &%address_retry_include_sender%& false. However, this can lead to
21534 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
21535
21536 .option allow_localhost smtp boolean false
21537 .cindex "local host" "sending to"
21538 .cindex "fallback" "hosts specified on transport"
21539 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
21540 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
21541 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
21542 the delivery anyway. This should be used only in special cases when the
21543 configuration ensures that no looping will result (for example, a differently
21544 configured Exim is listening on the port to which the message is sent).
21545
21546
21547 .option authenticated_sender smtp string&!! unset
21548 .cindex "Cyrus"
21549 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
21550 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
21551 overriding any existing authenticated sender value. If the string expansion is
21552 forced to fail, the option is ignored. Other expansion failures cause delivery
21553 to be deferred. If the result of expansion is an empty string, that is also
21554 ignored.
21555
21556 The expansion happens after the outgoing connection has been made and TLS
21557 started, if required. This means that the &$host$&, &$host_address$&,
21558 &$tls_cipher$&, and &$tls_peerdn$& variables are set according to the
21559 particular connection.
21560
21561 If the SMTP session is not authenticated, the expansion of
21562 &%authenticated_sender%& still happens (and can cause the delivery to be
21563 deferred if it fails), but no AUTH= item is added to MAIL commands
21564 unless &%authenticated_sender_force%& is true.
21565
21566 This option allows you to use the &(smtp)& transport in LMTP mode to
21567 deliver mail to Cyrus IMAP and provide the proper local part as the
21568 &"authenticated sender"&, via a setting such as:
21569 .code
21570 authenticated_sender = $local_part
21571 .endd
21572 This removes the need for IMAP subfolders to be assigned special ACLs to
21573 allow direct delivery to those subfolders.
21574
21575 Because of expected uses such as that just described for Cyrus (when no
21576 domain is involved), there is no checking on the syntax of the provided
21577 value.
21578
21579
21580 .option authenticated_sender_force smtp boolean false
21581 If this option is set true, the &%authenticated_sender%& option's value
21582 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
21583 authenticated as a client.
21584
21585
21586 .option command_timeout smtp time 5m
21587 This sets a timeout for receiving a response to an SMTP command that has been
21588 sent out. It is also used when waiting for the initial banner line from the
21589 remote host. Its value must not be zero.
21590
21591
21592 .option connect_timeout smtp time 5m
21593 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
21594 to a remote host. A setting of zero allows the system timeout (typically
21595 several minutes) to act. To have any effect, the value of this option must be
21596 less than the system timeout. However, it has been observed that on some
21597 systems there is no system timeout, which is why the default value for this
21598 option is 5 minutes, a value recommended by RFC 1123.
21599
21600
21601 .option connection_max_messages smtp integer 500
21602 .cindex "SMTP" "passed connection"
21603 .cindex "SMTP" "multiple deliveries"
21604 .cindex "multiple SMTP deliveries"
21605 This controls the maximum number of separate message deliveries that are sent
21606 over a single TCP/IP connection. If the value is zero, there is no limit.
21607 For testing purposes, this value can be overridden by the &%-oB%& command line
21608 option.
21609
21610
21611 .option data_timeout smtp time 5m
21612 This sets a timeout for the transmission of each block in the data portion of
21613 the message. As a result, the overall timeout for a message depends on the size
21614 of the message. Its value must not be zero. See also &%final_timeout%&.
21615
21616
21617 .option delay_after_cutoff smtp boolean true
21618 This option controls what happens when all remote IP addresses for a given
21619 domain have been inaccessible for so long that they have passed their retry
21620 cutoff times.
21621
21622 In the default state, if the next retry time has not been reached for any of
21623 them, the address is bounced without trying any deliveries. In other words,
21624 Exim delays retrying an IP address after the final cutoff time until a new
21625 retry time is reached, and can therefore bounce an address without ever trying
21626 a delivery, when machines have been down for a long time. Some people are
21627 unhappy at this prospect, so...
21628
21629 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
21630 addresses are past their final cutoff time, Exim tries to deliver to those
21631 IP addresses that have not been tried since the message arrived. If there are
21632 none, of if they all fail, the address is bounced. In other words, it does not
21633 delay when a new message arrives, but immediately tries those expired IP
21634 addresses that haven't been tried since the message arrived. If there is a
21635 continuous stream of messages for the dead hosts, unsetting
21636 &%delay_after_cutoff%& means that there will be many more attempts to deliver
21637 to them.
21638
21639
21640 .option dns_qualify_single smtp boolean true
21641 If the &%hosts%& or &%fallback_hosts%& option is being used,
21642 and the &%gethostbyname%& option is false,
21643 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
21644 in chapter &<<CHAPdnslookup>>& for more details.
21645
21646
21647 .option dns_search_parents smtp boolean false
21648 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
21649 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
21650 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
21651 details.
21652
21653
21654
21655 .option fallback_hosts smtp "string list" unset
21656 .cindex "fallback" "hosts specified on transport"
21657 String expansion is not applied to this option. The argument must be a
21658 colon-separated list of host names or IP addresses, optionally also including
21659 port numbers, though the separator can be changed, as described in section
21660 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
21661 item in a &%route_list%& setting for the &(manualroute)& router, as described
21662 in section &<<SECTformatonehostitem>>&.
21663
21664 Fallback hosts can also be specified on routers, which associate them with the
21665 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
21666 &%fallback_hosts%& specified on the transport is used only if the address does
21667 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
21668 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
21669 However, &%hosts_randomize%& does apply to fallback host lists.
21670
21671 If Exim is unable to deliver to any of the hosts for a particular address, and
21672 the errors are not permanent rejections, the address is put on a separate
21673 transport queue with its host list replaced by the fallback hosts, unless the
21674 address was routed via MX records and the current host was in the original MX
21675 list. In that situation, the fallback host list is not used.
21676
21677 Once normal deliveries are complete, the fallback queue is delivered by
21678 re-running the same transports with the new host lists. If several failing
21679 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
21680 copy of the message is sent.
21681
21682 The resolution of the host names on the fallback list is controlled by the
21683 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
21684 both to cases when the host list comes with the address and when it is taken
21685 from &%hosts%&. This option provides a &"use a smart host only if delivery
21686 fails"& facility.
21687
21688
21689 .option final_timeout smtp time 10m
21690 This is the timeout that applies while waiting for the response to the final
21691 line containing just &"."& that terminates a message. Its value must not be
21692 zero.
21693
21694 .option gethostbyname smtp boolean false
21695 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
21696 being used, names are looked up using &[gethostbyname()]&
21697 (or &[getipnodebyname()]& when available)
21698 instead of using the DNS. Of course, that function may in fact use the DNS, but
21699 it may also consult other sources of information such as &_/etc/hosts_&.
21700
21701 .option gnutls_require_kx smtp string unset
21702 This option controls the key exchange mechanisms when GnuTLS is used in an Exim
21703 client. For details, see section &<<SECTreqciphgnu>>&.
21704
21705 .option gnutls_require_mac smtp string unset
21706 This option controls the MAC algorithms when GnuTLS is used in an Exim
21707 client. For details, see section &<<SECTreqciphgnu>>&.
21708
21709 .option gnutls_require_protocols smtp string unset
21710 This option controls the protocols when GnuTLS is used in an Exim
21711 client. For details, see section &<<SECTreqciphgnu>>&.
21712
21713 .option gnutls_compat_mode smtp boolean unset
21714 This option controls whether GnuTLS is used in compatibility mode in an Exim
21715 server. This reduces security slightly, but improves interworking with older
21716 implementations of TLS.
21717
21718 .option helo_data smtp string&!! "see below"
21719 .cindex "HELO" "argument, setting"
21720 .cindex "EHLO" "argument, setting"
21721 .cindex "LHLO argument setting"
21722 The value of this option is expanded after a connection to a another host has
21723 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
21724 command that starts the outgoing SMTP or LMTP session. The default value of the
21725 option is:
21726 .code
21727 $primary_hostname
21728 .endd
21729 During the expansion, the variables &$host$& and &$host_address$& are set to
21730 the identity of the remote host, and the variables &$sending_ip_address$& and
21731 &$sending_port$& are set to the local IP address and port number that are being
21732 used. These variables can be used to generate different values for different
21733 servers or different local IP addresses. For example, if you want the string
21734 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
21735 interface address, you could use this:
21736 .code
21737 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
21738   {$primary_hostname}}
21739 .endd
21740 The use of &%helo_data%& applies both to sending messages and when doing
21741 callouts.
21742
21743 .option hosts smtp "string list&!!" unset
21744 Hosts are associated with an address by a router such as &(dnslookup)&, which
21745 finds the hosts by looking up the address domain in the DNS, or by
21746 &(manualroute)&, which has lists of hosts in its configuration. However,
21747 email addresses can be passed to the &(smtp)& transport by any router, and not
21748 all of them can provide an associated list of hosts.
21749
21750 The &%hosts%& option specifies a list of hosts to be used if the address being
21751 processed does not have any hosts associated with it. The hosts specified by
21752 &%hosts%& are also used, whether or not the address has its own hosts, if
21753 &%hosts_override%& is set.
21754
21755 The string is first expanded, before being interpreted as a colon-separated
21756 list of host names or IP addresses, possibly including port numbers. The
21757 separator may be changed to something other than colon, as described in section
21758 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
21759 item in a &%route_list%& setting for the &(manualroute)& router, as described
21760 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
21761 of the &(manualroute)& router is not available here.
21762
21763 If the expansion fails, delivery is deferred. Unless the failure was caused by
21764 the inability to complete a lookup, the error is logged to the panic log as
21765 well as the main log. Host names are looked up either by searching directly for
21766 address records in the DNS or by calling &[gethostbyname()]& (or
21767 &[getipnodebyname()]& when available), depending on the setting of the
21768 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
21769 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
21770 address are used.
21771
21772 During delivery, the hosts are tried in order, subject to their retry status,
21773 unless &%hosts_randomize%& is set.
21774
21775
21776 .option hosts_avoid_esmtp smtp "host list&!!" unset
21777 .cindex "ESMTP, avoiding use of"
21778 .cindex "HELO" "forcing use of"
21779 .cindex "EHLO" "avoiding use of"
21780 .cindex "PIPELINING" "avoiding the use of"
21781 This option is for use with broken hosts that announce ESMTP facilities (for
21782 example, PIPELINING) and then fail to implement them properly. When a host
21783 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
21784 start of the SMTP session. This means that it cannot use any of the ESMTP
21785 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
21786
21787
21788 .option hosts_avoid_pipelining smtp "host list&!!" unset
21789 .cindex "PIPELINING" "avoiding the use of"
21790 Exim will not use the SMTP PIPELINING extension when delivering to any host
21791 that matches this list, even if the server host advertises PIPELINING support.
21792
21793
21794 .option hosts_avoid_tls smtp "host list&!!" unset
21795 .cindex "TLS" "avoiding for certain hosts"
21796 Exim will not try to start a TLS session when delivering to any host that
21797 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
21798
21799
21800 .option hosts_max_try smtp integer 5
21801 .cindex "host" "maximum number to try"
21802 .cindex "limit" "number of hosts tried"
21803 .cindex "limit" "number of MX tried"
21804 .cindex "MX record" "maximum tried"
21805 This option limits the number of IP addresses that are tried for any one
21806 delivery in cases where there are temporary delivery errors. Section
21807 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
21808
21809
21810 .option hosts_max_try_hardlimit smtp integer 50
21811 This is an additional check on the maximum number of IP addresses that Exim
21812 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
21813 why it exists.
21814
21815
21816
21817 .option hosts_nopass_tls smtp "host list&!!" unset
21818 .cindex "TLS" "passing connection"
21819 .cindex "multiple SMTP deliveries"
21820 .cindex "TLS" "multiple message deliveries"
21821 For any host that matches this list, a connection on which a TLS session has
21822 been started will not be passed to a new delivery process for sending another
21823 message on the same connection. See section &<<SECTmulmessam>>& for an
21824 explanation of when this might be needed.
21825
21826
21827 .option hosts_override smtp boolean false
21828 If this option is set and the &%hosts%& option is also set, any hosts that are
21829 attached to the address are ignored, and instead the hosts specified by the
21830 &%hosts%& option are always used. This option does not apply to
21831 &%fallback_hosts%&.
21832
21833
21834 .option hosts_randomize smtp boolean false
21835 .cindex "randomized host list"
21836 .cindex "host" "list of; randomized"
21837 .cindex "fallback" "randomized hosts"
21838 If this option is set, and either the list of hosts is taken from the
21839 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
21840 were not obtained from MX records (this includes fallback hosts from the
21841 router), and were not randomized by the router, the order of trying the hosts
21842 is randomized each time the transport runs. Randomizing the order of a host
21843 list can be used to do crude load sharing.
21844
21845 When &%hosts_randomize%& is true, a host list may be split into groups whose
21846 order is separately randomized. This makes it possible to set up MX-like
21847 behaviour. The boundaries between groups are indicated by an item that is just
21848 &`+`& in the host list. For example:
21849 .code
21850 hosts = host1:host2:host3:+:host4:host5
21851 .endd
21852 The order of the first three hosts and the order of the last two hosts is
21853 randomized for each use, but the first three always end up before the last two.
21854 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
21855
21856 .option hosts_require_auth smtp "host list&!!" unset
21857 .cindex "authentication" "required by client"
21858 This option provides a list of servers for which authentication must succeed
21859 before Exim will try to transfer a message. If authentication fails for
21860 servers which are not in this list, Exim tries to send unauthenticated. If
21861 authentication fails for one of these servers, delivery is deferred. This
21862 temporary error is detectable in the retry rules, so it can be turned into a
21863 hard failure if required. See also &%hosts_try_auth%&, and chapter
21864 &<<CHAPSMTPAUTH>>& for details of authentication.
21865
21866
21867 .option hosts_require_tls smtp "host list&!!" unset
21868 .cindex "TLS" "requiring for certain servers"
21869 Exim will insist on using a TLS session when delivering to any host that
21870 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
21871 &*Note*&: This option affects outgoing mail only. To insist on TLS for
21872 incoming messages, use an appropriate ACL.
21873
21874 .option hosts_try_auth smtp "host list&!!" unset
21875 .cindex "authentication" "optional in client"
21876 This option provides a list of servers to which, provided they announce
21877 authentication support, Exim will attempt to authenticate as a client when it
21878 connects. If authentication fails, Exim will try to transfer the message
21879 unauthenticated. See also &%hosts_require_auth%&, and chapter
21880 &<<CHAPSMTPAUTH>>& for details of authentication.
21881
21882 .option interface smtp "string list&!!" unset
21883 .cindex "bind IP address"
21884 .cindex "IP address" "binding"
21885 .vindex "&$host$&"
21886 .vindex "&$host_address$&"
21887 This option specifies which interface to bind to when making an outgoing SMTP
21888 call. The value is an IP address, not an interface name such as
21889 &`eth0`&. Do not confuse this with the interface address that was used when a
21890 message was received, which is in &$received_ip_address$&, formerly known as
21891 &$interface_address$&. The name was changed to minimize confusion with the
21892 outgoing interface address. There is no variable that contains an outgoing
21893 interface address because, unless it is set by this option, its value is
21894 unknown.
21895
21896 During the expansion of the &%interface%& option the variables &$host$& and
21897 &$host_address$& refer to the host to which a connection is about to be made
21898 during the expansion of the string. Forced expansion failure, or an empty
21899 string result causes the option to be ignored. Otherwise, after expansion, the
21900 string must be a list of IP addresses, colon-separated by default, but the
21901 separator can be changed in the usual way. For example:
21902 .code
21903 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
21904 .endd
21905 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
21906 connection. If none of them are the correct type, the option is ignored. If
21907 &%interface%& is not set, or is ignored, the system's IP functions choose which
21908 interface to use if the host has more than one.
21909
21910
21911 .option keepalive smtp boolean true
21912 .cindex "keepalive" "on outgoing connection"
21913 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
21914 connections. When set, it causes the kernel to probe idle connections
21915 periodically, by sending packets with &"old"& sequence numbers. The other end
21916 of the connection should send a acknowledgment if the connection is still okay
21917 or a reset if the connection has been aborted. The reason for doing this is
21918 that it has the beneficial effect of freeing up certain types of connection
21919 that can get stuck when the remote host is disconnected without tidying up the
21920 TCP/IP call properly. The keepalive mechanism takes several hours to detect
21921 unreachable hosts.
21922
21923
21924 .option lmtp_ignore_quota smtp boolean false
21925 .cindex "LMTP" "ignoring quota errors"
21926 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
21927 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
21928 has advertised support for IGNOREQUOTA in its response to the LHLO command.
21929
21930 .option max_rcpt smtp integer 100
21931 .cindex "RCPT" "maximum number of outgoing"
21932 This option limits the number of RCPT commands that are sent in a single
21933 SMTP message transaction. Each set of addresses is treated independently, and
21934 so can cause parallel connections to the same host if &%remote_max_parallel%&
21935 permits this.
21936
21937
21938 .option multi_domain smtp boolean true
21939 .vindex "&$domain$&"
21940 When this option is set, the &(smtp)& transport can handle a number of
21941 addresses containing a mixture of different domains provided they all resolve
21942 to the same list of hosts. Turning the option off restricts the transport to
21943 handling only one domain at a time. This is useful if you want to use
21944 &$domain$& in an expansion for the transport, because it is set only when there
21945 is a single domain involved in a remote delivery.
21946
21947
21948 .option port smtp string&!! "see below"
21949 .cindex "port" "sending TCP/IP"
21950 .cindex "TCP/IP" "setting outgoing port"
21951 This option specifies the TCP/IP port on the server to which Exim connects.
21952 &*Note:*& Do not confuse this with the port that was used when a message was
21953 received, which is in &$received_port$&, formerly known as &$interface_port$&.
21954 The name was changed to minimize confusion with the outgoing port. There is no
21955 variable that contains an outgoing port.
21956
21957 If the value of this option begins with a digit it is taken as a port number;
21958 otherwise it is looked up using &[getservbyname()]&. The default value is
21959 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
21960 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
21961 is deferred.
21962
21963
21964
21965 .option protocol smtp string smtp
21966 .cindex "LMTP" "over TCP/IP"
21967 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
21968 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
21969 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
21970 deliveries into closed message stores. Exim also has support for running LMTP
21971 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
21972
21973
21974 .option retry_include_ip_address smtp boolean true
21975 Exim normally includes both the host name and the IP address in the key it
21976 constructs for indexing retry data after a temporary delivery failure. This
21977 means that when one of several IP addresses for a host is failing, it gets
21978 tried periodically (controlled by the retry rules), but use of the other IP
21979 addresses is not affected.
21980
21981 However, in some dialup environments hosts are assigned a different IP address
21982 each time they connect. In this situation the use of the IP address as part of
21983 the retry key leads to undesirable behaviour. Setting this option false causes
21984 Exim to use only the host name. This should normally be done on a separate
21985 instance of the &(smtp)& transport, set up specially to handle the dialup
21986 hosts.
21987
21988
21989 .option serialize_hosts smtp "host list&!!" unset
21990 .cindex "serializing connections"
21991 .cindex "host" "serializing connections"
21992 Because Exim operates in a distributed manner, if several messages for the same
21993 host arrive at around the same time, more than one simultaneous connection to
21994 the remote host can occur. This is not usually a problem except when there is a
21995 slow link between the hosts. In that situation it may be helpful to restrict
21996 Exim to one connection at a time. This can be done by setting
21997 &%serialize_hosts%& to match the relevant hosts.
21998
21999 .cindex "hints database" "serializing deliveries to a host"
22000 Exim implements serialization by means of a hints database in which a record is
22001 written whenever a process connects to one of the restricted hosts. The record
22002 is deleted when the connection is completed. Obviously there is scope for
22003 records to get left lying around if there is a system or program crash. To
22004 guard against this, Exim ignores any records that are more than six hours old.
22005
22006 If you set up this kind of serialization, you should also arrange to delete the
22007 relevant hints database whenever your system reboots. The names of the files
22008 start with &_misc_& and they are kept in the &_spool/db_& directory. There
22009 may be one or two files, depending on the type of DBM in use. The same files
22010 are used for ETRN serialization.
22011
22012
22013 .option size_addition smtp integer 1024
22014 .cindex "SMTP" "SIZE"
22015 .cindex "message" "size issue for transport filter"
22016 .cindex "size" "of message"
22017 .cindex "transport" "filter"
22018 .cindex "filter" "transport filter"
22019 If a remote SMTP server indicates that it supports the SIZE option of the
22020 MAIL command, Exim uses this to pass over the message size at the start of
22021 an SMTP transaction. It adds the value of &%size_addition%& to the value it
22022 sends, to allow for headers and other text that may be added during delivery by
22023 configuration options or in a transport filter. It may be necessary to increase
22024 this if a lot of text is added to messages.
22025
22026 Alternatively, if the value of &%size_addition%& is set negative, it disables
22027 the use of the SIZE option altogether.
22028
22029
22030 .option tls_certificate smtp string&!! unset
22031 .cindex "TLS" "client certificate, location of"
22032 .cindex "certificate" "client, location of"
22033 .vindex "&$host$&"
22034 .vindex "&$host_address$&"
22035 The value of this option must be the absolute path to a file which contains the
22036 client's certificate, for possible use when sending a message over an encrypted
22037 connection. The values of &$host$& and &$host_address$& are set to the name and
22038 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
22039 details of TLS.
22040
22041 &*Note*&: This option must be set if you want Exim to be able to use a TLS
22042 certificate when sending messages as a client. The global option of the same
22043 name specifies the certificate for Exim as a server; it is not automatically
22044 assumed that the same certificate should be used when Exim is operating as a
22045 client.
22046
22047
22048 .option tls_crl smtp string&!! unset
22049 .cindex "TLS" "client certificate revocation list"
22050 .cindex "certificate" "revocation list for client"
22051 This option specifies a certificate revocation list. The expanded value must
22052 be the name of a file that contains a CRL in PEM format.
22053
22054
22055 .option tls_privatekey smtp string&!! unset
22056 .cindex "TLS" "client private key, location of"
22057 .vindex "&$host$&"
22058 .vindex "&$host_address$&"
22059 The value of this option must be the absolute path to a file which contains the
22060 client's private key. This is used when sending a message over an encrypted
22061 connection using a client certificate. The values of &$host$& and
22062 &$host_address$& are set to the name and address of the server during the
22063 expansion. If this option is unset, or the expansion is forced to fail, or the
22064 result is an empty string, the private key is assumed to be in the same file as
22065 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
22066
22067
22068 .option tls_require_ciphers smtp string&!! unset
22069 .cindex "TLS" "requiring specific ciphers"
22070 .cindex "cipher" "requiring specific"
22071 .vindex "&$host$&"
22072 .vindex "&$host_address$&"
22073 The value of this option must be a list of permitted cipher suites, for use
22074 when setting up an outgoing encrypted connection. (There is a global option of
22075 the same name for controlling incoming connections.) The values of &$host$& and
22076 &$host_address$& are set to the name and address of the server during the
22077 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
22078 is used in different ways by OpenSSL and GnuTLS (see sections
22079 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
22080 ciphers is a preference order.
22081
22082
22083
22084 .option tls_tempfail_tryclear smtp boolean true
22085 .cindex "4&'xx'& responses" "to STARTTLS"
22086 When the server host is not in &%hosts_require_tls%&, and there is a problem in
22087 setting up a TLS session, this option determines whether or not Exim should try
22088 to deliver the message unencrypted. If it is set false, delivery to the
22089 current host is deferred; if there are other hosts, they are tried. If this
22090 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
22091 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
22092 TLS negotiation fails, Exim closes the current connection (because it is in an
22093 unknown state), opens a new one to the same host, and then tries the delivery
22094 in clear.
22095
22096
22097 .option tls_verify_certificates smtp string&!! unset
22098 .cindex "TLS" "server certificate verification"
22099 .cindex "certificate" "verification of server"
22100 .vindex "&$host$&"
22101 .vindex "&$host_address$&"
22102 The value of this option must be the absolute path to a file containing
22103 permitted server certificates, for use when setting up an encrypted connection.
22104 Alternatively, if you are using OpenSSL, you can set
22105 &%tls_verify_certificates%& to the name of a directory containing certificate
22106 files. This does not work with GnuTLS; the option must be set to the name of a
22107 single file if you are using GnuTLS. The values of &$host$& and
22108 &$host_address$& are set to the name and address of the server during the
22109 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
22110
22111
22112
22113
22114 .section "How the limits for the number of hosts to try are used" &&&
22115          "SECTvalhosmax"
22116 .cindex "host" "maximum number to try"
22117 .cindex "limit" "hosts; maximum number tried"
22118 There are two options that are concerned with the number of hosts that are
22119 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
22120 &%hosts_max_try_hardlimit%&.
22121
22122
22123 The &%hosts_max_try%& option limits the number of hosts that are tried
22124 for a single delivery. However, despite the term &"host"& in its name, the
22125 option actually applies to each IP address independently. In other words, a
22126 multihomed host is treated as several independent hosts, just as it is for
22127 retrying.
22128
22129 Many of the larger ISPs have multiple MX records which often point to
22130 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
22131 created as a result of routing one of these domains.
22132
22133 Trying every single IP address on such a long list does not seem sensible; if
22134 several at the top of the list fail, it is reasonable to assume there is some
22135 problem that is likely to affect all of them. Roughly speaking, the value of
22136 &%hosts_max_try%& is the maximum number that are tried before deferring the
22137 delivery. However, the logic cannot be quite that simple.
22138
22139 Firstly, IP addresses that are skipped because their retry times have not
22140 arrived do not count, and in addition, addresses that are past their retry
22141 limits are also not counted, even when they are tried. This means that when
22142 some IP addresses are past their retry limits, more than the value of
22143 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
22144 that all IP addresses are considered before timing out an email address (but
22145 see below for an exception).
22146
22147 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
22148 list to see if there is a subsequent host with a different (higher valued) MX.
22149 If there is, that host is considered next, and the current IP address is used
22150 but not counted. This behaviour helps in the case of a domain with a retry rule
22151 that hardly ever delays any hosts, as is now explained:
22152
22153 Consider the case of a long list of hosts with one MX value, and a few with a
22154 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
22155 hosts at the top of the list are tried at first. With the default retry rule,
22156 which specifies increasing retry times, the higher MX hosts are eventually
22157 tried when those at the top of the list are skipped because they have not
22158 reached their retry times.
22159
22160 However, it is common practice to put a fixed short retry time on domains for
22161 large ISPs, on the grounds that their servers are rarely down for very long.
22162 Unfortunately, these are exactly the domains that tend to resolve to long lists
22163 of hosts. The short retry time means that the lowest MX hosts are tried every
22164 time. The attempts may be in a different order because of random sorting, but
22165 without the special MX check, the higher MX hosts would never be tried until
22166 all the lower MX hosts had timed out (which might be several days), because
22167 there are always some lower MX hosts that have reached their retry times. With
22168 the special check, Exim considers at least one IP address from each MX value at
22169 every delivery attempt, even if the &%hosts_max_try%& limit has already been
22170 reached.
22171
22172 The above logic means that &%hosts_max_try%& is not a hard limit, and in
22173 particular, Exim normally eventually tries all the IP addresses before timing
22174 out an email address. When &%hosts_max_try%& was implemented, this seemed a
22175 reasonable thing to do. Recently, however, some lunatic DNS configurations have
22176 been set up with hundreds of IP addresses for some domains. It can
22177 take a very long time indeed for an address to time out in these cases.
22178
22179 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
22180 Exim never tries more than this number of IP addresses; if it hits this limit
22181 and they are all timed out, the email address is bounced, even though not all
22182 possible IP addresses have been tried.
22183 .ecindex IIDsmttra1
22184 .ecindex IIDsmttra2
22185
22186
22187
22188
22189
22190 . ////////////////////////////////////////////////////////////////////////////
22191 . ////////////////////////////////////////////////////////////////////////////
22192
22193 .chapter "Address rewriting" "CHAPrewrite"
22194 .scindex IIDaddrew "rewriting" "addresses"
22195 There are some circumstances in which Exim automatically rewrites domains in
22196 addresses. The two most common are when an address is given without a domain
22197 (referred to as an &"unqualified address"&) or when an address contains an
22198 abbreviated domain that is expanded by DNS lookup.
22199
22200 Unqualified envelope addresses are accepted only for locally submitted
22201 messages, or for messages that are received from hosts matching
22202 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
22203 appropriate. Unqualified addresses in header lines are qualified if they are in
22204 locally submitted messages, or messages from hosts that are permitted to send
22205 unqualified envelope addresses. Otherwise, unqualified addresses in header
22206 lines are neither qualified nor rewritten.
22207
22208 One situation in which Exim does &'not'& automatically rewrite a domain is
22209 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
22210 such a domain should be rewritten using the &"canonical"& name, and some MTAs
22211 do this. The new RFCs do not contain this suggestion.
22212
22213
22214 .section "Explicitly configured address rewriting" "SECID147"
22215 This chapter describes the rewriting rules that can be used in the
22216 main rewrite section of the configuration file, and also in the generic
22217 &%headers_rewrite%& option that can be set on any transport.
22218
22219 Some people believe that configured address rewriting is a Mortal Sin.
22220 Others believe that life is not possible without it. Exim provides the
22221 facility; you do not have to use it.
22222
22223 The main rewriting rules that appear in the &"rewrite"& section of the
22224 configuration file are applied to addresses in incoming messages, both envelope
22225 addresses and addresses in header lines. Each rule specifies the types of
22226 address to which it applies.
22227
22228 Whether or not addresses in header lines are rewritten depends on the origin of
22229 the headers and the type of rewriting. Global rewriting, that is, rewriting
22230 rules from the rewrite section of the configuration file, is applied only to
22231 those headers that were received with the message. Header lines that are added
22232 by ACLs or by a system filter or by individual routers or transports (which
22233 are specific to individual recipient addresses) are not rewritten by the global
22234 rules.
22235
22236 Rewriting at transport time, by means of the &%headers_rewrite%& option,
22237 applies all headers except those added by routers and transports. That is, as
22238 well as the headers that were received with the message, it also applies to
22239 headers that were added by an ACL or a system filter.
22240
22241
22242 In general, rewriting addresses from your own system or domain has some
22243 legitimacy. Rewriting other addresses should be done only with great care and
22244 in special circumstances. The author of Exim believes that rewriting should be
22245 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
22246 Although it can sometimes be used as a routing tool, this is very strongly
22247 discouraged.
22248
22249 There are two commonly encountered circumstances where rewriting is used, as
22250 illustrated by these examples:
22251
22252 .ilist
22253 The company whose domain is &'hitch.fict.example'& has a number of hosts that
22254 exchange mail with each other behind a firewall, but there is only a single
22255 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
22256 &'hitch.fict.example'& when sending mail off-site.
22257 .next
22258 A host rewrites the local parts of its own users so that, for example,
22259 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
22260 .endlist
22261
22262
22263
22264 .section "When does rewriting happen?" "SECID148"
22265 .cindex "rewriting" "timing of"
22266 .cindex "&ACL;" "rewriting addresses in"
22267 Configured address rewriting can take place at several different stages of a
22268 message's processing.
22269
22270 .vindex "&$sender_address$&"
22271 At the start of an ACL for MAIL, the sender address may have been rewritten
22272 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
22273 ordinary rewrite rules have yet been applied. If, however, the sender address
22274 is verified in the ACL, it is rewritten before verification, and remains
22275 rewritten thereafter. The subsequent value of &$sender_address$& is the
22276 rewritten address. This also applies if sender verification happens in a
22277 RCPT ACL. Otherwise, when the sender address is not verified, it is
22278 rewritten as soon as a message's header lines have been received.
22279
22280 .vindex "&$domain$&"
22281 .vindex "&$local_part$&"
22282 Similarly, at the start of an ACL for RCPT, the current recipient's address
22283 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
22284 rewrite rules have yet been applied to it. However, the behaviour is different
22285 from the sender address when a recipient is verified. The address is rewritten
22286 for the verification, but the rewriting is not remembered at this stage. The
22287 value of &$local_part$& and &$domain$& after verification are always the same
22288 as they were before (that is, they contain the unrewritten &-- except for
22289 SMTP-time rewriting &-- address).
22290
22291 As soon as a message's header lines have been received, all the envelope
22292 recipient addresses are permanently rewritten, and rewriting is also applied to
22293 the addresses in the header lines (if configured). This happens before adding
22294 any header lines that were specified in MAIL or RCPT ACLs, and
22295 .cindex "&[local_scan()]& function" "address rewriting; timing of"
22296 before the DATA ACL and &[local_scan()]& functions are run.
22297
22298 When an address is being routed, either for delivery or for verification,
22299 rewriting is applied immediately to child addresses that are generated by
22300 redirection, unless &%no_rewrite%& is set on the router.
22301
22302 .cindex "envelope sender" "rewriting at transport time"
22303 .cindex "rewriting" "at transport time"
22304 .cindex "header lines" "rewriting at transport time"
22305 At transport time, additional rewriting of addresses in header lines can be
22306 specified by setting the generic &%headers_rewrite%& option on a transport.
22307 This option contains rules that are identical in form to those in the rewrite
22308 section of the configuration file. They are applied to the original message
22309 header lines and any that were added by ACLs or a system filter. They are not
22310 applied to header lines that are added by routers or the transport.
22311
22312 The outgoing envelope sender can be rewritten by means of the &%return_path%&
22313 transport option. However, it is not possible to rewrite envelope recipients at
22314 transport time.
22315
22316
22317
22318
22319 .section "Testing the rewriting rules that apply on input" "SECID149"
22320 .cindex "rewriting" "testing"
22321 .cindex "testing" "rewriting"
22322 Exim's input rewriting configuration appears in a part of the run time
22323 configuration file headed by &"begin rewrite"&. It can be tested by the
22324 &%-brw%& command line option. This takes an address (which can be a full RFC
22325 2822 address) as its argument. The output is a list of how the address would be
22326 transformed by the rewriting rules for each of the different places it might
22327 appear in an incoming message, that is, for each different header and for the
22328 envelope sender and recipient fields. For example,
22329 .code
22330 exim -brw ph10@exim.workshop.example
22331 .endd
22332 might produce the output
22333 .code
22334 sender: Philip.Hazel@exim.workshop.example
22335 from: Philip.Hazel@exim.workshop.example
22336 to: ph10@exim.workshop.example
22337 cc: ph10@exim.workshop.example
22338 bcc: ph10@exim.workshop.example
22339 reply-to: Philip.Hazel@exim.workshop.example
22340 env-from: Philip.Hazel@exim.workshop.example
22341 env-to: ph10@exim.workshop.example
22342 .endd
22343 which shows that rewriting has been set up for that address when used in any of
22344 the source fields, but not when it appears as a recipient address. At the
22345 present time, there is no equivalent way of testing rewriting rules that are
22346 set for a particular transport.
22347
22348
22349 .section "Rewriting rules" "SECID150"
22350 .cindex "rewriting" "rules"
22351 The rewrite section of the configuration file consists of lines of rewriting
22352 rules in the form
22353 .display
22354 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
22355 .endd
22356 Rewriting rules that are specified for the &%headers_rewrite%& generic
22357 transport option are given as a colon-separated list. Each item in the list
22358 takes the same form as a line in the main rewriting configuration (except that
22359 any colons must be doubled, of course).
22360
22361 The formats of source patterns and replacement strings are described below.
22362 Each is terminated by white space, unless enclosed in double quotes, in which
22363 case normal quoting conventions apply inside the quotes. The flags are single
22364 characters which may appear in any order. Spaces and tabs between them are
22365 ignored.
22366
22367 For each address that could potentially be rewritten, the rules are scanned in
22368 order, and replacements for the address from earlier rules can themselves be
22369 replaced by later rules (but see the &"q"& and &"R"& flags).
22370
22371 The order in which addresses are rewritten is undefined, may change between
22372 releases, and must not be relied on, with one exception: when a message is
22373 received, the envelope sender is always rewritten first, before any header
22374 lines are rewritten. For example, the replacement string for a rewrite of an
22375 address in &'To:'& must not assume that the message's address in &'From:'& has
22376 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
22377 that the envelope sender has already been rewritten.
22378
22379 .vindex "&$domain$&"
22380 .vindex "&$local_part$&"
22381 The variables &$local_part$& and &$domain$& can be used in the replacement
22382 string to refer to the address that is being rewritten. Note that lookup-driven
22383 rewriting can be done by a rule of the form
22384 .code
22385 *@*   ${lookup ...
22386 .endd
22387 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
22388 refer to the address that is being rewritten.
22389
22390
22391 .section "Rewriting patterns" "SECID151"
22392 .cindex "rewriting" "patterns"
22393 .cindex "address list" "in a rewriting pattern"
22394 The source pattern in a rewriting rule is any item which may appear in an
22395 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
22396 single-item address list, which means that it is expanded before being tested
22397 against the address. As always, if you use a regular expression as a pattern,
22398 you must take care to escape dollar and backslash characters, or use the &`\N`&
22399 facility to suppress string expansion within the regular expression.
22400
22401 Domains in patterns should be given in lower case. Local parts in patterns are
22402 case-sensitive. If you want to do case-insensitive matching of local parts, you
22403 can use a regular expression that starts with &`^(?i)`&.
22404
22405 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
22406 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
22407 depending on the type of match which occurred. These can be used in the
22408 replacement string to insert portions of the incoming address. &$0$& always
22409 refers to the complete incoming address. When a regular expression is used, the
22410 numerical variables are set from its capturing subexpressions. For other types
22411 of pattern they are set as follows:
22412
22413 .ilist
22414 If a local part or domain starts with an asterisk, the numerical variables
22415 refer to the character strings matched by asterisks, with &$1$& associated with
22416 the first asterisk, and &$2$& with the second, if present. For example, if the
22417 pattern
22418 .code
22419 *queen@*.fict.example
22420 .endd
22421 is matched against the address &'hearts-queen@wonderland.fict.example'& then
22422 .code
22423 $0 = hearts-queen@wonderland.fict.example
22424 $1 = hearts-
22425 $2 = wonderland
22426 .endd
22427 Note that if the local part does not start with an asterisk, but the domain
22428 does, it is &$1$& that contains the wild part of the domain.
22429
22430 .next
22431 If the domain part of the pattern is a partial lookup, the wild and fixed parts
22432 of the domain are placed in the next available numerical variables. Suppose,
22433 for example, that the address &'foo@bar.baz.example'& is processed by a
22434 rewriting rule of the form
22435 .display
22436 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
22437 .endd
22438 and the key in the file that matches the domain is &`*.baz.example`&. Then
22439 .code
22440 $1 = foo
22441 $2 = bar
22442 $3 = baz.example
22443 .endd
22444 If the address &'foo@baz.example'& is looked up, this matches the same
22445 wildcard file entry, and in this case &$2$& is set to the empty string, but
22446 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
22447 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
22448 whole domain. For non-partial domain lookups, no numerical variables are set.
22449 .endlist
22450
22451
22452 .section "Rewriting replacements" "SECID152"
22453 .cindex "rewriting" "replacements"
22454 If the replacement string for a rule is a single asterisk, addresses that
22455 match the pattern and the flags are &'not'& rewritten, and no subsequent
22456 rewriting rules are scanned. For example,
22457 .code
22458 hatta@lookingglass.fict.example  *  f
22459 .endd
22460 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
22461 &'From:'& headers.
22462
22463 .vindex "&$domain$&"
22464 .vindex "&$local_part$&"
22465 If the replacement string is not a single asterisk, it is expanded, and must
22466 yield a fully qualified address. Within the expansion, the variables
22467 &$local_part$& and &$domain$& refer to the address that is being rewritten.
22468 Any letters they contain retain their original case &-- they are not lower
22469 cased. The numerical variables are set up according to the type of pattern that
22470 matched the address, as described above. If the expansion is forced to fail by
22471 the presence of &"fail"& in a conditional or lookup item, rewriting by the
22472 current rule is abandoned, but subsequent rules may take effect. Any other
22473 expansion failure causes the entire rewriting operation to be abandoned, and an
22474 entry written to the panic log.
22475
22476
22477
22478 .section "Rewriting flags" "SECID153"
22479 There are three different kinds of flag that may appear on rewriting rules:
22480
22481 .ilist
22482 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
22483 c, f, h, r, s, t.
22484 .next
22485 A flag that specifies rewriting at SMTP time: S.
22486 .next
22487 Flags that control the rewriting process: Q, q, R, w.
22488 .endlist
22489
22490 For rules that are part of the &%headers_rewrite%& generic transport option,
22491 E, F, T, and S are not permitted.
22492
22493
22494
22495 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
22496          "SECID154"
22497 .cindex "rewriting" "flags"
22498 If none of the following flag letters, nor the &"S"& flag (see section
22499 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
22500 and to both the sender and recipient fields of the envelope, whereas a
22501 transport-time rewriting rule just applies to all headers. Otherwise, the
22502 rewriting rule is skipped unless the relevant addresses are being processed.
22503 .display
22504 &`E`&       rewrite all envelope fields
22505 &`F`&       rewrite the envelope From field
22506 &`T`&       rewrite the envelope To field
22507 &`b`&       rewrite the &'Bcc:'& header
22508 &`c`&       rewrite the &'Cc:'& header
22509 &`f`&       rewrite the &'From:'& header
22510 &`h`&       rewrite all headers
22511 &`r`&       rewrite the &'Reply-To:'& header
22512 &`s`&       rewrite the &'Sender:'& header
22513 &`t`&       rewrite the &'To:'& header
22514 .endd
22515 "All headers" means all of the headers listed above that can be selected
22516 individually, plus their &'Resent-'& versions. It does not include
22517 other headers such as &'Subject:'& etc.
22518
22519 You should be particularly careful about rewriting &'Sender:'& headers, and
22520 restrict this to special known cases in your own domains.
22521
22522
22523 .section "The SMTP-time rewriting flag" "SECTrewriteS"
22524 .cindex "SMTP" "rewriting malformed addresses"
22525 .cindex "RCPT" "rewriting argument of"
22526 .cindex "MAIL" "rewriting argument of"
22527 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
22528 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
22529 before any other processing; even before syntax checking. The pattern is
22530 required to be a regular expression, and it is matched against the whole of the
22531 data for the command, including any surrounding angle brackets.
22532
22533 .vindex "&$domain$&"
22534 .vindex "&$local_part$&"
22535 This form of rewrite rule allows for the handling of addresses that are not
22536 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
22537 input). Because the input is not required to be a syntactically valid address,
22538 the variables &$local_part$& and &$domain$& are not available during the
22539 expansion of the replacement string. The result of rewriting replaces the
22540 original address in the MAIL or RCPT command.
22541
22542
22543 .section "Flags controlling the rewriting process" "SECID155"
22544 There are four flags which control the way the rewriting process works. These
22545 take effect only when a rule is invoked, that is, when the address is of the
22546 correct type (matches the flags) and matches the pattern:
22547
22548 .ilist
22549 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
22550 unqualified local part. It is qualified with &%qualify_recipient%&. In the
22551 absence of &"Q"& the rewritten address must always include a domain.
22552 .next
22553 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
22554 even if no rewriting actually takes place because of a &"fail"& in the
22555 expansion. The &"q"& flag is not effective if the address is of the wrong type
22556 (does not match the flags) or does not match the pattern.
22557 .next
22558 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
22559 address, up to ten times. It can be combined with the &"q"& flag, to stop
22560 rewriting once it fails to match (after at least one successful rewrite).
22561 .next
22562 .cindex "rewriting" "whole addresses"
22563 When an address in a header is rewritten, the rewriting normally applies only
22564 to the working part of the address, with any comments and RFC 2822 &"phrase"&
22565 left unchanged. For example, rewriting might change
22566 .code
22567 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
22568 .endd
22569 into
22570 .code
22571 From: Ford Prefect <prefectf@hitch.fict.example>
22572 .endd
22573 .cindex "RFC 2047"
22574 Sometimes there is a need to replace the whole address item, and this can be
22575 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
22576 causes an address in a header line to be rewritten, the entire address is
22577 replaced, not just the working part. The replacement must be a complete RFC
22578 2822 address, including the angle brackets if necessary. If text outside angle
22579 brackets contains a character whose value is greater than 126 or less than 32
22580 (except for tab), the text is encoded according to RFC 2047. The character set
22581 is taken from &%headers_charset%&, which defaults to ISO-8859-1.
22582
22583 When the &"w"& flag is set on a rule that causes an envelope address to be
22584 rewritten, all but the working part of the replacement address is discarded.
22585 .endlist
22586
22587
22588 .section "Rewriting examples" "SECID156"
22589 Here is an example of the two common rewriting paradigms:
22590 .code
22591 *@*.hitch.fict.example  $1@hitch.fict.example
22592 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
22593                      {$value}fail}@hitch.fict.example bctfrF
22594 .endd
22595 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
22596 the string expansion to fail if the lookup does not succeed. In this context it
22597 has the effect of leaving the original address unchanged, but Exim goes on to
22598 consider subsequent rewriting rules, if any, because the &"q"& flag is not
22599 present in that rule. An alternative to &"fail"& would be to supply &$1$&
22600 explicitly, which would cause the rewritten address to be the same as before,
22601 at the cost of a small bit of processing. Not supplying either of these is an
22602 error, since the rewritten address would then contain no local part.
22603
22604 The first example above replaces the domain with a superior, more general
22605 domain. This may not be desirable for certain local parts. If the rule
22606 .code
22607 root@*.hitch.fict.example  *
22608 .endd
22609 were inserted before the first rule, rewriting would be suppressed for the
22610 local part &'root'& at any domain ending in &'hitch.fict.example'&.
22611
22612 Rewriting can be made conditional on a number of tests, by making use of
22613 &${if$& in the expansion item. For example, to apply a rewriting rule only to
22614 messages that originate outside the local host:
22615 .code
22616 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
22617                          {$1@hitch.fict.example}fail}"
22618 .endd
22619 The replacement string is quoted in this example because it contains white
22620 space.
22621
22622 .cindex "rewriting" "bang paths"
22623 .cindex "bang paths" "rewriting"
22624 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
22625 an address it treats it as an unqualified local part which it qualifies with
22626 the local qualification domain (if the source of the message is local or if the
22627 remote host is permitted to send unqualified addresses). Rewriting can
22628 sometimes be used to handle simple bang paths with a fixed number of
22629 components. For example, the rule
22630 .code
22631 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
22632 .endd
22633 rewrites a two-component bang path &'host.name!user'& as the domain address
22634 &'user@host.name'&. However, there is a security implication in using this as
22635 a global rewriting rule for envelope addresses. It can provide a backdoor
22636 method for using your system as a relay, because the incoming addresses appear
22637 to be local. If the bang path addresses are received via SMTP, it is safer to
22638 use the &"S"& flag to rewrite them as they are received, so that relay checking
22639 can be done on the rewritten addresses.
22640 .ecindex IIDaddrew
22641
22642
22643
22644
22645
22646 . ////////////////////////////////////////////////////////////////////////////
22647 . ////////////////////////////////////////////////////////////////////////////
22648
22649 .chapter "Retry configuration" "CHAPretry"
22650 .scindex IIDretconf1 "retry" "configuration, description of"
22651 .scindex IIDregconf2 "configuration file" "retry section"
22652 The &"retry"& section of the runtime configuration file contains a list of
22653 retry rules that control how often Exim tries to deliver messages that cannot
22654 be delivered at the first attempt. If there are no retry rules (the section is
22655 empty or not present), there are no retries. In this situation, temporary
22656 errors are treated as permanent. The default configuration contains a single,
22657 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
22658 line option can be used to test which retry rule will be used for a given
22659 address, domain and error.
22660
22661 The most common cause of retries is temporary failure to deliver to a remote
22662 host because the host is down, or inaccessible because of a network problem.
22663 Exim's retry processing in this case is applied on a per-host (strictly, per IP
22664 address) basis, not on a per-message basis. Thus, if one message has recently
22665 been delayed, delivery of a new message to the same host is not immediately
22666 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
22667 log selector is set, the message
22668 .cindex "retry" "time not reached"
22669 &"retry time not reached"& is written to the main log whenever a delivery is
22670 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
22671 the handling of errors during remote deliveries.
22672
22673 Retry processing applies to routing as well as to delivering, except as covered
22674 in the next paragraph. The retry rules do not distinguish between these
22675 actions. It is not possible, for example, to specify different behaviour for
22676 failures to route the domain &'snark.fict.example'& and failures to deliver to
22677 the host &'snark.fict.example'&. I didn't think anyone would ever need this
22678 added complication, so did not implement it. However, although they share the
22679 same retry rule, the actual retry times for routing and transporting a given
22680 domain are maintained independently.
22681
22682 When a delivery is not part of a queue run (typically an immediate delivery on
22683 receipt of a message), the routers are always run, and local deliveries are
22684 always attempted, even if retry times are set for them. This makes for better
22685 behaviour if one particular message is causing problems (for example, causing
22686 quota overflow, or provoking an error in a filter file). If such a delivery
22687 suffers a temporary failure, the retry data is updated as normal, and
22688 subsequent delivery attempts from queue runs occur only when the retry time for
22689 the local address is reached.
22690
22691 .section "Changing retry rules" "SECID157"
22692 If you change the retry rules in your configuration, you should consider
22693 whether or not to delete the retry data that is stored in Exim's spool area in
22694 files with names like &_db/retry_&. Deleting any of Exim's hints files is
22695 always safe; that is why they are called &"hints"&.
22696
22697 The hints retry data contains suggested retry times based on the previous
22698 rules. In the case of a long-running problem with a remote host, it might
22699 record the fact that the host has timed out. If your new rules increase the
22700 timeout time for such a host, you should definitely remove the old retry data
22701 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
22702 messages that it should now be retaining.
22703
22704
22705
22706 .section "Format of retry rules" "SECID158"
22707 .cindex "retry" "rules"
22708 Each retry rule occupies one line and consists of three or four parts,
22709 separated by white space: a pattern, an error name, an optional list of sender
22710 addresses, and a list of retry parameters. The pattern and sender lists must be
22711 enclosed in double quotes if they contain white space. The rules are searched
22712 in order until one is found where the pattern, error name, and sender list (if
22713 present) match the failing host or address, the error that occurred, and the
22714 message's sender, respectively.
22715
22716
22717 The pattern is any single item that may appear in an address list (see section
22718 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
22719 which means that it is expanded before being tested against the address that
22720 has been delayed. A negated address list item is permitted. Address
22721 list processing treats a plain domain name as if it were preceded by &"*@"&,
22722 which makes it possible for many retry rules to start with just a domain. For
22723 example,
22724 .code
22725 lookingglass.fict.example        *  F,24h,30m;
22726 .endd
22727 provides a rule for any address in the &'lookingglass.fict.example'& domain,
22728 whereas
22729 .code
22730 alice@lookingglass.fict.example  *  F,24h,30m;
22731 .endd
22732 applies only to temporary failures involving the local part &%alice%&.
22733 In practice, almost all rules start with a domain name pattern without a local
22734 part.
22735
22736 .cindex "regular expressions" "in retry rules"
22737 &*Warning*&: If you use a regular expression in a routing rule pattern, it
22738 must match a complete address, not just a domain, because that is how regular
22739 expressions work in address lists.
22740 .display
22741 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
22742 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
22743 .endd
22744
22745
22746 .section "Choosing which retry rule to use for address errors" "SECID159"
22747 When Exim is looking for a retry rule after a routing attempt has failed (for
22748 example, after a DNS timeout), each line in the retry configuration is tested
22749 against the complete address only if &%retry_use_local_part%& is set for the
22750 router. Otherwise, only the domain is used, except when matching against a
22751 regular expression, when the local part of the address is replaced with &"*"&.
22752 A domain on its own can match a domain pattern, or a pattern that starts with
22753 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
22754 &%check_local_user%& is true, and false for other routers.
22755
22756 Similarly, when Exim is looking for a retry rule after a local delivery has
22757 failed (for example, after a mailbox full error), each line in the retry
22758 configuration is tested against the complete address only if
22759 &%retry_use_local_part%& is set for the transport (it defaults true for all
22760 local transports).
22761
22762 .cindex "4&'xx'& responses" "retry rules for"
22763 However, when Exim is looking for a retry rule after a remote delivery attempt
22764 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
22765 whole address is always used as the key when searching the retry rules. The
22766 rule that is found is used to create a retry time for the combination of the
22767 failing address and the message's sender. It is the combination of sender and
22768 recipient that is delayed in subsequent queue runs until its retry time is
22769 reached. You can delay the recipient without regard to the sender by setting
22770 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
22771 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
22772 commands.
22773
22774
22775
22776 .section "Choosing which retry rule to use for host and message errors" &&&
22777          "SECID160"
22778 For a temporary error that is not related to an individual address (for
22779 example, a connection timeout), each line in the retry configuration is checked
22780 twice. First, the name of the remote host is used as a domain name (preceded by
22781 &"*@"& when matching a regular expression). If this does not match the line,
22782 the domain from the email address is tried in a similar fashion. For example,
22783 suppose the MX records for &'a.b.c.example'& are
22784 .code
22785 a.b.c.example  MX  5  x.y.z.example
22786                MX  6  p.q.r.example
22787                MX  7  m.n.o.example
22788 .endd
22789 and the retry rules are
22790 .code
22791 p.q.r.example    *      F,24h,30m;
22792 a.b.c.example    *      F,4d,45m;
22793 .endd
22794 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
22795 first rule matches neither the host nor the domain, so Exim looks at the second
22796 rule. This does not match the host, but it does match the domain, so it is used
22797 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
22798 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
22799 first retry rule is used, because it matches the host.
22800
22801 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
22802 first rule to determine retry times, but for all the other hosts for the domain
22803 &'a.b.c.example'&, the second rule is used. The second rule is also used if
22804 routing to &'a.b.c.example'& suffers a temporary failure.
22805
22806 &*Note*&: The host name is used when matching the patterns, not its IP address.
22807 However, if a message is routed directly to an IP address without the use of a
22808 host name, for example, if a &(manualroute)& router contains a setting such as:
22809 .code
22810 route_list = *.a.example  192.168.34.23
22811 .endd
22812 then the &"host name"& that is used when searching for a retry rule is the
22813 textual form of the IP address.
22814
22815 .section "Retry rules for specific errors" "SECID161"
22816 .cindex "retry" "specific errors; specifying"
22817 The second field in a retry rule is the name of a particular error, or an
22818 asterisk, which matches any error. The errors that can be tested for are:
22819
22820 .vlist
22821 .vitem &%auth_failed%&
22822 Authentication failed when trying to send to a host in the
22823 &%hosts_require_auth%& list in an &(smtp)& transport.
22824
22825 .vitem &%data_4xx%&
22826 A 4&'xx'& error was received for an outgoing DATA command, either immediately
22827 after the command, or after sending the message's data.
22828
22829 .vitem &%mail_4xx%&
22830 A 4&'xx'& error was received for an outgoing MAIL command.
22831
22832 .vitem &%rcpt_4xx%&
22833 A 4&'xx'& error was received for an outgoing RCPT command.
22834 .endlist
22835
22836 For the three 4&'xx'& errors, either the first or both of the x's can be given
22837 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
22838 recognize 452 errors given to RCPT commands for addresses in a certain domain,
22839 and have retries every ten minutes with a one-hour timeout, you could set up a
22840 retry rule of this form:
22841 .code
22842 the.domain.name  rcpt_452   F,1h,10m
22843 .endd
22844 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
22845 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
22846
22847 .vlist
22848 .vitem &%lost_connection%&
22849 A server unexpectedly closed the SMTP connection. There may, of course,
22850 legitimate reasons for this (host died, network died), but if it repeats a lot
22851 for the same host, it indicates something odd.
22852
22853 .vitem &%refused_MX%&
22854 A connection to a host obtained from an MX record was refused.
22855
22856 .vitem &%refused_A%&
22857 A connection to a host not obtained from an MX record was refused.
22858
22859 .vitem &%refused%&
22860 A connection was refused.
22861
22862 .vitem &%timeout_connect_MX%&
22863 A connection attempt to a host obtained from an MX record timed out.
22864
22865 .vitem &%timeout_connect_A%&
22866 A connection attempt to a host not obtained from an MX record timed out.
22867
22868 .vitem &%timeout_connect%&
22869 A connection attempt timed out.
22870
22871 .vitem &%timeout_MX%&
22872 There was a timeout while connecting or during an SMTP session with a host
22873 obtained from an MX record.
22874
22875 .vitem &%timeout_A%&
22876 There was a timeout while connecting or during an SMTP session with a host not
22877 obtained from an MX record.
22878
22879 .vitem &%timeout%&
22880 There was a timeout while connecting or during an SMTP session.
22881
22882 .vitem &%tls_required%&
22883 The server was required to use TLS (it matched &%hosts_require_tls%& in the
22884 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
22885 to STARTTLS, or there was a problem setting up the TLS connection.
22886
22887 .vitem &%quota%&
22888 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
22889 transport.
22890
22891 .vitem &%quota_%&<&'time'&>
22892 .cindex "quota" "error testing in retry rule"
22893 .cindex "retry" "quota error testing"
22894 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
22895 transport, and the mailbox has not been accessed for <&'time'&>. For example,
22896 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
22897 for four days.
22898 .endlist
22899
22900 .cindex "mailbox" "time of last read"
22901 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
22902 timeouts when the mailbox is full and is not being read by its owner. Ideally,
22903 it should be based on the last time that the user accessed the mailbox.
22904 However, it is not always possible to determine this. Exim uses the following
22905 heuristic rules:
22906
22907 .ilist
22908 If the mailbox is a single file, the time of last access (the &"atime"&) is
22909 used. As no new messages are being delivered (because the mailbox is over
22910 quota), Exim does not access the file, so this is the time of last user access.
22911 .next
22912 .cindex "maildir format" "time of last read"
22913 For a maildir delivery, the time of last modification of the &_new_&
22914 subdirectory is used. As the mailbox is over quota, no new files are created in
22915 the &_new_& subdirectory, because no new messages are being delivered. Any
22916 change to the &_new_& subdirectory is therefore assumed to be the result of an
22917 MUA moving a new message to the &_cur_& directory when it is first read. The
22918 time that is used is therefore the last time that the user read a new message.
22919 .next
22920 For other kinds of multi-file mailbox, the time of last access cannot be
22921 obtained, so a retry rule that uses this type of error field is never matched.
22922 .endlist
22923
22924 The quota errors apply both to system-enforced quotas and to Exim's own quota
22925 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
22926 when a local delivery is deferred because a partition is full (the ENOSPC
22927 error).
22928
22929
22930
22931 .section "Retry rules for specified senders" "SECID162"
22932 .cindex "retry" "rules; sender-specific"
22933 You can specify retry rules that apply only when the failing message has a
22934 specific sender. In particular, this can be used to define retry rules that
22935 apply only to bounce messages. The third item in a retry rule can be of this
22936 form:
22937 .display
22938 &`senders=`&<&'address list'&>
22939 .endd
22940 The retry timings themselves are then the fourth item. For example:
22941 .code
22942 *   rcpt_4xx   senders=:   F,1h,30m
22943 .endd
22944 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
22945 host. If the address list contains white space, it must be enclosed in quotes.
22946 For example:
22947 .code
22948 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
22949 .endd
22950 &*Warning*&: This facility can be unhelpful if it is used for host errors
22951 (which do not depend on the recipient). The reason is that the sender is used
22952 only to match the retry rule. Once the rule has been found for a host error,
22953 its contents are used to set a retry time for the host, and this will apply to
22954 all messages, not just those with specific senders.
22955
22956 When testing retry rules using &%-brt%&, you can supply a sender using the
22957 &%-f%& command line option, like this:
22958 .code
22959 exim -f "" -brt user@dom.ain
22960 .endd
22961 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
22962 list is never matched.
22963
22964
22965
22966
22967
22968 .section "Retry parameters" "SECID163"
22969 .cindex "retry" "parameters in rules"
22970 The third (or fourth, if a senders list is present) field in a retry rule is a
22971 sequence of retry parameter sets, separated by semicolons. Each set consists of
22972 .display
22973 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
22974 .endd
22975 The letter identifies the algorithm for computing a new retry time; the cutoff
22976 time is the time beyond which this algorithm no longer applies, and the
22977 arguments vary the algorithm's action. The cutoff time is measured from the
22978 time that the first failure for the domain (combined with the local part if
22979 relevant) was detected, not from the time the message was received.
22980
22981 .cindex "retry" "algorithms"
22982 .cindex "retry" "fixed intervals"
22983 .cindex "retry" "increasing intervals"
22984 .cindex "retry" "random intervals"
22985 The available algorithms are:
22986
22987 .ilist
22988 &'F'&: retry at fixed intervals. There is a single time parameter specifying
22989 the interval.
22990 .next
22991 &'G'&: retry at geometrically increasing intervals. The first argument
22992 specifies a starting value for the interval, and the second a multiplier, which
22993 is used to increase the size of the interval at each retry.
22994 .next
22995 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
22996 retry, the previous interval is multiplied by the factor in order to get a
22997 maximum for the next interval. The minimum interval is the first argument of
22998 the parameter, and an actual interval is chosen randomly between them. Such a
22999 rule has been found to be helpful in cluster configurations when all the
23000 members of the cluster restart at once, and may therefore synchronize their
23001 queue processing times.
23002 .endlist
23003
23004 When computing the next retry time, the algorithm definitions are scanned in
23005 order until one whose cutoff time has not yet passed is reached. This is then
23006 used to compute a new retry time that is later than the current time. In the
23007 case of fixed interval retries, this simply means adding the interval to the
23008 current time. For geometrically increasing intervals, retry intervals are
23009 computed from the rule's parameters until one that is greater than the previous
23010 interval is found. The main configuration variable
23011 .cindex "limit" "retry interval"
23012 .cindex "retry" "interval, maximum"
23013 .oindex "&%retry_interval_max%&"
23014 &%retry_interval_max%& limits the maximum interval between retries. It
23015 cannot be set greater than &`24h`&, which is its default value.
23016
23017 A single remote domain may have a number of hosts associated with it, and each
23018 host may have more than one IP address. Retry algorithms are selected on the
23019 basis of the domain name, but are applied to each IP address independently. If,
23020 for example, a host has two IP addresses and one is unusable, Exim will
23021 generate retry times for it and will not try to use it until its next retry
23022 time comes. Thus the good IP address is likely to be tried first most of the
23023 time.
23024
23025 .cindex "hints database" "use for retrying"
23026 Retry times are hints rather than promises. Exim does not make any attempt to
23027 run deliveries exactly at the computed times. Instead, a queue runner process
23028 starts delivery processes for delayed messages periodically, and these attempt
23029 new deliveries only for those addresses that have passed their next retry time.
23030 If a new message arrives for a deferred address, an immediate delivery attempt
23031 occurs only if the address has passed its retry time. In the absence of new
23032 messages, the minimum time between retries is the interval between queue runner
23033 processes. There is not much point in setting retry times of five minutes if
23034 your queue runners happen only once an hour, unless there are a significant
23035 number of incoming messages (which might be the case on a system that is
23036 sending everything to a smart host, for example).
23037
23038 The data in the retry hints database can be inspected by using the
23039 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
23040 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
23041 &'exinext'& utility script can be used to find out what the next retry times
23042 are for the hosts associated with a particular mail domain, and also for local
23043 deliveries that have been deferred.
23044
23045
23046 .section "Retry rule examples" "SECID164"
23047 Here are some example retry rules:
23048 .code
23049 alice@wonderland.fict.example quota_5d  F,7d,3h
23050 wonderland.fict.example       quota_5d
23051 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
23052 lookingglass.fict.example     *         F,24h,30m;
23053 *                 refused_A   F,2h,20m;
23054 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
23055 .endd
23056 The first rule sets up special handling for mail to
23057 &'alice@wonderland.fict.example'& when there is an over-quota error and the
23058 mailbox has not been read for at least 5 days. Retries continue every three
23059 hours for 7 days. The second rule handles over-quota errors for all other local
23060 parts at &'wonderland.fict.example'&; the absence of a local part has the same
23061 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
23062 fail are bounced immediately if the mailbox has not been read for at least 5
23063 days.
23064
23065 The third rule handles all other errors at &'wonderland.fict.example'&; retries
23066 happen every 15 minutes for an hour, then with geometrically increasing
23067 intervals until two days have passed since a delivery first failed. After the
23068 first hour there is a delay of one hour, then two hours, then four hours, and
23069 so on (this is a rather extreme example).
23070
23071 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
23072 They happen every 30 minutes for 24 hours only. The remaining two rules handle
23073 all other domains, with special action for connection refusal from hosts that
23074 were not obtained from an MX record.
23075
23076 The final rule in a retry configuration should always have asterisks in the
23077 first two fields so as to provide a general catch-all for any addresses that do
23078 not have their own special handling. This example tries every 15 minutes for 2
23079 hours, then with intervals starting at one hour and increasing by a factor of
23080 1.5 up to 16 hours, then every 8 hours up to 5 days.
23081
23082
23083
23084 .section "Timeout of retry data" "SECID165"
23085 .cindex "timeout" "of retry data"
23086 .oindex "&%retry_data_expire%&"
23087 .cindex "hints database" "data expiry"
23088 .cindex "retry" "timeout of data"
23089 Exim timestamps the data that it writes to its retry hints database. When it
23090 consults the data during a delivery it ignores any that is older than the value
23091 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
23092 been tried for 7 days, Exim will try to deliver to it immediately a message
23093 arrives, and if that fails, it will calculate a retry time as if it were
23094 failing for the first time.
23095
23096 This improves the behaviour for messages routed to rarely-used hosts such as MX
23097 backups. If such a host was down at one time, and happens to be down again when
23098 Exim tries a month later, using the old retry data would imply that it had been
23099 down all the time, which is not a justified assumption.
23100
23101 If a host really is permanently dead, this behaviour causes a burst of retries
23102 every now and again, but only if messages routed to it are rare. If there is a
23103 message at least once every 7 days the retry data never expires.
23104
23105
23106
23107
23108 .section "Long-term failures" "SECID166"
23109 .cindex "delivery failure, long-term"
23110 .cindex "retry" "after long-term failure"
23111 Special processing happens when an email address has been failing for so long
23112 that the cutoff time for the last algorithm is reached. For example, using the
23113 default retry rule:
23114 .code
23115 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
23116 .endd
23117 the cutoff time is four days. Reaching the retry cutoff is independent of how
23118 long any specific message has been failing; it is the length of continuous
23119 failure for the recipient address that counts.
23120
23121 When the cutoff time is reached for a local delivery, or for all the IP
23122 addresses associated with a remote delivery, a subsequent delivery failure
23123 causes Exim to give up on the address, and a bounce message is generated.
23124 In order to cater for new messages that use the failing address, a next retry
23125 time is still computed from the final algorithm, and is used as follows:
23126
23127 For local deliveries, one delivery attempt is always made for any subsequent
23128 messages. If this delivery fails, the address fails immediately. The
23129 post-cutoff retry time is not used.
23130
23131 If the delivery is remote, there are two possibilities, controlled by the
23132 .oindex "&%delay_after_cutoff%&"
23133 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
23134 default. Until the post-cutoff retry time for one of the IP addresses is
23135 reached, the failing email address is bounced immediately, without a delivery
23136 attempt taking place. After that time, one new delivery attempt is made to
23137 those IP addresses that are past their retry times, and if that still fails,
23138 the address is bounced and new retry times are computed.
23139
23140 In other words, when all the hosts for a given email address have been failing
23141 for a long time, Exim bounces rather then defers until one of the hosts' retry
23142 times is reached. Then it tries once, and bounces if that attempt fails. This
23143 behaviour ensures that few resources are wasted in repeatedly trying to deliver
23144 to a broken destination, but if the host does recover, Exim will eventually
23145 notice.
23146
23147 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
23148 addresses are past their final cutoff time, Exim tries to deliver to those IP
23149 addresses that have not been tried since the message arrived. If there are
23150 no suitable IP addresses, or if they all fail, the address is bounced. In other
23151 words, it does not delay when a new message arrives, but tries the expired
23152 addresses immediately, unless they have been tried since the message arrived.
23153 If there is a continuous stream of messages for the failing domains, setting
23154 &%delay_after_cutoff%& false means that there will be many more attempts to
23155 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
23156 true.
23157
23158 .section "Deliveries that work intermittently" "SECID167"
23159 .cindex "retry" "intermittently working deliveries"
23160 Some additional logic is needed to cope with cases where a host is
23161 intermittently available, or when a message has some attribute that prevents
23162 its delivery when others to the same address get through. In this situation,
23163 because some messages are successfully delivered, the &"retry clock"& for the
23164 host or address keeps getting reset by the successful deliveries, and so
23165 failing messages remain on the queue for ever because the cutoff time is never
23166 reached.
23167
23168 Two exceptional actions are applied to prevent this happening. The first
23169 applies to errors that are related to a message rather than a remote host.
23170 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
23171 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
23172 commands, and quota failures. For this type of error, if a message's arrival
23173 time is earlier than the &"first failed"& time for the error, the earlier time
23174 is used when scanning the retry rules to decide when to try next and when to
23175 time out the address.
23176
23177 The exceptional second action applies in all cases. If a message has been on
23178 the queue for longer than the cutoff time of any applicable retry rule for a
23179 given address, a delivery is attempted for that address, even if it is not yet
23180 time, and if this delivery fails, the address is timed out. A new retry time is
23181 not computed in this case, so that other messages for the same address are
23182 considered immediately.
23183 .ecindex IIDretconf1
23184 .ecindex IIDregconf2
23185
23186
23187
23188
23189
23190
23191 . ////////////////////////////////////////////////////////////////////////////
23192 . ////////////////////////////////////////////////////////////////////////////
23193
23194 .chapter "SMTP authentication" "CHAPSMTPAUTH"
23195 .scindex IIDauthconf1 "SMTP" "authentication configuration"
23196 .scindex IIDauthconf2 "authentication"
23197 The &"authenticators"& section of Exim's run time configuration is concerned
23198 with SMTP authentication. This facility is an extension to the SMTP protocol,
23199 described in RFC 2554, which allows a client SMTP host to authenticate itself
23200 to a server. This is a common way for a server to recognize clients that are
23201 permitted to use it as a relay. SMTP authentication is not of relevance to the
23202 transfer of mail between servers that have no managerial connection with each
23203 other.
23204
23205 .cindex "AUTH" "description of"
23206 Very briefly, the way SMTP authentication works is as follows:
23207
23208 .ilist
23209 The server advertises a number of authentication &'mechanisms'& in response to
23210 the client's EHLO command.
23211 .next
23212 The client issues an AUTH command, naming a specific mechanism. The command
23213 may, optionally, contain some authentication data.
23214 .next
23215 The server may issue one or more &'challenges'&, to which the client must send
23216 appropriate responses. In simple authentication mechanisms, the challenges are
23217 just prompts for user names and passwords. The server does not have to issue
23218 any challenges &-- in some mechanisms the relevant data may all be transmitted
23219 with the AUTH command.
23220 .next
23221 The server either accepts or denies authentication.
23222 .next
23223 If authentication succeeds, the client may optionally make use of the AUTH
23224 option on the MAIL command to pass an authenticated sender in subsequent
23225 mail transactions. Authentication lasts for the remainder of the SMTP
23226 connection.
23227 .next
23228 If authentication fails, the client may give up, or it may try a different
23229 authentication mechanism, or it may try transferring mail over the
23230 unauthenticated connection.
23231 .endlist
23232
23233 If you are setting up a client, and want to know which authentication
23234 mechanisms the server supports, you can use Telnet to connect to port 25 (the
23235 SMTP port) on the server, and issue an EHLO command. The response to this
23236 includes the list of supported mechanisms. For example:
23237 .display
23238 &`$ `&&*&`telnet server.example 25`&*&
23239 &`Trying 192.168.34.25...`&
23240 &`Connected to server.example.`&
23241 &`Escape character is &#x0027;^]&#x0027;.`&
23242 &`220 server.example ESMTP Exim 4.20 ...`&
23243 &*&`ehlo client.example`&*&
23244 &`250-server.example Hello client.example [10.8.4.5]`&
23245 &`250-SIZE 52428800`&
23246 &`250-PIPELINING`&
23247 &`250-AUTH PLAIN`&
23248 &`250 HELP`&
23249 .endd
23250 The second-last line of this example output shows that the server supports
23251 authentication using the PLAIN mechanism. In Exim, the different authentication
23252 mechanisms are configured by specifying &'authenticator'& drivers. Like the
23253 routers and transports, which authenticators are included in the binary is
23254 controlled by build-time definitions. The following are currently available,
23255 included by setting
23256 .code
23257 AUTH_CRAM_MD5=yes
23258 AUTH_CYRUS_SASL=yes
23259 AUTH_PLAINTEXT=yes
23260 AUTH_SPA=yes
23261 .endd
23262 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
23263 authentication mechanism (RFC 2195), and the second provides an interface to
23264 the Cyrus SASL authentication library. The third can be configured to support
23265 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
23266 not formally documented, but used by several MUAs. The fourth authenticator
23267 supports Microsoft's &'Secure Password Authentication'& mechanism.
23268
23269 The authenticators are configured using the same syntax as other drivers (see
23270 section &<<SECTfordricon>>&). If no authenticators are required, no
23271 authentication section need be present in the configuration file. Each
23272 authenticator can in principle have both server and client functions. When Exim
23273 is receiving SMTP mail, it is acting as a server; when it is sending out
23274 messages over SMTP, it is acting as a client. Authenticator configuration
23275 options are provided for use in both these circumstances.
23276
23277 To make it clear which options apply to which situation, the prefixes
23278 &%server_%& and &%client_%& are used on option names that are specific to
23279 either the server or the client function, respectively. Server and client
23280 functions are disabled if none of their options are set. If an authenticator is
23281 to be used for both server and client functions, a single definition, using
23282 both sets of options, is required. For example:
23283 .code
23284 cram:
23285   driver = cram_md5
23286   public_name = CRAM-MD5
23287   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
23288   client_name = ph10
23289   client_secret = secret2
23290 .endd
23291 The &%server_%& option is used when Exim is acting as a server, and the
23292 &%client_%& options when it is acting as a client.
23293
23294 Descriptions of the individual authenticators are given in subsequent chapters.
23295 The remainder of this chapter covers the generic options for the
23296 authenticators, followed by general discussion of the way authentication works
23297 in Exim.
23298
23299
23300
23301 .section "Generic options for authenticators" "SECID168"
23302 .cindex "authentication" "generic options"
23303 .cindex "options" "generic; for authenticators"
23304
23305 .option client_condition authenticators string&!! unset
23306 When Exim is authenticating as a client, it skips any authenticator whose
23307 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
23308 used, for example, to skip plain text authenticators when the connection is not
23309 encrypted by a setting such as:
23310 .code
23311 client_condition = ${if !eq{$tls_cipher}{}}
23312 .endd
23313 (Older documentation incorrectly states that &$tls_cipher$& contains the cipher
23314 used for incoming messages. In fact, during SMTP delivery, it contains the
23315 cipher used for the delivery.)
23316
23317
23318 .option driver authenticators string unset
23319 This option must always be set. It specifies which of the available
23320 authenticators is to be used.
23321
23322
23323 .option public_name authenticators string unset
23324 This option specifies the name of the authentication mechanism that the driver
23325 implements, and by which it is known to the outside world. These names should
23326 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
23327 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
23328 defaults to the driver's instance name.
23329
23330
23331 .option server_advertise_condition authenticators string&!! unset
23332 When a server is about to advertise an authentication mechanism, the condition
23333 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
23334 mechanism is not advertised.
23335 If the expansion fails, the mechanism is not advertised. If the failure was not
23336 forced, and was not caused by a lookup defer, the incident is logged.
23337 See section &<<SECTauthexiser>>& below for further discussion.
23338
23339
23340 .option server_condition authenticators string&!! unset
23341 This option must be set for a &%plaintext%& server authenticator, where it
23342 is used directly to control authentication. See section &<<SECTplainserver>>&
23343 for details.
23344
23345 For the other authenticators, &%server_condition%& can be used as an additional
23346 authentication or authorization mechanism that is applied after the other
23347 authenticator conditions succeed. If it is set, it is expanded when the
23348 authenticator would otherwise return a success code. If the expansion is forced
23349 to fail, authentication fails. Any other expansion failure causes a temporary
23350 error code to be returned. If the result of a successful expansion is an empty
23351 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
23352 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
23353 other result, a temporary error code is returned, with the expanded string as
23354 the error text.
23355
23356
23357 .option server_debug_print authenticators string&!! unset
23358 If this option is set and authentication debugging is enabled (see the &%-d%&
23359 command line option), the string is expanded and included in the debugging
23360 output when the authenticator is run as a server. This can help with checking
23361 out the values of variables.
23362 If expansion of the string fails, the error message is written to the debugging
23363 output, and Exim carries on processing.
23364
23365
23366 .option server_set_id authenticators string&!! unset
23367 .vindex "&$authenticated_id$&"
23368 When an Exim server successfully authenticates a client, this string is
23369 expanded using data from the authentication, and preserved for any incoming
23370 messages in the variable &$authenticated_id$&. It is also included in the log
23371 lines for incoming messages. For example, a user/password authenticator
23372 configuration might preserve the user name that was used to authenticate, and
23373 refer to it subsequently during delivery of the message.
23374 If expansion fails, the option is ignored.
23375
23376
23377 .option server_mail_auth_condition authenticators string&!! unset
23378 This option allows a server to discard authenticated sender addresses supplied
23379 as part of MAIL commands in SMTP connections that are authenticated by the
23380 driver on which &%server_mail_auth_condition%& is set. The option is not used
23381 as part of the authentication process; instead its (unexpanded) value is
23382 remembered for later use.
23383 How it is used is described in the following section.
23384
23385
23386
23387
23388
23389 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
23390 .cindex "authentication" "sender; authenticated"
23391 .cindex "AUTH" "on MAIL command"
23392 When a client supplied an AUTH= item on a MAIL command, Exim applies
23393 the following checks before accepting it as the authenticated sender of the
23394 message:
23395
23396 .ilist
23397 If the connection is not using extended SMTP (that is, HELO was used rather
23398 than EHLO), the use of AUTH= is a syntax error.
23399 .next
23400 If the value of the AUTH= parameter is &"<>"&, it is ignored.
23401 .next
23402 .vindex "&$authenticated_sender$&"
23403 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
23404 running, the value of &$authenticated_sender$& is set to the value obtained
23405 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
23406 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
23407 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
23408 given for the MAIL command.
23409 .next
23410 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
23411 is accepted and placed in &$authenticated_sender$& only if the client has
23412 authenticated.
23413 .next
23414 If the AUTH= value was accepted by either of the two previous rules, and
23415 the client has authenticated, and the authenticator has a setting for the
23416 &%server_mail_auth_condition%&, the condition is checked at this point. The
23417 valued that was saved from the authenticator is expanded. If the expansion
23418 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
23419 &$authenticated_sender$& is deleted. If the expansion yields any other value,
23420 the value of &$authenticated_sender$& is retained and passed on with the
23421 message.
23422 .endlist
23423
23424
23425 When &$authenticated_sender$& is set for a message, it is passed on to other
23426 hosts to which Exim authenticates as a client. Do not confuse this value with
23427 &$authenticated_id$&, which is a string obtained from the authentication
23428 process, and which is not usually a complete email address.
23429
23430 .vindex "&$sender_address$&"
23431 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
23432 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
23433 therefore make use of &$authenticated_sender$&. The converse is not true: the
23434 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
23435 ACL is run.
23436
23437
23438
23439 .section "Authentication on an Exim server" "SECTauthexiser"
23440 .cindex "authentication" "on an Exim server"
23441 When Exim receives an EHLO command, it advertises the public names of those
23442 authenticators that are configured as servers, subject to the following
23443 conditions:
23444
23445 .ilist
23446 The client host must match &%auth_advertise_hosts%& (default *).
23447 .next
23448 It the &%server_advertise_condition%& option is set, its expansion must not
23449 yield the empty string, &"0"&, &"no"&, or &"false"&.
23450 .endlist
23451
23452 The order in which the authenticators are defined controls the order in which
23453 the mechanisms are advertised.
23454
23455 Some mail clients (for example, some versions of Netscape) require the user to
23456 provide a name and password for authentication whenever AUTH is advertised,
23457 even though authentication may not in fact be needed (for example, Exim may be
23458 set up to allow unconditional relaying from the client by an IP address check).
23459 You can make such clients more friendly by not advertising AUTH to them.
23460 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
23461 that runs for RCPT) to relay without authentication, you should set
23462 .code
23463 auth_advertise_hosts = ! 10.9.8.0/24
23464 .endd
23465 so that no authentication mechanisms are advertised to them.
23466
23467 The &%server_advertise_condition%& controls the advertisement of individual
23468 authentication mechanisms. For example, it can be used to restrict the
23469 advertisement of a particular mechanism to encrypted connections, by a setting
23470 such as:
23471 .code
23472 server_advertise_condition = ${if eq{$tls_cipher}{}{no}{yes}}
23473 .endd
23474 .vindex "&$tls_cipher$&"
23475 If the session is encrypted, &$tls_cipher$& is not empty, and so the expansion
23476 yields &"yes"&, which allows the advertisement to happen.
23477
23478 When an Exim server receives an AUTH command from a client, it rejects it
23479 immediately if AUTH was not advertised in response to an earlier EHLO
23480 command. This is the case if
23481
23482 .ilist
23483 The client host does not match &%auth_advertise_hosts%&; or
23484 .next
23485 No authenticators are configured with server options; or
23486 .next
23487 Expansion of &%server_advertise_condition%& blocked the advertising of all the
23488 server authenticators.
23489 .endlist
23490
23491
23492 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
23493 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
23494 AUTH is accepted from any client host.
23495
23496 If AUTH is not rejected by the ACL, Exim searches its configuration for a
23497 server authentication mechanism that was advertised in response to EHLO and
23498 that matches the one named in the AUTH command. If it finds one, it runs
23499 the appropriate authentication protocol, and authentication either succeeds or
23500 fails. If there is no matching advertised mechanism, the AUTH command is
23501 rejected with a 504 error.
23502
23503 .vindex "&$received_protocol$&"
23504 .vindex "&$sender_host_authenticated$&"
23505 When a message is received from an authenticated host, the value of
23506 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
23507 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
23508 public name) of the authenticator driver that successfully authenticated the
23509 client from which the message was received. This variable is empty if there was
23510 no successful authentication.
23511
23512
23513
23514
23515 .section "Testing server authentication" "SECID169"
23516 .cindex "authentication" "testing a server"
23517 .cindex "AUTH" "testing a server"
23518 .cindex "base64 encoding" "creating authentication test data"
23519 Exim's &%-bh%& option can be useful for testing server authentication
23520 configurations. The data for the AUTH command has to be sent using base64
23521 encoding. A quick way to produce such data for testing is the following Perl
23522 script:
23523 .code
23524 use MIME::Base64;
23525 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
23526 .endd
23527 .cindex "binary zero" "in authentication data"
23528 This interprets its argument as a Perl string, and then encodes it. The
23529 interpretation as a Perl string allows binary zeros, which are required for
23530 some kinds of authentication, to be included in the data. For example, a
23531 command line to run this script on such data might be
23532 .code
23533 encode '\0user\0password'
23534 .endd
23535 Note the use of single quotes to prevent the shell interpreting the
23536 backslashes, so that they can be interpreted by Perl to specify characters
23537 whose code value is zero.
23538
23539 &*Warning 1*&: If either of the user or password strings starts with an octal
23540 digit, you must use three zeros instead of one after the leading backslash. If
23541 you do not, the octal digit that starts your string will be incorrectly
23542 interpreted as part of the code for the first character.
23543
23544 &*Warning 2*&: If there are characters in the strings that Perl interprets
23545 specially, you must use a Perl escape to prevent them being misinterpreted. For
23546 example, a command such as
23547 .code
23548 encode '\0user@domain.com\0pas$$word'
23549 .endd
23550 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
23551
23552 If you have the &%mimencode%& command installed, another way to do produce
23553 base64-encoded strings is to run the command
23554 .code
23555 echo -e -n `\0user\0password' | mimencode
23556 .endd
23557 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
23558 in the argument, and the &%-n%& option specifies no newline at the end of its
23559 output. However, not all versions of &%echo%& recognize these options, so you
23560 should check your version before relying on this suggestion.
23561
23562
23563
23564 .section "Authentication by an Exim client" "SECID170"
23565 .cindex "authentication" "on an Exim client"
23566 The &(smtp)& transport has two options called &%hosts_require_auth%& and
23567 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
23568 announces support for authentication, and the host matches an entry in either
23569 of these options, Exim (as a client) tries to authenticate as follows:
23570
23571 .ilist
23572 For each authenticator that is configured as a client, in the order in which
23573 they are defined in the configuration, it searches the authentication
23574 mechanisms announced by the server for one whose name matches the public name
23575 of the authenticator.
23576 .next
23577 .vindex "&$host$&"
23578 .vindex "&$host_address$&"
23579 When it finds one that matches, it runs the authenticator's client code. The
23580 variables &$host$& and &$host_address$& are available for any string expansions
23581 that the client might do. They are set to the server's name and IP address. If
23582 any expansion is forced to fail, the authentication attempt is abandoned, and
23583 Exim moves on to the next authenticator. Otherwise an expansion failure causes
23584 delivery to be deferred.
23585 .next
23586 If the result of the authentication attempt is a temporary error or a timeout,
23587 Exim abandons trying to send the message to the host for the moment. It will
23588 try again later. If there are any backup hosts available, they are tried in the
23589 usual way.
23590 .next
23591 If the response to authentication is a permanent error (5&'xx'& code), Exim
23592 carries on searching the list of authenticators and tries another one if
23593 possible. If all authentication attempts give permanent errors, or if there are
23594 no attempts because no mechanisms match (or option expansions force failure),
23595 what happens depends on whether the host matches &%hosts_require_auth%& or
23596 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
23597 delivery is deferred. The error can be detected in the retry rules, and thereby
23598 turned into a permanent error if you wish. In the second case, Exim tries to
23599 deliver the message unauthenticated.
23600 .endlist
23601
23602 .cindex "AUTH" "on MAIL command"
23603 When Exim has authenticated itself to a remote server, it adds the AUTH
23604 parameter to the MAIL commands it sends, if it has an authenticated sender for
23605 the message. If the message came from a remote host, the authenticated sender
23606 is the one that was receiving on an incoming MAIL command, provided that the
23607 incoming connection was authenticated and the &%server_mail_auth%& condition
23608 allowed the authenticated sender to be retained. If a local process calls Exim
23609 to send a message, the sender address that is built from the login name and
23610 &%qualify_domain%& is treated as authenticated. However, if the
23611 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
23612 the authenticated sender that was received with the message.
23613 .ecindex IIDauthconf1
23614 .ecindex IIDauthconf2
23615
23616
23617
23618
23619
23620
23621 . ////////////////////////////////////////////////////////////////////////////
23622 . ////////////////////////////////////////////////////////////////////////////
23623
23624 .chapter "The plaintext authenticator" "CHAPplaintext"
23625 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
23626 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
23627 The &(plaintext)& authenticator can be configured to support the PLAIN and
23628 LOGIN authentication mechanisms, both of which transfer authentication data as
23629 plain (unencrypted) text (though base64 encoded). The use of plain text is a
23630 security risk; you are strongly advised to insist on the use of SMTP encryption
23631 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
23632 use unencrypted plain text, you should not use the same passwords for SMTP
23633 connections as you do for login accounts.
23634
23635 .section "Plaintext options" "SECID171"
23636 .cindex "options" "&(plaintext)& authenticator (server)"
23637 When configured as a server, &(plaintext)& uses the following options:
23638
23639 .option server_condition authenticators string&!! unset
23640 This is actually a global authentication option, but it must be set in order to
23641 configure the &(plaintext)& driver as a server. Its use is described below.
23642
23643 .option server_prompts plaintext string&!! unset
23644 The contents of this option, after expansion, must be a colon-separated list of
23645 prompt strings. If expansion fails, a temporary authentication rejection is
23646 given.
23647
23648 .section "Using plaintext in a server" "SECTplainserver"
23649 .cindex "AUTH" "in &(plaintext)& authenticator"
23650 .cindex "binary zero" "in &(plaintext)& authenticator"
23651 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
23652         "in &(plaintext)& authenticator"
23653 .vindex "&$auth1$&, &$auth2$&, etc"
23654 .cindex "base64 encoding" "in &(plaintext)& authenticator"
23655
23656 When running as a server, &(plaintext)& performs the authentication test by
23657 expanding a string. The data sent by the client with the AUTH command, or in
23658 response to subsequent prompts, is base64 encoded, and so may contain any byte
23659 values when decoded. If any data is supplied with the command, it is treated as
23660 a list of strings, separated by NULs (binary zeros), the first three of which
23661 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
23662 (neither LOGIN nor PLAIN uses more than three strings).
23663
23664 For compatibility with previous releases of Exim, the values are also placed in
23665 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
23666 variables for this purpose is now deprecated, as it can lead to confusion in
23667 string expansions that also use them for other things.
23668
23669 If there are more strings in &%server_prompts%& than the number of strings
23670 supplied with the AUTH command, the remaining prompts are used to obtain more
23671 data. Each response from the client may be a list of NUL-separated strings.
23672
23673 .vindex "&$authenticated_id$&"
23674 Once a sufficient number of data strings have been received,
23675 &%server_condition%& is expanded. If the expansion is forced to fail,
23676 authentication fails. Any other expansion failure causes a temporary error code
23677 to be returned. If the result of a successful expansion is an empty string,
23678 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
23679 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
23680 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
23681 For any other result, a temporary error code is returned, with the expanded
23682 string as the error text.
23683
23684 &*Warning*&: If you use a lookup in the expansion to find the user's
23685 password, be sure to make the authentication fail if the user is unknown.
23686 There are good and bad examples at the end of the next section.
23687
23688
23689
23690 .section "The PLAIN authentication mechanism" "SECID172"
23691 .cindex "PLAIN authentication mechanism"
23692 .cindex "authentication" "PLAIN mechanism"
23693 .cindex "binary zero" "in &(plaintext)& authenticator"
23694 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
23695 sent as one item of data (that is, one combined string containing two NUL
23696 separators). The data is sent either as part of the AUTH command, or
23697 subsequently in response to an empty prompt from the server.
23698
23699 The second and third strings are a user name and a corresponding password.
23700 Using a single fixed user name and password as an example, this could be
23701 configured as follows:
23702 .code
23703 fixed_plain:
23704   driver = plaintext
23705   public_name = PLAIN
23706   server_prompts = :
23707   server_condition = \
23708     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
23709   server_set_id = $auth2
23710 .endd
23711 Note that the default result strings from &%if%& (&"true"& or an empty string)
23712 are exactly what we want here, so they need not be specified. Obviously, if the
23713 password contains expansion-significant characters such as dollar, backslash,
23714 or closing brace, they have to be escaped.
23715
23716 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
23717 the end of a string list are ignored). If all the data comes as part of the
23718 AUTH command, as is commonly the case, the prompt is not used. This
23719 authenticator is advertised in the response to EHLO as
23720 .code
23721 250-AUTH PLAIN
23722 .endd
23723 and a client host can authenticate itself by sending the command
23724 .code
23725 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
23726 .endd
23727 As this contains three strings (more than the number of prompts), no further
23728 data is required from the client. Alternatively, the client may just send
23729 .code
23730 AUTH PLAIN
23731 .endd
23732 to initiate authentication, in which case the server replies with an empty
23733 prompt. The client must respond with the combined data string.
23734
23735 The data string is base64 encoded, as required by the RFC. This example,
23736 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
23737 represents a zero byte. This is split up into three strings, the first of which
23738 is empty. The &%server_condition%& option in the authenticator checks that the
23739 second two are &`username`& and &`mysecret`& respectively.
23740
23741 Having just one fixed user name and password, as in this example, is not very
23742 realistic, though for a small organization with only a handful of
23743 authenticating clients it could make sense.
23744
23745 A more sophisticated instance of this authenticator could use the user name in
23746 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
23747 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
23748 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
23749 This is an incorrect example:
23750 .code
23751 server_condition = \
23752   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
23753 .endd
23754 The expansion uses the user name (&$auth2$&) as the key to look up a password,
23755 which it then compares to the supplied password (&$auth3$&). Why is this example
23756 incorrect? It works fine for existing users, but consider what happens if a
23757 non-existent user name is given. The lookup fails, but as no success/failure
23758 strings are given for the lookup, it yields an empty string. Thus, to defeat
23759 the authentication, all a client has to do is to supply a non-existent user
23760 name and an empty password. The correct way of writing this test is:
23761 .code
23762 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
23763   {${if eq{$value}{$auth3}}} {false}}
23764 .endd
23765 In this case, if the lookup succeeds, the result is checked; if the lookup
23766 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
23767 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
23768 always fails if its second argument is empty. However, the second way of
23769 writing the test makes the logic clearer.
23770
23771
23772 .section "The LOGIN authentication mechanism" "SECID173"
23773 .cindex "LOGIN authentication mechanism"
23774 .cindex "authentication" "LOGIN mechanism"
23775 The LOGIN authentication mechanism is not documented in any RFC, but is in use
23776 in a number of programs. No data is sent with the AUTH command. Instead, a
23777 user name and password are supplied separately, in response to prompts. The
23778 plaintext authenticator can be configured to support this as in this example:
23779 .code
23780 fixed_login:
23781   driver = plaintext
23782   public_name = LOGIN
23783   server_prompts = User Name : Password
23784   server_condition = \
23785     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
23786   server_set_id = $auth1
23787 .endd
23788 Because of the way plaintext operates, this authenticator accepts data supplied
23789 with the AUTH command (in contravention of the specification of LOGIN), but
23790 if the client does not supply it (as is the case for LOGIN clients), the prompt
23791 strings are used to obtain two data items.
23792
23793 .new
23794 Some clients are very particular about the precise text of the prompts. For
23795 example, Outlook Express is reported to recognize only &"Username:"& and
23796 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
23797 strings. It uses the &%ldapauth%& expansion condition to check the user
23798 name and password by binding to an LDAP server:
23799 .code
23800 login:
23801   driver = plaintext
23802   public_name = LOGIN
23803   server_prompts = Username:: : Password::
23804   server_condition = ${if and{{ \
23805     !eq{}{$auth1} }{ \
23806     ldapauth{user="cn=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
23807              pass=${quote:$auth2} \
23808              ldap://ldap.example.org/} }} }
23809   server_set_id = uid=$auth1,ou=people,o=example.org
23810 .endd
23811 We have to check that the username is not empty before using it, because LDAP
23812 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
23813 operator to correctly quote the DN for authentication. However, the basic
23814 &%quote%& operator, rather than any of the LDAP quoting operators, is the
23815 correct one to use for the password, because quoting is needed only to make
23816 the password conform to the Exim syntax. At the LDAP level, the password is an
23817 uninterpreted string.
23818 .wen
23819
23820 .section "Support for different kinds of authentication" "SECID174"
23821 A number of string expansion features are provided for the purpose of
23822 interfacing to different ways of user authentication. These include checking
23823 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
23824 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
23825 &<<SECTexpcond>>&.
23826
23827
23828
23829
23830 .section "Using plaintext in a client" "SECID175"
23831 .cindex "options" "&(plaintext)& authenticator (client)"
23832 The &(plaintext)& authenticator has two client options:
23833
23834 .option client_ignore_invalid_base64 plaintext boolean false
23835 If the client receives a server prompt that is not a valid base64 string,
23836 authentication is abandoned by default. However, if this option is set true,
23837 the error in the challenge is ignored and the client sends the response as
23838 usual.
23839
23840 .option client_send plaintext string&!! unset
23841 The string is a colon-separated list of authentication data strings. Each
23842 string is independently expanded before being sent to the server. The first
23843 string is sent with the AUTH command; any more strings are sent in response
23844 to prompts from the server. Before each string is expanded, the value of the
23845 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
23846 with &$auth1$& for the first prompt. Up to three prompts are stored in this
23847 way. Thus, the prompt that is received in response to sending the first string
23848 (with the AUTH command) can be used in the expansion of the second string, and
23849 so on. If an invalid base64 string is received when
23850 &%client_ignore_invalid_base64%& is set, an empty string is put in the
23851 &$auth$&<&'n'&> variable.
23852
23853 &*Note*&: You cannot use expansion to create multiple strings, because
23854 splitting takes priority and happens first.
23855
23856 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
23857 the data, further processing is applied to each string before it is sent. If
23858 there are any single circumflex characters in the string, they are converted to
23859 NULs. Should an actual circumflex be required as data, it must be doubled in
23860 the string.
23861
23862 This is an example of a client configuration that implements the PLAIN
23863 authentication mechanism with a fixed user name and password:
23864 .code
23865 fixed_plain:
23866   driver = plaintext
23867   public_name = PLAIN
23868   client_send = ^username^mysecret
23869 .endd
23870 The lack of colons means that the entire text is sent with the AUTH
23871 command, with the circumflex characters converted to NULs. A similar example
23872 that uses the LOGIN mechanism is:
23873 .code
23874 fixed_login:
23875   driver = plaintext
23876   public_name = LOGIN
23877   client_send = : username : mysecret
23878 .endd
23879 The initial colon means that the first string is empty, so no data is sent with
23880 the AUTH command itself. The remaining strings are sent in response to
23881 prompts.
23882 .ecindex IIDplaiauth1
23883 .ecindex IIDplaiauth2
23884
23885
23886
23887
23888 . ////////////////////////////////////////////////////////////////////////////
23889 . ////////////////////////////////////////////////////////////////////////////
23890
23891 .chapter "The cram_md5 authenticator" "CHID9"
23892 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
23893 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
23894 .cindex "CRAM-MD5 authentication mechanism"
23895 .cindex "authentication" "CRAM-MD5 mechanism"
23896 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
23897 sends a challenge string to the client, and the response consists of a user
23898 name and the CRAM-MD5 digest of the challenge string combined with a secret
23899 string (password) which is known to both server and client. Thus, the secret
23900 is not sent over the network as plain text, which makes this authenticator more
23901 secure than &(plaintext)&. However, the downside is that the secret has to be
23902 available in plain text at either end.
23903
23904
23905 .section "Using cram_md5 as a server" "SECID176"
23906 .cindex "options" "&(cram_md5)& authenticator (server)"
23907 This authenticator has one server option, which must be set to configure the
23908 authenticator as a server:
23909
23910 .option server_secret cram_md5 string&!! unset
23911 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
23912 When the server receives the client's response, the user name is placed in
23913 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
23914 obtain the password for that user. The server then computes the CRAM-MD5 digest
23915 that the client should have sent, and checks that it received the correct
23916 string. If the expansion of &%server_secret%& is forced to fail, authentication
23917 fails. If the expansion fails for some other reason, a temporary error code is
23918 returned to the client.
23919
23920 For compatibility with previous releases of Exim, the user name is also placed
23921 in &$1$&. However, the use of this variables for this purpose is now
23922 deprecated, as it can lead to confusion in string expansions that also use
23923 numeric variables for other things.
23924
23925 For example, the following authenticator checks that the user name given by the
23926 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
23927 user name, authentication fails.
23928 .code
23929 fixed_cram:
23930   driver = cram_md5
23931   public_name = CRAM-MD5
23932   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
23933   server_set_id = $auth1
23934 .endd
23935 .vindex "&$authenticated_id$&"
23936 If authentication succeeds, the setting of &%server_set_id%& preserves the user
23937 name in &$authenticated_id$&. A more typical configuration might look up the
23938 secret string in a file, using the user name as the key. For example:
23939 .code
23940 lookup_cram:
23941   driver = cram_md5
23942   public_name = CRAM-MD5
23943   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
23944                   {$value}fail}
23945   server_set_id = $auth1
23946 .endd
23947 Note that this expansion explicitly forces failure if the lookup fails
23948 because &$auth1$& contains an unknown user name.
23949
23950
23951 .section "Using cram_md5 as a client" "SECID177"
23952 .cindex "options" "&(cram_md5)& authenticator (client)"
23953 When used as a client, the &(cram_md5)& authenticator has two options:
23954
23955
23956
23957 .option client_name cram_md5 string&!! "the primary host name"
23958 This string is expanded, and the result used as the user name data when
23959 computing the response to the server's challenge.
23960
23961
23962 .option client_secret cram_md5 string&!! unset
23963 This option must be set for the authenticator to work as a client. Its value is
23964 expanded and the result used as the secret string when computing the response.
23965
23966
23967 .vindex "&$host$&"
23968 .vindex "&$host_address$&"
23969 Different user names and secrets can be used for different servers by referring
23970 to &$host$& or &$host_address$& in the options. Forced failure of either
23971 expansion string is treated as an indication that this authenticator is not
23972 prepared to handle this case. Exim moves on to the next configured client
23973 authenticator. Any other expansion failure causes Exim to give up trying to
23974 send the message to the current server.
23975
23976 A simple example configuration of a &(cram_md5)& authenticator, using fixed
23977 strings, is:
23978 .code
23979 fixed_cram:
23980   driver = cram_md5
23981   public_name = CRAM-MD5
23982   client_name = ph10
23983   client_secret = secret
23984 .endd
23985 .ecindex IIDcramauth1
23986 .ecindex IIDcramauth2
23987
23988
23989
23990 . ////////////////////////////////////////////////////////////////////////////
23991 . ////////////////////////////////////////////////////////////////////////////
23992
23993 .chapter "The cyrus_sasl authenticator" "CHID10"
23994 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
23995 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
23996 .cindex "Cyrus" "SASL library"
23997 .cindex "Kerberos"
23998 The code for this authenticator was provided by Matthew Byng-Maddick of A L
23999 Digital Ltd (&url(http://www.aldigital.co.uk)).
24000
24001 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
24002 library implementation of the RFC 2222 (&"Simple Authentication and Security
24003 Layer"&). This library supports a number of authentication mechanisms,
24004 including PLAIN and LOGIN, but also several others that Exim does not support
24005 directly. In particular, there is support for Kerberos authentication.
24006
24007 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
24008 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
24009 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
24010 name of the driver to determine which mechanism to support.
24011
24012 Where access to some kind of secret file is required, for example in GSSAPI
24013 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
24014 user, and that the Cyrus SASL library has no way of escalating privileges
24015 by default. You may also find you need to set environment variables,
24016 depending on the driver you are using.
24017
24018 The application name provided by Exim is &"exim"&, so various SASL options may
24019 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
24020 Kerberos, note that because of limitations in the GSSAPI interface,
24021 changing the server keytab might need to be communicated down to the Kerberos
24022 layer independently. The mechanism for doing so is dependent upon the Kerberos
24023 implementation. For example, for Heimdal, the environment variable KRB5_KTNAME
24024 may be set to point to an alternative keytab file. Exim will pass this
24025 variable through from its own inherited environment when started as root or the
24026 Exim user. The keytab file needs to be readable by the Exim user.
24027
24028
24029 .section "Using cyrus_sasl as a server" "SECID178"
24030 The &(cyrus_sasl)& authenticator has four private options. It puts the username
24031 (on a successful authentication) into &$auth1$&. For compatibility with
24032 previous releases of Exim, the username is also placed in &$1$&. However, the
24033 use of this variable for this purpose is now deprecated, as it can lead to
24034 confusion in string expansions that also use numeric variables for other
24035 things.
24036
24037
24038 .option server_hostname cyrus_sasl string&!! "see below"
24039 This option selects the hostname that is used when communicating with the
24040 library. The default value is &`$primary_hostname`&. It is up to the underlying
24041 SASL plug-in what it does with this data.
24042
24043
24044 .option server_mech cyrus_sasl string "see below"
24045 This option selects the authentication mechanism this driver should use. The
24046 default is the value of the generic &%public_name%& option. This option allows
24047 you to use a different underlying mechanism from the advertised name. For
24048 example:
24049 .code
24050 sasl:
24051   driver = cyrus_sasl
24052   public_name = X-ANYTHING
24053   server_mech = CRAM-MD5
24054   server_set_id = $auth1
24055 .endd
24056
24057 .option server_realm cyrus_sasl string unset
24058 This specifies the SASL realm that the server claims to be in.
24059
24060
24061 .option server_service cyrus_sasl string &`smtp`&
24062 This is the SASL service that the server claims to implement.
24063
24064
24065 For straightforward cases, you do not need to set any of the authenticator's
24066 private options. All you need to do is to specify an appropriate mechanism as
24067 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
24068 PLAIN, you could have two authenticators as follows:
24069 .code
24070 sasl_cram_md5:
24071   driver = cyrus_sasl
24072   public_name = CRAM-MD5
24073   server_set_id = $auth1
24074
24075 sasl_plain:
24076   driver = cyrus_sasl
24077   public_name = PLAIN
24078   server_set_id = $auth2
24079 .endd
24080 Cyrus SASL does implement the LOGIN authentication method, even though it is
24081 not a standard method. It is disabled by default in the source distribution,
24082 but it is present in many binary distributions.
24083 .ecindex IIDcyrauth1
24084 .ecindex IIDcyrauth2
24085
24086
24087
24088
24089 . ////////////////////////////////////////////////////////////////////////////
24090 . ////////////////////////////////////////////////////////////////////////////
24091 .chapter "The dovecot authenticator" "CHAPdovecot"
24092 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
24093 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
24094 This authenticator is an interface to the authentication facility of the
24095 Dovecot POP/IMAP server, which can support a number of authentication methods.
24096 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
24097 to use the same mechanisms for SMTP authentication. This is a server
24098 authenticator only. There is only one option:
24099
24100 .option server_socket dovecot string unset
24101
24102 This option must specify the socket that is the interface to Dovecot
24103 authentication. The &%public_name%& option must specify an authentication
24104 mechanism that Dovecot is configured to support. You can have several
24105 authenticators for different mechanisms. For example:
24106 .code
24107 dovecot_plain:
24108   driver = dovecot
24109   public_name = PLAIN
24110   server_socket = /var/run/dovecot/auth-client
24111   server_set_id = $auth2
24112
24113 dovecot_ntlm:
24114   driver = dovecot
24115   public_name = NTLM
24116   server_socket = /var/run/dovecot/auth-client
24117   server_set_id = $auth1
24118 .endd
24119 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
24120 &$received_ip_address$& (that is, the connection is local), the &"secured"&
24121 option is passed in the Dovecot authentication command. If, for a TLS
24122 connection, a client certificate has been verified, the &"valid-client-cert"&
24123 option is passed. When authentication succeeds, the identity of the user
24124 who authenticated is placed in &$auth1$&.
24125 .ecindex IIDdcotauth1
24126 .ecindex IIDdcotauth2
24127
24128
24129 . ////////////////////////////////////////////////////////////////////////////
24130 . ////////////////////////////////////////////////////////////////////////////
24131
24132 .chapter "The spa authenticator" "CHAPspa"
24133 .scindex IIDspaauth1 "&(spa)& authenticator"
24134 .scindex IIDspaauth2 "authenticators" "&(spa)&"
24135 .cindex "authentication" "Microsoft Secure Password"
24136 .cindex "authentication" "NTLM"
24137 .cindex "Microsoft Secure Password Authentication"
24138 .cindex "NTLM authentication"
24139 The &(spa)& authenticator provides client support for Microsoft's &'Secure
24140 Password Authentication'& mechanism,
24141 which is also sometimes known as NTLM (NT LanMan). The code for client side of
24142 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
24143 taken from the Samba project (&url(http://www.samba.org)). The code for the
24144 server side was subsequently contributed by Tom Kistner. The mechanism works as
24145 follows:
24146
24147 .ilist
24148 After the AUTH command has been accepted, the client sends an SPA
24149 authentication request based on the user name and optional domain.
24150 .next
24151 The server sends back a challenge.
24152 .next
24153 The client builds a challenge response which makes use of the user's password
24154 and sends it to the server, which then accepts or rejects it.
24155 .endlist
24156
24157 Encryption is used to protect the password in transit.
24158
24159
24160
24161 .section "Using spa as a server" "SECID179"
24162 .cindex "options" "&(spa)& authenticator (server)"
24163 The &(spa)& authenticator has just one server option:
24164
24165 .option server_password spa string&!! unset
24166 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
24167 This option is expanded, and the result must be the cleartext password for the
24168 authenticating user, whose name is at this point in &$auth1$&. For
24169 compatibility with previous releases of Exim, the user name is also placed in
24170 &$1$&. However, the use of this variable for this purpose is now deprecated, as
24171 it can lead to confusion in string expansions that also use numeric variables
24172 for other things. For example:
24173 .code
24174 spa:
24175   driver = spa
24176   public_name = NTLM
24177   server_password = \
24178     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
24179 .endd
24180 If the expansion is forced to fail, authentication fails. Any other expansion
24181 failure causes a temporary error code to be returned.
24182
24183
24184
24185
24186
24187 .section "Using spa as a client" "SECID180"
24188 .cindex "options" "&(spa)& authenticator (client)"
24189 The &(spa)& authenticator has the following client options:
24190
24191
24192
24193 .option client_domain spa string&!! unset
24194 This option specifies an optional domain for the authentication.
24195
24196
24197 .option client_password spa string&!! unset
24198 This option specifies the user's password, and must be set.
24199
24200
24201 .option client_username spa string&!! unset
24202 This option specifies the user name, and must be set. Here is an example of a
24203 configuration of this authenticator for use with the mail servers at
24204 &'msn.com'&:
24205 .code
24206 msn:
24207   driver = spa
24208   public_name = MSN
24209   client_username = msn/msn_username
24210   client_password = msn_plaintext_password
24211   client_domain = DOMAIN_OR_UNSET
24212 .endd
24213 .ecindex IIDspaauth1
24214 .ecindex IIDspaauth2
24215
24216
24217
24218
24219
24220 . ////////////////////////////////////////////////////////////////////////////
24221 . ////////////////////////////////////////////////////////////////////////////
24222
24223 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
24224          "Encrypted SMTP connections"
24225 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
24226 .scindex IIDencsmtp2 "SMTP" "encryption"
24227 .cindex "TLS" "on SMTP connection"
24228 .cindex "OpenSSL"
24229 .cindex "GnuTLS"
24230 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
24231 Sockets Layer), is implemented by making use of the OpenSSL library or the
24232 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
24233 cryptographic code in the Exim distribution itself for implementing TLS. In
24234 order to use this feature you must install OpenSSL or GnuTLS, and then build a
24235 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
24236 You also need to understand the basic concepts of encryption at a managerial
24237 level, and in particular, the way that public keys, private keys, and
24238 certificates are used.
24239
24240 RFC 3207 defines how SMTP connections can make use of encryption. Once a
24241 connection is established, the client issues a STARTTLS command. If the
24242 server accepts this, the client and the server negotiate an encryption
24243 mechanism. If the negotiation succeeds, the data that subsequently passes
24244 between them is encrypted.
24245
24246 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
24247 and if so, what cipher suite is in use, whether the client supplied a
24248 certificate, and whether or not that certificate was verified. This makes it
24249 possible for an Exim server to deny or accept certain commands based on the
24250 encryption state.
24251
24252 &*Warning*&: Certain types of firewall and certain anti-virus products can
24253 disrupt TLS connections. You need to turn off SMTP scanning for these products
24254 in order to get TLS to work.
24255
24256
24257
24258 .section "Support for the legacy &""ssmtp""& (aka &""smtps""&) protocol" &&&
24259          "SECID284"
24260 .cindex "ssmtp protocol"
24261 .cindex "smtps protocol"
24262 .cindex "SMTP" "ssmtp protocol"
24263 .cindex "SMTP" "smtps protocol"
24264 Early implementations of encrypted SMTP used a different TCP port from normal
24265 SMTP, and expected an encryption negotiation to start immediately, instead of
24266 waiting for a STARTTLS command from the client using the standard SMTP
24267 port. The protocol was called &"ssmtp"& or &"smtps"&, and port 465 was
24268 allocated for this purpose.
24269
24270 This approach was abandoned when encrypted SMTP was standardized, but there are
24271 still some legacy clients that use it. Exim supports these clients by means of
24272 the &%tls_on_connect_ports%& global option. Its value must be a list of port
24273 numbers; the most common use is expected to be:
24274 .code
24275 tls_on_connect_ports = 465
24276 .endd
24277 The port numbers specified by this option apply to all SMTP connections, both
24278 via the daemon and via &'inetd'&. You still need to specify all the ports that
24279 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
24280 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
24281 an extra port &-- rather, it specifies different behaviour on a port that is
24282 defined elsewhere.
24283
24284 There is also a &%-tls-on-connect%& command line option. This overrides
24285 &%tls_on_connect_ports%&; it forces the legacy behaviour for all ports.
24286
24287
24288
24289
24290
24291
24292 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
24293 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
24294 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
24295 followed later, when the first versions of GnuTLS were released. To build Exim
24296 to use GnuTLS, you need to set
24297 .code
24298 USE_GNUTLS=yes
24299 .endd
24300 in Local/Makefile, in addition to
24301 .code
24302 SUPPORT_TLS=yes
24303 .endd
24304 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
24305 include files and libraries for GnuTLS can be found.
24306
24307 There are some differences in usage when using GnuTLS instead of OpenSSL:
24308
24309 .ilist
24310 The &%tls_verify_certificates%& option must contain the name of a file, not the
24311 name of a directory (for OpenSSL it can be either).
24312 .next
24313 The &%tls_dhparam%& option is ignored, because early versions of GnuTLS had no
24314 facility for varying its Diffie-Hellman parameters. I understand that this has
24315 changed, but Exim has not been updated to provide this facility.
24316 .next
24317 .vindex "&$tls_peerdn$&"
24318 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
24319 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
24320 affects the value of the &$tls_peerdn$& variable.
24321 .next
24322 OpenSSL identifies cipher suites using hyphens as separators, for example:
24323 DES-CBC3-SHA. GnuTLS uses underscores, for example: RSA_ARCFOUR_SHA. What is
24324 more, OpenSSL complains if underscores are present in a cipher list. To make
24325 life simpler, Exim changes underscores to hyphens for OpenSSL and hyphens to
24326 underscores for GnuTLS when processing lists of cipher suites in the
24327 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
24328 option).
24329 .next
24330 The &%tls_require_ciphers%& options operate differently, as described in the
24331 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
24332 .endlist
24333
24334
24335 .section "GnuTLS parameter computation" "SECID181"
24336 GnuTLS uses D-H parameters that may take a substantial amount of time
24337 to compute. It is unreasonable to re-compute them for every TLS session.
24338 Therefore, Exim keeps this data in a file in its spool directory, called
24339 &_gnutls-params_&. The file is owned by the Exim user and is readable only by
24340 its owner. Every Exim process that start up GnuTLS reads the D-H
24341 parameters from this file. If the file does not exist, the first Exim process
24342 that needs it computes the data and writes it to a temporary file which is
24343 renamed once it is complete. It does not matter if several Exim processes do
24344 this simultaneously (apart from wasting a few resources). Once a file is in
24345 place, new Exim processes immediately start using it.
24346
24347 For maximum security, the parameters that are stored in this file should be
24348 recalculated periodically, the frequency depending on your paranoia level.
24349 Arranging this is easy in principle; just delete the file when you want new
24350 values to be computed. However, there may be a problem. The calculation of new
24351 parameters needs random numbers, and these are obtained from &_/dev/random_&.
24352 If the system is not very active, &_/dev/random_& may delay returning data
24353 until enough randomness (entropy) is available. This may cause Exim to hang for
24354 a substantial amount of time, causing timeouts on incoming connections.
24355
24356 The solution is to generate the parameters externally to Exim. They are stored
24357 in &_gnutls-params_& in PEM format, which means that they can be generated
24358 externally using the &(certtool)& command that is part of GnuTLS.
24359
24360 To replace the parameters with new ones, instead of deleting the file
24361 and letting Exim re-create it, you can generate new parameters using
24362 &(certtool)& and, when this has been done, replace Exim's cache file by
24363 renaming. The relevant commands are something like this:
24364 .code
24365 # rm -f new-params
24366 # touch new-params
24367 # chown exim:exim new-params
24368 # chmod 0400 new-params
24369 # certtool --generate-privkey --bits 512 >new-params
24370 # echo "" >>new-params
24371 # certtool --generate-dh-params --bits 1024 >> new-params
24372 # mv new-params gnutls-params
24373 .endd
24374 If Exim never has to generate the parameters itself, the possibility of
24375 stalling is removed.
24376
24377
24378 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
24379 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
24380 .oindex "&%tls_require_ciphers%&" "OpenSSL"
24381 There is a function in the OpenSSL library that can be passed a list of cipher
24382 suites before the cipher negotiation takes place. This specifies which ciphers
24383 are acceptable. The list is colon separated and may contain names like
24384 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
24385 directly to this function call. The following quotation from the OpenSSL
24386 documentation specifies what forms of item are allowed in the cipher string:
24387
24388 .ilist
24389 It can consist of a single cipher suite such as RC4-SHA.
24390 .next
24391 It can represent a list of cipher suites containing a certain algorithm,
24392 or cipher suites of a certain type. For example SHA1 represents all
24393 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
24394 SSL v3 algorithms.
24395 .next
24396 Lists of cipher suites can be combined in a single cipher string using
24397 the + character. This is used as a logical and operation. For example
24398 SHA1+DES represents all cipher suites containing the SHA1 and the DES
24399 algorithms.
24400 .endlist
24401
24402 Each cipher string can be optionally preceded by one of the characters &`!`&,
24403 &`-`& or &`+`&.
24404 .ilist
24405 If &`!`& is used, the ciphers are permanently deleted from the list. The
24406 ciphers deleted can never reappear in the list even if they are explicitly
24407 stated.
24408 .next
24409 If &`-`& is used, the ciphers are deleted from the list, but some or all
24410 of the ciphers can be added again by later options.
24411 .next
24412 If &`+`& is used, the ciphers are moved to the end of the list. This
24413 option does not add any new ciphers; it just moves matching existing ones.
24414 .endlist
24415
24416 If none of these characters is present, the string is interpreted as
24417 a list of ciphers to be appended to the current preference list. If the list
24418 includes any ciphers already present they will be ignored: that is, they will
24419 not be moved to the end of the list.
24420 .endlist
24421
24422
24423
24424 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
24425          "SECTreqciphgnu"
24426 .cindex "GnuTLS" "specifying parameters for"
24427 .cindex "TLS" "specifying ciphers (GnuTLS)"
24428 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
24429 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
24430 .cindex "TLS" "specifying protocols (GnuTLS)"
24431 .oindex "&%tls_require_ciphers%&" "GnuTLS"
24432 The GnuTLS library allows the caller to specify separate lists of permitted key
24433 exchange methods, main cipher algorithms, MAC algorithms, and protocols.
24434 Unfortunately, these lists are numerical, and the library does not have a
24435 function for turning names into numbers. Consequently, lists of recognized
24436 names have to be built into the application. The permitted key exchange
24437 methods, ciphers, and MAC algorithms may be used in any combination to form a
24438 cipher suite. This is unlike OpenSSL, where complete cipher suite names are
24439 passed to its control function.
24440
24441 For compatibility with OpenSSL, the &%tls_require_ciphers%& option can be set
24442 to complete cipher suite names such as RSA_ARCFOUR_SHA, but for GnuTLS this
24443 option controls only the cipher algorithms. Exim searches each item in the
24444 list for the name of an available algorithm. For example, if the list
24445 contains RSA_AES_SHA, then AES is recognized, and the behaviour is exactly
24446 the same as if just AES were given.
24447
24448 .oindex "&%gnutls_require_kx%&"
24449 .oindex "&%gnutls_require_mac%&"
24450 .oindex "&%gnutls_require_protocols%&"
24451 There are additional options called &%gnutls_require_kx%&,
24452 &%gnutls_require_mac%&, and &%gnutls_require_protocols%& that can be used to
24453 restrict the key exchange methods, MAC algorithms, and protocols, respectively.
24454 These options are ignored if OpenSSL is in use.
24455
24456 All four options are available as global options, controlling how Exim
24457 behaves as a server, and also as options of the &(smtp)& transport, controlling
24458 how Exim behaves as a client. All the values are string expanded. After
24459 expansion, the values must be colon-separated lists, though the separator
24460 can be changed in the usual way.
24461
24462 Each of the four lists starts out with a default set of algorithms. If the
24463 first item in a list does &'not'& start with an exclamation mark, all the
24464 default items are deleted. In this case, only those that are explicitly
24465 specified can be used. If the first item in a list &'does'& start with an
24466 exclamation mark, the defaults are left on the list.
24467
24468 Then, any item that starts with an exclamation mark causes the relevant
24469 entry to be removed from the list, and any item that does not start with an
24470 exclamation mark causes a new entry to be added to the list. Unrecognized
24471 items in the list are ignored. Thus:
24472 .code
24473 tls_require_ciphers = !ARCFOUR
24474 .endd
24475 allows all the defaults except ARCFOUR, whereas
24476 .code
24477 tls_require_ciphers = AES : 3DES
24478 .endd
24479 allows only cipher suites that use AES or 3DES.
24480
24481 For &%tls_require_ciphers%& the recognized names are AES_256, AES_128, AES
24482 (both of the preceding), 3DES, ARCFOUR_128, ARCFOUR_40, and ARCFOUR (both of
24483 the preceding). The default list does not contain all of these; it just has
24484 AES_256, AES_128, 3DES, and ARCFOUR_128.
24485
24486 For &%gnutls_require_kx%&, the recognized names are DHE_RSA, RSA (which
24487 includes DHE_RSA), DHE_DSS, and DHE (which includes both DHE_RSA and
24488 DHE_DSS). The default list contains RSA, DHE_DSS, DHE_RSA.
24489
24490 For &%gnutls_require_mac%&, the recognized names are SHA (synonym SHA1), and
24491 MD5. The default list contains SHA, MD5.
24492
24493 For &%gnutls_require_protocols%&, the recognized names are TLS1 and SSL3.
24494 The default list contains TLS1, SSL3.
24495
24496 In a server, the order of items in these lists is unimportant. The server
24497 advertises the availability of all the relevant cipher suites. However, in a
24498 client, the order in the &%tls_require_ciphers%& list specifies a preference
24499 order for the cipher algorithms. The first one in the client's list that is
24500 also advertised by the server is tried first. The default order is as listed
24501 above.
24502
24503
24504
24505 .section "Configuring an Exim server to use TLS" "SECID182"
24506 .cindex "TLS" "configuring an Exim server"
24507 When Exim has been built with TLS support, it advertises the availability of
24508 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
24509 but not to any others. The default value of this option is unset, which means
24510 that STARTTLS is not advertised at all. This default is chosen because you
24511 need to set some other options in order to make TLS available, and also it is
24512 sensible for systems that want to use TLS only as a client.
24513
24514 If a client issues a STARTTLS command and there is some configuration
24515 problem in the server, the command is rejected with a 454 error. If the client
24516 persists in trying to issue SMTP commands, all except QUIT are rejected
24517 with the error
24518 .code
24519 554 Security failure
24520 .endd
24521 If a STARTTLS command is issued within an existing TLS session, it is
24522 rejected with a 554 error code.
24523
24524 To enable TLS operations on a server, you must set &%tls_advertise_hosts%& to
24525 match some hosts. You can, of course, set it to * to match all hosts.
24526 However, this is not all you need to do. TLS sessions to a server won't work
24527 without some further configuration at the server end.
24528
24529 It is rumoured that all existing clients that support TLS/SSL use RSA
24530 encryption. To make this work you need to set, in the server,
24531 .code
24532 tls_certificate = /some/file/name
24533 tls_privatekey = /some/file/name
24534 .endd
24535 These options are, in fact, expanded strings, so you can make them depend on
24536 the identity of the client that is connected if you wish. The first file
24537 contains the server's X509 certificate, and the second contains the private key
24538 that goes with it. These files need to be readable by the Exim user, and must
24539 always be given as full path names. They can be the same file if both the
24540 certificate and the key are contained within it. If &%tls_privatekey%& is not
24541 set, or if its expansion is forced to fail or results in an empty string, this
24542 is assumed to be the case. The certificate file may also contain intermediate
24543 certificates that need to be sent to the client to enable it to authenticate
24544 the server's certificate.
24545
24546 If you do not understand about certificates and keys, please try to find a
24547 source of this background information, which is not Exim-specific. (There are a
24548 few comments below in section &<<SECTcerandall>>&.)
24549
24550 &*Note*&: These options do not apply when Exim is operating as a client &--
24551 they apply only in the case of a server. If you need to use a certificate in an
24552 Exim client, you must set the options of the same names in an &(smtp)&
24553 transport.
24554
24555 With just these options, an Exim server will be able to use TLS. It does not
24556 require the client to have a certificate (but see below for how to insist on
24557 this). There is one other option that may be needed in other situations. If
24558 .code
24559 tls_dhparam = /some/file/name
24560 .endd
24561 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
24562 with the parameters contained in the file. This increases the set of cipher
24563 suites that the server supports. See the command
24564 .code
24565 openssl dhparam
24566 .endd
24567 for a way of generating this data. At present, &%tls_dhparam%& is used only
24568 when Exim is linked with OpenSSL. It is ignored if GnuTLS is being used.
24569
24570 The strings supplied for these three options are expanded every time a client
24571 host connects. It is therefore possible to use different certificates and keys
24572 for different hosts, if you so wish, by making use of the client's IP address
24573 in &$sender_host_address$& to control the expansion. If a string expansion is
24574 forced to fail, Exim behaves as if the option is not set.
24575
24576 .cindex "cipher" "logging"
24577 .cindex "log" "TLS cipher"
24578 .vindex "&$tls_cipher$&"
24579 The variable &$tls_cipher$& is set to the cipher suite that was negotiated for
24580 an incoming TLS connection. It is included in the &'Received:'& header of an
24581 incoming message (by default &-- you can, of course, change this), and it is
24582 also included in the log line that records a message's arrival, keyed by
24583 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
24584 condition can be used to test for specific cipher suites in ACLs.
24585 (For outgoing SMTP deliveries, &$tls_cipher$& is reset &-- see section
24586 &<<SECID185>>&.)
24587
24588 Once TLS has been established, the ACLs that run for subsequent SMTP commands
24589 can check the name of the cipher suite and vary their actions accordingly. The
24590 cipher suite names vary, depending on which TLS library is being used. For
24591 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
24592 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
24593 documentation for more details.
24594
24595
24596 .section "Requesting and verifying client certificates" "SECID183"
24597 .cindex "certificate" "verification of client"
24598 .cindex "TLS" "client certificate verification"
24599 If you want an Exim server to request a certificate when negotiating a TLS
24600 session with a client, you must set either &%tls_verify_hosts%& or
24601 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
24602 apply to all TLS connections. For any host that matches one of these options,
24603 Exim requests a certificate as part of the setup of the TLS session. The
24604 contents of the certificate are verified by comparing it with a list of
24605 expected certificates. These must be available in a file or,
24606 for OpenSSL only (not GnuTLS), a directory, identified by
24607 &%tls_verify_certificates%&.
24608
24609 A file can contain multiple certificates, concatenated end to end. If a
24610 directory is used
24611 (OpenSSL only),
24612 each certificate must be in a separate file, with a name (or a symbolic link)
24613 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
24614 certificate. You can compute the relevant hash by running the command
24615 .code
24616 openssl x509 -hash -noout -in /cert/file
24617 .endd
24618 where &_/cert/file_& contains a single certificate.
24619
24620 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
24621 what happens if the client does not supply a certificate, or if the certificate
24622 does not match any of the certificates in the collection named by
24623 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
24624 attempt to set up a TLS session is aborted, and the incoming connection is
24625 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
24626 session continues. ACLs that run for subsequent SMTP commands can detect the
24627 fact that no certificate was verified, and vary their actions accordingly. For
24628 example, you can insist on a certificate before accepting a message for
24629 relaying, but not when the message is destined for local delivery.
24630
24631 .vindex "&$tls_peerdn$&"
24632 When a client supplies a certificate (whether it verifies or not), the value of
24633 the Distinguished Name of the certificate is made available in the variable
24634 &$tls_peerdn$& during subsequent processing of the message.
24635
24636 .cindex "log" "distinguished name"
24637 Because it is often a long text string, it is not included in the log line or
24638 &'Received:'& header by default. You can arrange for it to be logged, keyed by
24639 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
24640 &%received_header_text%& to change the &'Received:'& header. When no
24641 certificate is supplied, &$tls_peerdn$& is empty.
24642
24643
24644 .section "Revoked certificates" "SECID184"
24645 .cindex "TLS" "revoked certificates"
24646 .cindex "revocation list"
24647 .cindex "certificate" "revocation list"
24648 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
24649 certificates are revoked. If you have such a list, you can pass it to an Exim
24650 server using the global option called &%tls_crl%& and to an Exim client using
24651 an identically named option for the &(smtp)& transport. In each case, the value
24652 of the option is expanded and must then be the name of a file that contains a
24653 CRL in PEM format.
24654
24655
24656 .section "Configuring an Exim client to use TLS" "SECID185"
24657 .cindex "cipher" "logging"
24658 .cindex "log" "TLS cipher"
24659 .cindex "log" "distinguished name"
24660 .cindex "TLS" "configuring an Exim client"
24661 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
24662 deliveries as well as to incoming, the latter one causing logging of the
24663 server certificate's DN. The remaining client configuration for TLS is all
24664 within the &(smtp)& transport.
24665
24666 It is not necessary to set any options to have TLS work in the &(smtp)&
24667 transport. If Exim is built with TLS support, and TLS is advertised by a
24668 server, the &(smtp)& transport always tries to start a TLS session. However,
24669 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
24670 transport) to a list of server hosts for which TLS should not be used.
24671
24672 If you do not want Exim to attempt to send messages unencrypted when an attempt
24673 to set up an encrypted connection fails in any way, you can set
24674 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
24675 those hosts, delivery is always deferred if an encrypted connection cannot be
24676 set up. If there are any other hosts for the address, they are tried in the
24677 usual way.
24678
24679 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
24680 the message unencrypted. It always does this if the response to STARTTLS is
24681 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
24682 session after a success response code, what happens is controlled by the
24683 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
24684 delivery to this host is deferred, and other hosts (if available) are tried. If
24685 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
24686 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
24687 negotiation fails, Exim closes the current connection (because it is in an
24688 unknown state), opens a new one to the same host, and then tries the delivery
24689 unencrypted.
24690
24691 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
24692 transport provide the client with a certificate, which is passed to the server
24693 if it requests it. If the server is Exim, it will request a certificate only if
24694 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
24695
24696 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
24697 must name a file or,
24698 for OpenSSL only (not GnuTLS), a directory, that contains a collection of
24699 expected server certificates. The client verifies the server's certificate
24700 against this collection, taking into account any revoked certificates that are
24701 in the list defined by &%tls_crl%&.
24702
24703 If
24704 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
24705 list of permitted cipher suites. If either of these checks fails, delivery to
24706 the current host is abandoned, and the &(smtp)& transport tries to deliver to
24707 alternative hosts, if any.
24708
24709  &*Note*&:
24710 These options must be set in the &(smtp)& transport for Exim to use TLS when it
24711 is operating as a client. Exim does not assume that a server certificate (set
24712 by the global options of the same name) should also be used when operating as a
24713 client.
24714
24715 .vindex "&$host$&"
24716 .vindex "&$host_address$&"
24717 All the TLS options in the &(smtp)& transport are expanded before use, with
24718 &$host$& and &$host_address$& containing the name and address of the server to
24719 which the client is connected. Forced failure of an expansion causes Exim to
24720 behave as if the relevant option were unset.
24721
24722 .vindex &$tls_cipher$&
24723 .vindex &$tls_peerdn$&
24724 Before an SMTP connection is established, the &$tls_cipher$& and &$tls_peerdn$&
24725 variables are emptied. (Until the first connection, they contain the values
24726 that were set when the message was received.) If STARTTLS is subsequently
24727 successfully obeyed, these variables are set to the relevant values for the
24728 outgoing connection.
24729
24730
24731
24732 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
24733          "SECTmulmessam"
24734 .cindex "multiple SMTP deliveries with TLS"
24735 .cindex "TLS" "multiple message deliveries"
24736 Exim sends multiple messages down the same TCP/IP connection by starting up
24737 an entirely new delivery process for each message, passing the socket from
24738 one process to the next. This implementation does not fit well with the use
24739 of TLS, because there is quite a lot of state information associated with a TLS
24740 connection, not just a socket identification. Passing all the state information
24741 to a new process is not feasible. Consequently, Exim shuts down an existing TLS
24742 session before passing the socket to a new process. The new process may then
24743 try to start a new TLS session, and if successful, may try to re-authenticate
24744 if AUTH is in use, before sending the next message.
24745
24746 The RFC is not clear as to whether or not an SMTP session continues in clear
24747 after TLS has been shut down, or whether TLS may be restarted again later, as
24748 just described. However, if the server is Exim, this shutdown and
24749 reinitialization works. It is not known which (if any) other servers operate
24750 successfully if the client closes a TLS session and continues with unencrypted
24751 SMTP, but there are certainly some that do not work. For such servers, Exim
24752 should not pass the socket to another process, because the failure of the
24753 subsequent attempt to use it would cause Exim to record a temporary host error,
24754 and delay other deliveries to that host.
24755
24756 To test for this case, Exim sends an EHLO command to the server after
24757 closing down the TLS session. If this fails in any way, the connection is
24758 closed instead of being passed to a new delivery process, but no retry
24759 information is recorded.
24760
24761 There is also a manual override; you can set &%hosts_nopass_tls%& on the
24762 &(smtp)& transport to match those hosts for which Exim should not pass
24763 connections to new processes if TLS has been used.
24764
24765
24766
24767
24768 .section "Certificates and all that" "SECTcerandall"
24769 .cindex "certificate" "references to discussion"
24770 In order to understand fully how TLS works, you need to know about
24771 certificates, certificate signing, and certificate authorities. This is not the
24772 place to give a tutorial, especially as I do not know very much about it
24773 myself. Some helpful introduction can be found in the FAQ for the SSL addition
24774 to Apache, currently at
24775 .display
24776 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
24777 .endd
24778 Other parts of the &'modssl'& documentation are also helpful, and have
24779 links to further files.
24780 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
24781 0-201-61598-3), contains both introductory and more in-depth descriptions.
24782 Some sample programs taken from the book are available from
24783 .display
24784 &url(http://www.rtfm.com/openssl-examples/)
24785 .endd
24786
24787
24788 .section "Certificate chains" "SECID186"
24789 The file named by &%tls_certificate%& may contain more than one
24790 certificate. This is useful in the case where the certificate that is being
24791 sent is validated by an intermediate certificate which the other end does
24792 not have. Multiple certificates must be in the correct order in the file.
24793 First the host's certificate itself, then the first intermediate
24794 certificate to validate the issuer of the host certificate, then the next
24795 intermediate certificate to validate the issuer of the first intermediate
24796 certificate, and so on, until finally (optionally) the root certificate.
24797 The root certificate must already be trusted by the recipient for
24798 validation to succeed, of course, but if it's not preinstalled, sending the
24799 root certificate along with the rest makes it available for the user to
24800 install if the receiving end is a client MUA that can interact with a user.
24801
24802
24803 .section "Self-signed certificates" "SECID187"
24804 .cindex "certificate" "self-signed"
24805 You can create a self-signed certificate using the &'req'& command provided
24806 with OpenSSL, like this:
24807 .code
24808 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
24809             -days 9999 -nodes
24810 .endd
24811 &_file1_& and &_file2_& can be the same file; the key and the certificate are
24812 delimited and so can be identified independently. The &%-days%& option
24813 specifies a period for which the certificate is valid. The &%-nodes%& option is
24814 important: if you do not set it, the key is encrypted with a passphrase
24815 that you are prompted for, and any use that is made of the key causes more
24816 prompting for the passphrase. This is not helpful if you are going to use
24817 this certificate and key in an MTA, where prompting is not possible.
24818
24819 A self-signed certificate made in this way is sufficient for testing, and
24820 may be adequate for all your requirements if you are mainly interested in
24821 encrypting transfers, and not in secure identification.
24822
24823 However, many clients require that the certificate presented by the server be a
24824 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
24825 certificate. In this situation, the self-signed certificate described above
24826 must be installed on the client host as a trusted root &'certification
24827 authority'& (CA), and the certificate used by Exim must be a user certificate
24828 signed with that self-signed certificate.
24829
24830 For information on creating self-signed CA certificates and using them to sign
24831 user certificates, see the &'General implementation overview'& chapter of the
24832 Open-source PKI book, available online at
24833 &url(http://ospkibook.sourceforge.net/).
24834 .ecindex IIDencsmtp1
24835 .ecindex IIDencsmtp2
24836
24837
24838
24839 . ////////////////////////////////////////////////////////////////////////////
24840 . ////////////////////////////////////////////////////////////////////////////
24841
24842 .chapter "Access control lists" "CHAPACL"
24843 .scindex IIDacl "&ACL;" "description"
24844 .cindex "control of incoming mail"
24845 .cindex "message" "controlling incoming"
24846 .cindex "policy control" "access control lists"
24847 Access Control Lists (ACLs) are defined in a separate section of the run time
24848 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
24849 name, terminated by a colon. Here is a complete ACL section that contains just
24850 one very small ACL:
24851 .code
24852 begin acl
24853 small_acl:
24854   accept   hosts = one.host.only
24855 .endd
24856 You can have as many lists as you like in the ACL section, and the order in
24857 which they appear does not matter. The lists are self-terminating.
24858
24859 The majority of ACLs are used to control Exim's behaviour when it receives
24860 certain SMTP commands. This applies both to incoming TCP/IP connections, and
24861 when a local process submits a message using SMTP by specifying the &%-bs%&
24862 option. The most common use is for controlling which recipients are accepted
24863 in incoming messages. In addition, you can define an ACL that is used to check
24864 local non-SMTP messages. The default configuration file contains an example of
24865 a realistic ACL for checking RCPT commands. This is discussed in chapter
24866 &<<CHAPdefconfil>>&.
24867
24868
24869 .section "Testing ACLs" "SECID188"
24870 The &%-bh%& command line option provides a way of testing your ACL
24871 configuration locally by running a fake SMTP session with which you interact.
24872 The host &'relay-test.mail-abuse.org'& provides a service for checking your
24873 relaying configuration (see section &<<SECTcheralcon>>& for more details).
24874
24875
24876
24877 .section "Specifying when ACLs are used" "SECID189"
24878 .cindex "&ACL;" "options for specifying"
24879 In order to cause an ACL to be used, you have to name it in one of the relevant
24880 options in the main part of the configuration. These options are:
24881 .cindex "AUTH" "ACL for"
24882 .cindex "DATA" "ACLs for"
24883 .cindex "ETRN" "ACL for"
24884 .cindex "EXPN" "ACL for"
24885 .cindex "HELO" "ACL for"
24886 .cindex "EHLO" "ACL for"
24887 .cindex "MAIL" "ACL for"
24888 .cindex "QUIT, ACL for"
24889 .cindex "RCPT" "ACL for"
24890 .cindex "STARTTLS, ACL for"
24891 .cindex "VRFY" "ACL for"
24892 .cindex "SMTP" "connection, ACL for"
24893 .cindex "non-SMTP messages" "ACLs for"
24894 .cindex "MIME content scanning" "ACL for"
24895
24896 .table2 140pt
24897 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
24898 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
24899 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
24900 .irow &%acl_smtp_auth%&        "ACL for AUTH"
24901 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
24902 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
24903 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
24904 .irow &%acl_smtp_expn%&        "ACL for EXPN"
24905 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
24906 .irow &%acl_smtp_mail%&        "ACL for MAIL"
24907 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
24908 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
24909 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
24910 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
24911 .irow &%acl_smtp_quit%&        "ACL for QUIT"
24912 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
24913 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
24914 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
24915 .endtable
24916
24917 For example, if you set
24918 .code
24919 acl_smtp_rcpt = small_acl
24920 .endd
24921 the little ACL defined above is used whenever Exim receives a RCPT command
24922 in an SMTP dialogue. The majority of policy tests on incoming messages can be
24923 done when RCPT commands arrive. A rejection of RCPT should cause the
24924 sending MTA to give up on the recipient address contained in the RCPT
24925 command, whereas rejection at other times may cause the client MTA to keep on
24926 trying to deliver the message. It is therefore recommended that you do as much
24927 testing as possible at RCPT time.
24928
24929
24930 .section "The non-SMTP ACLs" "SECID190"
24931 .cindex "non-SMTP messages" "ACLs for"
24932 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
24933 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
24934 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
24935 the state of the SMTP connection such as encryption and authentication) are not
24936 relevant and are forbidden in these ACLs. However, the sender and recipients
24937 are known, so the &%senders%& and &%sender_domains%& conditions and the
24938 &$sender_address$& and &$recipients$& variables can be used. Variables such as
24939 &$authenticated_sender$& are also available. You can specify added header lines
24940 in any of these ACLs.
24941
24942 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
24943 non-SMTP message, before any of the message has been read. (This is the
24944 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
24945 batched SMTP input, it runs after the DATA command has been reached. The
24946 result of this ACL is ignored; it cannot be used to reject a message. If you
24947 really need to, you could set a value in an ACL variable here and reject based
24948 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
24949 controls, and in particular, it can be used to set
24950 .code
24951 control = suppress_local_fixups
24952 .endd
24953 This cannot be used in the other non-SMTP ACLs because by the time they are
24954 run, it is too late.
24955
24956 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
24957 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
24958
24959 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
24960 kind of rejection is treated as permanent, because there is no way of sending a
24961 temporary error for these kinds of message.
24962
24963
24964 .section "The SMTP connect ACL" "SECID191"
24965 .cindex "SMTP" "connection, ACL for"
24966 .oindex &%smtp_banner%&
24967 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
24968 session, after the test specified by &%host_reject_connection%& (which is now
24969 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
24970 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
24971 the message override the banner message that is otherwise specified by the
24972 &%smtp_banner%& option.
24973
24974
24975 .section "The EHLO/HELO ACL" "SECID192"
24976 .cindex "EHLO" "ACL for"
24977 .cindex "HELO" "ACL for"
24978 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
24979 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
24980 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
24981 Note that a client may issue more than one EHLO or HELO command in an SMTP
24982 session, and indeed is required to issue a new EHLO or HELO after successfully
24983 setting up encryption following a STARTTLS command.
24984
24985 If the command is accepted by an &%accept%& verb that has a &%message%&
24986 modifier, the message may not contain more than one line (it will be truncated
24987 at the first newline and a panic logged if it does). Such a message cannot
24988 affect the EHLO options that are listed on the second and subsequent lines of
24989 an EHLO response.
24990
24991
24992 .section "The DATA ACLs" "SECID193"
24993 .cindex "DATA" "ACLs for"
24994 Two ACLs are associated with the DATA command, because it is two-stage
24995 command, with two responses being sent to the client.
24996 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
24997 is obeyed. This gives you control after all the RCPT commands, but before
24998 the message itself is received. It offers the opportunity to give a negative
24999 response to the DATA command before the data is transmitted. Header lines
25000 added by MAIL or RCPT ACLs are not visible at this time, but any that
25001 are defined here are visible when the &%acl_smtp_data%& ACL is run.
25002
25003 You cannot test the contents of the message, for example, to verify addresses
25004 in the headers, at RCPT time or when the DATA command is received. Such
25005 tests have to appear in the ACL that is run after the message itself has been
25006 received, before the final response to the DATA command is sent. This is
25007 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
25008 associated with the DATA command.
25009
25010 For both of these ACLs, it is not possible to reject individual recipients. An
25011 error response rejects the entire message. Unfortunately, it is known that some
25012 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
25013 before or after the data) correctly &-- they keep the message on their queues
25014 and try again later, but that is their problem, though it does waste some of
25015 your resources.
25016
25017
25018 .new
25019 .section "The SMTP DKIM ACL" "SECTDKIMACL"
25020 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
25021 enabled (which is the default).
25022
25023 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
25024 received, and is executed for each DKIM signature found in a message.  If not
25025 otherwise specified, the default action is to accept.
25026
25027 For details on the operation of DKIM, see chapter &<<CHID12>>&.
25028 .wen
25029
25030
25031 .section "The SMTP MIME ACL" "SECID194"
25032 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
25033 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
25034
25035
25036 .section "The QUIT ACL" "SECTQUITACL"
25037 .cindex "QUIT, ACL for"
25038 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
25039 does not affect the response code to QUIT, which is always 221. Thus, the ACL
25040 does not in fact control any access. For this reason, the only verbs that are
25041 permitted are &%accept%& and &%warn%&.
25042
25043 This ACL can be used for tasks such as custom logging at the end of an SMTP
25044 session. For example, you can use ACL variables in other ACLs to count
25045 messages, recipients, etc., and log the totals at QUIT time using one or
25046 more &%logwrite%& modifiers on a &%warn%& verb.
25047
25048 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
25049 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
25050
25051 You do not need to have a final &%accept%&, but if you do, you can use a
25052 &%message%& modifier to specify custom text that is sent as part of the 221
25053 response to QUIT.
25054
25055 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
25056 failure (for example, failure to open a log file, or when Exim is bombing out
25057 because it has detected an unrecoverable error), all SMTP commands from the
25058 client are given temporary error responses until QUIT is received or the
25059 connection is closed. In these special cases, the QUIT ACL does not run.
25060
25061
25062 .section "The not-QUIT ACL" "SECTNOTQUITACL"
25063 .vindex &$acl_smtp_notquit$&
25064 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
25065 an SMTP session ends without sending QUIT. However, when Exim itself is is bad
25066 trouble, such as being unable to write to its log files, this ACL is not run,
25067 because it might try to do things (such as write to log files) that make the
25068 situation even worse.
25069
25070 Like the QUIT ACL, this ACL is provided to make it possible to do customized
25071 logging or to gather statistics, and its outcome is ignored. The &%delay%&
25072 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
25073 and &%warn%&.
25074
25075 .vindex &$smtp_notquit_reason$&
25076 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
25077 to a string that indicates the reason for the termination of the SMTP
25078 connection. The possible values are:
25079 .table2
25080 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
25081 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
25082 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
25083 .irow &`connection-lost`&          "The SMTP connection has been lost"
25084 .irow &`data-timeout`&             "Timeout while reading message data"
25085 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
25086 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
25087 .irow &`signal-exit`&              "SIGTERM or SIGINT"
25088 .irow &`synchronization-error`&    "SMTP synchronization error"
25089 .irow &`tls-failed`&               "TLS failed to start"
25090 .endtable
25091 In most cases when an SMTP connection is closed without having received QUIT,
25092 Exim sends an SMTP response message before actually closing the connection.
25093 With the exception of the &`acl-drop`& case, the default message can be
25094 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
25095 &%drop%& verb in another ACL, it is the message from the other ACL that is
25096 used.
25097
25098
25099 .section "Finding an ACL to use" "SECID195"
25100 .cindex "&ACL;" "finding which to use"
25101 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
25102 you can use different ACLs in different circumstances. For example,
25103 .code
25104 acl_smtp_rcpt = ${if ={25}{$interface_port} \
25105                      {acl_check_rcpt} {acl_check_rcpt_submit} }
25106 .endd
25107 In the default configuration file there are some example settings for
25108 providing an RFC 4409 message submission service on port 587 and a
25109 non-standard &"smtps"& service on port 465. You can use a string
25110 expansion like this to choose an ACL for MUAs on these ports which is
25111 more appropriate for this purpose than the default ACL on port 25.
25112
25113 The expanded string does not have to be the name of an ACL in the
25114 configuration file; there are other possibilities. Having expanded the
25115 string, Exim searches for an ACL as follows:
25116
25117 .ilist
25118 If the string begins with a slash, Exim uses it as a file name, and reads its
25119 contents as an ACL. The lines are processed in the same way as lines in the
25120 Exim configuration file. In particular, continuation lines are supported, blank
25121 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
25122 If the file does not exist or cannot be read, an error occurs (typically
25123 causing a temporary failure of whatever caused the ACL to be run). For example:
25124 .code
25125 acl_smtp_data = /etc/acls/\
25126   ${lookup{$sender_host_address}lsearch\
25127   {/etc/acllist}{$value}{default}}
25128 .endd
25129 This looks up an ACL file to use on the basis of the host's IP address, falling
25130 back to a default if the lookup fails. If an ACL is successfully read from a
25131 file, it is retained in memory for the duration of the Exim process, so that it
25132 can be re-used without having to re-read the file.
25133 .next
25134 If the string does not start with a slash, and does not contain any spaces,
25135 Exim searches the ACL section of the configuration for an ACL whose name
25136 matches the string.
25137 .next
25138 If no named ACL is found, or if the string contains spaces, Exim parses
25139 the string as an inline ACL. This can save typing in cases where you just
25140 want to have something like
25141 .code
25142 acl_smtp_vrfy = accept
25143 .endd
25144 in order to allow free use of the VRFY command. Such a string may contain
25145 newlines; it is processed in the same way as an ACL that is read from a file.
25146 .endlist
25147
25148
25149
25150
25151 .section "ACL return codes" "SECID196"
25152 .cindex "&ACL;" "return codes"
25153 Except for the QUIT ACL, which does not affect the SMTP return code (see
25154 section &<<SECTQUITACL>>& above), the result of running an ACL is either
25155 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
25156 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
25157 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
25158 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
25159 This also causes a 4&'xx'& return code.
25160
25161 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
25162 &"deny"&, because there is no mechanism for passing temporary errors to the
25163 submitters of non-SMTP messages.
25164
25165
25166 ACLs that are relevant to message reception may also return &"discard"&. This
25167 has the effect of &"accept"&, but causes either the entire message or an
25168 individual recipient address to be discarded. In other words, it is a
25169 blackholing facility. Use it with care.
25170
25171 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
25172 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
25173 RCPT ACL is to discard just the one recipient address. If there are no
25174 recipients left when the message's data is received, the DATA ACL is not
25175 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
25176 remaining recipients. The &"discard"& return is not permitted for the
25177 &%acl_smtp_predata%& ACL.
25178
25179
25180 .cindex "&[local_scan()]& function" "when all recipients discarded"
25181 The &[local_scan()]& function is always run, even if there are no remaining
25182 recipients; it may create new recipients.
25183
25184
25185
25186 .section "Unset ACL options" "SECID197"
25187 .cindex "&ACL;" "unset options"
25188 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
25189 all the same. &*Note*&: These defaults apply only when the relevant ACL is
25190 not defined at all. For any defined ACL, the default action when control
25191 reaches the end of the ACL statements is &"deny"&.
25192
25193 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
25194 these two are ACLs that are used only for their side effects. They cannot be
25195 used to accept or reject anything.
25196
25197 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
25198 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
25199 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
25200 when the ACL is not defined is &"accept"&.
25201
25202 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
25203 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
25204 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
25205 messages over an SMTP connection. For an example, see the ACL in the default
25206 configuration file.
25207
25208
25209
25210
25211 .section "Data for message ACLs" "SECID198"
25212 .cindex "&ACL;" "data for message ACL"
25213 .vindex &$domain$&
25214 .vindex &$local_part$&
25215 .vindex &$sender_address$&
25216 .vindex &$sender_host_address$&
25217 .vindex &$smtp_command$&
25218 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
25219 that contain information about the host and the message's sender (for example,
25220 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
25221 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
25222 &$local_part$& are set from the argument address. The entire SMTP command
25223 is available in &$smtp_command$&.
25224
25225 When an ACL for the AUTH parameter of MAIL is running, the variables that
25226 contain information about the host are set, but &$sender_address$& is not yet
25227 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
25228 how it is used.
25229
25230 .vindex "&$message_size$&"
25231 The &$message_size$& variable is set to the value of the SIZE parameter on
25232 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
25233 that parameter is not given. The value is updated to the true message size by
25234 the time the final DATA ACL is run (after the message data has been
25235 received).
25236
25237 .vindex "&$rcpt_count$&"
25238 .vindex "&$recipients_count$&"
25239 The &$rcpt_count$& variable increases by one for each RCPT command received.
25240 The &$recipients_count$& variable increases by one each time a RCPT command is
25241 accepted, so while an ACL for RCPT is being processed, it contains the number
25242 of previously accepted recipients. At DATA time (for both the DATA ACLs),
25243 &$rcpt_count$& contains the total number of RCPT commands, and
25244 &$recipients_count$& contains the total number of accepted recipients.
25245
25246
25247
25248
25249
25250 .section "Data for non-message ACLs" "SECTdatfornon"
25251 .cindex "&ACL;" "data for non-message ACL"
25252 .vindex &$smtp_command_argument$&
25253 .vindex &$smtp_command$&
25254 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
25255 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
25256 and the entire SMTP command is available in &$smtp_command$&.
25257 These variables can be tested using a &%condition%& condition. For example,
25258 here is an ACL for use with AUTH, which insists that either the session is
25259 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
25260 does not permit authentication methods that use cleartext passwords on
25261 unencrypted connections.
25262 .code
25263 acl_check_auth:
25264   accept encrypted = *
25265   accept condition = ${if eq{${uc:$smtp_command_argument}}\
25266                      {CRAM-MD5}}
25267   deny   message   = TLS encryption or CRAM-MD5 required
25268 .endd
25269 (Another way of applying this restriction is to arrange for the authenticators
25270 that use cleartext passwords not to be advertised when the connection is not
25271 encrypted. You can use the generic &%server_advertise_condition%& authenticator
25272 option to do this.)
25273
25274
25275
25276 .section "Format of an ACL" "SECID199"
25277 .cindex "&ACL;" "format of"
25278 .cindex "&ACL;" "verbs, definition of"
25279 An individual ACL consists of a number of statements. Each statement starts
25280 with a verb, optionally followed by a number of conditions and &"modifiers"&.
25281 Modifiers can change the way the verb operates, define error and log messages,
25282 set variables, insert delays, and vary the processing of accepted messages.
25283
25284 If all the conditions are met, the verb is obeyed. The same condition may be
25285 used (with different arguments) more than once in the same statement. This
25286 provides a means of specifying an &"and"& conjunction between conditions. For
25287 example:
25288 .code
25289 deny  dnslists = list1.example
25290 dnslists = list2.example
25291 .endd
25292 If there are no conditions, the verb is always obeyed. Exim stops evaluating
25293 the conditions and modifiers when it reaches a condition that fails. What
25294 happens then depends on the verb (and in one case, on a special modifier). Not
25295 all the conditions make sense at every testing point. For example, you cannot
25296 test a sender address in the ACL that is run for a VRFY command.
25297
25298
25299 .section "ACL verbs" "SECID200"
25300 The ACL verbs are as follows:
25301
25302 .ilist
25303 .cindex "&%accept%& ACL verb"
25304 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
25305 of the conditions are not met, what happens depends on whether &%endpass%&
25306 appears among the conditions (for syntax see below). If the failing condition
25307 is before &%endpass%&, control is passed to the next ACL statement; if it is
25308 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
25309 check a RCPT command:
25310 .code
25311 accept domains = +local_domains
25312 endpass
25313 verify = recipient
25314 .endd
25315 If the recipient domain does not match the &%domains%& condition, control
25316 passes to the next statement. If it does match, the recipient is verified, and
25317 the command is accepted if verification succeeds. However, if verification
25318 fails, the ACL yields &"deny"&, because the failing condition is after
25319 &%endpass%&.
25320
25321 The &%endpass%& feature has turned out to be confusing to many people, so its
25322 use is not recommended nowadays. It is always possible to rewrite an ACL so
25323 that &%endpass%& is not needed, and it is no longer used in the default
25324 configuration.
25325
25326 .cindex "&%message%& ACL modifier" "with &%accept%&"
25327 If a &%message%& modifier appears on an &%accept%& statement, its action
25328 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
25329 (when an &%accept%& verb either accepts or passes control to the next
25330 statement), &%message%& can be used to vary the message that is sent when an
25331 SMTP command is accepted. For example, in a RCPT ACL you could have:
25332 .display
25333 &`accept  `&<&'some conditions'&>
25334 &`        message = OK, I will allow you through today`&
25335 .endd
25336 You can specify an SMTP response code, optionally followed by an &"extended
25337 response code"& at the start of the message, but the first digit must be the
25338 same as would be sent by default, which is 2 for an &%accept%& verb.
25339
25340 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
25341 an error message that is used when access is denied. This behaviour is retained
25342 for backward compatibility, but current &"best practice"& is to avoid the use
25343 of &%endpass%&.
25344
25345
25346 .next
25347 .cindex "&%defer%& ACL verb"
25348 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
25349 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
25350 &%defer%& is the same as &%deny%&, because there is no way of sending a
25351 temporary error. For a RCPT command, &%defer%& is much the same as using a
25352 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
25353 be used in any ACL, and even for a recipient it might be a simpler approach.
25354
25355
25356 .next
25357 .cindex "&%deny%& ACL verb"
25358 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
25359 the conditions are not met, control is passed to the next ACL statement. For
25360 example,
25361 .code
25362 deny dnslists = blackholes.mail-abuse.org
25363 .endd
25364 rejects commands from hosts that are on a DNS black list.
25365
25366
25367 .next
25368 .cindex "&%discard%& ACL verb"
25369 &%discard%&: This verb behaves like &%accept%&, except that it returns
25370 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
25371 that are concerned with receiving messages. When all the conditions are true,
25372 the sending entity receives a &"success"& response. However, &%discard%& causes
25373 recipients to be discarded. If it is used in an ACL for RCPT, just the one
25374 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
25375 message's recipients are discarded. Recipients that are discarded before DATA
25376 do not appear in the log line when the &%received_recipients%& log selector is set.
25377
25378 If the &%log_message%& modifier is set when &%discard%& operates,
25379 its contents are added to the line that is automatically written to the log.
25380 The &%message%& modifier operates exactly as it does for &%accept%&.
25381
25382
25383 .next
25384 .cindex "&%drop%& ACL verb"
25385 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
25386 forcibly closed after the 5&'xx'& error message has been sent. For example:
25387 .code
25388 drop   message   = I don't take more than 20 RCPTs
25389        condition = ${if > {$rcpt_count}{20}}
25390 .endd
25391 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
25392 The connection is always dropped after sending a 550 response.
25393
25394 .next
25395 .cindex "&%require%& ACL verb"
25396 &%require%&: If all the conditions are met, control is passed to the next ACL
25397 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
25398 example, when checking a RCPT command,
25399 .code
25400 require message = Sender did not verify
25401         verify  = sender
25402 .endd
25403 passes control to subsequent statements only if the message's sender can be
25404 verified. Otherwise, it rejects the command. Note the positioning of the
25405 &%message%& modifier, before the &%verify%& condition. The reason for this is
25406 discussed in section &<<SECTcondmodproc>>&.
25407
25408 .next
25409 .cindex "&%warn%& ACL verb"
25410 &%warn%&: If all the conditions are true, a line specified by the
25411 &%log_message%& modifier is written to Exim's main log. Control always passes
25412 to the next ACL statement. If any condition is false, the log line is not
25413 written. If an identical log line is requested several times in the same
25414 message, only one copy is actually written to the log. If you want to force
25415 duplicates to be written, use the &%logwrite%& modifier instead.
25416
25417 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
25418 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
25419 &%logwrite%&, and &%add_header%&) that appear before the first failing
25420 condition. There is more about adding header lines in section
25421 &<<SECTaddheadacl>>&.
25422
25423 If any condition on a &%warn%& statement cannot be completed (that is, there is
25424 some sort of defer), the log line specified by &%log_message%& is not written.
25425 This does not include the case of a forced failure from a lookup, which
25426 is considered to be a successful completion. After a defer, no further
25427 conditions or modifiers in the &%warn%& statement are processed. The incident
25428 is logged, and the ACL continues to be processed, from the next statement
25429 onwards.
25430
25431
25432 .vindex "&$acl_verify_message$&"
25433 When one of the &%warn%& conditions is an address verification that fails, the
25434 text of the verification failure message is in &$acl_verify_message$&. If you
25435 want this logged, you must set it up explicitly. For example:
25436 .code
25437 warn   !verify = sender
25438        log_message = sender verify failed: $acl_verify_message
25439 .endd
25440 .endlist
25441
25442 At the end of each ACL there is an implicit unconditional &%deny%&.
25443
25444 As you can see from the examples above, the conditions and modifiers are
25445 written one to a line, with the first one on the same line as the verb, and
25446 subsequent ones on following lines. If you have a very long condition, you can
25447 continue it onto several physical lines by the usual backslash continuation
25448 mechanism. It is conventional to align the conditions vertically.
25449
25450
25451
25452 .section "ACL variables" "SECTaclvariables"
25453 .cindex "&ACL;" "variables"
25454 There are some special variables that can be set during ACL processing. They
25455 can be used to pass information between different ACLs, different invocations
25456 of the same ACL in the same SMTP connection, and between ACLs and the routers,
25457 transports, and filters that are used to deliver a message. The names of these
25458 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
25459 an underscore, but the remainder of the name can be any sequence of
25460 alphanumeric characters and underscores that you choose. There is no limit on
25461 the number of ACL variables. The two sets act as follows:
25462 .ilist
25463 The values of those variables whose names begin with &$acl_c$& persist
25464 throughout an SMTP connection. They are never reset. Thus, a value that is set
25465 while receiving one message is still available when receiving the next message
25466 on the same SMTP connection.
25467 .next
25468 The values of those variables whose names begin with &$acl_m$& persist only
25469 while a message is being received. They are reset afterwards. They are also
25470 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
25471 .endlist
25472
25473 When a message is accepted, the current values of all the ACL variables are
25474 preserved with the message and are subsequently made available at delivery
25475 time. The ACL variables are set by a modifier called &%set%&. For example:
25476 .code
25477 accept hosts = whatever
25478        set acl_m4 = some value
25479 accept authenticated = *
25480        set acl_c_auth = yes
25481 .endd
25482 &*Note*&: A leading dollar sign is not used when naming a variable that is to
25483 be set. If you want to set a variable without taking any action, you can use a
25484 &%warn%& verb without any other modifiers or conditions.
25485
25486 .oindex &%strict_acl_vars%&
25487 What happens if a syntactically valid but undefined ACL variable is
25488 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
25489 false (the default), an empty string is substituted; if it is true, an
25490 error is generated.
25491
25492 Versions of Exim before 4.64 have a limited set of numbered variables, but
25493 their names are compatible, so there is no problem with upgrading.
25494
25495
25496 .section "Condition and modifier processing" "SECTcondmodproc"
25497 .cindex "&ACL;" "conditions; processing"
25498 .cindex "&ACL;" "modifiers; processing"
25499 An exclamation mark preceding a condition negates its result. For example:
25500 .code
25501 deny   domains = *.dom.example
25502       !verify  = recipient
25503 .endd
25504 causes the ACL to return &"deny"& if the recipient domain ends in
25505 &'dom.example'& and the recipient address cannot be verified. Sometimes
25506 negation can be used on the right-hand side of a condition. For example, these
25507 two statements are equivalent:
25508 .code
25509 deny  hosts = !192.168.3.4
25510 deny !hosts =  192.168.3.4
25511 .endd
25512 However, for many conditions (&%verify%& being a good example), only left-hand
25513 side negation of the whole condition is possible.
25514
25515 The arguments of conditions and modifiers are expanded. A forced failure
25516 of an expansion causes a condition to be ignored, that is, it behaves as if the
25517 condition is true. Consider these two statements:
25518 .code
25519 accept  senders = ${lookup{$host_name}lsearch\
25520                   {/some/file}{$value}fail}
25521 accept  senders = ${lookup{$host_name}lsearch\
25522                   {/some/file}{$value}{}}
25523 .endd
25524 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
25525 the returned list is searched, but if the lookup fails the behaviour is
25526 different in the two cases. The &%fail%& in the first statement causes the
25527 condition to be ignored, leaving no further conditions. The &%accept%& verb
25528 therefore succeeds. The second statement, however, generates an empty list when
25529 the lookup fails. No sender can match an empty list, so the condition fails,
25530 and therefore the &%accept%& also fails.
25531
25532 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
25533 specify actions that are taken as the conditions for a statement are checked;
25534 others specify text for messages that are used when access is denied or a
25535 warning is generated. The &%control%& modifier affects the way an incoming
25536 message is handled.
25537
25538 The positioning of the modifiers in an ACL statement important, because the
25539 processing of a verb ceases as soon as its outcome is known. Only those
25540 modifiers that have already been encountered will take effect. For example,
25541 consider this use of the &%message%& modifier:
25542 .code
25543 require message = Can't verify sender
25544         verify  = sender
25545         message = Can't verify recipient
25546         verify  = recipient
25547         message = This message cannot be used
25548 .endd
25549 If sender verification fails, Exim knows that the result of the statement is
25550 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
25551 so its text is used as the error message. If sender verification succeeds, but
25552 recipient verification fails, the second message is used. If recipient
25553 verification succeeds, the third message becomes &"current"&, but is never used
25554 because there are no more conditions to cause failure.
25555
25556 For the &%deny%& verb, on the other hand, it is always the last &%message%&
25557 modifier that is used, because all the conditions must be true for rejection to
25558 happen. Specifying more than one &%message%& modifier does not make sense, and
25559 the message can even be specified after all the conditions. For example:
25560 .code
25561 deny   hosts = ...
25562       !senders = *@my.domain.example
25563        message = Invalid sender from client host
25564 .endd
25565 The &"deny"& result does not happen until the end of the statement is reached,
25566 by which time Exim has set up the message.
25567
25568
25569
25570 .section "ACL modifiers" "SECTACLmodi"
25571 .cindex "&ACL;" "modifiers; list of"
25572 The ACL modifiers are as follows:
25573
25574 .vlist
25575 .vitem &*add_header*&&~=&~<&'text'&>
25576 This modifier specifies one or more header lines that are to be added to an
25577 incoming message, assuming, of course, that the message is ultimately
25578 accepted. For details, see section &<<SECTaddheadacl>>&.
25579
25580 .vitem &*continue*&&~=&~<&'text'&>
25581 .cindex "&%continue%& ACL modifier"
25582 .cindex "database" "updating in ACL"
25583 This modifier does nothing of itself, and processing of the ACL always
25584 continues with the next condition or modifier. The value of &%continue%& is in
25585 the side effects of expanding its argument. Typically this could be used to
25586 update a database. It is really just a syntactic tidiness, to avoid having to
25587 write rather ugly lines like this:
25588 .display
25589 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
25590 .endd
25591 Instead, all you need is
25592 .display
25593 &`continue = `&<&'some expansion'&>
25594 .endd
25595
25596 .vitem &*control*&&~=&~<&'text'&>
25597 .cindex "&%control%& ACL modifier"
25598 This modifier affects the subsequent processing of the SMTP connection or of an
25599 incoming message that is accepted. The effect of the first type of control
25600 lasts for the duration of the connection, whereas the effect of the second type
25601 lasts only until the current message has been received. The message-specific
25602 controls always apply to the whole message, not to individual recipients,
25603 even if the &%control%& modifier appears in a RCPT ACL.
25604
25605 As there are now quite a few controls that can be applied, they are described
25606 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
25607 in several different ways. For example:
25608
25609 . ==== As this is a nested list, any displays it contains must be indented
25610 . ==== as otherwise they are too far to the left. That comment applies only
25611 . ==== when xmlto and fop are used; formatting with sdop gets it right either
25612 . ==== way.
25613
25614 .ilist
25615 It can be at the end of an &%accept%& statement:
25616 .code
25617     accept  ...some conditions
25618             control = queue_only
25619 .endd
25620 In this case, the control is applied when this statement yields &"accept"&, in
25621 other words, when the conditions are all true.
25622
25623 .next
25624 It can be in the middle of an &%accept%& statement:
25625 .code
25626     accept  ...some conditions...
25627             control = queue_only
25628             ...some more conditions...
25629 .endd
25630 If the first set of conditions are true, the control is applied, even if the
25631 statement does not accept because one of the second set of conditions is false.
25632 In this case, some subsequent statement must yield &"accept"& for the control
25633 to be relevant.
25634
25635 .next
25636 It can be used with &%warn%& to apply the control, leaving the
25637 decision about accepting or denying to a subsequent verb. For
25638 example:
25639 .code
25640     warn    ...some conditions...
25641             control = freeze
25642     accept  ...
25643 .endd
25644 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
25645 &%logwrite%&, so it does not add anything to the message and does not write a
25646 log entry.
25647
25648 .next
25649 If you want to apply a control unconditionally, you can use it with a
25650 &%require%& verb. For example:
25651 .code
25652     require  control = no_multiline_responses
25653 .endd
25654 .endlist
25655
25656 .vitem &*delay*&&~=&~<&'time'&>
25657 .cindex "&%delay%& ACL modifier"
25658 .oindex "&%-bh%&"
25659 This modifier may appear in any ACL. It causes Exim to wait for the time
25660 interval before proceeding. However, when testing Exim using the &%-bh%&
25661 option, the delay is not actually imposed (an appropriate message is output
25662 instead). The time is given in the usual Exim notation, and the delay happens
25663 as soon as the modifier is processed. In an SMTP session, pending output is
25664 flushed before the delay is imposed.
25665
25666 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
25667 example:
25668 .code
25669 deny    ...some conditions...
25670         delay = 30s
25671 .endd
25672 The delay happens if all the conditions are true, before the statement returns
25673 &"deny"&. Compare this with:
25674 .code
25675 deny    delay = 30s
25676         ...some conditions...
25677 .endd
25678 which waits for 30s before processing the conditions. The &%delay%& modifier
25679 can also be used with &%warn%& and together with &%control%&:
25680 .code
25681 warn    ...some conditions...
25682         delay = 2m
25683         control = freeze
25684 accept  ...
25685 .endd
25686
25687 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
25688 responses to several commands are no longer buffered and sent in one packet (as
25689 they would normally be) because all output is flushed before imposing the
25690 delay. This optimization is disabled so that a number of small delays do not
25691 appear to the client as one large aggregated delay that might provoke an
25692 unwanted timeout. You can, however, disable output flushing for &%delay%& by
25693 using a &%control%& modifier to set &%no_delay_flush%&.
25694
25695
25696 .vitem &*endpass*&
25697 .cindex "&%endpass%& ACL modifier"
25698 This modifier, which has no argument, is recognized only in &%accept%& and
25699 &%discard%& statements. It marks the boundary between the conditions whose
25700 failure causes control to pass to the next statement, and the conditions whose
25701 failure causes the ACL to return &"deny"&. This concept has proved to be
25702 confusing to some people, so the use of &%endpass%& is no longer recommended as
25703 &"best practice"&. See the description of &%accept%& above for more details.
25704
25705
25706 .vitem &*log_message*&&~=&~<&'text'&>
25707 .cindex "&%log_message%& ACL modifier"
25708 This modifier sets up a message that is used as part of the log message if the
25709 ACL denies access or a &%warn%& statement's conditions are true. For example:
25710 .code
25711 require log_message = wrong cipher suite $tls_cipher
25712         encrypted   = DES-CBC3-SHA
25713 .endd
25714 &%log_message%& is also used when recipients are discarded by &%discard%&. For
25715 example:
25716 .display
25717 &`discard `&<&'some conditions'&>
25718 &`        log_message = Discarded $local_part@$domain because...`&
25719 .endd
25720 When access is denied, &%log_message%& adds to any underlying error message
25721 that may exist because of a condition failure. For example, while verifying a
25722 recipient address, a &':fail:'& redirection might have already set up a
25723 message.
25724
25725 The message may be defined before the conditions to which it applies, because
25726 the string expansion does not happen until Exim decides that access is to be
25727 denied. This means that any variables that are set by the condition are
25728 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
25729 variables are set after a DNS black list lookup succeeds. If the expansion of
25730 &%log_message%& fails, or if the result is an empty string, the modifier is
25731 ignored.
25732
25733 .vindex "&$acl_verify_message$&"
25734 If you want to use a &%warn%& statement to log the result of an address
25735 verification, you can use &$acl_verify_message$& to include the verification
25736 error message.
25737
25738 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
25739 the start of the logged message. If the same warning log message is requested
25740 more than once while receiving  a single email message, only one copy is
25741 actually logged. If you want to log multiple copies, use &%logwrite%& instead
25742 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
25743 is logged for a successful &%warn%& statement.
25744
25745 If &%log_message%& is not present and there is no underlying error message (for
25746 example, from the failure of address verification), but &%message%& is present,
25747 the &%message%& text is used for logging rejections. However, if any text for
25748 logging contains newlines, only the first line is logged. In the absence of
25749 both &%log_message%& and &%message%&, a default built-in message is used for
25750 logging rejections.
25751
25752
25753 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
25754 .cindex "&%log_reject_target%& ACL modifier"
25755 .cindex "logging in ACL" "specifying which log"
25756 This modifier makes it possible to specify which logs are used for messages
25757 about ACL rejections. Its argument is a colon-separated list of words that can
25758 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
25759 may be empty, in which case a rejection is not logged at all. For example, this
25760 ACL fragment writes no logging information when access is denied:
25761 .display
25762 &`deny `&<&'some conditions'&>
25763 &`     log_reject_target =`&
25764 .endd
25765 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
25766 permanent and temporary rejections. Its effect lasts for the rest of the
25767 current ACL.
25768
25769
25770 .vitem &*logwrite*&&~=&~<&'text'&>
25771 .cindex "&%logwrite%& ACL modifier"
25772 .cindex "logging in ACL" "immediate"
25773 This modifier writes a message to a log file as soon as it is encountered when
25774 processing an ACL. (Compare &%log_message%&, which, except in the case of
25775 &%warn%& and &%discard%&, is used only if the ACL statement denies
25776 access.) The &%logwrite%& modifier can be used to log special incidents in
25777 ACLs. For example:
25778 .display
25779 &`accept `&<&'some special conditions'&>
25780 &`       control  = freeze`&
25781 &`       logwrite = froze message because ...`&
25782 .endd
25783 By default, the message is written to the main log. However, it may begin
25784 with a colon, followed by a comma-separated list of log names, and then
25785 another colon, to specify exactly which logs are to be written. For
25786 example:
25787 .code
25788 logwrite = :main,reject: text for main and reject logs
25789 logwrite = :panic: text for panic log only
25790 .endd
25791
25792
25793 .vitem &*message*&&~=&~<&'text'&>
25794 .cindex "&%message%& ACL modifier"
25795 This modifier sets up a text string that is expanded and used as a response
25796 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
25797 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
25798 there is some complication if &%endpass%& is involved; see the description of
25799 &%accept%& for details.)
25800
25801 The expansion of the message happens at the time Exim decides that the ACL is
25802 to end, not at the time it processes &%message%&. If the expansion fails, or
25803 generates an empty string, the modifier is ignored. Here is an example where
25804 &%message%& must be specified first, because the ACL ends with a rejection if
25805 the &%hosts%& condition fails:
25806 .code
25807 require  message = Host not recognized
25808          hosts = 10.0.0.0/8
25809 .endd
25810 (Once a condition has failed, no further conditions or modifiers are
25811 processed.)
25812
25813 .cindex "SMTP" "error codes"
25814 .oindex "&%smtp_banner%&
25815 For ACLs that are triggered by SMTP commands, the message is returned as part
25816 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
25817 is meaningful only for SMTP, as no message is returned when a non-SMTP message
25818 is accepted. In the case of the connect ACL, accepting with a message modifier
25819 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
25820 accept message may not contain more than one line (otherwise it will be
25821 truncated at the first newline and a panic logged), and it cannot affect the
25822 EHLO options.
25823
25824 When SMTP is involved, the message may begin with an overriding response code,
25825 consisting of three digits optionally followed by an &"extended response code"&
25826 of the form &'n.n.n'&, each code being followed by a space. For example:
25827 .code
25828 deny  message = 599 1.2.3 Host not welcome
25829       hosts = 192.168.34.0/24
25830 .endd
25831 The first digit of the supplied response code must be the same as would be sent
25832 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
25833 access, but for the predata ACL, note that the default success code is 354, not
25834 2&'xx'&.
25835
25836 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
25837 the message modifier cannot override the 221 response code.
25838
25839 The text in a &%message%& modifier is literal; any quotes are taken as
25840 literals, but because the string is expanded, backslash escapes are processed
25841 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
25842 response.
25843
25844 .vindex "&$acl_verify_message$&"
25845 If &%message%& is used on a statement that verifies an address, the message
25846 specified overrides any message that is generated by the verification process.
25847 However, the original message is available in the variable
25848 &$acl_verify_message$&, so you can incorporate it into your message if you
25849 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
25850 routers to be passed back as part of the SMTP response, you should either not
25851 use a &%message%& modifier, or make use of &$acl_verify_message$&.
25852
25853 For compatibility with previous releases of Exim, a &%message%& modifier that
25854 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
25855 modifier, but this usage is now deprecated. However, &%message%& acts only when
25856 all the conditions are true, wherever it appears in an ACL command, whereas
25857 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
25858 &%warn%& in an ACL that is not concerned with receiving a message, it has no
25859 effect.
25860
25861
25862 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
25863 .cindex "&%set%& ACL modifier"
25864 This modifier puts a value into one of the ACL variables (see section
25865 &<<SECTaclvariables>>&).
25866 .endlist
25867
25868
25869
25870
25871
25872 .section "Use of the control modifier" "SECTcontrols"
25873 .cindex "&%control%& ACL modifier"
25874 The &%control%& modifier supports the following settings:
25875
25876 .vlist
25877 .vitem &*control&~=&~allow_auth_unadvertised*&
25878 This modifier allows a client host to use the SMTP AUTH command even when it
25879 has not been advertised in response to EHLO. Furthermore, because there are
25880 apparently some really broken clients that do this, Exim will accept AUTH after
25881 HELO (rather than EHLO) when this control is set. It should be used only if you
25882 really need it, and you should limit its use to those broken clients that do
25883 not work without it. For example:
25884 .code
25885 warn hosts   = 192.168.34.25
25886      control = allow_auth_unadvertised
25887 .endd
25888 Normally, when an Exim server receives an AUTH command, it checks the name of
25889 the authentication mechanism that is given in the command to ensure that it
25890 matches an advertised mechanism. When this control is set, the check that a
25891 mechanism has been advertised is bypassed. Any configured mechanism can be used
25892 by the client. This control is permitted only in the connection and HELO ACLs.
25893
25894
25895 .vitem &*control&~=&~caseful_local_part*& &&&
25896        &*control&~=&~caselower_local_part*&
25897 .cindex "&ACL;" "case of local part in"
25898 .cindex "case of local parts"
25899 .vindex "&$local_part$&"
25900 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
25901 (that is, during RCPT processing). By default, the contents of &$local_part$&
25902 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
25903 any uppercase letters in the original local part are restored in &$local_part$&
25904 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
25905 is encountered.
25906
25907 These controls affect only the current recipient. Moreover, they apply only to
25908 local part handling that takes place directly in the ACL (for example, as a key
25909 in lookups). If a test to verify the recipient is obeyed, the case-related
25910 handling of the local part during the verification is controlled by the router
25911 configuration (see the &%caseful_local_part%& generic router option).
25912
25913 This facility could be used, for example, to add a spam score to local parts
25914 containing upper case letters. For example, using &$acl_m4$& to accumulate the
25915 spam score:
25916 .code
25917 warn  control = caseful_local_part
25918       set acl_m4 = ${eval:\
25919                      $acl_m4 + \
25920                      ${if match{$local_part}{[A-Z]}{1}{0}}\
25921                     }
25922       control = caselower_local_part
25923 .endd
25924 Notice that we put back the lower cased version afterwards, assuming that
25925 is what is wanted for subsequent tests.
25926
25927 .new
25928 .vitem &*control&~=&~debug/*&<&'options'&>
25929 .cindex "&ACL;" "enabling debug logging"
25930 .cindex "debugging" "enabling from an ACL"
25931 This control turns on debug logging, almost as though Exim had been invoked
25932 with &`-d`&, with the output going to a new logfile, by default called
25933 &'debuglog'&.  The filename can be adjusted with the &'tag'& option, which
25934 may access any variables already defined.  The logging may be adjusted with
25935 the &'opts'& option, which takes the same values as the &`-d`& command-line
25936 option.  Some examples (which depend on variables that don't exist in all
25937 contexts):
25938 .code
25939       control = debug
25940       control = debug/tag=.$sender_host_address
25941       control = debug/opts=+expand+acl
25942       control = debug/tag=.$message_exim_id/opts=+expand
25943 .endd
25944 .wen
25945
25946 .vitem &*control&~=&~enforce_sync*& &&&
25947        &*control&~=&~no_enforce_sync*&
25948 .cindex "SMTP" "synchronization checking"
25949 .cindex "synchronization checking in SMTP"
25950 These controls make it possible to be selective about when SMTP synchronization
25951 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
25952 state of the switch (it is true by default). See the description of this option
25953 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
25954
25955 The effect of these two controls lasts for the remainder of the SMTP
25956 connection. They can appear in any ACL except the one for the non-SMTP
25957 messages. The most straightforward place to put them is in the ACL defined by
25958 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
25959 before the first synchronization check. The expected use is to turn off the
25960 synchronization checks for badly-behaved hosts that you nevertheless need to
25961 work with.
25962
25963
25964 .vitem &*control&~=&~fakedefer/*&<&'message'&>
25965 .cindex "fake defer"
25966 .cindex "defer, fake"
25967 This control works in exactly the same way as &%fakereject%& (described below)
25968 except that it causes an SMTP 450 response after the message data instead of a
25969 550 response. You must take care when using &%fakedefer%& because it causes the
25970 messages to be duplicated when the sender retries. Therefore, you should not
25971 use &%fakedefer%& if the message is to be delivered normally.
25972
25973 .vitem &*control&~=&~fakereject/*&<&'message'&>
25974 .cindex "fake rejection"
25975 .cindex "rejection, fake"
25976 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
25977 words, only when an SMTP message is being received. If Exim accepts the
25978 message, instead the final 250 response, a 550 rejection message is sent.
25979 However, Exim proceeds to deliver the message as normal. The control applies
25980 only to the current message, not to any subsequent ones that may be received in
25981 the same SMTP connection.
25982
25983 The text for the 550 response is taken from the &%control%& modifier. If no
25984 message is supplied, the following is used:
25985 .code
25986 550-Your message has been rejected but is being
25987 550-kept for evaluation.
25988 550-If it was a legitimate message, it may still be
25989 550 delivered to the target recipient(s).
25990 .endd
25991 This facility should be used with extreme caution.
25992
25993 .vitem &*control&~=&~freeze*&
25994 .cindex "frozen messages" "forcing in ACL"
25995 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
25996 other words, only when a message is being received. If the message is accepted,
25997 it is placed on Exim's queue and frozen. The control applies only to the
25998 current message, not to any subsequent ones that may be received in the same
25999 SMTP connection.
26000
26001 This modifier can optionally be followed by &`/no_tell`&. If the global option
26002 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
26003 is told about the freezing), provided all the &*control=freeze*& modifiers that
26004 are obeyed for the current message have the &`/no_tell`& option.
26005
26006 .vitem &*control&~=&~no_delay_flush*&
26007 .cindex "SMTP" "output flushing, disabling for delay"
26008 Exim normally flushes SMTP output before implementing a delay in an ACL, to
26009 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
26010 use. This control, as long as it is encountered before the &%delay%& modifier,
26011 disables such output flushing.
26012
26013 .vitem &*control&~=&~no_callout_flush*&
26014 .cindex "SMTP" "output flushing, disabling for callout"
26015 Exim normally flushes SMTP output before performing a callout in an ACL, to
26016 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
26017 use. This control, as long as it is encountered before the &%verify%& condition
26018 that causes the callout, disables such output flushing.
26019
26020 .vitem &*control&~=&~no_mbox_unspool*&
26021 This control is available when Exim is compiled with the content scanning
26022 extension. Content scanning may require a copy of the current message, or parts
26023 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
26024 or spam scanner. Normally, such copies are deleted when they are no longer
26025 needed. If this control is set, the copies are not deleted. The control applies
26026 only to the current message, not to any subsequent ones that may be received in
26027 the same SMTP connection. It is provided for debugging purposes and is unlikely
26028 to be useful in production.
26029
26030 .vitem &*control&~=&~no_multiline_responses*&
26031 .cindex "multiline responses, suppressing"
26032 This control is permitted for any ACL except the one for non-SMTP messages.
26033 It seems that there are broken clients in use that cannot handle multiline
26034 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
26035
26036 If this control is set, multiline SMTP responses from ACL rejections are
26037 suppressed. One way of doing this would have been to put out these responses as
26038 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
26039 (&"use multiline responses for more"& it says &-- ha!), and some of the
26040 responses might get close to that. So this facility, which is after all only a
26041 sop to broken clients, is implemented by doing two very easy things:
26042
26043 .ilist
26044 Extra information that is normally output as part of a rejection caused by
26045 sender verification failure is omitted. Only the final line (typically &"sender
26046 verification failed"&) is sent.
26047 .next
26048 If a &%message%& modifier supplies a multiline response, only the first
26049 line is output.
26050 .endlist
26051
26052 The setting of the switch can, of course, be made conditional on the
26053 calling host. Its effect lasts until the end of the SMTP connection.
26054
26055 .vitem &*control&~=&~no_pipelining*&
26056 .cindex "PIPELINING" "suppressing advertising"
26057 This control turns off the advertising of the PIPELINING extension to SMTP in
26058 the current session. To be useful, it must be obeyed before Exim sends its
26059 response to an EHLO command. Therefore, it should normally appear in an ACL
26060 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
26061 &%pipelining_advertise_hosts%&.
26062
26063 .vitem &*control&~=&~queue_only*&
26064 .oindex "&%queue_only%&"
26065 .cindex "queueing incoming messages"
26066 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
26067 other words, only when a message is being received. If the message is accepted,
26068 it is placed on Exim's queue and left there for delivery by a subsequent queue
26069 runner. No immediate delivery process is started. In other words, it has the
26070 effect as the &%queue_only%& global option. However, the control applies only
26071 to the current message, not to any subsequent ones that may be received in the
26072 same SMTP connection.
26073
26074 .vitem &*control&~=&~submission/*&<&'options'&>
26075 .cindex "message" "submission"
26076 .cindex "submission mode"
26077 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
26078 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
26079 the current message is a submission from a local MUA. In this case, Exim
26080 operates in &"submission mode"&, and applies certain fixups to the message if
26081 necessary. For example, it adds a &'Date:'& header line if one is not present.
26082 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
26083 late (the message has already been created).
26084
26085 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
26086 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
26087 submission mode; the available options for this control are described there.
26088 The control applies only to the current message, not to any subsequent ones
26089 that may be received in the same SMTP connection.
26090
26091 .vitem &*control&~=&~suppress_local_fixups*&
26092 .cindex "submission fixups, suppressing"
26093 This control applies to locally submitted (non TCP/IP) messages, and is the
26094 complement of &`control = submission`&. It disables the fixups that are
26095 normally applied to locally-submitted messages. Specifically:
26096
26097 .ilist
26098 Any &'Sender:'& header line is left alone (in this respect, it is a
26099 dynamic version of &%local_sender_retain%&).
26100 .next
26101 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
26102 .next
26103 There is no check that &'From:'& corresponds to the actual sender.
26104 .endlist ilist
26105
26106 This control may be useful when a remotely-originated message is accepted,
26107 passed to some scanning program, and then re-submitted for delivery. It can be
26108 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
26109 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
26110 data is read.
26111
26112 &*Note:*& This control applies only to the current message, not to any others
26113 that are being submitted at the same time using &%-bs%& or &%-bS%&.
26114 .endlist vlist
26115
26116
26117 .section "Summary of message fixup control" "SECTsummesfix"
26118 All four possibilities for message fixups can be specified:
26119
26120 .ilist
26121 Locally submitted, fixups applied: the default.
26122 .next
26123 Locally submitted, no fixups applied: use
26124 &`control = suppress_local_fixups`&.
26125 .next
26126 Remotely submitted, no fixups applied: the default.
26127 .next
26128 Remotely submitted, fixups applied: use &`control = submission`&.
26129 .endlist
26130
26131
26132
26133 .section "Adding header lines in ACLs" "SECTaddheadacl"
26134 .cindex "header lines" "adding in an ACL"
26135 .cindex "header lines" "position of added lines"
26136 .cindex "&%message%& ACL modifier"
26137 The &%add_header%& modifier can be used to add one or more extra header lines
26138 to an incoming message, as in this example:
26139 .code
26140 warn dnslists = sbl.spamhaus.org : \
26141                 dialup.mail-abuse.org
26142      add_header = X-blacklisted-at: $dnslist_domain
26143 .endd
26144 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
26145 MIME, and non-SMTP ACLs (in other words, those that are concerned with
26146 receiving a message). The message must ultimately be accepted for
26147 &%add_header%& to have any significant effect. You can use &%add_header%& with
26148 any ACL verb, including &%deny%& (though this is potentially useful only in a
26149 RCPT ACL).
26150
26151 If the data for the &%add_header%& modifier contains one or more newlines that
26152 are not followed by a space or a tab, it is assumed to contain multiple header
26153 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
26154 front of any line that is not a valid header line.
26155
26156 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
26157 They are added to the message before processing the DATA and MIME ACLs.
26158 However, if an identical header line is requested more than once, only one copy
26159 is actually added to the message. Further header lines may be accumulated
26160 during the DATA and MIME ACLs, after which they are added to the message, again
26161 with duplicates suppressed. Thus, it is possible to add two identical header
26162 lines to an SMTP message, but only if one is added before DATA and one after.
26163 In the case of non-SMTP messages, new headers are accumulated during the
26164 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
26165 message is rejected after DATA or by the non-SMTP ACL, all added header lines
26166 are included in the entry that is written to the reject log.
26167
26168 .cindex "header lines" "added; visibility of"
26169 Header lines are not visible in string expansions until they are added to the
26170 message. It follows that header lines defined in the MAIL, RCPT, and predata
26171 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
26172 header lines that are added by the DATA or MIME ACLs are not visible in those
26173 ACLs. Because of this restriction, you cannot use header lines as a way of
26174 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
26175 this, you can use ACL variables, as described in section
26176 &<<SECTaclvariables>>&.
26177
26178 The &%add_header%& modifier acts immediately it is encountered during the
26179 processing of an ACL. Notice the difference between these two cases:
26180 .display
26181 &`accept add_header = ADDED: some text`&
26182 &`       `&<&'some condition'&>
26183
26184 &`accept `&<&'some condition'&>
26185 &`       add_header = ADDED: some text`&
26186 .endd
26187 In the first case, the header line is always added, whether or not the
26188 condition is true. In the second case, the header line is added only if the
26189 condition is true. Multiple occurrences of &%add_header%& may occur in the same
26190 ACL statement. All those that are encountered before a condition fails are
26191 honoured.
26192
26193 .cindex "&%warn%& ACL verb"
26194 For compatibility with previous versions of Exim, a &%message%& modifier for a
26195 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
26196 effect only if all the conditions are true, even if it appears before some of
26197 them. Furthermore, only the last occurrence of &%message%& is honoured. This
26198 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
26199 are present on a &%warn%& verb, both are processed according to their
26200 specifications.
26201
26202 By default, new header lines are added to a message at the end of the existing
26203 header lines. However, you can specify that any particular header line should
26204 be added right at the start (before all the &'Received:'& lines), immediately
26205 after the first block of &'Received:'& lines, or immediately before any line
26206 that is not a &'Received:'& or &'Resent-something:'& header.
26207
26208 This is done by specifying &":at_start:"&, &":after_received:"&, or
26209 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
26210 header line, respectively. (Header text cannot start with a colon, as there has
26211 to be a header name first.) For example:
26212 .code
26213 warn add_header = \
26214        :after_received:X-My-Header: something or other...
26215 .endd
26216 If more than one header line is supplied in a single &%add_header%& modifier,
26217 each one is treated independently and can therefore be placed differently. If
26218 you add more than one line at the start, or after the Received: block, they end
26219 up in reverse order.
26220
26221 &*Warning*&: This facility currently applies only to header lines that are
26222 added in an ACL. It does NOT work for header lines that are added in a
26223 system filter or in a router or transport.
26224
26225
26226
26227
26228 .section "ACL conditions" "SECTaclconditions"
26229 .cindex "&ACL;" "conditions; list of"
26230 Some of conditions listed in this section are available only when Exim is
26231 compiled with the content-scanning extension. They are included here briefly
26232 for completeness. More detailed descriptions can be found in the discussion on
26233 content scanning in chapter &<<CHAPexiscan>>&.
26234
26235 Not all conditions are relevant in all circumstances. For example, testing
26236 senders and recipients does not make sense in an ACL that is being run as the
26237 result of the arrival of an ETRN command, and checks on message headers can be
26238 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
26239 can use the same condition (with different parameters) more than once in the
26240 same ACL statement. This provides a way of specifying an &"and"& conjunction.
26241 The conditions are as follows:
26242
26243
26244 .vlist
26245 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
26246 .cindex "&ACL;" "nested"
26247 .cindex "&ACL;" "indirect"
26248 .cindex "&%acl%& ACL condition"
26249 The possible values of the argument are the same as for the
26250 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
26251 &"accept"& the condition is true; if it returns &"deny"& the condition is
26252 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
26253 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
26254 condition false. This means that further processing of the &%warn%& verb
26255 ceases, but processing of the ACL continues.
26256
26257 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
26258 the connection is dropped. If it returns &"discard"&, the verb must be
26259 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
26260 conditions are tested.
26261
26262 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
26263 loops. This condition allows you to use different ACLs in different
26264 circumstances. For example, different ACLs can be used to handle RCPT commands
26265 for different local users or different local domains.
26266
26267 .vitem &*authenticated&~=&~*&<&'string&~list'&>
26268 .cindex "&%authenticated%& ACL condition"
26269 .cindex "authentication" "ACL checking"
26270 .cindex "&ACL;" "testing for authentication"
26271 If the SMTP connection is not authenticated, the condition is false. Otherwise,
26272 the name of the authenticator is tested against the list. To test for
26273 authentication by any authenticator, you can set
26274 .code
26275 authenticated = *
26276 .endd
26277
26278 .vitem &*condition&~=&~*&<&'string'&>
26279 .cindex "&%condition%& ACL condition"
26280 .cindex "customizing" "ACL condition"
26281 .cindex "&ACL;" "customized test"
26282 .cindex "&ACL;" "testing, customized"
26283 This feature allows you to make up custom conditions. If the result of
26284 expanding the string is an empty string, the number zero, or one of the strings
26285 &"no"& or &"false"&, the condition is false. If the result is any non-zero
26286 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
26287 any other value, some error is assumed to have occurred, and the ACL returns
26288 &"defer"&. However, if the expansion is forced to fail, the condition is
26289 ignored. The effect is to treat it as true, whether it is positive or
26290 negative.
26291
26292 .vitem &*decode&~=&~*&<&'location'&>
26293 .cindex "&%decode%& ACL condition"
26294 This condition is available only when Exim is compiled with the
26295 content-scanning extension, and it is allowed only in the ACL defined by
26296 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
26297 If all goes well, the condition is true. It is false only if there are
26298 problems such as a syntax error or a memory shortage. For more details, see
26299 chapter &<<CHAPexiscan>>&.
26300
26301 .vitem &*demime&~=&~*&<&'extension&~list'&>
26302 .cindex "&%demime%& ACL condition"
26303 This condition is available only when Exim is compiled with the
26304 content-scanning extension. Its use is described in section
26305 &<<SECTdemimecond>>&.
26306
26307 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
26308 .cindex "&%dnslists%& ACL condition"
26309 .cindex "DNS list" "in ACL"
26310 .cindex "black list (DNS)"
26311 .cindex "&ACL;" "testing a DNS list"
26312 This condition checks for entries in DNS black lists. These are also known as
26313 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
26314 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
26315 different variants of this condition to describe briefly here. See sections
26316 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
26317
26318 .vitem &*domains&~=&~*&<&'domain&~list'&>
26319 .cindex "&%domains%& ACL condition"
26320 .cindex "domain" "ACL checking"
26321 .cindex "&ACL;" "testing a recipient domain"
26322 .vindex "&$domain_data$&"
26323 This condition is relevant only after a RCPT command. It checks that the domain
26324 of the recipient address is in the domain list. If percent-hack processing is
26325 enabled, it is done before this test is done. If the check succeeds with a
26326 lookup, the result of the lookup is placed in &$domain_data$& until the next
26327 &%domains%& test.
26328
26329 &*Note carefully*& (because many people seem to fall foul of this): you cannot
26330 use &%domains%& in a DATA ACL.
26331
26332
26333 .vitem &*encrypted&~=&~*&<&'string&~list'&>
26334 .cindex "&%encrypted%& ACL condition"
26335 .cindex "encryption" "checking in an ACL"
26336 .cindex "&ACL;" "testing for encryption"
26337 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
26338 name of the cipher suite in use is tested against the list. To test for
26339 encryption without testing for any specific cipher suite(s), set
26340 .code
26341 encrypted = *
26342 .endd
26343
26344
26345 .vitem &*hosts&~=&~*&<&'&~host&~list'&>
26346 .cindex "&%hosts%& ACL condition"
26347 .cindex "host" "ACL checking"
26348 .cindex "&ACL;" "testing the client host"
26349 This condition tests that the calling host matches the host list. If you have
26350 name lookups or wildcarded host names and IP addresses in the same host list,
26351 you should normally put the IP addresses first. For example, you could have:
26352 .code
26353 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
26354 .endd
26355 The lookup in this example uses the host name for its key. This is implied by
26356 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
26357 and it wouldn't matter which way round you had these two items.)
26358
26359 The reason for the problem with host names lies in the left-to-right way that
26360 Exim processes lists. It can test IP addresses without doing any DNS lookups,
26361 but when it reaches an item that requires a host name, it fails if it cannot
26362 find a host name to compare with the pattern. If the above list is given in the
26363 opposite order, the &%accept%& statement fails for a host whose name cannot be
26364 found, even if its IP address is 10.9.8.7.
26365
26366 If you really do want to do the name check first, and still recognize the IP
26367 address even if the name lookup fails, you can rewrite the ACL like this:
26368 .code
26369 accept hosts = dbm;/etc/friendly/hosts
26370 accept hosts = 10.9.8.7
26371 .endd
26372 The default action on failing to find the host name is to assume that the host
26373 is not in the list, so the first &%accept%& statement fails. The second
26374 statement can then check the IP address.
26375
26376 .vindex "&$host_data$&"
26377 If a &%hosts%& condition is satisfied by means of a lookup, the result
26378 of the lookup is made available in the &$host_data$& variable. This
26379 allows you, for example, to set up a statement like this:
26380 .code
26381 deny  hosts = net-lsearch;/some/file
26382 message = $host_data
26383 .endd
26384 which gives a custom error message for each denied host.
26385
26386 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
26387 .cindex "&%local_parts%& ACL condition"
26388 .cindex "local part" "ACL checking"
26389 .cindex "&ACL;" "testing a local part"
26390 .vindex "&$local_part_data$&"
26391 This condition is relevant only after a RCPT command. It checks that the local
26392 part of the recipient address is in the list. If percent-hack processing is
26393 enabled, it is done before this test. If the check succeeds with a lookup, the
26394 result of the lookup is placed in &$local_part_data$&, which remains set until
26395 the next &%local_parts%& test.
26396
26397 .vitem &*malware&~=&~*&<&'option'&>
26398 .cindex "&%malware%& ACL condition"
26399 .cindex "&ACL;" "virus scanning"
26400 .cindex "&ACL;" "scanning for viruses"
26401 This condition is available only when Exim is compiled with the
26402 content-scanning extension. It causes the incoming message to be scanned for
26403 viruses. For details, see chapter &<<CHAPexiscan>>&.
26404
26405 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
26406 .cindex "&%mime_regex%& ACL condition"
26407 .cindex "&ACL;" "testing by regex matching"
26408 This condition is available only when Exim is compiled with the
26409 content-scanning extension, and it is allowed only in the ACL defined by
26410 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
26411 with any of the regular expressions. For details, see chapter
26412 &<<CHAPexiscan>>&.
26413
26414 .vitem &*ratelimit&~=&~*&<&'parameters'&>
26415 .cindex "rate limiting"
26416 This condition can be used to limit the rate at which a user or host submits
26417 messages. Details are given in section &<<SECTratelimiting>>&.
26418
26419 .vitem &*recipients&~=&~*&<&'address&~list'&>
26420 .cindex "&%recipients%& ACL condition"
26421 .cindex "recipient" "ACL checking"
26422 .cindex "&ACL;" "testing a recipient"
26423 This condition is relevant only after a RCPT command. It checks the entire
26424 recipient address against a list of recipients.
26425
26426 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
26427 .cindex "&%regex%& ACL condition"
26428 .cindex "&ACL;" "testing by regex matching"
26429 This condition is available only when Exim is compiled with the
26430 content-scanning extension, and is available only in the DATA, MIME, and
26431 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
26432 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
26433
26434 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
26435 .cindex "&%sender_domains%& ACL condition"
26436 .cindex "sender" "ACL checking"
26437 .cindex "&ACL;" "testing a sender domain"
26438 .vindex "&$domain$&"
26439 .vindex "&$sender_address_domain$&"
26440 This condition tests the domain of the sender of the message against the given
26441 domain list. &*Note*&: The domain of the sender address is in
26442 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
26443 of this condition. This is an exception to the general rule for testing domain
26444 lists. It is done this way so that, if this condition is used in an ACL for a
26445 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
26446 influence the sender checking.
26447
26448 &*Warning*&: It is a bad idea to use this condition on its own as a control on
26449 relaying, because sender addresses are easily, and commonly, forged.
26450
26451 .vitem &*senders&~=&~*&<&'address&~list'&>
26452 .cindex "&%senders%& ACL condition"
26453 .cindex "sender" "ACL checking"
26454 .cindex "&ACL;" "testing a sender"
26455 This condition tests the sender of the message against the given list. To test
26456 for a bounce message, which has an empty sender, set
26457 .code
26458 senders = :
26459 .endd
26460 &*Warning*&: It is a bad idea to use this condition on its own as a control on
26461 relaying, because sender addresses are easily, and commonly, forged.
26462
26463 .vitem &*spam&~=&~*&<&'username'&>
26464 .cindex "&%spam%& ACL condition"
26465 .cindex "&ACL;" "scanning for spam"
26466 This condition is available only when Exim is compiled with the
26467 content-scanning extension. It causes the incoming message to be scanned by
26468 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
26469
26470 .vitem &*verify&~=&~certificate*&
26471 .cindex "&%verify%& ACL condition"
26472 .cindex "TLS" "client certificate verification"
26473 .cindex "certificate" "verification of client"
26474 .cindex "&ACL;" "certificate verification"
26475 .cindex "&ACL;" "testing a TLS certificate"
26476 This condition is true in an SMTP session if the session is encrypted, and a
26477 certificate was received from the client, and the certificate was verified. The
26478 server requests a certificate only if the client matches &%tls_verify_hosts%&
26479 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
26480
26481 .vitem &*verify&~=&~csa*&
26482 .cindex "CSA verification"
26483 This condition checks whether the sending host (the client) is authorized to
26484 send email. Details of how this works are given in section
26485 &<<SECTverifyCSA>>&.
26486
26487 .vitem &*verify&~=&~header_sender/*&<&'options'&>
26488 .cindex "&%verify%& ACL condition"
26489 .cindex "&ACL;" "verifying sender in the header"
26490 .cindex "header lines" "verifying the sender in"
26491 .cindex "sender" "verifying in header"
26492 .cindex "verifying" "sender in header"
26493 This condition is relevant only in an ACL that is run after a message has been
26494 received, that is, in an ACL specified by &%acl_smtp_data%& or
26495 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
26496 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
26497 is loosely thought of as a &"sender"& address (hence the name of the test).
26498 However, an address that appears in one of these headers need not be an address
26499 that accepts bounce messages; only sender addresses in envelopes are required
26500 to accept bounces. Therefore, if you use the callout option on this check, you
26501 might want to arrange for a non-empty address in the MAIL command.
26502
26503 Details of address verification and the options are given later, starting at
26504 section &<<SECTaddressverification>>& (callouts are described in section
26505 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
26506 condition to restrict it to bounce messages only:
26507 .code
26508 deny    senders = :
26509         message = A valid sender header is required for bounces
26510        !verify  = header_sender
26511 .endd
26512
26513 .vitem &*verify&~=&~header_syntax*&
26514 .cindex "&%verify%& ACL condition"
26515 .cindex "&ACL;" "verifying header syntax"
26516 .cindex "header lines" "verifying syntax"
26517 .cindex "verifying" "header syntax"
26518 This condition is relevant only in an ACL that is run after a message has been
26519 received, that is, in an ACL specified by &%acl_smtp_data%& or
26520 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
26521 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
26522 and &'Bcc:'&). Unqualified addresses (local parts without domains) are
26523 permitted only in locally generated messages and from hosts that match
26524 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
26525 appropriate.
26526
26527 Note that this condition is a syntax check only. However, a common spamming
26528 ploy used to be to send syntactically invalid headers such as
26529 .code
26530 To: @
26531 .endd
26532 and this condition can be used to reject such messages, though they are not as
26533 common as they used to be.
26534
26535 .vitem &*verify&~=&~helo*&
26536 .cindex "&%verify%& ACL condition"
26537 .cindex "&ACL;" "verifying HELO/EHLO"
26538 .cindex "HELO" "verifying"
26539 .cindex "EHLO" "verifying"
26540 .cindex "verifying" "EHLO"
26541 .cindex "verifying" "HELO"
26542 This condition is true if a HELO or EHLO command has been received from the
26543 client host, and its contents have been verified. If there has been no previous
26544 attempt to verify the HELO/EHLO contents, it is carried out when this
26545 condition is encountered. See the description of the &%helo_verify_hosts%& and
26546 &%helo_try_verify_hosts%& options for details of how to request verification
26547 independently of this condition.
26548
26549 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
26550 option), this condition is always true.
26551
26552
26553 .vitem &*verify&~=&~not_blind*&
26554 .cindex "verifying" "not blind"
26555 .cindex "bcc recipients, verifying none"
26556 This condition checks that there are no blind (bcc) recipients in the message.
26557 Every envelope recipient must appear either in a &'To:'& header line or in a
26558 &'Cc:'& header line for this condition to be true. Local parts are checked
26559 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
26560 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
26561 used only in a DATA or non-SMTP ACL.
26562
26563 There are, of course, many legitimate messages that make use of blind (bcc)
26564 recipients. This check should not be used on its own for blocking messages.
26565
26566
26567 .vitem &*verify&~=&~recipient/*&<&'options'&>
26568 .cindex "&%verify%& ACL condition"
26569 .cindex "&ACL;" "verifying recipient"
26570 .cindex "recipient" "verifying"
26571 .cindex "verifying" "recipient"
26572 .vindex "&$address_data$&"
26573 This condition is relevant only after a RCPT command. It verifies the current
26574 recipient. Details of address verification are given later, starting at section
26575 &<<SECTaddressverification>>&. After a recipient has been verified, the value
26576 of &$address_data$& is the last value that was set while routing the address.
26577 This applies even if the verification fails. When an address that is being
26578 verified is redirected to a single address, verification continues with the new
26579 address, and in that case, the subsequent value of &$address_data$& is the
26580 value for the child address.
26581
26582 .vitem &*verify&~=&~reverse_host_lookup*&
26583 .cindex "&%verify%& ACL condition"
26584 .cindex "&ACL;" "verifying host reverse lookup"
26585 .cindex "host" "verifying reverse lookup"
26586 This condition ensures that a verified host name has been looked up from the IP
26587 address of the client host. (This may have happened already if the host name
26588 was needed for checking a host list, or if the host matched &%host_lookup%&.)
26589 Verification ensures that the host name obtained from a reverse DNS lookup, or
26590 one of its aliases, does, when it is itself looked up in the DNS, yield the
26591 original IP address.
26592
26593 If this condition is used for a locally generated message (that is, when there
26594 is no client host involved), it always succeeds.
26595
26596 .vitem &*verify&~=&~sender/*&<&'options'&>
26597 .cindex "&%verify%& ACL condition"
26598 .cindex "&ACL;" "verifying sender"
26599 .cindex "sender" "verifying"
26600 .cindex "verifying" "sender"
26601 This condition is relevant only after a MAIL or RCPT command, or after a
26602 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
26603 the message's sender is empty (that is, this is a bounce message), the
26604 condition is true. Otherwise, the sender address is verified.
26605
26606 .vindex "&$address_data$&"
26607 .vindex "&$sender_address_data$&"
26608 If there is data in the &$address_data$& variable at the end of routing, its
26609 value is placed in &$sender_address_data$& at the end of verification. This
26610 value can be used in subsequent conditions and modifiers in the same ACL
26611 statement. It does not persist after the end of the current statement. If you
26612 want to preserve the value for longer, you can save it in an ACL variable.
26613
26614 Details of verification are given later, starting at section
26615 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
26616 to avoid doing it more than once per message.
26617
26618 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
26619 .cindex "&%verify%& ACL condition"
26620 This is a variation of the previous option, in which a modified address is
26621 verified as a sender.
26622 .endlist
26623
26624
26625
26626 .section "Using DNS lists" "SECTmorednslists"
26627 .cindex "DNS list" "in ACL"
26628 .cindex "black list (DNS)"
26629 .cindex "&ACL;" "testing a DNS list"
26630 In its simplest form, the &%dnslists%& condition tests whether the calling host
26631 is on at least one of a number of DNS lists by looking up the inverted IP
26632 address in one or more DNS domains. (Note that DNS list domains are not mail
26633 domains, so the &`+`& syntax for named lists doesn't work - it is used for
26634 special options instead.) For example, if the calling host's IP
26635 address is 192.168.62.43, and the ACL statement is
26636 .code
26637 deny dnslists = blackholes.mail-abuse.org : \
26638                 dialups.mail-abuse.org
26639 .endd
26640 the following records are looked up:
26641 .code
26642 43.62.168.192.blackholes.mail-abuse.org
26643 43.62.168.192.dialups.mail-abuse.org
26644 .endd
26645 As soon as Exim finds an existing DNS record, processing of the list stops.
26646 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
26647 to test that a host is on more than one list (an &"and"& conjunction), you can
26648 use two separate conditions:
26649 .code
26650 deny dnslists = blackholes.mail-abuse.org
26651      dnslists = dialups.mail-abuse.org
26652 .endd
26653 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
26654 behaves as if the host does not match the list item, that is, as if the DNS
26655 record does not exist. If there are further items in the DNS list, they are
26656 processed.
26657
26658 This is usually the required action when &%dnslists%& is used with &%deny%&
26659 (which is the most common usage), because it prevents a DNS failure from
26660 blocking mail. However, you can change this behaviour by putting one of the
26661 following special items in the list:
26662 .display
26663 &`+include_unknown `&   behave as if the item is on the list
26664 &`+exclude_unknown `&   behave as if the item is not on the list (default)
26665 &`+defer_unknown   `&   give a temporary error
26666 .endd
26667 .cindex "&`+include_unknown`&"
26668 .cindex "&`+exclude_unknown`&"
26669 .cindex "&`+defer_unknown`&"
26670 Each of these applies to any subsequent items on the list. For example:
26671 .code
26672 deny dnslists = +defer_unknown : foo.bar.example
26673 .endd
26674 Testing the list of domains stops as soon as a match is found. If you want to
26675 warn for one list and block for another, you can use two different statements:
26676 .code
26677 deny  dnslists = blackholes.mail-abuse.org
26678 warn  message  = X-Warn: sending host is on dialups list
26679       dnslists = dialups.mail-abuse.org
26680 .endd
26681 DNS list lookups are cached by Exim for the duration of the SMTP session,
26682 so a lookup based on the IP address is done at most once for any incoming
26683 connection. Exim does not share information between multiple incoming
26684 connections (but your local name server cache should be active).
26685
26686
26687
26688 .section "Specifying the IP address for a DNS list lookup" "SECID201"
26689 .cindex "DNS list" "keyed by explicit IP address"
26690 By default, the IP address that is used in a DNS list lookup is the IP address
26691 of the calling host. However, you can specify another IP address by listing it
26692 after the domain name, introduced by a slash. For example:
26693 .code
26694 deny dnslists = black.list.tld/192.168.1.2
26695 .endd
26696 This feature is not very helpful with explicit IP addresses; it is intended for
26697 use with IP addresses that are looked up, for example, the IP addresses of the
26698 MX hosts or nameservers of an email sender address. For an example, see section
26699 &<<SECTmulkeyfor>>& below.
26700
26701
26702
26703
26704 .section "DNS lists keyed on domain names" "SECID202"
26705 .cindex "DNS list" "keyed by domain name"
26706 There are some lists that are keyed on domain names rather than inverted IP
26707 addresses (see for example the &'domain based zones'& link at
26708 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
26709 with these lists. You can change the name that is looked up in a DNS list by
26710 listing it after the domain name, introduced by a slash. For example,
26711 .code
26712 deny  message  = Sender's domain is listed at $dnslist_domain
26713       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
26714 .endd
26715 This particular example is useful only in ACLs that are obeyed after the
26716 RCPT or DATA commands, when a sender address is available. If (for
26717 example) the message's sender is &'user@tld.example'& the name that is looked
26718 up by this example is
26719 .code
26720 tld.example.dsn.rfc-ignorant.org
26721 .endd
26722 A single &%dnslists%& condition can contain entries for both names and IP
26723 addresses. For example:
26724 .code
26725 deny dnslists = sbl.spamhaus.org : \
26726                 dsn.rfc-ignorant.org/$sender_address_domain
26727 .endd
26728 The first item checks the sending host's IP address; the second checks a domain
26729 name. The whole condition is true if either of the DNS lookups succeeds.
26730
26731
26732
26733
26734 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
26735 .cindex "DNS list" "multiple keys for"
26736 The syntax described above for looking up explicitly-defined values (either
26737 names or IP addresses) in a DNS blacklist is a simplification. After the domain
26738 name for the DNS list, what follows the slash can in fact be a list of items.
26739 As with all lists in Exim, the default separator is a colon. However, because
26740 this is a sublist within the list of DNS blacklist domains, it is necessary
26741 either to double the separators like this:
26742 .code
26743 dnslists = black.list.tld/name.1::name.2
26744 .endd
26745 or to change the separator character, like this:
26746 .code
26747 dnslists = black.list.tld/<;name.1;name.2
26748 .endd
26749 If an item in the list is an IP address, it is inverted before the DNS
26750 blacklist domain is appended. If it is not an IP address, no inversion
26751 occurs. Consider this condition:
26752 .code
26753 dnslists = black.list.tld/<;192.168.1.2;a.domain
26754 .endd
26755 The DNS lookups that occur are:
26756 .code
26757 2.1.168.192.black.list.tld
26758 a.domain.black.list.tld
26759 .endd
26760 Once a DNS record has been found (that matches a specific IP return
26761 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
26762 are done. If there is a temporary DNS error, the rest of the sublist of domains
26763 or IP addresses is tried. A temporary error for the whole dnslists item occurs
26764 only if no other DNS lookup in this sublist succeeds. In other words, a
26765 successful lookup for any of the items in the sublist overrides a temporary
26766 error for a previous item.
26767
26768 The ability to supply a list of items after the slash is in some sense just a
26769 syntactic convenience. These two examples have the same effect:
26770 .code
26771 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
26772 dnslists = black.list.tld/a.domain::b.domain
26773 .endd
26774 However, when the data for the list is obtained from a lookup, the second form
26775 is usually much more convenient. Consider this example:
26776 .code
26777 deny message  = The mail servers for the domain \
26778                 $sender_address_domain \
26779                 are listed at $dnslist_domain ($dnslist_value); \
26780                 see $dnslist_text.
26781      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
26782                                    ${lookup dnsdb {>|mxh=\
26783                                    $sender_address_domain} }} }
26784 .endd
26785 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
26786 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
26787 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
26788 of expanding the condition might be something like this:
26789 .code
26790 dnslists = sbl.spahmaus.org/<|192.168.2.3|192.168.5.6|...
26791 .endd
26792 Thus, this example checks whether or not the IP addresses of the sender
26793 domain's mail servers are on the Spamhaus black list.
26794
26795 The key that was used for a successful DNS list lookup is put into the variable
26796 &$dnslist_matched$& (see section &<<SECID204>>&).
26797
26798
26799
26800
26801 .section "Data returned by DNS lists" "SECID203"
26802 .cindex "DNS list" "data returned from"
26803 DNS lists are constructed using address records in the DNS. The original RBL
26804 just used the address 127.0.0.1 on the right hand side of each record, but the
26805 RBL+ list and some other lists use a number of values with different meanings.
26806 The values used on the RBL+ list are:
26807 .display
26808 127.1.0.1  RBL
26809 127.1.0.2  DUL
26810 127.1.0.3  DUL and RBL
26811 127.1.0.4  RSS
26812 127.1.0.5  RSS and RBL
26813 127.1.0.6  RSS and DUL
26814 127.1.0.7  RSS and DUL and RBL
26815 .endd
26816 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
26817 different values. Some DNS lists may return more than one address record;
26818 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
26819
26820
26821 .section "Variables set from DNS lists" "SECID204"
26822 .cindex "expansion" "variables, set from DNS list"
26823 .cindex "DNS list" "variables set from"
26824 .vindex "&$dnslist_domain$&"
26825 .vindex "&$dnslist_matched$&"
26826 .vindex "&$dnslist_text$&"
26827 .vindex "&$dnslist_value$&"
26828 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
26829 the name of the overall domain that matched (for example,
26830 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
26831 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
26832 the DNS record. When the key is an IP address, it is not reversed in
26833 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
26834 cases, for example:
26835 .code
26836 deny dnslists = spamhaus.example
26837 .endd
26838 the key is also available in another variable (in this case,
26839 &$sender_host_address$&). In more complicated cases, however, this is not true.
26840 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
26841 might generate a dnslists lookup like this:
26842 .code
26843 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
26844 .endd
26845 If this condition succeeds, the value in &$dnslist_matched$& might be
26846 &`192.168.6.7`& (for example).
26847
26848 If more than one address record is returned by the DNS lookup, all the IP
26849 addresses are included in &$dnslist_value$&, separated by commas and spaces.
26850 The variable &$dnslist_text$& contains the contents of any associated TXT
26851 record. For lists such as RBL+ the TXT record for a merged entry is often not
26852 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
26853 information.
26854
26855 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
26856 &-- although these appear before the condition in the ACL, they are not
26857 expanded until after it has failed. For example:
26858 .code
26859 deny    hosts = !+local_networks
26860         message = $sender_host_address is listed \
26861                   at $dnslist_domain
26862         dnslists = rbl-plus.mail-abuse.example
26863 .endd
26864
26865
26866
26867 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
26868 .cindex "DNS list" "matching specific returned data"
26869 You can add an equals sign and an IP address after a &%dnslists%& domain name
26870 in order to restrict its action to DNS records with a matching right hand side.
26871 For example,
26872 .code
26873 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
26874 .endd
26875 rejects only those hosts that yield 127.0.0.2. Without this additional data,
26876 any address record is considered to be a match. For the moment, we assume
26877 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
26878 describes how multiple records are handled.
26879
26880 More than one IP address may be given for checking, using a comma as a
26881 separator. These are alternatives &-- if any one of them matches, the
26882 &%dnslists%& condition is true. For example:
26883 .code
26884 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
26885 .endd
26886 If you want to specify a constraining address list and also specify names or IP
26887 addresses to be looked up, the constraining address list must be specified
26888 first. For example:
26889 .code
26890 deny dnslists = dsn.rfc-ignorant.org\
26891                 =127.0.0.2/$sender_address_domain
26892 .endd
26893
26894 If the character &`&&`& is used instead of &`=`&, the comparison for each
26895 listed IP address is done by a bitwise &"and"& instead of by an equality test.
26896 In other words, the listed addresses are used as bit masks. The comparison is
26897 true if all the bits in the mask are present in the address that is being
26898 tested. For example:
26899 .code
26900 dnslists = a.b.c&0.0.0.3
26901 .endd
26902 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
26903 want to test whether one bit or another bit is present (as opposed to both
26904 being present), you must use multiple values. For example:
26905 .code
26906 dnslists = a.b.c&0.0.0.1,0.0.0.2
26907 .endd
26908 matches if the final component of the address is an odd number or two times
26909 an odd number.
26910
26911
26912
26913 .section "Negated DNS matching conditions" "SECID205"
26914 You can supply a negative list of IP addresses as part of a &%dnslists%&
26915 condition. Whereas
26916 .code
26917 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
26918 .endd
26919 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
26920 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
26921 .code
26922 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
26923 .endd
26924 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
26925 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
26926 words, the result of the test is inverted if an exclamation mark appears before
26927 the &`=`& (or the &`&&`&) sign.
26928
26929 &*Note*&: This kind of negation is not the same as negation in a domain,
26930 host, or address list (which is why the syntax is different).
26931
26932 If you are using just one list, the negation syntax does not gain you much. The
26933 previous example is precisely equivalent to
26934 .code
26935 deny  dnslists = a.b.c
26936      !dnslists = a.b.c=127.0.0.2,127.0.0.3
26937 .endd
26938 However, if you are using multiple lists, the negation syntax is clearer.
26939 Consider this example:
26940 .code
26941 deny  dnslists = sbl.spamhaus.org : \
26942                  list.dsbl.org : \
26943                  dnsbl.njabl.org!=127.0.0.3 : \
26944                  relays.ordb.org
26945 .endd
26946 Using only positive lists, this would have to be:
26947 .code
26948 deny  dnslists = sbl.spamhaus.org : \
26949                  list.dsbl.org
26950 deny  dnslists = dnsbl.njabl.org
26951      !dnslists = dnsbl.njabl.org=127.0.0.3
26952 deny  dnslists = relays.ordb.org
26953 .endd
26954 which is less clear, and harder to maintain.
26955
26956
26957
26958
26959 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
26960 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
26961 thereby providing more than one IP address. When an item in a &%dnslists%& list
26962 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
26963 the match to specific results from the DNS lookup, there are two ways in which
26964 the checking can be handled. For example, consider the condition:
26965 .code
26966 dnslists = a.b.c=127.0.0.1
26967 .endd
26968 What happens if the DNS lookup for the incoming IP address yields both
26969 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
26970 condition true because at least one given value was found, or is it false
26971 because at least one of the found values was not listed? And how does this
26972 affect negated conditions? Both possibilities are provided for with the help of
26973 additional separators &`==`& and &`=&&`&.
26974
26975 .ilist
26976 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
26977 IP addresses matches one of the listed addresses. For the example above, the
26978 condition is true because 127.0.0.1 matches.
26979 .next
26980 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
26981 looked up IP addresses matches one of the listed addresses. If the condition is
26982 changed to:
26983 .code
26984 dnslists = a.b.c==127.0.0.1
26985 .endd
26986 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
26987 false because 127.0.0.2 is not listed. You would need to have:
26988 .code
26989 dnslists = a.b.c==127.0.0.1,127.0.0.2
26990 .endd
26991 for the condition to be true.
26992 .endlist
26993
26994 When &`!`& is used to negate IP address matching, it inverts the result, giving
26995 the precise opposite of the behaviour above. Thus:
26996 .ilist
26997 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
26998 addresses matches one of the listed addresses. Consider:
26999 .code
27000 dnslists = a.b.c!&0.0.0.1
27001 .endd
27002 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
27003 false because 127.0.0.1 matches.
27004 .next
27005 If &`!==`& or &`!=&&`& is used, the condition is true there is at least one
27006 looked up IP address that does not match. Consider:
27007 .code
27008 dnslists = a.b.c!=&0.0.0.1
27009 .endd
27010 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
27011 true, because 127.0.0.2 does not match. You would need to have:
27012 .code
27013 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
27014 .endd
27015 for the condition to be false.
27016 .endlist
27017 When the DNS lookup yields only a single IP address, there is no difference
27018 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
27019
27020
27021
27022
27023 .section "Detailed information from merged DNS lists" "SECTmordetinf"
27024 .cindex "DNS list" "information from merged"
27025 When the facility for restricting the matching IP values in a DNS list is used,
27026 the text from the TXT record that is set in &$dnslist_text$& may not reflect
27027 the true reason for rejection. This happens when lists are merged and the IP
27028 address in the A record is used to distinguish them; unfortunately there is
27029 only one TXT record. One way round this is not to use merged lists, but that
27030 can be inefficient because it requires multiple DNS lookups where one would do
27031 in the vast majority of cases when the host of interest is not on any of the
27032 lists.
27033
27034 A less inefficient way of solving this problem is available. If
27035 two domain names, comma-separated, are given, the second is used first to
27036 do an initial check, making use of any IP value restrictions that are set.
27037 If there is a match, the first domain is used, without any IP value
27038 restrictions, to get the TXT record. As a byproduct of this, there is also
27039 a check that the IP being tested is indeed on the first list. The first
27040 domain is the one that is put in &$dnslist_domain$&. For example:
27041 .code
27042 reject message  = \
27043          rejected because $sender_host_address is blacklisted \
27044          at $dnslist_domain\n$dnslist_text
27045        dnslists = \
27046          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
27047          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
27048 .endd
27049 For the first blacklist item, this starts by doing a lookup in
27050 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
27051 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
27052 value, and as long as something is found, it looks for the corresponding TXT
27053 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
27054 The second blacklist item is processed similarly.
27055
27056 If you are interested in more than one merged list, the same list must be
27057 given several times, but because the results of the DNS lookups are cached,
27058 the DNS calls themselves are not repeated. For example:
27059 .code
27060 reject dnslists = \
27061          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
27062          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
27063          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
27064          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
27065 .endd
27066 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
27067 values matches (or if no record is found), this is the only lookup that is
27068 done. Only if there is a match is one of the more specific lists consulted.
27069
27070
27071
27072 .section "DNS lists and IPv6" "SECTmorednslistslast"
27073 .cindex "IPv6" "DNS black lists"
27074 .cindex "DNS list" "IPv6 usage"
27075 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
27076 nibble by nibble. For example, if the calling host's IP address is
27077 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
27078 .code
27079 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
27080   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
27081 .endd
27082 (split over two lines here to fit on the page). Unfortunately, some of the DNS
27083 lists contain wildcard records, intended for IPv4, that interact badly with
27084 IPv6. For example, the DNS entry
27085 .code
27086 *.3.some.list.example.    A    127.0.0.1
27087 .endd
27088 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
27089 Unfortunately, it also matches the entire 3::/4 IPv6 network.
27090
27091 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
27092 &%condition%& condition, as in this example:
27093 .code
27094 deny   condition = ${if isip4{$sender_host_address}}
27095        dnslists  = some.list.example
27096 .endd
27097
27098 .section "Rate limiting incoming messages" "SECTratelimiting"
27099 .cindex "rate limiting" "client sending"
27100 .cindex "limiting client sending rates"
27101 .oindex "&%smtp_ratelimit_*%&"
27102 The &%ratelimit%& ACL condition can be used to measure and control the rate at
27103 which clients can send email. This is more powerful than the
27104 &%smtp_ratelimit_*%& options, because those options control the rate of
27105 commands in a single SMTP session only, whereas the &%ratelimit%& condition
27106 works across all connections (concurrent and sequential) from the same client
27107 host. The syntax of the &%ratelimit%& condition is:
27108 .display
27109 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
27110 .endd
27111 If the average client sending rate is less than &'m'& messages per time
27112 period &'p'& then the condition is false; otherwise it is true.
27113
27114 As a side-effect, the &%ratelimit%& condition sets the expansion variable
27115 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
27116 configured value of &'m'&, and &$sender_rate_period$& to the configured value
27117 of &'p'&.
27118
27119 The parameter &'p'& is the smoothing time constant, in the form of an Exim
27120 time interval, for example, &`8h`& for eight hours. A larger time constant
27121 means that it takes Exim longer to forget a client's past behaviour. The
27122 parameter &'m'& is the maximum number of messages that a client is permitted to
27123 send in each time interval. It also specifies the number of messages permitted
27124 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
27125 constant, you can allow a client to send more messages in a burst without
27126 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
27127 both small, messages must be sent at an even rate.
27128
27129 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
27130 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
27131 when deploying the &%ratelimit%& ACL condition. The script prints usage
27132 instructions when it is run with no arguments.
27133
27134 The key is used to look up the data for calculating the client's average
27135 sending rate. This data is stored in Exim's spool directory, alongside the
27136 retry and other hints databases. The default key is &$sender_host_address$&,
27137 which means Exim computes the sending rate of each client host IP address.
27138 By changing the key you can change how Exim identifies clients for the purpose
27139 of ratelimiting. For example, to limit the sending rate of each authenticated
27140 user, independent of the computer they are sending from, set the key to
27141 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
27142 example, &$authenticated_id$& is only meaningful if the client has
27143 authenticated (which you can check with the &%authenticated%& ACL condition).
27144
27145 The lookup key does not have to identify clients: If you want to limit the
27146 rate at which a recipient receives messages, you can use the key
27147 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
27148 ACL.
27149
27150 Internally, Exim appends the smoothing constant &'p'& and the options onto the
27151 lookup key because they alter the meaning of the stored data. This is not true
27152 for the limit &'m'&, so you can alter the configured maximum rate and Exim will
27153 still remember clients' past behaviour, but if you alter the other ratelimit
27154 parameters Exim forgets past behaviour.
27155
27156 Each &%ratelimit%& condition can have up to three options. One option
27157 specifies what Exim measures the rate of, and the second specifies how Exim
27158 handles excessively fast clients. The third option can be &`noupdate`&, to
27159 disable updating of the ratelimiting database (see section &<<rearatdat>>&).
27160 The options are separated by a slash, like the other parameters. They may
27161 appear in any order.
27162
27163 .section "Ratelimit options for what is being measured" "ratoptmea"
27164 The &%per_conn%& option limits the client's connection rate.
27165
27166 The &%per_mail%& option limits the client's rate of sending messages. This is
27167 the default if none of the &%per_*%& options is specified.
27168
27169 The &%per_byte%& option limits the sender's email bandwidth. Note that it is
27170 best to use this option in the DATA ACL; if it is used in an earlier ACL it
27171 relies on the SIZE parameter specified by the client in its MAIL command,
27172 which may be inaccurate or completely missing. You can follow the limit &'m'&
27173 in the configuration with K, M, or G to specify limits in kilobytes,
27174 megabytes, or gigabytes, respectively.
27175
27176 The &%per_rcpt%& option causes Exim to limit the rate at which
27177 recipients are accepted. To be effective, it would need to be used in
27178 either the &%acl_smtp_rcpt%& or the &%acl_not_smtp%& ACL. In the
27179 &%acl_smtp_rcpt%& ACL, the number of recipients is incremented by one.
27180 In the case of a locally submitted message in the &%acl_not_smtp%& ACL,
27181 the number of recipients is incremented by the &%$recipients_count%&
27182 for the entire message. Note that in either case the rate limiting
27183 engine will see a message with many recipients as a large high-speed
27184 burst.
27185
27186 The &%per_cmd%& option causes Exim to recompute the rate every time the
27187 condition is processed. This can be used to limit the SMTP command rate.
27188 This command is essentially an alias of &%per_rcpt%& to make it clear
27189 that the effect is to limit the rate at which individual commands,
27190 rather than recipients, are accepted.
27191
27192 .section "Ratelimit options for handling fast clients" "ratophanfas"
27193 If a client's average rate is greater than the maximum, the rate limiting
27194 engine can react in two possible ways, depending on the presence of the
27195 &%strict%& or &%leaky%& options. This is independent of the other
27196 counter-measures (such as rejecting the message) that may be specified by the
27197 rest of the ACL. The default mode is leaky, which avoids a sender's
27198 over-aggressive retry rate preventing it from getting any email through.
27199
27200 The &%strict%& option means that the client's recorded rate is always
27201 updated. The effect of this is that Exim measures the client's average rate
27202 of attempts to send email, which can be much higher than the maximum it is
27203 actually allowed. If the client is over the limit it may be subjected to
27204 counter-measures by the ACL until it slows down below the maximum rate. If
27205 the client stops attempting to send email for the time specified in the &'p'&
27206 parameter then its computed rate will decay exponentially to 37% of its peak
27207 value. You can work out the time (the number of smoothing periods) that a
27208 client is subjected to counter-measures after an over-limit burst with this
27209 formula:
27210 .code
27211         ln(peakrate/maxrate)
27212 .endd
27213 The &%leaky%& (default) option means that the client's recorded rate is not
27214 updated if it is above the limit. The effect of this is that Exim measures the
27215 client's average rate of successfully sent email, which cannot be greater than
27216 the maximum allowed. If the client is over the limit it may suffer some
27217 counter-measures (as specified in the ACL), but it will still be able to send
27218 email at the configured maximum rate, whatever the rate of its attempts. This
27219 is generally the better choice if you have clients that retry automatically.
27220
27221 .section "Using rate limiting" "useratlim"
27222 Exim's other ACL facilities are used to define what counter-measures are taken
27223 when the rate limit is exceeded. This might be anything from logging a warning
27224 (for example, while measuring existing sending rates in order to define
27225 policy), through time delays to slow down fast senders, up to rejecting the
27226 message. For example:
27227 .code
27228 # Log all senders' rates
27229 warn ratelimit = 0 / 1h / strict
27230      log_message = Sender rate $sender_rate / $sender_rate_period
27231
27232 # Slow down fast senders; note the need to truncate $sender_rate
27233 # at the decimal point.
27234 warn ratelimit = 100 / 1h / per_rcpt / strict
27235      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
27236                    $sender_rate_limit }s
27237
27238 # Keep authenticated users under control
27239 deny authenticated = *
27240      ratelimit = 100 / 1d / strict / $authenticated_id
27241
27242 # System-wide rate limit
27243 defer message = Sorry, too busy. Try again later.
27244      ratelimit = 10 / 1s / $primary_hostname
27245
27246 # Restrict incoming rate from each host, with a default
27247 # set using a macro and special cases looked up in a table.
27248 defer message = Sender rate exceeds $sender_rate_limit \
27249                messages per $sender_rate_period
27250      ratelimit = ${lookup {$sender_host_address} \
27251                    cdb {DB/ratelimits.cdb} \
27252                    {$value} {RATELIMIT} }
27253 .endd
27254 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
27255 especially with the &%per_rcpt%& option, you may suffer from a performance
27256 bottleneck caused by locking on the ratelimit hints database. Apart from
27257 making your ACLs less complicated, you can reduce the problem by using a
27258 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
27259 this means that Exim will lose its hints data after a reboot (including retry
27260 hints, the callout cache, and ratelimit data).
27261
27262
27263 .section "Reading ratelimit data without updating" "rearatdat"
27264 .cindex "rate limitint" "reading data without updating"
27265 If the &%noupdate%& option is present on a &%ratelimit%& ACL condition, Exim
27266 computes the rate and checks the limit as normal, but it does not update the
27267 saved data. This means that, in relevant ACLs, it is possible to lookup the
27268 existence of a specified (or auto-generated) ratelimit key without incrementing
27269 the ratelimit counter for that key. In order for this to be useful, another ACL
27270 entry must set the rate for the same key (otherwise it will always be zero).
27271 For example:
27272 .code
27273 acl_check_connect:
27274   deny ratelimit = 100 / 5m / strict / per_cmd / noupdate
27275        log_message = RATE: $sender_rate/$sender_rate_period \
27276                      (max $sender_rate_limit)
27277 .endd
27278 .display
27279 &'... some other logic and tests...'&
27280 .endd
27281 .code
27282 acl_check_mail:
27283   warn ratelimit = 100 / 5m / strict / per_cmd
27284        condition = ${if le{$sender_rate}{$sender_rate_limit}}
27285        logwrite  = RATE UPDATE: $sender_rate/$sender_rate_period \
27286                      (max $sender_rate_limit)
27287 .endd
27288 In this example, the rate is tested and used to deny access (when it is too
27289 high) in the connect ACL, but the actual computation of the remembered rate
27290 happens later, on a per-command basis, in another ACL.
27291
27292
27293
27294 .section "Address verification" "SECTaddressverification"
27295 .cindex "verifying address" "options for"
27296 .cindex "policy control" "address verification"
27297 Several of the &%verify%& conditions described in section
27298 &<<SECTaclconditions>>& cause addresses to be verified. Section
27299 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
27300 The verification conditions can be followed by options that modify the
27301 verification process. The options are separated from the keyword and from each
27302 other by slashes, and some of them contain parameters. For example:
27303 .code
27304 verify = sender/callout
27305 verify = recipient/defer_ok/callout=10s,defer_ok
27306 .endd
27307 The first stage of address verification, which always happens, is to run the
27308 address through the routers, in &"verify mode"&. Routers can detect the
27309 difference between verification and routing for delivery, and their actions can
27310 be varied by a number of generic options such as &%verify%& and &%verify_only%&
27311 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
27312 The available options are as follows:
27313
27314 .ilist
27315 If the &%callout%& option is specified, successful routing to one or more
27316 remote hosts is followed by a &"callout"& to those hosts as an additional
27317 check. Callouts and their sub-options are discussed in the next section.
27318 .next
27319 If there is a defer error while doing verification routing, the ACL
27320 normally returns &"defer"&. However, if you include &%defer_ok%& in the
27321 options, the condition is forced to be true instead. Note that this is a main
27322 verification option as well as a suboption for callouts.
27323 .next
27324 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
27325 discusses the reporting of sender address verification failures.
27326 .next
27327 The &%success_on_redirect%& option causes verification always to succeed
27328 immediately after a successful redirection. By default, if a redirection
27329 generates just one address, that address is also verified. See further
27330 discussion in section &<<SECTredirwhilveri>>&.
27331 .endlist
27332
27333 .cindex "verifying address" "differentiating failures"
27334 .vindex "&$recipient_verify_failure$&"
27335 .vindex "&$sender_verify_failure$&"
27336 .vindex "&$acl_verify_message$&"
27337 After an address verification failure, &$acl_verify_message$& contains the
27338 error message that is associated with the failure. It can be preserved by
27339 coding like this:
27340 .code
27341 warn  !verify = sender
27342        set acl_m0 = $acl_verify_message
27343 .endd
27344 If you are writing your own custom rejection message or log message when
27345 denying access, you can use this variable to include information about the
27346 verification failure.
27347
27348 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
27349 appropriate) contains one of the following words:
27350
27351 .ilist
27352 &%qualify%&: The address was unqualified (no domain), and the message
27353 was neither local nor came from an exempted host.
27354 .next
27355 &%route%&: Routing failed.
27356 .next
27357 &%mail%&: Routing succeeded, and a callout was attempted; rejection
27358 occurred at or before the MAIL command (that is, on initial
27359 connection, HELO, or MAIL).
27360 .next
27361 &%recipient%&: The RCPT command in a callout was rejected.
27362 .next
27363 &%postmaster%&: The postmaster check in a callout was rejected.
27364 .endlist
27365
27366 The main use of these variables is expected to be to distinguish between
27367 rejections of MAIL and rejections of RCPT in callouts.
27368
27369
27370
27371
27372 .section "Callout verification" "SECTcallver"
27373 .cindex "verifying address" "by callout"
27374 .cindex "callout" "verification"
27375 .cindex "SMTP" "callout verification"
27376 For non-local addresses, routing verifies the domain, but is unable to do any
27377 checking of the local part. There are situations where some means of verifying
27378 the local part is desirable. One way this can be done is to make an SMTP
27379 &'callback'& to a delivery host for the sender address or a &'callforward'& to
27380 a subsequent host for a recipient address, to see if the host accepts the
27381 address. We use the term &'callout'& to cover both cases. Note that for a
27382 sender address, the callback is not to the client host that is trying to
27383 deliver the message, but to one of the hosts that accepts incoming mail for the
27384 sender's domain.
27385
27386 Exim does not do callouts by default. If you want them to happen, you must
27387 request them by setting appropriate options on the &%verify%& condition, as
27388 described below. This facility should be used with care, because it can add a
27389 lot of resource usage to the cost of verifying an address. However, Exim does
27390 cache the results of callouts, which helps to reduce the cost. Details of
27391 caching are in section &<<SECTcallvercache>>&.
27392
27393 Recipient callouts are usually used only between hosts that are controlled by
27394 the same administration. For example, a corporate gateway host could use
27395 callouts to check for valid recipients on an internal mailserver. A successful
27396 callout does not guarantee that a real delivery to the address would succeed;
27397 on the other hand, a failing callout does guarantee that a delivery would fail.
27398
27399 If the &%callout%& option is present on a condition that verifies an address, a
27400 second stage of verification occurs if the address is successfully routed to
27401 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
27402 &(manualroute)& router, where the router specifies the hosts. However, if a
27403 router that does not set up hosts routes to an &(smtp)& transport with a
27404 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
27405 &%hosts_override%& set, its hosts are always used, whether or not the router
27406 supplies a host list.
27407
27408 The port that is used is taken from the transport, if it is specified and is a
27409 remote transport. (For routers that do verification only, no transport need be
27410 specified.) Otherwise, the default SMTP port is used. If a remote transport
27411 specifies an outgoing interface, this is used; otherwise the interface is not
27412 specified. Likewise, the text that is used for the HELO command is taken from
27413 the transport's &%helo_data%& option; if there is no transport, the value of
27414 &$smtp_active_hostname$& is used.
27415
27416 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
27417 test whether a bounce message could be delivered to the sender address. The
27418 following SMTP commands are sent:
27419 .display
27420 &`HELO `&<&'local host name'&>
27421 &`MAIL FROM:<>`&
27422 &`RCPT TO:`&<&'the address to be tested'&>
27423 &`QUIT`&
27424 .endd
27425 LHLO is used instead of HELO if the transport's &%protocol%& option is
27426 set to &"lmtp"&.
27427
27428 A recipient callout check is similar. By default, it also uses an empty address
27429 for the sender. This default is chosen because most hosts do not make use of
27430 the sender address when verifying a recipient. Using the same address means
27431 that a single cache entry can be used for each recipient. Some sites, however,
27432 do make use of the sender address when verifying. These are catered for by the
27433 &%use_sender%& and &%use_postmaster%& options, described in the next section.
27434
27435 If the response to the RCPT command is a 2&'xx'& code, the verification
27436 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
27437 Exim tries the next host, if any. If there is a problem with all the remote
27438 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
27439 &%callout%& option is given, in which case the condition is forced to succeed.
27440
27441 .cindex "SMTP" "output flushing, disabling for callout"
27442 A callout may take a little time. For this reason, Exim normally flushes SMTP
27443 output before performing a callout in an ACL, to avoid unexpected timeouts in
27444 clients when the SMTP PIPELINING extension is in use. The flushing can be
27445 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
27446
27447
27448
27449
27450 .section "Additional parameters for callouts" "CALLaddparcall"
27451 .cindex "callout" "additional parameters for"
27452 The &%callout%& option can be followed by an equals sign and a number of
27453 optional parameters, separated by commas. For example:
27454 .code
27455 verify = recipient/callout=10s,defer_ok
27456 .endd
27457 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
27458 separate verify options, is retained for backwards compatibility, but is now
27459 deprecated. The additional parameters for &%callout%& are as follows:
27460
27461
27462 .vlist
27463 .vitem <&'a&~time&~interval'&>
27464 .cindex "callout" "timeout, specifying"
27465 This specifies the timeout that applies for the callout attempt to each host.
27466 For example:
27467 .code
27468 verify = sender/callout=5s
27469 .endd
27470 The default is 30 seconds. The timeout is used for each response from the
27471 remote host. It is also used for the initial connection, unless overridden by
27472 the &%connect%& parameter.
27473
27474
27475 .vitem &*connect&~=&~*&<&'time&~interval'&>
27476 .cindex "callout" "connection timeout, specifying"
27477 This parameter makes it possible to set a different (usually smaller) timeout
27478 for making the SMTP connection. For example:
27479 .code
27480 verify = sender/callout=5s,connect=1s
27481 .endd
27482 If not specified, this timeout defaults to the general timeout value.
27483
27484 .vitem &*defer_ok*&
27485 .cindex "callout" "defer, action on"
27486 When this parameter is present, failure to contact any host, or any other kind
27487 of temporary error, is treated as success by the ACL. However, the cache is not
27488 updated in this circumstance.
27489
27490 .vitem &*fullpostmaster*&
27491 .cindex "callout" "full postmaster check"
27492 This operates like the &%postmaster%& option (see below), but if the check for
27493 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
27494 accordance with the specification in RFC 2821. The RFC states that the
27495 unqualified address &'postmaster'& should be accepted.
27496
27497
27498 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
27499 .cindex "callout" "sender when verifying header"
27500 When verifying addresses in header lines using the &%header_sender%&
27501 verification option, Exim behaves by default as if the addresses are envelope
27502 sender addresses from a message. Callout verification therefore tests to see
27503 whether a bounce message could be delivered, by using an empty address in the
27504 MAIL command. However, it is arguable that these addresses might never be used
27505 as envelope senders, and could therefore justifiably reject bounce messages
27506 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
27507 address to use in the MAIL command. For example:
27508 .code
27509 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
27510 .endd
27511 This parameter is available only for the &%header_sender%& verification option.
27512
27513
27514 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
27515 .cindex "callout" "overall timeout, specifying"
27516 This parameter sets an overall timeout for performing a callout verification.
27517 For example:
27518 .code
27519 verify = sender/callout=5s,maxwait=30s
27520 .endd
27521 This timeout defaults to four times the callout timeout for individual SMTP
27522 commands. The overall timeout applies when there is more than one host that can
27523 be tried. The timeout is checked before trying the next host. This prevents
27524 very long delays if there are a large number of hosts and all are timing out
27525 (for example, when network connections are timing out).
27526
27527
27528 .vitem &*no_cache*&
27529 .cindex "callout" "cache, suppressing"
27530 .cindex "caching callout, suppressing"
27531 When this parameter is given, the callout cache is neither read nor updated.
27532
27533 .vitem &*postmaster*&
27534 .cindex "callout" "postmaster; checking"
27535 When this parameter is set, a successful callout check is followed by a similar
27536 check for the local part &'postmaster'& at the same domain. If this address is
27537 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
27538 the postmaster check is recorded in a cache record; if it is a failure, this is
27539 used to fail subsequent callouts for the domain without a connection being
27540 made, until the cache record expires.
27541
27542 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
27543 The postmaster check uses an empty sender in the MAIL command by default.
27544 You can use this parameter to do a postmaster check using a different address.
27545 For example:
27546 .code
27547 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
27548 .endd
27549 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
27550 one overrides. The &%postmaster%& parameter is equivalent to this example:
27551 .code
27552 require  verify = sender/callout=postmaster_mailfrom=
27553 .endd
27554 &*Warning*&: The caching arrangements for postmaster checking do not take
27555 account of the sender address. It is assumed that either the empty address or
27556 a fixed non-empty address will be used. All that Exim remembers is that the
27557 postmaster check for the domain succeeded or failed.
27558
27559
27560 .vitem &*random*&
27561 .cindex "callout" "&""random""& check"
27562 When this parameter is set, before doing the normal callout check, Exim does a
27563 check for a &"random"& local part at the same domain. The local part is not
27564 really random &-- it is defined by the expansion of the option
27565 &%callout_random_local_part%&, which defaults to
27566 .code
27567 $primary_host_name-$tod_epoch-testing
27568 .endd
27569 The idea here is to try to determine whether the remote host accepts all local
27570 parts without checking. If it does, there is no point in doing callouts for
27571 specific local parts. If the &"random"& check succeeds, the result is saved in
27572 a cache record, and used to force the current and subsequent callout checks to
27573 succeed without a connection being made, until the cache record expires.
27574
27575 .vitem &*use_postmaster*&
27576 .cindex "callout" "sender for recipient check"
27577 This parameter applies to recipient callouts only. For example:
27578 .code
27579 deny  !verify = recipient/callout=use_postmaster
27580 .endd
27581 .vindex "&$qualify_domain$&"
27582 It causes a non-empty postmaster address to be used in the MAIL command when
27583 performing the callout for the recipient, and also for a &"random"& check if
27584 that is configured. The local part of the address is &`postmaster`& and the
27585 domain is the contents of &$qualify_domain$&.
27586
27587 .vitem &*use_sender*&
27588 This option applies to recipient callouts only. For example:
27589 .code
27590 require  verify = recipient/callout=use_sender
27591 .endd
27592 It causes the message's actual sender address to be used in the MAIL
27593 command when performing the callout, instead of an empty address. There is no
27594 need to use this option unless you know that the called hosts make use of the
27595 sender when checking recipients. If used indiscriminately, it reduces the
27596 usefulness of callout caching.
27597 .endlist
27598
27599 If you use any of the parameters that set a non-empty sender for the MAIL
27600 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
27601 &%use_sender%&), you should think about possible loops. Recipient checking is
27602 usually done between two hosts that are under the same management, and the host
27603 that receives the callouts is not normally configured to do callouts itself.
27604 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
27605 these circumstances.
27606
27607 However, if you use a non-empty sender address for a callout to an arbitrary
27608 host, there is the likelihood that the remote host will itself initiate a
27609 callout check back to your host. As it is checking what appears to be a message
27610 sender, it is likely to use an empty address in MAIL, thus avoiding a
27611 callout loop. However, to be on the safe side it would be best to set up your
27612 own ACLs so that they do not do sender verification checks when the recipient
27613 is the address you use for header sender or postmaster callout checking.
27614
27615 Another issue to think about when using non-empty senders for callouts is
27616 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
27617 by the sender/recipient combination; thus, for any given recipient, many more
27618 actual callouts are performed than when an empty sender or postmaster is used.
27619
27620
27621
27622
27623 .section "Callout caching" "SECTcallvercache"
27624 .cindex "hints database" "callout cache"
27625 .cindex "callout" "cache, description of"
27626 .cindex "caching" "callout"
27627 Exim caches the results of callouts in order to reduce the amount of resources
27628 used, unless you specify the &%no_cache%& parameter with the &%callout%&
27629 option. A hints database called &"callout"& is used for the cache. Two
27630 different record types are used: one records the result of a callout check for
27631 a specific address, and the other records information that applies to the
27632 entire domain (for example, that it accepts the local part &'postmaster'&).
27633
27634 When an original callout fails, a detailed SMTP error message is given about
27635 the failure. However, for subsequent failures use the cache data, this message
27636 is not available.
27637
27638 The expiry times for negative and positive address cache records are
27639 independent, and can be set by the global options &%callout_negative_expire%&
27640 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
27641
27642 If a host gives a negative response to an SMTP connection, or rejects any
27643 commands up to and including
27644 .code
27645 MAIL FROM:<>
27646 .endd
27647 (but not including the MAIL command with a non-empty address),
27648 any callout attempt is bound to fail. Exim remembers such failures in a
27649 domain cache record, which it uses to fail callouts for the domain without
27650 making new connections, until the domain record times out. There are two
27651 separate expiry times for domain cache records:
27652 &%callout_domain_negative_expire%& (default 3h) and
27653 &%callout_domain_positive_expire%& (default 7d).
27654
27655 Domain records expire when the negative expiry time is reached if callouts
27656 cannot be made for the domain, or if the postmaster check failed.
27657 Otherwise, they expire when the positive expiry time is reached. This
27658 ensures that, for example, a host that stops accepting &"random"& local parts
27659 will eventually be noticed.
27660
27661 The callout caching mechanism is based on the domain of the address that is
27662 being tested. If the domain routes to several hosts, it is assumed that their
27663 behaviour will be the same.
27664
27665
27666
27667 .section "Sender address verification reporting" "SECTsenaddver"
27668 .cindex "verifying" "suppressing error details"
27669 See section &<<SECTaddressverification>>& for a general discussion of
27670 verification. When sender verification fails in an ACL, the details of the
27671 failure are given as additional output lines before the 550 response to the
27672 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
27673 you might see:
27674 .code
27675 MAIL FROM:<xyz@abc.example>
27676 250 OK
27677 RCPT TO:<pqr@def.example>
27678 550-Verification failed for <xyz@abc.example>
27679 550-Called:   192.168.34.43
27680 550-Sent:     RCPT TO:<xyz@abc.example>
27681 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
27682 550 Sender verification failed
27683 .endd
27684 If more than one RCPT command fails in the same way, the details are given
27685 only for the first of them. However, some administrators do not want to send
27686 out this much information. You can suppress the details by adding
27687 &`/no_details`& to the ACL statement that requests sender verification. For
27688 example:
27689 .code
27690 verify = sender/no_details
27691 .endd
27692
27693 .section "Redirection while verifying" "SECTredirwhilveri"
27694 .cindex "verifying" "redirection while"
27695 .cindex "address redirection" "while verifying"
27696 A dilemma arises when a local address is redirected by aliasing or forwarding
27697 during verification: should the generated addresses themselves be verified,
27698 or should the successful expansion of the original address be enough to verify
27699 it? By default, Exim takes the following pragmatic approach:
27700
27701 .ilist
27702 When an incoming address is redirected to just one child address, verification
27703 continues with the child address, and if that fails to verify, the original
27704 verification also fails.
27705 .next
27706 When an incoming address is redirected to more than one child address,
27707 verification does not continue. A success result is returned.
27708 .endlist
27709
27710 This seems the most reasonable behaviour for the common use of aliasing as a
27711 way of redirecting different local parts to the same mailbox. It means, for
27712 example, that a pair of alias entries of the form
27713 .code
27714 A.Wol:   aw123
27715 aw123:   :fail: Gone away, no forwarding address
27716 .endd
27717 work as expected, with both local parts causing verification failure. When a
27718 redirection generates more than one address, the behaviour is more like a
27719 mailing list, where the existence of the alias itself is sufficient for
27720 verification to succeed.
27721
27722 It is possible, however, to change the default behaviour so that all successful
27723 redirections count as successful verifications, however many new addresses are
27724 generated. This is specified by the &%success_on_redirect%& verification
27725 option. For example:
27726 .code
27727 require verify = recipient/success_on_redirect/callout=10s
27728 .endd
27729 In this example, verification succeeds if a router generates a new address, and
27730 the callout does not occur, because no address was routed to a remote host.
27731
27732 When verification is being tested via the &%-bv%& option, the treatment of
27733 redirections is as just described, unless the &%-v%& or any debugging option is
27734 also specified. In that case, full verification is done for every generated
27735 address and a report is output for each of them.
27736
27737
27738
27739 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
27740 .cindex "CSA" "verifying"
27741 Client SMTP Authorization is a system that allows a site to advertise
27742 which machines are and are not permitted to send email. This is done by placing
27743 special SRV records in the DNS; these are looked up using the client's HELO
27744 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
27745 Authorization checks in Exim are performed by the ACL condition:
27746 .code
27747 verify = csa
27748 .endd
27749 This fails if the client is not authorized. If there is a DNS problem, or if no
27750 valid CSA SRV record is found, or if the client is authorized, the condition
27751 succeeds. These three cases can be distinguished using the expansion variable
27752 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
27753 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
27754 be likely to cause problems for legitimate email.
27755
27756 The error messages produced by the CSA code include slightly more
27757 detail. If &$csa_status$& is &"defer"&, this may be because of problems
27758 looking up the CSA SRV record, or problems looking up the CSA target
27759 address record. There are four reasons for &$csa_status$& being &"fail"&:
27760
27761 .ilist
27762 The client's host name is explicitly not authorized.
27763 .next
27764 The client's IP address does not match any of the CSA target IP addresses.
27765 .next
27766 The client's host name is authorized but it has no valid target IP addresses
27767 (for example, the target's addresses are IPv6 and the client is using IPv4).
27768 .next
27769 The client's host name has no CSA SRV record but a parent domain has asserted
27770 that all subdomains must be explicitly authorized.
27771 .endlist
27772
27773 The &%csa%& verification condition can take an argument which is the domain to
27774 use for the DNS query. The default is:
27775 .code
27776 verify = csa/$sender_helo_name
27777 .endd
27778 This implementation includes an extension to CSA. If the query domain
27779 is an address literal such as [192.0.2.95], or if it is a bare IP
27780 address, Exim searches for CSA SRV records in the reverse DNS as if
27781 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
27782 meaningful to say:
27783 .code
27784 verify = csa/$sender_host_address
27785 .endd
27786 In fact, this is the check that Exim performs if the client does not say HELO.
27787 This extension can be turned off by setting the main configuration option
27788 &%dns_csa_use_reverse%& to be false.
27789
27790 If a CSA SRV record is not found for the domain itself, a search
27791 is performed through its parent domains for a record which might be
27792 making assertions about subdomains. The maximum depth of this search is limited
27793 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
27794 default. Exim does not look for CSA SRV records in a top level domain, so the
27795 default settings handle HELO domains as long as seven
27796 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
27797 of legitimate HELO domains.
27798
27799 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
27800 direct SRV lookups, this is not sufficient because of the extra parent domain
27801 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
27802 addresses into lookups in the reverse DNS space. The result of a successful
27803 lookup such as:
27804 .code
27805 ${lookup dnsdb {csa=$sender_helo_name}}
27806 .endd
27807 has two space-separated fields: an authorization code and a target host name.
27808 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
27809 authorization required but absent, or &"?"& for unknown.
27810
27811
27812
27813
27814 .section "Bounce address tag validation" "SECTverifyPRVS"
27815 .cindex "BATV, verifying"
27816 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
27817 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
27818 Genuine incoming bounce messages should therefore always be addressed to
27819 recipients that have a valid tag. This scheme is a way of detecting unwanted
27820 bounce messages caused by sender address forgeries (often called &"collateral
27821 spam"&), because the recipients of such messages do not include valid tags.
27822
27823 There are two expansion items to help with the implementation of the BATV
27824 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
27825 the original envelope sender address by using a simple key to add a hash of the
27826 address and some time-based randomizing information. The &%prvs%& expansion
27827 item creates a signed address, and the &%prvscheck%& expansion item checks one.
27828 The syntax of these expansion items is described in section
27829 &<<SECTexpansionitems>>&.
27830
27831 As an example, suppose the secret per-address keys are stored in an MySQL
27832 database. A query to look up the key for an address could be defined as a macro
27833 like this:
27834 .code
27835 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
27836                 WHERE sender='${quote_mysql:$prvscheck_address}'\
27837                 }{$value}}
27838 .endd
27839 Suppose also that the senders who make use of BATV are defined by an address
27840 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
27841 use this:
27842 .code
27843 # Bounces: drop unsigned addresses for BATV senders
27844 deny message = This address does not send an unsigned reverse path
27845      senders = :
27846      recipients = +batv_senders
27847
27848 # Bounces: In case of prvs-signed address, check signature.
27849 deny message = Invalid reverse path signature.
27850      senders = :
27851      condition  = ${prvscheck {$local_part@$domain}\
27852                   {PRVSCHECK_SQL}{1}}
27853      !condition = $prvscheck_result
27854 .endd
27855 The first statement rejects recipients for bounce messages that are addressed
27856 to plain BATV sender addresses, because it is known that BATV senders do not
27857 send out messages with plain sender addresses. The second statement rejects
27858 recipients that are prvs-signed, but with invalid signatures (either because
27859 the key is wrong, or the signature has timed out).
27860
27861 A non-prvs-signed address is not rejected by the second statement, because the
27862 &%prvscheck%& expansion yields an empty string if its first argument is not a
27863 prvs-signed address, thus causing the &%condition%& condition to be false. If
27864 the first argument is a syntactically valid prvs-signed address, the yield is
27865 the third string (in this case &"1"&), whether or not the cryptographic and
27866 timeout checks succeed. The &$prvscheck_result$& variable contains the result
27867 of the checks (empty for failure, &"1"& for success).
27868
27869 There is one more issue you must consider when implementing prvs-signing:
27870 you have to ensure that the routers accept prvs-signed addresses and
27871 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
27872 router to remove the signature with a configuration along these lines:
27873 .code
27874 batv_redirect:
27875   driver = redirect
27876   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
27877 .endd
27878 This works because, if the third argument of &%prvscheck%& is empty, the result
27879 of the expansion of a prvs-signed address is the decoded value of the original
27880 address. This router should probably be the first of your routers that handles
27881 local addresses.
27882
27883 To create BATV-signed addresses in the first place, a transport of this form
27884 can be used:
27885 .code
27886 external_smtp_batv:
27887   driver = smtp
27888   return_path = ${prvs {$return_path} \
27889                        {${lookup mysql{SELECT \
27890                        secret FROM batv_prvs WHERE \
27891                        sender='${quote_mysql:$sender_address}'} \
27892                        {$value}fail}}}
27893 .endd
27894 If no key can be found for the existing return path, no signing takes place.
27895
27896
27897
27898 .section "Using an ACL to control relaying" "SECTrelaycontrol"
27899 .cindex "&ACL;" "relay control"
27900 .cindex "relaying" "control by ACL"
27901 .cindex "policy control" "relay control"
27902 An MTA is said to &'relay'& a message if it receives it from some host and
27903 delivers it directly to another host as a result of a remote address contained
27904 within it. Redirecting a local address via an alias or forward file and then
27905 passing the message on to another host is not relaying,
27906 .cindex "&""percent hack""&"
27907 but a redirection as a result of the &"percent hack"& is.
27908
27909 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
27910 A host which is acting as a gateway or an MX backup is concerned with incoming
27911 relaying from arbitrary hosts to a specific set of domains. On the other hand,
27912 a host which is acting as a smart host for a number of clients is concerned
27913 with outgoing relaying from those clients to the Internet at large. Often the
27914 same host is fulfilling both functions,
27915 . ///
27916 . as illustrated in the diagram below,
27917 . ///
27918 but in principle these two kinds of relaying are entirely independent. What is
27919 not wanted is the transmission of mail from arbitrary remote hosts through your
27920 system to arbitrary domains.
27921
27922
27923 You can implement relay control by means of suitable statements in the ACL that
27924 runs for each RCPT command. For convenience, it is often easiest to use
27925 Exim's named list facility to define the domains and hosts involved. For
27926 example, suppose you want to do the following:
27927
27928 .ilist
27929 Deliver a number of domains to mailboxes on the local host (or process them
27930 locally in some other way). Let's say these are &'my.dom1.example'& and
27931 &'my.dom2.example'&.
27932 .next
27933 Relay mail for a number of other domains for which you are the secondary MX.
27934 These might be &'friend1.example'& and &'friend2.example'&.
27935 .next
27936 Relay mail from the hosts on your local LAN, to whatever domains are involved.
27937 Suppose your LAN is 192.168.45.0/24.
27938 .endlist
27939
27940
27941 In the main part of the configuration, you put the following definitions:
27942 .code
27943 domainlist local_domains = my.dom1.example : my.dom2.example
27944 domainlist relay_domains = friend1.example : friend2.example
27945 hostlist   relay_hosts   = 192.168.45.0/24
27946 .endd
27947 Now you can use these definitions in the ACL that is run for every RCPT
27948 command:
27949 .code
27950 acl_check_rcpt:
27951   accept domains = +local_domains : +relay_domains
27952   accept hosts   = +relay_hosts
27953 .endd
27954 The first statement accepts any RCPT command that contains an address in
27955 the local or relay domains. For any other domain, control passes to the second
27956 statement, which accepts the command only if it comes from one of the relay
27957 hosts. In practice, you will probably want to make your ACL more sophisticated
27958 than this, for example, by including sender and recipient verification. The
27959 default configuration includes a more comprehensive example, which is described
27960 in chapter &<<CHAPdefconfil>>&.
27961
27962
27963
27964 .section "Checking a relay configuration" "SECTcheralcon"
27965 .cindex "relaying" "checking control of"
27966 You can check the relay characteristics of your configuration in the same way
27967 that you can test any ACL behaviour for an incoming SMTP connection, by using
27968 the &%-bh%& option to run a fake SMTP session with which you interact.
27969
27970 For specifically testing for unwanted relaying, the host
27971 &'relay-test.mail-abuse.org'& provides a useful service. If you telnet to this
27972 host from the host on which Exim is running, using the normal telnet port, you
27973 will see a normal telnet connection message and then quite a long delay. Be
27974 patient. The remote host is making an SMTP connection back to your host, and
27975 trying a number of common probes to test for open relay vulnerability. The
27976 results of the tests will eventually appear on your terminal.
27977 .ecindex IIDacl
27978
27979
27980
27981 . ////////////////////////////////////////////////////////////////////////////
27982 . ////////////////////////////////////////////////////////////////////////////
27983
27984 .chapter "Content scanning at ACL time" "CHAPexiscan"
27985 .scindex IIDcosca "content scanning" "at ACL time"
27986 The extension of Exim to include content scanning at ACL time, formerly known
27987 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
27988 was integrated into the main source for Exim release 4.50, and Tom continues to
27989 maintain it. Most of the wording of this chapter is taken from Tom's
27990 specification.
27991
27992 It is also possible to scan the content of messages at other times. The
27993 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
27994 scanning after all the ACLs have run. A transport filter can be used to scan
27995 messages at delivery time (see the &%transport_filter%& option, described in
27996 chapter &<<CHAPtransportgeneric>>&).
27997
27998 If you want to include the ACL-time content-scanning features when you compile
27999 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
28000 &_Local/Makefile_&. When you do that, the Exim binary is built with:
28001
28002 .ilist
28003 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
28004 for all MIME parts for SMTP and non-SMTP messages, respectively.
28005 .next
28006 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
28007 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
28008 run at the end of message reception (the &%acl_smtp_data%& ACL).
28009 .next
28010 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
28011 of messages, or parts of messages, for debugging purposes.
28012 .next
28013 Additional expansion variables that are set in the new ACL and by the new
28014 conditions.
28015 .next
28016 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
28017 .endlist
28018
28019 There is another content-scanning configuration option for &_Local/Makefile_&,
28020 called WITH_OLD_DEMIME. If this is set, the old, deprecated &%demime%& ACL
28021 condition is compiled, in addition to all the other content-scanning features.
28022
28023 Content-scanning is continually evolving, and new features are still being
28024 added. While such features are still unstable and liable to incompatible
28025 changes, they are made available in Exim by setting options whose names begin
28026 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
28027 this manual. You can find out about them by reading the file called
28028 &_doc/experimental.txt_&.
28029
28030 All the content-scanning facilities work on a MBOX copy of the message that is
28031 temporarily created in a file called:
28032 .display
28033 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
28034 .endd
28035 The &_.eml_& extension is a friendly hint to virus scanners that they can
28036 expect an MBOX-like structure inside that file. The file is created when the
28037 first content scanning facility is called. Subsequent calls to content
28038 scanning conditions open the same file again. The directory is recursively
28039 removed when the &%acl_smtp_data%& ACL has finished running, unless
28040 .code
28041 control = no_mbox_unspool
28042 .endd
28043 has been encountered. When the MIME ACL decodes files, they are put into the
28044 same directory by default.
28045
28046
28047
28048 .section "Scanning for viruses" "SECTscanvirus"
28049 .cindex "virus scanning"
28050 .cindex "content scanning" "for viruses"
28051 .cindex "content scanning" "the &%malware%& condition"
28052 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
28053 It supports a &"generic"& interface to scanners called via the shell, and
28054 specialized interfaces for &"daemon"& type virus scanners, which are resident
28055 in memory and thus are much faster.
28056
28057 .new
28058 .oindex "&%av_scanner%&"
28059 You can set the &%av_scanner%& option in first part of the Exim configuration
28060 file to specify which scanner to use, together with any additional options that
28061 are needed. The basic syntax is as follows:
28062 .display
28063 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
28064 .endd
28065 If you do not set &%av_scanner%&, it defaults to
28066 .code
28067 av_scanner = sophie:/var/run/sophie
28068 .endd
28069 If the value of &%av_scanner%& starts with a dollar character, it is expanded
28070 before use. The following scanner types are supported in this release:
28071 .wen
28072 .vlist
28073 .vitem &%aveserver%&
28074 .cindex "virus scanners" "Kaspersky"
28075 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
28076 at &url(http://www.kaspersky.com). This scanner type takes one option,
28077 which is the path to the daemon's UNIX socket. The default is shown in this
28078 example:
28079 .code
28080 av_scanner = aveserver:/var/run/aveserver
28081 .endd
28082
28083 .new
28084 .vitem &%clamd%&
28085 .cindex "virus scanners" "clamd"
28086 This daemon-type scanner is GPL and free. You can get it at
28087 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
28088 unpack MIME containers, so it used to be recommended to unpack MIME attachments
28089 in the MIME ACL. This no longer believed to be necessary. One option is
28090 required: either the path and name of a UNIX socket file, or a hostname or IP
28091 number, and a port, separated by space, as in the second of these examples:
28092 .code
28093 av_scanner = clamd:/opt/clamd/socket
28094 av_scanner = clamd:192.0.2.3 1234
28095 av_scanner = clamd:192.0.2.3 1234:local
28096 .endd
28097 If the value of av_scanner points to a UNIX socket file or contains the local
28098 keyword, then the ClamAV interface will pass a filename containing the data
28099 to be scanned, which will should normally result in less I/O happening and be
28100 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
28101 Exim does not assume that there is a common filesystem with the remote host.
28102 There is an option WITH_OLD_CLAMAV_STREAM in &_src/EDITME_& available, should
28103 you be running a version of ClamAV prior to 0.95.
28104 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
28105 contributing the code for this scanner.
28106 .wen
28107 .vitem &%cmdline%&
28108 .cindex "virus scanners" "command line interface"
28109 This is the keyword for the generic command line scanner interface. It can be
28110 used to attach virus scanners that are invoked from the shell. This scanner
28111 type takes 3 mandatory options:
28112
28113 .olist
28114 The full path and name of the scanner binary, with all command line options,
28115 and a placeholder (&`%s`&) for the directory to scan.
28116
28117 .next
28118 A regular expression to match against the STDOUT and STDERR output of the
28119 virus scanner. If the expression matches, a virus was found. You must make
28120 absolutely sure that this expression matches on &"virus found"&. This is called
28121 the &"trigger"& expression.
28122
28123 .next
28124 Another regular expression, containing exactly one pair of parentheses, to
28125 match the name of the virus found in the scanners output. This is called the
28126 &"name"& expression.
28127 .endlist olist
28128
28129 For example, Sophos Sweep reports a virus on a line like this:
28130 .code
28131 Virus 'W32/Magistr-B' found in file ./those.bat
28132 .endd
28133 For the trigger expression, we can match the phrase &"found in file"&. For the
28134 name expression, we want to extract the W32/Magistr-B string, so we can match
28135 for the single quotes left and right of it. Altogether, this makes the
28136 configuration setting:
28137 .code
28138 av_scanner = cmdline:\
28139              /path/to/sweep -ss -all -rec -archive %s:\
28140              found in file:'(.+)'
28141 .endd
28142 .vitem &%drweb%&
28143 .cindex "virus scanners" "DrWeb"
28144 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface takes one
28145 argument, either a full path to a UNIX socket, or an IP address and port
28146 separated by white space, as in these examples:
28147 .code
28148 av_scanner = drweb:/var/run/drwebd.sock
28149 av_scanner = drweb:192.168.2.20 31337
28150 .endd
28151 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
28152 is used. Thanks to Alex Miller for contributing the code for this scanner.
28153
28154 .vitem &%fsecure%&
28155 .cindex "virus scanners" "F-Secure"
28156 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
28157 argument which is the path to a UNIX socket. For example:
28158 .code
28159 av_scanner = fsecure:/path/to/.fsav
28160 .endd
28161 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
28162 Thelmen for contributing the code for this scanner.
28163
28164 .vitem &%kavdaemon%&
28165 .cindex "virus scanners" "Kaspersky"
28166 This is the scanner daemon of Kaspersky Version 4. This version of the
28167 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
28168 scanner type takes one option, which is the path to the daemon's UNIX socket.
28169 For example:
28170 .code
28171 av_scanner = kavdaemon:/opt/AVP/AvpCtl
28172 .endd
28173 The default path is &_/var/run/AvpCtl_&.
28174
28175 .vitem &%mksd%&
28176 .cindex "virus scanners" "mksd"
28177 This is a daemon type scanner that is aimed mainly at Polish users, though some
28178 parts of documentation are now available in English. You can get it at
28179 &url(http://linux.mks.com.pl/). The only option for this scanner type is
28180 the maximum number of processes used simultaneously to scan the attachments,
28181 provided that the demime facility is employed and also provided that mksd has
28182 been run with at least the same number of child processes. For example:
28183 .code
28184 av_scanner = mksd:2
28185 .endd
28186 You can safely omit this option (the default value is 1).
28187
28188 .vitem &%sophie%&
28189 .cindex "virus scanners" "Sophos and Sophie"
28190 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
28191 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
28192 for this scanner type is the path to the UNIX socket that Sophie uses for
28193 client communication. For example:
28194 .code
28195 av_scanner = sophie:/tmp/sophie
28196 .endd
28197 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
28198 the option.
28199 .endlist
28200
28201 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
28202 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
28203 ACL.
28204
28205 The &%av_scanner%& option is expanded each time &%malware%& is called. This
28206 makes it possible to use different scanners. See further below for an example.
28207 The &%malware%& condition caches its results, so when you use it multiple times
28208 for the same message, the actual scanning process is only carried out once.
28209 However, using expandable items in &%av_scanner%& disables this caching, in
28210 which case each use of the &%malware%& condition causes a new scan of the
28211 message.
28212
28213 The &%malware%& condition takes a right-hand argument that is expanded before
28214 use. It can then be one of
28215
28216 .ilist
28217 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
28218 The condition succeeds if a virus was found, and fail otherwise. This is the
28219 recommended usage.
28220 .next
28221 &"false"& or &"0"& or an empty string, in which case no scanning is done and
28222 the condition fails immediately.
28223 .next
28224 A regular expression, in which case the message is scanned for viruses. The
28225 condition succeeds if a virus is found and its name matches the regular
28226 expression. This allows you to take special actions on certain types of virus.
28227 .endlist
28228
28229 You can append &`/defer_ok`& to the &%malware%& condition to accept messages
28230 even if there is a problem with the virus scanner. Otherwise, such a problem
28231 causes the ACL to defer.
28232
28233 .vindex "&$malware_name$&"
28234 When a virus is found, the condition sets up an expansion variable called
28235 &$malware_name$& that contains the name of the virus. You can use it in a
28236 &%message%& modifier that specifies the error returned to the sender, and/or in
28237 logging data.
28238
28239 If your virus scanner cannot unpack MIME and TNEF containers itself, you should
28240 use the &%demime%& condition (see section &<<SECTdemimecond>>&) before the
28241 &%malware%& condition.
28242
28243 .new
28244 Beware the interaction of Exim's &%message_size_limit%& with any size limits
28245 imposed by your anti-virus scanner.
28246 .wen
28247
28248 Here is a very simple scanning example:
28249 .code
28250 deny message = This message contains malware ($malware_name)
28251      demime = *
28252      malware = *
28253 .endd
28254 The next example accepts messages when there is a problem with the scanner:
28255 .code
28256 deny message = This message contains malware ($malware_name)
28257      demime = *
28258      malware = */defer_ok
28259 .endd
28260 The next example shows how to use an ACL variable to scan with both sophie and
28261 aveserver. It assumes you have set:
28262 .code
28263 av_scanner = $acl_m0
28264 .endd
28265 in the main Exim configuration.
28266 .code
28267 deny message = This message contains malware ($malware_name)
28268      set acl_m0 = sophie
28269      malware = *
28270
28271 deny message = This message contains malware ($malware_name)
28272      set acl_m0 = aveserver
28273      malware = *
28274 .endd
28275
28276
28277 .section "Scanning with SpamAssassin" "SECTscanspamass"
28278 .cindex "content scanning" "for spam"
28279 .cindex "spam scanning"
28280 .cindex "SpamAssassin"
28281 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
28282 score and a report for the message. You can get SpamAssassin at
28283 &url(http://www.spamassassin.org), or, if you have a working Perl
28284 installation, you can use CPAN by running:
28285 .code
28286 perl -MCPAN -e 'install Mail::SpamAssassin'
28287 .endd
28288 SpamAssassin has its own set of configuration files. Please review its
28289 documentation to see how you can tweak it. The default installation should work
28290 nicely, however.
28291
28292 .oindex "&%spamd_address%&"
28293 After having installed and configured SpamAssassin, start the &%spamd%& daemon.
28294 By default, it listens on 127.0.0.1, TCP port 783. If you use another host or
28295 port for &%spamd%&, you must set the &%spamd_address%& option in the global
28296 part of the Exim configuration as follows (example):
28297 .code
28298 spamd_address = 192.168.99.45 387
28299 .endd
28300 You do not need to set this option if you use the default. As of version 2.60,
28301 &%spamd%& also supports communication over UNIX sockets. If you want to use
28302 these, supply &%spamd_address%& with an absolute file name instead of a
28303 address/port pair:
28304 .code
28305 spamd_address = /var/run/spamd_socket
28306 .endd
28307 You can have multiple &%spamd%& servers to improve scalability. These can
28308 reside on other hardware reachable over the network. To specify multiple
28309 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
28310 option, separated with colons:
28311 .code
28312 spamd_address = 192.168.2.10 783 : \
28313                 192.168.2.11 783 : \
28314                 192.168.2.12 783
28315 .endd
28316 Up to 32 &%spamd%& servers are supported. The servers are queried in a random
28317 fashion. When a server fails to respond to the connection attempt, all other
28318 servers are tried until one succeeds. If no server responds, the &%spam%&
28319 condition defers.
28320
28321 &*Warning*&: It is not possible to use the UNIX socket connection method with
28322 multiple &%spamd%& servers.
28323
28324 The &%spamd_address%& variable is expanded before use if it starts with
28325 a dollar sign. In this case, the expansion may return a string that is
28326 used as the list so that multiple spamd servers can be the result of an
28327 expansion.
28328
28329 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
28330 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
28331 .code
28332 deny message = This message was classified as SPAM
28333      spam = joe
28334 .endd
28335 The right-hand side of the &%spam%& condition specifies a name. This is
28336 relevant if you have set up multiple SpamAssassin profiles. If you do not want
28337 to scan using a specific profile, but rather use the SpamAssassin system-wide
28338 default profile, you can scan for an unknown name, or simply use &"nobody"&.
28339 However, you must put something on the right-hand side.
28340
28341 The name allows you to use per-domain or per-user antispam profiles in
28342 principle, but this is not straightforward in practice, because a message may
28343 have multiple recipients, not necessarily all in the same domain. Because the
28344 &%spam%& condition has to be called from a DATA ACL in order to be able to
28345 read the contents of the message, the variables &$local_part$& and &$domain$&
28346 are not set.
28347
28348 The right-hand side of the &%spam%& condition is expanded before being used, so
28349 you can put lookups or conditions there. When the right-hand side evaluates to
28350 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
28351
28352
28353 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
28354 large ones may cause significant performance degradation. As most spam messages
28355 are quite small, it is recommended that you do not scan the big ones. For
28356 example:
28357 .code
28358 deny message = This message was classified as SPAM
28359      condition = ${if < {$message_size}{10K}}
28360      spam = nobody
28361 .endd
28362
28363 The &%spam%& condition returns true if the threshold specified in the user's
28364 SpamAssassin profile has been matched or exceeded. If you want to use the
28365 &%spam%& condition for its side effects (see the variables below), you can make
28366 it always return &"true"& by appending &`:true`& to the username.
28367
28368 .new
28369 .cindex "spam scanning" "returned variables"
28370 When the &%spam%& condition is run, it sets up a number of expansion
28371 variables. These variables are saved with the received message, thus they are
28372 available for use at delivery time.
28373 .wen
28374
28375 .vlist
28376 .vitem &$spam_score$&
28377 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
28378 for inclusion in log or reject messages.
28379
28380 .new
28381 .vitem &$spam_score_int$&
28382 The spam score of the message, multiplied by ten, as an integer value. For
28383 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
28384 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
28385 The integer value is useful for numeric comparisons in conditions.
28386 .wen
28387
28388 .vitem &$spam_bar$&
28389 A string consisting of a number of &"+"& or &"-"& characters, representing the
28390 integer part of the spam score value. A spam score of 4.4 would have a
28391 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
28392 headers, since MUAs can match on such strings.
28393
28394 .vitem &$spam_report$&
28395 A multiline text table, containing the full SpamAssassin report for the
28396 message. Useful for inclusion in headers or reject messages.
28397 .endlist
28398
28399 The &%spam%& condition caches its results unless expansion in
28400 spamd_address was used. If you call it again with the same user name, it
28401 does not scan again, but rather returns the same values as before.
28402
28403 The &%spam%& condition returns DEFER if there is any error while running
28404 the message through SpamAssassin or if the expansion of spamd_address
28405 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
28406 statement block), append &`/defer_ok`& to the right-hand side of the
28407 spam condition, like this:
28408 .code
28409 deny message = This message was classified as SPAM
28410      spam    = joe/defer_ok
28411 .endd
28412 This causes messages to be accepted even if there is a problem with &%spamd%&.
28413
28414 Here is a longer, commented example of the use of the &%spam%&
28415 condition:
28416 .code
28417 # put headers in all messages (no matter if spam or not)
28418 warn  spam = nobody:true
28419       add_header = X-Spam-Score: $spam_score ($spam_bar)
28420       add_header = X-Spam-Report: $spam_report
28421
28422 # add second subject line with *SPAM* marker when message
28423 # is over threshold
28424 warn  spam = nobody
28425       add_header = Subject: *SPAM* $h_Subject:
28426
28427 # reject spam at high scores (> 12)
28428 deny  message = This message scored $spam_score spam points.
28429       spam = nobody:true
28430       condition = ${if >{$spam_score_int}{120}{1}{0}}
28431 .endd
28432
28433
28434
28435 .section "Scanning MIME parts" "SECTscanmimepart"
28436 .cindex "content scanning" "MIME parts"
28437 .cindex "MIME content scanning"
28438 .oindex "&%acl_smtp_mime%&"
28439 .oindex "&%acl_not_smtp_mime%&"
28440 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
28441 each MIME part of an SMTP message, including multipart types, in the sequence
28442 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
28443 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
28444 options may both refer to the same ACL if you want the same processing in both
28445 cases.
28446
28447 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
28448 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
28449 the case of a non-SMTP message. However, a MIME ACL is called only if the
28450 message contains a &'Content-Type:'& header line. When a call to a MIME
28451 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
28452 result code is sent to the client. In the case of an SMTP message, the
28453 &%acl_smtp_data%& ACL is not called when this happens.
28454
28455 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
28456 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
28457 condition to match against the raw MIME part. You can also use the
28458 &%mime_regex%& condition to match against the decoded MIME part (see section
28459 &<<SECTscanregex>>&).
28460
28461 At the start of a MIME ACL, a number of variables are set from the header
28462 information for the relevant MIME part. These are described below. The contents
28463 of the MIME part are not by default decoded into a disk file except for MIME
28464 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
28465 part into a disk file, you can use the &%decode%& condition. The general
28466 syntax is:
28467 .display
28468 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
28469 .endd
28470 The right hand side is expanded before use. After expansion,
28471 the value can be:
28472
28473 .olist
28474 &"0"& or &"false"&, in which case no decoding is done.
28475 .next
28476 The string &"default"&. In that case, the file is put in the temporary
28477 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
28478 a sequential file name consisting of the message id and a sequence number. The
28479 full path and name is available in &$mime_decoded_filename$& after decoding.
28480 .next
28481 A full path name starting with a slash. If the full name is an existing
28482 directory, it is used as a replacement for the default directory. The filename
28483 is then sequentially assigned. If the path does not exist, it is used as
28484 the full path and file name.
28485 .next
28486 If the string does not start with a slash, it is used as the
28487 filename, and the default path is then used.
28488 .endlist
28489 The &%decode%& condition normally succeeds. It is only false for syntax
28490 errors or unusual circumstances such as memory shortages. You can easily decode
28491 a file with its original, proposed filename using
28492 .code
28493 decode = $mime_filename
28494 .endd
28495 However, you should keep in mind that &$mime_filename$& might contain
28496 anything. If you place files outside of the default path, they are not
28497 automatically unlinked.
28498
28499 For RFC822 attachments (these are messages attached to messages, with a
28500 content-type of &"message/rfc822"&), the ACL is called again in the same manner
28501 as for the primary message, only that the &$mime_is_rfc822$& expansion
28502 variable is set (see below). Attached messages are always decoded to disk
28503 before being checked, and the files are unlinked once the check is done.
28504
28505 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
28506 used to match regular expressions against raw and decoded MIME parts,
28507 respectively. They are described in section &<<SECTscanregex>>&.
28508
28509 .cindex "MIME content scanning" "returned variables"
28510 The following list describes all expansion variables that are
28511 available in the MIME ACL:
28512
28513 .vlist
28514 .vitem &$mime_boundary$&
28515 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
28516 have a boundary string, which is stored in this variable. If the current part
28517 has no boundary parameter in the &'Content-Type:'& header, this variable
28518 contains the empty string.
28519
28520 .vitem &$mime_charset$&
28521 This variable contains the character set identifier, if one was found in the
28522 &'Content-Type:'& header. Examples for charset identifiers are:
28523 .code
28524 us-ascii
28525 gb2312 (Chinese)
28526 iso-8859-1
28527 .endd
28528 Please note that this value is not normalized, so you should do matches
28529 case-insensitively.
28530
28531 .vitem &$mime_content_description$&
28532 This variable contains the normalized content of the &'Content-Description:'&
28533 header. It can contain a human-readable description of the parts content. Some
28534 implementations repeat the filename for attachments here, but they are usually
28535 only used for display purposes.
28536
28537 .vitem &$mime_content_disposition$&
28538 This variable contains the normalized content of the &'Content-Disposition:'&
28539 header. You can expect strings like &"attachment"& or &"inline"& here.
28540
28541 .vitem &$mime_content_id$&
28542 This variable contains the normalized content of the &'Content-ID:'& header.
28543 This is a unique ID that can be used to reference a part from another part.
28544
28545 .vitem &$mime_content_size$&
28546 This variable is set only after the &%decode%& modifier (see above) has been
28547 successfully run. It contains the size of the decoded part in kilobytes. The
28548 size is always rounded up to full kilobytes, so only a completely empty part
28549 has a &$mime_content_size$& of zero.
28550
28551 .vitem &$mime_content_transfer_encoding$&
28552 This variable contains the normalized content of the
28553 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
28554 type. Typical values are &"base64"& and &"quoted-printable"&.
28555
28556 .vitem &$mime_content_type$&
28557 If the MIME part has a &'Content-Type:'& header, this variable contains its
28558 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
28559 are some examples of popular MIME types, as they may appear in this variable:
28560 .code
28561 text/plain
28562 text/html
28563 application/octet-stream
28564 image/jpeg
28565 audio/midi
28566 .endd
28567 If the MIME part has no &'Content-Type:'& header, this variable contains the
28568 empty string.
28569
28570 .vitem &$mime_decoded_filename$&
28571 This variable is set only after the &%decode%& modifier (see above) has been
28572 successfully run. It contains the full path and file name of the file
28573 containing the decoded data.
28574 .endlist
28575
28576 .cindex "RFC 2047"
28577 .vlist
28578 .vitem &$mime_filename$&
28579 This is perhaps the most important of the MIME variables. It contains a
28580 proposed filename for an attachment, if one was found in either the
28581 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
28582 RFC2047 decoded, but no additional sanity checks are done. If no filename was
28583 found, this variable contains the empty string.
28584
28585 .vitem &$mime_is_coverletter$&
28586 This variable attempts to differentiate the &"cover letter"& of an e-mail from
28587 attached data. It can be used to clamp down on flashy or unnecessarily encoded
28588 content in the cover letter, while not restricting attachments at all.
28589
28590 The variable contains 1 (true) for a MIME part believed to be part of the
28591 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
28592 follows:
28593
28594 .olist
28595 The outermost MIME part of a message is always a cover letter.
28596
28597 .next
28598 If a multipart/alternative or multipart/related MIME part is a cover letter,
28599 so are all MIME subparts within that multipart.
28600
28601 .next
28602 If any other multipart is a cover letter, the first subpart is a cover letter,
28603 and the rest are attachments.
28604
28605 .next
28606 All parts contained within an attachment multipart are attachments.
28607 .endlist olist
28608
28609 As an example, the following will ban &"HTML mail"& (including that sent with
28610 alternative plain text), while allowing HTML files to be attached. HTML
28611 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
28612 .code
28613 deny message = HTML mail is not accepted here
28614 !condition = $mime_is_rfc822
28615 condition = $mime_is_coverletter
28616 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
28617 .endd
28618 .vitem &$mime_is_multipart$&
28619 This variable has the value 1 (true) when the current part has the main type
28620 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
28621 Since multipart entities only serve as containers for other parts, you may not
28622 want to carry out specific actions on them.
28623
28624 .vitem &$mime_is_rfc822$&
28625 This variable has the value 1 (true) if the current part is not a part of the
28626 checked message itself, but part of an attached message. Attached message
28627 decoding is fully recursive.
28628
28629 .vitem &$mime_part_count$&
28630 This variable is a counter that is raised for each processed MIME part. It
28631 starts at zero for the very first part (which is usually a multipart). The
28632 counter is per-message, so it is reset when processing RFC822 attachments (see
28633 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
28634 complete, so you can use it in the DATA ACL to determine the number of MIME
28635 parts of a message. For non-MIME messages, this variable contains the value -1.
28636 .endlist
28637
28638
28639
28640 .section "Scanning with regular expressions" "SECTscanregex"
28641 .cindex "content scanning" "with regular expressions"
28642 .cindex "regular expressions" "content scanning with"
28643 You can specify your own custom regular expression matches on the full body of
28644 the message, or on individual MIME parts.
28645
28646 The &%regex%& condition takes one or more regular expressions as arguments and
28647 matches them against the full message (when called in the DATA ACL) or a raw
28648 MIME part (when called in the MIME ACL). The &%regex%& condition matches
28649 linewise, with a maximum line length of 32K characters. That means you cannot
28650 have multiline matches with the &%regex%& condition.
28651
28652 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
28653 to 32K of decoded content (the whole content at once, not linewise). If the
28654 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
28655 is decoded automatically when &%mime_regex%& is executed (using default path
28656 and filename values). If the decoded data is larger than  32K, only the first
28657 32K characters are checked.
28658
28659 The regular expressions are passed as a colon-separated list. To include a
28660 literal colon, you must double it. Since the whole right-hand side string is
28661 expanded before being used, you must also escape dollar signs and backslashes
28662 with more backslashes, or use the &`\N`& facility to disable expansion.
28663 Here is a simple example that contains two regular expressions:
28664 .code
28665 deny message = contains blacklisted regex ($regex_match_string)
28666      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
28667 .endd
28668 The conditions returns true if any one of the regular expressions matches. The
28669 &$regex_match_string$& expansion variable is then set up and contains the
28670 matching regular expression.
28671
28672 &*Warning*&: With large messages, these conditions can be fairly
28673 CPU-intensive.
28674
28675
28676
28677
28678 .section "The demime condition" "SECTdemimecond"
28679 .cindex "content scanning" "MIME checking"
28680 .cindex "MIME content scanning"
28681 The &%demime%& ACL condition provides MIME unpacking, sanity checking and file
28682 extension blocking. It is usable only in the DATA and non-SMTP ACLs. The
28683 &%demime%& condition uses a simpler interface to MIME decoding than the MIME
28684 ACL functionality, but provides no additional facilities. Please note that this
28685 condition is deprecated and kept only for backward compatibility. You must set
28686 the WITH_OLD_DEMIME option in &_Local/Makefile_& at build time to be able to
28687 use the &%demime%& condition.
28688
28689 The &%demime%& condition unpacks MIME containers in the message. It detects
28690 errors in MIME containers and can match file extensions found in the message
28691 against a list. Using this facility produces files containing the unpacked MIME
28692 parts of the message in the temporary scan directory. If you do antivirus
28693 scanning, it is recommended that you use the &%demime%& condition before the
28694 antivirus (&%malware%&) condition.
28695
28696 On the right-hand side of the &%demime%& condition you can pass a
28697 colon-separated list of file extensions that it should match against. For
28698 example:
28699 .code
28700 deny message = Found blacklisted file attachment
28701      demime  = vbs:com:bat:pif:prf:lnk
28702 .endd
28703 If one of the file extensions is found, the condition is true, otherwise it is
28704 false. If there is a temporary error while demimeing (for example, &"disk
28705 full"&), the condition defers, and the message is temporarily rejected (unless
28706 the condition is on a &%warn%& verb).
28707
28708 The right-hand side is expanded before being treated as a list, so you can have
28709 conditions and lookups there. If it expands to an empty string, &"false"&, or
28710 zero (&"0"&), no demimeing is done and the condition is false.
28711
28712 The &%demime%& condition set the following variables:
28713
28714 .vlist
28715 .vitem &$demime_errorlevel$&
28716 .vindex "&$demime_errorlevel$&"
28717 When an error is detected in a MIME container, this variable contains the
28718 severity of the error, as an integer number. The higher the value, the more
28719 severe the error (the current maximum value is 3). If this variable is unset or
28720 zero, no error occurred.
28721
28722 .vitem &$demime_reason$&
28723 .vindex "&$demime_reason$&"
28724 When &$demime_errorlevel$& is greater than zero, this variable contains a
28725 human-readable text string describing the MIME error that occurred.
28726 .endlist
28727
28728 .vlist
28729 .vitem &$found_extension$&
28730 .vindex "&$found_extension$&"
28731 When the &%demime%& condition is true, this variable contains the file
28732 extension it found.
28733 .endlist
28734
28735 Both &$demime_errorlevel$& and &$demime_reason$& are set by the first call of
28736 the &%demime%& condition, and are not changed on subsequent calls.
28737
28738 If you do not want to check for file extensions, but rather use the &%demime%&
28739 condition for unpacking or error checking purposes, pass &"*"& as the
28740 right-hand side value. Here is a more elaborate example of how to use this
28741 facility:
28742 .code
28743 # Reject messages with serious MIME container errors
28744 deny  message = Found MIME error ($demime_reason).
28745       demime = *
28746       condition = ${if >{$demime_errorlevel}{2}{1}{0}}
28747
28748 # Reject known virus spreading file extensions.
28749 # Accepting these is pretty much braindead.
28750 deny  message = contains $found_extension file (blacklisted).
28751       demime  = com:vbs:bat:pif:scr
28752
28753 # Freeze .exe and .doc files. Postmaster can
28754 # examine them and eventually thaw them.
28755 deny  log_message = Another $found_extension file.
28756       demime = exe:doc
28757       control = freeze
28758 .endd
28759 .ecindex IIDcosca
28760
28761
28762
28763
28764 . ////////////////////////////////////////////////////////////////////////////
28765 . ////////////////////////////////////////////////////////////////////////////
28766
28767 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
28768          "Local scan function"
28769 .scindex IIDlosca "&[local_scan()]& function" "description of"
28770 .cindex "customizing" "input scan using C function"
28771 .cindex "policy control" "by local scan function"
28772 In these days of email worms, viruses, and ever-increasing spam, some sites
28773 want to apply a lot of checking to messages before accepting them.
28774
28775 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
28776 passing messages to external virus and spam scanning software. You can also do
28777 a certain amount in Exim itself through string expansions and the &%condition%&
28778 condition in the ACL that runs after the SMTP DATA command or the ACL for
28779 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
28780
28781 To allow for further customization to a site's own requirements, there is the
28782 possibility of linking Exim with a private message scanning function, written
28783 in C. If you want to run code that is written in something other than C, you
28784 can of course use a little C stub to call it.
28785
28786 The local scan function is run once for every incoming message, at the point
28787 when Exim is just about to accept the message.
28788 It can therefore be used to control non-SMTP messages from local processes as
28789 well as messages arriving via SMTP.
28790
28791 Exim applies a timeout to calls of the local scan function, and there is an
28792 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
28793 Zero means &"no timeout"&.
28794 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
28795 before calling the local scan function, so that the most common types of crash
28796 are caught. If the timeout is exceeded or one of those signals is caught, the
28797 incoming message is rejected with a temporary error if it is an SMTP message.
28798 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
28799 code. The incident is logged on the main and reject logs.
28800
28801
28802
28803 .section "Building Exim to use a local scan function" "SECID207"
28804 .cindex "&[local_scan()]& function" "building Exim to use"
28805 To make use of the local scan function feature, you must tell Exim where your
28806 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
28807 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
28808 directory, so you might set
28809 .code
28810 LOCAL_SCAN_SOURCE=Local/local_scan.c
28811 .endd
28812 for example. The function must be called &[local_scan()]&. It is called by
28813 Exim after it has received a message, when the success return code is about to
28814 be sent. This is after all the ACLs have been run. The return code from your
28815 function controls whether the message is actually accepted or not. There is a
28816 commented template function (that just accepts the message) in the file
28817 _src/local_scan.c_.
28818
28819 If you want to make use of Exim's run time configuration file to set options
28820 for your &[local_scan()]& function, you must also set
28821 .code
28822 LOCAL_SCAN_HAS_OPTIONS=yes
28823 .endd
28824 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
28825
28826
28827
28828
28829 .section "API for local_scan()" "SECTapiforloc"
28830 .cindex "&[local_scan()]& function" "API description"
28831 You must include this line near the start of your code:
28832 .code
28833 #include "local_scan.h"
28834 .endd
28835 This header file defines a number of variables and other values, and the
28836 prototype for the function itself. Exim is coded to use unsigned char values
28837 almost exclusively, and one of the things this header defines is a shorthand
28838 for &`unsigned char`& called &`uschar`&.
28839 It also contains the following macro definitions, to simplify casting character
28840 strings and pointers to character strings:
28841 .code
28842 #define CS   (char *)
28843 #define CCS  (const char *)
28844 #define CSS  (char **)
28845 #define US   (unsigned char *)
28846 #define CUS  (const unsigned char *)
28847 #define USS  (unsigned char **)
28848 .endd
28849 The function prototype for &[local_scan()]& is:
28850 .code
28851 extern int local_scan(int fd, uschar **return_text);
28852 .endd
28853 The arguments are as follows:
28854
28855 .ilist
28856 &%fd%& is a file descriptor for the file that contains the body of the message
28857 (the -D file). The file is open for reading and writing, but updating it is not
28858 recommended. &*Warning*&: You must &'not'& close this file descriptor.
28859
28860 The descriptor is positioned at character 19 of the file, which is the first
28861 character of the body itself, because the first 19 characters are the message
28862 id followed by &`-D`& and a newline. If you rewind the file, you should use the
28863 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
28864 case this changes in some future version.
28865 .next
28866 &%return_text%& is an address which you can use to return a pointer to a text
28867 string at the end of the function. The value it points to on entry is NULL.
28868 .endlist
28869
28870 The function must return an &%int%& value which is one of the following macros:
28871
28872 .vlist
28873 .vitem &`LOCAL_SCAN_ACCEPT`&
28874 .vindex "&$local_scan_data$&"
28875 The message is accepted. If you pass back a string of text, it is saved with
28876 the message, and made available in the variable &$local_scan_data$&. No
28877 newlines are permitted (if there are any, they are turned into spaces) and the
28878 maximum length of text is 1000 characters.
28879
28880 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
28881 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
28882 queued without immediate delivery, and is frozen.
28883
28884 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
28885 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
28886 queued without immediate delivery.
28887
28888 .vitem &`LOCAL_SCAN_REJECT`&
28889 The message is rejected; the returned text is used as an error message which is
28890 passed back to the sender and which is also logged. Newlines are permitted &--
28891 they cause a multiline response for SMTP rejections, but are converted to
28892 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
28893 used.
28894
28895 .vitem &`LOCAL_SCAN_TEMPREJECT`&
28896 The message is temporarily rejected; the returned text is used as an error
28897 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
28898 problem"& is used.
28899
28900 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
28901 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
28902 message is not written to the reject log. It has the effect of unsetting the
28903 &%rejected_header%& log selector for just this rejection. If
28904 &%rejected_header%& is already unset (see the discussion of the
28905 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
28906 same as LOCAL_SCAN_REJECT.
28907
28908 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
28909 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
28910 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
28911 .endlist
28912
28913 If the message is not being received by interactive SMTP, rejections are
28914 reported by writing to &%stderr%& or by sending an email, as configured by the
28915 &%-oe%& command line options.
28916
28917
28918
28919 .section "Configuration options for local_scan()" "SECTconoptloc"
28920 .cindex "&[local_scan()]& function" "configuration options"
28921 It is possible to have option settings in the main configuration file
28922 that set values in static variables in the &[local_scan()]& module. If you
28923 want to do this, you must have the line
28924 .code
28925 LOCAL_SCAN_HAS_OPTIONS=yes
28926 .endd
28927 in your &_Local/Makefile_& when you build Exim. (This line is in
28928 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
28929 file, you must define static variables to hold the option values, and a table
28930 to define them.
28931
28932 The table must be a vector called &%local_scan_options%&, of type
28933 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
28934 and a pointer to the variable that holds the value. The entries must appear in
28935 alphabetical order. Following &%local_scan_options%& you must also define a
28936 variable called &%local_scan_options_count%& that contains the number of
28937 entries in the table. Here is a short example, showing two kinds of option:
28938 .code
28939 static int my_integer_option = 42;
28940 static uschar *my_string_option = US"a default string";
28941
28942 optionlist local_scan_options[] = {
28943   { "my_integer", opt_int,       &my_integer_option },
28944   { "my_string",  opt_stringptr, &my_string_option }
28945 };
28946
28947 int local_scan_options_count =
28948   sizeof(local_scan_options)/sizeof(optionlist);
28949 .endd
28950 The values of the variables can now be changed from Exim's runtime
28951 configuration file by including a local scan section as in this example:
28952 .code
28953 begin local_scan
28954 my_integer = 99
28955 my_string = some string of text...
28956 .endd
28957 The available types of option data are as follows:
28958
28959 .vlist
28960 .vitem &*opt_bool*&
28961 This specifies a boolean (true/false) option. The address should point to a
28962 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
28963 that are defined as &"1"& and &"0"&, respectively. If you want to detect
28964 whether such a variable has been set at all, you can initialize it to
28965 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
28966 values.)
28967
28968 .vitem &*opt_fixed*&
28969 This specifies a fixed point number, such as is used for load averages.
28970 The address should point to a variable of type &`int`&. The value is stored
28971 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
28972
28973 .vitem &*opt_int*&
28974 This specifies an integer; the address should point to a variable of type
28975 &`int`&. The value may be specified in any of the integer formats accepted by
28976 Exim.
28977
28978 .vitem &*opt_mkint*&
28979 This is the same as &%opt_int%&, except that when such a value is output in a
28980 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
28981 printed with the suffix K or M.
28982
28983 .vitem &*opt_octint*&
28984 This also specifies an integer, but the value is always interpreted as an
28985 octal integer, whether or not it starts with the digit zero, and it is
28986 always output in octal.
28987
28988 .vitem &*opt_stringptr*&
28989 This specifies a string value; the address must be a pointer to a
28990 variable that points to a string (for example, of type &`uschar *`&).
28991
28992 .vitem &*opt_time*&
28993 This specifies a time interval value. The address must point to a variable of
28994 type &`int`&. The value that is placed there is a number of seconds.
28995 .endlist
28996
28997 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
28998 out the values of all the &[local_scan()]& options.
28999
29000
29001
29002 .section "Available Exim variables" "SECID208"
29003 .cindex "&[local_scan()]& function" "available Exim variables"
29004 The header &_local_scan.h_& gives you access to a number of C variables. These
29005 are the only ones that are guaranteed to be maintained from release to release.
29006 Note, however, that you can obtain the value of any Exim expansion variable,
29007 including &$recipients$&, by calling &'expand_string()'&. The exported
29008 C variables are as follows:
29009
29010 .vlist
29011 .vitem &*int&~body_linecount*&
29012 This variable contains the number of lines in the message's body.
29013
29014 .vitem &*int&~body_zerocount*&
29015 This variable contains the number of binary zero bytes in the message's body.
29016
29017 .vitem &*unsigned&~int&~debug_selector*&
29018 This variable is set to zero when no debugging is taking place. Otherwise, it
29019 is a bitmap of debugging selectors. Two bits are identified for use in
29020 &[local_scan()]&; they are defined as macros:
29021
29022 .ilist
29023 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
29024 testing option that is not privileged &-- any caller may set it. All the
29025 other selector bits can be set only by admin users.
29026
29027 .next
29028 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
29029 by the &`+local_scan`& debug selector. It is not included in the default set
29030 of debugging bits.
29031 .endlist ilist
29032
29033 Thus, to write to the debugging output only when &`+local_scan`& has been
29034 selected, you should use code like this:
29035 .code
29036 if ((debug_selector & D_local_scan) != 0)
29037   debug_printf("xxx", ...);
29038 .endd
29039 .vitem &*uschar&~*expand_string_message*&
29040 After a failing call to &'expand_string()'& (returned value NULL), the
29041 variable &%expand_string_message%& contains the error message, zero-terminated.
29042
29043 .vitem &*header_line&~*header_list*&
29044 A pointer to a chain of header lines. The &%header_line%& structure is
29045 discussed below.
29046
29047 .vitem &*header_line&~*header_last*&
29048 A pointer to the last of the header lines.
29049
29050 .vitem &*uschar&~*headers_charset*&
29051 The value of the &%headers_charset%& configuration option.
29052
29053 .vitem &*BOOL&~host_checking*&
29054 This variable is TRUE during a host checking session that is initiated by the
29055 &%-bh%& command line option.
29056
29057 .vitem &*uschar&~*interface_address*&
29058 The IP address of the interface that received the message, as a string. This
29059 is NULL for locally submitted messages.
29060
29061 .vitem &*int&~interface_port*&
29062 The port on which this message was received. When testing with the &%-bh%&
29063 command line option, the value of this variable is -1 unless a port has been
29064 specified via the &%-oMi%& option.
29065
29066 .vitem &*uschar&~*message_id*&
29067 This variable contains Exim's message id for the incoming message (the value of
29068 &$message_exim_id$&) as a zero-terminated string.
29069
29070 .vitem &*uschar&~*received_protocol*&
29071 The name of the protocol by which the message was received.
29072
29073 .vitem &*int&~recipients_count*&
29074 The number of accepted recipients.
29075
29076 .vitem &*recipient_item&~*recipients_list*&
29077 .cindex "recipient" "adding in local scan"
29078 .cindex "recipient" "removing in local scan"
29079 The list of accepted recipients, held in a vector of length
29080 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
29081 can add additional recipients by calling &'receive_add_recipient()'& (see
29082 below). You can delete recipients by removing them from the vector and
29083 adjusting the value in &%recipients_count%&. In particular, by setting
29084 &%recipients_count%& to zero you remove all recipients. If you then return the
29085 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
29086 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
29087 and then call &'receive_add_recipient()'& as often as needed.
29088
29089 .vitem &*uschar&~*sender_address*&
29090 The envelope sender address. For bounce messages this is the empty string.
29091
29092 .vitem &*uschar&~*sender_host_address*&
29093 The IP address of the sending host, as a string. This is NULL for
29094 locally-submitted messages.
29095
29096 .vitem &*uschar&~*sender_host_authenticated*&
29097 The name of the authentication mechanism that was used, or NULL if the message
29098 was not received over an authenticated SMTP connection.
29099
29100 .vitem &*uschar&~*sender_host_name*&
29101 The name of the sending host, if known.
29102
29103 .vitem &*int&~sender_host_port*&
29104 The port on the sending host.
29105
29106 .vitem &*BOOL&~smtp_input*&
29107 This variable is TRUE for all SMTP input, including BSMTP.
29108
29109 .vitem &*BOOL&~smtp_batched_input*&
29110 This variable is TRUE for BSMTP input.
29111
29112 .vitem &*int&~store_pool*&
29113 The contents of this variable control which pool of memory is used for new
29114 requests. See section &<<SECTmemhanloc>>& for details.
29115 .endlist
29116
29117
29118 .section "Structure of header lines" "SECID209"
29119 The &%header_line%& structure contains the members listed below.
29120 You can add additional header lines by calling the &'header_add()'& function
29121 (see below). You can cause header lines to be ignored (deleted) by setting
29122 their type to *.
29123
29124
29125 .vlist
29126 .vitem &*struct&~header_line&~*next*&
29127 A pointer to the next header line, or NULL for the last line.
29128
29129 .vitem &*int&~type*&
29130 A code identifying certain headers that Exim recognizes. The codes are printing
29131 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
29132 Notice in particular that any header line whose type is * is not transmitted
29133 with the message. This flagging is used for header lines that have been
29134 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
29135 lines.) Effectively, * means &"deleted"&.
29136
29137 .vitem &*int&~slen*&
29138 The number of characters in the header line, including the terminating and any
29139 internal newlines.
29140
29141 .vitem &*uschar&~*text*&
29142 A pointer to the text of the header. It always ends with a newline, followed by
29143 a zero byte. Internal newlines are preserved.
29144 .endlist
29145
29146
29147
29148 .section "Structure of recipient items" "SECID210"
29149 The &%recipient_item%& structure contains these members:
29150
29151 .vlist
29152 .vitem &*uschar&~*address*&
29153 This is a pointer to the recipient address as it was received.
29154
29155 .vitem &*int&~pno*&
29156 This is used in later Exim processing when top level addresses are created by
29157 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
29158 and must always contain -1 at this stage.
29159
29160 .vitem &*uschar&~*errors_to*&
29161 If this value is not NULL, bounce messages caused by failing to deliver to the
29162 recipient are sent to the address it contains. In other words, it overrides the
29163 envelope sender for this one recipient. (Compare the &%errors_to%& generic
29164 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
29165 an unqualified address, Exim qualifies it using the domain from
29166 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
29167 is NULL for all recipients.
29168 .endlist
29169
29170
29171
29172 .section "Available Exim functions" "SECID211"
29173 .cindex "&[local_scan()]& function" "available Exim functions"
29174 The header &_local_scan.h_& gives you access to a number of Exim functions.
29175 These are the only ones that are guaranteed to be maintained from release to
29176 release:
29177
29178 .vlist
29179 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
29180        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
29181
29182 This function creates a child process that runs the command specified by
29183 &%argv%&. The environment for the process is specified by &%envp%&, which can
29184 be NULL if no environment variables are to be passed. A new umask is supplied
29185 for the process in &%newumask%&.
29186
29187 Pipes to the standard input and output of the new process are set up
29188 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
29189 standard error is cloned to the standard output. If there are any file
29190 descriptors &"in the way"& in the new process, they are closed. If the final
29191 argument is TRUE, the new process is made into a process group leader.
29192
29193 The function returns the pid of the new process, or -1 if things go wrong.
29194
29195 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
29196 This function waits for a child process to terminate, or for a timeout (in
29197 seconds) to expire. A timeout value of zero means wait as long as it takes. The
29198 return value is as follows:
29199
29200 .ilist
29201 >= 0
29202
29203 The process terminated by a normal exit and the value is the process
29204 ending status.
29205
29206 .next
29207 < 0 and > &--256
29208
29209 The process was terminated by a signal and the value is the negation of the
29210 signal number.
29211
29212 .next
29213 &--256
29214
29215 The process timed out.
29216 .next
29217 &--257
29218
29219 The was some other error in wait(); &%errno%& is still set.
29220 .endlist
29221
29222 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
29223 This function provide you with a means of submitting a new message to
29224 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
29225 want, but this packages it all up for you.) The function creates a pipe,
29226 forks a subprocess that is running
29227 .code
29228 exim -t -oem -oi -f <>
29229 .endd
29230 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
29231 that is connected to the standard input. The yield of the function is the PID
29232 of the subprocess. You can then write a message to the file descriptor, with
29233 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
29234
29235 When you have finished, call &'child_close()'& to wait for the process to
29236 finish and to collect its ending status. A timeout value of zero is usually
29237 fine in this circumstance. Unless you have made a mistake with the recipient
29238 addresses, you should get a return code of zero.
29239
29240
29241 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
29242        *sender_authentication)*&
29243 This function is a more sophisticated version of &'child_open()'&. The command
29244 that it runs is:
29245 .display
29246 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
29247 .endd
29248 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
29249
29250
29251 .vitem &*void&~debug_printf(char&~*,&~...)*&
29252 This is Exim's debugging function, with arguments as for &'(printf()'&. The
29253 output is written to the standard error stream. If no debugging is selected,
29254 calls to &'debug_printf()'& have no effect. Normally, you should make calls
29255 conditional on the &`local_scan`& debug selector by coding like this:
29256 .code
29257 if ((debug_selector & D_local_scan) != 0)
29258   debug_printf("xxx", ...);
29259 .endd
29260
29261 .vitem &*uschar&~*expand_string(uschar&~*string)*&
29262 This is an interface to Exim's string expansion code. The return value is the
29263 expanded string, or NULL if there was an expansion failure.
29264 The C variable &%expand_string_message%& contains an error message after an
29265 expansion failure. If expansion does not change the string, the return value is
29266 the pointer to the input string. Otherwise, the return value points to a new
29267 block of memory that was obtained by a call to &'store_get()'&. See section
29268 &<<SECTmemhanloc>>& below for a discussion of memory handling.
29269
29270 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
29271 This function allows you to an add additional header line at the end of the
29272 existing ones. The first argument is the type, and should normally be a space
29273 character. The second argument is a format string and any number of
29274 substitution arguments as for &[sprintf()]&. You may include internal newlines
29275 if you want, and you must ensure that the string ends with a newline.
29276
29277 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
29278         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
29279 This function adds a new header line at a specified point in the header
29280 chain. The header itself is specified as for &'header_add()'&.
29281
29282 If &%name%& is NULL, the new header is added at the end of the chain if
29283 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
29284 NULL, the header lines are searched for the first non-deleted header that
29285 matches the name. If one is found, the new header is added before it if
29286 &%after%& is false. If &%after%& is true, the new header is added after the
29287 found header and any adjacent subsequent ones with the same name (even if
29288 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
29289 option controls where the header is added. If it is true, addition is at the
29290 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
29291 headers, or at the top if there are no &'Received:'& headers, you could use
29292 .code
29293 header_add_at_position(TRUE, US"Received", TRUE,
29294   ' ', "X-xxx: ...");
29295 .endd
29296 Normally, there is always at least one non-deleted &'Received:'& header, but
29297 there may not be if &%received_header_text%& expands to an empty string.
29298
29299
29300 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
29301 This function removes header lines. If &%occurrence%& is zero or negative, all
29302 occurrences of the header are removed. If occurrence is greater than zero, that
29303 particular instance of the header is removed. If no header(s) can be found that
29304 match the specification, the function does nothing.
29305
29306
29307 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
29308         int&~length,&~BOOL&~notdel)*&"
29309 This function tests whether the given header has the given name. It is not just
29310 a string comparison, because white space is permitted between the name and the
29311 colon. If the &%notdel%& argument is true, a false return is forced for all
29312 &"deleted"& headers; otherwise they are not treated specially. For example:
29313 .code
29314 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
29315 .endd
29316 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
29317 .cindex "base64 encoding" "functions for &[local_scan()]& use"
29318 This function base64-encodes a string, which is passed by address and length.
29319 The text may contain bytes of any value, including zero. The result is passed
29320 back in dynamic memory that is obtained by calling &'store_get()'&. It is
29321 zero-terminated.
29322
29323 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
29324 This function decodes a base64-encoded string. Its arguments are a
29325 zero-terminated base64-encoded string and the address of a variable that is set
29326 to point to the result, which is in dynamic memory. The length of the decoded
29327 string is the yield of the function. If the input is invalid base64 data, the
29328 yield is -1. A zero byte is added to the end of the output string to make it
29329 easy to interpret as a C string (assuming it contains no zeros of its own). The
29330 added zero byte is not included in the returned count.
29331
29332 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
29333 This function checks for a match in a domain list. Domains are always
29334 matched caselessly. The return value is one of the following:
29335 .display
29336 &`OK     `& match succeeded
29337 &`FAIL   `& match failed
29338 &`DEFER  `& match deferred
29339 .endd
29340 DEFER is usually caused by some kind of lookup defer, such as the
29341 inability to contact a database.
29342
29343 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
29344         BOOL&~caseless)*&"
29345 This function checks for a match in a local part list. The third argument
29346 controls case-sensitivity. The return values are as for
29347 &'lss_match_domain()'&.
29348
29349 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
29350         BOOL&~caseless)*&"
29351 This function checks for a match in an address list. The third argument
29352 controls the case-sensitivity of the local part match. The domain is always
29353 matched caselessly. The return values are as for &'lss_match_domain()'&.
29354
29355 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
29356         uschar&~*list)*&"
29357 This function checks for a match in a host list. The most common usage is
29358 expected to be
29359 .code
29360 lss_match_host(sender_host_name, sender_host_address, ...)
29361 .endd
29362 .vindex "&$sender_host_address$&"
29363 An empty address field matches an empty item in the host list. If the host name
29364 is NULL, the name corresponding to &$sender_host_address$& is automatically
29365 looked up if a host name is required to match an item in the list. The return
29366 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
29367 returns ERROR in the case when it had to look up a host name, but the lookup
29368 failed.
29369
29370 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
29371         *format,&~...)*&"
29372 This function writes to Exim's log files. The first argument should be zero (it
29373 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
29374 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
29375 them. It specifies to which log or logs the message is written. The remaining
29376 arguments are a format and relevant insertion arguments. The string should not
29377 contain any newlines, not even at the end.
29378
29379
29380 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
29381 This function adds an additional recipient to the message. The first argument
29382 is the recipient address. If it is unqualified (has no domain), it is qualified
29383 with the &%qualify_recipient%& domain. The second argument must always be -1.
29384
29385 This function does not allow you to specify a private &%errors_to%& address (as
29386 described with the structure of &%recipient_item%& above), because it pre-dates
29387 the addition of that field to the structure. However, it is easy to add such a
29388 value afterwards. For example:
29389 .code
29390  receive_add_recipient(US"monitor@mydom.example", -1);
29391  recipients_list[recipients_count-1].errors_to =
29392    US"postmaster@mydom.example";
29393 .endd
29394
29395 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
29396 This is a convenience function to remove a named recipient from the list of
29397 recipients. It returns true if a recipient was removed, and false if no
29398 matching recipient could be found. The argument must be a complete email
29399 address.
29400 .endlist
29401
29402
29403 .cindex "RFC 2047"
29404 .vlist
29405 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
29406   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
29407 This function decodes strings that are encoded according to RFC 2047. Typically
29408 these are the contents of header lines. First, each &"encoded word"& is decoded
29409 from the Q or B encoding into a byte-string. Then, if provided with the name of
29410 a charset encoding, and if the &[iconv()]& function is available, an attempt is
29411 made  to translate the result to the named character set. If this fails, the
29412 binary string is returned with an error message.
29413
29414 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
29415 maximum MIME word length is enforced. The third argument is the target
29416 encoding, or NULL if no translation is wanted.
29417
29418 .cindex "binary zero" "in RFC 2047 decoding"
29419 .cindex "RFC 2047" "binary zero in"
29420 If a binary zero is encountered in the decoded string, it is replaced by the
29421 contents of the &%zeroval%& argument. For use with Exim headers, the value must
29422 not be 0 because header lines are handled as zero-terminated strings.
29423
29424 The function returns the result of processing the string, zero-terminated; if
29425 &%lenptr%& is not NULL, the length of the result is set in the variable to
29426 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
29427
29428 If an error is encountered, the function returns NULL and uses the &%error%&
29429 argument to return an error message. The variable pointed to by &%error%& is
29430 set to NULL if there is no error; it may be set non-NULL even when the function
29431 returns a non-NULL value if decoding was successful, but there was a problem
29432 with translation.
29433
29434
29435 .vitem &*int&~smtp_fflush(void)*&
29436 This function is used in conjunction with &'smtp_printf()'&, as described
29437 below.
29438
29439 .vitem &*void&~smtp_printf(char&~*,&~...)*&
29440 The arguments of this function are like &[printf()]&; it writes to the SMTP
29441 output stream. You should use this function only when there is an SMTP output
29442 stream, that is, when the incoming message is being received via interactive
29443 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
29444 is FALSE. If you want to test for an incoming message from another host (as
29445 opposed to a local process that used the &%-bs%& command line option), you can
29446 test the value of &%sender_host_address%&, which is non-NULL when a remote host
29447 is involved.
29448
29449 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
29450 output function, so it can be used for all forms of SMTP connection.
29451
29452 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
29453 must start with an appropriate response code: 550 if you are going to return
29454 LOCAL_SCAN_REJECT, 451 if you are going to return
29455 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
29456 initial lines of a multi-line response, the code must be followed by a hyphen
29457 to indicate that the line is not the final response line. You must also ensure
29458 that the lines you write terminate with CRLF. For example:
29459 .code
29460 smtp_printf("550-this is some extra info\r\n");
29461 return LOCAL_SCAN_REJECT;
29462 .endd
29463 Note that you can also create multi-line responses by including newlines in
29464 the data returned via the &%return_text%& argument. The added value of using
29465 &'smtp_printf()'& is that, for instance, you could introduce delays between
29466 multiple output lines.
29467
29468 The &'smtp_printf()'& function does not return any error indication, because it
29469 does not automatically flush pending output, and therefore does not test
29470 the state of the stream. (In the main code of Exim, flushing and error
29471 detection is done when Exim is ready for the next SMTP input command.) If
29472 you want to flush the output and check for an error (for example, the
29473 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
29474 arguments. It flushes the output stream, and returns a non-zero value if there
29475 is an error.
29476
29477 .vitem &*void&~*store_get(int)*&
29478 This function accesses Exim's internal store (memory) manager. It gets a new
29479 chunk of memory whose size is given by the argument. Exim bombs out if it ever
29480 runs out of memory. See the next section for a discussion of memory handling.
29481
29482 .vitem &*void&~*store_get_perm(int)*&
29483 This function is like &'store_get()'&, but it always gets memory from the
29484 permanent pool. See the next section for a discussion of memory handling.
29485
29486 .vitem &*uschar&~*string_copy(uschar&~*string)*&
29487 See below.
29488
29489 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
29490 See below.
29491
29492 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
29493 These three functions create strings using Exim's dynamic memory facilities.
29494 The first makes a copy of an entire string. The second copies up to a maximum
29495 number of characters, indicated by the second argument. The third uses a format
29496 and insertion arguments to create a new string. In each case, the result is a
29497 pointer to a new string in the current memory pool. See the next section for
29498 more discussion.
29499 .endlist
29500
29501
29502
29503 .section "More about Exim's memory handling" "SECTmemhanloc"
29504 .cindex "&[local_scan()]& function" "memory handling"
29505 No function is provided for freeing memory, because that is never needed.
29506 The dynamic memory that Exim uses when receiving a message is automatically
29507 recycled if another message is received by the same process (this applies only
29508 to incoming SMTP connections &-- other input methods can supply only one
29509 message at a time). After receiving the last message, a reception process
29510 terminates.
29511
29512 Because it is recycled, the normal dynamic memory cannot be used for holding
29513 data that must be preserved over a number of incoming messages on the same SMTP
29514 connection. However, Exim in fact uses two pools of dynamic memory; the second
29515 one is not recycled, and can be used for this purpose.
29516
29517 If you want to allocate memory that remains available for subsequent messages
29518 in the same SMTP connection, you should set
29519 .code
29520 store_pool = POOL_PERM
29521 .endd
29522 before calling the function that does the allocation. There is no need to
29523 restore the value if you do not need to; however, if you do want to revert to
29524 the normal pool, you can either restore the previous value of &%store_pool%& or
29525 set it explicitly to POOL_MAIN.
29526
29527 The pool setting applies to all functions that get dynamic memory, including
29528 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
29529 There is also a convenience function called &'store_get_perm()'& that gets a
29530 block of memory from the permanent pool while preserving the value of
29531 &%store_pool%&.
29532 .ecindex IIDlosca
29533
29534
29535
29536
29537 . ////////////////////////////////////////////////////////////////////////////
29538 . ////////////////////////////////////////////////////////////////////////////
29539
29540 .chapter "System-wide message filtering" "CHAPsystemfilter"
29541 .scindex IIDsysfil1 "filter" "system filter"
29542 .scindex IIDsysfil2 "filtering all mail"
29543 .scindex IIDsysfil3 "system filter"
29544 The previous chapters (on ACLs and the local scan function) describe checks
29545 that can be applied to messages before they are accepted by a host. There is
29546 also a mechanism for checking messages once they have been received, but before
29547 they are delivered. This is called the &'system filter'&.
29548
29549 The system filter operates in a similar manner to users' filter files, but it
29550 is run just once per message (however many recipients the message has).
29551 It should not normally be used as a substitute for routing, because &%deliver%&
29552 commands in a system router provide new envelope recipient addresses.
29553 The system filter must be an Exim filter. It cannot be a Sieve filter.
29554
29555 The system filter is run at the start of a delivery attempt, before any routing
29556 is done. If a message fails to be completely delivered at the first attempt,
29557 the system filter is run again at the start of every retry.
29558 If you want your filter to do something only once per message, you can make use
29559 of the &%first_delivery%& condition in an &%if%& command in the filter to
29560 prevent it happening on retries.
29561
29562 .vindex "&$domain$&"
29563 .vindex "&$local_part$&"
29564 &*Warning*&: Because the system filter runs just once, variables that are
29565 specific to individual recipient addresses, such as &$local_part$& and
29566 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
29567 you want to run a centrally-specified filter for each recipient address
29568 independently, you can do so by setting up a suitable &(redirect)& router, as
29569 described in section &<<SECTperaddfil>>& below.
29570
29571
29572 .section "Specifying a system filter" "SECID212"
29573 .cindex "uid (user id)" "system filter"
29574 .cindex "gid (group id)" "system filter"
29575 The name of the file that contains the system filter must be specified by
29576 setting &%system_filter%&. If you want the filter to run under a uid and gid
29577 other than root, you must also set &%system_filter_user%& and
29578 &%system_filter_group%& as appropriate. For example:
29579 .code
29580 system_filter = /etc/mail/exim.filter
29581 system_filter_user = exim
29582 .endd
29583 If a system filter generates any deliveries directly to files or pipes (via the
29584 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
29585 specified by setting &%system_filter_file_transport%& and
29586 &%system_filter_pipe_transport%&, respectively. Similarly,
29587 &%system_filter_reply_transport%& must be set to handle any messages generated
29588 by the &%reply%& command.
29589
29590
29591 .section "Testing a system filter" "SECID213"
29592 You can run simple tests of a system filter in the same way as for a user
29593 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
29594 are permitted only in system filters are recognized.
29595
29596 If you want to test the combined effect of a system filter and a user filter,
29597 you can use both &%-bF%& and &%-bf%& on the same command line.
29598
29599
29600
29601 .section "Contents of a system filter" "SECID214"
29602 The language used to specify system filters is the same as for users' filter
29603 files. It is described in the separate end-user document &'Exim's interface to
29604 mail filtering'&. However, there are some additional features that are
29605 available only in system filters; these are described in subsequent sections.
29606 If they are encountered in a user's filter file or when testing with &%-bf%&,
29607 they cause errors.
29608
29609 .cindex "frozen messages" "manual thaw; testing in filter"
29610 There are two special conditions which, though available in users' filter
29611 files, are designed for use in system filters. The condition &%first_delivery%&
29612 is true only for the first attempt at delivering a message, and
29613 &%manually_thawed%& is true only if the message has been frozen, and
29614 subsequently thawed by an admin user. An explicit forced delivery counts as a
29615 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
29616
29617 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
29618 specify an &"unseen"& (non-significant) delivery, and that delivery does not
29619 succeed, it will not be tried again.
29620 If you want Exim to retry an unseen delivery until it succeeds, you should
29621 arrange to set it up every time the filter runs.
29622
29623 When a system filter finishes running, the values of the variables &$n0$& &--
29624 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
29625 users' filter files. Thus a system filter can, for example, set up &"scores"&
29626 to which users' filter files can refer.
29627
29628
29629
29630 .section "Additional variable for system filters" "SECID215"
29631 .vindex "&$recipients$&"
29632 The expansion variable &$recipients$&, containing a list of all the recipients
29633 of the message (separated by commas and white space), is available in system
29634 filters. It is not available in users' filters for privacy reasons.
29635
29636
29637
29638 .section "Defer, freeze, and fail commands for system filters" "SECID216"
29639 .cindex "freezing messages"
29640 .cindex "message" "freezing"
29641 .cindex "message" "forced failure"
29642 .cindex "&%fail%&" "in system filter"
29643 .cindex "&%freeze%& in system filter"
29644 .cindex "&%defer%& in system filter"
29645 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
29646 always available in system filters, but are not normally enabled in users'
29647 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
29648 for the &(redirect)& router.) These commands can optionally be followed by the
29649 word &%text%& and a string containing an error message, for example:
29650 .code
29651 fail text "this message looks like spam to me"
29652 .endd
29653 The keyword &%text%& is optional if the next character is a double quote.
29654
29655 The &%defer%& command defers delivery of the original recipients of the
29656 message. The &%fail%& command causes all the original recipients to be failed,
29657 and a bounce message to be created. The &%freeze%& command suspends all
29658 delivery attempts for the original recipients. In all cases, any new deliveries
29659 that are specified by the filter are attempted as normal after the filter has
29660 run.
29661
29662 The &%freeze%& command is ignored if the message has been manually unfrozen and
29663 not manually frozen since. This means that automatic freezing by a system
29664 filter can be used as a way of checking out suspicious messages. If a message
29665 is found to be all right, manually unfreezing it allows it to be delivered.
29666
29667 .cindex "log" "&%fail%& command log line"
29668 .cindex "&%fail%&" "log line; reducing"
29669 The text given with a fail command is used as part of the bounce message as
29670 well as being written to the log. If the message is quite long, this can fill
29671 up a lot of log space when such failures are common. To reduce the size of the
29672 log message, Exim interprets the text in a special way if it starts with the
29673 two characters &`<<`& and contains &`>>`& later. The text between these two
29674 strings is written to the log, and the rest of the text is used in the bounce
29675 message. For example:
29676 .code
29677 fail "<<filter test 1>>Your message is rejected \
29678      because it contains attachments that we are \
29679      not prepared to receive."
29680 .endd
29681
29682 .cindex "loop" "caused by &%fail%&"
29683 Take great care with the &%fail%& command when basing the decision to fail on
29684 the contents of the message, because the bounce message will of course include
29685 the contents of the original message and will therefore trigger the &%fail%&
29686 command again (causing a mail loop) unless steps are taken to prevent this.
29687 Testing the &%error_message%& condition is one way to prevent this. You could
29688 use, for example
29689 .code
29690 if $message_body contains "this is spam" and not error_message
29691 then fail text "spam is not wanted here" endif
29692 .endd
29693 though of course that might let through unwanted bounce messages. The
29694 alternative is clever checking of the body and/or headers to detect bounces
29695 generated by the filter.
29696
29697 The interpretation of a system filter file ceases after a
29698 &%defer%&,
29699 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
29700 set up earlier in the filter file are honoured, so you can use a sequence such
29701 as
29702 .code
29703 mail ...
29704 freeze
29705 .endd
29706 to send a specified message when the system filter is freezing (or deferring or
29707 failing) a message. The normal deliveries for the message do not, of course,
29708 take place.
29709
29710
29711
29712 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
29713 .cindex "header lines" "adding; in system filter"
29714 .cindex "header lines" "removing; in system filter"
29715 .cindex "filter" "header lines; adding/removing"
29716 Two filter commands that are available only in system filters are:
29717 .code
29718 headers add <string>
29719 headers remove <string>
29720 .endd
29721 The argument for the &%headers add%& is a string that is expanded and then
29722 added to the end of the message's headers. It is the responsibility of the
29723 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
29724 space is ignored, and if the string is otherwise empty, or if the expansion is
29725 forced to fail, the command has no effect.
29726
29727 You can use &"\n"& within the string, followed by white space, to specify
29728 continued header lines. More than one header may be added in one command by
29729 including &"\n"& within the string without any following white space. For
29730 example:
29731 .code
29732 headers add "X-header-1: ....\n  \
29733              continuation of X-header-1 ...\n\
29734              X-header-2: ...."
29735 .endd
29736 Note that the header line continuation white space after the first newline must
29737 be placed before the backslash that continues the input string, because white
29738 space after input continuations is ignored.
29739
29740 The argument for &%headers remove%& is a colon-separated list of header names.
29741 This command applies only to those headers that are stored with the message;
29742 those that are added at delivery time (such as &'Envelope-To:'& and
29743 &'Return-Path:'&) cannot be removed by this means. If there is more than one
29744 header with the same name, they are all removed.
29745
29746 The &%headers%& command in a system filter makes an immediate change to the set
29747 of header lines that was received with the message (with possible additions
29748 from ACL processing). Subsequent commands in the system filter operate on the
29749 modified set, which also forms the basis for subsequent message delivery.
29750 Unless further modified during routing or transporting, this set of headers is
29751 used for all recipients of the message.
29752
29753 During routing and transporting, the variables that refer to the contents of
29754 header lines refer only to those lines that are in this set. Thus, header lines
29755 that are added by a system filter are visible to users' filter files and to all
29756 routers and transports. This contrasts with the manipulation of header lines by
29757 routers and transports, which is not immediate, but which instead is saved up
29758 until the message is actually being written (see section
29759 &<<SECTheadersaddrem>>&).
29760
29761 If the message is not delivered at the first attempt, header lines that were
29762 added by the system filter are stored with the message, and so are still
29763 present at the next delivery attempt. Header lines that were removed are still
29764 present, but marked &"deleted"& so that they are not transported with the
29765 message. For this reason, it is usual to make the &%headers%& command
29766 conditional on &%first_delivery%& so that the set of header lines is not
29767 modified more than once.
29768
29769 Because header modification in a system filter acts immediately, you have to
29770 use an indirect approach if you want to modify the contents of a header line.
29771 For example:
29772 .code
29773 headers add "Old-Subject: $h_subject:"
29774 headers remove "Subject"
29775 headers add "Subject: new subject (was: $h_old-subject:)"
29776 headers remove "Old-Subject"
29777 .endd
29778
29779
29780
29781 .section "Setting an errors address in a system filter" "SECID217"
29782 .cindex "envelope sender"
29783 In a system filter, if a &%deliver%& command is followed by
29784 .code
29785 errors_to <some address>
29786 .endd
29787 in order to change the envelope sender (and hence the error reporting) for that
29788 delivery, any address may be specified. (In a user filter, only the current
29789 user's address can be set.) For example, if some mail is being monitored, you
29790 might use
29791 .code
29792 unseen deliver monitor@spying.example errors_to root@local.example
29793 .endd
29794 to take a copy which would not be sent back to the normal error reporting
29795 address if its delivery failed.
29796
29797
29798
29799 .section "Per-address filtering" "SECTperaddfil"
29800 .vindex "&$domain$&"
29801 .vindex "&$local_part$&"
29802 In contrast to the system filter, which is run just once per message for each
29803 delivery attempt, it is also possible to set up a system-wide filtering
29804 operation that runs once for each recipient address. In this case, variables
29805 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
29806 filter file could be made dependent on them. This is an example of a router
29807 which implements such a filter:
29808 .code
29809 central_filter:
29810   check_local_user
29811   driver = redirect
29812   domains = +local_domains
29813   file = /central/filters/$local_part
29814   no_verify
29815   allow_filter
29816   allow_freeze
29817 .endd
29818 The filter is run in a separate process under its own uid. Therefore, either
29819 &%check_local_user%& must be set (as above), in which case the filter is run as
29820 the local user, or the &%user%& option must be used to specify which user to
29821 use. If both are set, &%user%& overrides.
29822
29823 Care should be taken to ensure that none of the commands in the filter file
29824 specify a significant delivery if the message is to go on to be delivered to
29825 its intended recipient. The router will not then claim to have dealt with the
29826 address, so it will be passed on to subsequent routers to be delivered in the
29827 normal way.
29828 .ecindex IIDsysfil1
29829 .ecindex IIDsysfil2
29830 .ecindex IIDsysfil3
29831
29832
29833
29834
29835
29836
29837 . ////////////////////////////////////////////////////////////////////////////
29838 . ////////////////////////////////////////////////////////////////////////////
29839
29840 .chapter "Message processing" "CHAPmsgproc"
29841 .scindex IIDmesproc "message" "general processing"
29842 Exim performs various transformations on the sender and recipient addresses of
29843 all messages that it handles, and also on the messages' header lines. Some of
29844 these are optional and configurable, while others always take place. All of
29845 this processing, except rewriting as a result of routing, and the addition or
29846 removal of header lines while delivering, happens when a message is received,
29847 before it is placed on Exim's queue.
29848
29849 Some of the automatic processing takes place by default only for
29850 &"locally-originated"& messages. This adjective is used to describe messages
29851 that are not received over TCP/IP, but instead are passed to an Exim process on
29852 its standard input. This includes the interactive &"local SMTP"& case that is
29853 set up by the &%-bs%& command line option.
29854
29855 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
29856 or ::1) are not considered to be locally-originated. Exim does not treat the
29857 loopback interface specially in any way.
29858
29859 If you want the loopback interface to be treated specially, you must ensure
29860 that there are appropriate entries in your ACLs.
29861
29862
29863
29864
29865 .section "Submission mode for non-local messages" "SECTsubmodnon"
29866 .cindex "message" "submission"
29867 .cindex "submission mode"
29868 Processing that happens automatically for locally-originated messages (unless
29869 &%suppress_local_fixups%& is set) can also be requested for messages that are
29870 received over TCP/IP. The term &"submission mode"& is used to describe this
29871 state. Submission mode is set by the modifier
29872 .code
29873 control = submission
29874 .endd
29875 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
29876 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
29877 a local submission, and is normally used when the source of the message is
29878 known to be an MUA running on a client host (as opposed to an MTA). For
29879 example, to set submission mode for messages originating on the IPv4 loopback
29880 interface, you could include the following in the MAIL ACL:
29881 .code
29882 warn  hosts = 127.0.0.1
29883       control = submission
29884 .endd
29885 .cindex "&%sender_retain%& submission option"
29886 There are some options that can be used when setting submission mode. A slash
29887 is used to separate options. For example:
29888 .code
29889 control = submission/sender_retain
29890 .endd
29891 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
29892 true and &%local_from_check%& false for the current incoming message. The first
29893 of these allows an existing &'Sender:'& header in the message to remain, and
29894 the second suppresses the check to ensure that &'From:'& matches the
29895 authenticated sender. With this setting, Exim still fixes up messages by adding
29896 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
29897 attempt to check sender authenticity in header lines.
29898
29899 When &%sender_retain%& is not set, a submission mode setting may specify a
29900 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
29901 example:
29902 .code
29903 control = submission/domain=some.domain
29904 .endd
29905 The domain may be empty. How this value is used is described in sections
29906 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
29907 that allows you to specify the user's full name for inclusion in a created
29908 &'Sender:'& or &'From:'& header line. For example:
29909 .code
29910 accept authenticated = *
29911        control = submission/domain=wonderland.example/\
29912                             name=${lookup {$authenticated_id} \
29913                                    lsearch {/etc/exim/namelist}}
29914 .endd
29915 Because the name may contain any characters, including slashes, the &%name%&
29916 option must be given last. The remainder of the string is used as the name. For
29917 the example above, if &_/etc/exim/namelist_& contains:
29918 .code
29919 bigegg:  Humpty Dumpty
29920 .endd
29921 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
29922 line would be:
29923 .code
29924 Sender: Humpty Dumpty <bigegg@wonderland.example>
29925 .endd
29926 .cindex "return path" "in submission mode"
29927 By default, submission mode forces the return path to the same address as is
29928 used to create the &'Sender:'& header. However, if &%sender_retain%& is
29929 specified, the return path is also left unchanged.
29930
29931 &*Note*&: The changes caused by submission mode take effect after the predata
29932 ACL. This means that any sender checks performed before the fix-ups use the
29933 untrusted sender address specified by the user, not the trusted sender address
29934 specified by submission mode. Although this might be slightly unexpected, it
29935 does mean that you can configure ACL checks to spot that a user is trying to
29936 spoof another's address.
29937
29938 .section "Line endings" "SECTlineendings"
29939 .cindex "line endings"
29940 .cindex "carriage return"
29941 .cindex "linefeed"
29942 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
29943 linefeed) is the line ending for messages transmitted over the Internet using
29944 SMTP over TCP/IP. However, within individual operating systems, different
29945 conventions are used. For example, Unix-like systems use just LF, but others
29946 use CRLF or just CR.
29947
29948 Exim was designed for Unix-like systems, and internally, it stores messages
29949 using the system's convention of a single LF as a line terminator. When
29950 receiving a message, all line endings are translated to this standard format.
29951 Originally, it was thought that programs that passed messages directly to an
29952 MTA within an operating system would use that system's convention. Experience
29953 has shown that this is not the case; for example, there are Unix applications
29954 that use CRLF in this circumstance. For this reason, and for compatibility with
29955 other MTAs, the way Exim handles line endings for all messages is now as
29956 follows:
29957
29958 .ilist
29959 LF not preceded by CR is treated as a line ending.
29960 .next
29961 CR is treated as a line ending; if it is immediately followed by LF, the LF
29962 is ignored.
29963 .next
29964 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
29965 nor a local message in the state where a line containing only a dot is a
29966 terminator.
29967 .next
29968 If a bare CR is encountered within a header line, an extra space is added after
29969 the line terminator so as not to end the header line. The reasoning behind this
29970 is that bare CRs in header lines are most likely either to be mistakes, or
29971 people trying to play silly games.
29972 .next
29973 If the first header line received in a message ends with CRLF, a subsequent
29974 bare LF in a header line is treated in the same way as a bare CR in a header
29975 line.
29976 .endlist
29977
29978
29979
29980
29981
29982 .section "Unqualified addresses" "SECID218"
29983 .cindex "unqualified addresses"
29984 .cindex "address" "qualification"
29985 By default, Exim expects every envelope address it receives from an external
29986 host to be fully qualified. Unqualified addresses cause negative responses to
29987 SMTP commands. However, because SMTP is used as a means of transporting
29988 messages from MUAs running on personal workstations, there is sometimes a
29989 requirement to accept unqualified addresses from specific hosts or IP networks.
29990
29991 Exim has two options that separately control which hosts may send unqualified
29992 sender or recipient addresses in SMTP commands, namely
29993 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
29994 cases, if an unqualified address is accepted, it is qualified by adding the
29995 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
29996
29997 .oindex "&%qualify_domain%&"
29998 .oindex "&%qualify_recipient%&"
29999 Unqualified addresses in header lines are automatically qualified for messages
30000 that are locally originated, unless the &%-bnq%& option is given on the command
30001 line. For messages received over SMTP, unqualified addresses in header lines
30002 are qualified only if unqualified addresses are permitted in SMTP commands. In
30003 other words, such qualification is also controlled by
30004 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
30005
30006
30007
30008
30009 .section "The UUCP From line" "SECID219"
30010 .cindex "&""From""& line"
30011 .cindex "UUCP" "&""From""& line"
30012 .cindex "sender" "address"
30013 .oindex "&%uucp_from_pattern%&"
30014 .oindex "&%uucp_from_sender%&"
30015 .cindex "envelope sender"
30016 .cindex "Sendmail compatibility" "&""From""& line"
30017 Messages that have come from UUCP (and some other applications) often begin
30018 with a line containing the envelope sender and a timestamp, following the word
30019 &"From"&. Examples of two common formats are:
30020 .code
30021 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
30022 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
30023 .endd
30024 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
30025 Exim recognizes such lines at the start of messages that are submitted to it
30026 via the command line (that is, on the standard input). It does not recognize
30027 such lines in incoming SMTP messages, unless the sending host matches
30028 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
30029 and &%ignore_fromline_local%& is set. The recognition is controlled by a
30030 regular expression that is defined by the &%uucp_from_pattern%& option, whose
30031 default value matches the two common cases shown above and puts the address
30032 that follows &"From"& into &$1$&.
30033
30034 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
30035 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
30036 a trusted user, the message's sender address is constructed by expanding the
30037 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
30038 then parsed as an RFC 2822 address. If there is no domain, the local part is
30039 qualified with &%qualify_domain%& unless it is the empty string. However, if
30040 the command line &%-f%& option is used, it overrides the &"From"& line.
30041
30042 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
30043 sender address is not changed. This is also the case for incoming SMTP messages
30044 that are permitted to contain &"From"& lines.
30045
30046 Only one &"From"& line is recognized. If there is more than one, the second is
30047 treated as a data line that starts the body of the message, as it is not valid
30048 as a header line. This also happens if a &"From"& line is present in an
30049 incoming SMTP message from a source that is not permitted to send them.
30050
30051
30052
30053 .section "Resent- header lines" "SECID220"
30054 .cindex "&%Resent-%& header lines"
30055 RFC 2822 makes provision for sets of header lines starting with the string
30056 &`Resent-`& to be added to a message when it is resent by the original
30057 recipient to somebody else. These headers are &'Resent-Date:'&,
30058 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
30059 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
30060
30061 .blockquote
30062 &'Resent fields are strictly informational. They MUST NOT be used in the normal
30063 processing of replies or other such automatic actions on messages.'&
30064 .endblockquote
30065
30066 This leaves things a bit vague as far as other processing actions such as
30067 address rewriting are concerned. Exim treats &%Resent-%& header lines as
30068 follows:
30069
30070 .ilist
30071 A &'Resent-From:'& line that just contains the login id of the submitting user
30072 is automatically rewritten in the same way as &'From:'& (see below).
30073 .next
30074 If there's a rewriting rule for a particular header line, it is also applied to
30075 &%Resent-%& header lines of the same type. For example, a rule that rewrites
30076 &'From:'& also rewrites &'Resent-From:'&.
30077 .next
30078 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
30079 also removed.
30080 .next
30081 For a locally-submitted message,
30082 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
30083 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
30084 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
30085 included in log lines in this case.
30086 .next
30087 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
30088 &%Resent-%& header lines are present.
30089 .endlist
30090
30091
30092
30093
30094 .section "The Auto-Submitted: header line" "SECID221"
30095 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
30096 includes the header line:
30097 .code
30098 Auto-Submitted: auto-replied
30099 .endd
30100
30101 .section "The Bcc: header line" "SECID222"
30102 .cindex "&'Bcc:'& header line"
30103 If Exim is called with the &%-t%& option, to take recipient addresses from a
30104 message's header, it removes any &'Bcc:'& header line that may exist (after
30105 extracting its addresses). If &%-t%& is not present on the command line, any
30106 existing &'Bcc:'& is not removed.
30107
30108
30109 .section "The Date: header line" "SECID223"
30110 .cindex "&'Date:'& header line"
30111 If a locally-generated or submission-mode message has no &'Date:'& header line,
30112 Exim adds one, using the current date and time, unless the
30113 &%suppress_local_fixups%& control has been specified.
30114
30115 .section "The Delivery-date: header line" "SECID224"
30116 .cindex "&'Delivery-date:'& header line"
30117 .oindex "&%delivery_date_remove%&"
30118 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
30119 set. Exim can be configured to add them to the final delivery of messages. (See
30120 the generic &%delivery_date_add%& transport option.) They should not be present
30121 in messages in transit. If the &%delivery_date_remove%& configuration option is
30122 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
30123 messages.
30124
30125
30126 .section "The Envelope-to: header line" "SECID225"
30127 .cindex "&'Envelope-to:'& header line"
30128 .oindex "&%envelope_to_remove%&"
30129 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
30130 Exim can be configured to add them to the final delivery of messages. (See the
30131 generic &%envelope_to_add%& transport option.) They should not be present in
30132 messages in transit. If the &%envelope_to_remove%& configuration option is set
30133 (the default), Exim removes &'Envelope-to:'& header lines from incoming
30134 messages.
30135
30136
30137 .section "The From: header line" "SECTthefrohea"
30138 .cindex "&'From:'& header line"
30139 .cindex "Sendmail compatibility" "&""From""& line"
30140 .cindex "message" "submission"
30141 .cindex "submission mode"
30142 If a submission-mode message does not contain a &'From:'& header line, Exim
30143 adds one if either of the following conditions is true:
30144
30145 .ilist
30146 The envelope sender address is not empty (that is, this is not a bounce
30147 message). The added header line copies the envelope sender address.
30148 .next
30149 .vindex "&$authenticated_id$&"
30150 The SMTP session is authenticated and &$authenticated_id$& is not empty.
30151 .olist
30152 .vindex "&$qualify_domain$&"
30153 If no domain is specified by the submission control, the local part is
30154 &$authenticated_id$& and the domain is &$qualify_domain$&.
30155 .next
30156 If a non-empty domain is specified by the submission control, the local
30157 part is &$authenticated_id$&, and the domain is the specified domain.
30158 .next
30159 If an empty domain is specified by the submission control,
30160 &$authenticated_id$& is assumed to be the complete address.
30161 .endlist
30162 .endlist
30163
30164 A non-empty envelope sender takes precedence.
30165
30166 If a locally-generated incoming message does not contain a &'From:'& header
30167 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
30168 containing the sender's address. The calling user's login name and full name
30169 are used to construct the address, as described in section &<<SECTconstr>>&.
30170 They are obtained from the password data by calling &[getpwuid()]& (but see the
30171 &%unknown_login%& configuration option). The address is qualified with
30172 &%qualify_domain%&.
30173
30174 For compatibility with Sendmail, if an incoming, non-SMTP message has a
30175 &'From:'& header line containing just the unqualified login name of the calling
30176 user, this is replaced by an address containing the user's login name and full
30177 name as described in section &<<SECTconstr>>&.
30178
30179
30180 .section "The Message-ID: header line" "SECID226"
30181 .cindex "&'Message-ID:'& header line"
30182 .cindex "message" "submission"
30183 .oindex "&%message_id_header_text%&"
30184 If a locally-generated or submission-mode incoming message does not contain a
30185 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
30186 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
30187 to the message. If there are any &'Resent-:'& headers in the message, it
30188 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
30189 message id, preceded by the letter E to ensure it starts with a letter, and
30190 followed by @ and the primary host name. Additional information can be included
30191 in this header line by setting the &%message_id_header_text%& and/or
30192 &%message_id_header_domain%& options.
30193
30194
30195 .section "The Received: header line" "SECID227"
30196 .cindex "&'Received:'& header line"
30197 A &'Received:'& header line is added at the start of every message. The
30198 contents are defined by the &%received_header_text%& configuration option, and
30199 Exim automatically adds a semicolon and a timestamp to the configured string.
30200
30201 The &'Received:'& header is generated as soon as the message's header lines
30202 have been received. At this stage, the timestamp in the &'Received:'& header
30203 line is the time that the message started to be received. This is the value
30204 that is seen by the DATA ACL and by the &[local_scan()]& function.
30205
30206 Once a message is accepted, the timestamp in the &'Received:'& header line is
30207 changed to the time of acceptance, which is (apart from a small delay while the
30208 -H spool file is written) the earliest time at which delivery could start.
30209
30210
30211 .section "The References: header line" "SECID228"
30212 .cindex "&'References:'& header line"
30213 Messages created by the &(autoreply)& transport include a &'References:'&
30214 header line. This is constructed according to the rules that are described in
30215 section 3.64 of RFC 2822 (which states that replies should contain such a
30216 header line), and section 3.14 of RFC 3834 (which states that automatic
30217 responses are not different in this respect). However, because some mail
30218 processing software does not cope well with very long header lines, no more
30219 than 12 message IDs are copied from the &'References:'& header line in the
30220 incoming message. If there are more than 12, the first one and then the final
30221 11 are copied, before adding the message ID of the incoming message.
30222
30223
30224
30225 .section "The Return-path: header line" "SECID229"
30226 .cindex "&'Return-path:'& header line"
30227 .oindex "&%return_path_remove%&"
30228 &'Return-path:'& header lines are defined as something an MTA may insert when
30229 it does the final delivery of messages. (See the generic &%return_path_add%&
30230 transport option.) Therefore, they should not be present in messages in
30231 transit. If the &%return_path_remove%& configuration option is set (the
30232 default), Exim removes &'Return-path:'& header lines from incoming messages.
30233
30234
30235
30236 .section "The Sender: header line" "SECTthesenhea"
30237 .cindex "&'Sender:'& header line"
30238 .cindex "message" "submission"
30239 For a locally-originated message from an untrusted user, Exim may remove an
30240 existing &'Sender:'& header line, and it may add a new one. You can modify
30241 these actions by setting the &%local_sender_retain%& option true, the
30242 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
30243 control setting.
30244
30245 When a local message is received from an untrusted user and
30246 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
30247 control has not been set, a check is made to see if the address given in the
30248 &'From:'& header line is the correct (local) sender of the message. The address
30249 that is expected has the login name as the local part and the value of
30250 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
30251 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
30252 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
30253 line is added to the message.
30254
30255 If you set &%local_from_check%& false, this checking does not occur. However,
30256 the removal of an existing &'Sender:'& line still happens, unless you also set
30257 &%local_sender_retain%& to be true. It is not possible to set both of these
30258 options true at the same time.
30259
30260 .cindex "submission mode"
30261 By default, no processing of &'Sender:'& header lines is done for messages
30262 received over TCP/IP or for messages submitted by trusted users. However, when
30263 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
30264 not specified on the submission control, the following processing takes place:
30265
30266 .vindex "&$authenticated_id$&"
30267 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
30268 authenticated, and &$authenticated_id$& is not empty, a sender address is
30269 created as follows:
30270
30271 .ilist
30272 .vindex "&$qualify_domain$&"
30273 If no domain is specified by the submission control, the local part is
30274 &$authenticated_id$& and the domain is &$qualify_domain$&.
30275 .next
30276 If a non-empty domain is specified by the submission control, the local part
30277 is &$authenticated_id$&, and the domain is the specified domain.
30278 .next
30279 If an empty domain is specified by the submission control,
30280 &$authenticated_id$& is assumed to be the complete address.
30281 .endlist
30282
30283 This address is compared with the address in the &'From:'& header line. If they
30284 are different, a &'Sender:'& header line containing the created address is
30285 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
30286 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
30287
30288 .cindex "return path" "created from &'Sender:'&"
30289 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
30290 the message (the envelope sender address) is changed to be the same address,
30291 except in the case of submission mode when &%sender_retain%& is specified.
30292
30293
30294
30295 .section "Adding and removing header lines in routers and transports" &&&
30296          "SECTheadersaddrem"
30297 .cindex "header lines" "adding; in router or transport"
30298 .cindex "header lines" "removing; in router or transport"
30299 When a message is delivered, the addition and removal of header lines can be
30300 specified in a system filter, or on any of the routers and transports that
30301 process the message. Section &<<SECTaddremheasys>>& contains details about
30302 modifying headers in a system filter. Header lines can also be added in an ACL
30303 as a message is received (see section &<<SECTaddheadacl>>&).
30304
30305 In contrast to what happens in a system filter, header modifications that are
30306 specified on routers and transports apply only to the particular recipient
30307 addresses that are being processed by those routers and transports. These
30308 changes do not actually take place until a copy of the message is being
30309 transported. Therefore, they do not affect the basic set of header lines, and
30310 they do not affect the values of the variables that refer to header lines.
30311
30312 &*Note*&: In particular, this means that any expansions in the configuration of
30313 the transport cannot refer to the modified header lines, because such
30314 expansions all occur before the message is actually transported.
30315
30316 For both routers and transports, the result of expanding a &%headers_add%&
30317 option must be in the form of one or more RFC 2822 header lines, separated by
30318 newlines (coded as &"\n"&). For example:
30319 .code
30320 headers_add = X-added-header: added by $primary_hostname\n\
30321               X-added-second: another added header line
30322 .endd
30323 Exim does not check the syntax of these added header lines.
30324
30325 The result of expanding &%headers_remove%& must consist of a colon-separated
30326 list of header names. This is confusing, because header names themselves are
30327 often terminated by colons. In this case, the colons are the list separators,
30328 not part of the names. For example:
30329 .code
30330 headers_remove = return-receipt-to:acknowledge-to
30331 .endd
30332 When &%headers_add%& or &%headers_remove%& is specified on a router, its value
30333 is expanded at routing time, and then associated with all addresses that are
30334 accepted by that router, and also with any new addresses that it generates. If
30335 an address passes through several routers as a result of aliasing or
30336 forwarding, the changes are cumulative.
30337
30338 .oindex "&%unseen%&"
30339 However, this does not apply to multiple routers that result from the use of
30340 the &%unseen%& option. Any header modifications that were specified by the
30341 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
30342
30343 Addresses that end up with different &%headers_add%& or &%headers_remove%&
30344 settings cannot be delivered together in a batch, so a transport is always
30345 dealing with a set of addresses that have the same header-processing
30346 requirements.
30347
30348 The transport starts by writing the original set of header lines that arrived
30349 with the message, possibly modified by the system filter. As it writes out
30350 these lines, it consults the list of header names that were attached to the
30351 recipient address(es) by &%headers_remove%& options in routers, and it also
30352 consults the transport's own &%headers_remove%& option. Header lines whose
30353 names are on either of these lists are not written out. If there are multiple
30354 instances of any listed header, they are all skipped.
30355
30356 After the remaining original header lines have been written, new header
30357 lines that were specified by routers' &%headers_add%& options are written, in
30358 the order in which they were attached to the address. These are followed by any
30359 header lines specified by the transport's &%headers_add%& option.
30360
30361 This way of handling header line modifications in routers and transports has
30362 the following consequences:
30363
30364 .ilist
30365 The original set of header lines, possibly modified by the system filter,
30366 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
30367 to it, at all times.
30368 .next
30369 Header lines that are added by a router's
30370 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
30371 expansion syntax in subsequent routers or the transport.
30372 .next
30373 Conversely, header lines that are specified for removal by &%headers_remove%&
30374 in a router remain visible to subsequent routers and the transport.
30375 .next
30376 Headers added to an address by &%headers_add%& in a router cannot be removed by
30377 a later router or by a transport.
30378 .next
30379 An added header can refer to the contents of an original header that is to be
30380 removed, even it has the same name as the added header. For example:
30381 .code
30382 headers_remove = subject
30383 headers_add = Subject: new subject (was: $h_subject:)
30384 .endd
30385 .endlist
30386
30387 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
30388 for a &(redirect)& router that has the &%one_time%& option set.
30389
30390
30391
30392
30393
30394 .section "Constructed addresses" "SECTconstr"
30395 .cindex "address" "constructed"
30396 .cindex "constructed address"
30397 When Exim constructs a sender address for a locally-generated message, it uses
30398 the form
30399 .display
30400 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
30401 .endd
30402 For example:
30403 .code
30404 Zaphod Beeblebrox <zaphod@end.univ.example>
30405 .endd
30406 The user name is obtained from the &%-F%& command line option if set, or
30407 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
30408 &"gecos"& field from the password entry. If the &"gecos"& field contains an
30409 ampersand character, this is replaced by the login name with the first letter
30410 upper cased, as is conventional in a number of operating systems. See the
30411 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
30412 The &%unknown_username%& option can be used to specify user names in cases when
30413 there is no password file entry.
30414
30415 .cindex "RFC 2047"
30416 In all cases, the user name is made to conform to RFC 2822 by quoting all or
30417 parts of it if necessary. In addition, if it contains any non-printing
30418 characters, it is encoded as described in RFC 2047, which defines a way of
30419 including non-ASCII characters in header lines. The value of the
30420 &%headers_charset%& option specifies the name of the encoding that is used (the
30421 characters are assumed to be in this encoding). The setting of
30422 &%print_topbitchars%& controls whether characters with the top bit set (that
30423 is, with codes greater than 127) count as printing characters or not.
30424
30425
30426
30427 .section "Case of local parts" "SECID230"
30428 .cindex "case of local parts"
30429 .cindex "local part" "case of"
30430 RFC 2822 states that the case of letters in the local parts of addresses cannot
30431 be assumed to be non-significant. Exim preserves the case of local parts of
30432 addresses, but by default it uses a lower-cased form when it is routing,
30433 because on most Unix systems, usernames are in lower case and case-insensitive
30434 routing is required. However, any particular router can be made to use the
30435 original case for local parts by setting the &%caseful_local_part%& generic
30436 router option.
30437
30438 .cindex "mixed-case login names"
30439 If you must have mixed-case user names on your system, the best way to proceed,
30440 assuming you want case-independent handling of incoming email, is to set up
30441 your first router to convert incoming local parts in your domains to the
30442 correct case by means of a file lookup. For example:
30443 .code
30444 correct_case:
30445   driver = redirect
30446   domains = +local_domains
30447   data = ${lookup{$local_part}cdb\
30448               {/etc/usercased.cdb}{$value}fail}\
30449               @$domain
30450 .endd
30451 For this router, the local part is forced to lower case by the default action
30452 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
30453 up a new local part in the correct case. If you then set &%caseful_local_part%&
30454 on any subsequent routers which process your domains, they will operate on
30455 local parts with the correct case in a case-sensitive manner.
30456
30457
30458
30459 .section "Dots in local parts" "SECID231"
30460 .cindex "dot" "in local part"
30461 .cindex "local part" "dots in"
30462 RFC 2822 forbids empty components in local parts. That is, an unquoted local
30463 part may not begin or end with a dot, nor have two consecutive dots in the
30464 middle. However, it seems that many MTAs do not enforce this, so Exim permits
30465 empty components for compatibility.
30466
30467
30468
30469 .section "Rewriting addresses" "SECID232"
30470 .cindex "rewriting" "addresses"
30471 Rewriting of sender and recipient addresses, and addresses in headers, can
30472 happen automatically, or as the result of configuration options, as described
30473 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
30474 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
30475
30476 Automatic rewriting includes qualification, as mentioned above. The other case
30477 in which it can happen is when an incomplete non-local domain is given. The
30478 routing process may cause this to be expanded into the full domain name. For
30479 example, a header such as
30480 .code
30481 To: hare@teaparty
30482 .endd
30483 might get rewritten as
30484 .code
30485 To: hare@teaparty.wonderland.fict.example
30486 .endd
30487 Rewriting as a result of routing is the one kind of message processing that
30488 does not happen at input time, as it cannot be done until the address has
30489 been routed.
30490
30491 Strictly, one should not do &'any'& deliveries of a message until all its
30492 addresses have been routed, in case any of the headers get changed as a
30493 result of routing. However, doing this in practice would hold up many
30494 deliveries for unreasonable amounts of time, just because one address could not
30495 immediately be routed. Exim therefore does not delay other deliveries when
30496 routing of one or more addresses is deferred.
30497 .ecindex IIDmesproc
30498
30499
30500
30501 . ////////////////////////////////////////////////////////////////////////////
30502 . ////////////////////////////////////////////////////////////////////////////
30503
30504 .chapter "SMTP processing" "CHAPSMTP"
30505 .scindex IIDsmtpproc1 "SMTP" "processing details"
30506 .scindex IIDsmtpproc2 "LMTP" "processing details"
30507 Exim supports a number of different ways of using the SMTP protocol, and its
30508 LMTP variant, which is an interactive protocol for transferring messages into a
30509 closed mail store application. This chapter contains details of how SMTP is
30510 processed. For incoming mail, the following are available:
30511
30512 .ilist
30513 SMTP over TCP/IP (Exim daemon or &'inetd'&);
30514 .next
30515 SMTP over the standard input and output (the &%-bs%& option);
30516 .next
30517 Batched SMTP on the standard input (the &%-bS%& option).
30518 .endlist
30519
30520 For mail delivery, the following are available:
30521
30522 .ilist
30523 SMTP over TCP/IP (the &(smtp)& transport);
30524 .next
30525 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
30526 &"lmtp"&);
30527 .next
30528 LMTP over a pipe to a process running in the local host (the &(lmtp)&
30529 transport);
30530 .next
30531 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
30532 the &%use_bsmtp%& option set).
30533 .endlist
30534
30535 &'Batched SMTP'& is the name for a process in which batches of messages are
30536 stored in or read from files (or pipes), in a format in which SMTP commands are
30537 used to contain the envelope information.
30538
30539
30540
30541 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
30542 .cindex "SMTP" "outgoing over TCP/IP"
30543 .cindex "outgoing SMTP over TCP/IP"
30544 .cindex "LMTP" "over TCP/IP"
30545 .cindex "outgoing LMTP over TCP/IP"
30546 .cindex "EHLO"
30547 .cindex "HELO"
30548 .cindex "SIZE option on MAIL command"
30549 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
30550 The &%protocol%& option selects which protocol is to be used, but the actual
30551 processing is the same in both cases.
30552
30553 If, in response to its EHLO command, Exim is told that the SIZE
30554 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
30555 command. The value of <&'n'&> is the message size plus the value of the
30556 &%size_addition%& option (default 1024) to allow for additions to the message
30557 such as per-transport header lines, or changes made in a
30558 .cindex "transport" "filter"
30559 .cindex "filter" "transport filter"
30560 transport filter. If &%size_addition%& is set negative, the use of SIZE is
30561 suppressed.
30562
30563 If the remote server advertises support for PIPELINING, Exim uses the
30564 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
30565 required for the transaction.
30566
30567 If the remote server advertises support for the STARTTLS command, and Exim
30568 was built to support TLS encryption, it tries to start a TLS session unless the
30569 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
30570
30571 If the remote server advertises support for the AUTH command, Exim scans
30572 the authenticators configuration for any suitable client settings, as described
30573 in chapter &<<CHAPSMTPAUTH>>&.
30574
30575 .cindex "carriage return"
30576 .cindex "linefeed"
30577 Responses from the remote host are supposed to be terminated by CR followed by
30578 LF. However, there are known to be hosts that do not send CR characters, so in
30579 order to be able to interwork with such hosts, Exim treats LF on its own as a
30580 line terminator.
30581
30582 If a message contains a number of different addresses, all those with the same
30583 characteristics (for example, the same envelope sender) that resolve to the
30584 same set of hosts, in the same order, are sent in a single SMTP transaction,
30585 even if they are for different domains, unless there are more than the setting
30586 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
30587 they are split into groups containing no more than &%max_rcpt%&s addresses
30588 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
30589 in parallel sessions. The order of hosts with identical MX values is not
30590 significant when checking whether addresses can be batched in this way.
30591
30592 When the &(smtp)& transport suffers a temporary failure that is not
30593 message-related, Exim updates its transport-specific database, which contains
30594 records indexed by host name that remember which messages are waiting for each
30595 particular host. It also updates the retry database with new retry times.
30596
30597 .cindex "hints database" "retry keys"
30598 Exim's retry hints are based on host name plus IP address, so if one address of
30599 a multi-homed host is broken, it will soon be skipped most of the time.
30600 See the next section for more detail about error handling.
30601
30602 .cindex "SMTP" "passed connection"
30603 .cindex "SMTP" "batching over TCP/IP"
30604 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
30605 looks in the hints database for the transport to see if there are any queued
30606 messages waiting for the host to which it is connected. If it finds one, it
30607 creates a new Exim process using the &%-MC%& option (which can only be used by
30608 a process running as root or the Exim user) and passes the TCP/IP socket to it
30609 so that it can deliver another message using the same socket. The new process
30610 does only those deliveries that are routed to the connected host, and may in
30611 turn pass the socket on to a third process, and so on.
30612
30613 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
30614 limit the number of messages sent down a single TCP/IP connection.
30615
30616 .cindex "asterisk" "after IP address"
30617 The second and subsequent messages delivered down an existing connection are
30618 identified in the main log by the addition of an asterisk after the closing
30619 square bracket of the IP address.
30620
30621
30622
30623
30624 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
30625 .cindex "error" "in outgoing SMTP"
30626 .cindex "SMTP" "errors in outgoing"
30627 .cindex "host" "error"
30628 Three different kinds of error are recognized for outgoing SMTP: host errors,
30629 message errors, and recipient errors.
30630
30631 .vlist
30632 .vitem "&*Host errors*&"
30633 A host error is not associated with a particular message or with a
30634 particular recipient of a message. The host errors are:
30635
30636 .ilist
30637 Connection refused or timed out,
30638 .next
30639 Any error response code on connection,
30640 .next
30641 Any error response code to EHLO or HELO,
30642 .next
30643 Loss of connection at any time, except after &"."&,
30644 .next
30645 I/O errors at any time,
30646 .next
30647 Timeouts during the session, other than in response to MAIL, RCPT or
30648 the &"."& at the end of the data.
30649 .endlist ilist
30650
30651 For a host error, a permanent error response on connection, or in response to
30652 EHLO, causes all addresses routed to the host to be failed. Any other host
30653 error causes all addresses to be deferred, and retry data to be created for the
30654 host. It is not tried again, for any message, until its retry time arrives. If
30655 the current set of addresses are not all delivered in this run (to some
30656 alternative host), the message is added to the list of those waiting for this
30657 host, so if it is still undelivered when a subsequent successful delivery is
30658 made to the host, it will be sent down the same SMTP connection.
30659
30660 .vitem "&*Message errors*&"
30661 .cindex "message" "error"
30662 A message error is associated with a particular message when sent to a
30663 particular host, but not with a particular recipient of the message. The
30664 message errors are:
30665
30666 .ilist
30667 Any error response code to MAIL, DATA, or the &"."& that terminates
30668 the data,
30669 .next
30670 Timeout after MAIL,
30671 .next
30672 Timeout or loss of connection after the &"."& that terminates the data. A
30673 timeout after the DATA command itself is treated as a host error, as is loss of
30674 connection at any other time.
30675 .endlist ilist
30676
30677 For a message error, a permanent error response (5&'xx'&) causes all addresses
30678 to be failed, and a delivery error report to be returned to the sender. A
30679 temporary error response (4&'xx'&), or one of the timeouts, causes all
30680 addresses to be deferred. Retry data is not created for the host, but instead,
30681 a retry record for the combination of host plus message id is created. The
30682 message is not added to the list of those waiting for this host. This ensures
30683 that the failing message will not be sent to this host again until the retry
30684 time arrives. However, other messages that are routed to the host are not
30685 affected, so if it is some property of the message that is causing the error,
30686 it will not stop the delivery of other mail.
30687
30688 If the remote host specified support for the SIZE parameter in its response
30689 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
30690 over-large message will cause a message error because the error arrives as a
30691 response to MAIL.
30692
30693 .vitem "&*Recipient errors*&"
30694 .cindex "recipient" "error"
30695 A recipient error is associated with a particular recipient of a message. The
30696 recipient errors are:
30697
30698 .ilist
30699 Any error response to RCPT,
30700 .next
30701 Timeout after RCPT.
30702 .endlist
30703
30704 For a recipient error, a permanent error response (5&'xx'&) causes the
30705 recipient address to be failed, and a bounce message to be returned to the
30706 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
30707 address to be deferred, and routing retry data to be created for it. This is
30708 used to delay processing of the address in subsequent queue runs, until its
30709 routing retry time arrives. This applies to all messages, but because it
30710 operates only in queue runs, one attempt will be made to deliver a new message
30711 to the failing address before the delay starts to operate. This ensures that,
30712 if the failure is really related to the message rather than the recipient
30713 (&"message too big for this recipient"& is a possible example), other messages
30714 have a chance of getting delivered. If a delivery to the address does succeed,
30715 the retry information gets cleared, so all stuck messages get tried again, and
30716 the retry clock is reset.
30717
30718 The message is not added to the list of those waiting for this host. Use of the
30719 host for other messages is unaffected, and except in the case of a timeout,
30720 other recipients are processed independently, and may be successfully delivered
30721 in the current SMTP session. After a timeout it is of course impossible to
30722 proceed with the session, so all addresses get deferred. However, those other
30723 than the one that failed do not suffer any subsequent retry delays. Therefore,
30724 if one recipient is causing trouble, the others have a chance of getting
30725 through when a subsequent delivery attempt occurs before the failing
30726 recipient's retry time.
30727 .endlist
30728
30729 In all cases, if there are other hosts (or IP addresses) available for the
30730 current set of addresses (for example, from multiple MX records), they are
30731 tried in this run for any undelivered addresses, subject of course to their
30732 own retry data. In other words, recipient error retry data does not take effect
30733 until the next delivery attempt.
30734
30735 Some hosts have been observed to give temporary error responses to every
30736 MAIL command at certain times (&"insufficient space"& has been seen). It
30737 would be nice if such circumstances could be recognized, and defer data for the
30738 host itself created, but this is not possible within the current Exim design.
30739 What actually happens is that retry data for every (host, message) combination
30740 is created.
30741
30742 The reason that timeouts after MAIL and RCPT are treated specially is that
30743 these can sometimes arise as a result of the remote host's verification
30744 procedures. Exim makes this assumption, and treats them as if a temporary error
30745 response had been received. A timeout after &"."& is treated specially because
30746 it is known that some broken implementations fail to recognize the end of the
30747 message if the last character of the last line is a binary zero. Thus, it is
30748 helpful to treat this case as a message error.
30749
30750 Timeouts at other times are treated as host errors, assuming a problem with the
30751 host, or the connection to it. If a timeout after MAIL, RCPT,
30752 or &"."& is really a connection problem, the assumption is that at the next try
30753 the timeout is likely to occur at some other point in the dialogue, causing it
30754 then to be treated as a host error.
30755
30756 There is experimental evidence that some MTAs drop the connection after the
30757 terminating &"."& if they do not like the contents of the message for some
30758 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
30759 should be given. That is why Exim treats this case as a message rather than a
30760 host error, in order not to delay other messages to the same host.
30761
30762
30763
30764
30765 .section "Incoming SMTP messages over TCP/IP" "SECID233"
30766 .cindex "SMTP" "incoming over TCP/IP"
30767 .cindex "incoming SMTP over TCP/IP"
30768 .cindex "inetd"
30769 .cindex "daemon"
30770 Incoming SMTP messages can be accepted in one of two ways: by running a
30771 listening daemon, or by using &'inetd'&. In the latter case, the entry in
30772 &_/etc/inetd.conf_& should be like this:
30773 .code
30774 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
30775 .endd
30776 Exim distinguishes between this case and the case of a locally running user
30777 agent using the &%-bs%& option by checking whether or not the standard input is
30778 a socket. When it is, either the port must be privileged (less than 1024), or
30779 the caller must be root or the Exim user. If any other user passes a socket
30780 with an unprivileged port number, Exim prints a message on the standard error
30781 stream and exits with an error code.
30782
30783 By default, Exim does not make a log entry when a remote host connects or
30784 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
30785 unexpected. It can be made to write such log entries by setting the
30786 &%smtp_connection%& log selector.
30787
30788 .cindex "carriage return"
30789 .cindex "linefeed"
30790 Commands from the remote host are supposed to be terminated by CR followed by
30791 LF. However, there are known to be hosts that do not send CR characters. In
30792 order to be able to interwork with such hosts, Exim treats LF on its own as a
30793 line terminator.
30794 Furthermore, because common code is used for receiving messages from all
30795 sources, a CR on its own is also interpreted as a line terminator. However, the
30796 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
30797
30798 .cindex "EHLO" "invalid data"
30799 .cindex "HELO" "invalid data"
30800 One area that sometimes gives rise to problems concerns the EHLO or
30801 HELO commands. Some clients send syntactically invalid versions of these
30802 commands, which Exim rejects by default. (This is nothing to do with verifying
30803 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
30804 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
30805 match the broken hosts that send invalid commands.
30806
30807 .cindex "SIZE option on MAIL command"
30808 .cindex "MAIL" "SIZE option"
30809 The amount of disk space available is checked whenever SIZE is received on
30810 a MAIL command, independently of whether &%message_size_limit%& or
30811 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
30812 false. A temporary error is given if there is not enough space. If
30813 &%check_spool_space%& is set, the check is for that amount of space plus the
30814 value given with SIZE, that is, it checks that the addition of the incoming
30815 message will not reduce the space below the threshold.
30816
30817 When a message is successfully received, Exim includes the local message id in
30818 its response to the final &"."& that terminates the data. If the remote host
30819 logs this text it can help with tracing what has happened to a message.
30820
30821 The Exim daemon can limit the number of simultaneous incoming connections it is
30822 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
30823 number of simultaneous incoming connections from a single remote host (see the
30824 &%smtp_accept_max_per_host%& option). Additional connection attempts are
30825 rejected using the SMTP temporary error code 421.
30826
30827 The Exim daemon does not rely on the SIGCHLD signal to detect when a
30828 subprocess has finished, as this can get lost at busy times. Instead, it looks
30829 for completed subprocesses every time it wakes up. Provided there are other
30830 things happening (new incoming calls, starts of queue runs), completed
30831 processes will be noticed and tidied away. On very quiet systems you may
30832 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
30833 it will be noticed when the daemon next wakes up.
30834
30835 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
30836 and can also be set up to reject SMTP calls from non-reserved hosts at times of
30837 high system load &-- for details see the &%smtp_accept_reserve%&,
30838 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
30839 applies in both the daemon and &'inetd'& cases.
30840
30841 Exim normally starts a delivery process for each message received, though this
30842 can be varied by means of the &%-odq%& command line option and the
30843 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
30844 number of simultaneously running delivery processes started in this way from
30845 SMTP input can be limited by the &%smtp_accept_queue%& and
30846 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
30847 subsequently received messages are just put on the input queue without starting
30848 a delivery process.
30849
30850 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
30851 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
30852 started up from the &'inetd'& daemon, because in that case each connection is
30853 handled by an entirely independent Exim process. Control by load average is,
30854 however, available with &'inetd'&.
30855
30856 Exim can be configured to verify addresses in incoming SMTP commands as they
30857 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
30858 to rewrite addresses at this time &-- before any syntax checking is done. See
30859 section &<<SECTrewriteS>>&.
30860
30861 Exim can also be configured to limit the rate at which a client host submits
30862 MAIL and RCPT commands in a single SMTP session. See the
30863 &%smtp_ratelimit_hosts%& option.
30864
30865
30866
30867 .section "Unrecognized SMTP commands" "SECID234"
30868 .cindex "SMTP" "unrecognized commands"
30869 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
30870 commands during a single SMTP connection, it drops the connection after sending
30871 the error response to the last command. The default value for
30872 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
30873 abuse that subvert web servers into making connections to SMTP ports; in these
30874 circumstances, a number of non-SMTP lines are sent first.
30875
30876
30877 .section "Syntax and protocol errors in SMTP commands" "SECID235"
30878 .cindex "SMTP" "syntax errors"
30879 .cindex "SMTP" "protocol errors"
30880 A syntax error is detected if an SMTP command is recognized, but there is
30881 something syntactically wrong with its data, for example, a malformed email
30882 address in a RCPT command. Protocol errors include invalid command
30883 sequencing such as RCPT before MAIL. If Exim receives more than
30884 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
30885 drops the connection after sending the error response to the last command. The
30886 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
30887 broken clients that loop sending bad commands (yes, it has been seen).
30888
30889
30890
30891 .section "Use of non-mail SMTP commands" "SECID236"
30892 .cindex "SMTP" "non-mail commands"
30893 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
30894 DATA. Exim counts such commands, and drops the connection if there are too
30895 many of them in a single SMTP session. This action catches some
30896 denial-of-service attempts and things like repeated failing AUTHs, or a mad
30897 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
30898 defines what &"too many"& means. Its default value is 10.
30899
30900 When a new message is expected, one occurrence of RSET is not counted. This
30901 allows a client to send one RSET between messages (this is not necessary,
30902 but some clients do it). Exim also allows one uncounted occurrence of HELO
30903 or EHLO, and one occurrence of STARTTLS between messages. After
30904 starting up a TLS session, another EHLO is expected, and so it too is not
30905 counted.
30906
30907 The first occurrence of AUTH in a connection, or immediately following
30908 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
30909 RCPT, DATA, and QUIT are counted.
30910
30911 You can control which hosts are subject to the limit set by
30912 &%smtp_accept_max_nonmail%& by setting
30913 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
30914 the limit apply to all hosts. This option means that you can exclude any
30915 specific badly-behaved hosts that you have to live with.
30916
30917
30918
30919
30920 .section "The VRFY and EXPN commands" "SECID237"
30921 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
30922 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
30923 appropriate) in order to decide whether the command should be accepted or not.
30924 If no ACL is defined, the command is rejected.
30925
30926 .cindex "VRFY" "processing"
30927 When VRFY is accepted, it runs exactly the same code as when Exim is
30928 called with the &%-bv%& option.
30929
30930 .cindex "EXPN" "processing"
30931 When EXPN is accepted, a single-level expansion of the address is done.
30932 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
30933 than a verification (the &%-bv%& option). If an unqualified local part is given
30934 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
30935 of VRFY and EXPN commands are logged on the main and reject logs, and
30936 VRFY verification failures are logged on the main log for consistency with
30937 RCPT failures.
30938
30939
30940
30941 .section "The ETRN command" "SECTETRN"
30942 .cindex "ETRN" "processing"
30943 RFC 1985 describes an SMTP command called ETRN that is designed to
30944 overcome the security problems of the TURN command (which has fallen into
30945 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
30946 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
30947 should be accepted or not. If no ACL is defined, the command is rejected.
30948
30949 The ETRN command is concerned with &"releasing"& messages that are awaiting
30950 delivery to certain hosts. As Exim does not organize its message queue by host,
30951 the only form of ETRN that is supported by default is the one where the
30952 text starts with the &"#"& prefix, in which case the remainder of the text is
30953 specific to the SMTP server. A valid ETRN command causes a run of Exim with
30954 the &%-R%& option to happen, with the remainder of the ETRN text as its
30955 argument. For example,
30956 .code
30957 ETRN #brigadoon
30958 .endd
30959 runs the command
30960 .code
30961 exim -R brigadoon
30962 .endd
30963 which causes a delivery attempt on all messages with undelivered addresses
30964 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
30965 default), Exim prevents the simultaneous execution of more than one queue run
30966 for the same argument string as a result of an ETRN command. This stops
30967 a misbehaving client from starting more than one queue runner at once.
30968
30969 .cindex "hints database" "ETRN serialization"
30970 Exim implements the serialization by means of a hints database in which a
30971 record is written whenever a process is started by ETRN, and deleted when
30972 the process completes. However, Exim does not keep the SMTP session waiting for
30973 the ETRN process to complete. Once ETRN is accepted, the client is sent
30974 a &"success"& return code. Obviously there is scope for hints records to get
30975 left lying around if there is a system or program crash. To guard against this,
30976 Exim ignores any records that are more than six hours old.
30977
30978 .oindex "&%smtp_etrn_command%&"
30979 For more control over what ETRN does, the &%smtp_etrn_command%& option can
30980 used. This specifies a command that is run whenever ETRN is received,
30981 whatever the form of its argument. For
30982 example:
30983 .code
30984 smtp_etrn_command = /etc/etrn_command $domain \
30985                     $sender_host_address
30986 .endd
30987 .vindex "&$domain$&"
30988 The string is split up into arguments which are independently expanded. The
30989 expansion variable &$domain$& is set to the argument of the ETRN command,
30990 and no syntax checking is done on the contents of this argument. Exim does not
30991 wait for the command to complete, so its status code is not checked. Exim runs
30992 under its own uid and gid when receiving incoming SMTP, so it is not possible
30993 for it to change them before running the command.
30994
30995
30996
30997 .section "Incoming local SMTP" "SECID238"
30998 .cindex "SMTP" "local incoming"
30999 Some user agents use SMTP to pass messages to their local MTA using the
31000 standard input and output, as opposed to passing the envelope on the command
31001 line and writing the message to the standard input. This is supported by the
31002 &%-bs%& option. This form of SMTP is handled in the same way as incoming
31003 messages over TCP/IP (including the use of ACLs), except that the envelope
31004 sender given in a MAIL command is ignored unless the caller is trusted. In
31005 an ACL you can detect this form of SMTP input by testing for an empty host
31006 identification. It is common to have this as the first line in the ACL that
31007 runs for RCPT commands:
31008 .code
31009 accept hosts = :
31010 .endd
31011 This accepts SMTP messages from local processes without doing any other tests.
31012
31013
31014
31015 .section "Outgoing batched SMTP" "SECTbatchSMTP"
31016 .cindex "SMTP" "batched outgoing"
31017 .cindex "batched SMTP output"
31018 Both the &(appendfile)& and &(pipe)& transports can be used for handling
31019 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
31020 be output in BSMTP format. No SMTP responses are possible for this form of
31021 delivery. All it is doing is using SMTP commands as a way of transmitting the
31022 envelope along with the message.
31023
31024 The message is written to the file or pipe preceded by the SMTP commands
31025 MAIL and RCPT, and followed by a line containing a single dot. Lines in
31026 the message that start with a dot have an extra dot added. The SMTP command
31027 HELO is not normally used. If it is required, the &%message_prefix%& option
31028 can be used to specify it.
31029
31030 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
31031 one recipient address at a time by default. However, you can arrange for them
31032 to handle several addresses at once by setting the &%batch_max%& option. When
31033 this is done for BSMTP, messages may contain multiple RCPT commands. See
31034 chapter &<<CHAPbatching>>& for more details.
31035
31036 .vindex "&$host$&"
31037 When one or more addresses are routed to a BSMTP transport by a router that
31038 sets up a host list, the name of the first host on the list is available to the
31039 transport in the variable &$host$&. Here is an example of such a transport and
31040 router:
31041 .code
31042 begin routers
31043 route_append:
31044   driver = manualroute
31045   transport = smtp_appendfile
31046   route_list = domain.example  batch.host.example
31047
31048 begin transports
31049 smtp_appendfile:
31050   driver = appendfile
31051   directory = /var/bsmtp/$host
31052   batch_max = 1000
31053   use_bsmtp
31054   user = exim
31055 .endd
31056 This causes messages addressed to &'domain.example'& to be written in BSMTP
31057 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
31058 message (unless there are more than 1000 recipients).
31059
31060
31061
31062 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
31063 .cindex "SMTP" "batched incoming"
31064 .cindex "batched SMTP input"
31065 The &%-bS%& command line option causes Exim to accept one or more messages by
31066 reading SMTP on the standard input, but to generate no responses. If the caller
31067 is trusted, the senders in the MAIL commands are believed; otherwise the
31068 sender is always the caller of Exim. Unqualified senders and receivers are not
31069 rejected (there seems little point) but instead just get qualified. HELO
31070 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
31071 as NOOP; QUIT quits.
31072
31073 .new
31074 Minimal policy checking is done for BSMTP input. Only the non-SMTP
31075 ACL is run in the same way as for non-SMTP local input.
31076 .wen
31077 If an error is detected while reading a message, including a missing &"."& at
31078 the end, Exim gives up immediately. It writes details of the error to the
31079 standard output in a stylized way that the calling program should be able to
31080 make some use of automatically, for example:
31081 .code
31082 554 Unexpected end of file
31083 Transaction started in line 10
31084 Error detected in line 14
31085 .endd
31086 It writes a more verbose version, for human consumption, to the standard error
31087 file, for example:
31088 .code
31089 An error was detected while processing a file of BSMTP input.
31090 The error message was:
31091
31092 501 '>' missing at end of address
31093
31094 The SMTP transaction started in line 10.
31095 The error was detected in line 12.
31096 The SMTP command at fault was:
31097
31098 rcpt to:<malformed@in.com.plete
31099
31100 1 previous message was successfully processed.
31101 The rest of the batch was abandoned.
31102 .endd
31103 The return code from Exim is zero only if there were no errors. It is 1 if some
31104 messages were accepted before an error was detected, and 2 if no messages were
31105 accepted.
31106 .ecindex IIDsmtpproc1
31107 .ecindex IIDsmtpproc2
31108
31109
31110
31111 . ////////////////////////////////////////////////////////////////////////////
31112 . ////////////////////////////////////////////////////////////////////////////
31113
31114 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
31115          "Customizing messages"
31116 When a message fails to be delivered, or remains on the queue for more than a
31117 configured amount of time, Exim sends a message to the original sender, or
31118 to an alternative configured address. The text of these messages is built into
31119 the code of Exim, but it is possible to change it, either by adding a single
31120 string, or by replacing each of the paragraphs by text supplied in a file.
31121
31122 The &'From:'& and &'To:'& header lines are automatically generated; you can
31123 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
31124 option. Exim also adds the line
31125 .code
31126 Auto-Submitted: auto-generated
31127 .endd
31128 to all warning and bounce messages,
31129
31130
31131 .section "Customizing bounce messages" "SECID239"
31132 .cindex "customizing" "bounce message"
31133 .cindex "bounce message" "customizing"
31134 If &%bounce_message_text%& is set, its contents are included in the default
31135 message immediately after &"This message was created automatically by mail
31136 delivery software."& The string is not expanded. It is not used if
31137 &%bounce_message_file%& is set.
31138
31139 When &%bounce_message_file%& is set, it must point to a template file for
31140 constructing error messages. The file consists of a series of text items,
31141 separated by lines consisting of exactly four asterisks. If the file cannot be
31142 opened, default text is used and a message is written to the main and panic
31143 logs. If any text item in the file is empty, default text is used for that
31144 item.
31145
31146 .vindex "&$bounce_recipient$&"
31147 .vindex "&$bounce_return_size_limit$&"
31148 Each item of text that is read from the file is expanded, and there are two
31149 expansion variables which can be of use here: &$bounce_recipient$& is set to
31150 the recipient of an error message while it is being created, and
31151 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
31152 option, rounded to a whole number.
31153
31154 The items must appear in the file in the following order:
31155
31156 .ilist
31157 The first item is included in the headers, and should include at least a
31158 &'Subject:'& header. Exim does not check the syntax of these headers.
31159 .next
31160 The second item forms the start of the error message. After it, Exim lists the
31161 failing addresses with their error messages.
31162 .next
31163 The third item is used to introduce any text from pipe transports that is to be
31164 returned to the sender. It is omitted if there is no such text.
31165 .next
31166 The fourth item is used to introduce the copy of the message that is returned
31167 as part of the error report.
31168 .next
31169 The fifth item is added after the fourth one if the returned message is
31170 truncated because it is bigger than &%return_size_limit%&.
31171 .next
31172 The sixth item is added after the copy of the original message.
31173 .endlist
31174
31175 The default state (&%bounce_message_file%& unset) is equivalent to the
31176 following file, in which the sixth item is empty. The &'Subject:'& and some
31177 other lines have been split in order to fit them on the page:
31178 .code
31179 Subject: Mail delivery failed
31180   ${if eq{$sender_address}{$bounce_recipient}
31181   {: returning message to sender}}
31182 ****
31183 This message was created automatically by mail delivery software.
31184
31185 A message ${if eq{$sender_address}{$bounce_recipient}
31186   {that you sent }{sent by
31187
31188 <$sender_address>
31189
31190 }}could not be delivered to all of its recipients.
31191 This is a permanent error. The following address(es) failed:
31192 ****
31193 The following text was generated during the delivery attempt(s):
31194 ****
31195 ------ This is a copy of the message, including all the headers.
31196   ------
31197 ****
31198 ------ The body of the message is $message_size characters long;
31199   only the first
31200 ------ $bounce_return_size_limit or so are included here.
31201 ****
31202 .endd
31203 .section "Customizing warning messages" "SECTcustwarn"
31204 .cindex "customizing" "warning message"
31205 .cindex "warning of delay" "customizing the message"
31206 The option &%warn_message_file%& can be pointed at a template file for use when
31207 warnings about message delays are created. In this case there are only three
31208 text sections:
31209
31210 .ilist
31211 The first item is included in the headers, and should include at least a
31212 &'Subject:'& header. Exim does not check the syntax of these headers.
31213 .next
31214 The second item forms the start of the warning message. After it, Exim lists
31215 the delayed addresses.
31216 .next
31217 The third item then ends the message.
31218 .endlist
31219
31220 The default state is equivalent to the following file, except that some lines
31221 have been split here, in order to fit them on the page:
31222 .code
31223 Subject: Warning: message $message_exim_id delayed
31224   $warn_message_delay
31225 ****
31226 This message was created automatically by mail delivery software.
31227
31228 A message ${if eq{$sender_address}{$warn_message_recipients}
31229 {that you sent }{sent by
31230
31231 <$sender_address>
31232
31233 }}has not been delivered to all of its recipients after
31234 more than $warn_message_delay on the queue on $primary_hostname.
31235
31236 The message identifier is:     $message_exim_id
31237 The subject of the message is: $h_subject
31238 The date of the message is:    $h_date
31239
31240 The following address(es) have not yet been delivered:
31241 ****
31242 No action is required on your part. Delivery attempts will
31243 continue for some time, and this warning may be repeated at
31244 intervals if the message remains undelivered. Eventually the
31245 mail delivery software will give up, and when that happens,
31246 the message will be returned to you.
31247 .endd
31248 .vindex "&$warn_message_delay$&"
31249 .vindex "&$warn_message_recipients$&"
31250 However, in the default state the subject and date lines are omitted if no
31251 appropriate headers exist. During the expansion of this file,
31252 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
31253 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
31254 of recipients for the warning message. There may be more than one if there are
31255 multiple addresses with different &%errors_to%& settings on the routers that
31256 handled them.
31257
31258
31259
31260
31261 . ////////////////////////////////////////////////////////////////////////////
31262 . ////////////////////////////////////////////////////////////////////////////
31263
31264 .chapter "Some common configuration settings" "CHAPcomconreq"
31265 This chapter discusses some configuration settings that seem to be fairly
31266 common. More examples and discussion can be found in the Exim book.
31267
31268
31269
31270 .section "Sending mail to a smart host" "SECID240"
31271 .cindex "smart host" "example router"
31272 If you want to send all mail for non-local domains to a &"smart host"&, you
31273 should replace the default &(dnslookup)& router with a router which does the
31274 routing explicitly:
31275 .code
31276 send_to_smart_host:
31277   driver = manualroute
31278   route_list = !+local_domains smart.host.name
31279   transport = remote_smtp
31280 .endd
31281 You can use the smart host's IP address instead of the name if you wish.
31282 If you are using Exim only to submit messages to a smart host, and not for
31283 receiving incoming messages, you can arrange for it to do the submission
31284 synchronously by setting the &%mua_wrapper%& option (see chapter
31285 &<<CHAPnonqueueing>>&).
31286
31287
31288
31289
31290 .section "Using Exim to handle mailing lists" "SECTmailinglists"
31291 .cindex "mailing lists"
31292 Exim can be used to run simple mailing lists, but for large and/or complicated
31293 requirements, the use of additional specialized mailing list software such as
31294 Majordomo or Mailman is recommended.
31295
31296 The &(redirect)& router can be used to handle mailing lists where each list
31297 is maintained in a separate file, which can therefore be managed by an
31298 independent manager. The &%domains%& router option can be used to run these
31299 lists in a separate domain from normal mail. For example:
31300 .code
31301 lists:
31302   driver = redirect
31303   domains = lists.example
31304   file = /usr/lists/$local_part
31305   forbid_pipe
31306   forbid_file
31307   errors_to = $local_part-request@lists.example
31308   no_more
31309 .endd
31310 This router is skipped for domains other than &'lists.example'&. For addresses
31311 in that domain, it looks for a file that matches the local part. If there is no
31312 such file, the router declines, but because &%no_more%& is set, no subsequent
31313 routers are tried, and so the whole delivery fails.
31314
31315 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
31316 expanded into a file name or a pipe delivery, which is usually inappropriate in
31317 a mailing list.
31318
31319 .oindex "&%errors_to%&"
31320 The &%errors_to%& option specifies that any delivery errors caused by addresses
31321 taken from a mailing list are to be sent to the given address rather than the
31322 original sender of the message. However, before acting on this, Exim verifies
31323 the error address, and ignores it if verification fails.
31324
31325 For example, using the configuration above, mail sent to
31326 &'dicts@lists.example'& is passed on to those addresses contained in
31327 &_/usr/lists/dicts_&, with error reports directed to
31328 &'dicts-request@lists.example'&, provided that this address can be verified.
31329 There could be a file called &_/usr/lists/dicts-request_& containing
31330 the address(es) of this particular list's manager(s), but other approaches,
31331 such as setting up an earlier router (possibly using the &%local_part_prefix%&
31332 or &%local_part_suffix%& options) to handle addresses of the form
31333 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
31334
31335
31336
31337 .section "Syntax errors in mailing lists" "SECID241"
31338 .cindex "mailing lists" "syntax errors in"
31339 If an entry in redirection data contains a syntax error, Exim normally defers
31340 delivery of the original address. That means that a syntax error in a mailing
31341 list holds up all deliveries to the list. This may not be appropriate when a
31342 list is being maintained automatically from data supplied by users, and the
31343 addresses are not rigorously checked.
31344
31345 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
31346 entries that fail to parse, noting the incident in the log. If in addition
31347 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
31348 whenever a broken address is skipped. It is usually appropriate to set
31349 &%syntax_errors_to%& to the same address as &%errors_to%&.
31350
31351
31352
31353 .section "Re-expansion of mailing lists" "SECID242"
31354 .cindex "mailing lists" "re-expansion of"
31355 Exim remembers every individual address to which a message has been delivered,
31356 in order to avoid duplication, but it normally stores only the original
31357 recipient addresses with a message. If all the deliveries to a mailing list
31358 cannot be done at the first attempt, the mailing list is re-expanded when the
31359 delivery is next tried. This means that alterations to the list are taken into
31360 account at each delivery attempt, so addresses that have been added to
31361 the list since the message arrived will therefore receive a copy of the
31362 message, even though it pre-dates their subscription.
31363
31364 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
31365 on the &(redirect)& router. If this is done, any addresses generated by the
31366 router that fail to deliver at the first attempt are added to the message as
31367 &"top level"& addresses, and the parent address that generated them is marked
31368 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
31369 subsequent delivery attempts. The disadvantage of this is that if any of the
31370 failing addresses are incorrect, correcting them in the file has no effect on
31371 pre-existing messages.
31372
31373 The original top-level address is remembered with each of the generated
31374 addresses, and is output in any log messages. However, any intermediate parent
31375 addresses are not recorded. This makes a difference to the log only if the
31376 &%all_parents%& selector is set, but for mailing lists there is normally only
31377 one level of expansion anyway.
31378
31379
31380
31381 .section "Closed mailing lists" "SECID243"
31382 .cindex "mailing lists" "closed"
31383 The examples so far have assumed open mailing lists, to which anybody may
31384 send mail. It is also possible to set up closed lists, where mail is accepted
31385 from specified senders only. This is done by making use of the generic
31386 &%senders%& option to restrict the router that handles the list.
31387
31388 The following example uses the same file as a list of recipients and as a list
31389 of permitted senders. It requires three routers:
31390 .code
31391 lists_request:
31392   driver = redirect
31393   domains = lists.example
31394   local_part_suffix = -request
31395   file = /usr/lists/$local_part$local_part_suffix
31396   no_more
31397
31398 lists_post:
31399   driver = redirect
31400   domains = lists.example
31401   senders = ${if exists {/usr/lists/$local_part}\
31402              {lsearch;/usr/lists/$local_part}{*}}
31403   file = /usr/lists/$local_part
31404   forbid_pipe
31405   forbid_file
31406   errors_to = $local_part-request@lists.example
31407   no_more
31408
31409 lists_closed:
31410   driver = redirect
31411   domains = lists.example
31412   allow_fail
31413   data = :fail: $local_part@lists.example is a closed mailing list
31414 .endd
31415 All three routers have the same &%domains%& setting, so for any other domains,
31416 they are all skipped. The first router runs only if the local part ends in
31417 &%-request%&. It handles messages to the list manager(s) by means of an open
31418 mailing list.
31419
31420 The second router runs only if the &%senders%& precondition is satisfied. It
31421 checks for the existence of a list that corresponds to the local part, and then
31422 checks that the sender is on the list by means of a linear search. It is
31423 necessary to check for the existence of the file before trying to search it,
31424 because otherwise Exim thinks there is a configuration error. If the file does
31425 not exist, the expansion of &%senders%& is *, which matches all senders. This
31426 means that the router runs, but because there is no list, declines, and
31427 &%no_more%& ensures that no further routers are run. The address fails with an
31428 &"unrouteable address"& error.
31429
31430 The third router runs only if the second router is skipped, which happens when
31431 a mailing list exists, but the sender is not on it. This router forcibly fails
31432 the address, giving a suitable error message.
31433
31434
31435
31436
31437 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
31438 .cindex "VERP"
31439 .cindex "Variable Envelope Return Paths"
31440 .cindex "envelope sender"
31441 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
31442 are a way of helping mailing list administrators discover which subscription
31443 address is the cause of a particular delivery failure. The idea is to encode
31444 the original recipient address in the outgoing envelope sender address, so that
31445 if the message is forwarded by another host and then subsequently bounces, the
31446 original recipient can be extracted from the recipient address of the bounce.
31447
31448 .oindex &%errors_to%&
31449 .oindex &%return_path%&
31450 Envelope sender addresses can be modified by Exim using two different
31451 facilities: the &%errors_to%& option on a router (as shown in previous mailing
31452 list examples), or the &%return_path%& option on a transport. The second of
31453 these is effective only if the message is successfully delivered to another
31454 host; it is not used for errors detected on the local host (see the description
31455 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
31456 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
31457 .code
31458 verp_smtp:
31459   driver = smtp
31460   max_rcpt = 1
31461   return_path = \
31462     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
31463       {$1-request+$local_part=$domain@your.dom.example}fail}
31464 .endd
31465 This has the effect of rewriting the return path (envelope sender) on outgoing
31466 SMTP messages, if the local part of the original return path ends in
31467 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
31468 local part and domain of the recipient into the return path. Suppose, for
31469 example, that a message whose return path has been set to
31470 &'somelist-request@your.dom.example'& is sent to
31471 &'subscriber@other.dom.example'&. In the transport, the return path is
31472 rewritten as
31473 .code
31474 somelist-request+subscriber=other.dom.example@your.dom.example
31475 .endd
31476 .vindex "&$local_part$&"
31477 For this to work, you must tell Exim to send multiple copies of messages that
31478 have more than one recipient, so that each copy has just one recipient. This is
31479 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
31480 might be sent to several different recipients in the same domain, in which case
31481 &$local_part$& is not available in the transport, because it is not unique.
31482
31483 Unless your host is doing nothing but mailing list deliveries, you should
31484 probably use a separate transport for the VERP deliveries, so as not to use
31485 extra resources in making one-per-recipient copies for other deliveries. This
31486 can easily be done by expanding the &%transport%& option in the router:
31487 .code
31488 dnslookup:
31489   driver = dnslookup
31490   domains = ! +local_domains
31491   transport = \
31492     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
31493       {verp_smtp}{remote_smtp}}
31494   no_more
31495 .endd
31496 If you want to change the return path using &%errors_to%& in a router instead
31497 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
31498 routers that handle mailing list addresses. This will ensure that all delivery
31499 errors, including those detected on the local host, are sent to the VERP
31500 address.
31501
31502 On a host that does no local deliveries and has no manual routing, only the
31503 &(dnslookup)& router needs to be changed. A special transport is not needed for
31504 SMTP deliveries. Every mailing list recipient has its own return path value,
31505 and so Exim must hand them to the transport one at a time. Here is an example
31506 of a &(dnslookup)& router that implements VERP:
31507 .code
31508 verp_dnslookup:
31509   driver = dnslookup
31510   domains = ! +local_domains
31511   transport = remote_smtp
31512   errors_to = \
31513     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
31514      {$1-request+$local_part=$domain@your.dom.example}fail}
31515   no_more
31516 .endd
31517 Before you start sending out messages with VERPed return paths, you must also
31518 configure Exim to accept the bounce messages that come back to those paths.
31519 Typically this is done by setting a &%local_part_suffix%& option for a
31520 router, and using this to route the messages to wherever you want to handle
31521 them.
31522
31523 The overhead incurred in using VERP depends very much on the size of the
31524 message, the number of recipient addresses that resolve to the same remote
31525 host, and the speed of the connection over which the message is being sent. If
31526 a lot of addresses resolve to the same host and the connection is slow, sending
31527 a separate copy of the message for each address may take substantially longer
31528 than sending a single copy with many recipients (for which VERP cannot be
31529 used).
31530
31531
31532
31533
31534
31535
31536 .section "Virtual domains" "SECTvirtualdomains"
31537 .cindex "virtual domains"
31538 .cindex "domain" "virtual"
31539 The phrase &'virtual domain'& is unfortunately used with two rather different
31540 meanings:
31541
31542 .ilist
31543 A domain for which there are no real mailboxes; all valid local parts are
31544 aliases for other email addresses. Common examples are organizational
31545 top-level domains and &"vanity"& domains.
31546 .next
31547 One of a number of independent domains that are all handled by the same host,
31548 with mailboxes on that host, but where the mailbox owners do not necessarily
31549 have login accounts on that host.
31550 .endlist
31551
31552 The first usage is probably more common, and does seem more &"virtual"& than
31553 the second. This kind of domain can be handled in Exim with a straightforward
31554 aliasing router. One approach is to create a separate alias file for each
31555 virtual domain. Exim can test for the existence of the alias file to determine
31556 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
31557 to a router of this form:
31558 .code
31559 virtual:
31560   driver = redirect
31561   domains = dsearch;/etc/mail/virtual
31562   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
31563   no_more
31564 .endd
31565 The &%domains%& option specifies that the router is to be skipped, unless there
31566 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
31567 domain that is being processed. When the router runs, it looks up the local
31568 part in the file to find a new address (or list of addresses). The &%no_more%&
31569 setting ensures that if the lookup fails (leading to &%data%& being an empty
31570 string), Exim gives up on the address without trying any subsequent routers.
31571
31572 This one router can handle all the virtual domains because the alias file names
31573 follow a fixed pattern. Permissions can be arranged so that appropriate people
31574 can edit the different alias files. A successful aliasing operation results in
31575 a new envelope recipient address, which is then routed from scratch.
31576
31577 The other kind of &"virtual"& domain can also be handled in a straightforward
31578 way. One approach is to create a file for each domain containing a list of
31579 valid local parts, and use it in a router like this:
31580 .code
31581 my_domains:
31582   driver = accept
31583   domains = dsearch;/etc/mail/domains
31584   local_parts = lsearch;/etc/mail/domains/$domain
31585   transport = my_mailboxes
31586 .endd
31587 The address is accepted if there is a file for the domain, and the local part
31588 can be found in the file. The &%domains%& option is used to check for the
31589 file's existence because &%domains%& is tested before the &%local_parts%&
31590 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
31591 because that option is tested after &%local_parts%&. The transport is as
31592 follows:
31593 .code
31594 my_mailboxes:
31595   driver = appendfile
31596   file = /var/mail/$domain/$local_part
31597   user = mail
31598 .endd
31599 This uses a directory of mailboxes for each domain. The &%user%& setting is
31600 required, to specify which uid is to be used for writing to the mailboxes.
31601
31602 The configuration shown here is just one example of how you might support this
31603 requirement. There are many other ways this kind of configuration can be set
31604 up, for example, by using a database instead of separate files to hold all the
31605 information about the domains.
31606
31607
31608
31609 .section "Multiple user mailboxes" "SECTmulbox"
31610 .cindex "multiple mailboxes"
31611 .cindex "mailbox" "multiple"
31612 .cindex "local part" "prefix"
31613 .cindex "local part" "suffix"
31614 Heavy email users often want to operate with multiple mailboxes, into which
31615 incoming mail is automatically sorted. A popular way of handling this is to
31616 allow users to use multiple sender addresses, so that replies can easily be
31617 identified. Users are permitted to add prefixes or suffixes to their local
31618 parts for this purpose. The wildcard facility of the generic router options
31619 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
31620 example, consider this router:
31621 .code
31622 userforward:
31623   driver = redirect
31624   check_local_user
31625   file = $home/.forward
31626   local_part_suffix = -*
31627   local_part_suffix_optional
31628   allow_filter
31629 .endd
31630 .vindex "&$local_part_suffix$&"
31631 It runs a user's &_.forward_& file for all local parts of the form
31632 &'username-*'&. Within the filter file the user can distinguish different
31633 cases by testing the variable &$local_part_suffix$&. For example:
31634 .code
31635 if $local_part_suffix contains -special then
31636 save /home/$local_part/Mail/special
31637 endif
31638 .endd
31639 If the filter file does not exist, or does not deal with such addresses, they
31640 fall through to subsequent routers, and, assuming no subsequent use of the
31641 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
31642 control over which suffixes are valid.
31643
31644 Alternatively, a suffix can be used to trigger the use of a different
31645 &_.forward_& file &-- which is the way a similar facility is implemented in
31646 another MTA:
31647 .code
31648 userforward:
31649   driver = redirect
31650   check_local_user
31651   file = $home/.forward$local_part_suffix
31652   local_part_suffix = -*
31653   local_part_suffix_optional
31654   allow_filter
31655 .endd
31656 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
31657 example, &_.forward-special_& is used. Once again, if the appropriate file
31658 does not exist, or does not deal with the address, it is passed on to
31659 subsequent routers, which could, if required, look for an unqualified
31660 &_.forward_& file to use as a default.
31661
31662
31663
31664 .section "Simplified vacation processing" "SECID244"
31665 .cindex "vacation processing"
31666 The traditional way of running the &'vacation'& program is for a user to set up
31667 a pipe command in a &_.forward_& file
31668 (see section &<<SECTspecitredli>>& for syntax details).
31669 This is prone to error by inexperienced users. There are two features of Exim
31670 that can be used to make this process simpler for users:
31671
31672 .ilist
31673 A local part prefix such as &"vacation-"& can be specified on a router which
31674 can cause the message to be delivered directly to the &'vacation'& program, or
31675 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
31676 &_.forward_& file are then much simpler. For example:
31677 .code
31678 spqr, vacation-spqr
31679 .endd
31680 .next
31681 The &%require_files%& generic router option can be used to trigger a
31682 vacation delivery by checking for the existence of a certain file in the
31683 user's home directory. The &%unseen%& generic option should also be used, to
31684 ensure that the original delivery also proceeds. In this case, all the user has
31685 to do is to create a file called, say, &_.vacation_&, containing a vacation
31686 message.
31687 .endlist
31688
31689 Another advantage of both these methods is that they both work even when the
31690 use of arbitrary pipes by users is locked out.
31691
31692
31693
31694 .section "Taking copies of mail" "SECID245"
31695 .cindex "message" "copying every"
31696 Some installations have policies that require archive copies of all messages to
31697 be made. A single copy of each message can easily be taken by an appropriate
31698 command in a system filter, which could, for example, use a different file for
31699 each day's messages.
31700
31701 There is also a shadow transport mechanism that can be used to take copies of
31702 messages that are successfully delivered by local transports, one copy per
31703 delivery. This could be used, &'inter alia'&, to implement automatic
31704 notification of delivery by sites that insist on doing such things.
31705
31706
31707
31708 .section "Intermittently connected hosts" "SECID246"
31709 .cindex "intermittently connected hosts"
31710 It has become quite common (because it is cheaper) for hosts to connect to the
31711 Internet periodically rather than remain connected all the time. The normal
31712 arrangement is that mail for such hosts accumulates on a system that is
31713 permanently connected.
31714
31715 Exim was designed for use on permanently connected hosts, and so it is not
31716 particularly well-suited to use in an intermittently connected environment.
31717 Nevertheless there are some features that can be used.
31718
31719
31720 .section "Exim on the upstream server host" "SECID247"
31721 It is tempting to arrange for incoming mail for the intermittently connected
31722 host to remain on Exim's queue until the client connects. However, this
31723 approach does not scale very well. Two different kinds of waiting message are
31724 being mixed up in the same queue &-- those that cannot be delivered because of
31725 some temporary problem, and those that are waiting for their destination host
31726 to connect. This makes it hard to manage the queue, as well as wasting
31727 resources, because each queue runner scans the entire queue.
31728
31729 A better approach is to separate off those messages that are waiting for an
31730 intermittently connected host. This can be done by delivering these messages
31731 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
31732 format, from where they are transmitted by other software when their
31733 destination connects. This makes it easy to collect all the mail for one host
31734 in a single directory, and to apply local timeout rules on a per-message basis
31735 if required.
31736
31737 On a very small scale, leaving the mail on Exim's queue can be made to work. If
31738 you are doing this, you should configure Exim with a long retry period for the
31739 intermittent host. For example:
31740 .code
31741 cheshire.wonderland.fict.example    *   F,5d,24h
31742 .endd
31743 This stops a lot of failed delivery attempts from occurring, but Exim remembers
31744 which messages it has queued up for that host. Once the intermittent host comes
31745 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
31746 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
31747 causes all the queued up messages to be delivered, often down a single SMTP
31748 connection. While the host remains connected, any new messages get delivered
31749 immediately.
31750
31751 If the connecting hosts do not have fixed IP addresses, that is, if a host is
31752 issued with a different IP address each time it connects, Exim's retry
31753 mechanisms on the holding host get confused, because the IP address is normally
31754 used as part of the key string for holding retry information. This can be
31755 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
31756 Since this has disadvantages for permanently connected hosts, it is best to
31757 arrange a separate transport for the intermittently connected ones.
31758
31759
31760
31761 .section "Exim on the intermittently connected client host" "SECID248"
31762 The value of &%smtp_accept_queue_per_connection%& should probably be
31763 increased, or even set to zero (that is, disabled) on the intermittently
31764 connected host, so that all incoming messages down a single connection get
31765 delivered immediately.
31766
31767 .cindex "SMTP" "passed connection"
31768 .cindex "SMTP" "multiple deliveries"
31769 .cindex "multiple SMTP deliveries"
31770 Mail waiting to be sent from an intermittently connected host will probably
31771 not have been routed, because without a connection DNS lookups are not
31772 possible. This means that if a normal queue run is done at connection time,
31773 each message is likely to be sent in a separate SMTP session. This can be
31774 avoided by starting the queue run with a command line option beginning with
31775 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
31776 first pass, routing is done but no deliveries take place. The second pass is a
31777 normal queue run; since all the messages have been previously routed, those
31778 destined for the same host are likely to get sent as multiple deliveries in a
31779 single SMTP connection.
31780
31781
31782
31783 . ////////////////////////////////////////////////////////////////////////////
31784 . ////////////////////////////////////////////////////////////////////////////
31785
31786 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
31787          "Exim as a non-queueing client"
31788 .cindex "client, non-queueing"
31789 .cindex "smart host" "suppressing queueing"
31790 On a personal computer, it is a common requirement for all
31791 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
31792 configured to operate that way, for all the popular operating systems.
31793 However, there are some MUAs for Unix-like systems that cannot be so
31794 configured: they submit messages using the command line interface of
31795 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
31796 messages this way.
31797
31798 If the personal computer runs continuously, there is no problem, because it can
31799 run a conventional MTA that handles delivery to the smart host, and deal with
31800 any delays via its queueing mechanism. However, if the computer does not run
31801 continuously or runs different operating systems at different times, queueing
31802 email is not desirable.
31803
31804 There is therefore a requirement for something that can provide the
31805 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
31806 any queueing or retrying facilities. Furthermore, the delivery to the smart
31807 host should be synchronous, so that if it fails, the sending MUA is immediately
31808 informed. In other words, we want something that extends an MUA that submits
31809 to a local MTA via the command line so that it behaves like one that submits
31810 to a remote smart host using TCP/SMTP.
31811
31812 There are a number of applications (for example, there is one called &'ssmtp'&)
31813 that do this job. However, people have found them to be lacking in various
31814 ways. For instance, you might want to allow aliasing and forwarding to be done
31815 before sending a message to the smart host.
31816
31817 Exim already had the necessary infrastructure for doing this job. Just a few
31818 tweaks were needed to make it behave as required, though it is somewhat of an
31819 overkill to use a fully-featured MTA for this purpose.
31820
31821 .oindex "&%mua_wrapper%&"
31822 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
31823 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
31824 assumes that it is being used to &"wrap"& a command-line MUA in the manner
31825 just described. As well as setting &%mua_wrapper%&, you also need to provide a
31826 compatible router and transport configuration. Typically there will be just one
31827 router and one transport, sending everything to a smart host.
31828
31829 When run in MUA wrapping mode, the behaviour of Exim changes in the
31830 following ways:
31831
31832 .ilist
31833 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
31834 In other words, the only way to submit messages is via the command line.
31835 .next
31836 Each message is synchronously delivered as soon as it is received (&%-odi%& is
31837 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
31838 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
31839 does not finish until the delivery attempt is complete. If the delivery is
31840 successful, a zero return code is given.
31841 .next
31842 Address redirection is permitted, but the final routing for all addresses must
31843 be to the same remote transport, and to the same list of hosts. Furthermore,
31844 the return address (envelope sender) must be the same for all recipients, as
31845 must any added or deleted header lines. In other words, it must be possible to
31846 deliver the message in a single SMTP transaction, however many recipients there
31847 are.
31848 .next
31849 If these conditions are not met, or if routing any address results in a
31850 failure or defer status, or if Exim is unable to deliver all the recipients
31851 successfully to one of the smart hosts, delivery of the entire message fails.
31852 .next
31853 Because no queueing is allowed, all failures are treated as permanent; there
31854 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
31855 smart host. Furthermore, because only a single yes/no response can be given to
31856 the caller, it is not possible to deliver to some recipients and not others. If
31857 there is an error (temporary or permanent) for any recipient, all are failed.
31858 .next
31859 If more than one smart host is listed, Exim will try another host after a
31860 connection failure or a timeout, in the normal way. However, if this kind of
31861 failure happens for all the hosts, the delivery fails.
31862 .next
31863 When delivery fails, an error message is written to the standard error stream
31864 (as well as to Exim's log), and Exim exits to the caller with a return code
31865 value 1. The message is expunged from Exim's spool files. No bounce messages
31866 are ever generated.
31867 .next
31868 No retry data is maintained, and any retry rules are ignored.
31869 .next
31870 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
31871 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
31872 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
31873 .endlist
31874
31875 The overall effect is that Exim makes a single synchronous attempt to deliver
31876 the message, failing if there is any kind of problem. Because no local
31877 deliveries are done and no daemon can be run, Exim does not need root
31878 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
31879 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
31880 the advantages and disadvantages of running without root privilege.
31881
31882
31883
31884
31885 . ////////////////////////////////////////////////////////////////////////////
31886 . ////////////////////////////////////////////////////////////////////////////
31887
31888 .chapter "Log files" "CHAPlog"
31889 .scindex IIDloggen "log" "general description"
31890 .cindex "log" "types of"
31891 Exim writes three different logs, referred to as the main log, the reject log,
31892 and the panic log:
31893
31894 .ilist
31895 .cindex "main log"
31896 The main log records the arrival of each message and each delivery in a single
31897 line in each case. The format is as compact as possible, in an attempt to keep
31898 down the size of log files. Two-character flag sequences make it easy to pick
31899 out these lines. A number of other events are recorded in the main log. Some of
31900 them are optional, in which case the &%log_selector%& option controls whether
31901 they are included or not. A Perl script called &'eximstats'&, which does simple
31902 analysis of main log files, is provided in the Exim distribution (see section
31903 &<<SECTmailstat>>&).
31904 .next
31905 .cindex "reject log"
31906 The reject log records information from messages that are rejected as a result
31907 of a configuration option (that is, for policy reasons).
31908 The first line of each rejection is a copy of the line that is also written to
31909 the main log. Then, if the message's header has been read at the time the log
31910 is written, its contents are written to this log. Only the original header
31911 lines are available; header lines added by ACLs are not logged. You can use the
31912 reject log to check that your policy controls are working correctly; on a busy
31913 host this may be easier than scanning the main log for rejection messages. You
31914 can suppress the writing of the reject log by setting &%write_rejectlog%&
31915 false.
31916 .next
31917 .cindex "panic log"
31918 .cindex "system log"
31919 When certain serious errors occur, Exim writes entries to its panic log. If the
31920 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
31921 are usually written to the main log as well, but can get lost amid the mass of
31922 other entries. The panic log should be empty under normal circumstances. It is
31923 therefore a good idea to check it (or to have a &'cron'& script check it)
31924 regularly, in order to become aware of any problems. When Exim cannot open its
31925 panic log, it tries as a last resort to write to the system log (syslog). This
31926 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
31927 message itself is written at priority LOG_CRIT.
31928 .endlist
31929
31930 Every log line starts with a timestamp, in the format shown in the following
31931 example. Note that many of the examples shown in this chapter are line-wrapped.
31932 In the log file, this would be all on one line:
31933 .code
31934 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
31935   by QUIT
31936 .endd
31937 By default, the timestamps are in the local timezone. There are two
31938 ways of changing this:
31939
31940 .ilist
31941 You can set the &%timezone%& option to a different time zone; in particular, if
31942 you set
31943 .code
31944 timezone = UTC
31945 .endd
31946 the timestamps will be in UTC (aka GMT).
31947 .next
31948 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
31949 example:
31950 .code
31951 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
31952 .endd
31953 .endlist
31954
31955 .cindex "log" "process ids in"
31956 .cindex "pid (process id)" "in log lines"
31957 Exim does not include its process id in log lines by default, but you can
31958 request that it does so by specifying the &`pid`& log selector (see section
31959 &<<SECTlogselector>>&). When this is set, the process id is output, in square
31960 brackets, immediately after the time and date.
31961
31962
31963
31964
31965 .section "Where the logs are written" "SECTwhelogwri"
31966 .cindex "log" "destination"
31967 .cindex "log" "to file"
31968 .cindex "log" "to syslog"
31969 .cindex "syslog"
31970 The logs may be written to local files, or to syslog, or both. However, it
31971 should be noted that many syslog implementations use UDP as a transport, and
31972 are therefore unreliable in the sense that messages are not guaranteed to
31973 arrive at the loghost, nor is the ordering of messages necessarily maintained.
31974 It has also been reported that on large log files (tens of megabytes) you may
31975 need to tweak syslog to prevent it syncing the file with each write &-- on
31976 Linux this has been seen to make syslog take 90% plus of CPU time.
31977
31978 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
31979 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
31980 configuration. This latter string is expanded, so it can contain, for example,
31981 references to the host name:
31982 .code
31983 log_file_path = /var/log/$primary_hostname/exim_%slog
31984 .endd
31985 It is generally advisable, however, to set the string in &_Local/Makefile_&
31986 rather than at run time, because then the setting is available right from the
31987 start of Exim's execution. Otherwise, if there's something it wants to log
31988 before it has read the configuration file (for example, an error in the
31989 configuration file) it will not use the path you want, and may not be able to
31990 log at all.
31991
31992 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
31993 list, currently limited to at most two items. This is one option where the
31994 facility for changing a list separator may not be used. The list must always be
31995 colon-separated. If an item in the list is &"syslog"& then syslog is used;
31996 otherwise the item must either be an absolute path, containing &`%s`& at the
31997 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
31998 implying the use of a default path.
31999
32000 When Exim encounters an empty item in the list, it searches the list defined by
32001 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
32002 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
32003 mean &"use the path specified at build time"&. It no such item exists, log
32004 files are written in the &_log_& subdirectory of the spool directory. This is
32005 equivalent to the setting:
32006 .code
32007 log_file_path = $spool_directory/log/%slog
32008 .endd
32009 If you do not specify anything at build time or run time, that is where the
32010 logs are written.
32011
32012 A log file path may also contain &`%D`& if datestamped log file names are in
32013 use &-- see section &<<SECTdatlogfil>>& below.
32014
32015 Here are some examples of possible settings:
32016 .display
32017 &`LOG_FILE_PATH=syslog                    `& syslog only
32018 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
32019 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
32020 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
32021 .endd
32022 If there are more than two paths in the list, the first is used and a panic
32023 error is logged.
32024
32025
32026
32027 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
32028 .cindex "log" "cycling local files"
32029 .cindex "cycling logs"
32030 .cindex "&'exicyclog'&"
32031 .cindex "log" "local files; writing to"
32032 Some operating systems provide centralized and standardized methods for cycling
32033 log files. For those that do not, a utility script called &'exicyclog'& is
32034 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
32035 main and reject logs each time it is called. The maximum number of old logs to
32036 keep can be set. It is suggested this script is run as a daily &'cron'& job.
32037
32038 An Exim delivery process opens the main log when it first needs to write to it,
32039 and it keeps the file open in case subsequent entries are required &-- for
32040 example, if a number of different deliveries are being done for the same
32041 message. However, remote SMTP deliveries can take a long time, and this means
32042 that the file may be kept open long after it is renamed if &'exicyclog'& or
32043 something similar is being used to rename log files on a regular basis. To
32044 ensure that a switch of log files is noticed as soon as possible, Exim calls
32045 &[stat()]& on the main log's name before reusing an open file, and if the file
32046 does not exist, or its inode has changed, the old file is closed and Exim
32047 tries to open the main log from scratch. Thus, an old log file may remain open
32048 for quite some time, but no Exim processes should write to it once it has been
32049 renamed.
32050
32051
32052
32053 .section "Datestamped log files" "SECTdatlogfil"
32054 .cindex "log" "datestamped files"
32055 Instead of cycling the main and reject log files by renaming them
32056 periodically, some sites like to use files whose names contain a datestamp,
32057 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_&.
32058 Exim has support for this way of working. It is enabled by setting the
32059 &%log_file_path%& option to a path that includes &`%D`& at the point where the
32060 datestamp is required. For example:
32061 .code
32062 log_file_path = /var/spool/exim/log/%slog-%D
32063 log_file_path = /var/log/exim-%s-%D.log
32064 log_file_path = /var/spool/exim/log/%D-%slog
32065 .endd
32066 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
32067 examples of names generated by the above examples:
32068 .code
32069 /var/spool/exim/log/mainlog-20021225
32070 /var/log/exim-reject-20021225.log
32071 /var/spool/exim/log/20021225-mainlog
32072 .endd
32073 When this form of log file is specified, Exim automatically switches to new
32074 files at midnight. It does not make any attempt to compress old logs; you
32075 will need to write your own script if you require this. You should not
32076 run &'exicyclog'& with this form of logging.
32077
32078 The location of the panic log is also determined by &%log_file_path%&, but it
32079 is not datestamped, because rotation of the panic log does not make sense.
32080 When generating the name of the panic log, &`%D`& is removed from the string.
32081 In addition, if it immediately follows a slash, a following non-alphanumeric
32082 character is removed; otherwise a preceding non-alphanumeric character is
32083 removed. Thus, the three examples above would give these panic log names:
32084 .code
32085 /var/spool/exim/log/paniclog
32086 /var/log/exim-panic.log
32087 /var/spool/exim/log/paniclog
32088 .endd
32089
32090
32091 .section "Logging to syslog" "SECID249"
32092 .cindex "log" "syslog; writing to"
32093 The use of syslog does not change what Exim logs or the format of its messages,
32094 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
32095 Exim's log lines are omitted when these lines are sent to syslog. Apart from
32096 that, the same strings are written to syslog as to log files. The syslog
32097 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
32098 by default, but you can change these by setting the &%syslog_facility%& and
32099 &%syslog_processname%& options, respectively. If Exim was compiled with
32100 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
32101 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
32102 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
32103 the time and host name to each line.
32104 The three log streams are mapped onto syslog priorities as follows:
32105
32106 .ilist
32107 &'mainlog'& is mapped to LOG_INFO
32108 .next
32109 &'rejectlog'& is mapped to LOG_NOTICE
32110 .next
32111 &'paniclog'& is mapped to LOG_ALERT
32112 .endlist
32113
32114 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
32115 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
32116 these are routed by syslog to the same place. You can suppress this duplication
32117 by setting &%syslog_duplication%& false.
32118
32119 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
32120 entries contain multiple lines when headers are included. To cope with both
32121 these cases, entries written to syslog are split into separate &[syslog()]&
32122 calls at each internal newline, and also after a maximum of
32123 870 data characters. (This allows for a total syslog line length of 1024, when
32124 additions such as timestamps are added.) If you are running a syslog
32125 replacement that can handle lines longer than the 1024 characters allowed by
32126 RFC 3164, you should set
32127 .code
32128 SYSLOG_LONG_LINES=yes
32129 .endd
32130 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
32131 lines, but it still splits at internal newlines in &'reject'& log entries.
32132
32133 To make it easy to re-assemble split lines later, each component of a split
32134 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
32135 where <&'n'&> is the component number and <&'m'&> is the total number of
32136 components in the entry. The / delimiter is used when the line was split
32137 because it was too long; if it was split because of an internal newline, the \
32138 delimiter is used. For example, supposing the length limit to be 50 instead of
32139 870, the following would be the result of a typical rejection message to
32140 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
32141 name, and pid as added by syslog:
32142 .code
32143 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
32144 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
32145 [3/5]  when scanning for sender: missing or malformed lo
32146 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
32147 [5/5] mple>)
32148 .endd
32149 The same error might cause the following lines to be written to &"rejectlog"&
32150 (LOG_NOTICE):
32151 .code
32152 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
32153 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
32154 [3/18] er when scanning for sender: missing or malformed
32155 [4/18]  local part in "<>" (envelope sender is <ph10@cam
32156 [5\18] .example>)
32157 [6\18] Recipients: ph10@some.domain.cam.example
32158 [7\18] P Received: from [127.0.0.1] (ident=ph10)
32159 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
32160 [9\18]        id 16RdAL-0006pc-00
32161 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
32162 [11\18] 09:43 +0100
32163 [12\18] F From: <>
32164 [13\18]   Subject: this is a test header
32165 [18\18]   X-something: this is another header
32166 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
32167 [16\18] le>
32168 [17\18] B Bcc:
32169 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
32170 .endd
32171 Log lines that are neither too long nor contain newlines are written to syslog
32172 without modification.
32173
32174 If only syslog is being used, the Exim monitor is unable to provide a log tail
32175 display, unless syslog is routing &'mainlog'& to a file on the local host and
32176 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
32177 where it is.
32178
32179
32180
32181 .section "Log line flags" "SECID250"
32182 One line is written to the main log for each message received, and for each
32183 successful, unsuccessful, and delayed delivery. These lines can readily be
32184 picked out by the distinctive two-character flags that immediately follow the
32185 timestamp. The flags are:
32186 .display
32187 &`<=`&     message arrival
32188 &`=>`&     normal message delivery
32189 &`->`&     additional address in same delivery
32190 &`*>`&     delivery suppressed by &%-N%&
32191 &`**`&     delivery failed; address bounced
32192 &`==`&     delivery deferred; temporary problem
32193 .endd
32194
32195
32196 .section "Logging message reception" "SECID251"
32197 .cindex "log" "reception line"
32198 The format of the single-line entry in the main log that is written for every
32199 message received is shown in the basic example below, which is split over
32200 several lines in order to fit it on the page:
32201 .code
32202 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
32203   H=mailer.fict.example [192.168.123.123] U=exim
32204   P=smtp S=5678 id=<incoming message id>
32205 .endd
32206 The address immediately following &"<="& is the envelope sender address. A
32207 bounce message is shown with the sender address &"<>"&, and if it is locally
32208 generated, this is followed by an item of the form
32209 .code
32210 R=<message id>
32211 .endd
32212 which is a reference to the message that caused the bounce to be sent.
32213
32214 .cindex "HELO"
32215 .cindex "EHLO"
32216 For messages from other hosts, the H and U fields identify the remote host and
32217 record the RFC 1413 identity of the user that sent the message, if one was
32218 received. The number given in square brackets is the IP address of the sending
32219 host. If there is a single, unparenthesized  host name in the H field, as
32220 above, it has been verified to correspond to the IP address (see the
32221 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
32222 by the remote host in the SMTP HELO or EHLO command, and has not been
32223 verified. If verification yields a different name to that given for HELO or
32224 EHLO, the verified name appears first, followed by the HELO or EHLO
32225 name in parentheses.
32226
32227 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
32228 without brackets, in the HELO or EHLO command, leading to entries in
32229 the log containing text like these examples:
32230 .code
32231 H=(10.21.32.43) [192.168.8.34]
32232 H=([10.21.32.43]) [192.168.8.34]
32233 .endd
32234 This can be confusing. Only the final address in square brackets can be relied
32235 on.
32236
32237 For locally generated messages (that is, messages not received over TCP/IP),
32238 the H field is omitted, and the U field contains the login name of the caller
32239 of Exim.
32240
32241 .cindex "authentication" "logging"
32242 .cindex "AUTH" "logging"
32243 For all messages, the P field specifies the protocol used to receive the
32244 message. This is the value that is stored in &$received_protocol$&. In the case
32245 of incoming SMTP messages, the value indicates whether or not any SMTP
32246 extensions (ESMTP), encryption, or authentication were used. If the SMTP
32247 session was encrypted, there is an additional X field that records the cipher
32248 suite that was used.
32249
32250 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
32251 hosts that have authenticated themselves using the SMTP AUTH command. The first
32252 value is used when the SMTP connection was encrypted (&"secure"&). In this case
32253 there is an additional item A= followed by the name of the authenticator that
32254 was used. If an authenticated identification was set up by the authenticator's
32255 &%server_set_id%& option, this is logged too, separated by a colon from the
32256 authenticator name.
32257
32258 .cindex "size" "of message"
32259 The id field records the existing message id, if present. The size of the
32260 received message is given by the S field. When the message is delivered,
32261 headers may be removed or added, so that the size of delivered copies of the
32262 message may not correspond with this value (and indeed may be different to each
32263 other).
32264
32265 The &%log_selector%& option can be used to request the logging of additional
32266 data when a message is received. See section &<<SECTlogselector>>& below.
32267
32268
32269
32270 .section "Logging deliveries" "SECID252"
32271 .cindex "log" "delivery line"
32272 The format of the single-line entry in the main log that is written for every
32273 delivery is shown in one of the examples below, for local and remote
32274 deliveries, respectively. Each example has been split into two lines in order
32275 to fit it on the page:
32276 .code
32277 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
32278   <marv@hitch.fict.example> R=localuser T=local_delivery
32279 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
32280   monk@holistic.fict.example R=dnslookup T=remote_smtp
32281   H=holistic.fict.example [192.168.234.234]
32282 .endd
32283 For ordinary local deliveries, the original address is given in angle brackets
32284 after the final delivery address, which might be a pipe or a file. If
32285 intermediate address(es) exist between the original and the final address, the
32286 last of these is given in parentheses after the final address. The R and T
32287 fields record the router and transport that were used to process the address.
32288
32289 If a shadow transport was run after a successful local delivery, the log line
32290 for the successful delivery has an item added on the end, of the form
32291 .display
32292 &`ST=<`&&'shadow transport name'&&`>`&
32293 .endd
32294 If the shadow transport did not succeed, the error message is put in
32295 parentheses afterwards.
32296
32297 .cindex "asterisk" "after IP address"
32298 When more than one address is included in a single delivery (for example, two
32299 SMTP RCPT commands in one transaction) the second and subsequent addresses are
32300 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
32301 down a single SMTP connection, an asterisk follows the IP address in the log
32302 lines for the second and subsequent messages.
32303
32304 The generation of a reply message by a filter file gets logged as a
32305 &"delivery"& to the addressee, preceded by &">"&.
32306
32307 The &%log_selector%& option can be used to request the logging of additional
32308 data when a message is delivered. See section &<<SECTlogselector>>& below.
32309
32310
32311 .section "Discarded deliveries" "SECID253"
32312 .cindex "discarded messages"
32313 .cindex "message" "discarded"
32314 .cindex "delivery" "discarded; logging"
32315 When a message is discarded as a result of the command &"seen finish"& being
32316 obeyed in a filter file which generates no deliveries, a log entry of the form
32317 .code
32318 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
32319   <low.club@bridge.example> R=userforward
32320 .endd
32321 is written, to record why no deliveries are logged. When a message is discarded
32322 because it is aliased to &":blackhole:"& the log line is like this:
32323 .code
32324 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
32325   <hole@nowhere.example> R=blackhole_router
32326 .endd
32327
32328
32329 .section "Deferred deliveries" "SECID254"
32330 When a delivery is deferred, a line of the following form is logged:
32331 .code
32332 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
32333   R=dnslookup T=smtp defer (146): Connection refused
32334 .endd
32335 In the case of remote deliveries, the error is the one that was given for the
32336 last IP address that was tried. Details of individual SMTP failures are also
32337 written to the log, so the above line would be preceded by something like
32338 .code
32339 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
32340   mail1.endrest.example [192.168.239.239]: Connection refused
32341 .endd
32342 When a deferred address is skipped because its retry time has not been reached,
32343 a message is written to the log, but this can be suppressed by setting an
32344 appropriate value in &%log_selector%&.
32345
32346
32347
32348 .section "Delivery failures" "SECID255"
32349 .cindex "delivery" "failure; logging"
32350 If a delivery fails because an address cannot be routed, a line of the
32351 following form is logged:
32352 .code
32353 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
32354   <jim@trek99.example>: unknown mail domain
32355 .endd
32356 If a delivery fails at transport time, the router and transport are shown, and
32357 the response from the remote host is included, as in this example:
32358 .code
32359 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
32360   R=dnslookup T=remote_smtp: SMTP error from remote mailer
32361   after pipelined RCPT TO:<ace400@pb.example>: host
32362   pbmail3.py.example [192.168.63.111]: 553 5.3.0
32363   <ace400@pb.example>...Addressee unknown
32364 .endd
32365 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
32366 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
32367 disabling PIPELINING. The log lines for all forms of delivery failure are
32368 flagged with &`**`&.
32369
32370
32371
32372 .section "Fake deliveries" "SECID256"
32373 .cindex "delivery" "fake; logging"
32374 If a delivery does not actually take place because the &%-N%& option has been
32375 used to suppress it, a normal delivery line is written to the log, except that
32376 &"=>"& is replaced by &"*>"&.
32377
32378
32379
32380 .section "Completion" "SECID257"
32381 A line of the form
32382 .code
32383 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
32384 .endd
32385 is written to the main log when a message is about to be removed from the spool
32386 at the end of its processing.
32387
32388
32389
32390
32391 .section "Summary of Fields in Log Lines" "SECID258"
32392 .cindex "log" "summary of fields"
32393 A summary of the field identifiers that are used in log lines is shown in
32394 the following table:
32395 .display
32396 &`A   `&        authenticator name (and optional id)
32397 &`C   `&        SMTP confirmation on delivery
32398 &`    `&        command list for &"no mail in SMTP session"&
32399 &`CV  `&        certificate verification status
32400 &`D   `&        duration of &"no mail in SMTP session"&
32401 &`DN  `&        distinguished name from peer certificate
32402 &`DT  `&        on &`=>`& lines: time taken for a delivery
32403 &`F   `&        sender address (on delivery lines)
32404 &`H   `&        host name and IP address
32405 &`I   `&        local interface used
32406 &`id  `&        message id for incoming message
32407 &`P   `&        on &`<=`& lines: protocol used
32408 &`    `&        on &`=>`& and &`**`& lines: return path
32409 &`QT  `&        on &`=>`& lines: time spent on queue so far
32410 &`    `&        on &"Completed"& lines: time spent on queue
32411 &`R   `&        on &`<=`& lines: reference for local bounce
32412 &`    `&        on &`=>`&  &`**`& and &`==`& lines: router name
32413 &`S   `&        size of message
32414 &`ST  `&        shadow transport name
32415 &`T   `&        on &`<=`& lines: message subject (topic)
32416 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
32417 &`U   `&        local user or RFC 1413 identity
32418 &`X   `&        TLS cipher suite
32419 .endd
32420
32421
32422 .section "Other log entries" "SECID259"
32423 Various other types of log entry are written from time to time. Most should be
32424 self-explanatory. Among the more common are:
32425
32426 .ilist
32427 .cindex "retry" "time not reached"
32428 &'retry time not reached'&&~&~An address previously suffered a temporary error
32429 during routing or local delivery, and the time to retry has not yet arrived.
32430 This message is not written to an individual message log file unless it happens
32431 during the first delivery attempt.
32432 .next
32433 &'retry time not reached for any host'&&~&~An address previously suffered
32434 temporary errors during remote delivery, and the retry time has not yet arrived
32435 for any of the hosts to which it is routed.
32436 .next
32437 .cindex "spool directory" "file locked"
32438 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
32439 some other Exim process is already working on the message. This can be quite
32440 common if queue running processes are started at frequent intervals. The
32441 &'exiwhat'& utility script can be used to find out what Exim processes are
32442 doing.
32443 .next
32444 .cindex "error" "ignored"
32445 &'error ignored'&&~&~There are several circumstances that give rise to this
32446 message:
32447 .olist
32448 Exim failed to deliver a bounce message whose age was greater than
32449 &%ignore_bounce_errors_after%&. The bounce was discarded.
32450 .next
32451 A filter file set up a delivery using the &"noerror"& option, and the delivery
32452 failed. The delivery was discarded.
32453 .next
32454 A delivery set up by a router configured with
32455 . ==== As this is a nested list, any displays it contains must be indented
32456 . ==== as otherwise they are too far to the left.
32457 .code
32458     errors_to = <>
32459 .endd
32460 failed. The delivery was discarded.
32461 .endlist olist
32462 .endlist ilist
32463
32464
32465
32466
32467
32468 .section "Reducing or increasing what is logged" "SECTlogselector"
32469 .cindex "log" "selectors"
32470 By setting the &%log_selector%& global option, you can disable some of Exim's
32471 default logging, or you can request additional logging. The value of
32472 &%log_selector%& is made up of names preceded by plus or minus characters. For
32473 example:
32474 .code
32475 log_selector = +arguments -retry_defer
32476 .endd
32477 The list of optional log items is in the following table, with the default
32478 selection marked by asterisks:
32479 .display
32480 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
32481 &` address_rewrite            `&  address rewriting
32482 &` all_parents                `&  all parents in => lines
32483 &` arguments                  `&  command line arguments
32484 &`*connection_reject          `&  connection rejections
32485 &`*delay_delivery             `&  immediate delivery delayed
32486 &` deliver_time               `&  time taken to perform delivery
32487 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
32488 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
32489 &`*etrn                       `&  ETRN commands
32490 &`*host_lookup_failed         `&  as it says
32491 &` ident_timeout              `&  timeout for ident connection
32492 &` incoming_interface         `&  incoming interface on <= lines
32493 &` incoming_port              `&  incoming port on <= lines
32494 &`*lost_incoming_connection   `&  as it says (includes timeouts)
32495 &` outgoing_port              `&  add remote port to => lines
32496 &`*queue_run                  `&  start and end queue runs
32497 &` queue_time                 `&  time on queue for one recipient
32498 &` queue_time_overall         `&  time on queue for whole message
32499 &` pid                        `&  Exim process id
32500 &` received_recipients        `&  recipients on <= lines
32501 &` received_sender            `&  sender on <= lines
32502 &`*rejected_header            `&  header contents on reject log
32503 &`*retry_defer                `&  &"retry time not reached"&
32504 &` return_path_on_delivery    `&  put return path on => and ** lines
32505 &` sender_on_delivery         `&  add sender to => lines
32506 &`*sender_verify_fail         `&  sender verification failures
32507 &`*size_reject                `&  rejection because too big
32508 &`*skip_delivery              `&  delivery skipped in a queue run
32509 &` smtp_confirmation          `&  SMTP confirmation on => lines
32510 &` smtp_connection            `&  SMTP connections
32511 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
32512 &` smtp_no_mail               `&  session with no MAIL commands
32513 &` smtp_protocol_error        `&  SMTP protocol errors
32514 &` smtp_syntax_error          `&  SMTP syntax errors
32515 &` subject                    `&  contents of &'Subject:'& on <= lines
32516 &` tls_certificate_verified   `&  certificate verification status
32517 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
32518 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
32519 &` unknown_in_list            `&  DNS lookup failed in list match
32520
32521 &` all                        `&  all of the above
32522 .endd
32523 More details on each of these items follows:
32524
32525 .ilist
32526 .cindex "&%warn%& ACL verb" "log when skipping"
32527 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
32528 its conditions cannot be evaluated, a log line to this effect is written if
32529 this log selector is set.
32530 .next
32531 .cindex "log" "rewriting"
32532 .cindex "rewriting" "logging"
32533 &%address_rewrite%&: This applies both to global rewrites and per-transport
32534 rewrites, but not to rewrites in filters run as an unprivileged user (because
32535 such users cannot access the log).
32536 .next
32537 .cindex "log" "full parentage"
32538 &%all_parents%&: Normally only the original and final addresses are logged on
32539 delivery lines; with this selector, intermediate parents are given in
32540 parentheses between them.
32541 .next
32542 .cindex "log" "Exim arguments"
32543 .cindex "Exim arguments, logging"
32544 &%arguments%&: This causes Exim to write the arguments with which it was called
32545 to the main log, preceded by the current working directory. This is a debugging
32546 feature, added to make it easier to find out how certain MUAs call
32547 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
32548 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
32549 that are empty or that contain white space are quoted. Non-printing characters
32550 are shown as escape sequences. This facility cannot log unrecognized arguments,
32551 because the arguments are checked before the configuration file is read. The
32552 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
32553 between the caller and Exim.
32554 .next
32555 .cindex "log" "connection rejections"
32556 &%connection_reject%&: A log entry is written whenever an incoming SMTP
32557 connection is rejected, for whatever reason.
32558 .next
32559 .cindex "log" "delayed delivery"
32560 .cindex "delayed delivery, logging"
32561 &%delay_delivery%&: A log entry is written whenever a delivery process is not
32562 started for an incoming message because the load is too high or too many
32563 messages were received on one connection. Logging does not occur if no delivery
32564 process is started because &%queue_only%& is set or &%-odq%& was used.
32565 .next
32566 .cindex "log" "delivery duration"
32567 &%deliver_time%&: For each delivery, the amount of real time it has taken to
32568 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
32569 .next
32570 .cindex "log" "message size on delivery"
32571 .cindex "size" "of message"
32572 &%delivery_size%&: For each delivery, the size of message delivered is added to
32573 the &"=>"& line, tagged with S=.
32574 .next
32575 .cindex "log" "dnslist defer"
32576 .cindex "DNS list" "logging defer"
32577 .cindex "black list (DNS)"
32578 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
32579 DNS black list suffers a temporary error.
32580 .next
32581 .cindex "log" "ETRN commands"
32582 .cindex "ETRN" "logging"
32583 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
32584 is run to determine whether or not it is actually accepted. An invalid ETRN
32585 command, or one received within a message transaction is not logged by this
32586 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
32587 .next
32588 .cindex "log" "host lookup failure"
32589 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
32590 any addresses, or when a lookup of an IP address fails to find a host name, a
32591 log line is written. This logging does not apply to direct DNS lookups when
32592 routing email addresses, but it does apply to &"byname"& lookups.
32593 .next
32594 .cindex "log" "ident timeout"
32595 .cindex "RFC 1413" "logging timeout"
32596 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
32597 client's ident port times out.
32598 .next
32599 .cindex "log" "incoming interface"
32600 .cindex "interface" "logging"
32601 &%incoming_interface%&: The interface on which a message was received is added
32602 to the &"<="& line as an IP address in square brackets, tagged by I= and
32603 followed by a colon and the port number. The local interface and port are also
32604 added to other SMTP log lines, for example &"SMTP connection from"&, and to
32605 rejection lines.
32606 .next
32607 .cindex "log" "incoming remote port"
32608 .cindex "port" "logging remote"
32609 .cindex "TCP/IP" "logging incoming remote port"
32610 .vindex "&$sender_fullhost$&"
32611 .vindex "&$sender_rcvhost$&"
32612 &%incoming_port%&: The remote port number from which a message was received is
32613 added to log entries and &'Received:'& header lines, following the IP address
32614 in square brackets, and separated from it by a colon. This is implemented by
32615 changing the value that is put in the &$sender_fullhost$& and
32616 &$sender_rcvhost$& variables. Recording the remote port number has become more
32617 important with the widening use of NAT (see RFC 2505).
32618 .next
32619 .cindex "log" "dropped connection"
32620 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
32621 connection is unexpectedly dropped.
32622 .next
32623 .cindex "log" "outgoing remote port"
32624 .cindex "port" "logging outgoint remote"
32625 .cindex "TCP/IP" "logging ougtoing remote port"
32626 &%outgoing_port%&: The remote port number is added to delivery log lines (those
32627 containing => tags) following the IP address. This option is not included in
32628 the default setting, because for most ordinary configurations, the remote port
32629 number is always 25 (the SMTP port).
32630 .next
32631 .cindex "log" "process ids in"
32632 .cindex "pid (process id)" "in log lines"
32633 &%pid%&: The current process id is added to every log line, in square brackets,
32634 immediately after the time and date.
32635 .next
32636 .cindex "log" "queue run"
32637 .cindex "queue runner" "logging"
32638 &%queue_run%&: The start and end of every queue run are logged.
32639 .next
32640 .cindex "log" "queue time"
32641 &%queue_time%&: The amount of time the message has been in the queue on the
32642 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
32643 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
32644 includes reception time as well as the delivery time for the current address.
32645 This means that it may be longer than the difference between the arrival and
32646 delivery log line times, because the arrival log line is not written until the
32647 message has been successfully received.
32648 .next
32649 &%queue_time_overall%&: The amount of time the message has been in the queue on
32650 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
32651 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
32652 message, so it includes reception time as well as the total delivery time.
32653 .next
32654 .cindex "log" "recipients"
32655 &%received_recipients%&: The recipients of a message are listed in the main log
32656 as soon as the message is received. The list appears at the end of the log line
32657 that is written when a message is received, preceded by the word &"for"&. The
32658 addresses are listed after they have been qualified, but before any rewriting
32659 has taken place.
32660 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
32661 in the list.
32662 .next
32663 .cindex "log" "sender reception"
32664 &%received_sender%&: The unrewritten original sender of a message is added to
32665 the end of the log line that records the message's arrival, after the word
32666 &"from"& (before the recipients if &%received_recipients%& is also set).
32667 .next
32668 .cindex "log" "header lines for rejection"
32669 &%rejected_header%&: If a message's header has been received at the time a
32670 rejection is written to the reject log, the complete header is added to the
32671 log. Header logging can be turned off individually for messages that are
32672 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
32673 .next
32674 .cindex "log" "retry defer"
32675 &%retry_defer%&: A log line is written if a delivery is deferred because a
32676 retry time has not yet been reached. However, this &"retry time not reached"&
32677 message is always omitted from individual message logs after the first delivery
32678 attempt.
32679 .next
32680 .cindex "log" "return path"
32681 &%return_path_on_delivery%&: The return path that is being transmitted with
32682 the message is included in delivery and bounce lines, using the tag P=.
32683 This is omitted if no delivery actually happens, for example, if routing fails,
32684 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
32685 .next
32686 .cindex "log" "sender on delivery"
32687 &%sender_on_delivery%&: The message's sender address is added to every delivery
32688 and bounce line, tagged by F= (for &"from"&).
32689 This is the original sender that was received with the message; it is not
32690 necessarily the same as the outgoing return path.
32691 .next
32692 .cindex "log" "sender verify failure"
32693 &%sender_verify_fail%&: If this selector is unset, the separate log line that
32694 gives details of a sender verification failure is not written. Log lines for
32695 the rejection of SMTP commands contain just &"sender verify failed"&, so some
32696 detail is lost.
32697 .next
32698 .cindex "log" "size rejection"
32699 &%size_reject%&: A log line is written whenever a message is rejected because
32700 it is too big.
32701 .next
32702 .cindex "log" "frozen messages; skipped"
32703 .cindex "frozen messages" "logging skipping"
32704 &%skip_delivery%&: A log line is written whenever a message is skipped during a
32705 queue run because it is frozen or because another process is already delivering
32706 it.
32707 .cindex "&""spool file is locked""&"
32708 The message that is written is &"spool file is locked"&.
32709 .next
32710 .cindex "log" "smtp confirmation"
32711 .cindex "SMTP" "logging confirmation"
32712 &%smtp_confirmation%&: The response to the final &"."& in the SMTP dialogue for
32713 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
32714 A number of MTAs (including Exim) return an identifying string in this
32715 response.
32716 .next
32717 .cindex "log" "SMTP connections"
32718 .cindex "SMTP" "logging connections"
32719 &%smtp_connection%&: A log line is written whenever an SMTP connection is
32720 established or closed, unless the connection is from a host that matches
32721 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
32722 only when the closure is unexpected.) This applies to connections from local
32723 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
32724 dropped in the middle of a message, a log line is always written, whether or
32725 not this selector is set, but otherwise nothing is written at the start and end
32726 of connections unless this selector is enabled.
32727
32728 For TCP/IP connections to an Exim daemon, the current number of connections is
32729 included in the log message for each new connection, but note that the count is
32730 reset if the daemon is restarted.
32731 Also, because connections are closed (and the closure is logged) in
32732 subprocesses, the count may not include connections that have been closed but
32733 whose termination the daemon has not yet noticed. Thus, while it is possible to
32734 match up the opening and closing of connections in the log, the value of the
32735 logged counts may not be entirely accurate.
32736 .next
32737 .cindex "log" "SMTP transaction; incomplete"
32738 .cindex "SMTP" "logging incomplete transactions"
32739 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
32740 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
32741 and the message sender plus any accepted recipients are included in the log
32742 line. This can provide evidence of dictionary attacks.
32743 .next
32744 .cindex "log" "non-MAIL SMTP sessions"
32745 .cindex "MAIL" "logging session without"
32746 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
32747 connection terminates without having issued a MAIL command. This includes both
32748 the case when the connection is dropped, and the case when QUIT is used. It
32749 does not include cases where the connection is rejected right at the start (by
32750 an ACL, or because there are too many connections, or whatever). These cases
32751 already have their own log lines.
32752
32753 The log line that is written contains the identity of the client in the usual
32754 way, followed by D= and a time, which records the duration of the connection.
32755 If the connection was authenticated, this fact is logged exactly as it is for
32756 an incoming message, with an A= item. If the connection was encrypted, CV=,
32757 DN=, and X= items may appear as they do for an incoming message, controlled by
32758 the same logging options.
32759
32760 Finally, if any SMTP commands were issued during the connection, a C= item
32761 is added to the line, listing the commands that were used. For example,
32762 .code
32763 C=EHLO,QUIT
32764 .endd
32765 shows that the client issued QUIT straight after EHLO. If there were fewer
32766 than 20 commands, they are all listed. If there were more than 20 commands,
32767 the last 20 are listed, preceded by &"..."&. However, with the default
32768 setting of 10 for &%smtp_accep_max_nonmail%&, the connection will in any case
32769 have been aborted before 20 non-mail commands are processed.
32770 .next
32771 .cindex "log" "SMTP protocol error"
32772 .cindex "SMTP" "logging protocol error"
32773 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
32774 encountered. Exim does not have perfect detection of all protocol errors
32775 because of transmission delays and the use of pipelining. If PIPELINING has
32776 been advertised to a client, an Exim server assumes that the client will use
32777 it, and therefore it does not count &"expected"& errors (for example, RCPT
32778 received after rejecting MAIL) as protocol errors.
32779 .next
32780 .cindex "SMTP" "logging syntax errors"
32781 .cindex "SMTP" "syntax errors; logging"
32782 .cindex "SMTP" "unknown command; logging"
32783 .cindex "log" "unknown SMTP command"
32784 .cindex "log" "SMTP syntax error"
32785 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
32786 encountered. An unrecognized command is treated as a syntax error. For an
32787 external connection, the host identity is given; for an internal connection
32788 using &%-bs%& the sender identification (normally the calling user) is given.
32789 .next
32790 .cindex "log" "subject"
32791 .cindex "subject, logging"
32792 &%subject%&: The subject of the message is added to the arrival log line,
32793 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
32794 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
32795 specifies whether characters with values greater than 127 should be logged
32796 unchanged, or whether they should be rendered as escape sequences.
32797 .next
32798 .cindex "log" "certificate verification"
32799 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
32800 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
32801 verified, and &`CV=no`& if not.
32802 .next
32803 .cindex "log" "TLS cipher"
32804 .cindex "TLS" "logging cipher"
32805 &%tls_cipher%&: When a message is sent or received over an encrypted
32806 connection, the cipher suite used is added to the log line, preceded by X=.
32807 .next
32808 .cindex "log" "TLS peer DN"
32809 .cindex "TLS" "logging peer DN"
32810 &%tls_peerdn%&: When a message is sent or received over an encrypted
32811 connection, and a certificate is supplied by the remote host, the peer DN is
32812 added to the log line, preceded by DN=.
32813 .next
32814 .cindex "log" "DNS failure in list"
32815 &%unknown_in_list%&: This setting causes a log entry to be written when the
32816 result of a list match is failure because a DNS lookup failed.
32817 .endlist
32818
32819
32820 .section "Message log" "SECID260"
32821 .cindex "message" "log file for"
32822 .cindex "log" "message log; description of"
32823 .cindex "&_msglog_& directory"
32824 .oindex "&%preserve_message_logs%&"
32825 In addition to the general log files, Exim writes a log file for each message
32826 that it handles. The names of these per-message logs are the message ids, and
32827 they are kept in the &_msglog_& sub-directory of the spool directory. Each
32828 message log contains copies of the log lines that apply to the message. This
32829 makes it easier to inspect the status of an individual message without having
32830 to search the main log. A message log is deleted when processing of the message
32831 is complete, unless &%preserve_message_logs%& is set, but this should be used
32832 only with great care because they can fill up your disk very quickly.
32833
32834 On a heavily loaded system, it may be desirable to disable the use of
32835 per-message logs, in order to reduce disk I/O. This can be done by setting the
32836 &%message_logs%& option false.
32837 .ecindex IIDloggen
32838
32839
32840
32841
32842 . ////////////////////////////////////////////////////////////////////////////
32843 . ////////////////////////////////////////////////////////////////////////////
32844
32845 .chapter "Exim utilities" "CHAPutils"
32846 .scindex IIDutils "utilities"
32847 A number of utility scripts and programs are supplied with Exim and are
32848 described in this chapter. There is also the Exim Monitor, which is covered in
32849 the next chapter. The utilities described here are:
32850
32851 .itable none 0 0 3  7* left  15* left  40* left
32852 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
32853   "list what Exim processes are doing"
32854 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
32855 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
32856 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
32857 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
32858                                                 various criteria"
32859 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
32860 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
32861   "extract statistics from the log"
32862 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
32863   "check address acceptance from given IP"
32864 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
32865 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
32866 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
32867 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
32868 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
32869 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
32870 .endtable
32871
32872 Another utility that might be of use to sites with many MTAs is Tom Kistner's
32873 &'exilog'&. It provides log visualizations across multiple Exim servers. See
32874 &url(http://duncanthrax.net/exilog/) for details.
32875
32876
32877
32878
32879 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
32880 .cindex "&'exiwhat'&"
32881 .cindex "process, querying"
32882 .cindex "SIGUSR1"
32883 On operating systems that can restart a system call after receiving a signal
32884 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
32885 a line describing what it is doing to the file &_exim-process.info_& in the
32886 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
32887 processes it can find, having first emptied the file. It then waits for one
32888 second to allow the Exim processes to react before displaying the results. In
32889 order to run &'exiwhat'& successfully you have to have sufficient privilege to
32890 send the signal to the Exim processes, so it is normally run as root.
32891
32892 &*Warning*&: This is not an efficient process. It is intended for occasional
32893 use by system administrators. It is not sensible, for example, to set up a
32894 script that sends SIGUSR1 signals to Exim processes at short intervals.
32895
32896
32897 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
32898 varies in different operating systems. Not only are different options used,
32899 but the format of the output is different. For this reason, there are some
32900 system configuration options that configure exactly how &'exiwhat'& works. If
32901 it doesn't seem to be working for you, check the following compile-time
32902 options:
32903 .display
32904 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
32905 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
32906 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
32907 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
32908 .endd
32909 An example of typical output from &'exiwhat'& is
32910 .code
32911 164 daemon: -q1h, listening on port 25
32912 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
32913 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
32914   [10.19.42.42] (editor@ref.example)
32915 10592 handling incoming call from [192.168.243.242]
32916 10628 accepting a local non-SMTP message
32917 .endd
32918 The first number in the output line is the process number. The third line has
32919 been split here, in order to fit it on the page.
32920
32921
32922
32923 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
32924 .cindex "&'exiqgrep'&"
32925 .cindex "queue" "grepping"
32926 This utility is a Perl script contributed by Matt Hubbard. It runs
32927 .code
32928 exim -bpu
32929 .endd
32930 to obtain a queue listing with undelivered recipients only, and then greps the
32931 output to select messages that match given criteria. The following selection
32932 options are available:
32933
32934 .vlist
32935 .vitem &*-f*&&~<&'regex'&>
32936 Match the sender address. The field that is tested is enclosed in angle
32937 brackets, so you can test for bounce messages with
32938 .code
32939 exiqgrep -f '^<>$'
32940 .endd
32941 .vitem &*-r*&&~<&'regex'&>
32942 Match a recipient address. The field that is tested is not enclosed in angle
32943 brackets.
32944
32945 .vitem &*-s*&&~<&'regex'&>
32946 Match against the size field.
32947
32948 .vitem &*-y*&&~<&'seconds'&>
32949 Match messages that are younger than the given time.
32950
32951 .vitem &*-o*&&~<&'seconds'&>
32952 Match messages that are older than the given time.
32953
32954 .vitem &*-z*&
32955 Match only frozen messages.
32956
32957 .vitem &*-x*&
32958 Match only non-frozen messages.
32959 .endlist
32960
32961 The following options control the format of the output:
32962
32963 .vlist
32964 .vitem &*-c*&
32965 Display only the count of matching messages.
32966
32967 .vitem &*-l*&
32968 Long format &-- display the full message information as output by Exim. This is
32969 the default.
32970
32971 .vitem &*-i*&
32972 Display message ids only.
32973
32974 .vitem &*-b*&
32975 Brief format &-- one line per message.
32976
32977 .vitem &*-R*&
32978 Display messages in reverse order.
32979 .endlist
32980
32981 There is one more option, &%-h%&, which outputs a list of options.
32982
32983
32984
32985 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
32986 .cindex "&'exiqsumm'&"
32987 .cindex "queue" "summary"
32988 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
32989 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
32990 running a command such as
32991 .code
32992 exim -bp | exiqsumm
32993 .endd
32994 The output consists of one line for each domain that has messages waiting for
32995 it, as in the following example:
32996 .code
32997 3   2322   74m   66m  msn.com.example
32998 .endd
32999 Each line lists the number of pending deliveries for a domain, their total
33000 volume, and the length of time that the oldest and the newest messages have
33001 been waiting. Note that the number of pending deliveries is greater than the
33002 number of messages when messages have more than one recipient.
33003
33004 A summary line is output at the end. By default the output is sorted on the
33005 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
33006 the output to be sorted by oldest message and by count of messages,
33007 respectively. There are also three options that split the messages for each
33008 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
33009 separates frozen messages, and &%-s%& separates messages according to their
33010 sender.
33011
33012 The output of &'exim -bp'& contains the original addresses in the message, so
33013 this also applies to the output from &'exiqsumm'&. No domains from addresses
33014 generated by aliasing or forwarding are included (unless the &%one_time%&
33015 option of the &(redirect)& router has been used to convert them into &"top
33016 level"& addresses).
33017
33018
33019
33020
33021 .section "Extracting specific information from the log (exigrep)" &&&
33022          "SECTextspeinf"
33023 .cindex "&'exigrep'&"
33024 .cindex "log" "extracts; grepping for"
33025 The &'exigrep'& utility is a Perl script that searches one or more main log
33026 files for entries that match a given pattern. When it finds a match, it
33027 extracts all the log entries for the relevant message, not just those that
33028 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
33029 given message, or all mail for a given user, or for a given host, for example.
33030 The input files can be in Exim log format or syslog format.
33031 If a matching log line is not associated with a specific message, it is
33032 included in &'exigrep'&'s output without any additional lines. The usage is:
33033 .display
33034 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
33035 .endd
33036 If no log file names are given on the command line, the standard input is read.
33037
33038 The &%-t%& argument specifies a number of seconds. It adds an additional
33039 condition for message selection. Messages that are complete are shown only if
33040 they spent more than <&'n'&> seconds on the queue.
33041
33042 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
33043 makes it case-sensitive. This may give a performance improvement when searching
33044 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
33045 option; with &%-I%& they do not. In both cases it is possible to change the
33046 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
33047
33048 The &%-l%& option means &"literal"&, that is, treat all characters in the
33049 pattern as standing for themselves. Otherwise the pattern must be a Perl
33050 regular expression.
33051
33052 The &%-v%& option inverts the matching condition. That is, a line is selected
33053 if it does &'not'& match the pattern.
33054
33055 If the location of a &'zcat'& command is known from the definition of
33056 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
33057 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
33058
33059
33060 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
33061 .cindex "&'exipick'&"
33062 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
33063 lists messages from the queue according to a variety of criteria. For details
33064 of &'exipick'&'s facilities, visit the web page at
33065 &url(http://www.exim.org/eximwiki/ToolExipickManPage) or run &'exipick'& with
33066 the &%--help%& option.
33067
33068
33069 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
33070 .cindex "log" "cycling local files"
33071 .cindex "cycling logs"
33072 .cindex "&'exicyclog'&"
33073 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
33074 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
33075 you are using log files with datestamps in their names (see section
33076 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
33077 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
33078 There are two command line options for &'exicyclog'&:
33079 .ilist
33080 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
33081 default that is set when Exim is built. The default default is 10.
33082 .next
33083 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
33084 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
33085 overriding the script's default, which is to find the setting from Exim's
33086 configuration.
33087 .endlist
33088
33089 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
33090 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
33091 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
33092 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
33093 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
33094 logs are handled similarly.
33095
33096 If the limit is greater than 99, the script uses 3-digit numbers such as
33097 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
33098 to one that is greater, or &'vice versa'&, you will have to fix the names of
33099 any existing log files.
33100
33101 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
33102 the end are deleted. All files with numbers greater than 01 are compressed,
33103 using a compression command which is configured by the COMPRESS_COMMAND
33104 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
33105 root &%crontab%& entry of the form
33106 .code
33107 1 0 * * * su exim -c /usr/exim/bin/exicyclog
33108 .endd
33109 assuming you have used the name &"exim"& for the Exim user. You can run
33110 &'exicyclog'& as root if you wish, but there is no need.
33111
33112
33113
33114 .section "Mail statistics (eximstats)" "SECTmailstat"
33115 .cindex "statistics"
33116 .cindex "&'eximstats'&"
33117 A Perl script called &'eximstats'& is provided for extracting statistical
33118 information from log files. The output is either plain text, or HTML.
33119 Exim log files are also supported by the &'Lire'& system produced by the
33120 LogReport Foundation &url(http://www.logreport.org).
33121
33122 The &'eximstats'& script has been hacked about quite a bit over time. The
33123 latest version is the result of some extensive revision by Steve Campbell. A
33124 lot of information is given by default, but there are options for suppressing
33125 various parts of it. Following any options, the arguments to the script are a
33126 list of files, which should be main log files. For example:
33127 .code
33128 eximstats -nr /var/spool/exim/log/mainlog.01
33129 .endd
33130 By default, &'eximstats'& extracts information about the number and volume of
33131 messages received from or delivered to various hosts. The information is sorted
33132 both by message count and by volume, and the top fifty hosts in each category
33133 are listed on the standard output. Similar information, based on email
33134 addresses or domains instead of hosts can be requested by means of various
33135 options. For messages delivered and received locally, similar statistics are
33136 also produced per user.
33137
33138 The output also includes total counts and statistics about delivery errors, and
33139 histograms showing the number of messages received and deliveries made in each
33140 hour of the day. A delivery with more than one address in its envelope (for
33141 example, an SMTP transaction with more than one RCPT command) is counted
33142 as a single delivery by &'eximstats'&.
33143
33144 Though normally more deliveries than receipts are reported (as messages may
33145 have multiple recipients), it is possible for &'eximstats'& to report more
33146 messages received than delivered, even though the queue is empty at the start
33147 and end of the period in question. If an incoming message contains no valid
33148 recipients, no deliveries are recorded for it. A bounce message is handled as
33149 an entirely separate message.
33150
33151 &'eximstats'& always outputs a grand total summary giving the volume and number
33152 of messages received and deliveries made, and the number of hosts involved in
33153 each case. It also outputs the number of messages that were delayed (that is,
33154 not completely delivered at the first attempt), and the number that had at
33155 least one address that failed.
33156
33157 The remainder of the output is in sections that can be independently disabled
33158 or modified by various options. It consists of a summary of deliveries by
33159 transport, histograms of messages received and delivered per time interval
33160 (default per hour), information about the time messages spent on the queue,
33161 a list of relayed messages, lists of the top fifty sending hosts, local
33162 senders, destination hosts, and destination local users by count and by volume,
33163 and a list of delivery errors that occurred.
33164
33165 The relay information lists messages that were actually relayed, that is, they
33166 came from a remote host and were directly delivered to some other remote host,
33167 without being processed (for example, for aliasing or forwarding) locally.
33168
33169 There are quite a few options for &'eximstats'& to control exactly what it
33170 outputs. These are documented in the Perl script itself, and can be extracted
33171 by running the command &(perldoc)& on the script. For example:
33172 .code
33173 perldoc /usr/exim/bin/eximstats
33174 .endd
33175
33176 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
33177 .cindex "&'exim_checkaccess'&"
33178 .cindex "policy control" "checking access"
33179 .cindex "checking access"
33180 The &%-bh%& command line argument allows you to run a fake SMTP session with
33181 debugging output, in order to check what Exim is doing when it is applying
33182 policy controls to incoming SMTP mail. However, not everybody is sufficiently
33183 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
33184 sometimes you just want to answer the question &"Does this address have
33185 access?"& without bothering with any further details.
33186
33187 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
33188 two arguments, an IP address and an email address:
33189 .code
33190 exim_checkaccess 10.9.8.7 A.User@a.domain.example
33191 .endd
33192 The utility runs a call to Exim with the &%-bh%& option, to test whether the
33193 given email address would be accepted in a RCPT command in a TCP/IP
33194 connection from the host with the given IP address. The output of the utility
33195 is either the word &"accepted"&, or the SMTP error response, for example:
33196 .code
33197 Rejected:
33198 550 Relay not permitted
33199 .endd
33200 When running this test, the utility uses &`<>`& as the envelope sender address
33201 for the MAIL command, but you can change this by providing additional
33202 options. These are passed directly to the Exim command. For example, to specify
33203 that the test is to be run with the sender address &'himself@there.example'&
33204 you can use:
33205 .code
33206 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
33207                  -f himself@there.example
33208 .endd
33209 Note that these additional Exim command line items must be given after the two
33210 mandatory arguments.
33211
33212 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
33213 while running its checks. You can run checks that include callouts by using
33214 &%-bhc%&, but this is not yet available in a &"packaged"& form.
33215
33216
33217
33218 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
33219 .cindex "DBM" "building dbm files"
33220 .cindex "building DBM files"
33221 .cindex "&'exim_dbmbuild'&"
33222 .cindex "lower casing"
33223 .cindex "binary zero" "in lookup key"
33224 The &'exim_dbmbuild'& program reads an input file containing keys and data in
33225 the format used by the &(lsearch)& lookup (see section
33226 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
33227 names as keys and the remainder of the information as data. The lower-casing
33228 can be prevented by calling the program with the &%-nolc%& option.
33229
33230 A terminating zero is included as part of the key string. This is expected by
33231 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
33232 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
33233 strings or the data strings. The &(dbmnz)& lookup type can be used with such
33234 files.
33235
33236 The program requires two arguments: the name of the input file (which can be a
33237 single hyphen to indicate the standard input), and the name of the output file.
33238 It creates the output under a temporary name, and then renames it if all went
33239 well.
33240
33241 .cindex "USE_DB"
33242 If the native DB interface is in use (USE_DB is set in a compile-time
33243 configuration file &-- this is common in free versions of Unix) the two file
33244 names must be different, because in this mode the Berkeley DB functions create
33245 a single output file using exactly the name given. For example,
33246 .code
33247 exim_dbmbuild /etc/aliases /etc/aliases.db
33248 .endd
33249 reads the system alias file and creates a DBM version of it in
33250 &_/etc/aliases.db_&.
33251
33252 In systems that use the &'ndbm'& routines (mostly proprietary versions of
33253 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
33254 environment, the suffixes are added to the second argument of
33255 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
33256 when the Berkeley functions are used in compatibility mode (though this is not
33257 recommended), because in that case it adds a &_.db_& suffix to the file name.
33258
33259 If a duplicate key is encountered, the program outputs a warning, and when it
33260 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
33261 option is used. By default, only the first of a set of duplicates is used &--
33262 this makes it compatible with &(lsearch)& lookups. There is an option
33263 &%-lastdup%& which causes it to use the data for the last duplicate instead.
33264 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
33265 &%stderr%&. For other errors, where it doesn't actually make a new file, the
33266 return code is 2.
33267
33268
33269
33270
33271 .section "Finding individual retry times (exinext)" "SECTfinindret"
33272 .cindex "retry" "times"
33273 .cindex "&'exinext'&"
33274 A utility called &'exinext'& (mostly a Perl script) provides the ability to
33275 fish specific information out of the retry database. Given a mail domain (or a
33276 complete address), it looks up the hosts for that domain, and outputs any retry
33277 information for the hosts or for the domain. At present, the retry information
33278 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
33279 output. For example:
33280 .code
33281 $ exinext piglet@milne.fict.example
33282 kanga.milne.example:192.168.8.1 error 146: Connection refused
33283   first failed: 21-Feb-1996 14:57:34
33284   last tried:   21-Feb-1996 14:57:34
33285   next try at:  21-Feb-1996 15:02:34
33286 roo.milne.example:192.168.8.3 error 146: Connection refused
33287   first failed: 20-Jan-1996 13:12:08
33288   last tried:   21-Feb-1996 11:42:03
33289   next try at:  21-Feb-1996 19:42:03
33290   past final cutoff time
33291 .endd
33292 You can also give &'exinext'& a local part, without a domain, and it
33293 will give any retry information for that local part in your default domain.
33294 A message id can be used to obtain retry information pertaining to a specific
33295 message. This exists only when an attempt to deliver a message to a remote host
33296 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
33297 &'exinext'& is not particularly efficient, but then it is not expected to be
33298 run very often.
33299
33300 The &'exinext'& utility calls Exim to find out information such as the location
33301 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
33302 passed on to the &'exim'& commands. The first specifies an alternate Exim
33303 configuration file, and the second sets macros for use within the configuration
33304 file. These features are mainly to help in testing, but might also be useful in
33305 environments where more than one configuration file is in use.
33306
33307
33308
33309 .section "Hints database maintenance" "SECThindatmai"
33310 .cindex "hints database" "maintenance"
33311 .cindex "maintaining Exim's hints database"
33312 Three utility programs are provided for maintaining the DBM files that Exim
33313 uses to contain its delivery hint information. Each program requires two
33314 arguments. The first specifies the name of Exim's spool directory, and the
33315 second is the name of the database it is to operate on. These are as follows:
33316
33317 .ilist
33318 &'retry'&: the database of retry information
33319 .next
33320 &'wait-'&<&'transport name'&>: databases of information about messages waiting
33321 for remote hosts
33322 .next
33323 &'callout'&: the callout cache
33324 .next
33325 &'ratelimit'&: the data for implementing the ratelimit ACL condition
33326 .next
33327 &'misc'&: other hints data
33328 .endlist
33329
33330 The &'misc'& database is used for
33331
33332 .ilist
33333 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
33334 .next
33335 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
33336 &(smtp)& transport)
33337 .endlist
33338
33339
33340
33341 .section "exim_dumpdb" "SECID261"
33342 .cindex "&'exim_dumpdb'&"
33343 The entire contents of a database are written to the standard output by the
33344 &'exim_dumpdb'& program, which has no options or arguments other than the
33345 spool and database names. For example, to dump the retry database:
33346 .code
33347 exim_dumpdb /var/spool/exim retry
33348 .endd
33349 Two lines of output are produced for each entry:
33350 .code
33351 T:mail.ref.example:192.168.242.242 146 77 Connection refused
33352 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
33353 .endd
33354 The first item on the first line is the key of the record. It starts with one
33355 of the letters R, or T, depending on whether it refers to a routing or
33356 transport retry. For a local delivery, the next part is the local address; for
33357 a remote delivery it is the name of the remote host, followed by its failing IP
33358 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
33359 transport). If the remote port is not the standard one (port 25), it is added
33360 to the IP address. Then there follows an error code, an additional error code,
33361 and a textual description of the error.
33362
33363 The three times on the second line are the time of first failure, the time of
33364 the last delivery attempt, and the computed time for the next attempt. The line
33365 ends with an asterisk if the cutoff time for the last retry rule has been
33366 exceeded.
33367
33368 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
33369 consists of a host name followed by a list of ids for messages that are or were
33370 waiting to be delivered to that host. If there are a very large number for any
33371 one host, continuation records, with a sequence number added to the host name,
33372 may be seen. The data in these records is often out of date, because a message
33373 may be routed to several alternative hosts, and Exim makes no effort to keep
33374 cross-references.
33375
33376
33377
33378 .section "exim_tidydb" "SECID262"
33379 .cindex "&'exim_tidydb'&"
33380 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
33381 database. If run with no options, it removes all records that are more than 30
33382 days old. The age is calculated from the date and time that the record was last
33383 updated. Note that, in the case of the retry database, it is &'not'& the time
33384 since the first delivery failure. Information about a host that has been down
33385 for more than 30 days will remain in the database, provided that the record is
33386 updated sufficiently often.
33387
33388 The cutoff date can be altered by means of the &%-t%& option, which must be
33389 followed by a time. For example, to remove all records older than a week from
33390 the retry database:
33391 .code
33392 exim_tidydb -t 7d /var/spool/exim retry
33393 .endd
33394 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
33395 message ids. In the former these appear as data in records keyed by host &--
33396 they were messages that were waiting for that host &-- and in the latter they
33397 are the keys for retry information for messages that have suffered certain
33398 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
33399 message ids in database records are those of messages that are still on the
33400 queue. Message ids for messages that no longer exist are removed from
33401 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
33402 For the &'retry'& database, records whose keys are non-existent message ids are
33403 removed. The &'exim_tidydb'& utility outputs comments on the standard output
33404 whenever it removes information from the database.
33405
33406 Certain records are automatically removed by Exim when they are no longer
33407 needed, but others are not. For example, if all the MX hosts for a domain are
33408 down, a retry record is created for each one. If the primary MX host comes back
33409 first, its record is removed when Exim successfully delivers to it, but the
33410 records for the others remain because Exim has not tried to use those hosts.
33411
33412 It is important, therefore, to run &'exim_tidydb'& periodically on all the
33413 hints databases. You should do this at a quiet time of day, because it requires
33414 a database to be locked (and therefore inaccessible to Exim) while it does its
33415 work. Removing records from a DBM file does not normally make the file smaller,
33416 but all the common DBM libraries are able to re-use the space that is released.
33417 After an initial phase of increasing in size, the databases normally reach a
33418 point at which they no longer get any bigger, as long as they are regularly
33419 tidied.
33420
33421 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
33422 databases is likely to keep on increasing.
33423
33424
33425
33426
33427 .section "exim_fixdb" "SECID263"
33428 .cindex "&'exim_fixdb'&"
33429 The &'exim_fixdb'& program is a utility for interactively modifying databases.
33430 Its main use is for testing Exim, but it might also be occasionally useful for
33431 getting round problems in a live system. It has no options, and its interface
33432 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
33433 key of a database record can then be entered, and the data for that record is
33434 displayed.
33435
33436 If &"d"& is typed at the next prompt, the entire record is deleted. For all
33437 except the &'retry'& database, that is the only operation that can be carried
33438 out. For the &'retry'& database, each field is output preceded by a number, and
33439 data for individual fields can be changed by typing the field number followed
33440 by new data, for example:
33441 .code
33442 > 4 951102:1000
33443 .endd
33444 resets the time of the next delivery attempt. Time values are given as a
33445 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
33446 used as optional separators.
33447
33448
33449
33450
33451 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
33452 .cindex "mailbox" "maintenance"
33453 .cindex "&'exim_lock'&"
33454 .cindex "locking mailboxes"
33455 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
33456 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
33457 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
33458 a user agent while investigating a problem. The utility requires the name of
33459 the file as its first argument. If the locking is successful, the second
33460 argument is run as a command (using C's &[system()]& function); if there is no
33461 second argument, the value of the SHELL environment variable is used; if this
33462 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
33463 is unlocked and the utility ends. The following options are available:
33464
33465 .vlist
33466 .vitem &%-fcntl%&
33467 Use &[fcntl()]& locking on the open mailbox.
33468
33469 .vitem &%-flock%&
33470 Use &[flock()]& locking on the open mailbox, provided the operating system
33471 supports it.
33472
33473 .vitem &%-interval%&
33474 This must be followed by a number, which is a number of seconds; it sets the
33475 interval to sleep between retries (default 3).
33476
33477 .vitem &%-lockfile%&
33478 Create a lock file before opening the mailbox.
33479
33480 .vitem &%-mbx%&
33481 Lock the mailbox using MBX rules.
33482
33483 .vitem &%-q%&
33484 Suppress verification output.
33485
33486 .vitem &%-retries%&
33487 This must be followed by a number; it sets the number of times to try to get
33488 the lock (default 10).
33489
33490 .vitem &%-restore_time%&
33491 This option causes &%exim_lock%& to restore the modified and read times to the
33492 locked file before exiting. This allows you to access a locked mailbox (for
33493 example, to take a backup copy) without disturbing the times that the user
33494 subsequently sees.
33495
33496 .vitem &%-timeout%&
33497 This must be followed by a number, which is a number of seconds; it sets a
33498 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
33499 default), a non-blocking call is used.
33500
33501 .vitem &%-v%&
33502 Generate verbose output.
33503 .endlist
33504
33505 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
33506 default is to create a lock file and also to use &[fcntl()]& locking on the
33507 mailbox, which is the same as Exim's default. The use of &%-flock%& or
33508 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
33509 requires that the directory containing the file be writeable. Locking by lock
33510 file does not last for ever; Exim assumes that a lock file is expired if it is
33511 more than 30 minutes old.
33512
33513 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
33514 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
33515 to be taken out on the open mailbox, and an exclusive lock on the file
33516 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
33517 number of the mailbox file. When the locking is released, if an exclusive lock
33518 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
33519
33520 The default output contains verification of the locking that takes place. The
33521 &%-v%& option causes some additional information to be given. The &%-q%& option
33522 suppresses all output except error messages.
33523
33524 A command such as
33525 .code
33526 exim_lock /var/spool/mail/spqr
33527 .endd
33528 runs an interactive shell while the file is locked, whereas
33529 .display
33530 &`exim_lock -q /var/spool/mail/spqr <<End`&
33531 <&'some commands'&>
33532 &`End`&
33533 .endd
33534 runs a specific non-interactive sequence of commands while the file is locked,
33535 suppressing all verification output. A single command can be run by a command
33536 such as
33537 .code
33538 exim_lock -q /var/spool/mail/spqr \
33539   "cp /var/spool/mail/spqr /some/where"
33540 .endd
33541 Note that if a command is supplied, it must be entirely contained within the
33542 second argument &-- hence the quotes.
33543 .ecindex IIDutils
33544
33545
33546 . ////////////////////////////////////////////////////////////////////////////
33547 . ////////////////////////////////////////////////////////////////////////////
33548
33549 .chapter "The Exim monitor" "CHAPeximon"
33550 .scindex IIDeximon "Exim monitor" "description"
33551 .cindex "X-windows"
33552 .cindex "&'eximon'&"
33553 .cindex "Local/eximon.conf"
33554 .cindex "&_exim_monitor/EDITME_&"
33555 The Exim monitor is an application which displays in an X window information
33556 about the state of Exim's queue and what Exim is doing. An admin user can
33557 perform certain operations on messages from this GUI interface; however all
33558 such facilities are also available from the command line, and indeed, the
33559 monitor itself makes use of the command line to perform any actions requested.
33560
33561
33562
33563 .section "Running the monitor" "SECID264"
33564 The monitor is started by running the script called &'eximon'&. This is a shell
33565 script that sets up a number of environment variables, and then runs the
33566 binary called &_eximon.bin_&. The default appearance of the monitor window can
33567 be changed by editing the &_Local/eximon.conf_& file created by editing
33568 &_exim_monitor/EDITME_&. Comments in that file describe what the various
33569 parameters are for.
33570
33571 The parameters that get built into the &'eximon'& script can be overridden for
33572 a particular invocation by setting up environment variables of the same names,
33573 preceded by &`EXIMON_`&. For example, a shell command such as
33574 .code
33575 EXIMON_LOG_DEPTH=400 eximon
33576 .endd
33577 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
33578 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
33579 overrides the Exim log file configuration. This makes it possible to have
33580 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
33581 syslog messages are routed to a file on the local host.
33582
33583 X resources can be used to change the appearance of the window in the normal
33584 way. For example, a resource setting of the form
33585 .code
33586 Eximon*background: gray94
33587 .endd
33588 changes the colour of the background to light grey rather than white. The
33589 stripcharts are drawn with both the data lines and the reference lines in
33590 black. This means that the reference lines are not visible when on top of the
33591 data. However, their colour can be changed by setting a resource called
33592 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
33593 For example, if your X server is running Unix, you could set up lighter
33594 reference lines in the stripcharts by obeying
33595 .code
33596 xrdb -merge <<End
33597 Eximon*highlight: gray
33598 End
33599 .endd
33600 .cindex "admin user"
33601 In order to see the contents of messages on the queue, and to operate on them,
33602 &'eximon'& must either be run as root or by an admin user.
33603
33604 The monitor's window is divided into three parts. The first contains one or
33605 more stripcharts and two action buttons, the second contains a &"tail"& of the
33606 main log file, and the third is a display of the queue of messages awaiting
33607 delivery, with two more action buttons. The following sections describe these
33608 different parts of the display.
33609
33610
33611
33612
33613 .section "The stripcharts" "SECID265"
33614 .cindex "stripchart"
33615 The first stripchart is always a count of messages on the queue. Its name can
33616 be configured by setting QUEUE_STRIPCHART_NAME in the
33617 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
33618 configuration script by regular expression matches on log file entries, making
33619 it possible to display, for example, counts of messages delivered to certain
33620 hosts or using certain transports. The supplied defaults display counts of
33621 received and delivered messages, and of local and SMTP deliveries. The default
33622 period between stripchart updates is one minute; this can be adjusted by a
33623 parameter in the &_Local/eximon.conf_& file.
33624
33625 The stripchart displays rescale themselves automatically as the value they are
33626 displaying changes. There are always 10 horizontal lines in each chart; the
33627 title string indicates the value of each division when it is greater than one.
33628 For example, &"x2"& means that each division represents a value of 2.
33629
33630 It is also possible to have a stripchart which shows the percentage fullness of
33631 a particular disk partition, which is useful when local deliveries are confined
33632 to a single partition.
33633
33634 .cindex "&%statvfs%& function"
33635 This relies on the availability of the &[statvfs()]& function or equivalent in
33636 the operating system. Most, but not all versions of Unix that support Exim have
33637 this. For this particular stripchart, the top of the chart always represents
33638 100%, and the scale is given as &"x10%"&. This chart is configured by setting
33639 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
33640 &_Local/eximon.conf_& file.
33641
33642
33643
33644
33645 .section "Main action buttons" "SECID266"
33646 .cindex "size" "of monitor window"
33647 .cindex "Exim monitor" "window size"
33648 .cindex "window size"
33649 Below the stripcharts there is an action button for quitting the monitor. Next
33650 to this is another button marked &"Size"&. They are placed here so that
33651 shrinking the window to its default minimum size leaves just the queue count
33652 stripchart and these two buttons visible. Pressing the &"Size"& button causes
33653 the window to expand to its maximum size, unless it is already at the maximum,
33654 in which case it is reduced to its minimum.
33655
33656 When expanding to the maximum, if the window cannot be fully seen where it
33657 currently is, it is moved back to where it was the last time it was at full
33658 size. When it is expanding from its minimum size, the old position is
33659 remembered, and next time it is reduced to the minimum it is moved back there.
33660
33661 The idea is that you can keep a reduced window just showing one or two
33662 stripcharts at a convenient place on your screen, easily expand it to show
33663 the full window when required, and just as easily put it back to what it was.
33664 The idea is copied from what the &'twm'& window manager does for its
33665 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
33666 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
33667
33668 Normally, the monitor starts up with the window at its full size, but it can be
33669 built so that it starts up with the window at its smallest size, by setting
33670 START_SMALL=yes in &_Local/eximon.conf_&.
33671
33672
33673
33674 .section "The log display" "SECID267"
33675 .cindex "log" "tail of; in monitor"
33676 The second section of the window is an area in which a display of the tail of
33677 the main log is maintained.
33678 To save space on the screen, the timestamp on each log line is shortened by
33679 removing the date and, if &%log_timezone%& is set, the timezone.
33680 The log tail is not available when the only destination for logging data is
33681 syslog, unless the syslog lines are routed to a local file whose name is passed
33682 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
33683
33684 The log sub-window has a scroll bar at its lefthand side which can be used to
33685 move back to look at earlier text, and the up and down arrow keys also have a
33686 scrolling effect. The amount of log that is kept depends on the setting of
33687 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
33688 to use. When this is full, the earlier 50% of data is discarded &-- this is
33689 much more efficient than throwing it away line by line. The sub-window also has
33690 a horizontal scroll bar for accessing the ends of long log lines. This is the
33691 only means of horizontal scrolling; the right and left arrow keys are not
33692 available. Text can be cut from this part of the window using the mouse in the
33693 normal way. The size of this subwindow is controlled by parameters in the
33694 configuration file &_Local/eximon.conf_&.
33695
33696 Searches of the text in the log window can be carried out by means of the ^R
33697 and ^S keystrokes, which default to a reverse and a forward search,
33698 respectively. The search covers only the text that is displayed in the window.
33699 It cannot go further back up the log.
33700
33701 The point from which the search starts is indicated by a caret marker. This is
33702 normally at the end of the text in the window, but can be positioned explicitly
33703 by pointing and clicking with the left mouse button, and is moved automatically
33704 by a successful search. If new text arrives in the window when it is scrolled
33705 back, the caret remains where it is, but if the window is not scrolled back,
33706 the caret is moved to the end of the new text.
33707
33708 Pressing ^R or ^S pops up a window into which the search text can be typed.
33709 There are buttons for selecting forward or reverse searching, for carrying out
33710 the search, and for cancelling. If the &"Search"& button is pressed, the search
33711 happens and the window remains so that further searches can be done. If the
33712 &"Return"& key is pressed, a single search is done and the window is closed. If
33713 ^C is typed the search is cancelled.
33714
33715 The searching facility is implemented using the facilities of the Athena text
33716 widget. By default this pops up a window containing both &"search"& and
33717 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
33718 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
33719 However, the linkers in BSDI and HP-UX seem unable to handle an externally
33720 provided version of &%TextPop%& when the remaining parts of the text widget
33721 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
33722 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
33723 on these systems, at the expense of having unwanted items in the search popup
33724 window.
33725
33726
33727
33728 .section "The queue display" "SECID268"
33729 .cindex "queue" "display in monitor"
33730 The bottom section of the monitor window contains a list of all messages that
33731 are on the queue, which includes those currently being received or delivered,
33732 as well as those awaiting delivery. The size of this subwindow is controlled by
33733 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
33734 at which it is updated is controlled by another parameter in the same file &--
33735 the default is 5 minutes, since queue scans can be quite expensive. However,
33736 there is an &"Update"& action button just above the display which can be used
33737 to force an update of the queue display at any time.
33738
33739 When a host is down for some time, a lot of pending mail can build up for it,
33740 and this can make it hard to deal with other messages on the queue. To help
33741 with this situation there is a button next to &"Update"& called &"Hide"&. If
33742 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
33743 type anything in here and press &"Return"&, the text is added to a chain of
33744 such texts, and if every undelivered address in a message matches at least one
33745 of the texts, the message is not displayed.
33746
33747 If there is an address that does not match any of the texts, all the addresses
33748 are displayed as normal. The matching happens on the ends of addresses so, for
33749 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
33750 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
33751 has been set up, a button called &"Unhide"& is displayed. If pressed, it
33752 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
33753 a hide request is automatically cancelled after one hour.
33754
33755 While the dialogue box is displayed, you can't press any buttons or do anything
33756 else to the monitor window. For this reason, if you want to cut text from the
33757 queue display to use in the dialogue box, you have to do the cutting before
33758 pressing the &"Hide"& button.
33759
33760 The queue display contains, for each unhidden queued message, the length of
33761 time it has been on the queue, the size of the message, the message id, the
33762 message sender, and the first undelivered recipient, all on one line. If it is
33763 a bounce message, the sender is shown as &"<>"&. If there is more than one
33764 recipient to which the message has not yet been delivered, subsequent ones are
33765 listed on additional lines, up to a maximum configured number, following which
33766 an ellipsis is displayed. Recipients that have already received the message are
33767 not shown.
33768
33769 .cindex "frozen messages" "display"
33770 If a message is frozen, an asterisk is displayed at the left-hand side.
33771
33772 The queue display has a vertical scroll bar, and can also be scrolled by means
33773 of the arrow keys. Text can be cut from it using the mouse in the normal way.
33774 The text searching facilities, as described above for the log window, are also
33775 available, but the caret is always moved to the end of the text when the queue
33776 display is updated.
33777
33778
33779
33780 .section "The queue menu" "SECID269"
33781 .cindex "queue" "menu in monitor"
33782 If the &%shift%& key is held down and the left button is clicked when the mouse
33783 pointer is over the text for any message, an action menu pops up, and the first
33784 line of the queue display for the message is highlighted. This does not affect
33785 any selected text.
33786
33787 If you want to use some other event for popping up the menu, you can set the
33788 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
33789 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
33790 value set in this parameter is a standard X event description. For example, to
33791 run eximon using &%ctrl%& rather than &%shift%& you could use
33792 .code
33793 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
33794 .endd
33795 The title of the menu is the message id, and it contains entries which act as
33796 follows:
33797
33798 .ilist
33799 &'message log'&: The contents of the message log for the message are displayed
33800 in a new text window.
33801 .next
33802 &'headers'&: Information from the spool file that contains the envelope
33803 information and headers is displayed in a new text window. See chapter
33804 &<<CHAPspool>>& for a description of the format of spool files.
33805 .next
33806 &'body'&: The contents of the spool file containing the body of the message are
33807 displayed in a new text window. There is a default limit of 20,000 bytes to the
33808 amount of data displayed. This can be changed by setting the BODY_MAX
33809 option at compile time, or the EXIMON_BODY_MAX option at run time.
33810 .next
33811 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
33812 delivery of the message. This causes an automatic thaw if the message is
33813 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
33814 a new text window. The delivery is run in a separate process, to avoid holding
33815 up the monitor while the delivery proceeds.
33816 .next
33817 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
33818 that the message be frozen.
33819 .next
33820 .cindex "thawing messages"
33821 .cindex "unfreezing messages"
33822 .cindex "frozen messages" "thawing"
33823 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
33824 that the message be thawed.
33825 .next
33826 .cindex "delivery" "forcing failure"
33827 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
33828 that Exim gives up trying to deliver the message. A bounce message is generated
33829 for any remaining undelivered addresses.
33830 .next
33831 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
33832 that the message be deleted from the system without generating a bounce
33833 message.
33834 .next
33835 &'add recipient'&: A dialog box is displayed into which a recipient address can
33836 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
33837 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
33838 Otherwise it must be entered as a fully qualified address. Pressing RETURN
33839 causes a call to Exim to be made using the &%-Mar%& option to request that an
33840 additional recipient be added to the message, unless the entry box is empty, in
33841 which case no action is taken.
33842 .next
33843 &'mark delivered'&: A dialog box is displayed into which a recipient address
33844 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
33845 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
33846 Otherwise it must be entered as a fully qualified address. Pressing RETURN
33847 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
33848 recipient address as already delivered, unless the entry box is empty, in which
33849 case no action is taken.
33850 .next
33851 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
33852 mark all recipient addresses as already delivered.
33853 .next
33854 &'edit sender'&: A dialog box is displayed initialized with the current
33855 sender's address. Pressing RETURN causes a call to Exim to be made using the
33856 &%-Mes%& option to replace the sender address, unless the entry box is empty,
33857 in which case no action is taken. If you want to set an empty sender (as in
33858 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
33859 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
33860 the address is qualified with that domain.
33861 .endlist
33862
33863 When a delivery is forced, a window showing the &%-v%& output is displayed. In
33864 other cases when a call to Exim is made, if there is any output from Exim (in
33865 particular, if the command fails) a window containing the command and the
33866 output is displayed. Otherwise, the results of the action are normally apparent
33867 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
33868 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
33869 if no output is generated.
33870
33871 The queue display is automatically updated for actions such as freezing and
33872 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
33873 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
33874 force an update of the display after one of these actions.
33875
33876 In any text window that is displayed as result of a menu action, the normal
33877 cut-and-paste facility is available, and searching can be carried out using ^R
33878 and ^S, as described above for the log tail window.
33879 .ecindex IIDeximon
33880
33881
33882
33883
33884
33885 . ////////////////////////////////////////////////////////////////////////////
33886 . ////////////////////////////////////////////////////////////////////////////
33887
33888 .chapter "Security considerations" "CHAPsecurity"
33889 .scindex IIDsecurcon "security" "discussion of"
33890 This chapter discusses a number of issues concerned with security, some of
33891 which are also covered in other parts of this manual.
33892
33893 For reasons that this author does not understand, some people have promoted
33894 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
33895 existence of this chapter in the documentation. However, the intent of the
33896 chapter is simply to describe the way Exim works in relation to certain
33897 security concerns, not to make any specific claims about the effectiveness of
33898 its security as compared with other MTAs.
33899
33900 What follows is a description of the way Exim is supposed to be. Best efforts
33901 have been made to try to ensure that the code agrees with the theory, but an
33902 absence of bugs can never be guaranteed. Any that are reported will get fixed
33903 as soon as possible.
33904
33905
33906 .section "Building a more &""hardened""& Exim" "SECID286"
33907 .cindex "security" "build-time features"
33908 There are a number of build-time options that can be set in &_Local/Makefile_&
33909 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
33910 Exim administrator who does not have the root password, or by someone who has
33911 penetrated the Exim (but not the root) account. These options are as follows:
33912
33913 .ilist
33914 ALT_CONFIG_PREFIX can be set to a string that is required to match the
33915 start of any file names used with the &%-C%& option. When it is set, these file
33916 names are also not allowed to contain the sequence &"/../"&. (However, if the
33917 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
33918 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
33919 default setting for &%ALT_CONFIG_PREFIX%&.
33920
33921 .new
33922 If the permitted configuration files are confined to a directory to
33923 which only root has access, this guards against someone who has broken
33924 into the Exim account from running a privileged Exim with an arbitrary
33925 configuration file, and using it to break into other accounts.
33926 .next
33927
33928 If a non-trusted configuration file (i.e. not the default configuration file
33929 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
33930 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
33931 the next item), then root privilege is retained only if the caller of Exim is
33932 root. This locks out the possibility of testing a configuration using &%-C%&
33933 right through message reception and delivery, even if the caller is root. The
33934 reception works, but by that time, Exim is running as the Exim user, so when
33935 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
33936 privilege to be lost. However, root can test reception and delivery using two
33937 separate commands.
33938
33939 .next
33940 The WHITELIST_D_MACROS build option declares some macros to be safe to override
33941 with &%-D%& if the real uid is one of root, the Exim run-time user or the
33942 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
33943 requiring the run-time value supplied to &%-D%& to match a regex that errs on
33944 the restrictive side.  Requiring build-time selection of safe macros is onerous
33945 but this option is intended solely as a transition mechanism to permit
33946 previously-working configurations to continue to work after release 4.73.
33947 .next
33948 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
33949 is disabled.
33950 .next
33951 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
33952 never to be used for any deliveries. This is like the &%never_users%& runtime
33953 option, but it cannot be overridden; the runtime option adds additional users
33954 to the list. The default setting is &"root"&; this prevents a non-root user who
33955 is permitted to modify the runtime file from using Exim as a way to get root.
33956 .endlist
33957 .wen
33958
33959
33960
33961 .section "Root privilege" "SECID270"
33962 .cindex "setuid"
33963 .cindex "root privilege"
33964 The Exim binary is normally setuid to root, which means that it gains root
33965 privilege (runs as root) when it starts execution. In some special cases (for
33966 example, when the daemon is not in use and there are no local deliveries), it
33967 may be possible to run Exim setuid to some user other than root. This is
33968 discussed in the next section. However, in most installations, root privilege
33969 is required for two things:
33970
33971 .ilist
33972 To set up a socket connected to the standard SMTP port (25) when initialising
33973 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
33974 not required.
33975 .next
33976 To be able to change uid and gid in order to read users' &_.forward_& files and
33977 perform local deliveries as the receiving user or as specified in the
33978 configuration.
33979 .endlist
33980
33981 It is not necessary to be root to do any of the other things Exim does, such as
33982 receiving messages and delivering them externally over SMTP, and it is
33983 obviously more secure if Exim does not run as root except when necessary.
33984 For this reason, a user and group for Exim to use must be defined in
33985 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
33986 group"&. Their values can be changed by the run time configuration, though this
33987 is not recommended. Often a user called &'exim'& is used, but some sites use
33988 &'mail'& or another user name altogether.
33989
33990 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
33991 abdication; the process cannot regain root afterwards. Prior to release 4.00,
33992 &[seteuid()]& was used in some circumstances, but this is no longer the case.
33993
33994 After a new Exim process has interpreted its command line options, it changes
33995 uid and gid in the following cases:
33996
33997 .new
33998 .ilist
33999 .oindex "&%-C%&"
34000 .oindex "&%-D%&"
34001 If the &%-C%& option is used to specify an alternate configuration file, or if
34002 the &%-D%& option is used to define macro values for the configuration, and the
34003 calling process is not running as root, the uid and gid are changed to those of
34004 the calling process.
34005 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
34006 option may not be used at all.
34007 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
34008 can be supplied if the calling process is running as root, the Exim run-time
34009 user or CONFIGURE_OWNER, if defined.
34010 .next
34011 .oindex "&%-be%&"
34012 .oindex "&%-bf%&"
34013 .oindex "&%-bF%&"
34014 If the expansion test option (&%-be%&) or one of the filter testing options
34015 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
34016 calling process.
34017 .next
34018 If the process is not a daemon process or a queue runner process or a delivery
34019 process or a process for testing address routing (started with &%-bt%&), the
34020 uid and gid are changed to the Exim user and group. This means that Exim always
34021 runs under its own uid and gid when receiving messages. This also applies when
34022 testing address verification
34023 .oindex "&%-bv%&"
34024 .oindex "&%-bh%&"
34025 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
34026 option).
34027 .next
34028 For a daemon, queue runner, delivery, or address testing process, the uid
34029 remains as root at this stage, but the gid is changed to the Exim group.
34030 .endlist
34031 .wen
34032 The processes that initially retain root privilege behave as follows:
34033
34034 .ilist
34035 A daemon process changes the gid to the Exim group and the uid to the Exim
34036 user after setting up one or more listening sockets. The &[initgroups()]&
34037 function is called, so that if the Exim user is in any additional groups, they
34038 will be used during message reception.
34039 .next
34040 A queue runner process retains root privilege throughout its execution. Its
34041 job is to fork a controlled sequence of delivery processes.
34042 .next
34043 A delivery process retains root privilege throughout most of its execution,
34044 but any actual deliveries (that is, the transports themselves) are run in
34045 subprocesses which always change to a non-root uid and gid. For local
34046 deliveries this is typically the uid and gid of the owner of the mailbox; for
34047 remote deliveries, the Exim uid and gid are used. Once all the delivery
34048 subprocesses have been run, a delivery process changes to the Exim uid and gid
34049 while doing post-delivery tidying up such as updating the retry database and
34050 generating bounce and warning messages.
34051
34052 While the recipient addresses in a message are being routed, the delivery
34053 process runs as root. However, if a user's filter file has to be processed,
34054 this is done in a subprocess that runs under the individual user's uid and
34055 gid. A system filter is run as root unless &%system_filter_user%& is set.
34056 .next
34057 A process that is testing addresses (the &%-bt%& option) runs as root so that
34058 the routing is done in the same environment as a message delivery.
34059 .endlist
34060
34061
34062
34063
34064 .section "Running Exim without privilege" "SECTrunexiwitpri"
34065 .cindex "privilege, running without"
34066 .cindex "unprivileged running"
34067 .cindex "root privilege" "running without"
34068 Some installations like to run Exim in an unprivileged state for more of its
34069 operation, for added security. Support for this mode of operation is provided
34070 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
34071 gid are changed to the Exim user and group at the start of a delivery process
34072 (and also queue runner and address testing processes). This means that address
34073 routing is no longer run as root, and the deliveries themselves cannot change
34074 to any other uid.
34075
34076 .cindex SIGHUP
34077 .cindex "daemon" "restarting"
34078 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
34079 that the daemon can still be started in the usual way, and it can respond
34080 correctly to SIGHUP because the re-invocation regains root privilege.
34081
34082 An alternative approach is to make Exim setuid to the Exim user and also setgid
34083 to the Exim group. If you do this, the daemon must be started from a root
34084 process. (Calling Exim from a root process makes it behave in the way it does
34085 when it is setuid root.) However, the daemon cannot restart itself after a
34086 SIGHUP signal because it cannot regain privilege.
34087
34088 It is still useful to set &%deliver_drop_privilege%& in this case, because it
34089 stops Exim from trying to re-invoke itself to do a delivery after a message has
34090 been received. Such a re-invocation is a waste of resources because it has no
34091 effect.
34092
34093 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
34094 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
34095 to the Exim user seems a clean approach, but there is one complication:
34096
34097 In this style of operation, Exim is running with the real uid and gid set to
34098 those of the calling process, and the effective uid/gid set to Exim's values.
34099 Ideally, any association with the calling process' uid/gid should be dropped,
34100 that is, the real uid/gid should be reset to the effective values so as to
34101 discard any privileges that the caller may have. While some operating systems
34102 have a function that permits this action for a non-root effective uid, quite a
34103 number of them do not. Because of this lack of standardization, Exim does not
34104 address this problem at this time.
34105
34106 For this reason, the recommended approach for &"mostly unprivileged"& running
34107 is to keep the Exim binary setuid to root, and to set
34108 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
34109 be used in the most straightforward way.
34110
34111 If you configure Exim not to run delivery processes as root, there are a
34112 number of restrictions on what you can do:
34113
34114 .ilist
34115 You can deliver only as the Exim user/group. You should  explicitly use the
34116 &%user%& and &%group%& options to override routers or local transports that
34117 normally deliver as the recipient. This makes sure that configurations that
34118 work in this mode function the same way in normal mode. Any implicit or
34119 explicit specification of another user causes an error.
34120 .next
34121 Use of &_.forward_& files is severely restricted, such that it is usually
34122 not worthwhile to include them in the configuration.
34123 .next
34124 Users who wish to use &_.forward_& would have to make their home directory and
34125 the file itself accessible to the Exim user. Pipe and append-to-file entries,
34126 and their equivalents in Exim filters, cannot be used. While they could be
34127 enabled in the Exim user's name, that would be insecure and not very useful.
34128 .next
34129 Unless the local user mailboxes are all owned by the Exim user (possible in
34130 some POP3 or IMAP-only environments):
34131
34132 .olist
34133 They must be owned by the Exim group and be writeable by that group. This
34134 implies you must set &%mode%& in the appendfile configuration, as well as the
34135 mode of the mailbox files themselves.
34136 .next
34137 You must set &%no_check_owner%&, since most or all of the files will not be
34138 owned by the Exim user.
34139 .next
34140 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
34141 on a newly created mailbox when unprivileged. This also implies that new
34142 mailboxes need to be created manually.
34143 .endlist olist
34144 .endlist ilist
34145
34146
34147 These restrictions severely restrict what can be done in local deliveries.
34148 However, there are no restrictions on remote deliveries. If you are running a
34149 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
34150 gives more security at essentially no cost.
34151
34152 If you are using the &%mua_wrapper%& facility (see chapter
34153 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
34154
34155
34156
34157
34158 .section "Delivering to local files" "SECID271"
34159 Full details of the checks applied by &(appendfile)& before it writes to a file
34160 are given in chapter &<<CHAPappendfile>>&.
34161
34162
34163
34164 .section "IPv4 source routing" "SECID272"
34165 .cindex "source routing" "in IP packets"
34166 .cindex "IP source routing"
34167 Many operating systems suppress IP source-routed packets in the kernel, but
34168 some cannot be made to do this, so Exim does its own check. It logs incoming
34169 IPv4 source-routed TCP calls, and then drops them. Things are all different in
34170 IPv6. No special checking is currently done.
34171
34172
34173
34174 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
34175 Support for these SMTP commands is disabled by default. If required, they can
34176 be enabled by defining suitable ACLs.
34177
34178
34179
34180
34181 .section "Privileged users" "SECID274"
34182 .cindex "trusted users"
34183 .cindex "admin user"
34184 .cindex "privileged user"
34185 .cindex "user" "trusted"
34186 .cindex "user" "admin"
34187 Exim recognizes two sets of users with special privileges. Trusted users are
34188 able to submit new messages to Exim locally, but supply their own sender
34189 addresses and information about a sending host. For other users submitting
34190 local messages, Exim sets up the sender address from the uid, and doesn't
34191 permit a remote host to be specified.
34192
34193 .oindex "&%-f%&"
34194 However, an untrusted user is permitted to use the &%-f%& command line option
34195 in the special form &%-f <>%& to indicate that a delivery failure for the
34196 message should not cause an error report. This affects the message's envelope,
34197 but it does not affect the &'Sender:'& header. Untrusted users may also be
34198 permitted to use specific forms of address with the &%-f%& option by setting
34199 the &%untrusted_set_sender%& option.
34200
34201 Trusted users are used to run processes that receive mail messages from some
34202 other mail domain and pass them on to Exim for delivery either locally, or over
34203 the Internet. Exim trusts a caller that is running as root, as the Exim user,
34204 as any user listed in the &%trusted_users%& configuration option, or under any
34205 group listed in the &%trusted_groups%& option.
34206
34207 Admin users are permitted to do things to the messages on Exim's queue. They
34208 can freeze or thaw messages, cause them to be returned to their senders, remove
34209 them entirely, or modify them in various ways. In addition, admin users can run
34210 the Exim monitor and see all the information it is capable of providing, which
34211 includes the contents of files on the spool.
34212
34213 .oindex "&%-M%&"
34214 .oindex "&%-q%&"
34215 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
34216 delivery of messages on its queue is restricted to admin users. This
34217 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
34218 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
34219 queue is also restricted to admin users. This restriction can be relaxed by
34220 setting &%no_queue_list_requires_admin%&.
34221
34222 Exim recognizes an admin user if the calling process is running as root or as
34223 the Exim user or if any of the groups associated with the calling process is
34224 the Exim group. It is not necessary actually to be running under the Exim
34225 group. However, if admin users who are not root or the Exim user are to access
34226 the contents of files on the spool via the Exim monitor (which runs
34227 unprivileged), Exim must be built to allow group read access to its spool
34228 files.
34229
34230
34231
34232 .section "Spool files" "SECID275"
34233 .cindex "spool directory" "files"
34234 Exim's spool directory and everything it contains is owned by the Exim user and
34235 set to the Exim group. The mode for spool files is defined in the
34236 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
34237 any user who is a member of the Exim group can access these files.
34238
34239
34240
34241 .section "Use of argv[0]" "SECID276"
34242 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
34243 of specific strings, Exim assumes certain options. For example, calling Exim
34244 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
34245 to calling it with the option &%-bS%&. There are no security implications in
34246 this.
34247
34248
34249
34250 .section "Use of %f formatting" "SECID277"
34251 The only use made of &"%f"& by Exim is in formatting load average values. These
34252 are actually stored in integer variables as 1000 times the load average.
34253 Consequently, their range is limited and so therefore is the length of the
34254 converted output.
34255
34256
34257
34258 .section "Embedded Exim path" "SECID278"
34259 Exim uses its own path name, which is embedded in the code, only when it needs
34260 to re-exec in order to regain root privilege. Therefore, it is not root when it
34261 does so. If some bug allowed the path to get overwritten, it would lead to an
34262 arbitrary program's being run as exim, not as root.
34263
34264
34265
34266 .new
34267 .section "Dynamic module directory" "SECTdynmoddir"
34268 Any dynamically loadable modules must be installed into the directory
34269 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
34270 loading it.
34271 .wen
34272
34273
34274 .section "Use of sprintf()" "SECID279"
34275 .cindex "&[sprintf()]&"
34276 A large number of occurrences of &"sprintf"& in the code are actually calls to
34277 &'string_sprintf()'&, a function that returns the result in malloc'd store.
34278 The intermediate formatting is done into a large fixed buffer by a function
34279 that runs through the format string itself, and checks the length of each
34280 conversion before performing it, thus preventing buffer overruns.
34281
34282 The remaining uses of &[sprintf()]& happen in controlled circumstances where
34283 the output buffer is known to be sufficiently long to contain the converted
34284 string.
34285
34286
34287
34288 .section "Use of debug_printf() and log_write()" "SECID280"
34289 Arbitrary strings are passed to both these functions, but they do their
34290 formatting by calling the function &'string_vformat()'&, which runs through
34291 the format string itself, and checks the length of each conversion.
34292
34293
34294
34295 .section "Use of strcat() and strcpy()" "SECID281"
34296 These are used only in cases where the output buffer is known to be large
34297 enough to hold the result.
34298 .ecindex IIDsecurcon
34299
34300
34301
34302
34303 . ////////////////////////////////////////////////////////////////////////////
34304 . ////////////////////////////////////////////////////////////////////////////
34305
34306 .chapter "Format of spool files" "CHAPspool"
34307 .scindex IIDforspo1 "format" "spool files"
34308 .scindex IIDforspo2 "spool directory" "format of files"
34309 .scindex IIDforspo3 "spool files" "format of"
34310 .cindex "spool files" "editing"
34311 A message on Exim's queue consists of two files, whose names are the message id
34312 followed by -D and -H, respectively. The data portion of the message is kept in
34313 the -D file on its own. The message's envelope, status, and headers are all
34314 kept in the -H file, whose format is described in this chapter. Each of these
34315 two files contains the final component of its own name as its first line. This
34316 is insurance against disk crashes where the directory is lost but the files
34317 themselves are recoverable.
34318
34319 Some people are tempted into editing -D files in order to modify messages. You
34320 need to be extremely careful if you do this; it is not recommended and you are
34321 on your own if you do it. Here are some of the pitfalls:
34322
34323 .ilist
34324 You must ensure that Exim does not try to deliver the message while you are
34325 fiddling with it. The safest way is to take out a write lock on the -D file,
34326 which is what Exim itself does, using &[fcntl()]&. If you update the file in
34327 place, the lock will be retained. If you write a new file and rename it, the
34328 lock will be lost at the instant of rename.
34329 .next
34330 .vindex "&$body_linecount$&"
34331 If you change the number of lines in the file, the value of
34332 &$body_linecount$&, which is stored in the -H file, will be incorrect. At
34333 present, this value is not used by Exim, but there is no guarantee that this
34334 will always be the case.
34335 .next
34336 If the message is in MIME format, you must take care not to break it.
34337 .next
34338 If the message is cryptographically signed, any change will invalidate the
34339 signature.
34340 .endlist
34341 All in all, modifying -D files is fraught with danger.
34342
34343 Files whose names end with -J may also be seen in the &_input_& directory (or
34344 its subdirectories when &%split_spool_directory%& is set). These are journal
34345 files, used to record addresses to which the message has been delivered during
34346 the course of a delivery attempt. If there are still undelivered recipients at
34347 the end, the -H file is updated, and the -J file is deleted. If, however, there
34348 is some kind of crash (for example, a power outage) before this happens, the -J
34349 file remains in existence. When Exim next processes the message, it notices the
34350 -J file and uses it to update the -H file before starting the next delivery
34351 attempt.
34352
34353 .section "Format of the -H file" "SECID282"
34354 .cindex "uid (user id)" "in spool file"
34355 .cindex "gid (group id)" "in spool file"
34356 The second line of the -H file contains the login name for the uid of the
34357 process that called Exim to read the message, followed by the numerical uid and
34358 gid. For a locally generated message, this is normally the user who sent the
34359 message. For a message received over TCP/IP via the daemon, it is
34360 normally the Exim user.
34361
34362 The third line of the file contains the address of the message's sender as
34363 transmitted in the envelope, contained in angle brackets. The sender address is
34364 empty for bounce messages. For incoming SMTP mail, the sender address is given
34365 in the MAIL command. For locally generated mail, the sender address is
34366 created by Exim from the login name of the current user and the configured
34367 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
34368 leading &"From&~"& line if the caller is trusted, or if the supplied address is
34369 &"<>"& or an address that matches &%untrusted_set_senders%&.
34370
34371 The fourth line contains two numbers. The first is the time that the message
34372 was received, in the conventional Unix form &-- the number of seconds since the
34373 start of the epoch. The second number is a count of the number of messages
34374 warning of delayed delivery that have been sent to the sender.
34375
34376 There follow a number of lines starting with a hyphen. These can appear in any
34377 order, and are omitted when not relevant:
34378
34379 .vlist
34380 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
34381 This item is obsolete, and is not generated from Exim release 4.61 onwards;
34382 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
34383 recognized, to provide backward compatibility. In the old format, a line of
34384 this form is present for every ACL variable that is not empty. The number
34385 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
34386 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
34387 the data string for the variable. The string itself starts at the beginning of
34388 the next line, and is followed by a newline character. It may contain internal
34389 newlines.
34390
34391 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
34392 A line of this form is present for every ACL connection variable that is
34393 defined. Note that there is a space between &%-aclc%& and the rest of the name.
34394 The length is the length of the data string for the variable. The string itself
34395 starts at the beginning of the next line, and is followed by a newline
34396 character. It may contain internal newlines.
34397
34398 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
34399 A line of this form is present for every ACL message variable that is defined.
34400 Note that there is a space between &%-aclm%& and the rest of the name. The
34401 length is the length of the data string for the variable. The string itself
34402 starts at the beginning of the next line, and is followed by a newline
34403 character. It may contain internal newlines.
34404
34405 .vitem "&%-active_hostname%&&~<&'hostname'&>"
34406 This is present if, when the message was received over SMTP, the value of
34407 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
34408
34409 .vitem &%-allow_unqualified_recipient%&
34410 This is present if unqualified recipient addresses are permitted in header
34411 lines (to stop such addresses from being qualified if rewriting occurs at
34412 transport time). Local messages that were input using &%-bnq%& and remote
34413 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
34414
34415 .vitem &%-allow_unqualified_sender%&
34416 This is present if unqualified sender addresses are permitted in header lines
34417 (to stop such addresses from being qualified if rewriting occurs at transport
34418 time). Local messages that were input using &%-bnq%& and remote messages from
34419 hosts that match &%sender_unqualified_hosts%& set this flag.
34420
34421 .vitem "&%-auth_id%&&~<&'text'&>"
34422 The id information for a message received on an authenticated SMTP connection
34423 &-- the value of the &$authenticated_id$& variable.
34424
34425 .vitem "&%-auth_sender%&&~<&'address'&>"
34426 The address of an authenticated sender &-- the value of the
34427 &$authenticated_sender$& variable.
34428
34429 .vitem "&%-body_linecount%&&~<&'number'&>"
34430 This records the number of lines in the body of the message, and is always
34431 present.
34432
34433 .vitem "&%-body_zerocount%&&~<&'number'&>"
34434 This records the number of binary zero bytes in the body of the message, and is
34435 present if the number is greater than zero.
34436
34437 .vitem &%-deliver_firsttime%&
34438 This is written when a new message is first added to the spool. When the spool
34439 file is updated after a deferral, it is omitted.
34440
34441 .vitem "&%-frozen%&&~<&'time'&>"
34442 .cindex "frozen messages" "spool data"
34443 The message is frozen, and the freezing happened at <&'time'&>.
34444
34445 .vitem "&%-helo_name%&&~<&'text'&>"
34446 This records the host name as specified by a remote host in a HELO or EHLO
34447 command.
34448
34449 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
34450 This records the IP address of the host from which the message was received and
34451 the remote port number that was used. It is omitted for locally generated
34452 messages.
34453
34454 .vitem "&%-host_auth%&&~<&'text'&>"
34455 If the message was received on an authenticated SMTP connection, this records
34456 the name of the authenticator &-- the value of the
34457 &$sender_host_authenticated$& variable.
34458
34459 .vitem &%-host_lookup_failed%&
34460 This is present if an attempt to look up the sending host's name from its IP
34461 address failed. It corresponds to the &$host_lookup_failed$& variable.
34462
34463 .vitem "&%-host_name%&&~<&'text'&>"
34464 .cindex "reverse DNS lookup"
34465 .cindex "DNS" "reverse lookup"
34466 This records the name of the remote host from which the message was received,
34467 if the host name was looked up from the IP address when the message was being
34468 received. It is not present if no reverse lookup was done.
34469
34470 .vitem "&%-ident%&&~<&'text'&>"
34471 For locally submitted messages, this records the login of the originating user,
34472 unless it was a trusted user and the &%-oMt%& option was used to specify an
34473 ident value. For messages received over TCP/IP, this records the ident string
34474 supplied by the remote host, if any.
34475
34476 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
34477 This records the IP address of the local interface and the port number through
34478 which a message was received from a remote host. It is omitted for locally
34479 generated messages.
34480
34481 .vitem &%-local%&
34482 The message is from a local sender.
34483
34484 .vitem &%-localerror%&
34485 The message is a locally-generated bounce message.
34486
34487 .vitem "&%-local_scan%&&~<&'string'&>"
34488 This records the data string that was returned by the &[local_scan()]& function
34489 when the message was received &-- the value of the &$local_scan_data$&
34490 variable. It is omitted if no data was returned.
34491
34492 .vitem &%-manual_thaw%&
34493 The message was frozen but has been thawed manually, that is, by an explicit
34494 Exim command rather than via the auto-thaw process.
34495
34496 .vitem &%-N%&
34497 A testing delivery process was started using the &%-N%& option to suppress any
34498 actual deliveries, but delivery was deferred. At any further delivery attempts,
34499 &%-N%& is assumed.
34500
34501 .vitem &%-received_protocol%&
34502 This records the value of the &$received_protocol$& variable, which contains
34503 the name of the protocol by which the message was received.
34504
34505 .vitem &%-sender_set_untrusted%&
34506 The envelope sender of this message was set by an untrusted local caller (used
34507 to ensure that the caller is displayed in queue listings).
34508
34509 .vitem "&%-spam_score_int%&&~<&'number'&>"
34510 If a message was scanned by SpamAssassin, this is present. It records the value
34511 of &$spam_score_int$&.
34512
34513 .vitem &%-tls_certificate_verified%&
34514 A TLS certificate was received from the client that sent this message, and the
34515 certificate was verified by the server.
34516
34517 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
34518 When the message was received over an encrypted connection, this records the
34519 name of the cipher suite that was used.
34520
34521 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
34522 When the message was received over an encrypted connection, and a certificate
34523 was received from the client, this records the Distinguished Name from that
34524 certificate.
34525 .endlist
34526
34527 Following the options there is a list of those addresses to which the message
34528 is not to be delivered. This set of addresses is initialized from the command
34529 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
34530 is set; otherwise it starts out empty. Whenever a successful delivery is made,
34531 the address is added to this set. The addresses are kept internally as a
34532 balanced binary tree, and it is a representation of that tree which is written
34533 to the spool file. If an address is expanded via an alias or forward file, the
34534 original address is added to the tree when deliveries to all its child
34535 addresses are complete.
34536
34537 If the tree is empty, there is a single line in the spool file containing just
34538 the text &"XX"&. Otherwise, each line consists of two letters, which are either
34539 Y or N, followed by an address. The address is the value for the node of the
34540 tree, and the letters indicate whether the node has a left branch and/or a
34541 right branch attached to it, respectively. If branches exist, they immediately
34542 follow. Here is an example of a three-node tree:
34543 .code
34544 YY darcy@austen.fict.example
34545 NN alice@wonderland.fict.example
34546 NN editor@thesaurus.ref.example
34547 .endd
34548 After the non-recipients tree, there is a list of the message's recipients.
34549 This is a simple list, preceded by a count. It includes all the original
34550 recipients of the message, including those to whom the message has already been
34551 delivered. In the simplest case, the list contains one address per line. For
34552 example:
34553 .code
34554 4
34555 editor@thesaurus.ref.example
34556 darcy@austen.fict.example
34557 rdo@foundation
34558 alice@wonderland.fict.example
34559 .endd
34560 However, when a child address has been added to the top-level addresses as a
34561 result of the use of the &%one_time%& option on a &(redirect)& router, each
34562 line is of the following form:
34563 .display
34564 <&'top-level address'&> <&'errors_to address'&> &&&
34565   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
34566 .endd
34567 The 01 flag bit indicates the presence of the three other fields that follow
34568 the top-level address. Other bits may be used in future to support additional
34569 fields. The <&'parent number'&> is the offset in the recipients list of the
34570 original parent of the &"one time"& address. The first two fields are the
34571 envelope sender that is associated with this address and its length. If the
34572 length is zero, there is no special envelope sender (there are then two space
34573 characters in the line). A non-empty field can arise from a &(redirect)& router
34574 that has an &%errors_to%& setting.
34575
34576
34577 A blank line separates the envelope and status information from the headers
34578 which follow. A header may occupy several lines of the file, and to save effort
34579 when reading it in, each header is preceded by a number and an identifying
34580 character. The number is the number of characters in the header, including any
34581 embedded newlines and the terminating newline. The character is one of the
34582 following:
34583
34584 .table2 50pt
34585 .row <&'blank'&>         "header in which Exim has no special interest"
34586 .row &`B`&               "&'Bcc:'& header"
34587 .row &`C`&               "&'Cc:'& header"
34588 .row &`F`&               "&'From:'& header"
34589 .row &`I`&               "&'Message-id:'& header"
34590 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
34591 .row &`R`&               "&'Reply-To:'& header"
34592 .row &`S`&               "&'Sender:'& header"
34593 .row &`T`&               "&'To:'& header"
34594 .row &`*`&               "replaced or deleted header"
34595 .endtable
34596
34597 Deleted or replaced (rewritten) headers remain in the spool file for debugging
34598 purposes. They are not transmitted when the message is delivered. Here is a
34599 typical set of headers:
34600 .code
34601 111P Received: by hobbit.fict.example with local (Exim 4.00)
34602 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
34603 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
34604 038* X-rewrote-sender: bb@hobbit.fict.example
34605 042* From: Bilbo Baggins <bb@hobbit.fict.example>
34606 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
34607 099* To: alice@wonderland.fict.example, rdo@foundation,
34608 darcy@austen.fict.example, editor@thesaurus.ref.example
34609 104T To: alice@wonderland.fict.example, rdo@foundation.example,
34610 darcy@austen.fict.example, editor@thesaurus.ref.example
34611 038  Date: Fri, 11 May 2001 10:28:59 +0100
34612 .endd
34613 The asterisked headers indicate that the envelope sender, &'From:'& header, and
34614 &'To:'& header have been rewritten, the last one because routing expanded the
34615 unqualified domain &'foundation'&.
34616 .ecindex IIDforspo1
34617 .ecindex IIDforspo2
34618 .ecindex IIDforspo3
34619
34620 . ////////////////////////////////////////////////////////////////////////////
34621 . ////////////////////////////////////////////////////////////////////////////
34622
34623 .chapter "Support for DKIM (DomainKeys Identified Mail) - RFC4871" "CHID12" &&&
34624          "DKIM Support"
34625 .cindex "DKIM"
34626
34627 Since version 4.70, DKIM support is compiled into Exim by default. It can be
34628 disabled by setting DISABLE_DKIM=yes in Local/Makefile.
34629
34630 .new
34631 Exim's DKIM implementation allows to
34632 .olist
34633 Sign outgoing messages: This function is implemented in the SMTP transport.
34634 It can co-exist with all other Exim features, including transport filters.
34635 .next
34636 Verify signatures in incoming messages: This is implemented by an additional
34637 ACL (acl_smtp_dkim), which can be called several times per message, with
34638 different signature contexts.
34639 .endlist
34640 .wen
34641 In typical Exim style, the verification implementation does not include any
34642 default "policy". Instead it enables you to build your own policy using
34643 Exim's standard controls.
34644
34645 Please note that verification of DKIM signatures in incoming mail is turned
34646 on by default for logging purposes. For each signature in incoming email,
34647 exim will log a line displaying the most important signature details, and the
34648 signature status. Here is an example:
34649 .code
34650 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]
34651 .endd
34652 You might want to turn off DKIM verification processing entirely for internal
34653 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
34654 control modifier. This should typically be done in the RCPT ACL, at points
34655 where you accept mail from relay sources (internal hosts or authenticated
34656 senders).
34657
34658
34659 .section "Signing outgoing messages" "SECID513"
34660 .cindex "DKIM" "signing"
34661
34662 Signing is implemented by setting private options on the SMTP transport.
34663 These options take (expandable) strings as arguments.
34664
34665 .new
34666 .option dkim_domain smtp string&!! unset
34667 MANDATORY:
34668 The domain you want to sign with. The result of this expanded
34669 option is put into the &%$dkim_domain%& expansion variable.
34670
34671 .option dkim_selector smtp string&!! unset
34672 MANDATORY:
34673 This sets the key selector string. You can use the &%$dkim_domain%& expansion
34674 variable to look up a matching selector. The result is put in the expansion
34675 variable &%$dkim_selector%& which should be used in the &%dkim_private_key%&
34676 option along with &%$dkim_domain%&.
34677
34678 .option dkim_private_key smtp string&!! unset
34679 MANDATORY:
34680 This sets the private key to use. You can use the &%$dkim_domain%& and
34681 &%$dkim_selector%& expansion variables to determine the private key to use.
34682 The result can either
34683 .ilist
34684 be a valid RSA private key in ASCII armor, including line breaks.
34685 .next
34686 start with a slash, in which case it is treated as a file that contains
34687 the private key.
34688 .next
34689 be "0", "false" or the empty string, in which case the message will not
34690 be signed. This case will not result in an error, even if &%dkim_strict%&
34691 is set.
34692 .endlist
34693
34694 .option dkim_canon smtp string&!! unset
34695 OPTIONAL:
34696 This option sets the canonicalization method used when signing a message.
34697 The DKIM RFC currently supports two methods: "simple" and "relaxed".
34698 The option defaults to "relaxed" when unset. Note: the current implementation
34699 only supports using the same canonicalization method for both headers and body.
34700
34701 .option dkim_strict smtp string&!! unset
34702 OPTIONAL:
34703 This  option  defines  how  Exim  behaves  when  signing a message that
34704 should be signed fails for some reason.  When the expansion evaluates to
34705 either "1" or "true", Exim will defer. Otherwise Exim will send the message
34706 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
34707 variables here.
34708
34709 .option dkim_sign_headers smtp string&!! unset
34710 OPTIONAL:
34711 When set, this option must expand to (or be specified as) a colon-separated
34712 list of header names. Headers with these names will be included in the message
34713 signature. When unspecified, the header names recommended in RFC4871 will be
34714 used.
34715 .wen
34716
34717 .section "Verifying DKIM signatures in incoming mail" "SECID514"
34718 .cindex "DKIM" "verification"
34719
34720 Verification of DKIM signatures in incoming email is implemented via the
34721 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
34722 syntactically(!) correct signature in the incoming message.
34723
34724 To evaluate the signature in the ACL a large number of expansion variables
34725 containing the signature status and its details are set up during the
34726 runtime of the ACL.
34727
34728 Calling the ACL only for existing signatures is not sufficient to build
34729 more advanced policies. For that reason, the global option
34730 &%dkim_verify_signers%&, and a global expansion variable
34731 &%$dkim_signers%& exist.
34732
34733 .new
34734 The global option &%dkim_verify_signers%& can be set to a colon-separated
34735 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
34736 called. It is expanded when the message has been received. At this point,
34737 the expansion variable &%$dkim_signers%& already contains a colon-separated
34738 list of signer domains and identities for the message. When
34739 &%dkim_verify_signers%& is not specified in the main configuration,
34740 it defaults as:
34741 .code
34742 dkim_verify_signers = $dkim_signers
34743 .endd
34744 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
34745 DKIM signature in the message. Current DKIM verifiers may want to explicitly
34746 call the ACL for known domains or identities. This would be achieved as follows:
34747 .code
34748 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
34749 .endd
34750 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
34751 and "ebay.com", plus all domains and identities that have signatures in the message.
34752 You can also be more creative in constructing your policy. For example:
34753 .code
34754 dkim_verify_signers = $sender_address_domain:$dkim_signers
34755 .endd
34756 .wen
34757 If a domain or identity is listed several times in the (expanded) value of
34758 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
34759
34760
34761 Inside the &%acl_smtp_dkim%&, the following expansion variables are
34762 available (from most to least important):
34763
34764 .new
34765 .vlist
34766 .vitem &%$dkim_cur_signer%&
34767 The signer that is being evaluated in this ACL run. This can be a domain or
34768 an identity. This is one of the list items from the expanded main option
34769 &%dkim_verify_signers%& (see above).
34770 .vitem &%$dkim_verify_status%&
34771 A string describing the general status of the signature. One of
34772 .ilist
34773 &%none%&: There is no signature in the message for the current domain or
34774 identity (as reflected by &%$dkim_cur_signer%&).
34775 .next
34776 &%invalid%&: The signature could not be verified due to a processing error.
34777 More detail is available in &%$dkim_verify_reason%&.
34778 .next
34779 &%fail%&: Verification of the signature failed.  More detail is
34780 available in &%$dkim_verify_reason%&.
34781 .next
34782 &%pass%&: The signature passed verification. It is valid.
34783 .endlist
34784 .vitem &%$dkim_verify_reason%&
34785 A string giving a litte bit more detail when &%$dkim_verify_status%& is either
34786 "fail" or "invalid". One of
34787 .ilist
34788 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
34789 key for the domain could not be retrieved. This may be a temporary problem.
34790 .next
34791 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
34792 record for the domain is syntactically invalid.
34793 .next
34794 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
34795 body hash does not match the one specified in the signature header. This
34796 means that the message body was modified in transit.
34797 .next
34798 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
34799 could not be verified. This may mean that headers were modified,
34800 re-written or otherwise changed in a way which is incompatible with
34801 DKIM verification. It may of course also mean that the signature is forged.
34802 .endlist
34803 .vitem &%$dkim_domain%&
34804 The signing domain. IMPORTANT: This variable is only populated if there is
34805 an actual signature in the message for the current domain or identity (as
34806 reflected by &%$dkim_cur_signer%&).
34807 .vitem &%$dkim_identity%&
34808 The signing identity, if present. IMPORTANT: This variable is only populated
34809 if there is an actual signature in the message for the current domain or
34810 identity (as reflected by &%$dkim_cur_signer%&).
34811 .vitem &%$dkim_selector%&
34812 The key record selector string.
34813 .vitem &%$dkim_algo%&
34814 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
34815 .vitem &%$dkim_canon_body%&
34816 The body canonicalization method. One of 'relaxed' or 'simple'.
34817 .vitem &%dkim_canon_headers%&
34818 The header canonicalization method. One of 'relaxed' or 'simple'.
34819 .vitem &%$dkim_copiedheaders%&
34820 A transcript of headers and their values which are included in the signature
34821 (copied from the 'z=' tag of the signature).
34822 .vitem &%$dkim_bodylength%&
34823 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
34824 limit was set by the signer, "9999999999999" is returned. This makes sure
34825 that this variable always expands to an integer value.
34826 .vitem &%$dkim_created%&
34827 UNIX timestamp reflecting the date and time when the signature was created.
34828 When this was not specified by the signer, "0" is returned.
34829 .vitem &%$dkim_expires%&
34830 UNIX timestamp reflecting the date and time when the signer wants the
34831 signature to be treated as "expired". When this was not specified by the
34832 signer, "9999999999999" is returned. This makes it possible to do useful
34833 integer size comparisons against this value.
34834 .vitem &%$dkim_headernames%&
34835 A colon-separated list of names of headers included in the signature.
34836 .vitem &%$dkim_key_testing%&
34837 "1" if the key record has the "testing" flag set, "0" if not.
34838 .vitem &%$dkim_key_nosubdomaining%&
34839 "1" if the key record forbids subdomaining, "0" otherwise.
34840 .vitem &%$dkim_key_srvtype%&
34841 Service type (tag s=) from the key record. Defaults to "*" if not specified
34842 in the key record.
34843 .vitem &%$dkim_key_granularity%&
34844 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
34845 in the key record.
34846 .vitem &%$dkim_key_notes%&
34847 Notes from the key record (tag n=).
34848 .endlist
34849 .wen
34850 In addition, two ACL conditions are provided:
34851
34852 .new
34853 .vlist
34854 .vitem &%dkim_signers%&
34855 ACL condition that checks a colon-separated list of domains or identities
34856 for a match against the domain or identity that the ACL is currently verifying
34857 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
34858 verb to a group of domains or identities. For example:
34859 .wen
34860 .code
34861 # Warn when message apparently from GMail has no signature at all
34862 warn log_message = GMail sender without DKIM signature
34863      sender_domains = gmail.com
34864      dkim_signers = gmail.com
34865      dkim_status = none
34866 .endd
34867
34868 .vitem &%dkim_status%&
34869 ACL condition that checks a colon-separated list of possible DKIM verification
34870 results agains the actual result of verification. This is typically used
34871 to restrict an ACL verb to a list of verification outcomes, like:
34872
34873 .code
34874 deny message = Message from Paypal with invalid or missing signature
34875      sender_domains = paypal.com:paypal.de
34876      dkim_signers = paypal.com:paypal.de
34877      dkim_status = none:invalid:fail
34878 .endd
34879
34880 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
34881 see the documentation of the &%$dkim_verify_status%& expansion variable above
34882 for more information of what they mean.
34883 .endlist
34884
34885 . ////////////////////////////////////////////////////////////////////////////
34886 . ////////////////////////////////////////////////////////////////////////////
34887
34888 .chapter "Adding new drivers or lookup types" "CHID13" &&&
34889          "Adding drivers or lookups"
34890 .cindex "adding drivers"
34891 .cindex "new drivers, adding"
34892 .cindex "drivers" "adding new"
34893 The following actions have to be taken in order to add a new router, transport,
34894 authenticator, or lookup type to Exim:
34895
34896 .olist
34897 Choose a name for the driver or lookup type that does not conflict with any
34898 existing name; I will use &"newdriver"& in what follows.
34899 .next
34900 Add to &_src/EDITME_& the line:
34901 .display
34902 <&'type'&>&`_NEWDRIVER=yes`&
34903 .endd
34904 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
34905 code is not to be included in the binary by default, comment this line out. You
34906 should also add any relevant comments about the driver or lookup type.
34907 .next
34908 Add to &_src/config.h.defaults_& the line:
34909 .code
34910 #define <type>_NEWDRIVER
34911 .endd
34912 .next
34913 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
34914 and create a table entry as is done for all the other drivers and lookup types.
34915 .next
34916 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
34917 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
34918 driver or lookup type and add it to the definition of OBJ.
34919 .next
34920 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
34921 &_src_&.
34922 .next
34923 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
34924 as for other drivers and lookups.
34925 .endlist
34926
34927 Then all you need to do is write the code! A good way to start is to make a
34928 proforma by copying an existing module of the same type, globally changing all
34929 occurrences of the name, and cutting out most of the code. Note that any
34930 options you create must be listed in alphabetical order, because the tables are
34931 searched using a binary chop procedure.
34932
34933 There is a &_README_& file in each of the sub-directories of &_src_& describing
34934 the interface that is expected.
34935
34936
34937
34938
34939 . ////////////////////////////////////////////////////////////////////////////
34940 . ////////////////////////////////////////////////////////////////////////////
34941
34942 . /////////////////////////////////////////////////////////////////////////////
34943 . These lines are processing instructions for the Simple DocBook Processor that
34944 . Philip Hazel has developed as a less cumbersome way of making PostScript and
34945 . PDFs than using xmlto and fop. They will be ignored by all other XML
34946 . processors.
34947 . /////////////////////////////////////////////////////////////////////////////
34948
34949 .literal xml
34950 <?sdop
34951   format="newpage"
34952   foot_right_recto="&chaptertitle;"
34953   foot_right_verso="&chaptertitle;"
34954 ?>
34955 .literal off
34956
34957 .makeindex "Options index"   "option"
34958 .makeindex "Variables index" "variable"
34959 .makeindex "Concept index"   "concept"
34960
34961
34962 . /////////////////////////////////////////////////////////////////////////////
34963 . /////////////////////////////////////////////////////////////////////////////