bd658e55e46550d7d6bf4686cf432faf99d2cd6c
[users/heiko/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.73"
52
53 .set ACL "access control lists (ACLs)"
54 .set I   "&nbsp;&nbsp;&nbsp;&nbsp;"
55
56
57 . /////////////////////////////////////////////////////////////////////////////
58 . Additional xfpt markup used by this document, over and above the default
59 . provided in the xfpt library.
60 . /////////////////////////////////////////////////////////////////////////////
61
62 . --- Override the &$ flag to automatically insert a $ with the variable name
63
64 .flag &$  $&   "<varname>$"  "</varname>"
65
66 . --- Short flags for daggers in option headings. They will always be inside
67 . --- an italic string, but we want the daggers to be roman.
68
69 .flag &!!      "</emphasis>&dagger;<emphasis>"
70 .flag &!?      "</emphasis>&Dagger;<emphasis>"
71
72 . --- A macro for an Exim option definition heading, generating a one-line
73 . --- table with four columns. For cases when the option name is given with
74 . --- a space, so that it can be split, a fifth argument is used for the
75 . --- index entry.
76
77 .macro option
78 .arg 5
79 .oindex "&%$5%&"
80 .endarg
81 .arg -5
82 .oindex "&%$1%&"
83 .endarg
84 .itable all 0 0 4 8* left 6* center 6* center 6* right
85 .row "&%$1%&" "Use: &'$2'&" "Type: &'$3'&" "Default: &'$4'&"
86 .endtable
87 .endmacro
88
89 . --- A macro for the common 2-column tables. The width of the first column
90 . --- is suitable for the many tables at the start of the main options chapter;
91 . --- the small number of other 2-column tables override it.
92
93 .macro table2 196pt 254pt
94 .itable none 0 0 2 $1 left $2 left
95 .endmacro
96
97 . --- A macro that generates .row, but puts &I; at the start of the first
98 . --- argument, thus indenting it. Assume a minimum of two arguments, and
99 . --- allow up to four arguments, which is as many as we'll ever need.
100
101 .macro irow
102 .arg 4
103 .row "&I;$1" "$2" "$3" "$4"
104 .endarg
105 .arg -4
106 .arg 3
107 .row "&I;$1" "$2" "$3"
108 .endarg
109 .arg -3
110 .row "&I;$1" "$2"
111 .endarg
112 .endarg
113 .endmacro
114
115 . --- Macros for option, variable, and concept index entries. For a "range"
116 . --- style of entry, use .scindex for the start and .ecindex for the end. The
117 . --- first argument of .scindex and the only argument of .ecindex must be the
118 . --- ID that ties them together.
119
120 .macro cindex
121 &<indexterm role="concept">&
122 &<primary>&$1&</primary>&
123 .arg 2
124 &<secondary>&$2&</secondary>&
125 .endarg
126 &</indexterm>&
127 .endmacro
128
129 .macro scindex
130 &<indexterm role="concept" id="$1" class="startofrange">&
131 &<primary>&$2&</primary>&
132 .arg 3
133 &<secondary>&$3&</secondary>&
134 .endarg
135 &</indexterm>&
136 .endmacro
137
138 .macro ecindex
139 &<indexterm role="concept" startref="$1" class="endofrange"/>&
140 .endmacro
141
142 .macro oindex
143 &<indexterm role="option">&
144 &<primary>&$1&</primary>&
145 .arg 2
146 &<secondary>&$2&</secondary>&
147 .endarg
148 &</indexterm>&
149 .endmacro
150
151 .macro vindex
152 &<indexterm role="variable">&
153 &<primary>&$1&</primary>&
154 .arg 2
155 &<secondary>&$2&</secondary>&
156 .endarg
157 &</indexterm>&
158 .endmacro
159
160 .macro index
161 .echo "** Don't use .index; use .cindex or .oindex or .vindex"
162 .endmacro
163 . ////////////////////////////////////////////////////////////////////////////
164
165
166 . ////////////////////////////////////////////////////////////////////////////
167 . The <bookinfo> element is removed from the XML before processing for Ascii
168 . output formats.
169 . ////////////////////////////////////////////////////////////////////////////
170
171 .literal xml
172 <bookinfo>
173 <title>Specification of the Exim Mail Transfer Agent</title>
174 <titleabbrev>The Exim MTA</titleabbrev>
175 <date>29 May 2010</date>
176 <author><firstname>Exim</firstname><surname>Maintainers</surname></author>
177 <authorinitials>EM</authorinitials>
178 <revhistory><revision>
179   <revnumber>4.73</revnumber>
180   <date>19 Nov 2010</date>
181   <authorinitials>EM</authorinitials>
182 </revision></revhistory>
183 <copyright><year>2009</year><holder>University of Cambridge</holder></copyright>
184 </bookinfo>
185 .literal off
186
187
188 . /////////////////////////////////////////////////////////////////////////////
189 . This chunk of literal XML implements index entries of the form "x, see y" and
190 . "x, see also y". However, the DocBook DTD doesn't allow <indexterm> entries
191 . at the top level, so we have to put the .chapter directive first.
192 . /////////////////////////////////////////////////////////////////////////////
193
194 .chapter "Introduction" "CHID1"
195 .literal xml
196
197 <indexterm role="variable">
198   <primary>$1, $2, etc.</primary>
199   <see><emphasis>numerical variables</emphasis></see>
200 </indexterm>
201 <indexterm role="concept">
202   <primary>address</primary>
203   <secondary>rewriting</secondary>
204   <see><emphasis>rewriting</emphasis></see>
205 </indexterm>
206 <indexterm role="concept">
207   <primary>Bounce Address Tag Validation</primary>
208   <see><emphasis>BATV</emphasis></see>
209 </indexterm>
210 <indexterm role="concept">
211   <primary>Client SMTP Authorization</primary>
212   <see><emphasis>CSA</emphasis></see>
213 </indexterm>
214 <indexterm role="concept">
215   <primary>CR character</primary>
216   <see><emphasis>carriage return</emphasis></see>
217 </indexterm>
218 <indexterm role="concept">
219   <primary>CRL</primary>
220   <see><emphasis>certificate revocation list</emphasis></see>
221 </indexterm>
222 <indexterm role="concept">
223   <primary>delivery</primary>
224   <secondary>failure report</secondary>
225   <see><emphasis>bounce message</emphasis></see>
226 </indexterm>
227 <indexterm role="concept">
228   <primary>dialup</primary>
229   <see><emphasis>intermittently connected hosts</emphasis></see>
230 </indexterm>
231 <indexterm role="concept">
232   <primary>exiscan</primary>
233   <see><emphasis>content scanning</emphasis></see>
234 </indexterm>
235 <indexterm role="concept">
236   <primary>failover</primary>
237   <see><emphasis>fallback</emphasis></see>
238 </indexterm>
239 <indexterm role="concept">
240   <primary>fallover</primary>
241   <see><emphasis>fallback</emphasis></see>
242 </indexterm>
243 <indexterm role="concept">
244   <primary>filter</primary>
245   <secondary>Sieve</secondary>
246   <see><emphasis>Sieve filter</emphasis></see>
247 </indexterm>
248 <indexterm role="concept">
249   <primary>ident</primary>
250   <see><emphasis>RFC 1413</emphasis></see>
251 </indexterm>
252 <indexterm role="concept">
253   <primary>LF character</primary>
254   <see><emphasis>linefeed</emphasis></see>
255 </indexterm>
256 <indexterm role="concept">
257   <primary>maximum</primary>
258   <seealso><emphasis>limit</emphasis></seealso>
259 </indexterm>
260 <indexterm role="concept">
261   <primary>monitor</primary>
262   <see><emphasis>Exim monitor</emphasis></see>
263 </indexterm>
264 <indexterm role="concept">
265   <primary>no_<emphasis>xxx</emphasis></primary>
266   <see>entry for xxx</see>
267 </indexterm>
268 <indexterm role="concept">
269   <primary>NUL</primary>
270   <see><emphasis>binary zero</emphasis></see>
271 </indexterm>
272 <indexterm role="concept">
273   <primary>passwd file</primary>
274   <see><emphasis>/etc/passwd</emphasis></see>
275 </indexterm>
276 <indexterm role="concept">
277   <primary>process id</primary>
278   <see><emphasis>pid</emphasis></see>
279 </indexterm>
280 <indexterm role="concept">
281   <primary>RBL</primary>
282   <see><emphasis>DNS list</emphasis></see>
283 </indexterm>
284 <indexterm role="concept">
285   <primary>redirection</primary>
286   <see><emphasis>address redirection</emphasis></see>
287 </indexterm>
288 <indexterm role="concept">
289   <primary>return path</primary>
290   <seealso><emphasis>envelope sender</emphasis></seealso>
291 </indexterm>
292 <indexterm role="concept">
293   <primary>scanning</primary>
294   <see><emphasis>content scanning</emphasis></see>
295 </indexterm>
296 <indexterm role="concept">
297   <primary>SSL</primary>
298   <see><emphasis>TLS</emphasis></see>
299 </indexterm>
300 <indexterm role="concept">
301   <primary>string</primary>
302   <secondary>expansion</secondary>
303   <see><emphasis>expansion</emphasis></see>
304 </indexterm>
305 <indexterm role="concept">
306   <primary>top bit</primary>
307   <see><emphasis>8-bit characters</emphasis></see>
308 </indexterm>
309 <indexterm role="concept">
310   <primary>variables</primary>
311   <see><emphasis>expansion, variables</emphasis></see>
312 </indexterm>
313 <indexterm role="concept">
314   <primary>zero, binary</primary>
315   <see><emphasis>binary zero</emphasis></see>
316 </indexterm>
317
318 .literal off
319
320
321 . /////////////////////////////////////////////////////////////////////////////
322 . This is the real start of the first chapter. See the comment above as to why
323 . we can't have the .chapter line here.
324 . chapter "Introduction"
325 . /////////////////////////////////////////////////////////////////////////////
326
327 Exim is a mail transfer agent (MTA) for hosts that are running Unix or
328 Unix-like operating systems. It was designed on the assumption that it would be
329 run on hosts that are permanently connected to the Internet. However, it can be
330 used on intermittently connected hosts with suitable configuration adjustments.
331
332 Configuration files currently exist for the following operating systems: AIX,
333 BSD/OS (aka BSDI), Darwin (Mac OS X), DGUX, Dragonfly, FreeBSD, GNU/Hurd,
334 GNU/Linux, HI-OSF (Hitachi), HI-UX, HP-UX, IRIX, MIPS RISCOS, NetBSD, OpenBSD,
335 OpenUNIX, QNX, SCO, SCO SVR4.2 (aka UNIX-SV), Solaris (aka SunOS5), SunOS4,
336 Tru64-Unix (formerly Digital UNIX, formerly DEC-OSF1), Ultrix, and Unixware.
337 Some of these operating systems are no longer current and cannot easily be
338 tested, so the configuration files may no longer work in practice.
339
340 There are also configuration files for compiling Exim in the Cygwin environment
341 that can be installed on systems running Windows. However, this document does
342 not contain any information about running Exim in the Cygwin environment.
343
344 The terms and conditions for the use and distribution of Exim are contained in
345 the file &_NOTICE_&. Exim is distributed under the terms of the GNU General
346 Public Licence, a copy of which may be found in the file &_LICENCE_&.
347
348 The use, supply or promotion of Exim for the purpose of sending bulk,
349 unsolicited electronic mail is incompatible with the basic aims of the program,
350 which revolve around the free provision of a service that enhances the quality
351 of personal communications. The author of Exim regards indiscriminate
352 mass-mailing as an antisocial, irresponsible abuse of the Internet.
353
354 Exim owes a great deal to Smail 3 and its author, Ron Karr. Without the
355 experience of running and working on the Smail 3 code, I could never have
356 contemplated starting to write a new MTA. Many of the ideas and user interfaces
357 were originally taken from Smail 3, though the actual code of Exim is entirely
358 new, and has developed far beyond the initial concept.
359
360 Many people, both in Cambridge and around the world, have contributed to the
361 development and the testing of Exim, and to porting it to various operating
362 systems. I am grateful to them all. The distribution now contains a file called
363 &_ACKNOWLEDGMENTS_&, in which I have started recording the names of
364 contributors.
365
366
367 .section "Exim documentation" "SECID1"
368 . Keep this example change bar when updating the documentation!
369 .new
370 .cindex "documentation"
371 This edition of the Exim specification applies to version &version; of Exim.
372 Substantive changes from the &previousversion; edition are marked in some
373 renditions of the document; this paragraph is so marked if the rendition is
374 capable of showing a change indicator.
375 .wen
376
377 This document is very much a reference manual; it is not a tutorial. The reader
378 is expected to have some familiarity with the SMTP mail transfer protocol and
379 with general Unix system administration. Although there are some discussions
380 and examples in places, the information is mostly organized in a way that makes
381 it easy to look up, rather than in a natural order for sequential reading.
382 Furthermore, the manual aims to cover every aspect of Exim in detail, including
383 a number of rarely-used, special-purpose features that are unlikely to be of
384 very wide interest.
385
386 .cindex "books about Exim"
387 An &"easier"& discussion of Exim which provides more in-depth explanatory,
388 introductory, and tutorial material can be found in a book entitled &'The Exim
389 SMTP Mail Server'& (second edition, 2007), published by UIT Cambridge
390 (&url(http://www.uit.co.uk/exim-book/)).
391
392 This book also contains a chapter that gives a general introduction to SMTP and
393 Internet mail. Inevitably, however, the book is unlikely to be fully up-to-date
394 with the latest release of Exim. (Note that the earlier book about Exim,
395 published by O'Reilly, covers Exim 3, and many things have changed in Exim 4.)
396
397 .cindex "Debian" "information sources"
398 If you are using a Debian distribution of Exim, you will find information about
399 Debian-specific features in the file
400 &_/usr/share/doc/exim4-base/README.Debian_&.
401 The command &(man update-exim.conf)& is another source of Debian-specific
402 information.
403
404 .cindex "&_doc/NewStuff_&"
405 .cindex "&_doc/ChangeLog_&"
406 .cindex "change log"
407 As the program develops, there may be features in newer versions that have not
408 yet made it into this document, which is updated only when the most significant
409 digit of the fractional part of the version number changes. Specifications of
410 new features that are not yet in this manual are placed in the file
411 &_doc/NewStuff_& in the Exim distribution.
412
413 Some features may be classified as &"experimental"&. These may change
414 incompatibly while they are developing, or even be withdrawn. For this reason,
415 they are not documented in this manual. Information about experimental features
416 can be found in the file &_doc/experimental.txt_&.
417
418 All changes to the program (whether new features, bug fixes, or other kinds of
419 change) are noted briefly in the file called &_doc/ChangeLog_&.
420
421 .cindex "&_doc/spec.txt_&"
422 This specification itself is available as an ASCII file in &_doc/spec.txt_& so
423 that it can easily be searched with a text editor. Other files in the &_doc_&
424 directory are:
425
426 .table2 100pt
427 .row &_OptionLists.txt_&     "list of all options in alphabetical order"
428 .row &_dbm.discuss.txt_&     "discussion about DBM libraries"
429 .row &_exim.8_&              "a man page of Exim's command line options"
430 .row &_experimental.txt_&    "documentation of experimental features"
431 .row &_filter.txt_&          "specification of the filter language"
432 .row &_Exim3.upgrade_&       "upgrade notes from release 2 to release 3"
433 .row &_Exim4.upgrade_&       "upgrade notes from release 3 to release 4"
434 .endtable
435
436 The main specification and the specification of the filtering language are also
437 available in other formats (HTML, PostScript, PDF, and Texinfo). Section
438 &<<SECTavail>>& below tells you how to get hold of these.
439
440
441
442 .section "FTP and web sites" "SECID2"
443 .cindex "web site"
444 .cindex "FTP site"
445 The primary site for Exim source distributions is currently the University of
446 Cambridge's FTP site, whose contents are described in &'Where to find the Exim
447 distribution'& below. In addition, there is a web site and an FTP site at
448 &%exim.org%&. These are now also hosted at the University of Cambridge. The
449 &%exim.org%& site was previously hosted for a number of years by Energis
450 Squared, formerly Planet Online Ltd, whose support I gratefully acknowledge.
451
452 .cindex "wiki"
453 .cindex "FAQ"
454 As well as Exim distribution tar files, the Exim web site contains a number of
455 differently formatted versions of the documentation. A recent addition to the
456 online information is the Exim wiki (&url(http://wiki.exim.org)),
457 which contains what used to be a separate FAQ, as well as various other
458 examples, tips, and know-how that have been contributed by Exim users.
459
460 .cindex Bugzilla
461 An Exim Bugzilla exists at &url(http://bugs.exim.org). You can use
462 this to report bugs, and also to add items to the wish list. Please search
463 first to check that you are not duplicating a previous entry.
464
465
466
467 .section "Mailing lists" "SECID3"
468 .cindex "mailing lists" "for Exim users"
469 The following Exim mailing lists exist:
470
471 .table2 140pt
472 .row &'exim-users@exim.org'&      "General discussion list"
473 .row &'exim-dev@exim.org'&        "Discussion of bugs, enhancements, etc."
474 .row &'exim-announce@exim.org'&   "Moderated, low volume announcements list"
475 .row &'exim-future@exim.org'&     "Discussion of long-term development"
476 .endtable
477
478 You can subscribe to these lists, change your existing subscriptions, and view
479 or search the archives via the mailing lists link on the Exim home page.
480 .cindex "Debian" "mailing list for"
481 If you are using a Debian distribution of Exim, you may wish to subscribe to
482 the Debian-specific mailing list &'pkg-exim4-users@lists.alioth.debian.org'&
483 via this web page:
484 .display
485 &url(http://lists.alioth.debian.org/mailman/listinfo/pkg-exim4-users)
486 .endd
487 Please ask Debian-specific questions on this list and not on the general Exim
488 lists.
489
490 .section "Exim training" "SECID4"
491 .cindex "training courses"
492 Training courses in Cambridge (UK) used to be run annually by the author of
493 Exim, before he retired. At the time of writing, there are no plans to run
494 further Exim courses in Cambridge. However, if that changes, relevant
495 information will be posted at &url(http://www-tus.csx.cam.ac.uk/courses/exim/).
496
497 .section "Bug reports" "SECID5"
498 .cindex "bug reports"
499 .cindex "reporting bugs"
500 Reports of obvious bugs can be emailed to &'bugs@exim.org'& or reported
501 via the Bugzilla (&url(http://bugs.exim.org)). However, if you are unsure
502 whether some behaviour is a bug or not, the best thing to do is to post a
503 message to the &'exim-dev'& mailing list and have it discussed.
504
505
506
507 .section "Where to find the Exim distribution" "SECTavail"
508 .cindex "FTP site"
509 .cindex "distribution" "ftp site"
510 The master ftp site for the Exim distribution is
511 .display
512 &*ftp://ftp.csx.cam.ac.uk/pub/software/email/exim*&
513 .endd
514 This is mirrored by
515 .display
516 &*ftp://ftp.exim.org/pub/exim*&
517 .endd
518 The file references that follow are relative to the &_exim_& directories at
519 these sites. There are now quite a number of independent mirror sites around
520 the world. Those that I know about are listed in the file called &_Mirrors_&.
521
522 Within the &_exim_& directory there are subdirectories called &_exim3_& (for
523 previous Exim 3 distributions), &_exim4_& (for the latest Exim 4
524 distributions), and &_Testing_& for testing versions. In the &_exim4_&
525 subdirectory, the current release can always be found in files called
526 .display
527 &_exim-n.nn.tar.gz_&
528 &_exim-n.nn.tar.bz2_&
529 .endd
530 where &'n.nn'& is the highest such version number in the directory. The two
531 files contain identical data; the only difference is the type of compression.
532 The &_.bz2_& file is usually a lot smaller than the &_.gz_& file.
533
534 .cindex "distribution" "signing details"
535 .cindex "distribution" "public key"
536 .cindex "public key for signed distribution"
537 The distributions are currently signed with Nigel Metheringham's GPG key. The
538 corresponding public key is available from a number of keyservers, and there is
539 also a copy in the file &_nigel-pubkey.asc_&. The signatures for the tar bundles are
540 in:
541 .display
542 &_exim-n.nn.tar.gz.asc_&
543 &_exim-n.nn.tar.bz2.asc_&
544 .endd
545 For each released version, the log of changes is made separately available in a
546 separate file in the directory &_ChangeLogs_& so that it is possible to
547 find out what has changed without having to download the entire distribution.
548
549 .cindex "documentation" "available formats"
550 The main distribution contains ASCII versions of this specification and other
551 documentation; other formats of the documents are available in separate files
552 inside the &_exim4_& directory of the FTP site:
553 .display
554 &_exim-html-n.nn.tar.gz_&
555 &_exim-pdf-n.nn.tar.gz_&
556 &_exim-postscript-n.nn.tar.gz_&
557 &_exim-texinfo-n.nn.tar.gz_&
558 .endd
559 These tar files contain only the &_doc_& directory, not the complete
560 distribution, and are also available in &_.bz2_& as well as &_.gz_& forms.
561
562
563 .section "Limitations" "SECID6"
564 .ilist
565 .cindex "limitations of Exim"
566 .cindex "bang paths" "not handled by Exim"
567 Exim is designed for use as an Internet MTA, and therefore handles addresses in
568 RFC 2822 domain format only. It cannot handle UUCP &"bang paths"&, though
569 simple two-component bang paths can be converted by a straightforward rewriting
570 configuration. This restriction does not prevent Exim from being interfaced to
571 UUCP as a transport mechanism, provided that domain addresses are used.
572 .next
573 .cindex "domainless addresses"
574 .cindex "address" "without domain"
575 Exim insists that every address it handles has a domain attached. For incoming
576 local messages, domainless addresses are automatically qualified with a
577 configured domain value. Configuration options specify from which remote
578 systems unqualified addresses are acceptable. These are then qualified on
579 arrival.
580 .next
581 .cindex "transport" "external"
582 .cindex "external transports"
583 The only external transport mechanisms that are currently implemented are SMTP
584 and LMTP over a TCP/IP network (including support for IPv6). However, a pipe
585 transport is available, and there are facilities for writing messages to files
586 and pipes, optionally in &'batched SMTP'& format; these facilities can be used
587 to send messages to other transport mechanisms such as UUCP, provided they can
588 handle domain-style addresses. Batched SMTP input is also catered for.
589 .next
590 Exim is not designed for storing mail for dial-in hosts. When the volumes of
591 such mail are large, it is better to get the messages &"delivered"& into files
592 (that is, off Exim's queue) and subsequently passed on to the dial-in hosts by
593 other means.
594 .next
595 Although Exim does have basic facilities for scanning incoming messages, these
596 are not comprehensive enough to do full virus or spam scanning. Such operations
597 are best carried out using additional specialized software packages. If you
598 compile Exim with the content-scanning extension, straightforward interfaces to
599 a number of common scanners are provided.
600 .endlist
601
602
603 .section "Run time configuration" "SECID7"
604 Exim's run time configuration is held in a single text file that is divided
605 into a number of sections. The entries in this file consist of keywords and
606 values, in the style of Smail 3 configuration files. A default configuration
607 file which is suitable for simple online installations is provided in the
608 distribution, and is described in chapter &<<CHAPdefconfil>>& below.
609
610
611 .section "Calling interface" "SECID8"
612 .cindex "Sendmail compatibility" "command line interface"
613 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
614 can be a straight replacement for &_/usr/lib/sendmail_& or
615 &_/usr/sbin/sendmail_& when sending mail, but you do not need to know anything
616 about Sendmail in order to run Exim. For actions other than sending messages,
617 Sendmail-compatible options also exist, but those that produce output (for
618 example, &%-bp%&, which lists the messages on the queue) do so in Exim's own
619 format. There are also some additional options that are compatible with Smail
620 3, and some further options that are new to Exim. Chapter &<<CHAPcommandline>>&
621 documents all Exim's command line options. This information is automatically
622 made into the man page that forms part of the Exim distribution.
623
624 Control of messages on the queue can be done via certain privileged command
625 line options. There is also an optional monitor program called &'eximon'&,
626 which displays current information in an X window, and which contains a menu
627 interface to Exim's command line administration options.
628
629
630
631 .section "Terminology" "SECID9"
632 .cindex "terminology definitions"
633 .cindex "body of message" "definition of"
634 The &'body'& of a message is the actual data that the sender wants to transmit.
635 It is the last part of a message, and is separated from the &'header'& (see
636 below) by a blank line.
637
638 .cindex "bounce message" "definition of"
639 When a message cannot be delivered, it is normally returned to the sender in a
640 delivery failure message or a &"non-delivery report"& (NDR). The term
641 &'bounce'& is commonly used for this action, and the error reports are often
642 called &'bounce messages'&. This is a convenient shorthand for &"delivery
643 failure error report"&. Such messages have an empty sender address in the
644 message's &'envelope'& (see below) to ensure that they cannot themselves give
645 rise to further bounce messages.
646
647 The term &'default'& appears frequently in this manual. It is used to qualify a
648 value which is used in the absence of any setting in the configuration. It may
649 also qualify an action which is taken unless a configuration setting specifies
650 otherwise.
651
652 The term &'defer'& is used when the delivery of a message to a specific
653 destination cannot immediately take place for some reason (a remote host may be
654 down, or a user's local mailbox may be full). Such deliveries are &'deferred'&
655 until a later time.
656
657 The word &'domain'& is sometimes used to mean all but the first component of a
658 host's name. It is &'not'& used in that sense here, where it normally refers to
659 the part of an email address following the @ sign.
660
661 .cindex "envelope, definition of"
662 .cindex "sender" "definition of"
663 A message in transit has an associated &'envelope'&, as well as a header and a
664 body. The envelope contains a sender address (to which bounce messages should
665 be delivered), and any number of recipient addresses. References to the
666 sender or the recipients of a message usually mean the addresses in the
667 envelope. An MTA uses these addresses for delivery, and for returning bounce
668 messages, not the addresses that appear in the header lines.
669
670 .cindex "message" "header, definition of"
671 .cindex "header section" "definition of"
672 The &'header'& of a message is the first part of a message's text, consisting
673 of a number of lines, each of which has a name such as &'From:'&, &'To:'&,
674 &'Subject:'&, etc. Long header lines can be split over several text lines by
675 indenting the continuations. The header is separated from the body by a blank
676 line.
677
678 .cindex "local part" "definition of"
679 .cindex "domain" "definition of"
680 The term &'local part'&, which is taken from RFC 2822, is used to refer to that
681 part of an email address that precedes the @ sign. The part that follows the
682 @ sign is called the &'domain'& or &'mail domain'&.
683
684 .cindex "local delivery" "definition of"
685 .cindex "remote delivery, definition of"
686 The terms &'local delivery'& and &'remote delivery'& are used to distinguish
687 delivery to a file or a pipe on the local host from delivery by SMTP over
688 TCP/IP to another host. As far as Exim is concerned, all hosts other than the
689 host it is running on are &'remote'&.
690
691 .cindex "return path" "definition of"
692 &'Return path'& is another name that is used for the sender address in a
693 message's envelope.
694
695 .cindex "queue" "definition of"
696 The term &'queue'& is used to refer to the set of messages awaiting delivery,
697 because this term is in widespread use in the context of MTAs. However, in
698 Exim's case the reality is more like a pool than a queue, because there is
699 normally no ordering of waiting messages.
700
701 .cindex "queue runner" "definition of"
702 The term &'queue runner'& is used to describe a process that scans the queue
703 and attempts to deliver those messages whose retry times have come. This term
704 is used by other MTAs, and also relates to the command &%runq%&, but in Exim
705 the waiting messages are normally processed in an unpredictable order.
706
707 .cindex "spool directory" "definition of"
708 The term &'spool directory'& is used for a directory in which Exim keeps the
709 messages on its queue &-- that is, those that it is in the process of
710 delivering. This should not be confused with the directory in which local
711 mailboxes are stored, which is called a &"spool directory"& by some people. In
712 the Exim documentation, &"spool"& is always used in the first sense.
713
714
715
716
717
718
719 . ////////////////////////////////////////////////////////////////////////////
720 . ////////////////////////////////////////////////////////////////////////////
721
722 .chapter "Incorporated code" "CHID2"
723 .cindex "incorporated code"
724 .cindex "regular expressions" "library"
725 .cindex "PCRE"
726 A number of pieces of external code are included in the Exim distribution.
727
728 .ilist
729 Regular expressions are supported in the main Exim program and in the
730 Exim monitor using the freely-distributable PCRE library, copyright
731 &copy; University of Cambridge. The source to PCRE is no longer shipped with
732 Exim, so you will need to use the version of PCRE shipped with your system,
733 or obtain and install the full version of the library from
734 &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre).
735 .next
736 .cindex "cdb" "acknowledgment"
737 Support for the cdb (Constant DataBase) lookup method is provided by code
738 contributed by Nigel Metheringham of (at the time he contributed it) Planet
739 Online Ltd. The implementation is completely contained within the code of Exim.
740 It does not link against an external cdb library. The code contains the
741 following statements:
742
743 .blockquote
744 Copyright &copy; 1998 Nigel Metheringham, Planet Online Ltd
745
746 This program is free software; you can redistribute it and/or modify it under
747 the terms of the GNU General Public License as published by the Free Software
748 Foundation; either version 2 of the License, or (at your option) any later
749 version.
750 This code implements Dan Bernstein's Constant DataBase (cdb) spec. Information,
751 the spec and sample code for cdb can be obtained from
752 &url(http://www.pobox.com/~djb/cdb.html). This implementation borrows
753 some code from Dan Bernstein's implementation (which has no license
754 restrictions applied to it).
755 .endblockquote
756 .next
757 .cindex "SPA authentication"
758 .cindex "Samba project"
759 .cindex "Microsoft Secure Password Authentication"
760 Client support for Microsoft's &'Secure Password Authentication'& is provided
761 by code contributed by Marc Prud'hommeaux. Server support was contributed by
762 Tom Kistner. This includes code taken from the Samba project, which is released
763 under the Gnu GPL.
764 .next
765 .cindex "Cyrus"
766 .cindex "&'pwcheck'& daemon"
767 .cindex "&'pwauthd'& daemon"
768 Support for calling the Cyrus &'pwcheck'& and &'saslauthd'& daemons is provided
769 by code taken from the Cyrus-SASL library and adapted by Alexander S.
770 Sabourenkov. The permission notice appears below, in accordance with the
771 conditions expressed therein.
772
773 .blockquote
774 Copyright &copy; 2001 Carnegie Mellon University.  All rights reserved.
775
776 Redistribution and use in source and binary forms, with or without
777 modification, are permitted provided that the following conditions
778 are met:
779
780 .olist
781 Redistributions of source code must retain the above copyright
782 notice, this list of conditions and the following disclaimer.
783 .next
784 Redistributions in binary form must reproduce the above copyright
785 notice, this list of conditions and the following disclaimer in
786 the documentation and/or other materials provided with the
787 distribution.
788 .next
789 The name &"Carnegie Mellon University"& must not be used to
790 endorse or promote products derived from this software without
791 prior written permission. For permission or any other legal
792 details, please contact
793 .display
794               Office of Technology Transfer
795               Carnegie Mellon University
796               5000 Forbes Avenue
797               Pittsburgh, PA  15213-3890
798               (412) 268-4387, fax: (412) 268-7395
799               tech-transfer@andrew.cmu.edu
800 .endd
801 .next
802 Redistributions of any form whatsoever must retain the following
803 acknowledgment:
804
805 &"This product includes software developed by Computing Services
806 at Carnegie Mellon University (&url(http://www.cmu.edu/computing/)."&
807
808 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
809 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
810 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
811 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
812 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
813 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
814 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
815 .endlist
816 .endblockquote
817
818 .next
819 .cindex "Exim monitor" "acknowledgment"
820 .cindex "X-windows"
821 .cindex "Athena"
822 The Exim Monitor program, which is an X-Window application, includes
823 modified versions of the Athena StripChart and TextPop widgets.
824 This code is copyright by DEC and MIT, and their permission notice appears
825 below, in accordance with the conditions expressed therein.
826
827 .blockquote
828 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
829 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
830
831 All Rights Reserved
832
833 Permission to use, copy, modify, and distribute this software and its
834 documentation for any purpose and without fee is hereby granted,
835 provided that the above copyright notice appear in all copies and that
836 both that copyright notice and this permission notice appear in
837 supporting documentation, and that the names of Digital or MIT not be
838 used in advertising or publicity pertaining to distribution of the
839 software without specific, written prior permission.
840
841 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
842 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
843 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
844 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
845 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
846 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
847 SOFTWARE.
848 .endblockquote
849
850 .next
851 Many people have contributed code fragments, some large, some small, that were
852 not covered by any specific licence requirements. It is assumed that the
853 contributors are happy to see their code incorporated into Exim under the GPL.
854 .endlist
855
856
857
858
859
860 . ////////////////////////////////////////////////////////////////////////////
861 . ////////////////////////////////////////////////////////////////////////////
862
863 .chapter "How Exim receives and delivers mail" "CHID11" &&&
864          "Receiving and delivering mail"
865
866
867 .section "Overall philosophy" "SECID10"
868 .cindex "design philosophy"
869 Exim is designed to work efficiently on systems that are permanently connected
870 to the Internet and are handling a general mix of mail. In such circumstances,
871 most messages can be delivered immediately. Consequently, Exim does not
872 maintain independent queues of messages for specific domains or hosts, though
873 it does try to send several messages in a single SMTP connection after a host
874 has been down, and it also maintains per-host retry information.
875
876
877 .section "Policy control" "SECID11"
878 .cindex "policy control" "overview"
879 Policy controls are now an important feature of MTAs that are connected to the
880 Internet. Perhaps their most important job is to stop MTAs being abused as
881 &"open relays"& by misguided individuals who send out vast amounts of
882 unsolicited junk, and want to disguise its source. Exim provides flexible
883 facilities for specifying policy controls on incoming mail:
884
885 .ilist
886 .cindex "&ACL;" "introduction"
887 Exim 4 (unlike previous versions of Exim) implements policy controls on
888 incoming mail by means of &'Access Control Lists'& (ACLs). Each list is a
889 series of statements that may either grant or deny access. ACLs can be used at
890 several places in the SMTP dialogue while receiving a message from a remote
891 host. However, the most common places are after each RCPT command, and at the
892 very end of the message. The sysadmin can specify conditions for accepting or
893 rejecting individual recipients or the entire message, respectively, at these
894 two points (see chapter &<<CHAPACL>>&). Denial of access results in an SMTP
895 error code.
896 .next
897 An ACL is also available for locally generated, non-SMTP messages. In this
898 case, the only available actions are to accept or deny the entire message.
899 .next
900 When Exim is compiled with the content-scanning extension, facilities are
901 provided in the ACL mechanism for passing the message to external virus and/or
902 spam scanning software. The result of such a scan is passed back to the ACL,
903 which can then use it to decide what to do with the message.
904 .next
905 When a message has been received, either from a remote host or from the local
906 host, but before the final acknowledgment has been sent, a locally supplied C
907 function called &[local_scan()]& can be run to inspect the message and decide
908 whether to accept it or not (see chapter &<<CHAPlocalscan>>&). If the message
909 is accepted, the list of recipients can be modified by the function.
910 .next
911 Using the &[local_scan()]& mechanism is another way of calling external scanner
912 software. The &%SA-Exim%& add-on package works this way. It does not require
913 Exim to be compiled with the content-scanning extension.
914 .next
915 After a message has been accepted, a further checking mechanism is available in
916 the form of the &'system filter'& (see chapter &<<CHAPsystemfilter>>&). This
917 runs at the start of every delivery process.
918 .endlist
919
920
921
922 .section "User filters" "SECID12"
923 .cindex "filter" "introduction"
924 .cindex "Sieve filter"
925 In a conventional Exim configuration, users are able to run private filters by
926 setting up appropriate &_.forward_& files in their home directories. See
927 chapter &<<CHAPredirect>>& (about the &(redirect)& router) for the
928 configuration needed to support this, and the separate document entitled
929 &'Exim's interfaces to mail filtering'& for user details. Two different kinds
930 of filtering are available:
931
932 .ilist
933 Sieve filters are written in the standard filtering language that is defined
934 by RFC 3028.
935 .next
936 Exim filters are written in a syntax that is unique to Exim, but which is more
937 powerful than Sieve, which it pre-dates.
938 .endlist
939
940 User filters are run as part of the routing process, described below.
941
942
943
944 .section "Message identification" "SECTmessiden"
945 .cindex "message ids" "details of format"
946 .cindex "format" "of message id"
947 .cindex "id of message"
948 .cindex "base62"
949 .cindex "base36"
950 .cindex "Darwin"
951 .cindex "Cygwin"
952 Every message handled by Exim is given a &'message id'& which is sixteen
953 characters long. It is divided into three parts, separated by hyphens, for
954 example &`16VDhn-0001bo-D3`&. Each part is a sequence of letters and digits,
955 normally encoding numbers in base 62. However, in the Darwin operating
956 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
957 (avoiding the use of lower case letters) is used instead, because the message
958 id is used to construct file names, and the names of files in those systems are
959 not always case-sensitive.
960
961 .cindex "pid (process id)" "re-use of"
962 The detail of the contents of the message id have changed as Exim has evolved.
963 Earlier versions relied on the operating system not re-using a process id (pid)
964 within one second. On modern operating systems, this assumption can no longer
965 be made, so the algorithm had to be changed. To retain backward compatibility,
966 the format of the message id was retained, which is why the following rules are
967 somewhat eccentric:
968
969 .ilist
970 The first six characters of the message id are the time at which the message
971 started to be received, to a granularity of one second. That is, this field
972 contains the number of seconds since the start of the epoch (the normal Unix
973 way of representing the date and time of day).
974 .next
975 After the first hyphen, the next six characters are the id of the process that
976 received the message.
977 .next
978 There are two different possibilities for the final two characters:
979 .olist
980 .oindex "&%localhost_number%&"
981 If &%localhost_number%& is not set, this value is the fractional part of the
982 time of reception, normally in units of 1/2000 of a second, but for systems
983 that must use base 36 instead of base 62 (because of case-insensitive file
984 systems), the units are 1/1000 of a second.
985 .next
986 If &%localhost_number%& is set, it is multiplied by 200 (100) and added to
987 the fractional part of the time, which in this case is in units of 1/200
988 (1/100) of a second.
989 .endlist
990 .endlist
991
992 After a message has been received, Exim waits for the clock to tick at the
993 appropriate resolution before proceeding, so that if another message is
994 received by the same process, or by another process with the same (re-used)
995 pid, it is guaranteed that the time will be different. In most cases, the clock
996 will already have ticked while the message was being received.
997
998
999 .section "Receiving mail" "SECID13"
1000 .cindex "receiving mail"
1001 .cindex "message" "reception"
1002 The only way Exim can receive mail from another host is using SMTP over
1003 TCP/IP, in which case the sender and recipient addresses are transferred using
1004 SMTP commands. However, from a locally running process (such as a user's MUA),
1005 there are several possibilities:
1006
1007 .ilist
1008 If the process runs Exim with the &%-bm%& option, the message is read
1009 non-interactively (usually via a pipe), with the recipients taken from the
1010 command line, or from the body of the message if &%-t%& is also used.
1011 .next
1012 If the process runs Exim with the &%-bS%& option, the message is also read
1013 non-interactively, but in this case the recipients are listed at the start of
1014 the message in a series of SMTP RCPT commands, terminated by a DATA
1015 command. This is so-called &"batch SMTP"& format,
1016 but it isn't really SMTP. The SMTP commands are just another way of passing
1017 envelope addresses in a non-interactive submission.
1018 .next
1019 If the process runs Exim with the &%-bs%& option, the message is read
1020 interactively, using the SMTP protocol. A two-way pipe is normally used for
1021 passing data between the local process and the Exim process.
1022 This is &"real"& SMTP and is handled in the same way as SMTP over TCP/IP. For
1023 example, the ACLs for SMTP commands are used for this form of submission.
1024 .next
1025 A local process may also make a TCP/IP call to the host's loopback address
1026 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1027 does not treat the loopback address specially. It treats all such connections
1028 in the same way as connections from other hosts.
1029 .endlist
1030
1031
1032 .cindex "message sender, constructed by Exim"
1033 .cindex "sender" "constructed by Exim"
1034 In the three cases that do not involve TCP/IP, the sender address is
1035 constructed from the login name of the user that called Exim and a default
1036 qualification domain (which can be set by the &%qualify_domain%& configuration
1037 option). For local or batch SMTP, a sender address that is passed using the
1038 SMTP MAIL command is ignored. However, the system administrator may allow
1039 certain users (&"trusted users"&) to specify a different sender address
1040 unconditionally, or all users to specify certain forms of different sender
1041 address. The &%-f%& option or the SMTP MAIL command is used to specify these
1042 different addresses. See section &<<SECTtrustedadmin>>& for details of trusted
1043 users, and the &%untrusted_set_sender%& option for a way of allowing untrusted
1044 users to change sender addresses.
1045
1046 Messages received by either of the non-interactive mechanisms are subject to
1047 checking by the non-SMTP ACL, if one is defined. Messages received using SMTP
1048 (either over TCP/IP, or interacting with a local process) can be checked by a
1049 number of ACLs that operate at different times during the SMTP session. Either
1050 individual recipients, or the entire message, can be rejected if local policy
1051 requirements are not met. The &[local_scan()]& function (see chapter
1052 &<<CHAPlocalscan>>&) is run for all incoming messages.
1053
1054 Exim can be configured not to start a delivery process when a message is
1055 received; this can be unconditional, or depend on the number of incoming SMTP
1056 connections or the system load. In these situations, new messages wait on the
1057 queue until a queue runner process picks them up. However, in standard
1058 configurations under normal conditions, delivery is started as soon as a
1059 message is received.
1060
1061
1062
1063
1064
1065 .section "Handling an incoming message" "SECID14"
1066 .cindex "spool directory" "files that hold a message"
1067 .cindex "file" "how a message is held"
1068 When Exim accepts a message, it writes two files in its spool directory. The
1069 first contains the envelope information, the current status of the message, and
1070 the header lines, and the second contains the body of the message. The names of
1071 the two spool files consist of the message id, followed by &`-H`& for the
1072 file containing the envelope and header, and &`-D`& for the data file.
1073
1074 .cindex "spool directory" "&_input_& sub-directory"
1075 By default all these message files are held in a single directory called
1076 &_input_& inside the general Exim spool directory. Some operating systems do
1077 not perform very well if the number of files in a directory gets large; to
1078 improve performance in such cases, the &%split_spool_directory%& option can be
1079 used. This causes Exim to split up the input files into 62 sub-directories
1080 whose names are single letters or digits. When this is done, the queue is
1081 processed one sub-directory at a time instead of all at once, which can improve
1082 overall performance even when there are not enough files in each directory to
1083 affect file system performance.
1084
1085 The envelope information consists of the address of the message's sender and
1086 the addresses of the recipients. This information is entirely separate from
1087 any addresses contained in the header lines. The status of the message includes
1088 a list of recipients who have already received the message. The format of the
1089 first spool file is described in chapter &<<CHAPspool>>&.
1090
1091 .cindex "rewriting" "addresses"
1092 Address rewriting that is specified in the rewrite section of the configuration
1093 (see chapter &<<CHAPrewrite>>&) is done once and for all on incoming addresses,
1094 both in the header lines and the envelope, at the time the message is accepted.
1095 If during the course of delivery additional addresses are generated (for
1096 example, via aliasing), these new addresses are rewritten as soon as they are
1097 generated. At the time a message is actually delivered (transported) further
1098 rewriting can take place; because this is a transport option, it can be
1099 different for different forms of delivery. It is also possible to specify the
1100 addition or removal of certain header lines at the time the message is
1101 delivered (see chapters &<<CHAProutergeneric>>& and
1102 &<<CHAPtransportgeneric>>&).
1103
1104
1105
1106 .section "Life of a message" "SECID15"
1107 .cindex "message" "life of"
1108 .cindex "message" "frozen"
1109 A message remains in the spool directory until it is completely delivered to
1110 its recipients or to an error address, or until it is deleted by an
1111 administrator or by the user who originally created it. In cases when delivery
1112 cannot proceed &-- for example, when a message can neither be delivered to its
1113 recipients nor returned to its sender, the message is marked &"frozen"& on the
1114 spool, and no more deliveries are attempted.
1115
1116 .cindex "frozen messages" "thawing"
1117 .cindex "message" "thawing frozen"
1118 An administrator can &"thaw"& such messages when the problem has been
1119 corrected, and can also freeze individual messages by hand if necessary. In
1120 addition, an administrator can force a delivery error, causing a bounce message
1121 to be sent.
1122
1123 .oindex "&%timeout_frozen_after%&"
1124 .oindex "&%ignore_bounce_errors_after%&"
1125 There are options called &%ignore_bounce_errors_after%& and
1126 &%timeout_frozen_after%&, which discard frozen messages after a certain time.
1127 The first applies only to frozen bounces, the second to any frozen messages.
1128
1129 .cindex "message" "log file for"
1130 .cindex "log" "file for each message"
1131 While Exim is working on a message, it writes information about each delivery
1132 attempt to its main log file. This includes successful, unsuccessful, and
1133 delayed deliveries for each recipient (see chapter &<<CHAPlog>>&). The log
1134 lines are also written to a separate &'message log'& file for each message.
1135 These logs are solely for the benefit of the administrator, and are normally
1136 deleted along with the spool files when processing of a message is complete.
1137 The use of individual message logs can be disabled by setting
1138 &%no_message_logs%&; this might give an improvement in performance on very busy
1139 systems.
1140
1141 .cindex "journal file"
1142 .cindex "file" "journal"
1143 All the information Exim itself needs to set up a delivery is kept in the first
1144 spool file, along with the header lines. When a successful delivery occurs, the
1145 address is immediately written at the end of a journal file, whose name is the
1146 message id followed by &`-J`&. At the end of a delivery run, if there are some
1147 addresses left to be tried again later, the first spool file (the &`-H`& file)
1148 is updated to indicate which these are, and the journal file is then deleted.
1149 Updating the spool file is done by writing a new file and renaming it, to
1150 minimize the possibility of data loss.
1151
1152 Should the system or the program crash after a successful delivery but before
1153 the spool file has been updated, the journal is left lying around. The next
1154 time Exim attempts to deliver the message, it reads the journal file and
1155 updates the spool file before proceeding. This minimizes the chances of double
1156 deliveries caused by crashes.
1157
1158
1159
1160 .section "Processing an address for delivery" "SECTprocaddress"
1161 .cindex "drivers" "definition of"
1162 .cindex "router" "definition of"
1163 .cindex "transport" "definition of"
1164 The main delivery processing elements of Exim are called &'routers'& and
1165 &'transports'&, and collectively these are known as &'drivers'&. Code for a
1166 number of them is provided in the source distribution, and compile-time options
1167 specify which ones are included in the binary. Run time options specify which
1168 ones are actually used for delivering messages.
1169
1170 .cindex "drivers" "instance definition"
1171 Each driver that is specified in the run time configuration is an &'instance'&
1172 of that particular driver type. Multiple instances are allowed; for example,
1173 you can set up several different &(smtp)& transports, each with different
1174 option values that might specify different ports or different timeouts. Each
1175 instance has its own identifying name. In what follows we will normally use the
1176 instance name when discussing one particular instance (that is, one specific
1177 configuration of the driver), and the generic driver name when discussing
1178 the driver's features in general.
1179
1180 A &'router'& is a driver that operates on an address, either determining how
1181 its delivery should happen, by assigning it to a specific transport, or
1182 converting the address into one or more new addresses (for example, via an
1183 alias file). A router may also explicitly choose to fail an address, causing it
1184 to be bounced.
1185
1186 A &'transport'& is a driver that transmits a copy of the message from Exim's
1187 spool to some destination. There are two kinds of transport: for a &'local'&
1188 transport, the destination is a file or a pipe on the local host, whereas for a
1189 &'remote'& transport the destination is some other host. A message is passed
1190 to a specific transport as a result of successful routing. If a message has
1191 several recipients, it may be passed to a number of different transports.
1192
1193 .cindex "preconditions" "definition of"
1194 An address is processed by passing it to each configured router instance in
1195 turn, subject to certain preconditions, until a router accepts the address or
1196 specifies that it should be bounced. We will describe this process in more
1197 detail shortly. First, as a simple example, we consider how each recipient
1198 address in a message is processed in a small configuration of three routers.
1199
1200 To make this a more concrete example, it is described in terms of some actual
1201 routers, but remember, this is only an example. You can configure Exim's
1202 routers in many different ways, and there may be any number of routers in a
1203 configuration.
1204
1205 The first router that is specified in a configuration is often one that handles
1206 addresses in domains that are not recognized specially by the local host. These
1207 are typically addresses for arbitrary domains on the Internet. A precondition
1208 is set up which looks for the special domains known to the host (for example,
1209 its own domain name), and the router is run for addresses that do &'not'&
1210 match. Typically, this is a router that looks up domains in the DNS in order to
1211 find the hosts to which this address routes. If it succeeds, the address is
1212 assigned to a suitable SMTP transport; if it does not succeed, the router is
1213 configured to fail the address.
1214
1215 The second router is reached only when the domain is recognized as one that
1216 &"belongs"& to the local host. This router does redirection &-- also known as
1217 aliasing and forwarding. When it generates one or more new addresses from the
1218 original, each of them is routed independently from the start. Otherwise, the
1219 router may cause an address to fail, or it may simply decline to handle the
1220 address, in which case the address is passed to the next router.
1221
1222 The final router in many configurations is one that checks to see if the
1223 address belongs to a local mailbox. The precondition may involve a check to
1224 see if the local part is the name of a login account, or it may look up the
1225 local part in a file or a database. If its preconditions are not met, or if
1226 the router declines, we have reached the end of the routers. When this happens,
1227 the address is bounced.
1228
1229
1230
1231 .section "Processing an address for verification" "SECID16"
1232 .cindex "router" "for verification"
1233 .cindex "verifying address" "overview"
1234 As well as being used to decide how to deliver to an address, Exim's routers
1235 are also used for &'address verification'&. Verification can be requested as
1236 one of the checks to be performed in an ACL for incoming messages, on both
1237 sender and recipient addresses, and it can be tested using the &%-bv%& and
1238 &%-bvs%& command line options.
1239
1240 When an address is being verified, the routers are run in &"verify mode"&. This
1241 does not affect the way the routers work, but it is a state that can be
1242 detected. By this means, a router can be skipped or made to behave differently
1243 when verifying. A common example is a configuration in which the first router
1244 sends all messages to a message-scanning program, unless they have been
1245 previously scanned. Thus, the first router accepts all addresses without any
1246 checking, making it useless for verifying. Normally, the &%no_verify%& option
1247 would be set for such a router, causing it to be skipped in verify mode.
1248
1249
1250
1251
1252 .section "Running an individual router" "SECTrunindrou"
1253 .cindex "router" "running details"
1254 .cindex "preconditions" "checking"
1255 .cindex "router" "result of running"
1256 As explained in the example above, a number of preconditions are checked before
1257 running a router. If any are not met, the router is skipped, and the address is
1258 passed to the next router. When all the preconditions on a router &'are'& met,
1259 the router is run. What happens next depends on the outcome, which is one of
1260 the following:
1261
1262 .ilist
1263 &'accept'&: The router accepts the address, and either assigns it to a
1264 transport, or generates one or more &"child"& addresses. Processing the
1265 original address ceases,
1266 .oindex "&%unseen%&"
1267 unless the &%unseen%& option is set on the router. This option
1268 can be used to set up multiple deliveries with different routing (for example,
1269 for keeping archive copies of messages). When &%unseen%& is set, the address is
1270 passed to the next router. Normally, however, an &'accept'& return marks the
1271 end of routing.
1272
1273 Any child addresses generated by the router are processed independently,
1274 starting with the first router by default. It is possible to change this by
1275 setting the &%redirect_router%& option to specify which router to start at for
1276 child addresses. Unlike &%pass_router%& (see below) the router specified by
1277 &%redirect_router%& may be anywhere in the router configuration.
1278 .next
1279 &'pass'&: The router recognizes the address, but cannot handle it itself. It
1280 requests that the address be passed to another router. By default the address
1281 is passed to the next router, but this can be changed by setting the
1282 &%pass_router%& option. However, (unlike &%redirect_router%&) the named router
1283 must be below the current router (to avoid loops).
1284 .next
1285 &'decline'&: The router declines to accept the address because it does not
1286 recognize it at all. By default, the address is passed to the next router, but
1287 this can be prevented by setting the &%no_more%& option. When &%no_more%& is
1288 set, all the remaining routers are skipped. In effect, &%no_more%& converts
1289 &'decline'& into &'fail'&.
1290 .next
1291 &'fail'&: The router determines that the address should fail, and queues it for
1292 the generation of a bounce message. There is no further processing of the
1293 original address unless &%unseen%& is set on the router.
1294 .next
1295 &'defer'&: The router cannot handle the address at the present time. (A
1296 database may be offline, or a DNS lookup may have timed out.) No further
1297 processing of the address happens in this delivery attempt. It is tried again
1298 next time the message is considered for delivery.
1299 .next
1300 &'error'&: There is some error in the router (for example, a syntax error in
1301 its configuration). The action is as for defer.
1302 .endlist
1303
1304 If an address reaches the end of the routers without having been accepted by
1305 any of them, it is bounced as unrouteable. The default error message in this
1306 situation is &"unrouteable address"&, but you can set your own message by
1307 making use of the &%cannot_route_message%& option. This can be set for any
1308 router; the value from the last router that &"saw"& the address is used.
1309
1310 Sometimes while routing you want to fail a delivery when some conditions are
1311 met but others are not, instead of passing the address on for further routing.
1312 You can do this by having a second router that explicitly fails the delivery
1313 when the relevant conditions are met. The &(redirect)& router has a &"fail"&
1314 facility for this purpose.
1315
1316
1317 .section "Duplicate addresses" "SECID17"
1318 .cindex "case of local parts"
1319 .cindex "address duplicate, discarding"
1320 .cindex "duplicate addresses"
1321 Once routing is complete, Exim scans the addresses that are assigned to local
1322 and remote transports, and discards any duplicates that it finds. During this
1323 check, local parts are treated as case-sensitive. This happens only when
1324 actually delivering a message; when testing routers with &%-bt%&, all the
1325 routed addresses are shown.
1326
1327
1328
1329 .section "Router preconditions" "SECTrouprecon"
1330 .cindex "router" "preconditions, order of processing"
1331 .cindex "preconditions" "order of processing"
1332 The preconditions that are tested for each router are listed below, in the
1333 order in which they are tested. The individual configuration options are
1334 described in more detail in chapter &<<CHAProutergeneric>>&.
1335
1336 .ilist
1337 The &%local_part_prefix%& and &%local_part_suffix%& options can specify that
1338 the local parts handled by the router may or must have certain prefixes and/or
1339 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1340 skipped. These conditions are tested first. When an affix is present, it is
1341 removed from the local part before further processing, including the evaluation
1342 of any other conditions.
1343 .next
1344 Routers can be designated for use only when not verifying an address, that is,
1345 only when routing it for delivery (or testing its delivery routing). If the
1346 &%verify%& option is set false, the router is skipped when Exim is verifying an
1347 address.
1348 Setting the &%verify%& option actually sets two options, &%verify_sender%& and
1349 &%verify_recipient%&, which independently control the use of the router for
1350 sender and recipient verification. You can set these options directly if
1351 you want a router to be used for only one type of verification.
1352 .next
1353 If the &%address_test%& option is set false, the router is skipped when Exim is
1354 run with the &%-bt%& option to test an address routing. This can be helpful
1355 when the first router sends all new messages to a scanner of some sort; it
1356 makes it possible to use &%-bt%& to test subsequent delivery routing without
1357 having to simulate the effect of the scanner.
1358 .next
1359 Routers can be designated for use only when verifying an address, as
1360 opposed to routing it for delivery. The &%verify_only%& option controls this.
1361 .next
1362 Individual routers can be explicitly skipped when running the routers to
1363 check an address given in the SMTP EXPN command (see the &%expn%& option).
1364 .next
1365 If the &%domains%& option is set, the domain of the address must be in the set
1366 of domains that it defines.
1367 .next
1368 .vindex "&$local_part_prefix$&"
1369 .vindex "&$local_part$&"
1370 .vindex "&$local_part_suffix$&"
1371 If the &%local_parts%& option is set, the local part of the address must be in
1372 the set of local parts that it defines. If &%local_part_prefix%& or
1373 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1374 part before this check. If you want to do precondition tests on local parts
1375 that include affixes, you can do so by using a &%condition%& option (see below)
1376 that uses the variables &$local_part$&, &$local_part_prefix$&, and
1377 &$local_part_suffix$& as necessary.
1378 .next
1379 .vindex "&$local_user_uid$&"
1380 .vindex "&$local_user_gid$&"
1381 .vindex "&$home$&"
1382 If the &%check_local_user%& option is set, the local part must be the name of
1383 an account on the local host. If this check succeeds, the uid and gid of the
1384 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1385 user's home directory is placed in &$home$&; these values can be used in the
1386 remaining preconditions.
1387 .next
1388 If the &%router_home_directory%& option is set, it is expanded at this point,
1389 because it overrides the value of &$home$&. If this expansion were left till
1390 later, the value of &$home$& as set by &%check_local_user%& would be used in
1391 subsequent tests. Having two different values of &$home$& in the same router
1392 could lead to confusion.
1393 .next
1394 If the &%senders%& option is set, the envelope sender address must be in the
1395 set of addresses that it defines.
1396 .next
1397 If the &%require_files%& option is set, the existence or non-existence of
1398 specified files is tested.
1399 .next
1400 .cindex "customizing" "precondition"
1401 If the &%condition%& option is set, it is evaluated and tested. This option
1402 uses an expanded string to allow you to set up your own custom preconditions.
1403 Expanded strings are described in chapter &<<CHAPexpand>>&.
1404 .endlist
1405
1406
1407 Note that &%require_files%& comes near the end of the list, so you cannot use
1408 it to check for the existence of a file in which to lookup up a domain, local
1409 part, or sender. However, as these options are all expanded, you can use the
1410 &%exists%& expansion condition to make such tests within each condition. The
1411 &%require_files%& option is intended for checking files that the router may be
1412 going to use internally, or which are needed by a specific transport (for
1413 example, &_.procmailrc_&).
1414
1415
1416
1417 .section "Delivery in detail" "SECID18"
1418 .cindex "delivery" "in detail"
1419 When a message is to be delivered, the sequence of events is as follows:
1420
1421 .ilist
1422 If a system-wide filter file is specified, the message is passed to it. The
1423 filter may add recipients to the message, replace the recipients, discard the
1424 message, cause a new message to be generated, or cause the message delivery to
1425 fail. The format of the system filter file is the same as for Exim user filter
1426 files, described in the separate document entitled &'Exim's interfaces to mail
1427 filtering'&.
1428 .cindex "Sieve filter" "not available for system filter"
1429 (&*Note*&: Sieve cannot be used for system filter files.)
1430
1431 Some additional features are available in system filters &-- see chapter
1432 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1433 filter only once per delivery attempt, however many recipients it has. However,
1434 if there are several delivery attempts because one or more addresses could not
1435 be immediately delivered, the system filter is run each time. The filter
1436 condition &%first_delivery%& can be used to detect the first run of the system
1437 filter.
1438 .next
1439 Each recipient address is offered to each configured router in turn, subject to
1440 its preconditions, until one is able to handle it. If no router can handle the
1441 address, that is, if they all decline, the address is failed. Because routers
1442 can be targeted at particular domains, several locally handled domains can be
1443 processed entirely independently of each other.
1444 .next
1445 .cindex "routing" "loops in"
1446 .cindex "loop" "while routing"
1447 A router that accepts an address may assign it to a local or a remote
1448 transport. However, the transport is not run at this time. Instead, the address
1449 is placed on a list for the particular transport, which will be run later.
1450 Alternatively, the router may generate one or more new addresses (typically
1451 from alias, forward, or filter files). New addresses are fed back into this
1452 process from the top, but in order to avoid loops, a router ignores any address
1453 which has an identically-named ancestor that was processed by itself.
1454 .next
1455 When all the routing has been done, addresses that have been successfully
1456 handled are passed to their assigned transports. When local transports are
1457 doing real local deliveries, they handle only one address at a time, but if a
1458 local transport is being used as a pseudo-remote transport (for example, to
1459 collect batched SMTP messages for transmission by some other means) multiple
1460 addresses can be handled. Remote transports can always handle more than one
1461 address at a time, but can be configured not to do so, or to restrict multiple
1462 addresses to the same domain.
1463 .next
1464 Each local delivery to a file or a pipe runs in a separate process under a
1465 non-privileged uid, and these deliveries are run one at a time. Remote
1466 deliveries also run in separate processes, normally under a uid that is private
1467 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1468 run in parallel. The maximum number of simultaneous remote deliveries for any
1469 one message is set by the &%remote_max_parallel%& option.
1470 The order in which deliveries are done is not defined, except that all local
1471 deliveries happen before any remote deliveries.
1472 .next
1473 .cindex "queue runner"
1474 When it encounters a local delivery during a queue run, Exim checks its retry
1475 database to see if there has been a previous temporary delivery failure for the
1476 address before running the local transport. If there was a previous failure,
1477 Exim does not attempt a new delivery until the retry time for the address is
1478 reached. However, this happens only for delivery attempts that are part of a
1479 queue run. Local deliveries are always attempted when delivery immediately
1480 follows message reception, even if retry times are set for them. This makes for
1481 better behaviour if one particular message is causing problems (for example,
1482 causing quota overflow, or provoking an error in a filter file).
1483 .next
1484 .cindex "delivery" "retry in remote transports"
1485 Remote transports do their own retry handling, since an address may be
1486 deliverable to one of a number of hosts, each of which may have a different
1487 retry time. If there have been previous temporary failures and no host has
1488 reached its retry time, no delivery is attempted, whether in a queue run or
1489 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1490 .next
1491 If there were any permanent errors, a bounce message is returned to an
1492 appropriate address (the sender in the common case), with details of the error
1493 for each failing address. Exim can be configured to send copies of bounce
1494 messages to other addresses.
1495 .next
1496 .cindex "delivery" "deferral"
1497 If one or more addresses suffered a temporary failure, the message is left on
1498 the queue, to be tried again later. Delivery of these addresses is said to be
1499 &'deferred'&.
1500 .next
1501 When all the recipient addresses have either been delivered or bounced,
1502 handling of the message is complete. The spool files and message log are
1503 deleted, though the message log can optionally be preserved if required.
1504 .endlist
1505
1506
1507
1508
1509 .section "Retry mechanism" "SECID19"
1510 .cindex "delivery" "retry mechanism"
1511 .cindex "retry" "description of mechanism"
1512 .cindex "queue runner"
1513 Exim's mechanism for retrying messages that fail to get delivered at the first
1514 attempt is the queue runner process. You must either run an Exim daemon that
1515 uses the &%-q%& option with a time interval to start queue runners at regular
1516 intervals, or use some other means (such as &'cron'&) to start them. If you do
1517 not arrange for queue runners to be run, messages that fail temporarily at the
1518 first attempt will remain on your queue for ever. A queue runner process works
1519 its way through the queue, one message at a time, trying each delivery that has
1520 passed its retry time.
1521 You can run several queue runners at once.
1522
1523 Exim uses a set of configured rules to determine when next to retry the failing
1524 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1525 should give up trying to deliver to the address, at which point it generates a
1526 bounce message. If no retry rules are set for a particular host, address, and
1527 error combination, no retries are attempted, and temporary errors are treated
1528 as permanent.
1529
1530
1531
1532 .section "Temporary delivery failure" "SECID20"
1533 .cindex "delivery" "temporary failure"
1534 There are many reasons why a message may not be immediately deliverable to a
1535 particular address. Failure to connect to a remote machine (because it, or the
1536 connection to it, is down) is one of the most common. Temporary failures may be
1537 detected during routing as well as during the transport stage of delivery.
1538 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1539 is on a file system where the user is over quota. Exim can be configured to
1540 impose its own quotas on local mailboxes; where system quotas are set they will
1541 also apply.
1542
1543 If a host is unreachable for a period of time, a number of messages may be
1544 waiting for it by the time it recovers, and sending them in a single SMTP
1545 connection is clearly beneficial. Whenever a delivery to a remote host is
1546 deferred,
1547
1548 .cindex "hints database"
1549 Exim makes a note in its hints database, and whenever a successful
1550 SMTP delivery has happened, it looks to see if any other messages are waiting
1551 for the same host. If any are found, they are sent over the same SMTP
1552 connection, subject to a configuration limit as to the maximum number in any
1553 one connection.
1554
1555
1556
1557
1558 .section "Permanent delivery failure" "SECID21"
1559 .cindex "delivery" "permanent failure"
1560 .cindex "bounce message" "when generated"
1561 When a message cannot be delivered to some or all of its intended recipients, a
1562 bounce message is generated. Temporary delivery failures turn into permanent
1563 errors when their timeout expires. All the addresses that fail in a given
1564 delivery attempt are listed in a single message. If the original message has
1565 many recipients, it is possible for some addresses to fail in one delivery
1566 attempt and others to fail subsequently, giving rise to more than one bounce
1567 message. The wording of bounce messages can be customized by the administrator.
1568 See chapter &<<CHAPemsgcust>>& for details.
1569
1570 .cindex "&'X-Failed-Recipients:'& header line"
1571 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1572 failed addresses, for the benefit of programs that try to analyse such messages
1573 automatically.
1574
1575 .cindex "bounce message" "recipient of"
1576 A bounce message is normally sent to the sender of the original message, as
1577 obtained from the message's envelope. For incoming SMTP messages, this is the
1578 address given in the MAIL command. However, when an address is expanded via a
1579 forward or alias file, an alternative address can be specified for delivery
1580 failures of the generated addresses. For a mailing list expansion (see section
1581 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1582 of the list.
1583
1584
1585
1586 .section "Failures to deliver bounce messages" "SECID22"
1587 .cindex "bounce message" "failure to deliver"
1588 If a bounce message (either locally generated or received from a remote host)
1589 itself suffers a permanent delivery failure, the message is left on the queue,
1590 but it is frozen, awaiting the attention of an administrator. There are options
1591 that can be used to make Exim discard such failed messages, or to keep them
1592 for only a short time (see &%timeout_frozen_after%& and
1593 &%ignore_bounce_errors_after%&).
1594
1595
1596
1597
1598
1599 . ////////////////////////////////////////////////////////////////////////////
1600 . ////////////////////////////////////////////////////////////////////////////
1601
1602 .chapter "Building and installing Exim" "CHID3"
1603 .scindex IIDbuex "building Exim"
1604
1605 .section "Unpacking" "SECID23"
1606 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1607 creates a directory with the name of the current release (for example,
1608 &_exim-&version;_&) into which the following files are placed:
1609
1610 .table2 140pt
1611 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1612 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1613   documented"
1614 .irow &_LICENCE_&         "the GNU General Public Licence"
1615 .irow &_Makefile_&        "top-level make file"
1616 .irow &_NOTICE_&          "conditions for the use of Exim"
1617 .irow &_README_&          "list of files, directories and simple build &&&
1618   instructions"
1619 .endtable
1620
1621 Other files whose names begin with &_README_& may also be present. The
1622 following subdirectories are created:
1623
1624 .table2 140pt
1625 .irow &_Local_&           "an empty directory for local configuration files"
1626 .irow &_OS_&              "OS-specific files"
1627 .irow &_doc_&             "documentation files"
1628 .irow &_exim_monitor_&    "source files for the Exim monitor"
1629 .irow &_scripts_&         "scripts used in the build process"
1630 .irow &_src_&             "remaining source files"
1631 .irow &_util_&            "independent utilities"
1632 .endtable
1633
1634 The main utility programs are contained in the &_src_& directory, and are built
1635 with the Exim binary. The &_util_& directory contains a few optional scripts
1636 that may be useful to some sites.
1637
1638
1639 .section "Multiple machine architectures and operating systems" "SECID24"
1640 .cindex "building Exim" "multiple OS/architectures"
1641 The building process for Exim is arranged to make it easy to build binaries for
1642 a number of different architectures and operating systems from the same set of
1643 source files. Compilation does not take place in the &_src_& directory.
1644 Instead, a &'build directory'& is created for each architecture and operating
1645 system.
1646 .cindex "symbolic link" "to build directory"
1647 Symbolic links to the sources are installed in this directory, which is where
1648 the actual building takes place. In most cases, Exim can discover the machine
1649 architecture and operating system for itself, but the defaults can be
1650 overridden if necessary.
1651
1652
1653 .section "PCRE library" "SECTpcre"
1654 .cindex "PCRE library"
1655 Exim no longer has an embedded PCRE library as the vast majority of
1656 modern systems include PCRE as a system library, although you may need
1657 to install the PCRE or PCRE development package for your operating
1658 system. If your system has a normal PCRE installation the Exim build
1659 process will need no further configuration. If the library or the
1660 headers are in an unusual location you will need to set the PCRE_LIBS
1661 and INCLUDE directives appropriately. If your operating system has no
1662 PCRE support then you will need to obtain and build the current PCRE
1663 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1664
1665 .section "DBM libraries" "SECTdb"
1666 .cindex "DBM libraries" "discussion of"
1667 .cindex "hints database" "DBM files used for"
1668 Even if you do not use any DBM files in your configuration, Exim still needs a
1669 DBM library in order to operate, because it uses indexed files for its hints
1670 databases. Unfortunately, there are a number of DBM libraries in existence, and
1671 different operating systems often have different ones installed.
1672
1673 .cindex "Solaris" "DBM library for"
1674 .cindex "IRIX, DBM library for"
1675 .cindex "BSD, DBM library for"
1676 .cindex "Linux, DBM library for"
1677 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1678 Linux distribution, the DBM configuration should happen automatically, and you
1679 may be able to ignore this section. Otherwise, you may have to learn more than
1680 you would like about DBM libraries from what follows.
1681
1682 .cindex "&'ndbm'& DBM library"
1683 Licensed versions of Unix normally contain a library of DBM functions operating
1684 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1685 versions of Unix seem to vary in what they contain as standard. In particular,
1686 some early versions of Linux have no default DBM library, and different
1687 distributors have chosen to bundle different libraries with their packaged
1688 versions. However, the more recent releases seem to have standardized on the
1689 Berkeley DB library.
1690
1691 Different DBM libraries have different conventions for naming the files they
1692 use. When a program opens a file called &_dbmfile_&, there are several
1693 possibilities:
1694
1695 .olist
1696 A traditional &'ndbm'& implementation, such as that supplied as part of
1697 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1698 .next
1699 .cindex "&'gdbm'& DBM library"
1700 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1701 compatibility interface it makes two different hard links to it with names
1702 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1703 file name is used unmodified.
1704 .next
1705 .cindex "Berkeley DB library"
1706 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1707 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1708 programmer exactly the same as the traditional &'ndbm'& implementation.
1709 .next
1710 If the Berkeley package is used in its native mode, it operates on a single
1711 file called &_dbmfile_&; the programmer's interface is somewhat different to
1712 the traditional &'ndbm'& interface.
1713 .next
1714 To complicate things further, there are several very different versions of the
1715 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1716 2.&'x'& and 3.&'x'& were current for a while, but the latest versions are now
1717 numbered 4.&'x'&. Maintenance of some of the earlier releases has ceased. All
1718 versions of Berkeley DB can be obtained from
1719 &url(http://www.sleepycat.com/).
1720 .next
1721 .cindex "&'tdb'& DBM library"
1722 Yet another DBM library, called &'tdb'&, is available from
1723 &url(http://download.sourceforge.net/tdb). It has its own interface, and also
1724 operates on a single file.
1725 .endlist
1726
1727 .cindex "USE_DB"
1728 .cindex "DBM libraries" "configuration for building"
1729 Exim and its utilities can be compiled to use any of these interfaces. In order
1730 to use any version of the Berkeley DB package in native mode, you must set
1731 USE_DB in an appropriate configuration file (typically
1732 &_Local/Makefile_&). For example:
1733 .code
1734 USE_DB=yes
1735 .endd
1736 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1737 error is diagnosed if you set more than one of these.
1738
1739 At the lowest level, the build-time configuration sets none of these options,
1740 thereby assuming an interface of type (1). However, some operating system
1741 configuration files (for example, those for the BSD operating systems and
1742 Linux) assume type (4) by setting USE_DB as their default, and the
1743 configuration files for Cygwin set USE_GDBM. Anything you set in
1744 &_Local/Makefile_&, however, overrides these system defaults.
1745
1746 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1747 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1748 in one of these lines:
1749 .code
1750 DBMLIB = -ldb
1751 DBMLIB = -ltdb
1752 .endd
1753 Settings like that will work if the DBM library is installed in the standard
1754 place. Sometimes it is not, and the library's header file may also not be in
1755 the default path. You may need to set INCLUDE to specify where the header
1756 file is, and to specify the path to the library more fully in DBMLIB, as in
1757 this example:
1758 .code
1759 INCLUDE=-I/usr/local/include/db-4.1
1760 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1761 .endd
1762 There is further detailed discussion about the various DBM libraries in the
1763 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1764
1765
1766
1767 .section "Pre-building configuration" "SECID25"
1768 .cindex "building Exim" "pre-building configuration"
1769 .cindex "configuration for building Exim"
1770 .cindex "&_Local/Makefile_&"
1771 .cindex "&_src/EDITME_&"
1772 Before building Exim, a local configuration file that specifies options
1773 independent of any operating system has to be created with the name
1774 &_Local/Makefile_&. A template for this file is supplied as the file
1775 &_src/EDITME_&, and it contains full descriptions of all the option settings
1776 therein. These descriptions are therefore not repeated here. If you are
1777 building Exim for the first time, the simplest thing to do is to copy
1778 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1779
1780 There are three settings that you must supply, because Exim will not build
1781 without them. They are the location of the run time configuration file
1782 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1783 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1784 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1785 a colon-separated list of file names; Exim uses the first of them that exists.
1786
1787 There are a few other parameters that can be specified either at build time or
1788 at run time, to enable the same binary to be used on a number of different
1789 machines. However, if the locations of Exim's spool directory and log file
1790 directory (if not within the spool directory) are fixed, it is recommended that
1791 you specify them in &_Local/Makefile_& instead of at run time, so that errors
1792 detected early in Exim's execution (such as a malformed configuration file) can
1793 be logged.
1794
1795 .cindex "content scanning" "specifying at build time"
1796 Exim's interfaces for calling virus and spam scanning software directly from
1797 access control lists are not compiled by default. If you want to include these
1798 facilities, you need to set
1799 .code
1800 WITH_CONTENT_SCAN=yes
1801 .endd
1802 in your &_Local/Makefile_&. For details of the facilities themselves, see
1803 chapter &<<CHAPexiscan>>&.
1804
1805
1806 .cindex "&_Local/eximon.conf_&"
1807 .cindex "&_exim_monitor/EDITME_&"
1808 If you are going to build the Exim monitor, a similar configuration process is
1809 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1810 your installation and saved under the name &_Local/eximon.conf_&. If you are
1811 happy with the default settings described in &_exim_monitor/EDITME_&,
1812 &_Local/eximon.conf_& can be empty, but it must exist.
1813
1814 This is all the configuration that is needed in straightforward cases for known
1815 operating systems. However, the building process is set up so that it is easy
1816 to override options that are set by default or by operating-system-specific
1817 configuration files, for example to change the name of the C compiler, which
1818 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1819 do this.
1820
1821
1822
1823 .section "Support for iconv()" "SECID26"
1824 .cindex "&[iconv()]& support"
1825 .cindex "RFC 2047"
1826 The contents of header lines in messages may be encoded according to the rules
1827 described RFC 2047. This makes it possible to transmit characters that are not
1828 in the ASCII character set, and to label them as being in a particular
1829 character set. When Exim is inspecting header lines by means of the &%$h_%&
1830 mechanism, it decodes them, and translates them into a specified character set
1831 (default ISO-8859-1). The translation is possible only if the operating system
1832 supports the &[iconv()]& function.
1833
1834 However, some of the operating systems that supply &[iconv()]& do not support
1835 very many conversions. The GNU &%libiconv%& library (available from
1836 &url(http://www.gnu.org/software/libiconv/)) can be installed on such
1837 systems to remedy this deficiency, as well as on systems that do not supply
1838 &[iconv()]& at all. After installing &%libiconv%&, you should add
1839 .code
1840 HAVE_ICONV=yes
1841 .endd
1842 to your &_Local/Makefile_& and rebuild Exim.
1843
1844
1845
1846 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1847 .cindex "TLS" "including support for TLS"
1848 .cindex "encryption" "including support for"
1849 .cindex "SUPPORT_TLS"
1850 .cindex "OpenSSL" "building Exim with"
1851 .cindex "GnuTLS" "building Exim with"
1852 Exim can be built to support encrypted SMTP connections, using the STARTTLS
1853 command as per RFC 2487. It can also support legacy clients that expect to
1854 start a TLS session immediately on connection to a non-standard port (see the
1855 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1856 line option).
1857
1858 If you want to build Exim with TLS support, you must first install either the
1859 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1860 implementing SSL.
1861
1862 If OpenSSL is installed, you should set
1863 .code
1864 SUPPORT_TLS=yes
1865 TLS_LIBS=-lssl -lcrypto
1866 .endd
1867 in &_Local/Makefile_&. You may also need to specify the locations of the
1868 OpenSSL library and include files. For example:
1869 .code
1870 SUPPORT_TLS=yes
1871 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1872 TLS_INCLUDE=-I/usr/local/openssl/include/
1873 .endd
1874 .cindex "USE_GNUTLS"
1875 If GnuTLS is installed, you should set
1876 .code
1877 SUPPORT_TLS=yes
1878 USE_GNUTLS=yes
1879 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1880 .endd
1881 in &_Local/Makefile_&, and again you may need to specify the locations of the
1882 library and include files. For example:
1883 .code
1884 SUPPORT_TLS=yes
1885 USE_GNUTLS=yes
1886 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1887 TLS_INCLUDE=-I/usr/gnu/include
1888 .endd
1889 You do not need to set TLS_INCLUDE if the relevant directory is already
1890 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1891 given in chapter &<<CHAPTLS>>&.
1892
1893
1894
1895
1896 .section "Use of tcpwrappers" "SECID27"
1897 .new
1898 .cindex "tcpwrappers, building Exim to support"
1899 .cindex "USE_TCP_WRAPPERS"
1900 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1901 .cindex "tcp_wrappers_daemon_name"
1902 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1903 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1904 alternative to Exim's own checking facilities for installations that are
1905 already making use of &'tcpwrappers'& for other purposes. To do this, you
1906 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1907 &_tcpd.h_& to be available at compile time, and also ensure that the library
1908 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1909 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1910 you might have
1911 .code
1912 USE_TCP_WRAPPERS=yes
1913 CFLAGS=-O -I/usr/local/include
1914 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1915 .endd
1916 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1917 files is &"exim"&. For example, the line
1918 .code
1919 exim : LOCAL  192.168.1.  .friendly.domain.example
1920 .endd
1921 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1922 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1923 All other connections are denied. The daemon name used by &'tcpwrappers'&
1924 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
1925 in &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
1926 configure file. Consult the &'tcpwrappers'& documentation for
1927 further details.
1928 .wen
1929
1930
1931 .section "Including support for IPv6" "SECID28"
1932 .cindex "IPv6" "including support for"
1933 Exim contains code for use on systems that have IPv6 support. Setting
1934 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
1935 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
1936 where the IPv6 support is not fully integrated into the normal include and
1937 library files.
1938
1939 Two different types of DNS record for handling IPv6 addresses have been
1940 defined. AAAA records (analogous to A records for IPv4) are in use, and are
1941 currently seen as the mainstream. Another record type called A6 was proposed
1942 as better than AAAA because it had more flexibility. However, it was felt to be
1943 over-complex, and its status was reduced to &"experimental"&. It is not known
1944 if anyone is actually using A6 records. Exim has support for A6 records, but
1945 this is included only if you set &`SUPPORT_A6=YES`& in &_Local/Makefile_&. The
1946 support has not been tested for some time.
1947
1948
1949
1950 .section "The building process" "SECID29"
1951 .cindex "build directory"
1952 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
1953 created, run &'make'& at the top level. It determines the architecture and
1954 operating system types, and creates a build directory if one does not exist.
1955 For example, on a Sun system running Solaris 8, the directory
1956 &_build-SunOS5-5.8-sparc_& is created.
1957 .cindex "symbolic link" "to source files"
1958 Symbolic links to relevant source files are installed in the build directory.
1959
1960 &*Warning*&: The &%-j%& (parallel) flag must not be used with &'make'&; the
1961 building process fails if it is set.
1962
1963 If this is the first time &'make'& has been run, it calls a script that builds
1964 a make file inside the build directory, using the configuration files from the
1965 &_Local_& directory. The new make file is then passed to another instance of
1966 &'make'&. This does the real work, building a number of utility scripts, and
1967 then compiling and linking the binaries for the Exim monitor (if configured), a
1968 number of utility programs, and finally Exim itself. The command &`make
1969 makefile`& can be used to force a rebuild of the make file in the build
1970 directory, should this ever be necessary.
1971
1972 If you have problems building Exim, check for any comments there may be in the
1973 &_README_& file concerning your operating system, and also take a look at the
1974 FAQ, where some common problems are covered.
1975
1976
1977
1978 .section 'Output from &"make"&' "SECID283"
1979 The output produced by the &'make'& process for compile lines is often very
1980 unreadable, because these lines can be very long. For this reason, the normal
1981 output is suppressed by default, and instead output similar to that which
1982 appears when compiling the 2.6 Linux kernel is generated: just a short line for
1983 each module that is being compiled or linked. However, it is still possible to
1984 get the full output, by calling &'make'& like this:
1985 .code
1986 FULLECHO='' make -e
1987 .endd
1988 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
1989 command reflection in &'make'&. When you ask for the full output, it is
1990 given in addition to the short output.
1991
1992
1993
1994 .section "Overriding build-time options for Exim" "SECToverride"
1995 .cindex "build-time options, overriding"
1996 The main make file that is created at the beginning of the building process
1997 consists of the concatenation of a number of files which set configuration
1998 values, followed by a fixed set of &'make'& instructions. If a value is set
1999 more than once, the last setting overrides any previous ones. This provides a
2000 convenient way of overriding defaults. The files that are concatenated are, in
2001 order:
2002 .display
2003 &_OS/Makefile-Default_&
2004 &_OS/Makefile-_&<&'ostype'&>
2005 &_Local/Makefile_&
2006 &_Local/Makefile-_&<&'ostype'&>
2007 &_Local/Makefile-_&<&'archtype'&>
2008 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2009 &_OS/Makefile-Base_&
2010 .endd
2011 .cindex "&_Local/Makefile_&"
2012 .cindex "building Exim" "operating system type"
2013 .cindex "building Exim" "architecture type"
2014 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2015 architecture type. &_Local/Makefile_& is required to exist, and the building
2016 process fails if it is absent. The other three &_Local_& files are optional,
2017 and are often not needed.
2018
2019 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2020 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2021 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2022 values are used, thereby providing a means of forcing particular settings.
2023 Otherwise, the scripts try to get values from the &%uname%& command. If this
2024 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2025 of &'ad hoc'& transformations are then applied, to produce the standard names
2026 that Exim expects. You can run these scripts directly from the shell in order
2027 to find out what values are being used on your system.
2028
2029
2030 &_OS/Makefile-Default_& contains comments about the variables that are set
2031 therein. Some (but not all) are mentioned below. If there is something that
2032 needs changing, review the contents of this file and the contents of the make
2033 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2034 default values are.
2035
2036
2037 .cindex "building Exim" "overriding default settings"
2038 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2039 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2040 need to change the original files. Instead, you should make the changes by
2041 putting the new values in an appropriate &_Local_& file. For example,
2042 .cindex "Tru64-Unix build-time settings"
2043 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2044 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2045 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2046 called with the option &%-std1%&, to make it recognize some of the features of
2047 Standard C that Exim uses. (Most other compilers recognize Standard C by
2048 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2049 containing the lines
2050 .code
2051 CC=cc
2052 CFLAGS=-std1
2053 .endd
2054 If you are compiling for just one operating system, it may be easier to put
2055 these lines directly into &_Local/Makefile_&.
2056
2057 Keeping all your local configuration settings separate from the distributed
2058 files makes it easy to transfer them to new versions of Exim simply by copying
2059 the contents of the &_Local_& directory.
2060
2061
2062 .cindex "NIS lookup type" "including support for"
2063 .cindex "NIS+ lookup type" "including support for"
2064 .cindex "LDAP" "including support for"
2065 .cindex "lookup" "inclusion in binary"
2066 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2067 lookup, but not all systems have these components installed, so the default is
2068 not to include the relevant code in the binary. All the different kinds of file
2069 and database lookup that Exim supports are implemented as separate code modules
2070 which are included only if the relevant compile-time options are set. In the
2071 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2072 .code
2073 LOOKUP_LDAP=yes
2074 LOOKUP_NIS=yes
2075 LOOKUP_NISPLUS=yes
2076 .endd
2077 and similar settings apply to the other lookup types. They are all listed in
2078 &_src/EDITME_&. In many cases the relevant include files and interface
2079 libraries need to be installed before compiling Exim.
2080 .cindex "cdb" "including support for"
2081 However, there are some optional lookup types (such as cdb) for which
2082 the code is entirely contained within Exim, and no external include
2083 files or libraries are required. When a lookup type is not included in the
2084 binary, attempts to configure Exim to use it cause run time configuration
2085 errors.
2086
2087 .cindex "Perl" "including support for"
2088 Exim can be linked with an embedded Perl interpreter, allowing Perl
2089 subroutines to be called during string expansion. To enable this facility,
2090 .code
2091 EXIM_PERL=perl.o
2092 .endd
2093 must be defined in &_Local/Makefile_&. Details of this facility are given in
2094 chapter &<<CHAPperl>>&.
2095
2096 .cindex "X11 libraries, location of"
2097 The location of the X11 libraries is something that varies a lot between
2098 operating systems, and there may be different versions of X11 to cope
2099 with. Exim itself makes no use of X11, but if you are compiling the Exim
2100 monitor, the X11 libraries must be available.
2101 The following three variables are set in &_OS/Makefile-Default_&:
2102 .code
2103 X11=/usr/X11R6
2104 XINCLUDE=-I$(X11)/include
2105 XLFLAGS=-L$(X11)/lib
2106 .endd
2107 These are overridden in some of the operating-system configuration files. For
2108 example, in &_OS/Makefile-SunOS5_& there is
2109 .code
2110 X11=/usr/openwin
2111 XINCLUDE=-I$(X11)/include
2112 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2113 .endd
2114 If you need to override the default setting for your operating system, place a
2115 definition of all three of these variables into your
2116 &_Local/Makefile-<ostype>_& file.
2117
2118 .cindex "EXTRALIBS"
2119 If you need to add any extra libraries to the link steps, these can be put in a
2120 variable called EXTRALIBS, which appears in all the link commands, but by
2121 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2122 command for linking the main Exim binary, and not for any associated utilities.
2123
2124 .cindex "DBM libraries" "configuration for building"
2125 There is also DBMLIB, which appears in the link commands for binaries that
2126 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2127 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2128 binary, and which can be used, for example, to include additional X11
2129 libraries.
2130
2131 .cindex "configuration file" "editing"
2132 The make file copes with rebuilding Exim correctly if any of the configuration
2133 files are edited. However, if an optional configuration file is deleted, it is
2134 necessary to touch the associated non-optional file (that is,
2135 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2136
2137
2138 .section "OS-specific header files" "SECID30"
2139 .cindex "&_os.h_&"
2140 .cindex "building Exim" "OS-specific C header files"
2141 The &_OS_& directory contains a number of files with names of the form
2142 &_os.h-<ostype>_&. These are system-specific C header files that should not
2143 normally need to be changed. There is a list of macro settings that are
2144 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2145 are porting Exim to a new operating system.
2146
2147
2148
2149 .section "Overriding build-time options for the monitor" "SECID31"
2150 .cindex "building Eximon"
2151 A similar process is used for overriding things when building the Exim monitor,
2152 where the files that are involved are
2153 .display
2154 &_OS/eximon.conf-Default_&
2155 &_OS/eximon.conf-_&<&'ostype'&>
2156 &_Local/eximon.conf_&
2157 &_Local/eximon.conf-_&<&'ostype'&>
2158 &_Local/eximon.conf-_&<&'archtype'&>
2159 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2160 .endd
2161 .cindex "&_Local/eximon.conf_&"
2162 As with Exim itself, the final three files need not exist, and in this case the
2163 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2164 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2165 variables of the same name, preceded by EXIMON_. For example, setting
2166 EXIMON_LOG_DEPTH in the environment overrides the value of
2167 LOG_DEPTH at run time.
2168 .ecindex IIDbuex
2169
2170
2171 .section "Installing Exim binaries and scripts" "SECID32"
2172 .cindex "installing Exim"
2173 .cindex "BIN_DIRECTORY"
2174 The command &`make install`& runs the &(exim_install)& script with no
2175 arguments. The script copies binaries and utility scripts into the directory
2176 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2177 .cindex "setuid" "installing Exim with"
2178 The install script copies files only if they are newer than the files they are
2179 going to replace. The Exim binary is required to be owned by root and have the
2180 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2181 install`& as root so that it can set up the Exim binary in this way. However, in
2182 some special situations (for example, if a host is doing no local deliveries)
2183 it may be possible to run Exim without making the binary setuid root (see
2184 chapter &<<CHAPsecurity>>& for details).
2185
2186 .cindex "CONFIGURE_FILE"
2187 Exim's run time configuration file is named by the CONFIGURE_FILE setting
2188 in &_Local/Makefile_&. If this names a single file, and the file does not
2189 exist, the default configuration file &_src/configure.default_& is copied there
2190 by the installation script. If a run time configuration file already exists, it
2191 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2192 alternative files, no default is installed.
2193
2194 .cindex "system aliases file"
2195 .cindex "&_/etc/aliases_&"
2196 One change is made to the default configuration file when it is installed: the
2197 default configuration contains a router that references a system aliases file.
2198 The path to this file is set to the value specified by
2199 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2200 If the system aliases file does not exist, the installation script creates it,
2201 and outputs a comment to the user.
2202
2203 The created file contains no aliases, but it does contain comments about the
2204 aliases a site should normally have. Mail aliases have traditionally been
2205 kept in &_/etc/aliases_&. However, some operating systems are now using
2206 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2207 Exim's configuration if necessary.
2208
2209 The default configuration uses the local host's name as the only local domain,
2210 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2211 running as the local user. System aliases and &_.forward_& files in users' home
2212 directories are supported, but no NIS or NIS+ support is configured. Domains
2213 other than the name of the local host are routed using the DNS, with delivery
2214 over SMTP.
2215
2216 It is possible to install Exim for special purposes (such as building a binary
2217 distribution) in a private part of the file system. You can do this by a
2218 command such as
2219 .code
2220 make DESTDIR=/some/directory/ install
2221 .endd
2222 This has the effect of pre-pending the specified directory to all the file
2223 paths, except the name of the system aliases file that appears in the default
2224 configuration. (If a default alias file is created, its name &'is'& modified.)
2225 For backwards compatibility, ROOT is used if DESTDIR is not set,
2226 but this usage is deprecated.
2227
2228 .cindex "installing Exim" "what is not installed"
2229 Running &'make install'& does not copy the Exim 4 conversion script
2230 &'convert4r4'&. You will probably run this only once if you are
2231 upgrading from Exim 3. None of the documentation files in the &_doc_&
2232 directory are copied, except for the info files when you have set
2233 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2234
2235 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2236 to their names. The Exim binary itself, however, is handled differently. It is
2237 installed under a name that includes the version number and the compile number,
2238 for example &_exim-&version;-1_&. The script then arranges for a symbolic link
2239 called &_exim_& to point to the binary. If you are updating a previous version
2240 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2241 from the directory (as seen by other processes).
2242
2243 .cindex "installing Exim" "testing the script"
2244 If you want to see what the &'make install'& will do before running it for
2245 real, you can pass the &%-n%& option to the installation script by this
2246 command:
2247 .code
2248 make INSTALL_ARG=-n install
2249 .endd
2250 The contents of the variable INSTALL_ARG are passed to the installation
2251 script. You do not need to be root to run this test. Alternatively, you can run
2252 the installation script directly, but this must be from within the build
2253 directory. For example, from the top-level Exim directory you could use this
2254 command:
2255 .code
2256 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2257 .endd
2258 .cindex "installing Exim" "install script options"
2259 There are two other options that can be supplied to the installation script.
2260
2261 .ilist
2262 &%-no_chown%& bypasses the call to change the owner of the installed binary
2263 to root, and the call to make it a setuid binary.
2264 .next
2265 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2266 installed binary.
2267 .endlist
2268
2269 INSTALL_ARG can be used to pass these options to the script. For example:
2270 .code
2271 make INSTALL_ARG=-no_symlink install
2272 .endd
2273 The installation script can also be given arguments specifying which files are
2274 to be copied. For example, to install just the Exim binary, and nothing else,
2275 without creating the symbolic link, you could use:
2276 .code
2277 make INSTALL_ARG='-no_symlink exim' install
2278 .endd
2279
2280
2281
2282 .section "Installing info documentation" "SECTinsinfdoc"
2283 .cindex "installing Exim" "&'info'& documentation"
2284 Not all systems use the GNU &'info'& system for documentation, and for this
2285 reason, the Texinfo source of Exim's documentation is not included in the main
2286 distribution. Instead it is available separately from the ftp site (see section
2287 &<<SECTavail>>&).
2288
2289 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2290 source of the documentation is found in the source tree, running &`make
2291 install`& automatically builds the info files and installs them.
2292
2293
2294
2295 .section "Setting up the spool directory" "SECID33"
2296 .cindex "spool directory" "creating"
2297 When it starts up, Exim tries to create its spool directory if it does not
2298 exist. The Exim uid and gid are used for the owner and group of the spool
2299 directory. Sub-directories are automatically created in the spool directory as
2300 necessary.
2301
2302
2303
2304
2305 .section "Testing" "SECID34"
2306 .cindex "testing" "installation"
2307 Having installed Exim, you can check that the run time configuration file is
2308 syntactically valid by running the following command, which assumes that the
2309 Exim binary directory is within your PATH environment variable:
2310 .code
2311 exim -bV
2312 .endd
2313 If there are any errors in the configuration file, Exim outputs error messages.
2314 Otherwise it outputs the version number and build date,
2315 the DBM library that is being used, and information about which drivers and
2316 other optional code modules are included in the binary.
2317 Some simple routing tests can be done by using the address testing option. For
2318 example,
2319 .display
2320 &`exim -bt`& <&'local username'&>
2321 .endd
2322 should verify that it recognizes a local mailbox, and
2323 .display
2324 &`exim -bt`& <&'remote address'&>
2325 .endd
2326 a remote one. Then try getting it to deliver mail, both locally and remotely.
2327 This can be done by passing messages directly to Exim, without going through a
2328 user agent. For example:
2329 .code
2330 exim -v postmaster@your.domain.example
2331 From: user@your.domain.example
2332 To: postmaster@your.domain.example
2333 Subject: Testing Exim
2334
2335 This is a test message.
2336 ^D
2337 .endd
2338 The &%-v%& option causes Exim to output some verification of what it is doing.
2339 In this case you should see copies of three log lines, one for the message's
2340 arrival, one for its delivery, and one containing &"Completed"&.
2341
2342 .cindex "delivery" "problems with"
2343 If you encounter problems, look at Exim's log files (&'mainlog'& and
2344 &'paniclog'&) to see if there is any relevant information there. Another source
2345 of information is running Exim with debugging turned on, by specifying the
2346 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2347 with debugging turned on by a command of the form
2348 .display
2349 &`exim -d -M`& <&'exim-message-id'&>
2350 .endd
2351 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2352 produces rather a lot of output, but you can cut this down to specific areas.
2353 For example, if you use &%-d-all+route%& only the debugging information
2354 relevant to routing is included. (See the &%-d%& option in chapter
2355 &<<CHAPcommandline>>& for more details.)
2356
2357 .cindex '&"sticky"& bit'
2358 .cindex "lock files"
2359 One specific problem that has shown up on some sites is the inability to do
2360 local deliveries into a shared mailbox directory, because it does not have the
2361 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2362 writing to a mailbox file, and if it cannot create the lock file, the delivery
2363 is deferred. You can get round this either by setting the &"sticky bit"& on the
2364 directory, or by setting a specific group for local deliveries and allowing
2365 that group to create files in the directory (see the comments above the
2366 &(local_delivery)& transport in the default configuration file). Another
2367 approach is to configure Exim not to use lock files, but just to rely on
2368 &[fcntl()]& locking instead. However, you should do this only if all user
2369 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2370 see chapter &<<CHAPappendfile>>&.
2371
2372 One thing that cannot be tested on a system that is already running an MTA is
2373 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2374 &%-oX%& option can be used to run an Exim daemon that listens on some other
2375 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2376 &'exim_checkaccess'& utility can be used to check out policy controls on
2377 incoming SMTP mail.
2378
2379 Testing a new version on a system that is already running Exim can most easily
2380 be done by building a binary with a different CONFIGURE_FILE setting. From
2381 within the run time configuration, all other file and directory names
2382 that Exim uses can be altered, in order to keep it entirely clear of the
2383 production version.
2384
2385
2386 .section "Replacing another MTA with Exim" "SECID35"
2387 .cindex "replacing another MTA"
2388 Building and installing Exim for the first time does not of itself put it in
2389 general use. The name by which the system's MTA is called by mail user agents
2390 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2391 operating system), and it is necessary to make this name point to the &'exim'&
2392 binary in order to get the user agents to pass messages to Exim. This is
2393 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2394 or &_/usr/lib/sendmail_&
2395 .cindex "symbolic link" "to &'exim'& binary"
2396 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2397 privilege and executable status from the old MTA. It is then necessary to stop
2398 and restart the mailer daemon, if one is running.
2399
2400 .cindex "FreeBSD, MTA indirection"
2401 .cindex "&_/etc/mail/mailer.conf_&"
2402 Some operating systems have introduced alternative ways of switching MTAs. For
2403 example, if you are running FreeBSD, you need to edit the file
2404 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2405 described. A typical example of the contents of this file for running Exim is
2406 as follows:
2407 .code
2408 sendmail            /usr/exim/bin/exim
2409 send-mail           /usr/exim/bin/exim
2410 mailq               /usr/exim/bin/exim -bp
2411 newaliases          /usr/bin/true
2412 .endd
2413 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2414 your Exim installation is &"live"&. Check it by sending a message from your
2415 favourite user agent.
2416
2417 You should consider what to tell your users about the change of MTA. Exim may
2418 have different capabilities to what was previously running, and there are
2419 various operational differences such as the text of messages produced by
2420 command line options and in bounce messages. If you allow your users to make
2421 use of Exim's filtering capabilities, you should make the document entitled
2422 &'Exim's interface to mail filtering'& available to them.
2423
2424
2425
2426 .section "Upgrading Exim" "SECID36"
2427 .cindex "upgrading Exim"
2428 If you are already running Exim on your host, building and installing a new
2429 version automatically makes it available to MUAs, or any other programs that
2430 call the MTA directly. However, if you are running an Exim daemon, you do need
2431 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2432 new binary. You do not need to stop processing mail in order to install a new
2433 version of Exim. The install script does not modify an existing runtime
2434 configuration file.
2435
2436
2437
2438
2439 .section "Stopping the Exim daemon on Solaris" "SECID37"
2440 .cindex "Solaris" "stopping Exim on"
2441 The standard command for stopping the mailer daemon on Solaris is
2442 .code
2443 /etc/init.d/sendmail stop
2444 .endd
2445 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2446 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2447 for the text &"sendmail"&; this is not present because the actual program name
2448 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2449 solution is to replace the line that finds the process id with something like
2450 .code
2451 pid=`cat /var/spool/exim/exim-daemon.pid`
2452 .endd
2453 to obtain the daemon's pid directly from the file that Exim saves it in.
2454
2455 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2456 still be received from local processes, and if automatic delivery is configured
2457 (the normal case), deliveries will still occur.
2458
2459
2460
2461
2462 . ////////////////////////////////////////////////////////////////////////////
2463 . ////////////////////////////////////////////////////////////////////////////
2464
2465 .chapter "The Exim command line" "CHAPcommandline"
2466 .scindex IIDclo1 "command line" "options"
2467 .scindex IIDclo2 "options" "command line"
2468 Exim's command line takes the standard Unix form of a sequence of options,
2469 each starting with a hyphen character, followed by a number of arguments. The
2470 options are compatible with the main options of Sendmail, and there are also
2471 some additional options, some of which are compatible with Smail 3. Certain
2472 combinations of options do not make sense, and provoke an error if used.
2473 The form of the arguments depends on which options are set.
2474
2475
2476 .section "Setting options by program name" "SECID38"
2477 .cindex "&'mailq'&"
2478 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2479 were present before any other options.
2480 The &%-bp%& option requests a listing of the contents of the mail queue on the
2481 standard output.
2482 This feature is for compatibility with some systems that contain a command of
2483 that name in one of the standard libraries, symbolically linked to
2484 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2485
2486 .cindex "&'rsmtp'&"
2487 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2488 were present before any other options, for compatibility with Smail. The
2489 &%-bS%& option is used for reading in a number of messages in batched SMTP
2490 format.
2491
2492 .cindex "&'rmail'&"
2493 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2494 &%-oee%& options were present before any other options, for compatibility with
2495 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2496
2497 .cindex "&'runq'&"
2498 .cindex "queue runner"
2499 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2500 were present before any other options, for compatibility with Smail. The &%-q%&
2501 option causes a single queue runner process to be started.
2502
2503 .cindex "&'newaliases'&"
2504 .cindex "alias file" "building"
2505 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2506 If Exim is called under the name &'newaliases'& it behaves as if the option
2507 &%-bi%& were present before any other options, for compatibility with Sendmail.
2508 This option is used for rebuilding Sendmail's alias file. Exim does not have
2509 the concept of a single alias file, but can be configured to run a given
2510 command if called with the &%-bi%& option.
2511
2512
2513 .section "Trusted and admin users" "SECTtrustedadmin"
2514 Some Exim options are available only to &'trusted users'& and others are
2515 available only to &'admin users'&. In the description below, the phrases &"Exim
2516 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2517 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2518 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2519
2520 .ilist
2521 .cindex "trusted users" "definition of"
2522 .cindex "user" "trusted definition of"
2523 The trusted users are root, the Exim user, any user listed in the
2524 &%trusted_users%& configuration option, and any user whose current group or any
2525 supplementary group is one of those listed in the &%trusted_groups%&
2526 configuration option. Note that the Exim group is not automatically trusted.
2527
2528 .cindex '&"From"& line'
2529 .cindex "envelope sender"
2530 Trusted users are always permitted to use the &%-f%& option or a leading
2531 &"From&~"& line to specify the envelope sender of a message that is passed to
2532 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2533 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2534 users to set envelope senders.
2535
2536 .cindex "&'From:'& header line"
2537 .cindex "&'Sender:'& header line"
2538 For a trusted user, there is never any check on the contents of the &'From:'&
2539 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2540 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2541
2542 Trusted users may also specify a host name, host address, interface address,
2543 protocol name, ident value, and authentication data when submitting a message
2544 locally. Thus, they are able to insert messages into Exim's queue locally that
2545 have the characteristics of messages received from a remote host. Untrusted
2546 users may in some circumstances use &%-f%&, but can never set the other values
2547 that are available to trusted users.
2548 .next
2549 .cindex "user" "admin definition of"
2550 .cindex "admin user" "definition of"
2551 The admin users are root, the Exim user, and any user that is a member of the
2552 Exim group or of any group listed in the &%admin_groups%& configuration option.
2553 The current group does not have to be one of these groups.
2554
2555 Admin users are permitted to list the queue, and to carry out certain
2556 operations on messages, for example, to force delivery failures. It is also
2557 necessary to be an admin user in order to see the full information provided by
2558 the Exim monitor, and full debugging output.
2559
2560 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2561 Exim to attempt delivery of messages on its queue is restricted to admin users.
2562 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2563 option false (that is, specifying &%no_prod_requires_admin%&).
2564
2565 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2566 is restricted to admin users unless &%queue_list_requires_admin%& is set
2567 false.
2568 .endlist
2569
2570
2571 &*Warning*&: If you configure your system so that admin users are able to
2572 edit Exim's configuration file, you are giving those users an easy way of
2573 getting root. There is further discussion of this issue at the start of chapter
2574 &<<CHAPconf>>&.
2575
2576
2577
2578
2579 .section "Command line options" "SECID39"
2580 Exim's command line options are described in alphabetical order below. If none
2581 of the options that specifies a specific action (such as starting the daemon or
2582 a queue runner, or testing an address, or receiving a message in a specific
2583 format, or listing the queue) are present, and there is at least one argument
2584 on the command line, &%-bm%& (accept a local message on the standard input,
2585 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2586 outputs a brief message about itself and exits.
2587
2588 . ////////////////////////////////////////////////////////////////////////////
2589 . Insert a stylized XML comment here, to identify the start of the command line
2590 . options. This is for the benefit of the Perl script that automatically
2591 . creates a man page for the options.
2592 . ////////////////////////////////////////////////////////////////////////////
2593
2594 .literal xml
2595 <!-- === Start of command line options === -->
2596 .literal off
2597
2598
2599 .vlist
2600 .vitem &%--%&
2601 .oindex "--"
2602 .cindex "options" "command line; terminating"
2603 This is a pseudo-option whose only purpose is to terminate the options and
2604 therefore to cause subsequent command line items to be treated as arguments
2605 rather than options, even if they begin with hyphens.
2606
2607 .vitem &%--help%&
2608 .oindex "&%--help%&"
2609 This option causes Exim to output a few sentences stating what it is.
2610 The same output is generated if the Exim binary is called with no options and
2611 no arguments.
2612
2613 .new
2614 .vitem &%--version%&
2615 .oindex "&%--version%&"
2616 This option is an alias for &%-bV%& and causes version information to be
2617 displayed.
2618 .wen
2619
2620 .vitem &%-B%&<&'type'&>
2621 .oindex "&%-B%&"
2622 .cindex "8-bit characters"
2623 .cindex "Sendmail compatibility" "8-bit characters"
2624 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2625 clean; it ignores this option.
2626
2627 .vitem &%-bd%&
2628 .oindex "&%-bd%&"
2629 .cindex "daemon"
2630 .cindex "SMTP" "listener"
2631 .cindex "queue runner"
2632 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2633 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2634 that the daemon should also initiate periodic queue runs.
2635
2636 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2637 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2638 disconnect from the controlling terminal. When running this way, it can be
2639 stopped by pressing ctrl-C.
2640
2641 By default, Exim listens for incoming connections to the standard SMTP port on
2642 all the host's running interfaces. However, it is possible to listen on other
2643 ports, on multiple ports, and only on specific interfaces. Chapter
2644 &<<CHAPinterfaces>>& contains a description of the options that control this.
2645
2646 When a listening daemon
2647 .cindex "daemon" "process id (pid)"
2648 .cindex "pid (process id)" "of daemon"
2649 is started without the use of &%-oX%& (that is, without overriding the normal
2650 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2651 in Exim's spool directory. This location can be overridden by setting
2652 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2653 running as root.
2654
2655 When &%-oX%& is used on the command line to start a listening daemon, the
2656 process id is not written to the normal pid file path. However, &%-oP%& can be
2657 used to specify a path on the command line if a pid file is required.
2658
2659 The SIGHUP signal
2660 .cindex "SIGHUP"
2661 .cindex "daemon" "restarting"
2662 can be used to cause the daemon to re-execute itself. This should be done
2663 whenever Exim's configuration file, or any file that is incorporated into it by
2664 means of the &%.include%& facility, is changed, and also whenever a new version
2665 of Exim is installed. It is not necessary to do this when other files that are
2666 referenced from the configuration (for example, alias files) are changed,
2667 because these are reread each time they are used.
2668
2669 .vitem &%-bdf%&
2670 .oindex "&%-bdf%&"
2671 This option has the same effect as &%-bd%& except that it never disconnects
2672 from the controlling terminal, even when no debugging is specified.
2673
2674 .vitem &%-be%&
2675 .oindex "&%-be%&"
2676 .cindex "testing" "string expansion"
2677 .cindex "expansion" "testing"
2678 Run Exim in expansion testing mode. Exim discards its root privilege, to
2679 prevent ordinary users from using this mode to read otherwise inaccessible
2680 files. If no arguments are given, Exim runs interactively, prompting for lines
2681 of data. Otherwise, it processes each argument in turn.
2682
2683 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2684 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2685 used without command line arguments. If successful, it uses the &[readline()]&
2686 function, which provides extensive line-editing facilities, for reading the
2687 test data. A line history is supported.
2688
2689 Long expansion expressions can be split over several lines by using backslash
2690 continuations. As in Exim's run time configuration, white space at the start of
2691 continuation lines is ignored. Each argument or data line is passed through the
2692 string expansion mechanism, and the result is output. Variable values from the
2693 configuration file (for example, &$qualify_domain$&) are available, but no
2694 message-specific values (such as &$sender_domain$&) are set, because no message
2695 is being processed (but see &%-bem%& and &%-Mset%&).
2696
2697 &*Note*&: If you use this mechanism to test lookups, and you change the data
2698 files or databases you are using, you must exit and restart Exim before trying
2699 the same lookup again. Otherwise, because each Exim process caches the results
2700 of lookups, you will just get the same result as before.
2701
2702 .vitem &%-bem%&&~<&'filename'&>
2703 .oindex "&%-bem%&"
2704 .cindex "testing" "string expansion"
2705 .cindex "expansion" "testing"
2706 This option operates like &%-be%& except that it must be followed by the name
2707 of a file. For example:
2708 .code
2709 exim -bem /tmp/testmessage
2710 .endd
2711 The file is read as a message (as if receiving a locally-submitted non-SMTP
2712 message) before any of the test expansions are done. Thus, message-specific
2713 variables such as &$message_size$& and &$header_from:$& are available. However,
2714 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2715 recipients are read from the headers in the normal way, and are shown in the
2716 &$recipients$& variable. Note that recipients cannot be given on the command
2717 line, because further arguments are taken as strings to expand (just like
2718 &%-be%&).
2719
2720 .vitem &%-bF%&&~<&'filename'&>
2721 .oindex "&%-bF%&"
2722 .cindex "system filter" "testing"
2723 .cindex "testing" "system filter"
2724 This option is the same as &%-bf%& except that it assumes that the filter being
2725 tested is a system filter. The additional commands that are available only in
2726 system filters are recognized.
2727
2728 .vitem &%-bf%&&~<&'filename'&>
2729 .oindex "&%-bf%&"
2730 .cindex "filter" "testing"
2731 .cindex "testing" "filter file"
2732 .cindex "forward file" "testing"
2733 .cindex "testing" "forward file"
2734 .cindex "Sieve filter" "testing"
2735 This option runs Exim in user filter testing mode; the file is the filter file
2736 to be tested, and a test message must be supplied on the standard input. If
2737 there are no message-dependent tests in the filter, an empty file can be
2738 supplied.
2739
2740 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2741 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2742 filter and a user filter in the same run. For example:
2743 .code
2744 exim -bF /system/filter -bf /user/filter </test/message
2745 .endd
2746 This is helpful when the system filter adds header lines or sets filter
2747 variables that are used by the user filter.
2748
2749 If the test filter file does not begin with one of the special lines
2750 .code
2751 # Exim filter
2752 # Sieve filter
2753 .endd
2754 it is taken to be a normal &_.forward_& file, and is tested for validity under
2755 that interpretation. See sections &<<SECTitenonfilred>>& to
2756 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2757 redirection lists.
2758
2759 The result of an Exim command that uses &%-bf%&, provided no errors are
2760 detected, is a list of the actions that Exim would try to take if presented
2761 with the message for real. More details of filter testing are given in the
2762 separate document entitled &'Exim's interfaces to mail filtering'&.
2763
2764 When testing a filter file,
2765 .cindex "&""From""& line"
2766 .cindex "envelope sender"
2767 .oindex "&%-f%&" "for filter testing"
2768 the envelope sender can be set by the &%-f%& option,
2769 or by a &"From&~"& line at the start of the test message. Various parameters
2770 that would normally be taken from the envelope recipient address of the message
2771 can be set by means of additional command line options (see the next four
2772 options).
2773
2774 .vitem &%-bfd%&&~<&'domain'&>
2775 .oindex "&%-bfd%&"
2776 .vindex "&$qualify_domain$&"
2777 This sets the domain of the recipient address when a filter file is being
2778 tested by means of the &%-bf%& option. The default is the value of
2779 &$qualify_domain$&.
2780
2781 .vitem &%-bfl%&&~<&'local&~part'&>
2782 .oindex "&%-bfl%&"
2783 This sets the local part of the recipient address when a filter file is being
2784 tested by means of the &%-bf%& option. The default is the username of the
2785 process that calls Exim. A local part should be specified with any prefix or
2786 suffix stripped, because that is how it appears to the filter when a message is
2787 actually being delivered.
2788
2789 .vitem &%-bfp%&&~<&'prefix'&>
2790 .oindex "&%-bfp%&"
2791 This sets the prefix of the local part of the recipient address when a filter
2792 file is being tested by means of the &%-bf%& option. The default is an empty
2793 prefix.
2794
2795 .vitem &%-bfs%&&~<&'suffix'&>
2796 .oindex "&%-bfs%&"
2797 This sets the suffix of the local part of the recipient address when a filter
2798 file is being tested by means of the &%-bf%& option. The default is an empty
2799 suffix.
2800
2801 .vitem &%-bh%&&~<&'IP&~address'&>
2802 .oindex "&%-bh%&"
2803 .cindex "testing" "incoming SMTP"
2804 .cindex "SMTP" "testing incoming"
2805 .cindex "testing" "relay control"
2806 .cindex "relaying" "testing configuration"
2807 .cindex "policy control" "testing"
2808 .cindex "debugging" "&%-bh%& option"
2809 This option runs a fake SMTP session as if from the given IP address, using the
2810 standard input and output. The IP address may include a port number at the end,
2811 after a full stop. For example:
2812 .code
2813 exim -bh 10.9.8.7.1234
2814 exim -bh fe80::a00:20ff:fe86:a061.5678
2815 .endd
2816 When an IPv6 address is given, it is converted into canonical form. In the case
2817 of the second example above, the value of &$sender_host_address$& after
2818 conversion to the canonical form is
2819 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2820
2821 Comments as to what is going on are written to the standard error file. These
2822 include lines beginning with &"LOG"& for anything that would have been logged.
2823 This facility is provided for testing configuration options for incoming
2824 messages, to make sure they implement the required policy. For example, you can
2825 test your relay controls using &%-bh%&.
2826
2827 &*Warning 1*&:
2828 .cindex "RFC 1413"
2829 You can test features of the configuration that rely on ident (RFC 1413)
2830 information by using the &%-oMt%& option. However, Exim cannot actually perform
2831 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2832 connection.
2833
2834 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2835 are also skipped when testing using &%-bh%&. If you want these callouts to
2836 occur, use &%-bhc%& instead.
2837
2838 Messages supplied during the testing session are discarded, and nothing is
2839 written to any of the real log files. There may be pauses when DNS (and other)
2840 lookups are taking place, and of course these may time out. The &%-oMi%& option
2841 can be used to specify a specific IP interface and port if this is important,
2842 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2843 session were authenticated.
2844
2845 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2846 output just states whether a given recipient address from a given host is
2847 acceptable or not. See section &<<SECTcheckaccess>>&.
2848
2849 Features such as authentication and encryption, where the client input is not
2850 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2851 specialized SMTP test program such as
2852 &url(http://jetmore.org/john/code/#swaks,swaks).
2853
2854 .vitem &%-bhc%&&~<&'IP&~address'&>
2855 .oindex "&%-bhc%&"
2856 This option operates in the same way as &%-bh%&, except that address
2857 verification callouts are performed if required. This includes consulting and
2858 updating the callout cache database.
2859
2860 .vitem &%-bi%&
2861 .oindex "&%-bi%&"
2862 .cindex "alias file" "building"
2863 .cindex "building alias file"
2864 .cindex "Sendmail compatibility" "&%-bi%& option"
2865 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2866 Exim does not have the concept of a single alias file, and so it cannot mimic
2867 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2868 tend to appear in various scripts such as NIS make files, so the option must be
2869 recognized.
2870
2871 If &%-bi%& is encountered, the command specified by the &%bi_command%&
2872 configuration option is run, under the uid and gid of the caller of Exim. If
2873 the &%-oA%& option is used, its value is passed to the command as an argument.
2874 The command set by &%bi_command%& may not contain arguments. The command can
2875 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
2876 if this is required. If the &%bi_command%& option is not set, calling Exim with
2877 &%-bi%& is a no-op.
2878
2879 .vitem &%-bm%&
2880 .oindex "&%-bm%&"
2881 .cindex "local message reception"
2882 This option runs an Exim receiving process that accepts an incoming,
2883 locally-generated message on the current input. The recipients are given as the
2884 command arguments (except when &%-t%& is also present &-- see below). Each
2885 argument can be a comma-separated list of RFC 2822 addresses. This is the
2886 default option for selecting the overall action of an Exim call; it is assumed
2887 if no other conflicting option is present.
2888
2889 If any addresses in the message are unqualified (have no domain), they are
2890 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
2891 options, as appropriate. The &%-bnq%& option (see below) provides a way of
2892 suppressing this for special cases.
2893
2894 Policy checks on the contents of local messages can be enforced by means of
2895 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
2896
2897 .cindex "return code" "for &%-bm%&"
2898 The return code is zero if the message is successfully accepted. Otherwise, the
2899 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
2900
2901 The format
2902 .cindex "message" "format"
2903 .cindex "format" "message"
2904 .cindex "&""From""& line"
2905 .cindex "UUCP" "&""From""& line"
2906 .cindex "Sendmail compatibility" "&""From""& line"
2907 of the message must be as defined in RFC 2822, except that, for
2908 compatibility with Sendmail and Smail, a line in one of the forms
2909 .code
2910 From sender Fri Jan  5 12:55 GMT 1997
2911 From sender Fri, 5 Jan 97 12:55:01
2912 .endd
2913 (with the weekday optional, and possibly with additional text after the date)
2914 is permitted to appear at the start of the message. There appears to be no
2915 authoritative specification of the format of this line. Exim recognizes it by
2916 matching against the regular expression defined by the &%uucp_from_pattern%&
2917 option, which can be changed if necessary.
2918
2919 .oindex "&%-f%&" "overriding &""From""& line"
2920 The specified sender is treated as if it were given as the argument to the
2921 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
2922 preference to the address taken from the message. The caller of Exim must be a
2923 trusted user for the sender of a message to be set in this way.
2924
2925 .vitem &%-bnq%&
2926 .oindex "&%-bnq%&"
2927 .cindex "address qualification, suppressing"
2928 By default, Exim automatically qualifies unqualified addresses (those
2929 without domains) that appear in messages that are submitted locally (that
2930 is, not over TCP/IP). This qualification applies both to addresses in
2931 envelopes, and addresses in header lines. Sender addresses are qualified using
2932 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
2933 defaults to the value of &%qualify_domain%&).
2934
2935 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
2936 being used to re-submit messages that originally came from remote hosts after
2937 content scanning, you probably do not want to qualify unqualified addresses in
2938 header lines. (Such lines will be present only if you have not enabled a header
2939 syntax check in the appropriate ACL.)
2940
2941 The &%-bnq%& option suppresses all qualification of unqualified addresses in
2942 messages that originate on the local host. When this is used, unqualified
2943 addresses in the envelope provoke errors (causing message rejection) and
2944 unqualified addresses in header lines are left alone.
2945
2946
2947 .vitem &%-bP%&
2948 .oindex "&%-bP%&"
2949 .cindex "configuration options" "extracting"
2950 .cindex "options" "configuration &-- extracting"
2951 If this option is given with no arguments, it causes the values of all Exim's
2952 main configuration options to be written to the standard output. The values
2953 of one or more specific options can be requested by giving their names as
2954 arguments, for example:
2955 .code
2956 exim -bP qualify_domain hold_domains
2957 .endd
2958 .cindex "hiding configuration option values"
2959 .cindex "configuration options" "hiding value of"
2960 .cindex "options" "hiding value of"
2961 However, any option setting that is preceded by the word &"hide"& in the
2962 configuration file is not shown in full, except to an admin user. For other
2963 users, the output is as in this example:
2964 .code
2965 mysql_servers = <value not displayable>
2966 .endd
2967 If &%configure_file%& is given as an argument, the name of the run time
2968 configuration file is output.
2969 If a list of configuration files was supplied, the value that is output here
2970 is the name of the file that was actually used.
2971
2972 .cindex "daemon" "process id (pid)"
2973 .cindex "pid (process id)" "of daemon"
2974 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
2975 directories where log files and daemon pid files are written are output,
2976 respectively. If these values are unset, log files are written in a
2977 sub-directory of the spool directory called &%log%&, and the pid file is
2978 written directly into the spool directory.
2979
2980 If &%-bP%& is followed by a name preceded by &`+`&, for example,
2981 .code
2982 exim -bP +local_domains
2983 .endd
2984 it searches for a matching named list of any type (domain, host, address, or
2985 local part) and outputs what it finds.
2986
2987 .cindex "options" "router &-- extracting"
2988 .cindex "options" "transport &-- extracting"
2989 .cindex "options" "authenticator &-- extracting"
2990 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
2991 followed by the name of an appropriate driver instance, the option settings for
2992 that driver are output. For example:
2993 .code
2994 exim -bP transport local_delivery
2995 .endd
2996 The generic driver options are output first, followed by the driver's private
2997 options. A list of the names of drivers of a particular type can be obtained by
2998 using one of the words &%router_list%&, &%transport_list%&, or
2999 &%authenticator_list%&, and a complete list of all drivers with their option
3000 settings can be obtained by using &%routers%&, &%transports%&, or
3001 &%authenticators%&.
3002
3003 .cindex "options" "macro &-- extracting"
3004 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3005 are available, similarly to the drivers.  Because macros are sometimes used
3006 for storing passwords, this option is restricted.
3007 The output format is one item per line.
3008
3009 .vitem &%-bp%&
3010 .oindex "&%-bp%&"
3011 .cindex "queue" "listing messages on"
3012 .cindex "listing" "messages on the queue"
3013 This option requests a listing of the contents of the mail queue on the
3014 standard output. If the &%-bp%& option is followed by a list of message ids,
3015 just those messages are listed. By default, this option can be used only by an
3016 admin user. However, the &%queue_list_requires_admin%& option can be set false
3017 to allow any user to see the queue.
3018
3019 Each message on the queue is displayed as in the following example:
3020 .code
3021 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3022           red.king@looking-glass.fict.example
3023           <other addresses>
3024 .endd
3025 .cindex "message" "size in queue listing"
3026 .cindex "size" "of message"
3027 The first line contains the length of time the message has been on the queue
3028 (in this case 25 minutes), the size of the message (2.9K), the unique local
3029 identifier for the message, and the message sender, as contained in the
3030 envelope. For bounce messages, the sender address is empty, and appears as
3031 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3032 the default sender address, the user's login name is shown in parentheses
3033 before the sender address.
3034
3035 .cindex "frozen messages" "in queue listing"
3036 If the message is frozen (attempts to deliver it are suspended) then the text
3037 &"*** frozen ***"& is displayed at the end of this line.
3038
3039 The recipients of the message (taken from the envelope, not the headers) are
3040 displayed on subsequent lines. Those addresses to which the message has already
3041 been delivered are marked with the letter D. If an original address gets
3042 expanded into several addresses via an alias or forward file, the original is
3043 displayed with a D only when deliveries for all of its child addresses are
3044 complete.
3045
3046
3047 .vitem &%-bpa%&
3048 .oindex "&%-bpa%&"
3049 This option operates like &%-bp%&, but in addition it shows delivered addresses
3050 that were generated from the original top level address(es) in each message by
3051 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3052 of just &"D"&.
3053
3054
3055 .vitem &%-bpc%&
3056 .oindex "&%-bpc%&"
3057 .cindex "queue" "count of messages on"
3058 This option counts the number of messages on the queue, and writes the total
3059 to the standard output. It is restricted to admin users, unless
3060 &%queue_list_requires_admin%& is set false.
3061
3062
3063 .vitem &%-bpr%&
3064 .oindex "&%-bpr%&"
3065 This option operates like &%-bp%&, but the output is not sorted into
3066 chronological order of message arrival. This can speed it up when there are
3067 lots of messages on the queue, and is particularly useful if the output is
3068 going to be post-processed in a way that doesn't need the sorting.
3069
3070 .vitem &%-bpra%&
3071 .oindex "&%-bpra%&"
3072 This option is a combination of &%-bpr%& and &%-bpa%&.
3073
3074 .vitem &%-bpru%&
3075 .oindex "&%-bpru%&"
3076 This option is a combination of &%-bpr%& and &%-bpu%&.
3077
3078
3079 .vitem &%-bpu%&
3080 .oindex "&%-bpu%&"
3081 This option operates like &%-bp%& but shows only undelivered top-level
3082 addresses for each message displayed. Addresses generated by aliasing or
3083 forwarding are not shown, unless the message was deferred after processing by a
3084 router with the &%one_time%& option set.
3085
3086
3087 .vitem &%-brt%&
3088 .oindex "&%-brt%&"
3089 .cindex "testing" "retry configuration"
3090 .cindex "retry" "configuration testing"
3091 This option is for testing retry rules, and it must be followed by up to three
3092 arguments. It causes Exim to look for a retry rule that matches the values
3093 and to write it to the standard output. For example:
3094 .code
3095 exim -brt bach.comp.mus.example
3096 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3097 .endd
3098 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3099 argument, which is required, can be a complete address in the form
3100 &'local_part@domain'&, or it can be just a domain name. If the second argument
3101 contains a dot, it is interpreted as an optional second domain name; if no
3102 retry rule is found for the first argument, the second is tried. This ties in
3103 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3104 rule is found that matches the host, one that matches the mail domain is
3105 sought. Finally, an argument that is the name of a specific delivery error, as
3106 used in setting up retry rules, can be given. For example:
3107 .code
3108 exim -brt haydn.comp.mus.example quota_3d
3109 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3110 .endd
3111
3112 .vitem &%-brw%&
3113 .oindex "&%-brw%&"
3114 .cindex "testing" "rewriting"
3115 .cindex "rewriting" "testing"
3116 This option is for testing address rewriting rules, and it must be followed by
3117 a single argument, consisting of either a local part without a domain, or a
3118 complete address with a fully qualified domain. Exim outputs how this address
3119 would be rewritten for each possible place it might appear. See chapter
3120 &<<CHAPrewrite>>& for further details.
3121
3122 .vitem &%-bS%&
3123 .oindex "&%-bS%&"
3124 .cindex "SMTP" "batched incoming"
3125 .cindex "batched SMTP input"
3126 This option is used for batched SMTP input, which is an alternative interface
3127 for non-interactive local message submission. A number of messages can be
3128 submitted in a single run. However, despite its name, this is not really SMTP
3129 input. Exim reads each message's envelope from SMTP commands on the standard
3130 input, but generates no responses. If the caller is trusted, or
3131 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3132 believed; otherwise the sender is always the caller of Exim.
3133
3134 The message itself is read from the standard input, in SMTP format (leading
3135 dots doubled), terminated by a line containing just a single dot. An error is
3136 provoked if the terminating dot is missing. A further message may then follow.
3137
3138 As for other local message submissions, the contents of incoming batch SMTP
3139 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3140 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3141 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3142
3143 Some other SMTP commands are recognized in the input. HELO and EHLO act
3144 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3145 QUIT quits, ignoring the rest of the standard input.
3146
3147 .cindex "return code" "for &%-bS%&"
3148 If any error is encountered, reports are written to the standard output and
3149 error streams, and Exim gives up immediately. The return code is 0 if no error
3150 was detected; it is 1 if one or more messages were accepted before the error
3151 was detected; otherwise it is 2.
3152
3153 More details of input using batched SMTP are given in section
3154 &<<SECTincomingbatchedSMTP>>&.
3155
3156 .vitem &%-bs%&
3157 .oindex "&%-bs%&"
3158 .cindex "SMTP" "local input"
3159 .cindex "local SMTP input"
3160 This option causes Exim to accept one or more messages by reading SMTP commands
3161 on the standard input, and producing SMTP replies on the standard output. SMTP
3162 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3163 Some user agents use this interface as a way of passing locally-generated
3164 messages to the MTA.
3165
3166 In
3167 .cindex "sender" "source of"
3168 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3169 set, the senders of messages are taken from the SMTP MAIL commands.
3170 Otherwise the content of these commands is ignored and the sender is set up as
3171 the calling user. Unqualified addresses are automatically qualified using
3172 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3173 &%-bnq%& option is used.
3174
3175 .cindex "inetd"
3176 The
3177 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3178 using a listening daemon. Exim can distinguish the two cases by checking
3179 whether the standard input is a TCP/IP socket. When Exim is called from
3180 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3181 above concerning senders and qualification do not apply. In this situation,
3182 Exim behaves in exactly the same way as it does when receiving a message via
3183 the listening daemon.
3184
3185 .new
3186 .vitem &%-bmalware%&&~<&'filename'&>
3187 .oindex "&%-bmalware%&"
3188 .cindex "testing", "malware"
3189 .cindex "malware scan test"
3190 This debugging option causes Exim to scan the given file,
3191 using the malware scanning framework.  The option of &%av_scanner%& influences
3192 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3193 the expansion should have defaults which apply to this invocation.  ACLs are
3194 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3195 will never be populated and &%-bmalware%& will fail.
3196
3197 Exim will have changed working directory before resolving the filename, so
3198 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3199 user when it tries to open the file, rather than as the invoking user.
3200 This option requires admin privileges.
3201
3202 The &%-bmalware%& option will not be extended to be more generally useful,
3203 there are better tools for file-scanning.  This option exists to help
3204 administrators verify their Exim and AV scanner configuration.
3205 .wen
3206
3207 .vitem &%-bt%&
3208 .oindex "&%-bt%&"
3209 .cindex "testing" "addresses"
3210 .cindex "address" "testing"
3211 This option runs Exim in address testing mode, in which each argument is taken
3212 as a recipient address to be tested for deliverability. The results are
3213 written to the standard output. If a test fails, and the caller is not an admin
3214 user, no details of the failure are output, because these might contain
3215 sensitive information such as usernames and passwords for database lookups.
3216
3217 If no arguments are given, Exim runs in an interactive manner, prompting with a
3218 right angle bracket for addresses to be tested.
3219
3220 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3221 &[readline()]& function, because it is running as &'root'& and there are
3222 security issues.
3223
3224 Each address is handled as if it were the recipient address of a message
3225 (compare the &%-bv%& option). It is passed to the routers and the result is
3226 written to the standard output. However, any router that has
3227 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3228 genuine routing tests if your first router passes everything to a scanner
3229 program.
3230
3231 .cindex "return code" "for &%-bt%&"
3232 The return code is 2 if any address failed outright; it is 1 if no address
3233 failed outright but at least one could not be resolved for some reason. Return
3234 code 0 is given only when all addresses succeed.
3235
3236 .cindex "duplicate addresses"
3237 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3238 addresses after routing is complete, so that only one delivery takes place.
3239 This does not happen when testing with &%-bt%&; the full results of routing are
3240 always shown.
3241
3242 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3243 routers in the configuration makes any tests on the sender address of a
3244 message,
3245 .oindex "&%-f%&" "for address testing"
3246 you can use the &%-f%& option to set an appropriate sender when running
3247 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3248 default qualifying domain. However, if you have set up (for example) routers
3249 whose behaviour depends on the contents of an incoming message, you cannot test
3250 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3251 doing such tests.
3252
3253 .vitem &%-bV%&
3254 .oindex "&%-bV%&"
3255 .cindex "version number of Exim"
3256 This option causes Exim to write the current version number, compilation
3257 number, and compilation date of the &'exim'& binary to the standard output.
3258 It also lists the DBM library that is being used, the optional modules (such as
3259 specific lookup types), the drivers that are included in the binary, and the
3260 name of the run time configuration file that is in use.
3261
3262 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3263 configuration file. However, this is a static check only. It cannot check
3264 values that are to be expanded. For example, although a misspelt ACL verb is
3265 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3266 alone to discover (for example) all the typos in the configuration; some
3267 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3268 dynamic testing facilities.
3269
3270 .vitem &%-bv%&
3271 .oindex "&%-bv%&"
3272 .cindex "verifying address" "using &%-bv%&"
3273 .cindex "address" "verification"
3274 This option runs Exim in address verification mode, in which each argument is
3275 taken as a recipient address to be verified by the routers. (This does
3276 not involve any verification callouts). During normal operation, verification
3277 happens mostly as a consequence processing a &%verify%& condition in an ACL
3278 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3279 including callouts, see the &%-bh%& and &%-bhc%& options.
3280
3281 If verification fails, and the caller is not an admin user, no details of the
3282 failure are output, because these might contain sensitive information such as
3283 usernames and passwords for database lookups.
3284
3285 If no arguments are given, Exim runs in an interactive manner, prompting with a
3286 right angle bracket for addresses to be verified.
3287
3288 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3289 &[readline()]& function, because it is running as &'exim'& and there are
3290 security issues.
3291
3292 Verification differs from address testing (the &%-bt%& option) in that routers
3293 that have &%no_verify%& set are skipped, and if the address is accepted by a
3294 router that has &%fail_verify%& set, verification fails. The address is
3295 verified as a recipient if &%-bv%& is used; to test verification for a sender
3296 address, &%-bvs%& should be used.
3297
3298 If the &%-v%& option is not set, the output consists of a single line for each
3299 address, stating whether it was verified or not, and giving a reason in the
3300 latter case. Without &%-v%&, generating more than one address by redirection
3301 causes verification to end successfully, without considering the generated
3302 addresses. However, if just one address is generated, processing continues,
3303 and the generated address must verify successfully for the overall verification
3304 to succeed.
3305
3306 When &%-v%& is set, more details are given of how the address has been handled,
3307 and in the case of address redirection, all the generated addresses are also
3308 considered. Verification may succeed for some and fail for others.
3309
3310 The
3311 .cindex "return code" "for &%-bv%&"
3312 return code is 2 if any address failed outright; it is 1 if no address
3313 failed outright but at least one could not be resolved for some reason. Return
3314 code 0 is given only when all addresses succeed.
3315
3316 If any of the routers in the configuration makes any tests on the sender
3317 address of a message, you should use the &%-f%& option to set an appropriate
3318 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3319 calling user at the default qualifying domain.
3320
3321 .vitem &%-bvs%&
3322 .oindex "&%-bvs%&"
3323 This option acts like &%-bv%&, but verifies the address as a sender rather
3324 than a recipient address. This affects any rewriting and qualification that
3325 might happen.
3326
3327 .new
3328 .vitem &%-C%&&~<&'filelist'&>
3329 .oindex "&%-C%&"
3330 .cindex "configuration file" "alternate"
3331 .cindex "CONFIGURE_FILE"
3332 .cindex "alternate configuration file"
3333 This option causes Exim to find the run time configuration file from the given
3334 list instead of from the list specified by the CONFIGURE_FILE
3335 compile-time setting. Usually, the list will consist of just a single file
3336 name, but it can be a colon-separated list of names. In this case, the first
3337 file that exists is used. Failure to open an existing file stops Exim from
3338 proceeding any further along the list, and an error is generated.
3339
3340 When this option is used by a caller other than root, and the list is different
3341 from the compiled-in list, Exim gives up its root privilege immediately, and
3342 runs with the real and effective uid and gid set to those of the caller.
3343 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3344 file contains a list of full pathnames, one per line, for configuration files
3345 which are trusted. Root privilege is retained for any configuration file so
3346 listed, as long as the caller is the Exim user (or the user specified in the
3347 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3348 not writeable by inappropriate users or groups.
3349
3350 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3351 configuration using &%-C%& right through message reception and delivery,
3352 even if the caller is root. The reception works, but by that time, Exim is
3353 running as the Exim user, so when it re-executes to regain privilege for the
3354 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3355 test reception and delivery using two separate commands (one to put a message
3356 on the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3357
3358 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3359 prefix string with which any file named in a &%-C%& command line option
3360 must start. In addition, the file name must not contain the sequence &`/../`&.
3361 However, if the value of the &%-C%& option is identical to the value of
3362 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3363 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3364 unset, any file name can be used with &%-C%&.
3365
3366 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3367 to a directory to which only root has access. This prevents someone who has
3368 broken into the Exim account from running a privileged Exim with an arbitrary
3369 configuration file.
3370
3371 The &%-C%& facility is useful for ensuring that configuration files are
3372 syntactically correct, but cannot be used for test deliveries, unless the
3373 caller is privileged, or unless it is an exotic configuration that does not
3374 require privilege. No check is made on the owner or group of the files
3375 specified by this option.
3376 .wen
3377
3378 .new
3379 .vitem &%-D%&<&'macro'&>=<&'value'&>
3380 .oindex "&%-D%&"
3381 .cindex "macro" "setting on command line"
3382 This option can be used to override macro definitions in the configuration file
3383 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3384 unprivileged caller, it causes Exim to give up its root privilege.
3385 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3386 completely disabled, and its use causes an immediate error exit.
3387
3388 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3389 colon-separated list of macros which are considered safe and, if &%-D%& only
3390 supplies macros from this list, and the values are acceptable, then Exim will
3391 not give up root privilege if the caller is root, the Exim run-time user, or
3392 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3393 to be removed in the future.  Acceptable values for the macros satisfy the
3394 regexp: &`^[A-Za-z0-9_/.-]*$`&
3395
3396 The entire option (including equals sign if present) must all be within one
3397 command line item. &%-D%& can be used to set the value of a macro to the empty
3398 string, in which case the equals sign is optional. These two commands are
3399 synonymous:
3400 .code
3401 exim -DABC  ...
3402 exim -DABC= ...
3403 .endd
3404 To include spaces in a macro definition item, quotes must be used. If you use
3405 quotes, spaces are permitted around the macro name and the equals sign. For
3406 example:
3407 .code
3408 exim '-D ABC = something' ...
3409 .endd
3410 &%-D%& may be repeated up to 10 times on a command line.
3411 .wen
3412
3413 .vitem &%-d%&<&'debug&~options'&>
3414 .oindex "&%-d%&"
3415 .cindex "debugging" "list of selectors"
3416 .cindex "debugging" "&%-d%& option"
3417 This option causes debugging information to be written to the standard
3418 error stream. It is restricted to admin users because debugging output may show
3419 database queries that contain password information. Also, the details of users'
3420 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3421 writes an error message to the standard error stream and exits with a non-zero
3422 return code.
3423
3424 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3425 standard debugging data is output. This can be reduced, or increased to include
3426 some more rarely needed information, by directly following &%-d%& with a string
3427 made up of names preceded by plus or minus characters. These add or remove sets
3428 of debugging data, respectively. For example, &%-d+filter%& adds filter
3429 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3430 no spaces are allowed in the debug setting. The available debugging categories
3431 are:
3432 .display
3433 &`acl            `& ACL interpretation
3434 &`auth           `& authenticators
3435 &`deliver        `& general delivery logic
3436 &`dns            `& DNS lookups (see also resolver)
3437 &`dnsbl          `& DNS black list (aka RBL) code
3438 &`exec           `& arguments for &[execv()]& calls
3439 &`expand         `& detailed debugging for string expansions
3440 &`filter         `& filter handling
3441 &`hints_lookup   `& hints data lookups
3442 &`host_lookup    `& all types of name-to-IP address handling
3443 &`ident          `& ident lookup
3444 &`interface      `& lists of local interfaces
3445 &`lists          `& matching things in lists
3446 &`load           `& system load checks
3447 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3448                     &<<CHAPlocalscan>>&)
3449 &`lookup         `& general lookup code and all lookups
3450 &`memory         `& memory handling
3451 &`pid            `& add pid to debug output lines
3452 &`process_info   `& setting info for the process log
3453 &`queue_run      `& queue runs
3454 &`receive        `& general message reception logic
3455 &`resolver       `& turn on the DNS resolver's debugging output
3456 &`retry          `& retry handling
3457 &`rewrite        `& address rewriting
3458 &`route          `& address routing
3459 &`timestamp      `& add timestamp to debug output lines
3460 &`tls            `& TLS logic
3461 &`transport      `& transports
3462 &`uid            `& changes of uid/gid and looking up uid/gid
3463 &`verify         `& address verification logic
3464 &`all            `& almost all of the above (see below), and also &%-v%&
3465 .endd
3466 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3467 for &`-all`&. The reason for this is that &`+all`& is something that people
3468 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3469 is included, an awful lot of output that is very rarely of interest is
3470 generated, so it now has to be explicitly requested. However, &`-all`& does
3471 turn everything off.
3472
3473 .cindex "resolver, debugging output"
3474 .cindex "DNS resolver, debugging output"
3475 The &`resolver`& option produces output only if the DNS resolver was compiled
3476 with DEBUG enabled. This is not the case in some operating systems. Also,
3477 unfortunately, debugging output from the DNS resolver is written to stdout
3478 rather than stderr.
3479
3480 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3481 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3482 However, the &`pid`& selector is forced when debugging is turned on for a
3483 daemon, which then passes it on to any re-executed Exims. Exim also
3484 automatically adds the pid to debug lines when several remote deliveries are
3485 run in parallel.
3486
3487 The &`timestamp`& selector causes the current time to be inserted at the start
3488 of all debug output lines. This can be useful when trying to track down delays
3489 in processing.
3490
3491 If the &%debug_print%& option is set in any driver, it produces output whenever
3492 any debugging is selected, or if &%-v%& is used.
3493
3494 .vitem &%-dd%&<&'debug&~options'&>
3495 .oindex "&%-dd%&"
3496 This option behaves exactly like &%-d%& except when used on a command that
3497 starts a daemon process. In that case, debugging is turned off for the
3498 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3499 behaviour of the daemon without creating as much output as full debugging does.
3500
3501 .vitem &%-dropcr%&
3502 .oindex "&%-dropcr%&"
3503 This is an obsolete option that is now a no-op. It used to affect the way Exim
3504 handled CR and LF characters in incoming messages. What happens now is
3505 described in section &<<SECTlineendings>>&.
3506
3507 .vitem &%-E%&
3508 .oindex "&%-E%&"
3509 .cindex "bounce message" "generating"
3510 This option specifies that an incoming message is a locally-generated delivery
3511 failure report. It is used internally by Exim when handling delivery failures
3512 and is not intended for external use. Its only effect is to stop Exim
3513 generating certain messages to the postmaster, as otherwise message cascades
3514 could occur in some situations. As part of the same option, a message id may
3515 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3516 new message contains the id, following &"R="&, as a cross-reference.
3517
3518 .vitem &%-e%&&'x'&
3519 .oindex "&%-e%&&'x'&"
3520 There are a number of Sendmail options starting with &%-oe%& which seem to be
3521 called by various programs without the leading &%o%& in the option. For
3522 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3523 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3524
3525 .vitem &%-F%&&~<&'string'&>
3526 .oindex "&%-F%&"
3527 .cindex "sender" "name"
3528 .cindex "name" "of sender"
3529 This option sets the sender's full name for use when a locally-generated
3530 message is being accepted. In the absence of this option, the user's &'gecos'&
3531 entry from the password data is used. As users are generally permitted to alter
3532 their &'gecos'& entries, no security considerations are involved. White space
3533 between &%-F%& and the <&'string'&> is optional.
3534
3535 .vitem &%-f%&&~<&'address'&>
3536 .oindex "&%-f%&"
3537 .cindex "sender" "address"
3538 .cindex "address" "sender"
3539 .cindex "trusted users"
3540 .cindex "envelope sender"
3541 .cindex "user" "trusted"
3542 This option sets the address of the envelope sender of a locally-generated
3543 message (also known as the return path). The option can normally be used only
3544 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3545 users to use it.
3546
3547 Processes running as root or the Exim user are always trusted. Other
3548 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3549 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3550 of a local message is set to the caller's login name at the default qualify
3551 domain.
3552
3553 There is one exception to the restriction on the use of &%-f%&: an empty sender
3554 can be specified by any user, trusted or not, to create a message that can
3555 never provoke a bounce. An empty sender can be specified either as an empty
3556 string, or as a pair of angle brackets with nothing between them, as in these
3557 examples of shell commands:
3558 .code
3559 exim -f '<>' user@domain
3560 exim -f "" user@domain
3561 .endd
3562 In addition, the use of &%-f%& is not restricted when testing a filter file
3563 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3564 &%-bv%& options.
3565
3566 Allowing untrusted users to change the sender address does not of itself make
3567 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3568 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3569 though this can be overridden by setting &%no_local_from_check%&.
3570
3571 White
3572 .cindex "&""From""& line"
3573 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3574 given as two arguments or one combined argument). The sender of a
3575 locally-generated message can also be set (when permitted) by an initial
3576 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3577 if &%-f%& is also present, it overrides &"From&~"&.
3578
3579 .vitem &%-G%&
3580 .oindex "&%-G%&"
3581 .cindex "Sendmail compatibility" "&%-G%& option ignored"
3582 This is a Sendmail option which is ignored by Exim.
3583
3584 .vitem &%-h%&&~<&'number'&>
3585 .oindex "&%-h%&"
3586 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3587 This option is accepted for compatibility with Sendmail, but has no effect. (In
3588 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3589 headers.)
3590
3591 .vitem &%-i%&
3592 .oindex "&%-i%&"
3593 .cindex "Solaris" "&'mail'& command"
3594 .cindex "dot" "in incoming non-SMTP message"
3595 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3596 line by itself should not terminate an incoming, non-SMTP message. I can find
3597 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3598 command in Solaris 2.4 uses it. See also &%-ti%&.
3599
3600 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3601 .oindex "&%-M%&"
3602 .cindex "forcing delivery"
3603 .cindex "delivery" "forcing attempt"
3604 .cindex "frozen messages" "forcing delivery"
3605 This option requests Exim to run a delivery attempt on each message in turn. If
3606 any of the messages are frozen, they are automatically thawed before the
3607 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3608 and &%hold_domains%& are ignored.
3609
3610 Retry
3611 .cindex "hints database" "overriding retry hints"
3612 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3613 the normal retry time has not yet been reached. This option requires the caller
3614 to be an admin user. However, there is an option called &%prod_requires_admin%&
3615 which can be set false to relax this restriction (and also the same requirement
3616 for the &%-q%&, &%-R%&, and &%-S%& options).
3617
3618 The deliveries happen synchronously, that is, the original Exim process does
3619 not terminate until all the delivery attempts have finished. No output is
3620 produced unless there is a serious error. If you want to see what is happening,
3621 use the &%-v%& option as well, or inspect Exim's main log.
3622
3623 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3624 .oindex "&%-Mar%&"
3625 .cindex "message" "adding recipients"
3626 .cindex "recipient" "adding"
3627 This option requests Exim to add the addresses to the list of recipients of the
3628 message (&"ar"& for &"add recipients"&). The first argument must be a message
3629 id, and the remaining ones must be email addresses. However, if the message is
3630 active (in the middle of a delivery attempt), it is not altered. This option
3631 can be used only by an admin user.
3632
3633 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3634         &~<&'message&~id'&>"
3635 .oindex "&%-MC%&"
3636 .cindex "SMTP" "passed connection"
3637 .cindex "SMTP" "multiple deliveries"
3638 .cindex "multiple SMTP deliveries"
3639 This option is not intended for use by external callers. It is used internally
3640 by Exim to invoke another instance of itself to deliver a waiting message using
3641 an existing SMTP connection, which is passed as the standard input. Details are
3642 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3643 must be root or the Exim user in order to use it.
3644
3645 .vitem &%-MCA%&
3646 .oindex "&%-MCA%&"
3647 This option is not intended for use by external callers. It is used internally
3648 by Exim in conjunction with the &%-MC%& option. It signifies that the
3649 connection to the remote host has been authenticated.
3650
3651 .vitem &%-MCP%&
3652 .oindex "&%-MCP%&"
3653 This option is not intended for use by external callers. It is used internally
3654 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3655 which Exim is connected supports pipelining.
3656
3657 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3658 .oindex "&%-MCQ%&"
3659 This option is not intended for use by external callers. It is used internally
3660 by Exim in conjunction with the &%-MC%& option when the original delivery was
3661 started by a queue runner. It passes on the process id of the queue runner,
3662 together with the file descriptor number of an open pipe. Closure of the pipe
3663 signals the final completion of the sequence of processes that are passing
3664 messages through the same SMTP connection.
3665
3666 .vitem &%-MCS%&
3667 .oindex "&%-MCS%&"
3668 This option is not intended for use by external callers. It is used internally
3669 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3670 SMTP SIZE option should be used on messages delivered down the existing
3671 connection.
3672
3673 .vitem &%-MCT%&
3674 .oindex "&%-MCT%&"
3675 This option is not intended for use by external callers. It is used internally
3676 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3677 host to which Exim is connected supports TLS encryption.
3678
3679 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3680 .oindex "&%-Mc%&"
3681 .cindex "hints database" "not overridden by &%-Mc%&"
3682 .cindex "delivery" "manually started &-- not forced"
3683 This option requests Exim to run a delivery attempt on each message in turn,
3684 but unlike the &%-M%& option, it does check for retry hints, and respects any
3685 that are found. This option is not very useful to external callers. It is
3686 provided mainly for internal use by Exim when it needs to re-invoke itself in
3687 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3688 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3689 respects retry times and other options such as &%hold_domains%& that are
3690 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3691 If you want to run a specific delivery as if in a queue run, you should use
3692 &%-q%& with a message id argument. A distinction between queue run deliveries
3693 and other deliveries is made in one or two places.
3694
3695 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3696 .oindex "&%-Mes%&"
3697 .cindex "message" "changing sender"
3698 .cindex "sender" "changing"
3699 This option requests Exim to change the sender address in the message to the
3700 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3701 &"edit sender"&). There must be exactly two arguments. The first argument must
3702 be a message id, and the second one an email address. However, if the message
3703 is active (in the middle of a delivery attempt), its status is not altered.
3704 This option can be used only by an admin user.
3705
3706 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3707 .oindex "&%-Mf%&"
3708 .cindex "freezing messages"
3709 .cindex "message" "manually freezing"
3710 This option requests Exim to mark each listed message as &"frozen"&. This
3711 prevents any delivery attempts taking place until the message is &"thawed"&,
3712 either manually or as a result of the &%auto_thaw%& configuration option.
3713 However, if any of the messages are active (in the middle of a delivery
3714 attempt), their status is not altered. This option can be used only by an admin
3715 user.
3716
3717 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3718 .oindex "&%-Mg%&"
3719 .cindex "giving up on messages"
3720 .cindex "message" "abandoning delivery attempts"
3721 .cindex "delivery" "abandoning further attempts"
3722 This option requests Exim to give up trying to deliver the listed messages,
3723 including any that are frozen. However, if any of the messages are active,
3724 their status is not altered. For non-bounce messages, a delivery error message
3725 is sent to the sender, containing the text &"cancelled by administrator"&.
3726 Bounce messages are just discarded. This option can be used only by an admin
3727 user.
3728
3729 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3730 .oindex "&%-Mmad%&"
3731 .cindex "delivery" "cancelling all"
3732 This option requests Exim to mark all the recipient addresses in the messages
3733 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3734 message is active (in the middle of a delivery attempt), its status is not
3735 altered. This option can be used only by an admin user.
3736
3737 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3738 .oindex "&%-Mmd%&"
3739 .cindex "delivery" "cancelling by address"
3740 .cindex "recipient" "removing"
3741 .cindex "removing recipients"
3742 This option requests Exim to mark the given addresses as already delivered
3743 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3744 the remaining ones must be email addresses. These are matched to recipient
3745 addresses in the message in a case-sensitive manner. If the message is active
3746 (in the middle of a delivery attempt), its status is not altered. This option
3747 can be used only by an admin user.
3748
3749 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3750 .oindex "&%-Mrm%&"
3751 .cindex "removing messages"
3752 .cindex "abandoning mail"
3753 .cindex "message" "manually discarding"
3754 This option requests Exim to remove the given messages from the queue. No
3755 bounce messages are sent; each message is simply forgotten. However, if any of
3756 the messages are active, their status is not altered. This option can be used
3757 only by an admin user or by the user who originally caused the message to be
3758 placed on the queue.
3759
3760 .vitem &%-Mset%&&~<&'message&~id'&>
3761 .oindex "&%-Mset%&
3762 .cindex "testing" "string expansion"
3763 .cindex "expansion" "testing"
3764 This option is useful only in conjunction with &%-be%& (that is, when testing
3765 string expansions). Exim loads the given message from its spool before doing
3766 the test expansions, thus setting message-specific variables such as
3767 &$message_size$& and the header variables. The &$recipients$& variable is made
3768 available. This feature is provided to make it easier to test expansions that
3769 make use of these variables. However, this option can be used only by an admin
3770 user. See also &%-bem%&.
3771
3772 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3773 .oindex "&%-Mt%&"
3774 .cindex "thawing messages"
3775 .cindex "unfreezing messages"
3776 .cindex "frozen messages" "thawing"
3777 .cindex "message" "thawing frozen"
3778 This option requests Exim to &"thaw"& any of the listed messages that are
3779 &"frozen"&, so that delivery attempts can resume. However, if any of the
3780 messages are active, their status is not altered. This option can be used only
3781 by an admin user.
3782
3783 .vitem &%-Mvb%&&~<&'message&~id'&>
3784 .oindex "&%-Mvb%&"
3785 .cindex "listing" "message body"
3786 .cindex "message" "listing body of"
3787 This option causes the contents of the message body (-D) spool file to be
3788 written to the standard output. This option can be used only by an admin user.
3789
3790 .vitem &%-Mvc%&&~<&'message&~id'&>
3791 .oindex "&%-Mvc%&"
3792 .cindex "message" "listing in RFC 2822 format"
3793 .cindex "listing" "message in RFC 2822 format"
3794 This option causes a copy of the complete message (header lines plus body) to
3795 be written to the standard output in RFC 2822 format. This option can be used
3796 only by an admin user.
3797
3798 .vitem &%-Mvh%&&~<&'message&~id'&>
3799 .oindex "&%-Mvh%&"
3800 .cindex "listing" "message headers"
3801 .cindex "header lines" "listing"
3802 .cindex "message" "listing header lines"
3803 This option causes the contents of the message headers (-H) spool file to be
3804 written to the standard output. This option can be used only by an admin user.
3805
3806 .vitem &%-Mvl%&&~<&'message&~id'&>
3807 .oindex "&%-Mvl%&"
3808 .cindex "listing" "message log"
3809 .cindex "message" "listing message log"
3810 This option causes the contents of the message log spool file to be written to
3811 the standard output. This option can be used only by an admin user.
3812
3813 .vitem &%-m%&
3814 .oindex "&%-m%&"
3815 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
3816 treats it that way too.
3817
3818 .vitem &%-N%&
3819 .oindex "&%-N%&"
3820 .cindex "debugging" "&%-N%& option"
3821 .cindex "debugging" "suppressing delivery"
3822 This is a debugging option that inhibits delivery of a message at the transport
3823 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
3824 it just doesn't actually transport the message, but instead behaves as if it
3825 had successfully done so. However, it does not make any updates to the retry
3826 database, and the log entries for deliveries are flagged with &"*>"& rather
3827 than &"=>"&.
3828
3829 Because &%-N%& discards any message to which it applies, only root or the Exim
3830 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
3831 words, an ordinary user can use it only when supplying an incoming message to
3832 which it will apply. Although transportation never fails when &%-N%& is set, an
3833 address may be deferred because of a configuration problem on a transport, or a
3834 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
3835 the message, and applies to any subsequent delivery attempts that may happen
3836 for that message.
3837
3838 .vitem &%-n%&
3839 .oindex "&%-n%&"
3840 .cindex "Sendmail compatibility" "&%-n%& option ignored"
3841 This option is interpreted by Sendmail to mean &"no aliasing"&. It is ignored
3842 by Exim.
3843
3844 .vitem &%-O%&&~<&'data'&>
3845 .oindex "&%-O%&"
3846 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
3847 Exim.
3848
3849 .vitem &%-oA%&&~<&'file&~name'&>
3850 .oindex "&%-oA%&"
3851 .cindex "Sendmail compatibility" "&%-oA%& option"
3852 This option is used by Sendmail in conjunction with &%-bi%& to specify an
3853 alternative alias file name. Exim handles &%-bi%& differently; see the
3854 description above.
3855
3856 .vitem &%-oB%&&~<&'n'&>
3857 .oindex "&%-oB%&"
3858 .cindex "SMTP" "passed connection"
3859 .cindex "SMTP" "multiple deliveries"
3860 .cindex "multiple SMTP deliveries"
3861 This is a debugging option which limits the maximum number of messages that can
3862 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
3863 transport. If <&'n'&> is omitted, the limit is set to 1.
3864
3865 .vitem &%-odb%&
3866 .oindex "&%-odb%&"
3867 .cindex "background delivery"
3868 .cindex "delivery" "in the background"
3869 This option applies to all modes in which Exim accepts incoming messages,
3870 including the listening daemon. It requests &"background"& delivery of such
3871 messages, which means that the accepting process automatically starts a
3872 delivery process for each message received, but does not wait for the delivery
3873 processes to finish.
3874
3875 When all the messages have been received, the reception process exits,
3876 leaving the delivery processes to finish in their own time. The standard output
3877 and error streams are closed at the start of each delivery process.
3878 This is the default action if none of the &%-od%& options are present.
3879
3880 If one of the queueing options in the configuration file
3881 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
3882 overrides it if &%queue_only_override%& is set true, which is the default
3883 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
3884
3885 .vitem &%-odf%&
3886 .oindex "&%-odf%&"
3887 .cindex "foreground delivery"
3888 .cindex "delivery" "in the foreground"
3889 This option requests &"foreground"& (synchronous) delivery when Exim has
3890 accepted a locally-generated message. (For the daemon it is exactly the same as
3891 &%-odb%&.) A delivery process is automatically started to deliver the message,
3892 and Exim waits for it to complete before proceeding.
3893
3894 The original Exim reception process does not finish until the delivery
3895 process for the final message has ended. The standard error stream is left open
3896 during deliveries.
3897
3898 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
3899 false and one of the queueing options in the configuration file is in effect.
3900
3901 If there is a temporary delivery error during foreground delivery, the
3902 message is left on the queue for later delivery, and the original reception
3903 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
3904 restricted configuration that never queues messages.
3905
3906
3907 .vitem &%-odi%&
3908 .oindex "&%-odi%&"
3909 This option is synonymous with &%-odf%&. It is provided for compatibility with
3910 Sendmail.
3911
3912 .vitem &%-odq%&
3913 .oindex "&%-odq%&"
3914 .cindex "non-immediate delivery"
3915 .cindex "delivery" "suppressing immediate"
3916 .cindex "queueing incoming messages"
3917 This option applies to all modes in which Exim accepts incoming messages,
3918 including the listening daemon. It specifies that the accepting process should
3919 not automatically start a delivery process for each message received. Messages
3920 are placed on the queue, and remain there until a subsequent queue runner
3921 process encounters them. There are several configuration options (such as
3922 &%queue_only%&) that can be used to queue incoming messages under certain
3923 conditions. This option overrides all of them and also &%-odqs%&. It always
3924 forces queueing.
3925
3926 .vitem &%-odqs%&
3927 .oindex "&%-odqs%&"
3928 .cindex "SMTP" "delaying delivery"
3929 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
3930 However, like &%-odb%& and &%-odi%&, this option has no effect if
3931 &%queue_only_override%& is false and one of the queueing options in the
3932 configuration file is in effect.
3933
3934 When &%-odqs%& does operate, a delivery process is started for each incoming
3935 message, in the background by default, but in the foreground if &%-odi%& is
3936 also present. The recipient addresses are routed, and local deliveries are done
3937 in the normal way. However, if any SMTP deliveries are required, they are not
3938 done at this time, so the message remains on the queue until a subsequent queue
3939 runner process encounters it. Because routing was done, Exim knows which
3940 messages are waiting for which hosts, and so a number of messages for the same
3941 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
3942 configuration option has the same effect for specific domains. See also the
3943 &%-qq%& option.
3944
3945 .vitem &%-oee%&
3946 .oindex "&%-oee%&"
3947 .cindex "error" "reporting"
3948 If an error is detected while a non-SMTP message is being received (for
3949 example, a malformed address), the error is reported to the sender in a mail
3950 message.
3951
3952 .cindex "return code" "for &%-oee%&"
3953 Provided
3954 this error message is successfully sent, the Exim receiving process
3955 exits with a return code of zero. If not, the return code is 2 if the problem
3956 is that the original message has no recipients, or 1 any other error. This is
3957 the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
3958
3959 .vitem &%-oem%&
3960 .oindex "&%-oem%&"
3961 .cindex "error" "reporting"
3962 .cindex "return code" "for &%-oem%&"
3963 This is the same as &%-oee%&, except that Exim always exits with a non-zero
3964 return code, whether or not the error message was successfully sent.
3965 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
3966
3967 .vitem &%-oep%&
3968 .oindex "&%-oep%&"
3969 .cindex "error" "reporting"
3970 If an error is detected while a non-SMTP message is being received, the
3971 error is reported by writing a message to the standard error file (stderr).
3972 .cindex "return code" "for &%-oep%&"
3973 The return code is 1 for all errors.
3974
3975 .vitem &%-oeq%&
3976 .oindex "&%-oeq%&"
3977 .cindex "error" "reporting"
3978 This option is supported for compatibility with Sendmail, but has the same
3979 effect as &%-oep%&.
3980
3981 .vitem &%-oew%&
3982 .oindex "&%-oew%&"
3983 .cindex "error" "reporting"
3984 This option is supported for compatibility with Sendmail, but has the same
3985 effect as &%-oem%&.
3986
3987 .vitem &%-oi%&
3988 .oindex "&%-oi%&"
3989 .cindex "dot" "in incoming non-SMTP message"
3990 This option, which has the same effect as &%-i%&, specifies that a dot on a
3991 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
3992 single dot does terminate, though Exim does no special processing for other
3993 lines that start with a dot. This option is set by default if Exim is called as
3994 &'rmail'&. See also &%-ti%&.
3995
3996 .vitem &%-oitrue%&
3997 .oindex "&%-oitrue%&"
3998 This option is treated as synonymous with &%-oi%&.
3999
4000 .vitem &%-oMa%&&~<&'host&~address'&>
4001 .oindex "&%-oMa%&"
4002 .cindex "sender" "host address, specifying for local message"
4003 A number of options starting with &%-oM%& can be used to set values associated
4004 with remote hosts on locally-submitted messages (that is, messages not received
4005 over TCP/IP). These options can be used by any caller in conjunction with the
4006 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4007 other circumstances, they are ignored unless the caller is trusted.
4008
4009 The &%-oMa%& option sets the sender host address. This may include a port
4010 number at the end, after a full stop (period). For example:
4011 .code
4012 exim -bs -oMa 10.9.8.7.1234
4013 .endd
4014 An alternative syntax is to enclose the IP address in square brackets,
4015 followed by a colon and the port number:
4016 .code
4017 exim -bs -oMa [10.9.8.7]:1234
4018 .endd
4019 The IP address is placed in the &$sender_host_address$& variable, and the
4020 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4021 are present on the command line, the sender host IP address is taken from
4022 whichever one is last.
4023
4024 .vitem &%-oMaa%&&~<&'name'&>
4025 .oindex "&%-oMaa%&"
4026 .cindex "authentication" "name, specifying for local message"
4027 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4028 option sets the value of &$sender_host_authenticated$& (the authenticator
4029 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4030 This option can be used with &%-bh%& and &%-bs%& to set up an
4031 authenticated SMTP session without actually using the SMTP AUTH command.
4032
4033 .vitem &%-oMai%&&~<&'string'&>
4034 .oindex "&%-oMai%&"
4035 .cindex "authentication" "id, specifying for local message"
4036 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4037 option sets the value of &$authenticated_id$& (the id that was authenticated).
4038 This overrides the default value (the caller's login id, except with &%-bh%&,
4039 where there is no default) for messages from local sources. See chapter
4040 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4041
4042 .vitem &%-oMas%&&~<&'address'&>
4043 .oindex "&%-oMas%&"
4044 .cindex "authentication" "sender, specifying for local message"
4045 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4046 option sets the authenticated sender value in &$authenticated_sender$&. It
4047 overrides the sender address that is created from the caller's login id for
4048 messages from local sources, except when &%-bh%& is used, when there is no
4049 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4050 specified on a MAIL command overrides this value. See chapter
4051 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4052
4053 .vitem &%-oMi%&&~<&'interface&~address'&>
4054 .oindex "&%-oMi%&"
4055 .cindex "interface" "address, specifying for local message"
4056 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4057 option sets the IP interface address value. A port number may be included,
4058 using the same syntax as for &%-oMa%&. The interface address is placed in
4059 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4060
4061 .vitem &%-oMr%&&~<&'protocol&~name'&>
4062 .oindex "&%-oMr%&"
4063 .cindex "protocol, specifying for local message"
4064 .vindex "&$received_protocol$&"
4065 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4066 option sets the received protocol value that is stored in
4067 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4068 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4069 SMTP protocol names (see the description of &$received_protocol$& in section
4070 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4071 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4072 be set by &%-oMr%&.
4073
4074 .vitem &%-oMs%&&~<&'host&~name'&>
4075 .oindex "&%-oMs%&"
4076 .cindex "sender" "host name, specifying for local message"
4077 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4078 option sets the sender host name in &$sender_host_name$&. When this option is
4079 present, Exim does not attempt to look up a host name from an IP address; it
4080 uses the name it is given.
4081
4082 .vitem &%-oMt%&&~<&'ident&~string'&>
4083 .oindex "&%-oMt%&"
4084 .cindex "sender" "ident string, specifying for local message"
4085 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4086 option sets the sender ident value in &$sender_ident$&. The default setting for
4087 local callers is the login id of the calling process, except when &%-bh%& is
4088 used, when there is no default.
4089
4090 .vitem &%-om%&
4091 .oindex "&%-om%&"
4092 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4093 In Sendmail, this option means &"me too"&, indicating that the sender of a
4094 message should receive a copy of the message if the sender appears in an alias
4095 expansion. Exim always does this, so the option does nothing.
4096
4097 .vitem &%-oo%&
4098 .oindex "&%-oo%&"
4099 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4100 This option is ignored. In Sendmail it specifies &"old style headers"&,
4101 whatever that means.
4102
4103 .vitem &%-oP%&&~<&'path'&>
4104 .oindex "&%-oP%&"
4105 .cindex "pid (process id)" "of daemon"
4106 .cindex "daemon" "process id (pid)"
4107 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4108 value. The option specifies the file to which the process id of the daemon is
4109 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4110 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4111 because in those cases, the normal pid file is not used.
4112
4113 .vitem &%-or%&&~<&'time'&>
4114 .oindex "&%-or%&"
4115 .cindex "timeout" "for non-SMTP input"
4116 This option sets a timeout value for incoming non-SMTP messages. If it is not
4117 set, Exim will wait forever for the standard input. The value can also be set
4118 by the &%receive_timeout%& option. The format used for specifying times is
4119 described in section &<<SECTtimeformat>>&.
4120
4121 .vitem &%-os%&&~<&'time'&>
4122 .oindex "&%-os%&"
4123 .cindex "timeout" "for SMTP input"
4124 .cindex "SMTP" "input timeout"
4125 This option sets a timeout value for incoming SMTP messages. The timeout
4126 applies to each SMTP command and block of data. The value can also be set by
4127 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4128 for specifying times is described in section &<<SECTtimeformat>>&.
4129
4130 .vitem &%-ov%&
4131 .oindex "&%-ov%&"
4132 This option has exactly the same effect as &%-v%&.
4133
4134 .vitem &%-oX%&&~<&'number&~or&~string'&>
4135 .oindex "&%-oX%&"
4136 .cindex "TCP/IP" "setting listening ports"
4137 .cindex "TCP/IP" "setting listening interfaces"
4138 .cindex "port" "receiving TCP/IP"
4139 This option is relevant only when the &%-bd%& (start listening daemon) option
4140 is also given. It controls which ports and interfaces the daemon uses. Details
4141 of the syntax, and how it interacts with configuration file options, are given
4142 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4143 file is written unless &%-oP%& is also present to specify a pid file name.
4144
4145 .vitem &%-pd%&
4146 .oindex "&%-pd%&"
4147 .cindex "Perl" "starting the interpreter"
4148 This option applies when an embedded Perl interpreter is linked with Exim (see
4149 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4150 option, forcing the starting of the interpreter to be delayed until it is
4151 needed.
4152
4153 .vitem &%-ps%&
4154 .oindex "&%-ps%&"
4155 .cindex "Perl" "starting the interpreter"
4156 This option applies when an embedded Perl interpreter is linked with Exim (see
4157 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4158 option, forcing the starting of the interpreter to occur as soon as Exim is
4159 started.
4160
4161 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4162 .oindex "&%-p%&"
4163 For compatibility with Sendmail, this option is equivalent to
4164 .display
4165 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4166 .endd
4167 It sets the incoming protocol and host name (for trusted callers). The
4168 host name and its colon can be omitted when only the protocol is to be set.
4169 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4170 to embedded Perl. It is therefore impossible to set a protocol value of &`p`&
4171 or &`s`& using this option (but that does not seem a real limitation).
4172
4173 .vitem &%-q%&
4174 .oindex "&%-q%&"
4175 .cindex "queue runner" "starting manually"
4176 This option is normally restricted to admin users. However, there is a
4177 configuration option called &%prod_requires_admin%& which can be set false to
4178 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4179 and &%-S%& options).
4180
4181 .cindex "queue runner" "description of operation"
4182 The &%-q%& option starts one queue runner process. This scans the queue of
4183 waiting messages, and runs a delivery process for each one in turn. It waits
4184 for each delivery process to finish before starting the next one. A delivery
4185 process may not actually do any deliveries if the retry times for the addresses
4186 have not been reached. Use &%-qf%& (see below) if you want to override this.
4187
4188 If
4189 .cindex "SMTP" "passed connection"
4190 .cindex "SMTP" "multiple deliveries"
4191 .cindex "multiple SMTP deliveries"
4192 the delivery process spawns other processes to deliver other messages down
4193 passed SMTP connections, the queue runner waits for these to finish before
4194 proceeding.
4195
4196 When all the queued messages have been considered, the original queue runner
4197 process terminates. In other words, a single pass is made over the waiting
4198 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4199 this to be repeated periodically.
4200
4201 Exim processes the waiting messages in an unpredictable order. It isn't very
4202 random, but it is likely to be different each time, which is all that matters.
4203 If one particular message screws up a remote MTA, other messages to the same
4204 MTA have a chance of getting through if they get tried first.
4205
4206 It is possible to cause the messages to be processed in lexical message id
4207 order, which is essentially the order in which they arrived, by setting the
4208 &%queue_run_in_order%& option, but this is not recommended for normal use.
4209
4210 .vitem &%-q%&<&'qflags'&>
4211 The &%-q%& option may be followed by one or more flag letters that change its
4212 behaviour. They are all optional, but if more than one is present, they must
4213 appear in the correct order. Each flag is described in a separate item below.
4214
4215 .vitem &%-qq...%&
4216 .oindex "&%-qq%&"
4217 .cindex "queue" "double scanning"
4218 .cindex "queue" "routing"
4219 .cindex "routing" "whole queue before delivery"
4220 An option starting with &%-qq%& requests a two-stage queue run. In the first
4221 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4222 every domain. Addresses are routed, local deliveries happen, but no remote
4223 transports are run.
4224
4225 .cindex "hints database" "remembering routing"
4226 The hints database that remembers which messages are waiting for specific hosts
4227 is updated, as if delivery to those hosts had been deferred. After this is
4228 complete, a second, normal queue scan happens, with routing and delivery taking
4229 place as normal. Messages that are routed to the same host should mostly be
4230 delivered down a single SMTP
4231 .cindex "SMTP" "passed connection"
4232 .cindex "SMTP" "multiple deliveries"
4233 .cindex "multiple SMTP deliveries"
4234 connection because of the hints that were set up during the first queue scan.
4235 This option may be useful for hosts that are connected to the Internet
4236 intermittently.
4237
4238 .vitem &%-q[q]i...%&
4239 .oindex "&%-qi%&"
4240 .cindex "queue" "initial delivery"
4241 If the &'i'& flag is present, the queue runner runs delivery processes only for
4242 those messages that haven't previously been tried. (&'i'& stands for &"initial
4243 delivery"&.) This can be helpful if you are putting messages on the queue using
4244 &%-odq%& and want a queue runner just to process the new messages.
4245
4246 .vitem &%-q[q][i]f...%&
4247 .oindex "&%-qf%&"
4248 .cindex "queue" "forcing delivery"
4249 .cindex "delivery" "forcing in queue run"
4250 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4251 message, whereas without &'f'& only those non-frozen addresses that have passed
4252 their retry times are tried.
4253
4254 .vitem &%-q[q][i]ff...%&
4255 .oindex "&%-qff%&"
4256 .cindex "frozen messages" "forcing delivery"
4257 If &'ff'& is present, a delivery attempt is forced for every message, whether
4258 frozen or not.
4259
4260 .vitem &%-q[q][i][f[f]]l%&
4261 .oindex "&%-ql%&"
4262 .cindex "queue" "local deliveries only"
4263 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4264 be done. If a message requires any remote deliveries, it remains on the queue
4265 for later delivery.
4266
4267 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4268 .cindex "queue" "delivering specific messages"
4269 When scanning the queue, Exim can be made to skip over messages whose ids are
4270 lexically less than a given value by following the &%-q%& option with a
4271 starting message id. For example:
4272 .code
4273 exim -q 0t5C6f-0000c8-00
4274 .endd
4275 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4276 second message id is given, messages whose ids are lexically greater than it
4277 are also skipped. If the same id is given twice, for example,
4278 .code
4279 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4280 .endd
4281 just one delivery process is started, for that message. This differs from
4282 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4283 that it counts as a delivery from a queue run. Note that the selection
4284 mechanism does not affect the order in which the messages are scanned. There
4285 are also other ways of selecting specific sets of messages for delivery in a
4286 queue run &-- see &%-R%& and &%-S%&.
4287
4288 .vitem &%-q%&<&'qflags'&><&'time'&>
4289 .cindex "queue runner" "starting periodically"
4290 .cindex "periodic queue running"
4291 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4292 starting a queue runner process at intervals specified by the given time value
4293 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4294 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4295 single daemon process handles both functions. A common way of starting up a
4296 combined daemon at system boot time is to use a command such as
4297 .code
4298 /usr/exim/bin/exim -bd -q30m
4299 .endd
4300 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4301 process every 30 minutes.
4302
4303 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4304 pid file is written unless one is explicitly requested by the &%-oP%& option.
4305
4306 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4307 .oindex "&%-qR%&"
4308 This option is synonymous with &%-R%&. It is provided for Sendmail
4309 compatibility.
4310
4311 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4312 .oindex "&%-qS%&"
4313 This option is synonymous with &%-S%&.
4314
4315 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4316 .oindex "&%-R%&"
4317 .cindex "queue runner" "for specific recipients"
4318 .cindex "delivery" "to given domain"
4319 .cindex "domain" "delivery to"
4320 The <&'rsflags'&> may be empty, in which case the white space before the string
4321 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4322 which are the possible values for <&'rsflags'&>. White space is required if
4323 <&'rsflags'&> is not empty.
4324
4325 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4326 perform a single queue run, except that, when scanning the messages on the
4327 queue, Exim processes only those that have at least one undelivered recipient
4328 address containing the given string, which is checked in a case-independent
4329 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4330 regular expression; otherwise it is a literal string.
4331
4332 If you want to do periodic queue runs for messages with specific recipients,
4333 you can combine &%-R%& with &%-q%& and a time value. For example:
4334 .code
4335 exim -q25m -R @special.domain.example
4336 .endd
4337 This example does a queue run for messages with recipients in the given domain
4338 every 25 minutes. Any additional flags that are specified with &%-q%& are
4339 applied to each queue run.
4340
4341 Once a message is selected for delivery by this mechanism, all its addresses
4342 are processed. For the first selected message, Exim overrides any retry
4343 information and forces a delivery attempt for each undelivered address. This
4344 means that if delivery of any address in the first message is successful, any
4345 existing retry information is deleted, and so delivery attempts for that
4346 address in subsequently selected messages (which are processed without forcing)
4347 will run. However, if delivery of any address does not succeed, the retry
4348 information is updated, and in subsequently selected messages, the failing
4349 address will be skipped.
4350
4351 .cindex "frozen messages" "forcing delivery"
4352 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4353 all selected messages, not just the first; frozen messages are included when
4354 &'ff'& is present.
4355
4356 The &%-R%& option makes it straightforward to initiate delivery of all messages
4357 to a given domain after a host has been down for some time. When the SMTP
4358 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4359 effect is to run Exim with the &%-R%& option, but it can be configured to run
4360 an arbitrary command instead.
4361
4362 .vitem &%-r%&
4363 .oindex "&%-r%&"
4364 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4365
4366 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4367 .oindex "&%-S%&"
4368 .cindex "delivery" "from given sender"
4369 .cindex "queue runner" "for specific senders"
4370 This option acts like &%-R%& except that it checks the string against each
4371 message's sender instead of against the recipients. If &%-R%& is also set, both
4372 conditions must be met for a message to be selected. If either of the options
4373 has &'f'& or &'ff'& in its flags, the associated action is taken.
4374
4375 .vitem &%-Tqt%&&~<&'times'&>
4376 .oindex "&%-Tqt%&"
4377 This an option that is exclusively for use by the Exim testing suite. It is not
4378 recognized when Exim is run normally. It allows for the setting up of explicit
4379 &"queue times"& so that various warning/retry features can be tested.
4380
4381 .vitem &%-t%&
4382 .oindex "&%-t%&"
4383 .cindex "recipient" "extracting from header lines"
4384 .cindex "&'Bcc:'& header line"
4385 .cindex "&'Cc:'& header line"
4386 .cindex "&'To:'& header line"
4387 When Exim is receiving a locally-generated, non-SMTP message on its standard
4388 input, the &%-t%& option causes the recipients of the message to be obtained
4389 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4390 from the command arguments. The addresses are extracted before any rewriting
4391 takes place and the &'Bcc:'& header line, if present, is then removed.
4392
4393 .cindex "Sendmail compatibility" "&%-t%& option"
4394 If the command has any arguments, they specify addresses to which the message
4395 is &'not'& to be delivered. That is, the argument addresses are removed from
4396 the recipients list obtained from the headers. This is compatible with Smail 3
4397 and in accordance with the documented behaviour of several versions of
4398 Sendmail, as described in man pages on a number of operating systems (e.g.
4399 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4400 argument addresses to those obtained from the headers, and the O'Reilly
4401 Sendmail book documents it that way. Exim can be made to add argument addresses
4402 instead of subtracting them by setting the option
4403 &%extract_addresses_remove_arguments%& false.
4404
4405 .cindex "&%Resent-%& header lines" "with &%-t%&"
4406 If there are any &%Resent-%& header lines in the message, Exim extracts
4407 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4408 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4409 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4410 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4411
4412 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4413 message is resent several times). The RFC also specifies that they should be
4414 added at the front of the message, and separated by &'Received:'& lines. It is
4415 not at all clear how &%-t%& should operate in the present of multiple sets,
4416 nor indeed exactly what constitutes a &"set"&.
4417 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4418 are often added at the end of the header, and if a message is resent more than
4419 once, it is common for the original set of &%Resent-%& headers to be renamed as
4420 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4421
4422 .vitem &%-ti%&
4423 .oindex "&%-ti%&"
4424 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4425 compatibility with Sendmail.
4426
4427 .vitem &%-tls-on-connect%&
4428 .oindex "&%-tls-on-connect%&"
4429 .cindex "TLS" "use without STARTTLS"
4430 .cindex "TLS" "automatic start"
4431 This option is available when Exim is compiled with TLS support. It forces all
4432 incoming SMTP connections to behave as if the incoming port is listed in the
4433 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4434 &<<CHAPTLS>>& for further details.
4435
4436
4437 .vitem &%-U%&
4438 .oindex "&%-U%&"
4439 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4440 Sendmail uses this option for &"initial message submission"&, and its
4441 documentation states that in future releases, it may complain about
4442 syntactically invalid messages rather than fixing them when this flag is not
4443 set. Exim ignores this option.
4444
4445 .vitem &%-v%&
4446 .oindex "&%-v%&"
4447 This option causes Exim to write information to the standard error stream,
4448 describing what it is doing. In particular, it shows the log lines for
4449 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4450 dialogue is shown. Some of the log lines shown may not actually be written to
4451 the log if the setting of &%log_selector%& discards them. Any relevant
4452 selectors are shown with each log line. If none are shown, the logging is
4453 unconditional.
4454
4455 .vitem &%-x%&
4456 .oindex "&%-x%&"
4457 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4458 National Language Support extended characters in the body of the mail item"&).
4459 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4460 this option.
4461 .endlist
4462
4463 .ecindex IIDclo1
4464 .ecindex IIDclo2
4465
4466
4467 . ////////////////////////////////////////////////////////////////////////////
4468 . Insert a stylized DocBook comment here, to identify the end of the command
4469 . line options. This is for the benefit of the Perl script that automatically
4470 . creates a man page for the options.
4471 . ////////////////////////////////////////////////////////////////////////////
4472
4473 .literal xml
4474 <!-- === End of command line options === -->
4475 .literal off
4476
4477
4478
4479
4480
4481 . ////////////////////////////////////////////////////////////////////////////
4482 . ////////////////////////////////////////////////////////////////////////////
4483
4484
4485 .chapter "The Exim run time configuration file" "CHAPconf" &&&
4486          "The runtime configuration file"
4487
4488 .cindex "run time configuration"
4489 .cindex "configuration file" "general description"
4490 .cindex "CONFIGURE_FILE"
4491 .cindex "configuration file" "errors in"
4492 .cindex "error" "in configuration file"
4493 .cindex "return code" "for bad configuration"
4494 Exim uses a single run time configuration file that is read whenever an Exim
4495 binary is executed. Note that in normal operation, this happens frequently,
4496 because Exim is designed to operate in a distributed manner, without central
4497 control.
4498
4499 If a syntax error is detected while reading the configuration file, Exim
4500 writes a message on the standard error, and exits with a non-zero return code.
4501 The message is also written to the panic log. &*Note*&: Only simple syntax
4502 errors can be detected at this time. The values of any expanded options are
4503 not checked until the expansion happens, even when the expansion does not
4504 actually alter the string.
4505
4506 The name of the configuration file is compiled into the binary for security
4507 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4508 most configurations, this specifies a single file. However, it is permitted to
4509 give a colon-separated list of file names, in which case Exim uses the first
4510 existing file in the list.
4511
4512 .new
4513 .cindex "EXIM_USER"
4514 .cindex "EXIM_GROUP"
4515 .cindex "CONFIGURE_OWNER"
4516 .cindex "CONFIGURE_GROUP"
4517 .cindex "configuration file" "ownership"
4518 .cindex "ownership" "configuration file"
4519 The run time configuration file must be owned by root or by the user that is
4520 specified at compile time by the CONFIGURE_OWNER option (if set). The
4521 configuration file must not be world-writeable, or group-writeable unless its
4522 group is the root group or the one specified at compile time by the
4523 CONFIGURE_GROUP option.
4524
4525 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4526 to root, anybody who is able to edit the run time configuration file has an
4527 easy way to run commands as root. If you specify a user or group in the
4528 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4529 who are members of that group will trivially be able to obtain root privileges.
4530
4531 Up to Exim version 4.72, the run time configuration file was also permitted to
4532 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4533 since it offered a simple privilege escalation for any attacker who managed to
4534 compromise the Exim user account.
4535
4536 A default configuration file, which will work correctly in simple situations,
4537 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4538 defines just one file name, the installation process copies the default
4539 configuration to a new file of that name if it did not previously exist. If
4540 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4541 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4542 configuration.
4543 .wen
4544
4545
4546 .section "Using a different configuration file" "SECID40"
4547 .cindex "configuration file" "alternate"
4548 A one-off alternate configuration can be specified by the &%-C%& command line
4549 option, which may specify a single file or a list of files. However, when
4550 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4551 unless the argument for &%-C%& is identical to the built-in value from
4552 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4553 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4554 is useful mainly for checking the syntax of configuration files before
4555 installing them. No owner or group checks are done on a configuration file
4556 specified by &%-C%&, if root privilege has been dropped.
4557
4558 Even the Exim user is not trusted to specify an arbitrary configuration file
4559 with the &%-C%& option to be used with root privileges, unless that file is
4560 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4561 testing a configuration using &%-C%& right through message reception and
4562 delivery, even if the caller is root. The reception works, but by that time,
4563 Exim is running as the Exim user, so when it re-execs to regain privilege for
4564 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4565 can test reception and delivery using two separate commands (one to put a
4566 message on the queue, using &%-odq%&, and another to do the delivery, using
4567 &%-M%&).
4568
4569 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4570 prefix string with which any file named in a &%-C%& command line option must
4571 start. In addition, the file name must not contain the sequence &"&`/../`&"&.
4572 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any file
4573 name can be used with &%-C%&.
4574
4575 One-off changes to a configuration can be specified by the &%-D%& command line
4576 option, which defines and overrides values for macros used inside the
4577 configuration file. However, like &%-C%&, the use of this option by a
4578 non-privileged user causes Exim to discard its root privilege.
4579 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4580 completely disabled, and its use causes an immediate error exit.
4581
4582 .new
4583 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4584 to declare certain macro names trusted, such that root privilege will not
4585 necessarily be discarded.
4586 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4587 considered safe and, if &%-D%& only supplies macros from this list, and the
4588 values are acceptable, then Exim will not give up root privilege if the caller
4589 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4590 transition mechanism and is expected to be removed in the future.  Acceptable
4591 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4592 .wen
4593
4594 Some sites may wish to use the same Exim binary on different machines that
4595 share a file system, but to use different configuration files on each machine.
4596 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4597 looks for a file whose name is the configuration file name followed by a dot
4598 and the machine's node name, as obtained from the &[uname()]& function. If this
4599 file does not exist, the standard name is tried. This processing occurs for
4600 each file name in the list given by CONFIGURE_FILE or &%-C%&.
4601
4602 In some esoteric situations different versions of Exim may be run under
4603 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4604 help with this. See the comments in &_src/EDITME_& for details.
4605
4606
4607
4608 .section "Configuration file format" "SECTconffilfor"
4609 .cindex "configuration file" "format of"
4610 .cindex "format" "configuration file"
4611 Exim's configuration file is divided into a number of different parts. General
4612 option settings must always appear at the start of the file. The other parts
4613 are all optional, and may appear in any order. Each part other than the first
4614 is introduced by the word &"begin"& followed by the name of the part. The
4615 optional parts are:
4616
4617 .ilist
4618 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4619 &<<CHAPACL>>&).
4620 .next
4621 .cindex "AUTH" "configuration"
4622 &'authenticators'&: Configuration settings for the authenticator drivers. These
4623 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4624 .next
4625 &'routers'&: Configuration settings for the router drivers. Routers process
4626 addresses and determine how the message is to be delivered (see chapters
4627 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4628 .next
4629 &'transports'&: Configuration settings for the transport drivers. Transports
4630 define mechanisms for copying messages to destinations (see chapters
4631 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4632 .next
4633 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4634 If there is no retry section, or if it is empty (that is, no retry rules are
4635 defined), Exim will not retry deliveries. In this situation, temporary errors
4636 are treated the same as permanent errors. Retry rules are discussed in chapter
4637 &<<CHAPretry>>&.
4638 .next
4639 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4640 when new addresses are generated during delivery. Rewriting is discussed in
4641 chapter &<<CHAPrewrite>>&.
4642 .next
4643 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4644 want to use this feature, you must set
4645 .code
4646 LOCAL_SCAN_HAS_OPTIONS=yes
4647 .endd
4648 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4649 facility are given in chapter &<<CHAPlocalscan>>&.
4650 .endlist
4651
4652 .cindex "configuration file" "leading white space in"
4653 .cindex "configuration file" "trailing white space in"
4654 .cindex "white space" "in configuration file"
4655 Leading and trailing white space in configuration lines is always ignored.
4656
4657 Blank lines in the file, and lines starting with a # character (ignoring
4658 leading white space) are treated as comments and are ignored. &*Note*&: A
4659 # character other than at the beginning of a line is not treated specially,
4660 and does not introduce a comment.
4661
4662 Any non-comment line can be continued by ending it with a backslash. Note that
4663 the general rule for white space means that trailing white space after the
4664 backslash and leading white space at the start of continuation
4665 lines is ignored. Comment lines beginning with # (but not empty lines) may
4666 appear in the middle of a sequence of continuation lines.
4667
4668 A convenient way to create a configuration file is to start from the
4669 default, which is supplied in &_src/configure.default_&, and add, delete, or
4670 change settings as required.
4671
4672 The ACLs, retry rules, and rewriting rules have their own syntax which is
4673 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4674 respectively. The other parts of the configuration file have some syntactic
4675 items in common, and these are described below, from section &<<SECTcos>>&
4676 onwards. Before that, the inclusion, macro, and conditional facilities are
4677 described.
4678
4679
4680
4681 .section "File inclusions in the configuration file" "SECID41"
4682 .cindex "inclusions in configuration file"
4683 .cindex "configuration file" "including other files"
4684 .cindex "&`.include`& in configuration file"
4685 .cindex "&`.include_if_exists`& in configuration file"
4686 You can include other files inside Exim's run time configuration file by
4687 using this syntax:
4688 .display
4689 &`.include`& <&'file name'&>
4690 &`.include_if_exists`& <&'file name'&>
4691 .endd
4692 on a line by itself. Double quotes round the file name are optional. If you use
4693 the first form, a configuration error occurs if the file does not exist; the
4694 second form does nothing for non-existent files. In all cases, an absolute file
4695 name is required.
4696
4697 Includes may be nested to any depth, but remember that Exim reads its
4698 configuration file often, so it is a good idea to keep them to a minimum.
4699 If you change the contents of an included file, you must HUP the daemon,
4700 because an included file is read only when the configuration itself is read.
4701
4702 The processing of inclusions happens early, at a physical line level, so, like
4703 comment lines, an inclusion can be used in the middle of an option setting,
4704 for example:
4705 .code
4706 hosts_lookup = a.b.c \
4707                .include /some/file
4708 .endd
4709 Include processing happens after macro processing (see below). Its effect is to
4710 process the lines of the included file as if they occurred inline where the
4711 inclusion appears.
4712
4713
4714
4715 .section "Macros in the configuration file" "SECTmacrodefs"
4716 .cindex "macro" "description of"
4717 .cindex "configuration file" "macros"
4718 If a line in the main part of the configuration (that is, before the first
4719 &"begin"& line) begins with an upper case letter, it is taken as a macro
4720 definition, and must be of the form
4721 .display
4722 <&'name'&> = <&'rest of line'&>
4723 .endd
4724 The name must consist of letters, digits, and underscores, and need not all be
4725 in upper case, though that is recommended. The rest of the line, including any
4726 continuations, is the replacement text, and has leading and trailing white
4727 space removed. Quotes are not removed. The replacement text can never end with
4728 a backslash character, but this doesn't seem to be a serious limitation.
4729
4730 Macros may also be defined between router, transport, authenticator, or ACL
4731 definitions. They may not, however, be defined within an individual driver or
4732 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
4733
4734 .section "Macro substitution" "SECID42"
4735 Once a macro is defined, all subsequent lines in the file (and any included
4736 files) are scanned for the macro name; if there are several macros, the line is
4737 scanned for each in turn, in the order in which the macros are defined. The
4738 replacement text is not re-scanned for the current macro, though it is scanned
4739 for subsequently defined macros. For this reason, a macro name may not contain
4740 the name of a previously defined macro as a substring. You could, for example,
4741 define
4742 .display
4743 &`ABCD_XYZ = `&<&'something'&>
4744 &`ABCD = `&<&'something else'&>
4745 .endd
4746 but putting the definitions in the opposite order would provoke a configuration
4747 error. Macro expansion is applied to individual physical lines from the file,
4748 before checking for line continuation or file inclusion (see above). If a line
4749 consists solely of a macro name, and the expansion of the macro is empty, the
4750 line is ignored. A macro at the start of a line may turn the line into a
4751 comment line or a &`.include`& line.
4752
4753
4754 .section "Redefining macros" "SECID43"
4755 Once defined, the value of a macro can be redefined later in the configuration
4756 (or in an included file). Redefinition is specified by using &'=='& instead of
4757 &'='&. For example:
4758 .code
4759 MAC =  initial value
4760 ...
4761 MAC == updated value
4762 .endd
4763 Redefinition does not alter the order in which the macros are applied to the
4764 subsequent lines of the configuration file. It is still the same order in which
4765 the macros were originally defined. All that changes is the macro's value.
4766 Redefinition makes it possible to accumulate values. For example:
4767 .code
4768 MAC =  initial value
4769 ...
4770 MAC == MAC and something added
4771 .endd
4772 This can be helpful in situations where the configuration file is built
4773 from a number of other files.
4774
4775 .section "Overriding macro values" "SECID44"
4776 The values set for macros in the configuration file can be overridden by the
4777 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
4778 used, unless called by root or the Exim user. A definition on the command line
4779 using the &%-D%& option causes all definitions and redefinitions within the
4780 file to be ignored.
4781
4782
4783
4784 .section "Example of macro usage" "SECID45"
4785 As an example of macro usage, consider a configuration where aliases are looked
4786 up in a MySQL database. It helps to keep the file less cluttered if long
4787 strings such as SQL statements are defined separately as macros, for example:
4788 .code
4789 ALIAS_QUERY = select mailbox from user where \
4790               login='${quote_mysql:$local_part}';
4791 .endd
4792 This can then be used in a &(redirect)& router setting like this:
4793 .code
4794 data = ${lookup mysql{ALIAS_QUERY}}
4795 .endd
4796 In earlier versions of Exim macros were sometimes used for domain, host, or
4797 address lists. In Exim 4 these are handled better by named lists &-- see
4798 section &<<SECTnamedlists>>&.
4799
4800
4801 .section "Conditional skips in the configuration file" "SECID46"
4802 .cindex "configuration file" "conditional skips"
4803 .cindex "&`.ifdef`&"
4804 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
4805 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
4806 portions of the configuration file. The processing happens whenever the file is
4807 read (that is, when an Exim binary starts to run).
4808
4809 The implementation is very simple. Instances of the first four directives must
4810 be followed by text that includes the names of one or macros. The condition
4811 that is tested is whether or not any macro substitution has taken place in the
4812 line. Thus:
4813 .code
4814 .ifdef AAA
4815 message_size_limit = 50M
4816 .else
4817 message_size_limit = 100M
4818 .endif
4819 .endd
4820 sets a message size limit of 50M if the macro &`AAA`& is defined, and 100M
4821 otherwise. If there is more than one macro named on the line, the condition
4822 is true if any of them are defined. That is, it is an &"or"& condition. To
4823 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
4824
4825 Although you can use a macro expansion to generate one of these directives,
4826 it is not very useful, because the condition &"there was a macro substitution
4827 in this line"& will always be true.
4828
4829 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
4830 to clarify complicated nestings.
4831
4832
4833
4834 .section "Common option syntax" "SECTcos"
4835 .cindex "common option syntax"
4836 .cindex "syntax of common options"
4837 .cindex "configuration file" "common option syntax"
4838 For the main set of options, driver options, and &[local_scan()]& options,
4839 each setting is on a line by itself, and starts with a name consisting of
4840 lower-case letters and underscores. Many options require a data value, and in
4841 these cases the name must be followed by an equals sign (with optional white
4842 space) and then the value. For example:
4843 .code
4844 qualify_domain = mydomain.example.com
4845 .endd
4846 .cindex "hiding configuration option values"
4847 .cindex "configuration options" "hiding value of"
4848 .cindex "options" "hiding value of"
4849 Some option settings may contain sensitive data, for example, passwords for
4850 accessing databases. To stop non-admin users from using the &%-bP%& command
4851 line option to read these values, you can precede the option settings with the
4852 word &"hide"&. For example:
4853 .code
4854 hide mysql_servers = localhost/users/admin/secret-password
4855 .endd
4856 For non-admin users, such options are displayed like this:
4857 .code
4858 mysql_servers = <value not displayable>
4859 .endd
4860 If &"hide"& is used on a driver option, it hides the value of that option on
4861 all instances of the same driver.
4862
4863 The following sections describe the syntax used for the different data types
4864 that are found in option settings.
4865
4866
4867 .section "Boolean options" "SECID47"
4868 .cindex "format" "boolean"
4869 .cindex "boolean configuration values"
4870 .oindex "&%no_%&&'xxx'&"
4871 .oindex "&%not_%&&'xxx'&"
4872 Options whose type is given as boolean are on/off switches. There are two
4873 different ways of specifying such options: with and without a data value. If
4874 the option name is specified on its own without data, the switch is turned on;
4875 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
4876 boolean options may be followed by an equals sign and one of the words
4877 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
4878 the following two settings have exactly the same effect:
4879 .code
4880 queue_only
4881 queue_only = true
4882 .endd
4883 The following two lines also have the same (opposite) effect:
4884 .code
4885 no_queue_only
4886 queue_only = false
4887 .endd
4888 You can use whichever syntax you prefer.
4889
4890
4891
4892
4893 .section "Integer values" "SECID48"
4894 .cindex "integer configuration values"
4895 .cindex "format" "integer"
4896 If an option's type is given as &"integer"&, the value can be given in decimal,
4897 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
4898 number is assumed. Otherwise, it is treated as an octal number unless it starts
4899 with the characters &"0x"&, in which case the remainder is interpreted as a
4900 hexadecimal number.
4901
4902 If an integer value is followed by the letter K, it is multiplied by 1024; if
4903 it is followed by the letter M, it is multiplied by 1024x1024. When the values
4904 of integer option settings are output, values which are an exact multiple of
4905 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
4906 and M. The printing style is independent of the actual input format that was
4907 used.
4908
4909
4910 .section "Octal integer values" "SECID49"
4911 .cindex "integer format"
4912 .cindex "format" "octal integer"
4913 If an option's type is given as &"octal integer"&, its value is always
4914 interpreted as an octal number, whether or not it starts with the digit zero.
4915 Such options are always output in octal.
4916
4917
4918 .section "Fixed point numbers" "SECID50"
4919 .cindex "fixed point configuration values"
4920 .cindex "format" "fixed point"
4921 If an option's type is given as &"fixed-point"&, its value must be a decimal
4922 integer, optionally followed by a decimal point and up to three further digits.
4923
4924
4925
4926 .section "Time intervals" "SECTtimeformat"
4927 .cindex "time interval" "specifying in configuration"
4928 .cindex "format" "time interval"
4929 A time interval is specified as a sequence of numbers, each followed by one of
4930 the following letters, with no intervening white space:
4931
4932 .table2 30pt
4933 .irow &%s%& seconds
4934 .irow &%m%& minutes
4935 .irow &%h%& hours
4936 .irow &%d%& days
4937 .irow &%w%& weeks
4938 .endtable
4939
4940 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
4941 intervals are output in the same format. Exim does not restrict the values; it
4942 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
4943
4944
4945
4946 .section "String values" "SECTstrings"
4947 .cindex "string" "format of configuration values"
4948 .cindex "format" "string"
4949 If an option's type is specified as &"string"&, the value can be specified with
4950 or without double-quotes. If it does not start with a double-quote, the value
4951 consists of the remainder of the line plus any continuation lines, starting at
4952 the first character after any leading white space, with trailing white space
4953 removed, and with no interpretation of the characters in the string. Because
4954 Exim removes comment lines (those beginning with #) at an early stage, they can
4955 appear in the middle of a multi-line string. The following two settings are
4956 therefore equivalent:
4957 .code
4958 trusted_users = uucp:mail
4959 trusted_users = uucp:\
4960                 # This comment line is ignored
4961                 mail
4962 .endd
4963 .cindex "string" "quoted"
4964 .cindex "escape characters in quoted strings"
4965 If a string does start with a double-quote, it must end with a closing
4966 double-quote, and any backslash characters other than those used for line
4967 continuation are interpreted as escape characters, as follows:
4968
4969 .table2 100pt
4970 .irow &`\\`&                     "single backslash"
4971 .irow &`\n`&                     "newline"
4972 .irow &`\r`&                     "carriage return"
4973 .irow &`\t`&                     "tab"
4974 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
4975 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
4976                                    character"
4977 .endtable
4978
4979 If a backslash is followed by some other character, including a double-quote
4980 character, that character replaces the pair.
4981
4982 Quoting is necessary only if you want to make use of the backslash escapes to
4983 insert special characters, or if you need to specify a value with leading or
4984 trailing spaces. These cases are rare, so quoting is almost never needed in
4985 current versions of Exim. In versions of Exim before 3.14, quoting was required
4986 in order to continue lines, so you may come across older configuration files
4987 and examples that apparently quote unnecessarily.
4988
4989
4990 .section "Expanded strings" "SECID51"
4991 .cindex "expansion" "definition of"
4992 Some strings in the configuration file are subjected to &'string expansion'&,
4993 by which means various parts of the string may be changed according to the
4994 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
4995 is as just described; in particular, the handling of backslashes in quoted
4996 strings is done as part of the input process, before expansion takes place.
4997 However, backslash is also an escape character for the expander, so any
4998 backslashes that are required for that reason must be doubled if they are
4999 within a quoted configuration string.
5000
5001
5002 .section "User and group names" "SECID52"
5003 .cindex "user name" "format of"
5004 .cindex "format" "user name"
5005 .cindex "groups" "name format"
5006 .cindex "format" "group name"
5007 User and group names are specified as strings, using the syntax described
5008 above, but the strings are interpreted specially. A user or group name must
5009 either consist entirely of digits, or be a name that can be looked up using the
5010 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5011
5012
5013 .section "List construction" "SECTlistconstruct"
5014 .cindex "list" "syntax of in configuration"
5015 .cindex "format" "list item in configuration"
5016 .cindex "string" "list, definition of"
5017 The data for some configuration options is a list of items, with colon as the
5018 default separator. Many of these options are shown with type &"string list"& in
5019 the descriptions later in this document. Others are listed as &"domain list"&,
5020 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5021 are all the same; however, those other than &"string list"& are subject to
5022 particular kinds of interpretation, as described in chapter
5023 &<<CHAPdomhosaddlists>>&.
5024
5025 In all these cases, the entire list is treated as a single string as far as the
5026 input syntax is concerned. The &%trusted_users%& setting in section
5027 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5028 in a list, it must be entered as two colons. Leading and trailing white space
5029 on each item in a list is ignored. This makes it possible to include items that
5030 start with a colon, and in particular, certain forms of IPv6 address. For
5031 example, the list
5032 .code
5033 local_interfaces = 127.0.0.1 : ::::1
5034 .endd
5035 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5036
5037 &*Note*&: Although leading and trailing white space is ignored in individual
5038 list items, it is not ignored when parsing the list. The space after the first
5039 colon in the example above is necessary. If it were not there, the list would
5040 be interpreted as the two items 127.0.0.1:: and 1.
5041
5042 .section "Changing list separators" "SECID53"
5043 .cindex "list separator" "changing"
5044 .cindex "IPv6" "addresses in lists"
5045 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5046 introduced to allow the separator character to be changed. If a list begins
5047 with a left angle bracket, followed by any punctuation character, that
5048 character is used instead of colon as the list separator. For example, the list
5049 above can be rewritten to use a semicolon separator like this:
5050 .code
5051 local_interfaces = <; 127.0.0.1 ; ::1
5052 .endd
5053 This facility applies to all lists, with the exception of the list in
5054 &%log_file_path%&. It is recommended that the use of non-colon separators be
5055 confined to circumstances where they really are needed.
5056
5057 .cindex "list separator" "newline as"
5058 .cindex "newline" "as list separator"
5059 It is also possible to use newline and other control characters (those with
5060 code values less than 32, plus DEL) as separators in lists. Such separators
5061 must be provided literally at the time the list is processed. For options that
5062 are string-expanded, you can write the separator using a normal escape
5063 sequence. This will be processed by the expander before the string is
5064 interpreted as a list. For example, if a newline-separated list of domains is
5065 generated by a lookup, you can process it directly by a line such as this:
5066 .code
5067 domains = <\n ${lookup mysql{.....}}
5068 .endd
5069 This avoids having to change the list separator in such data. You are unlikely
5070 to want to use a control character as a separator in an option that is not
5071 expanded, because the value is literal text. However, it can be done by giving
5072 the value in quotes. For example:
5073 .code
5074 local_interfaces = "<\n 127.0.0.1 \n ::1"
5075 .endd
5076 Unlike printing character separators, which can be included in list items by
5077 doubling, it is not possible to include a control character as data when it is
5078 set as the separator. Two such characters in succession are interpreted as
5079 enclosing an empty list item.
5080
5081
5082
5083 .section "Empty items in lists" "SECTempitelis"
5084 .cindex "list" "empty item in"
5085 An empty item at the end of a list is always ignored. In other words, trailing
5086 separator characters are ignored. Thus, the list in
5087 .code
5088 senders = user@domain :
5089 .endd
5090 contains only a single item. If you want to include an empty string as one item
5091 in a list, it must not be the last item. For example, this list contains three
5092 items, the second of which is empty:
5093 .code
5094 senders = user1@domain : : user2@domain
5095 .endd
5096 &*Note*&: There must be white space between the two colons, as otherwise they
5097 are interpreted as representing a single colon data character (and the list
5098 would then contain just one item). If you want to specify a list that contains
5099 just one, empty item, you can do it as in this example:
5100 .code
5101 senders = :
5102 .endd
5103 In this case, the first item is empty, and the second is discarded because it
5104 is at the end of the list.
5105
5106
5107
5108
5109 .section "Format of driver configurations" "SECTfordricon"
5110 .cindex "drivers" "configuration format"
5111 There are separate parts in the configuration for defining routers, transports,
5112 and authenticators. In each part, you are defining a number of driver
5113 instances, each with its own set of options. Each driver instance is defined by
5114 a sequence of lines like this:
5115 .display
5116 <&'instance name'&>:
5117   <&'option'&>
5118   ...
5119   <&'option'&>
5120 .endd
5121 In the following example, the instance name is &(localuser)&, and it is
5122 followed by three options settings:
5123 .code
5124 localuser:
5125   driver = accept
5126   check_local_user
5127   transport = local_delivery
5128 .endd
5129 For each driver instance, you specify which Exim code module it uses &-- by the
5130 setting of the &%driver%& option &-- and (optionally) some configuration
5131 settings. For example, in the case of transports, if you want a transport to
5132 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5133 a local file you would use the &(appendfile)& driver. Each of the drivers is
5134 described in detail in its own separate chapter later in this manual.
5135
5136 You can have several routers, transports, or authenticators that are based on
5137 the same underlying driver (each must have a different instance name).
5138
5139 The order in which routers are defined is important, because addresses are
5140 passed to individual routers one by one, in order. The order in which
5141 transports are defined does not matter at all. The order in which
5142 authenticators are defined is used only when Exim, as a client, is searching
5143 them to find one that matches an authentication mechanism offered by the
5144 server.
5145
5146 .cindex "generic options"
5147 .cindex "options" "generic &-- definition of"
5148 Within a driver instance definition, there are two kinds of option: &'generic'&
5149 and &'private'&. The generic options are those that apply to all drivers of the
5150 same type (that is, all routers, all transports or all authenticators). The
5151 &%driver%& option is a generic option that must appear in every definition.
5152 .cindex "private options"
5153 The private options are special for each driver, and none need appear, because
5154 they all have default values.
5155
5156 The options may appear in any order, except that the &%driver%& option must
5157 precede any private options, since these depend on the particular driver. For
5158 this reason, it is recommended that &%driver%& always be the first option.
5159
5160 Driver instance names, which are used for reference in log entries and
5161 elsewhere, can be any sequence of letters, digits, and underscores (starting
5162 with a letter) and must be unique among drivers of the same type. A router and
5163 a transport (for example) can each have the same name, but no two router
5164 instances can have the same name. The name of a driver instance should not be
5165 confused with the name of the underlying driver module. For example, the
5166 configuration lines:
5167 .code
5168 remote_smtp:
5169   driver = smtp
5170 .endd
5171 create an instance of the &(smtp)& transport driver whose name is
5172 &(remote_smtp)&. The same driver code can be used more than once, with
5173 different instance names and different option settings each time. A second
5174 instance of the &(smtp)& transport, with different options, might be defined
5175 thus:
5176 .code
5177 special_smtp:
5178   driver = smtp
5179   port = 1234
5180   command_timeout = 10s
5181 .endd
5182 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5183 these transport instances from routers, and these names would appear in log
5184 lines.
5185
5186 Comment lines may be present in the middle of driver specifications. The full
5187 list of option settings for any particular driver instance, including all the
5188 defaulted values, can be extracted by making use of the &%-bP%& command line
5189 option.
5190
5191
5192
5193
5194
5195
5196 . ////////////////////////////////////////////////////////////////////////////
5197 . ////////////////////////////////////////////////////////////////////////////
5198
5199 .chapter "The default configuration file" "CHAPdefconfil"
5200 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5201 .cindex "default" "configuration file &""walk through""&"
5202 The default configuration file supplied with Exim as &_src/configure.default_&
5203 is sufficient for a host with simple mail requirements. As an introduction to
5204 the way Exim is configured, this chapter &"walks through"& the default
5205 configuration, giving brief explanations of the settings. Detailed descriptions
5206 of the options are given in subsequent chapters. The default configuration file
5207 itself contains extensive comments about ways you might want to modify the
5208 initial settings. However, note that there are many options that are not
5209 mentioned at all in the default configuration.
5210
5211
5212
5213 .section "Main configuration settings" "SECTdefconfmain"
5214 The main (global) configuration option settings must always come first in the
5215 file. The first thing you'll see in the file, after some initial comments, is
5216 the line
5217 .code
5218 # primary_hostname =
5219 .endd
5220 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5221 to know the official, fully qualified name of your host, and this is where you
5222 can specify it. However, in most cases you do not need to set this option. When
5223 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5224
5225 The first three non-comment configuration lines are as follows:
5226 .code
5227 domainlist local_domains = @
5228 domainlist relay_to_domains =
5229 hostlist   relay_from_hosts = 127.0.0.1
5230 .endd
5231 These are not, in fact, option settings. They are definitions of two named
5232 domain lists and one named host list. Exim allows you to give names to lists of
5233 domains, hosts, and email addresses, in order to make it easier to manage the
5234 configuration file (see section &<<SECTnamedlists>>&).
5235
5236 The first line defines a domain list called &'local_domains'&; this is used
5237 later in the configuration to identify domains that are to be delivered
5238 on the local host.
5239
5240 .cindex "@ in a domain list"
5241 There is just one item in this list, the string &"@"&. This is a special form
5242 of entry which means &"the name of the local host"&. Thus, if the local host is
5243 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5244 be delivered locally. Because the local host's name is referenced indirectly,
5245 the same configuration file can be used on different hosts.
5246
5247 The second line defines a domain list called &'relay_to_domains'&, but the
5248 list itself is empty. Later in the configuration we will come to the part that
5249 controls mail relaying through the local host; it allows relaying to any
5250 domains in this list. By default, therefore, no relaying on the basis of a mail
5251 domain is permitted.
5252
5253 The third line defines a host list called &'relay_from_hosts'&. This list is
5254 used later in the configuration to permit relaying from any host or IP address
5255 that matches the list. The default contains just the IP address of the IPv4
5256 loopback interface, which means that processes on the local host are able to
5257 submit mail for relaying by sending it over TCP/IP to that interface. No other
5258 hosts are permitted to submit messages for relaying.
5259
5260 Just to be sure there's no misunderstanding: at this point in the configuration
5261 we aren't actually setting up any controls. We are just defining some domains
5262 and hosts that will be used in the controls that are specified later.
5263
5264 The next two configuration lines are genuine option settings:
5265 .code
5266 acl_smtp_rcpt = acl_check_rcpt
5267 acl_smtp_data = acl_check_data
5268 .endd
5269 These options specify &'Access Control Lists'& (ACLs) that are to be used
5270 during an incoming SMTP session for every recipient of a message (every RCPT
5271 command), and after the contents of the message have been received,
5272 respectively. The names of the lists are &'acl_check_rcpt'& and
5273 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5274 section of the configuration. The RCPT ACL controls which recipients are
5275 accepted for an incoming message &-- if a configuration does not provide an ACL
5276 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5277 contents of a message to be checked.
5278
5279 Two commented-out option settings are next:
5280 .code
5281 # av_scanner = clamd:/tmp/clamd
5282 # spamd_address = 127.0.0.1 783
5283 .endd
5284 These are example settings that can be used when Exim is compiled with the
5285 content-scanning extension. The first specifies the interface to the virus
5286 scanner, and the second specifies the interface to SpamAssassin. Further
5287 details are given in chapter &<<CHAPexiscan>>&.
5288
5289 Three more commented-out option settings follow:
5290 .code
5291 # tls_advertise_hosts = *
5292 # tls_certificate = /etc/ssl/exim.crt
5293 # tls_privatekey = /etc/ssl/exim.pem
5294 .endd
5295 These are example settings that can be used when Exim is compiled with
5296 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5297 first one specifies the list of clients that are allowed to use TLS when
5298 connecting to this server; in this case the wildcard means all clients. The
5299 other options specify where Exim should find its TLS certificate and private
5300 key, which together prove the server's identity to any clients that connect.
5301 More details are given in chapter &<<CHAPTLS>>&.
5302
5303 Another two commented-out option settings follow:
5304 .code
5305 # daemon_smtp_ports = 25 : 465 : 587
5306 # tls_on_connect_ports = 465
5307 .endd
5308 .cindex "port" "465 and 587"
5309 .cindex "port" "for message submission"
5310 .cindex "message" "submission, ports for"
5311 .cindex "ssmtp protocol"
5312 .cindex "smtps protocol"
5313 .cindex "SMTP" "ssmtp protocol"
5314 .cindex "SMTP" "smtps protocol"
5315 These options provide better support for roaming users who wish to use this
5316 server for message submission. They are not much use unless you have turned on
5317 TLS (as described in the previous paragraph) and authentication (about which
5318 more in section &<<SECTdefconfauth>>&). The usual SMTP port 25 is often blocked
5319 on end-user networks, so RFC 4409 specifies that message submission should use
5320 port 587 instead. However some software (notably Microsoft Outlook) cannot be
5321 configured to use port 587 correctly, so these settings also enable the
5322 non-standard &"smtps"& (aka &"ssmtp"&) port 465 (see section
5323 &<<SECTsupobssmt>>&).
5324
5325 Two more commented-out options settings follow:
5326 .code
5327 # qualify_domain =
5328 # qualify_recipient =
5329 .endd
5330 The first of these specifies a domain that Exim uses when it constructs a
5331 complete email address from a local login name. This is often needed when Exim
5332 receives a message from a local process. If you do not set &%qualify_domain%&,
5333 the value of &%primary_hostname%& is used. If you set both of these options,
5334 you can have different qualification domains for sender and recipient
5335 addresses. If you set only the first one, its value is used in both cases.
5336
5337 .cindex "domain literal" "recognizing format"
5338 The following line must be uncommented if you want Exim to recognize
5339 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5340 (an IP address within square brackets) instead of a named domain.
5341 .code
5342 # allow_domain_literals
5343 .endd
5344 The RFCs still require this form, but many people think that in the modern
5345 Internet it makes little sense to permit mail to be sent to specific hosts by
5346 quoting their IP addresses. This ancient format has been used by people who
5347 try to abuse hosts by using them for unwanted relaying. However, some
5348 people believe there are circumstances (for example, messages addressed to
5349 &'postmaster'&) where domain literals are still useful.
5350
5351 The next configuration line is a kind of trigger guard:
5352 .code
5353 never_users = root
5354 .endd
5355 It specifies that no delivery must ever be run as the root user. The normal
5356 convention is to set up &'root'& as an alias for the system administrator. This
5357 setting is a guard against slips in the configuration.
5358 The list of users specified by &%never_users%& is not, however, the complete
5359 list; the build-time configuration in &_Local/Makefile_& has an option called
5360 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5361 contents of &%never_users%& are added to this list. By default
5362 FIXED_NEVER_USERS also specifies root.
5363
5364 When a remote host connects to Exim in order to send mail, the only information
5365 Exim has about the host's identity is its IP address. The next configuration
5366 line,
5367 .code
5368 host_lookup = *
5369 .endd
5370 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5371 in order to get a host name. This improves the quality of the logging
5372 information, but if you feel it is too expensive, you can remove it entirely,
5373 or restrict the lookup to hosts on &"nearby"& networks.
5374 Note that it is not always possible to find a host name from an IP address,
5375 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5376 unreachable.
5377
5378 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5379 1413 (hence their names):
5380 .code
5381 rfc1413_hosts = *
5382 rfc1413_query_timeout = 5s
5383 .endd
5384 These settings cause Exim to make ident callbacks for all incoming SMTP calls.
5385 You can limit the hosts to which these calls are made, or change the timeout
5386 that is used. If you set the timeout to zero, all ident calls are disabled.
5387 Although they are cheap and can provide useful information for tracing problem
5388 messages, some hosts and firewalls have problems with ident calls. This can
5389 result in a timeout instead of an immediate refused connection, leading to
5390 delays on starting up an incoming SMTP session.
5391
5392 When Exim receives messages over SMTP connections, it expects all addresses to
5393 be fully qualified with a domain, as required by the SMTP definition. However,
5394 if you are running a server to which simple clients submit messages, you may
5395 find that they send unqualified addresses. The two commented-out options:
5396 .code
5397 # sender_unqualified_hosts =
5398 # recipient_unqualified_hosts =
5399 .endd
5400 show how you can specify hosts that are permitted to send unqualified sender
5401 and recipient addresses, respectively.
5402
5403 The &%percent_hack_domains%& option is also commented out:
5404 .code
5405 # percent_hack_domains =
5406 .endd
5407 It provides a list of domains for which the &"percent hack"& is to operate.
5408 This is an almost obsolete form of explicit email routing. If you do not know
5409 anything about it, you can safely ignore this topic.
5410
5411 The last two settings in the main part of the default configuration are
5412 concerned with messages that have been &"frozen"& on Exim's queue. When a
5413 message is frozen, Exim no longer continues to try to deliver it. Freezing
5414 occurs when a bounce message encounters a permanent failure because the sender
5415 address of the original message that caused the bounce is invalid, so the
5416 bounce cannot be delivered. This is probably the most common case, but there
5417 are also other conditions that cause freezing, and frozen messages are not
5418 always bounce messages.
5419 .code
5420 ignore_bounce_errors_after = 2d
5421 timeout_frozen_after = 7d
5422 .endd
5423 The first of these options specifies that failing bounce messages are to be
5424 discarded after 2 days on the queue. The second specifies that any frozen
5425 message (whether a bounce message or not) is to be timed out (and discarded)
5426 after a week. In this configuration, the first setting ensures that no failing
5427 bounce message ever lasts a week.
5428
5429
5430
5431 .section "ACL configuration" "SECID54"
5432 .cindex "default" "ACLs"
5433 .cindex "&ACL;" "default configuration"
5434 In the default configuration, the ACL section follows the main configuration.
5435 It starts with the line
5436 .code
5437 begin acl
5438 .endd
5439 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5440 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5441 and &%acl_smtp_data%& above.
5442
5443 .cindex "RCPT" "ACL for"
5444 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5445 RCPT command specifies one of the message's recipients. The ACL statements
5446 are considered in order, until the recipient address is either accepted or
5447 rejected. The RCPT command is then accepted or rejected, according to the
5448 result of the ACL processing.
5449 .code
5450 acl_check_rcpt:
5451 .endd
5452 This line, consisting of a name terminated by a colon, marks the start of the
5453 ACL, and names it.
5454 .code
5455 accept  hosts = :
5456 .endd
5457 This ACL statement accepts the recipient if the sending host matches the list.
5458 But what does that strange list mean? It doesn't actually contain any host
5459 names or IP addresses. The presence of the colon puts an empty item in the
5460 list; Exim matches this only if the incoming message did not come from a remote
5461 host, because in that case, the remote hostname is empty. The colon is
5462 important. Without it, the list itself is empty, and can never match anything.
5463
5464 What this statement is doing is to accept unconditionally all recipients in
5465 messages that are submitted by SMTP from local processes using the standard
5466 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5467 manner.
5468 .code
5469 deny    message       = Restricted characters in address
5470         domains       = +local_domains
5471         local_parts   = ^[.] : ^.*[@%!/|]
5472
5473 deny    message       = Restricted characters in address
5474         domains       = !+local_domains
5475         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5476 .endd
5477 These statements are concerned with local parts that contain any of the
5478 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5479 Although these characters are entirely legal in local parts (in the case of
5480 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5481 in Internet mail addresses.
5482
5483 The first three have in the past been associated with explicitly routed
5484 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5485 option). Addresses containing these characters are regularly tried by spammers
5486 in an attempt to bypass relaying restrictions, and also by open relay testing
5487 programs. Unless you really need them it is safest to reject these characters
5488 at this early stage. This configuration is heavy-handed in rejecting these
5489 characters for all messages it accepts from remote hosts. This is a deliberate
5490 policy of being as safe as possible.
5491
5492 The first rule above is stricter, and is applied to messages that are addressed
5493 to one of the local domains handled by this host. This is implemented by the
5494 first condition, which restricts it to domains that are listed in the
5495 &'local_domains'& domain list. The &"+"& character is used to indicate a
5496 reference to a named list. In this configuration, there is just one domain in
5497 &'local_domains'&, but in general there may be many.
5498
5499 The second condition on the first statement uses two regular expressions to
5500 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5501 or &"|"&. If you have local accounts that include these characters, you will
5502 have to modify this rule.
5503
5504 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5505 allows them because they have been encountered in practice. (Consider the
5506 common convention of local parts constructed as
5507 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5508 the author of Exim, who has no second initial.) However, a local part starting
5509 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5510 file name (for example, for a mailing list). This is also true for local parts
5511 that contain slashes. A pipe symbol can also be troublesome if the local part
5512 is incorporated unthinkingly into a shell command line.
5513
5514 The second rule above applies to all other domains, and is less strict. This
5515 allows your own users to send outgoing messages to sites that use slashes
5516 and vertical bars in their local parts. It blocks local parts that begin
5517 with a dot, slash, or vertical bar, but allows these characters within the
5518 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5519 and &"!"& is blocked, as before. The motivation here is to prevent your users
5520 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5521 .code
5522 accept  local_parts   = postmaster
5523         domains       = +local_domains
5524 .endd
5525 This statement, which has two conditions, accepts an incoming address if the
5526 local part is &'postmaster'& and the domain is one of those listed in the
5527 &'local_domains'& domain list. The &"+"& character is used to indicate a
5528 reference to a named list. In this configuration, there is just one domain in
5529 &'local_domains'&, but in general there may be many.
5530
5531 The presence of this statement means that mail to postmaster is never blocked
5532 by any of the subsequent tests. This can be helpful while sorting out problems
5533 in cases where the subsequent tests are incorrectly denying access.
5534 .code
5535 require verify        = sender
5536 .endd
5537 This statement requires the sender address to be verified before any subsequent
5538 ACL statement can be used. If verification fails, the incoming recipient
5539 address is refused. Verification consists of trying to route the address, to
5540 see if a bounce message could be delivered to it. In the case of remote
5541 addresses, basic verification checks only the domain, but &'callouts'& can be
5542 used for more verification if required. Section &<<SECTaddressverification>>&
5543 discusses the details of address verification.
5544 .code
5545 accept  hosts         = +relay_from_hosts
5546         control       = submission
5547 .endd
5548 This statement accepts the address if the message is coming from one of the
5549 hosts that are defined as being allowed to relay through this host. Recipient
5550 verification is omitted here, because in many cases the clients are dumb MUAs
5551 that do not cope well with SMTP error responses. For the same reason, the
5552 second line specifies &"submission mode"& for messages that are accepted. This
5553 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5554 messages that are deficient in some way, for example, because they lack a
5555 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5556 probably add recipient verification here, and disable submission mode.
5557 .code
5558 accept  authenticated = *
5559         control       = submission
5560 .endd
5561 This statement accepts the address if the client host has authenticated itself.
5562 Submission mode is again specified, on the grounds that such messages are most
5563 likely to come from MUAs. The default configuration does not define any
5564 authenticators, though it does include some nearly complete commented-out
5565 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5566 fact authenticate until you complete the authenticator definitions.
5567 .code
5568 require message = relay not permitted
5569         domains = +local_domains : +relay_domains
5570 .endd
5571 This statement rejects the address if its domain is neither a local domain nor
5572 one of the domains for which this host is a relay.
5573 .code
5574 require verify = recipient
5575 .endd
5576 This statement requires the recipient address to be verified; if verification
5577 fails, the address is rejected.
5578 .code
5579 # deny    message     = rejected because $sender_host_address \
5580 #                       is in a black list at $dnslist_domain\n\
5581 #                       $dnslist_text
5582 #         dnslists    = black.list.example
5583 #
5584 # warn    dnslists    = black.list.example
5585 #         add_header  = X-Warning: $sender_host_address is in \
5586 #                       a black list at $dnslist_domain
5587 #         log_message = found in $dnslist_domain
5588 .endd
5589 These commented-out lines are examples of how you could configure Exim to check
5590 sending hosts against a DNS black list. The first statement rejects messages
5591 from blacklisted hosts, whereas the second just inserts a warning header
5592 line.
5593 .code
5594 # require verify = csa
5595 .endd
5596 This commented-out line is an example of how you could turn on client SMTP
5597 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5598 records.
5599 .code
5600 accept
5601 .endd
5602 The final statement in the first ACL unconditionally accepts any recipient
5603 address that has successfully passed all the previous tests.
5604 .code
5605 acl_check_data:
5606 .endd
5607 This line marks the start of the second ACL, and names it. Most of the contents
5608 of this ACL are commented out:
5609 .code
5610 # deny    malware   = *
5611 #         message   = This message contains a virus \
5612 #                     ($malware_name).
5613 .endd
5614 These lines are examples of how to arrange for messages to be scanned for
5615 viruses when Exim has been compiled with the content-scanning extension, and a
5616 suitable virus scanner is installed. If the message is found to contain a
5617 virus, it is rejected with the given custom error message.
5618 .code
5619 # warn    spam      = nobody
5620 #         message   = X-Spam_score: $spam_score\n\
5621 #                     X-Spam_score_int: $spam_score_int\n\
5622 #                     X-Spam_bar: $spam_bar\n\
5623 #                     X-Spam_report: $spam_report
5624 .endd
5625 These lines are an example of how to arrange for messages to be scanned by
5626 SpamAssassin when Exim has been compiled with the content-scanning extension,
5627 and SpamAssassin has been installed. The SpamAssassin check is run with
5628 &`nobody`& as its user parameter, and the results are added to the message as a
5629 series of extra header line. In this case, the message is not rejected,
5630 whatever the spam score.
5631 .code
5632 accept
5633 .endd
5634 This final line in the DATA ACL accepts the message unconditionally.
5635
5636
5637 .section "Router configuration" "SECID55"
5638 .cindex "default" "routers"
5639 .cindex "routers" "default"
5640 The router configuration comes next in the default configuration, introduced
5641 by the line
5642 .code
5643 begin routers
5644 .endd
5645 Routers are the modules in Exim that make decisions about where to send
5646 messages. An address is passed to each router in turn, until it is either
5647 accepted, or failed. This means that the order in which you define the routers
5648 matters. Each router is fully described in its own chapter later in this
5649 manual. Here we give only brief overviews.
5650 .code
5651 # domain_literal:
5652 #   driver = ipliteral
5653 #   domains = !+local_domains
5654 #   transport = remote_smtp
5655 .endd
5656 .cindex "domain literal" "default router"
5657 This router is commented out because the majority of sites do not want to
5658 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
5659 you uncomment this router, you also need to uncomment the setting of
5660 &%allow_domain_literals%& in the main part of the configuration.
5661 .code
5662 dnslookup:
5663   driver = dnslookup
5664   domains = ! +local_domains
5665   transport = remote_smtp
5666   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
5667   no_more
5668 .endd
5669 The first uncommented router handles addresses that do not involve any local
5670 domains. This is specified by the line
5671 .code
5672 domains = ! +local_domains
5673 .endd
5674 The &%domains%& option lists the domains to which this router applies, but the
5675 exclamation mark is a negation sign, so the router is used only for domains
5676 that are not in the domain list called &'local_domains'& (which was defined at
5677 the start of the configuration). The plus sign before &'local_domains'&
5678 indicates that it is referring to a named list. Addresses in other domains are
5679 passed on to the following routers.
5680
5681 The name of the router driver is &(dnslookup)&,
5682 and is specified by the &%driver%& option. Do not be confused by the fact that
5683 the name of this router instance is the same as the name of the driver. The
5684 instance name is arbitrary, but the name set in the &%driver%& option must be
5685 one of the driver modules that is in the Exim binary.
5686
5687 The &(dnslookup)& router routes addresses by looking up their domains in the
5688 DNS in order to obtain a list of hosts to which the address is routed. If the
5689 router succeeds, the address is queued for the &(remote_smtp)& transport, as
5690 specified by the &%transport%& option. If the router does not find the domain
5691 in the DNS, no further routers are tried because of the &%no_more%& setting, so
5692 the address fails and is bounced.
5693
5694 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
5695 be entirely ignored. This option is present because a number of cases have been
5696 encountered where MX records in the DNS point to host names
5697 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
5698 Completely ignoring these IP addresses causes Exim to fail to route the
5699 email address, so it bounces. Otherwise, Exim would log a routing problem, and
5700 continue to try to deliver the message periodically until the address timed
5701 out.
5702 .code
5703 system_aliases:
5704   driver = redirect
5705   allow_fail
5706   allow_defer
5707   data = ${lookup{$local_part}lsearch{/etc/aliases}}
5708 # user = exim
5709   file_transport = address_file
5710   pipe_transport = address_pipe
5711 .endd
5712 Control reaches this and subsequent routers only for addresses in the local
5713 domains. This router checks to see whether the local part is defined as an
5714 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
5715 data that it looks up from that file. If no data is found for the local part,
5716 the value of the &%data%& option is empty, causing the address to be passed to
5717 the next router.
5718
5719 &_/etc/aliases_& is a conventional name for the system aliases file that is
5720 often used. That is why it is referenced by from the default configuration
5721 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
5722 &_Local/Makefile_& before building Exim.
5723 .code
5724 userforward:
5725   driver = redirect
5726   check_local_user
5727 # local_part_suffix = +* : -*
5728 # local_part_suffix_optional
5729   file = $home/.forward
5730 # allow_filter
5731   no_verify
5732   no_expn
5733   check_ancestor
5734   file_transport = address_file
5735   pipe_transport = address_pipe
5736   reply_transport = address_reply
5737 .endd
5738 This is the most complicated router in the default configuration. It is another
5739 redirection router, but this time it is looking for forwarding data set up by
5740 individual users. The &%check_local_user%& setting specifies a check that the
5741 local part of the address is the login name of a local user. If it is not, the
5742 router is skipped. The two commented options that follow &%check_local_user%&,
5743 namely:
5744 .code
5745 # local_part_suffix = +* : -*
5746 # local_part_suffix_optional
5747 .endd
5748 .vindex "&$local_part_suffix$&"
5749 show how you can specify the recognition of local part suffixes. If the first
5750 is uncommented, a suffix beginning with either a plus or a minus sign, followed
5751 by any sequence of characters, is removed from the local part and placed in the
5752 variable &$local_part_suffix$&. The second suffix option specifies that the
5753 presence of a suffix in the local part is optional. When a suffix is present,
5754 the check for a local login uses the local part with the suffix removed.
5755
5756 When a local user account is found, the file called &_.forward_& in the user's
5757 home directory is consulted. If it does not exist, or is empty, the router
5758 declines. Otherwise, the contents of &_.forward_& are interpreted as
5759 redirection data (see chapter &<<CHAPredirect>>& for more details).
5760
5761 .cindex "Sieve filter" "enabling in default router"
5762 Traditional &_.forward_& files contain just a list of addresses, pipes, or
5763 files. Exim supports this by default. However, if &%allow_filter%& is set (it
5764 is commented out by default), the contents of the file are interpreted as a set
5765 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
5766 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
5767 separate document entitled &'Exim's interfaces to mail filtering'&.
5768
5769 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
5770 verifying addresses, or when running as a consequence of an SMTP EXPN command.
5771 There are two reasons for doing this:
5772
5773 .olist
5774 Whether or not a local user has a &_.forward_& file is not really relevant when
5775 checking an address for validity; it makes sense not to waste resources doing
5776 unnecessary work.
5777 .next
5778 More importantly, when Exim is verifying addresses or handling an EXPN
5779 command during an SMTP session, it is running as the Exim user, not as root.
5780 The group is the Exim group, and no additional groups are set up.
5781 It may therefore not be possible for Exim to read users' &_.forward_& files at
5782 this time.
5783 .endlist
5784
5785 The setting of &%check_ancestor%& prevents the router from generating a new
5786 address that is the same as any previous address that was redirected. (This
5787 works round a problem concerning a bad interaction between aliasing and
5788 forwarding &-- see section &<<SECTredlocmai>>&).
5789
5790 The final three option settings specify the transports that are to be used when
5791 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
5792 auto-reply, respectively. For example, if a &_.forward_& file contains
5793 .code
5794 a.nother@elsewhere.example, /home/spqr/archive
5795 .endd
5796 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
5797 transport.
5798 .code
5799 localuser:
5800   driver = accept
5801   check_local_user
5802 # local_part_suffix = +* : -*
5803 # local_part_suffix_optional
5804   transport = local_delivery
5805 .endd
5806 The final router sets up delivery into local mailboxes, provided that the local
5807 part is the name of a local login, by accepting the address and assigning it to
5808 the &(local_delivery)& transport. Otherwise, we have reached the end of the
5809 routers, so the address is bounced. The commented suffix settings fulfil the
5810 same purpose as they do for the &(userforward)& router.
5811
5812
5813 .section "Transport configuration" "SECID56"
5814 .cindex "default" "transports"
5815 .cindex "transports" "default"
5816 Transports define mechanisms for actually delivering messages. They operate
5817 only when referenced from routers, so the order in which they are defined does
5818 not matter. The transports section of the configuration starts with
5819 .code
5820 begin transports
5821 .endd
5822 One remote transport and four local transports are defined.
5823 .code
5824 remote_smtp:
5825   driver = smtp
5826 .endd
5827 This transport is used for delivering messages over SMTP connections. All its
5828 options are defaulted. The list of remote hosts comes from the router.
5829 .code
5830 local_delivery:
5831   driver = appendfile
5832   file = /var/mail/$local_part
5833   delivery_date_add
5834   envelope_to_add
5835   return_path_add
5836 # group = mail
5837 # mode = 0660
5838 .endd
5839 This &(appendfile)& transport is used for local delivery to user mailboxes in
5840 traditional BSD mailbox format. By default it runs under the uid and gid of the
5841 local user, which requires the sticky bit to be set on the &_/var/mail_&
5842 directory. Some systems use the alternative approach of running mail deliveries
5843 under a particular group instead of using the sticky bit. The commented options
5844 show how this can be done.
5845
5846 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
5847 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
5848 similarly-named options above.
5849 .code
5850 address_pipe:
5851   driver = pipe
5852   return_output
5853 .endd
5854 This transport is used for handling deliveries to pipes that are generated by
5855 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
5856 option specifies that any output generated by the pipe is to be returned to the
5857 sender.
5858 .code
5859 address_file:
5860   driver = appendfile
5861   delivery_date_add
5862   envelope_to_add
5863   return_path_add
5864 .endd
5865 This transport is used for handling deliveries to files that are generated by
5866 redirection. The name of the file is not specified in this instance of
5867 &(appendfile)&, because it comes from the &(redirect)& router.
5868 .code
5869 address_reply:
5870   driver = autoreply
5871 .endd
5872 This transport is used for handling automatic replies generated by users'
5873 filter files.
5874
5875
5876
5877 .section "Default retry rule" "SECID57"
5878 .cindex "retry" "default rule"
5879 .cindex "default" "retry rule"
5880 The retry section of the configuration file contains rules which affect the way
5881 Exim retries deliveries that cannot be completed at the first attempt. It is
5882 introduced by the line
5883 .code
5884 begin retry
5885 .endd
5886 In the default configuration, there is just one rule, which applies to all
5887 errors:
5888 .code
5889 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
5890 .endd
5891 This causes any temporarily failing address to be retried every 15 minutes for
5892 2 hours, then at intervals starting at one hour and increasing by a factor of
5893 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
5894 is not delivered after 4 days of temporary failure, it is bounced.
5895
5896 If the retry section is removed from the configuration, or is empty (that is,
5897 if no retry rules are defined), Exim will not retry deliveries. This turns
5898 temporary errors into permanent errors.
5899
5900
5901 .section "Rewriting configuration" "SECID58"
5902 The rewriting section of the configuration, introduced by
5903 .code
5904 begin rewrite
5905 .endd
5906 contains rules for rewriting addresses in messages as they arrive. There are no
5907 rewriting rules in the default configuration file.
5908
5909
5910
5911 .section "Authenticators configuration" "SECTdefconfauth"
5912 .cindex "AUTH" "configuration"
5913 The authenticators section of the configuration, introduced by
5914 .code
5915 begin authenticators
5916 .endd
5917 defines mechanisms for the use of the SMTP AUTH command. The default
5918 configuration file contains two commented-out example authenticators
5919 which support plaintext username/password authentication using the
5920 standard PLAIN mechanism and the traditional but non-standard LOGIN
5921 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
5922 to support most MUA software.
5923
5924 The example PLAIN authenticator looks like this:
5925 .code
5926 #PLAIN:
5927 #  driver                  = plaintext
5928 #  server_set_id           = $auth2
5929 #  server_prompts          = :
5930 #  server_condition        = Authentication is not yet configured
5931 #  server_advertise_condition = ${if def:tls_cipher }
5932 .endd
5933 And the example LOGIN authenticator looks like this:
5934 .code
5935 #LOGIN:
5936 #  driver                  = plaintext
5937 #  server_set_id           = $auth1
5938 #  server_prompts          = <| Username: | Password:
5939 #  server_condition        = Authentication is not yet configured
5940 #  server_advertise_condition = ${if def:tls_cipher }
5941 .endd
5942
5943 The &%server_set_id%& option makes Exim remember the authenticated username
5944 in &$authenticated_id$&, which can be used later in ACLs or routers. The
5945 &%server_prompts%& option configures the &(plaintext)& authenticator so
5946 that it implements the details of the specific authentication mechanism,
5947 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
5948 when Exim offers authentication to clients; in the examples, this is only
5949 when TLS or SSL has been started, so to enable the authenticators you also
5950 need to add support for TLS as described in &<<SECTdefconfmain>>&.
5951
5952 The &%server_condition%& setting defines how to verify that the username and
5953 password are correct. In the examples it just produces an error message.
5954 To make the authenticators work, you can use a string expansion
5955 expression like one of the examples in &<<CHAPplaintext>>&.
5956
5957 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
5958 usercode and password are in different positions.  &<<CHAPplaintext>>&
5959 covers both.
5960
5961 .ecindex IIDconfiwal
5962
5963
5964
5965 . ////////////////////////////////////////////////////////////////////////////
5966 . ////////////////////////////////////////////////////////////////////////////
5967
5968 .chapter "Regular expressions" "CHAPregexp"
5969
5970 .cindex "regular expressions" "library"
5971 .cindex "PCRE"
5972 Exim supports the use of regular expressions in many of its options. It
5973 uses the PCRE regular expression library; this provides regular expression
5974 matching that is compatible with Perl 5. The syntax and semantics of
5975 regular expressions is discussed in many Perl reference books, and also in
5976 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
5977 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
5978
5979 The documentation for the syntax and semantics of the regular expressions that
5980 are supported by PCRE is included in the PCRE distribution, and no further
5981 description is included here. The PCRE functions are called from Exim using
5982 the default option settings (that is, with no PCRE options set), except that
5983 the PCRE_CASELESS option is set when the matching is required to be
5984 case-insensitive.
5985
5986 In most cases, when a regular expression is required in an Exim configuration,
5987 it has to start with a circumflex, in order to distinguish it from plain text
5988 or an &"ends with"& wildcard. In this example of a configuration setting, the
5989 second item in the colon-separated list is a regular expression.
5990 .code
5991 domains = a.b.c : ^\\d{3} : *.y.z : ...
5992 .endd
5993 The doubling of the backslash is required because of string expansion that
5994 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
5995 of this issue, and a way of avoiding the need for doubling backslashes. The
5996 regular expression that is eventually used in this example contains just one
5997 backslash. The circumflex is included in the regular expression, and has the
5998 normal effect of &"anchoring"& it to the start of the string that is being
5999 matched.
6000
6001 There are, however, two cases where a circumflex is not required for the
6002 recognition of a regular expression: these are the &%match%& condition in a
6003 string expansion, and the &%matches%& condition in an Exim filter file. In
6004 these cases, the relevant string is always treated as a regular expression; if
6005 it does not start with a circumflex, the expression is not anchored, and can
6006 match anywhere in the subject string.
6007
6008 In all cases, if you want a regular expression to match at the end of a string,
6009 you must code the $ metacharacter to indicate this. For example:
6010 .code
6011 domains = ^\\d{3}\\.example
6012 .endd
6013 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6014 You need to use:
6015 .code
6016 domains = ^\\d{3}\\.example\$
6017 .endd
6018 if you want &'example'& to be the top-level domain. The backslash before the
6019 $ is needed because string expansion also interprets dollar characters.
6020
6021
6022
6023 . ////////////////////////////////////////////////////////////////////////////
6024 . ////////////////////////////////////////////////////////////////////////////
6025
6026 .chapter "File and database lookups" "CHAPfdlookup"
6027 .scindex IIDfidalo1 "file" "lookups"
6028 .scindex IIDfidalo2 "database" "lookups"
6029 .cindex "lookup" "description of"
6030 Exim can be configured to look up data in files or databases as it processes
6031 messages. Two different kinds of syntax are used:
6032
6033 .olist
6034 A string that is to be expanded may contain explicit lookup requests. These
6035 cause parts of the string to be replaced by data that is obtained from the
6036 lookup. Lookups of this type are conditional expansion items. Different results
6037 can be defined for the cases of lookup success and failure. See chapter
6038 &<<CHAPexpand>>&, where string expansions are described in detail.
6039 .next
6040 Lists of domains, hosts, and email addresses can contain lookup requests as a
6041 way of avoiding excessively long linear lists. In this case, the data that is
6042 returned by the lookup is often (but not always) discarded; whether the lookup
6043 succeeds or fails is what really counts. These kinds of list are described in
6044 chapter &<<CHAPdomhosaddlists>>&.
6045 .endlist
6046
6047 String expansions, lists, and lookups interact with each other in such a way
6048 that there is no order in which to describe any one of them that does not
6049 involve references to the others. Each of these three chapters makes more sense
6050 if you have read the other two first. If you are reading this for the first
6051 time, be aware that some of it will make a lot more sense after you have read
6052 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6053
6054 .section "Examples of different lookup syntax" "SECID60"
6055 It is easy to confuse the two different kinds of lookup, especially as the
6056 lists that may contain the second kind are always expanded before being
6057 processed as lists. Therefore, they may also contain lookups of the first kind.
6058 Be careful to distinguish between the following two examples:
6059 .code
6060 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6061 domains = lsearch;/some/file
6062 .endd
6063 The first uses a string expansion, the result of which must be a domain list.
6064 No strings have been specified for a successful or a failing lookup; the
6065 defaults in this case are the looked-up data and an empty string, respectively.
6066 The expansion takes place before the string is processed as a list, and the
6067 file that is searched could contain lines like this:
6068 .code
6069 192.168.3.4: domain1:domain2:...
6070 192.168.1.9: domain3:domain4:...
6071 .endd
6072 When the lookup succeeds, the result of the expansion is a list of domains (and
6073 possibly other types of item that are allowed in domain lists).
6074
6075 In the second example, the lookup is a single item in a domain list. It causes
6076 Exim to use a lookup to see if the domain that is being processed can be found
6077 in the file. The file could contains lines like this:
6078 .code
6079 domain1:
6080 domain2:
6081 .endd
6082 Any data that follows the keys is not relevant when checking that the domain
6083 matches the list item.
6084
6085 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6086 Consider a file containing lines like this:
6087 .code
6088 192.168.5.6: lsearch;/another/file
6089 .endd
6090 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6091 first &%domains%& setting above generates the second setting, which therefore
6092 causes a second lookup to occur.
6093
6094 The rest of this chapter describes the different lookup types that are
6095 available. Any of them can be used in any part of the configuration where a
6096 lookup is permitted.
6097
6098
6099 .section "Lookup types" "SECID61"
6100 .cindex "lookup" "types of"
6101 .cindex "single-key lookup" "definition of"
6102 Two different types of data lookup are implemented:
6103
6104 .ilist
6105 The &'single-key'& type requires the specification of a file in which to look,
6106 and a single key to search for. The key must be a non-empty string for the
6107 lookup to succeed. The lookup type determines how the file is searched.
6108 .next
6109 .cindex "query-style lookup" "definition of"
6110 The &'query-style'& type accepts a generalized database query. No particular
6111 key value is assumed by Exim for query-style lookups. You can use whichever
6112 Exim variables you need to construct the database query.
6113 .endlist
6114
6115 The code for each lookup type is in a separate source file that is included in
6116 the binary of Exim only if the corresponding compile-time option is set. The
6117 default settings in &_src/EDITME_& are:
6118 .code
6119 LOOKUP_DBM=yes
6120 LOOKUP_LSEARCH=yes
6121 .endd
6122 which means that only linear searching and DBM lookups are included by default.
6123 For some types of lookup (e.g. SQL databases), you need to install appropriate
6124 libraries and header files before building Exim.
6125
6126
6127
6128
6129 .section "Single-key lookup types" "SECTsinglekeylookups"
6130 .cindex "lookup" "single-key types"
6131 .cindex "single-key lookup" "list of types"
6132 The following single-key lookup types are implemented:
6133
6134 .ilist
6135 .cindex "cdb" "description of"
6136 .cindex "lookup" "cdb"
6137 .cindex "binary zero" "in lookup key"
6138 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6139 string without a terminating binary zero. The cdb format is designed for
6140 indexed files that are read frequently and never updated, except by total
6141 re-creation. As such, it is particularly suitable for large files containing
6142 aliases or other indexed data referenced by an MTA. Information about cdb can
6143 be found in several places:
6144 .display
6145 &url(http://www.pobox.com/~djb/cdb.html)
6146 &url(ftp://ftp.corpit.ru/pub/tinycdb/)
6147 &url(http://packages.debian.org/stable/utils/freecdb.html)
6148 .endd
6149 A cdb distribution is not needed in order to build Exim with cdb support,
6150 because the code for reading cdb files is included directly in Exim itself.
6151 However, no means of building or testing cdb files is provided with Exim, so
6152 you need to obtain a cdb distribution in order to do this.
6153 .next
6154 .cindex "DBM" "lookup type"
6155 .cindex "lookup" "dbm"
6156 .cindex "binary zero" "in lookup key"
6157 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6158 DBM file by looking up the record with the given key. A terminating binary
6159 zero is included in the key that is passed to the DBM library. See section
6160 &<<SECTdb>>& for a discussion of DBM libraries.
6161
6162 .cindex "Berkeley DB library" "file format"
6163 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6164 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6165 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6166 the DB_UNKNOWN option. This enables it to handle any of the types of database
6167 that the library supports, and can be useful for accessing DBM files created by
6168 other applications. (For earlier DB versions, DB_HASH is always used.)
6169 .next
6170 .cindex "lookup" "dbmnz"
6171 .cindex "lookup" "dbm &-- terminating zero"
6172 .cindex "binary zero" "in lookup key"
6173 .cindex "Courier"
6174 .cindex "&_/etc/userdbshadow.dat_&"
6175 .cindex "dmbnz lookup type"
6176 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6177 is not included in the key that is passed to the DBM library. You may need this
6178 if you want to look up data in files that are created by or shared with some
6179 other application that does not use terminating zeros. For example, you need to
6180 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6181 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6182 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6183 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6184 .next
6185 .cindex "lookup" "dsearch"
6186 .cindex "dsearch lookup type"
6187 &(dsearch)&: The given file must be a directory; this is searched for an entry
6188 whose name is the key by calling the &[lstat()]& function. The key may not
6189 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6190 the lookup is the name of the entry, which may be a file, directory,
6191 symbolic link, or any other kind of directory entry. An example of how this
6192 lookup can be used to support virtual domains is given in section
6193 &<<SECTvirtualdomains>>&.
6194 .next
6195 .cindex "lookup" "iplsearch"
6196 .cindex "iplsearch lookup type"
6197 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6198 terminated by a colon or white space or the end of the line. The keys in the
6199 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6200 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6201 being interpreted as a key terminator. For example:
6202 .code
6203 1.2.3.4:           data for 1.2.3.4
6204 192.168.0.0/16:    data for 192.168.0.0/16
6205 "abcd::cdab":      data for abcd::cdab
6206 "abcd:abcd::/32"   data for abcd:abcd::/32
6207 .endd
6208 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6209 file is searched linearly, using the CIDR masks where present, until a matching
6210 key is found. The first key that matches is used; there is no attempt to find a
6211 &"best"& match. Apart from the way the keys are matched, the processing for
6212 &(iplsearch)& is the same as for &(lsearch)&.
6213
6214 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6215 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6216 lookup types support only literal keys.
6217
6218 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6219 the implicit key is the host's IP address rather than its name (see section
6220 &<<SECThoslispatsikey>>&).
6221 .next
6222 .cindex "linear search"
6223 .cindex "lookup" "lsearch"
6224 .cindex "lsearch lookup type"
6225 .cindex "case sensitivity" "in lsearch lookup"
6226 &(lsearch)&: The given file is a text file that is searched linearly for a
6227 line beginning with the search key, terminated by a colon or white space or the
6228 end of the line. The search is case-insensitive; that is, upper and lower case
6229 letters are treated as the same. The first occurrence of the key that is found
6230 in the file is used.
6231
6232 White space between the key and the colon is permitted. The remainder of the
6233 line, with leading and trailing white space removed, is the data. This can be
6234 continued onto subsequent lines by starting them with any amount of white
6235 space, but only a single space character is included in the data at such a
6236 junction. If the data begins with a colon, the key must be terminated by a
6237 colon, for example:
6238 .code
6239 baduser:  :fail:
6240 .endd
6241 Empty lines and lines beginning with # are ignored, even if they occur in the
6242 middle of an item. This is the traditional textual format of alias files. Note
6243 that the keys in an &(lsearch)& file are literal strings. There is no
6244 wildcarding of any kind.
6245
6246 .cindex "lookup" "lsearch &-- colons in keys"
6247 .cindex "white space" "in lsearch key"
6248 In most &(lsearch)& files, keys are not required to contain colons or #
6249 characters, or white space. However, if you need this feature, it is available.
6250 If a key begins with a doublequote character, it is terminated only by a
6251 matching quote (or end of line), and the normal escaping rules apply to its
6252 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6253 quoted keys (exactly as for unquoted keys). There is no special handling of
6254 quotes for the data part of an &(lsearch)& line.
6255
6256 .next
6257 .cindex "NIS lookup type"
6258 .cindex "lookup" "NIS"
6259 .cindex "binary zero" "in lookup key"
6260 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6261 the given key, without a terminating binary zero. There is a variant called
6262 &(nis0)& which does include the terminating binary zero in the key. This is
6263 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6264 aliases; the full map names must be used.
6265
6266 .next
6267 .cindex "wildlsearch lookup type"
6268 .cindex "lookup" "wildlsearch"
6269 .cindex "nwildlsearch lookup type"
6270 .cindex "lookup" "nwildlsearch"
6271 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6272 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6273 the file may be wildcarded. The difference between these two lookup types is
6274 that for &(wildlsearch)&, each key in the file is string-expanded before being
6275 used, whereas for &(nwildlsearch)&, no expansion takes place.
6276
6277 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6278 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6279 file that are regular expressions can be made case-sensitive by the use of
6280 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6281
6282 . ==== As this is a nested list, any displays it contains must be indented
6283 . ==== as otherwise they are too far to the left.
6284
6285 .olist
6286 The string may begin with an asterisk to mean &"ends with"&. For example:
6287 .code
6288     *.a.b.c       data for anything.a.b.c
6289     *fish         data for anythingfish
6290 .endd
6291 .next
6292 The string may begin with a circumflex to indicate a regular expression. For
6293 example, for &(wildlsearch)&:
6294 .code
6295     ^\N\d+\.a\.b\N    data for <digits>.a.b
6296 .endd
6297 Note the use of &`\N`& to disable expansion of the contents of the regular
6298 expression. If you are using &(nwildlsearch)&, where the keys are not
6299 string-expanded, the equivalent entry is:
6300 .code
6301     ^\d+\.a\.b        data for <digits>.a.b
6302 .endd
6303 The case-insensitive flag is set at the start of compiling the regular
6304 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6305 For example, to make the entire pattern case-sensitive:
6306 .code
6307     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6308 .endd
6309
6310 If the regular expression contains white space or colon characters, you must
6311 either quote it (see &(lsearch)& above), or represent these characters in other
6312 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6313 colon. This may be easier than quoting, because if you quote, you have to
6314 escape all the backslashes inside the quotes.
6315
6316 &*Note*&: It is not possible to capture substrings in a regular expression
6317 match for later use, because the results of all lookups are cached. If a lookup
6318 is repeated, the result is taken from the cache, and no actual pattern matching
6319 takes place. The values of all the numeric variables are unset after a
6320 &((n)wildlsearch)& match.
6321
6322 .next
6323 Although I cannot see it being of much use, the general matching function that
6324 is used to implement &((n)wildlsearch)& means that the string may begin with a
6325 lookup name terminated by a semicolon, and followed by lookup data. For
6326 example:
6327 .code
6328     cdb;/some/file  data for keys that match the file
6329 .endd
6330 The data that is obtained from the nested lookup is discarded.
6331 .endlist olist
6332
6333 Keys that do not match any of these patterns are interpreted literally. The
6334 continuation rules for the data are the same as for &(lsearch)&, and keys may
6335 be followed by optional colons.
6336
6337 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6338 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6339 lookup types support only literal keys.
6340 .endlist ilist
6341
6342
6343 .section "Query-style lookup types" "SECID62"
6344 .cindex "lookup" "query-style types"
6345 .cindex "query-style lookup" "list of types"
6346 The supported query-style lookup types are listed below. Further details about
6347 many of them are given in later sections.
6348
6349 .ilist
6350 .cindex "DNS" "as a lookup type"
6351 .cindex "lookup" "DNS"
6352 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6353 are given in the supplied query. The resulting data is the contents of the
6354 records. See section &<<SECTdnsdb>>&.
6355 .next
6356 .cindex "InterBase lookup type"
6357 .cindex "lookup" "InterBase"
6358 &(ibase)&: This does a lookup in an InterBase database.
6359 .next
6360 .cindex "LDAP" "lookup type"
6361 .cindex "lookup" "LDAP"
6362 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6363 returns attributes from a single entry. There is a variant called &(ldapm)&
6364 that permits values from multiple entries to be returned. A third variant
6365 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6366 any attribute values. See section &<<SECTldap>>&.
6367 .next
6368 .cindex "MySQL" "lookup type"
6369 .cindex "lookup" "MySQL"
6370 &(mysql)&: The format of the query is an SQL statement that is passed to a
6371 MySQL database. See section &<<SECTsql>>&.
6372 .next
6373 .cindex "NIS+ lookup type"
6374 .cindex "lookup" "NIS+"
6375 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6376 the field to be returned. See section &<<SECTnisplus>>&.
6377 .next
6378 .cindex "Oracle" "lookup type"
6379 .cindex "lookup" "Oracle"
6380 &(oracle)&: The format of the query is an SQL statement that is passed to an
6381 Oracle database. See section &<<SECTsql>>&.
6382 .next
6383 .cindex "lookup" "passwd"
6384 .cindex "passwd lookup type"
6385 .cindex "&_/etc/passwd_&"
6386 &(passwd)& is a query-style lookup with queries that are just user names. The
6387 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6388 success, the result string is the same as you would get from an &(lsearch)&
6389 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6390 password value. For example:
6391 .code
6392 *:42:42:King Rat:/home/kr:/bin/bash
6393 .endd
6394 .next
6395 .cindex "PostgreSQL lookup type"
6396 .cindex "lookup" "PostgreSQL"
6397 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6398 PostgreSQL database. See section &<<SECTsql>>&.
6399
6400 .next
6401 .cindex "sqlite lookup type"
6402 .cindex "lookup" "sqlite"
6403 &(sqlite)&: The format of the query is a file name followed by an SQL statement
6404 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6405
6406 .next
6407 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6408 not likely to be useful in normal operation.
6409 .next
6410 .cindex "whoson lookup type"
6411 .cindex "lookup" "whoson"
6412 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6413 allows a server to check whether a particular (dynamically allocated) IP
6414 address is currently allocated to a known (trusted) user and, optionally, to
6415 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6416 at one time for &"POP before SMTP"& authentication, but that approach has been
6417 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6418 &"POP before SMTP"& checking using ACL statements such as
6419 .code
6420 require condition = \
6421   ${lookup whoson {$sender_host_address}{yes}{no}}
6422 .endd
6423 The query consists of a single IP address. The value returned is the name of
6424 the authenticated user, which is stored in the variable &$value$&. However, in
6425 this example, the data in &$value$& is not used; the result of the lookup is
6426 one of the fixed strings &"yes"& or &"no"&.
6427 .endlist
6428
6429
6430
6431 .section "Temporary errors in lookups" "SECID63"
6432 .cindex "lookup" "temporary error in"
6433 Lookup functions can return temporary error codes if the lookup cannot be
6434 completed. For example, an SQL or LDAP database might be unavailable. For this
6435 reason, it is not advisable to use a lookup that might do this for critical
6436 options such as a list of local domains.
6437
6438 When a lookup cannot be completed in a router or transport, delivery
6439 of the message (to the relevant address) is deferred, as for any other
6440 temporary error. In other circumstances Exim may assume the lookup has failed,
6441 or may give up altogether.
6442
6443
6444
6445 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
6446 .cindex "wildcard lookups"
6447 .cindex "lookup" "default values"
6448 .cindex "lookup" "wildcard"
6449 .cindex "lookup" "* added to type"
6450 .cindex "default" "in single-key lookups"
6451 In this context, a &"default value"& is a value specified by the administrator
6452 that is to be used if a lookup fails.
6453
6454 &*Note:*& This section applies only to single-key lookups. For query-style
6455 lookups, the facilities of the query language must be used. An attempt to
6456 specify a default for a query-style lookup provokes an error.
6457
6458 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
6459 and the initial lookup fails, the key &"*"& is looked up in the file to
6460 provide a default value. See also the section on partial matching below.
6461
6462 .cindex "*@ with single-key lookup"
6463 .cindex "lookup" "*@ added to type"
6464 .cindex "alias file" "per-domain default"
6465 Alternatively, if &"*@"& is added to a single-key lookup type (for example
6466 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
6467 character, a second lookup is done with everything before the last @ replaced
6468 by *. This makes it possible to provide per-domain defaults in alias files
6469 that include the domains in the keys. If the second lookup fails (or doesn't
6470 take place because there is no @ in the key), &"*"& is looked up.
6471 For example, a &(redirect)& router might contain:
6472 .code
6473 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
6474 .endd
6475 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
6476 looks up these keys, in this order:
6477 .code
6478 jane@eyre.example
6479 *@eyre.example
6480 *
6481 .endd
6482 The data is taken from whichever key it finds first. &*Note*&: In an
6483 &(lsearch)& file, this does not mean the first of these keys in the file. A
6484 complete scan is done for each key, and only if it is not found at all does
6485 Exim move on to try the next key.
6486
6487
6488
6489 .section "Partial matching in single-key lookups" "SECTpartiallookup"
6490 .cindex "partial matching"
6491 .cindex "wildcard lookups"
6492 .cindex "lookup" "partial matching"
6493 .cindex "lookup" "wildcard"
6494 .cindex "asterisk" "in search type"
6495 The normal operation of a single-key lookup is to search the file for an exact
6496 match with the given key. However, in a number of situations where domains are
6497 being looked up, it is useful to be able to do partial matching. In this case,
6498 information in the file that has a key starting with &"*."& is matched by any
6499 domain that ends with the components that follow the full stop. For example, if
6500 a key in a DBM file is
6501 .code
6502 *.dates.fict.example
6503 .endd
6504 then when partial matching is enabled this is matched by (amongst others)
6505 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
6506 by &'dates.fict.example'&, if that does not appear as a separate key in the
6507 file.
6508
6509 &*Note*&: Partial matching is not available for query-style lookups. It is
6510 also not available for any lookup items in address lists (see section
6511 &<<SECTaddresslist>>&).
6512
6513 Partial matching is implemented by doing a series of separate lookups using
6514 keys constructed by modifying the original subject key. This means that it can
6515 be used with any of the single-key lookup types, provided that
6516 partial matching keys
6517 beginning with a special prefix (default &"*."&) are included in the data file.
6518 Keys in the file that do not begin with the prefix are matched only by
6519 unmodified subject keys when partial matching is in use.
6520
6521 Partial matching is requested by adding the string &"partial-"& to the front of
6522 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
6523 is done, the subject key is first looked up unmodified; if that fails, &"*."&
6524 is added at the start of the subject key, and it is looked up again. If that
6525 fails, further lookups are tried with dot-separated components removed from the
6526 start of the subject key, one-by-one, and &"*."& added on the front of what
6527 remains.
6528
6529 A minimum number of two non-* components are required. This can be adjusted
6530 by including a number before the hyphen in the search type. For example,
6531 &%partial3-lsearch%& specifies a minimum of three non-* components in the
6532 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
6533 subject key is &'2250.dates.fict.example'& then the following keys are looked
6534 up when the minimum number of non-* components is two:
6535 .code
6536 2250.dates.fict.example
6537 *.2250.dates.fict.example
6538 *.dates.fict.example
6539 *.fict.example
6540 .endd
6541 As soon as one key in the sequence is successfully looked up, the lookup
6542 finishes.
6543
6544 .cindex "lookup" "partial matching &-- changing prefix"
6545 .cindex "prefix" "for partial matching"
6546 The use of &"*."& as the partial matching prefix is a default that can be
6547 changed. The motivation for this feature is to allow Exim to operate with file
6548 formats that are used by other MTAs. A different prefix can be supplied in
6549 parentheses instead of the hyphen after &"partial"&. For example:
6550 .code
6551 domains = partial(.)lsearch;/some/file
6552 .endd
6553 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
6554 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
6555 components is unchanged). The prefix may consist of any punctuation characters
6556 other than a closing parenthesis. It may be empty, for example:
6557 .code
6558 domains = partial1()cdb;/some/file
6559 .endd
6560 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
6561 &`a.b.c`&, &`b.c`&, and &`c`&.
6562
6563 If &"partial0"& is specified, what happens at the end (when the lookup with
6564 just one non-wild component has failed, and the original key is shortened right
6565 down to the null string) depends on the prefix:
6566
6567 .ilist
6568 If the prefix has zero length, the whole lookup fails.
6569 .next
6570 If the prefix has length 1, a lookup for just the prefix is done. For
6571 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
6572 .next
6573 Otherwise, if the prefix ends in a dot, the dot is removed, and the
6574 remainder is looked up. With the default prefix, therefore, the final lookup is
6575 for &"*"& on its own.
6576 .next
6577 Otherwise, the whole prefix is looked up.
6578 .endlist
6579
6580
6581 If the search type ends in &"*"& or &"*@"& (see section
6582 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
6583 this implies happens after all partial lookups have failed. If &"partial0"& is
6584 specified, adding &"*"& to the search type has no effect with the default
6585 prefix, because the &"*"& key is already included in the sequence of partial
6586 lookups. However, there might be a use for lookup types such as
6587 &"partial0(.)lsearch*"&.
6588
6589 The use of &"*"& in lookup partial matching differs from its use as a wildcard
6590 in domain lists and the like. Partial matching works only in terms of
6591 dot-separated components; a key such as &`*fict.example`&
6592 in a database file is useless, because the asterisk in a partial matching
6593 subject key is always followed by a dot.
6594
6595
6596
6597
6598 .section "Lookup caching" "SECID64"
6599 .cindex "lookup" "caching"
6600 .cindex "caching" "lookup data"
6601 Exim caches all lookup results in order to avoid needless repetition of
6602 lookups. However, because (apart from the daemon) Exim operates as a collection
6603 of independent, short-lived processes, this caching applies only within a
6604 single Exim process. There is no inter-process lookup caching facility.
6605
6606 For single-key lookups, Exim keeps the relevant files open in case there is
6607 another lookup that needs them. In some types of configuration this can lead to
6608 many files being kept open for messages with many recipients. To avoid hitting
6609 the operating system limit on the number of simultaneously open files, Exim
6610 closes the least recently used file when it needs to open more files than its
6611 own internal limit, which can be changed via the &%lookup_open_max%& option.
6612
6613 The single-key lookup files are closed and the lookup caches are flushed at
6614 strategic points during delivery &-- for example, after all routing is
6615 complete.
6616
6617
6618
6619
6620 .section "Quoting lookup data" "SECID65"
6621 .cindex "lookup" "quoting"
6622 .cindex "quoting" "in lookups"
6623 When data from an incoming message is included in a query-style lookup, there
6624 is the possibility of special characters in the data messing up the syntax of
6625 the query. For example, a NIS+ query that contains
6626 .code
6627 [name=$local_part]
6628 .endd
6629 will be broken if the local part happens to contain a closing square bracket.
6630 For NIS+, data can be enclosed in double quotes like this:
6631 .code
6632 [name="$local_part"]
6633 .endd
6634 but this still leaves the problem of a double quote in the data. The rule for
6635 NIS+ is that double quotes must be doubled. Other lookup types have different
6636 rules, and to cope with the differing requirements, an expansion operator
6637 of the following form is provided:
6638 .code
6639 ${quote_<lookup-type>:<string>}
6640 .endd
6641 For example, the safest way to write the NIS+ query is
6642 .code
6643 [name="${quote_nisplus:$local_part}"]
6644 .endd
6645 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
6646 operator can be used for all lookup types, but has no effect for single-key
6647 lookups, since no quoting is ever needed in their key strings.
6648
6649
6650
6651
6652 .section "More about dnsdb" "SECTdnsdb"
6653 .cindex "dnsdb lookup"
6654 .cindex "lookup" "dnsdb"
6655 .cindex "DNS" "as a lookup type"
6656 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
6657 of a record type and a domain name, separated by an equals sign. For example,
6658 an expansion string could contain:
6659 .code
6660 ${lookup dnsdb{mx=a.b.example}{$value}fail}
6661 .endd
6662 If the lookup succeeds, the result is placed in &$value$&, which in this case
6663 is used on its own as the result. If the lookup does not succeed, the
6664 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
6665 &<<SECTforexpfai>>& for an explanation of what this means.
6666
6667 The supported DNS record types are A, CNAME, MX, NS, PTR, SRV, and TXT, and,
6668 when Exim is compiled with IPv6 support, AAAA (and A6 if that is also
6669 configured). If no type is given, TXT is assumed. When the type is PTR,
6670 the data can be an IP address, written as normal; inversion and the addition of
6671 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
6672 .code
6673 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
6674 .endd
6675 If the data for a PTR record is not a syntactically valid IP address, it is not
6676 altered and nothing is added.
6677
6678 .cindex "MX record" "in &(dnsdb)& lookup"
6679 .cindex "SRV record" "in &(dnsdb)& lookup"
6680 For an MX lookup, both the preference value and the host name are returned for
6681 each record, separated by a space. For an SRV lookup, the priority, weight,
6682 port, and host name are returned for each record, separated by spaces.
6683
6684 For any record type, if multiple records are found (or, for A6 lookups, if a
6685 single record leads to multiple addresses), the data is returned as a
6686 concatenation, with newline as the default separator. The order, of course,
6687 depends on the DNS resolver. You can specify a different separator character
6688 between multiple records by putting a right angle-bracket followed immediately
6689 by the new separator at the start of the query. For example:
6690 .code
6691 ${lookup dnsdb{>: a=host1.example}}
6692 .endd
6693 It is permitted to specify a space as the separator character. Further
6694 white space is ignored.
6695
6696 .cindex "TXT record" "in &(dnsdb)& lookup"
6697 For TXT records with multiple items of data, only the first item is returned,
6698 unless a separator for them is specified using a comma after the separator
6699 character followed immediately by the TXT record item separator. To concatenate
6700 items without a separator, use a semicolon instead.
6701 .code
6702 ${lookup dnsdb{>\n,: txt=a.b.example}}
6703 ${lookup dnsdb{>\n; txt=a.b.example}}
6704 .endd
6705 It is permitted to specify a space as the separator character. Further
6706 white space is ignored.
6707
6708 .section "Pseudo dnsdb record types" "SECID66"
6709 .cindex "MX record" "in &(dnsdb)& lookup"
6710 By default, both the preference value and the host name are returned for
6711 each MX record, separated by a space. If you want only host names, you can use
6712 the pseudo-type MXH:
6713 .code
6714 ${lookup dnsdb{mxh=a.b.example}}
6715 .endd
6716 In this case, the preference values are omitted, and just the host names are
6717 returned.
6718
6719 .cindex "name server for enclosing domain"
6720 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
6721 records on the given domain, but if none are found, it removes the first
6722 component of the domain name, and tries again. This process continues until NS
6723 records are found or there are no more components left (or there is a DNS
6724 error). In other words, it may return the name servers for a top-level domain,
6725 but it never returns the root name servers. If there are no NS records for the
6726 top-level domain, the lookup fails. Consider these examples:
6727 .code
6728 ${lookup dnsdb{zns=xxx.quercite.com}}
6729 ${lookup dnsdb{zns=xxx.edu}}
6730 .endd
6731 Assuming that in each case there are no NS records for the full domain name,
6732 the first returns the name servers for &%quercite.com%&, and the second returns
6733 the name servers for &%edu%&.
6734
6735 You should be careful about how you use this lookup because, unless the
6736 top-level domain does not exist, the lookup always returns some host names. The
6737 sort of use to which this might be put is for seeing if the name servers for a
6738 given domain are on a blacklist. You can probably assume that the name servers
6739 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
6740 such a list.
6741
6742 .cindex "CSA" "in &(dnsdb)& lookup"
6743 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
6744 records according to the CSA rules, which are described in section
6745 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
6746 not sufficient because of the extra parent domain search behaviour of CSA. The
6747 result of a successful lookup such as:
6748 .code
6749 ${lookup dnsdb {csa=$sender_helo_name}}
6750 .endd
6751 has two space-separated fields: an authorization code and a target host name.
6752 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
6753 authorization required but absent, or &"?"& for unknown.
6754
6755
6756 .section "Multiple dnsdb lookups" "SECID67"
6757 In the previous sections, &(dnsdb)& lookups for a single domain are described.
6758 However, you can specify a list of domains or IP addresses in a single
6759 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
6760 the default separator, but with the ability to change this. For example:
6761 .code
6762 ${lookup dnsdb{one.domain.com:two.domain.com}}
6763 ${lookup dnsdb{a=one.host.com:two.host.com}}
6764 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
6765 .endd
6766 In order to retain backwards compatibility, there is one special case: if
6767 the lookup type is PTR and no change of separator is specified, Exim looks
6768 to see if the rest of the string is precisely one IPv6 address. In this
6769 case, it does not treat it as a list.
6770
6771 The data from each lookup is concatenated, with newline separators by default,
6772 in the same way that multiple DNS records for a single item are handled. A
6773 different separator can be specified, as described above.
6774
6775 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
6776 temporary DNS error for any of them, the behaviour is controlled by
6777 an optional keyword followed by a comma that may appear before the record
6778 type. The possible keywords are &"defer_strict"&, &"defer_never"&, and
6779 &"defer_lax"&. With &"strict"& behaviour, any temporary DNS error causes the
6780 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
6781 ignored, and the behaviour is as if the DNS lookup failed to find anything.
6782 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
6783 error causes the whole lookup to defer only if none of the other lookups
6784 succeed. The default is &"lax"&, so the following lookups are equivalent:
6785 .code
6786 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
6787 ${lookup dnsdb{a=one.host.com:two.host.com}}
6788 .endd
6789 Thus, in the default case, as long as at least one of the DNS lookups
6790 yields some data, the lookup succeeds.
6791
6792
6793
6794
6795 .section "More about LDAP" "SECTldap"
6796 .cindex "LDAP" "lookup, more about"
6797 .cindex "lookup" "LDAP"
6798 .cindex "Solaris" "LDAP"
6799 The original LDAP implementation came from the University of Michigan; this has
6800 become &"Open LDAP"&, and there are now two different releases. Another
6801 implementation comes from Netscape, and Solaris 7 and subsequent releases
6802 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
6803 the lookup function level, their error handling is different. For this reason
6804 it is necessary to set a compile-time variable when building Exim with LDAP, to
6805 indicate which LDAP library is in use. One of the following should appear in
6806 your &_Local/Makefile_&:
6807 .code
6808 LDAP_LIB_TYPE=UMICHIGAN
6809 LDAP_LIB_TYPE=OPENLDAP1
6810 LDAP_LIB_TYPE=OPENLDAP2
6811 LDAP_LIB_TYPE=NETSCAPE
6812 LDAP_LIB_TYPE=SOLARIS
6813 .endd
6814 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
6815 same interface as the University of Michigan version.
6816
6817 There are three LDAP lookup types in Exim. These behave slightly differently in
6818 the way they handle the results of a query:
6819
6820 .ilist
6821 &(ldap)& requires the result to contain just one entry; if there are more, it
6822 gives an error.
6823 .next
6824 &(ldapdn)& also requires the result to contain just one entry, but it is the
6825 Distinguished Name that is returned rather than any attribute values.
6826 .next
6827 &(ldapm)& permits the result to contain more than one entry; the attributes
6828 from all of them are returned.
6829 .endlist
6830
6831
6832 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
6833 Exim behaves as if the entry did not exist, and the lookup fails. The format of
6834 the data returned by a successful lookup is described in the next section.
6835 First we explain how LDAP queries are coded.
6836
6837
6838 .section "Format of LDAP queries" "SECTforldaque"
6839 .cindex "LDAP" "query format"
6840 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
6841 the configuration of a &(redirect)& router one might have this setting:
6842 .code
6843 data = ${lookup ldap \
6844   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
6845   c=UK?mailbox?base?}}
6846 .endd
6847 .cindex "LDAP" "with TLS"
6848 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
6849 secure (encrypted) LDAP connections. The second of these ensures that an
6850 encrypted TLS connection is used.
6851
6852
6853 .section "LDAP quoting" "SECID68"
6854 .cindex "LDAP" "quoting"
6855 Two levels of quoting are required in LDAP queries, the first for LDAP itself
6856 and the second because the LDAP query is represented as a URL. Furthermore,
6857 within an LDAP query, two different kinds of quoting are required. For this
6858 reason, there are two different LDAP-specific quoting operators.
6859
6860 The &%quote_ldap%& operator is designed for use on strings that are part of
6861 filter specifications. Conceptually, it first does the following conversions on
6862 the string:
6863 .code
6864 *   =>   \2A
6865 (   =>   \28
6866 )   =>   \29
6867 \   =>   \5C
6868 .endd
6869 in accordance with RFC 2254. The resulting string is then quoted according
6870 to the rules for URLs, that is, all non-alphanumeric characters except
6871 .code
6872 ! $ ' - . _ ( ) * +
6873 .endd
6874 are converted to their hex values, preceded by a percent sign. For example:
6875 .code
6876 ${quote_ldap: a(bc)*, a<yz>; }
6877 .endd
6878 yields
6879 .code
6880 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
6881 .endd
6882 Removing the URL quoting, this is (with a leading and a trailing space):
6883 .code
6884 a\28bc\29\2A, a<yz>;
6885 .endd
6886 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
6887 base DN specifications in queries. Conceptually, it first converts the string
6888 by inserting a backslash in front of any of the following characters:
6889 .code
6890 , + " \ < > ;
6891 .endd
6892 It also inserts a backslash before any leading spaces or # characters, and
6893 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
6894 is then quoted according to the rules for URLs. For example:
6895 .code
6896 ${quote_ldap_dn: a(bc)*, a<yz>; }
6897 .endd
6898 yields
6899 .code
6900 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
6901 .endd
6902 Removing the URL quoting, this is (with a trailing space):
6903 .code
6904 \ a(bc)*\, a\<yz\>\;\
6905 .endd
6906 There are some further comments about quoting in the section on LDAP
6907 authentication below.
6908
6909
6910 .section "LDAP connections" "SECID69"
6911 .cindex "LDAP" "connections"
6912 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
6913 is in use, via a Unix domain socket. The example given above does not specify
6914 an LDAP server. A server that is reached by TCP/IP can be specified in a query
6915 by starting it with
6916 .code
6917 ldap://<hostname>:<port>/...
6918 .endd
6919 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
6920 used. When no server is specified in a query, a list of default servers is
6921 taken from the &%ldap_default_servers%& configuration option. This supplies a
6922 colon-separated list of servers which are tried in turn until one successfully
6923 handles a query, or there is a serious error. Successful handling either
6924 returns the requested data, or indicates that it does not exist. Serious errors
6925 are syntactical, or multiple values when only a single value is expected.
6926 Errors which cause the next server to be tried are connection failures, bind
6927 failures, and timeouts.
6928
6929 For each server name in the list, a port number can be given. The standard way
6930 of specifying a host and port is to use a colon separator (RFC 1738). Because
6931 &%ldap_default_servers%& is a colon-separated list, such colons have to be
6932 doubled. For example
6933 .code
6934 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
6935 .endd
6936 If &%ldap_default_servers%& is unset, a URL with no server name is passed
6937 to the LDAP library with no server name, and the library's default (normally
6938 the local host) is used.
6939
6940 If you are using the OpenLDAP library, you can connect to an LDAP server using
6941 a Unix domain socket instead of a TCP/IP connection. This is specified by using
6942 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
6943 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
6944 not available.
6945
6946 For this type of connection, instead of a host name for the server, a pathname
6947 for the socket is required, and the port number is not relevant. The pathname
6948 can be specified either as an item in &%ldap_default_servers%&, or inline in
6949 the query. In the former case, you can have settings such as
6950 .code
6951 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
6952 .endd
6953 When the pathname is given in the query, you have to escape the slashes as
6954 &`%2F`& to fit in with the LDAP URL syntax. For example:
6955 .code
6956 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
6957 .endd
6958 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
6959 a pathname, it uses the Unix domain socket code, even if the query actually
6960 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
6961 socket connection. This behaviour means that you can use a setting of
6962 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
6963 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
6964 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
6965 backup host.
6966
6967 If an explicit &`ldapi`& type is given in a query when a host name is
6968 specified, an error is diagnosed. However, if there are more items in
6969 &%ldap_default_servers%&, they are tried. In other words:
6970
6971 .ilist
6972 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
6973 interface.
6974 .next
6975 Using &`ldapi`& with a host name causes an error.
6976 .endlist
6977
6978
6979 Using &`ldapi`& with no host or path in the query, and no setting of
6980 &%ldap_default_servers%&, does whatever the library does by default.
6981
6982
6983
6984 .section "LDAP authentication and control information" "SECID70"
6985 .cindex "LDAP" "authentication"
6986 The LDAP URL syntax provides no way of passing authentication and other control
6987 information to the server. To make this possible, the URL in an LDAP query may
6988 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
6989 spaces. If a value contains spaces it must be enclosed in double quotes, and
6990 when double quotes are used, backslash is interpreted in the usual way inside
6991 them. The following names are recognized:
6992 .display
6993 &`DEREFERENCE`&  set the dereferencing parameter
6994 &`NETTIME    `&  set a timeout for a network operation
6995 &`USER       `&  set the DN, for authenticating the LDAP bind
6996 &`PASS       `&  set the password, likewise
6997 &`REFERRALS  `&  set the referrals parameter
6998 &`SIZE       `&  set the limit for the number of entries returned
6999 &`TIME       `&  set the maximum waiting time for a query
7000 .endd
7001 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7002 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7003 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7004 library from trying to follow referrals issued by the LDAP server.
7005
7006 The name CONNECT is an obsolete name for NETTIME, retained for
7007 backwards compatibility. This timeout (specified as a number of seconds) is
7008 enforced from the client end for operations that can be carried out over a
7009 network. Specifically, it applies to network connections and calls to the
7010 &'ldap_result()'& function. If the value is greater than zero, it is used if
7011 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7012 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7013 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7014 Netscape SDK; for OpenLDAP no action is taken.
7015
7016 The TIME parameter (also a number of seconds) is passed to the server to
7017 set a server-side limit on the time taken to complete a search.
7018
7019
7020 Here is an example of an LDAP query in an Exim lookup that uses some of these
7021 values. This is a single line, folded to fit on the page:
7022 .code
7023 ${lookup ldap
7024   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7025   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7026   {$value}fail}
7027 .endd
7028 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7029 any of the auxiliary data. Exim configuration settings that include lookups
7030 which contain password information should be preceded by &"hide"& to prevent
7031 non-admin users from using the &%-bP%& option to see their values.
7032
7033 The auxiliary data items may be given in any order. The default is no
7034 connection timeout (the system timeout is used), no user or password, no limit
7035 on the number of entries returned, and no time limit on queries.
7036
7037 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7038 removes any URL quoting that it may contain before passing it LDAP. Apparently
7039 some libraries do this for themselves, but some do not. Removing the URL
7040 quoting has two advantages:
7041
7042 .ilist
7043 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7044 DNs as with DNs inside actual queries.
7045 .next
7046 It permits spaces inside USER= DNs.
7047 .endlist
7048
7049 For example, a setting such as
7050 .code
7051 USER=cn=${quote_ldap_dn:$1}
7052 .endd
7053 should work even if &$1$& contains spaces.
7054
7055 Expanded data for the PASS= value should be quoted using the &%quote%&
7056 expansion operator, rather than the LDAP quote operators. The only reason this
7057 field needs quoting is to ensure that it conforms to the Exim syntax, which
7058 does not allow unquoted spaces. For example:
7059 .code
7060 PASS=${quote:$3}
7061 .endd
7062 The LDAP authentication mechanism can be used to check passwords as part of
7063 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7064 &<<CHAPexpand>>&.
7065
7066
7067
7068 .section "Format of data returned by LDAP" "SECID71"
7069 .cindex "LDAP" "returned data formats"
7070 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7071 as a sequence of values, for example
7072 .code
7073 cn=manager, o=University of Cambridge, c=UK
7074 .endd
7075 The &(ldap)& lookup type generates an error if more than one entry matches the
7076 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7077 the result between the data from different entries. It is possible for multiple
7078 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7079 you know that whatever values are returned all came from a single entry in the
7080 directory.
7081
7082 In the common case where you specify a single attribute in your LDAP query, the
7083 result is not quoted, and does not contain the attribute name. If the attribute
7084 has multiple values, they are separated by commas.
7085
7086 If you specify multiple attributes, the result contains space-separated, quoted
7087 strings, each preceded by the attribute name and an equals sign. Within the
7088 quotes, the quote character, backslash, and newline are escaped with
7089 backslashes, and commas are used to separate multiple values for the attribute.
7090 Apart from the escaping, the string within quotes takes the same form as the
7091 output when a single attribute is requested. Specifying no attributes is the
7092 same as specifying all of an entry's attributes.
7093
7094 Here are some examples of the output format. The first line of each pair is an
7095 LDAP query, and the second is the data that is returned. The attribute called
7096 &%attr1%& has two values, whereas &%attr2%& has only one value:
7097 .code
7098 ldap:///o=base?attr1?sub?(uid=fred)
7099 value1.1, value1.2
7100
7101 ldap:///o=base?attr2?sub?(uid=fred)
7102 value two
7103
7104 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7105 attr1="value1.1, value1.2" attr2="value two"
7106
7107 ldap:///o=base??sub?(uid=fred)
7108 objectClass="top" attr1="value1.1, value1.2" attr2="value two"
7109 .endd
7110 The &%extract%& operator in string expansions can be used to pick out
7111 individual fields from data that consists of &'key'&=&'value'& pairs. You can
7112 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7113 results of LDAP lookups.
7114
7115
7116
7117
7118 .section "More about NIS+" "SECTnisplus"
7119 .cindex "NIS+ lookup type"
7120 .cindex "lookup" "NIS+"
7121 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7122 and field name. If this is given, the result of a successful query is the
7123 contents of the named field; otherwise the result consists of a concatenation
7124 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7125 values containing spaces are quoted. For example, the query
7126 .code
7127 [name=mg1456],passwd.org_dir
7128 .endd
7129 might return the string
7130 .code
7131 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7132 home=/home/mg1456 shell=/bin/bash shadow=""
7133 .endd
7134 (split over two lines here to fit on the page), whereas
7135 .code
7136 [name=mg1456],passwd.org_dir:gcos
7137 .endd
7138 would just return
7139 .code
7140 Martin Guerre
7141 .endd
7142 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7143 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7144 operator is to double any quote characters within the text.
7145
7146
7147
7148 .section "SQL lookups" "SECTsql"
7149 .cindex "SQL lookup types"
7150 .cindex "MySQL" "lookup type"
7151 .cindex "PostgreSQL lookup type"
7152 .cindex "lookup" "MySQL"
7153 .cindex "lookup" "PostgreSQL"
7154 .cindex "Oracle" "lookup type"
7155 .cindex "lookup" "Oracle"
7156 .cindex "InterBase lookup type"
7157 .cindex "lookup" "InterBase"
7158 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, and SQLite
7159 databases. Queries for these databases contain SQL statements, so an example
7160 might be
7161 .code
7162 ${lookup mysql{select mailbox from users where id='userx'}\
7163   {$value}fail}
7164 .endd
7165 If the result of the query contains more than one field, the data for each
7166 field in the row is returned, preceded by its name, so the result of
7167 .code
7168 ${lookup pgsql{select home,name from users where id='userx'}\
7169   {$value}}
7170 .endd
7171 might be
7172 .code
7173 home=/home/userx name="Mister X"
7174 .endd
7175 Empty values and values containing spaces are double quoted, with embedded
7176 quotes escaped by a backslash. If the result of the query contains just one
7177 field, the value is passed back verbatim, without a field name, for example:
7178 .code
7179 Mister X
7180 .endd
7181 If the result of the query yields more than one row, it is all concatenated,
7182 with a newline between the data for each row.
7183
7184
7185 .section "More about MySQL, PostgreSQL, Oracle, and InterBase" "SECID72"
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 If any MySQL, PostgreSQL, Oracle, or InterBase lookups are used, the
7195 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, or &%ibase_servers%&
7196 option (as appropriate) must be set to a colon-separated list of server
7197 information.
7198 (For MySQL and PostgreSQL only, the global option need not be set if all
7199 queries contain their own server information &-- see section
7200 &<<SECTspeserque>>&.) Each item in the list is a slash-separated list of four
7201 items: host name, database name, user name, and password. In the case of
7202 Oracle, the host name field is used for the &"service name"&, and the database
7203 name field is not used and should be empty. For example:
7204 .code
7205 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7206 .endd
7207 Because password data is sensitive, you should always precede the setting with
7208 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7209 option. Here is an example where two MySQL servers are listed:
7210 .code
7211 hide mysql_servers = localhost/users/root/secret:\
7212                      otherhost/users/root/othersecret
7213 .endd
7214 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7215 because this is a colon-separated list, the colon has to be doubled. For each
7216 query, these parameter groups are tried in order until a connection is made and
7217 a query is successfully processed. The result of a query may be that no data is
7218 found, but that is still a successful query. In other words, the list of
7219 servers provides a backup facility, not a list of different places to look.
7220
7221 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7222 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7223 respectively, and the characters single-quote, double-quote, and backslash
7224 itself are escaped with backslashes. The &%quote_pgsql%& expansion operator, in
7225 addition, escapes the percent and underscore characters. This cannot be done
7226 for MySQL because these escapes are not recognized in contexts where these
7227 characters are not special.
7228
7229 .section "Specifying the server in the query" "SECTspeserque"
7230 For MySQL and PostgreSQL lookups (but not currently for Oracle and InterBase),
7231 it is possible to specify a list of servers with an individual query. This is
7232 done by starting the query with
7233 .display
7234 &`servers=`&&'server1:server2:server3:...'&&`;`&
7235 .endd
7236 Each item in the list may take one of two forms:
7237 .olist
7238 If it contains no slashes it is assumed to be just a host name. The appropriate
7239 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7240 of the same name, and the remaining parameters (database, user, password) are
7241 taken from there.
7242 .next
7243 If it contains any slashes, it is taken as a complete parameter set.
7244 .endlist
7245 The list of servers is used in exactly the same way as the global list.
7246 Once a connection to a server has happened and a query has been
7247 successfully executed, processing of the lookup ceases.
7248
7249 This feature is intended for use in master/slave situations where updates
7250 are occurring and you want to update the master rather than a slave. If the
7251 master is in the list as a backup for reading, you might have a global setting
7252 like this:
7253 .code
7254 mysql_servers = slave1/db/name/pw:\
7255                 slave2/db/name/pw:\
7256                 master/db/name/pw
7257 .endd
7258 In an updating lookup, you could then write:
7259 .code
7260 ${lookup mysql{servers=master; UPDATE ...} }
7261 .endd
7262 That query would then be sent only to the master server. If, on the other hand,
7263 the master is not to be used for reading, and so is not present in the global
7264 option, you can still update it by a query of this form:
7265 .code
7266 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7267 .endd
7268
7269
7270 .section "Special MySQL features" "SECID73"
7271 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7272 causes a connection to the server on the local host by means of a Unix domain
7273 socket. An alternate socket can be specified in parentheses. The full syntax of
7274 each item in &%mysql_servers%& is:
7275 .display
7276 <&'hostname'&>::<&'port'&>(<&'socket name'&>)/<&'database'&>/&&&
7277   <&'user'&>/<&'password'&>
7278 .endd
7279 Any of the three sub-parts of the first field can be omitted. For normal use on
7280 the local host it can be left blank or set to just &"localhost"&.
7281
7282 No database need be supplied &-- but if it is absent here, it must be given in
7283 the queries.
7284
7285 If a MySQL query is issued that does not request any data (an insert, update,
7286 or delete command), the result of the lookup is the number of rows affected.
7287
7288 &*Warning*&: This can be misleading. If an update does not actually change
7289 anything (for example, setting a field to the value it already has), the result
7290 is zero because no rows are affected.
7291
7292
7293 .section "Special PostgreSQL features" "SECID74"
7294 PostgreSQL lookups can also use Unix domain socket connections to the database.
7295 This is usually faster and costs less CPU time than a TCP/IP connection.
7296 However it can be used only if the mail server runs on the same machine as the
7297 database server. A configuration line for PostgreSQL via Unix domain sockets
7298 looks like this:
7299 .code
7300 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7301 .endd
7302 In other words, instead of supplying a host name, a path to the socket is
7303 given. The path name is enclosed in parentheses so that its slashes aren't
7304 visually confused with the delimiters for the other server parameters.
7305
7306 If a PostgreSQL query is issued that does not request any data (an insert,
7307 update, or delete command), the result of the lookup is the number of rows
7308 affected.
7309
7310 .section "More about SQLite" "SECTsqlite"
7311 .cindex "lookup" "SQLite"
7312 .cindex "sqlite lookup type"
7313 SQLite is different to the other SQL lookups because a file name is required in
7314 addition to the SQL query. An SQLite database is a single file, and there is no
7315 daemon as in the other SQL databases. The interface to Exim requires the name
7316 of the file, as an absolute path, to be given at the start of the query. It is
7317 separated from the query by white space. This means that the path name cannot
7318 contain white space. Here is a lookup expansion example:
7319 .code
7320 ${lookup sqlite {/some/thing/sqlitedb \
7321   select name from aliases where id='userx';}}
7322 .endd
7323 In a list, the syntax is similar. For example:
7324 .code
7325 domainlist relay_domains = sqlite;/some/thing/sqlitedb \
7326    select * from relays where ip='$sender_host_address';
7327 .endd
7328 The only character affected by the &%quote_sqlite%& operator is a single
7329 quote, which it doubles.
7330
7331 The SQLite library handles multiple simultaneous accesses to the database
7332 internally. Multiple readers are permitted, but only one process can
7333 update at once. Attempts to access the database while it is being updated
7334 are rejected after a timeout period, during which the SQLite library
7335 waits for the lock to be released. In Exim, the default timeout is set
7336 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7337 option.
7338 .ecindex IIDfidalo1
7339 .ecindex IIDfidalo2
7340
7341
7342 . ////////////////////////////////////////////////////////////////////////////
7343 . ////////////////////////////////////////////////////////////////////////////
7344
7345 .chapter "Domain, host, address, and local part lists" &&&
7346          "CHAPdomhosaddlists" &&&
7347          "Domain, host, and address lists"
7348 .scindex IIDdohoadli "lists of domains; hosts; etc."
7349 A number of Exim configuration options contain lists of domains, hosts,
7350 email addresses, or local parts. For example, the &%hold_domains%& option
7351 contains a list of domains whose delivery is currently suspended. These lists
7352 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7353 arguments to expansion conditions such as &%match_domain%&.
7354
7355 Each item in one of these lists is a pattern to be matched against a domain,
7356 host, email address, or local part, respectively. In the sections below, the
7357 different types of pattern for each case are described, but first we cover some
7358 general facilities that apply to all four kinds of list.
7359
7360
7361
7362 .section "Expansion of lists" "SECID75"
7363 .cindex "expansion" "of lists"
7364 Each list is expanded as a single string before it is used. The result of
7365 expansion must be a list, possibly containing empty items, which is split up
7366 into separate items for matching. By default, colon is the separator character,
7367 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7368 &<<SECTempitelis>>& for details of the list syntax; the second of these
7369 discusses the way to specify empty list items.
7370
7371
7372 If the string expansion is forced to fail, Exim behaves as if the item it is
7373 testing (domain, host, address, or local part) is not in the list. Other
7374 expansion failures cause temporary errors.
7375
7376 If an item in a list is a regular expression, backslashes, dollars and possibly
7377 other special characters in the expression must be protected against
7378 misinterpretation by the string expander. The easiest way to do this is to use
7379 the &`\N`& expansion feature to indicate that the contents of the regular
7380 expression should not be expanded. For example, in an ACL you might have:
7381 .code
7382 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7383                ${lookup{$domain}lsearch{/badsenders/bydomain}}
7384 .endd
7385 The first item is a regular expression that is protected from expansion by
7386 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7387 senders based on the receiving domain.
7388
7389
7390
7391
7392 .section "Negated items in lists" "SECID76"
7393 .cindex "list" "negation"
7394 .cindex "negation" "in lists"
7395 Items in a list may be positive or negative. Negative items are indicated by a
7396 leading exclamation mark, which may be followed by optional white space. A list
7397 defines a set of items (domains, etc). When Exim processes one of these lists,
7398 it is trying to find out whether a domain, host, address, or local part
7399 (respectively) is in the set that is defined by the list. It works like this:
7400
7401 The list is scanned from left to right. If a positive item is matched, the
7402 subject that is being checked is in the set; if a negative item is matched, the
7403 subject is not in the set. If the end of the list is reached without the
7404 subject having matched any of the patterns, it is in the set if the last item
7405 was a negative one, but not if it was a positive one. For example, the list in
7406 .code
7407 domainlist relay_domains = !a.b.c : *.b.c
7408 .endd
7409 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7410 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7411 list is positive. However, if the setting were
7412 .code
7413 domainlist relay_domains = !a.b.c
7414 .endd
7415 then all domains other than &'a.b.c'& would match because the last item in the
7416 list is negative. In other words, a list that ends with a negative item behaves
7417 as if it had an extra item &`:*`& on the end.
7418
7419 Another way of thinking about positive and negative items in lists is to read
7420 the connector as &"or"& after a positive item and as &"and"& after a negative
7421 item.
7422
7423
7424
7425 .section "File names in lists" "SECTfilnamlis"
7426 .cindex "list" "file name in"
7427 If an item in a domain, host, address, or local part list is an absolute file
7428 name (beginning with a slash character), each line of the file is read and
7429 processed as if it were an independent item in the list, except that further
7430 file names are not allowed,
7431 and no expansion of the data from the file takes place.
7432 Empty lines in the file are ignored, and the file may also contain comment
7433 lines:
7434
7435 .ilist
7436 For domain and host lists, if a # character appears anywhere in a line of the
7437 file, it and all following characters are ignored.
7438 .next
7439 Because local parts may legitimately contain # characters, a comment in an
7440 address list or local part list file is recognized only if # is preceded by
7441 white space or the start of the line. For example:
7442 .code
7443 not#comment@x.y.z   # but this is a comment
7444 .endd
7445 .endlist
7446
7447 Putting a file name in a list has the same effect as inserting each line of the
7448 file as an item in the list (blank lines and comments excepted). However, there
7449 is one important difference: the file is read each time the list is processed,
7450 so if its contents vary over time, Exim's behaviour changes.
7451
7452 If a file name is preceded by an exclamation mark, the sense of any match
7453 within the file is inverted. For example, if
7454 .code
7455 hold_domains = !/etc/nohold-domains
7456 .endd
7457 and the file contains the lines
7458 .code
7459 !a.b.c
7460 *.b.c
7461 .endd
7462 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
7463 any domain matching &`*.b.c`& is not.
7464
7465
7466
7467 .section "An lsearch file is not an out-of-line list" "SECID77"
7468 As will be described in the sections that follow, lookups can be used in lists
7469 to provide indexed methods of checking list membership. There has been some
7470 confusion about the way &(lsearch)& lookups work in lists. Because
7471 an &(lsearch)& file contains plain text and is scanned sequentially, it is
7472 sometimes thought that it is allowed to contain wild cards and other kinds of
7473 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
7474 always fixed strings, just as for any other single-key lookup type.
7475
7476 If you want to use a file to contain wild-card patterns that form part of a
7477 list, just give the file name on its own, without a search type, as described
7478 in the previous section. You could also use the &(wildlsearch)& or
7479 &(nwildlsearch)&, but there is no advantage in doing this.
7480
7481
7482
7483
7484 .section "Named lists" "SECTnamedlists"
7485 .cindex "named lists"
7486 .cindex "list" "named"
7487 A list of domains, hosts, email addresses, or local parts can be given a name
7488 which is then used to refer to the list elsewhere in the configuration. This is
7489 particularly convenient if the same list is required in several different
7490 places. It also allows lists to be given meaningful names, which can improve
7491 the readability of the configuration. For example, it is conventional to define
7492 a domain list called &'local_domains'& for all the domains that are handled
7493 locally on a host, using a configuration line such as
7494 .code
7495 domainlist local_domains = localhost:my.dom.example
7496 .endd
7497 Named lists are referenced by giving their name preceded by a plus sign, so,
7498 for example, a router that is intended to handle local domains would be
7499 configured with the line
7500 .code
7501 domains = +local_domains
7502 .endd
7503 The first router in a configuration is often one that handles all domains
7504 except the local ones, using a configuration with a negated item like this:
7505 .code
7506 dnslookup:
7507   driver = dnslookup
7508   domains = ! +local_domains
7509   transport = remote_smtp
7510   no_more
7511 .endd
7512 The four kinds of named list are created by configuration lines starting with
7513 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
7514 respectively. Then there follows the name that you are defining, followed by an
7515 equals sign and the list itself. For example:
7516 .code
7517 hostlist    relay_hosts = 192.168.23.0/24 : my.friend.example
7518 addresslist bad_senders = cdb;/etc/badsenders
7519 .endd
7520 A named list may refer to other named lists:
7521 .code
7522 domainlist  dom1 = first.example : second.example
7523 domainlist  dom2 = +dom1 : third.example
7524 domainlist  dom3 = fourth.example : +dom2 : fifth.example
7525 .endd
7526 &*Warning*&: If the last item in a referenced list is a negative one, the
7527 effect may not be what you intended, because the negation does not propagate
7528 out to the higher level. For example, consider:
7529 .code
7530 domainlist  dom1 = !a.b
7531 domainlist  dom2 = +dom1 : *.b
7532 .endd
7533 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
7534 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
7535 means it matches the second list as well. The effect is not the same as
7536 .code
7537 domainlist  dom2 = !a.b : *.b
7538 .endd
7539 where &'x.y'& does not match. It's best to avoid negation altogether in
7540 referenced lists if you can.
7541
7542 Named lists may have a performance advantage. When Exim is routing an
7543 address or checking an incoming message, it caches the result of tests on named
7544 lists. So, if you have a setting such as
7545 .code
7546 domains = +local_domains
7547 .endd
7548 on several of your routers
7549 or in several ACL statements,
7550 the actual test is done only for the first one. However, the caching works only
7551 if there are no expansions within the list itself or any sublists that it
7552 references. In other words, caching happens only for lists that are known to be
7553 the same each time they are referenced.
7554
7555 By default, there may be up to 16 named lists of each type. This limit can be
7556 extended by changing a compile-time variable. The use of domain and host lists
7557 is recommended for concepts such as local domains, relay domains, and relay
7558 hosts. The default configuration is set up like this.
7559
7560
7561
7562 .section "Named lists compared with macros" "SECID78"
7563 .cindex "list" "named compared with macro"
7564 .cindex "macro" "compared with named list"
7565 At first sight, named lists might seem to be no different from macros in the
7566 configuration file. However, macros are just textual substitutions. If you
7567 write
7568 .code
7569 ALIST = host1 : host2
7570 auth_advertise_hosts = !ALIST
7571 .endd
7572 it probably won't do what you want, because that is exactly the same as
7573 .code
7574 auth_advertise_hosts = !host1 : host2
7575 .endd
7576 Notice that the second host name is not negated. However, if you use a host
7577 list, and write
7578 .code
7579 hostlist alist = host1 : host2
7580 auth_advertise_hosts = ! +alist
7581 .endd
7582 the negation applies to the whole list, and so that is equivalent to
7583 .code
7584 auth_advertise_hosts = !host1 : !host2
7585 .endd
7586
7587
7588 .section "Named list caching" "SECID79"
7589 .cindex "list" "caching of named"
7590 .cindex "caching" "named lists"
7591 While processing a message, Exim caches the result of checking a named list if
7592 it is sure that the list is the same each time. In practice, this means that
7593 the cache operates only if the list contains no $ characters, which guarantees
7594 that it will not change when it is expanded. Sometimes, however, you may have
7595 an expanded list that you know will be the same each time within a given
7596 message. For example:
7597 .code
7598 domainlist special_domains = \
7599            ${lookup{$sender_host_address}cdb{/some/file}}
7600 .endd
7601 This provides a list of domains that depends only on the sending host's IP
7602 address. If this domain list is referenced a number of times (for example,
7603 in several ACL lines, or in several routers) the result of the check is not
7604 cached by default, because Exim does not know that it is going to be the
7605 same list each time.
7606
7607 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
7608 cache the result anyway. For example:
7609 .code
7610 domainlist_cache special_domains = ${lookup{...
7611 .endd
7612 If you do this, you should be absolutely sure that caching is going to do
7613 the right thing in all cases. When in doubt, leave it out.
7614
7615
7616
7617 .section "Domain lists" "SECTdomainlist"
7618 .cindex "domain list" "patterns for"
7619 .cindex "list" "domain list"
7620 Domain lists contain patterns that are to be matched against a mail domain.
7621 The following types of item may appear in domain lists:
7622
7623 .ilist
7624 .cindex "primary host name"
7625 .cindex "host name" "matched in domain list"
7626 .oindex "&%primary_hostname%&"
7627 .cindex "domain list" "matching primary host name"
7628 .cindex "@ in a domain list"
7629 If a pattern consists of a single @ character, it matches the local host name,
7630 as set by the &%primary_hostname%& option (or defaulted). This makes it
7631 possible to use the same configuration file on several different hosts that
7632 differ only in their names.
7633 .next
7634 .cindex "@[] in a domain list"
7635 .cindex "domain list" "matching local IP interfaces"
7636 .cindex "domain literal"
7637 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
7638 in square brackets (as in an email address that contains a domain literal), but
7639 only if that IP address is recognized as local for email routing purposes. The
7640 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
7641 control which of a host's several IP addresses are treated as local.
7642 In today's Internet, the use of domain literals is controversial.
7643 .next
7644 .cindex "@mx_any"
7645 .cindex "@mx_primary"
7646 .cindex "@mx_secondary"
7647 .cindex "domain list" "matching MX pointers to local host"
7648 If a pattern consists of the string &`@mx_any`& it matches any domain that
7649 has an MX record pointing to the local host or to any host that is listed in
7650 .oindex "&%hosts_treat_as_local%&"
7651 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
7652 are similar, except that the first matches only when a primary MX target is the
7653 local host, and the second only when no primary MX target is the local host,
7654 but a secondary MX target is. &"Primary"& means an MX record with the lowest
7655 preference value &-- there may of course be more than one of them.
7656
7657 The MX lookup that takes place when matching a pattern of this type is
7658 performed with the resolver options for widening names turned off. Thus, for
7659 example, a single-component domain will &'not'& be expanded by adding the
7660 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
7661 options of the &(dnslookup)& router for a discussion of domain widening.
7662
7663 Sometimes you may want to ignore certain IP addresses when using one of these
7664 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
7665 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
7666 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
7667 on a router). For example:
7668 .code
7669 domains = @mx_any/ignore=127.0.0.1
7670 .endd
7671 This example matches any domain that has an MX record pointing to one of
7672 the local host's IP addresses other than 127.0.0.1.
7673
7674 The list of IP addresses is in fact processed by the same code that processes
7675 host lists, so it may contain CIDR-coded network specifications and it may also
7676 contain negative items.
7677
7678 Because the list of IP addresses is a sublist within a domain list, you have to
7679 be careful about delimiters if there is more than one address. Like any other
7680 list, the default delimiter can be changed. Thus, you might have:
7681 .code
7682 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
7683           an.other.domain : ...
7684 .endd
7685 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
7686 involved, it is easiest to change the delimiter for the main list as well:
7687 .code
7688 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
7689           an.other.domain ? ...
7690 .endd
7691 .next
7692 .cindex "asterisk" "in domain list"
7693 .cindex "domain list" "asterisk in"
7694 .cindex "domain list" "matching &""ends with""&"
7695 If a pattern starts with an asterisk, the remaining characters of the pattern
7696 are compared with the terminating characters of the domain. The use of &"*"& in
7697 domain lists differs from its use in partial matching lookups. In a domain
7698 list, the character following the asterisk need not be a dot, whereas partial
7699 matching works only in terms of dot-separated components. For example, a domain
7700 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
7701 &'cipher.key.ex'&.
7702
7703 .next
7704 .cindex "regular expressions" "in domain list"
7705 .cindex "domain list" "matching regular expression"
7706 If a pattern starts with a circumflex character, it is treated as a regular
7707 expression, and matched against the domain using a regular expression matching
7708 function. The circumflex is treated as part of the regular expression.
7709 Email domains are case-independent, so this regular expression match is by
7710 default case-independent, but you can make it case-dependent by starting it
7711 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
7712 are given in chapter &<<CHAPregexp>>&.
7713
7714 &*Warning*&: Because domain lists are expanded before being processed, you
7715 must escape any backslash and dollar characters in the regular expression, or
7716 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
7717 it is not to be expanded (unless you really do want to build a regular
7718 expression by expansion, of course).
7719 .next
7720 .cindex "lookup" "in domain list"
7721 .cindex "domain list" "matching by lookup"
7722 If a pattern starts with the name of a single-key lookup type followed by a
7723 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
7724 must be a file name in a suitable format for the lookup type. For example, for
7725 &"cdb;"& it must be an absolute path:
7726 .code
7727 domains = cdb;/etc/mail/local_domains.cdb
7728 .endd
7729 The appropriate type of lookup is done on the file using the domain name as the
7730 key. In most cases, the data that is looked up is not used; Exim is interested
7731 only in whether or not the key is present in the file. However, when a lookup
7732 is used for the &%domains%& option on a router
7733 or a &%domains%& condition in an ACL statement, the data is preserved in the
7734 &$domain_data$& variable and can be referred to in other router options or
7735 other statements in the same ACL.
7736
7737 .next
7738 Any of the single-key lookup type names may be preceded by
7739 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
7740 .code
7741 domains = partial-dbm;/partial/domains
7742 .endd
7743 This causes partial matching logic to be invoked; a description of how this
7744 works is given in section &<<SECTpartiallookup>>&.
7745
7746 .next
7747 .cindex "asterisk" "in lookup type"
7748 Any of the single-key lookup types may be followed by an asterisk. This causes
7749 a default lookup for a key consisting of a single asterisk to be done if the
7750 original lookup fails. This is not a useful feature when using a domain list to
7751 select particular domains (because any domain would match), but it might have
7752 value if the result of the lookup is being used via the &$domain_data$&
7753 expansion variable.
7754 .next
7755 If the pattern starts with the name of a query-style lookup type followed by a
7756 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
7757 pattern must be an appropriate query for the lookup type, as described in
7758 chapter &<<CHAPfdlookup>>&. For example:
7759 .code
7760 hold_domains = mysql;select domain from holdlist \
7761   where domain = '$domain';
7762 .endd
7763 In most cases, the data that is looked up is not used (so for an SQL query, for
7764 example, it doesn't matter what field you select). Exim is interested only in
7765 whether or not the query succeeds. However, when a lookup is used for the
7766 &%domains%& option on a router, the data is preserved in the &$domain_data$&
7767 variable and can be referred to in other options.
7768 .next
7769 .cindex "domain list" "matching literal domain name"
7770 If none of the above cases apply, a caseless textual comparison is made
7771 between the pattern and the domain.
7772 .endlist
7773
7774 Here is an example that uses several different kinds of pattern:
7775 .code
7776 domainlist funny_domains = \
7777   @ : \
7778   lib.unseen.edu : \
7779   *.foundation.fict.example : \
7780   \N^[1-2]\d{3}\.fict\.example$\N : \
7781   partial-dbm;/opt/data/penguin/book : \
7782   nis;domains.byname : \
7783   nisplus;[name=$domain,status=local],domains.org_dir
7784 .endd
7785 There are obvious processing trade-offs among the various matching modes. Using
7786 an asterisk is faster than a regular expression, and listing a few names
7787 explicitly probably is too. The use of a file or database lookup is expensive,
7788 but may be the only option if hundreds of names are required. Because the
7789 patterns are tested in order, it makes sense to put the most commonly matched
7790 patterns earlier.
7791
7792
7793
7794 .section "Host lists" "SECThostlist"
7795 .cindex "host list" "patterns in"
7796 .cindex "list" "host list"
7797 Host lists are used to control what remote hosts are allowed to do. For
7798 example, some hosts may be allowed to use the local host as a relay, and some
7799 may be permitted to use the SMTP ETRN command. Hosts can be identified in
7800 two different ways, by name or by IP address. In a host list, some types of
7801 pattern are matched to a host name, and some are matched to an IP address.
7802 You need to be particularly careful with this when single-key lookups are
7803 involved, to ensure that the right value is being used as the key.
7804
7805
7806 .section "Special host list patterns" "SECID80"
7807 .cindex "empty item in hosts list"
7808 .cindex "host list" "empty string in"
7809 If a host list item is the empty string, it matches only when no remote host is
7810 involved. This is the case when a message is being received from a local
7811 process using SMTP on the standard input, that is, when a TCP/IP connection is
7812 not used.
7813
7814 .cindex "asterisk" "in host list"
7815 The special pattern &"*"& in a host list matches any host or no host. Neither
7816 the IP address nor the name is actually inspected.
7817
7818
7819
7820 .section "Host list patterns that match by IP address" "SECThoslispatip"
7821 .cindex "host list" "matching IP addresses"
7822 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
7823 the incoming address actually appears in the IPv6 host as
7824 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
7825 list, it is converted into a traditional IPv4 address first. (Not all operating
7826 systems accept IPv4 calls on IPv6 sockets, as there have been some security
7827 concerns.)
7828
7829 The following types of pattern in a host list check the remote host by
7830 inspecting its IP address:
7831
7832 .ilist
7833 If the pattern is a plain domain name (not a regular expression, not starting
7834 with *, not a lookup of any kind), Exim calls the operating system function
7835 to find the associated IP address(es). Exim uses the newer
7836 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
7837 This typically causes a forward DNS lookup of the name. The result is compared
7838 with the IP address of the subject host.
7839
7840 If there is a temporary problem (such as a DNS timeout) with the host name
7841 lookup, a temporary error occurs. For example, if the list is being used in an
7842 ACL condition, the ACL gives a &"defer"& response, usually leading to a
7843 temporary SMTP error code. If no IP address can be found for the host name,
7844 what happens is described in section &<<SECTbehipnot>>& below.
7845
7846 .next
7847 .cindex "@ in a host list"
7848 If the pattern is &"@"&, the primary host name is substituted and used as a
7849 domain name, as just described.
7850
7851 .next
7852 If the pattern is an IP address, it is matched against the IP address of the
7853 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
7854 IPv6 addresses can be given in colon-separated format, but the colons have to
7855 be doubled so as not to be taken as item separators when the default list
7856 separator is used. IPv6 addresses are recognized even when Exim is compiled
7857 without IPv6 support. This means that if they appear in a host list on an
7858 IPv4-only host, Exim will not treat them as host names. They are just addresses
7859 that can never match a client host.
7860
7861 .next
7862 .cindex "@[] in a host list"
7863 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
7864 the local host. For example, if the local host is an IPv4 host with one
7865 interface address 10.45.23.56, these two ACL statements have the same effect:
7866 .code
7867 accept hosts = 127.0.0.1 : 10.45.23.56
7868 accept hosts = @[]
7869 .endd
7870 .next
7871 .cindex "CIDR notation"
7872 If the pattern is an IP address followed by a slash and a mask length (for
7873 example 10.11.42.0/24), it is matched against the IP address of the subject
7874 host under the given mask. This allows, an entire network of hosts to be
7875 included (or excluded) by a single item. The mask uses CIDR notation; it
7876 specifies the number of address bits that must match, starting from the most
7877 significant end of the address.
7878
7879 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
7880 of a range of addresses. It is the number of bits in the network portion of the
7881 address. The above example specifies a 24-bit netmask, so it matches all 256
7882 addresses in the 10.11.42.0 network. An item such as
7883 .code
7884 192.168.23.236/31
7885 .endd
7886 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
7887 32 for an IPv4 address is the same as no mask at all; just a single address
7888 matches.
7889
7890 Here is another example which shows an IPv4 and an IPv6 network:
7891 .code
7892 recipient_unqualified_hosts = 192.168.0.0/16: \
7893                               3ffe::ffff::836f::::/48
7894 .endd
7895 The doubling of list separator characters applies only when these items
7896 appear inline in a host list. It is not required when indirecting via a file.
7897 For example:
7898 .code
7899 recipient_unqualified_hosts = /opt/exim/unqualnets
7900 .endd
7901 could make use of a file containing
7902 .code
7903 172.16.0.0/12
7904 3ffe:ffff:836f::/48
7905 .endd
7906 to have exactly the same effect as the previous example. When listing IPv6
7907 addresses inline, it is usually more convenient to use the facility for
7908 changing separator characters. This list contains the same two networks:
7909 .code
7910 recipient_unqualified_hosts = <; 172.16.0.0/12; \
7911                                  3ffe:ffff:836f::/48
7912 .endd
7913 The separator is changed to semicolon by the leading &"<;"& at the start of the
7914 list.
7915 .endlist
7916
7917
7918
7919 .section "Host list patterns for single-key lookups by host address" &&&
7920          "SECThoslispatsikey"
7921 .cindex "host list" "lookup of IP address"
7922 When a host is to be identified by a single-key lookup of its complete IP
7923 address, the pattern takes this form:
7924 .display
7925 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
7926 .endd
7927 For example:
7928 .code
7929 hosts_lookup = net-cdb;/hosts-by-ip.db
7930 .endd
7931 The text form of the IP address of the subject host is used as the lookup key.
7932 IPv6 addresses are converted to an unabbreviated form, using lower case
7933 letters, with dots as separators because colon is the key terminator in
7934 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
7935 quoting the keys, but this is a facility that was added later.] The data
7936 returned by the lookup is not used.
7937
7938 .cindex "IP address" "masking"
7939 .cindex "host list" "masked IP address"
7940 Single-key lookups can also be performed using masked IP addresses, using
7941 patterns of this form:
7942 .display
7943 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
7944 .endd
7945 For example:
7946 .code
7947 net24-dbm;/networks.db
7948 .endd
7949 The IP address of the subject host is masked using <&'number'&> as the mask
7950 length. A textual string is constructed from the masked value, followed by the
7951 mask, and this is used as the lookup key. For example, if the host's IP address
7952 is 192.168.34.6, the key that is looked up for the above example is
7953 &"192.168.34.0/24"&.
7954
7955 When an IPv6 address is converted to a string, dots are normally used instead
7956 of colons, so that keys in &(lsearch)& files need not contain colons (which
7957 terminate &(lsearch)& keys). This was implemented some time before the ability
7958 to quote keys was made available in &(lsearch)& files. However, the more
7959 recently implemented &(iplsearch)& files do require colons in IPv6 keys
7960 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
7961 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
7962 converted using colons and not dots. In all cases, full, unabbreviated IPv6
7963 addresses are always used.
7964
7965 Ideally, it would be nice to tidy up this anomalous situation by changing to
7966 colons in all cases, given that quoting is now available for &(lsearch)&.
7967 However, this would be an incompatible change that might break some existing
7968 configurations.
7969
7970 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
7971 IPv6 address) is not the same as specifying just &%net-%& without a number. In
7972 the former case the key strings include the mask value, whereas in the latter
7973 case the IP address is used on its own.
7974
7975
7976
7977 .section "Host list patterns that match by host name" "SECThoslispatnam"
7978 .cindex "host" "lookup failures"
7979 .cindex "unknown host name"
7980 .cindex "host list" "matching host name"
7981 There are several types of pattern that require Exim to know the name of the
7982 remote host. These are either wildcard patterns or lookups by name. (If a
7983 complete hostname is given without any wildcarding, it is used to find an IP
7984 address to match against, as described in the section &<<SECThoslispatip>>&
7985 above.)
7986
7987 If the remote host name is not already known when Exim encounters one of these
7988 patterns, it has to be found from the IP address.
7989 Although many sites on the Internet are conscientious about maintaining reverse
7990 DNS data for their hosts, there are also many that do not do this.
7991 Consequently, a name cannot always be found, and this may lead to unwanted
7992 effects. Take care when configuring host lists with wildcarded name patterns.
7993 Consider what will happen if a name cannot be found.
7994
7995 Because of the problems of determining host names from IP addresses, matching
7996 against host names is not as common as matching against IP addresses.
7997
7998 By default, in order to find a host name, Exim first does a reverse DNS lookup;
7999 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8000 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8001 are done can be changed by setting the &%host_lookup_order%& option. For
8002 security, once Exim has found one or more names, it looks up the IP addresses
8003 for these names and compares them with the IP address that it started with.
8004 Only those names whose IP addresses match are accepted. Any other names are
8005 discarded. If no names are left, Exim behaves as if the host name cannot be
8006 found. In the most common case there is only one name and one IP address.
8007
8008 There are some options that control what happens if a host name cannot be
8009 found. These are described in section &<<SECTbehipnot>>& below.
8010
8011 .cindex "host" "alias for"
8012 .cindex "alias for host"
8013 As a result of aliasing, hosts may have more than one name. When processing any
8014 of the following types of pattern, all the host's names are checked:
8015
8016 .ilist
8017 .cindex "asterisk" "in host list"
8018 If a pattern starts with &"*"& the remainder of the item must match the end of
8019 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8020 &'.b.c'&. This special simple form is provided because this is a very common
8021 requirement. Other kinds of wildcarding require the use of a regular
8022 expression.
8023 .next
8024 .cindex "regular expressions" "in host list"
8025 .cindex "host list" "regular expression in"
8026 If the item starts with &"^"& it is taken to be a regular expression which is
8027 matched against the host name. Host names are case-independent, so this regular
8028 expression match is by default case-independent, but you can make it
8029 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8030 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8031 example,
8032 .code
8033 ^(a|b)\.c\.d$
8034 .endd
8035 is a regular expression that matches either of the two hosts &'a.c.d'& or
8036 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8037 that backslash and dollar characters are not misinterpreted as part of the
8038 string expansion. The simplest way to do this is to use &`\N`& to mark that
8039 part of the string as non-expandable. For example:
8040 .code
8041 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8042 .endd
8043 &*Warning*&: If you want to match a complete host name, you must include the
8044 &`$`& terminating metacharacter in the regular expression, as in the above
8045 example. Without it, a match at the start of the host name is all that is
8046 required.
8047 .endlist
8048
8049
8050
8051
8052 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8053 .cindex "host" "lookup failures, permanent"
8054 While processing a host list, Exim may need to look up an IP address from a
8055 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8056 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8057 behaviour when it fails to find the information it is seeking is the same.
8058
8059 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8060 apply to temporary DNS errors, whose handling is described in the next section.
8061
8062 .cindex "&`+include_unknown`&"
8063 .cindex "&`+ignore_unknown`&"
8064 By default, Exim behaves as if the host does not match the list. This may not
8065 always be what you want to happen. To change Exim's behaviour, the special
8066 items &`+include_unknown`& or &`+ignore_unknown`& may appear in the list (at
8067 top level &-- they are not recognized in an indirected file).
8068
8069 .ilist
8070 If any item that follows &`+include_unknown`& requires information that
8071 cannot found, Exim behaves as if the host does match the list. For example,
8072 .code
8073 host_reject_connection = +include_unknown:*.enemy.ex
8074 .endd
8075 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8076 any hosts whose name it cannot find.
8077
8078 .next
8079 If any item that follows &`+ignore_unknown`& requires information that cannot
8080 be found, Exim ignores that item and proceeds to the rest of the list. For
8081 example:
8082 .code
8083 accept hosts = +ignore_unknown : friend.example : \
8084                192.168.4.5
8085 .endd
8086 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8087 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8088 name can be found for 192.168.4.5, it is rejected.
8089 .endlist
8090
8091 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8092 list. The effect of each one lasts until the next, or until the end of the
8093 list.
8094
8095
8096 .section "Temporary DNS errors when looking up host information" &&&
8097          "SECTtemdnserr"
8098 .cindex "host" "lookup failures, temporary"
8099 .cindex "&`+include_defer`&"
8100 .cindex "&`+ignore_defer`&"
8101 A temporary DNS lookup failure normally causes a defer action (except when
8102 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8103 host lists can include &`+ignore_defer`& and &`+include_defer`&, analagous to
8104 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8105 section. These options should be used with care, probably only in non-critical
8106 host lists such as whitelists.
8107
8108
8109
8110 .section "Host list patterns for single-key lookups by host name" &&&
8111          "SECThoslispatnamsk"
8112 .cindex "unknown host name"
8113 .cindex "host list" "matching host name"
8114 If a pattern is of the form
8115 .display
8116 <&'single-key-search-type'&>;<&'search-data'&>
8117 .endd
8118 for example
8119 .code
8120 dbm;/host/accept/list
8121 .endd
8122 a single-key lookup is performed, using the host name as its key. If the
8123 lookup succeeds, the host matches the item. The actual data that is looked up
8124 is not used.
8125
8126 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8127 keys in the file, not IP addresses. If you want to do lookups based on IP
8128 addresses, you must precede the search type with &"net-"& (see section
8129 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8130 two items in the same list, one doing an address lookup and one doing a name
8131 lookup, both using the same file.
8132
8133
8134
8135 .section "Host list patterns for query-style lookups" "SECID81"
8136 If a pattern is of the form
8137 .display
8138 <&'query-style-search-type'&>;<&'query'&>
8139 .endd
8140 the query is obeyed, and if it succeeds, the host matches the item. The actual
8141 data that is looked up is not used. The variables &$sender_host_address$& and
8142 &$sender_host_name$& can be used in the query. For example:
8143 .code
8144 hosts_lookup = pgsql;\
8145   select ip from hostlist where ip='$sender_host_address'
8146 .endd
8147 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8148 can use the &%sg%& expansion item to change this if you need to. If you want to
8149 use masked IP addresses in database queries, you can use the &%mask%& expansion
8150 operator.
8151
8152 If the query contains a reference to &$sender_host_name$&, Exim automatically
8153 looks up the host name if has not already done so. (See section
8154 &<<SECThoslispatnam>>& for comments on finding host names.)
8155
8156 Historical note: prior to release 4.30, Exim would always attempt to find a
8157 host name before running the query, unless the search type was preceded by
8158 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8159 still recognized for query-style lookups, but its presence or absence has no
8160 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8161 See section &<<SECThoslispatsikey>>&.)
8162
8163
8164
8165 .section "Mixing wildcarded host names and addresses in host lists" &&&
8166          "SECTmixwilhos"
8167 .cindex "host list" "mixing names and addresses in"
8168 If you have name lookups or wildcarded host names and IP addresses in the same
8169 host list, you should normally put the IP addresses first. For example, in an
8170 ACL you could have:
8171 .code
8172 accept hosts = 10.9.8.7 : *.friend.example
8173 .endd
8174 The reason for this lies in the left-to-right way that Exim processes lists.
8175 It can test IP addresses without doing any DNS lookups, but when it reaches an
8176 item that requires a host name, it fails if it cannot find a host name to
8177 compare with the pattern. If the above list is given in the opposite order, the
8178 &%accept%& statement fails for a host whose name cannot be found, even if its
8179 IP address is 10.9.8.7.
8180
8181 If you really do want to do the name check first, and still recognize the IP
8182 address, you can rewrite the ACL like this:
8183 .code
8184 accept hosts = *.friend.example
8185 accept hosts = 10.9.8.7
8186 .endd
8187 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8188 &<<CHAPACL>>& for details of ACLs.
8189
8190
8191
8192
8193
8194 .section "Address lists" "SECTaddresslist"
8195 .cindex "list" "address list"
8196 .cindex "address list" "empty item"
8197 .cindex "address list" "patterns"
8198 Address lists contain patterns that are matched against mail addresses. There
8199 is one special case to be considered: the sender address of a bounce message is
8200 always empty. You can test for this by providing an empty item in an address
8201 list. For example, you can set up a router to process bounce messages by
8202 using this option setting:
8203 .code
8204 senders = :
8205 .endd
8206 The presence of the colon creates an empty item. If you do not provide any
8207 data, the list is empty and matches nothing. The empty sender can also be
8208 detected by a regular expression that matches an empty string,
8209 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8210
8211 Non-empty items in an address list can be straightforward email addresses. For
8212 example:
8213 .code
8214 senders = jbc@askone.example : hs@anacreon.example
8215 .endd
8216 A certain amount of wildcarding is permitted. If a pattern contains an @
8217 character, but is not a regular expression and does not begin with a
8218 semicolon-terminated lookup type (described below), the local part of the
8219 subject address is compared with the local part of the pattern, which may start
8220 with an asterisk. If the local parts match, the domain is checked in exactly
8221 the same way as for a pattern in a domain list. For example, the domain can be
8222 wildcarded, refer to a named list, or be a lookup:
8223 .code
8224 deny senders = *@*.spamming.site:\
8225                *@+hostile_domains:\
8226                bozo@partial-lsearch;/list/of/dodgy/sites:\
8227                *@dbm;/bad/domains.db
8228 .endd
8229 .cindex "local part" "starting with !"
8230 .cindex "address list" "local part starting with !"
8231 If a local part that begins with an exclamation mark is required, it has to be
8232 specified using a regular expression, because otherwise the exclamation mark is
8233 treated as a sign of negation, as is standard in lists.
8234
8235 If a non-empty pattern that is not a regular expression or a lookup does not
8236 contain an @ character, it is matched against the domain part of the subject
8237 address. The only two formats that are recognized this way are a literal
8238 domain, or a domain pattern that starts with *. In both these cases, the effect
8239 is the same as if &`*@`& preceded the pattern. For example:
8240 .code
8241 deny senders = enemy.domain : *.enemy.domain
8242 .endd
8243
8244 The following kinds of more complicated address list pattern can match any
8245 address, including the empty address that is characteristic of bounce message
8246 senders:
8247
8248 .ilist
8249 .cindex "regular expressions" "in address list"
8250 .cindex "address list" "regular expression in"
8251 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8252 done against the complete address, with the pattern as the regular expression.
8253 You must take care that backslash and dollar characters are not misinterpreted
8254 as part of the string expansion. The simplest way to do this is to use &`\N`&
8255 to mark that part of the string as non-expandable. For example:
8256 .code
8257 deny senders = \N^.*this.*@example\.com$\N : \
8258                \N^\d{8}.+@spamhaus.example$\N : ...
8259 .endd
8260 The &`\N`& sequences are removed by the expansion, so these items do indeed
8261 start with &"^"& by the time they are being interpreted as address patterns.
8262
8263 .next
8264 .cindex "address list" "lookup for complete address"
8265 Complete addresses can be looked up by using a pattern that starts with a
8266 lookup type terminated by a semicolon, followed by the data for the lookup. For
8267 example:
8268 .code
8269 deny senders = cdb;/etc/blocked.senders : \
8270   mysql;select address from blocked where \
8271   address='${quote_mysql:$sender_address}'
8272 .endd
8273 Both query-style and single-key lookup types can be used. For a single-key
8274 lookup type, Exim uses the complete address as the key. However, empty keys are
8275 not supported for single-key lookups, so a match against the empty address
8276 always fails. This restriction does not apply to query-style lookups.
8277
8278 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8279 cannot be used, and is ignored if specified, with an entry being written to the
8280 panic log.
8281 .cindex "*@ with single-key lookup"
8282 However, you can configure lookup defaults, as described in section
8283 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8284 default. For example, with this lookup:
8285 .code
8286 accept senders = lsearch*@;/some/file
8287 .endd
8288 the file could contains lines like this:
8289 .code
8290 user1@domain1.example
8291 *@domain2.example
8292 .endd
8293 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8294 that are tried is:
8295 .code
8296 nimrod@jaeger.example
8297 *@jaeger.example
8298 *
8299 .endd
8300 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8301 would mean that every address matches, thus rendering the test useless.
8302
8303 &*Warning 2*&: Do not confuse these two kinds of item:
8304 .code
8305 deny recipients = dbm*@;/some/file
8306 deny recipients = *@dbm;/some/file
8307 .endd
8308 The first does a whole address lookup, with defaulting, as just described,
8309 because it starts with a lookup type. The second matches the local part and
8310 domain independently, as described in a bullet point below.
8311 .endlist
8312
8313
8314 The following kinds of address list pattern can match only non-empty addresses.
8315 If the subject address is empty, a match against any of these pattern types
8316 always fails.
8317
8318
8319 .ilist
8320 .cindex "@@ with single-key lookup"
8321 .cindex "address list" "@@ lookup type"
8322 .cindex "address list" "split local part and domain"
8323 If a pattern starts with &"@@"& followed by a single-key lookup item
8324 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8325 split into a local part and a domain. The domain is looked up in the file. If
8326 it is not found, there is no match. If it is found, the data that is looked up
8327 from the file is treated as a colon-separated list of local part patterns, each
8328 of which is matched against the subject local part in turn.
8329
8330 .cindex "asterisk" "in address list"
8331 The lookup may be a partial one, and/or one involving a search for a default
8332 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8333 patterns that are looked up can be regular expressions or begin with &"*"&, or
8334 even be further lookups. They may also be independently negated. For example,
8335 with
8336 .code
8337 deny senders = @@dbm;/etc/reject-by-domain
8338 .endd
8339 the data from which the DBM file is built could contain lines like
8340 .code
8341 baddomain.com:  !postmaster : *
8342 .endd
8343 to reject all senders except &%postmaster%& from that domain.
8344
8345 .cindex "local part" "starting with !"
8346 If a local part that actually begins with an exclamation mark is required, it
8347 has to be specified using a regular expression. In &(lsearch)& files, an entry
8348 may be split over several lines by indenting the second and subsequent lines,
8349 but the separating colon must still be included at line breaks. White space
8350 surrounding the colons is ignored. For example:
8351 .code
8352 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
8353 spammer3 : spammer4
8354 .endd
8355 As in all colon-separated lists in Exim, a colon can be included in an item by
8356 doubling.
8357
8358 If the last item in the list starts with a right angle-bracket, the remainder
8359 of the item is taken as a new key to look up in order to obtain a continuation
8360 list of local parts. The new key can be any sequence of characters. Thus one
8361 might have entries like
8362 .code
8363 aol.com: spammer1 : spammer 2 : >*
8364 xyz.com: spammer3 : >*
8365 *:       ^\d{8}$
8366 .endd
8367 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8368 local parts for all domains, in addition to the specific local parts listed for
8369 each domain. Of course, using this feature costs another lookup each time a
8370 chain is followed, but the effort needed to maintain the data is reduced.
8371
8372 .cindex "loop" "in lookups"
8373 It is possible to construct loops using this facility, and in order to catch
8374 them, the chains may be no more than fifty items long.
8375
8376 .next
8377 The @@<&'lookup'&> style of item can also be used with a query-style
8378 lookup, but in this case, the chaining facility is not available. The lookup
8379 can only return a single list of local parts.
8380 .endlist
8381
8382 &*Warning*&: There is an important difference between the address list items
8383 in these two examples:
8384 .code
8385 senders = +my_list
8386 senders = *@+my_list
8387 .endd
8388 In the first one, &`my_list`& is a named address list, whereas in the second
8389 example it is a named domain list.
8390
8391
8392
8393
8394 .section "Case of letters in address lists" "SECTcasletadd"
8395 .cindex "case of local parts"
8396 .cindex "address list" "case forcing"
8397 .cindex "case forcing in address lists"
8398 Domains in email addresses are always handled caselessly, but for local parts
8399 case may be significant on some systems (see &%caseful_local_part%& for how
8400 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8401 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8402 blocking lists should be done in a case-independent manner. Since most address
8403 lists in Exim are used for this kind of control, Exim attempts to do this by
8404 default.
8405
8406 The domain portion of an address is always lowercased before matching it to an
8407 address list. The local part is lowercased by default, and any string
8408 comparisons that take place are done caselessly. This means that the data in
8409 the address list itself, in files included as plain file names, and in any file
8410 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8411 keys in files that are looked up by a search type other than &(lsearch)& (which
8412 works caselessly) must be in lower case, because these lookups are not
8413 case-independent.
8414
8415 .cindex "&`+caseful`&"
8416 To allow for the possibility of caseful address list matching, if an item in
8417 an address list is the string &"+caseful"&, the original case of the local
8418 part is restored for any comparisons that follow, and string comparisons are no
8419 longer case-independent. This does not affect the domain, which remains in
8420 lower case. However, although independent matches on the domain alone are still
8421 performed caselessly, regular expressions that match against an entire address
8422 become case-sensitive after &"+caseful"& has been seen.
8423
8424
8425
8426 .section "Local part lists" "SECTlocparlis"
8427 .cindex "list" "local part list"
8428 .cindex "local part" "list"
8429 Case-sensitivity in local part lists is handled in the same way as for address
8430 lists, as just described. The &"+caseful"& item can be used if required. In a
8431 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
8432 set false, the subject is lowercased and the matching is initially
8433 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
8434 matching in the local part list, but not elsewhere in the router. If
8435 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
8436 option is case-sensitive from the start.
8437
8438 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
8439 comments are handled in the same way as address lists &-- they are recognized
8440 only if the # is preceded by white space or the start of the line.
8441 Otherwise, local part lists are matched in the same way as domain lists, except
8442 that the special items that refer to the local host (&`@`&, &`@[]`&,
8443 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
8444 Refer to section &<<SECTdomainlist>>& for details of the other available item
8445 types.
8446 .ecindex IIDdohoadli
8447
8448
8449
8450
8451 . ////////////////////////////////////////////////////////////////////////////
8452 . ////////////////////////////////////////////////////////////////////////////
8453
8454 .chapter "String expansions" "CHAPexpand"
8455 .scindex IIDstrexp "expansion" "of strings"
8456 Many strings in Exim's run time configuration are expanded before use. Some of
8457 them are expanded every time they are used; others are expanded only once.
8458
8459 When a string is being expanded it is copied verbatim from left to right except
8460 when a dollar or backslash character is encountered. A dollar specifies the
8461 start of a portion of the string that is interpreted and replaced as described
8462 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
8463 escape character, as described in the following section.
8464
8465
8466
8467 .section "Literal text in expanded strings" "SECTlittext"
8468 .cindex "expansion" "including literal text"
8469 An uninterpreted dollar can be included in an expanded string by putting a
8470 backslash in front of it. A backslash can be used to prevent any special
8471 character being treated specially in an expansion, including backslash itself.
8472 If the string appears in quotes in the configuration file, two backslashes are
8473 required because the quotes themselves cause interpretation of backslashes when
8474 the string is read in (see section &<<SECTstrings>>&).
8475
8476 .cindex "expansion" "non-expandable substrings"
8477 A portion of the string can specified as non-expandable by placing it between
8478 two occurrences of &`\N`&. This is particularly useful for protecting regular
8479 expressions, which often contain backslashes and dollar signs. For example:
8480 .code
8481 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
8482 .endd
8483 On encountering the first &`\N`&, the expander copies subsequent characters
8484 without interpretation until it reaches the next &`\N`& or the end of the
8485 string.
8486
8487
8488
8489 .section "Character escape sequences in expanded strings" "SECID82"
8490 .cindex "expansion" "escape sequences"
8491 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
8492 expanded string is recognized as an escape sequence for the character newline,
8493 carriage return, or tab, respectively. A backslash followed by up to three
8494 octal digits is recognized as an octal encoding for a single character, and a
8495 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
8496 encoding.
8497
8498 These escape sequences are also recognized in quoted strings when they are read
8499 in. Their interpretation in expansions as well is useful for unquoted strings,
8500 and for other cases such as looked-up strings that are then expanded.
8501
8502
8503 .section "Testing string expansions" "SECID83"
8504 .cindex "expansion" "testing"
8505 .cindex "testing" "string expansion"
8506 .oindex "&%-be%&"
8507 Many expansions can be tested by calling Exim with the &%-be%& option. This
8508 takes the command arguments, or lines from the standard input if there are no
8509 arguments, runs them through the string expansion code, and writes the results
8510 to the standard output. Variables based on configuration values are set up, but
8511 since no message is being processed, variables such as &$local_part$& have no
8512 value. Nevertheless the &%-be%& option can be useful for checking out file and
8513 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
8514 and &%nhash%&.
8515
8516 Exim gives up its root privilege when it is called with the &%-be%& option, and
8517 instead runs under the uid and gid it was called with, to prevent users from
8518 using &%-be%& for reading files to which they do not have access.
8519
8520 .oindex "&%-bem%&"
8521 If you want to test expansions that include variables whose values are taken
8522 from a message, there are two other options that can be used. The &%-bem%&
8523 option is like &%-be%& except that it is followed by a file name. The file is
8524 read as a message before doing the test expansions. For example:
8525 .code
8526 exim -bem /tmp/test.message '$h_subject:'
8527 .endd
8528 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
8529 Exim message identifier. For example:
8530 .code
8531 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
8532 .endd
8533 This loads the message from Exim's spool before doing the test expansions, and
8534 is therefore restricted to admin users.
8535
8536
8537 .section "Forced expansion failure" "SECTforexpfai"
8538 .cindex "expansion" "forced failure"
8539 A number of expansions that are described in the following section have
8540 alternative &"true"& and &"false"& substrings, enclosed in brace characters
8541 (which are sometimes called &"curly brackets"&). Which of the two strings is
8542 used depends on some condition that is evaluated as part of the expansion. If,
8543 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
8544 the entire string expansion fails in a way that can be detected by the code
8545 that requested the expansion. This is called &"forced expansion failure"&, and
8546 its consequences depend on the circumstances. In some cases it is no different
8547 from any other expansion failure, but in others a different action may be
8548 taken. Such variations are mentioned in the documentation of the option that is
8549 being expanded.
8550
8551
8552
8553
8554 .section "Expansion items" "SECTexpansionitems"
8555 The following items are recognized in expanded strings. White space may be used
8556 between sub-items that are keywords or substrings enclosed in braces inside an
8557 outer set of braces, to improve readability. &*Warning*&: Within braces,
8558 white space is significant.
8559
8560 .vlist
8561 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
8562 .cindex "expansion" "variables"
8563 Substitute the contents of the named variable, for example:
8564 .code
8565 $local_part
8566 ${domain}
8567 .endd
8568 The second form can be used to separate the name from subsequent alphanumeric
8569 characters. This form (using braces) is available only for variables; it does
8570 &'not'& apply to message headers. The names of the variables are given in
8571 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
8572 given, the expansion fails.
8573
8574 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
8575 .cindex "expansion" "operators"
8576 The string is first itself expanded, and then the operation specified by
8577 <&'op'&> is applied to it. For example:
8578 .code
8579 ${lc:$local_part}
8580 .endd
8581 The string starts with the first character after the colon, which may be
8582 leading white space. A list of operators is given in section &<<SECTexpop>>&
8583 below. The operator notation is used for simple expansion items that have just
8584 one argument, because it reduces the number of braces and therefore makes the
8585 string easier to understand.
8586
8587 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
8588 This item inserts &"basic"& header lines. It is described with the &%header%&
8589 expansion item below.
8590
8591 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
8592        {*&<&'arg'&>&*}...}*&"
8593 .cindex &%dlfunc%&
8594 This expansion dynamically loads and then calls a locally-written C function.
8595 This functionality is available only if Exim is compiled with
8596 .code
8597 EXPAND_DLFUNC=yes
8598 .endd
8599 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
8600 object so that it doesn't reload the same object file in the same Exim process
8601 (but of course Exim does start new processes frequently).
8602
8603 There may be from zero to eight arguments to the function. When compiling
8604 a local function that is to be called in this way, &_local_scan.h_& should be
8605 included. The Exim variables and functions that are defined by that API
8606 are also available for dynamically loaded functions. The function itself
8607 must have the following type:
8608 .code
8609 int dlfunction(uschar **yield, int argc, uschar *argv[])
8610 .endd
8611 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
8612 function should return one of the following values:
8613
8614 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
8615 into the expanded string that is being built.
8616
8617 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
8618 from &'yield'&, if it is set.
8619
8620 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
8621 taken from &'yield'& if it is set.
8622
8623 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
8624
8625 When compiling a function that is to be used in this way with gcc,
8626 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
8627 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
8628
8629 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
8630        {*&<&'string3'&>&*}}*&"
8631 .cindex "expansion" "extracting substrings by key"
8632 .cindex "&%extract%&" "substrings by key"
8633 The key and <&'string1'&> are first expanded separately. Leading and trailing
8634 white space is removed from the key (but not from any of the strings). The key
8635 must not consist entirely of digits. The expanded <&'string1'&> must be of the
8636 form:
8637 .display
8638 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
8639 .endd
8640 .vindex "&$value$&"
8641 where the equals signs and spaces (but not both) are optional. If any of the
8642 values contain white space, they must be enclosed in double quotes, and any
8643 values that are enclosed in double quotes are subject to escape processing as
8644 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
8645 for the value that corresponds to the key. The search is case-insensitive. If
8646 the key is found, <&'string2'&> is expanded, and replaces the whole item;
8647 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
8648 variable &$value$& contains the value that has been extracted. Afterwards, it
8649 is restored to any previous value it might have had.
8650
8651 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
8652 key is not found. If {<&'string2'&>} is also omitted, the value that was
8653 extracted is used. Thus, for example, these two expansions are identical, and
8654 yield &"2001"&:
8655 .code
8656 ${extract{gid}{uid=1984 gid=2001}}
8657 ${extract{gid}{uid=1984 gid=2001}{$value}}
8658 .endd
8659 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
8660 appear, for example:
8661 .code
8662 ${extract{Z}{A=... B=...}{$value} fail }
8663 .endd
8664 This forces an expansion failure (see section &<<SECTforexpfai>>&);
8665 {<&'string2'&>} must be present for &"fail"& to be recognized.
8666
8667
8668 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
8669         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
8670 .cindex "expansion" "extracting substrings by number"
8671 .cindex "&%extract%&" "substrings by number"
8672 The <&'number'&> argument must consist entirely of decimal digits,
8673 apart from leading and trailing white space, which is ignored.
8674 This is what distinguishes this form of &%extract%& from the previous kind. It
8675 behaves in the same way, except that, instead of extracting a named field, it
8676 extracts from <&'string1'&> the field whose number is given as the first
8677 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
8678 <&'string3'&> as before.
8679
8680 The fields in the string are separated by any one of the characters in the
8681 separator string. These may include space or tab characters.
8682 The first field is numbered one. If the number is negative, the fields are
8683 counted from the end of the string, with the rightmost one numbered -1. If the
8684 number given is zero, the entire string is returned. If the modulus of the
8685 number is greater than the number of fields in the string, the result is the
8686 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
8687 provided. For example:
8688 .code
8689 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
8690 .endd
8691 yields &"42"&, and
8692 .code
8693 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
8694 .endd
8695 yields &"99"&. Two successive separators mean that the field between them is
8696 empty (for example, the fifth field above).
8697
8698
8699 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
8700 .cindex "list" "selecting by condition"
8701 .cindex "expansion" "selecting from list by condition"
8702 .vindex "&$item$&"
8703 After expansion, <&'string'&> is interpreted as a list, colon-separated by
8704 default, but the separator can be changed in the usual way. For each item
8705 in this list, its value is place in &$item$&, and then the condition is
8706 evaluated. If the condition is true, &$item$& is added to the output as an
8707 item in a new list; if the condition is false, the item is discarded. The
8708 separator used for the output list is the same as the one used for the
8709 input, but a separator setting is not included in the output. For example:
8710 .code
8711 ${filter{a:b:c}{!eq{$item}{b}}
8712 .endd
8713 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
8714 to what it was before. See also the &*map*& and &*reduce*& expansion items.
8715
8716
8717 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
8718 .cindex "hash function" "textual"
8719 .cindex "expansion" "textual hash"
8720 This is a textual hashing function, and was the first to be implemented in
8721 early versions of Exim. In current releases, there are other hashing functions
8722 (numeric, MD5, and SHA-1), which are described below.
8723
8724 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
8725 <&'n'&>. If you are using fixed values for these numbers, that is, if
8726 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
8727 use the simpler operator notation that avoids some of the braces:
8728 .code
8729 ${hash_<n>_<m>:<string>}
8730 .endd
8731 The second number is optional (in both notations). If <&'n'&> is greater than
8732 or equal to the length of the string, the expansion item returns the string.
8733 Otherwise it computes a new string of length <&'n'&> by applying a hashing
8734 function to the string. The new string consists of characters taken from the
8735 first <&'m'&> characters of the string
8736 .code
8737 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
8738 .endd
8739 If <&'m'&> is not present the value 26 is used, so that only lower case
8740 letters appear. For example:
8741 .display
8742 &`$hash{3}{monty}}           `&   yields  &`jmg`&
8743 &`$hash{5}{monty}}           `&   yields  &`monty`&
8744 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
8745 .endd
8746
8747 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
8748         &*$h_*&<&'header&~name'&>&*:*&" &&&
8749        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
8750         &*$bh_*&<&'header&~name'&>&*:*&" &&&
8751        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
8752         &*$rh_*&<&'header&~name'&>&*:*&"
8753 .cindex "expansion" "header insertion"
8754 .vindex "&$header_$&"
8755 .vindex "&$bheader_$&"
8756 .vindex "&$rheader_$&"
8757 .cindex "header lines" "in expansion strings"
8758 .cindex "header lines" "character sets"
8759 .cindex "header lines" "decoding"
8760 Substitute the contents of the named message header line, for example
8761 .code
8762 $header_reply-to:
8763 .endd
8764 The newline that terminates a header line is not included in the expansion, but
8765 internal newlines (caused by splitting the header line over several physical
8766 lines) may be present.
8767
8768 The difference between &%rheader%&, &%bheader%&, and &%header%& is in the way
8769 the data in the header line is interpreted.
8770
8771 .ilist
8772 .cindex "white space" "in header lines"
8773 &%rheader%& gives the original &"raw"& content of the header line, with no
8774 processing at all, and without the removal of leading and trailing white space.
8775
8776 .next
8777 .cindex "base64 encoding" "in header lines"
8778 &%bheader%& removes leading and trailing white space, and then decodes base64
8779 or quoted-printable MIME &"words"& within the header text, but does no
8780 character set translation. If decoding of what looks superficially like a MIME
8781 &"word"& fails, the raw string is returned. If decoding
8782 .cindex "binary zero" "in header line"
8783 produces a binary zero character, it is replaced by a question mark &-- this is
8784 what Exim does for binary zeros that are actually received in header lines.
8785
8786 .next
8787 &%header%& tries to translate the string as decoded by &%bheader%& to a
8788 standard character set. This is an attempt to produce the same string as would
8789 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
8790 returned. Translation is attempted only on operating systems that support the
8791 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
8792 a system Makefile or in &_Local/Makefile_&.
8793 .endlist ilist
8794
8795 In a filter file, the target character set for &%header%& can be specified by a
8796 command of the following form:
8797 .code
8798 headers charset "UTF-8"
8799 .endd
8800 This command affects all references to &$h_$& (or &$header_$&) expansions in
8801 subsequently obeyed filter commands. In the absence of this command, the target
8802 character set in a filter is taken from the setting of the &%headers_charset%&
8803 option in the runtime configuration. The value of this option defaults to the
8804 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
8805 ISO-8859-1.
8806
8807 Header names follow the syntax of RFC 2822, which states that they may contain
8808 any printing characters except space and colon. Consequently, curly brackets
8809 &'do not'& terminate header names, and should not be used to enclose them as
8810 if they were variables. Attempting to do so causes a syntax error.
8811
8812 Only header lines that are common to all copies of a message are visible to
8813 this mechanism. These are the original header lines that are received with the
8814 message, and any that are added by an ACL statement or by a system
8815 filter. Header lines that are added to a particular copy of a message by a
8816 router or transport are not accessible.
8817
8818 For incoming SMTP messages, no header lines are visible in ACLs that are obeyed
8819 before the DATA ACL, because the header structure is not set up until the
8820 message is received. Header lines that are added in a RCPT ACL (for example)
8821 are saved until the message's incoming header lines are available, at which
8822 point they are added. When a DATA ACL is running, however, header lines added
8823 by earlier ACLs are visible.
8824
8825 Upper case and lower case letters are synonymous in header names. If the
8826 following character is white space, the terminating colon may be omitted, but
8827 this is not recommended, because you may then forget it when it is needed. When
8828 white space terminates the header name, it is included in the expanded string.
8829 If the message does not contain the given header, the expansion item is
8830 replaced by an empty string. (See the &%def%& condition in section
8831 &<<SECTexpcond>>& for a means of testing for the existence of a header.)
8832
8833 If there is more than one header with the same name, they are all concatenated
8834 to form the substitution string, up to a maximum length of 64K. Unless
8835 &%rheader%& is being used, leading and trailing white space is removed from
8836 each header before concatenation, and a completely empty header is ignored. A
8837 newline character is then inserted between non-empty headers, but there is no
8838 newline at the very end. For the &%header%& and &%bheader%& expansion, for
8839 those headers that contain lists of addresses, a comma is also inserted at the
8840 junctions between headers. This does not happen for the &%rheader%& expansion.
8841
8842
8843 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
8844 .cindex "expansion" "hmac hashing"
8845 .cindex &%hmac%&
8846 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
8847 shared secret and some text into a message authentication code, as specified in
8848 RFC 2104. This differs from &`${md5:secret_text...}`& or
8849 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
8850 cryptographic hash, allowing for authentication that is not possible with MD5
8851 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
8852 present. For example:
8853 .code
8854 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
8855 .endd
8856 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
8857 produces:
8858 .code
8859 dd97e3ba5d1a61b5006108f8c8252953
8860 .endd
8861 As an example of how this might be used, you might put in the main part of
8862 an Exim configuration:
8863 .code
8864 SPAMSCAN_SECRET=cohgheeLei2thahw
8865 .endd
8866 In a router or a transport you could then have:
8867 .code
8868 headers_add = \
8869   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
8870   ${hmac{md5}{SPAMSCAN_SECRET}\
8871   {${primary_hostname},${message_exim_id},$h_message-id:}}
8872 .endd
8873 Then given a message, you can check where it was scanned by looking at the
8874 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
8875 this header line is authentic by recomputing the authentication code from the
8876 host name, message ID and the &'Message-id:'& header line. This can be done
8877 using Exim's &%-be%& option, or by other means, for example by using the
8878 &'hmac_md5_hex()'& function in Perl.
8879
8880
8881 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
8882 .cindex "expansion" "conditional"
8883 .cindex "&%if%&, expansion item"
8884 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
8885 item; otherwise <&'string2'&> is used. The available conditions are described
8886 in section &<<SECTexpcond>>& below. For example:
8887 .code
8888 ${if eq {$local_part}{postmaster} {yes}{no} }
8889 .endd
8890 The second string need not be present; if it is not and the condition is not
8891 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
8892 be present instead of the second string (without any curly brackets). In this
8893 case, the expansion is forced to fail if the condition is not true (see section
8894 &<<SECTforexpfai>>&).
8895
8896 If both strings are omitted, the result is the string &`true`& if the condition
8897 is true, and the empty string if the condition is false. This makes it less
8898 cumbersome to write custom ACL and router conditions. For example, instead of
8899 .code
8900 condition = ${if >{$acl_m4}{3}{true}{false}}
8901 .endd
8902 you can use
8903 .code
8904 condition = ${if >{$acl_m4}{3}}
8905 .endd
8906
8907 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
8908 .cindex "expansion" "string truncation"
8909 .cindex "&%length%& expansion item"
8910 The &%length%& item is used to extract the initial portion of a string. Both
8911 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
8912 you are using a fixed value for the number, that is, if <&'string1'&> does not
8913 change when expanded, you can use the simpler operator notation that avoids
8914 some of the braces:
8915 .code
8916 ${length_<n>:<string>}
8917 .endd
8918 The result of this item is either the first <&'n'&> characters or the whole
8919 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
8920 &%strlen%&, which gives the length of a string.
8921
8922
8923 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
8924         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
8925 This is the first of one of two different types of lookup item, which are both
8926 described in the next item.
8927
8928 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
8929         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
8930 .cindex "expansion" "lookup in"
8931 .cindex "file" "lookups"
8932 .cindex "lookup" "in expanded string"
8933 The two forms of lookup item specify data lookups in files and databases, as
8934 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
8935 lookups, and the second is used for query-style lookups. The <&'key'&>,
8936 <&'file'&>, and <&'query'&> strings are expanded before use.
8937
8938 If there is any white space in a lookup item which is part of a filter command,
8939 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
8940 other place where white space is significant, the lookup item must be enclosed
8941 in double quotes. The use of data lookups in users' filter files may be locked
8942 out by the system administrator.
8943
8944 .vindex "&$value$&"
8945 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
8946 During its expansion, the variable &$value$& contains the data returned by the
8947 lookup. Afterwards it reverts to the value it had previously (at the outer
8948 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
8949 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
8950 string on failure. If <&'string2'&> is provided, it can itself be a nested
8951 lookup, thus providing a mechanism for looking up a default value when the
8952 original lookup fails.
8953
8954 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
8955 data for the outer lookup while the parameters of the second lookup are
8956 expanded, and also while <&'string2'&> of the second lookup is expanded, should
8957 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
8958 appear, and in this case, if the lookup fails, the entire expansion is forced
8959 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
8960 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
8961 successful lookup, and nothing in the case of failure.
8962
8963 For single-key lookups, the string &"partial"& is permitted to precede the
8964 search type in order to do partial matching, and * or *@ may follow a search
8965 type to request default lookups if the key does not match (see sections
8966 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
8967
8968 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
8969 If a partial search is used, the variables &$1$& and &$2$& contain the wild
8970 and non-wild parts of the key during the expansion of the replacement text.
8971 They return to their previous values at the end of the lookup item.
8972
8973 This example looks up the postmaster alias in the conventional alias file:
8974 .code
8975 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
8976 .endd
8977 This example uses NIS+ to look up the full name of the user corresponding to
8978 the local part of an address, forcing the expansion to fail if it is not found:
8979 .code
8980 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
8981   {$value}fail}
8982 .endd
8983
8984
8985 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
8986 .cindex "expansion" "list creation"
8987 .vindex "&$item$&"
8988 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
8989 default, but the separator can be changed in the usual way. For each item
8990 in this list, its value is place in &$item$&, and then <&'string2'&> is
8991 expanded and added to the output as an item in a new list. The separator used
8992 for the output list is the same as the one used for the input, but a separator
8993 setting is not included in the output. For example:
8994 .code
8995 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
8996 .endd
8997 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
8998 value of &$item$& is restored to what it was before. See also the &*filter*&
8999 and &*reduce*& expansion items.
9000
9001 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9002 .cindex "expansion" "numeric hash"
9003 .cindex "hash function" "numeric"
9004 The three strings are expanded; the first two must yield numbers. Call them
9005 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9006 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9007 can use the simpler operator notation that avoids some of the braces:
9008 .code
9009 ${nhash_<n>_<m>:<string>}
9010 .endd
9011 The second number is optional (in both notations). If there is only one number,
9012 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
9013 processed by a div/mod hash function that returns two numbers, separated by a
9014 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
9015 example,
9016 .code
9017 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
9018 .endd
9019 returns the string &"6/33"&.
9020
9021
9022
9023 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
9024 .cindex "Perl" "use in expanded string"
9025 .cindex "expansion" "calling Perl from"
9026 This item is available only if Exim has been built to include an embedded Perl
9027 interpreter. The subroutine name and the arguments are first separately
9028 expanded, and then the Perl subroutine is called with those arguments. No
9029 additional arguments need be given; the maximum number permitted, including the
9030 name of the subroutine, is nine.
9031
9032 The return value of the subroutine is inserted into the expanded string, unless
9033 the return value is &%undef%&. In that case, the expansion fails in the same
9034 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
9035 Whatever you return is evaluated in a scalar context. For example, if you
9036 return the name of a Perl vector, the return value is the size of the vector,
9037 not its contents.
9038
9039 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
9040 with the error message that was passed to &%die%&. More details of the embedded
9041 Perl facility are given in chapter &<<CHAPperl>>&.
9042
9043 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
9044 out the use of this expansion item in filter files.
9045
9046
9047 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9048 .cindex "&%prvs%& expansion item"
9049 The first argument is a complete email address and the second is secret
9050 keystring. The third argument, specifying a key number, is optional. If absent,
9051 it defaults to 0. The result of the expansion is a prvs-signed email address,
9052 to be typically used with the &%return_path%& option on an &(smtp)& transport
9053 as part of a bounce address tag validation (BATV) scheme. For more discussion
9054 and an example, see section &<<SECTverifyPRVS>>&.
9055
9056 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
9057         {*&<&'string'&>&*}}*&"
9058 .cindex "&%prvscheck%& expansion item"
9059 This expansion item is the complement of the &%prvs%& item. It is used for
9060 checking prvs-signed addresses. If the expansion of the first argument does not
9061 yield a syntactically valid prvs-signed address, the whole item expands to the
9062 empty string. When the first argument does expand to a syntactically valid
9063 prvs-signed address, the second argument is expanded, with the prvs-decoded
9064 version of the address and the key number extracted from the address in the
9065 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9066
9067 These two variables can be used in the expansion of the second argument to
9068 retrieve the secret. The validity of the prvs-signed address is then checked
9069 against the secret. The result is stored in the variable &$prvscheck_result$&,
9070 which is empty for failure or &"1"& for success.
9071
9072 The third argument is optional; if it is missing, it defaults to an empty
9073 string. This argument is now expanded. If the result is an empty string, the
9074 result of the expansion is the decoded version of the address. This is the case
9075 whether or not the signature was valid. Otherwise, the result of the expansion
9076 is the expansion of the third argument.
9077
9078 All three variables can be used in the expansion of the third argument.
9079 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9080 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9081
9082 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9083 .cindex "expansion" "inserting an entire file"
9084 .cindex "file" "inserting into expansion"
9085 .cindex "&%readfile%& expansion item"
9086 The file name and end-of-line string are first expanded separately. The file is
9087 then read, and its contents replace the entire item. All newline characters in
9088 the file are replaced by the end-of-line string if it is present. Otherwise,
9089 newlines are left in the string.
9090 String expansion is not applied to the contents of the file. If you want this,
9091 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9092 the string expansion fails.
9093
9094 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9095 locks out the use of this expansion item in filter files.
9096
9097
9098
9099 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9100         {*&<&'timeout'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9101 .cindex "expansion" "inserting from a socket"
9102 .cindex "socket, use of in expansion"
9103 .cindex "&%readsocket%& expansion item"
9104 This item inserts data from a Unix domain or Internet socket into the expanded
9105 string. The minimal way of using it uses just two arguments, as in these
9106 examples:
9107 .code
9108 ${readsocket{/socket/name}{request string}}
9109 ${readsocket{inet:some.host:1234}{request string}}
9110 .endd
9111 For a Unix domain socket, the first substring must be the path to the socket.
9112 For an Internet socket, the first substring must contain &`inet:`& followed by
9113 a host name or IP address, followed by a colon and a port, which can be a
9114 number or the name of a TCP port in &_/etc/services_&. An IP address may
9115 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9116 example:
9117 .code
9118 ${readsocket{inet:[::1]:1234}{request string}}
9119 .endd
9120 Only a single host name may be given, but if looking it up yields more than
9121 one IP address, they are each tried in turn until a connection is made. For
9122 both kinds of socket, Exim makes a connection, writes the request string
9123 (unless it is an empty string) and reads from the socket until an end-of-file
9124 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9125 extend what can be done. Firstly, you can vary the timeout. For example:
9126 .code
9127 ${readsocket{/socket/name}{request string}{3s}}
9128 .endd
9129 A fourth argument allows you to change any newlines that are in the data
9130 that is read, in the same way as for &%readfile%& (see above). This example
9131 turns them into spaces:
9132 .code
9133 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9134 .endd
9135 As with all expansions, the substrings are expanded before the processing
9136 happens. Errors in these sub-expansions cause the expansion to fail. In
9137 addition, the following errors can occur:
9138
9139 .ilist
9140 Failure to create a socket file descriptor;
9141 .next
9142 Failure to connect the socket;
9143 .next
9144 Failure to write the request string;
9145 .next
9146 Timeout on reading from the socket.
9147 .endlist
9148
9149 By default, any of these errors causes the expansion to fail. However, if
9150 you supply a fifth substring, it is expanded and used when any of the above
9151 errors occurs. For example:
9152 .code
9153 ${readsocket{/socket/name}{request string}{3s}{\n}\
9154   {socket failure}}
9155 .endd
9156 You can test for the existence of a Unix domain socket by wrapping this
9157 expansion in &`${if exists`&, but there is a race condition between that test
9158 and the actual opening of the socket, so it is safer to use the fifth argument
9159 if you want to be absolutely sure of avoiding an expansion error for a
9160 non-existent Unix domain socket, or a failure to connect to an Internet socket.
9161
9162 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
9163 locks out the use of this expansion item in filter files.
9164
9165
9166 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9167 .cindex "expansion" "reducing a list to a scalar"
9168 .cindex "list" "reducing to a scalar"
9169 .vindex "&$value$&"
9170 .vindex "&$item$&"
9171 This operation reduces a list to a single, scalar string. After expansion,
9172 <&'string1'&> is interpreted as a list, colon-separated by default, but the
9173 separator can be changed in the usual way. Then <&'string2'&> is expanded and
9174 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
9175 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
9176 them. The result of that expansion is assigned to &$value$& before the next
9177 iteration. When the end of the list is reached, the final value of &$value$& is
9178 added to the expansion output. The &*reduce*& expansion item can be used in a
9179 number of ways. For example, to add up a list of numbers:
9180 .code
9181 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
9182 .endd
9183 The result of that expansion would be &`6`&. The maximum of a list of numbers
9184 can be found:
9185 .code
9186 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
9187 .endd
9188 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
9189 restored to what they were before. See also the &*filter*& and &*map*&
9190 expansion items.
9191
9192 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
9193 This item inserts &"raw"& header lines. It is described with the &%header%&
9194 expansion item above.
9195
9196 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
9197         {*&<&'string2'&>&*}}*&"
9198 .cindex "expansion" "running a command"
9199 .cindex "&%run%& expansion item"
9200 The command and its arguments are first expanded separately, and then the
9201 command is run in a separate process, but under the same uid and gid. As in
9202 other command executions from Exim, a shell is not used by default. If you want
9203 a shell, you must explicitly code it.
9204
9205 The standard input for the command exists, but is empty. The standard output
9206 and standard error are set to the same file descriptor.
9207 .cindex "return code" "from &%run%& expansion"
9208 .vindex "&$value$&"
9209 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
9210 and replaces the entire item; during this expansion, the standard output/error
9211 from the command is in the variable &$value$&. If the command fails,
9212 <&'string2'&>, if present, is expanded and used. Once again, during the
9213 expansion, the standard output/error from the command is in the variable
9214 &$value$&.
9215
9216 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
9217 can be the word &"fail"& (not in braces) to force expansion failure if the
9218 command does not succeed. If both strings are omitted, the result is contents
9219 of the standard output/error on success, and nothing on failure.
9220
9221 .vindex "&$runrc$&"
9222 The return code from the command is put in the variable &$runrc$&, and this
9223 remains set afterwards, so in a filter file you can do things like this:
9224 .code
9225 if "${run{x y z}{}}$runrc" is 1 then ...
9226   elif $runrc is 2 then ...
9227   ...
9228 endif
9229 .endd
9230 If execution of the command fails (for example, the command does not exist),
9231 the return code is 127 &-- the same code that shells use for non-existent
9232 commands.
9233
9234 &*Warning*&: In a router or transport, you cannot assume the order in which
9235 option values are expanded, except for those preconditions whose order of
9236 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
9237 by the expansion of one option, and use it in another.
9238
9239 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
9240 out the use of this expansion item in filter files.
9241
9242
9243 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
9244 .cindex "expansion" "string substitution"
9245 .cindex "&%sg%& expansion item"
9246 This item works like Perl's substitution operator (s) with the global (/g)
9247 option; hence its name. However, unlike the Perl equivalent, Exim does not
9248 modify the subject string; instead it returns the modified string for insertion
9249 into the overall expansion. The item takes three arguments: the subject string,
9250 a regular expression, and a substitution string. For example:
9251 .code
9252 ${sg{abcdefabcdef}{abc}{xyz}}
9253 .endd
9254 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
9255 if any $ or \ characters are required in the regular expression or in the
9256 substitution string, they have to be escaped. For example:
9257 .code
9258 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
9259 .endd
9260 yields &"defabc"&, and
9261 .code
9262 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
9263 .endd
9264 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
9265 the regular expression from string expansion.
9266
9267
9268
9269 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9270 .cindex "&%substr%& expansion item"
9271 .cindex "substring extraction"
9272 .cindex "expansion" "substring extraction"
9273 The three strings are expanded; the first two must yield numbers. Call them
9274 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9275 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9276 can use the simpler operator notation that avoids some of the braces:
9277 .code
9278 ${substr_<n>_<m>:<string>}
9279 .endd
9280 The second number is optional (in both notations).
9281 If it is absent in the simpler format, the preceding underscore must also be
9282 omitted.
9283
9284 The &%substr%& item can be used to extract more general substrings than
9285 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
9286 length required. For example
9287 .code
9288 ${substr{3}{2}{$local_part}}
9289 .endd
9290 If the starting offset is greater than the string length the result is the
9291 null string; if the length plus starting offset is greater than the string
9292 length, the result is the right-hand part of the string, starting from the
9293 given offset. The first character in the string has offset zero.
9294
9295 The &%substr%& expansion item can take negative offset values to count
9296 from the right-hand end of its operand. The last character is offset -1, the
9297 second-last is offset -2, and so on. Thus, for example,
9298 .code
9299 ${substr{-5}{2}{1234567}}
9300 .endd
9301 yields &"34"&. If the absolute value of a negative offset is greater than the
9302 length of the string, the substring starts at the beginning of the string, and
9303 the length is reduced by the amount of overshoot. Thus, for example,
9304 .code
9305 ${substr{-5}{2}{12}}
9306 .endd
9307 yields an empty string, but
9308 .code
9309 ${substr{-3}{2}{12}}
9310 .endd
9311 yields &"1"&.
9312
9313 When the second number is omitted from &%substr%&, the remainder of the string
9314 is taken if the offset is positive. If it is negative, all characters in the
9315 string preceding the offset point are taken. For example, an offset of -1 and
9316 no length, as in these semantically identical examples:
9317 .code
9318 ${substr_-1:abcde}
9319 ${substr{-1}{abcde}}
9320 .endd
9321 yields all but the last character of the string, that is, &"abcd"&.
9322
9323
9324
9325 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
9326         {*&<&'replacements'&>&*}}*&"
9327 .cindex "expansion" "character translation"
9328 .cindex "&%tr%& expansion item"
9329 This item does single-character translation on its subject string. The second
9330 argument is a list of characters to be translated in the subject string. Each
9331 matching character is replaced by the corresponding character from the
9332 replacement list. For example
9333 .code
9334 ${tr{abcdea}{ac}{13}}
9335 .endd
9336 yields &`1b3de1`&. If there are duplicates in the second character string, the
9337 last occurrence is used. If the third string is shorter than the second, its
9338 last character is replicated. However, if it is empty, no translation takes
9339 place.
9340 .endlist
9341
9342
9343
9344 .section "Expansion operators" "SECTexpop"
9345 .cindex "expansion" "operators"
9346 For expansion items that perform transformations on a single argument string,
9347 the &"operator"& notation is used because it is simpler and uses fewer braces.
9348 The substring is first expanded before the operation is applied to it. The
9349 following operations can be performed:
9350
9351 .vlist
9352 .vitem &*${address:*&<&'string'&>&*}*&
9353 .cindex "expansion" "RFC 2822 address handling"
9354 .cindex "&%address%& expansion item"
9355 The string is interpreted as an RFC 2822 address, as it might appear in a
9356 header line, and the effective address is extracted from it. If the string does
9357 not parse successfully, the result is empty.
9358
9359
9360 .vitem &*${addresses:*&<&'string'&>&*}*&
9361 .cindex "expansion" "RFC 2822 address handling"
9362 .cindex "&%addresses%& expansion item"
9363 The string (after expansion) is interpreted as a list of addresses in RFC
9364 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
9365 operative address (&'local-part@domain'&) is extracted from each item, and the
9366 result of the expansion is a colon-separated list, with appropriate
9367 doubling of colons should any happen to be present in the email addresses.
9368 Syntactically invalid RFC2822 address items are omitted from the output.
9369
9370 It is possible to specify a character other than colon for the output
9371 separator by starting the string with > followed by the new separator
9372 character. For example:
9373 .code
9374 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
9375 .endd
9376 expands to &`ceo@up.stairs&&sec@base.ment`&. Compare the &*address*& (singular)
9377 expansion item, which extracts the working address from a single RFC2822
9378 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
9379 processing lists.
9380
9381
9382 .vitem &*${base62:*&<&'digits'&>&*}*&
9383 .cindex "&%base62%& expansion item"
9384 .cindex "expansion" "conversion to base 62"
9385 The string must consist entirely of decimal digits. The number is converted to
9386 base 62 and output as a string of six characters, including leading zeros. In
9387 the few operating environments where Exim uses base 36 instead of base 62 for
9388 its message identifiers (because those systems do not have case-sensitive file
9389 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
9390 be absolutely clear: this is &'not'& base64 encoding.
9391
9392 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
9393 .cindex "&%base62d%& expansion item"
9394 .cindex "expansion" "conversion to base 62"
9395 The string must consist entirely of base-62 digits, or, in operating
9396 environments where Exim uses base 36 instead of base 62 for its message
9397 identifiers, base-36 digits. The number is converted to decimal and output as a
9398 string.
9399
9400 .vitem &*${domain:*&<&'string'&>&*}*&
9401 .cindex "domain" "extraction"
9402 .cindex "expansion" "domain extraction"
9403 The string is interpreted as an RFC 2822 address and the domain is extracted
9404 from it. If the string does not parse successfully, the result is empty.
9405
9406
9407 .vitem &*${escape:*&<&'string'&>&*}*&
9408 .cindex "expansion" "escaping non-printing characters"
9409 .cindex "&%escape%& expansion item"
9410 If the string contains any non-printing characters, they are converted to
9411 escape sequences starting with a backslash. Whether characters with the most
9412 significant bit set (so-called &"8-bit characters"&) count as printing or not
9413 is controlled by the &%print_topbitchars%& option.
9414
9415
9416 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
9417 .cindex "expansion" "expression evaluation"
9418 .cindex "expansion" "arithmetic expression"
9419 .cindex "&%eval%& expansion item"
9420 These items supports simple arithmetic and bitwise logical operations in
9421 expansion strings. The string (after expansion) must be a conventional
9422 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
9423 logical operators, and parentheses. All operations are carried out using
9424 integer arithmetic. The operator priorities are as follows (the same as in the
9425 C programming language):
9426 .table2 70pt 300pt
9427 .irow &'highest:'& "not (~), negate (-)"
9428 .irow ""   "multiply (*), divide (/), remainder (%)"
9429 .irow ""   "plus (+), minus (-)"
9430 .irow ""   "shift-left (<<), shift-right (>>)"
9431 .irow ""   "and (&&)"
9432 .irow ""   "xor (^)"
9433 .irow &'lowest:'&  "or (|)"
9434 .endtable
9435 Binary operators with the same priority are evaluated from left to right. White
9436 space is permitted before or after operators.
9437
9438 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
9439 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
9440 decimal, even if they start with a leading zero; hexadecimal numbers are not
9441 permitted. This can be useful when processing numbers extracted from dates or
9442 times, which often do have leading zeros.
9443
9444 A number may be followed by &"K"& or &"M"& to multiply it by 1024 or 1024*1024,
9445 respectively. Negative numbers are supported. The result of the computation is
9446 a decimal representation of the answer (without &"K"& or &"M"&). For example:
9447
9448 .display
9449 &`${eval:1+1}            `&  yields 2
9450 &`${eval:1+2*3}          `&  yields 7
9451 &`${eval:(1+2)*3}        `&  yields 9
9452 &`${eval:2+42%5}         `&  yields 4
9453 &`${eval:0xc&amp;5}          `&  yields 4
9454 &`${eval:0xc|5}          `&  yields 13
9455 &`${eval:0xc^5}          `&  yields 9
9456 &`${eval:0xc>>1}         `&  yields 6
9457 &`${eval:0xc<<1}         `&  yields 24
9458 &`${eval:~255&amp;0x1234}    `&  yields 4608
9459 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
9460 .endd
9461
9462 As a more realistic example, in an ACL you might have
9463 .code
9464 deny   message = Too many bad recipients
9465        condition =                    \
9466          ${if and {                   \
9467            {>{$rcpt_count}{10}}       \
9468            {                          \
9469            <                          \
9470              {$recipients_count}      \
9471              {${eval:$rcpt_count/2}}  \
9472            }                          \
9473          }{yes}{no}}
9474 .endd
9475 The condition is true if there have been more than 10 RCPT commands and
9476 fewer than half of them have resulted in a valid recipient.
9477
9478
9479 .vitem &*${expand:*&<&'string'&>&*}*&
9480 .cindex "expansion" "re-expansion of substring"
9481 The &%expand%& operator causes a string to be expanded for a second time. For
9482 example,
9483 .code
9484 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
9485 .endd
9486 first looks up a string in a file while expanding the operand for &%expand%&,
9487 and then re-expands what it has found.
9488
9489
9490 .vitem &*${from_utf8:*&<&'string'&>&*}*&
9491 .cindex "Unicode"
9492 .cindex "UTF-8" "conversion from"
9493 .cindex "expansion" "UTF-8 conversion"
9494 .cindex "&%from_utf8%& expansion item"
9495 The world is slowly moving towards Unicode, although there are no standards for
9496 email yet. However, other applications (including some databases) are starting
9497 to store data in Unicode, using UTF-8 encoding. This operator converts from a
9498 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
9499 converted to underscores. The input must be a valid UTF-8 string. If it is not,
9500 the result is an undefined sequence of bytes.
9501
9502 Unicode code points with values less than 256 are compatible with ASCII and
9503 ISO-8859-1 (also known as Latin-1).
9504 For example, character 169 is the copyright symbol in both cases, though the
9505 way it is encoded is different. In UTF-8, more than one byte is needed for
9506 characters with code values greater than 127, whereas ISO-8859-1 is a
9507 single-byte encoding (but thereby limited to 256 characters). This makes
9508 translation from UTF-8 to ISO-8859-1 straightforward.
9509
9510
9511 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
9512 .cindex "hash function" "textual"
9513 .cindex "expansion" "textual hash"
9514 The &%hash%& operator is a simpler interface to the hashing function that can
9515 be used when the two parameters are fixed numbers (as opposed to strings that
9516 change when expanded). The effect is the same as
9517 .code
9518 ${hash{<n>}{<m>}{<string>}}
9519 .endd
9520 See the description of the general &%hash%& item above for details. The
9521 abbreviation &%h%& can be used when &%hash%& is used as an operator.
9522
9523
9524
9525 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
9526 .cindex "base64 encoding" "conversion from hex"
9527 .cindex "expansion" "hex to base64"
9528 .cindex "&%hex2b64%& expansion item"
9529 This operator converts a hex string into one that is base64 encoded. This can
9530 be useful for processing the output of the MD5 and SHA-1 hashing functions.
9531
9532
9533 .vitem &*${lc:*&<&'string'&>&*}*&
9534 .cindex "case forcing in strings"
9535 .cindex "string" "case forcing"
9536 .cindex "lower casing"
9537 .cindex "expansion" "case forcing"
9538 .cindex "&%lc%& expansion item"
9539 This forces the letters in the string into lower-case, for example:
9540 .code
9541 ${lc:$local_part}
9542 .endd
9543
9544 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
9545 .cindex "expansion" "string truncation"
9546 .cindex "&%length%& expansion item"
9547 The &%length%& operator is a simpler interface to the &%length%& function that
9548 can be used when the parameter is a fixed number (as opposed to a string that
9549 changes when expanded). The effect is the same as
9550 .code
9551 ${length{<number>}{<string>}}
9552 .endd
9553 See the description of the general &%length%& item above for details. Note that
9554 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
9555 when &%length%& is used as an operator.
9556
9557
9558 .vitem &*${local_part:*&<&'string'&>&*}*&
9559 .cindex "expansion" "local part extraction"
9560 .cindex "&%local_part%& expansion item"
9561 The string is interpreted as an RFC 2822 address and the local part is
9562 extracted from it. If the string does not parse successfully, the result is
9563 empty.
9564
9565
9566 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
9567 .cindex "masked IP address"
9568 .cindex "IP address" "masking"
9569 .cindex "CIDR notation"
9570 .cindex "expansion" "IP address masking"
9571 .cindex "&%mask%& expansion item"
9572 If the form of the string to be operated on is not an IP address followed by a
9573 slash and an integer (that is, a network address in CIDR notation), the
9574 expansion fails. Otherwise, this operator converts the IP address to binary,
9575 masks off the least significant bits according to the bit count, and converts
9576 the result back to text, with mask appended. For example,
9577 .code
9578 ${mask:10.111.131.206/28}
9579 .endd
9580 returns the string &"10.111.131.192/28"&. Since this operation is expected to
9581 be mostly used for looking up masked addresses in files, the result for an IPv6
9582 address uses dots to separate components instead of colons, because colon
9583 terminates a key string in lsearch files. So, for example,
9584 .code
9585 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
9586 .endd
9587 returns the string
9588 .code
9589 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
9590 .endd
9591 Letters in IPv6 addresses are always output in lower case.
9592
9593
9594 .vitem &*${md5:*&<&'string'&>&*}*&
9595 .cindex "MD5 hash"
9596 .cindex "expansion" "MD5 hash"
9597 .cindex "&%md5%& expansion item"
9598 The &%md5%& operator computes the MD5 hash value of the string, and returns it
9599 as a 32-digit hexadecimal number, in which any letters are in lower case.
9600
9601
9602 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
9603 .cindex "expansion" "numeric hash"
9604 .cindex "hash function" "numeric"
9605 The &%nhash%& operator is a simpler interface to the numeric hashing function
9606 that can be used when the two parameters are fixed numbers (as opposed to
9607 strings that change when expanded). The effect is the same as
9608 .code
9609 ${nhash{<n>}{<m>}{<string>}}
9610 .endd
9611 See the description of the general &%nhash%& item above for details.
9612
9613
9614 .vitem &*${quote:*&<&'string'&>&*}*&
9615 .cindex "quoting" "in string expansions"
9616 .cindex "expansion" "quoting"
9617 .cindex "&%quote%& expansion item"
9618 The &%quote%& operator puts its argument into double quotes if it
9619 is an empty string or
9620 contains anything other than letters, digits, underscores, dots, and hyphens.
9621 Any occurrences of double quotes and backslashes are escaped with a backslash.
9622 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
9623 respectively For example,
9624 .code
9625 ${quote:ab"*"cd}
9626 .endd
9627 becomes
9628 .code
9629 "ab\"*\"cd"
9630 .endd
9631 The place where this is useful is when the argument is a substitution from a
9632 variable or a message header.
9633
9634 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
9635 .cindex "&%quote_local_part%& expansion item"
9636 This operator is like &%quote%&, except that it quotes the string only if
9637 required to do so by the rules of RFC 2822 for quoting local parts. For
9638 example, a plus sign would not cause quoting (but it would for &%quote%&).
9639 If you are creating a new email address from the contents of &$local_part$&
9640 (or any other unknown data), you should always use this operator.
9641
9642
9643 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
9644 .cindex "quoting" "lookup-specific"
9645 This operator applies lookup-specific quoting rules to the string. Each
9646 query-style lookup type has its own quoting rules which are described with
9647 the lookups in chapter &<<CHAPfdlookup>>&. For example,
9648 .code
9649 ${quote_ldap:two * two}
9650 .endd
9651 returns
9652 .code
9653 two%20%5C2A%20two
9654 .endd
9655 For single-key lookup types, no quoting is ever necessary and this operator
9656 yields an unchanged string.
9657
9658
9659 .vitem &*${randint:*&<&'n'&>&*}*&
9660 .cindex "random number"
9661 This operator returns a somewhat random number which is less than the
9662 supplied number and is at least 0.  The quality of this randomness depends
9663 on how Exim was built; the values are not suitable for keying material.
9664 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
9665 Otherwise, the implementation may be arc4random(), random() seeded by
9666 srandomdev() or srandom(), or a custom implementation even weaker than
9667 random().
9668
9669
9670 .new
9671 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
9672 .cindex "expansion" "IP address"
9673 This operator reverses an IP address; for IPv4 addresses, the result is in
9674 dotted-quad decimal form, while for IPv6 addreses the result is in
9675 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
9676 for DNS.  For example,
9677 .code
9678 ${reverse_ip:192.0.2.4} and ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.3}
9679 .endd
9680 returns
9681 .code
9682 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
9683 .endd
9684 .wen
9685
9686
9687 .vitem &*${rfc2047:*&<&'string'&>&*}*&
9688 .cindex "expansion" "RFC 2047"
9689 .cindex "RFC 2047" "expansion operator"
9690 .cindex "&%rfc2047%& expansion item"
9691 This operator encodes text according to the rules of RFC 2047. This is an
9692 encoding that is used in header lines to encode non-ASCII characters. It is
9693 assumed that the input string is in the encoding specified by the
9694 &%headers_charset%& option, which defaults to ISO-8859-1. If the string
9695 contains only characters in the range 33&--126, and no instances of the
9696 characters
9697 .code
9698 ? = ( ) < > @ , ; : \ " . [ ] _
9699 .endd
9700 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
9701 string, using as many &"encoded words"& as necessary to encode all the
9702 characters.
9703
9704
9705 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
9706 .cindex "expansion" "RFC 2047"
9707 .cindex "RFC 2047" "decoding"
9708 .cindex "&%rfc2047d%& expansion item"
9709 This operator decodes strings that are encoded as per RFC 2047. Binary zero
9710 bytes are replaced by question marks. Characters are converted into the
9711 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
9712 not recognized unless &%check_rfc2047_length%& is set false.
9713
9714 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
9715 access a header line, RFC 2047 decoding is done automatically. You do not need
9716 to use this operator as well.
9717
9718
9719
9720 .vitem &*${rxquote:*&<&'string'&>&*}*&
9721 .cindex "quoting" "in regular expressions"
9722 .cindex "regular expressions" "quoting"
9723 .cindex "&%rxquote%& expansion item"
9724 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
9725 characters in its argument. This is useful when substituting the values of
9726 variables or headers inside regular expressions.
9727
9728
9729 .vitem &*${sha1:*&<&'string'&>&*}*&
9730 .cindex "SHA-1 hash"
9731 .cindex "expansion" "SHA-1 hashing"
9732 .cindex "&%sha2%& expansion item"
9733 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
9734 it as a 40-digit hexadecimal number, in which any letters are in upper case.
9735
9736
9737 .vitem &*${stat:*&<&'string'&>&*}*&
9738 .cindex "expansion" "statting a file"
9739 .cindex "file" "extracting characteristics"
9740 .cindex "&%stat%& expansion item"
9741 The string, after expansion, must be a file path. A call to the &[stat()]&
9742 function is made for this path. If &[stat()]& fails, an error occurs and the
9743 expansion fails. If it succeeds, the data from the stat replaces the item, as a
9744 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
9745 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
9746 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
9747 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
9748 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
9749 can extract individual fields using the &%extract%& expansion item.
9750
9751 The use of the &%stat%& expansion in users' filter files can be locked out by
9752 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
9753 systems for files larger than 2GB.
9754
9755 .vitem &*${str2b64:*&<&'string'&>&*}*&
9756 .cindex "expansion" "base64 encoding"
9757 .cindex "base64 encoding" "in string expansion"
9758 .cindex "&%str2b64%& expansion item"
9759 This operator converts a string into one that is base64 encoded.
9760
9761
9762
9763 .vitem &*${strlen:*&<&'string'&>&*}*&
9764 .cindex "expansion" "string length"
9765 .cindex "string" "length in expansion"
9766 .cindex "&%strlen%& expansion item"
9767 The item is replace by the length of the expanded string, expressed as a
9768 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
9769
9770
9771 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
9772 .cindex "&%substr%& expansion item"
9773 .cindex "substring extraction"
9774 .cindex "expansion" "substring expansion"
9775 The &%substr%& operator is a simpler interface to the &%substr%& function that
9776 can be used when the two parameters are fixed numbers (as opposed to strings
9777 that change when expanded). The effect is the same as
9778 .code
9779 ${substr{<start>}{<length>}{<string>}}
9780 .endd
9781 See the description of the general &%substr%& item above for details. The
9782 abbreviation &%s%& can be used when &%substr%& is used as an operator.
9783
9784 .vitem &*${time_eval:*&<&'string'&>&*}*&
9785 .cindex "&%time_eval%& expansion item"
9786 .cindex "time interval" "decoding"
9787 This item converts an Exim time interval such as &`2d4h5m`& into a number of
9788 seconds.
9789
9790 .vitem &*${time_interval:*&<&'string'&>&*}*&
9791 .cindex "&%time_interval%& expansion item"
9792 .cindex "time interval" "formatting"
9793 The argument (after sub-expansion) must be a sequence of decimal digits that
9794 represents an interval of time as a number of seconds. It is converted into a
9795 number of larger units and output in Exim's normal time format, for example,
9796 &`1w3d4h2m6s`&.
9797
9798 .vitem &*${uc:*&<&'string'&>&*}*&
9799 .cindex "case forcing in strings"
9800 .cindex "string" "case forcing"
9801 .cindex "upper casing"
9802 .cindex "expansion" "case forcing"
9803 .cindex "&%uc%& expansion item"
9804 This forces the letters in the string into upper-case.
9805 .endlist
9806
9807
9808
9809
9810
9811
9812 .section "Expansion conditions" "SECTexpcond"
9813 .scindex IIDexpcond "expansion" "conditions"
9814 The following conditions are available for testing by the &%${if%& construct
9815 while expanding strings:
9816
9817 .vlist
9818 .vitem &*!*&<&'condition'&>
9819 .cindex "expansion" "negating a condition"
9820 .cindex "negation" "in expansion condition"
9821 Preceding any condition with an exclamation mark negates the result of the
9822 condition.
9823
9824 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
9825 .cindex "numeric comparison"
9826 .cindex "expansion" "numeric comparison"
9827 There are a number of symbolic operators for doing numeric comparisons. They
9828 are:
9829 .display
9830 &`=   `&   equal
9831 &`==  `&   equal
9832 &`>   `&   greater
9833 &`>=  `&   greater or equal
9834 &`<   `&   less
9835 &`<=  `&   less or equal
9836 .endd
9837 For example:
9838 .code
9839 ${if >{$message_size}{10M} ...
9840 .endd
9841 Note that the general negation operator provides for inequality testing. The
9842 two strings must take the form of optionally signed decimal integers,
9843 optionally followed by one of the letters &"K"& or &"M"& (in either upper or
9844 lower case), signifying multiplication by 1024 or 1024*1024, respectively.
9845 As a special case, the numerical value of an empty string is taken as
9846 zero.
9847
9848
9849 .new
9850 .vitem &*bool&~{*&<&'string'&>&*}*&
9851 .cindex "expansion" "boolean parsing"
9852 .cindex "&%bool%& expansion condition"
9853 This condition turns a string holding a true or false representation into
9854 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
9855 (case-insensitively); also positive integer numbers map to true if non-zero,
9856 false if zero.  Leading and trailing whitespace is ignored.
9857 All other string values will result in expansion failure.
9858
9859 When combined with ACL variables, this expansion condition will let you
9860 make decisions in one place and act on those decisions in another place.
9861 For example:
9862 .code
9863 ${if bool{$acl_m_privileged_sender} ...
9864 .endd
9865 .wen
9866
9867
9868 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
9869 .cindex "expansion" "boolean parsing"
9870 .cindex "&%bool_lax%& expansion condition"
9871 Like &%bool%&, this condition turns a string into a boolean state.  But
9872 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
9873 loose definition that the Router &%condition%& option uses.  The empty string
9874 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
9875 true.  Leading and trailing whitespace is ignored.
9876
9877 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
9878
9879 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
9880 .cindex "expansion" "encrypted comparison"
9881 .cindex "encrypted strings, comparing"
9882 .cindex "&%crypteq%& expansion condition"
9883 This condition is included in the Exim binary if it is built to support any
9884 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
9885 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
9886 included in the binary.
9887
9888 The &%crypteq%& condition has two arguments. The first is encrypted and
9889 compared against the second, which is already encrypted. The second string may
9890 be in the LDAP form for storing encrypted strings, which starts with the
9891 encryption type in curly brackets, followed by the data. If the second string
9892 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
9893 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
9894 Typically this will be a field from a password file. An example of an encrypted
9895 string in LDAP form is:
9896 .code
9897 {md5}CY9rzUYh03PK3k6DJie09g==
9898 .endd
9899 If such a string appears directly in an expansion, the curly brackets have to
9900 be quoted, because they are part of the expansion syntax. For example:
9901 .code
9902 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
9903 .endd
9904 The following encryption types (whose names are matched case-independently) are
9905 supported:
9906
9907 .ilist
9908 .cindex "MD5 hash"
9909 .cindex "base64 encoding" "in encrypted password"
9910 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
9911 printable characters to compare with the remainder of the second string. If the
9912 length of the comparison string is 24, Exim assumes that it is base64 encoded
9913 (as in the above example). If the length is 32, Exim assumes that it is a
9914 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
9915 comparison fails.
9916
9917 .next
9918 .cindex "SHA-1 hash"
9919 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
9920 printable characters to compare with the remainder of the second string. If the
9921 length of the comparison string is 28, Exim assumes that it is base64 encoded.
9922 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
9923 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
9924
9925 .next
9926 .cindex "&[crypt()]&"
9927 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
9928 only the first eight characters of the password. However, in modern operating
9929 systems this is no longer true, and in many cases the entire password is used,
9930 whatever its length.
9931
9932 .next
9933 .cindex "&[crypt16()]&"
9934 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
9935 use up to 16 characters of the password in some operating systems. Again, in
9936 modern operating systems, more characters may be used.
9937 .endlist
9938 Exim has its own version of &[crypt16()]&, which is just a double call to
9939 &[crypt()]&. For operating systems that have their own version, setting
9940 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
9941 operating system version instead of its own. This option is set by default in
9942 the OS-dependent &_Makefile_& for those operating systems that are known to
9943 support &[crypt16()]&.
9944
9945 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
9946 it was not using the same algorithm as some operating systems' versions. It
9947 turns out that as well as &[crypt16()]& there is a function called
9948 &[bigcrypt()]& in some operating systems. This may or may not use the same
9949 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
9950
9951 However, since there is now a move away from the traditional &[crypt()]&
9952 functions towards using SHA1 and other algorithms, tidying up this area of
9953 Exim is seen as very low priority.
9954
9955 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
9956 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
9957 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
9958 default is &`{crypt}`&. Whatever the default, you can always use either
9959 function by specifying it explicitly in curly brackets.
9960
9961 .vitem &*def:*&<&'variable&~name'&>
9962 .cindex "expansion" "checking for empty variable"
9963 .cindex "&%def%& expansion condition"
9964 The &%def%& condition must be followed by the name of one of the expansion
9965 variables defined in section &<<SECTexpvar>>&. The condition is true if the
9966 variable does not contain the empty string. For example:
9967 .code
9968 ${if def:sender_ident {from $sender_ident}}
9969 .endd
9970 Note that the variable name is given without a leading &%$%& character. If the
9971 variable does not exist, the expansion fails.
9972
9973 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
9974         &~&*def:h_*&<&'header&~name'&>&*:*&"
9975 .cindex "expansion" "checking header line existence"
9976 This condition is true if a message is being processed and the named header
9977 exists in the message. For example,
9978 .code
9979 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
9980 .endd
9981 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
9982 the header name must be terminated by a colon if white space does not follow.
9983
9984 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
9985        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
9986 .cindex "string" "comparison"
9987 .cindex "expansion" "string comparison"
9988 .cindex "&%eq%& expansion condition"
9989 .cindex "&%eqi%& expansion condition"
9990 The two substrings are first expanded. The condition is true if the two
9991 resulting strings are identical. For &%eq%& the comparison includes the case of
9992 letters, whereas for &%eqi%& the comparison is case-independent.
9993
9994 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
9995 .cindex "expansion" "file existence test"
9996 .cindex "file" "existence test"
9997 .cindex "&%exists%&, expansion condition"
9998 The substring is first expanded and then interpreted as an absolute path. The
9999 condition is true if the named file (or directory) exists. The existence test
10000 is done by calling the &[stat()]& function. The use of the &%exists%& test in
10001 users' filter files may be locked out by the system administrator.
10002
10003 .vitem &*first_delivery*&
10004 .cindex "delivery" "first"
10005 .cindex "first delivery"
10006 .cindex "expansion" "first delivery test"
10007 .cindex "&%first_delivery%& expansion condition"
10008 This condition, which has no data, is true during a message's first delivery
10009 attempt. It is false during any subsequent delivery attempts.
10010
10011
10012 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
10013        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
10014 .cindex "list" "iterative conditions"
10015 .cindex "expansion" "&*forall*& condition"
10016 .cindex "expansion" "&*forany*& condition"
10017 .vindex "&$item$&"
10018 These conditions iterate over a list. The first argument is expanded to form
10019 the list. By default, the list separator is a colon, but it can be changed by
10020 the normal method. The second argument is interpreted as a condition that is to
10021 be applied to each item in the list in turn. During the interpretation of the
10022 condition, the current list item is placed in a variable called &$item$&.
10023 .ilist
10024 For &*forany*&, interpretation stops if the condition is true for any item, and
10025 the result of the whole condition is true. If the condition is false for all
10026 items in the list, the overall condition is false.
10027 .next
10028 For &*forall*&, interpretation stops if the condition is false for any item,
10029 and the result of the whole condition is false. If the condition is true for
10030 all items in the list, the overall condition is true.
10031 .endlist
10032 Note that negation of &*forany*& means that the condition must be false for all
10033 items for the overall condition to succeed, and negation of &*forall*& means
10034 that the condition must be false for at least one item. In this example, the
10035 list separator is changed to a comma:
10036 .code
10037 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
10038 .endd
10039 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
10040 being processed, to enable these expansion items to be nested.
10041
10042
10043 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10044        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10045 .cindex "string" "comparison"
10046 .cindex "expansion" "string comparison"
10047 .cindex "&%ge%& expansion condition"
10048 .cindex "&%gei%& expansion condition"
10049 The two substrings are first expanded. The condition is true if the first
10050 string is lexically greater than or equal to the second string. For &%ge%& the
10051 comparison includes the case of letters, whereas for &%gei%& the comparison is
10052 case-independent.
10053
10054 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10055        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10056 .cindex "string" "comparison"
10057 .cindex "expansion" "string comparison"
10058 .cindex "&%gt%& expansion condition"
10059 .cindex "&%gti%& expansion condition"
10060 The two substrings are first expanded. The condition is true if the first
10061 string is lexically greater than the second string. For &%gt%& the comparison
10062 includes the case of letters, whereas for &%gti%& the comparison is
10063 case-independent.
10064
10065 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
10066        &*isip4&~{*&<&'string'&>&*}*& &&&
10067        &*isip6&~{*&<&'string'&>&*}*&
10068 .cindex "IP address" "testing string format"
10069 .cindex "string" "testing for IP address"
10070 .cindex "&%isip%& expansion condition"
10071 .cindex "&%isip4%& expansion condition"
10072 .cindex "&%isip6%& expansion condition"
10073 The substring is first expanded, and then tested to see if it has the form of
10074 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
10075 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
10076
10077 For an IPv4 address, the test is for four dot-separated components, each of
10078 which consists of from one to three digits. For an IPv6 address, up to eight
10079 colon-separated components are permitted, each containing from one to four
10080 hexadecimal digits. There may be fewer than eight components if an empty
10081 component (adjacent colons) is present. Only one empty component is permitted.
10082
10083 &*Note*&: The checks are just on the form of the address; actual numerical
10084 values are not considered. Thus, for example, 999.999.999.999 passes the IPv4
10085 check. The main use of these tests is to distinguish between IP addresses and
10086 host names, or between IPv4 and IPv6 addresses. For example, you could use
10087 .code
10088 ${if isip4{$sender_host_address}...
10089 .endd
10090 to test which IP version an incoming SMTP connection is using.
10091
10092 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
10093 .cindex "LDAP" "use for authentication"
10094 .cindex "expansion" "LDAP authentication test"
10095 .cindex "&%ldapauth%& expansion condition"
10096 This condition supports user authentication using LDAP. See section
10097 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
10098 queries. For this use, the query must contain a user name and password. The
10099 query itself is not used, and can be empty. The condition is true if the
10100 password is not empty, and the user name and password are accepted by the LDAP
10101 server. An empty password is rejected without calling LDAP because LDAP binds
10102 with an empty password are considered anonymous regardless of the username, and
10103 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
10104 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
10105 this can be used.
10106
10107
10108 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10109        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10110 .cindex "string" "comparison"
10111 .cindex "expansion" "string comparison"
10112 .cindex "&%le%& expansion condition"
10113 .cindex "&%lei%& expansion condition"
10114 The two substrings are first expanded. The condition is true if the first
10115 string is lexically less than or equal to the second string. For &%le%& the
10116 comparison includes the case of letters, whereas for &%lei%& the comparison is
10117 case-independent.
10118
10119 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10120        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10121 .cindex "string" "comparison"
10122 .cindex "expansion" "string comparison"
10123 .cindex "&%lt%& expansion condition"
10124 .cindex "&%lti%& expansion condition"
10125 The two substrings are first expanded. The condition is true if the first
10126 string is lexically less than the second string. For &%lt%& the comparison
10127 includes the case of letters, whereas for &%lti%& the comparison is
10128 case-independent.
10129
10130
10131 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10132 .cindex "expansion" "regular expression comparison"
10133 .cindex "regular expressions" "match in expanded string"
10134 .cindex "&%match%& expansion condition"
10135 The two substrings are first expanded. The second is then treated as a regular
10136 expression and applied to the first. Because of the pre-expansion, if the
10137 regular expression contains dollar, or backslash characters, they must be
10138 escaped. Care must also be taken if the regular expression contains braces
10139 (curly brackets). A closing brace must be escaped so that it is not taken as a
10140 premature termination of <&'string2'&>. The easiest approach is to use the
10141 &`\N`& feature to disable expansion of the regular expression.
10142 For example,
10143 .code
10144 ${if match {$local_part}{\N^\d{3}\N} ...
10145 .endd
10146 If the whole expansion string is in double quotes, further escaping of
10147 backslashes is also required.
10148
10149 The condition is true if the regular expression match succeeds.
10150 The regular expression is not required to begin with a circumflex
10151 metacharacter, but if there is no circumflex, the expression is not anchored,
10152 and it may match anywhere in the subject, not just at the start. If you want
10153 the pattern to match at the end of the subject, you must include the &`$`&
10154 metacharacter at an appropriate point.
10155
10156 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
10157 At the start of an &%if%& expansion the values of the numeric variable
10158 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
10159 succeeds causes them to be reset to the substrings of that condition and they
10160 will have these values during the expansion of the success string. At the end
10161 of the &%if%& expansion, the previous values are restored. After testing a
10162 combination of conditions using &%or%&, the subsequent values of the numeric
10163 variables are those of the condition that succeeded.
10164
10165 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10166 .cindex "&%match_address%& expansion condition"
10167 See &*match_local_part*&.
10168
10169 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10170 .cindex "&%match_domain%& expansion condition"
10171 See &*match_local_part*&.
10172
10173 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10174 .cindex "&%match_ip%& expansion condition"
10175 This condition matches an IP address to a list of IP address patterns. It must
10176 be followed by two argument strings. The first (after expansion) must be an IP
10177 address or an empty string. The second (after expansion) is a restricted host
10178 list that can match only an IP address, not a host name. For example:
10179 .code
10180 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
10181 .endd
10182 The specific types of host list item that are permitted in the list are:
10183
10184 .ilist
10185 An IP address, optionally with a CIDR mask.
10186 .next
10187 A single asterisk, which matches any IP address.
10188 .next
10189 An empty item, which matches only if the IP address is empty. This could be
10190 useful for testing for a locally submitted message or one from specific hosts
10191 in a single test such as
10192 . ==== As this is a nested list, any displays it contains must be indented
10193 . ==== as otherwise they are too far to the left. This comment applies to
10194 . ==== the use of xmlto plus fop. There's no problem when formatting with
10195 . ==== sdop, with or without the extra indent.
10196 .code
10197   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
10198 .endd
10199 where the first item in the list is the empty string.
10200 .next
10201 The item @[] matches any of the local host's interface addresses.
10202 .next
10203 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
10204 even if &`net-`& is not specified. There is never any attempt to turn the IP
10205 address into a host name. The most common type of linear search for
10206 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
10207 masks. For example:
10208 .code
10209   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
10210 .endd
10211 It is of course possible to use other kinds of lookup, and in such a case, you
10212 do need to specify the &`net-`& prefix if you want to specify a specific
10213 address mask, for example:
10214 .code
10215   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
10216 .endd
10217 However, unless you are combining a &%match_ip%& condition with others, it is
10218 just as easy to use the fact that a lookup is itself a condition, and write:
10219 .code
10220   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
10221 .endd
10222 .endlist ilist
10223
10224 Consult section &<<SECThoslispatip>>& for further details of these patterns.
10225
10226 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10227 .cindex "domain list" "in expansion condition"
10228 .cindex "address list" "in expansion condition"
10229 .cindex "local part" "list, in expansion condition"
10230 .cindex "&%match_local_part%& expansion condition"
10231 This condition, together with &%match_address%& and &%match_domain%&, make it
10232 possible to test domain, address, and local part lists within expansions. Each
10233 condition requires two arguments: an item and a list to match. A trivial
10234 example is:
10235 .code
10236 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
10237 .endd
10238 In each case, the second argument may contain any of the allowable items for a
10239 list of the appropriate type. Also, because the second argument (after
10240 expansion) is a standard form of list, it is possible to refer to a named list.
10241 Thus, you can use conditions like this:
10242 .code
10243 ${if match_domain{$domain}{+local_domains}{...
10244 .endd
10245 .cindex "&`+caseful`&"
10246 For address lists, the matching starts off caselessly, but the &`+caseful`&
10247 item can be used, as in all address lists, to cause subsequent items to
10248 have their local parts matched casefully. Domains are always matched
10249 caselessly.
10250
10251 &*Note*&: Host lists are &'not'& supported in this way. This is because
10252 hosts have two identities: a name and an IP address, and it is not clear
10253 how to specify cleanly how such a test would work. However, IP addresses can be
10254 matched using &%match_ip%&.
10255
10256 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
10257 .cindex "PAM authentication"
10258 .cindex "AUTH" "with PAM"
10259 .cindex "Solaris" "PAM support"
10260 .cindex "expansion" "PAM authentication test"
10261 .cindex "&%pam%& expansion condition"
10262 &'Pluggable Authentication Modules'&
10263 (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is
10264 available in the latest releases of Solaris and in some GNU/Linux
10265 distributions. The Exim support, which is intended for use in conjunction with
10266 the SMTP AUTH command, is available only if Exim is compiled with
10267 .code
10268 SUPPORT_PAM=yes
10269 .endd
10270 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
10271 in some releases of GNU/Linux &%-ldl%& is also needed.
10272
10273 The argument string is first expanded, and the result must be a
10274 colon-separated list of strings. Leading and trailing white space is ignored.
10275 The PAM module is initialized with the service name &"exim"& and the user name
10276 taken from the first item in the colon-separated data string (<&'string1'&>).
10277 The remaining items in the data string are passed over in response to requests
10278 from the authentication function. In the simple case there will only be one
10279 request, for a password, so the data consists of just two strings.
10280
10281 There can be problems if any of the strings are permitted to contain colon
10282 characters. In the usual way, these have to be doubled to avoid being taken as
10283 separators. If the data is being inserted from a variable, the &%sg%& expansion
10284 item can be used to double any existing colons. For example, the configuration
10285 of a LOGIN authenticator might contain this setting:
10286 .code
10287 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
10288 .endd
10289 For a PLAIN authenticator you could use:
10290 .code
10291 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
10292 .endd
10293 In some operating systems, PAM authentication can be done only from a process
10294 running as root. Since Exim is running as the Exim user when receiving
10295 messages, this means that PAM cannot be used directly in those systems.
10296 A patched version of the &'pam_unix'& module that comes with the
10297 Linux PAM package is available from &url(http://www.e-admin.de/pam_exim/).
10298 The patched module allows one special uid/gid combination, in addition to root,
10299 to authenticate. If you build the patched module to allow the Exim user and
10300 group, PAM can then be used from an Exim authenticator.
10301
10302
10303 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
10304 .cindex "&'pwcheck'& daemon"
10305 .cindex "Cyrus"
10306 .cindex "expansion" "&'pwcheck'& authentication test"
10307 .cindex "&%pwcheck%& expansion condition"
10308 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
10309 This is one way of making it possible for passwords to be checked by a process
10310 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
10311 deprecated. Its replacement is &'saslauthd'& (see below).
10312
10313 The pwcheck support is not included in Exim by default. You need to specify
10314 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
10315 building Exim. For example:
10316 .code
10317 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
10318 .endd
10319 You do not need to install the full Cyrus software suite in order to use
10320 the pwcheck daemon. You can compile and install just the daemon alone
10321 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
10322 access to the &_/var/pwcheck_& directory.
10323
10324 The &%pwcheck%& condition takes one argument, which must be the user name and
10325 password, separated by a colon. For example, in a LOGIN authenticator
10326 configuration, you might have this:
10327 .code
10328 server_condition = ${if pwcheck{$auth1:$auth2}}
10329 .endd
10330 Again, for a PLAIN authenticator configuration, this would be:
10331 .code
10332 server_condition = ${if pwcheck{$auth2:$auth3}}
10333 .endd
10334 .vitem &*queue_running*&
10335 .cindex "queue runner" "detecting when delivering from"
10336 .cindex "expansion" "queue runner test"
10337 .cindex "&%queue_running%& expansion condition"
10338 This condition, which has no data, is true during delivery attempts that are
10339 initiated by queue runner processes, and false otherwise.
10340
10341
10342 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
10343 .cindex "Radius"
10344 .cindex "expansion" "Radius authentication"
10345 .cindex "&%radius%& expansion condition"
10346 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
10347 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
10348 the Radius client configuration file in order to build Exim with Radius
10349 support.
10350
10351 With just that one setting, Exim expects to be linked with the &%radiusclient%&
10352 library, using the original API. If you are using release 0.4.0 or later of
10353 this library, you need to set
10354 .code
10355 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
10356 .endd
10357 in &_Local/Makefile_& when building Exim. You can also link Exim with the
10358 &%libradius%& library that comes with FreeBSD. To do this, set
10359 .code
10360 RADIUS_LIB_TYPE=RADLIB
10361 .endd
10362 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
10363 You may also have to supply a suitable setting in EXTRALIBS so that the
10364 Radius library can be found when Exim is linked.
10365
10366 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
10367 Radius client library, which calls the Radius server. The condition is true if
10368 the authentication is successful. For example:
10369 .code
10370 server_condition = ${if radius{<arguments>}}
10371 .endd
10372
10373
10374 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
10375         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
10376 .cindex "&'saslauthd'& daemon"
10377 .cindex "Cyrus"
10378 .cindex "expansion" "&'saslauthd'& authentication test"
10379 .cindex "&%saslauthd%& expansion condition"
10380 This condition supports user authentication using the Cyrus &'saslauthd'&
10381 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
10382 Using this daemon is one way of making it possible for passwords to be checked
10383 by a process that is not running as root.
10384
10385 The saslauthd support is not included in Exim by default. You need to specify
10386 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
10387 building Exim. For example:
10388 .code
10389 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
10390 .endd
10391 You do not need to install the full Cyrus software suite in order to use
10392 the saslauthd daemon. You can compile and install just the daemon alone
10393 from the Cyrus SASL library.
10394
10395 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
10396 two are mandatory. For example:
10397 .code
10398 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
10399 .endd
10400 The service and the realm are optional (which is why the arguments are enclosed
10401 in their own set of braces). For details of the meaning of the service and
10402 realm, and how to run the daemon, consult the Cyrus documentation.
10403 .endlist vlist
10404
10405
10406
10407 .section "Combining expansion conditions" "SECID84"
10408 .cindex "expansion" "combining conditions"
10409 Several conditions can be tested at once by combining them using the &%and%&
10410 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
10411 conditions on their own, and precede their lists of sub-conditions. Each
10412 sub-condition must be enclosed in braces within the overall braces that contain
10413 the list. No repetition of &%if%& is used.
10414
10415
10416 .vlist
10417 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
10418 .cindex "&""or""& expansion condition"
10419 .cindex "expansion" "&""or""& of conditions"
10420 The sub-conditions are evaluated from left to right. The condition is true if
10421 any one of the sub-conditions is true.
10422 For example,
10423 .code
10424 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
10425 .endd
10426 When a true sub-condition is found, the following ones are parsed but not
10427 evaluated. If there are several &"match"& sub-conditions the values of the
10428 numeric variables afterwards are taken from the first one that succeeds.
10429
10430 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
10431 .cindex "&""and""& expansion condition"
10432 .cindex "expansion" "&""and""& of conditions"
10433 The sub-conditions are evaluated from left to right. The condition is true if
10434 all of the sub-conditions are true. If there are several &"match"&
10435 sub-conditions, the values of the numeric variables afterwards are taken from
10436 the last one. When a false sub-condition is found, the following ones are
10437 parsed but not evaluated.
10438 .endlist
10439 .ecindex IIDexpcond
10440
10441
10442
10443
10444 .section "Expansion variables" "SECTexpvar"
10445 .cindex "expansion" "variables, list of"
10446 This section contains an alphabetical list of all the expansion variables. Some
10447 of them are available only when Exim is compiled with specific options such as
10448 support for TLS or the content scanning extension.
10449
10450 .vlist
10451 .vitem "&$0$&, &$1$&, etc"
10452 .cindex "numerical variables (&$1$& &$2$& etc)"
10453 When a &%match%& expansion condition succeeds, these variables contain the
10454 captured substrings identified by the regular expression during subsequent
10455 processing of the success string of the containing &%if%& expansion item.
10456 However, they do not retain their values afterwards; in fact, their previous
10457 values are restored at the end of processing an &%if%& item. The numerical
10458 variables may also be set externally by some other matching process which
10459 precedes the expansion of the string. For example, the commands available in
10460 Exim filter files include an &%if%& command with its own regular expression
10461 matching condition.
10462
10463 .vitem "&$acl_c...$&"
10464 Values can be placed in these variables by the &%set%& modifier in an ACL. They
10465 can be given any name that starts with &$acl_c$& and is at least six characters
10466 long, but the sixth character must be either a digit or an underscore. For
10467 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
10468 variables persist throughout the lifetime of an SMTP connection. They can be
10469 used to pass information between ACLs and between different invocations of the
10470 same ACL. When a message is received, the values of these variables are saved
10471 with the message, and can be accessed by filters, routers, and transports
10472 during subsequent delivery.
10473
10474 .vitem "&$acl_m...$&"
10475 These variables are like the &$acl_c...$& variables, except that their values
10476 are reset after a message has been received. Thus, if several messages are
10477 received in one SMTP connection, &$acl_m...$& values are not passed on from one
10478 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
10479 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
10480 message is received, the values of these variables are saved with the message,
10481 and can be accessed by filters, routers, and transports during subsequent
10482 delivery.
10483
10484 .vitem &$acl_verify_message$&
10485 .vindex "&$acl_verify_message$&"
10486 After an address verification has failed, this variable contains the failure
10487 message. It retains its value for use in subsequent modifiers. The message can
10488 be preserved by coding like this:
10489 .code
10490 warn !verify = sender
10491      set acl_m0 = $acl_verify_message
10492 .endd
10493 You can use &$acl_verify_message$& during the expansion of the &%message%& or
10494 &%log_message%& modifiers, to include information about the verification
10495 failure.
10496
10497 .vitem &$address_data$&
10498 .vindex "&$address_data$&"
10499 This variable is set by means of the &%address_data%& option in routers. The
10500 value then remains with the address while it is processed by subsequent routers
10501 and eventually a transport. If the transport is handling multiple addresses,
10502 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
10503 for more details. &*Note*&: The contents of &$address_data$& are visible in
10504 user filter files.
10505
10506 If &$address_data$& is set when the routers are called from an ACL to verify
10507 a recipient address, the final value is still in the variable for subsequent
10508 conditions and modifiers of the ACL statement. If routing the address caused it
10509 to be redirected to just one address, the child address is also routed as part
10510 of the verification, and in this case the final value of &$address_data$& is
10511 from the child's routing.
10512
10513 If &$address_data$& is set when the routers are called from an ACL to verify a
10514 sender address, the final value is also preserved, but this time in
10515 &$sender_address_data$&, to distinguish it from data from a recipient
10516 address.
10517
10518 In both cases (recipient and sender verification), the value does not persist
10519 after the end of the current ACL statement. If you want to preserve
10520 these values for longer, you can save them in ACL variables.
10521
10522 .vitem &$address_file$&
10523 .vindex "&$address_file$&"
10524 When, as a result of aliasing, forwarding, or filtering, a message is directed
10525 to a specific file, this variable holds the name of the file when the transport
10526 is running. At other times, the variable is empty. For example, using the
10527 default configuration, if user &%r2d2%& has a &_.forward_& file containing
10528 .code
10529 /home/r2d2/savemail
10530 .endd
10531 then when the &(address_file)& transport is running, &$address_file$&
10532 contains the text string &`/home/r2d2/savemail`&.
10533 .cindex "Sieve filter" "value of &$address_file$&"
10534 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
10535 then up to the transport configuration to generate an appropriate absolute path
10536 to the relevant file.
10537
10538 .vitem &$address_pipe$&
10539 .vindex "&$address_pipe$&"
10540 When, as a result of aliasing or forwarding, a message is directed to a pipe,
10541 this variable holds the pipe command when the transport is running.
10542
10543 .vitem "&$auth1$& &-- &$auth3$&"
10544 .vindex "&$auth1$&, &$auth2$&, etc"
10545 These variables are used in SMTP authenticators (see chapters
10546 &<<CHAPplaintext>>&&--&<<CHAPspa>>&). Elsewhere, they are empty.
10547
10548 .vitem &$authenticated_id$&
10549 .cindex "authentication" "id"
10550 .vindex "&$authenticated_id$&"
10551 When a server successfully authenticates a client it may be configured to
10552 preserve some of the authentication information in the variable
10553 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
10554 user/password authenticator configuration might preserve the user name for use
10555 in the routers. Note that this is not the same information that is saved in
10556 &$sender_host_authenticated$&.
10557 When a message is submitted locally (that is, not over a TCP connection)
10558 the value of &$authenticated_id$& is normally the login name of the calling
10559 process. However, a trusted user can override this by means of the &%-oMai%&
10560 command line option.
10561
10562
10563
10564
10565 .vitem &$authenticated_sender$&
10566 .cindex "sender" "authenticated"
10567 .cindex "authentication" "sender"
10568 .cindex "AUTH" "on MAIL command"
10569 .vindex "&$authenticated_sender$&"
10570 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
10571 SMTP MAIL command if it believes the sender is sufficiently trusted, as
10572 described in section &<<SECTauthparamail>>&. Unless the data is the string
10573 &"<>"&, it is set as the authenticated sender of the message, and the value is
10574 available during delivery in the &$authenticated_sender$& variable. If the
10575 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
10576
10577 .vindex "&$qualify_domain$&"
10578 When a message is submitted locally (that is, not over a TCP connection), the
10579 value of &$authenticated_sender$& is an address constructed from the login
10580 name of the calling process and &$qualify_domain$&, except that a trusted user
10581 can override this by means of the &%-oMas%& command line option.
10582
10583
10584 .vitem &$authentication_failed$&
10585 .cindex "authentication" "failure"
10586 .vindex "&$authentication_failed$&"
10587 This variable is set to &"1"& in an Exim server if a client issues an AUTH
10588 command that does not succeed. Otherwise it is set to &"0"&. This makes it
10589 possible to distinguish between &"did not try to authenticate"&
10590 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
10591 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
10592 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
10593 negative response to an AUTH command, including (for example) an attempt to use
10594 an undefined mechanism.
10595
10596 .vitem &$body_linecount$&
10597 .cindex "message body" "line count"
10598 .cindex "body of message" "line count"
10599 .vindex "&$body_linecount$&"
10600 When a message is being received or delivered, this variable contains the
10601 number of lines in the message's body. See also &$message_linecount$&.
10602
10603 .vitem &$body_zerocount$&
10604 .cindex "message body" "binary zero count"
10605 .cindex "body of message" "binary zero count"
10606 .cindex "binary zero" "in message body"
10607 .vindex "&$body_zerocount$&"
10608 When a message is being received or delivered, this variable contains the
10609 number of binary zero bytes in the message's body.
10610
10611 .vitem &$bounce_recipient$&
10612 .vindex "&$bounce_recipient$&"
10613 This is set to the recipient address of a bounce message while Exim is creating
10614 it. It is useful if a customized bounce message text file is in use (see
10615 chapter &<<CHAPemsgcust>>&).
10616
10617 .vitem &$bounce_return_size_limit$&
10618 .vindex "&$bounce_return_size_limit$&"
10619 This contains the value set in the &%bounce_return_size_limit%& option, rounded
10620 up to a multiple of 1000. It is useful when a customized error message text
10621 file is in use (see chapter &<<CHAPemsgcust>>&).
10622
10623 .vitem &$caller_gid$&
10624 .cindex "gid (group id)" "caller"
10625 .vindex "&$caller_gid$&"
10626 The real group id under which the process that called Exim was running. This is
10627 not the same as the group id of the originator of a message (see
10628 &$originator_gid$&). If Exim re-execs itself, this variable in the new
10629 incarnation normally contains the Exim gid.
10630
10631 .vitem &$caller_uid$&
10632 .cindex "uid (user id)" "caller"
10633 .vindex "&$caller_uid$&"
10634 The real user id under which the process that called Exim was running. This is
10635 not the same as the user id of the originator of a message (see
10636 &$originator_uid$&). If Exim re-execs itself, this variable in the new
10637 incarnation normally contains the Exim uid.
10638
10639 .vitem &$compile_date$&
10640 .vindex "&$compile_date$&"
10641 The date on which the Exim binary was compiled.
10642
10643 .vitem &$compile_number$&
10644 .vindex "&$compile_number$&"
10645 The building process for Exim keeps a count of the number
10646 of times it has been compiled. This serves to distinguish different
10647 compilations of the same version of the program.
10648
10649 .vitem &$demime_errorlevel$&
10650 .vindex "&$demime_errorlevel$&"
10651 This variable is available when Exim is compiled with
10652 the content-scanning extension and the obsolete &%demime%& condition. For
10653 details, see section &<<SECTdemimecond>>&.
10654
10655 .vitem &$demime_reason$&
10656 .vindex "&$demime_reason$&"
10657 This variable is available when Exim is compiled with the
10658 content-scanning extension and the obsolete &%demime%& condition. For details,
10659 see section &<<SECTdemimecond>>&.
10660
10661 .vitem &$dnslist_domain$& &&&
10662        &$dnslist_matched$& &&&
10663        &$dnslist_text$& &&&
10664        &$dnslist_value$&
10665 .vindex "&$dnslist_domain$&"
10666 .vindex "&$dnslist_matched$&"
10667 .vindex "&$dnslist_text$&"
10668 .vindex "&$dnslist_value$&"
10669 .cindex "black list (DNS)"
10670 When a DNS (black) list lookup succeeds, these variables are set to contain
10671 the following data from the lookup: the list's domain name, the key that was
10672 looked up, the contents of any associated TXT record, and the value from the
10673 main A record. See section &<<SECID204>>& for more details.
10674
10675 .vitem &$domain$&
10676 .vindex "&$domain$&"
10677 When an address is being routed, or delivered on its own, this variable
10678 contains the domain. Uppercase letters in the domain are converted into lower
10679 case for &$domain$&.
10680
10681 Global address rewriting happens when a message is received, so the value of
10682 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
10683 is set during user filtering, but not during system filtering, because a
10684 message may have many recipients and the system filter is called just once.
10685
10686 When more than one address is being delivered at once (for example, several
10687 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
10688 have the same domain. Transports can be restricted to handling only one domain
10689 at a time if the value of &$domain$& is required at transport time &-- this is
10690 the default for local transports. For further details of the environment in
10691 which local transports are run, see chapter &<<CHAPenvironment>>&.
10692
10693 .oindex "&%delay_warning_condition%&"
10694 At the end of a delivery, if all deferred addresses have the same domain, it is
10695 set in &$domain$& during the expansion of &%delay_warning_condition%&.
10696
10697 The &$domain$& variable is also used in some other circumstances:
10698
10699 .ilist
10700 When an ACL is running for a RCPT command, &$domain$& contains the domain of
10701 the recipient address. The domain of the &'sender'& address is in
10702 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
10703 normally set during the running of the MAIL ACL. However, if the sender address
10704 is verified with a callout during the MAIL ACL, the sender domain is placed in
10705 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
10706 the &(smtp)& transport.
10707
10708 .next
10709 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
10710 &$domain$& contains the domain portion of the address that is being rewritten;
10711 it can be used in the expansion of the replacement address, for example, to
10712 rewrite domains by file lookup.
10713
10714 .next
10715 With one important exception, whenever a domain list is being scanned,
10716 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
10717 a &%sender_domains%& condition in an ACL is being processed, the subject domain
10718 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
10719 that, in a RCPT ACL, the sender domain list can be dependent on the
10720 recipient domain (which is what is in &$domain$& at this time).
10721
10722 .next
10723 .cindex "ETRN" "value of &$domain$&"
10724 .oindex "&%smtp_etrn_command%&"
10725 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
10726 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
10727 .endlist
10728
10729
10730 .vitem &$domain_data$&
10731 .vindex "&$domain_data$&"
10732 When the &%domains%& option on a router matches a domain by
10733 means of a lookup, the data read by the lookup is available during the running
10734 of the router as &$domain_data$&. In addition, if the driver routes the
10735 address to a transport, the value is available in that transport. If the
10736 transport is handling multiple addresses, the value from the first address is
10737 used.
10738
10739 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
10740 domain by means of a lookup. The data read by the lookup is available during
10741 the rest of the ACL statement. In all other situations, this variable expands
10742 to nothing.
10743
10744 .vitem &$exim_gid$&
10745 .vindex "&$exim_gid$&"
10746 This variable contains the numerical value of the Exim group id.
10747
10748 .vitem &$exim_path$&
10749 .vindex "&$exim_path$&"
10750 This variable contains the path to the Exim binary.
10751
10752 .vitem &$exim_uid$&
10753 .vindex "&$exim_uid$&"
10754 This variable contains the numerical value of the Exim user id.
10755
10756 .vitem &$found_extension$&
10757 .vindex "&$found_extension$&"
10758 This variable is available when Exim is compiled with the
10759 content-scanning extension and the obsolete &%demime%& condition. For details,
10760 see section &<<SECTdemimecond>>&.
10761
10762 .vitem &$header_$&<&'name'&>
10763 This is not strictly an expansion variable. It is expansion syntax for
10764 inserting the message header line with the given name. Note that the name must
10765 be terminated by colon or white space, because it may contain a wide variety of
10766 characters. Note also that braces must &'not'& be used.
10767
10768 .vitem &$home$&
10769 .vindex "&$home$&"
10770 When the &%check_local_user%& option is set for a router, the user's home
10771 directory is placed in &$home$& when the check succeeds. In particular, this
10772 means it is set during the running of users' filter files. A router may also
10773 explicitly set a home directory for use by a transport; this can be overridden
10774 by a setting on the transport itself.
10775
10776 When running a filter test via the &%-bf%& option, &$home$& is set to the value
10777 of the environment variable HOME.
10778
10779 .vitem &$host$&
10780 .vindex "&$host$&"
10781 If a router assigns an address to a transport (any transport), and passes a
10782 list of hosts with the address, the value of &$host$& when the transport starts
10783 to run is the name of the first host on the list. Note that this applies both
10784 to local and remote transports.
10785
10786 .cindex "transport" "filter"
10787 .cindex "filter" "transport filter"
10788 For the &(smtp)& transport, if there is more than one host, the value of
10789 &$host$& changes as the transport works its way through the list. In
10790 particular, when the &(smtp)& transport is expanding its options for encryption
10791 using TLS, or for specifying a transport filter (see chapter
10792 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
10793 is connected.
10794
10795 When used in the client part of an authenticator configuration (see chapter
10796 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
10797 client is connected.
10798
10799
10800 .vitem &$host_address$&
10801 .vindex "&$host_address$&"
10802 This variable is set to the remote host's IP address whenever &$host$& is set
10803 for a remote connection. It is also set to the IP address that is being checked
10804 when the &%ignore_target_hosts%& option is being processed.
10805
10806 .vitem &$host_data$&
10807 .vindex "&$host_data$&"
10808 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
10809 result of the lookup is made available in the &$host_data$& variable. This
10810 allows you, for example, to do things like this:
10811 .code
10812 deny  hosts = net-lsearch;/some/file
10813 message = $host_data
10814 .endd
10815 .vitem &$host_lookup_deferred$&
10816 .cindex "host name" "lookup, failure of"
10817 .vindex "&$host_lookup_deferred$&"
10818 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
10819 message comes from a remote host and there is an attempt to look up the host's
10820 name from its IP address, and the attempt is not successful, one of these
10821 variables is set to &"1"&.
10822
10823 .ilist
10824 If the lookup receives a definite negative response (for example, a DNS lookup
10825 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
10826
10827 .next
10828 If there is any kind of problem during the lookup, such that Exim cannot
10829 tell whether or not the host name is defined (for example, a timeout for a DNS
10830 lookup), &$host_lookup_deferred$& is set to &"1"&.
10831 .endlist ilist
10832
10833 Looking up a host's name from its IP address consists of more than just a
10834 single reverse lookup. Exim checks that a forward lookup of at least one of the
10835 names it receives from a reverse lookup yields the original IP address. If this
10836 is not the case, Exim does not accept the looked up name(s), and
10837 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
10838 IP address (for example, the existence of a PTR record in the DNS) is not
10839 sufficient on its own for the success of a host name lookup. If the reverse
10840 lookup succeeds, but there is a lookup problem such as a timeout when checking
10841 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
10842 &"1"&. See also &$sender_host_name$&.
10843
10844 .vitem &$host_lookup_failed$&
10845 .vindex "&$host_lookup_failed$&"
10846 See &$host_lookup_deferred$&.
10847
10848
10849 .vitem &$inode$&
10850 .vindex "&$inode$&"
10851 The only time this variable is set is while expanding the &%directory_file%&
10852 option in the &(appendfile)& transport. The variable contains the inode number
10853 of the temporary file which is about to be renamed. It can be used to construct
10854 a unique name for the file.
10855
10856 .vitem &$interface_address$&
10857 .vindex "&$interface_address$&"
10858 This is an obsolete name for &$received_ip_address$&.
10859
10860 .vitem &$interface_port$&
10861 .vindex "&$interface_port$&"
10862 This is an obsolete name for &$received_port$&.
10863
10864 .vitem &$item$&
10865 .vindex "&$item$&"
10866 This variable is used during the expansion of &*forall*& and &*forany*&
10867 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
10868 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
10869 empty.
10870
10871 .vitem &$ldap_dn$&
10872 .vindex "&$ldap_dn$&"
10873 This variable, which is available only when Exim is compiled with LDAP support,
10874 contains the DN from the last entry in the most recently successful LDAP
10875 lookup.
10876
10877 .vitem &$load_average$&
10878 .vindex "&$load_average$&"
10879 This variable contains the system load average, multiplied by 1000 so that it
10880 is an integer. For example, if the load average is 0.21, the value of the
10881 variable is 210. The value is recomputed every time the variable is referenced.
10882
10883 .vitem &$local_part$&
10884 .vindex "&$local_part$&"
10885 When an address is being routed, or delivered on its own, this
10886 variable contains the local part. When a number of addresses are being
10887 delivered together (for example, multiple RCPT commands in an SMTP
10888 session), &$local_part$& is not set.
10889
10890 Global address rewriting happens when a message is received, so the value of
10891 &$local_part$& during routing and delivery is the value after rewriting.
10892 &$local_part$& is set during user filtering, but not during system filtering,
10893 because a message may have many recipients and the system filter is called just
10894 once.
10895
10896 .vindex "&$local_part_prefix$&"
10897 .vindex "&$local_part_suffix$&"
10898 If a local part prefix or suffix has been recognized, it is not included in the
10899 value of &$local_part$& during routing and subsequent delivery. The values of
10900 any prefix or suffix are in &$local_part_prefix$& and
10901 &$local_part_suffix$&, respectively.
10902
10903 When a message is being delivered to a file, pipe, or autoreply transport as a
10904 result of aliasing or forwarding, &$local_part$& is set to the local part of
10905 the parent address, not to the file name or command (see &$address_file$& and
10906 &$address_pipe$&).
10907
10908 When an ACL is running for a RCPT command, &$local_part$& contains the
10909 local part of the recipient address.
10910
10911 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
10912 &$local_part$& contains the local part of the address that is being rewritten;
10913 it can be used in the expansion of the replacement address, for example.
10914
10915 In all cases, all quoting is removed from the local part. For example, for both
10916 the addresses
10917 .code
10918 "abc:xyz"@test.example
10919 abc\:xyz@test.example
10920 .endd
10921 the value of &$local_part$& is
10922 .code
10923 abc:xyz
10924 .endd
10925 If you use &$local_part$& to create another address, you should always wrap it
10926 inside a quoting operator. For example, in a &(redirect)& router you could
10927 have:
10928 .code
10929 data = ${quote_local_part:$local_part}@new.domain.example
10930 .endd
10931 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
10932 to process local parts in a case-dependent manner in a router, you can set the
10933 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
10934
10935 .vitem &$local_part_data$&
10936 .vindex "&$local_part_data$&"
10937 When the &%local_parts%& option on a router matches a local part by means of a
10938 lookup, the data read by the lookup is available during the running of the
10939 router as &$local_part_data$&. In addition, if the driver routes the address
10940 to a transport, the value is available in that transport. If the transport is
10941 handling multiple addresses, the value from the first address is used.
10942
10943 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
10944 matches a local part by means of a lookup. The data read by the lookup is
10945 available during the rest of the ACL statement. In all other situations, this
10946 variable expands to nothing.
10947
10948 .vitem &$local_part_prefix$&
10949 .vindex "&$local_part_prefix$&"
10950 When an address is being routed or delivered, and a
10951 specific prefix for the local part was recognized, it is available in this
10952 variable, having been removed from &$local_part$&.
10953
10954 .vitem &$local_part_suffix$&
10955 .vindex "&$local_part_suffix$&"
10956 When an address is being routed or delivered, and a
10957 specific suffix for the local part was recognized, it is available in this
10958 variable, having been removed from &$local_part$&.
10959
10960 .vitem &$local_scan_data$&
10961 .vindex "&$local_scan_data$&"
10962 This variable contains the text returned by the &[local_scan()]& function when
10963 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
10964
10965 .vitem &$local_user_gid$&
10966 .vindex "&$local_user_gid$&"
10967 See &$local_user_uid$&.
10968
10969 .vitem &$local_user_uid$&
10970 .vindex "&$local_user_uid$&"
10971 This variable and &$local_user_gid$& are set to the uid and gid after the
10972 &%check_local_user%& router precondition succeeds. This means that their values
10973 are available for the remaining preconditions (&%senders%&, &%require_files%&,
10974 and &%condition%&), for the &%address_data%& expansion, and for any
10975 router-specific expansions. At all other times, the values in these variables
10976 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
10977
10978 .vitem &$localhost_number$&
10979 .vindex "&$localhost_number$&"
10980 This contains the expanded value of the
10981 &%localhost_number%& option. The expansion happens after the main options have
10982 been read.
10983
10984 .vitem &$log_inodes$&
10985 .vindex "&$log_inodes$&"
10986 The number of free inodes in the disk partition where Exim's
10987 log files are being written. The value is recalculated whenever the variable is
10988 referenced. If the relevant file system does not have the concept of inodes,
10989 the value of is -1. See also the &%check_log_inodes%& option.
10990
10991 .vitem &$log_space$&
10992 .vindex "&$log_space$&"
10993 The amount of free space (as a number of kilobytes) in the disk
10994 partition where Exim's log files are being written. The value is recalculated
10995 whenever the variable is referenced. If the operating system does not have the
10996 ability to find the amount of free space (only true for experimental systems),
10997 the space value is -1. See also the &%check_log_space%& option.
10998
10999
11000 .vitem &$mailstore_basename$&
11001 .vindex "&$mailstore_basename$&"
11002 This variable is set only when doing deliveries in &"mailstore"& format in the
11003 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
11004 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
11005 contains the basename of the files that are being written, that is, the name
11006 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
11007 variable is empty.
11008
11009 .vitem &$malware_name$&
11010 .vindex "&$malware_name$&"
11011 This variable is available when Exim is compiled with the
11012 content-scanning extension. It is set to the name of the virus that was found
11013 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
11014
11015 .vitem &$max_received_linelength$&
11016 .vindex "&$max_received_linelength$&"
11017 .cindex "maximum" "line length"
11018 .cindex "line length" "maximum"
11019 This variable contains the number of bytes in the longest line that was
11020 received as part of the message, not counting the line termination
11021 character(s).
11022
11023 .vitem &$message_age$&
11024 .cindex "message" "age of"
11025 .vindex "&$message_age$&"
11026 This variable is set at the start of a delivery attempt to contain the number
11027 of seconds since the message was received. It does not change during a single
11028 delivery attempt.
11029
11030 .vitem &$message_body$&
11031 .cindex "body of message" "expansion variable"
11032 .cindex "message body" "in expansion"
11033 .cindex "binary zero" "in message body"
11034 .vindex "&$message_body$&"
11035 .oindex "&%message_body_visible%&"
11036 This variable contains the initial portion of a message's body while it is
11037 being delivered, and is intended mainly for use in filter files. The maximum
11038 number of characters of the body that are put into the variable is set by the
11039 &%message_body_visible%& configuration option; the default is 500.
11040
11041 .oindex "&%message_body_newlines%&"
11042 By default, newlines are converted into spaces in &$message_body$&, to make it
11043 easier to search for phrases that might be split over a line break. However,
11044 this can be disabled by setting &%message_body_newlines%& to be true. Binary
11045 zeros are always converted into spaces.
11046
11047 .vitem &$message_body_end$&
11048 .cindex "body of message" "expansion variable"
11049 .cindex "message body" "in expansion"
11050 .vindex "&$message_body_end$&"
11051 This variable contains the final portion of a message's
11052 body while it is being delivered. The format and maximum size are as for
11053 &$message_body$&.
11054
11055 .vitem &$message_body_size$&
11056 .cindex "body of message" "size"
11057 .cindex "message body" "size"
11058 .vindex "&$message_body_size$&"
11059 When a message is being delivered, this variable contains the size of the body
11060 in bytes. The count starts from the character after the blank line that
11061 separates the body from the header. Newlines are included in the count. See
11062 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
11063
11064 .vitem &$message_exim_id$&
11065 .vindex "&$message_exim_id$&"
11066 When a message is being received or delivered, this variable contains the
11067 unique message id that is generated and used by Exim to identify the message.
11068 An id is not created for a message until after its header has been successfully
11069 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
11070 line; it is the local id that Exim assigns to the message, for example:
11071 &`1BXTIK-0001yO-VA`&.
11072
11073 .vitem &$message_headers$&
11074 .vindex &$message_headers$&
11075 This variable contains a concatenation of all the header lines when a message
11076 is being processed, except for lines added by routers or transports. The header
11077 lines are separated by newline characters. Their contents are decoded in the
11078 same way as a header line that is inserted by &%bheader%&.
11079
11080 .vitem &$message_headers_raw$&
11081 .vindex &$message_headers_raw$&
11082 This variable is like &$message_headers$& except that no processing of the
11083 contents of header lines is done.
11084
11085 .vitem &$message_id$&
11086 This is an old name for &$message_exim_id$&, which is now deprecated.
11087
11088 .vitem &$message_linecount$&
11089 .vindex "&$message_linecount$&"
11090 This variable contains the total number of lines in the header and body of the
11091 message. Compare &$body_linecount$&, which is the count for the body only.
11092 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
11093 number of lines received. Before delivery happens (that is, before filters,
11094 routers, and transports run) the count is increased to include the
11095 &'Received:'& header line that Exim standardly adds, and also any other header
11096 lines that are added by ACLs. The blank line that separates the message header
11097 from the body is not counted. Here is an example of the use of this variable in
11098 a DATA ACL:
11099 .code
11100 deny message   = Too many lines in message header
11101      condition = \
11102       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
11103 .endd
11104 In the MAIL and RCPT ACLs, the value is zero because at that stage the
11105 message has not yet been received.
11106
11107 .vitem &$message_size$&
11108 .cindex "size" "of message"
11109 .cindex "message" "size"
11110 .vindex "&$message_size$&"
11111 When a message is being processed, this variable contains its size in bytes. In
11112 most cases, the size includes those headers that were received with the
11113 message, but not those (such as &'Envelope-to:'&) that are added to individual
11114 deliveries as they are written. However, there is one special case: during the
11115 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
11116 doing a delivery in maildir format, the value of &$message_size$& is the
11117 precise size of the file that has been written. See also
11118 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
11119
11120 .cindex "RCPT" "value of &$message_size$&"
11121 While running a per message ACL (mail/rcpt/predata), &$message_size$&
11122 contains the size supplied on the MAIL command, or -1 if no size was given. The
11123 value may not, of course, be truthful.
11124
11125 .vitem &$mime_$&&'xxx'&
11126 A number of variables whose names start with &$mime$& are
11127 available when Exim is compiled with the content-scanning extension. For
11128 details, see section &<<SECTscanmimepart>>&.
11129
11130 .vitem "&$n0$& &-- &$n9$&"
11131 These variables are counters that can be incremented by means
11132 of the &%add%& command in filter files.
11133
11134 .vitem &$original_domain$&
11135 .vindex "&$domain$&"
11136 .vindex "&$original_domain$&"
11137 When a top-level address is being processed for delivery, this contains the
11138 same value as &$domain$&. However, if a &"child"& address (for example,
11139 generated by an alias, forward, or filter file) is being processed, this
11140 variable contains the domain of the original address (lower cased). This
11141 differs from &$parent_domain$& only when there is more than one level of
11142 aliasing or forwarding. When more than one address is being delivered in a
11143 single transport run, &$original_domain$& is not set.
11144
11145 If a new address is created by means of a &%deliver%& command in a system
11146 filter, it is set up with an artificial &"parent"& address. This has the local
11147 part &'system-filter'& and the default qualify domain.
11148
11149 .vitem &$original_local_part$&
11150 .vindex "&$local_part$&"
11151 .vindex "&$original_local_part$&"
11152 When a top-level address is being processed for delivery, this contains the
11153 same value as &$local_part$&, unless a prefix or suffix was removed from the
11154 local part, because &$original_local_part$& always contains the full local
11155 part. When a &"child"& address (for example, generated by an alias, forward, or
11156 filter file) is being processed, this variable contains the full local part of
11157 the original address.
11158
11159 If the router that did the redirection processed the local part
11160 case-insensitively, the value in &$original_local_part$& is in lower case.
11161 This variable differs from &$parent_local_part$& only when there is more than
11162 one level of aliasing or forwarding. When more than one address is being
11163 delivered in a single transport run, &$original_local_part$& is not set.
11164
11165 If a new address is created by means of a &%deliver%& command in a system
11166 filter, it is set up with an artificial &"parent"& address. This has the local
11167 part &'system-filter'& and the default qualify domain.
11168
11169 .vitem &$originator_gid$&
11170 .cindex "gid (group id)" "of originating user"
11171 .cindex "sender" "gid"
11172 .vindex "&$caller_gid$&"
11173 .vindex "&$originator_gid$&"
11174 This variable contains the value of &$caller_gid$& that was set when the
11175 message was received. For messages received via the command line, this is the
11176 gid of the sending user. For messages received by SMTP over TCP/IP, this is
11177 normally the gid of the Exim user.
11178
11179 .vitem &$originator_uid$&
11180 .cindex "uid (user id)" "of originating user"
11181 .cindex "sender" "uid"
11182 .vindex "&$caller_uid$&"
11183 .vindex "&$originaltor_uid$&"
11184 The value of &$caller_uid$& that was set when the message was received. For
11185 messages received via the command line, this is the uid of the sending user.
11186 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
11187 user.
11188
11189 .vitem &$parent_domain$&
11190 .vindex "&$parent_domain$&"
11191 This variable is similar to &$original_domain$& (see
11192 above), except that it refers to the immediately preceding parent address.
11193
11194 .vitem &$parent_local_part$&
11195 .vindex "&$parent_local_part$&"
11196 This variable is similar to &$original_local_part$&
11197 (see above), except that it refers to the immediately preceding parent address.
11198
11199 .vitem &$pid$&
11200 .cindex "pid (process id)" "of current process"
11201 .vindex "&$pid$&"
11202 This variable contains the current process id.
11203
11204 .vitem &$pipe_addresses$&
11205 .cindex "filter" "transport filter"
11206 .cindex "transport" "filter"
11207 .vindex "&$pipe_addresses$&"
11208 This is not an expansion variable, but is mentioned here because the string
11209 &`$pipe_addresses`& is handled specially in the command specification for the
11210 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
11211 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
11212 It cannot be used in general expansion strings, and provokes an &"unknown
11213 variable"& error if encountered.
11214
11215 .vitem &$primary_hostname$&
11216 .vindex "&$primary_hostname$&"
11217 This variable contains the value set by &%primary_hostname%& in the
11218 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
11219 a single-component name, Exim calls &[gethostbyname()]& (or
11220 &[getipnodebyname()]& where available) in an attempt to acquire a fully
11221 qualified host name. See also &$smtp_active_hostname$&.
11222
11223
11224 .vitem &$prvscheck_address$&
11225 This variable is used in conjunction with the &%prvscheck%& expansion item,
11226 which is described in sections &<<SECTexpansionitems>>& and
11227 &<<SECTverifyPRVS>>&.
11228
11229 .vitem &$prvscheck_keynum$&
11230 This variable is used in conjunction with the &%prvscheck%& expansion item,
11231 which is described in sections &<<SECTexpansionitems>>& and
11232 &<<SECTverifyPRVS>>&.
11233
11234 .vitem &$prvscheck_result$&
11235 This variable is used in conjunction with the &%prvscheck%& expansion item,
11236 which is described in sections &<<SECTexpansionitems>>& and
11237 &<<SECTverifyPRVS>>&.
11238
11239 .vitem &$qualify_domain$&
11240 .vindex "&$qualify_domain$&"
11241 The value set for the &%qualify_domain%& option in the configuration file.
11242
11243 .vitem &$qualify_recipient$&
11244 .vindex "&$qualify_recipient$&"
11245 The value set for the &%qualify_recipient%& option in the configuration file,
11246 or if not set, the value of &$qualify_domain$&.
11247
11248 .vitem &$rcpt_count$&
11249 .vindex "&$rcpt_count$&"
11250 When a message is being received by SMTP, this variable contains the number of
11251 RCPT commands received for the current message. If this variable is used in a
11252 RCPT ACL, its value includes the current command.
11253
11254 .vitem &$rcpt_defer_count$&
11255 .vindex "&$rcpt_defer_count$&"
11256 .cindex "4&'xx'& responses" "count of"
11257 When a message is being received by SMTP, this variable contains the number of
11258 RCPT commands in the current message that have previously been rejected with a
11259 temporary (4&'xx'&) response.
11260
11261 .vitem &$rcpt_fail_count$&
11262 .vindex "&$rcpt_fail_count$&"
11263 When a message is being received by SMTP, this variable contains the number of
11264 RCPT commands in the current message that have previously been rejected with a
11265 permanent (5&'xx'&) response.
11266
11267 .vitem &$received_count$&
11268 .vindex "&$received_count$&"
11269 This variable contains the number of &'Received:'& header lines in the message,
11270 including the one added by Exim (so its value is always greater than zero). It
11271 is available in the DATA ACL, the non-SMTP ACL, and while routing and
11272 delivering.
11273
11274 .vitem &$received_for$&
11275 .vindex "&$received_for$&"
11276 If there is only a single recipient address in an incoming message, this
11277 variable contains that address when the &'Received:'& header line is being
11278 built. The value is copied after recipient rewriting has happened, but before
11279 the &[local_scan()]& function is run.
11280
11281 .vitem &$received_ip_address$&
11282 .vindex "&$received_ip_address$&"
11283 As soon as an Exim server starts processing an incoming TCP/IP connection, this
11284 variable is set to the address of the local IP interface, and &$received_port$&
11285 is set to the local port number. (The remote IP address and port are in
11286 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
11287 the port value is -1 unless it has been set using the &%-oMi%& command line
11288 option.
11289
11290 As well as being useful in ACLs (including the &"connect"& ACL), these variable
11291 could be used, for example, to make the file name for a TLS certificate depend
11292 on which interface and/or port is being used for the incoming connection. The
11293 values of &$received_ip_address$& and &$received_port$& are saved with any
11294 messages that are received, thus making these variables available at delivery
11295 time.
11296
11297 &*Note:*& There are no equivalent variables for outgoing connections, because
11298 the values are unknown (unless they are explicitly set by options of the
11299 &(smtp)& transport).
11300
11301 .vitem &$received_port$&
11302 .vindex "&$received_port$&"
11303 See &$received_ip_address$&.
11304
11305 .vitem &$received_protocol$&
11306 .vindex "&$received_protocol$&"
11307 When a message is being processed, this variable contains the name of the
11308 protocol by which it was received. Most of the names used by Exim are defined
11309 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
11310 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
11311 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
11312 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
11313 connection and the client was successfully authenticated.
11314
11315 Exim uses the protocol name &"smtps"& for the case when encryption is
11316 automatically set up on connection without the use of STARTTLS (see
11317 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
11318 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
11319 where the client initially uses EHLO, sets up an encrypted connection using
11320 STARTTLS, and then uses HELO afterwards.
11321
11322 The &%-oMr%& option provides a way of specifying a custom protocol name for
11323 messages that are injected locally by trusted callers. This is commonly used to
11324 identify messages that are being re-injected after some kind of scanning.
11325
11326 .vitem &$received_time$&
11327 .vindex "&$received_time$&"
11328 This variable contains the date and time when the current message was received,
11329 as a number of seconds since the start of the Unix epoch.
11330
11331 .vitem &$recipient_data$&
11332 .vindex "&$recipient_data$&"
11333 This variable is set after an indexing lookup success in an ACL &%recipients%&
11334 condition. It contains the data from the lookup, and the value remains set
11335 until the next &%recipients%& test. Thus, you can do things like this:
11336 .display
11337 &`require recipients  = cdb*@;/some/file`&
11338 &`deny    `&&'some further test involving'& &`$recipient_data`&
11339 .endd
11340 &*Warning*&: This variable is set only when a lookup is used as an indexing
11341 method in the address list, using the semicolon syntax as in the example above.
11342 The variable is not set for a lookup that is used as part of the string
11343 expansion that all such lists undergo before being interpreted.
11344
11345 .vitem &$recipient_verify_failure$&
11346 .vindex "&$recipient_verify_failure$&"
11347 In an ACL, when a recipient verification fails, this variable contains
11348 information about the failure. It is set to one of the following words:
11349
11350 .ilist
11351 &"qualify"&: The address was unqualified (no domain), and the message
11352 was neither local nor came from an exempted host.
11353
11354 .next
11355 &"route"&: Routing failed.
11356
11357 .next
11358 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
11359 or before the MAIL command (that is, on initial connection, HELO, or
11360 MAIL).
11361
11362 .next
11363 &"recipient"&: The RCPT command in a callout was rejected.
11364 .next
11365
11366 &"postmaster"&: The postmaster check in a callout was rejected.
11367 .endlist
11368
11369 The main use of this variable is expected to be to distinguish between
11370 rejections of MAIL and rejections of RCPT.
11371
11372 .vitem &$recipients$&
11373 .vindex "&$recipients$&"
11374 This variable contains a list of envelope recipients for a message. A comma and
11375 a space separate the addresses in the replacement text. However, the variable
11376 is not generally available, to prevent exposure of Bcc recipients in
11377 unprivileged users' filter files. You can use &$recipients$& only in these
11378 cases:
11379
11380 .olist
11381 In a system filter file.
11382 .next
11383 In the ACLs associated with the DATA command and with non-SMTP messages, that
11384 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
11385 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
11386 &%acl_not_smtp_mime%&.
11387 .next
11388 From within a &[local_scan()]& function.
11389 .endlist
11390
11391
11392 .vitem &$recipients_count$&
11393 .vindex "&$recipients_count$&"
11394 When a message is being processed, this variable contains the number of
11395 envelope recipients that came with the message. Duplicates are not excluded
11396 from the count. While a message is being received over SMTP, the number
11397 increases for each accepted recipient. It can be referenced in an ACL.
11398
11399
11400 .vitem &$regex_match_string$&
11401 .vindex "&$regex_match_string$&"
11402 This variable is set to contain the matching regular expression after a
11403 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
11404
11405
11406 .vitem &$reply_address$&
11407 .vindex "&$reply_address$&"
11408 When a message is being processed, this variable contains the contents of the
11409 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
11410 contents of the &'From:'& header line. Apart from the removal of leading
11411 white space, the value is not processed in any way. In particular, no RFC 2047
11412 decoding or character code translation takes place.
11413
11414 .vitem &$return_path$&
11415 .vindex "&$return_path$&"
11416 When a message is being delivered, this variable contains the return path &--
11417 the sender field that will be sent as part of the envelope. It is not enclosed
11418 in <> characters. At the start of routing an address, &$return_path$& has the
11419 same value as &$sender_address$&, but if, for example, an incoming message to a
11420 mailing list has been expanded by a router which specifies a different address
11421 for bounce messages, &$return_path$& subsequently contains the new bounce
11422 address, whereas &$sender_address$& always contains the original sender address
11423 that was received with the message. In other words, &$sender_address$& contains
11424 the incoming envelope sender, and &$return_path$& contains the outgoing
11425 envelope sender.
11426
11427 .vitem &$return_size_limit$&
11428 .vindex "&$return_size_limit$&"
11429 This is an obsolete name for &$bounce_return_size_limit$&.
11430
11431 .vitem &$runrc$&
11432 .cindex "return code" "from &%run%& expansion"
11433 .vindex "&$runrc$&"
11434 This variable contains the return code from a command that is run by the
11435 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
11436 assume the order in which option values are expanded, except for those
11437 preconditions whose order of testing is documented. Therefore, you cannot
11438 reliably expect to set &$runrc$& by the expansion of one option, and use it in
11439 another.
11440
11441 .vitem &$self_hostname$&
11442 .oindex "&%self%&" "value of host name"
11443 .vindex "&$self_hostname$&"
11444 When an address is routed to a supposedly remote host that turns out to be the
11445 local host, what happens is controlled by the &%self%& generic router option.
11446 One of its values causes the address to be passed to another router. When this
11447 happens, &$self_hostname$& is set to the name of the local host that the
11448 original router encountered. In other circumstances its contents are null.
11449
11450 .vitem &$sender_address$&
11451 .vindex "&$sender_address$&"
11452 When a message is being processed, this variable contains the sender's address
11453 that was received in the message's envelope. The case of letters in the address
11454 is retained, in both the local part and the domain. For bounce messages, the
11455 value of this variable is the empty string. See also &$return_path$&.
11456
11457 .vitem &$sender_address_data$&
11458 .vindex "&$address_data$&"
11459 .vindex "&$sender_address_data$&"
11460 If &$address_data$& is set when the routers are called from an ACL to verify a
11461 sender address, the final value is preserved in &$sender_address_data$&, to
11462 distinguish it from data from a recipient address. The value does not persist
11463 after the end of the current ACL statement. If you want to preserve it for
11464 longer, you can save it in an ACL variable.
11465
11466 .vitem &$sender_address_domain$&
11467 .vindex "&$sender_address_domain$&"
11468 The domain portion of &$sender_address$&.
11469
11470 .vitem &$sender_address_local_part$&
11471 .vindex "&$sender_address_local_part$&"
11472 The local part portion of &$sender_address$&.
11473
11474 .vitem &$sender_data$&
11475 .vindex "&$sender_data$&"
11476 This variable is set after a lookup success in an ACL &%senders%& condition or
11477 in a router &%senders%& option. It contains the data from the lookup, and the
11478 value remains set until the next &%senders%& test. Thus, you can do things like
11479 this:
11480 .display
11481 &`require senders      = cdb*@;/some/file`&
11482 &`deny    `&&'some further test involving'& &`$sender_data`&
11483 .endd
11484 &*Warning*&: This variable is set only when a lookup is used as an indexing
11485 method in the address list, using the semicolon syntax as in the example above.
11486 The variable is not set for a lookup that is used as part of the string
11487 expansion that all such lists undergo before being interpreted.
11488
11489 .vitem &$sender_fullhost$&
11490 .vindex "&$sender_fullhost$&"
11491 When a message is received from a remote host, this variable contains the host
11492 name and IP address in a single string. It ends with the IP address in square
11493 brackets, followed by a colon and a port number if the logging of ports is
11494 enabled. The format of the rest of the string depends on whether the host
11495 issued a HELO or EHLO SMTP command, and whether the host name was verified by
11496 looking up its IP address. (Looking up the IP address can be forced by the
11497 &%host_lookup%& option, independent of verification.) A plain host name at the
11498 start of the string is a verified host name; if this is not present,
11499 verification either failed or was not requested. A host name in parentheses is
11500 the argument of a HELO or EHLO command. This is omitted if it is identical to
11501 the verified host name or to the host's IP address in square brackets.
11502
11503 .vitem &$sender_helo_name$&
11504 .vindex "&$sender_helo_name$&"
11505 When a message is received from a remote host that has issued a HELO or EHLO
11506 command, the argument of that command is placed in this variable. It is also
11507 set if HELO or EHLO is used when a message is received using SMTP locally via
11508 the &%-bs%& or &%-bS%& options.
11509
11510 .vitem &$sender_host_address$&
11511 .vindex "&$sender_host_address$&"
11512 When a message is received from a remote host, this variable contains that
11513 host's IP address. For locally submitted messages, it is empty.
11514
11515 .vitem &$sender_host_authenticated$&
11516 .vindex "&$sender_host_authenticated$&"
11517 This variable contains the name (not the public name) of the authenticator
11518 driver that successfully authenticated the client from which the message was
11519 received. It is empty if there was no successful authentication. See also
11520 &$authenticated_id$&.
11521
11522 .vitem &$sender_host_name$&
11523 .vindex "&$sender_host_name$&"
11524 When a message is received from a remote host, this variable contains the
11525 host's name as obtained by looking up its IP address. For messages received by
11526 other means, this variable is empty.
11527
11528 .vindex "&$host_lookup_failed$&"
11529 If the host name has not previously been looked up, a reference to
11530 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
11531 A looked up name is accepted only if it leads back to the original IP address
11532 via a forward lookup. If either the reverse or the forward lookup fails to find
11533 any data, or if the forward lookup does not yield the original IP address,
11534 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
11535
11536 .vindex "&$host_lookup_deferred$&"
11537 However, if either of the lookups cannot be completed (for example, there is a
11538 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
11539 &$host_lookup_failed$& remains set to &"0"&.
11540
11541 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
11542 host name again if there is a subsequent reference to &$sender_host_name$&
11543 in the same Exim process, but it does try again if &$host_lookup_deferred$&
11544 is set to &"1"&.
11545
11546 Exim does not automatically look up every calling host's name. If you want
11547 maximum efficiency, you should arrange your configuration so that it avoids
11548 these lookups altogether. The lookup happens only if one or more of the
11549 following are true:
11550
11551 .ilist
11552 A string containing &$sender_host_name$& is expanded.
11553 .next
11554 The calling host matches the list in &%host_lookup%&. In the default
11555 configuration, this option is set to *, so it must be changed if lookups are
11556 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
11557 .next
11558 Exim needs the host name in order to test an item in a host list. The items
11559 that require this are described in sections &<<SECThoslispatnam>>& and
11560 &<<SECThoslispatnamsk>>&.
11561 .next
11562 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
11563 In this case, the host name is required to compare with the name quoted in any
11564 EHLO or HELO commands that the client issues.
11565 .next
11566 The remote host issues a EHLO or HELO command that quotes one of the
11567 domains in &%helo_lookup_domains%&. The default value of this option is
11568 . ==== As this is a nested list, any displays it contains must be indented
11569 . ==== as otherwise they are too far to the left.
11570 .code
11571   helo_lookup_domains = @ : @[]
11572 .endd
11573 which causes a lookup if a remote host (incorrectly) gives the server's name or
11574 IP address in an EHLO or HELO command.
11575 .endlist
11576
11577
11578 .vitem &$sender_host_port$&
11579 .vindex "&$sender_host_port$&"
11580 When a message is received from a remote host, this variable contains the port
11581 number that was used on the remote host.
11582
11583 .vitem &$sender_ident$&
11584 .vindex "&$sender_ident$&"
11585 When a message is received from a remote host, this variable contains the
11586 identification received in response to an RFC 1413 request. When a message has
11587 been received locally, this variable contains the login name of the user that
11588 called Exim.
11589
11590 .vitem &$sender_rate_$&&'xxx'&
11591 A number of variables whose names begin &$sender_rate_$& are set as part of the
11592 &%ratelimit%& ACL condition. Details are given in section
11593 &<<SECTratelimiting>>&.
11594
11595 .vitem &$sender_rcvhost$&
11596 .cindex "DNS" "reverse lookup"
11597 .cindex "reverse DNS lookup"
11598 .vindex "&$sender_rcvhost$&"
11599 This is provided specifically for use in &'Received:'& headers. It starts with
11600 either the verified host name (as obtained from a reverse DNS lookup) or, if
11601 there is no verified host name, the IP address in square brackets. After that
11602 there may be text in parentheses. When the first item is a verified host name,
11603 the first thing in the parentheses is the IP address in square brackets,
11604 followed by a colon and a port number if port logging is enabled. When the
11605 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
11606 the parentheses.
11607
11608 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
11609 was used and its argument was not identical to the real host name or IP
11610 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
11611 all three items are present in the parentheses, a newline and tab are inserted
11612 into the string, to improve the formatting of the &'Received:'& header.
11613
11614 .vitem &$sender_verify_failure$&
11615 .vindex "&$sender_verify_failure$&"
11616 In an ACL, when a sender verification fails, this variable contains information
11617 about the failure. The details are the same as for
11618 &$recipient_verify_failure$&.
11619
11620 .vitem &$sending_ip_address$&
11621 .vindex "&$sending_ip_address$&"
11622 This variable is set whenever an outgoing SMTP connection to another host has
11623 been set up. It contains the IP address of the local interface that is being
11624 used. This is useful if a host that has more than one IP address wants to take
11625 on different personalities depending on which one is being used. For incoming
11626 connections, see &$received_ip_address$&.
11627
11628 .vitem &$sending_port$&
11629 .vindex "&$sending_port$&"
11630 This variable is set whenever an outgoing SMTP connection to another host has
11631 been set up. It contains the local port that is being used. For incoming
11632 connections, see &$received_port$&.
11633
11634 .vitem &$smtp_active_hostname$&
11635 .vindex "&$smtp_active_hostname$&"
11636 During an incoming SMTP session, this variable contains the value of the active
11637 host name, as specified by the &%smtp_active_hostname%& option. The value of
11638 &$smtp_active_hostname$& is saved with any message that is received, so its
11639 value can be consulted during routing and delivery.
11640
11641 .vitem &$smtp_command$&
11642 .vindex "&$smtp_command$&"
11643 During the processing of an incoming SMTP command, this variable contains the
11644 entire command. This makes it possible to distinguish between HELO and EHLO in
11645 the HELO ACL, and also to distinguish between commands such as these:
11646 .code
11647 MAIL FROM:<>
11648 MAIL FROM: <>
11649 .endd
11650 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
11651 command, the address in &$smtp_command$& is the original address before any
11652 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
11653 the address after SMTP-time rewriting.
11654
11655 .vitem &$smtp_command_argument$&
11656 .cindex "SMTP" "command, argument for"
11657 .vindex "&$smtp_command_argument$&"
11658 While an ACL is running to check an SMTP command, this variable contains the
11659 argument, that is, the text that follows the command name, with leading white
11660 space removed. Following the introduction of &$smtp_command$&, this variable is
11661 somewhat redundant, but is retained for backwards compatibility.
11662
11663 .vitem &$smtp_count_at_connection_start$&
11664 .vindex "&$smtp_count_at_connection_start$&"
11665 This variable is set greater than zero only in processes spawned by the Exim
11666 daemon for handling incoming SMTP connections. The name is deliberately long,
11667 in order to emphasize what the contents are. When the daemon accepts a new
11668 connection, it increments this variable. A copy of the variable is passed to
11669 the child process that handles the connection, but its value is fixed, and
11670 never changes. It is only an approximation of how many incoming connections
11671 there actually are, because many other connections may come and go while a
11672 single connection is being processed. When a child process terminates, the
11673 daemon decrements its copy of the variable.
11674
11675 .vitem "&$sn0$& &-- &$sn9$&"
11676 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
11677 that were current at the end of the system filter file. This allows a system
11678 filter file to set values that can be tested in users' filter files. For
11679 example, a system filter could set a value indicating how likely it is that a
11680 message is junk mail.
11681
11682 .vitem &$spam_$&&'xxx'&
11683 A number of variables whose names start with &$spam$& are available when Exim
11684 is compiled with the content-scanning extension. For details, see section
11685 &<<SECTscanspamass>>&.
11686
11687
11688 .vitem &$spool_directory$&
11689 .vindex "&$spool_directory$&"
11690 The name of Exim's spool directory.
11691
11692 .vitem &$spool_inodes$&
11693 .vindex "&$spool_inodes$&"
11694 The number of free inodes in the disk partition where Exim's spool files are
11695 being written. The value is recalculated whenever the variable is referenced.
11696 If the relevant file system does not have the concept of inodes, the value of
11697 is -1. See also the &%check_spool_inodes%& option.
11698
11699 .vitem &$spool_space$&
11700 .vindex "&$spool_space$&"
11701 The amount of free space (as a number of kilobytes) in the disk partition where
11702 Exim's spool files are being written. The value is recalculated whenever the
11703 variable is referenced. If the operating system does not have the ability to
11704 find the amount of free space (only true for experimental systems), the space
11705 value is -1. For example, to check in an ACL that there is at least 50
11706 megabytes free on the spool, you could write:
11707 .code
11708 condition = ${if > {$spool_space}{50000}}
11709 .endd
11710 See also the &%check_spool_space%& option.
11711
11712
11713 .vitem &$thisaddress$&
11714 .vindex "&$thisaddress$&"
11715 This variable is set only during the processing of the &%foranyaddress%&
11716 command in a filter file. Its use is explained in the description of that
11717 command, which can be found in the separate document entitled &'Exim's
11718 interfaces to mail filtering'&.
11719
11720 .vitem &$tls_certificate_verified$&
11721 .vindex "&$tls_certificate_verified$&"
11722 This variable is set to &"1"& if a TLS certificate was verified when the
11723 message was received, and &"0"& otherwise.
11724
11725 .vitem &$tls_cipher$&
11726 .vindex "&$tls_cipher$&"
11727 When a message is received from a remote host over an encrypted SMTP
11728 connection, this variable is set to the cipher suite that was negotiated, for
11729 example DES-CBC3-SHA. In other circumstances, in particular, for message
11730 received over unencrypted connections, the variable is empty. Testing
11731 &$tls_cipher$& for emptiness is one way of distinguishing between encrypted and
11732 non-encrypted connections during ACL processing.
11733
11734 The &$tls_cipher$& variable retains its value during message delivery, except
11735 when an outward SMTP delivery takes place via the &(smtp)& transport. In this
11736 case, &$tls_cipher$& is cleared before any outgoing SMTP connection is made,
11737 and then set to the outgoing cipher suite if one is negotiated. See chapter
11738 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
11739 details of the &(smtp)& transport.
11740
11741 .vitem &$tls_peerdn$&
11742 .vindex "&$tls_peerdn$&"
11743 When a message is received from a remote host over an encrypted SMTP
11744 connection, and Exim is configured to request a certificate from the client,
11745 the value of the Distinguished Name of the certificate is made available in the
11746 &$tls_peerdn$& during subsequent processing. Like &$tls_cipher$&, the
11747 value is retained during message delivery, except during outbound SMTP
11748 deliveries.
11749
11750 .vitem &$tod_bsdinbox$&
11751 .vindex "&$tod_bsdinbox$&"
11752 The time of day and the date, in the format required for BSD-style mailbox
11753 files, for example: Thu Oct 17 17:14:09 1995.
11754
11755 .vitem &$tod_epoch$&
11756 .vindex "&$tod_epoch$&"
11757 The time and date as a number of seconds since the start of the Unix epoch.
11758
11759 .vitem &$tod_full$&
11760 .vindex "&$tod_full$&"
11761 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
11762 +0100. The timezone is always given as a numerical offset from UTC, with
11763 positive values used for timezones that are ahead (east) of UTC, and negative
11764 values for those that are behind (west).
11765
11766 .vitem &$tod_log$&
11767 .vindex "&$tod_log$&"
11768 The time and date in the format used for writing Exim's log files, for example:
11769 1995-10-12 15:32:29, but without a timezone.
11770
11771 .vitem &$tod_logfile$&
11772 .vindex "&$tod_logfile$&"
11773 This variable contains the date in the format yyyymmdd. This is the format that
11774 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
11775 flag.
11776
11777 .vitem &$tod_zone$&
11778 .vindex "&$tod_zone$&"
11779 This variable contains the numerical value of the local timezone, for example:
11780 -0500.
11781
11782 .vitem &$tod_zulu$&
11783 .vindex "&$tod_zulu$&"
11784 This variable contains the UTC date and time in &"Zulu"& format, as specified
11785 by ISO 8601, for example: 20030221154023Z.
11786
11787 .vitem &$value$&
11788 .vindex "&$value$&"
11789 This variable contains the result of an expansion lookup, extraction operation,
11790 or external command, as described above. It is also used during a
11791 &*reduce*& expansion.
11792
11793 .vitem &$version_number$&
11794 .vindex "&$version_number$&"
11795 The version number of Exim.
11796
11797 .vitem &$warn_message_delay$&
11798 .vindex "&$warn_message_delay$&"
11799 This variable is set only during the creation of a message warning about a
11800 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
11801
11802 .vitem &$warn_message_recipients$&
11803 .vindex "&$warn_message_recipients$&"
11804 This variable is set only during the creation of a message warning about a
11805 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
11806 .endlist
11807 .ecindex IIDstrexp
11808
11809
11810
11811 . ////////////////////////////////////////////////////////////////////////////
11812 . ////////////////////////////////////////////////////////////////////////////
11813
11814 .chapter "Embedded Perl" "CHAPperl"
11815 .scindex IIDperl "Perl" "calling from Exim"
11816 Exim can be built to include an embedded Perl interpreter. When this is done,
11817 Perl subroutines can be called as part of the string expansion process. To make
11818 use of the Perl support, you need version 5.004 or later of Perl installed on
11819 your system. To include the embedded interpreter in the Exim binary, include
11820 the line
11821 .code
11822 EXIM_PERL = perl.o
11823 .endd
11824 in your &_Local/Makefile_& and then build Exim in the normal way.
11825
11826
11827 .section "Setting up so Perl can be used" "SECID85"
11828 .oindex "&%perl_startup%&"
11829 Access to Perl subroutines is via a global configuration option called
11830 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
11831 no &%perl_startup%& option in the Exim configuration file then no Perl
11832 interpreter is started and there is almost no overhead for Exim (since none of
11833 the Perl library will be paged in unless used). If there is a &%perl_startup%&
11834 option then the associated value is taken to be Perl code which is executed in
11835 a newly created Perl interpreter.
11836
11837 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
11838 need backslashes before any characters to escape special meanings. The option
11839 should usually be something like
11840 .code
11841 perl_startup = do '/etc/exim.pl'
11842 .endd
11843 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
11844 use from Exim. Exim can be configured either to start up a Perl interpreter as
11845 soon as it is entered, or to wait until the first time it is needed. Starting
11846 the interpreter at the beginning ensures that it is done while Exim still has
11847 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
11848 fact used in a particular run. Also, note that this does not mean that Exim is
11849 necessarily running as root when Perl is called at a later time. By default,
11850 the interpreter is started only when it is needed, but this can be changed in
11851 two ways:
11852
11853 .ilist
11854 .oindex "&%perl_at_start%&"
11855 Setting &%perl_at_start%& (a boolean option) in the configuration requests
11856 a startup when Exim is entered.
11857 .next
11858 The command line option &%-ps%& also requests a startup when Exim is entered,
11859 overriding the setting of &%perl_at_start%&.
11860 .endlist
11861
11862 There is also a command line option &%-pd%& (for delay) which suppresses the
11863 initial startup, even if &%perl_at_start%& is set.
11864
11865
11866 .section "Calling Perl subroutines" "SECID86"
11867 When the configuration file includes a &%perl_startup%& option you can make use
11868 of the string expansion item to call the Perl subroutines that are defined
11869 by the &%perl_startup%& code. The operator is used in any of the following
11870 forms:
11871 .code
11872 ${perl{foo}}
11873 ${perl{foo}{argument}}
11874 ${perl{foo}{argument1}{argument2} ... }
11875 .endd
11876 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
11877 arguments may be passed. Passing more than this results in an expansion failure
11878 with an error message of the form
11879 .code
11880 Too many arguments passed to Perl subroutine "foo" (max is 8)
11881 .endd
11882 The return value of the Perl subroutine is evaluated in a scalar context before
11883 it is passed back to Exim to be inserted into the expanded string. If the
11884 return value is &'undef'&, the expansion is forced to fail in the same way as
11885 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
11886 by obeying Perl's &%die%& function, the expansion fails with the error message
11887 that was passed to &%die%&.
11888
11889
11890 .section "Calling Exim functions from Perl" "SECID87"
11891 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
11892 is available to call back into Exim's string expansion function. For example,
11893 the Perl code
11894 .code
11895 my $lp = Exim::expand_string('$local_part');
11896 .endd
11897 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
11898 Note those are single quotes and not double quotes to protect against
11899 &$local_part$& being interpolated as a Perl variable.
11900
11901 If the string expansion is forced to fail by a &"fail"& item, the result of
11902 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
11903 expansion string, the Perl call from the original expansion string fails with
11904 an appropriate error message, in the same way as if &%die%& were used.
11905
11906 .cindex "debugging" "from embedded Perl"
11907 .cindex "log" "writing from embedded Perl"
11908 Two other Exim functions are available for use from within Perl code.
11909 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
11910 debugging is enabled. If you want a newline at the end, you must supply it.
11911 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
11912 timestamp. In this case, you should not supply a terminating newline.
11913
11914
11915 .section "Use of standard output and error by Perl" "SECID88"
11916 .cindex "Perl" "standard output and error"
11917 You should not write to the standard error or output streams from within your
11918 Perl code, as it is not defined how these are set up. In versions of Exim
11919 before 4.50, it is possible for the standard output or error to refer to the
11920 SMTP connection during message reception via the daemon. Writing to this stream
11921 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
11922 error streams are connected to &_/dev/null_& in the daemon. The chaos is
11923 avoided, but the output is lost.
11924
11925 .cindex "Perl" "use of &%warn%&"
11926 The Perl &%warn%& statement writes to the standard error stream by default.
11927 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
11928 you have no control. When Exim starts up the Perl interpreter, it arranges for
11929 output from the &%warn%& statement to be written to the Exim main log. You can
11930 change this by including appropriate Perl magic somewhere in your Perl code.
11931 For example, to discard &%warn%& output completely, you need this:
11932 .code
11933 $SIG{__WARN__} = sub { };
11934 .endd
11935 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
11936 example, the code for the subroutine is empty, so it does nothing, but you can
11937 include any Perl code that you like. The text of the &%warn%& message is passed
11938 as the first subroutine argument.
11939 .ecindex IIDperl
11940
11941
11942 . ////////////////////////////////////////////////////////////////////////////
11943 . ////////////////////////////////////////////////////////////////////////////
11944
11945 .chapter "Starting the daemon and the use of network interfaces" &&&
11946          "CHAPinterfaces" &&&
11947          "Starting the daemon"
11948 .cindex "daemon" "starting"
11949 .cindex "interface" "listening"
11950 .cindex "network interface"
11951 .cindex "interface" "network"
11952 .cindex "IP address" "for listening"
11953 .cindex "daemon" "listening IP addresses"
11954 .cindex "TCP/IP" "setting listening interfaces"
11955 .cindex "TCP/IP" "setting listening ports"
11956 A host that is connected to a TCP/IP network may have one or more physical
11957 hardware network interfaces. Each of these interfaces may be configured as one
11958 or more &"logical"& interfaces, which are the entities that a program actually
11959 works with. Each of these logical interfaces is associated with an IP address.
11960 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
11961 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
11962 knowledge about the host's interfaces for use in three different circumstances:
11963
11964 .olist
11965 When a listening daemon is started, Exim needs to know which interfaces
11966 and ports to listen on.
11967 .next
11968 When Exim is routing an address, it needs to know which IP addresses
11969 are associated with local interfaces. This is required for the correct
11970 processing of MX lists by removing the local host and others with the
11971 same or higher priority values. Also, Exim needs to detect cases
11972 when an address is routed to an IP address that in fact belongs to the
11973 local host. Unless the &%self%& router option or the &%allow_localhost%&
11974 option of the smtp transport is set (as appropriate), this is treated
11975 as an error situation.
11976 .next
11977 When Exim connects to a remote host, it may need to know which interface to use
11978 for the outgoing connection.
11979 .endlist
11980
11981
11982 Exim's default behaviour is likely to be appropriate in the vast majority
11983 of cases. If your host has only one interface, and you want all its IP
11984 addresses to be treated in the same way, and you are using only the
11985 standard SMTP port, you should not need to take any special action. The
11986 rest of this chapter does not apply to you.
11987
11988 In a more complicated situation you may want to listen only on certain
11989 interfaces, or on different ports, and for this reason there are a number of
11990 options that can be used to influence Exim's behaviour. The rest of this
11991 chapter describes how they operate.
11992
11993 When a message is received over TCP/IP, the interface and port that were
11994 actually used are set in &$received_ip_address$& and &$received_port$&.
11995
11996
11997
11998 .section "Starting a listening daemon" "SECID89"
11999 When a listening daemon is started (by means of the &%-bd%& command line
12000 option), the interfaces and ports on which it listens are controlled by the
12001 following options:
12002
12003 .ilist
12004 &%daemon_smtp_ports%& contains a list of default ports. (For backward
12005 compatibility, this option can also be specified in the singular.)
12006 .next
12007 &%local_interfaces%& contains list of interface IP addresses on which to
12008 listen. Each item may optionally also specify a port.
12009 .endlist
12010
12011 The default list separator in both cases is a colon, but this can be changed as
12012 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
12013 it is usually best to change the separator to avoid having to double all the
12014 colons. For example:
12015 .code
12016 local_interfaces = <; 127.0.0.1 ; \
12017                       192.168.23.65 ; \
12018                       ::1 ; \
12019                       3ffe:ffff:836f::fe86:a061
12020 .endd
12021 There are two different formats for specifying a port along with an IP address
12022 in &%local_interfaces%&:
12023
12024 .olist
12025 The port is added onto the address with a dot separator. For example, to listen
12026 on port 1234 on two different IP addresses:
12027 .code
12028 local_interfaces = <; 192.168.23.65.1234 ; \
12029                       3ffe:ffff:836f::fe86:a061.1234
12030 .endd
12031 .next
12032 The IP address is enclosed in square brackets, and the port is added
12033 with a colon separator, for example:
12034 .code
12035 local_interfaces = <; [192.168.23.65]:1234 ; \
12036                       [3ffe:ffff:836f::fe86:a061]:1234
12037 .endd
12038 .endlist
12039
12040 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
12041 default setting contains just one port:
12042 .code
12043 daemon_smtp_ports = smtp
12044 .endd
12045 If more than one port is listed, each interface that does not have its own port
12046 specified listens on all of them. Ports that are listed in
12047 &%daemon_smtp_ports%& can be identified either by name (defined in
12048 &_/etc/services_&) or by number. However, when ports are given with individual
12049 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
12050
12051
12052
12053 .section "Special IP listening addresses" "SECID90"
12054 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
12055 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
12056 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
12057 instead of setting up separate listening sockets for each interface. The
12058 default value of &%local_interfaces%& is
12059 .code
12060 local_interfaces = 0.0.0.0
12061 .endd
12062 when Exim is built without IPv6 support; otherwise it is:
12063 .code
12064 local_interfaces = <; ::0 ; 0.0.0.0
12065 .endd
12066 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
12067
12068
12069
12070 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
12071 The &%-oX%& command line option can be used to override the values of
12072 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
12073 instance. Another way of doing this would be to use macros and the &%-D%&
12074 option. However, &%-oX%& can be used by any admin user, whereas modification of
12075 the runtime configuration by &%-D%& is allowed only when the caller is root or
12076 exim.
12077
12078 The value of &%-oX%& is a list of items. The default colon separator can be
12079 changed in the usual way if required. If there are any items that do not
12080 contain dots or colons (that is, are not IP addresses), the value of
12081 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
12082 items that do contain dots or colons, the value of &%local_interfaces%& is
12083 replaced by those items. Thus, for example,
12084 .code
12085 -oX 1225
12086 .endd
12087 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
12088 whereas
12089 .code
12090 -oX 192.168.34.5.1125
12091 .endd
12092 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
12093 (However, since &%local_interfaces%& now contains no items without ports, the
12094 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
12095
12096
12097
12098 .section "Support for the obsolete SSMTP (or SMTPS) protocol" "SECTsupobssmt"
12099 .cindex "ssmtp protocol"
12100 .cindex "smtps protocol"
12101 .cindex "SMTP" "ssmtp protocol"
12102 .cindex "SMTP" "smtps protocol"
12103 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
12104 before the STARTTLS command was standardized for SMTP. Some legacy clients
12105 still use this protocol. If the &%tls_on_connect_ports%& option is set to a
12106 list of port numbers, connections to those ports must use SSMTP. The most
12107 common use of this option is expected to be
12108 .code
12109 tls_on_connect_ports = 465
12110 .endd
12111 because 465 is the usual port number used by the legacy clients. There is also
12112 a command line option &%-tls-on-connect%&, which forces all ports to behave in
12113 this way when a daemon is started.
12114
12115 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
12116 daemon to listen on those ports. You must still specify them in
12117 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
12118 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
12119 connections via the daemon.)
12120
12121
12122
12123
12124 .section "IPv6 address scopes" "SECID92"
12125 .cindex "IPv6" "address scopes"
12126 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
12127 can, in principle, have the same link-local IPv6 address on different
12128 interfaces. Thus, additional information is needed, over and above the IP
12129 address, to distinguish individual interfaces. A convention of using a
12130 percent sign followed by something (often the interface name) has been
12131 adopted in some cases, leading to addresses like this:
12132 .code
12133 fe80::202:b3ff:fe03:45c1%eth0
12134 .endd
12135 To accommodate this usage, a percent sign followed by an arbitrary string is
12136 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
12137 to convert a textual IPv6 address for actual use. This function recognizes the
12138 percent convention in operating systems that support it, and it processes the
12139 address appropriately. Unfortunately, some older libraries have problems with
12140 &[getaddrinfo()]&. If
12141 .code
12142 IPV6_USE_INET_PTON=yes
12143 .endd
12144 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
12145 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
12146 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
12147 function.) Of course, this means that the additional functionality of
12148 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
12149
12150 .section "Disabling IPv6" "SECID93"
12151 .cindex "IPv6" "disabling"
12152 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
12153 run on a host whose kernel does not support IPv6. The binary will fall back to
12154 using IPv4, but it may waste resources looking up AAAA records, and trying to
12155 connect to IPv6 addresses, causing delays to mail delivery. If you set the
12156 .oindex "&%disable_ipv6%&"
12157 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
12158 activities take place. AAAA records are never looked up, and any IPv6 addresses
12159 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
12160 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
12161 to handle IPv6 literal addresses.
12162
12163 On the other hand, when IPv6 is in use, there may be times when you want to
12164 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
12165 option to globally suppress the lookup of AAAA records for specified domains,
12166 and you can use the &%ignore_target_hosts%& generic router option to ignore
12167 IPv6 addresses in an individual router.
12168
12169
12170
12171 .section "Examples of starting a listening daemon" "SECID94"
12172 The default case in an IPv6 environment is
12173 .code
12174 daemon_smtp_ports = smtp
12175 local_interfaces = <; ::0 ; 0.0.0.0
12176 .endd
12177 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
12178 Either one or two sockets may be used, depending on the characteristics of
12179 the TCP/IP stack. (This is complicated and messy; for more information,
12180 read the comments in the &_daemon.c_& source file.)
12181
12182 To specify listening on ports 25 and 26 on all interfaces:
12183 .code
12184 daemon_smtp_ports = 25 : 26
12185 .endd
12186 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
12187 .code
12188 local_interfaces = <; ::0.25     ; ::0.26 \
12189                       0.0.0.0.25 ; 0.0.0.0.26
12190 .endd
12191 To listen on the default port on all IPv4 interfaces, and on port 26 on the
12192 IPv4 loopback address only:
12193 .code
12194 local_interfaces = 0.0.0.0 : 127.0.0.1.26
12195 .endd
12196 To specify listening on the default port on specific interfaces only:
12197 .code
12198 local_interfaces = 192.168.34.67 : 192.168.34.67
12199 .endd
12200 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
12201
12202
12203
12204 .section "Recognizing the local host" "SECTreclocipadd"
12205 The &%local_interfaces%& option is also used when Exim needs to determine
12206 whether or not an IP address refers to the local host. That is, the IP
12207 addresses of all the interfaces on which a daemon is listening are always
12208 treated as local.
12209
12210 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
12211 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
12212 available interfaces from the operating system, and extracts the relevant
12213 (that is, IPv4 or IPv6) addresses to use for checking.
12214
12215 Some systems set up large numbers of virtual interfaces in order to provide
12216 many virtual web servers. In this situation, you may want to listen for
12217 email on only a few of the available interfaces, but nevertheless treat all
12218 interfaces as local when routing. You can do this by setting
12219 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
12220 &"all"& wildcard values. These addresses are recognized as local, but are not
12221 used for listening. Consider this example:
12222 .code
12223 local_interfaces = <; 127.0.0.1 ; ::1 ; \
12224                       192.168.53.235 ; \
12225                       3ffe:2101:12:1:a00:20ff:fe86:a061
12226
12227 extra_local_interfaces = <; ::0 ; 0.0.0.0
12228 .endd
12229 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
12230 address, but all available interface addresses are treated as local when
12231 Exim is routing.
12232
12233 In some environments the local host name may be in an MX list, but with an IP
12234 address that is not assigned to any local interface. In other cases it may be
12235 desirable to treat other host names as if they referred to the local host. Both
12236 these cases can be handled by setting the &%hosts_treat_as_local%& option.
12237 This contains host names rather than IP addresses. When a host is referenced
12238 during routing, either via an MX record or directly, it is treated as the local
12239 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
12240 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
12241
12242
12243
12244 .section "Delivering to a remote host" "SECID95"
12245 Delivery to a remote host is handled by the smtp transport. By default, it
12246 allows the system's TCP/IP functions to choose which interface to use (if
12247 there is more than one) when connecting to a remote host. However, the
12248 &%interface%& option can be set to specify which interface is used. See the
12249 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
12250 details.
12251
12252
12253
12254
12255 . ////////////////////////////////////////////////////////////////////////////
12256 . ////////////////////////////////////////////////////////////////////////////
12257
12258 .chapter "Main configuration" "CHAPmainconfig"
12259 .scindex IIDconfima "configuration file" "main section"
12260 .scindex IIDmaiconf "main configuration"
12261 The first part of the run time configuration file contains three types of item:
12262
12263 .ilist
12264 Macro definitions: These lines start with an upper case letter. See section
12265 &<<SECTmacrodefs>>& for details of macro processing.
12266 .next
12267 Named list definitions: These lines start with one of the words &"domainlist"&,
12268 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
12269 section &<<SECTnamedlists>>&.
12270 .next
12271 Main configuration settings: Each setting occupies one line of the file
12272 (with possible continuations). If any setting is preceded by the word
12273 &"hide"&, the &%-bP%& command line option displays its value to admin users
12274 only. See section &<<SECTcos>>& for a description of the syntax of these option
12275 settings.
12276 .endlist
12277
12278 This chapter specifies all the main configuration options, along with their
12279 types and default values. For ease of finding a particular option, they appear
12280 in alphabetical order in section &<<SECTalomo>>& below. However, because there
12281 are now so many options, they are first listed briefly in functional groups, as
12282 an aid to finding the name of the option you are looking for. Some options are
12283 listed in more than one group.
12284
12285 .section "Miscellaneous" "SECID96"
12286 .table2
12287 .row &%bi_command%&                  "to run for &%-bi%& command line option"
12288 .row &%disable_ipv6%&                "do no IPv6 processing"
12289 .row &%keep_malformed%&              "for broken files &-- should not happen"
12290 .row &%localhost_number%&            "for unique message ids in clusters"
12291 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
12292 .row &%message_body_visible%&        "how much to show in &$message_body$&"
12293 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
12294 .row &%print_topbitchars%&           "top-bit characters are printing"
12295 .row &%timezone%&                    "force time zone"
12296 .endtable
12297
12298
12299 .section "Exim parameters" "SECID97"
12300 .table2
12301 .row &%exim_group%&                  "override compiled-in value"
12302 .row &%exim_path%&                   "override compiled-in value"
12303 .row &%exim_user%&                   "override compiled-in value"
12304 .row &%primary_hostname%&            "default from &[uname()]&"
12305 .row &%split_spool_directory%&       "use multiple directories"
12306 .row &%spool_directory%&             "override compiled-in value"
12307 .endtable
12308
12309
12310
12311 .section "Privilege controls" "SECID98"
12312 .table2
12313 .row &%admin_groups%&                "groups that are Exim admin users"
12314 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
12315 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
12316 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
12317 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
12318 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
12319 .row &%never_users%&                 "do not run deliveries as these"
12320 .row &%prod_requires_admin%&         "forced delivery requires admin user"
12321 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
12322 .row &%trusted_groups%&              "groups that are trusted"
12323 .row &%trusted_users%&               "users that are trusted"
12324 .endtable
12325
12326
12327
12328 .section "Logging" "SECID99"
12329 .table2
12330 .row &%hosts_connection_nolog%&      "exemption from connect logging"
12331 .row &%log_file_path%&               "override compiled-in value"
12332 .row &%log_selector%&                "set/unset optional logging"
12333 .row &%log_timezone%&                "add timezone to log lines"
12334 .row &%message_logs%&                "create per-message logs"
12335 .row &%preserve_message_logs%&       "after message completion"
12336 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
12337 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
12338 .row &%syslog_facility%&             "set syslog &""facility""& field"
12339 .row &%syslog_processname%&          "set syslog &""ident""& field"
12340 .row &%syslog_timestamp%&            "timestamp syslog lines"
12341 .row &%write_rejectlog%&             "control use of message log"
12342 .endtable
12343
12344
12345
12346 .section "Frozen messages" "SECID100"
12347 .table2
12348 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
12349 .row &%freeze_tell%&                 "send message when freezing"
12350 .row &%move_frozen_messages%&        "to another directory"
12351 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
12352 .endtable
12353
12354
12355
12356 .section "Data lookups" "SECID101"
12357 .table2
12358 .row &%ibase_servers%&               "InterBase servers"
12359 .row &%ldap_default_servers%&        "used if no server in query"
12360 .row &%ldap_version%&                "set protocol version"
12361 .row &%lookup_open_max%&             "lookup files held open"
12362 .row &%mysql_servers%&               "default MySQL servers"
12363 .row &%oracle_servers%&              "Oracle servers"
12364 .row &%pgsql_servers%&               "default PostgreSQL servers"
12365 .row &%sqlite_lock_timeout%&         "as it says"
12366 .endtable
12367
12368
12369
12370 .section "Message ids" "SECID102"
12371 .table2
12372 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
12373 .row &%message_id_header_text%&      "ditto"
12374 .endtable
12375
12376
12377
12378 .section "Embedded Perl Startup" "SECID103"
12379 .table2
12380 .row &%perl_at_start%&               "always start the interpreter"
12381 .row &%perl_startup%&                "code to obey when starting Perl"
12382 .endtable
12383
12384
12385
12386 .section "Daemon" "SECID104"
12387 .table2
12388 .row &%daemon_smtp_ports%&           "default ports"
12389 .row &%daemon_startup_retries%&      "number of times to retry"
12390 .row &%daemon_startup_sleep%&        "time to sleep between tries"
12391 .row &%extra_local_interfaces%&      "not necessarily listened on"
12392 .row &%local_interfaces%&            "on which to listen, with optional ports"
12393 .row &%pid_file_path%&               "override compiled-in value"
12394 .row &%queue_run_max%&               "maximum simultaneous queue runners"
12395 .endtable
12396
12397
12398
12399 .section "Resource control" "SECID105"
12400 .table2
12401 .row &%check_log_inodes%&            "before accepting a message"
12402 .row &%check_log_space%&             "before accepting a message"
12403 .row &%check_spool_inodes%&          "before accepting a message"
12404 .row &%check_spool_space%&           "before accepting a message"
12405 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
12406 .row &%queue_only_load%&             "queue incoming if load high"
12407 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
12408 .row &%queue_run_max%&               "maximum simultaneous queue runners"
12409 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
12410 .row &%smtp_accept_max%&             "simultaneous incoming connections"
12411 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
12412 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
12413 .row &%smtp_accept_max_per_connection%& "messages per connection"
12414 .row &%smtp_accept_max_per_host%&    "connections from one host"
12415 .row &%smtp_accept_queue%&           "queue mail if more connections"
12416 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
12417                                            connection"
12418 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
12419 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
12420 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
12421 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
12422 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
12423 .endtable
12424
12425
12426
12427 .section "Policy controls" "SECID106"
12428 .table2
12429 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
12430 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
12431 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
12432 .row &%acl_smtp_auth%&               "ACL for AUTH"
12433 .row &%acl_smtp_connect%&            "ACL for connection"
12434 .row &%acl_smtp_data%&               "ACL for DATA"
12435 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
12436 .row &%acl_smtp_etrn%&               "ACL for ETRN"
12437 .row &%acl_smtp_expn%&               "ACL for EXPN"
12438 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
12439 .row &%acl_smtp_mail%&               "ACL for MAIL"
12440 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
12441 .row &%acl_smtp_mime%&               "ACL for MIME parts"
12442 .row &%acl_smtp_predata%&            "ACL for start of data"
12443 .row &%acl_smtp_quit%&               "ACL for QUIT"
12444 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
12445 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
12446 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
12447 .row &%av_scanner%&                  "specify virus scanner"
12448 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
12449                                       words""&"
12450 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
12451 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
12452 .row &%header_maxsize%&              "total size of message header"
12453 .row &%header_line_maxsize%&         "individual header line limit"
12454 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
12455 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
12456 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
12457 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
12458 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
12459 .row &%host_lookup%&                 "host name looked up for these hosts"
12460 .row &%host_lookup_order%&           "order of DNS and local name lookups"
12461 .row &%host_reject_connection%&      "reject connection from these hosts"
12462 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
12463 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
12464 .row &%message_size_limit%&          "for all messages"
12465 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
12466 .row &%spamd_address%&               "set interface to SpamAssassin"
12467 .row &%strict_acl_vars%&             "object to unset ACL variables"
12468 .endtable
12469
12470
12471
12472 .section "Callout cache" "SECID107"
12473 .table2
12474 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
12475                                          item"
12476 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
12477                                          item"
12478 .row &%callout_negative_expire%&     "timeout for negative address cache item"
12479 .row &%callout_positive_expire%&     "timeout for positive address cache item"
12480 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
12481 .endtable
12482
12483
12484
12485 .section "TLS" "SECID108"
12486 .table2
12487 .row &%gnutls_require_kx%&           "control GnuTLS key exchanges"
12488 .row &%gnutls_require_mac%&          "control GnuTLS MAC algorithms"
12489 .row &%gnutls_require_protocols%&    "control GnuTLS protocols"
12490 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
12491 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
12492 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
12493 .row &%tls_certificate%&             "location of server certificate"
12494 .row &%tls_crl%&                     "certificate revocation list"
12495 .row &%tls_dhparam%&                 "DH parameters for server"
12496 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
12497 .row &%tls_privatekey%&              "location of server private key"
12498 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
12499 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
12500 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
12501 .row &%tls_verify_certificates%&     "expected client certificates"
12502 .row &%tls_verify_hosts%&            "insist on client certificate verify"
12503 .endtable
12504
12505
12506
12507 .section "Local user handling" "SECID109"
12508 .table2
12509 .row &%finduser_retries%&            "useful in NIS environments"
12510 .row &%gecos_name%&                  "used when creating &'Sender:'&"
12511 .row &%gecos_pattern%&               "ditto"
12512 .row &%max_username_length%&         "for systems that truncate"
12513 .row &%unknown_login%&               "used when no login name found"
12514 .row &%unknown_username%&            "ditto"
12515 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
12516 .row &%uucp_from_sender%&            "ditto"
12517 .endtable
12518
12519
12520
12521 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
12522 .table2
12523 .row &%header_maxsize%&              "total size of message header"
12524 .row &%header_line_maxsize%&         "individual header line limit"
12525 .row &%message_size_limit%&          "applies to all messages"
12526 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
12527 .row &%received_header_text%&        "expanded to make &'Received:'&"
12528 .row &%received_headers_max%&        "for mail loop detection"
12529 .row &%recipients_max%&              "limit per message"
12530 .row &%recipients_max_reject%&       "permanently reject excess recipients"
12531 .endtable
12532
12533
12534
12535
12536 .section "Non-SMTP incoming messages" "SECID111"
12537 .table2
12538 .row &%receive_timeout%&             "for non-SMTP messages"
12539 .endtable
12540
12541
12542
12543
12544
12545 .section "Incoming SMTP messages" "SECID112"
12546 See also the &'Policy controls'& section above.
12547
12548 .table2
12549 .row &%host_lookup%&                 "host name looked up for these hosts"
12550 .row &%host_lookup_order%&           "order of DNS and local name lookups"
12551 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
12552 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
12553 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
12554 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
12555 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
12556 .row &%smtp_accept_max%&             "simultaneous incoming connections"
12557 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
12558 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
12559 .row &%smtp_accept_max_per_connection%& "messages per connection"
12560 .row &%smtp_accept_max_per_host%&    "connections from one host"
12561 .row &%smtp_accept_queue%&           "queue mail if more connections"
12562 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
12563                                            connection"
12564 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
12565 .row &%smtp_active_hostname%&        "host name to use in messages"
12566 .row &%smtp_banner%&                 "text for welcome banner"
12567 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
12568 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
12569 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
12570 .row &%smtp_etrn_command%&           "what to run for ETRN"
12571 .row &%smtp_etrn_serialize%&         "only one at once"
12572 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
12573 .row &%smtp_max_unknown_commands%&   "before dropping connection"
12574 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
12575 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
12576 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
12577 .row &%smtp_receive_timeout%&        "per command or data line"
12578 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
12579 .row &%smtp_return_error_details%&   "give detail on rejections"
12580 .endtable
12581
12582
12583
12584 .section "SMTP extensions" "SECID113"
12585 .table2
12586 .row &%accept_8bitmime%&             "advertise 8BITMIME"
12587 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
12588 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
12589 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
12590 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
12591 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
12592 .endtable
12593
12594
12595
12596 .section "Processing messages" "SECID114"
12597 .table2
12598 .row &%allow_domain_literals%&       "recognize domain literal syntax"
12599 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
12600 .row &%allow_utf8_domains%&          "in addresses"
12601 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
12602                                       words""&"
12603 .row &%delivery_date_remove%&        "from incoming messages"
12604 .row &%envelope_to_remove%&          "from incoming messages"
12605 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
12606 .row &%headers_charset%&             "default for translations"
12607 .row &%qualify_domain%&              "default for senders"
12608 .row &%qualify_recipient%&           "default for recipients"
12609 .row &%return_path_remove%&          "from incoming messages"
12610 .row &%strip_excess_angle_brackets%& "in addresses"
12611 .row &%strip_trailing_dot%&          "at end of addresses"
12612 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
12613 .endtable
12614
12615
12616
12617 .section "System filter" "SECID115"
12618 .table2
12619 .row &%system_filter%&               "locate system filter"
12620 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
12621                                             directory"
12622 .row &%system_filter_file_transport%& "transport for delivery to a file"
12623 .row &%system_filter_group%&         "group for filter running"
12624 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
12625 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
12626 .row &%system_filter_user%&          "user for filter running"
12627 .endtable
12628
12629
12630
12631 .section "Routing and delivery" "SECID116"
12632 .table2
12633 .row &%disable_ipv6%&                "do no IPv6 processing"
12634 .row &%dns_again_means_nonexist%&    "for broken domains"
12635 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
12636 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
12637 .row &%dns_retrans%&                 "parameter for resolver"
12638 .row &%dns_retry%&                   "parameter for resolver"
12639 .row &%hold_domains%&                "hold delivery for these domains"
12640 .row &%local_interfaces%&            "for routing checks"
12641 .row &%queue_domains%&               "no immediate delivery for these"
12642 .row &%queue_only%&                  "no immediate delivery at all"
12643 .row &%queue_only_file%&             "no immediate delivery if file exists"
12644 .row &%queue_only_load%&             "no immediate delivery if load is high"
12645 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
12646 .row &%queue_only_override%&         "allow command line to override"
12647 .row &%queue_run_in_order%&          "order of arrival"
12648 .row &%queue_run_max%&               "of simultaneous queue runners"
12649 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
12650 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
12651 .row &%remote_sort_domains%&         "order of remote deliveries"
12652 .row &%retry_data_expire%&           "timeout for retry data"
12653 .row &%retry_interval_max%&          "safety net for retry rules"
12654 .endtable
12655
12656
12657
12658 .section "Bounce and warning messages" "SECID117"
12659 .table2
12660 .row &%bounce_message_file%&         "content of bounce"
12661 .row &%bounce_message_text%&         "content of bounce"
12662 .row &%bounce_return_body%&          "include body if returning message"
12663 .row &%bounce_return_message%&       "include original message in bounce"
12664 .row &%bounce_return_size_limit%&    "limit on returned message"
12665 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
12666 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
12667 .row &%errors_copy%&                 "copy bounce messages"
12668 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
12669 .row &%delay_warning%&               "time schedule"
12670 .row &%delay_warning_condition%&     "condition for warning messages"
12671 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
12672 .row &%smtp_return_error_details%&   "give detail on rejections"
12673 .row &%warn_message_file%&           "content of warning message"
12674 .endtable
12675
12676
12677
12678 .section "Alphabetical list of main options" "SECTalomo"
12679 Those options that undergo string expansion before use are marked with
12680 &dagger;.
12681
12682 .option accept_8bitmime main boolean false
12683 .cindex "8BITMIME"
12684 .cindex "8-bit characters"
12685 This option causes Exim to send 8BITMIME in its response to an SMTP
12686 EHLO command, and to accept the BODY= parameter on MAIL commands.
12687 However, though Exim is 8-bit clean, it is not a protocol converter, and it
12688 takes no steps to do anything special with messages received by this route.
12689 Consequently, this option is turned off by default.
12690
12691 .option acl_not_smtp main string&!! unset
12692 .cindex "&ACL;" "for non-SMTP messages"
12693 .cindex "non-SMTP messages" "ACLs for"
12694 This option defines the ACL that is run when a non-SMTP message has been
12695 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
12696 further details.
12697
12698 .option acl_not_smtp_mime main string&!! unset
12699 This option defines the ACL that is run for individual MIME parts of non-SMTP
12700 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
12701 SMTP messages.
12702
12703 .option acl_not_smtp_start main string&!! unset
12704 .cindex "&ACL;" "at start of non-SMTP message"
12705 .cindex "non-SMTP messages" "ACLs for"
12706 This option defines the ACL that is run before Exim starts reading a
12707 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
12708
12709 .option acl_smtp_auth main string&!! unset
12710 .cindex "&ACL;" "setting up for SMTP commands"
12711 .cindex "AUTH" "ACL for"
12712 This option defines the ACL that is run when an SMTP AUTH command is
12713 received. See chapter &<<CHAPACL>>& for further details.
12714
12715 .option acl_smtp_connect main string&!! unset
12716 .cindex "&ACL;" "on SMTP connection"
12717 This option defines the ACL that is run when an SMTP connection is received.
12718 See chapter &<<CHAPACL>>& for further details.
12719
12720 .option acl_smtp_data main string&!! unset
12721 .cindex "DATA" "ACL for"
12722 This option defines the ACL that is run after an SMTP DATA command has been
12723 processed and the message itself has been received, but before the final
12724 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
12725
12726 .option acl_smtp_etrn main string&!! unset
12727 .cindex "ETRN" "ACL for"
12728 This option defines the ACL that is run when an SMTP ETRN command is
12729 received. See chapter &<<CHAPACL>>& for further details.
12730
12731 .option acl_smtp_expn main string&!! unset
12732 .cindex "EXPN" "ACL for"
12733 This option defines the ACL that is run when an SMTP EXPN command is
12734 received. See chapter &<<CHAPACL>>& for further details.
12735
12736 .option acl_smtp_helo main string&!! unset
12737 .cindex "EHLO" "ACL for"
12738 .cindex "HELO" "ACL for"
12739 This option defines the ACL that is run when an SMTP EHLO or HELO
12740 command is received. See chapter &<<CHAPACL>>& for further details.
12741
12742
12743 .option acl_smtp_mail main string&!! unset
12744 .cindex "MAIL" "ACL for"
12745 This option defines the ACL that is run when an SMTP MAIL command is
12746 received. See chapter &<<CHAPACL>>& for further details.
12747
12748 .option acl_smtp_mailauth main string&!! unset
12749 .cindex "AUTH" "on MAIL command"
12750 This option defines the ACL that is run when there is an AUTH parameter on
12751 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
12752 &<<CHAPSMTPAUTH>>& for details of authentication.
12753
12754 .option acl_smtp_mime main string&!! unset
12755 .cindex "MIME content scanning" "ACL for"
12756 This option is available when Exim is built with the content-scanning
12757 extension. It defines the ACL that is run for each MIME part in a message. See
12758 section &<<SECTscanmimepart>>& for details.
12759
12760 .option acl_smtp_predata main string&!! unset
12761 This option defines the ACL that is run when an SMTP DATA command is
12762 received, before the message itself is received. See chapter &<<CHAPACL>>& for
12763 further details.
12764
12765 .option acl_smtp_quit main string&!! unset
12766 .cindex "QUIT, ACL for"
12767 This option defines the ACL that is run when an SMTP QUIT command is
12768 received. See chapter &<<CHAPACL>>& for further details.
12769
12770 .option acl_smtp_rcpt main string&!! unset
12771 .cindex "RCPT" "ACL for"
12772 This option defines the ACL that is run when an SMTP RCPT command is
12773 received. See chapter &<<CHAPACL>>& for further details.
12774
12775 .option acl_smtp_starttls main string&!! unset
12776 .cindex "STARTTLS, ACL for"
12777 This option defines the ACL that is run when an SMTP STARTTLS command is
12778 received. See chapter &<<CHAPACL>>& for further details.
12779
12780 .option acl_smtp_vrfy main string&!! unset
12781 .cindex "VRFY" "ACL for"
12782 This option defines the ACL that is run when an SMTP VRFY command is
12783 received. See chapter &<<CHAPACL>>& for further details.
12784
12785 .option admin_groups main "string list&!!" unset
12786 .cindex "admin user"
12787 This option is expanded just once, at the start of Exim's processing. If the
12788 current group or any of the supplementary groups of an Exim caller is in this
12789 colon-separated list, the caller has admin privileges. If all your system
12790 programmers are in a specific group, for example, you can give them all Exim
12791 admin privileges by putting that group in &%admin_groups%&. However, this does
12792 not permit them to read Exim's spool files (whose group owner is the Exim gid).
12793 To permit this, you have to add individuals to the Exim group.
12794
12795 .option allow_domain_literals main boolean false
12796 .cindex "domain literal"
12797 If this option is set, the RFC 2822 domain literal format is permitted in
12798 email addresses. The option is not set by default, because the domain literal
12799 format is not normally required these days, and few people know about it. It
12800 has, however, been exploited by mail abusers.
12801
12802 Unfortunately, it seems that some DNS black list maintainers are using this
12803 format to report black listing to postmasters. If you want to accept messages
12804 addressed to your hosts by IP address, you need to set
12805 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
12806 domains (defined in the named domain list &%local_domains%& in the default
12807 configuration). This &"magic string"& matches the domain literal form of all
12808 the local host's IP addresses.
12809
12810
12811 .option allow_mx_to_ip main boolean false
12812 .cindex "MX record" "pointing to IP address"
12813 It appears that more and more DNS zone administrators are breaking the rules
12814 and putting domain names that look like IP addresses on the right hand side of
12815 MX records. Exim follows the rules and rejects this, giving an error message
12816 that explains the mis-configuration. However, some other MTAs support this
12817 practice, so to avoid &"Why can't Exim do this?"& complaints,
12818 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
12819 recommended, except when you have no other choice.
12820
12821 .option allow_utf8_domains main boolean false
12822 .cindex "domain" "UTF-8 characters in"
12823 .cindex "UTF-8" "in domain name"
12824 Lots of discussion is going on about internationalized domain names. One
12825 camp is strongly in favour of just using UTF-8 characters, and it seems
12826 that at least two other MTAs permit this. This option allows Exim users to
12827 experiment if they wish.
12828
12829 If it is set true, Exim's domain parsing function allows valid
12830 UTF-8 multicharacters to appear in domain name components, in addition to
12831 letters, digits, and hyphens. However, just setting this option is not
12832 enough; if you want to look up these domain names in the DNS, you must also
12833 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
12834 suitable setting is:
12835 .code
12836 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
12837   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
12838 .endd
12839 Alternatively, you can just disable this feature by setting
12840 .code
12841 dns_check_names_pattern =
12842 .endd
12843 That is, set the option to an empty string so that no check is done.
12844
12845
12846 .option auth_advertise_hosts main "host list&!!" *
12847 .cindex "authentication" "advertising"
12848 .cindex "AUTH" "advertising"
12849 If any server authentication mechanisms are configured, Exim advertises them in
12850 response to an EHLO command only if the calling host matches this list.
12851 Otherwise, Exim does not advertise AUTH.
12852 Exim does not accept AUTH commands from clients to which it has not
12853 advertised the availability of AUTH. The advertising of individual
12854 authentication mechanisms can be controlled by the use of the
12855 &%server_advertise_condition%& generic authenticator option on the individual
12856 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
12857
12858 Certain mail clients (for example, Netscape) require the user to provide a name
12859 and password for authentication if AUTH is advertised, even though it may
12860 not be needed (the host may accept messages from hosts on its local LAN without
12861 authentication, for example). The &%auth_advertise_hosts%& option can be used
12862 to make these clients more friendly by excluding them from the set of hosts to
12863 which Exim advertises AUTH.
12864
12865 .cindex "AUTH" "advertising when encrypted"
12866 If you want to advertise the availability of AUTH only when the connection
12867 is encrypted using TLS, you can make use of the fact that the value of this
12868 option is expanded, with a setting like this:
12869 .code
12870 auth_advertise_hosts = ${if eq{$tls_cipher}{}{}{*}}
12871 .endd
12872 .vindex "&$tls_cipher$&"
12873 If &$tls_cipher$& is empty, the session is not encrypted, and the result of
12874 the expansion is empty, thus matching no hosts. Otherwise, the result of the
12875 expansion is *, which matches all hosts.
12876
12877
12878 .option auto_thaw main time 0s
12879 .cindex "thawing messages"
12880 .cindex "unfreezing messages"
12881 If this option is set to a time greater than zero, a queue runner will try a
12882 new delivery attempt on any frozen message, other than a bounce message, if
12883 this much time has passed since it was frozen. This may result in the message
12884 being re-frozen if nothing has changed since the last attempt. It is a way of
12885 saying &"keep on trying, even though there are big problems"&.
12886
12887 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
12888 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
12889 thought to be very useful any more, and its use should probably be avoided.
12890
12891 .option av_scanner main string "see below"
12892 This option is available if Exim is built with the content-scanning extension.
12893 It specifies which anti-virus scanner to use. The default value is:
12894 .code
12895 sophie:/var/run/sophie
12896 .endd
12897 If the value of &%av_scanner%& starts with a dollar character, it is expanded
12898 before use. See section &<<SECTscanvirus>>& for further details.
12899
12900
12901
12902 .option bi_command main string unset
12903 .oindex "&%-bi%&"
12904 This option supplies the name of a command that is run when Exim is called with
12905 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
12906 just the command name, it is not a complete command line. If an argument is
12907 required, it must come from the &%-oA%& command line option.
12908
12909
12910 .option bounce_message_file main string unset
12911 .cindex "bounce message" "customizing"
12912 .cindex "customizing" "bounce message"
12913 This option defines a template file containing paragraphs of text to be used
12914 for constructing bounce messages.  Details of the file's contents are given in
12915 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
12916
12917
12918 .option bounce_message_text main string unset
12919 When this option is set, its contents are included in the default bounce
12920 message immediately after &"This message was created automatically by mail
12921 delivery software."& It is not used if &%bounce_message_file%& is set.
12922
12923 .option bounce_return_body main boolean true
12924 .cindex "bounce message" "including body"
12925 This option controls whether the body of an incoming message is included in a
12926 bounce message when &%bounce_return_message%& is true. The default setting
12927 causes the entire message, both header and body, to be returned (subject to the
12928 value of &%bounce_return_size_limit%&). If this option is false, only the
12929 message header is included. In the case of a non-SMTP message containing an
12930 error that is detected during reception, only those header lines preceding the
12931 point at which the error was detected are returned.
12932 .cindex "bounce message" "including original"
12933
12934 .option bounce_return_message main boolean true
12935 If this option is set false, none of the original message is included in
12936 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
12937 &%bounce_return_body%&.
12938
12939
12940 .option bounce_return_size_limit main integer 100K
12941 .cindex "size" "of bounce, limit"
12942 .cindex "bounce message" "size limit"
12943 .cindex "limit" "bounce message size"
12944 This option sets a limit in bytes on the size of messages that are returned to
12945 senders as part of bounce messages when &%bounce_return_message%& is true. The
12946 limit should be less than the value of the global &%message_size_limit%& and of
12947 any &%message_size_limit%& settings on transports, to allow for the bounce text
12948 that Exim generates. If this option is set to zero there is no limit.
12949
12950 When the body of any message that is to be included in a bounce message is
12951 greater than the limit, it is truncated, and a comment pointing this out is
12952 added at the top. The actual cutoff may be greater than the value given, owing
12953 to the use of buffering for transferring the message in chunks (typically 8K in
12954 size). The idea is to save bandwidth on those undeliverable 15-megabyte
12955 messages.
12956
12957 .option bounce_sender_authentication main string unset
12958 .cindex "bounce message" "sender authentication"
12959 .cindex "authentication" "bounce message"
12960 .cindex "AUTH" "on bounce message"
12961 This option provides an authenticated sender address that is sent with any
12962 bounce messages generated by Exim that are sent over an authenticated SMTP
12963 connection. A typical setting might be:
12964 .code
12965 bounce_sender_authentication = mailer-daemon@my.domain.example
12966 .endd
12967 which would cause bounce messages to be sent using the SMTP command:
12968 .code
12969 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
12970 .endd
12971 The value of &%bounce_sender_authentication%& must always be a complete email
12972 address.
12973
12974 .option callout_domain_negative_expire main time 3h
12975 .cindex "caching" "callout timeouts"
12976 .cindex "callout" "caching timeouts"
12977 This option specifies the expiry time for negative callout cache data for a
12978 domain. See section &<<SECTcallver>>& for details of callout verification, and
12979 section &<<SECTcallvercache>>& for details of the caching.
12980
12981
12982 .option callout_domain_positive_expire main time 7d
12983 This option specifies the expiry time for positive callout cache data for a
12984 domain. See section &<<SECTcallver>>& for details of callout verification, and
12985 section &<<SECTcallvercache>>& for details of the caching.
12986
12987
12988 .option callout_negative_expire main time 2h
12989 This option specifies the expiry time for negative callout cache data for an
12990 address. See section &<<SECTcallver>>& for details of callout verification, and
12991 section &<<SECTcallvercache>>& for details of the caching.
12992
12993
12994 .option callout_positive_expire main time 24h
12995 This option specifies the expiry time for positive callout cache data for an
12996 address. See section &<<SECTcallver>>& for details of callout verification, and
12997 section &<<SECTcallvercache>>& for details of the caching.
12998
12999
13000 .option callout_random_local_part main string&!! "see below"
13001 This option defines the &"random"& local part that can be used as part of
13002 callout verification. The default value is
13003 .code
13004 $primary_host_name-$tod_epoch-testing
13005 .endd
13006 See section &<<CALLaddparcall>>& for details of how this value is used.
13007
13008
13009 .option check_log_inodes main integer 0
13010 See &%check_spool_space%& below.
13011
13012
13013 .option check_log_space main integer 0
13014 See &%check_spool_space%& below.
13015
13016 .oindex "&%check_rfc2047_length%&"
13017 .cindex "RFC 2047" "disabling length check"
13018 .option check_rfc2047_length main boolean true
13019 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
13020 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
13021 word; strings to be encoded that exceed this length are supposed to use
13022 multiple encoded words. By default, Exim does not recognize encoded words that
13023 exceed the maximum length. However, it seems that some software, in violation
13024 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
13025 set false, Exim recognizes encoded words of any length.
13026
13027
13028 .option check_spool_inodes main integer 0
13029 See &%check_spool_space%& below.
13030
13031
13032 .option check_spool_space main integer 0
13033 .cindex "checking disk space"
13034 .cindex "disk space, checking"
13035 .cindex "spool directory" "checking space"
13036 The four &%check_...%& options allow for checking of disk resources before a
13037 message is accepted.
13038
13039 .vindex "&$log_inodes$&"
13040 .vindex "&$log_space$&"
13041 .vindex "&$spool_inodes$&"
13042 .vindex "&$spool_space$&"
13043 When any of these options are set, they apply to all incoming messages. If you
13044 want to apply different checks to different kinds of message, you can do so by
13045 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
13046 &$spool_space$& in an ACL with appropriate additional conditions.
13047
13048
13049 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
13050 either value is greater than zero, for example:
13051 .code
13052 check_spool_space = 10M
13053 check_spool_inodes = 100
13054 .endd
13055 The spool partition is the one that contains the directory defined by
13056 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
13057 transit.
13058
13059 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
13060 files are written if either is greater than zero. These should be set only if
13061 &%log_file_path%& and &%spool_directory%& refer to different partitions.
13062
13063 If there is less space or fewer inodes than requested, Exim refuses to accept
13064 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
13065 error response to the MAIL command. If ESMTP is in use and there was a
13066 SIZE parameter on the MAIL command, its value is added to the
13067 &%check_spool_space%& value, and the check is performed even if
13068 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
13069
13070 The values for &%check_spool_space%& and &%check_log_space%& are held as a
13071 number of kilobytes. If a non-multiple of 1024 is specified, it is rounded up.
13072
13073 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
13074 failure a message is written to stderr and Exim exits with a non-zero code, as
13075 it obviously cannot send an error message of any kind.
13076
13077 .option daemon_smtp_ports main string &`smtp`&
13078 .cindex "port" "for daemon"
13079 .cindex "TCP/IP" "setting listening ports"
13080 This option specifies one or more default SMTP ports on which the Exim daemon
13081 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
13082 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
13083
13084 .option daemon_startup_retries main integer 9
13085 .cindex "daemon startup, retrying"
13086 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
13087 the daemon at startup when it cannot immediately bind a listening socket
13088 (typically because the socket is already in use): &%daemon_startup_retries%&
13089 defines the number of retries after the first failure, and
13090 &%daemon_startup_sleep%& defines the length of time to wait between retries.
13091
13092 .option daemon_startup_sleep main time 30s
13093 See &%daemon_startup_retries%&.
13094
13095 .option delay_warning main "time list" 24h
13096 .cindex "warning of delay"
13097 .cindex "delay warning, specifying"
13098 When a message is delayed, Exim sends a warning message to the sender at
13099 intervals specified by this option. The data is a colon-separated list of times
13100 after which to send warning messages. If the value of the option is an empty
13101 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
13102 message has been on the queue for longer than the last time, the last interval
13103 between the times is used to compute subsequent warning times. For example,
13104 with
13105 .code
13106 delay_warning = 4h:8h:24h
13107 .endd
13108 the first message is sent after 4 hours, the second after 8 hours, and
13109 the third one after 24 hours. After that, messages are sent every 16 hours,
13110 because that is the interval between the last two times on the list. If you set
13111 just one time, it specifies the repeat interval. For example, with:
13112 .code
13113 delay_warning = 6h
13114 .endd
13115 messages are repeated every six hours. To stop warnings after a given time, set
13116 a very large time at the end of the list. For example:
13117 .code
13118 delay_warning = 2h:12h:99d
13119 .endd
13120
13121 .option delay_warning_condition main string&!! "see below"
13122 .vindex "&$domain$&"
13123 The string is expanded at the time a warning message might be sent. If all the
13124 deferred addresses have the same domain, it is set in &$domain$& during the
13125 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
13126 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
13127 &"false"& (the comparison being done caselessly) then the warning message is
13128 not sent. The default is:
13129 .code
13130 delay_warning_condition = ${if or {\
13131   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
13132   { match{$h_precedence:}{(?i)bulk|list|junk} }\
13133   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
13134   } {no}{yes}}
13135 .endd
13136 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
13137 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
13138 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
13139 &"auto-replied"& in an &'Auto-Submitted:'& header.
13140
13141 .option deliver_drop_privilege main boolean false
13142 .cindex "unprivileged delivery"
13143 .cindex "delivery" "unprivileged"
13144 If this option is set true, Exim drops its root privilege at the start of a
13145 delivery process, and runs as the Exim user throughout. This severely restricts
13146 the kinds of local delivery that are possible, but is viable in certain types
13147 of configuration. There is a discussion about the use of root privilege in
13148 chapter &<<CHAPsecurity>>&.
13149
13150 .option deliver_queue_load_max main fixed-point unset
13151 .cindex "load average"
13152 .cindex "queue runner" "abandoning"
13153 When this option is set, a queue run is abandoned if the system load average
13154 becomes greater than the value of the option. The option has no effect on
13155 ancient operating systems on which Exim cannot determine the load average.
13156 See also &%queue_only_load%& and &%smtp_load_reserve%&.
13157
13158
13159 .option delivery_date_remove main boolean true
13160 .cindex "&'Delivery-date:'& header line"
13161 Exim's transports have an option for adding a &'Delivery-date:'& header to a
13162 message when it is delivered, in exactly the same way as &'Return-path:'& is
13163 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
13164 should not be present in incoming messages, and this option causes them to be
13165 removed at the time the message is received, to avoid any problems that might
13166 occur when a delivered message is subsequently sent on to some other recipient.
13167
13168 .option disable_fsync main boolean false
13169 .cindex "&[fsync()]&, disabling"
13170 This option is available only if Exim was built with the compile-time option
13171 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
13172 a runtime configuration generates an &"unknown option"& error. You should not
13173 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
13174 really, really, really understand what you are doing. &'No pre-compiled
13175 distributions of Exim should ever make this option available.'&
13176
13177 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
13178 updated files' data to be written to disc before continuing. Unexpected events
13179 such as crashes and power outages may cause data to be lost or scrambled.
13180 Here be Dragons. &*Beware.*&
13181
13182
13183 .option disable_ipv6 main boolean false
13184 .cindex "IPv6" "disabling"
13185 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
13186 activities take place. AAAA records are never looked up, and any IPv6 addresses
13187 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
13188 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13189 to handle IPv6 literal addresses.
13190
13191
13192 .option dns_again_means_nonexist main "domain list&!!" unset
13193 .cindex "DNS" "&""try again""& response; overriding"
13194 DNS lookups give a &"try again"& response for the DNS errors
13195 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
13196 keep trying to deliver a message, or to give repeated temporary errors to
13197 incoming mail. Sometimes the effect is caused by a badly set up name server and
13198 may persist for a long time. If a domain which exhibits this problem matches
13199 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
13200 This option should be used with care. You can make it apply to reverse lookups
13201 by a setting such as this:
13202 .code
13203 dns_again_means_nonexist = *.in-addr.arpa
13204 .endd
13205 This option applies to all DNS lookups that Exim does. It also applies when the
13206 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
13207 since these are most likely to be caused by DNS lookup problems. The
13208 &(dnslookup)& router has some options of its own for controlling what happens
13209 when lookups for MX or SRV records give temporary errors. These more specific
13210 options are applied after this global option.
13211
13212 .option dns_check_names_pattern main string "see below"
13213 .cindex "DNS" "pre-check of name syntax"
13214 When this option is set to a non-empty string, it causes Exim to check domain
13215 names for characters that are not allowed in host names before handing them to
13216 the DNS resolver, because some resolvers give temporary errors for names that
13217 contain unusual characters. If a domain name contains any unwanted characters,
13218 a &"not found"& result is forced, and the resolver is not called. The check is
13219 done by matching the domain name against a regular expression, which is the
13220 value of this option. The default pattern is
13221 .code
13222 dns_check_names_pattern = \
13223   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
13224 .endd
13225 which permits only letters, digits, slashes, and hyphens in components, but
13226 they must start and end with a letter or digit. Slashes are not, in fact,
13227 permitted in host names, but they are found in certain NS records (which can be
13228 accessed in Exim by using a &%dnsdb%& lookup). If you set
13229 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
13230 empty string.
13231
13232 .option dns_csa_search_limit main integer 5
13233 This option controls the depth of parental searching for CSA SRV records in the
13234 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
13235
13236 .option dns_csa_use_reverse main boolean true
13237 This option controls whether or not an IP address, given as a CSA domain, is
13238 reversed and looked up in the reverse DNS, as described in more detail in
13239 section &<<SECTverifyCSA>>&.
13240
13241 .option dns_ipv4_lookup main "domain list&!!" unset
13242 .cindex "IPv6" "DNS lookup for AAAA records"
13243 .cindex "DNS" "IPv6 lookup for AAAA records"
13244 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
13245 looks for IPv6 address records (AAAA records) as well as IPv4 address records
13246 (A records) when trying to find IP addresses for hosts, unless the host's
13247 domain matches this list.
13248
13249 This is a fudge to help with name servers that give big delays or otherwise do
13250 not work for the AAAA record type. In due course, when the world's name
13251 servers have all been upgraded, there should be no need for this option.
13252
13253
13254 .option dns_retrans main time 0s
13255 .cindex "DNS" "resolver options"
13256 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
13257 retransmission and retry parameters for DNS lookups. Values of zero (the
13258 defaults) leave the system default settings unchanged. The first value is the
13259 time between retries, and the second is the number of retries. It isn't
13260 totally clear exactly how these settings affect the total time a DNS lookup may
13261 take. I haven't found any documentation about timeouts on DNS lookups; these
13262 parameter values are available in the external resolver interface structure,
13263 but nowhere does it seem to describe how they are used or what you might want
13264 to set in them.
13265
13266
13267 .option dns_retry main integer 0
13268 See &%dns_retrans%& above.
13269
13270
13271 .option drop_cr main boolean false
13272 This is an obsolete option that is now a no-op. It used to affect the way Exim
13273 handled CR and LF characters in incoming messages. What happens now is
13274 described in section &<<SECTlineendings>>&.
13275
13276 .option dsn_from main "string&!!" "see below"
13277 .cindex "&'From:'& header line" "in bounces"
13278 .cindex "bounce messages" "&'From:'& line, specifying"
13279 This option can be used to vary the contents of &'From:'& header lines in
13280 bounces and other automatically generated messages (&"Delivery Status
13281 Notifications"& &-- hence the name of the option). The default setting is:
13282 .code
13283 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
13284 .endd
13285 The value is expanded every time it is needed. If the expansion fails, a
13286 panic is logged, and the default value is used.
13287
13288 .option envelope_to_remove main boolean true
13289 .cindex "&'Envelope-to:'& header line"
13290 Exim's transports have an option for adding an &'Envelope-to:'& header to a
13291 message when it is delivered, in exactly the same way as &'Return-path:'& is
13292 handled. &'Envelope-to:'& records the original recipient address from the
13293 messages's envelope that caused the delivery to happen. Such headers should not
13294 be present in incoming messages, and this option causes them to be removed at
13295 the time the message is received, to avoid any problems that might occur when a
13296 delivered message is subsequently sent on to some other recipient.
13297
13298
13299 .option errors_copy main "string list&!!" unset
13300 .cindex "bounce message" "copy to other address"
13301 .cindex "copy of bounce message"
13302 Setting this option causes Exim to send bcc copies of bounce messages that it
13303 generates to other addresses. &*Note*&: This does not apply to bounce messages
13304 coming from elsewhere. The value of the option is a colon-separated list of
13305 items. Each item consists of a pattern, terminated by white space, followed by
13306 a comma-separated list of email addresses. If a pattern contains spaces, it
13307 must be enclosed in double quotes.
13308
13309 Each pattern is processed in the same way as a single item in an address list
13310 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
13311 the bounce message, the message is copied to the addresses on the list. The
13312 items are scanned in order, and once a matching one is found, no further items
13313 are examined. For example:
13314 .code
13315 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
13316               rqps@mydomain   hostmaster@mydomain.example,\
13317                               postmaster@mydomain.example
13318 .endd
13319 .vindex "&$domain$&"
13320 .vindex "&$local_part$&"
13321 The address list is expanded before use. The expansion variables &$local_part$&
13322 and &$domain$& are set from the original recipient of the error message, and if
13323 there was any wildcard matching in the pattern, the expansion
13324 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
13325 variables &$0$&, &$1$&, etc. are set in the normal way.
13326
13327
13328 .option errors_reply_to main string unset
13329 .cindex "bounce message" "&'Reply-to:'& in"
13330 By default, Exim's bounce and delivery warning messages contain the header line
13331 .display
13332 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
13333 .endd
13334 .oindex &%quota_warn_message%&
13335 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
13336 A warning message that is generated by the &%quota_warn_message%& option in an
13337 &(appendfile)& transport may contain its own &'From:'& header line that
13338 overrides the default.
13339
13340 Experience shows that people reply to bounce messages. If the
13341 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
13342 and warning messages. For example:
13343 .code
13344 errors_reply_to = postmaster@my.domain.example
13345 .endd
13346 The value of the option is not expanded. It must specify a valid RFC 2822
13347 address. However, if a warning message that is generated by the
13348 &%quota_warn_message%& option in an &(appendfile)& transport contain its
13349 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
13350 not used.
13351
13352
13353 .option exim_group main string "compile-time configured"
13354 .cindex "gid (group id)" "Exim's own"
13355 .cindex "Exim group"
13356 This option changes the gid under which Exim runs when it gives up root
13357 privilege. The default value is compiled into the binary. The value of this
13358 option is used only when &%exim_user%& is also set. Unless it consists entirely
13359 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
13360 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
13361 security issues.
13362
13363
13364 .option exim_path main string "see below"
13365 .cindex "Exim binary, path name"
13366 This option specifies the path name of the Exim binary, which is used when Exim
13367 needs to re-exec itself. The default is set up to point to the file &'exim'& in
13368 the directory configured at compile time by the BIN_DIRECTORY setting. It
13369 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
13370 other place.
13371 &*Warning*&: Do not use a macro to define the value of this option, because
13372 you will break those Exim utilities that scan the configuration file to find
13373 where the binary is. (They then use the &%-bP%& option to extract option
13374 settings such as the value of &%spool_directory%&.)
13375
13376
13377 .option exim_user main string "compile-time configured"
13378 .cindex "uid (user id)" "Exim's own"
13379 .cindex "Exim user"
13380 This option changes the uid under which Exim runs when it gives up root
13381 privilege. The default value is compiled into the binary. Ownership of the run
13382 time configuration file and the use of the &%-C%& and &%-D%& command line
13383 options is checked against the values in the binary, not what is set here.
13384
13385 Unless it consists entirely of digits, the string is looked up using
13386 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
13387 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
13388 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
13389
13390
13391 .option extra_local_interfaces main "string list" unset
13392 This option defines network interfaces that are to be considered local when
13393 routing, but which are not used for listening by the daemon. See section
13394 &<<SECTreclocipadd>>& for details.
13395
13396
13397 . Allow this long option name to split; give it unsplit as a fifth argument
13398 . for the automatic .oindex that is generated by .option.
13399
13400 .option "extract_addresses_remove_ &~&~arguments" main boolean true &&&
13401          extract_addresses_remove_arguments
13402 .oindex "&%-t%&"
13403 .cindex "command line" "addresses with &%-t%&"
13404 .cindex "Sendmail compatibility" "&%-t%& option"
13405 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
13406 are present on the command line when the &%-t%& option is used to build an
13407 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
13408 line addresses are removed from the recipients list. This is also how Smail
13409 behaves. However, other Sendmail documentation (the O'Reilly book) states that
13410 command line addresses are added to those obtained from the header lines. When
13411 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
13412 argument headers. If it is set false, Exim adds rather than removes argument
13413 addresses.
13414
13415
13416 .option finduser_retries main integer 0
13417 .cindex "NIS, retrying user lookups"
13418 On systems running NIS or other schemes in which user and group information is
13419 distributed from a remote system, there can be times when &[getpwnam()]& and
13420 related functions fail, even when given valid data, because things time out.
13421 Unfortunately these failures cannot be distinguished from genuine &"not found"&
13422 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
13423 many extra times to find a user or a group, waiting for one second between
13424 retries.
13425
13426 .cindex "&_/etc/passwd_&" "multiple reading of"
13427 You should not set this option greater than zero if your user information is in
13428 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
13429 search the file multiple times for non-existent users, and also cause delay.
13430
13431
13432
13433 .option freeze_tell main "string list, comma separated" unset
13434 .cindex "freezing messages" "sending a message when freezing"
13435 On encountering certain errors, or when configured to do so in a system filter,
13436 ACL, or special router, Exim freezes a message. This means that no further
13437 delivery attempts take place until an administrator thaws the message, or the
13438 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
13439 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
13440 warning message whenever it freezes something, unless the message it is
13441 freezing is a locally-generated bounce message. (Without this exception there
13442 is the possibility of looping.) The warning message is sent to the addresses
13443 supplied as the comma-separated value of this option. If several of the
13444 message's addresses cause freezing, only a single message is sent. If the
13445 freezing was automatic, the reason(s) for freezing can be found in the message
13446 log. If you configure freezing in a filter or ACL, you must arrange for any
13447 logging that you require.
13448
13449
13450 .option gecos_name main string&!! unset
13451 .cindex "HP-UX"
13452 .cindex "&""gecos""& field, parsing"
13453 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
13454 password file to hold other information in addition to users' real names. Exim
13455 looks up this field for use when it is creating &'Sender:'& or &'From:'&
13456 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
13457 of the field are used unchanged, except that, if an ampersand is encountered,
13458 it is replaced by the user's login name with the first character forced to
13459 upper case, since this is a convention that is observed on many systems.
13460
13461 When these options are set, &%gecos_pattern%& is treated as a regular
13462 expression that is to be applied to the field (again with && replaced by the
13463 login name), and if it matches, &%gecos_name%& is expanded and used as the
13464 user's name.
13465
13466 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
13467 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
13468 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
13469 name terminates at the first comma, the following can be used:
13470 .code
13471 gecos_pattern = ([^,]*)
13472 gecos_name = $1
13473 .endd
13474
13475 .option gecos_pattern main string unset
13476 See &%gecos_name%& above.
13477
13478
13479 .option gnutls_require_kx main string unset
13480 This option controls the key exchange mechanisms when GnuTLS is used in an Exim
13481 server. For details, see section &<<SECTreqciphgnu>>&.
13482
13483 .option gnutls_require_mac main string unset
13484 This option controls the MAC algorithms when GnuTLS is used in an Exim
13485 server. For details, see section &<<SECTreqciphgnu>>&.
13486
13487 .option gnutls_require_protocols main string unset
13488 This option controls the protocols when GnuTLS is used in an Exim
13489 server. For details, see section &<<SECTreqciphgnu>>&.
13490
13491 .option gnutls_compat_mode main boolean unset
13492 This option controls whether GnuTLS is used in compatibility mode in an Exim
13493 server. This reduces security slightly, but improves interworking with older
13494 implementations of TLS.
13495
13496 .option headers_charset main string "see below"
13497 This option sets a default character set for translating from encoded MIME
13498 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
13499 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
13500 ultimate default is ISO-8859-1. For more details see the description of header
13501 insertions in section &<<SECTexpansionitems>>&.
13502
13503
13504
13505 .option header_maxsize main integer "see below"
13506 .cindex "header section" "maximum size of"
13507 .cindex "limit" "size of message header section"
13508 This option controls the overall maximum size of a message's header
13509 section. The default is the value of HEADER_MAXSIZE in
13510 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
13511 sections are rejected.
13512
13513
13514 .option header_line_maxsize main integer 0
13515 .cindex "header lines" "maximum size of"
13516 .cindex "limit" "size of one header line"
13517 This option limits the length of any individual header line in a message, after
13518 all the continuations have been joined together. Messages with individual
13519 header lines that are longer than the limit are rejected. The default value of
13520 zero means &"no limit"&.
13521
13522
13523
13524
13525 .option helo_accept_junk_hosts main "host list&!!" unset
13526 .cindex "HELO" "accepting junk data"
13527 .cindex "EHLO" "accepting junk data"
13528 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
13529 mail, and gives an error response for invalid data. Unfortunately, there are
13530 some SMTP clients that send syntactic junk. They can be accommodated by setting
13531 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
13532 if you want to do semantic checking.
13533 See also &%helo_allow_chars%& for a way of extending the permitted character
13534 set.
13535
13536
13537 .option helo_allow_chars main string unset
13538 .cindex "HELO" "underscores in"
13539 .cindex "EHLO" "underscores in"
13540 .cindex "underscore in EHLO/HELO"
13541 This option can be set to a string of rogue characters that are permitted in
13542 all EHLO and HELO names in addition to the standard letters, digits,
13543 hyphens, and dots. If you really must allow underscores, you can set
13544 .code
13545 helo_allow_chars = _
13546 .endd
13547 Note that the value is one string, not a list.
13548
13549
13550 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
13551 .cindex "HELO" "forcing reverse lookup"
13552 .cindex "EHLO" "forcing reverse lookup"
13553 If the domain given by a client in a HELO or EHLO command matches this
13554 list, a reverse lookup is done in order to establish the host's true name. The
13555 default forces a lookup if the client host gives the server's name or any of
13556 its IP addresses (in brackets), something that broken clients have been seen to
13557 do.
13558
13559
13560 .option helo_try_verify_hosts main "host list&!!" unset
13561 .cindex "HELO verifying" "optional"
13562 .cindex "EHLO" "verifying, optional"
13563 By default, Exim just checks the syntax of HELO and EHLO commands (see
13564 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
13565 to do more extensive checking of the data supplied by these commands. The ACL
13566 condition &`verify = helo`& is provided to make this possible.
13567 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
13568 to force the check to occur. From release 4.53 onwards, this is no longer
13569 necessary. If the check has not been done before &`verify = helo`& is
13570 encountered, it is done at that time. Consequently, this option is obsolete.
13571 Its specification is retained here for backwards compatibility.
13572
13573 When an EHLO or HELO command is received, if the calling host matches
13574 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
13575 EHLO command either:
13576
13577 .ilist
13578 is an IP literal matching the calling address of the host, or
13579 .next
13580 .cindex "DNS" "reverse lookup"
13581 .cindex "reverse DNS lookup"
13582 matches the host name that Exim obtains by doing a reverse lookup of the
13583 calling host address, or
13584 .next
13585 when looked up using &[gethostbyname()]& (or &[getipnodebyname()]& when
13586 available) yields the calling host address.
13587 .endlist
13588
13589 However, the EHLO or HELO command is not rejected if any of the checks
13590 fail. Processing continues, but the result of the check is remembered, and can
13591 be detected later in an ACL by the &`verify = helo`& condition.
13592
13593 .option helo_verify_hosts main "host list&!!" unset
13594 .cindex "HELO verifying" "mandatory"
13595 .cindex "EHLO" "verifying, mandatory"
13596 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
13597 backwards compatibility. For hosts that match this option, Exim checks the host
13598 name given in the HELO or EHLO in the same way as for
13599 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
13600 rejected with a 550 error, and entries are written to the main and reject logs.
13601 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
13602 error.
13603
13604 .option hold_domains main "domain list&!!" unset
13605 .cindex "domain" "delaying delivery"
13606 .cindex "delivery" "delaying certain domains"
13607 This option allows mail for particular domains to be held on the queue
13608 manually. The option is overridden if a message delivery is forced with the
13609 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
13610 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
13611 item in &%hold_domains%&, no routing or delivery for that address is done, and
13612 it is deferred every time the message is looked at.
13613
13614 This option is intended as a temporary operational measure for delaying the
13615 delivery of mail while some problem is being sorted out, or some new
13616 configuration tested. If you just want to delay the processing of some
13617 domains until a queue run occurs, you should use &%queue_domains%& or
13618 &%queue_smtp_domains%&, not &%hold_domains%&.
13619
13620 A setting of &%hold_domains%& does not override Exim's code for removing
13621 messages from the queue if they have been there longer than the longest retry
13622 time in any retry rule. If you want to hold messages for longer than the normal
13623 retry times, insert a dummy retry rule with a long retry time.
13624
13625
13626 .option host_lookup main "host list&!!" unset
13627 .cindex "host name" "lookup, forcing"
13628 Exim does not look up the name of a calling host from its IP address unless it
13629 is required to compare against some host list, or the host matches
13630 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
13631 option (which normally contains IP addresses rather than host names). The
13632 default configuration file contains
13633 .code
13634 host_lookup = *
13635 .endd
13636 which causes a lookup to happen for all hosts. If the expense of these lookups
13637 is felt to be too great, the setting can be changed or removed.
13638
13639 After a successful reverse lookup, Exim does a forward lookup on the name it
13640 has obtained, to verify that it yields the IP address that it started with. If
13641 this check fails, Exim behaves as if the name lookup failed.
13642
13643 .vindex "&$host_lookup_failed$&"
13644 .vindex "&$sender_host_name$&"
13645 After any kind of failure, the host name (in &$sender_host_name$&) remains
13646 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
13647 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
13648 &`verify = reverse_host_lookup`& in ACLs.
13649
13650
13651 .option host_lookup_order main "string list" &`bydns:byaddr`&
13652 This option specifies the order of different lookup methods when Exim is trying
13653 to find a host name from an IP address. The default is to do a DNS lookup
13654 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
13655 if that fails. You can change the order of these lookups, or omit one entirely,
13656 if you want.
13657
13658 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
13659 multiple PTR records in the DNS and the IP address is not listed in
13660 &_/etc/hosts_&. Different operating systems give different results in this
13661 case. That is why the default tries a DNS lookup first.
13662
13663
13664
13665 .option host_reject_connection main "host list&!!" unset
13666 .cindex "host" "rejecting connections from"
13667 If this option is set, incoming SMTP calls from the hosts listed are rejected
13668 as soon as the connection is made.
13669 This option is obsolete, and retained only for backward compatibility, because
13670 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
13671 connections immediately.
13672
13673 The ability to give an immediate rejection (either by this option or using an
13674 ACL) is provided for use in unusual cases. Many hosts will just try again,
13675 sometimes without much delay. Normally, it is better to use an ACL to reject
13676 incoming messages at a later stage, such as after RCPT commands. See
13677 chapter &<<CHAPACL>>&.
13678
13679
13680 .option hosts_connection_nolog main "host list&!!" unset
13681 .cindex "host" "not logging connections from"
13682 This option defines a list of hosts for which connection logging does not
13683 happen, even though the &%smtp_connection%& log selector is set. For example,
13684 you might want not to log SMTP connections from local processes, or from
13685 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
13686 the daemon; you should therefore strive to restrict its value to a short inline
13687 list of IP addresses and networks. To disable logging SMTP connections from
13688 local processes, you must create a host list with an empty item. For example:
13689 .code
13690 hosts_connection_nolog = :
13691 .endd
13692 If the &%smtp_connection%& log selector is not set, this option has no effect.
13693
13694
13695
13696 .option hosts_treat_as_local main "domain list&!!" unset
13697 .cindex "local host" "domains treated as"
13698 .cindex "host" "treated as local"
13699 If this option is set, any host names that match the domain list are treated as
13700 if they were the local host when Exim is scanning host lists obtained from MX
13701 records
13702 or other sources. Note that the value of this option is a domain list, not a
13703 host list, because it is always used to check host names, not IP addresses.
13704
13705 This option also applies when Exim is matching the special items
13706 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
13707 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
13708 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
13709 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
13710 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
13711 interfaces and recognizing the local host.
13712
13713
13714 .option ibase_servers main "string list" unset
13715 .cindex "InterBase" "server list"
13716 This option provides a list of InterBase servers and associated connection data,
13717 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
13718 The option is available only if Exim has been built with InterBase support.
13719
13720
13721
13722 .option ignore_bounce_errors_after main time 10w
13723 .cindex "bounce message" "discarding"
13724 .cindex "discarding bounce message"
13725 This option affects the processing of bounce messages that cannot be delivered,
13726 that is, those that suffer a permanent delivery failure. (Bounce messages that
13727 suffer temporary delivery failures are of course retried in the usual way.)
13728
13729 After a permanent delivery failure, bounce messages are frozen,
13730 because there is no sender to whom they can be returned. When a frozen bounce
13731 message has been on the queue for more than the given time, it is unfrozen at
13732 the next queue run, and a further delivery is attempted. If delivery fails
13733 again, the bounce message is discarded. This makes it possible to keep failed
13734 bounce messages around for a shorter time than the normal maximum retry time
13735 for frozen messages. For example,
13736 .code
13737 ignore_bounce_errors_after = 12h
13738 .endd
13739 retries failed bounce message deliveries after 12 hours, discarding any further
13740 failures. If the value of this option is set to a zero time period, bounce
13741 failures are discarded immediately. Setting a very long time (as in the default
13742 value) has the effect of disabling this option. For ways of automatically
13743 dealing with other kinds of frozen message, see &%auto_thaw%& and
13744 &%timeout_frozen_after%&.
13745
13746
13747 .option ignore_fromline_hosts main "host list&!!" unset
13748 .cindex "&""From""& line"
13749 .cindex "UUCP" "&""From""& line"
13750 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
13751 the headers of a message. By default this is treated as the start of the
13752 message's body, which means that any following headers are not recognized as
13753 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
13754 match those hosts that insist on sending it. If the sender is actually a local
13755 process rather than a remote host, and is using &%-bs%& to inject the messages,
13756 &%ignore_fromline_local%& must be set to achieve this effect.
13757
13758
13759 .option ignore_fromline_local main boolean false
13760 See &%ignore_fromline_hosts%& above.
13761
13762
13763 .option keep_malformed main time 4d
13764 This option specifies the length of time to keep messages whose spool files
13765 have been corrupted in some way. This should, of course, never happen. At the
13766 next attempt to deliver such a message, it gets removed. The incident is
13767 logged.
13768
13769
13770 .option ldap_default_servers main "string list" unset
13771 .cindex "LDAP" "default servers"
13772 This option provides a list of LDAP servers which are tried in turn when an
13773 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
13774 details of LDAP queries. This option is available only when Exim has been built
13775 with LDAP support.
13776
13777
13778 .option ldap_version main integer unset
13779 .cindex "LDAP" "protocol version, forcing"
13780 This option can be used to force Exim to set a specific protocol version for
13781 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
13782 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
13783 the LDAP headers; otherwise it is 2. This option is available only when Exim
13784 has been built with LDAP support.
13785
13786
13787
13788 .option local_from_check main boolean true
13789 .cindex "&'Sender:'& header line" "disabling addition of"
13790 .cindex "&'From:'& header line" "disabling checking of"
13791 When a message is submitted locally (that is, not over a TCP/IP connection) by
13792 an untrusted user, Exim removes any existing &'Sender:'& header line, and
13793 checks that the &'From:'& header line matches the login of the calling user and
13794 the domain specified by &%qualify_domain%&.
13795
13796 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
13797 locally submitted message is automatically qualified by Exim, unless the
13798 &%-bnq%& command line option is used.
13799
13800 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
13801 on the local part. If the &'From:'& header line does not match, Exim adds a
13802 &'Sender:'& header with an address constructed from the calling user's login
13803 and the default qualify domain.
13804
13805 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
13806 and no &'Sender:'& header is ever added. If, in addition, you want to retain
13807 &'Sender:'& header lines supplied by untrusted users, you must also set
13808 &%local_sender_retain%& to be true.
13809
13810 .cindex "envelope sender"
13811 These options affect only the header lines in the message. The envelope sender
13812 is still forced to be the login id at the qualify domain unless
13813 &%untrusted_set_sender%& permits the user to supply an envelope sender.
13814
13815 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
13816 request similar header line checking. See section &<<SECTthesenhea>>&, which
13817 has more details about &'Sender:'& processing.
13818
13819
13820
13821
13822 .option local_from_prefix main string unset
13823 When Exim checks the &'From:'& header line of locally submitted messages for
13824 matching the login id (see &%local_from_check%& above), it can be configured to
13825 ignore certain prefixes and suffixes in the local part of the address. This is
13826 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
13827 appropriate lists, in the same form as the &%local_part_prefix%& and
13828 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
13829 example, if
13830 .code
13831 local_from_prefix = *-
13832 .endd
13833 is set, a &'From:'& line containing
13834 .code
13835 From: anything-user@your.domain.example
13836 .endd
13837 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
13838 matches the actual sender address that is constructed from the login name and
13839 qualify domain.
13840
13841
13842 .option local_from_suffix main string unset
13843 See &%local_from_prefix%& above.
13844
13845
13846 .option local_interfaces main "string list" "see below"
13847 This option controls which network interfaces are used by the daemon for
13848 listening; they are also used to identify the local host when routing. Chapter
13849 &<<CHAPinterfaces>>& contains a full description of this option and the related
13850 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
13851 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
13852 &%local_interfaces%& is
13853 .code
13854 local_interfaces = 0.0.0.0
13855 .endd
13856 when Exim is built without IPv6 support; otherwise it is
13857 .code
13858 local_interfaces = <; ::0 ; 0.0.0.0
13859 .endd
13860
13861 .option local_scan_timeout main time 5m
13862 .cindex "timeout" "for &[local_scan()]& function"
13863 .cindex "&[local_scan()]& function" "timeout"
13864 This timeout applies to the &[local_scan()]& function (see chapter
13865 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
13866 the incoming message is rejected with a temporary error if it is an SMTP
13867 message. For a non-SMTP message, the message is dropped and Exim ends with a
13868 non-zero code. The incident is logged on the main and reject logs.
13869
13870
13871
13872 .option local_sender_retain main boolean false
13873 .cindex "&'Sender:'& header line" "retaining from local submission"
13874 When a message is submitted locally (that is, not over a TCP/IP connection) by
13875 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
13876 do not want this to happen, you must set &%local_sender_retain%&, and you must
13877 also set &%local_from_check%& to be false (Exim will complain if you do not).
13878 See also the ACL modifier &`control = suppress_local_fixups`&. Section
13879 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
13880
13881
13882
13883
13884 .option localhost_number main string&!! unset
13885 .cindex "host" "locally unique number for"
13886 .cindex "message ids" "with multiple hosts"
13887 .vindex "&$localhost_number$&"
13888 Exim's message ids are normally unique only within the local host. If
13889 uniqueness among a set of hosts is required, each host must set a different
13890 value for the &%localhost_number%& option. The string is expanded immediately
13891 after reading the configuration file (so that a number can be computed from the
13892 host name, for example) and the result of the expansion must be a number in the
13893 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
13894 systems). This is available in subsequent string expansions via the variable
13895 &$localhost_number$&. When &%localhost_number is set%&, the final two
13896 characters of the message id, instead of just being a fractional part of the
13897 time, are computed from the time and the local host number as described in
13898 section &<<SECTmessiden>>&.
13899
13900
13901
13902 .option log_file_path main "string list&!!" "set at compile time"
13903 .cindex "log" "file path for"
13904 This option sets the path which is used to determine the names of Exim's log
13905 files, or indicates that logging is to be to syslog, or both. It is expanded
13906 when Exim is entered, so it can, for example, contain a reference to the host
13907 name. If no specific path is set for the log files at compile or run time, they
13908 are written in a sub-directory called &_log_& in Exim's spool directory.
13909 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
13910 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
13911 used. If this string is fixed at your installation (contains no expansion
13912 variables) it is recommended that you do not set this option in the
13913 configuration file, but instead supply the path using LOG_FILE_PATH in
13914 &_Local/Makefile_& so that it is available to Exim for logging errors detected
13915 early on &-- in particular, failure to read the configuration file.
13916
13917
13918 .option log_selector main string unset
13919 .cindex "log" "selectors"
13920 This option can be used to reduce or increase the number of things that Exim
13921 writes to its log files. Its argument is made up of names preceded by plus or
13922 minus characters. For example:
13923 .code
13924 log_selector = +arguments -retry_defer
13925 .endd
13926 A list of possible names and what they control is given in the chapter on
13927 logging, in section &<<SECTlogselector>>&.
13928
13929
13930 .option log_timezone main boolean false
13931 .cindex "log" "timezone for entries"
13932 .vindex "&$tod_log$&"
13933 .vindex "&$tod_zone$&"
13934 By default, the timestamps on log lines are in local time without the
13935 timezone. This means that if your timezone changes twice a year, the timestamps
13936 in log lines are ambiguous for an hour when the clocks go back. One way of
13937 avoiding this problem is to set the timezone to UTC. An alternative is to set
13938 &%log_timezone%& true. This turns on the addition of the timezone offset to
13939 timestamps in log lines. Turning on this option can add quite a lot to the size
13940 of log files because each line is extended by 6 characters. Note that the
13941 &$tod_log$& variable contains the log timestamp without the zone, but there is
13942 another variable called &$tod_zone$& that contains just the timezone offset.
13943
13944
13945 .option lookup_open_max main integer 25
13946 .cindex "too many open files"
13947 .cindex "open files, too many"
13948 .cindex "file" "too many open"
13949 .cindex "lookup" "maximum open files"
13950 .cindex "limit" "open files for lookups"
13951 This option limits the number of simultaneously open files for single-key
13952 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
13953 Exim normally keeps these files open during routing, because often the same
13954 file is required several times. If the limit is reached, Exim closes the least
13955 recently used file. Note that if you are using the &'ndbm'& library, it
13956 actually opens two files for each logical DBM database, though it still counts
13957 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
13958 open files"& errors with NDBM, you need to reduce the value of
13959 &%lookup_open_max%&.
13960
13961
13962 .option max_username_length main integer 0
13963 .cindex "length of login name"
13964 .cindex "user name" "maximum length"
13965 .cindex "limit" "user name length"
13966 Some operating systems are broken in that they truncate long arguments to
13967 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
13968 this option is set greater than zero, any attempt to call &[getpwnam()]& with
13969 an argument that is longer behaves as if &[getpwnam()]& failed.
13970
13971
13972 .option message_body_newlines main bool false
13973 .cindex "message body" "newlines in variables"
13974 .cindex "newline" "in message body variables"
13975 .vindex "&$message_body$&"
13976 .vindex "&$message_body_end$&"
13977 By default, newlines in the message body are replaced by spaces when setting
13978 the &$message_body$& and &$message_body_end$& expansion variables. If this
13979 option is set true, this no longer happens.
13980
13981
13982 .option message_body_visible main integer 500
13983 .cindex "body of message" "visible size"
13984 .cindex "message body" "visible size"
13985 .vindex "&$message_body$&"
13986 .vindex "&$message_body_end$&"
13987 This option specifies how much of a message's body is to be included in the
13988 &$message_body$& and &$message_body_end$& expansion variables.
13989
13990
13991 .option message_id_header_domain main string&!! unset
13992 .cindex "&'Message-ID:'& header line"
13993 If this option is set, the string is expanded and used as the right hand side
13994 (domain) of the &'Message-ID:'& header that Exim creates if a
13995 locally-originated incoming message does not have one. &"Locally-originated"&
13996 means &"not received over TCP/IP."&
13997 Otherwise, the primary host name is used.
13998 Only letters, digits, dot and hyphen are accepted; any other characters are
13999 replaced by hyphens. If the expansion is forced to fail, or if the result is an
14000 empty string, the option is ignored.
14001
14002
14003 .option message_id_header_text main string&!! unset
14004 If this variable is set, the string is expanded and used to augment the text of
14005 the &'Message-id:'& header that Exim creates if a locally-originated incoming
14006 message does not have one. The text of this header is required by RFC 2822 to
14007 take the form of an address. By default, Exim uses its internal message id as
14008 the local part, and the primary host name as the domain. If this option is set,
14009 it is expanded, and provided the expansion is not forced to fail, and does not
14010 yield an empty string, the result is inserted into the header immediately
14011 before the @, separated from the internal message id by a dot. Any characters
14012 that are illegal in an address are automatically converted into hyphens. This
14013 means that variables such as &$tod_log$& can be used, because the spaces and
14014 colons will become hyphens.
14015
14016
14017 .option message_logs main boolean true
14018 .cindex "message logs" "disabling"
14019 .cindex "log" "message log; disabling"
14020 If this option is turned off, per-message log files are not created in the
14021 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
14022 Exim, by reducing the number of files involved in handling a message from a
14023 minimum of four (header spool file, body spool file, delivery journal, and
14024 per-message log) to three. The other major I/O activity is Exim's main log,
14025 which is not affected by this option.
14026
14027
14028 .option message_size_limit main string&!! 50M
14029 .cindex "message" "size limit"
14030 .cindex "limit" "message size"
14031 .cindex "size" "of message, limit"
14032 This option limits the maximum size of message that Exim will process. The
14033 value is expanded for each incoming connection so, for example, it can be made
14034 to depend on the IP address of the remote host for messages arriving via
14035 TCP/IP. After expansion, the value must be a sequence of decimal digits,
14036 optionally followed by K or M.
14037
14038 &*Note*&: This limit cannot be made to depend on a message's sender or any
14039 other properties of an individual message, because it has to be advertised in
14040 the server's response to EHLO. String expansion failure causes a temporary
14041 error. A value of zero means no limit, but its use is not recommended. See also
14042 &%bounce_return_size_limit%&.
14043
14044 Incoming SMTP messages are failed with a 552 error if the limit is
14045 exceeded; locally-generated messages either get a stderr message or a delivery
14046 failure message to the sender, depending on the &%-oe%& setting. Rejection of
14047 an oversized message is logged in both the main and the reject logs. See also
14048 the generic transport option &%message_size_limit%&, which limits the size of
14049 message that an individual transport can process.
14050
14051 .new
14052 If you use a virus-scanner and set this option to to a value larger than the
14053 maximum size that your virus-scanner is configured to support, you may get
14054 failures triggered by large mails.  The right size to configure for the
14055 virus-scanner depends upon what data is passed and the options in use but it's
14056 probably safest to just set it to a little larger than this value.  Eg, with a
14057 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
14058 some problems may result.
14059 .wen
14060
14061
14062 .option move_frozen_messages main boolean false
14063 .cindex "frozen messages" "moving"
14064 This option, which is available only if Exim has been built with the setting
14065 .code
14066 SUPPORT_MOVE_FROZEN_MESSAGES=yes
14067 .endd
14068 in &_Local/Makefile_&, causes frozen messages and their message logs to be
14069 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
14070 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
14071 standard utilities for handling such moved messages, and they do not show up in
14072 lists generated by &%-bp%& or by the Exim monitor.
14073
14074
14075 .option mua_wrapper main boolean false
14076 Setting this option true causes Exim to run in a very restrictive mode in which
14077 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
14078 contains a full description of this facility.
14079
14080
14081
14082 .option mysql_servers main "string list" unset
14083 .cindex "MySQL" "server list"
14084 This option provides a list of MySQL servers and associated connection data, to
14085 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
14086 option is available only if Exim has been built with MySQL support.
14087
14088
14089 .option never_users main "string list&!!" unset
14090 This option is expanded just once, at the start of Exim's processing. Local
14091 message deliveries are normally run in processes that are setuid to the
14092 recipient, and remote deliveries are normally run under Exim's own uid and gid.
14093 It is usually desirable to prevent any deliveries from running as root, as a
14094 safety precaution.
14095
14096 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
14097 list of users that must not be used for local deliveries. This list is fixed in
14098 the binary and cannot be overridden by the configuration file. By default, it
14099 contains just the single user name &"root"&. The &%never_users%& runtime option
14100 can be used to add more users to the fixed list.
14101
14102 If a message is to be delivered as one of the users on the fixed list or the
14103 &%never_users%& list, an error occurs, and delivery is deferred. A common
14104 example is
14105 .code
14106 never_users = root:daemon:bin
14107 .endd
14108 Including root is redundant if it is also on the fixed list, but it does no
14109 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
14110 transport driver.
14111
14112
14113 .new
14114 .option openssl_options main "string list" +dont_insert_empty_fragments
14115 .cindex "OpenSSL "compatibility options"
14116 This option allows an administrator to adjust the SSL options applied
14117 by OpenSSL to connections.  It is given as a space-separated list of items,
14118 each one to be +added or -subtracted from the current value.  The default
14119 value is one option which happens to have been set historically.  You can
14120 remove all options with:
14121 .code
14122 openssl_options = -all
14123 .endd
14124 This option is only available if Exim is built against OpenSSL.  The values
14125 available for this option vary according to the age of your OpenSSL install.
14126 The &"all"& value controls a subset of flags which are available, typically
14127 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
14128 list the values known on your system and Exim should support all the
14129 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
14130 names lose the leading &"SSL_OP_"& and are lower-cased.
14131
14132 Note that adjusting the options can have severe impact upon the security of
14133 SSL as used by Exim.  It is possible to disable safety checks and shoot
14134 yourself in the foot in various unpleasant ways.  This option should not be
14135 adjusted lightly.  An unrecognised item will be detected at by invoking Exim
14136 with the &%-bV%& flag.
14137
14138 An example:
14139 .code
14140 openssl_options = -all +microsoft_big_sslv3_buffer
14141 .endd
14142 .wen
14143
14144
14145 .option oracle_servers main "string list" unset
14146 .cindex "Oracle" "server list"
14147 This option provides a list of Oracle servers and associated connection data,
14148 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
14149 The option is available only if Exim has been built with Oracle support.
14150
14151
14152 .option percent_hack_domains main "domain list&!!" unset
14153 .cindex "&""percent hack""&"
14154 .cindex "source routing" "in email address"
14155 .cindex "address" "source-routed"
14156 The &"percent hack"& is the convention whereby a local part containing a
14157 percent sign is re-interpreted as a new email address, with the percent
14158 replaced by @. This is sometimes called &"source routing"&, though that term is
14159 also applied to RFC 2822 addresses that begin with an @ character. If this
14160 option is set, Exim implements the percent facility for those domains listed,
14161 but no others. This happens before an incoming SMTP address is tested against
14162 an ACL.
14163
14164 &*Warning*&: The &"percent hack"& has often been abused by people who are
14165 trying to get round relaying restrictions. For this reason, it is best avoided
14166 if at all possible. Unfortunately, a number of less security-conscious MTAs
14167 implement it unconditionally. If you are running Exim on a gateway host, and
14168 routing mail through to internal MTAs without processing the local parts, it is
14169 a good idea to reject recipient addresses with percent characters in their
14170 local parts. Exim's default configuration does this.
14171
14172
14173 .option perl_at_start main boolean false
14174 This option is available only when Exim is built with an embedded Perl
14175 interpreter. See chapter &<<CHAPperl>>& for details of its use.
14176
14177
14178 .option perl_startup main string unset
14179 This option is available only when Exim is built with an embedded Perl
14180 interpreter. See chapter &<<CHAPperl>>& for details of its use.
14181
14182
14183 .option pgsql_servers main "string list" unset
14184 .cindex "PostgreSQL lookup type" "server list"
14185 This option provides a list of PostgreSQL servers and associated connection
14186 data, to be used in conjunction with &(pgsql)& lookups (see section
14187 &<<SECID72>>&). The option is available only if Exim has been built with
14188 PostgreSQL support.
14189
14190
14191 .option pid_file_path main string&!! "set at compile time"
14192 .cindex "daemon" "pid file path"
14193 .cindex "pid file, path for"
14194 This option sets the name of the file to which the Exim daemon writes its
14195 process id. The string is expanded, so it can contain, for example, references
14196 to the host name:
14197 .code
14198 pid_file_path = /var/log/$primary_hostname/exim.pid
14199 .endd
14200 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
14201 spool directory.
14202 The value set by the option can be overridden by the &%-oP%& command line
14203 option. A pid file is not written if a &"non-standard"& daemon is run by means
14204 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
14205
14206
14207 .option pipelining_advertise_hosts main "host list&!!" *
14208 .cindex "PIPELINING" "suppressing advertising"
14209 This option can be used to suppress the advertisement of the SMTP
14210 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
14211 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
14212 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
14213 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
14214 that clients will use it; &"out of order"& commands that are &"expected"& do
14215 not count as protocol errors (see &%smtp_max_synprot_errors%&).
14216
14217
14218 .option preserve_message_logs main boolean false
14219 .cindex "message logs" "preserving"
14220 If this option is set, message log files are not deleted when messages are
14221 completed. Instead, they are moved to a sub-directory of the spool directory
14222 called &_msglog.OLD_&, where they remain available for statistical or debugging
14223 purposes. This is a dangerous option to set on systems with any appreciable
14224 volume of mail. Use with care!
14225
14226
14227 .option primary_hostname main string "see below"
14228 .cindex "name" "of local host"
14229 .cindex "host" "name of local"
14230 .cindex "local host" "name of"
14231 .vindex "&$primary_hostname$&"
14232 This specifies the name of the current host. It is used in the default EHLO or
14233 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
14234 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
14235 The value is also used by default in some SMTP response messages from an Exim
14236 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
14237
14238 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
14239 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
14240 contains only one component, Exim passes it to &[gethostbyname()]& (or
14241 &[getipnodebyname()]& when available) in order to obtain the fully qualified
14242 version. The variable &$primary_hostname$& contains the host name, whether set
14243 explicitly by this option, or defaulted.
14244
14245
14246 .option print_topbitchars main boolean false
14247 .cindex "printing characters"
14248 .cindex "8-bit characters"
14249 By default, Exim considers only those characters whose codes lie in the range
14250 32&--126 to be printing characters. In a number of circumstances (for example,
14251 when writing log entries) non-printing characters are converted into escape
14252 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
14253 is set, code values of 128 and above are also considered to be printing
14254 characters.
14255
14256 This option also affects the header syntax checks performed by the
14257 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
14258 the user's full name when constructing From: and Sender: addresses (as
14259 described in section &<<SECTconstr>>&). Setting this option can cause
14260 Exim to generate eight bit message headers that do not conform to the
14261 standards.
14262
14263
14264 .option process_log_path main string unset
14265 .cindex "process log path"
14266 .cindex "log" "process log"
14267 .cindex "&'exiwhat'&"
14268 This option sets the name of the file to which an Exim process writes its
14269 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
14270 utility script. If this option is unset, the file called &_exim-process.info_&
14271 in Exim's spool directory is used. The ability to specify the name explicitly
14272 can be useful in environments where two different Exims are running, using
14273 different spool directories.
14274
14275
14276 .option prod_requires_admin main boolean true
14277 .oindex "&%-M%&"
14278 .oindex "&%-R%&"
14279 .oindex "&%-q%&"
14280 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
14281 admin user unless &%prod_requires_admin%& is set false. See also
14282 &%queue_list_requires_admin%&.
14283
14284
14285 .option qualify_domain main string "see below"
14286 .cindex "domain" "for qualifying addresses"
14287 .cindex "address" "qualification"
14288 This option specifies the domain name that is added to any envelope sender
14289 addresses that do not have a domain qualification. It also applies to
14290 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
14291 are accepted by default only for locally-generated messages. Qualification is
14292 also applied to addresses in header lines such as &'From:'& and &'To:'& for
14293 locally-generated messages, unless the &%-bnq%& command line option is used.
14294
14295 Messages from external sources must always contain fully qualified addresses,
14296 unless the sending host matches &%sender_unqualified_hosts%& or
14297 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
14298 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
14299 necessary. Internally, Exim always works with fully qualified envelope
14300 addresses. If &%qualify_domain%& is not set, it defaults to the
14301 &%primary_hostname%& value.
14302
14303
14304 .option qualify_recipient main string "see below"
14305 This option allows you to specify a different domain for qualifying recipient
14306 addresses to the one that is used for senders. See &%qualify_domain%& above.
14307
14308
14309
14310 .option queue_domains main "domain list&!!" unset
14311 .cindex "domain" "specifying non-immediate delivery"
14312 .cindex "queueing incoming messages"
14313 .cindex "message" "queueing certain domains"
14314 This option lists domains for which immediate delivery is not required.
14315 A delivery process is started whenever a message is received, but only those
14316 domains that do not match are processed. All other deliveries wait until the
14317 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
14318
14319
14320 .option queue_list_requires_admin main boolean true
14321 .oindex "&%-bp%&"
14322 The &%-bp%& command-line option, which lists the messages that are on the
14323 queue, requires the caller to be an admin user unless
14324 &%queue_list_requires_admin%& is set false. See also &%prod_requires_admin%&.
14325
14326
14327 .option queue_only main boolean false
14328 .cindex "queueing incoming messages"
14329 .cindex "message" "queueing unconditionally"
14330 If &%queue_only%& is set, a delivery process is not automatically started
14331 whenever a message is received. Instead, the message waits on the queue for the
14332 next queue run. Even if &%queue_only%& is false, incoming messages may not get
14333 delivered immediately when certain conditions (such as heavy load) occur.
14334
14335 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
14336 and &%-odi%& command line options override &%queue_only%& unless
14337 &%queue_only_override%& is set false. See also &%queue_only_file%&,
14338 &%queue_only_load%&, and &%smtp_accept_queue%&.
14339
14340
14341 .option queue_only_file main string unset
14342 .cindex "queueing incoming messages"
14343 .cindex "message" "queueing by file existence"
14344 This option can be set to a colon-separated list of absolute path names, each
14345 one optionally preceded by &"smtp"&. When Exim is receiving a message,
14346 it tests for the existence of each listed path using a call to &[stat()]&. For
14347 each path that exists, the corresponding queueing option is set.
14348 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
14349 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
14350 .code
14351 queue_only_file = smtp/some/file
14352 .endd
14353 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
14354 &_/some/file_& exists.
14355
14356
14357 .option queue_only_load main fixed-point unset
14358 .cindex "load average"
14359 .cindex "queueing incoming messages"
14360 .cindex "message" "queueing by load"
14361 If the system load average is higher than this value, incoming messages from
14362 all sources are queued, and no automatic deliveries are started. If this
14363 happens during local or remote SMTP input, all subsequent messages received on
14364 the same SMTP connection are queued by default, whatever happens to the load in
14365 the meantime, but this can be changed by setting &%queue_only_load_latch%&
14366 false.
14367
14368 Deliveries will subsequently be performed by queue runner processes. This
14369 option has no effect on ancient operating systems on which Exim cannot
14370 determine the load average. See also &%deliver_queue_load_max%& and
14371 &%smtp_load_reserve%&.
14372
14373
14374 .option queue_only_load_latch main boolean true
14375 .cindex "load average" "re-evaluating per message"
14376 When this option is true (the default), once one message has been queued
14377 because the load average is higher than the value set by &%queue_only_load%&,
14378 all subsequent messages received on the same SMTP connection are also queued.
14379 This is a deliberate choice; even though the load average may fall below the
14380 threshold, it doesn't seem right to deliver later messages on the same
14381 connection when not delivering earlier ones. However, there are special
14382 circumstances such as very long-lived connections from scanning appliances
14383 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
14384 should be set false. This causes the value of the load average to be
14385 re-evaluated for each message.
14386
14387
14388 .option queue_only_override main boolean true
14389 .cindex "queueing incoming messages"
14390 When this option is true, the &%-od%&&'x'& command line options override the
14391 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
14392 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
14393 to override; they are accepted, but ignored.
14394
14395
14396 .option queue_run_in_order main boolean false
14397 .cindex "queue runner" "processing messages in order"
14398 If this option is set, queue runs happen in order of message arrival instead of
14399 in an arbitrary order. For this to happen, a complete list of the entire queue
14400 must be set up before the deliveries start. When the queue is all held in a
14401 single directory (the default), a single list is created for both the ordered
14402 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
14403 single list is not created when &%queue_run_in_order%& is false. In this case,
14404 the sub-directories are processed one at a time (in a random order), and this
14405 avoids setting up one huge list for the whole queue. Thus, setting
14406 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
14407 when the queue is large, because of the extra work in setting up the single,
14408 large list. In most situations, &%queue_run_in_order%& should not be set.
14409
14410
14411
14412 .option queue_run_max main integer 5
14413 .cindex "queue runner" "maximum number of"
14414 This controls the maximum number of queue runner processes that an Exim daemon
14415 can run simultaneously. This does not mean that it starts them all at once,
14416 but rather that if the maximum number are still running when the time comes to
14417 start another one, it refrains from starting another one. This can happen with
14418 very large queues and/or very sluggish deliveries. This option does not,
14419 however, interlock with other processes, so additional queue runners can be
14420 started by other means, or by killing and restarting the daemon.
14421
14422 Setting this option to zero does not suppress queue runs; rather, it disables
14423 the limit, allowing any number of simultaneous queue runner processes to be
14424 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
14425 the daemon's command line.
14426
14427 .option queue_smtp_domains main "domain list&!!" unset
14428 .cindex "queueing incoming messages"
14429 .cindex "message" "queueing remote deliveries"
14430 When this option is set, a delivery process is started whenever a message is
14431 received, routing is performed, and local deliveries take place.
14432 However, if any SMTP deliveries are required for domains that match
14433 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
14434 message waits on the queue for the next queue run. Since routing of the message
14435 has taken place, Exim knows to which remote hosts it must be delivered, and so
14436 when the queue run happens, multiple messages for the same host are delivered
14437 over a single SMTP connection. The &%-odqs%& command line option causes all
14438 SMTP deliveries to be queued in this way, and is equivalent to setting
14439 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
14440 &%queue_domains%&.
14441
14442
14443 .option receive_timeout main time 0s
14444 .cindex "timeout" "for non-SMTP input"
14445 This option sets the timeout for accepting a non-SMTP message, that is, the
14446 maximum time that Exim waits when reading a message on the standard input. If
14447 the value is zero, it will wait for ever. This setting is overridden by the
14448 &%-or%& command line option. The timeout for incoming SMTP messages is
14449 controlled by &%smtp_receive_timeout%&.
14450
14451 .option received_header_text main string&!! "see below"
14452 .cindex "customizing" "&'Received:'& header"
14453 .cindex "&'Received:'& header line" "customizing"
14454 This string defines the contents of the &'Received:'& message header that is
14455 added to each message, except for the timestamp, which is automatically added
14456 on at the end (preceded by a semicolon). The string is expanded each time it is
14457 used. If the expansion yields an empty string, no &'Received:'& header line is
14458 added to the message. Otherwise, the string should start with the text
14459 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
14460 header lines. The default setting is:
14461
14462 .code
14463 received_header_text = Received: \
14464   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
14465   {${if def:sender_ident \
14466   {from ${quote_local_part:$sender_ident} }}\
14467   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
14468   by $primary_hostname \
14469   ${if def:received_protocol {with $received_protocol}} \
14470   ${if def:tls_cipher {($tls_cipher)\n\t}}\
14471   (Exim $version_number)\n\t\
14472   ${if def:sender_address \
14473   {(envelope-from <$sender_address>)\n\t}}\
14474   id $message_exim_id\
14475   ${if def:received_for {\n\tfor $received_for}}
14476 .endd
14477
14478 The reference to the TLS cipher is omitted when Exim is built without TLS
14479 support. The use of conditional expansions ensures that this works for both
14480 locally generated messages and messages received from remote hosts, giving
14481 header lines such as the following:
14482 .code
14483 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
14484 by marley.carol.example with esmtp (Exim 4.00)
14485 (envelope-from <bob@carol.example>)
14486 id 16IOWa-00019l-00
14487 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
14488 Received: by scrooge.carol.example with local (Exim 4.00)
14489 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
14490 .endd
14491 Until the body of the message has been received, the timestamp is the time when
14492 the message started to be received. Once the body has arrived, and all policy
14493 checks have taken place, the timestamp is updated to the time at which the
14494 message was accepted.
14495
14496
14497 .option received_headers_max main integer 30
14498 .cindex "loop" "prevention"
14499 .cindex "mail loop prevention"
14500 .cindex "&'Received:'& header line" "counting"
14501 When a message is to be delivered, the number of &'Received:'& headers is
14502 counted, and if it is greater than this parameter, a mail loop is assumed to
14503 have occurred, the delivery is abandoned, and an error message is generated.
14504 This applies to both local and remote deliveries.
14505
14506
14507 .option recipient_unqualified_hosts main "host list&!!" unset
14508 .cindex "unqualified addresses"
14509 .cindex "host" "unqualified addresses from"
14510 This option lists those hosts from which Exim is prepared to accept unqualified
14511 recipient addresses in message envelopes. The addresses are made fully
14512 qualified by the addition of the &%qualify_recipient%& value. This option also
14513 affects message header lines. Exim does not reject unqualified recipient
14514 addresses in headers, but it qualifies them only if the message came from a
14515 host that matches &%recipient_unqualified_hosts%&,
14516 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
14517 option was not set.
14518
14519
14520 .option recipients_max main integer 0
14521 .cindex "limit" "number of recipients"
14522 .cindex "recipient" "maximum number"
14523 If this option is set greater than zero, it specifies the maximum number of
14524 original recipients for any message. Additional recipients that are generated
14525 by aliasing or forwarding do not count. SMTP messages get a 452 response for
14526 all recipients over the limit; earlier recipients are delivered as normal.
14527 Non-SMTP messages with too many recipients are failed, and no deliveries are
14528 done.
14529
14530 .cindex "RCPT" "maximum number of incoming"
14531 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
14532 RCPT commands in a single message.
14533
14534
14535 .option recipients_max_reject main boolean false
14536 If this option is set true, Exim rejects SMTP messages containing too many
14537 recipients by giving 552 errors to the surplus RCPT commands, and a 554
14538 error to the eventual DATA command. Otherwise (the default) it gives a 452
14539 error to the surplus RCPT commands and accepts the message on behalf of the
14540 initial set of recipients. The remote server should then re-send the message
14541 for the remaining recipients at a later time.
14542
14543
14544 .option remote_max_parallel main integer 2
14545 .cindex "delivery" "parallelism for remote"
14546 This option controls parallel delivery of one message to a number of remote
14547 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
14548 does all the remote deliveries for a message one by one. Otherwise, if a single
14549 message has to be delivered to more than one remote host, or if several copies
14550 have to be sent to the same remote host, up to &%remote_max_parallel%&
14551 deliveries are done simultaneously. If more than &%remote_max_parallel%&
14552 deliveries are required, the maximum number of processes are started, and as
14553 each one finishes, another is begun. The order of starting processes is the
14554 same as if sequential delivery were being done, and can be controlled by the
14555 &%remote_sort_domains%& option. If parallel delivery takes place while running
14556 with debugging turned on, the debugging output from each delivery process is
14557 tagged with its process id.
14558
14559 This option controls only the maximum number of parallel deliveries for one
14560 message in one Exim delivery process. Because Exim has no central queue
14561 manager, there is no way of controlling the total number of simultaneous
14562 deliveries if the configuration allows a delivery attempt as soon as a message
14563 is received.
14564
14565 .cindex "number of deliveries"
14566 .cindex "delivery" "maximum number of"
14567 If you want to control the total number of deliveries on the system, you
14568 need to set the &%queue_only%& option. This ensures that all incoming messages
14569 are added to the queue without starting a delivery process. Then set up an Exim
14570 daemon to start queue runner processes at appropriate intervals (probably
14571 fairly often, for example, every minute), and limit the total number of queue
14572 runners by setting the &%queue_run_max%& parameter. Because each queue runner
14573 delivers only one message at a time, the maximum number of deliveries that can
14574 then take place at once is &%queue_run_max%& multiplied by
14575 &%remote_max_parallel%&.
14576
14577 If it is purely remote deliveries you want to control, use
14578 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
14579 doing the SMTP routing before queueing, so that several messages for the same
14580 host will eventually get delivered down the same connection.
14581
14582
14583 .option remote_sort_domains main "domain list&!!" unset
14584 .cindex "sorting remote deliveries"
14585 .cindex "delivery" "sorting remote"
14586 When there are a number of remote deliveries for a message, they are sorted by
14587 domain into the order given by this list. For example,
14588 .code
14589 remote_sort_domains = *.cam.ac.uk:*.uk
14590 .endd
14591 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
14592 then to those in the &%uk%& domain, then to any others.
14593
14594
14595 .option retry_data_expire main time 7d
14596 .cindex "hints database" "data expiry"
14597 This option sets a &"use before"& time on retry information in Exim's hints
14598 database. Any older retry data is ignored. This means that, for example, once a
14599 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
14600 past failures.
14601
14602
14603 .option retry_interval_max main time 24h
14604 .cindex "retry" "limit on interval"
14605 .cindex "limit" "on retry interval"
14606 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
14607 intervals between delivery attempts for messages that cannot be delivered
14608 straight away. This option sets an overall limit to the length of time between
14609 retries. It cannot be set greater than 24 hours; any attempt to do so forces
14610 the default value.
14611
14612
14613 .option return_path_remove main boolean true
14614 .cindex "&'Return-path:'& header line" "removing"
14615 RFC 2821, section 4.4, states that an SMTP server must insert a
14616 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
14617 The &'Return-path:'& header preserves the sender address as received in the
14618 MAIL command. This description implies that this header should not be present
14619 in an incoming message. If &%return_path_remove%& is true, any existing
14620 &'Return-path:'& headers are removed from messages at the time they are
14621 received. Exim's transports have options for adding &'Return-path:'& headers at
14622 the time of delivery. They are normally used only for final local deliveries.
14623
14624
14625 .option return_size_limit main integer 100K
14626 This option is an obsolete synonym for &%bounce_return_size_limit%&.
14627
14628
14629 .option rfc1413_hosts main "host list&!!" *
14630 .cindex "RFC 1413"
14631 .cindex "host" "for RFC 1413 calls"
14632 RFC 1413 identification calls are made to any client host which matches an item
14633 in the list.
14634
14635 .option rfc1413_query_timeout main time 5s
14636 .cindex "RFC 1413" "query timeout"
14637 .cindex "timeout" "for RFC 1413 call"
14638 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
14639 no RFC 1413 calls are ever made.
14640
14641
14642 .option sender_unqualified_hosts main "host list&!!" unset
14643 .cindex "unqualified addresses"
14644 .cindex "host" "unqualified addresses from"
14645 This option lists those hosts from which Exim is prepared to accept unqualified
14646 sender addresses. The addresses are made fully qualified by the addition of
14647 &%qualify_domain%&. This option also affects message header lines. Exim does
14648 not reject unqualified addresses in headers that contain sender addresses, but
14649 it qualifies them only if the message came from a host that matches
14650 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
14651 using TCP/IP), and the &%-bnq%& option was not set.
14652
14653
14654 .option smtp_accept_keepalive main boolean true
14655 .cindex "keepalive" "on incoming connection"
14656 This option controls the setting of the SO_KEEPALIVE option on incoming
14657 TCP/IP socket connections. When set, it causes the kernel to probe idle
14658 connections periodically, by sending packets with &"old"& sequence numbers. The
14659 other end of the connection should send an acknowledgment if the connection is
14660 still okay or a reset if the connection has been aborted. The reason for doing
14661 this is that it has the beneficial effect of freeing up certain types of
14662 connection that can get stuck when the remote host is disconnected without
14663 tidying up the TCP/IP call properly. The keepalive mechanism takes several
14664 hours to detect unreachable hosts.
14665
14666
14667
14668 .option smtp_accept_max main integer 20
14669 .cindex "limit" "incoming SMTP connections"
14670 .cindex "SMTP" "incoming connection count"
14671 .cindex "inetd"
14672 This option specifies the maximum number of simultaneous incoming SMTP calls
14673 that Exim will accept. It applies only to the listening daemon; there is no
14674 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
14675 value is set to zero, no limit is applied. However, it is required to be
14676 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
14677 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
14678
14679 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
14680 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
14681 that limit has not been reached for the client host, &%smtp_accept_reserve%&
14682 and &%smtp_load_reserve%& are then checked before accepting the connection.
14683
14684
14685 .option smtp_accept_max_nonmail main integer 10
14686 .cindex "limit" "non-mail SMTP commands"
14687 .cindex "SMTP" "limiting non-mail commands"
14688 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
14689 the connection if there are too many. This option defines &"too many"&. The
14690 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
14691 client looping sending EHLO, for example. The check is applied only if the
14692 client host matches &%smtp_accept_max_nonmail_hosts%&.
14693
14694 When a new message is expected, one occurrence of RSET is not counted. This
14695 allows a client to send one RSET between messages (this is not necessary,
14696 but some clients do it). Exim also allows one uncounted occurrence of HELO
14697 or EHLO, and one occurrence of STARTTLS between messages. After
14698 starting up a TLS session, another EHLO is expected, and so it too is not
14699 counted. The first occurrence of AUTH in a connection, or immediately
14700 following STARTTLS is not counted. Otherwise, all commands other than
14701 MAIL, RCPT, DATA, and QUIT are counted.
14702
14703
14704 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
14705 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
14706 check by setting this option. The default value makes it apply to all hosts. By
14707 changing the value, you can exclude any badly-behaved hosts that you have to
14708 live with.
14709
14710
14711 . Allow this long option name to split; give it unsplit as a fifth argument
14712 . for the automatic .oindex that is generated by .option.
14713
14714 .option "smtp_accept_max_per_ &~&~connection" main integer 1000 &&&
14715          smtp_accept_max_per_connection
14716 .cindex "SMTP" "limiting incoming message count"
14717 .cindex "limit" "messages per SMTP connection"
14718 The value of this option limits the number of MAIL commands that Exim is
14719 prepared to accept over a single SMTP connection, whether or not each command
14720 results in the transfer of a message. After the limit is reached, a 421
14721 response is given to subsequent MAIL commands. This limit is a safety
14722 precaution against a client that goes mad (incidents of this type have been
14723 seen).
14724
14725
14726 .option smtp_accept_max_per_host main string&!! unset
14727 .cindex "limit" "SMTP connections from one host"
14728 .cindex "host" "limiting SMTP connections from"
14729 This option restricts the number of simultaneous IP connections from a single
14730 host (strictly, from a single IP address) to the Exim daemon. The option is
14731 expanded, to enable different limits to be applied to different hosts by
14732 reference to &$sender_host_address$&. Once the limit is reached, additional
14733 connection attempts from the same host are rejected with error code 421. This
14734 is entirely independent of &%smtp_accept_reserve%&. The option's default value
14735 of zero imposes no limit. If this option is set greater than zero, it is
14736 required that &%smtp_accept_max%& be non-zero.
14737
14738 &*Warning*&: When setting this option you should not use any expansion
14739 constructions that take an appreciable amount of time. The expansion and test
14740 happen in the main daemon loop, in order to reject additional connections
14741 without forking additional processes (otherwise a denial-of-service attack
14742 could cause a vast number or processes to be created). While the daemon is
14743 doing this processing, it cannot accept any other incoming connections.
14744
14745
14746
14747 .option smtp_accept_queue main integer 0
14748 .cindex "SMTP" "incoming connection count"
14749 .cindex "queueing incoming messages"
14750 .cindex "message" "queueing by SMTP connection count"
14751 If the number of simultaneous incoming SMTP connections being handled via the
14752 listening daemon exceeds this value, messages received by SMTP are just placed
14753 on the queue; no delivery processes are started automatically. The count is
14754 fixed at the start of an SMTP connection. It cannot be updated in the
14755 subprocess that receives messages, and so the queueing or not queueing applies
14756 to all messages received in the same connection.
14757
14758 A value of zero implies no limit, and clearly any non-zero value is useful only
14759 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
14760 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
14761 various &%-od%&&'x'& command line options.
14762
14763
14764 . Allow this long option name to split; give it unsplit as a fifth argument
14765 . for the automatic .oindex that is generated by .option.
14766
14767 .option "smtp_accept_queue_per_ &~&~connection" main integer 10 &&&
14768          smtp_accept_queue_per_connection
14769 .cindex "queueing incoming messages"
14770 .cindex "message" "queueing by message count"
14771 This option limits the number of delivery processes that Exim starts
14772 automatically when receiving messages via SMTP, whether via the daemon or by
14773 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
14774 and the number of messages received in a single SMTP session exceeds this
14775 number, subsequent messages are placed on the queue, but no delivery processes
14776 are started. This helps to limit the number of Exim processes when a server
14777 restarts after downtime and there is a lot of mail waiting for it on other
14778 systems. On large systems, the default should probably be increased, and on
14779 dial-in client systems it should probably be set to zero (that is, disabled).
14780
14781
14782 .option smtp_accept_reserve main integer 0
14783 .cindex "SMTP" "incoming call count"
14784 .cindex "host" "reserved"
14785 When &%smtp_accept_max%& is set greater than zero, this option specifies a
14786 number of SMTP connections that are reserved for connections from the hosts
14787 that are specified in &%smtp_reserve_hosts%&. The value set in
14788 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
14789 restricted to this number of connections; the option specifies a minimum number
14790 of connection slots for them, not a maximum. It is a guarantee that this group
14791 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
14792 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
14793 individual host.
14794
14795 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
14796 set to 5, once there are 45 active connections (from any hosts), new
14797 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
14798 provided the other criteria for acceptance are met.
14799
14800
14801 .option smtp_active_hostname main string&!! unset
14802 .cindex "host" "name in SMTP responses"
14803 .cindex "SMTP" "host name in responses"
14804 .vindex "&$primary_hostname$&"
14805 This option is provided for multi-homed servers that want to masquerade as
14806 several different hosts. At the start of an incoming SMTP connection, its value
14807 is expanded and used instead of the value of &$primary_hostname$& in SMTP
14808 responses. For example, it is used as domain name in the response to an
14809 incoming HELO or EHLO command.
14810
14811 .vindex "&$smtp_active_hostname$&"
14812 The active hostname is placed in the &$smtp_active_hostname$& variable, which
14813 is saved with any messages that are received. It is therefore available for use
14814 in routers and transports when the message is later delivered.
14815
14816 If this option is unset, or if its expansion is forced to fail, or if the
14817 expansion results in an empty string, the value of &$primary_hostname$& is
14818 used. Other expansion failures cause a message to be written to the main and
14819 panic logs, and the SMTP command receives a temporary error. Typically, the
14820 value of &%smtp_active_hostname%& depends on the incoming interface address.
14821 For example:
14822 .code
14823 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
14824   {cox.mydomain}{box.mydomain}}
14825 .endd
14826
14827 Although &$smtp_active_hostname$& is primarily concerned with incoming
14828 messages, it is also used as the default for HELO commands in callout
14829 verification if there is no remote transport from which to obtain a
14830 &%helo_data%& value.
14831
14832 .option smtp_banner main string&!! "see below"
14833 .cindex "SMTP" "welcome banner"
14834 .cindex "banner for SMTP"
14835 .cindex "welcome banner for SMTP"
14836 .cindex "customizing" "SMTP banner"
14837 This string, which is expanded every time it is used, is output as the initial
14838 positive response to an SMTP connection. The default setting is:
14839 .code
14840 smtp_banner = $smtp_active_hostname ESMTP Exim \
14841   $version_number $tod_full
14842 .endd
14843 Failure to expand the string causes a panic error. If you want to create a
14844 multiline response to the initial SMTP connection, use &"\n"& in the string at
14845 appropriate points, but not at the end. Note that the 220 code is not included
14846 in this string. Exim adds it automatically (several times in the case of a
14847 multiline response).
14848
14849
14850 .option smtp_check_spool_space main boolean true
14851 .cindex "checking disk space"
14852 .cindex "disk space, checking"
14853 .cindex "spool directory" "checking space"
14854 When this option is set, if an incoming SMTP session encounters the SIZE
14855 option on a MAIL command, it checks that there is enough space in the
14856 spool directory's partition to accept a message of that size, while still
14857 leaving free the amount specified by &%check_spool_space%& (even if that value
14858 is zero). If there isn't enough space, a temporary error code is returned.
14859
14860
14861 .option smtp_connect_backlog main integer 20
14862 .cindex "connection backlog"
14863 .cindex "SMTP" "connection backlog"
14864 .cindex "backlog of connections"
14865 This option specifies a maximum number of waiting SMTP connections. Exim passes
14866 this value to the TCP/IP system when it sets up its listener. Once this number
14867 of connections are waiting for the daemon's attention, subsequent connection
14868 attempts are refused at the TCP/IP level. At least, that is what the manuals
14869 say; in some circumstances such connection attempts have been observed to time
14870 out instead. For large systems it is probably a good idea to increase the
14871 value (to 50, say). It also gives some protection against denial-of-service
14872 attacks by SYN flooding.
14873
14874
14875 .option smtp_enforce_sync main boolean true
14876 .cindex "SMTP" "synchronization checking"
14877 .cindex "synchronization checking in SMTP"
14878 The SMTP protocol specification requires the client to wait for a response from
14879 the server at certain points in the dialogue. Without PIPELINING these
14880 synchronization points are after every command; with PIPELINING they are
14881 fewer, but they still exist.
14882
14883 Some spamming sites send out a complete set of SMTP commands without waiting
14884 for any response. Exim protects against this by rejecting a message if the
14885 client has sent further input when it should not have. The error response &"554
14886 SMTP synchronization error"& is sent, and the connection is dropped. Testing
14887 for this error cannot be perfect because of transmission delays (unexpected
14888 input may be on its way but not yet received when Exim checks). However, it
14889 does detect many instances.
14890
14891 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
14892 If you want to disable the check selectively (for example, only for certain
14893 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
14894 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
14895
14896
14897
14898 .option smtp_etrn_command main string&!! unset
14899 .cindex "ETRN" "command to be run"
14900 .vindex "&$domain$&"
14901 If this option is set, the given command is run whenever an SMTP ETRN
14902 command is received from a host that is permitted to issue such commands (see
14903 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
14904 are independently expanded. The expansion variable &$domain$& is set to the
14905 argument of the ETRN command, and no syntax checking is done on it. For
14906 example:
14907 .code
14908 smtp_etrn_command = /etc/etrn_command $domain \
14909                     $sender_host_address
14910 .endd
14911 A new process is created to run the command, but Exim does not wait for it to
14912 complete. Consequently, its status cannot be checked. If the command cannot be
14913 run, a line is written to the panic log, but the ETRN caller still receives
14914 a 250 success response. Exim is normally running under its own uid when
14915 receiving SMTP, so it is not possible for it to change the uid before running
14916 the command.
14917
14918
14919 .option smtp_etrn_serialize main boolean true
14920 .cindex "ETRN" "serializing"
14921 When this option is set, it prevents the simultaneous execution of more than
14922 one identical command as a result of ETRN in an SMTP connection. See
14923 section &<<SECTETRN>>& for details.
14924
14925
14926 .option smtp_load_reserve main fixed-point unset
14927 .cindex "load average"
14928 If the system load average ever gets higher than this, incoming SMTP calls are
14929 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
14930 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
14931 the load is over the limit. The option has no effect on ancient operating
14932 systems on which Exim cannot determine the load average. See also
14933 &%deliver_queue_load_max%& and &%queue_only_load%&.
14934
14935
14936
14937 .option smtp_max_synprot_errors main integer 3
14938 .cindex "SMTP" "limiting syntax and protocol errors"
14939 .cindex "limit" "SMTP syntax and protocol errors"
14940 Exim rejects SMTP commands that contain syntax or protocol errors. In
14941 particular, a syntactically invalid email address, as in this command:
14942 .code
14943 RCPT TO:<abc xyz@a.b.c>
14944 .endd
14945 causes immediate rejection of the command, before any other tests are done.
14946 (The ACL cannot be run if there is no valid address to set up for it.) An
14947 example of a protocol error is receiving RCPT before MAIL. If there are
14948 too many syntax or protocol errors in one SMTP session, the connection is
14949 dropped. The limit is set by this option.
14950
14951 .cindex "PIPELINING" "expected errors"
14952 When the PIPELINING extension to SMTP is in use, some protocol errors are
14953 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
14954 Exim assumes that PIPELINING will be used if it advertises it (see
14955 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
14956 not count towards the limit.
14957
14958
14959
14960 .option smtp_max_unknown_commands main integer 3
14961 .cindex "SMTP" "limiting unknown commands"
14962 .cindex "limit" "unknown SMTP commands"
14963 If there are too many unrecognized commands in an incoming SMTP session, an
14964 Exim server drops the connection. This is a defence against some kinds of abuse
14965 that subvert web
14966 clients
14967 into making connections to SMTP ports; in these circumstances, a number of
14968 non-SMTP command lines are sent first.
14969
14970
14971
14972 .option smtp_ratelimit_hosts main "host list&!!" unset
14973 .cindex "SMTP" "rate limiting"
14974 .cindex "limit" "rate of message arrival"
14975 .cindex "RCPT" "rate limiting"
14976 Some sites find it helpful to be able to limit the rate at which certain hosts
14977 can send them messages, and the rate at which an individual message can specify
14978 recipients.
14979
14980 Exim has two rate-limiting facilities. This section describes the older
14981 facility, which can limit rates within a single connection. The newer
14982 &%ratelimit%& ACL condition can limit rates across all connections. See section
14983 &<<SECTratelimiting>>& for details of the newer facility.
14984
14985 When a host matches &%smtp_ratelimit_hosts%&, the values of
14986 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
14987 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
14988 respectively. Each option, if set, must contain a set of four comma-separated
14989 values:
14990
14991 .ilist
14992 A threshold, before which there is no rate limiting.
14993 .next
14994 An initial time delay. Unlike other times in Exim, numbers with decimal
14995 fractional parts are allowed here.
14996 .next
14997 A factor by which to increase the delay each time.
14998 .next
14999 A maximum value for the delay. This should normally be less than 5 minutes,
15000 because after that time, the client is liable to timeout the SMTP command.
15001 .endlist
15002
15003 For example, these settings have been used successfully at the site which
15004 first suggested this feature, for controlling mail from their customers:
15005 .code
15006 smtp_ratelimit_mail = 2,0.5s,1.05,4m
15007 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
15008 .endd
15009 The first setting specifies delays that are applied to MAIL commands after
15010 two have been received over a single connection. The initial delay is 0.5
15011 seconds, increasing by a factor of 1.05 each time. The second setting applies
15012 delays to RCPT commands when more than four occur in a single message.
15013
15014
15015 .option smtp_ratelimit_mail main string unset
15016 See &%smtp_ratelimit_hosts%& above.
15017
15018
15019 .option smtp_ratelimit_rcpt main string unset
15020 See &%smtp_ratelimit_hosts%& above.
15021
15022
15023 .option smtp_receive_timeout main time 5m
15024 .cindex "timeout" "for SMTP input"
15025 .cindex "SMTP" "input timeout"
15026 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
15027 input, including batch SMTP. If a line of input (either an SMTP command or a
15028 data line) is not received within this time, the SMTP connection is dropped and
15029 the message is abandoned.
15030 A line is written to the log containing one of the following messages:
15031 .code
15032 SMTP command timeout on connection from...
15033 SMTP data timeout on connection from...
15034 .endd
15035 The former means that Exim was expecting to read an SMTP command; the latter
15036 means that it was in the DATA phase, reading the contents of a message.
15037
15038
15039 .oindex "&%-os%&"
15040 The value set by this option can be overridden by the
15041 &%-os%& command-line option. A setting of zero time disables the timeout, but
15042 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
15043 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
15044 timeout is controlled by &%receive_timeout%& and &%-or%&.
15045
15046
15047 .option smtp_reserve_hosts main "host list&!!" unset
15048 This option defines hosts for which SMTP connections are reserved; see
15049 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
15050
15051
15052 .option smtp_return_error_details main boolean false
15053 .cindex "SMTP" "details policy failures"
15054 .cindex "policy control" "rejection, returning details"
15055 In the default state, Exim uses bland messages such as
15056 &"Administrative prohibition"& when it rejects SMTP commands for policy
15057 reasons. Many sysadmins like this because it gives away little information
15058 to spammers. However, some other sysadmins who are applying strict checking
15059 policies want to give out much fuller information about failures. Setting
15060 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
15061 example, instead of &"Administrative prohibition"&, it might give:
15062 .code
15063 550-Rejected after DATA: '>' missing at end of address:
15064 550 failing address in "From" header is: <user@dom.ain
15065 .endd
15066
15067 .option spamd_address main string "see below"
15068 This option is available when Exim is compiled with the content-scanning
15069 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
15070 The default value is
15071 .code
15072 127.0.0.1 783
15073 .endd
15074 See section &<<SECTscanspamass>>& for more details.
15075
15076
15077
15078 .option split_spool_directory main boolean false
15079 .cindex "multiple spool directories"
15080 .cindex "spool directory" "split"
15081 .cindex "directories, multiple"
15082 If this option is set, it causes Exim to split its input directory into 62
15083 subdirectories, each with a single alphanumeric character as its name. The
15084 sixth character of the message id is used to allocate messages to
15085 subdirectories; this is the least significant base-62 digit of the time of
15086 arrival of the message.
15087
15088 Splitting up the spool in this way may provide better performance on systems
15089 where there are long mail queues, by reducing the number of files in any one
15090 directory. The msglog directory is also split up in a similar way to the input
15091 directory; however, if &%preserve_message_logs%& is set, all old msglog files
15092 are still placed in the single directory &_msglog.OLD_&.
15093
15094 It is not necessary to take any special action for existing messages when
15095 changing &%split_spool_directory%&. Exim notices messages that are in the
15096 &"wrong"& place, and continues to process them. If the option is turned off
15097 after a period of being on, the subdirectories will eventually empty and be
15098 automatically deleted.
15099
15100 When &%split_spool_directory%& is set, the behaviour of queue runner processes
15101 changes. Instead of creating a list of all messages in the queue, and then
15102 trying to deliver each one in turn, it constructs a list of those in one
15103 sub-directory and tries to deliver them, before moving on to the next
15104 sub-directory. The sub-directories are processed in a random order. This
15105 spreads out the scanning of the input directories, and uses less memory. It is
15106 particularly beneficial when there are lots of messages on the queue. However,
15107 if &%queue_run_in_order%& is set, none of this new processing happens. The
15108 entire queue has to be scanned and sorted before any deliveries can start.
15109
15110
15111 .option spool_directory main string&!! "set at compile time"
15112 .cindex "spool directory" "path to"
15113 This defines the directory in which Exim keeps its spool, that is, the messages
15114 it is waiting to deliver. The default value is taken from the compile-time
15115 configuration setting, if there is one. If not, this option must be set. The
15116 string is expanded, so it can contain, for example, a reference to
15117 &$primary_hostname$&.
15118
15119 If the spool directory name is fixed on your installation, it is recommended
15120 that you set it at build time rather than from this option, particularly if the
15121 log files are being written to the spool directory (see &%log_file_path%&).
15122 Otherwise log files cannot be used for errors that are detected early on, such
15123 as failures in the configuration file.
15124
15125 By using this option to override the compiled-in path, it is possible to run
15126 tests of Exim without using the standard spool.
15127
15128 .option sqlite_lock_timeout main time 5s
15129 .cindex "sqlite lookup type" "lock timeout"
15130 This option controls the timeout that the &(sqlite)& lookup uses when trying to
15131 access an SQLite database. See section &<<SECTsqlite>>& for more details.
15132
15133 .option strict_acl_vars main boolean false
15134 .cindex "&ACL;" "variables, handling unset"
15135 This option controls what happens if a syntactically valid but undefined ACL
15136 variable is referenced. If it is false (the default), an empty string
15137 is substituted; if it is true, an error is generated. See section
15138 &<<SECTaclvariables>>& for details of ACL variables.
15139
15140 .option strip_excess_angle_brackets main boolean false
15141 .cindex "angle brackets, excess"
15142 If this option is set, redundant pairs of angle brackets round &"route-addr"&
15143 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
15144 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
15145 passed on to another MTA, the excess angle brackets are not passed on. If this
15146 option is not set, multiple pairs of angle brackets cause a syntax error.
15147
15148
15149 .option strip_trailing_dot main boolean false
15150 .cindex "trailing dot on domain"
15151 .cindex "dot" "trailing on domain"
15152 If this option is set, a trailing dot at the end of a domain in an address is
15153 ignored. If this is in the envelope and the message is passed on to another
15154 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
15155 domain causes a syntax error.
15156 However, addresses in header lines are checked only when an ACL requests header
15157 syntax checking.
15158
15159
15160 .option syslog_duplication main boolean true
15161 .cindex "syslog" "duplicate log lines; suppressing"
15162 When Exim is logging to syslog, it writes the log lines for its three
15163 separate logs at different syslog priorities so that they can in principle
15164 be separated on the logging hosts. Some installations do not require this
15165 separation, and in those cases, the duplication of certain log lines is a
15166 nuisance. If &%syslog_duplication%& is set false, only one copy of any
15167 particular log line is written to syslog. For lines that normally go to
15168 both the main log and the reject log, the reject log version (possibly
15169 containing message header lines) is written, at LOG_NOTICE priority.
15170 Lines that normally go to both the main and the panic log are written at
15171 the LOG_ALERT priority.
15172
15173
15174 .option syslog_facility main string unset
15175 .cindex "syslog" "facility; setting"
15176 This option sets the syslog &"facility"& name, used when Exim is logging to
15177 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
15178 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
15179 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
15180 details of Exim's logging.
15181
15182
15183
15184 .option syslog_processname main string &`exim`&
15185 .cindex "syslog" "process name; setting"
15186 This option sets the syslog &"ident"& name, used when Exim is logging to
15187 syslog. The value must be no longer than 32 characters. See chapter
15188 &<<CHAPlog>>& for details of Exim's logging.
15189
15190
15191
15192 .option syslog_timestamp main boolean true
15193 .cindex "syslog" "timestamps"
15194 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
15195 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
15196 details of Exim's logging.
15197
15198
15199 .option system_filter main string&!! unset
15200 .cindex "filter" "system filter"
15201 .cindex "system filter" "specifying"
15202 .cindex "Sieve filter" "not available for system filter"
15203 This option specifies an Exim filter file that is applied to all messages at
15204 the start of each delivery attempt, before any routing is done. System filters
15205 must be Exim filters; they cannot be Sieve filters. If the system filter
15206 generates any deliveries to files or pipes, or any new mail messages, the
15207 appropriate &%system_filter_..._transport%& option(s) must be set, to define
15208 which transports are to be used. Details of this facility are given in chapter
15209 &<<CHAPsystemfilter>>&.
15210
15211
15212 .option system_filter_directory_transport main string&!! unset
15213 .vindex "&$address_file$&"
15214 This sets the name of the transport driver that is to be used when the
15215 &%save%& command in a system message filter specifies a path ending in &"/"&,
15216 implying delivery of each message into a separate file in some directory.
15217 During the delivery, the variable &$address_file$& contains the path name.
15218
15219
15220 .option system_filter_file_transport main string&!! unset
15221 .cindex "file" "transport for system filter"
15222 This sets the name of the transport driver that is to be used when the &%save%&
15223 command in a system message filter specifies a path not ending in &"/"&. During
15224 the delivery, the variable &$address_file$& contains the path name.
15225
15226 .option system_filter_group main string unset
15227 .cindex "gid (group id)" "system filter"
15228 This option is used only when &%system_filter_user%& is also set. It sets the
15229 gid under which the system filter is run, overriding any gid that is associated
15230 with the user. The value may be numerical or symbolic.
15231
15232 .option system_filter_pipe_transport main string&!! unset
15233 .cindex "&(pipe)& transport" "for system filter"
15234 .vindex "&$address_pipe$&"
15235 This specifies the transport driver that is to be used when a &%pipe%& command
15236 is used in a system filter. During the delivery, the variable &$address_pipe$&
15237 contains the pipe command.
15238
15239
15240 .option system_filter_reply_transport main string&!! unset
15241 .cindex "&(autoreply)& transport" "for system filter"
15242 This specifies the transport driver that is to be used when a &%mail%& command
15243 is used in a system filter.
15244
15245 .new
15246 .option system_filter_user main string unset
15247 .cindex "uid (user id)" "system filter"
15248 If this option is set to root, the system filter is run in the main Exim
15249 delivery process, as root.  Otherwise, the system filter runs in a separate
15250 process, as the given user, defaulting to the Exim run-time user.
15251 Unless the string consists entirely of digits, it
15252 is looked up in the password data. Failure to find the named user causes a
15253 configuration error. The gid is either taken from the password data, or
15254 specified by &%system_filter_group%&. When the uid is specified numerically,
15255 &%system_filter_group%& is required to be set.
15256
15257 If the system filter generates any pipe, file, or reply deliveries, the uid
15258 under which the filter is run is used when transporting them, unless a
15259 transport option overrides.
15260 .wen
15261
15262
15263 .option tcp_nodelay main boolean true
15264 .cindex "daemon" "TCP_NODELAY on sockets"
15265 .cindex "Nagle algorithm"
15266 .cindex "TCP_NODELAY on listening sockets"
15267 If this option is set false, it stops the Exim daemon setting the
15268 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
15269 turns off the &"Nagle algorithm"&, which is a way of improving network
15270 performance in interactive (character-by-character) situations. Turning it off
15271 should improve Exim's performance a bit, so that is what happens by default.
15272 However, it appears that some broken clients cannot cope, and time out. Hence
15273 this option. It affects only those sockets that are set up for listening by the
15274 daemon. Sockets created by the smtp transport for delivering mail always set
15275 TCP_NODELAY.
15276
15277
15278 .option timeout_frozen_after main time 0s
15279 .cindex "frozen messages" "timing out"
15280 .cindex "timeout" "frozen messages"
15281 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
15282 message of any kind that has been on the queue for longer than the given time
15283 is automatically cancelled at the next queue run. If the frozen message is a
15284 bounce message, it is just discarded; otherwise, a bounce is sent to the
15285 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
15286 If you want to timeout frozen bounce messages earlier than other kinds of
15287 frozen message, see &%ignore_bounce_errors_after%&.
15288
15289 &*Note:*& the default value of zero means no timeouts; with this setting,
15290 frozen messages remain on the queue forever (except for any frozen bounce
15291 messages that are released by &%ignore_bounce_errors_after%&).
15292
15293
15294 .option timezone main string unset
15295 .cindex "timezone, setting"
15296 The value of &%timezone%& is used to set the environment variable TZ while
15297 running Exim (if it is different on entry). This ensures that all timestamps
15298 created by Exim are in the required timezone. If you want all your timestamps
15299 to be in UTC (aka GMT) you should set
15300 .code
15301 timezone = UTC
15302 .endd
15303 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
15304 or, if that is not set, from the value of the TZ environment variable when Exim
15305 is built. If &%timezone%& is set to the empty string, either at build or run
15306 time, any existing TZ variable is removed from the environment when Exim
15307 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
15308 unfortunately not all, operating systems.
15309
15310
15311 .option tls_advertise_hosts main "host list&!!" unset
15312 .cindex "TLS" "advertising"
15313 .cindex "encryption" "on SMTP connection"
15314 .cindex "SMTP" "encrypted connection"
15315 When Exim is built with support for TLS encrypted connections, the availability
15316 of the STARTTLS command to set up an encrypted session is advertised in
15317 response to EHLO only to those client hosts that match this option. See
15318 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
15319
15320
15321 .option tls_certificate main string&!! unset
15322 .cindex "TLS" "server certificate; location of"
15323 .cindex "certificate" "server, location of"
15324 The value of this option is expanded, and must then be the absolute path to a
15325 file which contains the server's certificates. The server's private key is also
15326 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
15327 &<<CHAPTLS>>& for further details.
15328
15329 &*Note*&: The certificates defined by this option are used only when Exim is
15330 receiving incoming messages as a server. If you want to supply certificates for
15331 use when sending messages as a client, you must set the &%tls_certificate%&
15332 option in the relevant &(smtp)& transport.
15333
15334
15335 .option tls_crl main string&!! unset
15336 .cindex "TLS" "server certificate revocation list"
15337 .cindex "certificate" "revocation list for server"
15338 This option specifies a certificate revocation list. The expanded value must
15339 be the name of a file that contains a CRL in PEM format.
15340
15341
15342 .option tls_dhparam main string&!! unset
15343 .cindex "TLS" "D-H parameters for server"
15344 The value of this option is expanded, and must then be the absolute path to
15345 a file which contains the server's DH parameter values.
15346 This is used only for OpenSSL. When Exim is linked with GnuTLS, this option is
15347 ignored. See section &<<SECTopenvsgnu>>& for further details.
15348
15349
15350 .option tls_on_connect_ports main "string list" unset
15351 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
15352 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
15353 set up without waiting for the client to issue a STARTTLS command. For
15354 further details, see section &<<SECTsupobssmt>>&.
15355
15356
15357
15358 .option tls_privatekey main string&!! unset
15359 .cindex "TLS" "server private key; location of"
15360 The value of this option is expanded, and must then be the absolute path to a
15361 file which contains the server's private key. If this option is unset, or if
15362 the expansion is forced to fail, or the result is an empty string, the private
15363 key is assumed to be in the same file as the server's certificates. See chapter
15364 &<<CHAPTLS>>& for further details.
15365
15366
15367 .option tls_remember_esmtp main boolean false
15368 .cindex "TLS" "esmtp state; remembering"
15369 .cindex "TLS" "broken clients"
15370 If this option is set true, Exim violates the RFCs by remembering that it is in
15371 &"esmtp"& state after successfully negotiating a TLS session. This provides
15372 support for broken clients that fail to send a new EHLO after starting a
15373 TLS session.
15374
15375
15376 .option tls_require_ciphers main string&!! unset
15377 .cindex "TLS" "requiring specific ciphers"
15378 .cindex "cipher" "requiring specific"
15379 This option controls which ciphers can be used for incoming TLS connections.
15380 The &(smtp)& transport has an option of the same name for controlling outgoing
15381 connections. This option is expanded for each connection, so can be varied for
15382 different clients if required. The value of this option must be a list of
15383 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
15384 in somewhat different ways. If GnuTLS is being used, the client controls the
15385 preference order of the available ciphers. Details are given in sections
15386 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
15387
15388
15389 .option tls_try_verify_hosts main "host list&!!" unset
15390 .cindex "TLS" "client certificate verification"
15391 .cindex "certificate" "verification of client"
15392 See &%tls_verify_hosts%& below.
15393
15394
15395 .option tls_verify_certificates main string&!! unset
15396 .cindex "TLS" "client certificate verification"
15397 .cindex "certificate" "verification of client"
15398 The value of this option is expanded, and must then be the absolute path to
15399 a file containing permitted certificates for clients that
15400 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&. Alternatively, if you
15401 are using OpenSSL, you can set &%tls_verify_certificates%& to the name of a
15402 directory containing certificate files. This does not work with GnuTLS; the
15403 option must be set to the name of a single file if you are using GnuTLS.
15404
15405
15406 .option tls_verify_hosts main "host list&!!" unset
15407 .cindex "TLS" "client certificate verification"
15408 .cindex "certificate" "verification of client"
15409 This option, along with &%tls_try_verify_hosts%&, controls the checking of
15410 certificates from clients. The expected certificates are defined by
15411 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
15412 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
15413 &%tls_verify_certificates%& is not set.
15414
15415 Any client that matches &%tls_verify_hosts%& is constrained by
15416 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
15417 present one of the listed certificates. If it does not, the connection is
15418 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
15419 the host to use TLS. It can still send SMTP commands through unencrypted
15420 connections. Forcing a client to use TLS has to be done separately using an
15421 ACL to reject inappropriate commands when the connection is not encrypted.
15422
15423 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
15424 matches this option (but not &%tls_verify_hosts%&), Exim requests a
15425 certificate and checks it against &%tls_verify_certificates%&, but does not
15426 abort the connection if there is no certificate or if it does not match. This
15427 state can be detected in an ACL, which makes it possible to implement policies
15428 such as &"accept for relay only if a verified certificate has been received,
15429 but accept for local delivery if encrypted, even without a verified
15430 certificate"&.
15431
15432 Client hosts that match neither of these lists are not asked to present
15433 certificates.
15434
15435
15436 .option trusted_groups main "string list&!!" unset
15437 .cindex "trusted groups"
15438 .cindex "groups" "trusted"
15439 This option is expanded just once, at the start of Exim's processing. If this
15440 option is set, any process that is running in one of the listed groups, or
15441 which has one of them as a supplementary group, is trusted. The groups can be
15442 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
15443 details of what trusted callers are permitted to do. If neither
15444 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
15445 are trusted.
15446
15447 .option trusted_users main "string list&!!" unset
15448 .cindex "trusted users"
15449 .cindex "user" "trusted"
15450 This option is expanded just once, at the start of Exim's processing. If this
15451 option is set, any process that is running as one of the listed users is
15452 trusted. The users can be specified numerically or by name. See section
15453 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
15454 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
15455 Exim user are trusted.
15456
15457 .option unknown_login main string&!! unset
15458 .cindex "uid (user id)" "unknown caller"
15459 .vindex "&$caller_uid$&"
15460 This is a specialized feature for use in unusual configurations. By default, if
15461 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
15462 gives up. The &%unknown_login%& option can be used to set a login name to be
15463 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
15464 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
15465 is used for the user's real name (gecos field), unless this has been set by the
15466 &%-F%& option.
15467
15468 .option unknown_username main string unset
15469 See &%unknown_login%&.
15470
15471 .option untrusted_set_sender main "address list&!!" unset
15472 .cindex "trusted users"
15473 .cindex "sender" "setting by untrusted user"
15474 .cindex "untrusted user setting sender"
15475 .cindex "user" "untrusted setting sender"
15476 .cindex "envelope sender"
15477 When an untrusted user submits a message to Exim using the standard input, Exim
15478 normally creates an envelope sender address from the user's login and the
15479 default qualification domain. Data from the &%-f%& option (for setting envelope
15480 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
15481 is used) is ignored.
15482
15483 However, untrusted users are permitted to set an empty envelope sender address,
15484 to declare that a message should never generate any bounces. For example:
15485 .code
15486 exim -f '<>' user@domain.example
15487 .endd
15488 .vindex "&$sender_ident$&"
15489 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
15490 other envelope sender addresses in a controlled way. When it is set, untrusted
15491 users are allowed to set envelope sender addresses that match any of the
15492 patterns in the list. Like all address lists, the string is expanded. The
15493 identity of the user is in &$sender_ident$&, so you can, for example, restrict
15494 users to setting senders that start with their login ids
15495 followed by a hyphen
15496 by a setting like this:
15497 .code
15498 untrusted_set_sender = ^$sender_ident-
15499 .endd
15500 If you want to allow untrusted users to set envelope sender addresses without
15501 restriction, you can use
15502 .code
15503 untrusted_set_sender = *
15504 .endd
15505 The &%untrusted_set_sender%& option applies to all forms of local input, but
15506 only to the setting of the envelope sender. It does not permit untrusted users
15507 to use the other options which trusted user can use to override message
15508 parameters. Furthermore, it does not stop Exim from removing an existing
15509 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
15510 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
15511 overriding these actions. The handling of the &'Sender:'& header is also
15512 described in section &<<SECTthesenhea>>&.
15513
15514 The log line for a message's arrival shows the envelope sender following
15515 &"<="&. For local messages, the user's login always follows, after &"U="&. In
15516 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
15517 envelope sender address, the user's login is shown in parentheses after the
15518 sender address.
15519
15520
15521 .option uucp_from_pattern main string "see below"
15522 .cindex "&""From""& line"
15523 .cindex "UUCP" "&""From""& line"
15524 Some applications that pass messages to an MTA via a command line interface use
15525 an initial line starting with &"From&~"& to pass the envelope sender. In
15526 particular, this is used by UUCP software. Exim recognizes such a line by means
15527 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
15528 matches, the sender address is constructed by expanding the contents of
15529 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
15530 default pattern recognizes lines in the following two forms:
15531 .code
15532 From ph10 Fri Jan  5 12:35 GMT 1996
15533 From ph10 Fri, 7 Jan 97 14:00:00 GMT
15534 .endd
15535 The pattern can be seen by running
15536 .code
15537 exim -bP uucp_from_pattern
15538 .endd
15539 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
15540 year in the second case. The first word after &"From&~"& is matched in the
15541 regular expression by a parenthesized subpattern. The default value for
15542 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
15543 (&"ph10"& in the example above) as the message's sender. See also
15544 &%ignore_fromline_hosts%&.
15545
15546
15547 .option uucp_from_sender main string&!! &`$1`&
15548 See &%uucp_from_pattern%& above.
15549
15550
15551 .option warn_message_file main string unset
15552 .cindex "warning of delay" "customizing the message"
15553 .cindex "customizing" "warning message"
15554 This option defines a template file containing paragraphs of text to be used
15555 for constructing the warning message which is sent by Exim when a message has
15556 been on the queue for a specified amount of time, as specified by
15557 &%delay_warning%&. Details of the file's contents are given in chapter
15558 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
15559
15560
15561 .option write_rejectlog main boolean true
15562 .cindex "reject log" "disabling"
15563 If this option is set false, Exim no longer writes anything to the reject log.
15564 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
15565 .ecindex IIDconfima
15566 .ecindex IIDmaiconf
15567
15568
15569
15570
15571 . ////////////////////////////////////////////////////////////////////////////
15572 . ////////////////////////////////////////////////////////////////////////////
15573
15574 .chapter "Generic options for routers" "CHAProutergeneric"
15575 .scindex IIDgenoprou1 "options" "generic; for routers"
15576 .scindex IIDgenoprou2 "generic options" "router"
15577 This chapter describes the generic options that apply to all routers.
15578 Those that are preconditions are marked with &Dagger; in the &"use"& field.
15579
15580 For a general description of how a router operates, see sections
15581 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
15582 which the preconditions are tested. The order of expansion of the options that
15583 provide data for a transport is: &%errors_to%&, &%headers_add%&,
15584 &%headers_remove%&, &%transport%&.
15585
15586
15587
15588 .option address_data routers string&!! unset
15589 .cindex "router" "data attached to address"
15590 The string is expanded just before the router is run, that is, after all the
15591 precondition tests have succeeded. If the expansion is forced to fail, the
15592 router declines, the value of &%address_data%& remains unchanged, and the
15593 &%more%& option controls what happens next. Other expansion failures cause
15594 delivery of the address to be deferred.
15595
15596 .vindex "&$address_data$&"
15597 When the expansion succeeds, the value is retained with the address, and can be
15598 accessed using the variable &$address_data$& in the current router, subsequent
15599 routers, and the eventual transport.
15600
15601 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
15602 that runs a user's filter file, the contents of &$address_data$& are accessible
15603 in the filter. This is not normally a problem, because such data is usually
15604 either not confidential or it &"belongs"& to the current user, but if you do
15605 put confidential data into &$address_data$& you need to remember this point.
15606
15607 Even if the router declines or passes, the value of &$address_data$& remains
15608 with the address, though it can be changed by another &%address_data%& setting
15609 on a subsequent router. If a router generates child addresses, the value of
15610 &$address_data$& propagates to them. This also applies to the special kind of
15611 &"child"& that is generated by a router with the &%unseen%& option.
15612
15613 The idea of &%address_data%& is that you can use it to look up a lot of data
15614 for the address once, and then pick out parts of the data later. For example,
15615 you could use a single LDAP lookup to return a string of the form
15616 .code
15617 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
15618 .endd
15619 In the transport you could pick out the mailbox by a setting such as
15620 .code
15621 file = ${extract{mailbox}{$address_data}}
15622 .endd
15623 This makes the configuration file less messy, and also reduces the number of
15624 lookups (though Exim does cache lookups).
15625
15626 .vindex "&$sender_address_data$&"
15627 .vindex "&$address_data$&"
15628 The &%address_data%& facility is also useful as a means of passing information
15629 from one router to another, and from a router to a transport. In addition, if
15630 &$address_data$& is set by a router when verifying a recipient address from an
15631 ACL, it remains available for use in the rest of the ACL statement. After
15632 verifying a sender, the value is transferred to &$sender_address_data$&.
15633
15634
15635
15636 .option address_test routers&!? boolean true
15637 .oindex "&%-bt%&"
15638 .cindex "router" "skipping when address testing"
15639 If this option is set false, the router is skipped when routing is being tested
15640 by means of the &%-bt%& command line option. This can be a convenience when
15641 your first router sends messages to an external scanner, because it saves you
15642 having to set the &"already scanned"& indicator when testing real address
15643 routing.
15644
15645
15646
15647 .option cannot_route_message routers string&!! unset
15648 .cindex "router" "customizing &""cannot route""& message"
15649 .cindex "customizing" "&""cannot route""& message"
15650 This option specifies a text message that is used when an address cannot be
15651 routed because Exim has run out of routers. The default message is
15652 &"Unrouteable address"&. This option is useful only on routers that have
15653 &%more%& set false, or on the very last router in a configuration, because the
15654 value that is used is taken from the last router that is considered. This
15655 includes a router that is skipped because its preconditions are not met, as
15656 well as a router that declines. For example, using the default configuration,
15657 you could put:
15658 .code
15659 cannot_route_message = Remote domain not found in DNS
15660 .endd
15661 on the first router, which is a &(dnslookup)& router with &%more%& set false,
15662 and
15663 .code
15664 cannot_route_message = Unknown local user
15665 .endd
15666 on the final router that checks for local users. If string expansion fails for
15667 this option, the default message is used. Unless the expansion failure was
15668 explicitly forced, a message about the failure is written to the main and panic
15669 logs, in addition to the normal message about the routing failure.
15670
15671
15672 .option caseful_local_part routers boolean false
15673 .cindex "case of local parts"
15674 .cindex "router" "case of local parts"
15675 By default, routers handle the local parts of addresses in a case-insensitive
15676 manner, though the actual case is preserved for transmission with the message.
15677 If you want the case of letters to be significant in a router, you must set
15678 this option true. For individual router options that contain address or local
15679 part lists (for example, &%local_parts%&), case-sensitive matching can be
15680 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
15681 more details.
15682
15683 .vindex "&$local_part$&"
15684 .vindex "&$original_local_part$&"
15685 .vindex "&$parent_local_part$&"
15686 The value of the &$local_part$& variable is forced to lower case while a
15687 router is running unless &%caseful_local_part%& is set. When a router assigns
15688 an address to a transport, the value of &$local_part$& when the transport runs
15689 is the same as it was in the router. Similarly, when a router generates child
15690 addresses by aliasing or forwarding, the values of &$original_local_part$&
15691 and &$parent_local_part$& are those that were used by the redirecting router.
15692
15693 This option applies to the processing of an address by a router. When a
15694 recipient address is being processed in an ACL, there is a separate &%control%&
15695 modifier that can be used to specify case-sensitive processing within the ACL
15696 (see section &<<SECTcontrols>>&).
15697
15698
15699
15700 .option check_local_user routers&!? boolean false
15701 .cindex "local user, checking in router"
15702 .cindex "router" "checking for local user"
15703 .cindex "&_/etc/passwd_&"
15704 .vindex "&$home$&"
15705 When this option is true, Exim checks that the local part of the recipient
15706 address (with affixes removed if relevant) is the name of an account on the
15707 local system. The check is done by calling the &[getpwnam()]& function rather
15708 than trying to read &_/etc/passwd_& directly. This means that other methods of
15709 holding password data (such as NIS) are supported. If the local part is a local
15710 user, &$home$& is set from the password data, and can be tested in other
15711 preconditions that are evaluated after this one (the order of evaluation is
15712 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
15713 overridden by &%router_home_directory%&. If the local part is not a local user,
15714 the router is skipped.
15715
15716 If you want to check that the local part is either the name of a local user
15717 or matches something else, you cannot combine &%check_local_user%& with a
15718 setting of &%local_parts%&, because that specifies the logical &'and'& of the
15719 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
15720 setting to achieve this. For example:
15721 .code
15722 local_parts = passwd;$local_part : lsearch;/etc/other/users
15723 .endd
15724 Note, however, that the side effects of &%check_local_user%& (such as setting
15725 up a home directory) do not occur when a &(passwd)& lookup is used in a
15726 &%local_parts%& (or any other) precondition.
15727
15728
15729
15730 .option condition routers&!? string&!! unset
15731 .cindex "router" "customized precondition"
15732 This option specifies a general precondition test that has to succeed for the
15733 router to be called. The &%condition%& option is the last precondition to be
15734 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
15735 result is a forced failure, or an empty string, or one of the strings &"0"& or
15736 &"no"& or &"false"& (checked without regard to the case of the letters), the
15737 router is skipped, and the address is offered to the next one.
15738
15739 If the result is any other value, the router is run (as this is the last
15740 precondition to be evaluated, all the other preconditions must be true).
15741
15742 .new
15743 This option is unique in that multiple &%condition%& options may be present.
15744 All &%condition%& options must succeed.
15745 .wen
15746
15747 The &%condition%& option provides a means of applying custom conditions to the
15748 running of routers. Note that in the case of a simple conditional expansion,
15749 the default expansion values are exactly what is wanted. For example:
15750 .code
15751 condition = ${if >{$message_age}{600}}
15752 .endd
15753 Because of the default behaviour of the string expansion, this is equivalent to
15754 .code
15755 condition = ${if >{$message_age}{600}{true}{}}
15756 .endd
15757 .new
15758 A multiple condition example, which succeeds:
15759 .code
15760 condition = ${if >{$message_age}{600}}
15761 condition = ${if !eq{${lc:$local_part}}{postmaster}}
15762 condition = foobar
15763 .endd
15764 .wen
15765 If the expansion fails (other than forced failure) delivery is deferred. Some
15766 of the other precondition options are common special cases that could in fact
15767 be specified using &%condition%&.
15768
15769
15770
15771 .option debug_print routers string&!! unset
15772 .cindex "testing" "variables in drivers"
15773 If this option is set and debugging is enabled (see the &%-d%& command line
15774 option), the string is expanded and included in the debugging output.
15775 If expansion of the string fails, the error message is written to the debugging
15776 output, and Exim carries on processing.
15777 This option is provided to help with checking out the values of variables and
15778 so on when debugging router configurations. For example, if a &%condition%&
15779 option appears not to be working, &%debug_print%& can be used to output the
15780 variables it references. The output happens after checks for &%domains%&,
15781 &%local_parts%&, and &%check_local_user%& but before any other preconditions
15782 are tested. A newline is added to the text if it does not end with one.
15783
15784
15785
15786 .option disable_logging routers boolean false
15787 If this option is set true, nothing is logged for any routing errors
15788 or for any deliveries caused by this router. You should not set this option
15789 unless you really, really know what you are doing. See also the generic
15790 transport option of the same name.
15791
15792
15793 .option domains routers&!? "domain list&!!" unset
15794 .cindex "router" "restricting to specific domains"
15795 .vindex "&$domain_data$&"
15796 If this option is set, the router is skipped unless the current domain matches
15797 the list. If the match is achieved by means of a file lookup, the data that the
15798 lookup returned for the domain is placed in &$domain_data$& for use in string
15799 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
15800 a list of the order in which preconditions are evaluated.
15801
15802
15803
15804 .option driver routers string unset
15805 This option must always be set. It specifies which of the available routers is
15806 to be used.
15807
15808
15809
15810 .option errors_to routers string&!! unset
15811 .cindex "envelope sender"
15812 .cindex "router" "changing address for errors"
15813 If a router successfully handles an address, it may assign the address to a
15814 transport for delivery or it may generate child addresses. In both cases, if
15815 there is a delivery problem during later processing, the resulting bounce
15816 message is sent to the address that results from expanding this string,
15817 provided that the address verifies successfully. The &%errors_to%& option is
15818 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
15819
15820 The &%errors_to%& setting associated with an address can be overridden if it
15821 subsequently passes through other routers that have their own &%errors_to%&
15822 settings, or if the message is delivered by a transport with a &%return_path%&
15823 setting.
15824
15825 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
15826 the expansion fails to verify, the errors address associated with the incoming
15827 address is used. At top level, this is the envelope sender. A non-forced
15828 expansion failure causes delivery to be deferred.
15829
15830 If an address for which &%errors_to%& has been set ends up being delivered over
15831 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
15832 any bounces that are generated by other MTAs on the delivery route are also
15833 sent there. You can set &%errors_to%& to the empty string by either of these
15834 settings:
15835 .code
15836 errors_to =
15837 errors_to = ""
15838 .endd
15839 An expansion item that yields an empty string has the same effect. If you do
15840 this, a locally detected delivery error for addresses processed by this router
15841 no longer gives rise to a bounce message; the error is discarded. If the
15842 address is delivered to a remote host, the return path is set to &`<>`&, unless
15843 overridden by the &%return_path%& option on the transport.
15844
15845 .vindex "&$address_data$&"
15846 If for some reason you want to discard local errors, but use a non-empty
15847 MAIL command for remote delivery, you can preserve the original return
15848 path in &$address_data$& in the router, and reinstate it in the transport by
15849 setting &%return_path%&.
15850
15851 The most common use of &%errors_to%& is to direct mailing list bounces to the
15852 manager of the list, as described in section &<<SECTmailinglists>>&, or to
15853 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
15854
15855
15856
15857 .option expn routers&!? boolean true
15858 .cindex "address" "testing"
15859 .cindex "testing" "addresses"
15860 .cindex "EXPN" "router skipping"
15861 .cindex "router" "skipping for EXPN"
15862 If this option is turned off, the router is skipped when testing an address
15863 as a result of processing an SMTP EXPN command. You might, for example,
15864 want to turn it off on a router for users' &_.forward_& files, while leaving it
15865 on for the system alias file.
15866 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
15867 are evaluated.
15868
15869 The use of the SMTP EXPN command is controlled by an ACL (see chapter
15870 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
15871 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
15872
15873
15874
15875 .option fail_verify routers boolean false
15876 .cindex "router" "forcing verification failure"
15877 Setting this option has the effect of setting both &%fail_verify_sender%& and
15878 &%fail_verify_recipient%& to the same value.
15879
15880
15881
15882 .option fail_verify_recipient routers boolean false
15883 If this option is true and an address is accepted by this router when
15884 verifying a recipient, verification fails.
15885
15886
15887
15888 .option fail_verify_sender routers boolean false
15889 If this option is true and an address is accepted by this router when
15890 verifying a sender, verification fails.
15891
15892
15893
15894 .option fallback_hosts routers "string list" unset
15895 .cindex "router" "fallback hosts"
15896 .cindex "fallback" "hosts specified on router"
15897 String expansion is not applied to this option. The argument must be a
15898 colon-separated list of host names or IP addresses. The list separator can be
15899 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
15900 each name or address. In fact, the format of each item is exactly the same as
15901 defined for the list of hosts in a &(manualroute)& router (see section
15902 &<<SECTformatonehostitem>>&).
15903
15904 If a router queues an address for a remote transport, this host list is
15905 associated with the address, and used instead of the transport's fallback host
15906 list. If &%hosts_randomize%& is set on the transport, the order of the list is
15907 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
15908 transport for further details.
15909
15910
15911 .option group routers string&!! "see below"
15912 .cindex "gid (group id)" "local delivery"
15913 .cindex "local transports" "uid and gid"
15914 .cindex "transport" "local"
15915 .cindex "router" "setting group"
15916 When a router queues an address for a transport, and the transport does not
15917 specify a group, the group given here is used when running the delivery
15918 process.
15919 The group may be specified numerically or by name. If expansion fails, the
15920 error is logged and delivery is deferred.
15921 The default is unset, unless &%check_local_user%& is set, when the default
15922 is taken from the password information. See also &%initgroups%& and &%user%&
15923 and the discussion in chapter &<<CHAPenvironment>>&.
15924
15925
15926
15927 .option headers_add routers string&!! unset
15928 .cindex "header lines" "adding"
15929 .cindex "router" "adding header lines"
15930 This option specifies a string of text that is expanded at routing time, and
15931 associated with any addresses that are accepted by the router. However, this
15932 option has no effect when an address is just being verified. The way in which
15933 the text is used to add header lines at transport time is described in section
15934 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
15935 message is in the process of being transported. This means that references to
15936 header lines in string expansions in the transport's configuration do not
15937 &"see"& the added header lines.
15938
15939 The &%headers_add%& option is expanded after &%errors_to%&, but before
15940 &%headers_remove%& and &%transport%&. If the expanded string is empty, or if
15941 the expansion is forced to fail, the option has no effect. Other expansion
15942 failures are treated as configuration errors.
15943
15944 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
15945 router that has the &%one_time%& option set.
15946
15947 .cindex "duplicate addresses"
15948 .oindex "&%unseen%&"
15949 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
15950 additions are deleted when the address is passed on to subsequent routers.
15951 For a &%redirect%& router, if a generated address is the same as the incoming
15952 address, this can lead to duplicate addresses with different header
15953 modifications. Exim does not do duplicate deliveries (except, in certain
15954 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
15955 which of the duplicates is discarded, so this ambiguous situation should be
15956 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
15957
15958
15959
15960 .option headers_remove routers string&!! unset
15961 .cindex "header lines" "removing"
15962 .cindex "router" "removing header lines"
15963 This option specifies a string of text that is expanded at routing time, and
15964 associated with any addresses that are accepted by the router. However, this
15965 option has no effect when an address is just being verified. The way in which
15966 the text is used to remove header lines at transport time is described in
15967 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
15968 the message is in the process of being transported. This means that references
15969 to header lines in string expansions in the transport's configuration still
15970 &"see"& the original header lines.
15971
15972 The &%headers_remove%& option is expanded after &%errors_to%& and
15973 &%headers_add%&, but before &%transport%&. If the expansion is forced to fail,
15974 the option has no effect. Other expansion failures are treated as configuration
15975 errors.
15976
15977 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
15978 router that has the &%one_time%& option set.
15979
15980 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
15981 removal requests are deleted when the address is passed on to subsequent
15982 routers, and this can lead to problems with duplicates -- see the similar
15983 warning for &%headers_add%& above.
15984
15985
15986 .option ignore_target_hosts routers "host list&!!" unset
15987 .cindex "IP address" "discarding"
15988 .cindex "router" "discarding IP addresses"
15989 Although this option is a host list, it should normally contain IP address
15990 entries rather than names. If any host that is looked up by the router has an
15991 IP address that matches an item in this list, Exim behaves as if that IP
15992 address did not exist. This option allows you to cope with rogue DNS entries
15993 like
15994 .code
15995 remote.domain.example.  A  127.0.0.1
15996 .endd
15997 by setting
15998 .code
15999 ignore_target_hosts = 127.0.0.1
16000 .endd
16001 on the relevant router. If all the hosts found by a &(dnslookup)& router are
16002 discarded in this way, the router declines. In a conventional configuration, an
16003 attempt to mail to such a domain would normally provoke the &"unrouteable
16004 domain"& error, and an attempt to verify an address in the domain would fail.
16005 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
16006 router declines if presented with one of the listed addresses.
16007
16008 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
16009 means of the first or the second of the following settings, respectively:
16010 .code
16011 ignore_target_hosts = 0.0.0.0/0
16012 ignore_target_hosts = <; 0::0/0
16013 .endd
16014 The pattern in the first line matches all IPv4 addresses, whereas the pattern
16015 in the second line matches all IPv6 addresses.
16016
16017 This option may also be useful for ignoring link-local and site-local IPv6
16018 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
16019 is expanded before use as a list, it is possible to make it dependent on the
16020 domain that is being routed.
16021
16022 .vindex "&$host_address$&"
16023 During its expansion, &$host_address$& is set to the IP address that is being
16024 checked.
16025
16026 .option initgroups routers boolean false
16027 .cindex "additional groups"
16028 .cindex "groups" "additional"
16029 .cindex "local transports" "uid and gid"
16030 .cindex "transport" "local"
16031 If the router queues an address for a transport, and this option is true, and
16032 the uid supplied by the router is not overridden by the transport, the
16033 &[initgroups()]& function is called when running the transport to ensure that
16034 any additional groups associated with the uid are set up. See also &%group%&
16035 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
16036
16037
16038
16039 .option local_part_prefix routers&!? "string list" unset
16040 .cindex "router" "prefix for local part"
16041 .cindex "prefix" "for local part, used in router"
16042 If this option is set, the router is skipped unless the local part starts with
16043 one of the given strings, or &%local_part_prefix_optional%& is true. See
16044 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
16045 evaluated.
16046
16047 The list is scanned from left to right, and the first prefix that matches is
16048 used. A limited form of wildcard is available; if the prefix begins with an
16049 asterisk, it matches the longest possible sequence of arbitrary characters at
16050 the start of the local part. An asterisk should therefore always be followed by
16051 some character that does not occur in normal local parts.
16052 .cindex "multiple mailboxes"
16053 .cindex "mailbox" "multiple"
16054 Wildcarding can be used to set up multiple user mailboxes, as described in
16055 section &<<SECTmulbox>>&.
16056
16057 .vindex "&$local_part$&"
16058 .vindex "&$local_part_prefix$&"
16059 During the testing of the &%local_parts%& option, and while the router is
16060 running, the prefix is removed from the local part, and is available in the
16061 expansion variable &$local_part_prefix$&. When a message is being delivered, if
16062 the router accepts the address, this remains true during subsequent delivery by
16063 a transport. In particular, the local part that is transmitted in the RCPT
16064 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
16065 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
16066 the relevant transport.
16067
16068 When an address is being verified, &%local_part_prefix%& affects only the
16069 behaviour of the router. If the callout feature of verification is in use, this
16070 means that the full address, including the prefix, will be used during the
16071 callout.
16072
16073 The prefix facility is commonly used to handle local parts of the form
16074 &%owner-something%&. Another common use is to support local parts of the form
16075 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
16076 to tell a user their forwarding is broken &-- by placing a router like this one
16077 immediately before the router that handles &_.forward_& files:
16078 .code
16079 real_localuser:
16080   driver = accept
16081   local_part_prefix = real-
16082   check_local_user
16083   transport = local_delivery
16084 .endd
16085 For security, it would probably be a good idea to restrict the use of this
16086 router to locally-generated messages, using a condition such as this:
16087 .code
16088   condition = ${if match {$sender_host_address}\
16089                          {\N^(|127\.0\.0\.1)$\N}}
16090 .endd
16091
16092 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
16093 both conditions must be met if not optional. Care must be taken if wildcards
16094 are used in both a prefix and a suffix on the same router. Different
16095 separator characters must be used to avoid ambiguity.
16096
16097
16098 .option local_part_prefix_optional routers boolean false
16099 See &%local_part_prefix%& above.
16100
16101
16102
16103 .option local_part_suffix routers&!? "string list" unset
16104 .cindex "router" "suffix for local part"
16105 .cindex "suffix for local part" "used in router"
16106 This option operates in the same way as &%local_part_prefix%&, except that the
16107 local part must end (rather than start) with the given string, the
16108 &%local_part_suffix_optional%& option determines whether the suffix is
16109 mandatory, and the wildcard * character, if present, must be the last
16110 character of the suffix. This option facility is commonly used to handle local
16111 parts of the form &%something-request%& and multiple user mailboxes of the form
16112 &%username-foo%&.
16113
16114
16115 .option local_part_suffix_optional routers boolean false
16116 See &%local_part_suffix%& above.
16117
16118
16119
16120 .option local_parts routers&!? "local part list&!!" unset
16121 .cindex "router" "restricting to specific local parts"
16122 .cindex "local part" "checking in router"
16123 The router is run only if the local part of the address matches the list.
16124 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16125 are evaluated, and
16126 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
16127 string is expanded, it is possible to make it depend on the domain, for
16128 example:
16129 .code
16130 local_parts = dbm;/usr/local/specials/$domain
16131 .endd
16132 .vindex "&$local_part_data$&"
16133 If the match is achieved by a lookup, the data that the lookup returned
16134 for the local part is placed in the variable &$local_part_data$& for use in
16135 expansions of the router's private options. You might use this option, for
16136 example, if you have a large number of local virtual domains, and you want to
16137 send all postmaster mail to the same place without having to set up an alias in
16138 each virtual domain:
16139 .code
16140 postmaster:
16141   driver = redirect
16142   local_parts = postmaster
16143   data = postmaster@real.domain.example
16144 .endd
16145
16146
16147 .option log_as_local routers boolean "see below"
16148 .cindex "log" "delivery line"
16149 .cindex "delivery" "log line format"
16150 Exim has two logging styles for delivery, the idea being to make local
16151 deliveries stand out more visibly from remote ones. In the &"local"& style, the
16152 recipient address is given just as the local part, without a domain. The use of
16153 this style is controlled by this option. It defaults to true for the &(accept)&
16154 router, and false for all the others. This option applies only when a
16155 router assigns an address to a transport. It has no effect on routers that
16156 redirect addresses.
16157
16158
16159
16160 .option more routers boolean&!! true
16161 The result of string expansion for this option must be a valid boolean value,
16162 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
16163 result causes an error, and delivery is deferred. If the expansion is forced to
16164 fail, the default value for the option (true) is used. Other failures cause
16165 delivery to be deferred.
16166
16167 If this option is set false, and the router declines to handle the address, no
16168 further routers are tried, routing fails, and the address is bounced.
16169 .oindex "&%self%&"
16170 However, if the router explicitly passes an address to the following router by
16171 means of the setting
16172 .code
16173 self = pass
16174 .endd
16175 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
16176 does not affect the behaviour if one of the precondition tests fails. In that
16177 case, the address is always passed to the next router.
16178
16179 Note that &%address_data%& is not considered to be a precondition. If its
16180 expansion is forced to fail, the router declines, and the value of &%more%&
16181 controls what happens next.
16182
16183
16184 .option pass_on_timeout routers boolean false
16185 .cindex "timeout" "of router"
16186 .cindex "router" "timeout"
16187 If a router times out during a host lookup, it normally causes deferral of the
16188 address. If &%pass_on_timeout%& is set, the address is passed on to the next
16189 router, overriding &%no_more%&. This may be helpful for systems that are
16190 intermittently connected to the Internet, or those that want to pass to a smart
16191 host any messages that cannot immediately be delivered.
16192
16193 There are occasional other temporary errors that can occur while doing DNS
16194 lookups. They are treated in the same way as a timeout, and this option
16195 applies to all of them.
16196
16197
16198
16199 .option pass_router routers string unset
16200 .cindex "router" "go to after &""pass""&"
16201 Routers that recognize the generic &%self%& option (&(dnslookup)&,
16202 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
16203 routing to continue, and overriding a false setting of &%more%&. When one of
16204 these routers returns &"pass"&, the address is normally handed on to the next
16205 router in sequence. This can be changed by setting &%pass_router%& to the name
16206 of another router. However (unlike &%redirect_router%&) the named router must
16207 be below the current router, to avoid loops. Note that this option applies only
16208 to the special case of &"pass"&. It does not apply when a router returns
16209 &"decline"& because it cannot handle an address.
16210
16211
16212
16213 .option redirect_router routers string unset
16214 .cindex "router" "start at after redirection"
16215 Sometimes an administrator knows that it is pointless to reprocess addresses
16216 generated from alias or forward files with the same router again. For
16217 example, if an alias file translates real names into login ids there is no
16218 point searching the alias file a second time, especially if it is a large file.
16219
16220 The &%redirect_router%& option can be set to the name of any router instance.
16221 It causes the routing of any generated addresses to start at the named router
16222 instead of at the first router. This option has no effect if the router in
16223 which it is set does not generate new addresses.
16224
16225
16226
16227 .option require_files routers&!? "string list&!!" unset
16228 .cindex "file" "requiring for router"
16229 .cindex "router" "requiring file existence"
16230 This option provides a general mechanism for predicating the running of a
16231 router on the existence or non-existence of certain files or directories.
16232 Before running a router, as one of its precondition tests, Exim works its way
16233 through the &%require_files%& list, expanding each item separately.
16234
16235 Because the list is split before expansion, any colons in expansion items must
16236 be doubled, or the facility for using a different list separator must be used.
16237 If any expansion is forced to fail, the item is ignored. Other expansion
16238 failures cause routing of the address to be deferred.
16239
16240 If any expanded string is empty, it is ignored. Otherwise, except as described
16241 below, each string must be a fully qualified file path, optionally preceded by
16242 &"!"&. The paths are passed to the &[stat()]& function to test for the
16243 existence of the files or directories. The router is skipped if any paths not
16244 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
16245
16246 .cindex "NFS"
16247 If &[stat()]& cannot determine whether a file exists or not, delivery of
16248 the message is deferred. This can happen when NFS-mounted filesystems are
16249 unavailable.
16250
16251 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
16252 options, so you cannot use it to check for the existence of a file in which to
16253 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
16254 full list of the order in which preconditions are evaluated.) However, as
16255 these options are all expanded, you can use the &%exists%& expansion condition
16256 to make such tests. The &%require_files%& option is intended for checking files
16257 that the router may be going to use internally, or which are needed by a
16258 transport (for example &_.procmailrc_&).
16259
16260 During delivery, the &[stat()]& function is run as root, but there is a
16261 facility for some checking of the accessibility of a file by another user.
16262 This is not a proper permissions check, but just a &"rough"& check that
16263 operates as follows:
16264
16265 If an item in a &%require_files%& list does not contain any forward slash
16266 characters, it is taken to be the user (and optional group, separated by a
16267 comma) to be checked for subsequent files in the list. If no group is specified
16268 but the user is specified symbolically, the gid associated with the uid is
16269 used. For example:
16270 .code
16271 require_files = mail:/some/file
16272 require_files = $local_part:$home/.procmailrc
16273 .endd
16274 If a user or group name in a &%require_files%& list does not exist, the
16275 &%require_files%& condition fails.
16276
16277 Exim performs the check by scanning along the components of the file path, and
16278 checking the access for the given uid and gid. It checks for &"x"& access on
16279 directories, and &"r"& access on the final file. Note that this means that file
16280 access control lists, if the operating system has them, are ignored.
16281
16282 &*Warning 1*&: When the router is being run to verify addresses for an
16283 incoming SMTP message, Exim is not running as root, but under its own uid. This
16284 may affect the result of a &%require_files%& check. In particular, &[stat()]&
16285 may yield the error EACCES (&"Permission denied"&). This means that the Exim
16286 user is not permitted to read one of the directories on the file's path.
16287
16288 &*Warning 2*&: Even when Exim is running as root while delivering a message,
16289 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
16290 without root access. In this case, if a check for access by a particular user
16291 is requested, Exim creates a subprocess that runs as that user, and tries the
16292 check again in that process.
16293
16294 The default action for handling an unresolved EACCES is to consider it to
16295 be caused by a configuration error, and routing is deferred because the
16296 existence or non-existence of the file cannot be determined. However, in some
16297 circumstances it may be desirable to treat this condition as if the file did
16298 not exist. If the file name (or the exclamation mark that precedes the file
16299 name for non-existence) is preceded by a plus sign, the EACCES error is treated
16300 as if the file did not exist. For example:
16301 .code
16302 require_files = +/some/file
16303 .endd
16304 If the router is not an essential part of verification (for example, it
16305 handles users' &_.forward_& files), another solution is to set the &%verify%&
16306 option false so that the router is skipped when verifying.
16307
16308
16309
16310 .option retry_use_local_part routers boolean "see below"
16311 .cindex "hints database" "retry keys"
16312 .cindex "local part" "in retry keys"
16313 When a delivery suffers a temporary routing failure, a retry record is created
16314 in Exim's hints database. For addresses whose routing depends only on the
16315 domain, the key for the retry record should not involve the local part, but for
16316 other addresses, both the domain and the local part should be included.
16317 Usually, remote routing is of the former kind, and local routing is of the
16318 latter kind.
16319
16320 This option controls whether the local part is used to form the key for retry
16321 hints for addresses that suffer temporary errors while being handled by this
16322 router. The default value is true for any router that has &%check_local_user%&
16323 set, and false otherwise. Note that this option does not apply to hints keys
16324 for transport delays; they are controlled by a generic transport option of the
16325 same name.
16326
16327 The setting of &%retry_use_local_part%& applies only to the router on which it
16328 appears. If the router generates child addresses, they are routed
16329 independently; this setting does not become attached to them.
16330
16331
16332
16333 .option router_home_directory routers string&!! unset
16334 .cindex "router" "home directory for"
16335 .cindex "home directory" "for router"
16336 .vindex "&$home$&"
16337 This option sets a home directory for use while the router is running. (Compare
16338 &%transport_home_directory%&, which sets a home directory for later
16339 transporting.) In particular, if used on a &(redirect)& router, this option
16340 sets a value for &$home$& while a filter is running. The value is expanded;
16341 forced expansion failure causes the option to be ignored &-- other failures
16342 cause the router to defer.
16343
16344 Expansion of &%router_home_directory%& happens immediately after the
16345 &%check_local_user%& test (if configured), before any further expansions take
16346 place.
16347 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16348 are evaluated.)
16349 While the router is running, &%router_home_directory%& overrides the value of
16350 &$home$& that came from &%check_local_user%&.
16351
16352 When a router accepts an address and assigns it to a local transport (including
16353 the cases when a &(redirect)& router generates a pipe, file, or autoreply
16354 delivery), the home directory setting for the transport is taken from the first
16355 of these values that is set:
16356
16357 .ilist
16358 The &%home_directory%& option on the transport;
16359 .next
16360 The &%transport_home_directory%& option on the router;
16361 .next
16362 The password data if &%check_local_user%& is set on the router;
16363 .next
16364 The &%router_home_directory%& option on the router.
16365 .endlist
16366
16367 In other words, &%router_home_directory%& overrides the password data for the
16368 router, but not for the transport.
16369
16370
16371
16372 .option self routers string freeze
16373 .cindex "MX record" "pointing to local host"
16374 .cindex "local host" "MX pointing to"
16375 This option applies to those routers that use a recipient address to find a
16376 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
16377 and &(manualroute)& routers.
16378 Certain configurations of the &(queryprogram)& router can also specify a list
16379 of remote hosts.
16380 Usually such routers are configured to send the message to a remote host via an
16381 &(smtp)& transport. The &%self%& option specifies what happens when the first
16382 host on the list turns out to be the local host.
16383 The way in which Exim checks for the local host is described in section
16384 &<<SECTreclocipadd>>&.
16385
16386 Normally this situation indicates either an error in Exim's configuration (for
16387 example, the router should be configured not to process this domain), or an
16388 error in the DNS (for example, the MX should not point to this host). For this
16389 reason, the default action is to log the incident, defer the address, and
16390 freeze the message. The following alternatives are provided for use in special
16391 cases:
16392
16393 .vlist
16394 .vitem &%defer%&
16395 Delivery of the message is tried again later, but the message is not frozen.
16396
16397 .vitem "&%reroute%&: <&'domain'&>"
16398 The domain is changed to the given domain, and the address is passed back to
16399 be reprocessed by the routers. No rewriting of headers takes place. This
16400 behaviour is essentially a redirection.
16401
16402 .vitem "&%reroute: rewrite:%& <&'domain'&>"
16403 The domain is changed to the given domain, and the address is passed back to be
16404 reprocessed by the routers. Any headers that contain the original domain are
16405 rewritten.
16406
16407 .vitem &%pass%&
16408 .oindex "&%more%&"
16409 .vindex "&$self_hostname$&"
16410 The router passes the address to the next router, or to the router named in the
16411 &%pass_router%& option if it is set. This overrides &%no_more%&. During
16412 subsequent routing and delivery, the variable &$self_hostname$& contains the
16413 name of the local host that the router encountered. This can be used to
16414 distinguish between different cases for hosts with multiple names. The
16415 combination
16416 .code
16417 self = pass
16418 no_more
16419 .endd
16420 ensures that only those addresses that routed to the local host are passed on.
16421 Without &%no_more%&, addresses that were declined for other reasons would also
16422 be passed to the next router.
16423
16424 .vitem &%fail%&
16425 Delivery fails and an error report is generated.
16426
16427 .vitem &%send%&
16428 .cindex "local host" "sending to"
16429 The anomaly is ignored and the address is queued for the transport. This
16430 setting should be used with extreme caution. For an &(smtp)& transport, it
16431 makes sense only in cases where the program that is listening on the SMTP port
16432 is not this version of Exim. That is, it must be some other MTA, or Exim with a
16433 different configuration file that handles the domain in another way.
16434 .endlist
16435
16436
16437
16438 .option senders routers&!? "address list&!!" unset
16439 .cindex "router" "checking senders"
16440 If this option is set, the router is skipped unless the message's sender
16441 address matches something on the list.
16442 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16443 are evaluated.
16444
16445 There are issues concerning verification when the running of routers is
16446 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
16447 setting, it sets the sender to the null string. When using the &%-bt%& option
16448 to check a configuration file, it is necessary also to use the &%-f%& option to
16449 set an appropriate sender. For incoming mail, the sender is unset when
16450 verifying the sender, but is available when verifying any recipients. If the
16451 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
16452 matters.
16453
16454
16455 .option translate_ip_address routers string&!! unset
16456 .cindex "IP address" "translating"
16457 .cindex "packet radio"
16458 .cindex "router" "IP address translation"
16459 There exist some rare networking situations (for example, packet radio) where
16460 it is helpful to be able to translate IP addresses generated by normal routing
16461 mechanisms into other IP addresses, thus performing a kind of manual IP
16462 routing. This should be done only if the normal IP routing of the TCP/IP stack
16463 is inadequate or broken. Because this is an extremely uncommon requirement, the
16464 code to support this option is not included in the Exim binary unless
16465 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
16466
16467 .vindex "&$host_address$&"
16468 The &%translate_ip_address%& string is expanded for every IP address generated
16469 by the router, with the generated address set in &$host_address$&. If the
16470 expansion is forced to fail, no action is taken.
16471 For any other expansion error, delivery of the message is deferred.
16472 If the result of the expansion is an IP address, that replaces the original
16473 address; otherwise the result is assumed to be a host name &-- this is looked
16474 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
16475 produce one or more replacement IP addresses. For example, to subvert all IP
16476 addresses in some specific networks, this could be added to a router:
16477 .code
16478 translate_ip_address = \
16479   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
16480     {$value}fail}}
16481 .endd
16482 The file would contain lines like
16483 .code
16484 10.2.3.128/26    some.host
16485 10.8.4.34/26     10.44.8.15
16486 .endd
16487 You should not make use of this facility unless you really understand what you
16488 are doing.
16489
16490
16491
16492 .option transport routers string&!! unset
16493 This option specifies the transport to be used when a router accepts an address
16494 and sets it up for delivery. A transport is never needed if a router is used
16495 only for verification. The value of the option is expanded at routing time,
16496 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
16497 and result must be the name of one of the configured transports. If it is not,
16498 delivery is deferred.
16499
16500 The &%transport%& option is not used by the &(redirect)& router, but it does
16501 have some private options that set up transports for pipe and file deliveries
16502 (see chapter &<<CHAPredirect>>&).
16503
16504
16505
16506 .option transport_current_directory routers string&!! unset
16507 .cindex "current directory for local transport"
16508 This option associates a current directory with any address that is routed
16509 to a local transport. This can happen either because a transport is
16510 explicitly configured for the router, or because it generates a delivery to a
16511 file or a pipe. During the delivery process (that is, at transport time), this
16512 option string is expanded and is set as the current directory, unless
16513 overridden by a setting on the transport.
16514 If the expansion fails for any reason, including forced failure, an error is
16515 logged, and delivery is deferred.
16516 See chapter &<<CHAPenvironment>>& for details of the local delivery
16517 environment.
16518
16519
16520
16521
16522 .option transport_home_directory routers string&!! "see below"
16523 .cindex "home directory" "for local transport"
16524 This option associates a home directory with any address that is routed to a
16525 local transport. This can happen either because a transport is explicitly
16526 configured for the router, or because it generates a delivery to a file or a
16527 pipe. During the delivery process (that is, at transport time), the option
16528 string is expanded and is set as the home directory, unless overridden by a
16529 setting of &%home_directory%& on the transport.
16530 If the expansion fails for any reason, including forced failure, an error is
16531 logged, and delivery is deferred.
16532
16533 If the transport does not specify a home directory, and
16534 &%transport_home_directory%& is not set for the router, the home directory for
16535 the transport is taken from the password data if &%check_local_user%& is set for
16536 the router. Otherwise it is taken from &%router_home_directory%& if that option
16537 is set; if not, no home directory is set for the transport.
16538
16539 See chapter &<<CHAPenvironment>>& for further details of the local delivery
16540 environment.
16541
16542
16543
16544
16545 .option unseen routers boolean&!! false
16546 .cindex "router" "carrying on after success"
16547 The result of string expansion for this option must be a valid boolean value,
16548 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
16549 result causes an error, and delivery is deferred. If the expansion is forced to
16550 fail, the default value for the option (false) is used. Other failures cause
16551 delivery to be deferred.
16552
16553 When this option is set true, routing does not cease if the router accepts the
16554 address. Instead, a copy of the incoming address is passed to the next router,
16555 overriding a false setting of &%more%&. There is little point in setting
16556 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
16557 the value of &%unseen%& contains expansion items (and therefore, presumably, is
16558 sometimes true and sometimes false).
16559
16560 .cindex "copy of message (&%unseen%& option)"
16561 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
16562 qualifier in filter files. It can be used to cause copies of messages to be
16563 delivered to some other destination, while also carrying out a normal delivery.
16564 In effect, the current address is made into a &"parent"& that has two children
16565 &-- one that is delivered as specified by this router, and a clone that goes on
16566 to be routed further. For this reason, &%unseen%& may not be combined with the
16567 &%one_time%& option in a &(redirect)& router.
16568
16569 &*Warning*&: Header lines added to the address (or specified for removal) by
16570 this router or by previous routers affect the &"unseen"& copy of the message
16571 only. The clone that continues to be processed by further routers starts with
16572 no added headers and none specified for removal. For a &%redirect%& router, if
16573 a generated address is the same as the incoming address, this can lead to
16574 duplicate addresses with different header modifications. Exim does not do
16575 duplicate deliveries (except, in certain circumstances, to pipes -- see section
16576 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
16577 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
16578 &%redirect%& router may be of help.
16579
16580 Unlike the handling of header modifications, any data that was set by the
16581 &%address_data%& option in the current or previous routers &'is'& passed on to
16582 subsequent routers.
16583
16584
16585 .option user routers string&!! "see below"
16586 .cindex "uid (user id)" "local delivery"
16587 .cindex "local transports" "uid and gid"
16588 .cindex "transport" "local"
16589 .cindex "router" "user for filter processing"
16590 .cindex "filter" "user for processing"
16591 When a router queues an address for a transport, and the transport does not
16592 specify a user, the user given here is used when running the delivery process.
16593 The user may be specified numerically or by name. If expansion fails, the
16594 error is logged and delivery is deferred.
16595 This user is also used by the &(redirect)& router when running a filter file.
16596 The default is unset, except when &%check_local_user%& is set. In this case,
16597 the default is taken from the password information. If the user is specified as
16598 a name, and &%group%& is not set, the group associated with the user is used.
16599 See also &%initgroups%& and &%group%& and the discussion in chapter
16600 &<<CHAPenvironment>>&.
16601
16602
16603
16604 .option verify routers&!? boolean true
16605 Setting this option has the effect of setting &%verify_sender%& and
16606 &%verify_recipient%& to the same value.
16607
16608
16609 .option verify_only routers&!? boolean false
16610 .cindex "EXPN" "with &%verify_only%&"
16611 .oindex "&%-bv%&"
16612 .cindex "router" "used only when verifying"
16613 If this option is set, the router is used only when verifying an address or
16614 testing with the &%-bv%& option, not when actually doing a delivery, testing
16615 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
16616 restricted to verifying only senders or recipients by means of
16617 &%verify_sender%& and &%verify_recipient%&.
16618
16619 &*Warning*&: When the router is being run to verify addresses for an incoming
16620 SMTP message, Exim is not running as root, but under its own uid. If the router
16621 accesses any files, you need to make sure that they are accessible to the Exim
16622 user or group.
16623
16624
16625 .option verify_recipient routers&!? boolean true
16626 If this option is false, the router is skipped when verifying recipient
16627 addresses
16628 or testing recipient verification using &%-bv%&.
16629 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16630 are evaluated.
16631
16632
16633 .option verify_sender routers&!? boolean true
16634 If this option is false, the router is skipped when verifying sender addresses
16635 or testing sender verification using &%-bvs%&.
16636 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16637 are evaluated.
16638 .ecindex IIDgenoprou1
16639 .ecindex IIDgenoprou2
16640
16641
16642
16643
16644
16645
16646 . ////////////////////////////////////////////////////////////////////////////
16647 . ////////////////////////////////////////////////////////////////////////////
16648
16649 .chapter "The accept router" "CHID4"
16650 .cindex "&(accept)& router"
16651 .cindex "routers" "&(accept)&"
16652 The &(accept)& router has no private options of its own. Unless it is being
16653 used purely for verification (see &%verify_only%&) a transport is required to
16654 be defined by the generic &%transport%& option. If the preconditions that are
16655 specified by generic options are met, the router accepts the address and queues
16656 it for the given transport. The most common use of this router is for setting
16657 up deliveries to local mailboxes. For example:
16658 .code
16659 localusers:
16660   driver = accept
16661   domains = mydomain.example
16662   check_local_user
16663   transport = local_delivery
16664 .endd
16665 The &%domains%& condition in this example checks the domain of the address, and
16666 &%check_local_user%& checks that the local part is the login of a local user.
16667 When both preconditions are met, the &(accept)& router runs, and queues the
16668 address for the &(local_delivery)& transport.
16669
16670
16671
16672
16673
16674
16675 . ////////////////////////////////////////////////////////////////////////////
16676 . ////////////////////////////////////////////////////////////////////////////
16677
16678 .chapter "The dnslookup router" "CHAPdnslookup"
16679 .scindex IIDdnsrou1 "&(dnslookup)& router"
16680 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
16681 The &(dnslookup)& router looks up the hosts that handle mail for the
16682 recipient's domain in the DNS. A transport must always be set for this router,
16683 unless &%verify_only%& is set.
16684
16685 If SRV support is configured (see &%check_srv%& below), Exim first searches for
16686 SRV records. If none are found, or if SRV support is not configured,
16687 MX records are looked up. If no MX records exist, address records are sought.
16688 However, &%mx_domains%& can be set to disable the direct use of address
16689 records.
16690
16691 MX records of equal priority are sorted by Exim into a random order. Exim then
16692 looks for address records for the host names obtained from MX or SRV records.
16693 When a host has more than one IP address, they are sorted into a random order,
16694 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
16695 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
16696 generic option, the router declines.
16697
16698 Unless they have the highest priority (lowest MX value), MX records that point
16699 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
16700 are discarded, together with any other MX records of equal or lower priority.
16701
16702 .cindex "MX record" "pointing to local host"
16703 .cindex "local host" "MX pointing to"
16704 .oindex "&%self%&" "in &(dnslookup)& router"
16705 If the host pointed to by the highest priority MX record, or looked up as an
16706 address record, is the local host, or matches &%hosts_treat_as_local%&, what
16707 happens is controlled by the generic &%self%& option.
16708
16709
16710 .section "Problems with DNS lookups" "SECTprowitdnsloo"
16711 There have been problems with DNS servers when SRV records are looked up.
16712 Some mis-behaving servers return a DNS error or timeout when a non-existent
16713 SRV record is sought. Similar problems have in the past been reported for
16714 MX records. The global &%dns_again_means_nonexist%& option can help with this
16715 problem, but it is heavy-handed because it is a global option.
16716
16717 For this reason, there are two options, &%srv_fail_domains%& and
16718 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
16719 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
16720 an attempt to look up an SRV or MX record causes one of these results, and the
16721 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
16722 such record"&. In the case of an SRV lookup, this means that the router
16723 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
16724 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
16725 case routing fails.
16726
16727
16728
16729
16730 .section "Private options for dnslookup" "SECID118"
16731 .cindex "options" "&(dnslookup)& router"
16732 The private options for the &(dnslookup)& router are as follows:
16733
16734 .option check_secondary_mx dnslookup boolean false
16735 .cindex "MX record" "checking for secondary"
16736 If this option is set, the router declines unless the local host is found in
16737 (and removed from) the list of hosts obtained by MX lookup. This can be used to
16738 process domains for which the local host is a secondary mail exchanger
16739 differently to other domains. The way in which Exim decides whether a host is
16740 the local host is described in section &<<SECTreclocipadd>>&.
16741
16742
16743 .option check_srv dnslookup string&!! unset
16744 .cindex "SRV record" "enabling use of"
16745 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
16746 addition to MX and address records. The support is disabled by default. To
16747 enable SRV support, set the &%check_srv%& option to the name of the service
16748 required. For example,
16749 .code
16750 check_srv = smtp
16751 .endd
16752 looks for SRV records that refer to the normal smtp service. The option is
16753 expanded, so the service name can vary from message to message or address
16754 to address. This might be helpful if SRV records are being used for a
16755 submission service. If the expansion is forced to fail, the &%check_srv%&
16756 option is ignored, and the router proceeds to look for MX records in the
16757 normal way.
16758
16759 When the expansion succeeds, the router searches first for SRV records for
16760 the given service (it assumes TCP protocol). A single SRV record with a
16761 host name that consists of just a single dot indicates &"no such service for
16762 this domain"&; if this is encountered, the router declines. If other kinds of
16763 SRV record are found, they are used to construct a host list for delivery
16764 according to the rules of RFC 2782. MX records are not sought in this case.
16765
16766 When no SRV records are found, MX records (and address records) are sought in
16767 the traditional way. In other words, SRV records take precedence over MX
16768 records, just as MX records take precedence over address records. Note that
16769 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
16770 defined it. It is apparently believed that MX records are sufficient for email
16771 and that SRV records should not be used for this purpose. However, SRV records
16772 have an additional &"weight"& feature which some people might find useful when
16773 trying to split an SMTP load between hosts of different power.
16774
16775 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
16776 when there is a DNS lookup error.
16777
16778
16779
16780 .option mx_domains dnslookup "domain list&!!" unset
16781 .cindex "MX record" "required to exist"
16782 .cindex "SRV record" "required to exist"
16783 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
16784 record in order to be recognized. (The name of this option could be improved.)
16785 For example, if all the mail hosts in &'fict.example'& are known to have MX
16786 records, except for those in &'discworld.fict.example'&, you could use this
16787 setting:
16788 .code
16789 mx_domains = ! *.discworld.fict.example : *.fict.example
16790 .endd
16791 This specifies that messages addressed to a domain that matches the list but
16792 has no MX record should be bounced immediately instead of being routed using
16793 the address record.
16794
16795
16796 .option mx_fail_domains dnslookup "domain list&!!" unset
16797 If the DNS lookup for MX records for one of the domains in this list causes a
16798 DNS lookup error, Exim behaves as if no MX records were found. See section
16799 &<<SECTprowitdnsloo>>& for more discussion.
16800
16801
16802
16803
16804 .option qualify_single dnslookup boolean true
16805 .cindex "DNS" "resolver options"
16806 .cindex "DNS" "qualifying single-component names"
16807 When this option is true, the resolver option RES_DEFNAMES is set for DNS
16808 lookups. Typically, but not standardly, this causes the resolver to qualify
16809 single-component names with the default domain. For example, on a machine
16810 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
16811 &'thesaurus.ref.example'& inside the resolver. For details of what your
16812 resolver actually does, consult your man pages for &'resolver'& and
16813 &'resolv.conf'&.
16814
16815
16816
16817 .option rewrite_headers dnslookup boolean true
16818 .cindex "rewriting" "header lines"
16819 .cindex "header lines" "rewriting"
16820 If the domain name in the address that is being processed is not fully
16821 qualified, it may be expanded to its full form by a DNS lookup. For example, if
16822 an address is specified as &'dormouse@teaparty'&, the domain might be
16823 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
16824 occur as a result of setting the &%widen_domains%& option. If
16825 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
16826 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
16827 header lines of the message are rewritten with the full domain name.
16828
16829 This option should be turned off only when it is known that no message is
16830 ever going to be sent outside an environment where the abbreviation makes
16831 sense.
16832
16833 When an MX record is looked up in the DNS and matches a wildcard record, name
16834 servers normally return a record containing the name that has been looked up,
16835 making it impossible to detect whether a wildcard was present or not. However,
16836 some name servers have recently been seen to return the wildcard entry. If the
16837 name returned by a DNS lookup begins with an asterisk, it is not used for
16838 header rewriting.
16839
16840
16841 .option same_domain_copy_routing dnslookup boolean false
16842 .cindex "address" "copying routing"
16843 Addresses with the same domain are normally routed by the &(dnslookup)& router
16844 to the same list of hosts. However, this cannot be presumed, because the router
16845 options and preconditions may refer to the local part of the address. By
16846 default, therefore, Exim routes each address in a message independently. DNS
16847 servers run caches, so repeated DNS lookups are not normally expensive, and in
16848 any case, personal messages rarely have more than a few recipients.
16849
16850 If you are running mailing lists with large numbers of subscribers at the same
16851 domain, and you are using a &(dnslookup)& router which is independent of the
16852 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
16853 lookups for identical domains in one message. In this case, when &(dnslookup)&
16854 routes an address to a remote transport, any other unrouted addresses in the
16855 message that have the same domain are automatically given the same routing
16856 without processing them independently,
16857 provided the following conditions are met:
16858
16859 .ilist
16860 No router that processed the address specified &%headers_add%& or
16861 &%headers_remove%&.
16862 .next
16863 The router did not change the address in any way, for example, by &"widening"&
16864 the domain.
16865 .endlist
16866
16867
16868
16869
16870 .option search_parents dnslookup boolean false
16871 .cindex "DNS" "resolver options"
16872 When this option is true, the resolver option RES_DNSRCH is set for DNS
16873 lookups. This is different from the &%qualify_single%& option in that it
16874 applies to domains containing dots. Typically, but not standardly, it causes
16875 the resolver to search for the name in the current domain and in parent
16876 domains. For example, on a machine in the &'fict.example'& domain, if looking
16877 up &'teaparty.wonderland'& failed, the resolver would try
16878 &'teaparty.wonderland.fict.example'&. For details of what your resolver
16879 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
16880
16881 Setting this option true can cause problems in domains that have a wildcard MX
16882 record, because any domain that does not have its own MX record matches the
16883 local wildcard.
16884
16885
16886
16887 .option srv_fail_domains dnslookup "domain list&!!" unset
16888 If the DNS lookup for SRV records for one of the domains in this list causes a
16889 DNS lookup error, Exim behaves as if no SRV records were found. See section
16890 &<<SECTprowitdnsloo>>& for more discussion.
16891
16892
16893
16894
16895 .option widen_domains dnslookup "string list" unset
16896 .cindex "domain" "partial; widening"
16897 If a DNS lookup fails and this option is set, each of its strings in turn is
16898 added onto the end of the domain, and the lookup is tried again. For example,
16899 if
16900 .code
16901 widen_domains = fict.example:ref.example
16902 .endd
16903 is set and a lookup of &'klingon.dictionary'& fails,
16904 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
16905 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
16906 and &%search_parents%& options can cause some widening to be undertaken inside
16907 the DNS resolver. &%widen_domains%& is not applied to sender addresses
16908 when verifying, unless &%rewrite_headers%& is false (not the default).
16909
16910
16911 .section "Effect of qualify_single and search_parents" "SECID119"
16912 When a domain from an envelope recipient is changed by the resolver as a result
16913 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
16914 corresponding address in the message's header lines unless &%rewrite_headers%&
16915 is set false. Exim then re-routes the address, using the full domain.
16916
16917 These two options affect only the DNS lookup that takes place inside the router
16918 for the domain of the address that is being routed. They do not affect lookups
16919 such as that implied by
16920 .code
16921 domains = @mx_any
16922 .endd
16923 that may happen while processing a router precondition before the router is
16924 entered. No widening ever takes place for these lookups.
16925 .ecindex IIDdnsrou1
16926 .ecindex IIDdnsrou2
16927
16928
16929
16930
16931
16932
16933
16934
16935
16936 . ////////////////////////////////////////////////////////////////////////////
16937 . ////////////////////////////////////////////////////////////////////////////
16938
16939 .chapter "The ipliteral router" "CHID5"
16940 .cindex "&(ipliteral)& router"
16941 .cindex "domain literal" "routing"
16942 .cindex "routers" "&(ipliteral)&"
16943 This router has no private options. Unless it is being used purely for
16944 verification (see &%verify_only%&) a transport is required to be defined by the
16945 generic &%transport%& option. The router accepts the address if its domain part
16946 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
16947 router handles the address
16948 .code
16949 root@[192.168.1.1]
16950 .endd
16951 by setting up delivery to the host with that IP address. IPv4 domain literals
16952 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
16953 are similar, but the address is preceded by &`ipv6:`&. For example:
16954 .code
16955 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
16956 .endd
16957 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
16958 grounds that sooner or later somebody will try it.
16959
16960 .oindex "&%self%&" "in &(ipliteral)& router"
16961 If the IP address matches something in &%ignore_target_hosts%&, the router
16962 declines. If an IP literal turns out to refer to the local host, the generic
16963 &%self%& option determines what happens.
16964
16965 The RFCs require support for domain literals; however, their use is
16966 controversial in today's Internet. If you want to use this router, you must
16967 also set the main configuration option &%allow_domain_literals%&. Otherwise,
16968 Exim will not recognize the domain literal syntax in addresses.
16969
16970
16971
16972 . ////////////////////////////////////////////////////////////////////////////
16973 . ////////////////////////////////////////////////////////////////////////////
16974
16975 .chapter "The iplookup router" "CHID6"
16976 .cindex "&(iplookup)& router"
16977 .cindex "routers" "&(iplookup)&"
16978 The &(iplookup)& router was written to fulfil a specific requirement in
16979 Cambridge University (which in fact no longer exists). For this reason, it is
16980 not included in the binary of Exim by default. If you want to include it, you
16981 must set
16982 .code
16983 ROUTER_IPLOOKUP=yes
16984 .endd
16985 in your &_Local/Makefile_& configuration file.
16986
16987 The &(iplookup)& router routes an address by sending it over a TCP or UDP
16988 connection to one or more specific hosts. The host can then return the same or
16989 a different address &-- in effect rewriting the recipient address in the
16990 message's envelope. The new address is then passed on to subsequent routers. If
16991 this process fails, the address can be passed on to other routers, or delivery
16992 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
16993 must not be specified for it.
16994
16995 .cindex "options" "&(iplookup)& router"
16996 .option hosts iplookup string unset
16997 This option must be supplied. Its value is a colon-separated list of host
16998 names. The hosts are looked up using &[gethostbyname()]&
16999 (or &[getipnodebyname()]& when available)
17000 and are tried in order until one responds to the query. If none respond, what
17001 happens is controlled by &%optional%&.
17002
17003
17004 .option optional iplookup boolean false
17005 If &%optional%& is true, if no response is obtained from any host, the address
17006 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
17007 delivery to the address is deferred.
17008
17009
17010 .option port iplookup integer 0
17011 .cindex "port" "&(iplookup)& router"
17012 This option must be supplied. It specifies the port number for the TCP or UDP
17013 call.
17014
17015
17016 .option protocol iplookup string udp
17017 This option can be set to &"udp"& or &"tcp"& to specify which of the two
17018 protocols is to be used.
17019
17020
17021 .option query iplookup string&!! "see below"
17022 This defines the content of the query that is sent to the remote hosts. The
17023 default value is:
17024 .code
17025 $local_part@$domain $local_part@$domain
17026 .endd
17027 The repetition serves as a way of checking that a response is to the correct
17028 query in the default case (see &%response_pattern%& below).
17029
17030
17031 .option reroute iplookup string&!! unset
17032 If this option is not set, the rerouted address is precisely the byte string
17033 returned by the remote host, up to the first white space, if any. If set, the
17034 string is expanded to form the rerouted address. It can include parts matched
17035 in the response by &%response_pattern%& by means of numeric variables such as
17036 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
17037 whether or not a pattern is in use. In all cases, the rerouted address must end
17038 up in the form &'local_part@domain'&.
17039
17040
17041 .option response_pattern iplookup string unset
17042 This option can be set to a regular expression that is applied to the string
17043 returned from the remote host. If the pattern does not match the response, the
17044 router declines. If &%response_pattern%& is not set, no checking of the
17045 response is done, unless the query was defaulted, in which case there is a
17046 check that the text returned after the first white space is the original
17047 address. This checks that the answer that has been received is in response to
17048 the correct question. For example, if the response is just a new domain, the
17049 following could be used:
17050 .code
17051 response_pattern = ^([^@]+)$
17052 reroute = $local_part@$1
17053 .endd
17054
17055 .option timeout iplookup time 5s
17056 This specifies the amount of time to wait for a response from the remote
17057 machine. The same timeout is used for the &[connect()]& function for a TCP
17058 call. It does not apply to UDP.
17059
17060
17061
17062
17063 . ////////////////////////////////////////////////////////////////////////////
17064 . ////////////////////////////////////////////////////////////////////////////
17065
17066 .chapter "The manualroute router" "CHID7"
17067 .scindex IIDmanrou1 "&(manualroute)& router"
17068 .scindex IIDmanrou2 "routers" "&(manualroute)&"
17069 .cindex "domain" "manually routing"
17070 The &(manualroute)& router is so-called because it provides a way of manually
17071 routing an address according to its domain. It is mainly used when you want to
17072 route addresses to remote hosts according to your own rules, bypassing the
17073 normal DNS routing that looks up MX records. However, &(manualroute)& can also
17074 route to local transports, a facility that may be useful if you want to save
17075 messages for dial-in hosts in local files.
17076
17077 The &(manualroute)& router compares a list of domain patterns with the domain
17078 it is trying to route. If there is no match, the router declines. Each pattern
17079 has associated with it a list of hosts and some other optional data, which may
17080 include a transport. The combination of a pattern and its data is called a
17081 &"routing rule"&. For patterns that do not have an associated transport, the
17082 generic &%transport%& option must specify a transport, unless the router is
17083 being used purely for verification (see &%verify_only%&).
17084
17085 .vindex "&$host$&"
17086 In the case of verification, matching the domain pattern is sufficient for the
17087 router to accept the address. When actually routing an address for delivery,
17088 an address that matches a domain pattern is queued for the associated
17089 transport. If the transport is not a local one, a host list must be associated
17090 with the pattern; IP addresses are looked up for the hosts, and these are
17091 passed to the transport along with the mail address. For local transports, a
17092 host list is optional. If it is present, it is passed in &$host$& as a single
17093 text string.
17094
17095 The list of routing rules can be provided as an inline string in
17096 &%route_list%&, or the data can be obtained by looking up the domain in a file
17097 or database by setting &%route_data%&. Only one of these settings may appear in
17098 any one instance of &(manualroute)&. The format of routing rules is described
17099 below, following the list of private options.
17100
17101
17102 .section "Private options for manualroute" "SECTprioptman"
17103
17104 .cindex "options" "&(manualroute)& router"
17105 The private options for the &(manualroute)& router are as follows:
17106
17107 .option host_all_ignored manualroute string defer
17108 See &%host_find_failed%&.
17109
17110 .option host_find_failed manualroute string freeze
17111 This option controls what happens when &(manualroute)& tries to find an IP
17112 address for a host, and the host does not exist. The option can be set to one
17113 of the following values:
17114 .code
17115 decline
17116 defer
17117 fail
17118 freeze
17119 ignore
17120 pass
17121 .endd
17122 The default (&"freeze"&) assumes that this state is a serious configuration
17123 error. The difference between &"pass"& and &"decline"& is that the former
17124 forces the address to be passed to the next router (or the router defined by
17125 &%pass_router%&),
17126 .oindex "&%more%&"
17127 overriding &%no_more%&, whereas the latter passes the address to the next
17128 router only if &%more%& is true.
17129
17130 The value &"ignore"& causes Exim to completely ignore a host whose IP address
17131 cannot be found. If all the hosts in the list are ignored, the behaviour is
17132 controlled by the &%host_all_ignored%& option. This takes the same values
17133 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
17134
17135 The &%host_find_failed%& option applies only to a definite &"does not exist"&
17136 state; if a host lookup gets a temporary error, delivery is deferred unless the
17137 generic &%pass_on_timeout%& option is set.
17138
17139
17140 .option hosts_randomize manualroute boolean false
17141 .cindex "randomized host list"
17142 .cindex "host" "list of; randomized"
17143 If this option is set, the order of the items in a host list in a routing rule
17144 is randomized each time the list is used, unless an option in the routing rule
17145 overrides (see below). Randomizing the order of a host list can be used to do
17146 crude load sharing. However, if more than one mail address is routed by the
17147 same router to the same host list, the host lists are considered to be the same
17148 (even though they may be randomized into different orders) for the purpose of
17149 deciding whether to batch the deliveries into a single SMTP transaction.
17150
17151 When &%hosts_randomize%& is true, a host list may be split
17152 into groups whose order is separately randomized. This makes it possible to
17153 set up MX-like behaviour. The boundaries between groups are indicated by an
17154 item that is just &`+`& in the host list. For example:
17155 .code
17156 route_list = * host1:host2:host3:+:host4:host5
17157 .endd
17158 The order of the first three hosts and the order of the last two hosts is
17159 randomized for each use, but the first three always end up before the last two.
17160 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
17161 randomized host list is passed to an &(smtp)& transport that also has
17162 &%hosts_randomize set%&, the list is not re-randomized.
17163
17164
17165 .option route_data manualroute string&!! unset
17166 If this option is set, it must expand to yield the data part of a routing rule.
17167 Typically, the expansion string includes a lookup based on the domain. For
17168 example:
17169 .code
17170 route_data = ${lookup{$domain}dbm{/etc/routes}}
17171 .endd
17172 If the expansion is forced to fail, or the result is an empty string, the
17173 router declines. Other kinds of expansion failure cause delivery to be
17174 deferred.
17175
17176
17177 .option route_list manualroute "string list" unset
17178 This string is a list of routing rules, in the form defined below. Note that,
17179 unlike most string lists, the items are separated by semicolons. This is so
17180 that they may contain colon-separated host lists.
17181
17182
17183 .option same_domain_copy_routing manualroute boolean false
17184 .cindex "address" "copying routing"
17185 Addresses with the same domain are normally routed by the &(manualroute)&
17186 router to the same list of hosts. However, this cannot be presumed, because the
17187 router options and preconditions may refer to the local part of the address. By
17188 default, therefore, Exim routes each address in a message independently. DNS
17189 servers run caches, so repeated DNS lookups are not normally expensive, and in
17190 any case, personal messages rarely have more than a few recipients.
17191
17192 If you are running mailing lists with large numbers of subscribers at the same
17193 domain, and you are using a &(manualroute)& router which is independent of the
17194 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
17195 lookups for identical domains in one message. In this case, when
17196 &(manualroute)& routes an address to a remote transport, any other unrouted
17197 addresses in the message that have the same domain are automatically given the
17198 same routing without processing them independently. However, this is only done
17199 if &%headers_add%& and &%headers_remove%& are unset.
17200
17201
17202
17203
17204 .section "Routing rules in route_list" "SECID120"
17205 The value of &%route_list%& is a string consisting of a sequence of routing
17206 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
17207 entered as two semicolons. Alternatively, the list separator can be changed as
17208 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
17209 Empty rules are ignored. The format of each rule is
17210 .display
17211 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
17212 .endd
17213 The following example contains two rules, each with a simple domain pattern and
17214 no options:
17215 .code
17216 route_list = \
17217   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
17218   thes.ref.example  mail-3.ref.example:mail-4.ref.example
17219 .endd
17220 The three parts of a rule are separated by white space. The pattern and the
17221 list of hosts can be enclosed in quotes if necessary, and if they are, the
17222 usual quoting rules apply. Each rule in a &%route_list%& must start with a
17223 single domain pattern, which is the only mandatory item in the rule. The
17224 pattern is in the same format as one item in a domain list (see section
17225 &<<SECTdomainlist>>&),
17226 except that it may not be the name of an interpolated file.
17227 That is, it may be wildcarded, or a regular expression, or a file or database
17228 lookup (with semicolons doubled, because of the use of semicolon as a separator
17229 in a &%route_list%&).
17230
17231 The rules in &%route_list%& are searched in order until one of the patterns
17232 matches the domain that is being routed. The list of hosts and then options are
17233 then used as described below. If there is no match, the router declines. When
17234 &%route_list%& is set, &%route_data%& must not be set.
17235
17236
17237
17238 .section "Routing rules in route_data" "SECID121"
17239 The use of &%route_list%& is convenient when there are only a small number of
17240 routing rules. For larger numbers, it is easier to use a file or database to
17241 hold the routing information, and use the &%route_data%& option instead.
17242 The value of &%route_data%& is a list of hosts, followed by (optional) options.
17243 Most commonly, &%route_data%& is set as a string that contains an
17244 expansion lookup. For example, suppose we place two routing rules in a file
17245 like this:
17246 .code
17247 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
17248 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
17249 .endd
17250 This data can be accessed by setting
17251 .code
17252 route_data = ${lookup{$domain}lsearch{/the/file/name}}
17253 .endd
17254 Failure of the lookup results in an empty string, causing the router to
17255 decline. However, you do not have to use a lookup in &%route_data%&. The only
17256 requirement is that the result of expanding the string is a list of hosts,
17257 possibly followed by options, separated by white space. The list of hosts must
17258 be enclosed in quotes if it contains white space.
17259
17260
17261
17262
17263 .section "Format of the list of hosts" "SECID122"
17264 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
17265 always separately expanded before use. If the expansion fails, the router
17266 declines. The result of the expansion must be a colon-separated list of names
17267 and/or IP addresses, optionally also including ports. The format of each item
17268 in the list is described in the next section. The list separator can be changed
17269 as described in section &<<SECTlistconstruct>>&.
17270
17271 If the list of hosts was obtained from a &%route_list%& item, the following
17272 variables are set during its expansion:
17273
17274 .ilist
17275 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
17276 If the domain was matched against a regular expression, the numeric variables
17277 &$1$&, &$2$&, etc. may be set. For example:
17278 .code
17279 route_list = ^domain(\d+)   host-$1.text.example
17280 .endd
17281 .next
17282 &$0$& is always set to the entire domain.
17283 .next
17284 &$1$& is also set when partial matching is done in a file lookup.
17285
17286 .next
17287 .vindex "&$value$&"
17288 If the pattern that matched the domain was a lookup item, the data that was
17289 looked up is available in the expansion variable &$value$&. For example:
17290 .code
17291 route_list = lsearch;;/some/file.routes  $value
17292 .endd
17293 .endlist
17294
17295 Note the doubling of the semicolon in the pattern that is necessary because
17296 semicolon is the default route list separator.
17297
17298
17299
17300 .section "Format of one host item" "SECTformatonehostitem"
17301 Each item in the list of hosts is either a host name or an IP address,
17302 optionally with an attached port number. When no port is given, an IP address
17303 is not enclosed in brackets. When a port is specified, it overrides the port
17304 specification on the transport. The port is separated from the name or address
17305 by a colon. This leads to some complications:
17306
17307 .ilist
17308 Because colon is the default separator for the list of hosts, either
17309 the colon that specifies a port must be doubled, or the list separator must
17310 be changed. The following two examples have the same effect:
17311 .code
17312 route_list = * "host1.tld::1225 : host2.tld::1226"
17313 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
17314 .endd
17315 .next
17316 When IPv6 addresses are involved, it gets worse, because they contain
17317 colons of their own. To make this case easier, it is permitted to
17318 enclose an IP address (either v4 or v6) in square brackets if a port
17319 number follows. For example:
17320 .code
17321 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
17322 .endd
17323 .endlist
17324
17325 .section "How the list of hosts is used" "SECThostshowused"
17326 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
17327 the hosts is tried, in the order specified, when carrying out the SMTP
17328 delivery. However, the order can be changed by setting the &%hosts_randomize%&
17329 option, either on the router (see section &<<SECTprioptman>>& above), or on the
17330 transport.
17331
17332 Hosts may be listed by name or by IP address. An unadorned name in the list of
17333 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
17334 interpreted as an indirection to a sublist of hosts obtained by looking up MX
17335 records in the DNS. For example:
17336 .code
17337 route_list = *  x.y.z:p.q.r/MX:e.f.g
17338 .endd
17339 If this feature is used with a port specifier, the port must come last. For
17340 example:
17341 .code
17342 route_list = *  dom1.tld/mx::1225
17343 .endd
17344 If the &%hosts_randomize%& option is set, the order of the items in the list is
17345 randomized before any lookups are done. Exim then scans the list; for any name
17346 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
17347 be an interface on the local host and the item is not the first in the list,
17348 Exim discards it and any subsequent items. If it is the first item, what
17349 happens is controlled by the
17350 .oindex "&%self%&" "in &(manualroute)& router"
17351 &%self%& option of the router.
17352
17353 A name on the list that is followed by &`/MX`& is replaced with the list of
17354 hosts obtained by looking up MX records for the name. This is always a DNS
17355 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
17356 below) are not relevant here. The order of these hosts is determined by the
17357 preference values in the MX records, according to the usual rules. Because
17358 randomizing happens before the MX lookup, it does not affect the order that is
17359 defined by MX preferences.
17360
17361 If the local host is present in the sublist obtained from MX records, but is
17362 not the most preferred host in that list, it and any equally or less
17363 preferred hosts are removed before the sublist is inserted into the main list.
17364
17365 If the local host is the most preferred host in the MX list, what happens
17366 depends on where in the original list of hosts the &`/MX`& item appears. If it
17367 is not the first item (that is, there are previous hosts in the main list),
17368 Exim discards this name and any subsequent items in the main list.
17369
17370 If the MX item is first in the list of hosts, and the local host is the
17371 most preferred host, what happens is controlled by the &%self%& option of the
17372 router.
17373
17374 DNS failures when lookup up the MX records are treated in the same way as DNS
17375 failures when looking up IP addresses: &%pass_on_timeout%& and
17376 &%host_find_failed%& are used when relevant.
17377
17378 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
17379 whether obtained from an MX lookup or not.
17380
17381
17382
17383 .section "How the options are used" "SECThowoptused"
17384 The options are a sequence of words; in practice no more than three are ever
17385 present. One of the words can be the name of a transport; this overrides the
17386 &%transport%& option on the router for this particular routing rule only. The
17387 other words (if present) control randomization of the list of hosts on a
17388 per-rule basis, and how the IP addresses of the hosts are to be found when
17389 routing to a remote transport. These options are as follows:
17390
17391 .ilist
17392 &%randomize%&: randomize the order of the hosts in this list, overriding the
17393 setting of &%hosts_randomize%& for this routing rule only.
17394 .next
17395 &%no_randomize%&: do not randomize the order of the hosts in this list,
17396 overriding the setting of &%hosts_randomize%& for this routing rule only.
17397 .next
17398 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
17399 find IP addresses. This function may ultimately cause a DNS lookup, but it may
17400 also look in &_/etc/hosts_& or other sources of information.
17401 .next
17402 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
17403 no address records are found. If there is a temporary DNS error (such as a
17404 timeout), delivery is deferred.
17405 .endlist
17406
17407 For example:
17408 .code
17409 route_list = domain1  host1:host2:host3  randomize bydns;\
17410              domain2  host4:host5
17411 .endd
17412 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
17413 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
17414 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
17415 or &[gethostbyname()]&, and the result of the lookup is the result of that
17416 call.
17417
17418 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
17419 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
17420 instead of TRY_AGAIN. That is why the default action is to try a DNS
17421 lookup first. Only if that gives a definite &"no such host"& is the local
17422 function called.
17423
17424
17425
17426 If no IP address for a host can be found, what happens is controlled by the
17427 &%host_find_failed%& option.
17428
17429 .vindex "&$host$&"
17430 When an address is routed to a local transport, IP addresses are not looked up.
17431 The host list is passed to the transport in the &$host$& variable.
17432
17433
17434
17435 .section "Manualroute examples" "SECID123"
17436 In some of the examples that follow, the presence of the &%remote_smtp%&
17437 transport, as defined in the default configuration file, is assumed:
17438
17439 .ilist
17440 .cindex "smart host" "example router"
17441 The &(manualroute)& router can be used to forward all external mail to a
17442 &'smart host'&. If you have set up, in the main part of the configuration, a
17443 named domain list that contains your local domains, for example:
17444 .code
17445 domainlist local_domains = my.domain.example
17446 .endd
17447 You can arrange for all other domains to be routed to a smart host by making
17448 your first router something like this:
17449 .code
17450 smart_route:
17451   driver = manualroute
17452   domains = !+local_domains
17453   transport = remote_smtp
17454   route_list = * smarthost.ref.example
17455 .endd
17456 This causes all non-local addresses to be sent to the single host
17457 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
17458 they are tried in order
17459 (but you can use &%hosts_randomize%& to vary the order each time).
17460 Another way of configuring the same thing is this:
17461 .code
17462 smart_route:
17463   driver = manualroute
17464   transport = remote_smtp
17465   route_list = !+local_domains  smarthost.ref.example
17466 .endd
17467 There is no difference in behaviour between these two routers as they stand.
17468 However, they behave differently if &%no_more%& is added to them. In the first
17469 example, the router is skipped if the domain does not match the &%domains%&
17470 precondition; the following router is always tried. If the router runs, it
17471 always matches the domain and so can never decline. Therefore, &%no_more%&
17472 would have no effect. In the second case, the router is never skipped; it
17473 always runs. However, if it doesn't match the domain, it declines. In this case
17474 &%no_more%& would prevent subsequent routers from running.
17475
17476 .next
17477 .cindex "mail hub example"
17478 A &'mail hub'& is a host which receives mail for a number of domains via MX
17479 records in the DNS and delivers it via its own private routing mechanism. Often
17480 the final destinations are behind a firewall, with the mail hub being the one
17481 machine that can connect to machines both inside and outside the firewall. The
17482 &(manualroute)& router is usually used on a mail hub to route incoming messages
17483 to the correct hosts. For a small number of domains, the routing can be inline,
17484 using the &%route_list%& option, but for a larger number a file or database
17485 lookup is easier to manage.
17486
17487 If the domain names are in fact the names of the machines to which the mail is
17488 to be sent by the mail hub, the configuration can be quite simple. For
17489 example:
17490 .code
17491 hub_route:
17492   driver = manualroute
17493   transport = remote_smtp
17494   route_list = *.rhodes.tvs.example  $domain
17495 .endd
17496 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
17497 whose names are the same as the mail domains. A similar approach can be taken
17498 if the host name can be obtained from the domain name by a string manipulation
17499 that the expansion facilities can handle. Otherwise, a lookup based on the
17500 domain can be used to find the host:
17501 .code
17502 through_firewall:
17503   driver = manualroute
17504   transport = remote_smtp
17505   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
17506 .endd
17507 The result of the lookup must be the name or IP address of the host (or
17508 hosts) to which the address is to be routed. If the lookup fails, the route
17509 data is empty, causing the router to decline. The address then passes to the
17510 next router.
17511
17512 .next
17513 .cindex "batched SMTP output example"
17514 .cindex "SMTP" "batched outgoing; example"
17515 You can use &(manualroute)& to deliver messages to pipes or files in batched
17516 SMTP format for onward transportation by some other means. This is one way of
17517 storing mail for a dial-up host when it is not connected. The route list entry
17518 can be as simple as a single domain name in a configuration like this:
17519 .code
17520 save_in_file:
17521   driver = manualroute
17522   transport = batchsmtp_appendfile
17523   route_list = saved.domain.example
17524 .endd
17525 though often a pattern is used to pick up more than one domain. If there are
17526 several domains or groups of domains with different transport requirements,
17527 different transports can be listed in the routing information:
17528 .code
17529 save_in_file:
17530   driver = manualroute
17531   route_list = \
17532     *.saved.domain1.example  $domain  batch_appendfile; \
17533     *.saved.domain2.example  \
17534       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
17535       batch_pipe
17536 .endd
17537 .vindex "&$domain$&"
17538 .vindex "&$host$&"
17539 The first of these just passes the domain in the &$host$& variable, which
17540 doesn't achieve much (since it is also in &$domain$&), but the second does a
17541 file lookup to find a value to pass, causing the router to decline to handle
17542 the address if the lookup fails.
17543
17544 .next
17545 .cindex "UUCP" "example of router for"
17546 Routing mail directly to UUCP software is a specific case of the use of
17547 &(manualroute)& in a gateway to another mail environment. This is an example of
17548 one way it can be done:
17549 .code
17550 # Transport
17551 uucp:
17552   driver = pipe
17553   user = nobody
17554   command = /usr/local/bin/uux -r - \
17555     ${substr_-5:$host}!rmail ${local_part}
17556   return_fail_output = true
17557
17558 # Router
17559 uucphost:
17560   transport = uucp
17561   driver = manualroute
17562   route_data = \
17563     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
17564 .endd
17565 The file &_/usr/local/exim/uucphosts_& contains entries like
17566 .code
17567 darksite.ethereal.example:           darksite.UUCP
17568 .endd
17569 It can be set up more simply without adding and removing &".UUCP"& but this way
17570 makes clear the distinction between the domain name
17571 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
17572 .endlist
17573 .ecindex IIDmanrou1
17574 .ecindex IIDmanrou2
17575
17576
17577
17578
17579
17580
17581
17582
17583 . ////////////////////////////////////////////////////////////////////////////
17584 . ////////////////////////////////////////////////////////////////////////////
17585
17586 .chapter "The queryprogram router" "CHAPdriverlast"
17587 .scindex IIDquerou1 "&(queryprogram)& router"
17588 .scindex IIDquerou2 "routers" "&(queryprogram)&"
17589 .cindex "routing" "by external program"
17590 The &(queryprogram)& router routes an address by running an external command
17591 and acting on its output. This is an expensive way to route, and is intended
17592 mainly for use in lightly-loaded systems, or for performing experiments.
17593 However, if it is possible to use the precondition options (&%domains%&,
17594 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
17595 be used in special cases, even on a busy host. There are the following private
17596 options:
17597 .cindex "options" "&(queryprogram)& router"
17598
17599 .option command queryprogram string&!! unset
17600 This option must be set. It specifies the command that is to be run. The
17601 command is split up into a command name and arguments, and then each is
17602 expanded separately (exactly as for a &(pipe)& transport, described in chapter
17603 &<<CHAPpipetransport>>&).
17604
17605
17606 .option command_group queryprogram string unset
17607 .cindex "gid (group id)" "in &(queryprogram)& router"
17608 This option specifies a gid to be set when running the command while routing an
17609 address for deliver. It must be set if &%command_user%& specifies a numerical
17610 uid. If it begins with a digit, it is interpreted as the numerical value of the
17611 gid. Otherwise it is looked up using &[getgrnam()]&.
17612
17613
17614 .option command_user queryprogram string unset
17615 .cindex "uid (user id)" "for &(queryprogram)&"
17616 This option must be set. It specifies the uid which is set when running the
17617 command while routing an address for delivery. If the value begins with a digit,
17618 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
17619 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
17620 not set, a value for the gid also.
17621
17622 &*Warning:*& Changing uid and gid is possible only when Exim is running as
17623 root, which it does during a normal delivery in a conventional configuration.
17624 However, when an address is being verified during message reception, Exim is
17625 usually running as the Exim user, not as root. If the &(queryprogram)& router
17626 is called from a non-root process, Exim cannot change uid or gid before running
17627 the command. In this circumstance the command runs under the current uid and
17628 gid.
17629
17630
17631 .option current_directory queryprogram string /
17632 This option specifies an absolute path which is made the current directory
17633 before running the command.
17634
17635
17636 .option timeout queryprogram time 1h
17637 If the command does not complete within the timeout period, its process group
17638 is killed and the message is frozen. A value of zero time specifies no
17639 timeout.
17640
17641
17642 The standard output of the command is connected to a pipe, which is read when
17643 the command terminates. It should consist of a single line of output,
17644 containing up to five fields, separated by white space. The maximum length of
17645 the line is 1023 characters. Longer lines are silently truncated. The first
17646 field is one of the following words (case-insensitive):
17647
17648 .ilist
17649 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
17650 below).
17651 .next
17652 &'Decline'&: the router declines; pass the address to the next router, unless
17653 &%no_more%& is set.
17654 .next
17655 &'Fail'&: routing failed; do not pass the address to any more routers. Any
17656 subsequent text on the line is an error message. If the router is run as part
17657 of address verification during an incoming SMTP message, the message is
17658 included in the SMTP response.
17659 .next
17660 &'Defer'&: routing could not be completed at this time; try again later. Any
17661 subsequent text on the line is an error message which is logged. It is not
17662 included in any SMTP response.
17663 .next
17664 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
17665 .next
17666 &'Pass'&: pass the address to the next router (or the router specified by
17667 &%pass_router%&), overriding &%no_more%&.
17668 .next
17669 &'Redirect'&: the message is redirected. The remainder of the line is a list of
17670 new addresses, which are routed independently, starting with the first router,
17671 or the router specified by &%redirect_router%&, if set.
17672 .endlist
17673
17674 When the first word is &'accept'&, the remainder of the line consists of a
17675 number of keyed data values, as follows (split into two lines here, to fit on
17676 the page):
17677 .code
17678 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
17679 LOOKUP=byname|bydns DATA=<text>
17680 .endd
17681 The data items can be given in any order, and all are optional. If no transport
17682 is included, the transport specified by the generic &%transport%& option is
17683 used. The list of hosts and the lookup type are needed only if the transport is
17684 an &(smtp)& transport that does not itself supply a list of hosts.
17685
17686 The format of the list of hosts is the same as for the &(manualroute)& router.
17687 As well as host names and IP addresses with optional port numbers, as described
17688 in section &<<SECTformatonehostitem>>&, it may contain names followed by
17689 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
17690 (see section &<<SECThostshowused>>&).
17691
17692 If the lookup type is not specified, Exim behaves as follows when trying to
17693 find an IP address for each host: First, a DNS lookup is done. If this yields
17694 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
17695 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
17696 result of the lookup is the result of that call.
17697
17698 .vindex "&$address_data$&"
17699 If the DATA field is set, its value is placed in the &$address_data$&
17700 variable. For example, this return line
17701 .code
17702 accept hosts=x1.y.example:x2.y.example data="rule1"
17703 .endd
17704 routes the address to the default transport, passing a list of two hosts. When
17705 the transport runs, the string &"rule1"& is in &$address_data$&.
17706 .ecindex IIDquerou1
17707 .ecindex IIDquerou2
17708
17709
17710
17711
17712 . ////////////////////////////////////////////////////////////////////////////
17713 . ////////////////////////////////////////////////////////////////////////////
17714
17715 .chapter "The redirect router" "CHAPredirect"
17716 .scindex IIDredrou1 "&(redirect)& router"
17717 .scindex IIDredrou2 "routers" "&(redirect)&"
17718 .cindex "alias file" "in a &(redirect)& router"
17719 .cindex "address redirection" "&(redirect)& router"
17720 The &(redirect)& router handles several kinds of address redirection. Its most
17721 common uses are for resolving local part aliases from a central alias file
17722 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
17723 files, but it has many other potential uses. The incoming address can be
17724 redirected in several different ways:
17725
17726 .ilist
17727 It can be replaced by one or more new addresses which are themselves routed
17728 independently.
17729 .next
17730 It can be routed to be delivered to a given file or directory.
17731 .next
17732 It can be routed to be delivered to a specified pipe command.
17733 .next
17734 It can cause an automatic reply to be generated.
17735 .next
17736 It can be forced to fail, optionally with a custom error message.
17737 .next
17738 It can be temporarily deferred, optionally with a custom message.
17739 .next
17740 It can be discarded.
17741 .endlist
17742
17743 The generic &%transport%& option must not be set for &(redirect)& routers.
17744 However, there are some private options which define transports for delivery to
17745 files and pipes, and for generating autoreplies. See the &%file_transport%&,
17746 &%pipe_transport%& and &%reply_transport%& descriptions below.
17747
17748
17749
17750 .section "Redirection data" "SECID124"
17751 The router operates by interpreting a text string which it obtains either by
17752 expanding the contents of the &%data%& option, or by reading the entire
17753 contents of a file whose name is given in the &%file%& option. These two
17754 options are mutually exclusive. The first is commonly used for handling system
17755 aliases, in a configuration like this:
17756 .code
17757 system_aliases:
17758   driver = redirect
17759   data = ${lookup{$local_part}lsearch{/etc/aliases}}
17760 .endd
17761 If the lookup fails, the expanded string in this example is empty. When the
17762 expansion of &%data%& results in an empty string, the router declines. A forced
17763 expansion failure also causes the router to decline; other expansion failures
17764 cause delivery to be deferred.
17765
17766 A configuration using &%file%& is commonly used for handling users'
17767 &_.forward_& files, like this:
17768 .code
17769 userforward:
17770   driver = redirect
17771   check_local_user
17772   file = $home/.forward
17773   no_verify
17774 .endd
17775 If the file does not exist, or causes no action to be taken (for example, it is
17776 empty or consists only of comments), the router declines. &*Warning*&: This
17777 is not the case when the file contains syntactically valid items that happen to
17778 yield empty addresses, for example, items containing only RFC 2822 address
17779 comments.
17780
17781
17782
17783 .section "Forward files and address verification" "SECID125"
17784 .cindex "address redirection" "while verifying"
17785 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
17786 &_.forward_& files, as in the example above. There are two reasons for this:
17787
17788 .ilist
17789 When Exim is receiving an incoming SMTP message from a remote host, it is
17790 running under the Exim uid, not as root. Exim is unable to change uid to read
17791 the file as the user, and it may not be able to read it as the Exim user. So in
17792 practice the router may not be able to operate.
17793 .next
17794 However, even when the router can operate, the existence of a &_.forward_& file
17795 is unimportant when verifying an address. What should be checked is whether the
17796 local part is a valid user name or not. Cutting out the redirection processing
17797 saves some resources.
17798 .endlist
17799
17800
17801
17802
17803
17804
17805 .section "Interpreting redirection data" "SECID126"
17806 .cindex "Sieve filter" "specifying in redirection data"
17807 .cindex "filter" "specifying in redirection data"
17808 The contents of the data string, whether obtained from &%data%& or &%file%&,
17809 can be interpreted in two different ways:
17810
17811 .ilist
17812 If the &%allow_filter%& option is set true, and the data begins with the text
17813 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
17814 &'filtering'& instructions in the form of an Exim or Sieve filter file,
17815 respectively. Details of the syntax and semantics of filter files are described
17816 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
17817 document is intended for use by end users.
17818 .next
17819 Otherwise, the data must be a comma-separated list of redirection items, as
17820 described in the next section.
17821 .endlist
17822
17823 When a message is redirected to a file (a &"mail folder"&), the file name given
17824 in a non-filter redirection list must always be an absolute path. A filter may
17825 generate a relative path &-- how this is handled depends on the transport's
17826 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
17827 for the &(appendfile)& transport.
17828
17829
17830
17831 .section "Items in a non-filter redirection list" "SECTitenonfilred"
17832 .cindex "address redirection" "non-filter list items"
17833 When the redirection data is not an Exim or Sieve filter, for example, if it
17834 comes from a conventional alias or forward file, it consists of a list of
17835 addresses, file names, pipe commands, or certain special items (see section
17836 &<<SECTspecitredli>>& below). The special items can be individually enabled or
17837 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
17838 depending on their default values. The items in the list are separated by
17839 commas or newlines.
17840 If a comma is required in an item, the entire item must be enclosed in double
17841 quotes.
17842
17843 Lines starting with a # character are comments, and are ignored, and # may
17844 also appear following a comma, in which case everything between the # and the
17845 next newline character is ignored.
17846
17847 If an item is entirely enclosed in double quotes, these are removed. Otherwise
17848 double quotes are retained because some forms of mail address require their use
17849 (but never to enclose the entire address). In the following description,
17850 &"item"& refers to what remains after any surrounding double quotes have been
17851 removed.
17852
17853 .vindex "&$local_part$&"
17854 &*Warning*&: If you use an Exim expansion to construct a redirection address,
17855 and the expansion contains a reference to &$local_part$&, you should make use
17856 of the &%quote_local_part%& expansion operator, in case the local part contains
17857 special characters. For example, to redirect all mail for the domain
17858 &'obsolete.example'&, retaining the existing local part, you could use this
17859 setting:
17860 .code
17861 data = ${quote_local_part:$local_part}@newdomain.example
17862 .endd
17863
17864
17865 .section "Redirecting to a local mailbox" "SECTredlocmai"
17866 .cindex "routing" "loops in"
17867 .cindex "loop" "while routing, avoidance of"
17868 .cindex "address redirection" "to local mailbox"
17869 A redirection item may safely be the same as the address currently under
17870 consideration. This does not cause a routing loop, because a router is
17871 automatically skipped if any ancestor of the address that is being processed
17872 is the same as the current address and was processed by the current router.
17873 Such an address is therefore passed to the following routers, so it is handled
17874 as if there were no redirection. When making this loop-avoidance test, the
17875 complete local part, including any prefix or suffix, is used.
17876
17877 .cindex "address redirection" "local part without domain"
17878 Specifying the same local part without a domain is a common usage in personal
17879 filter files when the user wants to have messages delivered to the local
17880 mailbox and also forwarded elsewhere. For example, the user whose login is
17881 &'cleo'& might have a &_.forward_& file containing this:
17882 .code
17883 cleo, cleopatra@egypt.example
17884 .endd
17885 .cindex "backslash in alias file"
17886 .cindex "alias file" "backslash in"
17887 For compatibility with other MTAs, such unqualified local parts may be
17888 preceded by &"\"&, but this is not a requirement for loop prevention. However,
17889 it does make a difference if more than one domain is being handled
17890 synonymously.
17891
17892 If an item begins with &"\"& and the rest of the item parses as a valid RFC
17893 2822 address that does not include a domain, the item is qualified using the
17894 domain of the incoming address. In the absence of a leading &"\"&, unqualified
17895 addresses are qualified using the value in &%qualify_recipient%&, but you can
17896 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
17897
17898 Care must be taken if there are alias names for local users.
17899 Consider an MTA handling a single local domain where the system alias file
17900 contains:
17901 .code
17902 Sam.Reman: spqr
17903 .endd
17904 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
17905 messages in the local mailbox, and also forward copies elsewhere. He creates
17906 this forward file:
17907 .code
17908 Sam.Reman, spqr@reme.elsewhere.example
17909 .endd
17910 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
17911 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
17912 second time round, because it has previously routed it,
17913 and the following routers presumably cannot handle the alias. The forward file
17914 should really contain
17915 .code
17916 spqr, spqr@reme.elsewhere.example
17917 .endd
17918 but because this is such a common error, the &%check_ancestor%& option (see
17919 below) exists to provide a way to get round it. This is normally set on a
17920 &(redirect)& router that is handling users' &_.forward_& files.
17921
17922
17923
17924 .section "Special items in redirection lists" "SECTspecitredli"
17925 In addition to addresses, the following types of item may appear in redirection
17926 lists (that is, in non-filter redirection data):
17927
17928 .ilist
17929 .cindex "pipe" "in redirection list"
17930 .cindex "address redirection" "to pipe"
17931 An item is treated as a pipe command if it begins with &"|"& and does not parse
17932 as a valid RFC 2822 address that includes a domain. A transport for running the
17933 command must be specified by the &%pipe_transport%& option.
17934 Normally, either the router or the transport specifies a user and a group under
17935 which to run the delivery. The default is to use the Exim user and group.
17936
17937 Single or double quotes can be used for enclosing the individual arguments of
17938 the pipe command; no interpretation of escapes is done for single quotes. If
17939 the command contains a comma character, it is necessary to put the whole item
17940 in double quotes, for example:
17941 .code
17942 "|/some/command ready,steady,go"
17943 .endd
17944 since items in redirection lists are terminated by commas. Do not, however,
17945 quote just the command. An item such as
17946 .code
17947 |"/some/command ready,steady,go"
17948 .endd
17949 is interpreted as a pipe with a rather strange command name, and no arguments.
17950
17951 .next
17952 .cindex "file" "in redirection list"
17953 .cindex "address redirection" "to file"
17954 An item is interpreted as a path name if it begins with &"/"& and does not
17955 parse as a valid RFC 2822 address that includes a domain. For example,
17956 .code
17957 /home/world/minbari
17958 .endd
17959 is treated as a file name, but
17960 .code
17961 /s=molari/o=babylon/@x400gate.way
17962 .endd
17963 is treated as an address. For a file name, a transport must be specified using
17964 the &%file_transport%& option. However, if the generated path name ends with a
17965 forward slash character, it is interpreted as a directory name rather than a
17966 file name, and &%directory_transport%& is used instead.
17967
17968 Normally, either the router or the transport specifies a user and a group under
17969 which to run the delivery. The default is to use the Exim user and group.
17970
17971 .cindex "&_/dev/null_&"
17972 However, if a redirection item is the path &_/dev/null_&, delivery to it is
17973 bypassed at a high level, and the log entry shows &"**bypassed**"&
17974 instead of a transport name. In this case the user and group are not used.
17975
17976 .next
17977 .cindex "included address list"
17978 .cindex "address redirection" "included external list"
17979 If an item is of the form
17980 .code
17981 :include:<path name>
17982 .endd
17983 a list of further items is taken from the given file and included at that
17984 point. &*Note*&: Such a file can not be a filter file; it is just an
17985 out-of-line addition to the list. The items in the included list are separated
17986 by commas or newlines and are not subject to expansion. If this is the first
17987 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
17988 the alias name. This example is incorrect:
17989 .code
17990 list1    :include:/opt/lists/list1
17991 .endd
17992 It must be given as
17993 .code
17994 list1:   :include:/opt/lists/list1
17995 .endd
17996 .next
17997 .cindex "address redirection" "to black hole"
17998 Sometimes you want to throw away mail to a particular local part. Making the
17999 &%data%& option expand to an empty string does not work, because that causes
18000 the router to decline. Instead, the alias item
18001 .cindex "black hole"
18002 .cindex "abandoning mail"
18003 &':blackhole:'& can be used. It does what its name implies. No delivery is
18004 done, and no error message is generated. This has the same effect as specifing
18005 &_/dev/null_& as a destination, but it can be independently disabled.
18006
18007 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
18008 delivery is done for the original local part, even if other redirection items
18009 are present. If you are generating a multi-item list (for example, by reading a
18010 database) and need the ability to provide a no-op item, you must use
18011 &_/dev/null_&.
18012
18013 .next
18014 .cindex "delivery" "forcing failure"
18015 .cindex "delivery" "forcing deferral"
18016 .cindex "failing delivery" "forcing"
18017 .cindex "deferred delivery, forcing"
18018 .cindex "customizing" "failure message"
18019 An attempt to deliver a particular address can be deferred or forced to fail by
18020 redirection items of the form
18021 .code
18022 :defer:
18023 :fail:
18024 .endd
18025 respectively. When a redirection list contains such an item, it applies
18026 to the entire redirection; any other items in the list are ignored. Any
18027 text following &':fail:'& or &':defer:'& is placed in the error text
18028 associated with the failure. For example, an alias file might contain:
18029 .code
18030 X.Employee:  :fail: Gone away, no forwarding address
18031 .endd
18032 In the case of an address that is being verified from an ACL or as the subject
18033 of a
18034 .cindex "VRFY" "error text, display of"
18035 VRFY command, the text is included in the SMTP error response by
18036 default.
18037 .cindex "EXPN" "error text, display of"
18038 The text is not included in the response to an EXPN command. In non-SMTP cases
18039 the text is included in the error message that Exim generates.
18040
18041 .cindex "SMTP" "error codes"
18042 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
18043 &':fail:'&. However, if the message starts with three digits followed by a
18044 space, optionally followed by an extended code of the form &'n.n.n'&, also
18045 followed by a space, and the very first digit is the same as the default error
18046 code, the code from the message is used instead. If the very first digit is
18047 incorrect, a panic error is logged, and the default code is used. You can
18048 suppress the use of the supplied code in a redirect router by setting the
18049 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
18050 ignored.
18051
18052 .vindex "&$acl_verify_message$&"
18053 In an ACL, an explicitly provided message overrides the default, but the
18054 default message is available in the variable &$acl_verify_message$& and can
18055 therefore be included in a custom message if this is desired.
18056
18057 Normally the error text is the rest of the redirection list &-- a comma does
18058 not terminate it &-- but a newline does act as a terminator. Newlines are not
18059 normally present in alias expansions. In &(lsearch)& lookups they are removed
18060 as part of the continuation process, but they may exist in other kinds of
18061 lookup and in &':include:'& files.
18062
18063 During routing for message delivery (as opposed to verification), a redirection
18064 containing &':fail:'& causes an immediate failure of the incoming address,
18065 whereas &':defer:'& causes the message to remain on the queue so that a
18066 subsequent delivery attempt can happen at a later time. If an address is
18067 deferred for too long, it will ultimately fail, because the normal retry
18068 rules still apply.
18069
18070 .next
18071 .cindex "alias file" "exception to default"
18072 Sometimes it is useful to use a single-key search type with a default (see
18073 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
18074 for exceptions to the default. These can be handled by aliasing them to
18075 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
18076 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
18077 results in an empty redirection list has the same effect.
18078 .endlist
18079
18080
18081 .section "Duplicate addresses" "SECTdupaddr"
18082 .cindex "duplicate addresses"
18083 .cindex "address duplicate, discarding"
18084 .cindex "pipe" "duplicated"
18085 Exim removes duplicate addresses from the list to which it is delivering, so as
18086 to deliver just one copy to each address. This does not apply to deliveries
18087 routed to pipes by different immediate parent addresses, but an indirect
18088 aliasing scheme of the type
18089 .code
18090 pipe:       |/some/command $local_part
18091 localpart1: pipe
18092 localpart2: pipe
18093 .endd
18094 does not work with a message that is addressed to both local parts, because
18095 when the second is aliased to the intermediate local part &"pipe"& it gets
18096 discarded as being the same as a previously handled address. However, a scheme
18097 such as
18098 .code
18099 localpart1: |/some/command $local_part
18100 localpart2: |/some/command $local_part
18101 .endd
18102 does result in two different pipe deliveries, because the immediate parents of
18103 the pipes are distinct.
18104
18105
18106
18107 .section "Repeated redirection expansion" "SECID128"
18108 .cindex "repeated redirection expansion"
18109 .cindex "address redirection" "repeated for each delivery attempt"
18110 When a message cannot be delivered to all of its recipients immediately,
18111 leading to two or more delivery attempts, redirection expansion is carried out
18112 afresh each time for those addresses whose children were not all previously
18113 delivered. If redirection is being used as a mailing list, this can lead to new
18114 members of the list receiving copies of old messages. The &%one_time%& option
18115 can be used to avoid this.
18116
18117
18118 .section "Errors in redirection lists" "SECID129"
18119 .cindex "address redirection" "errors"
18120 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
18121 error is skipped, and an entry is written to the main log. This may be useful
18122 for mailing lists that are automatically managed. Otherwise, if an error is
18123 detected while generating the list of new addresses, the original address is
18124 deferred. See also &%syntax_errors_to%&.
18125
18126
18127
18128 .section "Private options for the redirect router" "SECID130"
18129
18130 .cindex "options" "&(redirect)& router"
18131 The private options for the &(redirect)& router are as follows:
18132
18133
18134 .option allow_defer redirect boolean false
18135 Setting this option allows the use of &':defer:'& in non-filter redirection
18136 data, or the &%defer%& command in an Exim filter file.
18137
18138
18139 .option allow_fail redirect boolean false
18140 .cindex "failing delivery" "from filter"
18141 If this option is true, the &':fail:'& item can be used in a redirection list,
18142 and the &%fail%& command may be used in an Exim filter file.
18143
18144
18145 .option allow_filter redirect boolean false
18146 .cindex "filter" "enabling use of"
18147 .cindex "Sieve filter" "enabling use of"
18148 Setting this option allows Exim to interpret redirection data that starts with
18149 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
18150 are some features of Exim filter files that some administrators may wish to
18151 lock out; see the &%forbid_filter_%&&'xxx'& options below.
18152
18153 It is also possible to lock out Exim filters or Sieve filters while allowing
18154 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
18155
18156
18157 The filter is run using the uid and gid set by the generic &%user%& and
18158 &%group%& options. These take their defaults from the password data if
18159 &%check_local_user%& is set, so in the normal case of users' personal filter
18160 files, the filter is run as the relevant user. When &%allow_filter%& is set
18161 true, Exim insists that either &%check_local_user%& or &%user%& is set.
18162
18163
18164
18165 .option allow_freeze redirect boolean false
18166 .cindex "freezing messages" "allowing in filter"
18167 Setting this option allows the use of the &%freeze%& command in an Exim filter.
18168 This command is more normally encountered in system filters, and is disabled by
18169 default for redirection filters because it isn't something you usually want to
18170 let ordinary users do.
18171
18172
18173
18174 .option check_ancestor redirect boolean false
18175 This option is concerned with handling generated addresses that are the same
18176 as some address in the list of redirection ancestors of the current address.
18177 Although it is turned off by default in the code, it is set in the default
18178 configuration file for handling users' &_.forward_& files. It is recommended
18179 for this use of the &(redirect)& router.
18180
18181 When &%check_ancestor%& is set, if a generated address (including the domain)
18182 is the same as any ancestor of the current address, it is replaced by a copy of
18183 the current address. This helps in the case where local part A is aliased to B,
18184 and B has a &_.forward_& file pointing back to A. For example, within a single
18185 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
18186 &_&~jb/.forward_& contains:
18187 .code
18188 \Joe.Bloggs, <other item(s)>
18189 .endd
18190 Without the &%check_ancestor%& setting, either local part (&"jb"& or
18191 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
18192 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
18193 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
18194 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
18195 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
18196 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
18197 original address. See also the &%repeat_use%& option below.
18198
18199
18200 .option check_group redirect boolean "see below"
18201 When the &%file%& option is used, the group owner of the file is checked only
18202 when this option is set. The permitted groups are those listed in the
18203 &%owngroups%& option, together with the user's default group if
18204 &%check_local_user%& is set. If the file has the wrong group, routing is
18205 deferred. The default setting for this option is true if &%check_local_user%&
18206 is set and the &%modemask%& option permits the group write bit, or if the
18207 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
18208
18209
18210
18211 .option check_owner redirect boolean "see below"
18212 When the &%file%& option is used, the owner of the file is checked only when
18213 this option is set. If &%check_local_user%& is set, the local user is
18214 permitted; otherwise the owner must be one of those listed in the &%owners%&
18215 option. The default value for this option is true if &%check_local_user%& or
18216 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
18217
18218
18219 .option data redirect string&!! unset
18220 This option is mutually exclusive with &%file%&. One or other of them must be
18221 set, but not both. The contents of &%data%& are expanded, and then used as the
18222 list of forwarding items, or as a set of filtering instructions. If the
18223 expansion is forced to fail, or the result is an empty string or a string that
18224 has no effect (consists entirely of comments), the router declines.
18225
18226 When filtering instructions are used, the string must begin with &"#Exim
18227 filter"&, and all comments in the string, including this initial one, must be
18228 terminated with newline characters. For example:
18229 .code
18230 data = #Exim filter\n\
18231        if $h_to: contains Exim then save $home/mail/exim endif
18232 .endd
18233 If you are reading the data from a database where newlines cannot be included,
18234 you can use the &${sg}$& expansion item to turn the escape string of your
18235 choice into a newline.
18236
18237
18238 .option directory_transport redirect string&!! unset
18239 A &(redirect)& router sets up a direct delivery to a directory when a path name
18240 ending with a slash is specified as a new &"address"&. The transport used is
18241 specified by this option, which, after expansion, must be the name of a
18242 configured transport. This should normally be an &(appendfile)& transport.
18243
18244
18245 .option file redirect string&!! unset
18246 This option specifies the name of a file that contains the redirection data. It
18247 is mutually exclusive with the &%data%& option. The string is expanded before
18248 use; if the expansion is forced to fail, the router declines. Other expansion
18249 failures cause delivery to be deferred. The result of a successful expansion
18250 must be an absolute path. The entire file is read and used as the redirection
18251 data. If the data is an empty string or a string that has no effect (consists
18252 entirely of comments), the router declines.
18253
18254 .cindex "NFS" "checking for file existence"
18255 If the attempt to open the file fails with a &"does not exist"& error, Exim
18256 runs a check on the containing directory,
18257 unless &%ignore_enotdir%& is true (see below).
18258 If the directory does not appear to exist, delivery is deferred. This can
18259 happen when users' &_.forward_& files are in NFS-mounted directories, and there
18260 is a mount problem. If the containing directory does exist, but the file does
18261 not, the router declines.
18262
18263
18264 .option file_transport redirect string&!! unset
18265 .vindex "&$address_file$&"
18266 A &(redirect)& router sets up a direct delivery to a file when a path name not
18267 ending in a slash is specified as a new &"address"&. The transport used is
18268 specified by this option, which, after expansion, must be the name of a
18269 configured transport. This should normally be an &(appendfile)& transport. When
18270 it is running, the file name is in &$address_file$&.
18271
18272
18273 .option filter_prepend_home redirect boolean true
18274 When this option is true, if a &(save)& command in an Exim filter specifies a
18275 relative path, and &$home$& is defined, it is automatically prepended to the
18276 relative path. If this option is set false, this action does not happen. The
18277 relative path is then passed to the transport unmodified.
18278
18279
18280 .option forbid_blackhole redirect boolean false
18281 If this option is true, the &':blackhole:'& item may not appear in a
18282 redirection list.
18283
18284
18285 .option forbid_exim_filter redirect boolean false
18286 If this option is set true, only Sieve filters are permitted when
18287 &%allow_filter%& is true.
18288
18289
18290
18291
18292 .option forbid_file redirect boolean false
18293 .cindex "delivery" "to file; forbidding"
18294 .cindex "Sieve filter" "forbidding delivery to a file"
18295 .cindex "Sieve filter" "&""keep""& facility; disabling"
18296 If this option is true, this router may not generate a new address that
18297 specifies delivery to a local file or directory, either from a filter or from a
18298 conventional forward file. This option is forced to be true if &%one_time%& is
18299 set. It applies to Sieve filters as well as to Exim filters, but if true, it
18300 locks out the Sieve's &"keep"& facility.
18301
18302
18303 .option forbid_filter_dlfunc redirect boolean false
18304 .cindex "filter" "locking out certain features"
18305 If this option is true, string expansions in Exim filters are not allowed to
18306 make use of the &%dlfunc%& expansion facility to run dynamically loaded
18307 functions.
18308
18309 .option forbid_filter_existstest redirect boolean false
18310 .cindex "expansion" "statting a file"
18311 If this option is true, string expansions in Exim filters are not allowed to
18312 make use of the &%exists%& condition or the &%stat%& expansion item.
18313
18314 .option forbid_filter_logwrite redirect boolean false
18315 If this option is true, use of the logging facility in Exim filters is not
18316 permitted. Logging is in any case available only if the filter is being run
18317 under some unprivileged uid (which is normally the case for ordinary users'
18318 &_.forward_& files).
18319
18320
18321 .option forbid_filter_lookup redirect boolean false
18322 If this option is true, string expansions in Exim filter files are not allowed
18323 to make use of &%lookup%& items.
18324
18325
18326 .option forbid_filter_perl redirect boolean false
18327 This option has an effect only if Exim is built with embedded Perl support. If
18328 it is true, string expansions in Exim filter files are not allowed to make use
18329 of the embedded Perl support.
18330
18331
18332 .option forbid_filter_readfile redirect boolean false
18333 If this option is true, string expansions in Exim filter files are not allowed
18334 to make use of &%readfile%& items.
18335
18336
18337 .option forbid_filter_readsocket redirect boolean false
18338 If this option is true, string expansions in Exim filter files are not allowed
18339 to make use of &%readsocket%& items.
18340
18341
18342 .option forbid_filter_reply redirect boolean false
18343 If this option is true, this router may not generate an automatic reply
18344 message. Automatic replies can be generated only from Exim or Sieve filter
18345 files, not from traditional forward files. This option is forced to be true if
18346 &%one_time%& is set.
18347
18348
18349 .option forbid_filter_run redirect boolean false
18350 If this option is true, string expansions in Exim filter files are not allowed
18351 to make use of &%run%& items.
18352
18353
18354 .option forbid_include redirect boolean false
18355 If this option is true, items of the form
18356 .code
18357 :include:<path name>
18358 .endd
18359 are not permitted in non-filter redirection lists.
18360
18361
18362 .option forbid_pipe redirect boolean false
18363 .cindex "delivery" "to pipe; forbidding"
18364 If this option is true, this router may not generate a new address which
18365 specifies delivery to a pipe, either from an Exim filter or from a conventional
18366 forward file. This option is forced to be true if &%one_time%& is set.
18367
18368
18369 .option forbid_sieve_filter redirect boolean false
18370 If this option is set true, only Exim filters are permitted when
18371 &%allow_filter%& is true.
18372
18373
18374 .cindex "SMTP" "error codes"
18375 .option forbid_smtp_code redirect boolean false
18376 If this option is set true, any SMTP error codes that are present at the start
18377 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
18378 the default codes (451 and 550, respectively) are always used.
18379
18380
18381
18382
18383 .option hide_child_in_errmsg redirect boolean false
18384 .cindex "bounce message" "redirection details; suppressing"
18385 If this option is true, it prevents Exim from quoting a child address if it
18386 generates a bounce or delay message for it. Instead it says &"an address
18387 generated from <&'the top level address'&>"&. Of course, this applies only to
18388 bounces generated locally. If a message is forwarded to another host, &'its'&
18389 bounce may well quote the generated address.
18390
18391
18392 .option ignore_eacces redirect boolean false
18393 .cindex "EACCES"
18394 If this option is set and an attempt to open a redirection file yields the
18395 EACCES error (permission denied), the &(redirect)& router behaves as if the
18396 file did not exist.
18397
18398
18399 .option ignore_enotdir redirect boolean false
18400 .cindex "ENOTDIR"
18401 If this option is set and an attempt to open a redirection file yields the
18402 ENOTDIR error (something on the path is not a directory), the &(redirect)&
18403 router behaves as if the file did not exist.
18404
18405 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
18406 router that has the &%file%& option set discovers that the file does not exist
18407 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
18408 against unmounted NFS directories. If the parent can not be statted, delivery
18409 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
18410 is set, because that option tells Exim to ignore &"something on the path is not
18411 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
18412 that some operating systems give ENOENT where others give ENOTDIR.
18413
18414
18415
18416 .option include_directory redirect string unset
18417 If this option is set, the path names of any &':include:'& items in a
18418 redirection list must start with this directory.
18419
18420
18421 .option modemask redirect "octal integer" 022
18422 This specifies mode bits which must not be set for a file specified by the
18423 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
18424
18425
18426 .option one_time redirect boolean false
18427 .cindex "one-time aliasing/forwarding expansion"
18428 .cindex "alias file" "one-time expansion"
18429 .cindex "forward file" "one-time expansion"
18430 .cindex "mailing lists" "one-time expansion"
18431 .cindex "address redirection" "one-time expansion"
18432 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
18433 files each time it tries to deliver a message causes a problem when one or more
18434 of the generated addresses fails be delivered at the first attempt. The problem
18435 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
18436 but of what happens when the redirection list changes during the time that the
18437 message is on Exim's queue. This is particularly true in the case of mailing
18438 lists, where new subscribers might receive copies of messages that were posted
18439 before they subscribed.
18440
18441 If &%one_time%& is set and any addresses generated by the router fail to
18442 deliver at the first attempt, the failing addresses are added to the message as
18443 &"top level"& addresses, and the parent address that generated them is marked
18444 &"delivered"&. Thus, redirection does not happen again at the next delivery
18445 attempt.
18446
18447 &*Warning 1*&: Any header line addition or removal that is specified by this
18448 router would be lost if delivery did not succeed at the first attempt. For this
18449 reason, the &%headers_add%& and &%headers_remove%& generic options are not
18450 permitted when &%one_time%& is set.
18451
18452 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
18453 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
18454 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
18455
18456 &*Warning 3*&: The &%unseen%& generic router option may not be set with
18457 &%one_time%&.
18458
18459 The original top-level address is remembered with each of the generated
18460 addresses, and is output in any log messages. However, any intermediate parent
18461 addresses are not recorded. This makes a difference to the log only if
18462 &%all_parents%& log selector is set. It is expected that &%one_time%& will
18463 typically be used for mailing lists, where there is normally just one level of
18464 expansion.
18465
18466
18467 .option owners redirect "string list" unset
18468 .cindex "ownership" "alias file"
18469 .cindex "ownership" "forward file"
18470 .cindex "alias file" "ownership"
18471 .cindex "forward file" "ownership"
18472 This specifies a list of permitted owners for the file specified by &%file%&.
18473 This list is in addition to the local user when &%check_local_user%& is set.
18474 See &%check_owner%& above.
18475
18476
18477 .option owngroups redirect "string list" unset
18478 This specifies a list of permitted groups for the file specified by &%file%&.
18479 The list is in addition to the local user's primary group when
18480 &%check_local_user%& is set. See &%check_group%& above.
18481
18482
18483 .option pipe_transport redirect string&!! unset
18484 .vindex "&$address_pipe$&"
18485 A &(redirect)& router sets up a direct delivery to a pipe when a string
18486 starting with a vertical bar character is specified as a new &"address"&. The
18487 transport used is specified by this option, which, after expansion, must be the
18488 name of a configured transport. This should normally be a &(pipe)& transport.
18489 When the transport is run, the pipe command is in &$address_pipe$&.
18490
18491
18492 .option qualify_domain redirect string&!! unset
18493 .vindex "&$qualify_recipient$&"
18494 If this option is set, and an unqualified address (one without a domain) is
18495 generated, and that address would normally be qualified by the global setting
18496 in &%qualify_recipient%&, it is instead qualified with the domain specified by
18497 expanding this string. If the expansion fails, the router declines. If you want
18498 to revert to the default, you can have the expansion generate
18499 &$qualify_recipient$&.
18500
18501 This option applies to all unqualified addresses generated by Exim filters,
18502 but for traditional &_.forward_& files, it applies only to addresses that are
18503 not preceded by a backslash. Sieve filters cannot generate unqualified
18504 addresses.
18505
18506 .option qualify_preserve_domain redirect boolean false
18507 .cindex "domain" "in redirection; preserving"
18508 .cindex "preserving domain in redirection"
18509 .cindex "address redirection" "domain; preserving"
18510 If this option is set, the router's local &%qualify_domain%& option must not be
18511 set (a configuration error occurs if it is). If an unqualified address (one
18512 without a domain) is generated, it is qualified with the domain of the parent
18513 address (the immediately preceding ancestor) instead of the global
18514 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
18515 this applies whether or not the address is preceded by a backslash.
18516
18517
18518 .option repeat_use redirect boolean true
18519 If this option is set false, the router is skipped for a child address that has
18520 any ancestor that was routed by this router. This test happens before any of
18521 the other preconditions are tested. Exim's default anti-looping rules skip
18522 only when the ancestor is the same as the current address. See also
18523 &%check_ancestor%& above and the generic &%redirect_router%& option.
18524
18525
18526 .option reply_transport redirect string&!! unset
18527 A &(redirect)& router sets up an automatic reply when a &%mail%& or
18528 &%vacation%& command is used in a filter file. The transport used is specified
18529 by this option, which, after expansion, must be the name of a configured
18530 transport. This should normally be an &(autoreply)& transport. Other transports
18531 are unlikely to do anything sensible or useful.
18532
18533
18534 .option rewrite redirect boolean true
18535 .cindex "address redirection" "disabling rewriting"
18536 If this option is set false, addresses generated by the router are not
18537 subject to address rewriting. Otherwise, they are treated like new addresses
18538 and are rewritten according to the global rewriting rules.
18539
18540
18541 .option sieve_subaddress redirect string&!! unset
18542 The value of this option is passed to a Sieve filter to specify the
18543 :subaddress part of an address.
18544
18545 .option sieve_useraddress redirect string&!! unset
18546 The value of this option is passed to a Sieve filter to specify the :user part
18547 of an address. However, if it is unset, the entire original local part
18548 (including any prefix or suffix) is used for :user.
18549
18550
18551 .option sieve_vacation_directory redirect string&!! unset
18552 .cindex "Sieve filter" "vacation directory"
18553 To enable the &"vacation"& extension for Sieve filters, you must set
18554 &%sieve_vacation_directory%& to the directory where vacation databases are held
18555 (do not put anything else in that directory), and ensure that the
18556 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
18557 needs their own directory; Exim will create it if necessary.
18558
18559
18560
18561 .option skip_syntax_errors redirect boolean false
18562 .cindex "forward file" "broken"
18563 .cindex "address redirection" "broken files"
18564 .cindex "alias file" "broken"
18565 .cindex "broken alias or forward files"
18566 .cindex "ignoring faulty addresses"
18567 .cindex "skipping faulty addresses"
18568 .cindex "error" "skipping bad syntax"
18569 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
18570 non-filter redirection data are skipped, and each failing address is logged. If
18571 &%syntax_errors_to%& is set, a message is sent to the address it defines,
18572 giving details of the failures. If &%syntax_errors_text%& is set, its contents
18573 are expanded and placed at the head of the error message generated by
18574 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
18575 be the same address as the generic &%errors_to%& option. The
18576 &%skip_syntax_errors%& option is often used when handling mailing lists.
18577
18578 If all the addresses in a redirection list are skipped because of syntax
18579 errors, the router declines to handle the original address, and it is passed to
18580 the following routers.
18581
18582 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
18583 error in the filter causes filtering to be abandoned without any action being
18584 taken. The incident is logged, and the router declines to handle the address,
18585 so it is passed to the following routers.
18586
18587 .cindex "Sieve filter" "syntax errors in"
18588 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
18589 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
18590 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
18591
18592 &%skip_syntax_errors%& can be used to specify that errors in users' forward
18593 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
18594 option, used with an address that does not get redirected, can be used to
18595 notify users of these errors, by means of a router like this:
18596 .code
18597 userforward:
18598   driver = redirect
18599   allow_filter
18600   check_local_user
18601   file = $home/.forward
18602   file_transport = address_file
18603   pipe_transport = address_pipe
18604   reply_transport = address_reply
18605   no_verify
18606   skip_syntax_errors
18607   syntax_errors_to = real-$local_part@$domain
18608   syntax_errors_text = \
18609    This is an automatically generated message. An error has\n\
18610    been found in your .forward file. Details of the error are\n\
18611    reported below. While this error persists, you will receive\n\
18612    a copy of this message for every message that is addressed\n\
18613    to you. If your .forward file is a filter file, or if it is\n\
18614    a non-filter file containing no valid forwarding addresses,\n\
18615    a copy of each incoming message will be put in your normal\n\
18616    mailbox. If a non-filter file contains at least one valid\n\
18617    forwarding address, forwarding to the valid addresses will\n\
18618    happen, and those will be the only deliveries that occur.
18619 .endd
18620 You also need a router to ensure that local addresses that are prefixed by
18621 &`real-`& are recognized, but not forwarded or filtered. For example, you could
18622 put this immediately before the &(userforward)& router:
18623 .code
18624 real_localuser:
18625   driver = accept
18626   check_local_user
18627   local_part_prefix = real-
18628   transport = local_delivery
18629 .endd
18630 For security, it would probably be a good idea to restrict the use of this
18631 router to locally-generated messages, using a condition such as this:
18632 .code
18633   condition = ${if match {$sender_host_address}\
18634                          {\N^(|127\.0\.0\.1)$\N}}
18635 .endd
18636
18637
18638 .option syntax_errors_text redirect string&!! unset
18639 See &%skip_syntax_errors%& above.
18640
18641
18642 .option syntax_errors_to redirect string unset
18643 See &%skip_syntax_errors%& above.
18644 .ecindex IIDredrou1
18645 .ecindex IIDredrou2
18646
18647
18648
18649
18650
18651
18652 . ////////////////////////////////////////////////////////////////////////////
18653 . ////////////////////////////////////////////////////////////////////////////
18654
18655 .chapter "Environment for running local transports" "CHAPenvironment" &&&
18656          "Environment for local transports"
18657 .scindex IIDenvlotra1 "local transports" "environment for"
18658 .scindex IIDenvlotra2 "environment for local transports"
18659 .scindex IIDenvlotra3 "transport" "local; environment for"
18660 Local transports handle deliveries to files and pipes. (The &(autoreply)&
18661 transport can be thought of as similar to a pipe.) Exim always runs transports
18662 in subprocesses, under specified uids and gids. Typical deliveries to local
18663 mailboxes run under the uid and gid of the local user.
18664
18665 Exim also sets a specific current directory while running the transport; for
18666 some transports a home directory setting is also relevant. The &(pipe)&
18667 transport is the only one that sets up environment variables; see section
18668 &<<SECTpipeenv>>& for details.
18669
18670 The values used for the uid, gid, and the directories may come from several
18671 different places. In many cases, the router that handles the address associates
18672 settings with that address as a result of its &%check_local_user%&, &%group%&,
18673 or &%user%& options. However, values may also be given in the transport's own
18674 configuration, and these override anything that comes from the router.
18675
18676
18677
18678 .section "Concurrent deliveries" "SECID131"
18679 .cindex "concurrent deliveries"
18680 .cindex "simultaneous deliveries"
18681 If two different messages for the same local recipient arrive more or less
18682 simultaneously, the two delivery processes are likely to run concurrently. When
18683 the &(appendfile)& transport is used to write to a file, Exim applies locking
18684 rules to stop concurrent processes from writing to the same file at the same
18685 time.
18686
18687 However, when you use a &(pipe)& transport, it is up to you to arrange any
18688 locking that is needed. Here is a silly example:
18689 .code
18690 my_transport:
18691   driver = pipe
18692   command = /bin/sh -c 'cat >>/some/file'
18693 .endd
18694 This is supposed to write the message at the end of the file. However, if two
18695 messages arrive at the same time, the file will be scrambled. You can use the
18696 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
18697 file using the same algorithm that Exim itself uses.
18698
18699
18700
18701
18702 .section "Uids and gids" "SECTenvuidgid"
18703 .cindex "local transports" "uid and gid"
18704 .cindex "transport" "local; uid and gid"
18705 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
18706 overrides any group that the router set in the address, even if &%user%& is not
18707 set for the transport. This makes it possible, for example, to run local mail
18708 delivery under the uid of the recipient (set by the router), but in a special
18709 group (set by the transport). For example:
18710 .code
18711 # Routers ...
18712 # User/group are set by check_local_user in this router
18713 local_users:
18714   driver = accept
18715   check_local_user
18716   transport = group_delivery
18717
18718 # Transports ...
18719 # This transport overrides the group
18720 group_delivery:
18721   driver = appendfile
18722   file = /var/spool/mail/$local_part
18723   group = mail
18724 .endd
18725 If &%user%& is set for a transport, its value overrides what is set in the
18726 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
18727 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
18728 set.
18729
18730 .oindex "&%initgroups%&"
18731 When the uid is taken from the transport's configuration, the &[initgroups()]&
18732 function is called for the groups associated with that uid if the
18733 &%initgroups%& option is set for the transport. When the uid is not specified
18734 by the transport, but is associated with the address by a router, the option
18735 for calling &[initgroups()]& is taken from the router configuration.
18736
18737 .cindex "&(pipe)& transport" "uid for"
18738 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
18739 is set and &%user%& is not set, the uid of the process that called Exim to
18740 receive the message is used, and if &%group%& is not set, the corresponding
18741 original gid is also used.
18742
18743 This is the detailed preference order for obtaining a gid; the first of the
18744 following that is set is used:
18745
18746 .ilist
18747 A &%group%& setting of the transport;
18748 .next
18749 A &%group%& setting of the router;
18750 .next
18751 A gid associated with a user setting of the router, either as a result of
18752 &%check_local_user%& or an explicit non-numeric &%user%& setting;
18753 .next
18754 The group associated with a non-numeric &%user%& setting of the transport;
18755 .next
18756 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
18757 the uid is the creator's uid;
18758 .next
18759 The Exim gid if the Exim uid is being used as a default.
18760 .endlist
18761
18762 If, for example, the user is specified numerically on the router and there are
18763 no group settings, no gid is available. In this situation, an error occurs.
18764 This is different for the uid, for which there always is an ultimate default.
18765 The first of the following that is set is used:
18766
18767 .ilist
18768 A &%user%& setting of the transport;
18769 .next
18770 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
18771 .next
18772 A &%user%& setting of the router;
18773 .next
18774 A &%check_local_user%& setting of the router;
18775 .next
18776 The Exim uid.
18777 .endlist
18778
18779 Of course, an error will still occur if the uid that is chosen is on the
18780 &%never_users%& list.
18781
18782
18783
18784
18785
18786 .section "Current and home directories" "SECID132"
18787 .cindex "current directory for local transport"
18788 .cindex "home directory" "for local transport"
18789 .cindex "transport" "local; home directory for"
18790 .cindex "transport" "local; current directory for"
18791 Routers may set current and home directories for local transports by means of
18792 the &%transport_current_directory%& and &%transport_home_directory%& options.
18793 However, if the transport's &%current_directory%& or &%home_directory%& options
18794 are set, they override the router's values. In detail, the home directory
18795 for a local transport is taken from the first of these values that is set:
18796
18797 .ilist
18798 The &%home_directory%& option on the transport;
18799 .next
18800 The &%transport_home_directory%& option on the router;
18801 .next
18802 The password data if &%check_local_user%& is set on the router;
18803 .next
18804 The &%router_home_directory%& option on the router.
18805 .endlist
18806
18807 The current directory is taken from the first of these values that is set:
18808
18809 .ilist
18810 The &%current_directory%& option on the transport;
18811 .next
18812 The &%transport_current_directory%& option on the router.
18813 .endlist
18814
18815
18816 If neither the router nor the transport sets a current directory, Exim uses the
18817 value of the home directory, if it is set. Otherwise it sets the current
18818 directory to &_/_& before running a local transport.
18819
18820
18821
18822 .section "Expansion variables derived from the address" "SECID133"
18823 .vindex "&$domain$&"
18824 .vindex "&$local_part$&"
18825 .vindex "&$original_domain$&"
18826 Normally a local delivery is handling a single address, and in that case the
18827 variables such as &$domain$& and &$local_part$& are set during local
18828 deliveries. However, in some circumstances more than one address may be handled
18829 at once (for example, while writing batch SMTP for onward transmission by some
18830 other means). In this case, the variables associated with the local part are
18831 never set, &$domain$& is set only if all the addresses have the same domain,
18832 and &$original_domain$& is never set.
18833 .ecindex IIDenvlotra1
18834 .ecindex IIDenvlotra2
18835 .ecindex IIDenvlotra3
18836
18837
18838
18839
18840
18841
18842
18843 . ////////////////////////////////////////////////////////////////////////////
18844 . ////////////////////////////////////////////////////////////////////////////
18845
18846 .chapter "Generic options for transports" "CHAPtransportgeneric"
18847 .scindex IIDgenoptra1 "generic options" "transport"
18848 .scindex IIDgenoptra2 "options" "generic; for transports"
18849 .scindex IIDgenoptra3 "transport" "generic options for"
18850 The following generic options apply to all transports:
18851
18852
18853 .option body_only transports boolean false
18854 .cindex "transport" "body only"
18855 .cindex "message" "transporting body only"
18856 .cindex "body of message" "transporting"
18857 If this option is set, the message's headers are not transported. It is
18858 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
18859 or &(pipe)& transports, the settings of &%message_prefix%& and
18860 &%message_suffix%& should be checked, because this option does not
18861 automatically suppress them.
18862
18863
18864 .option current_directory transports string&!! unset
18865 .cindex "transport" "current directory for"
18866 This specifies the current directory that is to be set while running the
18867 transport, overriding any value that may have been set by the router.
18868 If the expansion fails for any reason, including forced failure, an error is
18869 logged, and delivery is deferred.
18870
18871
18872 .option disable_logging transports boolean false
18873 If this option is set true, nothing is logged for any
18874 deliveries by the transport or for any
18875 transport errors. You should not set this option unless you really, really know
18876 what you are doing.
18877
18878
18879 .option debug_print transports string&!! unset
18880 .cindex "testing" "variables in drivers"
18881 If this option is set and debugging is enabled (see the &%-d%& command line
18882 option), the string is expanded and included in the debugging output when the
18883 transport is run.
18884 If expansion of the string fails, the error message is written to the debugging
18885 output, and Exim carries on processing.
18886 This facility is provided to help with checking out the values of variables and
18887 so on when debugging driver configurations. For example, if a &%headers_add%&
18888 option is not working properly, &%debug_print%& could be used to output the
18889 variables it references. A newline is added to the text if it does not end with
18890 one.
18891
18892
18893 .option delivery_date_add transports boolean false
18894 .cindex "&'Delivery-date:'& header line"
18895 If this option is true, a &'Delivery-date:'& header is added to the message.
18896 This gives the actual time the delivery was made. As this is not a standard
18897 header, Exim has a configuration option (&%delivery_date_remove%&) which
18898 requests its removal from incoming messages, so that delivered messages can
18899 safely be resent to other recipients.
18900
18901
18902 .option driver transports string unset
18903 This specifies which of the available transport drivers is to be used.
18904 There is no default, and this option must be set for every transport.
18905
18906
18907 .option envelope_to_add transports boolean false
18908 .cindex "&'Envelope-to:'& header line"
18909 If this option is true, an &'Envelope-to:'& header is added to the message.
18910 This gives the original address(es) in the incoming envelope that caused this
18911 delivery to happen. More than one address may be present if the transport is
18912 configured to handle several addresses at once, or if more than one original
18913 address was redirected to the same final address. As this is not a standard
18914 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
18915 its removal from incoming messages, so that delivered messages can safely be
18916 resent to other recipients.
18917
18918
18919 .option group transports string&!! "Exim group"
18920 .cindex "transport" "group; specifying"
18921 This option specifies a gid for running the transport process, overriding any
18922 value that the router supplies, and also overriding any value associated with
18923 &%user%& (see below).
18924
18925
18926 .option headers_add transports string&!! unset
18927 .cindex "header lines" "adding in transport"
18928 .cindex "transport" "header lines; adding"
18929 This option specifies a string of text that is expanded and added to the header
18930 portion of a message as it is transported, as described in section
18931 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
18932 routers. If the result of the expansion is an empty string, or if the expansion
18933 is forced to fail, no action is taken. Other expansion failures are treated as
18934 errors and cause the delivery to be deferred.
18935
18936
18937
18938 .option headers_only transports boolean false
18939 .cindex "transport" "header lines only"
18940 .cindex "message" "transporting headers only"
18941 .cindex "header lines" "transporting"
18942 If this option is set, the message's body is not transported. It is mutually
18943 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
18944 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
18945 checked, since this option does not automatically suppress them.
18946
18947
18948 .option headers_remove transports string&!! unset
18949 .cindex "header lines" "removing"
18950 .cindex "transport" "header lines; removing"
18951 This option specifies a string that is expanded into a list of header names;
18952 these headers are omitted from the message as it is transported, as described
18953 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
18954 routers. If the result of the expansion is an empty string, or if the expansion
18955 is forced to fail, no action is taken. Other expansion failures are treated as
18956 errors and cause the delivery to be deferred.
18957
18958
18959
18960 .option headers_rewrite transports string unset
18961 .cindex "transport" "header lines; rewriting"
18962 .cindex "rewriting" "at transport time"
18963 This option allows addresses in header lines to be rewritten at transport time,
18964 that is, as the message is being copied to its destination. The contents of the
18965 option are a colon-separated list of rewriting rules. Each rule is in exactly
18966 the same form as one of the general rewriting rules that are applied when a
18967 message is received. These are described in chapter &<<CHAPrewrite>>&. For
18968 example,
18969 .code
18970 headers_rewrite = a@b c@d f : \
18971                   x@y w@z
18972 .endd
18973 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
18974 &'w@z'& in all address-bearing header lines. The rules are applied to the
18975 header lines just before they are written out at transport time, so they affect
18976 only those copies of the message that pass through the transport. However, only
18977 the message's original header lines, and any that were added by a system
18978 filter, are rewritten. If a router or transport adds header lines, they are not
18979 affected by this option. These rewriting rules are &'not'& applied to the
18980 envelope. You can change the return path using &%return_path%&, but you cannot
18981 change envelope recipients at this time.
18982
18983
18984 .option home_directory transports string&!! unset
18985 .cindex "transport" "home directory for"
18986 .vindex "&$home$&"
18987 This option specifies a home directory setting for a local transport,
18988 overriding any value that may be set by the router. The home directory is
18989 placed in &$home$& while expanding the transport's private options. It is also
18990 used as the current directory if no current directory is set by the
18991 &%current_directory%& option on the transport or the
18992 &%transport_current_directory%& option on the router. If the expansion fails
18993 for any reason, including forced failure, an error is logged, and delivery is
18994 deferred.
18995
18996
18997 .option initgroups transports boolean false
18998 .cindex "additional groups"
18999 .cindex "groups" "additional"
19000 .cindex "transport" "group; additional"
19001 If this option is true and the uid for the delivery process is provided by the
19002 transport, the &[initgroups()]& function is called when running the transport
19003 to ensure that any additional groups associated with the uid are set up.
19004
19005
19006 .option message_size_limit transports string&!! 0
19007 .cindex "limit" "message size per transport"
19008 .cindex "size" "of message, limit"
19009 .cindex "transport" "message size; limiting"
19010 This option controls the size of messages passed through the transport. It is
19011 expanded before use; the result of the expansion must be a sequence of decimal
19012 digits, optionally followed by K or M. If the expansion fails for any reason,
19013 including forced failure, or if the result is not of the required form,
19014 delivery is deferred. If the value is greater than zero and the size of a
19015 message exceeds this limit, the address is failed. If there is any chance that
19016 the resulting bounce message could be routed to the same transport, you should
19017 ensure that &%return_size_limit%& is less than the transport's
19018 &%message_size_limit%&, as otherwise the bounce message will fail to get
19019 delivered.
19020
19021
19022
19023 .option rcpt_include_affixes transports boolean false
19024 .cindex "prefix" "for local part, including in envelope"
19025 .cindex "suffix for local part" "including in envelope"
19026 .cindex "local part" "prefix"
19027 .cindex "local part" "suffix"
19028 When this option is false (the default), and an address that has had any
19029 affixes (prefixes or suffixes) removed from the local part is delivered by any
19030 form of SMTP or LMTP, the affixes are not included. For example, if a router
19031 that contains
19032 .code
19033 local_part_prefix = *-
19034 .endd
19035 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
19036 is delivered with
19037 .code
19038 RCPT TO:<xyz@some.domain>
19039 .endd
19040 This is also the case when an ACL-time callout is being used to verify a
19041 recipient address. However, if &%rcpt_include_affixes%& is set true, the
19042 whole local part is included in the RCPT command. This option applies to BSMTP
19043 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
19044 &(lmtp)& and &(smtp)& transports.
19045
19046
19047 .option retry_use_local_part transports boolean "see below"
19048 .cindex "hints database" "retry keys"
19049 When a delivery suffers a temporary failure, a retry record is created
19050 in Exim's hints database. For remote deliveries, the key for the retry record
19051 is based on the name and/or IP address of the failing remote host. For local
19052 deliveries, the key is normally the entire address, including both the local
19053 part and the domain. This is suitable for most common cases of local delivery
19054 temporary failure &-- for example, exceeding a mailbox quota should delay only
19055 deliveries to that mailbox, not to the whole domain.
19056
19057 However, in some special cases you may want to treat a temporary local delivery
19058 as a failure associated with the domain, and not with a particular local part.
19059 (For example, if you are storing all mail for some domain in files.) You can do
19060 this by setting &%retry_use_local_part%& false.
19061
19062 For all the local transports, its default value is true. For remote transports,
19063 the default value is false for tidiness, but changing the value has no effect
19064 on a remote transport in the current implementation.
19065
19066
19067 .option return_path transports string&!! unset
19068 .cindex "envelope sender"
19069 .cindex "transport" "return path; changing"
19070 .cindex "return path" "changing in transport"
19071 If this option is set, the string is expanded at transport time and replaces
19072 the existing return path (envelope sender) value in the copy of the message
19073 that is being delivered. An empty return path is permitted. This feature is
19074 designed for remote deliveries, where the value of this option is used in the
19075 SMTP MAIL command. If you set &%return_path%& for a local transport, the
19076 only effect is to change the address that is placed in the &'Return-path:'&
19077 header line, if one is added to the message (see the next option).
19078
19079 &*Note:*& A changed return path is not logged unless you add
19080 &%return_path_on_delivery%& to the log selector.
19081
19082 .vindex "&$return_path$&"
19083 The expansion can refer to the existing value via &$return_path$&. This is
19084 either the message's envelope sender, or an address set by the
19085 &%errors_to%& option on a router. If the expansion is forced to fail, no
19086 replacement occurs; if it fails for another reason, delivery is deferred. This
19087 option can be used to support VERP (Variable Envelope Return Paths) &-- see
19088 section &<<SECTverp>>&.
19089
19090 &*Note*&: If a delivery error is detected locally, including the case when a
19091 remote server rejects a message at SMTP time, the bounce message is not sent to
19092 the value of this option. It is sent to the previously set errors address.
19093 This defaults to the incoming sender address, but can be changed by setting
19094 &%errors_to%& in a router.
19095
19096
19097
19098 .option return_path_add transports boolean false
19099 .cindex "&'Return-path:'& header line"
19100 If this option is true, a &'Return-path:'& header is added to the message.
19101 Although the return path is normally available in the prefix line of BSD
19102 mailboxes, this is commonly not displayed by MUAs, and so the user does not
19103 have easy access to it.
19104
19105 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
19106 the delivery SMTP server makes the final delivery"&. This implies that this
19107 header should not be present in incoming messages. Exim has a configuration
19108 option, &%return_path_remove%&, which requests removal of this header from
19109 incoming messages, so that delivered messages can safely be resent to other
19110 recipients.
19111
19112
19113 .option shadow_condition transports string&!! unset
19114 See &%shadow_transport%& below.
19115
19116
19117 .option shadow_transport transports string unset
19118 .cindex "shadow transport"
19119 .cindex "transport" "shadow"
19120 A local transport may set the &%shadow_transport%& option to the name of
19121 another local transport. Shadow remote transports are not supported.
19122
19123 Whenever a delivery to the main transport succeeds, and either
19124 &%shadow_condition%& is unset, or its expansion does not result in the empty
19125 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
19126 passed to the shadow transport, with the same delivery address or addresses. If
19127 expansion fails, no action is taken except that non-forced expansion failures
19128 cause a log line to be written.
19129
19130 The result of the shadow transport is discarded and does not affect the
19131 subsequent processing of the message. Only a single level of shadowing is
19132 provided; the &%shadow_transport%& option is ignored on any transport when it
19133 is running as a shadow. Options concerned with output from pipes are also
19134 ignored. The log line for the successful delivery has an item added on the end,
19135 of the form
19136 .code
19137 ST=<shadow transport name>
19138 .endd
19139 If the shadow transport did not succeed, the error message is put in
19140 parentheses afterwards. Shadow transports can be used for a number of different
19141 purposes, including keeping more detailed log information than Exim normally
19142 provides, and implementing automatic acknowledgment policies based on message
19143 headers that some sites insist on.
19144
19145
19146 .option transport_filter transports string&!! unset
19147 .cindex "transport" "filter"
19148 .cindex "filter" "transport filter"
19149 This option sets up a filtering (in the Unix shell sense) process for messages
19150 at transport time. It should not be confused with mail filtering as set up by
19151 individual users or via a system filter.
19152
19153 When the message is about to be written out, the command specified by
19154 &%transport_filter%& is started up in a separate, parallel process, and
19155 the entire message, including the header lines, is passed to it on its standard
19156 input (this in fact is done from a third process, to avoid deadlock). The
19157 command must be specified as an absolute path.
19158
19159 The lines of the message that are written to the transport filter are
19160 terminated by newline (&"\n"&). The message is passed to the filter before any
19161 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
19162 lines beginning with a dot, and also before any processing implied by the
19163 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
19164 &(pipe)& transports.
19165
19166 The standard error for the filter process is set to the same destination as its
19167 standard output; this is read and written to the message's ultimate
19168 destination. The process that writes the message to the filter, the
19169 filter itself, and the original process that reads the result and delivers it
19170 are all run in parallel, like a shell pipeline.
19171
19172 The filter can perform any transformations it likes, but of course should take
19173 care not to break RFC 2822 syntax. Exim does not check the result, except to
19174 test for a final newline when SMTP is in use. All messages transmitted over
19175 SMTP must end with a newline, so Exim supplies one if it is missing.
19176
19177 .cindex "content scanning" "per user"
19178 A transport filter can be used to provide content-scanning on a per-user basis
19179 at delivery time if the only required effect of the scan is to modify the
19180 message. For example, a content scan could insert a new header line containing
19181 a spam score. This could be interpreted by a filter in the user's MUA. It is
19182 not possible to discard a message at this stage.
19183
19184 .cindex "SMTP" "SIZE"
19185 A problem might arise if the filter increases the size of a message that is
19186 being sent down an SMTP connection. If the receiving SMTP server has indicated
19187 support for the SIZE parameter, Exim will have sent the size of the message
19188 at the start of the SMTP session. If what is actually sent is substantially
19189 more, the server might reject the message. This can be worked round by setting
19190 the &%size_addition%& option on the &(smtp)& transport, either to allow for
19191 additions to the message, or to disable the use of SIZE altogether.
19192
19193 .vindex "&$pipe_addresses$&"
19194 The value of the &%transport_filter%& option is the command string for starting
19195 the filter, which is run directly from Exim, not under a shell. The string is
19196 parsed by Exim in the same way as a command string for the &(pipe)& transport:
19197 Exim breaks it up into arguments and then expands each argument separately (see
19198 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
19199 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
19200 of arguments, one for each address that applies to this delivery. (This isn't
19201 an ideal name for this feature here, but as it was already implemented for the
19202 &(pipe)& transport, it seemed sensible not to change it.)
19203
19204 .vindex "&$host$&"
19205 .vindex "&$host_address$&"
19206 The expansion variables &$host$& and &$host_address$& are available when the
19207 transport is a remote one. They contain the name and IP address of the host to
19208 which the message is being sent. For example:
19209 .code
19210 transport_filter = /some/directory/transport-filter.pl \
19211   $host $host_address $sender_address $pipe_addresses
19212 .endd
19213
19214 Two problems arise if you want to use more complicated expansion items to
19215 generate transport filter commands, both of which due to the fact that the
19216 command is split up &'before'& expansion.
19217 .ilist
19218 If an expansion item contains white space, you must quote it, so that it is all
19219 part of the same command item. If the entire option setting is one such
19220 expansion item, you have to take care what kind of quoting you use. For
19221 example:
19222 .code
19223 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
19224 .endd
19225 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
19226 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
19227 stripped by Exim when it read the option's value. When the value is used, if
19228 the single quotes were missing, the line would be split into two items,
19229 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
19230 Exim tried to expand the first one.
19231 .next
19232 Except for the special case of &$pipe_addresses$& that is mentioned above, an
19233 expansion cannot generate multiple arguments, or a command name followed by
19234 arguments. Consider this example:
19235 .code
19236 transport_filter = ${lookup{$host}lsearch{/a/file}\
19237                     {$value}{/bin/cat}}
19238 .endd
19239 The result of the lookup is interpreted as the name of the command, even
19240 if it contains white space. The simplest way round this is to use a shell:
19241 .code
19242 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
19243                                {$value}{/bin/cat}}
19244 .endd
19245 .endlist
19246
19247 The filter process is run under the same uid and gid as the normal delivery.
19248 For remote deliveries this is the Exim uid/gid by default. The command should
19249 normally yield a zero return code. Transport filters are not supposed to fail.
19250 A non-zero code is taken to mean that the transport filter encountered some
19251 serious problem. Delivery of the message is deferred; the message remains on
19252 the queue and is tried again later. It is not possible to cause a message to be
19253 bounced from a transport filter.
19254
19255 If a transport filter is set on an autoreply transport, the original message is
19256 passed through the filter as it is being copied into the newly generated
19257 message, which happens if the &%return_message%& option is set.
19258
19259
19260 .option transport_filter_timeout transports time 5m
19261 .cindex "transport" "filter, timeout"
19262 When Exim is reading the output of a transport filter, it a applies a timeout
19263 that can be set by this option. Exceeding the timeout is normally treated as a
19264 temporary delivery failure. However, if a transport filter is used with a
19265 &(pipe)& transport, a timeout in the transport filter is treated in the same
19266 way as a timeout in the pipe command itself. By default, a timeout is a hard
19267 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
19268 becomes a temporary error.
19269
19270
19271 .option user transports string&!! "Exim user"
19272 .cindex "uid (user id)" "local delivery"
19273 .cindex "transport" "user, specifying"
19274 This option specifies the user under whose uid the delivery process is to be
19275 run, overriding any uid that may have been set by the router. If the user is
19276 given as a name, the uid is looked up from the password data, and the
19277 associated group is taken as the value of the gid to be used if the &%group%&
19278 option is not set.
19279
19280 For deliveries that use local transports, a user and group are normally
19281 specified explicitly or implicitly (for example, as a result of
19282 &%check_local_user%&) by the router or transport.
19283
19284 .cindex "hints database" "access by remote transport"
19285 For remote transports, you should leave this option unset unless you really are
19286 sure you know what you are doing. When a remote transport is running, it needs
19287 to be able to access Exim's hints databases, because each host may have its own
19288 retry data.
19289 .ecindex IIDgenoptra1
19290 .ecindex IIDgenoptra2
19291 .ecindex IIDgenoptra3
19292
19293
19294
19295
19296
19297
19298 . ////////////////////////////////////////////////////////////////////////////
19299 . ////////////////////////////////////////////////////////////////////////////
19300
19301 .chapter "Address batching in local transports" "CHAPbatching" &&&
19302          "Address batching"
19303 .cindex "transport" "local; address batching in"
19304 The only remote transport (&(smtp)&) is normally configured to handle more than
19305 one address at a time, so that when several addresses are routed to the same
19306 remote host, just one copy of the message is sent. Local transports, however,
19307 normally handle one address at a time. That is, a separate instance of the
19308 transport is run for each address that is routed to the transport. A separate
19309 copy of the message is delivered each time.
19310
19311 .cindex "batched local delivery"
19312 .oindex "&%batch_max%&"
19313 .oindex "&%batch_id%&"
19314 In special cases, it may be desirable to handle several addresses at once in a
19315 local transport, for example:
19316
19317 .ilist
19318 In an &(appendfile)& transport, when storing messages in files for later
19319 delivery by some other means, a single copy of the message with multiple
19320 recipients saves space.
19321 .next
19322 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
19323 a single copy saves time, and is the normal way LMTP is expected to work.
19324 .next
19325 In a &(pipe)& transport, when passing the message
19326 to a scanner program or
19327 to some other delivery mechanism such as UUCP, multiple recipients may be
19328 acceptable.
19329 .endlist
19330
19331 These three local transports all have the same options for controlling multiple
19332 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
19333 repeating the information for each transport, these options are described here.
19334
19335 The &%batch_max%& option specifies the maximum number of addresses that can be
19336 delivered together in a single run of the transport. Its default value is one
19337 (no batching). When more than one address is routed to a transport that has a
19338 &%batch_max%& value greater than one, the addresses are delivered in a batch
19339 (that is, in a single run of the transport with multiple recipients), subject
19340 to certain conditions:
19341
19342 .ilist
19343 .vindex "&$local_part$&"
19344 If any of the transport's options contain a reference to &$local_part$&, no
19345 batching is possible.
19346 .next
19347 .vindex "&$domain$&"
19348 If any of the transport's options contain a reference to &$domain$&, only
19349 addresses with the same domain are batched.
19350 .next
19351 .cindex "customizing" "batching condition"
19352 If &%batch_id%& is set, it is expanded for each address, and only those
19353 addresses with the same expanded value are batched. This allows you to specify
19354 customized batching conditions. Failure of the expansion for any reason,
19355 including forced failure, disables batching, but it does not stop the delivery
19356 from taking place.
19357 .next
19358 Batched addresses must also have the same errors address (where to send
19359 delivery errors), the same header additions and removals, the same user and
19360 group for the transport, and if a host list is present, the first host must
19361 be the same.
19362 .endlist
19363
19364 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
19365 both when the file or pipe command is specified in the transport, and when it
19366 is specified by a &(redirect)& router, but all the batched addresses must of
19367 course be routed to the same file or pipe command. These two transports have an
19368 option called &%use_bsmtp%&, which causes them to deliver the message in
19369 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
19370 &%check_string%& and &%escape_string%& options are forced to the values
19371 .code
19372 check_string = "."
19373 escape_string = ".."
19374 .endd
19375 when batched SMTP is in use. A full description of the batch SMTP mechanism is
19376 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
19377 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
19378
19379 .cindex "&'Envelope-to:'& header line"
19380 If the generic &%envelope_to_add%& option is set for a batching transport, the
19381 &'Envelope-to:'& header that is added to the message contains all the addresses
19382 that are being processed together. If you are using a batching &(appendfile)&
19383 transport without &%use_bsmtp%&, the only way to preserve the recipient
19384 addresses is to set the &%envelope_to_add%& option.
19385
19386 .cindex "&(pipe)& transport" "with multiple addresses"
19387 .vindex "&$pipe_addresses$&"
19388 If you are using a &(pipe)& transport without BSMTP, and setting the
19389 transport's &%command%& option, you can include &$pipe_addresses$& as part of
19390 the command. This is not a true variable; it is a bit of magic that causes each
19391 of the recipient addresses to be inserted into the command as a separate
19392 argument. This provides a way of accessing all the addresses that are being
19393 delivered in the batch. &*Note:*& This is not possible for pipe commands that
19394 are specified by a &(redirect)& router.
19395
19396
19397
19398
19399 . ////////////////////////////////////////////////////////////////////////////
19400 . ////////////////////////////////////////////////////////////////////////////
19401
19402 .chapter "The appendfile transport" "CHAPappendfile"
19403 .scindex IIDapptra1 "&(appendfile)& transport"
19404 .scindex IIDapptra2 "transports" "&(appendfile)&"
19405 .cindex "directory creation"
19406 .cindex "creating directories"
19407 The &(appendfile)& transport delivers a message by appending it to an existing
19408 file, or by creating an entirely new file in a specified directory. Single
19409 files to which messages are appended can be in the traditional Unix mailbox
19410 format, or optionally in the MBX format supported by the Pine MUA and
19411 University of Washington IMAP daemon, &'inter alia'&. When each message is
19412 being delivered as a separate file, &"maildir"& format can optionally be used
19413 to give added protection against failures that happen part-way through the
19414 delivery. A third form of separate-file delivery known as &"mailstore"& is also
19415 supported. For all file formats, Exim attempts to create as many levels of
19416 directory as necessary, provided that &%create_directory%& is set.
19417
19418 The code for the optional formats is not included in the Exim binary by
19419 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
19420 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
19421 included.
19422
19423 .cindex "quota" "system"
19424 Exim recognizes system quota errors, and generates an appropriate message. Exim
19425 also supports its own quota control within the transport, for use when the
19426 system facility is unavailable or cannot be used for some reason.
19427
19428 If there is an error while appending to a file (for example, quota exceeded or
19429 partition filled), Exim attempts to reset the file's length and last
19430 modification time back to what they were before. If there is an error while
19431 creating an entirely new file, the new file is removed.
19432
19433 Before appending to a file, a number of security checks are made, and the
19434 file is locked. A detailed description is given below, after the list of
19435 private options.
19436
19437 The &(appendfile)& transport is most commonly used for local deliveries to
19438 users' mailboxes. However, it can also be used as a pseudo-remote transport for
19439 putting messages into files for remote delivery by some means other than Exim.
19440 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
19441 option).
19442
19443
19444
19445 .section "The file and directory options" "SECTfildiropt"
19446 The &%file%& option specifies a single file, to which the message is appended;
19447 the &%directory%& option specifies a directory, in which a new file containing
19448 the message is created. Only one of these two options can be set, and for
19449 normal deliveries to mailboxes, one of them &'must'& be set.
19450
19451 .vindex "&$address_file$&"
19452 .vindex "&$local_part$&"
19453 However, &(appendfile)& is also used for delivering messages to files or
19454 directories whose names (or parts of names) are obtained from alias,
19455 forwarding, or filtering operations (for example, a &%save%& command in a
19456 user's Exim filter). When such a transport is running, &$local_part$& contains
19457 the local part that was aliased or forwarded, and &$address_file$& contains the
19458 name (or partial name) of the file or directory generated by the redirection
19459 operation. There are two cases:
19460
19461 .ilist
19462 If neither &%file%& nor &%directory%& is set, the redirection operation
19463 must specify an absolute path (one that begins with &`/`&). This is the most
19464 common case when users with local accounts use filtering to sort mail into
19465 different folders. See for example, the &(address_file)& transport in the
19466 default configuration. If the path ends with a slash, it is assumed to be the
19467 name of a directory. A delivery to a directory can also be forced by setting
19468 &%maildir_format%& or &%mailstore_format%&.
19469 .next
19470 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
19471 used to determine the file or directory name for the delivery. Normally, the
19472 contents of &$address_file$& are used in some way in the string expansion.
19473 .endlist
19474
19475
19476 .cindex "Sieve filter" "configuring &(appendfile)&"
19477 .cindex "Sieve filter" "relative mailbox path handling"
19478 As an example of the second case, consider an environment where users do not
19479 have home directories. They may be permitted to use Exim filter commands of the
19480 form:
19481 .code
19482 save folder23
19483 .endd
19484 or Sieve filter commands of the form:
19485 .code
19486 require "fileinto";
19487 fileinto "folder23";
19488 .endd
19489 In this situation, the expansion of &%file%& or &%directory%& in the transport
19490 must transform the relative path into an appropriate absolute file name. In the
19491 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
19492 is used as a result of a &"keep"& action in the filter. This example shows one
19493 way of handling this requirement:
19494 .code
19495 file = ${if eq{$address_file}{inbox} \
19496             {/var/mail/$local_part} \
19497             {${if eq{${substr_0_1:$address_file}}{/} \
19498                   {$address_file} \
19499                   {$home/mail/$address_file} \
19500             }} \
19501        }
19502 .endd
19503 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
19504 location, absolute paths are used without change, and other folders are in the
19505 &_mail_& directory within the home directory.
19506
19507 &*Note 1*&: While processing an Exim filter, a relative path such as
19508 &_folder23_& is turned into an absolute path if a home directory is known to
19509 the router. In particular, this is the case if &%check_local_user%& is set. If
19510 you want to prevent this happening at routing time, you can set
19511 &%router_home_directory%& empty. This forces the router to pass the relative
19512 path to the transport.
19513
19514 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
19515 the &%file%& or &%directory%& option is still used if it is set.
19516
19517
19518
19519
19520 .section "Private options for appendfile" "SECID134"
19521 .cindex "options" "&(appendfile)& transport"
19522
19523
19524
19525 .option allow_fifo appendfile boolean false
19526 .cindex "fifo (named pipe)"
19527 .cindex "named pipe (fifo)"
19528 .cindex "pipe" "named (fifo)"
19529 Setting this option permits delivery to named pipes (FIFOs) as well as to
19530 regular files. If no process is reading the named pipe at delivery time, the
19531 delivery is deferred.
19532
19533
19534 .option allow_symlink appendfile boolean false
19535 .cindex "symbolic link" "to mailbox"
19536 .cindex "mailbox" "symbolic link"
19537 By default, &(appendfile)& will not deliver if the path name for the file is
19538 that of a symbolic link. Setting this option relaxes that constraint, but there
19539 are security issues involved in the use of symbolic links. Be sure you know
19540 what you are doing if you set this. Details of exactly what this option affects
19541 are included in the discussion which follows this list of options.
19542
19543
19544 .option batch_id appendfile string&!! unset
19545 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
19546 However, batching is automatically disabled for &(appendfile)& deliveries that
19547 happen as a result of forwarding or aliasing or other redirection directly to a
19548 file.
19549
19550
19551 .option batch_max appendfile integer 1
19552 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
19553
19554
19555 .option check_group appendfile boolean false
19556 When this option is set, the group owner of the file defined by the &%file%&
19557 option is checked to see that it is the same as the group under which the
19558 delivery process is running. The default setting is false because the default
19559 file mode is 0600, which means that the group is irrelevant.
19560
19561
19562 .option check_owner appendfile boolean true
19563 When this option is set, the owner of the file defined by the &%file%& option
19564 is checked to ensure that it is the same as the user under which the delivery
19565 process is running.
19566
19567
19568 .option check_string appendfile string "see below"
19569 .cindex "&""From""& line"
19570 As &(appendfile)& writes the message, the start of each line is tested for
19571 matching &%check_string%&, and if it does, the initial matching characters are
19572 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
19573 a literal string, not a regular expression, and the case of any letters it
19574 contains is significant.
19575
19576 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
19577 are forced to &"."& and &".."& respectively, and any settings in the
19578 configuration are ignored. Otherwise, they default to &"From&~"& and
19579 &">From&~"& when the &%file%& option is set, and unset when any of the
19580 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
19581
19582 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
19583 suitable for traditional &"BSD"& mailboxes, where a line beginning with
19584 &"From&~"& indicates the start of a new message. All four options need changing
19585 if another format is used. For example, to deliver to mailboxes in MMDF format:
19586 .cindex "MMDF format mailbox"
19587 .cindex "mailbox" "MMDF format"
19588 .code
19589 check_string = "\1\1\1\1\n"
19590 escape_string = "\1\1\1\1 \n"
19591 message_prefix = "\1\1\1\1\n"
19592 message_suffix = "\1\1\1\1\n"
19593 .endd
19594 .option create_directory appendfile boolean true
19595 .cindex "directory creation"
19596 When this option is true, Exim attempts to create any missing superior
19597 directories for the file that it is about to write. A created directory's mode
19598 is given by the &%directory_mode%& option.
19599
19600 The group ownership of a newly created directory is highly dependent on the
19601 operating system (and possibly the file system) that is being used. For
19602 example, in Solaris, if the parent directory has the setgid bit set, its group
19603 is propagated to the child; if not, the currently set group is used. However,
19604 in FreeBSD, the parent's group is always used.
19605
19606
19607
19608 .option create_file appendfile string anywhere
19609 This option constrains the location of files and directories that are created
19610 by this transport. It applies to files defined by the &%file%& option and
19611 directories defined by the &%directory%& option. In the case of maildir
19612 delivery, it applies to the top level directory, not the maildir directories
19613 beneath.
19614
19615 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
19616 &"belowhome"&. In the second and third cases, a home directory must have been
19617 set for the transport. This option is not useful when an explicit file name is
19618 given for normal mailbox deliveries. It is intended for the case when file
19619 names are generated from users' &_.forward_& files. These are usually handled
19620 by an &(appendfile)& transport called &%address_file%&. See also
19621 &%file_must_exist%&.
19622
19623
19624 .option directory appendfile string&!! unset
19625 This option is mutually exclusive with the &%file%& option, but one of &%file%&
19626 or &%directory%& must be set, unless the delivery is the direct result of a
19627 redirection (see section &<<SECTfildiropt>>&).
19628
19629 When &%directory%& is set, the string is expanded, and the message is delivered
19630 into a new file or files in or below the given directory, instead of being
19631 appended to a single mailbox file. A number of different formats are provided
19632 (see &%maildir_format%& and &%mailstore_format%&), and see section
19633 &<<SECTopdir>>& for further details of this form of delivery.
19634
19635
19636 .option directory_file appendfile string&!! "see below"
19637 .cindex "base62"
19638 .vindex "&$inode$&"
19639 When &%directory%& is set, but neither &%maildir_format%& nor
19640 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
19641 whose name is obtained by expanding this string. The default value is:
19642 .code
19643 q${base62:$tod_epoch}-$inode
19644 .endd
19645 This generates a unique name from the current time, in base 62 form, and the
19646 inode of the file. The variable &$inode$& is available only when expanding this
19647 option.
19648
19649
19650 .option directory_mode appendfile "octal integer" 0700
19651 If &(appendfile)& creates any directories as a result of the
19652 &%create_directory%& option, their mode is specified by this option.
19653
19654
19655 .option escape_string appendfile string "see description"
19656 See &%check_string%& above.
19657
19658
19659 .option file appendfile string&!! unset
19660 This option is mutually exclusive with the &%directory%& option, but one of
19661 &%file%& or &%directory%& must be set, unless the delivery is the direct result
19662 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
19663 specifies a single file, to which the message is appended. One or more of
19664 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
19665 &%file%&.
19666
19667 .cindex "NFS" "lock file"
19668 .cindex "locking files"
19669 .cindex "lock files"
19670 If you are using more than one host to deliver over NFS into the same
19671 mailboxes, you should always use lock files.
19672
19673 The string value is expanded for each delivery, and must yield an absolute
19674 path. The most common settings of this option are variations on one of these
19675 examples:
19676 .code
19677 file = /var/spool/mail/$local_part
19678 file = /home/$local_part/inbox
19679 file = $home/inbox
19680 .endd
19681 .cindex "&""sticky""& bit"
19682 In the first example, all deliveries are done into the same directory. If Exim
19683 is configured to use lock files (see &%use_lockfile%& below) it must be able to
19684 create a file in the directory, so the &"sticky"& bit must be turned on for
19685 deliveries to be possible, or alternatively the &%group%& option can be used to
19686 run the delivery under a group id which has write access to the directory.
19687
19688
19689
19690 .option file_format appendfile string unset
19691 .cindex "file" "mailbox; checking existing format"
19692 This option requests the transport to check the format of an existing file
19693 before adding to it. The check consists of matching a specific string at the
19694 start of the file. The value of the option consists of an even number of
19695 colon-separated strings. The first of each pair is the test string, and the
19696 second is the name of a transport. If the transport associated with a matched
19697 string is not the current transport, control is passed over to the other
19698 transport. For example, suppose the standard &(local_delivery)& transport has
19699 this added to it:
19700 .code
19701 file_format = "From       : local_delivery :\
19702                \1\1\1\1\n : local_mmdf_delivery"
19703 .endd
19704 Mailboxes that begin with &"From"& are still handled by this transport, but if
19705 a mailbox begins with four binary ones followed by a newline, control is passed
19706 to a transport called &%local_mmdf_delivery%&, which presumably is configured
19707 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
19708 is assumed to match the current transport. If the start of a mailbox doesn't
19709 match any string, or if the transport named for a given string is not defined,
19710 delivery is deferred.
19711
19712
19713 .option file_must_exist appendfile boolean false
19714 If this option is true, the file specified by the &%file%& option must exist.
19715 A temporary error occurs if it does not, causing delivery to be deferred.
19716 If this option is false, the file is created if it does not exist.
19717
19718
19719 .option lock_fcntl_timeout appendfile time 0s
19720 .cindex "timeout" "mailbox locking"
19721 .cindex "mailbox" "locking, blocking and non-blocking"
19722 .cindex "locking files"
19723 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
19724 when locking an open mailbox file. If the call fails, the delivery process
19725 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
19726 Non-blocking calls are used so that the file is not kept open during the wait
19727 for the lock; the reason for this is to make it as safe as possible for
19728 deliveries over NFS in the case when processes might be accessing an NFS
19729 mailbox without using a lock file. This should not be done, but
19730 misunderstandings and hence misconfigurations are not unknown.
19731
19732 On a busy system, however, the performance of a non-blocking lock approach is
19733 not as good as using a blocking lock with a timeout. In this case, the waiting
19734 is done inside the system call, and Exim's delivery process acquires the lock
19735 and can proceed as soon as the previous lock holder releases it.
19736
19737 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
19738 timeout, are used. There may still be some retrying: the maximum number of
19739 retries is
19740 .code
19741 (lock_retries * lock_interval) / lock_fcntl_timeout
19742 .endd
19743 rounded up to the next whole number. In other words, the total time during
19744 which &(appendfile)& is trying to get a lock is roughly the same, unless
19745 &%lock_fcntl_timeout%& is set very large.
19746
19747 You should consider setting this option if you are getting a lot of delayed
19748 local deliveries because of errors of the form
19749 .code
19750 failed to lock mailbox /some/file (fcntl)
19751 .endd
19752
19753 .option lock_flock_timeout appendfile time 0s
19754 This timeout applies to file locking when using &[flock()]& (see
19755 &%use_flock%&); the timeout operates in a similar manner to
19756 &%lock_fcntl_timeout%&.
19757
19758
19759 .option lock_interval appendfile time 3s
19760 This specifies the time to wait between attempts to lock the file. See below
19761 for details of locking.
19762
19763
19764 .option lock_retries appendfile integer 10
19765 This specifies the maximum number of attempts to lock the file. A value of zero
19766 is treated as 1. See below for details of locking.
19767
19768
19769 .option lockfile_mode appendfile "octal integer" 0600
19770 This specifies the mode of the created lock file, when a lock file is being
19771 used (see &%use_lockfile%& and &%use_mbx_lock%&).
19772
19773
19774 .option lockfile_timeout appendfile time 30m
19775 .cindex "timeout" "mailbox locking"
19776 When a lock file is being used (see &%use_lockfile%&), if a lock file already
19777 exists and is older than this value, it is assumed to have been left behind by
19778 accident, and Exim attempts to remove it.
19779
19780
19781 .option mailbox_filecount appendfile string&!! unset
19782 .cindex "mailbox" "specifying size of"
19783 .cindex "size" "of mailbox"
19784 If this option is set, it is expanded, and the result is taken as the current
19785 number of files in the mailbox. It must be a decimal number, optionally
19786 followed by K or M. This provides a way of obtaining this information from an
19787 external source that maintains the data.
19788
19789
19790 .option mailbox_size appendfile string&!! unset
19791 .cindex "mailbox" "specifying size of"
19792 .cindex "size" "of mailbox"
19793 If this option is set, it is expanded, and the result is taken as the current
19794 size the mailbox. It must be a decimal number, optionally followed by K or M.
19795 This provides a way of obtaining this information from an external source that
19796 maintains the data. This is likely to be helpful for maildir deliveries where
19797 it is computationally expensive to compute the size of a mailbox.
19798
19799
19800
19801 .option maildir_format appendfile boolean false
19802 .cindex "maildir format" "specifying"
19803 If this option is set with the &%directory%& option, the delivery is into a new
19804 file, in the &"maildir"& format that is used by other mail software. When the
19805 transport is activated directly from a &(redirect)& router (for example, the
19806 &(address_file)& transport in the default configuration), setting
19807 &%maildir_format%& causes the path received from the router to be treated as a
19808 directory, whether or not it ends with &`/`&. This option is available only if
19809 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
19810 &<<SECTmaildirdelivery>>& below for further details.
19811
19812
19813 .option maildir_quota_directory_regex appendfile string "See below"
19814 .cindex "maildir format" "quota; directories included in"
19815 .cindex "quota" "maildir; directories included in"
19816 This option is relevant only when &%maildir_use_size_file%& is set. It defines
19817 a regular expression for specifying directories, relative to the quota
19818 directory (see &%quota_directory%&), that should be included in the quota
19819 calculation. The default value is:
19820 .code
19821 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
19822 .endd
19823 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
19824 (directories whose names begin with a dot). If you want to exclude the
19825 &_Trash_&
19826 folder from the count (as some sites do), you need to change this setting to
19827 .code
19828 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
19829 .endd
19830 This uses a negative lookahead in the regular expression to exclude the
19831 directory whose name is &_.Trash_&. When a directory is excluded from quota
19832 calculations, quota processing is bypassed for any messages that are delivered
19833 directly into that directory.
19834
19835
19836 .option maildir_retries appendfile integer 10
19837 This option specifies the number of times to retry when writing a file in
19838 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
19839
19840
19841 .option maildir_tag appendfile string&!! unset
19842 This option applies only to deliveries in maildir format, and is described in
19843 section &<<SECTmaildirdelivery>>& below.
19844
19845
19846 .option maildir_use_size_file appendfile boolean false
19847 .cindex "maildir format" "&_maildirsize_& file"
19848 Setting this option true enables support for &_maildirsize_& files. Exim
19849 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
19850 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
19851 value is zero. See &%maildir_quota_directory_regex%& above and section
19852 &<<SECTmaildirdelivery>>& below for further details.
19853
19854 .option maildirfolder_create_regex appendfile string unset
19855 .cindex "maildir format" "&_maildirfolder_& file"
19856 .cindex "&_maildirfolder_&, creating"
19857 The value of this option is a regular expression. If it is unset, it has no
19858 effect. Otherwise, before a maildir delivery takes place, the pattern is
19859 matched against the name of the maildir directory, that is, the directory
19860 containing the &_new_& and &_tmp_& subdirectories that will be used for the
19861 delivery. If there is a match, Exim checks for the existence of a file called
19862 &_maildirfolder_& in the directory, and creates it if it does not exist.
19863 See section &<<SECTmaildirdelivery>>& for more details.
19864
19865
19866 .option mailstore_format appendfile boolean false
19867 .cindex "mailstore format" "specifying"
19868 If this option is set with the &%directory%& option, the delivery is into two
19869 new files in  &"mailstore"& format. The option is available only if
19870 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
19871 below for further details.
19872
19873
19874 .option mailstore_prefix appendfile string&!! unset
19875 This option applies only to deliveries in mailstore format, and is described in
19876 section &<<SECTopdir>>& below.
19877
19878
19879 .option mailstore_suffix appendfile string&!! unset
19880 This option applies only to deliveries in mailstore format, and is described in
19881 section &<<SECTopdir>>& below.
19882
19883
19884 .option mbx_format appendfile boolean false
19885 .cindex "locking files"
19886 .cindex "file" "locking"
19887 .cindex "file" "MBX format"
19888 .cindex "MBX format, specifying"
19889 This option is available only if Exim has been compiled with SUPPORT_MBX
19890 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
19891 the message is appended to the mailbox file in MBX format instead of
19892 traditional Unix format. This format is supported by Pine4 and its associated
19893 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
19894
19895 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
19896 automatically changed by the use of &%mbx_format%&. They should normally be set
19897 empty when using MBX format, so this option almost always appears in this
19898 combination:
19899 .code
19900 mbx_format = true
19901 message_prefix =
19902 message_suffix =
19903 .endd
19904 If none of the locking options are mentioned in the configuration,
19905 &%use_mbx_lock%& is assumed and the other locking options default to false. It
19906 is possible to specify the other kinds of locking with &%mbx_format%&, but
19907 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
19908 interworks with &'c-client'&, providing for shared access to the mailbox. It
19909 should not be used if any program that does not use this form of locking is
19910 going to access the mailbox, nor should it be used if the mailbox file is NFS
19911 mounted, because it works only when the mailbox is accessed from a single host.
19912
19913 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
19914 the standard version of &'c-client'&, because as long as it has a mailbox open
19915 (this means for the whole of a Pine or IMAP session), Exim will not be able to
19916 append messages to it.
19917
19918
19919 .option message_prefix appendfile string&!! "see below"
19920 .cindex "&""From""& line"
19921 The string specified here is expanded and output at the start of every message.
19922 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
19923 in which case it is:
19924 .code
19925 message_prefix = "From ${if def:return_path{$return_path}\
19926   {MAILER-DAEMON}} $tod_bsdinbox\n"
19927 .endd
19928 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
19929 &`\n`& to &`\r\n`& in &%message_prefix%&.
19930
19931 .option message_suffix appendfile string&!! "see below"
19932 The string specified here is expanded and output at the end of every message.
19933 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
19934 in which case it is a single newline character. The suffix can be suppressed by
19935 setting
19936 .code
19937 message_suffix =
19938 .endd
19939 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
19940 &`\n`& to &`\r\n`& in &%message_suffix%&.
19941
19942 .option mode appendfile "octal integer" 0600
19943 If the output file is created, it is given this mode. If it already exists and
19944 has wider permissions, they are reduced to this mode. If it has narrower
19945 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
19946 if the delivery is the result of a &%save%& command in a filter file specifying
19947 a particular mode, the mode of the output file is always forced to take that
19948 value, and this option is ignored.
19949
19950
19951 .option mode_fail_narrower appendfile boolean true
19952 This option applies in the case when an existing mailbox file has a narrower
19953 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
19954 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
19955 continues with the delivery attempt, using the existing mode of the file.
19956
19957
19958 .option notify_comsat appendfile boolean false
19959 If this option is true, the &'comsat'& daemon is notified after every
19960 successful delivery to a user mailbox. This is the daemon that notifies logged
19961 on users about incoming mail.
19962
19963
19964 .option quota appendfile string&!! unset
19965 .cindex "quota" "imposed by Exim"
19966 This option imposes a limit on the size of the file to which Exim is appending,
19967 or to the total space used in the directory tree when the &%directory%& option
19968 is set. In the latter case, computation of the space used is expensive, because
19969 all the files in the directory (and any sub-directories) have to be
19970 individually inspected and their sizes summed. (See &%quota_size_regex%& and
19971 &%maildir_use_size_file%& for ways to avoid this in environments where users
19972 have no shell access to their mailboxes).
19973
19974 As there is no interlock against two simultaneous deliveries into a
19975 multi-file mailbox, it is possible for the quota to be overrun in this case.
19976 For single-file mailboxes, of course, an interlock is a necessity.
19977
19978 A file's size is taken as its &'used'& value. Because of blocking effects, this
19979 may be a lot less than the actual amount of disk space allocated to the file.
19980 If the sizes of a number of files are being added up, the rounding effect can
19981 become quite noticeable, especially on systems that have large block sizes.
19982 Nevertheless, it seems best to stick to the &'used'& figure, because this is
19983 the obvious value which users understand most easily.
19984
19985 The value of the option is expanded, and must then be a numerical value
19986 (decimal point allowed), optionally followed by one of the letters K, M, or G,
19987 for kilobytes, megabytes, or gigabytes. If Exim is running on a system with
19988 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
19989 be handled.
19990
19991 &*Note*&: A value of zero is interpreted as &"no quota"&.
19992
19993 The expansion happens while Exim is running as root, before it changes uid for
19994 the delivery. This means that files that are inaccessible to the end user can
19995 be used to hold quota values that are looked up in the expansion. When delivery
19996 fails because this quota is exceeded, the handling of the error is as for
19997 system quota failures.
19998
19999 By default, Exim's quota checking mimics system quotas, and restricts the
20000 mailbox to the specified maximum size, though the value is not accurate to the
20001 last byte, owing to separator lines and additional headers that may get added
20002 during message delivery. When a mailbox is nearly full, large messages may get
20003 refused even though small ones are accepted, because the size of the current
20004 message is added to the quota when the check is made. This behaviour can be
20005 changed by setting &%quota_is_inclusive%& false. When this is done, the check
20006 for exceeding the quota does not include the current message. Thus, deliveries
20007 continue until the quota has been exceeded; thereafter, no further messages are
20008 delivered. See also &%quota_warn_threshold%&.
20009
20010
20011 .option quota_directory appendfile string&!! unset
20012 This option defines the directory to check for quota purposes when delivering
20013 into individual files. The default is the delivery directory, or, if a file
20014 called &_maildirfolder_& exists in a maildir directory, the parent of the
20015 delivery directory.
20016
20017
20018 .option quota_filecount appendfile string&!! 0
20019 This option applies when the &%directory%& option is set. It limits the total
20020 number of files in the directory (compare the inode limit in system quotas). It
20021 can only be used if &%quota%& is also set. The value is expanded; an expansion
20022 failure causes delivery to be deferred. A value of zero is interpreted as
20023 &"no quota"&.
20024
20025
20026 .option quota_is_inclusive appendfile boolean true
20027 See &%quota%& above.
20028
20029
20030 .option quota_size_regex appendfile string unset
20031 This option applies when one of the delivery modes that writes a separate file
20032 for each message is being used. When Exim wants to find the size of one of
20033 these files in order to test the quota, it first checks &%quota_size_regex%&.
20034 If this is set to a regular expression that matches the file name, and it
20035 captures one string, that string is interpreted as a representation of the
20036 file's size. The value of &%quota_size_regex%& is not expanded.
20037
20038 This feature is useful only when users have no shell access to their mailboxes
20039 &-- otherwise they could defeat the quota simply by renaming the files. This
20040 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
20041 the file length to the file name. For example:
20042 .code
20043 maildir_tag = ,S=$message_size
20044 quota_size_regex = ,S=(\d+)
20045 .endd
20046 An alternative to &$message_size$& is &$message_linecount$&, which contains the
20047 number of lines in the message.
20048
20049 The regular expression should not assume that the length is at the end of the
20050 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
20051 sometimes add other information onto the ends of message file names.
20052
20053
20054
20055 .option quota_warn_message appendfile string&!! "see below"
20056 See below for the use of this option. If it is not set when
20057 &%quota_warn_threshold%& is set, it defaults to
20058 .code
20059 quota_warn_message = "\
20060   To: $local_part@$domain\n\
20061   Subject: Your mailbox\n\n\
20062   This message is automatically created \
20063   by mail delivery software.\n\n\
20064   The size of your mailbox has exceeded \
20065   a warning threshold that is\n\
20066   set by the system administrator.\n"
20067 .endd
20068
20069
20070 .option quota_warn_threshold appendfile string&!! 0
20071 .cindex "quota" "warning threshold"
20072 .cindex "mailbox" "size warning"
20073 .cindex "size" "of mailbox"
20074 This option is expanded in the same way as &%quota%& (see above). If the
20075 resulting value is greater than zero, and delivery of the message causes the
20076 size of the file or total space in the directory tree to cross the given
20077 threshold, a warning message is sent. If &%quota%& is also set, the threshold
20078 may be specified as a percentage of it by following the value with a percent
20079 sign. For example:
20080 .code
20081 quota = 10M
20082 quota_warn_threshold = 75%
20083 .endd
20084 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
20085 percent sign is ignored.
20086
20087 The warning message itself is specified by the &%quota_warn_message%& option,
20088 and it must start with a &'To:'& header line containing the recipient(s) of the
20089 warning message. These do not necessarily have to include the recipient(s) of
20090 the original message. A &'Subject:'& line should also normally be supplied. You
20091 can include any other header lines that you want. If you do not include a
20092 &'From:'& line, the default is:
20093 .code
20094 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
20095 .endd
20096 .oindex &%errors_reply_to%&
20097 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
20098 option.
20099
20100 The &%quota%& option does not have to be set in order to use this option; they
20101 are independent of one another except when the threshold is specified as a
20102 percentage.
20103
20104
20105 .option use_bsmtp appendfile boolean false
20106 .cindex "envelope sender"
20107 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
20108 format, with the envelope sender and recipient(s) included as SMTP commands. If
20109 you want to include a leading HELO command with such messages, you can do
20110 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
20111 for details of batch SMTP.
20112
20113
20114 .option use_crlf appendfile boolean false
20115 .cindex "carriage return"
20116 .cindex "linefeed"
20117 This option causes lines to be terminated with the two-character CRLF sequence
20118 (carriage return, linefeed) instead of just a linefeed character. In the case
20119 of batched SMTP, the byte sequence written to the file is then an exact image
20120 of what would be sent down a real SMTP connection.
20121
20122 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
20123 (which are used to supply the traditional &"From&~"& and blank line separators
20124 in Berkeley-style mailboxes) are written verbatim, so must contain their own
20125 carriage return characters if these are needed. In cases where these options
20126 have non-empty defaults, the values end with a single linefeed, so they must be
20127 changed to end with &`\r\n`& if &%use_crlf%& is set.
20128
20129
20130 .option use_fcntl_lock appendfile boolean "see below"
20131 This option controls the use of the &[fcntl()]& function to lock a file for
20132 exclusive use when a message is being appended. It is set by default unless
20133 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
20134 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
20135 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
20136
20137
20138 .option use_flock_lock appendfile boolean false
20139 This option is provided to support the use of &[flock()]& for file locking, for
20140 the few situations where it is needed. Most modern operating systems support
20141 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
20142 each other. Exim uses &[fcntl()]& locking by default.
20143
20144 This option is required only if you are using an operating system where
20145 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
20146 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
20147 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
20148
20149 .cindex "Solaris" "&[flock()]& support"
20150 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
20151 have it (and some, I think, provide a not quite right version built on top of
20152 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
20153 the ability to use it, and any attempt to do so will cause a configuration
20154 error.
20155
20156 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
20157 is just being mapped onto &[fcntl()]& by the OS).
20158
20159
20160 .option use_lockfile appendfile boolean "see below"
20161 If this option is turned off, Exim does not attempt to create a lock file when
20162 appending to a mailbox file. In this situation, the only locking is by
20163 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
20164 sure that every MUA that is ever going to look at your users' mailboxes uses
20165 &[fcntl()]& rather than a lock file, and even then only when you are not
20166 delivering over NFS from more than one host.
20167
20168 .cindex "NFS" "lock file"
20169 In order to append to an NFS file safely from more than one host, it is
20170 necessary to take out a lock &'before'& opening the file, and the lock file
20171 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
20172 file corruption.
20173
20174 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
20175 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
20176 except when &%mbx_format%& is set.
20177
20178
20179 .option use_mbx_lock appendfile boolean "see below"
20180 This option is available only if Exim has been compiled with SUPPORT_MBX
20181 set in &_Local/Makefile_&. Setting the option specifies that special MBX
20182 locking rules be used. It is set by default if &%mbx_format%& is set and none
20183 of the locking options are mentioned in the configuration. The locking rules
20184 are the same as are used by the &'c-client'& library that underlies Pine and
20185 the IMAP4 and POP daemons that come with it (see the discussion below). The
20186 rules allow for shared access to the mailbox. However, this kind of locking
20187 does not work when the mailbox is NFS mounted.
20188
20189 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
20190 &%use_flock_lock%& to control what kind of locking is used in implementing the
20191 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
20192 without &%use_fcntl_lock%& or &%use_flock_lock%&.
20193
20194
20195
20196
20197 .section "Operational details for appending" "SECTopappend"
20198 .cindex "appending to a file"
20199 .cindex "file" "appending"
20200 Before appending to a file, the following preparations are made:
20201
20202 .ilist
20203 If the name of the file is &_/dev/null_&, no action is taken, and a success
20204 return is given.
20205
20206 .next
20207 .cindex "directory creation"
20208 If any directories on the file's path are missing, Exim creates them if the
20209 &%create_directory%& option is set. A created directory's mode is given by the
20210 &%directory_mode%& option.
20211
20212 .next
20213 If &%file_format%& is set, the format of an existing file is checked. If this
20214 indicates that a different transport should be used, control is passed to that
20215 transport.
20216
20217 .next
20218 .cindex "file" "locking"
20219 .cindex "locking files"
20220 .cindex "NFS" "lock file"
20221 If &%use_lockfile%& is set, a lock file is built in a way that will work
20222 reliably over NFS, as follows:
20223
20224 .olist
20225 Create a &"hitching post"& file whose name is that of the lock file with the
20226 current time, primary host name, and process id added, by opening for writing
20227 as a new file. If this fails with an access error, delivery is deferred.
20228 .next
20229 Close the hitching post file, and hard link it to the lock file name.
20230 .next
20231 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
20232 Unlink the hitching post name.
20233 .next
20234 Otherwise, use &[stat()]& to get information about the hitching post file, and
20235 then unlink hitching post name. If the number of links is exactly two, creation
20236 of the lock file succeeded but something (for example, an NFS server crash and
20237 restart) caused this fact not to be communicated to the &[link()]& call.
20238 .next
20239 If creation of the lock file failed, wait for &%lock_interval%& and try again,
20240 up to &%lock_retries%& times. However, since any program that writes to a
20241 mailbox should complete its task very quickly, it is reasonable to time out old
20242 lock files that are normally the result of user agent and system crashes. If an
20243 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
20244 it before trying again.
20245 .endlist olist
20246
20247 .next
20248 A call is made to &[lstat()]& to discover whether the main file exists, and if
20249 so, what its characteristics are. If &[lstat()]& fails for any reason other
20250 than non-existence, delivery is deferred.
20251
20252 .next
20253 .cindex "symbolic link" "to mailbox"
20254 .cindex "mailbox" "symbolic link"
20255 If the file does exist and is a symbolic link, delivery is deferred, unless the
20256 &%allow_symlink%& option is set, in which case the ownership of the link is
20257 checked, and then &[stat()]& is called to find out about the real file, which
20258 is then subjected to the checks below. The check on the top-level link
20259 ownership prevents one user creating a link for another's mailbox in a sticky
20260 directory, though allowing symbolic links in this case is definitely not a good
20261 idea. If there is a chain of symbolic links, the intermediate ones are not
20262 checked.
20263
20264 .next
20265 If the file already exists but is not a regular file, or if the file's owner
20266 and group (if the group is being checked &-- see &%check_group%& above) are
20267 different from the user and group under which the delivery is running,
20268 delivery is deferred.
20269
20270 .next
20271 If the file's permissions are more generous than specified, they are reduced.
20272 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
20273 is set false, in which case the delivery is tried using the existing
20274 permissions.
20275
20276 .next
20277 The file's inode number is saved, and the file is then opened for appending.
20278 If this fails because the file has vanished, &(appendfile)& behaves as if it
20279 hadn't existed (see below). For any other failures, delivery is deferred.
20280
20281 .next
20282 If the file is opened successfully, check that the inode number hasn't
20283 changed, that it is still a regular file, and that the owner and permissions
20284 have not changed. If anything is wrong, defer delivery and freeze the message.
20285
20286 .next
20287 If the file did not exist originally, defer delivery if the &%file_must_exist%&
20288 option is set. Otherwise, check that the file is being created in a permitted
20289 directory if the &%create_file%& option is set (deferring on failure), and then
20290 open for writing as a new file, with the O_EXCL and O_CREAT options,
20291 except when dealing with a symbolic link (the &%allow_symlink%& option must be
20292 set). In this case, which can happen if the link points to a non-existent file,
20293 the file is opened for writing using O_CREAT but not O_EXCL, because
20294 that prevents link following.
20295
20296 .next
20297 .cindex "loop" "while file testing"
20298 If opening fails because the file exists, obey the tests given above for
20299 existing files. However, to avoid looping in a situation where the file is
20300 being continuously created and destroyed, the exists/not-exists loop is broken
20301 after 10 repetitions, and the message is then frozen.
20302
20303 .next
20304 If opening fails with any other error, defer delivery.
20305
20306 .next
20307 .cindex "file" "locking"
20308 .cindex "locking files"
20309 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
20310 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
20311 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
20312 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
20313 file, and an exclusive lock on the file whose name is
20314 .code
20315 /tmp/.<device-number>.<inode-number>
20316 .endd
20317 using the device and inode numbers of the open mailbox file, in accordance with
20318 the MBX locking rules. This file is created with a mode that is specified by
20319 the &%lockfile_mode%& option.
20320
20321 If Exim fails to lock the file, there are two possible courses of action,
20322 depending on the value of the locking timeout. This is obtained from
20323 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
20324
20325 If the timeout value is zero, the file is closed, Exim waits for
20326 &%lock_interval%&, and then goes back and re-opens the file as above and tries
20327 to lock it again. This happens up to &%lock_retries%& times, after which the
20328 delivery is deferred.
20329
20330 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
20331 &[flock()]& are used (with the given timeout), so there has already been some
20332 waiting involved by the time locking fails. Nevertheless, Exim does not give up
20333 immediately. It retries up to
20334 .code
20335 (lock_retries * lock_interval) / <timeout>
20336 .endd
20337 times (rounded up).
20338 .endlist
20339
20340 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
20341 and/or &[flock()]& locks) and then deletes the lock file if one was created.
20342
20343
20344 .section "Operational details for delivery to a new file" "SECTopdir"
20345 .cindex "delivery" "to single file"
20346 .cindex "&""From""& line"
20347 When the &%directory%& option is set instead of &%file%&, each message is
20348 delivered into a newly-created file or set of files. When &(appendfile)& is
20349 activated directly from a &(redirect)& router, neither &%file%& nor
20350 &%directory%& is normally set, because the path for delivery is supplied by the
20351 router. (See for example, the &(address_file)& transport in the default
20352 configuration.) In this case, delivery is to a new file if either the path name
20353 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
20354
20355 No locking is required while writing the message to a new file, so the various
20356 locking options of the transport are ignored. The &"From"& line that by default
20357 separates messages in a single file is not normally needed, nor is the escaping
20358 of message lines that start with &"From"&, and there is no need to ensure a
20359 newline at the end of each message. Consequently, the default values for
20360 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
20361 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
20362
20363 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
20364 the files in the delivery directory by default. However, you can specify a
20365 different directory by setting &%quota_directory%&. Also, for maildir
20366 deliveries (see below) the &_maildirfolder_& convention is honoured.
20367
20368
20369 .cindex "maildir format"
20370 .cindex "mailstore format"
20371 There are three different ways in which delivery to individual files can be
20372 done, controlled by the settings of the &%maildir_format%& and
20373 &%mailstore_format%& options. Note that code to support maildir or mailstore
20374 formats is not included in the binary unless SUPPORT_MAILDIR or
20375 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
20376
20377 .cindex "directory creation"
20378 In all three cases an attempt is made to create the directory and any necessary
20379 sub-directories if they do not exist, provided that the &%create_directory%&
20380 option is set (the default). The location of a created directory can be
20381 constrained by setting &%create_file%&. A created directory's mode is given by
20382 the &%directory_mode%& option. If creation fails, or if the
20383 &%create_directory%& option is not set when creation is required, delivery is
20384 deferred.
20385
20386
20387
20388 .section "Maildir delivery" "SECTmaildirdelivery"
20389 .cindex "maildir format" "description of"
20390 If the &%maildir_format%& option is true, Exim delivers each message by writing
20391 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
20392 directory that is defined by the &%directory%& option (the &"delivery
20393 directory"&). If the delivery is successful, the file is renamed into the
20394 &_new_& subdirectory.
20395
20396 In the file name, <&'stime'&> is the current time of day in seconds, and
20397 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
20398 Exim checks that the time-of-day clock has moved on by at least one microsecond
20399 before terminating the delivery process. This guarantees uniqueness for the
20400 file name. However, as a precaution, Exim calls &[stat()]& for the file before
20401 opening it. If any response other than ENOENT (does not exist) is given,
20402 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
20403
20404 Before Exim carries out a maildir delivery, it ensures that subdirectories
20405 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
20406 do not exist, Exim tries to create them and any superior directories in their
20407 path, subject to the &%create_directory%& and &%create_file%& options. If the
20408 &%maildirfolder_create_regex%& option is set, and the regular expression it
20409 contains matches the delivery directory, Exim also ensures that a file called
20410 &_maildirfolder_& exists in the delivery directory. If a missing directory or
20411 &_maildirfolder_& file cannot be created, delivery is deferred.
20412
20413 These features make it possible to use Exim to create all the necessary files
20414 and directories in a maildir mailbox, including subdirectories for maildir++
20415 folders. Consider this example:
20416 .code
20417 maildir_format = true
20418 directory = /var/mail/$local_part\
20419            ${if eq{$local_part_suffix}{}{}\
20420            {/.${substr_1:$local_part_suffix}}}
20421 maildirfolder_create_regex = /\.[^/]+$
20422 .endd
20423 If &$local_part_suffix$& is empty (there was no suffix for the local part),
20424 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
20425 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
20426 not match this name, so Exim will not look for or create the file
20427 &_/var/mail/pimbo/maildirfolder_&, though it will create
20428 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
20429
20430 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
20431 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
20432 does match &%maildirfolder_create_regex%&. In this case, Exim will create
20433 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
20434 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
20435
20436 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
20437 not inadvertently match the toplevel maildir directory, because a
20438 &_maildirfolder_& file at top level would completely break quota calculations.
20439
20440 .cindex "quota" "in maildir delivery"
20441 .cindex "maildir++"
20442 If Exim is required to check a &%quota%& setting before a maildir delivery, and
20443 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
20444 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
20445 Exim assumes the directory is a maildir++ folder directory, which is one level
20446 down from the user's top level mailbox directory. This causes it to start at
20447 the parent directory instead of the current directory when calculating the
20448 amount of space used.
20449
20450 One problem with delivering into a multi-file mailbox is that it is
20451 computationally expensive to compute the size of the mailbox for quota
20452 checking. Various approaches have been taken to reduce the amount of work
20453 needed. The next two sections describe two of them. A third alternative is to
20454 use some external process for maintaining the size data, and use the expansion
20455 of the &%mailbox_size%& option as a way of importing it into Exim.
20456
20457
20458
20459
20460 .section "Using tags to record message sizes" "SECID135"
20461 If &%maildir_tag%& is set, the string is expanded for each delivery.
20462 When the maildir file is renamed into the &_new_& sub-directory, the
20463 tag is added to its name. However, if adding the tag takes the length of the
20464 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
20465 the tag is dropped and the maildir file is created with no tag.
20466
20467 .vindex "&$message_size$&"
20468 Tags can be used to encode the size of files in their names; see
20469 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
20470 happens after the message has been written. The value of the &$message_size$&
20471 variable is set to the number of bytes actually written. If the expansion is
20472 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
20473 be deferred. The expanded tag may contain any printing characters except &"/"&.
20474 Non-printing characters in the string are ignored; if the resulting string is
20475 empty, it is ignored. If it starts with an alphanumeric character, a leading
20476 colon is inserted.
20477
20478
20479
20480 .section "Using a maildirsize file" "SECID136"
20481 .cindex "quota" "in maildir delivery"
20482 .cindex "maildir format" "&_maildirsize_& file"
20483 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
20484 storing quota and message size information in a file called &_maildirsize_&
20485 within the toplevel maildir directory. If this file does not exist, Exim
20486 creates it, setting the quota from the &%quota%& option of the transport. If
20487 the maildir directory itself does not exist, it is created before any attempt
20488 to write a &_maildirsize_& file.
20489
20490 The &_maildirsize_& file is used to hold information about the sizes of
20491 messages in the maildir, thus speeding up quota calculations. The quota value
20492 in the file is just a cache; if the quota is changed in the transport, the new
20493 value overrides the cached value when the next message is delivered. The cache
20494 is maintained for the benefit of other programs that access the maildir and
20495 need to know the quota.
20496
20497 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
20498 file is maintained (with a zero quota setting), but no quota is imposed.
20499
20500 A regular expression is available for controlling which directories in the
20501 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
20502 See the description of the &%maildir_quota_directory_regex%& option above for
20503 details.
20504
20505
20506 .section "Mailstore delivery" "SECID137"
20507 .cindex "mailstore format" "description of"
20508 If the &%mailstore_format%& option is true, each message is written as two
20509 files in the given directory. A unique base name is constructed from the
20510 message id and the current delivery process, and the files that are written use
20511 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
20512 contains the message's envelope, and the &_.msg_& file contains the message
20513 itself. The base name is placed in the variable &$mailstore_basename$&.
20514
20515 During delivery, the envelope is first written to a file with the suffix
20516 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
20517 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
20518 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
20519 file before accessing either of them. An alternative approach is to wait for
20520 the absence of a &_.tmp_& file.
20521
20522 The envelope file starts with any text defined by the &%mailstore_prefix%&
20523 option, expanded and terminated by a newline if there isn't one. Then follows
20524 the sender address on one line, then all the recipient addresses, one per line.
20525 There can be more than one recipient only if the &%batch_max%& option is set
20526 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
20527 appended to the file, followed by a newline if it does not end with one.
20528
20529 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
20530 failure, it is ignored. Other expansion errors are treated as serious
20531 configuration errors, and delivery is deferred. The variable
20532 &$mailstore_basename$& is available for use during these expansions.
20533
20534
20535 .section "Non-special new file delivery" "SECID138"
20536 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
20537 file is created directly in the named directory. For example, when delivering
20538 messages into files in batched SMTP format for later delivery to some host (see
20539 section &<<SECTbatchSMTP>>&), a setting such as
20540 .code
20541 directory = /var/bsmtp/$host
20542 .endd
20543 might be used. A message is written to a file with a temporary name, which is
20544 then renamed when the delivery is complete. The final name is obtained by
20545 expanding the contents of the &%directory_file%& option.
20546 .ecindex IIDapptra1
20547 .ecindex IIDapptra2
20548
20549
20550
20551
20552
20553
20554 . ////////////////////////////////////////////////////////////////////////////
20555 . ////////////////////////////////////////////////////////////////////////////
20556
20557 .chapter "The autoreply transport" "CHID8"
20558 .scindex IIDauttra1 "transports" "&(autoreply)&"
20559 .scindex IIDauttra2 "&(autoreply)& transport"
20560 The &(autoreply)& transport is not a true transport in that it does not cause
20561 the message to be transmitted. Instead, it generates a new mail message as an
20562 automatic reply to the incoming message. &'References:'& and
20563 &'Auto-Submitted:'& header lines are included. These are constructed according
20564 to the rules in RFCs 2822 and 3834, respectively.
20565
20566 If the router that passes the message to this transport does not have the
20567 &%unseen%& option set, the original message (for the current recipient) is not
20568 delivered anywhere. However, when the &%unseen%& option is set on the router
20569 that passes the message to this transport, routing of the address continues, so
20570 another router can set up a normal message delivery.
20571
20572
20573 The &(autoreply)& transport is usually run as the result of mail filtering, a
20574 &"vacation"& message being the standard example. However, it can also be run
20575 directly from a router like any other transport. To reduce the possibility of
20576 message cascades, messages created by the &(autoreply)& transport always have
20577 empty envelope sender addresses, like bounce messages.
20578
20579 The parameters of the message to be sent can be specified in the configuration
20580 by options described below. However, these are used only when the address
20581 passed to the transport does not contain its own reply information. When the
20582 transport is run as a consequence of a
20583 &%mail%&
20584 or &%vacation%& command in a filter file, the parameters of the message are
20585 supplied by the filter, and passed with the address. The transport's options
20586 that define the message are then ignored (so they are not usually set in this
20587 case). The message is specified entirely by the filter or by the transport; it
20588 is never built from a mixture of options. However, the &%file_optional%&,
20589 &%mode%&, and &%return_message%& options apply in all cases.
20590
20591 &(Autoreply)& is implemented as a local transport. When used as a result of a
20592 command in a user's filter file, &(autoreply)& normally runs under the uid and
20593 gid of the user, and with appropriate current and home directories (see chapter
20594 &<<CHAPenvironment>>&).
20595
20596 There is a subtle difference between routing a message to a &(pipe)& transport
20597 that generates some text to be returned to the sender, and routing it to an
20598 &(autoreply)& transport. This difference is noticeable only if more than one
20599 address from the same message is so handled. In the case of a pipe, the
20600 separate outputs from the different addresses are gathered up and returned to
20601 the sender in a single message, whereas if &(autoreply)& is used, a separate
20602 message is generated for each address that is passed to it.
20603
20604 Non-printing characters are not permitted in the header lines generated for the
20605 message that &(autoreply)& creates, with the exception of newlines that are
20606 immediately followed by white space. If any non-printing characters are found,
20607 the transport defers.
20608 Whether characters with the top bit set count as printing characters or not is
20609 controlled by the &%print_topbitchars%& global option.
20610
20611 If any of the generic options for manipulating headers (for example,
20612 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
20613 of the original message that is included in the generated message when
20614 &%return_message%& is set. They do not apply to the generated message itself.
20615
20616 .vindex "&$sender_address$&"
20617 If the &(autoreply)& transport receives return code 2 from Exim when it submits
20618 the message, indicating that there were no recipients, it does not treat this
20619 as an error. This means that autoreplies sent to &$sender_address$& when this
20620 is empty (because the incoming message is a bounce message) do not cause
20621 problems. They are just discarded.
20622
20623
20624
20625 .section "Private options for autoreply" "SECID139"
20626 .cindex "options" "&(autoreply)& transport"
20627
20628 .option bcc autoreply string&!! unset
20629 This specifies the addresses that are to receive &"blind carbon copies"& of the
20630 message when the message is specified by the transport.
20631
20632
20633 .option cc autoreply string&!! unset
20634 This specifies recipients of the message and the contents of the &'Cc:'& header
20635 when the message is specified by the transport.
20636
20637
20638 .option file autoreply string&!! unset
20639 The contents of the file are sent as the body of the message when the message
20640 is specified by the transport. If both &%file%& and &%text%& are set, the text
20641 string comes first.
20642
20643
20644 .option file_expand autoreply boolean false
20645 If this is set, the contents of the file named by the &%file%& option are
20646 subjected to string expansion as they are added to the message.
20647
20648
20649 .option file_optional autoreply boolean false
20650 If this option is true, no error is generated if the file named by the &%file%&
20651 option or passed with the address does not exist or cannot be read.
20652
20653
20654 .option from autoreply string&!! unset
20655 This specifies the contents of the &'From:'& header when the message is
20656 specified by the transport.
20657
20658
20659 .option headers autoreply string&!! unset
20660 This specifies additional RFC 2822 headers that are to be added to the message
20661 when the message is specified by the transport. Several can be given by using
20662 &"\n"& to separate them. There is no check on the format.
20663
20664
20665 .option log autoreply string&!! unset
20666 This option names a file in which a record of every message sent is logged when
20667 the message is specified by the transport.
20668
20669
20670 .option mode autoreply "octal integer" 0600
20671 If either the log file or the &"once"& file has to be created, this mode is
20672 used.
20673
20674
20675 .option never_mail autoreply "address list&!!" unset
20676 If any run of the transport creates a message with a recipient that matches any
20677 item in the list, that recipient is quietly discarded. If all recipients are
20678 discarded, no message is created. This applies both when the recipients are
20679 generated by a filter and when they are specified in the transport.
20680
20681
20682
20683 .option once autoreply string&!! unset
20684 This option names a file or DBM database in which a record of each &'To:'&
20685 recipient is kept when the message is specified by the transport. &*Note*&:
20686 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
20687
20688 If &%once%& is unset, or is set to an empty string, the message is always sent.
20689 By default, if &%once%& is set to a non-empty file name, the message
20690 is not sent if a potential recipient is already listed in the database.
20691 However, if the &%once_repeat%& option specifies a time greater than zero, the
20692 message is sent if that much time has elapsed since a message was last sent to
20693 this recipient. A setting of zero time for &%once_repeat%& (the default)
20694 prevents a message from being sent a second time &-- in this case, zero means
20695 infinity.
20696
20697 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
20698 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
20699 greater than zero, it changes the way Exim implements the &%once%& option.
20700 Instead of using a DBM file to record every recipient it sends to, it uses a
20701 regular file, whose size will never get larger than the given value.
20702
20703 In the file, Exim keeps a linear list of recipient addresses and the times at
20704 which they were sent messages. If the file is full when a new address needs to
20705 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
20706 means that a given recipient may receive multiple messages, but at
20707 unpredictable intervals that depend on the rate of turnover of addresses in the
20708 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
20709
20710
20711 .option once_file_size autoreply integer 0
20712 See &%once%& above.
20713
20714
20715 .option once_repeat autoreply time&!! 0s
20716 See &%once%& above.
20717 After expansion, the value of this option must be a valid time value.
20718
20719
20720 .option reply_to autoreply string&!! unset
20721 This specifies the contents of the &'Reply-To:'& header when the message is
20722 specified by the transport.
20723
20724
20725 .option return_message autoreply boolean false
20726 If this is set, a copy of the original message is returned with the new
20727 message, subject to the maximum size set in the &%return_size_limit%& global
20728 configuration option.
20729
20730
20731 .option subject autoreply string&!! unset
20732 This specifies the contents of the &'Subject:'& header when the message is
20733 specified by the transport. It is tempting to quote the original subject in
20734 automatic responses. For example:
20735 .code
20736 subject = Re: $h_subject:
20737 .endd
20738 There is a danger in doing this, however. It may allow a third party to
20739 subscribe your users to an opt-in mailing list, provided that the list accepts
20740 bounce messages as subscription confirmations. Well-managed lists require a
20741 non-bounce message to confirm a subscription, so the danger is relatively
20742 small.
20743
20744
20745
20746 .option text autoreply string&!! unset
20747 This specifies a single string to be used as the body of the message when the
20748 message is specified by the transport. If both &%text%& and &%file%& are set,
20749 the text comes first.
20750
20751
20752 .option to autoreply string&!! unset
20753 This specifies recipients of the message and the contents of the &'To:'& header
20754 when the message is specified by the transport.
20755 .ecindex IIDauttra1
20756 .ecindex IIDauttra2
20757
20758
20759
20760
20761 . ////////////////////////////////////////////////////////////////////////////
20762 . ////////////////////////////////////////////////////////////////////////////
20763
20764 .chapter "The lmtp transport" "CHAPLMTP"
20765 .cindex "transports" "&(lmtp)&"
20766 .cindex "&(lmtp)& transport"
20767 .cindex "LMTP" "over a pipe"
20768 .cindex "LMTP" "over a socket"
20769 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
20770 specified command
20771 or by interacting with a Unix domain socket.
20772 This transport is something of a cross between the &(pipe)& and &(smtp)&
20773 transports. Exim also has support for using LMTP over TCP/IP; this is
20774 implemented as an option for the &(smtp)& transport. Because LMTP is expected
20775 to be of minority interest, the default build-time configure in &_src/EDITME_&
20776 has it commented out. You need to ensure that
20777 .code
20778 TRANSPORT_LMTP=yes
20779 .endd
20780 .cindex "options" "&(lmtp)& transport"
20781 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
20782 included in the Exim binary. The private options of the &(lmtp)& transport are
20783 as follows:
20784
20785 .option batch_id lmtp string&!! unset
20786 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20787
20788
20789 .option batch_max lmtp integer 1
20790 This limits the number of addresses that can be handled in a single delivery.
20791 Most LMTP servers can handle several addresses at once, so it is normally a
20792 good idea to increase this value. See the description of local delivery
20793 batching in chapter &<<CHAPbatching>>&.
20794
20795
20796 .option command lmtp string&!! unset
20797 This option must be set if &%socket%& is not set. The string is a command which
20798 is run in a separate process. It is split up into a command name and list of
20799 arguments, each of which is separately expanded (so expansion cannot change the
20800 number of arguments). The command is run directly, not via a shell. The message
20801 is passed to the new process using the standard input and output to operate the
20802 LMTP protocol.
20803
20804 .option ignore_quota lmtp boolean false
20805 .cindex "LMTP" "ignoring quota errors"
20806 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
20807 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
20808 in its response to the LHLO command.
20809
20810 .option socket lmtp string&!! unset
20811 This option must be set if &%command%& is not set. The result of expansion must
20812 be the name of a Unix domain socket. The transport connects to the socket and
20813 delivers the message to it using the LMTP protocol.
20814
20815
20816 .option timeout lmtp time 5m
20817 The transport is aborted if the created process or Unix domain socket does not
20818 respond to LMTP commands or message input within this timeout. Delivery
20819 is deferred, and will be tried again later. Here is an example of a typical
20820 LMTP transport:
20821 .code
20822 lmtp:
20823   driver = lmtp
20824   command = /some/local/lmtp/delivery/program
20825   batch_max = 20
20826   user = exim
20827 .endd
20828 This delivers up to 20 addresses at a time, in a mixture of domains if
20829 necessary, running as the user &'exim'&.
20830
20831
20832
20833 . ////////////////////////////////////////////////////////////////////////////
20834 . ////////////////////////////////////////////////////////////////////////////
20835
20836 .chapter "The pipe transport" "CHAPpipetransport"
20837 .scindex IIDpiptra1 "transports" "&(pipe)&"
20838 .scindex IIDpiptra2 "&(pipe)& transport"
20839 The &(pipe)& transport is used to deliver messages via a pipe to a command
20840 running in another process. One example is the use of &(pipe)& as a
20841 pseudo-remote transport for passing messages to some other delivery mechanism
20842 (such as UUCP). Another is the use by individual users to automatically process
20843 their incoming messages. The &(pipe)& transport can be used in one of the
20844 following ways:
20845
20846 .ilist
20847 .vindex "&$local_part$&"
20848 A router routes one address to a transport in the normal way, and the
20849 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
20850 contains the local part of the address (as usual), and the command that is run
20851 is specified by the &%command%& option on the transport.
20852 .next
20853 .vindex "&$pipe_addresses$&"
20854 If the &%batch_max%& option is set greater than 1 (the default is 1), the
20855 transport can handle more than one address in a single run. In this case, when
20856 more than one address is routed to the transport, &$local_part$& is not set
20857 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
20858 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
20859 that are routed to the transport.
20860 .next
20861 .vindex "&$address_pipe$&"
20862 A router redirects an address directly to a pipe command (for example, from an
20863 alias or forward file). In this case, &$address_pipe$& contains the text of the
20864 pipe command, and the &%command%& option on the transport is ignored. If only
20865 one address is being transported (&%batch_max%& is not greater than one, or
20866 only one address was redirected to this pipe command), &$local_part$& contains
20867 the local part that was redirected.
20868 .endlist
20869
20870
20871 The &(pipe)& transport is a non-interactive delivery method. Exim can also
20872 deliver messages over pipes using the LMTP interactive protocol. This is
20873 implemented by the &(lmtp)& transport.
20874
20875 In the case when &(pipe)& is run as a consequence of an entry in a local user's
20876 &_.forward_& file, the command runs under the uid and gid of that user. In
20877 other cases, the uid and gid have to be specified explicitly, either on the
20878 transport or on the router that handles the address. Current and &"home"&
20879 directories are also controllable. See chapter &<<CHAPenvironment>>& for
20880 details of the local delivery environment and chapter &<<CHAPbatching>>&
20881 for a discussion of local delivery batching.
20882
20883
20884 .section "Concurrent delivery" "SECID140"
20885 If two messages arrive at almost the same time, and both are routed to a pipe
20886 delivery, the two pipe transports may be run concurrently. You must ensure that
20887 any pipe commands you set up are robust against this happening. If the commands
20888 write to a file, the &%exim_lock%& utility might be of use.
20889
20890
20891
20892
20893 .section "Returned status and data" "SECID141"
20894 .cindex "&(pipe)& transport" "returned data"
20895 If the command exits with a non-zero return code, the delivery is deemed to
20896 have failed, unless either the &%ignore_status%& option is set (in which case
20897 the return code is treated as zero), or the return code is one of those listed
20898 in the &%temp_errors%& option, which are interpreted as meaning &"try again
20899 later"&. In this case, delivery is deferred. Details of a permanent failure are
20900 logged, but are not included in the bounce message, which merely contains
20901 &"local delivery failed"&.
20902
20903 If the return code is greater than 128 and the command being run is a shell
20904 script, it normally means that the script was terminated by a signal whose
20905 value is the return code minus 128.
20906
20907 If Exim is unable to run the command (that is, if &[execve()]& fails), the
20908 return code is set to 127. This is the value that a shell returns if it is
20909 asked to run a non-existent command. The wording for the log line suggests that
20910 a non-existent command may be the problem.
20911
20912 The &%return_output%& option can affect the result of a pipe delivery. If it is
20913 set and the command produces any output on its standard output or standard
20914 error streams, the command is considered to have failed, even if it gave a zero
20915 return code or if &%ignore_status%& is set. The output from the command is
20916 included as part of the bounce message. The &%return_fail_output%& option is
20917 similar, except that output is returned only when the command exits with a
20918 failure return code, that is, a value other than zero or a code that matches
20919 &%temp_errors%&.
20920
20921
20922
20923 .section "How the command is run" "SECThowcommandrun"
20924 .cindex "&(pipe)& transport" "path for command"
20925 The command line is (by default) broken down into a command name and arguments
20926 by the &(pipe)& transport itself. The &%allow_commands%& and
20927 &%restrict_to_path%& options can be used to restrict the commands that may be
20928 run.
20929
20930 .cindex "quoting" "in pipe command"
20931 Unquoted arguments are delimited by white space. If an argument appears in
20932 double quotes, backslash is interpreted as an escape character in the usual
20933 way. If an argument appears in single quotes, no escaping is done.
20934
20935 String expansion is applied to the command line except when it comes from a
20936 traditional &_.forward_& file (commands from a filter file are expanded). The
20937 expansion is applied to each argument in turn rather than to the whole line.
20938 For this reason, any string expansion item that contains white space must be
20939 quoted so as to be contained within a single argument. A setting such as
20940 .code
20941 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
20942 .endd
20943 will not work, because the expansion item gets split between several
20944 arguments. You have to write
20945 .code
20946 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
20947 .endd
20948 to ensure that it is all in one argument. The expansion is done in this way,
20949 argument by argument, so that the number of arguments cannot be changed as a
20950 result of expansion, and quotes or backslashes in inserted variables do not
20951 interact with external quoting. However, this leads to problems if you want to
20952 generate multiple arguments (or the command name plus arguments) from a single
20953 expansion. In this situation, the simplest solution is to use a shell. For
20954 example:
20955 .code
20956 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
20957 .endd
20958
20959 .cindex "transport" "filter"
20960 .cindex "filter" "transport filter"
20961 .vindex "&$pipe_addresses$&"
20962 Special handling takes place when an argument consists of precisely the text
20963 &`$pipe_addresses`&. This is not a general expansion variable; the only
20964 place this string is recognized is when it appears as an argument for a pipe or
20965 transport filter command. It causes each address that is being handled to be
20966 inserted in the argument list at that point &'as a separate argument'&. This
20967 avoids any problems with spaces or shell metacharacters, and is of use when a
20968 &(pipe)& transport is handling groups of addresses in a batch.
20969
20970 After splitting up into arguments and expansion, the resulting command is run
20971 in a subprocess directly from the transport, &'not'& under a shell. The
20972 message that is being delivered is supplied on the standard input, and the
20973 standard output and standard error are both connected to a single pipe that is
20974 read by Exim. The &%max_output%& option controls how much output the command
20975 may produce, and the &%return_output%& and &%return_fail_output%& options
20976 control what is done with it.
20977
20978 Not running the command under a shell (by default) lessens the security risks
20979 in cases when a command from a user's filter file is built out of data that was
20980 taken from an incoming message. If a shell is required, it can of course be
20981 explicitly specified as the command to be run. However, there are circumstances
20982 where existing commands (for example, in &_.forward_& files) expect to be run
20983 under a shell and cannot easily be modified. To allow for these cases, there is
20984 an option called &%use_shell%&, which changes the way the &(pipe)& transport
20985 works. Instead of breaking up the command line as just described, it expands it
20986 as a single string and passes the result to &_/bin/sh_&. The
20987 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
20988 with &%use_shell%&, and the whole mechanism is inherently less secure.
20989
20990
20991
20992 .section "Environment variables" "SECTpipeenv"
20993 .cindex "&(pipe)& transport" "environment for command"
20994 .cindex "environment for pipe transport"
20995 The environment variables listed below are set up when the command is invoked.
20996 This list is a compromise for maximum compatibility with other MTAs. Note that
20997 the &%environment%& option can be used to add additional variables to this
20998 environment.
20999 .display
21000 &`DOMAIN            `&   the domain of the address
21001 &`HOME              `&   the home directory, if set
21002 &`HOST              `&   the host name when called from a router (see below)
21003 &`LOCAL_PART        `&   see below
21004 &`LOCAL_PART_PREFIX `&   see below
21005 &`LOCAL_PART_SUFFIX `&   see below
21006 &`LOGNAME           `&   see below
21007 &`MESSAGE_ID        `&   Exim's local ID for the message
21008 &`PATH              `&   as specified by the &%path%& option below
21009 &`QUALIFY_DOMAIN    `&   the sender qualification domain
21010 &`RECIPIENT         `&   the complete recipient address
21011 &`SENDER            `&   the sender of the message (empty if a bounce)
21012 &`SHELL             `&   &`/bin/sh`&
21013 &`TZ                `&   the value of the &%timezone%& option, if set
21014 &`USER              `&   see below
21015 .endd
21016 When a &(pipe)& transport is called directly from (for example) an &(accept)&
21017 router, LOCAL_PART is set to the local part of the address. When it is
21018 called as a result of a forward or alias expansion, LOCAL_PART is set to
21019 the local part of the address that was expanded. In both cases, any affixes are
21020 removed from the local part, and made available in LOCAL_PART_PREFIX and
21021 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
21022 same value as LOCAL_PART for compatibility with other MTAs.
21023
21024 .cindex "HOST"
21025 HOST is set only when a &(pipe)& transport is called from a router that
21026 associates hosts with an address, typically when using &(pipe)& as a
21027 pseudo-remote transport. HOST is set to the first host name specified by
21028 the router.
21029
21030 .cindex "HOME"
21031 If the transport's generic &%home_directory%& option is set, its value is used
21032 for the HOME environment variable. Otherwise, a home directory may be set
21033 by the router's &%transport_home_directory%& option, which defaults to the
21034 user's home directory if &%check_local_user%& is set.
21035
21036
21037 .section "Private options for pipe" "SECID142"
21038 .cindex "options" "&(pipe)& transport"
21039
21040
21041
21042 .option allow_commands pipe "string list&!!" unset
21043 .cindex "&(pipe)& transport" "permitted commands"
21044 The string is expanded, and is then interpreted as a colon-separated list of
21045 permitted commands. If &%restrict_to_path%& is not set, the only commands
21046 permitted are those in the &%allow_commands%& list. They need not be absolute
21047 paths; the &%path%& option is still used for relative paths. If
21048 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
21049 in the &%allow_commands%& list, or a name without any slashes that is found on
21050 the path. In other words, if neither &%allow_commands%& nor
21051 &%restrict_to_path%& is set, there is no restriction on the command, but
21052 otherwise only commands that are permitted by one or the other are allowed. For
21053 example, if
21054 .code
21055 allow_commands = /usr/bin/vacation
21056 .endd
21057 and &%restrict_to_path%& is not set, the only permitted command is
21058 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
21059 &%use_shell%& is set.
21060
21061
21062 .option batch_id pipe string&!! unset
21063 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21064
21065
21066 .option batch_max pipe integer 1
21067 This limits the number of addresses that can be handled in a single delivery.
21068 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21069
21070
21071 .option check_string pipe string unset
21072 As &(pipe)& writes the message, the start of each line is tested for matching
21073 &%check_string%&, and if it does, the initial matching characters are replaced
21074 by the contents of &%escape_string%&, provided both are set. The value of
21075 &%check_string%& is a literal string, not a regular expression, and the case of
21076 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
21077 of &%check_string%& and &%escape_string%& are forced to values that implement
21078 the SMTP escaping protocol. Any settings made in the configuration file are
21079 ignored.
21080
21081
21082 .option command pipe string&!! unset
21083 This option need not be set when &(pipe)& is being used to deliver to pipes
21084 obtained directly from address redirections. In other cases, the option must be
21085 set, to provide a command to be run. It need not yield an absolute path (see
21086 the &%path%& option below). The command is split up into separate arguments by
21087 Exim, and each argument is separately expanded, as described in section
21088 &<<SECThowcommandrun>>& above.
21089
21090
21091 .option environment pipe string&!! unset
21092 .cindex "&(pipe)& transport" "environment for command"
21093 .cindex "environment for &(pipe)& transport"
21094 This option is used to add additional variables to the environment in which the
21095 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
21096 a string which is expanded, and then interpreted as a colon-separated list of
21097 environment settings of the form <&'name'&>=<&'value'&>.
21098
21099
21100 .option escape_string pipe string unset
21101 See &%check_string%& above.
21102
21103
21104 .option freeze_exec_fail pipe boolean false
21105 .cindex "exec failure"
21106 .cindex "failure of exec"
21107 .cindex "&(pipe)& transport" "failure of exec"
21108 Failure to exec the command in a pipe transport is by default treated like
21109 any other failure while running the command. However, if &%freeze_exec_fail%&
21110 is set, failure to exec is treated specially, and causes the message to be
21111 frozen, whatever the setting of &%ignore_status%&.
21112
21113
21114 .option ignore_status pipe boolean false
21115 If this option is true, the status returned by the subprocess that is set up to
21116 run the command is ignored, and Exim behaves as if zero had been returned.
21117 Otherwise, a non-zero status or termination by signal causes an error return
21118 from the transport unless the status value is one of those listed in
21119 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
21120
21121 &*Note*&: This option does not apply to timeouts, which do not return a status.
21122 See the &%timeout_defer%& option for how timeouts are handled.
21123
21124 .option log_defer_output pipe boolean false
21125 .cindex "&(pipe)& transport" "logging output"
21126 If this option is set, and the status returned by the command is
21127 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
21128 and any output was produced, the first line of it is written to the main log.
21129
21130
21131 .option log_fail_output pipe boolean false
21132 If this option is set, and the command returns any output, and also ends with a
21133 return code that is neither zero nor one of the return codes listed in
21134 &%temp_errors%& (that is, the delivery failed), the first line of output is
21135 written to the main log. This option and &%log_output%& are mutually exclusive.
21136 Only one of them may be set.
21137
21138
21139
21140 .option log_output pipe boolean false
21141 If this option is set and the command returns any output, the first line of
21142 output is written to the main log, whatever the return code. This option and
21143 &%log_fail_output%& are mutually exclusive. Only one of them may be set.
21144
21145
21146
21147 .option max_output pipe integer 20K
21148 This specifies the maximum amount of output that the command may produce on its
21149 standard output and standard error file combined. If the limit is exceeded, the
21150 process running the command is killed. This is intended as a safety measure to
21151 catch runaway processes. The limit is applied independently of the settings of
21152 the options that control what is done with such output (for example,
21153 &%return_output%&). Because of buffering effects, the amount of output may
21154 exceed the limit by a small amount before Exim notices.
21155
21156
21157 .option message_prefix pipe string&!! "see below"
21158 The string specified here is expanded and output at the start of every message.
21159 The default is unset if &%use_bsmtp%& is set. Otherwise it is
21160 .code
21161 message_prefix = \
21162   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
21163   ${tod_bsdinbox}\n
21164 .endd
21165 .cindex "Cyrus"
21166 .cindex "&%tmail%&"
21167 .cindex "&""From""& line"
21168 This is required by the commonly used &_/usr/bin/vacation_& program.
21169 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
21170 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
21171 setting
21172 .code
21173 message_prefix =
21174 .endd
21175 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21176 &`\n`& to &`\r\n`& in &%message_prefix%&.
21177
21178
21179 .option message_suffix pipe string&!! "see below"
21180 The string specified here is expanded and output at the end of every message.
21181 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
21182 The suffix can be suppressed by setting
21183 .code
21184 message_suffix =
21185 .endd
21186 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21187 &`\n`& to &`\r\n`& in &%message_suffix%&.
21188
21189
21190 .option path pipe string "see below"
21191 This option specifies the string that is set up in the PATH environment
21192 variable of the subprocess. The default is:
21193 .code
21194 /bin:/usr/bin
21195 .endd
21196 If the &%command%& option does not yield an absolute path name, the command is
21197 sought in the PATH directories, in the usual way. &*Warning*&: This does not
21198 apply to a command specified as a transport filter.
21199
21200
21201 .new
21202 .option permit_coredump pipe boolean false
21203 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
21204 a core-dump of a pipe command, enable this command.  This enables core-dumps
21205 during delivery and affects both the Exim binary and the pipe command run.
21206 It is recommended that this option remain off unless and until you have a need
21207 for it and that this only be enabled when needed, as the risk of excessive
21208 resource consumption can be quite high.  Note also that Exim is typically
21209 installed as a setuid binary and most operating systems will inhibit coredumps
21210 of these by default, so further OS-specific action may be required.
21211 .wen
21212
21213
21214 .option pipe_as_creator pipe boolean false
21215 .cindex "uid (user id)" "local delivery"
21216 If the generic &%user%& option is not set and this option is true, the delivery
21217 process is run under the uid that was in force when Exim was originally called
21218 to accept the message. If the group id is not otherwise set (via the generic
21219 &%group%& option), the gid that was in force when Exim was originally called to
21220 accept the message is used.
21221
21222
21223 .option restrict_to_path pipe boolean false
21224 When this option is set, any command name not listed in &%allow_commands%& must
21225 contain no slashes. The command is searched for only in the directories listed
21226 in the &%path%& option. This option is intended for use in the case when a pipe
21227 command has been generated from a user's &_.forward_& file. This is usually
21228 handled by a &(pipe)& transport called &%address_pipe%&.
21229
21230
21231 .option return_fail_output pipe boolean false
21232 If this option is true, and the command produced any output and ended with a
21233 return code other than zero or one of the codes listed in &%temp_errors%& (that
21234 is, the delivery failed), the output is returned in the bounce message.
21235 However, if the message has a null sender (that is, it is itself a bounce
21236 message), output from the command is discarded. This option and
21237 &%return_output%& are mutually exclusive. Only one of them may be set.
21238
21239
21240
21241 .option return_output pipe boolean false
21242 If this option is true, and the command produced any output, the delivery is
21243 deemed to have failed whatever the return code from the command, and the output
21244 is returned in the bounce message. Otherwise, the output is just discarded.
21245 However, if the message has a null sender (that is, it is a bounce message),
21246 output from the command is always discarded, whatever the setting of this
21247 option. This option and &%return_fail_output%& are mutually exclusive. Only one
21248 of them may be set.
21249
21250
21251
21252 .option temp_errors pipe "string list" "see below"
21253 .cindex "&(pipe)& transport" "temporary failure"
21254 This option contains either a colon-separated list of numbers, or a single
21255 asterisk. If &%ignore_status%& is false
21256 and &%return_output%& is not set,
21257 and the command exits with a non-zero return code, the failure is treated as
21258 temporary and the delivery is deferred if the return code matches one of the
21259 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
21260 codes are treated as permanent errors. The default setting contains the codes
21261 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
21262 compiled on a system that does not define these macros, it assumes values of 75
21263 and 73, respectively.
21264
21265
21266 .option timeout pipe time 1h
21267 If the command fails to complete within this time, it is killed. This normally
21268 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
21269 specifies no timeout. In order to ensure that any subprocesses created by the
21270 command are also killed, Exim makes the initial process a process group leader,
21271 and kills the whole process group on a timeout. However, this can be defeated
21272 if one of the processes starts a new process group.
21273
21274 .option timeout_defer pipe boolean false
21275 A timeout in a &(pipe)& transport, either in the command that the transport
21276 runs, or in a transport filter that is associated with it, is by default
21277 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
21278 is set true, both kinds of timeout become temporary errors, causing the
21279 delivery to be deferred.
21280
21281 .option umask pipe "octal integer" 022
21282 This specifies the umask setting for the subprocess that runs the command.
21283
21284
21285 .option use_bsmtp pipe boolean false
21286 .cindex "envelope sender"
21287 If this option is set true, the &(pipe)& transport writes messages in &"batch
21288 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
21289 commands. If you want to include a leading HELO command with such messages,
21290 you can do so by setting the &%message_prefix%& option. See section
21291 &<<SECTbatchSMTP>>& for details of batch SMTP.
21292
21293 .option use_classresources pipe boolean false
21294 .cindex "class resources (BSD)"
21295 This option is available only when Exim is running on FreeBSD, NetBSD, or
21296 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
21297 resource limits when a &(pipe)& transport is run to perform a delivery. The
21298 limits for the uid under which the pipe is to run are obtained from the login
21299 class database.
21300
21301
21302 .option use_crlf pipe boolean false
21303 .cindex "carriage return"
21304 .cindex "linefeed"
21305 This option causes lines to be terminated with the two-character CRLF sequence
21306 (carriage return, linefeed) instead of just a linefeed character. In the case
21307 of batched SMTP, the byte sequence written to the pipe is then an exact image
21308 of what would be sent down a real SMTP connection.
21309
21310 The contents of the &%message_prefix%& and &%message_suffix%& options are
21311 written verbatim, so must contain their own carriage return characters if these
21312 are needed. When &%use_bsmtp%& is not set, the default values for both
21313 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
21314 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
21315
21316
21317 .option use_shell pipe boolean false
21318 .vindex "&$pipe_addresses$&"
21319 If this option is set, it causes the command to be passed to &_/bin/sh_&
21320 instead of being run directly from the transport, as described in section
21321 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
21322 where the command is expected to be run under a shell and cannot easily be
21323 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
21324 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
21325 command is expanded as a single string, and handed to &_/bin/sh_& as data for
21326 its &%-c%& option.
21327
21328
21329
21330 .section "Using an external local delivery agent" "SECID143"
21331 .cindex "local delivery" "using an external agent"
21332 .cindex "&'procmail'&"
21333 .cindex "external local delivery"
21334 .cindex "delivery" "&'procmail'&"
21335 .cindex "delivery" "by external agent"
21336 The &(pipe)& transport can be used to pass all messages that require local
21337 delivery to a separate local delivery agent such as &%procmail%&. When doing
21338 this, care must be taken to ensure that the pipe is run under an appropriate
21339 uid and gid. In some configurations one wants this to be a uid that is trusted
21340 by the delivery agent to supply the correct sender of the message. It may be
21341 necessary to recompile or reconfigure the delivery agent so that it trusts an
21342 appropriate user. The following is an example transport and router
21343 configuration for &%procmail%&:
21344 .code
21345 # transport
21346 procmail_pipe:
21347   driver = pipe
21348   command = /usr/local/bin/procmail -d $local_part
21349   return_path_add
21350   delivery_date_add
21351   envelope_to_add
21352   check_string = "From "
21353   escape_string = ">From "
21354   umask = 077
21355   user = $local_part
21356   group = mail
21357
21358 # router
21359 procmail:
21360   driver = accept
21361   check_local_user
21362   transport = procmail_pipe
21363 .endd
21364 In this example, the pipe is run as the local user, but with the group set to
21365 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
21366 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
21367 user to supply a correct sender address. If you do not specify either a
21368 &%group%& or a &%user%& option, the pipe command is run as the local user. The
21369 home directory is the user's home directory by default.
21370
21371 &*Note*&: The command that the pipe transport runs does &'not'& begin with
21372 .code
21373 IFS=" "
21374 .endd
21375 as shown in some &%procmail%& documentation, because Exim does not by default
21376 use a shell to run pipe commands.
21377
21378 .cindex "Cyrus"
21379 The next example shows a transport and a router for a system where local
21380 deliveries are handled by the Cyrus IMAP server.
21381 .code
21382 # transport
21383 local_delivery_cyrus:
21384   driver = pipe
21385   command = /usr/cyrus/bin/deliver \
21386             -m ${substr_1:$local_part_suffix} -- $local_part
21387   user = cyrus
21388   group = mail
21389   return_output
21390   log_output
21391   message_prefix =
21392   message_suffix =
21393
21394 # router
21395 local_user_cyrus:
21396   driver = accept
21397   check_local_user
21398   local_part_suffix = .*
21399   transport = local_delivery_cyrus
21400 .endd
21401 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
21402 &%return_output%& to cause any text written by Cyrus to be returned to the
21403 sender.
21404 .ecindex IIDpiptra1
21405 .ecindex IIDpiptra2
21406
21407
21408 . ////////////////////////////////////////////////////////////////////////////
21409 . ////////////////////////////////////////////////////////////////////////////
21410
21411 .chapter "The smtp transport" "CHAPsmtptrans"
21412 .scindex IIDsmttra1 "transports" "&(smtp)&"
21413 .scindex IIDsmttra2 "&(smtp)& transport"
21414 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
21415 or LMTP protocol. The list of hosts to try can either be taken from the address
21416 that is being processed (having been set up by the router), or specified
21417 explicitly for the transport. Timeout and retry processing (see chapter
21418 &<<CHAPretry>>&) is applied to each IP address independently.
21419
21420
21421 .section "Multiple messages on a single connection" "SECID144"
21422 The sending of multiple messages over a single TCP/IP connection can arise in
21423 two ways:
21424
21425 .ilist
21426 If a message contains more than &%max_rcpt%& (see below) addresses that are
21427 routed to the same host, more than one copy of the message has to be sent to
21428 that host. In this situation, multiple copies may be sent in a single run of
21429 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
21430 does when it has too many addresses to send in one message also depends on the
21431 value of the global &%remote_max_parallel%& option. Details are given in
21432 section &<<SECToutSMTPTCP>>&.)
21433 .next
21434 .cindex "hints database" "remembering routing"
21435 When a message has been successfully delivered over a TCP/IP connection, Exim
21436 looks in its hints database to see if there are any other messages awaiting a
21437 connection to the same host. If there are, a new delivery process is started
21438 for one of them, and the current TCP/IP connection is passed on to it. The new
21439 process may in turn send multiple copies and possibly create yet another
21440 process.
21441 .endlist
21442
21443
21444 For each copy sent over the same TCP/IP connection, a sequence counter is
21445 incremented, and if it ever gets to the value of &%connection_max_messages%&,
21446 no further messages are sent over that connection.
21447
21448
21449
21450 .section "Use of the $host and $host_address variables" "SECID145"
21451 .vindex "&$host$&"
21452 .vindex "&$host_address$&"
21453 At the start of a run of the &(smtp)& transport, the values of &$host$& and
21454 &$host_address$& are the name and IP address of the first host on the host list
21455 passed by the router. However, when the transport is about to connect to a
21456 specific host, and while it is connected to that host, &$host$& and
21457 &$host_address$& are set to the values for that host. These are the values
21458 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
21459 &%serialize_hosts%&, and the various TLS options are expanded.
21460
21461
21462 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
21463 .vindex &$tls_cipher$&
21464 .vindex &$tls_peerdn$&
21465 At the start of a run of the &(smtp)& transport, the values of &$tls_cipher$&
21466 and &$tls_peerdn$& are the values that were set when the message was received.
21467 These are the values that are used for options that are expanded before any
21468 SMTP connections are made. Just before each connection is made, these two
21469 variables are emptied. If TLS is subsequently started, they are set to the
21470 appropriate values for the outgoing connection, and these are the values that
21471 are in force when any authenticators are run and when the
21472 &%authenticated_sender%& option is expanded.
21473
21474
21475 .section "Private options for smtp" "SECID146"
21476 .cindex "options" "&(smtp)& transport"
21477 The private options of the &(smtp)& transport are as follows:
21478
21479
21480 .option address_retry_include_sender smtp boolean true
21481 .cindex "4&'xx'& responses" "retrying after"
21482 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
21483 is the combination of sender and recipient that is delayed in subsequent queue
21484 runs until the retry time is reached. You can delay the recipient without
21485 reference to the sender (which is what earlier versions of Exim did), by
21486 setting &%address_retry_include_sender%& false. However, this can lead to
21487 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
21488
21489 .option allow_localhost smtp boolean false
21490 .cindex "local host" "sending to"
21491 .cindex "fallback" "hosts specified on transport"
21492 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
21493 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
21494 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
21495 the delivery anyway. This should be used only in special cases when the
21496 configuration ensures that no looping will result (for example, a differently
21497 configured Exim is listening on the port to which the message is sent).
21498
21499
21500 .option authenticated_sender smtp string&!! unset
21501 .cindex "Cyrus"
21502 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
21503 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
21504 overriding any existing authenticated sender value. If the string expansion is
21505 forced to fail, the option is ignored. Other expansion failures cause delivery
21506 to be deferred. If the result of expansion is an empty string, that is also
21507 ignored.
21508
21509 The expansion happens after the outgoing connection has been made and TLS
21510 started, if required. This means that the &$host$&, &$host_address$&,
21511 &$tls_cipher$&, and &$tls_peerdn$& variables are set according to the
21512 particular connection.
21513
21514 If the SMTP session is not authenticated, the expansion of
21515 &%authenticated_sender%& still happens (and can cause the delivery to be
21516 deferred if it fails), but no AUTH= item is added to MAIL commands
21517 unless &%authenticated_sender_force%& is true.
21518
21519 This option allows you to use the &(smtp)& transport in LMTP mode to
21520 deliver mail to Cyrus IMAP and provide the proper local part as the
21521 &"authenticated sender"&, via a setting such as:
21522 .code
21523 authenticated_sender = $local_part
21524 .endd
21525 This removes the need for IMAP subfolders to be assigned special ACLs to
21526 allow direct delivery to those subfolders.
21527
21528 Because of expected uses such as that just described for Cyrus (when no
21529 domain is involved), there is no checking on the syntax of the provided
21530 value.
21531
21532
21533 .option authenticated_sender_force smtp boolean false
21534 If this option is set true, the &%authenticated_sender%& option's value
21535 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
21536 authenticated as a client.
21537
21538
21539 .option command_timeout smtp time 5m
21540 This sets a timeout for receiving a response to an SMTP command that has been
21541 sent out. It is also used when waiting for the initial banner line from the
21542 remote host. Its value must not be zero.
21543
21544
21545 .option connect_timeout smtp time 5m
21546 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
21547 to a remote host. A setting of zero allows the system timeout (typically
21548 several minutes) to act. To have any effect, the value of this option must be
21549 less than the system timeout. However, it has been observed that on some
21550 systems there is no system timeout, which is why the default value for this
21551 option is 5 minutes, a value recommended by RFC 1123.
21552
21553
21554 .option connection_max_messages smtp integer 500
21555 .cindex "SMTP" "passed connection"
21556 .cindex "SMTP" "multiple deliveries"
21557 .cindex "multiple SMTP deliveries"
21558 This controls the maximum number of separate message deliveries that are sent
21559 over a single TCP/IP connection. If the value is zero, there is no limit.
21560 For testing purposes, this value can be overridden by the &%-oB%& command line
21561 option.
21562
21563
21564 .option data_timeout smtp time 5m
21565 This sets a timeout for the transmission of each block in the data portion of
21566 the message. As a result, the overall timeout for a message depends on the size
21567 of the message. Its value must not be zero. See also &%final_timeout%&.
21568
21569
21570 .option delay_after_cutoff smtp boolean true
21571 This option controls what happens when all remote IP addresses for a given
21572 domain have been inaccessible for so long that they have passed their retry
21573 cutoff times.
21574
21575 In the default state, if the next retry time has not been reached for any of
21576 them, the address is bounced without trying any deliveries. In other words,
21577 Exim delays retrying an IP address after the final cutoff time until a new
21578 retry time is reached, and can therefore bounce an address without ever trying
21579 a delivery, when machines have been down for a long time. Some people are
21580 unhappy at this prospect, so...
21581
21582 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
21583 addresses are past their final cutoff time, Exim tries to deliver to those
21584 IP addresses that have not been tried since the message arrived. If there are
21585 none, of if they all fail, the address is bounced. In other words, it does not
21586 delay when a new message arrives, but immediately tries those expired IP
21587 addresses that haven't been tried since the message arrived. If there is a
21588 continuous stream of messages for the dead hosts, unsetting
21589 &%delay_after_cutoff%& means that there will be many more attempts to deliver
21590 to them.
21591
21592
21593 .option dns_qualify_single smtp boolean true
21594 If the &%hosts%& or &%fallback_hosts%& option is being used,
21595 and the &%gethostbyname%& option is false,
21596 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
21597 in chapter &<<CHAPdnslookup>>& for more details.
21598
21599
21600 .option dns_search_parents smtp boolean false
21601 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
21602 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
21603 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
21604 details.
21605
21606
21607
21608 .option fallback_hosts smtp "string list" unset
21609 .cindex "fallback" "hosts specified on transport"
21610 String expansion is not applied to this option. The argument must be a
21611 colon-separated list of host names or IP addresses, optionally also including
21612 port numbers, though the separator can be changed, as described in section
21613 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
21614 item in a &%route_list%& setting for the &(manualroute)& router, as described
21615 in section &<<SECTformatonehostitem>>&.
21616
21617 Fallback hosts can also be specified on routers, which associate them with the
21618 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
21619 &%fallback_hosts%& specified on the transport is used only if the address does
21620 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
21621 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
21622 However, &%hosts_randomize%& does apply to fallback host lists.
21623
21624 If Exim is unable to deliver to any of the hosts for a particular address, and
21625 the errors are not permanent rejections, the address is put on a separate
21626 transport queue with its host list replaced by the fallback hosts, unless the
21627 address was routed via MX records and the current host was in the original MX
21628 list. In that situation, the fallback host list is not used.
21629
21630 Once normal deliveries are complete, the fallback queue is delivered by
21631 re-running the same transports with the new host lists. If several failing
21632 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
21633 copy of the message is sent.
21634
21635 The resolution of the host names on the fallback list is controlled by the
21636 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
21637 both to cases when the host list comes with the address and when it is taken
21638 from &%hosts%&. This option provides a &"use a smart host only if delivery
21639 fails"& facility.
21640
21641
21642 .option final_timeout smtp time 10m
21643 This is the timeout that applies while waiting for the response to the final
21644 line containing just &"."& that terminates a message. Its value must not be
21645 zero.
21646
21647 .option gethostbyname smtp boolean false
21648 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
21649 being used, names are looked up using &[gethostbyname()]&
21650 (or &[getipnodebyname()]& when available)
21651 instead of using the DNS. Of course, that function may in fact use the DNS, but
21652 it may also consult other sources of information such as &_/etc/hosts_&.
21653
21654 .option gnutls_require_kx smtp string unset
21655 This option controls the key exchange mechanisms when GnuTLS is used in an Exim
21656 client. For details, see section &<<SECTreqciphgnu>>&.
21657
21658 .option gnutls_require_mac smtp string unset
21659 This option controls the MAC algorithms when GnuTLS is used in an Exim
21660 client. For details, see section &<<SECTreqciphgnu>>&.
21661
21662 .option gnutls_require_protocols smtp string unset
21663 This option controls the protocols when GnuTLS is used in an Exim
21664 client. For details, see section &<<SECTreqciphgnu>>&.
21665
21666 .option gnutls_compat_mode smtp boolean unset
21667 This option controls whether GnuTLS is used in compatibility mode in an Exim
21668 server. This reduces security slightly, but improves interworking with older
21669 implementations of TLS.
21670
21671 .option helo_data smtp string&!! "see below"
21672 .cindex "HELO" "argument, setting"
21673 .cindex "EHLO" "argument, setting"
21674 .cindex "LHLO argument setting"
21675 The value of this option is expanded after a connection to a another host has
21676 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
21677 command that starts the outgoing SMTP or LMTP session. The default value of the
21678 option is:
21679 .code
21680 $primary_hostname
21681 .endd
21682 During the expansion, the variables &$host$& and &$host_address$& are set to
21683 the identity of the remote host, and the variables &$sending_ip_address$& and
21684 &$sending_port$& are set to the local IP address and port number that are being
21685 used. These variables can be used to generate different values for different
21686 servers or different local IP addresses. For example, if you want the string
21687 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
21688 interface address, you could use this:
21689 .code
21690 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
21691   {$primary_hostname}}
21692 .endd
21693 The use of &%helo_data%& applies both to sending messages and when doing
21694 callouts.
21695
21696 .option hosts smtp "string list&!!" unset
21697 Hosts are associated with an address by a router such as &(dnslookup)&, which
21698 finds the hosts by looking up the address domain in the DNS, or by
21699 &(manualroute)&, which has lists of hosts in its configuration. However,
21700 email addresses can be passed to the &(smtp)& transport by any router, and not
21701 all of them can provide an associated list of hosts.
21702
21703 The &%hosts%& option specifies a list of hosts to be used if the address being
21704 processed does not have any hosts associated with it. The hosts specified by
21705 &%hosts%& are also used, whether or not the address has its own hosts, if
21706 &%hosts_override%& is set.
21707
21708 The string is first expanded, before being interpreted as a colon-separated
21709 list of host names or IP addresses, possibly including port numbers. The
21710 separator may be changed to something other than colon, as described in section
21711 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
21712 item in a &%route_list%& setting for the &(manualroute)& router, as described
21713 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
21714 of the &(manualroute)& router is not available here.
21715
21716 If the expansion fails, delivery is deferred. Unless the failure was caused by
21717 the inability to complete a lookup, the error is logged to the panic log as
21718 well as the main log. Host names are looked up either by searching directly for
21719 address records in the DNS or by calling &[gethostbyname()]& (or
21720 &[getipnodebyname()]& when available), depending on the setting of the
21721 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
21722 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
21723 address are used.
21724
21725 During delivery, the hosts are tried in order, subject to their retry status,
21726 unless &%hosts_randomize%& is set.
21727
21728
21729 .option hosts_avoid_esmtp smtp "host list&!!" unset
21730 .cindex "ESMTP, avoiding use of"
21731 .cindex "HELO" "forcing use of"
21732 .cindex "EHLO" "avoiding use of"
21733 .cindex "PIPELINING" "avoiding the use of"
21734 This option is for use with broken hosts that announce ESMTP facilities (for
21735 example, PIPELINING) and then fail to implement them properly. When a host
21736 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
21737 start of the SMTP session. This means that it cannot use any of the ESMTP
21738 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
21739
21740
21741 .option hosts_avoid_pipelining smtp "host list&!!" unset
21742 .cindex "PIPELINING" "avoiding the use of"
21743 Exim will not use the SMTP PIPELINING extension when delivering to any host
21744 that matches this list, even if the server host advertises PIPELINING support.
21745
21746
21747 .option hosts_avoid_tls smtp "host list&!!" unset
21748 .cindex "TLS" "avoiding for certain hosts"
21749 Exim will not try to start a TLS session when delivering to any host that
21750 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
21751
21752
21753 .option hosts_max_try smtp integer 5
21754 .cindex "host" "maximum number to try"
21755 .cindex "limit" "number of hosts tried"
21756 .cindex "limit" "number of MX tried"
21757 .cindex "MX record" "maximum tried"
21758 This option limits the number of IP addresses that are tried for any one
21759 delivery in cases where there are temporary delivery errors. Section
21760 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
21761
21762
21763 .option hosts_max_try_hardlimit smtp integer 50
21764 This is an additional check on the maximum number of IP addresses that Exim
21765 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
21766 why it exists.
21767
21768
21769
21770 .option hosts_nopass_tls smtp "host list&!!" unset
21771 .cindex "TLS" "passing connection"
21772 .cindex "multiple SMTP deliveries"
21773 .cindex "TLS" "multiple message deliveries"
21774 For any host that matches this list, a connection on which a TLS session has
21775 been started will not be passed to a new delivery process for sending another
21776 message on the same connection. See section &<<SECTmulmessam>>& for an
21777 explanation of when this might be needed.
21778
21779
21780 .option hosts_override smtp boolean false
21781 If this option is set and the &%hosts%& option is also set, any hosts that are
21782 attached to the address are ignored, and instead the hosts specified by the
21783 &%hosts%& option are always used. This option does not apply to
21784 &%fallback_hosts%&.
21785
21786
21787 .option hosts_randomize smtp boolean false
21788 .cindex "randomized host list"
21789 .cindex "host" "list of; randomized"
21790 .cindex "fallback" "randomized hosts"
21791 If this option is set, and either the list of hosts is taken from the
21792 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
21793 were not obtained from MX records (this includes fallback hosts from the
21794 router), and were not randomized by the router, the order of trying the hosts
21795 is randomized each time the transport runs. Randomizing the order of a host
21796 list can be used to do crude load sharing.
21797
21798 When &%hosts_randomize%& is true, a host list may be split into groups whose
21799 order is separately randomized. This makes it possible to set up MX-like
21800 behaviour. The boundaries between groups are indicated by an item that is just
21801 &`+`& in the host list. For example:
21802 .code
21803 hosts = host1:host2:host3:+:host4:host5
21804 .endd
21805 The order of the first three hosts and the order of the last two hosts is
21806 randomized for each use, but the first three always end up before the last two.
21807 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
21808
21809 .option hosts_require_auth smtp "host list&!!" unset
21810 .cindex "authentication" "required by client"
21811 This option provides a list of servers for which authentication must succeed
21812 before Exim will try to transfer a message. If authentication fails for
21813 servers which are not in this list, Exim tries to send unauthenticated. If
21814 authentication fails for one of these servers, delivery is deferred. This
21815 temporary error is detectable in the retry rules, so it can be turned into a
21816 hard failure if required. See also &%hosts_try_auth%&, and chapter
21817 &<<CHAPSMTPAUTH>>& for details of authentication.
21818
21819
21820 .option hosts_require_tls smtp "host list&!!" unset
21821 .cindex "TLS" "requiring for certain servers"
21822 Exim will insist on using a TLS session when delivering to any host that
21823 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
21824 &*Note*&: This option affects outgoing mail only. To insist on TLS for
21825 incoming messages, use an appropriate ACL.
21826
21827 .option hosts_try_auth smtp "host list&!!" unset
21828 .cindex "authentication" "optional in client"
21829 This option provides a list of servers to which, provided they announce
21830 authentication support, Exim will attempt to authenticate as a client when it
21831 connects. If authentication fails, Exim will try to transfer the message
21832 unauthenticated. See also &%hosts_require_auth%&, and chapter
21833 &<<CHAPSMTPAUTH>>& for details of authentication.
21834
21835 .option interface smtp "string list&!!" unset
21836 .cindex "bind IP address"
21837 .cindex "IP address" "binding"
21838 .vindex "&$host$&"
21839 .vindex "&$host_address$&"
21840 This option specifies which interface to bind to when making an outgoing SMTP
21841 call. The value is an IP address, not an interface name such as
21842 &`eth0`&. Do not confuse this with the interface address that was used when a
21843 message was received, which is in &$received_ip_address$&, formerly known as
21844 &$interface_address$&. The name was changed to minimize confusion with the
21845 outgoing interface address. There is no variable that contains an outgoing
21846 interface address because, unless it is set by this option, its value is
21847 unknown.
21848
21849 During the expansion of the &%interface%& option the variables &$host$& and
21850 &$host_address$& refer to the host to which a connection is about to be made
21851 during the expansion of the string. Forced expansion failure, or an empty
21852 string result causes the option to be ignored. Otherwise, after expansion, the
21853 string must be a list of IP addresses, colon-separated by default, but the
21854 separator can be changed in the usual way. For example:
21855 .code
21856 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
21857 .endd
21858 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
21859 connection. If none of them are the correct type, the option is ignored. If
21860 &%interface%& is not set, or is ignored, the system's IP functions choose which
21861 interface to use if the host has more than one.
21862
21863
21864 .option keepalive smtp boolean true
21865 .cindex "keepalive" "on outgoing connection"
21866 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
21867 connections. When set, it causes the kernel to probe idle connections
21868 periodically, by sending packets with &"old"& sequence numbers. The other end
21869 of the connection should send a acknowledgment if the connection is still okay
21870 or a reset if the connection has been aborted. The reason for doing this is
21871 that it has the beneficial effect of freeing up certain types of connection
21872 that can get stuck when the remote host is disconnected without tidying up the
21873 TCP/IP call properly. The keepalive mechanism takes several hours to detect
21874 unreachable hosts.
21875
21876
21877 .option lmtp_ignore_quota smtp boolean false
21878 .cindex "LMTP" "ignoring quota errors"
21879 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
21880 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
21881 has advertised support for IGNOREQUOTA in its response to the LHLO command.
21882
21883 .option max_rcpt smtp integer 100
21884 .cindex "RCPT" "maximum number of outgoing"
21885 This option limits the number of RCPT commands that are sent in a single
21886 SMTP message transaction. Each set of addresses is treated independently, and
21887 so can cause parallel connections to the same host if &%remote_max_parallel%&
21888 permits this.
21889
21890
21891 .option multi_domain smtp boolean true
21892 .vindex "&$domain$&"
21893 When this option is set, the &(smtp)& transport can handle a number of
21894 addresses containing a mixture of different domains provided they all resolve
21895 to the same list of hosts. Turning the option off restricts the transport to
21896 handling only one domain at a time. This is useful if you want to use
21897 &$domain$& in an expansion for the transport, because it is set only when there
21898 is a single domain involved in a remote delivery.
21899
21900
21901 .option port smtp string&!! "see below"
21902 .cindex "port" "sending TCP/IP"
21903 .cindex "TCP/IP" "setting outgoing port"
21904 This option specifies the TCP/IP port on the server to which Exim connects.
21905 &*Note:*& Do not confuse this with the port that was used when a message was
21906 received, which is in &$received_port$&, formerly known as &$interface_port$&.
21907 The name was changed to minimize confusion with the outgoing port. There is no
21908 variable that contains an outgoing port.
21909
21910 If the value of this option begins with a digit it is taken as a port number;
21911 otherwise it is looked up using &[getservbyname()]&. The default value is
21912 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
21913 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
21914 is deferred.
21915
21916
21917
21918 .option protocol smtp string smtp
21919 .cindex "LMTP" "over TCP/IP"
21920 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
21921 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
21922 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
21923 deliveries into closed message stores. Exim also has support for running LMTP
21924 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
21925
21926
21927 .option retry_include_ip_address smtp boolean true
21928 Exim normally includes both the host name and the IP address in the key it
21929 constructs for indexing retry data after a temporary delivery failure. This
21930 means that when one of several IP addresses for a host is failing, it gets
21931 tried periodically (controlled by the retry rules), but use of the other IP
21932 addresses is not affected.
21933
21934 However, in some dialup environments hosts are assigned a different IP address
21935 each time they connect. In this situation the use of the IP address as part of
21936 the retry key leads to undesirable behaviour. Setting this option false causes
21937 Exim to use only the host name. This should normally be done on a separate
21938 instance of the &(smtp)& transport, set up specially to handle the dialup
21939 hosts.
21940
21941
21942 .option serialize_hosts smtp "host list&!!" unset
21943 .cindex "serializing connections"
21944 .cindex "host" "serializing connections"
21945 Because Exim operates in a distributed manner, if several messages for the same
21946 host arrive at around the same time, more than one simultaneous connection to
21947 the remote host can occur. This is not usually a problem except when there is a
21948 slow link between the hosts. In that situation it may be helpful to restrict
21949 Exim to one connection at a time. This can be done by setting
21950 &%serialize_hosts%& to match the relevant hosts.
21951
21952 .cindex "hints database" "serializing deliveries to a host"
21953 Exim implements serialization by means of a hints database in which a record is
21954 written whenever a process connects to one of the restricted hosts. The record
21955 is deleted when the connection is completed. Obviously there is scope for
21956 records to get left lying around if there is a system or program crash. To
21957 guard against this, Exim ignores any records that are more than six hours old.
21958
21959 If you set up this kind of serialization, you should also arrange to delete the
21960 relevant hints database whenever your system reboots. The names of the files
21961 start with &_misc_& and they are kept in the &_spool/db_& directory. There
21962 may be one or two files, depending on the type of DBM in use. The same files
21963 are used for ETRN serialization.
21964
21965
21966 .option size_addition smtp integer 1024
21967 .cindex "SMTP" "SIZE"
21968 .cindex "message" "size issue for transport filter"
21969 .cindex "size" "of message"
21970 .cindex "transport" "filter"
21971 .cindex "filter" "transport filter"
21972 If a remote SMTP server indicates that it supports the SIZE option of the
21973 MAIL command, Exim uses this to pass over the message size at the start of
21974 an SMTP transaction. It adds the value of &%size_addition%& to the value it
21975 sends, to allow for headers and other text that may be added during delivery by
21976 configuration options or in a transport filter. It may be necessary to increase
21977 this if a lot of text is added to messages.
21978
21979 Alternatively, if the value of &%size_addition%& is set negative, it disables
21980 the use of the SIZE option altogether.
21981
21982
21983 .option tls_certificate smtp string&!! unset
21984 .cindex "TLS" "client certificate, location of"
21985 .cindex "certificate" "client, location of"
21986 .vindex "&$host$&"
21987 .vindex "&$host_address$&"
21988 The value of this option must be the absolute path to a file which contains the
21989 client's certificate, for possible use when sending a message over an encrypted
21990 connection. The values of &$host$& and &$host_address$& are set to the name and
21991 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
21992 details of TLS.
21993
21994 &*Note*&: This option must be set if you want Exim to be able to use a TLS
21995 certificate when sending messages as a client. The global option of the same
21996 name specifies the certificate for Exim as a server; it is not automatically
21997 assumed that the same certificate should be used when Exim is operating as a
21998 client.
21999
22000
22001 .option tls_crl smtp string&!! unset
22002 .cindex "TLS" "client certificate revocation list"
22003 .cindex "certificate" "revocation list for client"
22004 This option specifies a certificate revocation list. The expanded value must
22005 be the name of a file that contains a CRL in PEM format.
22006
22007
22008 .option tls_privatekey smtp string&!! unset
22009 .cindex "TLS" "client private key, location of"
22010 .vindex "&$host$&"
22011 .vindex "&$host_address$&"
22012 The value of this option must be the absolute path to a file which contains the
22013 client's private key. This is used when sending a message over an encrypted
22014 connection using a client certificate. The values of &$host$& and
22015 &$host_address$& are set to the name and address of the server during the
22016 expansion. If this option is unset, or the expansion is forced to fail, or the
22017 result is an empty string, the private key is assumed to be in the same file as
22018 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
22019
22020
22021 .option tls_require_ciphers smtp string&!! unset
22022 .cindex "TLS" "requiring specific ciphers"
22023 .cindex "cipher" "requiring specific"
22024 .vindex "&$host$&"
22025 .vindex "&$host_address$&"
22026 The value of this option must be a list of permitted cipher suites, for use
22027 when setting up an outgoing encrypted connection. (There is a global option of
22028 the same name for controlling incoming connections.) The values of &$host$& and
22029 &$host_address$& are set to the name and address of the server during the
22030 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
22031 is used in different ways by OpenSSL and GnuTLS (see sections
22032 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
22033 ciphers is a preference order.
22034
22035
22036
22037 .option tls_tempfail_tryclear smtp boolean true
22038 .cindex "4&'xx'& responses" "to STARTTLS"
22039 When the server host is not in &%hosts_require_tls%&, and there is a problem in
22040 setting up a TLS session, this option determines whether or not Exim should try
22041 to deliver the message unencrypted. If it is set false, delivery to the
22042 current host is deferred; if there are other hosts, they are tried. If this
22043 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
22044 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
22045 TLS negotiation fails, Exim closes the current connection (because it is in an
22046 unknown state), opens a new one to the same host, and then tries the delivery
22047 in clear.
22048
22049
22050 .option tls_verify_certificates smtp string&!! unset
22051 .cindex "TLS" "server certificate verification"
22052 .cindex "certificate" "verification of server"
22053 .vindex "&$host$&"
22054 .vindex "&$host_address$&"
22055 The value of this option must be the absolute path to a file containing
22056 permitted server certificates, for use when setting up an encrypted connection.
22057 Alternatively, if you are using OpenSSL, you can set
22058 &%tls_verify_certificates%& to the name of a directory containing certificate
22059 files. This does not work with GnuTLS; the option must be set to the name of a
22060 single file if you are using GnuTLS. The values of &$host$& and
22061 &$host_address$& are set to the name and address of the server during the
22062 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
22063
22064
22065
22066
22067 .section "How the limits for the number of hosts to try are used" &&&
22068          "SECTvalhosmax"
22069 .cindex "host" "maximum number to try"
22070 .cindex "limit" "hosts; maximum number tried"
22071 There are two options that are concerned with the number of hosts that are
22072 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
22073 &%hosts_max_try_hardlimit%&.
22074
22075
22076 The &%hosts_max_try%& option limits the number of hosts that are tried
22077 for a single delivery. However, despite the term &"host"& in its name, the
22078 option actually applies to each IP address independently. In other words, a
22079 multihomed host is treated as several independent hosts, just as it is for
22080 retrying.
22081
22082 Many of the larger ISPs have multiple MX records which often point to
22083 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
22084 created as a result of routing one of these domains.
22085
22086 Trying every single IP address on such a long list does not seem sensible; if
22087 several at the top of the list fail, it is reasonable to assume there is some
22088 problem that is likely to affect all of them. Roughly speaking, the value of
22089 &%hosts_max_try%& is the maximum number that are tried before deferring the
22090 delivery. However, the logic cannot be quite that simple.
22091
22092 Firstly, IP addresses that are skipped because their retry times have not
22093 arrived do not count, and in addition, addresses that are past their retry
22094 limits are also not counted, even when they are tried. This means that when
22095 some IP addresses are past their retry limits, more than the value of
22096 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
22097 that all IP addresses are considered before timing out an email address (but
22098 see below for an exception).
22099
22100 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
22101 list to see if there is a subsequent host with a different (higher valued) MX.
22102 If there is, that host is considered next, and the current IP address is used
22103 but not counted. This behaviour helps in the case of a domain with a retry rule
22104 that hardly ever delays any hosts, as is now explained:
22105
22106 Consider the case of a long list of hosts with one MX value, and a few with a
22107 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
22108 hosts at the top of the list are tried at first. With the default retry rule,
22109 which specifies increasing retry times, the higher MX hosts are eventually
22110 tried when those at the top of the list are skipped because they have not
22111 reached their retry times.
22112
22113 However, it is common practice to put a fixed short retry time on domains for
22114 large ISPs, on the grounds that their servers are rarely down for very long.
22115 Unfortunately, these are exactly the domains that tend to resolve to long lists
22116 of hosts. The short retry time means that the lowest MX hosts are tried every
22117 time. The attempts may be in a different order because of random sorting, but
22118 without the special MX check, the higher MX hosts would never be tried until
22119 all the lower MX hosts had timed out (which might be several days), because
22120 there are always some lower MX hosts that have reached their retry times. With
22121 the special check, Exim considers at least one IP address from each MX value at
22122 every delivery attempt, even if the &%hosts_max_try%& limit has already been
22123 reached.
22124
22125 The above logic means that &%hosts_max_try%& is not a hard limit, and in
22126 particular, Exim normally eventually tries all the IP addresses before timing
22127 out an email address. When &%hosts_max_try%& was implemented, this seemed a
22128 reasonable thing to do. Recently, however, some lunatic DNS configurations have
22129 been set up with hundreds of IP addresses for some domains. It can
22130 take a very long time indeed for an address to time out in these cases.
22131
22132 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
22133 Exim never tries more than this number of IP addresses; if it hits this limit
22134 and they are all timed out, the email address is bounced, even though not all
22135 possible IP addresses have been tried.
22136 .ecindex IIDsmttra1
22137 .ecindex IIDsmttra2
22138
22139
22140
22141
22142
22143 . ////////////////////////////////////////////////////////////////////////////
22144 . ////////////////////////////////////////////////////////////////////////////
22145
22146 .chapter "Address rewriting" "CHAPrewrite"
22147 .scindex IIDaddrew "rewriting" "addresses"
22148 There are some circumstances in which Exim automatically rewrites domains in
22149 addresses. The two most common are when an address is given without a domain
22150 (referred to as an &"unqualified address"&) or when an address contains an
22151 abbreviated domain that is expanded by DNS lookup.
22152
22153 Unqualified envelope addresses are accepted only for locally submitted
22154 messages, or for messages that are received from hosts matching
22155 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
22156 appropriate. Unqualified addresses in header lines are qualified if they are in
22157 locally submitted messages, or messages from hosts that are permitted to send
22158 unqualified envelope addresses. Otherwise, unqualified addresses in header
22159 lines are neither qualified nor rewritten.
22160
22161 One situation in which Exim does &'not'& automatically rewrite a domain is
22162 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
22163 such a domain should be rewritten using the &"canonical"& name, and some MTAs
22164 do this. The new RFCs do not contain this suggestion.
22165
22166
22167 .section "Explicitly configured address rewriting" "SECID147"
22168 This chapter describes the rewriting rules that can be used in the
22169 main rewrite section of the configuration file, and also in the generic
22170 &%headers_rewrite%& option that can be set on any transport.
22171
22172 Some people believe that configured address rewriting is a Mortal Sin.
22173 Others believe that life is not possible without it. Exim provides the
22174 facility; you do not have to use it.
22175
22176 The main rewriting rules that appear in the &"rewrite"& section of the
22177 configuration file are applied to addresses in incoming messages, both envelope
22178 addresses and addresses in header lines. Each rule specifies the types of
22179 address to which it applies.
22180
22181 Whether or not addresses in header lines are rewritten depends on the origin of
22182 the headers and the type of rewriting. Global rewriting, that is, rewriting
22183 rules from the rewrite section of the configuration file, is applied only to
22184 those headers that were received with the message. Header lines that are added
22185 by ACLs or by a system filter or by individual routers or transports (which
22186 are specific to individual recipient addresses) are not rewritten by the global
22187 rules.
22188
22189 Rewriting at transport time, by means of the &%headers_rewrite%& option,
22190 applies all headers except those added by routers and transports. That is, as
22191 well as the headers that were received with the message, it also applies to
22192 headers that were added by an ACL or a system filter.
22193
22194
22195 In general, rewriting addresses from your own system or domain has some
22196 legitimacy. Rewriting other addresses should be done only with great care and
22197 in special circumstances. The author of Exim believes that rewriting should be
22198 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
22199 Although it can sometimes be used as a routing tool, this is very strongly
22200 discouraged.
22201
22202 There are two commonly encountered circumstances where rewriting is used, as
22203 illustrated by these examples:
22204
22205 .ilist
22206 The company whose domain is &'hitch.fict.example'& has a number of hosts that
22207 exchange mail with each other behind a firewall, but there is only a single
22208 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
22209 &'hitch.fict.example'& when sending mail off-site.
22210 .next
22211 A host rewrites the local parts of its own users so that, for example,
22212 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
22213 .endlist
22214
22215
22216
22217 .section "When does rewriting happen?" "SECID148"
22218 .cindex "rewriting" "timing of"
22219 .cindex "&ACL;" "rewriting addresses in"
22220 Configured address rewriting can take place at several different stages of a
22221 message's processing.
22222
22223 .vindex "&$sender_address$&"
22224 At the start of an ACL for MAIL, the sender address may have been rewritten
22225 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
22226 ordinary rewrite rules have yet been applied. If, however, the sender address
22227 is verified in the ACL, it is rewritten before verification, and remains
22228 rewritten thereafter. The subsequent value of &$sender_address$& is the
22229 rewritten address. This also applies if sender verification happens in a
22230 RCPT ACL. Otherwise, when the sender address is not verified, it is
22231 rewritten as soon as a message's header lines have been received.
22232
22233 .vindex "&$domain$&"
22234 .vindex "&$local_part$&"
22235 Similarly, at the start of an ACL for RCPT, the current recipient's address
22236 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
22237 rewrite rules have yet been applied to it. However, the behaviour is different
22238 from the sender address when a recipient is verified. The address is rewritten
22239 for the verification, but the rewriting is not remembered at this stage. The
22240 value of &$local_part$& and &$domain$& after verification are always the same
22241 as they were before (that is, they contain the unrewritten &-- except for
22242 SMTP-time rewriting &-- address).
22243
22244 As soon as a message's header lines have been received, all the envelope
22245 recipient addresses are permanently rewritten, and rewriting is also applied to
22246 the addresses in the header lines (if configured). This happens before adding
22247 any header lines that were specified in MAIL or RCPT ACLs, and
22248 .cindex "&[local_scan()]& function" "address rewriting; timing of"
22249 before the DATA ACL and &[local_scan()]& functions are run.
22250
22251 When an address is being routed, either for delivery or for verification,
22252 rewriting is applied immediately to child addresses that are generated by
22253 redirection, unless &%no_rewrite%& is set on the router.
22254
22255 .cindex "envelope sender" "rewriting at transport time"
22256 .cindex "rewriting" "at transport time"
22257 .cindex "header lines" "rewriting at transport time"
22258 At transport time, additional rewriting of addresses in header lines can be
22259 specified by setting the generic &%headers_rewrite%& option on a transport.
22260 This option contains rules that are identical in form to those in the rewrite
22261 section of the configuration file. They are applied to the original message
22262 header lines and any that were added by ACLs or a system filter. They are not
22263 applied to header lines that are added by routers or the transport.
22264
22265 The outgoing envelope sender can be rewritten by means of the &%return_path%&
22266 transport option. However, it is not possible to rewrite envelope recipients at
22267 transport time.
22268
22269
22270
22271
22272 .section "Testing the rewriting rules that apply on input" "SECID149"
22273 .cindex "rewriting" "testing"
22274 .cindex "testing" "rewriting"
22275 Exim's input rewriting configuration appears in a part of the run time
22276 configuration file headed by &"begin rewrite"&. It can be tested by the
22277 &%-brw%& command line option. This takes an address (which can be a full RFC
22278 2822 address) as its argument. The output is a list of how the address would be
22279 transformed by the rewriting rules for each of the different places it might
22280 appear in an incoming message, that is, for each different header and for the
22281 envelope sender and recipient fields. For example,
22282 .code
22283 exim -brw ph10@exim.workshop.example
22284 .endd
22285 might produce the output
22286 .code
22287 sender: Philip.Hazel@exim.workshop.example
22288 from: Philip.Hazel@exim.workshop.example
22289 to: ph10@exim.workshop.example
22290 cc: ph10@exim.workshop.example
22291 bcc: ph10@exim.workshop.example
22292 reply-to: Philip.Hazel@exim.workshop.example
22293 env-from: Philip.Hazel@exim.workshop.example
22294 env-to: ph10@exim.workshop.example
22295 .endd
22296 which shows that rewriting has been set up for that address when used in any of
22297 the source fields, but not when it appears as a recipient address. At the
22298 present time, there is no equivalent way of testing rewriting rules that are
22299 set for a particular transport.
22300
22301
22302 .section "Rewriting rules" "SECID150"
22303 .cindex "rewriting" "rules"
22304 The rewrite section of the configuration file consists of lines of rewriting
22305 rules in the form
22306 .display
22307 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
22308 .endd
22309 Rewriting rules that are specified for the &%headers_rewrite%& generic
22310 transport option are given as a colon-separated list. Each item in the list
22311 takes the same form as a line in the main rewriting configuration (except that
22312 any colons must be doubled, of course).
22313
22314 The formats of source patterns and replacement strings are described below.
22315 Each is terminated by white space, unless enclosed in double quotes, in which
22316 case normal quoting conventions apply inside the quotes. The flags are single
22317 characters which may appear in any order. Spaces and tabs between them are
22318 ignored.
22319
22320 For each address that could potentially be rewritten, the rules are scanned in
22321 order, and replacements for the address from earlier rules can themselves be
22322 replaced by later rules (but see the &"q"& and &"R"& flags).
22323
22324 The order in which addresses are rewritten is undefined, may change between
22325 releases, and must not be relied on, with one exception: when a message is
22326 received, the envelope sender is always rewritten first, before any header
22327 lines are rewritten. For example, the replacement string for a rewrite of an
22328 address in &'To:'& must not assume that the message's address in &'From:'& has
22329 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
22330 that the envelope sender has already been rewritten.
22331
22332 .vindex "&$domain$&"
22333 .vindex "&$local_part$&"
22334 The variables &$local_part$& and &$domain$& can be used in the replacement
22335 string to refer to the address that is being rewritten. Note that lookup-driven
22336 rewriting can be done by a rule of the form
22337 .code
22338 *@*   ${lookup ...
22339 .endd
22340 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
22341 refer to the address that is being rewritten.
22342
22343
22344 .section "Rewriting patterns" "SECID151"
22345 .cindex "rewriting" "patterns"
22346 .cindex "address list" "in a rewriting pattern"
22347 The source pattern in a rewriting rule is any item which may appear in an
22348 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
22349 single-item address list, which means that it is expanded before being tested
22350 against the address. As always, if you use a regular expression as a pattern,
22351 you must take care to escape dollar and backslash characters, or use the &`\N`&
22352 facility to suppress string expansion within the regular expression.
22353
22354 Domains in patterns should be given in lower case. Local parts in patterns are
22355 case-sensitive. If you want to do case-insensitive matching of local parts, you
22356 can use a regular expression that starts with &`^(?i)`&.
22357
22358 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
22359 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
22360 depending on the type of match which occurred. These can be used in the
22361 replacement string to insert portions of the incoming address. &$0$& always
22362 refers to the complete incoming address. When a regular expression is used, the
22363 numerical variables are set from its capturing subexpressions. For other types
22364 of pattern they are set as follows:
22365
22366 .ilist
22367 If a local part or domain starts with an asterisk, the numerical variables
22368 refer to the character strings matched by asterisks, with &$1$& associated with
22369 the first asterisk, and &$2$& with the second, if present. For example, if the
22370 pattern
22371 .code
22372 *queen@*.fict.example
22373 .endd
22374 is matched against the address &'hearts-queen@wonderland.fict.example'& then
22375 .code
22376 $0 = hearts-queen@wonderland.fict.example
22377 $1 = hearts-
22378 $2 = wonderland
22379 .endd
22380 Note that if the local part does not start with an asterisk, but the domain
22381 does, it is &$1$& that contains the wild part of the domain.
22382
22383 .next
22384 If the domain part of the pattern is a partial lookup, the wild and fixed parts
22385 of the domain are placed in the next available numerical variables. Suppose,
22386 for example, that the address &'foo@bar.baz.example'& is processed by a
22387 rewriting rule of the form
22388 .display
22389 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
22390 .endd
22391 and the key in the file that matches the domain is &`*.baz.example`&. Then
22392 .code
22393 $1 = foo
22394 $2 = bar
22395 $3 = baz.example
22396 .endd
22397 If the address &'foo@baz.example'& is looked up, this matches the same
22398 wildcard file entry, and in this case &$2$& is set to the empty string, but
22399 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
22400 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
22401 whole domain. For non-partial domain lookups, no numerical variables are set.
22402 .endlist
22403
22404
22405 .section "Rewriting replacements" "SECID152"
22406 .cindex "rewriting" "replacements"
22407 If the replacement string for a rule is a single asterisk, addresses that
22408 match the pattern and the flags are &'not'& rewritten, and no subsequent
22409 rewriting rules are scanned. For example,
22410 .code
22411 hatta@lookingglass.fict.example  *  f
22412 .endd
22413 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
22414 &'From:'& headers.
22415
22416 .vindex "&$domain$&"
22417 .vindex "&$local_part$&"
22418 If the replacement string is not a single asterisk, it is expanded, and must
22419 yield a fully qualified address. Within the expansion, the variables
22420 &$local_part$& and &$domain$& refer to the address that is being rewritten.
22421 Any letters they contain retain their original case &-- they are not lower
22422 cased. The numerical variables are set up according to the type of pattern that
22423 matched the address, as described above. If the expansion is forced to fail by
22424 the presence of &"fail"& in a conditional or lookup item, rewriting by the
22425 current rule is abandoned, but subsequent rules may take effect. Any other
22426 expansion failure causes the entire rewriting operation to be abandoned, and an
22427 entry written to the panic log.
22428
22429
22430
22431 .section "Rewriting flags" "SECID153"
22432 There are three different kinds of flag that may appear on rewriting rules:
22433
22434 .ilist
22435 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
22436 c, f, h, r, s, t.
22437 .next
22438 A flag that specifies rewriting at SMTP time: S.
22439 .next
22440 Flags that control the rewriting process: Q, q, R, w.
22441 .endlist
22442
22443 For rules that are part of the &%headers_rewrite%& generic transport option,
22444 E, F, T, and S are not permitted.
22445
22446
22447
22448 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
22449          "SECID154"
22450 .cindex "rewriting" "flags"
22451 If none of the following flag letters, nor the &"S"& flag (see section
22452 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
22453 and to both the sender and recipient fields of the envelope, whereas a
22454 transport-time rewriting rule just applies to all headers. Otherwise, the
22455 rewriting rule is skipped unless the relevant addresses are being processed.
22456 .display
22457 &`E`&       rewrite all envelope fields
22458 &`F`&       rewrite the envelope From field
22459 &`T`&       rewrite the envelope To field
22460 &`b`&       rewrite the &'Bcc:'& header
22461 &`c`&       rewrite the &'Cc:'& header
22462 &`f`&       rewrite the &'From:'& header
22463 &`h`&       rewrite all headers
22464 &`r`&       rewrite the &'Reply-To:'& header
22465 &`s`&       rewrite the &'Sender:'& header
22466 &`t`&       rewrite the &'To:'& header
22467 .endd
22468 "All headers" means all of the headers listed above that can be selected
22469 individually, plus their &'Resent-'& versions. It does not include
22470 other headers such as &'Subject:'& etc.
22471
22472 You should be particularly careful about rewriting &'Sender:'& headers, and
22473 restrict this to special known cases in your own domains.
22474
22475
22476 .section "The SMTP-time rewriting flag" "SECTrewriteS"
22477 .cindex "SMTP" "rewriting malformed addresses"
22478 .cindex "RCPT" "rewriting argument of"
22479 .cindex "MAIL" "rewriting argument of"
22480 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
22481 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
22482 before any other processing; even before syntax checking. The pattern is
22483 required to be a regular expression, and it is matched against the whole of the
22484 data for the command, including any surrounding angle brackets.
22485
22486 .vindex "&$domain$&"
22487 .vindex "&$local_part$&"
22488 This form of rewrite rule allows for the handling of addresses that are not
22489 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
22490 input). Because the input is not required to be a syntactically valid address,
22491 the variables &$local_part$& and &$domain$& are not available during the
22492 expansion of the replacement string. The result of rewriting replaces the
22493 original address in the MAIL or RCPT command.
22494
22495
22496 .section "Flags controlling the rewriting process" "SECID155"
22497 There are four flags which control the way the rewriting process works. These
22498 take effect only when a rule is invoked, that is, when the address is of the
22499 correct type (matches the flags) and matches the pattern:
22500
22501 .ilist
22502 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
22503 unqualified local part. It is qualified with &%qualify_recipient%&. In the
22504 absence of &"Q"& the rewritten address must always include a domain.
22505 .next
22506 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
22507 even if no rewriting actually takes place because of a &"fail"& in the
22508 expansion. The &"q"& flag is not effective if the address is of the wrong type
22509 (does not match the flags) or does not match the pattern.
22510 .next
22511 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
22512 address, up to ten times. It can be combined with the &"q"& flag, to stop
22513 rewriting once it fails to match (after at least one successful rewrite).
22514 .next
22515 .cindex "rewriting" "whole addresses"
22516 When an address in a header is rewritten, the rewriting normally applies only
22517 to the working part of the address, with any comments and RFC 2822 &"phrase"&
22518 left unchanged. For example, rewriting might change
22519 .code
22520 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
22521 .endd
22522 into
22523 .code
22524 From: Ford Prefect <prefectf@hitch.fict.example>
22525 .endd
22526 .cindex "RFC 2047"
22527 Sometimes there is a need to replace the whole address item, and this can be
22528 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
22529 causes an address in a header line to be rewritten, the entire address is
22530 replaced, not just the working part. The replacement must be a complete RFC
22531 2822 address, including the angle brackets if necessary. If text outside angle
22532 brackets contains a character whose value is greater than 126 or less than 32
22533 (except for tab), the text is encoded according to RFC 2047. The character set
22534 is taken from &%headers_charset%&, which defaults to ISO-8859-1.
22535
22536 When the &"w"& flag is set on a rule that causes an envelope address to be
22537 rewritten, all but the working part of the replacement address is discarded.
22538 .endlist
22539
22540
22541 .section "Rewriting examples" "SECID156"
22542 Here is an example of the two common rewriting paradigms:
22543 .code
22544 *@*.hitch.fict.example  $1@hitch.fict.example
22545 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
22546                      {$value}fail}@hitch.fict.example bctfrF
22547 .endd
22548 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
22549 the string expansion to fail if the lookup does not succeed. In this context it
22550 has the effect of leaving the original address unchanged, but Exim goes on to
22551 consider subsequent rewriting rules, if any, because the &"q"& flag is not
22552 present in that rule. An alternative to &"fail"& would be to supply &$1$&
22553 explicitly, which would cause the rewritten address to be the same as before,
22554 at the cost of a small bit of processing. Not supplying either of these is an
22555 error, since the rewritten address would then contain no local part.
22556
22557 The first example above replaces the domain with a superior, more general
22558 domain. This may not be desirable for certain local parts. If the rule
22559 .code
22560 root@*.hitch.fict.example  *
22561 .endd
22562 were inserted before the first rule, rewriting would be suppressed for the
22563 local part &'root'& at any domain ending in &'hitch.fict.example'&.
22564
22565 Rewriting can be made conditional on a number of tests, by making use of
22566 &${if$& in the expansion item. For example, to apply a rewriting rule only to
22567 messages that originate outside the local host:
22568 .code
22569 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
22570                          {$1@hitch.fict.example}fail}"
22571 .endd
22572 The replacement string is quoted in this example because it contains white
22573 space.
22574
22575 .cindex "rewriting" "bang paths"
22576 .cindex "bang paths" "rewriting"
22577 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
22578 an address it treats it as an unqualified local part which it qualifies with
22579 the local qualification domain (if the source of the message is local or if the
22580 remote host is permitted to send unqualified addresses). Rewriting can
22581 sometimes be used to handle simple bang paths with a fixed number of
22582 components. For example, the rule
22583 .code
22584 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
22585 .endd
22586 rewrites a two-component bang path &'host.name!user'& as the domain address
22587 &'user@host.name'&. However, there is a security implication in using this as
22588 a global rewriting rule for envelope addresses. It can provide a backdoor
22589 method for using your system as a relay, because the incoming addresses appear
22590 to be local. If the bang path addresses are received via SMTP, it is safer to
22591 use the &"S"& flag to rewrite them as they are received, so that relay checking
22592 can be done on the rewritten addresses.
22593 .ecindex IIDaddrew
22594
22595
22596
22597
22598
22599 . ////////////////////////////////////////////////////////////////////////////
22600 . ////////////////////////////////////////////////////////////////////////////
22601
22602 .chapter "Retry configuration" "CHAPretry"
22603 .scindex IIDretconf1 "retry" "configuration, description of"
22604 .scindex IIDregconf2 "configuration file" "retry section"
22605 The &"retry"& section of the runtime configuration file contains a list of
22606 retry rules that control how often Exim tries to deliver messages that cannot
22607 be delivered at the first attempt. If there are no retry rules (the section is
22608 empty or not present), there are no retries. In this situation, temporary
22609 errors are treated as permanent. The default configuration contains a single,
22610 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
22611 line option can be used to test which retry rule will be used for a given
22612 address, domain and error.
22613
22614 The most common cause of retries is temporary failure to deliver to a remote
22615 host because the host is down, or inaccessible because of a network problem.
22616 Exim's retry processing in this case is applied on a per-host (strictly, per IP
22617 address) basis, not on a per-message basis. Thus, if one message has recently
22618 been delayed, delivery of a new message to the same host is not immediately
22619 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
22620 log selector is set, the message
22621 .cindex "retry" "time not reached"
22622 &"retry time not reached"& is written to the main log whenever a delivery is
22623 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
22624 the handling of errors during remote deliveries.
22625
22626 Retry processing applies to routing as well as to delivering, except as covered
22627 in the next paragraph. The retry rules do not distinguish between these
22628 actions. It is not possible, for example, to specify different behaviour for
22629 failures to route the domain &'snark.fict.example'& and failures to deliver to
22630 the host &'snark.fict.example'&. I didn't think anyone would ever need this
22631 added complication, so did not implement it. However, although they share the
22632 same retry rule, the actual retry times for routing and transporting a given
22633 domain are maintained independently.
22634
22635 When a delivery is not part of a queue run (typically an immediate delivery on
22636 receipt of a message), the routers are always run, and local deliveries are
22637 always attempted, even if retry times are set for them. This makes for better
22638 behaviour if one particular message is causing problems (for example, causing
22639 quota overflow, or provoking an error in a filter file). If such a delivery
22640 suffers a temporary failure, the retry data is updated as normal, and
22641 subsequent delivery attempts from queue runs occur only when the retry time for
22642 the local address is reached.
22643
22644 .section "Changing retry rules" "SECID157"
22645 If you change the retry rules in your configuration, you should consider
22646 whether or not to delete the retry data that is stored in Exim's spool area in
22647 files with names like &_db/retry_&. Deleting any of Exim's hints files is
22648 always safe; that is why they are called &"hints"&.
22649
22650 The hints retry data contains suggested retry times based on the previous
22651 rules. In the case of a long-running problem with a remote host, it might
22652 record the fact that the host has timed out. If your new rules increase the
22653 timeout time for such a host, you should definitely remove the old retry data
22654 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
22655 messages that it should now be retaining.
22656
22657
22658
22659 .section "Format of retry rules" "SECID158"
22660 .cindex "retry" "rules"
22661 Each retry rule occupies one line and consists of three or four parts,
22662 separated by white space: a pattern, an error name, an optional list of sender
22663 addresses, and a list of retry parameters. The pattern and sender lists must be
22664 enclosed in double quotes if they contain white space. The rules are searched
22665 in order until one is found where the pattern, error name, and sender list (if
22666 present) match the failing host or address, the error that occurred, and the
22667 message's sender, respectively.
22668
22669
22670 The pattern is any single item that may appear in an address list (see section
22671 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
22672 which means that it is expanded before being tested against the address that
22673 has been delayed. A negated address list item is permitted. Address
22674 list processing treats a plain domain name as if it were preceded by &"*@"&,
22675 which makes it possible for many retry rules to start with just a domain. For
22676 example,
22677 .code
22678 lookingglass.fict.example        *  F,24h,30m;
22679 .endd
22680 provides a rule for any address in the &'lookingglass.fict.example'& domain,
22681 whereas
22682 .code
22683 alice@lookingglass.fict.example  *  F,24h,30m;
22684 .endd
22685 applies only to temporary failures involving the local part &%alice%&.
22686 In practice, almost all rules start with a domain name pattern without a local
22687 part.
22688
22689 .cindex "regular expressions" "in retry rules"
22690 &*Warning*&: If you use a regular expression in a routing rule pattern, it
22691 must match a complete address, not just a domain, because that is how regular
22692 expressions work in address lists.
22693 .display
22694 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
22695 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
22696 .endd
22697
22698
22699 .section "Choosing which retry rule to use for address errors" "SECID159"
22700 When Exim is looking for a retry rule after a routing attempt has failed (for
22701 example, after a DNS timeout), each line in the retry configuration is tested
22702 against the complete address only if &%retry_use_local_part%& is set for the
22703 router. Otherwise, only the domain is used, except when matching against a
22704 regular expression, when the local part of the address is replaced with &"*"&.
22705 A domain on its own can match a domain pattern, or a pattern that starts with
22706 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
22707 &%check_local_user%& is true, and false for other routers.
22708
22709 Similarly, when Exim is looking for a retry rule after a local delivery has
22710 failed (for example, after a mailbox full error), each line in the retry
22711 configuration is tested against the complete address only if
22712 &%retry_use_local_part%& is set for the transport (it defaults true for all
22713 local transports).
22714
22715 .cindex "4&'xx'& responses" "retry rules for"
22716 However, when Exim is looking for a retry rule after a remote delivery attempt
22717 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
22718 whole address is always used as the key when searching the retry rules. The
22719 rule that is found is used to create a retry time for the combination of the
22720 failing address and the message's sender. It is the combination of sender and
22721 recipient that is delayed in subsequent queue runs until its retry time is
22722 reached. You can delay the recipient without regard to the sender by setting
22723 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
22724 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
22725 commands.
22726
22727
22728
22729 .section "Choosing which retry rule to use for host and message errors" &&&
22730          "SECID160"
22731 For a temporary error that is not related to an individual address (for
22732 example, a connection timeout), each line in the retry configuration is checked
22733 twice. First, the name of the remote host is used as a domain name (preceded by
22734 &"*@"& when matching a regular expression). If this does not match the line,
22735 the domain from the email address is tried in a similar fashion. For example,
22736 suppose the MX records for &'a.b.c.example'& are
22737 .code
22738 a.b.c.example  MX  5  x.y.z.example
22739                MX  6  p.q.r.example
22740                MX  7  m.n.o.example
22741 .endd
22742 and the retry rules are
22743 .code
22744 p.q.r.example    *      F,24h,30m;
22745 a.b.c.example    *      F,4d,45m;
22746 .endd
22747 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
22748 first rule matches neither the host nor the domain, so Exim looks at the second
22749 rule. This does not match the host, but it does match the domain, so it is used
22750 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
22751 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
22752 first retry rule is used, because it matches the host.
22753
22754 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
22755 first rule to determine retry times, but for all the other hosts for the domain
22756 &'a.b.c.example'&, the second rule is used. The second rule is also used if
22757 routing to &'a.b.c.example'& suffers a temporary failure.
22758
22759 &*Note*&: The host name is used when matching the patterns, not its IP address.
22760 However, if a message is routed directly to an IP address without the use of a
22761 host name, for example, if a &(manualroute)& router contains a setting such as:
22762 .code
22763 route_list = *.a.example  192.168.34.23
22764 .endd
22765 then the &"host name"& that is used when searching for a retry rule is the
22766 textual form of the IP address.
22767
22768 .section "Retry rules for specific errors" "SECID161"
22769 .cindex "retry" "specific errors; specifying"
22770 The second field in a retry rule is the name of a particular error, or an
22771 asterisk, which matches any error. The errors that can be tested for are:
22772
22773 .vlist
22774 .vitem &%auth_failed%&
22775 Authentication failed when trying to send to a host in the
22776 &%hosts_require_auth%& list in an &(smtp)& transport.
22777
22778 .vitem &%data_4xx%&
22779 A 4&'xx'& error was received for an outgoing DATA command, either immediately
22780 after the command, or after sending the message's data.
22781
22782 .vitem &%mail_4xx%&
22783 A 4&'xx'& error was received for an outgoing MAIL command.
22784
22785 .vitem &%rcpt_4xx%&
22786 A 4&'xx'& error was received for an outgoing RCPT command.
22787 .endlist
22788
22789 For the three 4&'xx'& errors, either the first or both of the x's can be given
22790 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
22791 recognize 452 errors given to RCPT commands for addresses in a certain domain,
22792 and have retries every ten minutes with a one-hour timeout, you could set up a
22793 retry rule of this form:
22794 .code
22795 the.domain.name  rcpt_452   F,1h,10m
22796 .endd
22797 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
22798 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
22799
22800 .vlist
22801 .vitem &%lost_connection%&
22802 A server unexpectedly closed the SMTP connection. There may, of course,
22803 legitimate reasons for this (host died, network died), but if it repeats a lot
22804 for the same host, it indicates something odd.
22805
22806 .vitem &%refused_MX%&
22807 A connection to a host obtained from an MX record was refused.
22808
22809 .vitem &%refused_A%&
22810 A connection to a host not obtained from an MX record was refused.
22811
22812 .vitem &%refused%&
22813 A connection was refused.
22814
22815 .vitem &%timeout_connect_MX%&
22816 A connection attempt to a host obtained from an MX record timed out.
22817
22818 .vitem &%timeout_connect_A%&
22819 A connection attempt to a host not obtained from an MX record timed out.
22820
22821 .vitem &%timeout_connect%&
22822 A connection attempt timed out.
22823
22824 .vitem &%timeout_MX%&
22825 There was a timeout while connecting or during an SMTP session with a host
22826 obtained from an MX record.
22827
22828 .vitem &%timeout_A%&
22829 There was a timeout while connecting or during an SMTP session with a host not
22830 obtained from an MX record.
22831
22832 .vitem &%timeout%&
22833 There was a timeout while connecting or during an SMTP session.
22834
22835 .vitem &%tls_required%&
22836 The server was required to use TLS (it matched &%hosts_require_tls%& in the
22837 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
22838 to STARTTLS, or there was a problem setting up the TLS connection.
22839
22840 .vitem &%quota%&
22841 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
22842 transport.
22843
22844 .vitem &%quota_%&<&'time'&>
22845 .cindex "quota" "error testing in retry rule"
22846 .cindex "retry" "quota error testing"
22847 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
22848 transport, and the mailbox has not been accessed for <&'time'&>. For example,
22849 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
22850 for four days.
22851 .endlist
22852
22853 .cindex "mailbox" "time of last read"
22854 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
22855 timeouts when the mailbox is full and is not being read by its owner. Ideally,
22856 it should be based on the last time that the user accessed the mailbox.
22857 However, it is not always possible to determine this. Exim uses the following
22858 heuristic rules:
22859
22860 .ilist
22861 If the mailbox is a single file, the time of last access (the &"atime"&) is
22862 used. As no new messages are being delivered (because the mailbox is over
22863 quota), Exim does not access the file, so this is the time of last user access.
22864 .next
22865 .cindex "maildir format" "time of last read"
22866 For a maildir delivery, the time of last modification of the &_new_&
22867 subdirectory is used. As the mailbox is over quota, no new files are created in
22868 the &_new_& subdirectory, because no new messages are being delivered. Any
22869 change to the &_new_& subdirectory is therefore assumed to be the result of an
22870 MUA moving a new message to the &_cur_& directory when it is first read. The
22871 time that is used is therefore the last time that the user read a new message.
22872 .next
22873 For other kinds of multi-file mailbox, the time of last access cannot be
22874 obtained, so a retry rule that uses this type of error field is never matched.
22875 .endlist
22876
22877 The quota errors apply both to system-enforced quotas and to Exim's own quota
22878 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
22879 when a local delivery is deferred because a partition is full (the ENOSPC
22880 error).
22881
22882
22883
22884 .section "Retry rules for specified senders" "SECID162"
22885 .cindex "retry" "rules; sender-specific"
22886 You can specify retry rules that apply only when the failing message has a
22887 specific sender. In particular, this can be used to define retry rules that
22888 apply only to bounce messages. The third item in a retry rule can be of this
22889 form:
22890 .display
22891 &`senders=`&<&'address list'&>
22892 .endd
22893 The retry timings themselves are then the fourth item. For example:
22894 .code
22895 *   rcpt_4xx   senders=:   F,1h,30m
22896 .endd
22897 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
22898 host. If the address list contains white space, it must be enclosed in quotes.
22899 For example:
22900 .code
22901 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
22902 .endd
22903 &*Warning*&: This facility can be unhelpful if it is used for host errors
22904 (which do not depend on the recipient). The reason is that the sender is used
22905 only to match the retry rule. Once the rule has been found for a host error,
22906 its contents are used to set a retry time for the host, and this will apply to
22907 all messages, not just those with specific senders.
22908
22909 When testing retry rules using &%-brt%&, you can supply a sender using the
22910 &%-f%& command line option, like this:
22911 .code
22912 exim -f "" -brt user@dom.ain
22913 .endd
22914 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
22915 list is never matched.
22916
22917
22918
22919
22920
22921 .section "Retry parameters" "SECID163"
22922 .cindex "retry" "parameters in rules"
22923 The third (or fourth, if a senders list is present) field in a retry rule is a
22924 sequence of retry parameter sets, separated by semicolons. Each set consists of
22925 .display
22926 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
22927 .endd
22928 The letter identifies the algorithm for computing a new retry time; the cutoff
22929 time is the time beyond which this algorithm no longer applies, and the
22930 arguments vary the algorithm's action. The cutoff time is measured from the
22931 time that the first failure for the domain (combined with the local part if
22932 relevant) was detected, not from the time the message was received.
22933
22934 .cindex "retry" "algorithms"
22935 .cindex "retry" "fixed intervals"
22936 .cindex "retry" "increasing intervals"
22937 .cindex "retry" "random intervals"
22938 The available algorithms are:
22939
22940 .ilist
22941 &'F'&: retry at fixed intervals. There is a single time parameter specifying
22942 the interval.
22943 .next
22944 &'G'&: retry at geometrically increasing intervals. The first argument
22945 specifies a starting value for the interval, and the second a multiplier, which
22946 is used to increase the size of the interval at each retry.
22947 .next
22948 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
22949 retry, the previous interval is multiplied by the factor in order to get a
22950 maximum for the next interval. The minimum interval is the first argument of
22951 the parameter, and an actual interval is chosen randomly between them. Such a
22952 rule has been found to be helpful in cluster configurations when all the
22953 members of the cluster restart at once, and may therefore synchronize their
22954 queue processing times.
22955 .endlist
22956
22957 When computing the next retry time, the algorithm definitions are scanned in
22958 order until one whose cutoff time has not yet passed is reached. This is then
22959 used to compute a new retry time that is later than the current time. In the
22960 case of fixed interval retries, this simply means adding the interval to the
22961 current time. For geometrically increasing intervals, retry intervals are
22962 computed from the rule's parameters until one that is greater than the previous
22963 interval is found. The main configuration variable
22964 .cindex "limit" "retry interval"
22965 .cindex "retry" "interval, maximum"
22966 .oindex "&%retry_interval_max%&"
22967 &%retry_interval_max%& limits the maximum interval between retries. It
22968 cannot be set greater than &`24h`&, which is its default value.
22969
22970 A single remote domain may have a number of hosts associated with it, and each
22971 host may have more than one IP address. Retry algorithms are selected on the
22972 basis of the domain name, but are applied to each IP address independently. If,
22973 for example, a host has two IP addresses and one is unusable, Exim will
22974 generate retry times for it and will not try to use it until its next retry
22975 time comes. Thus the good IP address is likely to be tried first most of the
22976 time.
22977
22978 .cindex "hints database" "use for retrying"
22979 Retry times are hints rather than promises. Exim does not make any attempt to
22980 run deliveries exactly at the computed times. Instead, a queue runner process
22981 starts delivery processes for delayed messages periodically, and these attempt
22982 new deliveries only for those addresses that have passed their next retry time.
22983 If a new message arrives for a deferred address, an immediate delivery attempt
22984 occurs only if the address has passed its retry time. In the absence of new
22985 messages, the minimum time between retries is the interval between queue runner
22986 processes. There is not much point in setting retry times of five minutes if
22987 your queue runners happen only once an hour, unless there are a significant
22988 number of incoming messages (which might be the case on a system that is
22989 sending everything to a smart host, for example).
22990
22991 The data in the retry hints database can be inspected by using the
22992 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
22993 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
22994 &'exinext'& utility script can be used to find out what the next retry times
22995 are for the hosts associated with a particular mail domain, and also for local
22996 deliveries that have been deferred.
22997
22998
22999 .section "Retry rule examples" "SECID164"
23000 Here are some example retry rules:
23001 .code
23002 alice@wonderland.fict.example quota_5d  F,7d,3h
23003 wonderland.fict.example       quota_5d
23004 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
23005 lookingglass.fict.example     *         F,24h,30m;
23006 *                 refused_A   F,2h,20m;
23007 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
23008 .endd
23009 The first rule sets up special handling for mail to
23010 &'alice@wonderland.fict.example'& when there is an over-quota error and the
23011 mailbox has not been read for at least 5 days. Retries continue every three
23012 hours for 7 days. The second rule handles over-quota errors for all other local
23013 parts at &'wonderland.fict.example'&; the absence of a local part has the same
23014 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
23015 fail are bounced immediately if the mailbox has not been read for at least 5
23016 days.
23017
23018 The third rule handles all other errors at &'wonderland.fict.example'&; retries
23019 happen every 15 minutes for an hour, then with geometrically increasing
23020 intervals until two days have passed since a delivery first failed. After the
23021 first hour there is a delay of one hour, then two hours, then four hours, and
23022 so on (this is a rather extreme example).
23023
23024 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
23025 They happen every 30 minutes for 24 hours only. The remaining two rules handle
23026 all other domains, with special action for connection refusal from hosts that
23027 were not obtained from an MX record.
23028
23029 The final rule in a retry configuration should always have asterisks in the
23030 first two fields so as to provide a general catch-all for any addresses that do
23031 not have their own special handling. This example tries every 15 minutes for 2
23032 hours, then with intervals starting at one hour and increasing by a factor of
23033 1.5 up to 16 hours, then every 8 hours up to 5 days.
23034
23035
23036
23037 .section "Timeout of retry data" "SECID165"
23038 .cindex "timeout" "of retry data"
23039 .oindex "&%retry_data_expire%&"
23040 .cindex "hints database" "data expiry"
23041 .cindex "retry" "timeout of data"
23042 Exim timestamps the data that it writes to its retry hints database. When it
23043 consults the data during a delivery it ignores any that is older than the value
23044 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
23045 been tried for 7 days, Exim will try to deliver to it immediately a message
23046 arrives, and if that fails, it will calculate a retry time as if it were
23047 failing for the first time.
23048
23049 This improves the behaviour for messages routed to rarely-used hosts such as MX
23050 backups. If such a host was down at one time, and happens to be down again when
23051 Exim tries a month later, using the old retry data would imply that it had been
23052 down all the time, which is not a justified assumption.
23053
23054 If a host really is permanently dead, this behaviour causes a burst of retries
23055 every now and again, but only if messages routed to it are rare. If there is a
23056 message at least once every 7 days the retry data never expires.
23057
23058
23059
23060
23061 .section "Long-term failures" "SECID166"
23062 .cindex "delivery failure, long-term"
23063 .cindex "retry" "after long-term failure"
23064 Special processing happens when an email address has been failing for so long
23065 that the cutoff time for the last algorithm is reached. For example, using the
23066 default retry rule:
23067 .code
23068 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
23069 .endd
23070 the cutoff time is four days. Reaching the retry cutoff is independent of how
23071 long any specific message has been failing; it is the length of continuous
23072 failure for the recipient address that counts.
23073
23074 When the cutoff time is reached for a local delivery, or for all the IP
23075 addresses associated with a remote delivery, a subsequent delivery failure
23076 causes Exim to give up on the address, and a bounce message is generated.
23077 In order to cater for new messages that use the failing address, a next retry
23078 time is still computed from the final algorithm, and is used as follows:
23079
23080 For local deliveries, one delivery attempt is always made for any subsequent
23081 messages. If this delivery fails, the address fails immediately. The
23082 post-cutoff retry time is not used.
23083
23084 If the delivery is remote, there are two possibilities, controlled by the
23085 .oindex "&%delay_after_cutoff%&"
23086 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
23087 default. Until the post-cutoff retry time for one of the IP addresses is
23088 reached, the failing email address is bounced immediately, without a delivery
23089 attempt taking place. After that time, one new delivery attempt is made to
23090 those IP addresses that are past their retry times, and if that still fails,
23091 the address is bounced and new retry times are computed.
23092
23093 In other words, when all the hosts for a given email address have been failing
23094 for a long time, Exim bounces rather then defers until one of the hosts' retry
23095 times is reached. Then it tries once, and bounces if that attempt fails. This
23096 behaviour ensures that few resources are wasted in repeatedly trying to deliver
23097 to a broken destination, but if the host does recover, Exim will eventually
23098 notice.
23099
23100 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
23101 addresses are past their final cutoff time, Exim tries to deliver to those IP
23102 addresses that have not been tried since the message arrived. If there are
23103 no suitable IP addresses, or if they all fail, the address is bounced. In other
23104 words, it does not delay when a new message arrives, but tries the expired
23105 addresses immediately, unless they have been tried since the message arrived.
23106 If there is a continuous stream of messages for the failing domains, setting
23107 &%delay_after_cutoff%& false means that there will be many more attempts to
23108 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
23109 true.
23110
23111 .section "Deliveries that work intermittently" "SECID167"
23112 .cindex "retry" "intermittently working deliveries"
23113 Some additional logic is needed to cope with cases where a host is
23114 intermittently available, or when a message has some attribute that prevents
23115 its delivery when others to the same address get through. In this situation,
23116 because some messages are successfully delivered, the &"retry clock"& for the
23117 host or address keeps getting reset by the successful deliveries, and so
23118 failing messages remain on the queue for ever because the cutoff time is never
23119 reached.
23120
23121 Two exceptional actions are applied to prevent this happening. The first
23122 applies to errors that are related to a message rather than a remote host.
23123 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
23124 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
23125 commands, and quota failures. For this type of error, if a message's arrival
23126 time is earlier than the &"first failed"& time for the error, the earlier time
23127 is used when scanning the retry rules to decide when to try next and when to
23128 time out the address.
23129
23130 The exceptional second action applies in all cases. If a message has been on
23131 the queue for longer than the cutoff time of any applicable retry rule for a
23132 given address, a delivery is attempted for that address, even if it is not yet
23133 time, and if this delivery fails, the address is timed out. A new retry time is
23134 not computed in this case, so that other messages for the same address are
23135 considered immediately.
23136 .ecindex IIDretconf1
23137 .ecindex IIDregconf2
23138
23139
23140
23141
23142
23143
23144 . ////////////////////////////////////////////////////////////////////////////
23145 . ////////////////////////////////////////////////////////////////////////////
23146
23147 .chapter "SMTP authentication" "CHAPSMTPAUTH"
23148 .scindex IIDauthconf1 "SMTP" "authentication configuration"
23149 .scindex IIDauthconf2 "authentication"
23150 The &"authenticators"& section of Exim's run time configuration is concerned
23151 with SMTP authentication. This facility is an extension to the SMTP protocol,
23152 described in RFC 2554, which allows a client SMTP host to authenticate itself
23153 to a server. This is a common way for a server to recognize clients that are
23154 permitted to use it as a relay. SMTP authentication is not of relevance to the
23155 transfer of mail between servers that have no managerial connection with each
23156 other.
23157
23158 .cindex "AUTH" "description of"
23159 Very briefly, the way SMTP authentication works is as follows:
23160
23161 .ilist
23162 The server advertises a number of authentication &'mechanisms'& in response to
23163 the client's EHLO command.
23164 .next
23165 The client issues an AUTH command, naming a specific mechanism. The command
23166 may, optionally, contain some authentication data.
23167 .next
23168 The server may issue one or more &'challenges'&, to which the client must send
23169 appropriate responses. In simple authentication mechanisms, the challenges are
23170 just prompts for user names and passwords. The server does not have to issue
23171 any challenges &-- in some mechanisms the relevant data may all be transmitted
23172 with the AUTH command.
23173 .next
23174 The server either accepts or denies authentication.
23175 .next
23176 If authentication succeeds, the client may optionally make use of the AUTH
23177 option on the MAIL command to pass an authenticated sender in subsequent
23178 mail transactions. Authentication lasts for the remainder of the SMTP
23179 connection.
23180 .next
23181 If authentication fails, the client may give up, or it may try a different
23182 authentication mechanism, or it may try transferring mail over the
23183 unauthenticated connection.
23184 .endlist
23185
23186 If you are setting up a client, and want to know which authentication
23187 mechanisms the server supports, you can use Telnet to connect to port 25 (the
23188 SMTP port) on the server, and issue an EHLO command. The response to this
23189 includes the list of supported mechanisms. For example:
23190 .display
23191 &`$ `&&*&`telnet server.example 25`&*&
23192 &`Trying 192.168.34.25...`&
23193 &`Connected to server.example.`&
23194 &`Escape character is &#x0027;^]&#x0027;.`&
23195 &`220 server.example ESMTP Exim 4.20 ...`&
23196 &*&`ehlo client.example`&*&
23197 &`250-server.example Hello client.example [10.8.4.5]`&
23198 &`250-SIZE 52428800`&
23199 &`250-PIPELINING`&
23200 &`250-AUTH PLAIN`&
23201 &`250 HELP`&
23202 .endd
23203 The second-last line of this example output shows that the server supports
23204 authentication using the PLAIN mechanism. In Exim, the different authentication
23205 mechanisms are configured by specifying &'authenticator'& drivers. Like the
23206 routers and transports, which authenticators are included in the binary is
23207 controlled by build-time definitions. The following are currently available,
23208 included by setting
23209 .code
23210 AUTH_CRAM_MD5=yes
23211 AUTH_CYRUS_SASL=yes
23212 AUTH_PLAINTEXT=yes
23213 AUTH_SPA=yes
23214 .endd
23215 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
23216 authentication mechanism (RFC 2195), and the second provides an interface to
23217 the Cyrus SASL authentication library. The third can be configured to support
23218 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
23219 not formally documented, but used by several MUAs. The fourth authenticator
23220 supports Microsoft's &'Secure Password Authentication'& mechanism.
23221
23222 The authenticators are configured using the same syntax as other drivers (see
23223 section &<<SECTfordricon>>&). If no authenticators are required, no
23224 authentication section need be present in the configuration file. Each
23225 authenticator can in principle have both server and client functions. When Exim
23226 is receiving SMTP mail, it is acting as a server; when it is sending out
23227 messages over SMTP, it is acting as a client. Authenticator configuration
23228 options are provided for use in both these circumstances.
23229
23230 To make it clear which options apply to which situation, the prefixes
23231 &%server_%& and &%client_%& are used on option names that are specific to
23232 either the server or the client function, respectively. Server and client
23233 functions are disabled if none of their options are set. If an authenticator is
23234 to be used for both server and client functions, a single definition, using
23235 both sets of options, is required. For example:
23236 .code
23237 cram:
23238   driver = cram_md5
23239   public_name = CRAM-MD5
23240   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
23241   client_name = ph10
23242   client_secret = secret2
23243 .endd
23244 The &%server_%& option is used when Exim is acting as a server, and the
23245 &%client_%& options when it is acting as a client.
23246
23247 Descriptions of the individual authenticators are given in subsequent chapters.
23248 The remainder of this chapter covers the generic options for the
23249 authenticators, followed by general discussion of the way authentication works
23250 in Exim.
23251
23252
23253
23254 .section "Generic options for authenticators" "SECID168"
23255 .cindex "authentication" "generic options"
23256 .cindex "options" "generic; for authenticators"
23257
23258 .option client_condition authenticators string&!! unset
23259 When Exim is authenticating as a client, it skips any authenticator whose
23260 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
23261 used, for example, to skip plain text authenticators when the connection is not
23262 encrypted by a setting such as:
23263 .code
23264 client_condition = ${if !eq{$tls_cipher}{}}
23265 .endd
23266 (Older documentation incorrectly states that &$tls_cipher$& contains the cipher
23267 used for incoming messages. In fact, during SMTP delivery, it contains the
23268 cipher used for the delivery.)
23269
23270
23271 .option driver authenticators string unset
23272 This option must always be set. It specifies which of the available
23273 authenticators is to be used.
23274
23275
23276 .option public_name authenticators string unset
23277 This option specifies the name of the authentication mechanism that the driver
23278 implements, and by which it is known to the outside world. These names should
23279 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
23280 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
23281 defaults to the driver's instance name.
23282
23283
23284 .option server_advertise_condition authenticators string&!! unset
23285 When a server is about to advertise an authentication mechanism, the condition
23286 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
23287 mechanism is not advertised.
23288 If the expansion fails, the mechanism is not advertised. If the failure was not
23289 forced, and was not caused by a lookup defer, the incident is logged.
23290 See section &<<SECTauthexiser>>& below for further discussion.
23291
23292
23293 .option server_condition authenticators string&!! unset
23294 This option must be set for a &%plaintext%& server authenticator, where it
23295 is used directly to control authentication. See section &<<SECTplainserver>>&
23296 for details.
23297
23298 For the other authenticators, &%server_condition%& can be used as an additional
23299 authentication or authorization mechanism that is applied after the other
23300 authenticator conditions succeed. If it is set, it is expanded when the
23301 authenticator would otherwise return a success code. If the expansion is forced
23302 to fail, authentication fails. Any other expansion failure causes a temporary
23303 error code to be returned. If the result of a successful expansion is an empty
23304 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
23305 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
23306 other result, a temporary error code is returned, with the expanded string as
23307 the error text.
23308
23309
23310 .option server_debug_print authenticators string&!! unset
23311 If this option is set and authentication debugging is enabled (see the &%-d%&
23312 command line option), the string is expanded and included in the debugging
23313 output when the authenticator is run as a server. This can help with checking
23314 out the values of variables.
23315 If expansion of the string fails, the error message is written to the debugging
23316 output, and Exim carries on processing.
23317
23318
23319 .option server_set_id authenticators string&!! unset
23320 .vindex "&$authenticated_id$&"
23321 When an Exim server successfully authenticates a client, this string is
23322 expanded using data from the authentication, and preserved for any incoming
23323 messages in the variable &$authenticated_id$&. It is also included in the log
23324 lines for incoming messages. For example, a user/password authenticator
23325 configuration might preserve the user name that was used to authenticate, and
23326 refer to it subsequently during delivery of the message.
23327 If expansion fails, the option is ignored.
23328
23329
23330 .option server_mail_auth_condition authenticators string&!! unset
23331 This option allows a server to discard authenticated sender addresses supplied
23332 as part of MAIL commands in SMTP connections that are authenticated by the
23333 driver on which &%server_mail_auth_condition%& is set. The option is not used
23334 as part of the authentication process; instead its (unexpanded) value is
23335 remembered for later use.
23336 How it is used is described in the following section.
23337
23338
23339
23340
23341
23342 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
23343 .cindex "authentication" "sender; authenticated"
23344 .cindex "AUTH" "on MAIL command"
23345 When a client supplied an AUTH= item on a MAIL command, Exim applies
23346 the following checks before accepting it as the authenticated sender of the
23347 message:
23348
23349 .ilist
23350 If the connection is not using extended SMTP (that is, HELO was used rather
23351 than EHLO), the use of AUTH= is a syntax error.
23352 .next
23353 If the value of the AUTH= parameter is &"<>"&, it is ignored.
23354 .next
23355 .vindex "&$authenticated_sender$&"
23356 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
23357 running, the value of &$authenticated_sender$& is set to the value obtained
23358 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
23359 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
23360 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
23361 given for the MAIL command.
23362 .next
23363 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
23364 is accepted and placed in &$authenticated_sender$& only if the client has
23365 authenticated.
23366 .next
23367 If the AUTH= value was accepted by either of the two previous rules, and
23368 the client has authenticated, and the authenticator has a setting for the
23369 &%server_mail_auth_condition%&, the condition is checked at this point. The
23370 valued that was saved from the authenticator is expanded. If the expansion
23371 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
23372 &$authenticated_sender$& is deleted. If the expansion yields any other value,
23373 the value of &$authenticated_sender$& is retained and passed on with the
23374 message.
23375 .endlist
23376
23377
23378 When &$authenticated_sender$& is set for a message, it is passed on to other
23379 hosts to which Exim authenticates as a client. Do not confuse this value with
23380 &$authenticated_id$&, which is a string obtained from the authentication
23381 process, and which is not usually a complete email address.
23382
23383 .vindex "&$sender_address$&"
23384 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
23385 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
23386 therefore make use of &$authenticated_sender$&. The converse is not true: the
23387 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
23388 ACL is run.
23389
23390
23391
23392 .section "Authentication on an Exim server" "SECTauthexiser"
23393 .cindex "authentication" "on an Exim server"
23394 When Exim receives an EHLO command, it advertises the public names of those
23395 authenticators that are configured as servers, subject to the following
23396 conditions:
23397
23398 .ilist
23399 The client host must match &%auth_advertise_hosts%& (default *).
23400 .next
23401 It the &%server_advertise_condition%& option is set, its expansion must not
23402 yield the empty string, &"0"&, &"no"&, or &"false"&.
23403 .endlist
23404
23405 The order in which the authenticators are defined controls the order in which
23406 the mechanisms are advertised.
23407
23408 Some mail clients (for example, some versions of Netscape) require the user to
23409 provide a name and password for authentication whenever AUTH is advertised,
23410 even though authentication may not in fact be needed (for example, Exim may be
23411 set up to allow unconditional relaying from the client by an IP address check).
23412 You can make such clients more friendly by not advertising AUTH to them.
23413 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
23414 that runs for RCPT) to relay without authentication, you should set
23415 .code
23416 auth_advertise_hosts = ! 10.9.8.0/24
23417 .endd
23418 so that no authentication mechanisms are advertised to them.
23419
23420 The &%server_advertise_condition%& controls the advertisement of individual
23421 authentication mechanisms. For example, it can be used to restrict the
23422 advertisement of a particular mechanism to encrypted connections, by a setting
23423 such as:
23424 .code
23425 server_advertise_condition = ${if eq{$tls_cipher}{}{no}{yes}}
23426 .endd
23427 .vindex "&$tls_cipher$&"
23428 If the session is encrypted, &$tls_cipher$& is not empty, and so the expansion
23429 yields &"yes"&, which allows the advertisement to happen.
23430
23431 When an Exim server receives an AUTH command from a client, it rejects it
23432 immediately if AUTH was not advertised in response to an earlier EHLO
23433 command. This is the case if
23434
23435 .ilist
23436 The client host does not match &%auth_advertise_hosts%&; or
23437 .next
23438 No authenticators are configured with server options; or
23439 .next
23440 Expansion of &%server_advertise_condition%& blocked the advertising of all the
23441 server authenticators.
23442 .endlist
23443
23444
23445 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
23446 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
23447 AUTH is accepted from any client host.
23448
23449 If AUTH is not rejected by the ACL, Exim searches its configuration for a
23450 server authentication mechanism that was advertised in response to EHLO and
23451 that matches the one named in the AUTH command. If it finds one, it runs
23452 the appropriate authentication protocol, and authentication either succeeds or
23453 fails. If there is no matching advertised mechanism, the AUTH command is
23454 rejected with a 504 error.
23455
23456 .vindex "&$received_protocol$&"
23457 .vindex "&$sender_host_authenticated$&"
23458 When a message is received from an authenticated host, the value of
23459 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
23460 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
23461 public name) of the authenticator driver that successfully authenticated the
23462 client from which the message was received. This variable is empty if there was
23463 no successful authentication.
23464
23465
23466
23467
23468 .section "Testing server authentication" "SECID169"
23469 .cindex "authentication" "testing a server"
23470 .cindex "AUTH" "testing a server"
23471 .cindex "base64 encoding" "creating authentication test data"
23472 Exim's &%-bh%& option can be useful for testing server authentication
23473 configurations. The data for the AUTH command has to be sent using base64
23474 encoding. A quick way to produce such data for testing is the following Perl
23475 script:
23476 .code
23477 use MIME::Base64;
23478 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
23479 .endd
23480 .cindex "binary zero" "in authentication data"
23481 This interprets its argument as a Perl string, and then encodes it. The
23482 interpretation as a Perl string allows binary zeros, which are required for
23483 some kinds of authentication, to be included in the data. For example, a
23484 command line to run this script on such data might be
23485 .code
23486 encode '\0user\0password'
23487 .endd
23488 Note the use of single quotes to prevent the shell interpreting the
23489 backslashes, so that they can be interpreted by Perl to specify characters
23490 whose code value is zero.
23491
23492 &*Warning 1*&: If either of the user or password strings starts with an octal
23493 digit, you must use three zeros instead of one after the leading backslash. If
23494 you do not, the octal digit that starts your string will be incorrectly
23495 interpreted as part of the code for the first character.
23496
23497 &*Warning 2*&: If there are characters in the strings that Perl interprets
23498 specially, you must use a Perl escape to prevent them being misinterpreted. For
23499 example, a command such as
23500 .code
23501 encode '\0user@domain.com\0pas$$word'
23502 .endd
23503 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
23504
23505 If you have the &%mimencode%& command installed, another way to do produce
23506 base64-encoded strings is to run the command
23507 .code
23508 echo -e -n `\0user\0password' | mimencode
23509 .endd
23510 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
23511 in the argument, and the &%-n%& option specifies no newline at the end of its
23512 output. However, not all versions of &%echo%& recognize these options, so you
23513 should check your version before relying on this suggestion.
23514
23515
23516
23517 .section "Authentication by an Exim client" "SECID170"
23518 .cindex "authentication" "on an Exim client"
23519 The &(smtp)& transport has two options called &%hosts_require_auth%& and
23520 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
23521 announces support for authentication, and the host matches an entry in either
23522 of these options, Exim (as a client) tries to authenticate as follows:
23523
23524 .ilist
23525 For each authenticator that is configured as a client, in the order in which
23526 they are defined in the configuration, it searches the authentication
23527 mechanisms announced by the server for one whose name matches the public name
23528 of the authenticator.
23529 .next
23530 .vindex "&$host$&"
23531 .vindex "&$host_address$&"
23532 When it finds one that matches, it runs the authenticator's client code. The
23533 variables &$host$& and &$host_address$& are available for any string expansions
23534 that the client might do. They are set to the server's name and IP address. If
23535 any expansion is forced to fail, the authentication attempt is abandoned, and
23536 Exim moves on to the next authenticator. Otherwise an expansion failure causes
23537 delivery to be deferred.
23538 .next
23539 If the result of the authentication attempt is a temporary error or a timeout,
23540 Exim abandons trying to send the message to the host for the moment. It will
23541 try again later. If there are any backup hosts available, they are tried in the
23542 usual way.
23543 .next
23544 If the response to authentication is a permanent error (5&'xx'& code), Exim
23545 carries on searching the list of authenticators and tries another one if
23546 possible. If all authentication attempts give permanent errors, or if there are
23547 no attempts because no mechanisms match (or option expansions force failure),
23548 what happens depends on whether the host matches &%hosts_require_auth%& or
23549 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
23550 delivery is deferred. The error can be detected in the retry rules, and thereby
23551 turned into a permanent error if you wish. In the second case, Exim tries to
23552 deliver the message unauthenticated.
23553 .endlist
23554
23555 .cindex "AUTH" "on MAIL command"
23556 When Exim has authenticated itself to a remote server, it adds the AUTH
23557 parameter to the MAIL commands it sends, if it has an authenticated sender for
23558 the message. If the message came from a remote host, the authenticated sender
23559 is the one that was receiving on an incoming MAIL command, provided that the
23560 incoming connection was authenticated and the &%server_mail_auth%& condition
23561 allowed the authenticated sender to be retained. If a local process calls Exim
23562 to send a message, the sender address that is built from the login name and
23563 &%qualify_domain%& is treated as authenticated. However, if the
23564 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
23565 the authenticated sender that was received with the message.
23566 .ecindex IIDauthconf1
23567 .ecindex IIDauthconf2
23568
23569
23570
23571
23572
23573
23574 . ////////////////////////////////////////////////////////////////////////////
23575 . ////////////////////////////////////////////////////////////////////////////
23576
23577 .chapter "The plaintext authenticator" "CHAPplaintext"
23578 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
23579 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
23580 The &(plaintext)& authenticator can be configured to support the PLAIN and
23581 LOGIN authentication mechanisms, both of which transfer authentication data as
23582 plain (unencrypted) text (though base64 encoded). The use of plain text is a
23583 security risk; you are strongly advised to insist on the use of SMTP encryption
23584 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
23585 use unencrypted plain text, you should not use the same passwords for SMTP
23586 connections as you do for login accounts.
23587
23588 .section "Plaintext options" "SECID171"
23589 .cindex "options" "&(plaintext)& authenticator (server)"
23590 When configured as a server, &(plaintext)& uses the following options:
23591
23592 .option server_condition authenticators string&!! unset
23593 This is actually a global authentication option, but it must be set in order to
23594 configure the &(plaintext)& driver as a server. Its use is described below.
23595
23596 .option server_prompts plaintext string&!! unset
23597 The contents of this option, after expansion, must be a colon-separated list of
23598 prompt strings. If expansion fails, a temporary authentication rejection is
23599 given.
23600
23601 .section "Using plaintext in a server" "SECTplainserver"
23602 .cindex "AUTH" "in &(plaintext)& authenticator"
23603 .cindex "binary zero" "in &(plaintext)& authenticator"
23604 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
23605         "in &(plaintext)& authenticator"
23606 .vindex "&$auth1$&, &$auth2$&, etc"
23607 .cindex "base64 encoding" "in &(plaintext)& authenticator"
23608
23609 When running as a server, &(plaintext)& performs the authentication test by
23610 expanding a string. The data sent by the client with the AUTH command, or in
23611 response to subsequent prompts, is base64 encoded, and so may contain any byte
23612 values when decoded. If any data is supplied with the command, it is treated as
23613 a list of strings, separated by NULs (binary zeros), the first three of which
23614 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
23615 (neither LOGIN nor PLAIN uses more than three strings).
23616
23617 For compatibility with previous releases of Exim, the values are also placed in
23618 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
23619 variables for this purpose is now deprecated, as it can lead to confusion in
23620 string expansions that also use them for other things.
23621
23622 If there are more strings in &%server_prompts%& than the number of strings
23623 supplied with the AUTH command, the remaining prompts are used to obtain more
23624 data. Each response from the client may be a list of NUL-separated strings.
23625
23626 .vindex "&$authenticated_id$&"
23627 Once a sufficient number of data strings have been received,
23628 &%server_condition%& is expanded. If the expansion is forced to fail,
23629 authentication fails. Any other expansion failure causes a temporary error code
23630 to be returned. If the result of a successful expansion is an empty string,
23631 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
23632 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
23633 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
23634 For any other result, a temporary error code is returned, with the expanded
23635 string as the error text.
23636
23637 &*Warning*&: If you use a lookup in the expansion to find the user's
23638 password, be sure to make the authentication fail if the user is unknown.
23639 There are good and bad examples at the end of the next section.
23640
23641
23642
23643 .section "The PLAIN authentication mechanism" "SECID172"
23644 .cindex "PLAIN authentication mechanism"
23645 .cindex "authentication" "PLAIN mechanism"
23646 .cindex "binary zero" "in &(plaintext)& authenticator"
23647 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
23648 sent as one item of data (that is, one combined string containing two NUL
23649 separators). The data is sent either as part of the AUTH command, or
23650 subsequently in response to an empty prompt from the server.
23651
23652 The second and third strings are a user name and a corresponding password.
23653 Using a single fixed user name and password as an example, this could be
23654 configured as follows:
23655 .code
23656 fixed_plain:
23657   driver = plaintext
23658   public_name = PLAIN
23659   server_prompts = :
23660   server_condition = \
23661     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
23662   server_set_id = $auth2
23663 .endd
23664 Note that the default result strings from &%if%& (&"true"& or an empty string)
23665 are exactly what we want here, so they need not be specified. Obviously, if the
23666 password contains expansion-significant characters such as dollar, backslash,
23667 or closing brace, they have to be escaped.
23668
23669 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
23670 the end of a string list are ignored). If all the data comes as part of the
23671 AUTH command, as is commonly the case, the prompt is not used. This
23672 authenticator is advertised in the response to EHLO as
23673 .code
23674 250-AUTH PLAIN
23675 .endd
23676 and a client host can authenticate itself by sending the command
23677 .code
23678 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
23679 .endd
23680 As this contains three strings (more than the number of prompts), no further
23681 data is required from the client. Alternatively, the client may just send
23682 .code
23683 AUTH PLAIN
23684 .endd
23685 to initiate authentication, in which case the server replies with an empty
23686 prompt. The client must respond with the combined data string.
23687
23688 The data string is base64 encoded, as required by the RFC. This example,
23689 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
23690 represents a zero byte. This is split up into three strings, the first of which
23691 is empty. The &%server_condition%& option in the authenticator checks that the
23692 second two are &`username`& and &`mysecret`& respectively.
23693
23694 Having just one fixed user name and password, as in this example, is not very
23695 realistic, though for a small organization with only a handful of
23696 authenticating clients it could make sense.
23697
23698 A more sophisticated instance of this authenticator could use the user name in
23699 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
23700 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
23701 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
23702 This is an incorrect example:
23703 .code
23704 server_condition = \
23705   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
23706 .endd
23707 The expansion uses the user name (&$auth2$&) as the key to look up a password,
23708 which it then compares to the supplied password (&$auth3$&). Why is this example
23709 incorrect? It works fine for existing users, but consider what happens if a
23710 non-existent user name is given. The lookup fails, but as no success/failure
23711 strings are given for the lookup, it yields an empty string. Thus, to defeat
23712 the authentication, all a client has to do is to supply a non-existent user
23713 name and an empty password. The correct way of writing this test is:
23714 .code
23715 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
23716   {${if eq{$value}{$auth3}}} {false}}
23717 .endd
23718 In this case, if the lookup succeeds, the result is checked; if the lookup
23719 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
23720 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
23721 always fails if its second argument is empty. However, the second way of
23722 writing the test makes the logic clearer.
23723
23724
23725 .section "The LOGIN authentication mechanism" "SECID173"
23726 .cindex "LOGIN authentication mechanism"
23727 .cindex "authentication" "LOGIN mechanism"
23728 The LOGIN authentication mechanism is not documented in any RFC, but is in use
23729 in a number of programs. No data is sent with the AUTH command. Instead, a
23730 user name and password are supplied separately, in response to prompts. The
23731 plaintext authenticator can be configured to support this as in this example:
23732 .code
23733 fixed_login:
23734   driver = plaintext
23735   public_name = LOGIN
23736   server_prompts = User Name : Password
23737   server_condition = \
23738     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
23739   server_set_id = $auth1
23740 .endd
23741 Because of the way plaintext operates, this authenticator accepts data supplied
23742 with the AUTH command (in contravention of the specification of LOGIN), but
23743 if the client does not supply it (as is the case for LOGIN clients), the prompt
23744 strings are used to obtain two data items.
23745
23746 Some clients are very particular about the precise text of the prompts. For
23747 example, Outlook Express is reported to recognize only &"Username:"& and
23748 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
23749 strings. It uses the &%ldapauth%& expansion condition to check the user
23750 name and password by binding to an LDAP server:
23751 .code
23752 login:
23753   driver = plaintext
23754   public_name = LOGIN
23755   server_prompts = Username:: : Password::
23756   server_condition = ${if and{{
23757     !eq{}{$auth1} }{ \
23758     ldapauth{user="cn=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
23759              pass=${quote:$auth2} \
23760              ldap://ldap.example.org/} }} }
23761   server_set_id = uid=$auth1,ou=people,o=example.org
23762 .endd
23763 We have to check that the username is not empty before using it, because LDAP
23764 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
23765 operator to correctly quote the DN for authentication. However, the basic
23766 &%quote%& operator, rather than any of the LDAP quoting operators, is the
23767 correct one to use for the password, because quoting is needed only to make
23768 the password conform to the Exim syntax. At the LDAP level, the password is an
23769 uninterpreted string.
23770
23771
23772 .section "Support for different kinds of authentication" "SECID174"
23773 A number of string expansion features are provided for the purpose of
23774 interfacing to different ways of user authentication. These include checking
23775 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
23776 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
23777 &<<SECTexpcond>>&.
23778
23779
23780
23781
23782 .section "Using plaintext in a client" "SECID175"
23783 .cindex "options" "&(plaintext)& authenticator (client)"
23784 The &(plaintext)& authenticator has two client options:
23785
23786 .option client_ignore_invalid_base64 plaintext boolean false
23787 If the client receives a server prompt that is not a valid base64 string,
23788 authentication is abandoned by default. However, if this option is set true,
23789 the error in the challenge is ignored and the client sends the response as
23790 usual.
23791
23792 .option client_send plaintext string&!! unset
23793 The string is a colon-separated list of authentication data strings. Each
23794 string is independently expanded before being sent to the server. The first
23795 string is sent with the AUTH command; any more strings are sent in response
23796 to prompts from the server. Before each string is expanded, the value of the
23797 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
23798 with &$auth1$& for the first prompt. Up to three prompts are stored in this
23799 way. Thus, the prompt that is received in response to sending the first string
23800 (with the AUTH command) can be used in the expansion of the second string, and
23801 so on. If an invalid base64 string is received when
23802 &%client_ignore_invalid_base64%& is set, an empty string is put in the
23803 &$auth$&<&'n'&> variable.
23804
23805 &*Note*&: You cannot use expansion to create multiple strings, because
23806 splitting takes priority and happens first.
23807
23808 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
23809 the data, further processing is applied to each string before it is sent. If
23810 there are any single circumflex characters in the string, they are converted to
23811 NULs. Should an actual circumflex be required as data, it must be doubled in
23812 the string.
23813
23814 This is an example of a client configuration that implements the PLAIN
23815 authentication mechanism with a fixed user name and password:
23816 .code
23817 fixed_plain:
23818   driver = plaintext
23819   public_name = PLAIN
23820   client_send = ^username^mysecret
23821 .endd
23822 The lack of colons means that the entire text is sent with the AUTH
23823 command, with the circumflex characters converted to NULs. A similar example
23824 that uses the LOGIN mechanism is:
23825 .code
23826 fixed_login:
23827   driver = plaintext
23828   public_name = LOGIN
23829   client_send = : username : mysecret
23830 .endd
23831 The initial colon means that the first string is empty, so no data is sent with
23832 the AUTH command itself. The remaining strings are sent in response to
23833 prompts.
23834 .ecindex IIDplaiauth1
23835 .ecindex IIDplaiauth2
23836
23837
23838
23839
23840 . ////////////////////////////////////////////////////////////////////////////
23841 . ////////////////////////////////////////////////////////////////////////////
23842
23843 .chapter "The cram_md5 authenticator" "CHID9"
23844 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
23845 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
23846 .cindex "CRAM-MD5 authentication mechanism"
23847 .cindex "authentication" "CRAM-MD5 mechanism"
23848 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
23849 sends a challenge string to the client, and the response consists of a user
23850 name and the CRAM-MD5 digest of the challenge string combined with a secret
23851 string (password) which is known to both server and client. Thus, the secret
23852 is not sent over the network as plain text, which makes this authenticator more
23853 secure than &(plaintext)&. However, the downside is that the secret has to be
23854 available in plain text at either end.
23855
23856
23857 .section "Using cram_md5 as a server" "SECID176"
23858 .cindex "options" "&(cram_md5)& authenticator (server)"
23859 This authenticator has one server option, which must be set to configure the
23860 authenticator as a server:
23861
23862 .option server_secret cram_md5 string&!! unset
23863 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
23864 When the server receives the client's response, the user name is placed in
23865 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
23866 obtain the password for that user. The server then computes the CRAM-MD5 digest
23867 that the client should have sent, and checks that it received the correct
23868 string. If the expansion of &%server_secret%& is forced to fail, authentication
23869 fails. If the expansion fails for some other reason, a temporary error code is
23870 returned to the client.
23871
23872 For compatibility with previous releases of Exim, the user name is also placed
23873 in &$1$&. However, the use of this variables for this purpose is now
23874 deprecated, as it can lead to confusion in string expansions that also use
23875 numeric variables for other things.
23876
23877 For example, the following authenticator checks that the user name given by the
23878 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
23879 user name, authentication fails.
23880 .code
23881 fixed_cram:
23882   driver = cram_md5
23883   public_name = CRAM-MD5
23884   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
23885   server_set_id = $auth1
23886 .endd
23887 .vindex "&$authenticated_id$&"
23888 If authentication succeeds, the setting of &%server_set_id%& preserves the user
23889 name in &$authenticated_id$&. A more typical configuration might look up the
23890 secret string in a file, using the user name as the key. For example:
23891 .code
23892 lookup_cram:
23893   driver = cram_md5
23894   public_name = CRAM-MD5
23895   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
23896                   {$value}fail}
23897   server_set_id = $auth1
23898 .endd
23899 Note that this expansion explicitly forces failure if the lookup fails
23900 because &$auth1$& contains an unknown user name.
23901
23902
23903 .section "Using cram_md5 as a client" "SECID177"
23904 .cindex "options" "&(cram_md5)& authenticator (client)"
23905 When used as a client, the &(cram_md5)& authenticator has two options:
23906
23907
23908
23909 .option client_name cram_md5 string&!! "the primary host name"
23910 This string is expanded, and the result used as the user name data when
23911 computing the response to the server's challenge.
23912
23913
23914 .option client_secret cram_md5 string&!! unset
23915 This option must be set for the authenticator to work as a client. Its value is
23916 expanded and the result used as the secret string when computing the response.
23917
23918
23919 .vindex "&$host$&"
23920 .vindex "&$host_address$&"
23921 Different user names and secrets can be used for different servers by referring
23922 to &$host$& or &$host_address$& in the options. Forced failure of either
23923 expansion string is treated as an indication that this authenticator is not
23924 prepared to handle this case. Exim moves on to the next configured client
23925 authenticator. Any other expansion failure causes Exim to give up trying to
23926 send the message to the current server.
23927
23928 A simple example configuration of a &(cram_md5)& authenticator, using fixed
23929 strings, is:
23930 .code
23931 fixed_cram:
23932   driver = cram_md5
23933   public_name = CRAM-MD5
23934   client_name = ph10
23935   client_secret = secret
23936 .endd
23937 .ecindex IIDcramauth1
23938 .ecindex IIDcramauth2
23939
23940
23941
23942 . ////////////////////////////////////////////////////////////////////////////
23943 . ////////////////////////////////////////////////////////////////////////////
23944
23945 .chapter "The cyrus_sasl authenticator" "CHID10"
23946 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
23947 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
23948 .cindex "Cyrus" "SASL library"
23949 .cindex "Kerberos"
23950 The code for this authenticator was provided by Matthew Byng-Maddick of A L
23951 Digital Ltd (&url(http://www.aldigital.co.uk)).
23952
23953 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
23954 library implementation of the RFC 2222 (&"Simple Authentication and Security
23955 Layer"&). This library supports a number of authentication mechanisms,
23956 including PLAIN and LOGIN, but also several others that Exim does not support
23957 directly. In particular, there is support for Kerberos authentication.
23958
23959 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
23960 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
23961 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
23962 name of the driver to determine which mechanism to support.
23963
23964 Where access to some kind of secret file is required, for example in GSSAPI
23965 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
23966 user, and that the Cyrus SASL library has no way of escalating privileges
23967 by default. You may also find you need to set environment variables,
23968 depending on the driver you are using.
23969
23970 The application name provided by Exim is &"exim"&, so various SASL options may
23971 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
23972 Kerberos, note that because of limitations in the GSSAPI interface,
23973 changing the server keytab might need to be communicated down to the Kerberos
23974 layer independently. The mechanism for doing so is dependent upon the Kerberos
23975 implementation. For example, for Heimdal, the environment variable KRB5_KTNAME
23976 may be set to point to an alternative keytab file. Exim will pass this
23977 variable through from its own inherited environment when started as root or the
23978 Exim user. The keytab file needs to be readable by the Exim user.
23979
23980
23981 .section "Using cyrus_sasl as a server" "SECID178"
23982 The &(cyrus_sasl)& authenticator has four private options. It puts the username
23983 (on a successful authentication) into &$auth1$&. For compatibility with
23984 previous releases of Exim, the username is also placed in &$1$&. However, the
23985 use of this variable for this purpose is now deprecated, as it can lead to
23986 confusion in string expansions that also use numeric variables for other
23987 things.
23988
23989
23990 .option server_hostname cyrus_sasl string&!! "see below"
23991 This option selects the hostname that is used when communicating with the
23992 library. The default value is &`$primary_hostname`&. It is up to the underlying
23993 SASL plug-in what it does with this data.
23994
23995
23996 .option server_mech cyrus_sasl string "see below"
23997 This option selects the authentication mechanism this driver should use. The
23998 default is the value of the generic &%public_name%& option. This option allows
23999 you to use a different underlying mechanism from the advertised name. For
24000 example:
24001 .code
24002 sasl:
24003   driver = cyrus_sasl
24004   public_name = X-ANYTHING
24005   server_mech = CRAM-MD5
24006   server_set_id = $auth1
24007 .endd
24008
24009 .option server_realm cyrus_sasl string unset
24010 This specifies the SASL realm that the server claims to be in.
24011
24012
24013 .option server_service cyrus_sasl string &`smtp`&
24014 This is the SASL service that the server claims to implement.
24015
24016
24017 For straightforward cases, you do not need to set any of the authenticator's
24018 private options. All you need to do is to specify an appropriate mechanism as
24019 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
24020 PLAIN, you could have two authenticators as follows:
24021 .code
24022 sasl_cram_md5:
24023   driver = cyrus_sasl
24024   public_name = CRAM-MD5
24025   server_set_id = $auth1
24026
24027 sasl_plain:
24028   driver = cyrus_sasl
24029   public_name = PLAIN
24030   server_set_id = $auth2
24031 .endd
24032 Cyrus SASL does implement the LOGIN authentication method, even though it is
24033 not a standard method. It is disabled by default in the source distribution,
24034 but it is present in many binary distributions.
24035 .ecindex IIDcyrauth1
24036 .ecindex IIDcyrauth2
24037
24038
24039
24040
24041 . ////////////////////////////////////////////////////////////////////////////
24042 . ////////////////////////////////////////////////////////////////////////////
24043 .chapter "The dovecot authenticator" "CHAPdovecot"
24044 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
24045 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
24046 This authenticator is an interface to the authentication facility of the
24047 Dovecot POP/IMAP server, which can support a number of authentication methods.
24048 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
24049 to use the same mechanisms for SMTP authentication. This is a server
24050 authenticator only. There is only one option:
24051
24052 .option server_socket dovecot string unset
24053
24054 This option must specify the socket that is the interface to Dovecot
24055 authentication. The &%public_name%& option must specify an authentication
24056 mechanism that Dovecot is configured to support. You can have several
24057 authenticators for different mechanisms. For example:
24058 .code
24059 dovecot_plain:
24060   driver = dovecot
24061   public_name = PLAIN
24062   server_socket = /var/run/dovecot/auth-client
24063   server_set_id = $auth2
24064
24065 dovecot_ntlm:
24066   driver = dovecot
24067   public_name = NTLM
24068   server_socket = /var/run/dovecot/auth-client
24069   server_set_id = $auth1
24070 .endd
24071 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
24072 &$received_ip_address$& (that is, the connection is local), the &"secured"&
24073 option is passed in the Dovecot authentication command. If, for a TLS
24074 connection, a client certificate has been verified, the &"valid-client-cert"&
24075 option is passed. When authentication succeeds, the identity of the user
24076 who authenticated is placed in &$auth1$&.
24077 .ecindex IIDdcotauth1
24078 .ecindex IIDdcotauth2
24079
24080
24081 . ////////////////////////////////////////////////////////////////////////////
24082 . ////////////////////////////////////////////////////////////////////////////
24083
24084 .chapter "The spa authenticator" "CHAPspa"
24085 .scindex IIDspaauth1 "&(spa)& authenticator"
24086 .scindex IIDspaauth2 "authenticators" "&(spa)&"
24087 .cindex "authentication" "Microsoft Secure Password"
24088 .cindex "authentication" "NTLM"
24089 .cindex "Microsoft Secure Password Authentication"
24090 .cindex "NTLM authentication"
24091 The &(spa)& authenticator provides client support for Microsoft's &'Secure
24092 Password Authentication'& mechanism,
24093 which is also sometimes known as NTLM (NT LanMan). The code for client side of
24094 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
24095 taken from the Samba project (&url(http://www.samba.org)). The code for the
24096 server side was subsequently contributed by Tom Kistner. The mechanism works as
24097 follows:
24098
24099 .ilist
24100 After the AUTH command has been accepted, the client sends an SPA
24101 authentication request based on the user name and optional domain.
24102 .next
24103 The server sends back a challenge.
24104 .next
24105 The client builds a challenge response which makes use of the user's password
24106 and sends it to the server, which then accepts or rejects it.
24107 .endlist
24108
24109 Encryption is used to protect the password in transit.
24110
24111
24112
24113 .section "Using spa as a server" "SECID179"
24114 .cindex "options" "&(spa)& authenticator (server)"
24115 The &(spa)& authenticator has just one server option:
24116
24117 .option server_password spa string&!! unset
24118 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
24119 This option is expanded, and the result must be the cleartext password for the
24120 authenticating user, whose name is at this point in &$auth1$&. For
24121 compatibility with previous releases of Exim, the user name is also placed in
24122 &$1$&. However, the use of this variable for this purpose is now deprecated, as
24123 it can lead to confusion in string expansions that also use numeric variables
24124 for other things. For example:
24125 .code
24126 spa:
24127   driver = spa
24128   public_name = NTLM
24129   server_password = \
24130     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
24131 .endd
24132 If the expansion is forced to fail, authentication fails. Any other expansion
24133 failure causes a temporary error code to be returned.
24134
24135
24136
24137
24138
24139 .section "Using spa as a client" "SECID180"
24140 .cindex "options" "&(spa)& authenticator (client)"
24141 The &(spa)& authenticator has the following client options:
24142
24143
24144
24145 .option client_domain spa string&!! unset
24146 This option specifies an optional domain for the authentication.
24147
24148
24149 .option client_password spa string&!! unset
24150 This option specifies the user's password, and must be set.
24151
24152
24153 .option client_username spa string&!! unset
24154 This option specifies the user name, and must be set. Here is an example of a
24155 configuration of this authenticator for use with the mail servers at
24156 &'msn.com'&:
24157 .code
24158 msn:
24159   driver = spa
24160   public_name = MSN
24161   client_username = msn/msn_username
24162   client_password = msn_plaintext_password
24163   client_domain = DOMAIN_OR_UNSET
24164 .endd
24165 .ecindex IIDspaauth1
24166 .ecindex IIDspaauth2
24167
24168
24169
24170
24171
24172 . ////////////////////////////////////////////////////////////////////////////
24173 . ////////////////////////////////////////////////////////////////////////////
24174
24175 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
24176          "Encrypted SMTP connections"
24177 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
24178 .scindex IIDencsmtp2 "SMTP" "encryption"
24179 .cindex "TLS" "on SMTP connection"
24180 .cindex "OpenSSL"
24181 .cindex "GnuTLS"
24182 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
24183 Sockets Layer), is implemented by making use of the OpenSSL library or the
24184 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
24185 cryptographic code in the Exim distribution itself for implementing TLS. In
24186 order to use this feature you must install OpenSSL or GnuTLS, and then build a
24187 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
24188 You also need to understand the basic concepts of encryption at a managerial
24189 level, and in particular, the way that public keys, private keys, and
24190 certificates are used.
24191
24192 RFC 3207 defines how SMTP connections can make use of encryption. Once a
24193 connection is established, the client issues a STARTTLS command. If the
24194 server accepts this, the client and the server negotiate an encryption
24195 mechanism. If the negotiation succeeds, the data that subsequently passes
24196 between them is encrypted.
24197
24198 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
24199 and if so, what cipher suite is in use, whether the client supplied a
24200 certificate, and whether or not that certificate was verified. This makes it
24201 possible for an Exim server to deny or accept certain commands based on the
24202 encryption state.
24203
24204 &*Warning*&: Certain types of firewall and certain anti-virus products can
24205 disrupt TLS connections. You need to turn off SMTP scanning for these products
24206 in order to get TLS to work.
24207
24208
24209
24210 .section "Support for the legacy &""ssmtp""& (aka &""smtps""&) protocol" &&&
24211          "SECID284"
24212 .cindex "ssmtp protocol"
24213 .cindex "smtps protocol"
24214 .cindex "SMTP" "ssmtp protocol"
24215 .cindex "SMTP" "smtps protocol"
24216 Early implementations of encrypted SMTP used a different TCP port from normal
24217 SMTP, and expected an encryption negotiation to start immediately, instead of
24218 waiting for a STARTTLS command from the client using the standard SMTP
24219 port. The protocol was called &"ssmtp"& or &"smtps"&, and port 465 was
24220 allocated for this purpose.
24221
24222 This approach was abandoned when encrypted SMTP was standardized, but there are
24223 still some legacy clients that use it. Exim supports these clients by means of
24224 the &%tls_on_connect_ports%& global option. Its value must be a list of port
24225 numbers; the most common use is expected to be:
24226 .code
24227 tls_on_connect_ports = 465
24228 .endd
24229 The port numbers specified by this option apply to all SMTP connections, both
24230 via the daemon and via &'inetd'&. You still need to specify all the ports that
24231 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
24232 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
24233 an extra port &-- rather, it specifies different behaviour on a port that is
24234 defined elsewhere.
24235
24236 There is also a &%-tls-on-connect%& command line option. This overrides
24237 &%tls_on_connect_ports%&; it forces the legacy behaviour for all ports.
24238
24239
24240
24241
24242
24243
24244 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
24245 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
24246 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
24247 followed later, when the first versions of GnuTLS were released. To build Exim
24248 to use GnuTLS, you need to set
24249 .code
24250 USE_GNUTLS=yes
24251 .endd
24252 in Local/Makefile, in addition to
24253 .code
24254 SUPPORT_TLS=yes
24255 .endd
24256 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
24257 include files and libraries for GnuTLS can be found.
24258
24259 There are some differences in usage when using GnuTLS instead of OpenSSL:
24260
24261 .ilist
24262 The &%tls_verify_certificates%& option must contain the name of a file, not the
24263 name of a directory (for OpenSSL it can be either).
24264 .next
24265 The &%tls_dhparam%& option is ignored, because early versions of GnuTLS had no
24266 facility for varying its Diffie-Hellman parameters. I understand that this has
24267 changed, but Exim has not been updated to provide this facility.
24268 .next
24269 .vindex "&$tls_peerdn$&"
24270 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
24271 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
24272 affects the value of the &$tls_peerdn$& variable.
24273 .next
24274 OpenSSL identifies cipher suites using hyphens as separators, for example:
24275 DES-CBC3-SHA. GnuTLS uses underscores, for example: RSA_ARCFOUR_SHA. What is
24276 more, OpenSSL complains if underscores are present in a cipher list. To make
24277 life simpler, Exim changes underscores to hyphens for OpenSSL and hyphens to
24278 underscores for GnuTLS when processing lists of cipher suites in the
24279 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
24280 option).
24281 .next
24282 The &%tls_require_ciphers%& options operate differently, as described in the
24283 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
24284 .endlist
24285
24286
24287 .section "GnuTLS parameter computation" "SECID181"
24288 GnuTLS uses D-H parameters that may take a substantial amount of time
24289 to compute. It is unreasonable to re-compute them for every TLS session.
24290 Therefore, Exim keeps this data in a file in its spool directory, called
24291 &_gnutls-params_&. The file is owned by the Exim user and is readable only by
24292 its owner. Every Exim process that start up GnuTLS reads the D-H
24293 parameters from this file. If the file does not exist, the first Exim process
24294 that needs it computes the data and writes it to a temporary file which is
24295 renamed once it is complete. It does not matter if several Exim processes do
24296 this simultaneously (apart from wasting a few resources). Once a file is in
24297 place, new Exim processes immediately start using it.
24298
24299 For maximum security, the parameters that are stored in this file should be
24300 recalculated periodically, the frequency depending on your paranoia level.
24301 Arranging this is easy in principle; just delete the file when you want new
24302 values to be computed. However, there may be a problem. The calculation of new
24303 parameters needs random numbers, and these are obtained from &_/dev/random_&.
24304 If the system is not very active, &_/dev/random_& may delay returning data
24305 until enough randomness (entropy) is available. This may cause Exim to hang for
24306 a substantial amount of time, causing timeouts on incoming connections.
24307
24308 The solution is to generate the parameters externally to Exim. They are stored
24309 in &_gnutls-params_& in PEM format, which means that they can be generated
24310 externally using the &(certtool)& command that is part of GnuTLS.
24311
24312 To replace the parameters with new ones, instead of deleting the file
24313 and letting Exim re-create it, you can generate new parameters using
24314 &(certtool)& and, when this has been done, replace Exim's cache file by
24315 renaming. The relevant commands are something like this:
24316 .code
24317 # rm -f new-params
24318 # touch new-params
24319 # chown exim:exim new-params
24320 # chmod 0400 new-params
24321 # certtool --generate-privkey --bits 512 >new-params
24322 # echo "" >>new-params
24323 # certtool --generate-dh-params --bits 1024 >> new-params
24324 # mv new-params gnutls-params
24325 .endd
24326 If Exim never has to generate the parameters itself, the possibility of
24327 stalling is removed.
24328
24329
24330 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
24331 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
24332 .oindex "&%tls_require_ciphers%&" "OpenSSL"
24333 There is a function in the OpenSSL library that can be passed a list of cipher
24334 suites before the cipher negotiation takes place. This specifies which ciphers
24335 are acceptable. The list is colon separated and may contain names like
24336 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
24337 directly to this function call. The following quotation from the OpenSSL
24338 documentation specifies what forms of item are allowed in the cipher string:
24339
24340 .ilist
24341 It can consist of a single cipher suite such as RC4-SHA.
24342 .next
24343 It can represent a list of cipher suites containing a certain algorithm,
24344 or cipher suites of a certain type. For example SHA1 represents all
24345 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
24346 SSL v3 algorithms.
24347 .next
24348 Lists of cipher suites can be combined in a single cipher string using
24349 the + character. This is used as a logical and operation. For example
24350 SHA1+DES represents all cipher suites containing the SHA1 and the DES
24351 algorithms.
24352 .endlist
24353
24354 Each cipher string can be optionally preceded by one of the characters &`!`&,
24355 &`-`& or &`+`&.
24356 .ilist
24357 If &`!`& is used, the ciphers are permanently deleted from the list. The
24358 ciphers deleted can never reappear in the list even if they are explicitly
24359 stated.
24360 .next
24361 If &`-`& is used, the ciphers are deleted from the list, but some or all
24362 of the ciphers can be added again by later options.
24363 .next
24364 If &`+`& is used, the ciphers are moved to the end of the list. This
24365 option does not add any new ciphers; it just moves matching existing ones.
24366 .endlist
24367
24368 If none of these characters is present, the string is interpreted as
24369 a list of ciphers to be appended to the current preference list. If the list
24370 includes any ciphers already present they will be ignored: that is, they will
24371 not be moved to the end of the list.
24372 .endlist
24373
24374
24375
24376 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
24377          "SECTreqciphgnu"
24378 .cindex "GnuTLS" "specifying parameters for"
24379 .cindex "TLS" "specifying ciphers (GnuTLS)"
24380 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
24381 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
24382 .cindex "TLS" "specifying protocols (GnuTLS)"
24383 .oindex "&%tls_require_ciphers%&" "GnuTLS"
24384 The GnuTLS library allows the caller to specify separate lists of permitted key
24385 exchange methods, main cipher algorithms, MAC algorithms, and protocols.
24386 Unfortunately, these lists are numerical, and the library does not have a
24387 function for turning names into numbers. Consequently, lists of recognized
24388 names have to be built into the application. The permitted key exchange
24389 methods, ciphers, and MAC algorithms may be used in any combination to form a
24390 cipher suite. This is unlike OpenSSL, where complete cipher suite names are
24391 passed to its control function.
24392
24393 For compatibility with OpenSSL, the &%tls_require_ciphers%& option can be set
24394 to complete cipher suite names such as RSA_ARCFOUR_SHA, but for GnuTLS this
24395 option controls only the cipher algorithms. Exim searches each item in the
24396 list for the name of an available algorithm. For example, if the list
24397 contains RSA_AES_SHA, then AES is recognized, and the behaviour is exactly
24398 the same as if just AES were given.
24399
24400 .oindex "&%gnutls_require_kx%&"
24401 .oindex "&%gnutls_require_mac%&"
24402 .oindex "&%gnutls_require_protocols%&"
24403 There are additional options called &%gnutls_require_kx%&,
24404 &%gnutls_require_mac%&, and &%gnutls_require_protocols%& that can be used to
24405 restrict the key exchange methods, MAC algorithms, and protocols, respectively.
24406 These options are ignored if OpenSSL is in use.
24407
24408 All four options are available as global options, controlling how Exim
24409 behaves as a server, and also as options of the &(smtp)& transport, controlling
24410 how Exim behaves as a client. All the values are string expanded. After
24411 expansion, the values must be colon-separated lists, though the separator
24412 can be changed in the usual way.
24413
24414 Each of the four lists starts out with a default set of algorithms. If the
24415 first item in a list does &'not'& start with an exclamation mark, all the
24416 default items are deleted. In this case, only those that are explicitly
24417 specified can be used. If the first item in a list &'does'& start with an
24418 exclamation mark, the defaults are left on the list.
24419
24420 Then, any item that starts with an exclamation mark causes the relevant
24421 entry to be removed from the list, and any item that does not start with an
24422 exclamation mark causes a new entry to be added to the list. Unrecognized
24423 items in the list are ignored. Thus:
24424 .code
24425 tls_require_ciphers = !ARCFOUR
24426 .endd
24427 allows all the defaults except ARCFOUR, whereas
24428 .code
24429 tls_require_ciphers = AES : 3DES
24430 .endd
24431 allows only cipher suites that use AES or 3DES.
24432
24433 For &%tls_require_ciphers%& the recognized names are AES_256, AES_128, AES
24434 (both of the preceding), 3DES, ARCFOUR_128, ARCFOUR_40, and ARCFOUR (both of
24435 the preceding). The default list does not contain all of these; it just has
24436 AES_256, AES_128, 3DES, and ARCFOUR_128.
24437
24438 For &%gnutls_require_kx%&, the recognized names are DHE_RSA, RSA (which
24439 includes DHE_RSA), DHE_DSS, and DHE (which includes both DHE_RSA and
24440 DHE_DSS). The default list contains RSA, DHE_DSS, DHE_RSA.
24441
24442 For &%gnutls_require_mac%&, the recognized names are SHA (synonym SHA1), and
24443 MD5. The default list contains SHA, MD5.
24444
24445 For &%gnutls_require_protocols%&, the recognized names are TLS1 and SSL3.
24446 The default list contains TLS1, SSL3.
24447
24448 In a server, the order of items in these lists is unimportant. The server
24449 advertises the availability of all the relevant cipher suites. However, in a
24450 client, the order in the &%tls_require_ciphers%& list specifies a preference
24451 order for the cipher algorithms. The first one in the client's list that is
24452 also advertised by the server is tried first. The default order is as listed
24453 above.
24454
24455
24456
24457 .section "Configuring an Exim server to use TLS" "SECID182"
24458 .cindex "TLS" "configuring an Exim server"
24459 When Exim has been built with TLS support, it advertises the availability of
24460 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
24461 but not to any others. The default value of this option is unset, which means
24462 that STARTTLS is not advertised at all. This default is chosen because you
24463 need to set some other options in order to make TLS available, and also it is
24464 sensible for systems that want to use TLS only as a client.
24465
24466 If a client issues a STARTTLS command and there is some configuration
24467 problem in the server, the command is rejected with a 454 error. If the client
24468 persists in trying to issue SMTP commands, all except QUIT are rejected
24469 with the error
24470 .code
24471 554 Security failure
24472 .endd
24473 If a STARTTLS command is issued within an existing TLS session, it is
24474 rejected with a 554 error code.
24475
24476 To enable TLS operations on a server, you must set &%tls_advertise_hosts%& to
24477 match some hosts. You can, of course, set it to * to match all hosts.
24478 However, this is not all you need to do. TLS sessions to a server won't work
24479 without some further configuration at the server end.
24480
24481 It is rumoured that all existing clients that support TLS/SSL use RSA
24482 encryption. To make this work you need to set, in the server,
24483 .code
24484 tls_certificate = /some/file/name
24485 tls_privatekey = /some/file/name
24486 .endd
24487 These options are, in fact, expanded strings, so you can make them depend on
24488 the identity of the client that is connected if you wish. The first file
24489 contains the server's X509 certificate, and the second contains the private key
24490 that goes with it. These files need to be readable by the Exim user, and must
24491 always be given as full path names. They can be the same file if both the
24492 certificate and the key are contained within it. If &%tls_privatekey%& is not
24493 set, or if its expansion is forced to fail or results in an empty string, this
24494 is assumed to be the case. The certificate file may also contain intermediate
24495 certificates that need to be sent to the client to enable it to authenticate
24496 the server's certificate.
24497
24498 If you do not understand about certificates and keys, please try to find a
24499 source of this background information, which is not Exim-specific. (There are a
24500 few comments below in section &<<SECTcerandall>>&.)
24501
24502 &*Note*&: These options do not apply when Exim is operating as a client &--
24503 they apply only in the case of a server. If you need to use a certificate in an
24504 Exim client, you must set the options of the same names in an &(smtp)&
24505 transport.
24506
24507 With just these options, an Exim server will be able to use TLS. It does not
24508 require the client to have a certificate (but see below for how to insist on
24509 this). There is one other option that may be needed in other situations. If
24510 .code
24511 tls_dhparam = /some/file/name
24512 .endd
24513 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
24514 with the parameters contained in the file. This increases the set of cipher
24515 suites that the server supports. See the command
24516 .code
24517 openssl dhparam
24518 .endd
24519 for a way of generating this data. At present, &%tls_dhparam%& is used only
24520 when Exim is linked with OpenSSL. It is ignored if GnuTLS is being used.
24521
24522 The strings supplied for these three options are expanded every time a client
24523 host connects. It is therefore possible to use different certificates and keys
24524 for different hosts, if you so wish, by making use of the client's IP address
24525 in &$sender_host_address$& to control the expansion. If a string expansion is
24526 forced to fail, Exim behaves as if the option is not set.
24527
24528 .cindex "cipher" "logging"
24529 .cindex "log" "TLS cipher"
24530 .vindex "&$tls_cipher$&"
24531 The variable &$tls_cipher$& is set to the cipher suite that was negotiated for
24532 an incoming TLS connection. It is included in the &'Received:'& header of an
24533 incoming message (by default &-- you can, of course, change this), and it is
24534 also included in the log line that records a message's arrival, keyed by
24535 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
24536 condition can be used to test for specific cipher suites in ACLs.
24537 (For outgoing SMTP deliveries, &$tls_cipher$& is reset &-- see section
24538 &<<SECID185>>&.)
24539
24540 Once TLS has been established, the ACLs that run for subsequent SMTP commands
24541 can check the name of the cipher suite and vary their actions accordingly. The
24542 cipher suite names vary, depending on which TLS library is being used. For
24543 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
24544 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
24545 documentation for more details.
24546
24547
24548 .section "Requesting and verifying client certificates" "SECID183"
24549 .cindex "certificate" "verification of client"
24550 .cindex "TLS" "client certificate verification"
24551 If you want an Exim server to request a certificate when negotiating a TLS
24552 session with a client, you must set either &%tls_verify_hosts%& or
24553 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
24554 apply to all TLS connections. For any host that matches one of these options,
24555 Exim requests a certificate as part of the setup of the TLS session. The
24556 contents of the certificate are verified by comparing it with a list of
24557 expected certificates. These must be available in a file or,
24558 for OpenSSL only (not GnuTLS), a directory, identified by
24559 &%tls_verify_certificates%&.
24560
24561 A file can contain multiple certificates, concatenated end to end. If a
24562 directory is used
24563 (OpenSSL only),
24564 each certificate must be in a separate file, with a name (or a symbolic link)
24565 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
24566 certificate. You can compute the relevant hash by running the command
24567 .code
24568 openssl x509 -hash -noout -in /cert/file
24569 .endd
24570 where &_/cert/file_& contains a single certificate.
24571
24572 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
24573 what happens if the client does not supply a certificate, or if the certificate
24574 does not match any of the certificates in the collection named by
24575 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
24576 attempt to set up a TLS session is aborted, and the incoming connection is
24577 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
24578 session continues. ACLs that run for subsequent SMTP commands can detect the
24579 fact that no certificate was verified, and vary their actions accordingly. For
24580 example, you can insist on a certificate before accepting a message for
24581 relaying, but not when the message is destined for local delivery.
24582
24583 .vindex "&$tls_peerdn$&"
24584 When a client supplies a certificate (whether it verifies or not), the value of
24585 the Distinguished Name of the certificate is made available in the variable
24586 &$tls_peerdn$& during subsequent processing of the message.
24587
24588 .cindex "log" "distinguished name"
24589 Because it is often a long text string, it is not included in the log line or
24590 &'Received:'& header by default. You can arrange for it to be logged, keyed by
24591 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
24592 &%received_header_text%& to change the &'Received:'& header. When no
24593 certificate is supplied, &$tls_peerdn$& is empty.
24594
24595
24596 .section "Revoked certificates" "SECID184"
24597 .cindex "TLS" "revoked certificates"
24598 .cindex "revocation list"
24599 .cindex "certificate" "revocation list"
24600 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
24601 certificates are revoked. If you have such a list, you can pass it to an Exim
24602 server using the global option called &%tls_crl%& and to an Exim client using
24603 an identically named option for the &(smtp)& transport. In each case, the value
24604 of the option is expanded and must then be the name of a file that contains a
24605 CRL in PEM format.
24606
24607
24608 .section "Configuring an Exim client to use TLS" "SECID185"
24609 .cindex "cipher" "logging"
24610 .cindex "log" "TLS cipher"
24611 .cindex "log" "distinguished name"
24612 .cindex "TLS" "configuring an Exim client"
24613 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
24614 deliveries as well as to incoming, the latter one causing logging of the
24615 server certificate's DN. The remaining client configuration for TLS is all
24616 within the &(smtp)& transport.
24617
24618 It is not necessary to set any options to have TLS work in the &(smtp)&
24619 transport. If Exim is built with TLS support, and TLS is advertised by a
24620 server, the &(smtp)& transport always tries to start a TLS session. However,
24621 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
24622 transport) to a list of server hosts for which TLS should not be used.
24623
24624 If you do not want Exim to attempt to send messages unencrypted when an attempt
24625 to set up an encrypted connection fails in any way, you can set
24626 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
24627 those hosts, delivery is always deferred if an encrypted connection cannot be
24628 set up. If there are any other hosts for the address, they are tried in the
24629 usual way.
24630
24631 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
24632 the message unencrypted. It always does this if the response to STARTTLS is
24633 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
24634 session after a success response code, what happens is controlled by the
24635 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
24636 delivery to this host is deferred, and other hosts (if available) are tried. If
24637 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
24638 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
24639 negotiation fails, Exim closes the current connection (because it is in an
24640 unknown state), opens a new one to the same host, and then tries the delivery
24641 unencrypted.
24642
24643 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
24644 transport provide the client with a certificate, which is passed to the server
24645 if it requests it. If the server is Exim, it will request a certificate only if
24646 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
24647
24648 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
24649 must name a file or,
24650 for OpenSSL only (not GnuTLS), a directory, that contains a collection of
24651 expected server certificates. The client verifies the server's certificate
24652 against this collection, taking into account any revoked certificates that are
24653 in the list defined by &%tls_crl%&.
24654
24655 If
24656 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
24657 list of permitted cipher suites. If either of these checks fails, delivery to
24658 the current host is abandoned, and the &(smtp)& transport tries to deliver to
24659 alternative hosts, if any.
24660
24661  &*Note*&:
24662 These options must be set in the &(smtp)& transport for Exim to use TLS when it
24663 is operating as a client. Exim does not assume that a server certificate (set
24664 by the global options of the same name) should also be used when operating as a
24665 client.
24666
24667 .vindex "&$host$&"
24668 .vindex "&$host_address$&"
24669 All the TLS options in the &(smtp)& transport are expanded before use, with
24670 &$host$& and &$host_address$& containing the name and address of the server to
24671 which the client is connected. Forced failure of an expansion causes Exim to
24672 behave as if the relevant option were unset.
24673
24674 .vindex &$tls_cipher$&
24675 .vindex &$tls_peerdn$&
24676 Before an SMTP connection is established, the &$tls_cipher$& and &$tls_peerdn$&
24677 variables are emptied. (Until the first connection, they contain the values
24678 that were set when the message was received.) If STARTTLS is subsequently
24679 successfully obeyed, these variables are set to the relevant values for the
24680 outgoing connection.
24681
24682
24683
24684 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
24685          "SECTmulmessam"
24686 .cindex "multiple SMTP deliveries with TLS"
24687 .cindex "TLS" "multiple message deliveries"
24688 Exim sends multiple messages down the same TCP/IP connection by starting up
24689 an entirely new delivery process for each message, passing the socket from
24690 one process to the next. This implementation does not fit well with the use
24691 of TLS, because there is quite a lot of state information associated with a TLS
24692 connection, not just a socket identification. Passing all the state information
24693 to a new process is not feasible. Consequently, Exim shuts down an existing TLS
24694 session before passing the socket to a new process. The new process may then
24695 try to start a new TLS session, and if successful, may try to re-authenticate
24696 if AUTH is in use, before sending the next message.
24697
24698 The RFC is not clear as to whether or not an SMTP session continues in clear
24699 after TLS has been shut down, or whether TLS may be restarted again later, as
24700 just described. However, if the server is Exim, this shutdown and
24701 reinitialization works. It is not known which (if any) other servers operate
24702 successfully if the client closes a TLS session and continues with unencrypted
24703 SMTP, but there are certainly some that do not work. For such servers, Exim
24704 should not pass the socket to another process, because the failure of the
24705 subsequent attempt to use it would cause Exim to record a temporary host error,
24706 and delay other deliveries to that host.
24707
24708 To test for this case, Exim sends an EHLO command to the server after
24709 closing down the TLS session. If this fails in any way, the connection is
24710 closed instead of being passed to a new delivery process, but no retry
24711 information is recorded.
24712
24713 There is also a manual override; you can set &%hosts_nopass_tls%& on the
24714 &(smtp)& transport to match those hosts for which Exim should not pass
24715 connections to new processes if TLS has been used.
24716
24717
24718
24719
24720 .section "Certificates and all that" "SECTcerandall"
24721 .cindex "certificate" "references to discussion"
24722 In order to understand fully how TLS works, you need to know about
24723 certificates, certificate signing, and certificate authorities. This is not the
24724 place to give a tutorial, especially as I do not know very much about it
24725 myself. Some helpful introduction can be found in the FAQ for the SSL addition
24726 to Apache, currently at
24727 .display
24728 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
24729 .endd
24730 Other parts of the &'modssl'& documentation are also helpful, and have
24731 links to further files.
24732 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
24733 0-201-61598-3), contains both introductory and more in-depth descriptions.
24734 Some sample programs taken from the book are available from
24735 .display
24736 &url(http://www.rtfm.com/openssl-examples/)
24737 .endd
24738
24739
24740 .section "Certificate chains" "SECID186"
24741 The file named by &%tls_certificate%& may contain more than one
24742 certificate. This is useful in the case where the certificate that is being
24743 sent is validated by an intermediate certificate which the other end does
24744 not have. Multiple certificates must be in the correct order in the file.
24745 First the host's certificate itself, then the first intermediate
24746 certificate to validate the issuer of the host certificate, then the next
24747 intermediate certificate to validate the issuer of the first intermediate
24748 certificate, and so on, until finally (optionally) the root certificate.
24749 The root certificate must already be trusted by the recipient for
24750 validation to succeed, of course, but if it's not preinstalled, sending the
24751 root certificate along with the rest makes it available for the user to
24752 install if the receiving end is a client MUA that can interact with a user.
24753
24754
24755 .section "Self-signed certificates" "SECID187"
24756 .cindex "certificate" "self-signed"
24757 You can create a self-signed certificate using the &'req'& command provided
24758 with OpenSSL, like this:
24759 .code
24760 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
24761             -days 9999 -nodes
24762 .endd
24763 &_file1_& and &_file2_& can be the same file; the key and the certificate are
24764 delimited and so can be identified independently. The &%-days%& option
24765 specifies a period for which the certificate is valid. The &%-nodes%& option is
24766 important: if you do not set it, the key is encrypted with a passphrase
24767 that you are prompted for, and any use that is made of the key causes more
24768 prompting for the passphrase. This is not helpful if you are going to use
24769 this certificate and key in an MTA, where prompting is not possible.
24770
24771 A self-signed certificate made in this way is sufficient for testing, and
24772 may be adequate for all your requirements if you are mainly interested in
24773 encrypting transfers, and not in secure identification.
24774
24775 However, many clients require that the certificate presented by the server be a
24776 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
24777 certificate. In this situation, the self-signed certificate described above
24778 must be installed on the client host as a trusted root &'certification
24779 authority'& (CA), and the certificate used by Exim must be a user certificate
24780 signed with that self-signed certificate.
24781
24782 For information on creating self-signed CA certificates and using them to sign
24783 user certificates, see the &'General implementation overview'& chapter of the
24784 Open-source PKI book, available online at
24785 &url(http://ospkibook.sourceforge.net/).
24786 .ecindex IIDencsmtp1
24787 .ecindex IIDencsmtp2
24788
24789
24790
24791 . ////////////////////////////////////////////////////////////////////////////
24792 . ////////////////////////////////////////////////////////////////////////////
24793
24794 .chapter "Access control lists" "CHAPACL"
24795 .scindex IIDacl "&ACL;" "description"
24796 .cindex "control of incoming mail"
24797 .cindex "message" "controlling incoming"
24798 .cindex "policy control" "access control lists"
24799 Access Control Lists (ACLs) are defined in a separate section of the run time
24800 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
24801 name, terminated by a colon. Here is a complete ACL section that contains just
24802 one very small ACL:
24803 .code
24804 begin acl
24805 small_acl:
24806   accept   hosts = one.host.only
24807 .endd
24808 You can have as many lists as you like in the ACL section, and the order in
24809 which they appear does not matter. The lists are self-terminating.
24810
24811 The majority of ACLs are used to control Exim's behaviour when it receives
24812 certain SMTP commands. This applies both to incoming TCP/IP connections, and
24813 when a local process submits a message using SMTP by specifying the &%-bs%&
24814 option. The most common use is for controlling which recipients are accepted
24815 in incoming messages. In addition, you can define an ACL that is used to check
24816 local non-SMTP messages. The default configuration file contains an example of
24817 a realistic ACL for checking RCPT commands. This is discussed in chapter
24818 &<<CHAPdefconfil>>&.
24819
24820
24821 .section "Testing ACLs" "SECID188"
24822 The &%-bh%& command line option provides a way of testing your ACL
24823 configuration locally by running a fake SMTP session with which you interact.
24824 The host &'relay-test.mail-abuse.org'& provides a service for checking your
24825 relaying configuration (see section &<<SECTcheralcon>>& for more details).
24826
24827
24828
24829 .section "Specifying when ACLs are used" "SECID189"
24830 .cindex "&ACL;" "options for specifying"
24831 In order to cause an ACL to be used, you have to name it in one of the relevant
24832 options in the main part of the configuration. These options are:
24833 .cindex "AUTH" "ACL for"
24834 .cindex "DATA" "ACLs for"
24835 .cindex "ETRN" "ACL for"
24836 .cindex "EXPN" "ACL for"
24837 .cindex "HELO" "ACL for"
24838 .cindex "EHLO" "ACL for"
24839 .cindex "MAIL" "ACL for"
24840 .cindex "QUIT, ACL for"
24841 .cindex "RCPT" "ACL for"
24842 .cindex "STARTTLS, ACL for"
24843 .cindex "VRFY" "ACL for"
24844 .cindex "SMTP" "connection, ACL for"
24845 .cindex "non-SMTP messages" "ACLs for"
24846 .cindex "MIME content scanning" "ACL for"
24847
24848 .table2 140pt
24849 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
24850 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
24851 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
24852 .irow &%acl_smtp_auth%&        "ACL for AUTH"
24853 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
24854 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
24855 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
24856 .irow &%acl_smtp_expn%&        "ACL for EXPN"
24857 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
24858 .irow &%acl_smtp_mail%&        "ACL for MAIL"
24859 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
24860 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
24861 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
24862 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
24863 .irow &%acl_smtp_quit%&        "ACL for QUIT"
24864 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
24865 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
24866 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
24867 .endtable
24868
24869 For example, if you set
24870 .code
24871 acl_smtp_rcpt = small_acl
24872 .endd
24873 the little ACL defined above is used whenever Exim receives a RCPT command
24874 in an SMTP dialogue. The majority of policy tests on incoming messages can be
24875 done when RCPT commands arrive. A rejection of RCPT should cause the
24876 sending MTA to give up on the recipient address contained in the RCPT
24877 command, whereas rejection at other times may cause the client MTA to keep on
24878 trying to deliver the message. It is therefore recommended that you do as much
24879 testing as possible at RCPT time.
24880
24881
24882 .section "The non-SMTP ACLs" "SECID190"
24883 .cindex "non-SMTP messages" "ACLs for"
24884 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
24885 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
24886 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
24887 the state of the SMTP connection such as encryption and authentication) are not
24888 relevant and are forbidden in these ACLs. However, the sender and recipients
24889 are known, so the &%senders%& and &%sender_domains%& conditions and the
24890 &$sender_address$& and &$recipients$& variables can be used. Variables such as
24891 &$authenticated_sender$& are also available. You can specify added header lines
24892 in any of these ACLs.
24893
24894 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
24895 non-SMTP message, before any of the message has been read. (This is the
24896 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
24897 batched SMTP input, it runs after the DATA command has been reached. The
24898 result of this ACL is ignored; it cannot be used to reject a message. If you
24899 really need to, you could set a value in an ACL variable here and reject based
24900 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
24901 controls, and in particular, it can be used to set
24902 .code
24903 control = suppress_local_fixups
24904 .endd
24905 This cannot be used in the other non-SMTP ACLs because by the time they are
24906 run, it is too late.
24907
24908 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
24909 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
24910
24911 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
24912 kind of rejection is treated as permanent, because there is no way of sending a
24913 temporary error for these kinds of message.
24914
24915
24916 .section "The SMTP connect ACL" "SECID191"
24917 .cindex "SMTP" "connection, ACL for"
24918 .oindex &%smtp_banner%&
24919 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
24920 session, after the test specified by &%host_reject_connection%& (which is now
24921 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
24922 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
24923 the message override the banner message that is otherwise specified by the
24924 &%smtp_banner%& option.
24925
24926
24927 .section "The EHLO/HELO ACL" "SECID192"
24928 .cindex "EHLO" "ACL for"
24929 .cindex "HELO" "ACL for"
24930 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
24931 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
24932 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
24933 Note that a client may issue more than one EHLO or HELO command in an SMTP
24934 session, and indeed is required to issue a new EHLO or HELO after successfully
24935 setting up encryption following a STARTTLS command.
24936
24937 If the command is accepted by an &%accept%& verb that has a &%message%&
24938 modifier, the message may not contain more than one line (it will be truncated
24939 at the first newline and a panic logged if it does). Such a message cannot
24940 affect the EHLO options that are listed on the second and subsequent lines of
24941 an EHLO response.
24942
24943
24944 .section "The DATA ACLs" "SECID193"
24945 .cindex "DATA" "ACLs for"
24946 Two ACLs are associated with the DATA command, because it is two-stage
24947 command, with two responses being sent to the client.
24948 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
24949 is obeyed. This gives you control after all the RCPT commands, but before
24950 the message itself is received. It offers the opportunity to give a negative
24951 response to the DATA command before the data is transmitted. Header lines
24952 added by MAIL or RCPT ACLs are not visible at this time, but any that
24953 are defined here are visible when the &%acl_smtp_data%& ACL is run.
24954
24955 You cannot test the contents of the message, for example, to verify addresses
24956 in the headers, at RCPT time or when the DATA command is received. Such
24957 tests have to appear in the ACL that is run after the message itself has been
24958 received, before the final response to the DATA command is sent. This is
24959 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
24960 associated with the DATA command.
24961
24962 For both of these ACLs, it is not possible to reject individual recipients. An
24963 error response rejects the entire message. Unfortunately, it is known that some
24964 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
24965 before or after the data) correctly &-- they keep the message on their queues
24966 and try again later, but that is their problem, though it does waste some of
24967 your resources.
24968
24969
24970 .section "The SMTP MIME ACL" "SECID194"
24971 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
24972 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
24973
24974
24975 .section "The QUIT ACL" "SECTQUITACL"
24976 .cindex "QUIT, ACL for"
24977 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
24978 does not affect the response code to QUIT, which is always 221. Thus, the ACL
24979 does not in fact control any access. For this reason, the only verbs that are
24980 permitted are &%accept%& and &%warn%&.
24981
24982 This ACL can be used for tasks such as custom logging at the end of an SMTP
24983 session. For example, you can use ACL variables in other ACLs to count
24984 messages, recipients, etc., and log the totals at QUIT time using one or
24985 more &%logwrite%& modifiers on a &%warn%& verb.
24986
24987 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
24988 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
24989
24990 You do not need to have a final &%accept%&, but if you do, you can use a
24991 &%message%& modifier to specify custom text that is sent as part of the 221
24992 response to QUIT.
24993
24994 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
24995 failure (for example, failure to open a log file, or when Exim is bombing out
24996 because it has detected an unrecoverable error), all SMTP commands from the
24997 client are given temporary error responses until QUIT is received or the
24998 connection is closed. In these special cases, the QUIT ACL does not run.
24999
25000
25001 .section "The not-QUIT ACL" "SECTNOTQUITACL"
25002 .vindex &$acl_smtp_notquit$&
25003 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
25004 an SMTP session ends without sending QUIT. However, when Exim itself is is bad
25005 trouble, such as being unable to write to its log files, this ACL is not run,
25006 because it might try to do things (such as write to log files) that make the
25007 situation even worse.
25008
25009 Like the QUIT ACL, this ACL is provided to make it possible to do customized
25010 logging or to gather statistics, and its outcome is ignored. The &%delay%&
25011 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
25012 and &%warn%&.
25013
25014 .vindex &$smtp_notquit_reason$&
25015 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
25016 to a string that indicates the reason for the termination of the SMTP
25017 connection. The possible values are:
25018 .table2
25019 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
25020 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
25021 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
25022 .irow &`connection-lost`&          "The SMTP connection has been lost"
25023 .irow &`data-timeout`&             "Timeout while reading message data"
25024 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
25025 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
25026 .irow &`signal-exit`&              "SIGTERM or SIGINT"
25027 .irow &`synchronization-error`&    "SMTP synchronization error"
25028 .irow &`tls-failed`&               "TLS failed to start"
25029 .endtable
25030 In most cases when an SMTP connection is closed without having received QUIT,
25031 Exim sends an SMTP response message before actually closing the connection.
25032 With the exception of the &`acl-drop`& case, the default message can be
25033 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
25034 &%drop%& verb in another ACL, it is the message from the other ACL that is
25035 used.
25036
25037
25038 .section "Finding an ACL to use" "SECID195"
25039 .cindex "&ACL;" "finding which to use"
25040 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
25041 you can use different ACLs in different circumstances. For example,
25042 .code
25043 acl_smtp_rcpt = ${if ={25}{$interface_port} \
25044                      {acl_check_rcpt} {acl_check_rcpt_submit} }
25045 .endd
25046 In the default configuration file there are some example settings for
25047 providing an RFC 4409 message submission service on port 587 and a
25048 non-standard &"smtps"& service on port 465. You can use a string
25049 expansion like this to choose an ACL for MUAs on these ports which is
25050 more appropriate for this purpose than the default ACL on port 25.
25051
25052 The expanded string does not have to be the name of an ACL in the
25053 configuration file; there are other possibilities. Having expanded the
25054 string, Exim searches for an ACL as follows:
25055
25056 .ilist
25057 If the string begins with a slash, Exim uses it as a file name, and reads its
25058 contents as an ACL. The lines are processed in the same way as lines in the
25059 Exim configuration file. In particular, continuation lines are supported, blank
25060 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
25061 If the file does not exist or cannot be read, an error occurs (typically
25062 causing a temporary failure of whatever caused the ACL to be run). For example:
25063 .code
25064 acl_smtp_data = /etc/acls/\
25065   ${lookup{$sender_host_address}lsearch\
25066   {/etc/acllist}{$value}{default}}
25067 .endd
25068 This looks up an ACL file to use on the basis of the host's IP address, falling
25069 back to a default if the lookup fails. If an ACL is successfully read from a
25070 file, it is retained in memory for the duration of the Exim process, so that it
25071 can be re-used without having to re-read the file.
25072 .next
25073 If the string does not start with a slash, and does not contain any spaces,
25074 Exim searches the ACL section of the configuration for an ACL whose name
25075 matches the string.
25076 .next
25077 If no named ACL is found, or if the string contains spaces, Exim parses
25078 the string as an inline ACL. This can save typing in cases where you just
25079 want to have something like
25080 .code
25081 acl_smtp_vrfy = accept
25082 .endd
25083 in order to allow free use of the VRFY command. Such a string may contain
25084 newlines; it is processed in the same way as an ACL that is read from a file.
25085 .endlist
25086
25087
25088
25089
25090 .section "ACL return codes" "SECID196"
25091 .cindex "&ACL;" "return codes"
25092 Except for the QUIT ACL, which does not affect the SMTP return code (see
25093 section &<<SECTQUITACL>>& above), the result of running an ACL is either
25094 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
25095 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
25096 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
25097 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
25098 This also causes a 4&'xx'& return code.
25099
25100 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
25101 &"deny"&, because there is no mechanism for passing temporary errors to the
25102 submitters of non-SMTP messages.
25103
25104
25105 ACLs that are relevant to message reception may also return &"discard"&. This
25106 has the effect of &"accept"&, but causes either the entire message or an
25107 individual recipient address to be discarded. In other words, it is a
25108 blackholing facility. Use it with care.
25109
25110 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
25111 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
25112 RCPT ACL is to discard just the one recipient address. If there are no
25113 recipients left when the message's data is received, the DATA ACL is not
25114 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
25115 remaining recipients. The &"discard"& return is not permitted for the
25116 &%acl_smtp_predata%& ACL.
25117
25118
25119 .cindex "&[local_scan()]& function" "when all recipients discarded"
25120 The &[local_scan()]& function is always run, even if there are no remaining
25121 recipients; it may create new recipients.
25122
25123
25124
25125 .section "Unset ACL options" "SECID197"
25126 .cindex "&ACL;" "unset options"
25127 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
25128 all the same. &*Note*&: These defaults apply only when the relevant ACL is
25129 not defined at all. For any defined ACL, the default action when control
25130 reaches the end of the ACL statements is &"deny"&.
25131
25132 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
25133 these two are ACLs that are used only for their side effects. They cannot be
25134 used to accept or reject anything.
25135
25136 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
25137 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
25138 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
25139 when the ACL is not defined is &"accept"&.
25140
25141 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
25142 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
25143 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
25144 messages over an SMTP connection. For an example, see the ACL in the default
25145 configuration file.
25146
25147
25148
25149
25150 .section "Data for message ACLs" "SECID198"
25151 .cindex "&ACL;" "data for message ACL"
25152 .vindex &$domain$&
25153 .vindex &$local_part$&
25154 .vindex &$sender_address$&
25155 .vindex &$sender_host_address$&
25156 .vindex &$smtp_command$&
25157 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
25158 that contain information about the host and the message's sender (for example,
25159 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
25160 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
25161 &$local_part$& are set from the argument address. The entire SMTP command
25162 is available in &$smtp_command$&.
25163
25164 When an ACL for the AUTH parameter of MAIL is running, the variables that
25165 contain information about the host are set, but &$sender_address$& is not yet
25166 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
25167 how it is used.
25168
25169 .vindex "&$message_size$&"
25170 The &$message_size$& variable is set to the value of the SIZE parameter on
25171 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
25172 that parameter is not given. The value is updated to the true message size by
25173 the time the final DATA ACL is run (after the message data has been
25174 received).
25175
25176 .vindex "&$rcpt_count$&"
25177 .vindex "&$recipients_count$&"
25178 The &$rcpt_count$& variable increases by one for each RCPT command received.
25179 The &$recipients_count$& variable increases by one each time a RCPT command is
25180 accepted, so while an ACL for RCPT is being processed, it contains the number
25181 of previously accepted recipients. At DATA time (for both the DATA ACLs),
25182 &$rcpt_count$& contains the total number of RCPT commands, and
25183 &$recipients_count$& contains the total number of accepted recipients.
25184
25185
25186
25187
25188
25189 .section "Data for non-message ACLs" "SECTdatfornon"
25190 .cindex "&ACL;" "data for non-message ACL"
25191 .vindex &$smtp_command_argument$&
25192 .vindex &$smtp_command$&
25193 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
25194 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
25195 and the entire SMTP command is available in &$smtp_command$&.
25196 These variables can be tested using a &%condition%& condition. For example,
25197 here is an ACL for use with AUTH, which insists that either the session is
25198 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
25199 does not permit authentication methods that use cleartext passwords on
25200 unencrypted connections.
25201 .code
25202 acl_check_auth:
25203   accept encrypted = *
25204   accept condition = ${if eq{${uc:$smtp_command_argument}}\
25205                      {CRAM-MD5}}
25206   deny   message   = TLS encryption or CRAM-MD5 required
25207 .endd
25208 (Another way of applying this restriction is to arrange for the authenticators
25209 that use cleartext passwords not to be advertised when the connection is not
25210 encrypted. You can use the generic &%server_advertise_condition%& authenticator
25211 option to do this.)
25212
25213
25214
25215 .section "Format of an ACL" "SECID199"
25216 .cindex "&ACL;" "format of"
25217 .cindex "&ACL;" "verbs, definition of"
25218 An individual ACL consists of a number of statements. Each statement starts
25219 with a verb, optionally followed by a number of conditions and &"modifiers"&.
25220 Modifiers can change the way the verb operates, define error and log messages,
25221 set variables, insert delays, and vary the processing of accepted messages.
25222
25223 If all the conditions are met, the verb is obeyed. The same condition may be
25224 used (with different arguments) more than once in the same statement. This
25225 provides a means of specifying an &"and"& conjunction between conditions. For
25226 example:
25227 .code
25228 deny  dnslists = list1.example
25229 dnslists = list2.example
25230 .endd
25231 If there are no conditions, the verb is always obeyed. Exim stops evaluating
25232 the conditions and modifiers when it reaches a condition that fails. What
25233 happens then depends on the verb (and in one case, on a special modifier). Not
25234 all the conditions make sense at every testing point. For example, you cannot
25235 test a sender address in the ACL that is run for a VRFY command.
25236
25237
25238 .section "ACL verbs" "SECID200"
25239 The ACL verbs are as follows:
25240
25241 .ilist
25242 .cindex "&%accept%& ACL verb"
25243 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
25244 of the conditions are not met, what happens depends on whether &%endpass%&
25245 appears among the conditions (for syntax see below). If the failing condition
25246 is before &%endpass%&, control is passed to the next ACL statement; if it is
25247 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
25248 check a RCPT command:
25249 .code
25250 accept domains = +local_domains
25251 endpass
25252 verify = recipient
25253 .endd
25254 If the recipient domain does not match the &%domains%& condition, control
25255 passes to the next statement. If it does match, the recipient is verified, and
25256 the command is accepted if verification succeeds. However, if verification
25257 fails, the ACL yields &"deny"&, because the failing condition is after
25258 &%endpass%&.
25259
25260 The &%endpass%& feature has turned out to be confusing to many people, so its
25261 use is not recommended nowadays. It is always possible to rewrite an ACL so
25262 that &%endpass%& is not needed, and it is no longer used in the default
25263 configuration.
25264
25265 .cindex "&%message%& ACL modifier" "with &%accept%&"
25266 If a &%message%& modifier appears on an &%accept%& statement, its action
25267 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
25268 (when an &%accept%& verb either accepts or passes control to the next
25269 statement), &%message%& can be used to vary the message that is sent when an
25270 SMTP command is accepted. For example, in a RCPT ACL you could have:
25271 .display
25272 &`accept  `&<&'some conditions'&>
25273 &`        message = OK, I will allow you through today`&
25274 .endd
25275 You can specify an SMTP response code, optionally followed by an &"extended
25276 response code"& at the start of the message, but the first digit must be the
25277 same as would be sent by default, which is 2 for an &%accept%& verb.
25278
25279 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
25280 an error message that is used when access is denied. This behaviour is retained
25281 for backward compatibility, but current &"best practice"& is to avoid the use
25282 of &%endpass%&.
25283
25284
25285 .next
25286 .cindex "&%defer%& ACL verb"
25287 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
25288 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
25289 &%defer%& is the same as &%deny%&, because there is no way of sending a
25290 temporary error. For a RCPT command, &%defer%& is much the same as using a
25291 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
25292 be used in any ACL, and even for a recipient it might be a simpler approach.
25293
25294
25295 .next
25296 .cindex "&%deny%& ACL verb"
25297 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
25298 the conditions are not met, control is passed to the next ACL statement. For
25299 example,
25300 .code
25301 deny dnslists = blackholes.mail-abuse.org
25302 .endd
25303 rejects commands from hosts that are on a DNS black list.
25304
25305
25306 .next
25307 .cindex "&%discard%& ACL verb"
25308 &%discard%&: This verb behaves like &%accept%&, except that it returns
25309 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
25310 that are concerned with receiving messages. When all the conditions are true,
25311 the sending entity receives a &"success"& response. However, &%discard%& causes
25312 recipients to be discarded. If it is used in an ACL for RCPT, just the one
25313 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
25314 message's recipients are discarded. Recipients that are discarded before DATA
25315 do not appear in the log line when the &%received_recipients%& log selector is set.
25316
25317 If the &%log_message%& modifier is set when &%discard%& operates,
25318 its contents are added to the line that is automatically written to the log.
25319 The &%message%& modifier operates exactly as it does for &%accept%&.
25320
25321
25322 .next
25323 .cindex "&%drop%& ACL verb"
25324 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
25325 forcibly closed after the 5&'xx'& error message has been sent. For example:
25326 .code
25327 drop   message   = I don't take more than 20 RCPTs
25328        condition = ${if > {$rcpt_count}{20}}
25329 .endd
25330 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
25331 The connection is always dropped after sending a 550 response.
25332
25333 .next
25334 .cindex "&%require%& ACL verb"
25335 &%require%&: If all the conditions are met, control is passed to the next ACL
25336 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
25337 example, when checking a RCPT command,
25338 .code
25339 require message = Sender did not verify
25340         verify  = sender
25341 .endd
25342 passes control to subsequent statements only if the message's sender can be
25343 verified. Otherwise, it rejects the command. Note the positioning of the
25344 &%message%& modifier, before the &%verify%& condition. The reason for this is
25345 discussed in section &<<SECTcondmodproc>>&.
25346
25347 .next
25348 .cindex "&%warn%& ACL verb"
25349 &%warn%&: If all the conditions are true, a line specified by the
25350 &%log_message%& modifier is written to Exim's main log. Control always passes
25351 to the next ACL statement. If any condition is false, the log line is not
25352 written. If an identical log line is requested several times in the same
25353 message, only one copy is actually written to the log. If you want to force
25354 duplicates to be written, use the &%logwrite%& modifier instead.
25355
25356 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
25357 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
25358 &%logwrite%&, and &%add_header%&) that appear before the first failing
25359 condition. There is more about adding header lines in section
25360 &<<SECTaddheadacl>>&.
25361
25362 If any condition on a &%warn%& statement cannot be completed (that is, there is
25363 some sort of defer), the log line specified by &%log_message%& is not written.
25364 This does not include the case of a forced failure from a lookup, which
25365 is considered to be a successful completion. After a defer, no further
25366 conditions or modifiers in the &%warn%& statement are processed. The incident
25367 is logged, and the ACL continues to be processed, from the next statement
25368 onwards.
25369
25370
25371 .vindex "&$acl_verify_message$&"
25372 When one of the &%warn%& conditions is an address verification that fails, the
25373 text of the verification failure message is in &$acl_verify_message$&. If you
25374 want this logged, you must set it up explicitly. For example:
25375 .code
25376 warn   !verify = sender
25377        log_message = sender verify failed: $acl_verify_message
25378 .endd
25379 .endlist
25380
25381 At the end of each ACL there is an implicit unconditional &%deny%&.
25382
25383 As you can see from the examples above, the conditions and modifiers are
25384 written one to a line, with the first one on the same line as the verb, and
25385 subsequent ones on following lines. If you have a very long condition, you can
25386 continue it onto several physical lines by the usual backslash continuation
25387 mechanism. It is conventional to align the conditions vertically.
25388
25389
25390
25391 .section "ACL variables" "SECTaclvariables"
25392 .cindex "&ACL;" "variables"
25393 There are some special variables that can be set during ACL processing. They
25394 can be used to pass information between different ACLs, different invocations
25395 of the same ACL in the same SMTP connection, and between ACLs and the routers,
25396 transports, and filters that are used to deliver a message. The names of these
25397 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
25398 an underscore, but the remainder of the name can be any sequence of
25399 alphanumeric characters and underscores that you choose. There is no limit on
25400 the number of ACL variables. The two sets act as follows:
25401 .ilist
25402 The values of those variables whose names begin with &$acl_c$& persist
25403 throughout an SMTP connection. They are never reset. Thus, a value that is set
25404 while receiving one message is still available when receiving the next message
25405 on the same SMTP connection.
25406 .next
25407 The values of those variables whose names begin with &$acl_m$& persist only
25408 while a message is being received. They are reset afterwards. They are also
25409 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
25410 .endlist
25411
25412 When a message is accepted, the current values of all the ACL variables are
25413 preserved with the message and are subsequently made available at delivery
25414 time. The ACL variables are set by a modifier called &%set%&. For example:
25415 .code
25416 accept hosts = whatever
25417        set acl_m4 = some value
25418 accept authenticated = *
25419        set acl_c_auth = yes
25420 .endd
25421 &*Note*&: A leading dollar sign is not used when naming a variable that is to
25422 be set. If you want to set a variable without taking any action, you can use a
25423 &%warn%& verb without any other modifiers or conditions.
25424
25425 .oindex &%strict_acl_vars%&
25426 What happens if a syntactically valid but undefined ACL variable is
25427 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
25428 false (the default), an empty string is substituted; if it is true, an
25429 error is generated.
25430
25431 Versions of Exim before 4.64 have a limited set of numbered variables, but
25432 their names are compatible, so there is no problem with upgrading.
25433
25434
25435 .section "Condition and modifier processing" "SECTcondmodproc"
25436 .cindex "&ACL;" "conditions; processing"
25437 .cindex "&ACL;" "modifiers; processing"
25438 An exclamation mark preceding a condition negates its result. For example:
25439 .code
25440 deny   domains = *.dom.example
25441       !verify  = recipient
25442 .endd
25443 causes the ACL to return &"deny"& if the recipient domain ends in
25444 &'dom.example'& and the recipient address cannot be verified. Sometimes
25445 negation can be used on the right-hand side of a condition. For example, these
25446 two statements are equivalent:
25447 .code
25448 deny  hosts = !192.168.3.4
25449 deny !hosts =  192.168.3.4
25450 .endd
25451 However, for many conditions (&%verify%& being a good example), only left-hand
25452 side negation of the whole condition is possible.
25453
25454 The arguments of conditions and modifiers are expanded. A forced failure
25455 of an expansion causes a condition to be ignored, that is, it behaves as if the
25456 condition is true. Consider these two statements:
25457 .code
25458 accept  senders = ${lookup{$host_name}lsearch\
25459                   {/some/file}{$value}fail}
25460 accept  senders = ${lookup{$host_name}lsearch\
25461                   {/some/file}{$value}{}}
25462 .endd
25463 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
25464 the returned list is searched, but if the lookup fails the behaviour is
25465 different in the two cases. The &%fail%& in the first statement causes the
25466 condition to be ignored, leaving no further conditions. The &%accept%& verb
25467 therefore succeeds. The second statement, however, generates an empty list when
25468 the lookup fails. No sender can match an empty list, so the condition fails,
25469 and therefore the &%accept%& also fails.
25470
25471 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
25472 specify actions that are taken as the conditions for a statement are checked;
25473 others specify text for messages that are used when access is denied or a
25474 warning is generated. The &%control%& modifier affects the way an incoming
25475 message is handled.
25476
25477 The positioning of the modifiers in an ACL statement important, because the
25478 processing of a verb ceases as soon as its outcome is known. Only those
25479 modifiers that have already been encountered will take effect. For example,
25480 consider this use of the &%message%& modifier:
25481 .code
25482 require message = Can't verify sender
25483         verify  = sender
25484         message = Can't verify recipient
25485         verify  = recipient
25486         message = This message cannot be used
25487 .endd
25488 If sender verification fails, Exim knows that the result of the statement is
25489 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
25490 so its text is used as the error message. If sender verification succeeds, but
25491 recipient verification fails, the second message is used. If recipient
25492 verification succeeds, the third message becomes &"current"&, but is never used
25493 because there are no more conditions to cause failure.
25494
25495 For the &%deny%& verb, on the other hand, it is always the last &%message%&
25496 modifier that is used, because all the conditions must be true for rejection to
25497 happen. Specifying more than one &%message%& modifier does not make sense, and
25498 the message can even be specified after all the conditions. For example:
25499 .code
25500 deny   hosts = ...
25501       !senders = *@my.domain.example
25502        message = Invalid sender from client host
25503 .endd
25504 The &"deny"& result does not happen until the end of the statement is reached,
25505 by which time Exim has set up the message.
25506
25507
25508
25509 .section "ACL modifiers" "SECTACLmodi"
25510 .cindex "&ACL;" "modifiers; list of"
25511 The ACL modifiers are as follows:
25512
25513 .vlist
25514 .vitem &*add_header*&&~=&~<&'text'&>
25515 This modifier specifies one or more header lines that are to be added to an
25516 incoming message, assuming, of course, that the message is ultimately
25517 accepted. For details, see section &<<SECTaddheadacl>>&.
25518
25519 .vitem &*continue*&&~=&~<&'text'&>
25520 .cindex "&%continue%& ACL modifier"
25521 .cindex "database" "updating in ACL"
25522 This modifier does nothing of itself, and processing of the ACL always
25523 continues with the next condition or modifier. The value of &%continue%& is in
25524 the side effects of expanding its argument. Typically this could be used to
25525 update a database. It is really just a syntactic tidiness, to avoid having to
25526 write rather ugly lines like this:
25527 .display
25528 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
25529 .endd
25530 Instead, all you need is
25531 .display
25532 &`continue = `&<&'some expansion'&>
25533 .endd
25534
25535 .vitem &*control*&&~=&~<&'text'&>
25536 .cindex "&%control%& ACL modifier"
25537 This modifier affects the subsequent processing of the SMTP connection or of an
25538 incoming message that is accepted. The effect of the first type of control
25539 lasts for the duration of the connection, whereas the effect of the second type
25540 lasts only until the current message has been received. The message-specific
25541 controls always apply to the whole message, not to individual recipients,
25542 even if the &%control%& modifier appears in a RCPT ACL.
25543
25544 As there are now quite a few controls that can be applied, they are described
25545 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
25546 in several different ways. For example:
25547
25548 . ==== As this is a nested list, any displays it contains must be indented
25549 . ==== as otherwise they are too far to the left. That comment applies only
25550 . ==== when xmlto and fop are used; formatting with sdop gets it right either
25551 . ==== way.
25552
25553 .ilist
25554 It can be at the end of an &%accept%& statement:
25555 .code
25556     accept  ...some conditions
25557             control = queue_only
25558 .endd
25559 In this case, the control is applied when this statement yields &"accept"&, in
25560 other words, when the conditions are all true.
25561
25562 .next
25563 It can be in the middle of an &%accept%& statement:
25564 .code
25565     accept  ...some conditions...
25566             control = queue_only
25567             ...some more conditions...
25568 .endd
25569 If the first set of conditions are true, the control is applied, even if the
25570 statement does not accept because one of the second set of conditions is false.
25571 In this case, some subsequent statement must yield &"accept"& for the control
25572 to be relevant.
25573
25574 .next
25575 It can be used with &%warn%& to apply the control, leaving the
25576 decision about accepting or denying to a subsequent verb. For
25577 example:
25578 .code
25579     warn    ...some conditions...
25580             control = freeze
25581     accept  ...
25582 .endd
25583 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
25584 &%logwrite%&, so it does not add anything to the message and does not write a
25585 log entry.
25586
25587 .next
25588 If you want to apply a control unconditionally, you can use it with a
25589 &%require%& verb. For example:
25590 .code
25591     require  control = no_multiline_responses
25592 .endd
25593 .endlist
25594
25595 .vitem &*delay*&&~=&~<&'time'&>
25596 .cindex "&%delay%& ACL modifier"
25597 .oindex "&%-bh%&"
25598 This modifier may appear in any ACL. It causes Exim to wait for the time
25599 interval before proceeding. However, when testing Exim using the &%-bh%&
25600 option, the delay is not actually imposed (an appropriate message is output
25601 instead). The time is given in the usual Exim notation, and the delay happens
25602 as soon as the modifier is processed. In an SMTP session, pending output is
25603 flushed before the delay is imposed.
25604
25605 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
25606 example:
25607 .code
25608 deny    ...some conditions...
25609         delay = 30s
25610 .endd
25611 The delay happens if all the conditions are true, before the statement returns
25612 &"deny"&. Compare this with:
25613 .code
25614 deny    delay = 30s
25615         ...some conditions...
25616 .endd
25617 which waits for 30s before processing the conditions. The &%delay%& modifier
25618 can also be used with &%warn%& and together with &%control%&:
25619 .code
25620 warn    ...some conditions...
25621         delay = 2m
25622         control = freeze
25623 accept  ...
25624 .endd
25625
25626 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
25627 responses to several commands are no longer buffered and sent in one packet (as
25628 they would normally be) because all output is flushed before imposing the
25629 delay. This optimization is disabled so that a number of small delays do not
25630 appear to the client as one large aggregated delay that might provoke an
25631 unwanted timeout. You can, however, disable output flushing for &%delay%& by
25632 using a &%control%& modifier to set &%no_delay_flush%&.
25633
25634
25635 .vitem &*endpass*&
25636 .cindex "&%endpass%& ACL modifier"
25637 This modifier, which has no argument, is recognized only in &%accept%& and
25638 &%discard%& statements. It marks the boundary between the conditions whose
25639 failure causes control to pass to the next statement, and the conditions whose
25640 failure causes the ACL to return &"deny"&. This concept has proved to be
25641 confusing to some people, so the use of &%endpass%& is no longer recommended as
25642 &"best practice"&. See the description of &%accept%& above for more details.
25643
25644
25645 .vitem &*log_message*&&~=&~<&'text'&>
25646 .cindex "&%log_message%& ACL modifier"
25647 This modifier sets up a message that is used as part of the log message if the
25648 ACL denies access or a &%warn%& statement's conditions are true. For example:
25649 .code
25650 require log_message = wrong cipher suite $tls_cipher
25651         encrypted   = DES-CBC3-SHA
25652 .endd
25653 &%log_message%& is also used when recipients are discarded by &%discard%&. For
25654 example:
25655 .display
25656 &`discard `&<&'some conditions'&>
25657 &`        log_message = Discarded $local_part@$domain because...`&
25658 .endd
25659 When access is denied, &%log_message%& adds to any underlying error message
25660 that may exist because of a condition failure. For example, while verifying a
25661 recipient address, a &':fail:'& redirection might have already set up a
25662 message.
25663
25664 The message may be defined before the conditions to which it applies, because
25665 the string expansion does not happen until Exim decides that access is to be
25666 denied. This means that any variables that are set by the condition are
25667 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
25668 variables are set after a DNS black list lookup succeeds. If the expansion of
25669 &%log_message%& fails, or if the result is an empty string, the modifier is
25670 ignored.
25671
25672 .vindex "&$acl_verify_message$&"
25673 If you want to use a &%warn%& statement to log the result of an address
25674 verification, you can use &$acl_verify_message$& to include the verification
25675 error message.
25676
25677 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
25678 the start of the logged message. If the same warning log message is requested
25679 more than once while receiving  a single email message, only one copy is
25680 actually logged. If you want to log multiple copies, use &%logwrite%& instead
25681 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
25682 is logged for a successful &%warn%& statement.
25683
25684 If &%log_message%& is not present and there is no underlying error message (for
25685 example, from the failure of address verification), but &%message%& is present,
25686 the &%message%& text is used for logging rejections. However, if any text for
25687 logging contains newlines, only the first line is logged. In the absence of
25688 both &%log_message%& and &%message%&, a default built-in message is used for
25689 logging rejections.
25690
25691
25692 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
25693 .cindex "&%log_reject_target%& ACL modifier"
25694 .cindex "logging in ACL" "specifying which log"
25695 This modifier makes it possible to specify which logs are used for messages
25696 about ACL rejections. Its argument is a colon-separated list of words that can
25697 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
25698 may be empty, in which case a rejection is not logged at all. For example, this
25699 ACL fragment writes no logging information when access is denied:
25700 .display
25701 &`deny `&<&'some conditions'&>
25702 &`     log_reject_target =`&
25703 .endd
25704 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
25705 permanent and temporary rejections. Its effect lasts for the rest of the
25706 current ACL.
25707
25708
25709 .vitem &*logwrite*&&~=&~<&'text'&>
25710 .cindex "&%logwrite%& ACL modifier"
25711 .cindex "logging in ACL" "immediate"
25712 This modifier writes a message to a log file as soon as it is encountered when
25713 processing an ACL. (Compare &%log_message%&, which, except in the case of
25714 &%warn%& and &%discard%&, is used only if the ACL statement denies
25715 access.) The &%logwrite%& modifier can be used to log special incidents in
25716 ACLs. For example:
25717 .display
25718 &`accept `&<&'some special conditions'&>
25719 &`       control  = freeze`&
25720 &`       logwrite = froze message because ...`&
25721 .endd
25722 By default, the message is written to the main log. However, it may begin
25723 with a colon, followed by a comma-separated list of log names, and then
25724 another colon, to specify exactly which logs are to be written. For
25725 example:
25726 .code
25727 logwrite = :main,reject: text for main and reject logs
25728 logwrite = :panic: text for panic log only
25729 .endd
25730
25731
25732 .vitem &*message*&&~=&~<&'text'&>
25733 .cindex "&%message%& ACL modifier"
25734 This modifier sets up a text string that is expanded and used as a response
25735 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
25736 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
25737 there is some complication if &%endpass%& is involved; see the description of
25738 &%accept%& for details.)
25739
25740 The expansion of the message happens at the time Exim decides that the ACL is
25741 to end, not at the time it processes &%message%&. If the expansion fails, or
25742 generates an empty string, the modifier is ignored. Here is an example where
25743 &%message%& must be specified first, because the ACL ends with a rejection if
25744 the &%hosts%& condition fails:
25745 .code
25746 require  message = Host not recognized
25747          hosts = 10.0.0.0/8
25748 .endd
25749 (Once a condition has failed, no further conditions or modifiers are
25750 processed.)
25751
25752 .cindex "SMTP" "error codes"
25753 .oindex "&%smtp_banner%&
25754 For ACLs that are triggered by SMTP commands, the message is returned as part
25755 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
25756 is meaningful only for SMTP, as no message is returned when a non-SMTP message
25757 is accepted. In the case of the connect ACL, accepting with a message modifier
25758 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
25759 accept message may not contain more than one line (otherwise it will be
25760 truncated at the first newline and a panic logged), and it cannot affect the
25761 EHLO options.
25762
25763 When SMTP is involved, the message may begin with an overriding response code,
25764 consisting of three digits optionally followed by an &"extended response code"&
25765 of the form &'n.n.n'&, each code being followed by a space. For example:
25766 .code
25767 deny  message = 599 1.2.3 Host not welcome
25768       hosts = 192.168.34.0/24
25769 .endd
25770 The first digit of the supplied response code must be the same as would be sent
25771 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
25772 access, but for the predata ACL, note that the default success code is 354, not
25773 2&'xx'&.
25774
25775 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
25776 the message modifier cannot override the 221 response code.
25777
25778 The text in a &%message%& modifier is literal; any quotes are taken as
25779 literals, but because the string is expanded, backslash escapes are processed
25780 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
25781 response.
25782
25783 .vindex "&$acl_verify_message$&"
25784 If &%message%& is used on a statement that verifies an address, the message
25785 specified overrides any message that is generated by the verification process.
25786 However, the original message is available in the variable
25787 &$acl_verify_message$&, so you can incorporate it into your message if you
25788 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
25789 routers to be passed back as part of the SMTP response, you should either not
25790 use a &%message%& modifier, or make use of &$acl_verify_message$&.
25791
25792 For compatibility with previous releases of Exim, a &%message%& modifier that
25793 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
25794 modifier, but this usage is now deprecated. However, &%message%& acts only when
25795 all the conditions are true, wherever it appears in an ACL command, whereas
25796 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
25797 &%warn%& in an ACL that is not concerned with receiving a message, it has no
25798 effect.
25799
25800
25801 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
25802 .cindex "&%set%& ACL modifier"
25803 This modifier puts a value into one of the ACL variables (see section
25804 &<<SECTaclvariables>>&).
25805 .endlist
25806
25807
25808
25809
25810
25811 .section "Use of the control modifier" "SECTcontrols"
25812 .cindex "&%control%& ACL modifier"
25813 The &%control%& modifier supports the following settings:
25814
25815 .vlist
25816 .vitem &*control&~=&~allow_auth_unadvertised*&
25817 This modifier allows a client host to use the SMTP AUTH command even when it
25818 has not been advertised in response to EHLO. Furthermore, because there are
25819 apparently some really broken clients that do this, Exim will accept AUTH after
25820 HELO (rather than EHLO) when this control is set. It should be used only if you
25821 really need it, and you should limit its use to those broken clients that do
25822 not work without it. For example:
25823 .code
25824 warn hosts   = 192.168.34.25
25825      control = allow_auth_unadvertised
25826 .endd
25827 Normally, when an Exim server receives an AUTH command, it checks the name of
25828 the authentication mechanism that is given in the command to ensure that it
25829 matches an advertised mechanism. When this control is set, the check that a
25830 mechanism has been advertised is bypassed. Any configured mechanism can be used
25831 by the client. This control is permitted only in the connection and HELO ACLs.
25832
25833
25834 .vitem &*control&~=&~caseful_local_part*& &&&
25835        &*control&~=&~caselower_local_part*&
25836 .cindex "&ACL;" "case of local part in"
25837 .cindex "case of local parts"
25838 .vindex "&$local_part$&"
25839 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
25840 (that is, during RCPT processing). By default, the contents of &$local_part$&
25841 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
25842 any uppercase letters in the original local part are restored in &$local_part$&
25843 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
25844 is encountered.
25845
25846 These controls affect only the current recipient. Moreover, they apply only to
25847 local part handling that takes place directly in the ACL (for example, as a key
25848 in lookups). If a test to verify the recipient is obeyed, the case-related
25849 handling of the local part during the verification is controlled by the router
25850 configuration (see the &%caseful_local_part%& generic router option).
25851
25852 This facility could be used, for example, to add a spam score to local parts
25853 containing upper case letters. For example, using &$acl_m4$& to accumulate the
25854 spam score:
25855 .code
25856 warn  control = caseful_local_part
25857       set acl_m4 = ${eval:\
25858                      $acl_m4 + \
25859                      ${if match{$local_part}{[A-Z]}{1}{0}}\
25860                     }
25861       control = caselower_local_part
25862 .endd
25863 Notice that we put back the lower cased version afterwards, assuming that
25864 is what is wanted for subsequent tests.
25865
25866 .new
25867 .vitem &*control&~=&~debug/*&<&'options'&>
25868 .cindex "&ACL;" "enabling debug logging"
25869 .cindex "debugging" "enabling from an ACL"
25870 This control turns on debug logging, almost as though Exim had been invoked
25871 with &`-d`&, with the output going to a new logfile, by default called
25872 &'debuglog'&.  The filename can be adjusted with the &'tag'& option, which
25873 may access any variables already defined.  The logging may be adjusted with
25874 the &'opts'& option, which takes the same values as the &`-d`& command-line
25875 option.  Some examples (which depend on variables that don't exist in all
25876 contexts):
25877 .code
25878       control = debug
25879       control = debug/tag=.$sender_host_address
25880       control = debug/opts=+expand+acl
25881       control = debug/tag=.$message_exim_id/opts=+expand
25882 .endd
25883 .wen
25884
25885 .vitem &*control&~=&~enforce_sync*& &&&
25886        &*control&~=&~no_enforce_sync*&
25887 .cindex "SMTP" "synchronization checking"
25888 .cindex "synchronization checking in SMTP"
25889 These controls make it possible to be selective about when SMTP synchronization
25890 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
25891 state of the switch (it is true by default). See the description of this option
25892 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
25893
25894 The effect of these two controls lasts for the remainder of the SMTP
25895 connection. They can appear in any ACL except the one for the non-SMTP
25896 messages. The most straightforward place to put them is in the ACL defined by
25897 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
25898 before the first synchronization check. The expected use is to turn off the
25899 synchronization checks for badly-behaved hosts that you nevertheless need to
25900 work with.
25901
25902
25903 .vitem &*control&~=&~fakedefer/*&<&'message'&>
25904 .cindex "fake defer"
25905 .cindex "defer, fake"
25906 This control works in exactly the same way as &%fakereject%& (described below)
25907 except that it causes an SMTP 450 response after the message data instead of a
25908 550 response. You must take care when using &%fakedefer%& because it causes the
25909 messages to be duplicated when the sender retries. Therefore, you should not
25910 use &%fakedefer%& if the message is to be delivered normally.
25911
25912 .vitem &*control&~=&~fakereject/*&<&'message'&>
25913 .cindex "fake rejection"
25914 .cindex "rejection, fake"
25915 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
25916 words, only when an SMTP message is being received. If Exim accepts the
25917 message, instead the final 250 response, a 550 rejection message is sent.
25918 However, Exim proceeds to deliver the message as normal. The control applies
25919 only to the current message, not to any subsequent ones that may be received in
25920 the same SMTP connection.
25921
25922 The text for the 550 response is taken from the &%control%& modifier. If no
25923 message is supplied, the following is used:
25924 .code
25925 550-Your message has been rejected but is being
25926 550-kept for evaluation.
25927 550-If it was a legitimate message, it may still be
25928 550 delivered to the target recipient(s).
25929 .endd
25930 This facility should be used with extreme caution.
25931
25932 .vitem &*control&~=&~freeze*&
25933 .cindex "frozen messages" "forcing in ACL"
25934 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
25935 other words, only when a message is being received. If the message is accepted,
25936 it is placed on Exim's queue and frozen. The control applies only to the
25937 current message, not to any subsequent ones that may be received in the same
25938 SMTP connection.
25939
25940 This modifier can optionally be followed by &`/no_tell`&. If the global option
25941 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
25942 is told about the freezing), provided all the &*control=freeze*& modifiers that
25943 are obeyed for the current message have the &`/no_tell`& option.
25944
25945 .vitem &*control&~=&~no_delay_flush*&
25946 .cindex "SMTP" "output flushing, disabling for delay"
25947 Exim normally flushes SMTP output before implementing a delay in an ACL, to
25948 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
25949 use. This control, as long as it is encountered before the &%delay%& modifier,
25950 disables such output flushing.
25951
25952 .vitem &*control&~=&~no_callout_flush*&
25953 .cindex "SMTP" "output flushing, disabling for callout"
25954 Exim normally flushes SMTP output before performing a callout in an ACL, to
25955 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
25956 use. This control, as long as it is encountered before the &%verify%& condition
25957 that causes the callout, disables such output flushing.
25958
25959 .vitem &*control&~=&~no_mbox_unspool*&
25960 This control is available when Exim is compiled with the content scanning
25961 extension. Content scanning may require a copy of the current message, or parts
25962 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
25963 or spam scanner. Normally, such copies are deleted when they are no longer
25964 needed. If this control is set, the copies are not deleted. The control applies
25965 only to the current message, not to any subsequent ones that may be received in
25966 the same SMTP connection. It is provided for debugging purposes and is unlikely
25967 to be useful in production.
25968
25969 .vitem &*control&~=&~no_multiline_responses*&
25970 .cindex "multiline responses, suppressing"
25971 This control is permitted for any ACL except the one for non-SMTP messages.
25972 It seems that there are broken clients in use that cannot handle multiline
25973 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
25974
25975 If this control is set, multiline SMTP responses from ACL rejections are
25976 suppressed. One way of doing this would have been to put out these responses as
25977 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
25978 (&"use multiline responses for more"& it says &-- ha!), and some of the
25979 responses might get close to that. So this facility, which is after all only a
25980 sop to broken clients, is implemented by doing two very easy things:
25981
25982 .ilist
25983 Extra information that is normally output as part of a rejection caused by
25984 sender verification failure is omitted. Only the final line (typically &"sender
25985 verification failed"&) is sent.
25986 .next
25987 If a &%message%& modifier supplies a multiline response, only the first
25988 line is output.
25989 .endlist
25990
25991 The setting of the switch can, of course, be made conditional on the
25992 calling host. Its effect lasts until the end of the SMTP connection.
25993
25994 .vitem &*control&~=&~no_pipelining*&
25995 .cindex "PIPELINING" "suppressing advertising"
25996 This control turns off the advertising of the PIPELINING extension to SMTP in
25997 the current session. To be useful, it must be obeyed before Exim sends its
25998 response to an EHLO command. Therefore, it should normally appear in an ACL
25999 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
26000 &%pipelining_advertise_hosts%&.
26001
26002 .vitem &*control&~=&~queue_only*&
26003 .oindex "&%queue_only%&"
26004 .cindex "queueing incoming messages"
26005 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
26006 other words, only when a message is being received. If the message is accepted,
26007 it is placed on Exim's queue and left there for delivery by a subsequent queue
26008 runner. No immediate delivery process is started. In other words, it has the
26009 effect as the &%queue_only%& global option. However, the control applies only
26010 to the current message, not to any subsequent ones that may be received in the
26011 same SMTP connection.
26012
26013 .vitem &*control&~=&~submission/*&<&'options'&>
26014 .cindex "message" "submission"
26015 .cindex "submission mode"
26016 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
26017 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
26018 the current message is a submission from a local MUA. In this case, Exim
26019 operates in &"submission mode"&, and applies certain fixups to the message if
26020 necessary. For example, it adds a &'Date:'& header line if one is not present.
26021 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
26022 late (the message has already been created).
26023
26024 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
26025 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
26026 submission mode; the available options for this control are described there.
26027 The control applies only to the current message, not to any subsequent ones
26028 that may be received in the same SMTP connection.
26029
26030 .vitem &*control&~=&~suppress_local_fixups*&
26031 .cindex "submission fixups, suppressing"
26032 This control applies to locally submitted (non TCP/IP) messages, and is the
26033 complement of &`control = submission`&. It disables the fixups that are
26034 normally applied to locally-submitted messages. Specifically:
26035
26036 .ilist
26037 Any &'Sender:'& header line is left alone (in this respect, it is a
26038 dynamic version of &%local_sender_retain%&).
26039 .next
26040 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
26041 .next
26042 There is no check that &'From:'& corresponds to the actual sender.
26043 .endlist ilist
26044
26045 This control may be useful when a remotely-originated message is accepted,
26046 passed to some scanning program, and then re-submitted for delivery. It can be
26047 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
26048 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
26049 data is read.
26050
26051 &*Note:*& This control applies only to the current message, not to any others
26052 that are being submitted at the same time using &%-bs%& or &%-bS%&.
26053 .endlist vlist
26054
26055
26056 .section "Summary of message fixup control" "SECTsummesfix"
26057 All four possibilities for message fixups can be specified:
26058
26059 .ilist
26060 Locally submitted, fixups applied: the default.
26061 .next
26062 Locally submitted, no fixups applied: use
26063 &`control = suppress_local_fixups`&.
26064 .next
26065 Remotely submitted, no fixups applied: the default.
26066 .next
26067 Remotely submitted, fixups applied: use &`control = submission`&.
26068 .endlist
26069
26070
26071
26072 .section "Adding header lines in ACLs" "SECTaddheadacl"
26073 .cindex "header lines" "adding in an ACL"
26074 .cindex "header lines" "position of added lines"
26075 .cindex "&%message%& ACL modifier"
26076 The &%add_header%& modifier can be used to add one or more extra header lines
26077 to an incoming message, as in this example:
26078 .code
26079 warn dnslists = sbl.spamhaus.org : \
26080                 dialup.mail-abuse.org
26081      add_header = X-blacklisted-at: $dnslist_domain
26082 .endd
26083 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
26084 MIME, and non-SMTP ACLs (in other words, those that are concerned with
26085 receiving a message). The message must ultimately be accepted for
26086 &%add_header%& to have any significant effect. You can use &%add_header%& with
26087 any ACL verb, including &%deny%& (though this is potentially useful only in a
26088 RCPT ACL).
26089
26090 If the data for the &%add_header%& modifier contains one or more newlines that
26091 are not followed by a space or a tab, it is assumed to contain multiple header
26092 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
26093 front of any line that is not a valid header line.
26094
26095 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
26096 They are added to the message before processing the DATA and MIME ACLs.
26097 However, if an identical header line is requested more than once, only one copy
26098 is actually added to the message. Further header lines may be accumulated
26099 during the DATA and MIME ACLs, after which they are added to the message, again
26100 with duplicates suppressed. Thus, it is possible to add two identical header
26101 lines to an SMTP message, but only if one is added before DATA and one after.
26102 In the case of non-SMTP messages, new headers are accumulated during the
26103 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
26104 message is rejected after DATA or by the non-SMTP ACL, all added header lines
26105 are included in the entry that is written to the reject log.
26106
26107 .cindex "header lines" "added; visibility of"
26108 Header lines are not visible in string expansions until they are added to the
26109 message. It follows that header lines defined in the MAIL, RCPT, and predata
26110 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
26111 header lines that are added by the DATA or MIME ACLs are not visible in those
26112 ACLs. Because of this restriction, you cannot use header lines as a way of
26113 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
26114 this, you can use ACL variables, as described in section
26115 &<<SECTaclvariables>>&.
26116
26117 The &%add_header%& modifier acts immediately it is encountered during the
26118 processing of an ACL. Notice the difference between these two cases:
26119 .display
26120 &`accept add_header = ADDED: some text`&
26121 &`       `&<&'some condition'&>
26122
26123 &`accept `&<&'some condition'&>
26124 &`       add_header = ADDED: some text`&
26125 .endd
26126 In the first case, the header line is always added, whether or not the
26127 condition is true. In the second case, the header line is added only if the
26128 condition is true. Multiple occurrences of &%add_header%& may occur in the same
26129 ACL statement. All those that are encountered before a condition fails are
26130 honoured.
26131
26132 .cindex "&%warn%& ACL verb"
26133 For compatibility with previous versions of Exim, a &%message%& modifier for a
26134 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
26135 effect only if all the conditions are true, even if it appears before some of
26136 them. Furthermore, only the last occurrence of &%message%& is honoured. This
26137 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
26138 are present on a &%warn%& verb, both are processed according to their
26139 specifications.
26140
26141 By default, new header lines are added to a message at the end of the existing
26142 header lines. However, you can specify that any particular header line should
26143 be added right at the start (before all the &'Received:'& lines), immediately
26144 after the first block of &'Received:'& lines, or immediately before any line
26145 that is not a &'Received:'& or &'Resent-something:'& header.
26146
26147 This is done by specifying &":at_start:"&, &":after_received:"&, or
26148 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
26149 header line, respectively. (Header text cannot start with a colon, as there has
26150 to be a header name first.) For example:
26151 .code
26152 warn add_header = \
26153        :after_received:X-My-Header: something or other...
26154 .endd
26155 If more than one header line is supplied in a single &%add_header%& modifier,
26156 each one is treated independently and can therefore be placed differently. If
26157 you add more than one line at the start, or after the Received: block, they end
26158 up in reverse order.
26159
26160 &*Warning*&: This facility currently applies only to header lines that are
26161 added in an ACL. It does NOT work for header lines that are added in a
26162 system filter or in a router or transport.
26163
26164
26165
26166
26167 .section "ACL conditions" "SECTaclconditions"
26168 .cindex "&ACL;" "conditions; list of"
26169 Some of conditions listed in this section are available only when Exim is
26170 compiled with the content-scanning extension. They are included here briefly
26171 for completeness. More detailed descriptions can be found in the discussion on
26172 content scanning in chapter &<<CHAPexiscan>>&.
26173
26174 Not all conditions are relevant in all circumstances. For example, testing
26175 senders and recipients does not make sense in an ACL that is being run as the
26176 result of the arrival of an ETRN command, and checks on message headers can be
26177 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
26178 can use the same condition (with different parameters) more than once in the
26179 same ACL statement. This provides a way of specifying an &"and"& conjunction.
26180 The conditions are as follows:
26181
26182
26183 .vlist
26184 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
26185 .cindex "&ACL;" "nested"
26186 .cindex "&ACL;" "indirect"
26187 .cindex "&%acl%& ACL condition"
26188 The possible values of the argument are the same as for the
26189 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
26190 &"accept"& the condition is true; if it returns &"deny"& the condition is
26191 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
26192 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
26193 condition false. This means that further processing of the &%warn%& verb
26194 ceases, but processing of the ACL continues.
26195
26196 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
26197 the connection is dropped. If it returns &"discard"&, the verb must be
26198 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
26199 conditions are tested.
26200
26201 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
26202 loops. This condition allows you to use different ACLs in different
26203 circumstances. For example, different ACLs can be used to handle RCPT commands
26204 for different local users or different local domains.
26205
26206 .vitem &*authenticated&~=&~*&<&'string&~list'&>
26207 .cindex "&%authenticated%& ACL condition"
26208 .cindex "authentication" "ACL checking"
26209 .cindex "&ACL;" "testing for authentication"
26210 If the SMTP connection is not authenticated, the condition is false. Otherwise,
26211 the name of the authenticator is tested against the list. To test for
26212 authentication by any authenticator, you can set
26213 .code
26214 authenticated = *
26215 .endd
26216
26217 .vitem &*condition&~=&~*&<&'string'&>
26218 .cindex "&%condition%& ACL condition"
26219 .cindex "customizing" "ACL condition"
26220 .cindex "&ACL;" "customized test"
26221 .cindex "&ACL;" "testing, customized"
26222 This feature allows you to make up custom conditions. If the result of
26223 expanding the string is an empty string, the number zero, or one of the strings
26224 &"no"& or &"false"&, the condition is false. If the result is any non-zero
26225 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
26226 any other value, some error is assumed to have occurred, and the ACL returns
26227 &"defer"&. However, if the expansion is forced to fail, the condition is
26228 ignored. The effect is to treat it as true, whether it is positive or
26229 negative.
26230
26231 .vitem &*decode&~=&~*&<&'location'&>
26232 .cindex "&%decode%& ACL condition"
26233 This condition is available only when Exim is compiled with the
26234 content-scanning extension, and it is allowed only in the ACL defined by
26235 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
26236 If all goes well, the condition is true. It is false only if there are
26237 problems such as a syntax error or a memory shortage. For more details, see
26238 chapter &<<CHAPexiscan>>&.
26239
26240 .vitem &*demime&~=&~*&<&'extension&~list'&>
26241 .cindex "&%demime%& ACL condition"
26242 This condition is available only when Exim is compiled with the
26243 content-scanning extension. Its use is described in section
26244 &<<SECTdemimecond>>&.
26245
26246 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
26247 .cindex "&%dnslists%& ACL condition"
26248 .cindex "DNS list" "in ACL"
26249 .cindex "black list (DNS)"
26250 .cindex "&ACL;" "testing a DNS list"
26251 This condition checks for entries in DNS black lists. These are also known as
26252 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
26253 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
26254 different variants of this condition to describe briefly here. See sections
26255 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
26256
26257 .vitem &*domains&~=&~*&<&'domain&~list'&>
26258 .cindex "&%domains%& ACL condition"
26259 .cindex "domain" "ACL checking"
26260 .cindex "&ACL;" "testing a recipient domain"
26261 .vindex "&$domain_data$&"
26262 This condition is relevant only after a RCPT command. It checks that the domain
26263 of the recipient address is in the domain list. If percent-hack processing is
26264 enabled, it is done before this test is done. If the check succeeds with a
26265 lookup, the result of the lookup is placed in &$domain_data$& until the next
26266 &%domains%& test.
26267
26268 &*Note carefully*& (because many people seem to fall foul of this): you cannot
26269 use &%domains%& in a DATA ACL.
26270
26271
26272 .vitem &*encrypted&~=&~*&<&'string&~list'&>
26273 .cindex "&%encrypted%& ACL condition"
26274 .cindex "encryption" "checking in an ACL"
26275 .cindex "&ACL;" "testing for encryption"
26276 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
26277 name of the cipher suite in use is tested against the list. To test for
26278 encryption without testing for any specific cipher suite(s), set
26279 .code
26280 encrypted = *
26281 .endd
26282
26283
26284 .vitem &*hosts&~=&~*&<&'&~host&~list'&>
26285 .cindex "&%hosts%& ACL condition"
26286 .cindex "host" "ACL checking"
26287 .cindex "&ACL;" "testing the client host"
26288 This condition tests that the calling host matches the host list. If you have
26289 name lookups or wildcarded host names and IP addresses in the same host list,
26290 you should normally put the IP addresses first. For example, you could have:
26291 .code
26292 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
26293 .endd
26294 The lookup in this example uses the host name for its key. This is implied by
26295 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
26296 and it wouldn't matter which way round you had these two items.)
26297
26298 The reason for the problem with host names lies in the left-to-right way that
26299 Exim processes lists. It can test IP addresses without doing any DNS lookups,
26300 but when it reaches an item that requires a host name, it fails if it cannot
26301 find a host name to compare with the pattern. If the above list is given in the
26302 opposite order, the &%accept%& statement fails for a host whose name cannot be
26303 found, even if its IP address is 10.9.8.7.
26304
26305 If you really do want to do the name check first, and still recognize the IP
26306 address even if the name lookup fails, you can rewrite the ACL like this:
26307 .code
26308 accept hosts = dbm;/etc/friendly/hosts
26309 accept hosts = 10.9.8.7
26310 .endd
26311 The default action on failing to find the host name is to assume that the host
26312 is not in the list, so the first &%accept%& statement fails. The second
26313 statement can then check the IP address.
26314
26315 .vindex "&$host_data$&"
26316 If a &%hosts%& condition is satisfied by means of a lookup, the result
26317 of the lookup is made available in the &$host_data$& variable. This
26318 allows you, for example, to set up a statement like this:
26319 .code
26320 deny  hosts = net-lsearch;/some/file
26321 message = $host_data
26322 .endd
26323 which gives a custom error message for each denied host.
26324
26325 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
26326 .cindex "&%local_parts%& ACL condition"
26327 .cindex "local part" "ACL checking"
26328 .cindex "&ACL;" "testing a local part"
26329 .vindex "&$local_part_data$&"
26330 This condition is relevant only after a RCPT command. It checks that the local
26331 part of the recipient address is in the list. If percent-hack processing is
26332 enabled, it is done before this test. If the check succeeds with a lookup, the
26333 result of the lookup is placed in &$local_part_data$&, which remains set until
26334 the next &%local_parts%& test.
26335
26336 .vitem &*malware&~=&~*&<&'option'&>
26337 .cindex "&%malware%& ACL condition"
26338 .cindex "&ACL;" "virus scanning"
26339 .cindex "&ACL;" "scanning for viruses"
26340 This condition is available only when Exim is compiled with the
26341 content-scanning extension. It causes the incoming message to be scanned for
26342 viruses. For details, see chapter &<<CHAPexiscan>>&.
26343
26344 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
26345 .cindex "&%mime_regex%& ACL condition"
26346 .cindex "&ACL;" "testing by regex matching"
26347 This condition is available only when Exim is compiled with the
26348 content-scanning extension, and it is allowed only in the ACL defined by
26349 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
26350 with any of the regular expressions. For details, see chapter
26351 &<<CHAPexiscan>>&.
26352
26353 .vitem &*ratelimit&~=&~*&<&'parameters'&>
26354 .cindex "rate limiting"
26355 This condition can be used to limit the rate at which a user or host submits
26356 messages. Details are given in section &<<SECTratelimiting>>&.
26357
26358 .vitem &*recipients&~=&~*&<&'address&~list'&>
26359 .cindex "&%recipients%& ACL condition"
26360 .cindex "recipient" "ACL checking"
26361 .cindex "&ACL;" "testing a recipient"
26362 This condition is relevant only after a RCPT command. It checks the entire
26363 recipient address against a list of recipients.
26364
26365 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
26366 .cindex "&%regex%& ACL condition"
26367 .cindex "&ACL;" "testing by regex matching"
26368 This condition is available only when Exim is compiled with the
26369 content-scanning extension, and is available only in the DATA, MIME, and
26370 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
26371 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
26372
26373 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
26374 .cindex "&%sender_domains%& ACL condition"
26375 .cindex "sender" "ACL checking"
26376 .cindex "&ACL;" "testing a sender domain"
26377 .vindex "&$domain$&"
26378 .vindex "&$sender_address_domain$&"
26379 This condition tests the domain of the sender of the message against the given
26380 domain list. &*Note*&: The domain of the sender address is in
26381 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
26382 of this condition. This is an exception to the general rule for testing domain
26383 lists. It is done this way so that, if this condition is used in an ACL for a
26384 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
26385 influence the sender checking.
26386
26387 &*Warning*&: It is a bad idea to use this condition on its own as a control on
26388 relaying, because sender addresses are easily, and commonly, forged.
26389
26390 .vitem &*senders&~=&~*&<&'address&~list'&>
26391 .cindex "&%senders%& ACL condition"
26392 .cindex "sender" "ACL checking"
26393 .cindex "&ACL;" "testing a sender"
26394 This condition tests the sender of the message against the given list. To test
26395 for a bounce message, which has an empty sender, set
26396 .code
26397 senders = :
26398 .endd
26399 &*Warning*&: It is a bad idea to use this condition on its own as a control on
26400 relaying, because sender addresses are easily, and commonly, forged.
26401
26402 .vitem &*spam&~=&~*&<&'username'&>
26403 .cindex "&%spam%& ACL condition"
26404 .cindex "&ACL;" "scanning for spam"
26405 This condition is available only when Exim is compiled with the
26406 content-scanning extension. It causes the incoming message to be scanned by
26407 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
26408
26409 .vitem &*verify&~=&~certificate*&
26410 .cindex "&%verify%& ACL condition"
26411 .cindex "TLS" "client certificate verification"
26412 .cindex "certificate" "verification of client"
26413 .cindex "&ACL;" "certificate verification"
26414 .cindex "&ACL;" "testing a TLS certificate"
26415 This condition is true in an SMTP session if the session is encrypted, and a
26416 certificate was received from the client, and the certificate was verified. The
26417 server requests a certificate only if the client matches &%tls_verify_hosts%&
26418 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
26419
26420 .vitem &*verify&~=&~csa*&
26421 .cindex "CSA verification"
26422 This condition checks whether the sending host (the client) is authorized to
26423 send email. Details of how this works are given in section
26424 &<<SECTverifyCSA>>&.
26425
26426 .vitem &*verify&~=&~header_sender/*&<&'options'&>
26427 .cindex "&%verify%& ACL condition"
26428 .cindex "&ACL;" "verifying sender in the header"
26429 .cindex "header lines" "verifying the sender in"
26430 .cindex "sender" "verifying in header"
26431 .cindex "verifying" "sender in header"
26432 This condition is relevant only in an ACL that is run after a message has been
26433 received, that is, in an ACL specified by &%acl_smtp_data%& or
26434 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
26435 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
26436 is loosely thought of as a &"sender"& address (hence the name of the test).
26437 However, an address that appears in one of these headers need not be an address
26438 that accepts bounce messages; only sender addresses in envelopes are required
26439 to accept bounces. Therefore, if you use the callout option on this check, you
26440 might want to arrange for a non-empty address in the MAIL command.
26441
26442 Details of address verification and the options are given later, starting at
26443 section &<<SECTaddressverification>>& (callouts are described in section
26444 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
26445 condition to restrict it to bounce messages only:
26446 .code
26447 deny    senders = :
26448         message = A valid sender header is required for bounces
26449        !verify  = header_sender
26450 .endd
26451
26452 .vitem &*verify&~=&~header_syntax*&
26453 .cindex "&%verify%& ACL condition"
26454 .cindex "&ACL;" "verifying header syntax"
26455 .cindex "header lines" "verifying syntax"
26456 .cindex "verifying" "header syntax"
26457 This condition is relevant only in an ACL that is run after a message has been
26458 received, that is, in an ACL specified by &%acl_smtp_data%& or
26459 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
26460 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
26461 and &'Bcc:'&). Unqualified addresses (local parts without domains) are
26462 permitted only in locally generated messages and from hosts that match
26463 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
26464 appropriate.
26465
26466 Note that this condition is a syntax check only. However, a common spamming
26467 ploy used to be to send syntactically invalid headers such as
26468 .code
26469 To: @
26470 .endd
26471 and this condition can be used to reject such messages, though they are not as
26472 common as they used to be.
26473
26474 .vitem &*verify&~=&~helo*&
26475 .cindex "&%verify%& ACL condition"
26476 .cindex "&ACL;" "verifying HELO/EHLO"
26477 .cindex "HELO" "verifying"
26478 .cindex "EHLO" "verifying"
26479 .cindex "verifying" "EHLO"
26480 .cindex "verifying" "HELO"
26481 This condition is true if a HELO or EHLO command has been received from the
26482 client host, and its contents have been verified. If there has been no previous
26483 attempt to verify the HELO/EHLO contents, it is carried out when this
26484 condition is encountered. See the description of the &%helo_verify_hosts%& and
26485 &%helo_try_verify_hosts%& options for details of how to request verification
26486 independently of this condition.
26487
26488 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
26489 option), this condition is always true.
26490
26491
26492 .vitem &*verify&~=&~not_blind*&
26493 .cindex "verifying" "not blind"
26494 .cindex "bcc recipients, verifying none"
26495 This condition checks that there are no blind (bcc) recipients in the message.
26496 Every envelope recipient must appear either in a &'To:'& header line or in a
26497 &'Cc:'& header line for this condition to be true. Local parts are checked
26498 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
26499 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
26500 used only in a DATA or non-SMTP ACL.
26501
26502 There are, of course, many legitimate messages that make use of blind (bcc)
26503 recipients. This check should not be used on its own for blocking messages.
26504
26505
26506 .vitem &*verify&~=&~recipient/*&<&'options'&>
26507 .cindex "&%verify%& ACL condition"
26508 .cindex "&ACL;" "verifying recipient"
26509 .cindex "recipient" "verifying"
26510 .cindex "verifying" "recipient"
26511 .vindex "&$address_data$&"
26512 This condition is relevant only after a RCPT command. It verifies the current
26513 recipient. Details of address verification are given later, starting at section
26514 &<<SECTaddressverification>>&. After a recipient has been verified, the value
26515 of &$address_data$& is the last value that was set while routing the address.
26516 This applies even if the verification fails. When an address that is being
26517 verified is redirected to a single address, verification continues with the new
26518 address, and in that case, the subsequent value of &$address_data$& is the
26519 value for the child address.
26520
26521 .vitem &*verify&~=&~reverse_host_lookup*&
26522 .cindex "&%verify%& ACL condition"
26523 .cindex "&ACL;" "verifying host reverse lookup"
26524 .cindex "host" "verifying reverse lookup"
26525 This condition ensures that a verified host name has been looked up from the IP
26526 address of the client host. (This may have happened already if the host name
26527 was needed for checking a host list, or if the host matched &%host_lookup%&.)
26528 Verification ensures that the host name obtained from a reverse DNS lookup, or
26529 one of its aliases, does, when it is itself looked up in the DNS, yield the
26530 original IP address.
26531
26532 If this condition is used for a locally generated message (that is, when there
26533 is no client host involved), it always succeeds.
26534
26535 .vitem &*verify&~=&~sender/*&<&'options'&>
26536 .cindex "&%verify%& ACL condition"
26537 .cindex "&ACL;" "verifying sender"
26538 .cindex "sender" "verifying"
26539 .cindex "verifying" "sender"
26540 This condition is relevant only after a MAIL or RCPT command, or after a
26541 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
26542 the message's sender is empty (that is, this is a bounce message), the
26543 condition is true. Otherwise, the sender address is verified.
26544
26545 .vindex "&$address_data$&"
26546 .vindex "&$sender_address_data$&"
26547 If there is data in the &$address_data$& variable at the end of routing, its
26548 value is placed in &$sender_address_data$& at the end of verification. This
26549 value can be used in subsequent conditions and modifiers in the same ACL
26550 statement. It does not persist after the end of the current statement. If you
26551 want to preserve the value for longer, you can save it in an ACL variable.
26552
26553 Details of verification are given later, starting at section
26554 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
26555 to avoid doing it more than once per message.
26556
26557 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
26558 .cindex "&%verify%& ACL condition"
26559 This is a variation of the previous option, in which a modified address is
26560 verified as a sender.
26561 .endlist
26562
26563
26564
26565 .section "Using DNS lists" "SECTmorednslists"
26566 .cindex "DNS list" "in ACL"
26567 .cindex "black list (DNS)"
26568 .cindex "&ACL;" "testing a DNS list"
26569 In its simplest form, the &%dnslists%& condition tests whether the calling host
26570 is on at least one of a number of DNS lists by looking up the inverted IP
26571 address in one or more DNS domains. (Note that DNS list domains are not mail
26572 domains, so the &`+`& syntax for named lists doesn't work - it is used for
26573 special options instead.) For example, if the calling host's IP
26574 address is 192.168.62.43, and the ACL statement is
26575 .code
26576 deny dnslists = blackholes.mail-abuse.org : \
26577                 dialups.mail-abuse.org
26578 .endd
26579 the following records are looked up:
26580 .code
26581 43.62.168.192.blackholes.mail-abuse.org
26582 43.62.168.192.dialups.mail-abuse.org
26583 .endd
26584 As soon as Exim finds an existing DNS record, processing of the list stops.
26585 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
26586 to test that a host is on more than one list (an &"and"& conjunction), you can
26587 use two separate conditions:
26588 .code
26589 deny dnslists = blackholes.mail-abuse.org
26590      dnslists = dialups.mail-abuse.org
26591 .endd
26592 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
26593 behaves as if the host does not match the list item, that is, as if the DNS
26594 record does not exist. If there are further items in the DNS list, they are
26595 processed.
26596
26597 This is usually the required action when &%dnslists%& is used with &%deny%&
26598 (which is the most common usage), because it prevents a DNS failure from
26599 blocking mail. However, you can change this behaviour by putting one of the
26600 following special items in the list:
26601 .display
26602 &`+include_unknown `&   behave as if the item is on the list
26603 &`+exclude_unknown `&   behave as if the item is not on the list (default)
26604 &`+defer_unknown   `&   give a temporary error
26605 .endd
26606 .cindex "&`+include_unknown`&"
26607 .cindex "&`+exclude_unknown`&"
26608 .cindex "&`+defer_unknown`&"
26609 Each of these applies to any subsequent items on the list. For example:
26610 .code
26611 deny dnslists = +defer_unknown : foo.bar.example
26612 .endd
26613 Testing the list of domains stops as soon as a match is found. If you want to
26614 warn for one list and block for another, you can use two different statements:
26615 .code
26616 deny  dnslists = blackholes.mail-abuse.org
26617 warn  message  = X-Warn: sending host is on dialups list
26618       dnslists = dialups.mail-abuse.org
26619 .endd
26620 DNS list lookups are cached by Exim for the duration of the SMTP session,
26621 so a lookup based on the IP address is done at most once for any incoming
26622 connection. Exim does not share information between multiple incoming
26623 connections (but your local name server cache should be active).
26624
26625
26626
26627 .section "Specifying the IP address for a DNS list lookup" "SECID201"
26628 .cindex "DNS list" "keyed by explicit IP address"
26629 By default, the IP address that is used in a DNS list lookup is the IP address
26630 of the calling host. However, you can specify another IP address by listing it
26631 after the domain name, introduced by a slash. For example:
26632 .code
26633 deny dnslists = black.list.tld/192.168.1.2
26634 .endd
26635 This feature is not very helpful with explicit IP addresses; it is intended for
26636 use with IP addresses that are looked up, for example, the IP addresses of the
26637 MX hosts or nameservers of an email sender address. For an example, see section
26638 &<<SECTmulkeyfor>>& below.
26639
26640
26641
26642
26643 .section "DNS lists keyed on domain names" "SECID202"
26644 .cindex "DNS list" "keyed by domain name"
26645 There are some lists that are keyed on domain names rather than inverted IP
26646 addresses (see for example the &'domain based zones'& link at
26647 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
26648 with these lists. You can change the name that is looked up in a DNS list by
26649 listing it after the domain name, introduced by a slash. For example,
26650 .code
26651 deny  message  = Sender's domain is listed at $dnslist_domain
26652       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
26653 .endd
26654 This particular example is useful only in ACLs that are obeyed after the
26655 RCPT or DATA commands, when a sender address is available. If (for
26656 example) the message's sender is &'user@tld.example'& the name that is looked
26657 up by this example is
26658 .code
26659 tld.example.dsn.rfc-ignorant.org
26660 .endd
26661 A single &%dnslists%& condition can contain entries for both names and IP
26662 addresses. For example:
26663 .code
26664 deny dnslists = sbl.spamhaus.org : \
26665                 dsn.rfc-ignorant.org/$sender_address_domain
26666 .endd
26667 The first item checks the sending host's IP address; the second checks a domain
26668 name. The whole condition is true if either of the DNS lookups succeeds.
26669
26670
26671
26672
26673 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
26674 .cindex "DNS list" "multiple keys for"
26675 The syntax described above for looking up explicitly-defined values (either
26676 names or IP addresses) in a DNS blacklist is a simplification. After the domain
26677 name for the DNS list, what follows the slash can in fact be a list of items.
26678 As with all lists in Exim, the default separator is a colon. However, because
26679 this is a sublist within the list of DNS blacklist domains, it is necessary
26680 either to double the separators like this:
26681 .code
26682 dnslists = black.list.tld/name.1::name.2
26683 .endd
26684 or to change the separator character, like this:
26685 .code
26686 dnslists = black.list.tld/<;name.1;name.2
26687 .endd
26688 If an item in the list is an IP address, it is inverted before the DNS
26689 blacklist domain is appended. If it is not an IP address, no inversion
26690 occurs. Consider this condition:
26691 .code
26692 dnslists = black.list.tld/<;192.168.1.2;a.domain
26693 .endd
26694 The DNS lookups that occur are:
26695 .code
26696 2.1.168.192.black.list.tld
26697 a.domain.black.list.tld
26698 .endd
26699 Once a DNS record has been found (that matches a specific IP return
26700 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
26701 are done. If there is a temporary DNS error, the rest of the sublist of domains
26702 or IP addresses is tried. A temporary error for the whole dnslists item occurs
26703 only if no other DNS lookup in this sublist succeeds. In other words, a
26704 successful lookup for any of the items in the sublist overrides a temporary
26705 error for a previous item.
26706
26707 The ability to supply a list of items after the slash is in some sense just a
26708 syntactic convenience. These two examples have the same effect:
26709 .code
26710 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
26711 dnslists = black.list.tld/a.domain::b.domain
26712 .endd
26713 However, when the data for the list is obtained from a lookup, the second form
26714 is usually much more convenient. Consider this example:
26715 .code
26716 deny message  = The mail servers for the domain \
26717                 $sender_address_domain \
26718                 are listed at $dnslist_domain ($dnslist_value); \
26719                 see $dnslist_text.
26720      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
26721                                    ${lookup dnsdb {>|mxh=\
26722                                    $sender_address_domain} }} }
26723 .endd
26724 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
26725 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
26726 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
26727 of expanding the condition might be something like this:
26728 .code
26729 dnslists = sbl.spahmaus.org/<|192.168.2.3|192.168.5.6|...
26730 .endd
26731 Thus, this example checks whether or not the IP addresses of the sender
26732 domain's mail servers are on the Spamhaus black list.
26733
26734 The key that was used for a successful DNS list lookup is put into the variable
26735 &$dnslist_matched$& (see section &<<SECID204>>&).
26736
26737
26738
26739
26740 .section "Data returned by DNS lists" "SECID203"
26741 .cindex "DNS list" "data returned from"
26742 DNS lists are constructed using address records in the DNS. The original RBL
26743 just used the address 127.0.0.1 on the right hand side of each record, but the
26744 RBL+ list and some other lists use a number of values with different meanings.
26745 The values used on the RBL+ list are:
26746 .display
26747 127.1.0.1  RBL
26748 127.1.0.2  DUL
26749 127.1.0.3  DUL and RBL
26750 127.1.0.4  RSS
26751 127.1.0.5  RSS and RBL
26752 127.1.0.6  RSS and DUL
26753 127.1.0.7  RSS and DUL and RBL
26754 .endd
26755 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
26756 different values. Some DNS lists may return more than one address record;
26757 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
26758
26759
26760 .section "Variables set from DNS lists" "SECID204"
26761 .cindex "expansion" "variables, set from DNS list"
26762 .cindex "DNS list" "variables set from"
26763 .vindex "&$dnslist_domain$&"
26764 .vindex "&$dnslist_matched$&"
26765 .vindex "&$dnslist_text$&"
26766 .vindex "&$dnslist_value$&"
26767 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
26768 the name of the overall domain that matched (for example,
26769 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
26770 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
26771 the DNS record. When the key is an IP address, it is not reversed in
26772 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
26773 cases, for example:
26774 .code
26775 deny dnslists = spamhaus.example
26776 .endd
26777 the key is also available in another variable (in this case,
26778 &$sender_host_address$&). In more complicated cases, however, this is not true.
26779 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
26780 might generate a dnslists lookup like this:
26781 .code
26782 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
26783 .endd
26784 If this condition succeeds, the value in &$dnslist_matched$& might be
26785 &`192.168.6.7`& (for example).
26786
26787 If more than one address record is returned by the DNS lookup, all the IP
26788 addresses are included in &$dnslist_value$&, separated by commas and spaces.
26789 The variable &$dnslist_text$& contains the contents of any associated TXT
26790 record. For lists such as RBL+ the TXT record for a merged entry is often not
26791 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
26792 information.
26793
26794 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
26795 &-- although these appear before the condition in the ACL, they are not
26796 expanded until after it has failed. For example:
26797 .code
26798 deny    hosts = !+local_networks
26799         message = $sender_host_address is listed \
26800                   at $dnslist_domain
26801         dnslists = rbl-plus.mail-abuse.example
26802 .endd
26803
26804
26805
26806 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
26807 .cindex "DNS list" "matching specific returned data"
26808 You can add an equals sign and an IP address after a &%dnslists%& domain name
26809 in order to restrict its action to DNS records with a matching right hand side.
26810 For example,
26811 .code
26812 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
26813 .endd
26814 rejects only those hosts that yield 127.0.0.2. Without this additional data,
26815 any address record is considered to be a match. For the moment, we assume
26816 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
26817 describes how multiple records are handled.
26818
26819 More than one IP address may be given for checking, using a comma as a
26820 separator. These are alternatives &-- if any one of them matches, the
26821 &%dnslists%& condition is true. For example:
26822 .code
26823 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
26824 .endd
26825 If you want to specify a constraining address list and also specify names or IP
26826 addresses to be looked up, the constraining address list must be specified
26827 first. For example:
26828 .code
26829 deny dnslists = dsn.rfc-ignorant.org\
26830                 =127.0.0.2/$sender_address_domain
26831 .endd
26832
26833 If the character &`&&`& is used instead of &`=`&, the comparison for each
26834 listed IP address is done by a bitwise &"and"& instead of by an equality test.
26835 In other words, the listed addresses are used as bit masks. The comparison is
26836 true if all the bits in the mask are present in the address that is being
26837 tested. For example:
26838 .code
26839 dnslists = a.b.c&0.0.0.3
26840 .endd
26841 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
26842 want to test whether one bit or another bit is present (as opposed to both
26843 being present), you must use multiple values. For example:
26844 .code
26845 dnslists = a.b.c&0.0.0.1,0.0.0.2
26846 .endd
26847 matches if the final component of the address is an odd number or two times
26848 an odd number.
26849
26850
26851
26852 .section "Negated DNS matching conditions" "SECID205"
26853 You can supply a negative list of IP addresses as part of a &%dnslists%&
26854 condition. Whereas
26855 .code
26856 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
26857 .endd
26858 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
26859 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
26860 .code
26861 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
26862 .endd
26863 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
26864 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
26865 words, the result of the test is inverted if an exclamation mark appears before
26866 the &`=`& (or the &`&&`&) sign.
26867
26868 &*Note*&: This kind of negation is not the same as negation in a domain,
26869 host, or address list (which is why the syntax is different).
26870
26871 If you are using just one list, the negation syntax does not gain you much. The
26872 previous example is precisely equivalent to
26873 .code
26874 deny  dnslists = a.b.c
26875      !dnslists = a.b.c=127.0.0.2,127.0.0.3
26876 .endd
26877 However, if you are using multiple lists, the negation syntax is clearer.
26878 Consider this example:
26879 .code
26880 deny  dnslists = sbl.spamhaus.org : \
26881                  list.dsbl.org : \
26882                  dnsbl.njabl.org!=127.0.0.3 : \
26883                  relays.ordb.org
26884 .endd
26885 Using only positive lists, this would have to be:
26886 .code
26887 deny  dnslists = sbl.spamhaus.org : \
26888                  list.dsbl.org
26889 deny  dnslists = dnsbl.njabl.org
26890      !dnslists = dnsbl.njabl.org=127.0.0.3
26891 deny  dnslists = relays.ordb.org
26892 .endd
26893 which is less clear, and harder to maintain.
26894
26895
26896
26897
26898 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
26899 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
26900 thereby providing more than one IP address. When an item in a &%dnslists%& list
26901 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
26902 the match to specific results from the DNS lookup, there are two ways in which
26903 the checking can be handled. For example, consider the condition:
26904 .code
26905 dnslists = a.b.c=127.0.0.1
26906 .endd
26907 What happens if the DNS lookup for the incoming IP address yields both
26908 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
26909 condition true because at least one given value was found, or is it false
26910 because at least one of the found values was not listed? And how does this
26911 affect negated conditions? Both possibilities are provided for with the help of
26912 additional separators &`==`& and &`=&&`&.
26913
26914 .ilist
26915 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
26916 IP addresses matches one of the listed addresses. For the example above, the
26917 condition is true because 127.0.0.1 matches.
26918 .next
26919 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
26920 looked up IP addresses matches one of the listed addresses. If the condition is
26921 changed to:
26922 .code
26923 dnslists = a.b.c==127.0.0.1
26924 .endd
26925 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
26926 false because 127.0.0.2 is not listed. You would need to have:
26927 .code
26928 dnslists = a.b.c==127.0.0.1,127.0.0.2
26929 .endd
26930 for the condition to be true.
26931 .endlist
26932
26933 When &`!`& is used to negate IP address matching, it inverts the result, giving
26934 the precise opposite of the behaviour above. Thus:
26935 .ilist
26936 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
26937 addresses matches one of the listed addresses. Consider:
26938 .code
26939 dnslists = a.b.c!&0.0.0.1
26940 .endd
26941 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
26942 false because 127.0.0.1 matches.
26943 .next
26944 If &`!==`& or &`!=&&`& is used, the condition is true there is at least one
26945 looked up IP address that does not match. Consider:
26946 .code
26947 dnslists = a.b.c!=&0.0.0.1
26948 .endd
26949 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
26950 true, because 127.0.0.2 does not match. You would need to have:
26951 .code
26952 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
26953 .endd
26954 for the condition to be false.
26955 .endlist
26956 When the DNS lookup yields only a single IP address, there is no difference
26957 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
26958
26959
26960
26961
26962 .section "Detailed information from merged DNS lists" "SECTmordetinf"
26963 .cindex "DNS list" "information from merged"
26964 When the facility for restricting the matching IP values in a DNS list is used,
26965 the text from the TXT record that is set in &$dnslist_text$& may not reflect
26966 the true reason for rejection. This happens when lists are merged and the IP
26967 address in the A record is used to distinguish them; unfortunately there is
26968 only one TXT record. One way round this is not to use merged lists, but that
26969 can be inefficient because it requires multiple DNS lookups where one would do
26970 in the vast majority of cases when the host of interest is not on any of the
26971 lists.
26972
26973 A less inefficient way of solving this problem is available. If
26974 two domain names, comma-separated, are given, the second is used first to
26975 do an initial check, making use of any IP value restrictions that are set.
26976 If there is a match, the first domain is used, without any IP value
26977 restrictions, to get the TXT record. As a byproduct of this, there is also
26978 a check that the IP being tested is indeed on the first list. The first
26979 domain is the one that is put in &$dnslist_domain$&. For example:
26980 .code
26981 reject message  = \
26982          rejected because $sender_host_address is blacklisted \
26983          at $dnslist_domain\n$dnslist_text
26984        dnslists = \
26985          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
26986          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
26987 .endd
26988 For the first blacklist item, this starts by doing a lookup in
26989 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
26990 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
26991 value, and as long as something is found, it looks for the corresponding TXT
26992 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
26993 The second blacklist item is processed similarly.
26994
26995 If you are interested in more than one merged list, the same list must be
26996 given several times, but because the results of the DNS lookups are cached,
26997 the DNS calls themselves are not repeated. For example:
26998 .code
26999 reject dnslists = \
27000          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
27001          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
27002          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
27003          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
27004 .endd
27005 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
27006 values matches (or if no record is found), this is the only lookup that is
27007 done. Only if there is a match is one of the more specific lists consulted.
27008
27009
27010
27011 .section "DNS lists and IPv6" "SECTmorednslistslast"
27012 .cindex "IPv6" "DNS black lists"
27013 .cindex "DNS list" "IPv6 usage"
27014 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
27015 nibble by nibble. For example, if the calling host's IP address is
27016 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
27017 .code
27018 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
27019   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
27020 .endd
27021 (split over two lines here to fit on the page). Unfortunately, some of the DNS
27022 lists contain wildcard records, intended for IPv4, that interact badly with
27023 IPv6. For example, the DNS entry
27024 .code
27025 *.3.some.list.example.    A    127.0.0.1
27026 .endd
27027 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
27028 Unfortunately, it also matches the entire 3::/4 IPv6 network.
27029
27030 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
27031 &%condition%& condition, as in this example:
27032 .code
27033 deny   condition = ${if isip4{$sender_host_address}}
27034        dnslists  = some.list.example
27035 .endd
27036
27037 .section "Rate limiting incoming messages" "SECTratelimiting"
27038 .cindex "rate limiting" "client sending"
27039 .cindex "limiting client sending rates"
27040 .oindex "&%smtp_ratelimit_*%&"
27041 The &%ratelimit%& ACL condition can be used to measure and control the rate at
27042 which clients can send email. This is more powerful than the
27043 &%smtp_ratelimit_*%& options, because those options control the rate of
27044 commands in a single SMTP session only, whereas the &%ratelimit%& condition
27045 works across all connections (concurrent and sequential) from the same client
27046 host. The syntax of the &%ratelimit%& condition is:
27047 .display
27048 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
27049 .endd
27050 If the average client sending rate is less than &'m'& messages per time
27051 period &'p'& then the condition is false; otherwise it is true.
27052
27053 As a side-effect, the &%ratelimit%& condition sets the expansion variable
27054 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
27055 configured value of &'m'&, and &$sender_rate_period$& to the configured value
27056 of &'p'&.
27057
27058 The parameter &'p'& is the smoothing time constant, in the form of an Exim
27059 time interval, for example, &`8h`& for eight hours. A larger time constant
27060 means that it takes Exim longer to forget a client's past behaviour. The
27061 parameter &'m'& is the maximum number of messages that a client is permitted to
27062 send in each time interval. It also specifies the number of messages permitted
27063 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
27064 constant, you can allow a client to send more messages in a burst without
27065 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
27066 both small, messages must be sent at an even rate.
27067
27068 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
27069 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
27070 when deploying the &%ratelimit%& ACL condition. The script prints usage
27071 instructions when it is run with no arguments.
27072
27073 The key is used to look up the data for calculating the client's average
27074 sending rate. This data is stored in Exim's spool directory, alongside the
27075 retry and other hints databases. The default key is &$sender_host_address$&,
27076 which means Exim computes the sending rate of each client host IP address.
27077 By changing the key you can change how Exim identifies clients for the purpose
27078 of ratelimiting. For example, to limit the sending rate of each authenticated
27079 user, independent of the computer they are sending from, set the key to
27080 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
27081 example, &$authenticated_id$& is only meaningful if the client has
27082 authenticated (which you can check with the &%authenticated%& ACL condition).
27083
27084 The lookup key does not have to identify clients: If you want to limit the
27085 rate at which a recipient receives messages, you can use the key
27086 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
27087 ACL.
27088
27089 Internally, Exim appends the smoothing constant &'p'& and the options onto the
27090 lookup key because they alter the meaning of the stored data. This is not true
27091 for the limit &'m'&, so you can alter the configured maximum rate and Exim will
27092 still remember clients' past behaviour, but if you alter the other ratelimit
27093 parameters Exim forgets past behaviour.
27094
27095 Each &%ratelimit%& condition can have up to three options. One option
27096 specifies what Exim measures the rate of, and the second specifies how Exim
27097 handles excessively fast clients. The third option can be &`noupdate`&, to
27098 disable updating of the ratelimiting database (see section &<<rearatdat>>&).
27099 The options are separated by a slash, like the other parameters. They may
27100 appear in any order.
27101
27102 .section "Ratelimit options for what is being measured" "ratoptmea"
27103 The &%per_conn%& option limits the client's connection rate.
27104
27105 The &%per_mail%& option limits the client's rate of sending messages. This is
27106 the default if none of the &%per_*%& options is specified.
27107
27108 The &%per_byte%& option limits the sender's email bandwidth. Note that it is
27109 best to use this option in the DATA ACL; if it is used in an earlier ACL it
27110 relies on the SIZE parameter specified by the client in its MAIL command,
27111 which may be inaccurate or completely missing. You can follow the limit &'m'&
27112 in the configuration with K, M, or G to specify limits in kilobytes,
27113 megabytes, or gigabytes, respectively.
27114
27115 The &%per_rcpt%& option causes Exim to limit the rate at which
27116 recipients are accepted. To be effective, it would need to be used in
27117 either the &%acl_smtp_rcpt%& or the &%acl_not_smtp%& ACL. In the
27118 &%acl_smtp_rcpt%& ACL, the number of recipients is incremented by one.
27119 In the case of a locally submitted message in the &%acl_not_smtp%& ACL,
27120 the number of recipients is incremented by the &%$recipients_count%&
27121 for the entire message. Note that in either case the rate limiting
27122 engine will see a message with many recipients as a large high-speed
27123 burst.
27124
27125 The &%per_cmd%& option causes Exim to recompute the rate every time the
27126 condition is processed. This can be used to limit the SMTP command rate.
27127 This command is essentially an alias of &%per_rcpt%& to make it clear
27128 that the effect is to limit the rate at which individual commands,
27129 rather than recipients, are accepted.
27130
27131 .section "Ratelimit options for handling fast clients" "ratophanfas"
27132 If a client's average rate is greater than the maximum, the rate limiting
27133 engine can react in two possible ways, depending on the presence of the
27134 &%strict%& or &%leaky%& options. This is independent of the other
27135 counter-measures (such as rejecting the message) that may be specified by the
27136 rest of the ACL. The default mode is leaky, which avoids a sender's
27137 over-aggressive retry rate preventing it from getting any email through.
27138
27139 The &%strict%& option means that the client's recorded rate is always
27140 updated. The effect of this is that Exim measures the client's average rate
27141 of attempts to send email, which can be much higher than the maximum it is
27142 actually allowed. If the client is over the limit it may be subjected to
27143 counter-measures by the ACL until it slows down below the maximum rate. If
27144 the client stops attempting to send email for the time specified in the &'p'&
27145 parameter then its computed rate will decay exponentially to 37% of its peak
27146 value. You can work out the time (the number of smoothing periods) that a
27147 client is subjected to counter-measures after an over-limit burst with this
27148 formula:
27149 .code
27150         ln(peakrate/maxrate)
27151 .endd
27152 The &%leaky%& (default) option means that the client's recorded rate is not
27153 updated if it is above the limit. The effect of this is that Exim measures the
27154 client's average rate of successfully sent email, which cannot be greater than
27155 the maximum allowed. If the client is over the limit it may suffer some
27156 counter-measures (as specified in the ACL), but it will still be able to send
27157 email at the configured maximum rate, whatever the rate of its attempts. This
27158 is generally the better choice if you have clients that retry automatically.
27159
27160 .section "Using rate limiting" "useratlim"
27161 Exim's other ACL facilities are used to define what counter-measures are taken
27162 when the rate limit is exceeded. This might be anything from logging a warning
27163 (for example, while measuring existing sending rates in order to define
27164 policy), through time delays to slow down fast senders, up to rejecting the
27165 message. For example:
27166 .code
27167 # Log all senders' rates
27168 warn ratelimit = 0 / 1h / strict
27169      log_message = Sender rate $sender_rate / $sender_rate_period
27170
27171 # Slow down fast senders; note the need to truncate $sender_rate
27172 # at the decimal point.
27173 warn ratelimit = 100 / 1h / per_rcpt / strict
27174      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
27175                    $sender_rate_limit }s
27176
27177 # Keep authenticated users under control
27178 deny authenticated = *
27179      ratelimit = 100 / 1d / strict / $authenticated_id
27180
27181 # System-wide rate limit
27182 defer message = Sorry, too busy. Try again later.
27183      ratelimit = 10 / 1s / $primary_hostname
27184
27185 # Restrict incoming rate from each host, with a default
27186 # set using a macro and special cases looked up in a table.
27187 defer message = Sender rate exceeds $sender_rate_limit \
27188                messages per $sender_rate_period
27189      ratelimit = ${lookup {$sender_host_address} \
27190                    cdb {DB/ratelimits.cdb} \
27191                    {$value} {RATELIMIT} }
27192 .endd
27193 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
27194 especially with the &%per_rcpt%& option, you may suffer from a performance
27195 bottleneck caused by locking on the ratelimit hints database. Apart from
27196 making your ACLs less complicated, you can reduce the problem by using a
27197 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
27198 this means that Exim will lose its hints data after a reboot (including retry
27199 hints, the callout cache, and ratelimit data).
27200
27201
27202 .section "Reading ratelimit data without updating" "rearatdat"
27203 .cindex "rate limitint" "reading data without updating"
27204 If the &%noupdate%& option is present on a &%ratelimit%& ACL condition, Exim
27205 computes the rate and checks the limit as normal, but it does not update the
27206 saved data. This means that, in relevant ACLs, it is possible to lookup the
27207 existence of a specified (or auto-generated) ratelimit key without incrementing
27208 the ratelimit counter for that key. In order for this to be useful, another ACL
27209 entry must set the rate for the same key (otherwise it will always be zero).
27210 For example:
27211 .code
27212 acl_check_connect:
27213   deny ratelimit = 100 / 5m / strict / per_cmd / noupdate
27214        log_message = RATE: $sender_rate/$sender_rate_period \
27215                      (max $sender_rate_limit)
27216 .endd
27217 .display
27218 &'... some other logic and tests...'&
27219 .endd
27220 .code
27221 acl_check_mail:
27222   warn ratelimit = 100 / 5m / strict / per_cmd
27223        condition = ${if le{$sender_rate}{$sender_rate_limit}}
27224        logwrite  = RATE UPDATE: $sender_rate/$sender_rate_period \
27225                      (max $sender_rate_limit)
27226 .endd
27227 In this example, the rate is tested and used to deny access (when it is too
27228 high) in the connect ACL, but the actual computation of the remembered rate
27229 happens later, on a per-command basis, in another ACL.
27230
27231
27232
27233 .section "Address verification" "SECTaddressverification"
27234 .cindex "verifying address" "options for"
27235 .cindex "policy control" "address verification"
27236 Several of the &%verify%& conditions described in section
27237 &<<SECTaclconditions>>& cause addresses to be verified. Section
27238 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
27239 The verification conditions can be followed by options that modify the
27240 verification process. The options are separated from the keyword and from each
27241 other by slashes, and some of them contain parameters. For example:
27242 .code
27243 verify = sender/callout
27244 verify = recipient/defer_ok/callout=10s,defer_ok
27245 .endd
27246 The first stage of address verification, which always happens, is to run the
27247 address through the routers, in &"verify mode"&. Routers can detect the
27248 difference between verification and routing for delivery, and their actions can
27249 be varied by a number of generic options such as &%verify%& and &%verify_only%&
27250 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
27251 The available options are as follows:
27252
27253 .ilist
27254 If the &%callout%& option is specified, successful routing to one or more
27255 remote hosts is followed by a &"callout"& to those hosts as an additional
27256 check. Callouts and their sub-options are discussed in the next section.
27257 .next
27258 If there is a defer error while doing verification routing, the ACL
27259 normally returns &"defer"&. However, if you include &%defer_ok%& in the
27260 options, the condition is forced to be true instead. Note that this is a main
27261 verification option as well as a suboption for callouts.
27262 .next
27263 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
27264 discusses the reporting of sender address verification failures.
27265 .next
27266 The &%success_on_redirect%& option causes verification always to succeed
27267 immediately after a successful redirection. By default, if a redirection
27268 generates just one address, that address is also verified. See further
27269 discussion in section &<<SECTredirwhilveri>>&.
27270 .endlist
27271
27272 .cindex "verifying address" "differentiating failures"
27273 .vindex "&$recipient_verify_failure$&"
27274 .vindex "&$sender_verify_failure$&"
27275 .vindex "&$acl_verify_message$&"
27276 After an address verification failure, &$acl_verify_message$& contains the
27277 error message that is associated with the failure. It can be preserved by
27278 coding like this:
27279 .code
27280 warn  !verify = sender
27281        set acl_m0 = $acl_verify_message
27282 .endd
27283 If you are writing your own custom rejection message or log message when
27284 denying access, you can use this variable to include information about the
27285 verification failure.
27286
27287 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
27288 appropriate) contains one of the following words:
27289
27290 .ilist
27291 &%qualify%&: The address was unqualified (no domain), and the message
27292 was neither local nor came from an exempted host.
27293 .next
27294 &%route%&: Routing failed.
27295 .next
27296 &%mail%&: Routing succeeded, and a callout was attempted; rejection
27297 occurred at or before the MAIL command (that is, on initial
27298 connection, HELO, or MAIL).
27299 .next
27300 &%recipient%&: The RCPT command in a callout was rejected.
27301 .next
27302 &%postmaster%&: The postmaster check in a callout was rejected.
27303 .endlist
27304
27305 The main use of these variables is expected to be to distinguish between
27306 rejections of MAIL and rejections of RCPT in callouts.
27307
27308
27309
27310
27311 .section "Callout verification" "SECTcallver"
27312 .cindex "verifying address" "by callout"
27313 .cindex "callout" "verification"
27314 .cindex "SMTP" "callout verification"
27315 For non-local addresses, routing verifies the domain, but is unable to do any
27316 checking of the local part. There are situations where some means of verifying
27317 the local part is desirable. One way this can be done is to make an SMTP
27318 &'callback'& to a delivery host for the sender address or a &'callforward'& to
27319 a subsequent host for a recipient address, to see if the host accepts the
27320 address. We use the term &'callout'& to cover both cases. Note that for a
27321 sender address, the callback is not to the client host that is trying to
27322 deliver the message, but to one of the hosts that accepts incoming mail for the
27323 sender's domain.
27324
27325 Exim does not do callouts by default. If you want them to happen, you must
27326 request them by setting appropriate options on the &%verify%& condition, as
27327 described below. This facility should be used with care, because it can add a
27328 lot of resource usage to the cost of verifying an address. However, Exim does
27329 cache the results of callouts, which helps to reduce the cost. Details of
27330 caching are in section &<<SECTcallvercache>>&.
27331
27332 Recipient callouts are usually used only between hosts that are controlled by
27333 the same administration. For example, a corporate gateway host could use
27334 callouts to check for valid recipients on an internal mailserver. A successful
27335 callout does not guarantee that a real delivery to the address would succeed;
27336 on the other hand, a failing callout does guarantee that a delivery would fail.
27337
27338 If the &%callout%& option is present on a condition that verifies an address, a
27339 second stage of verification occurs if the address is successfully routed to
27340 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
27341 &(manualroute)& router, where the router specifies the hosts. However, if a
27342 router that does not set up hosts routes to an &(smtp)& transport with a
27343 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
27344 &%hosts_override%& set, its hosts are always used, whether or not the router
27345 supplies a host list.
27346
27347 The port that is used is taken from the transport, if it is specified and is a
27348 remote transport. (For routers that do verification only, no transport need be
27349 specified.) Otherwise, the default SMTP port is used. If a remote transport
27350 specifies an outgoing interface, this is used; otherwise the interface is not
27351 specified. Likewise, the text that is used for the HELO command is taken from
27352 the transport's &%helo_data%& option; if there is no transport, the value of
27353 &$smtp_active_hostname$& is used.
27354
27355 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
27356 test whether a bounce message could be delivered to the sender address. The
27357 following SMTP commands are sent:
27358 .display
27359 &`HELO `&<&'local host name'&>
27360 &`MAIL FROM:<>`&
27361 &`RCPT TO:`&<&'the address to be tested'&>
27362 &`QUIT`&
27363 .endd
27364 LHLO is used instead of HELO if the transport's &%protocol%& option is
27365 set to &"lmtp"&.
27366
27367 A recipient callout check is similar. By default, it also uses an empty address
27368 for the sender. This default is chosen because most hosts do not make use of
27369 the sender address when verifying a recipient. Using the same address means
27370 that a single cache entry can be used for each recipient. Some sites, however,
27371 do make use of the sender address when verifying. These are catered for by the
27372 &%use_sender%& and &%use_postmaster%& options, described in the next section.
27373
27374 If the response to the RCPT command is a 2&'xx'& code, the verification
27375 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
27376 Exim tries the next host, if any. If there is a problem with all the remote
27377 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
27378 &%callout%& option is given, in which case the condition is forced to succeed.
27379
27380 .cindex "SMTP" "output flushing, disabling for callout"
27381 A callout may take a little time. For this reason, Exim normally flushes SMTP
27382 output before performing a callout in an ACL, to avoid unexpected timeouts in
27383 clients when the SMTP PIPELINING extension is in use. The flushing can be
27384 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
27385
27386
27387
27388
27389 .section "Additional parameters for callouts" "CALLaddparcall"
27390 .cindex "callout" "additional parameters for"
27391 The &%callout%& option can be followed by an equals sign and a number of
27392 optional parameters, separated by commas. For example:
27393 .code
27394 verify = recipient/callout=10s,defer_ok
27395 .endd
27396 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
27397 separate verify options, is retained for backwards compatibility, but is now
27398 deprecated. The additional parameters for &%callout%& are as follows:
27399
27400
27401 .vlist
27402 .vitem <&'a&~time&~interval'&>
27403 .cindex "callout" "timeout, specifying"
27404 This specifies the timeout that applies for the callout attempt to each host.
27405 For example:
27406 .code
27407 verify = sender/callout=5s
27408 .endd
27409 The default is 30 seconds. The timeout is used for each response from the
27410 remote host. It is also used for the initial connection, unless overridden by
27411 the &%connect%& parameter.
27412
27413
27414 .vitem &*connect&~=&~*&<&'time&~interval'&>
27415 .cindex "callout" "connection timeout, specifying"
27416 This parameter makes it possible to set a different (usually smaller) timeout
27417 for making the SMTP connection. For example:
27418 .code
27419 verify = sender/callout=5s,connect=1s
27420 .endd
27421 If not specified, this timeout defaults to the general timeout value.
27422
27423 .vitem &*defer_ok*&
27424 .cindex "callout" "defer, action on"
27425 When this parameter is present, failure to contact any host, or any other kind
27426 of temporary error, is treated as success by the ACL. However, the cache is not
27427 updated in this circumstance.
27428
27429 .vitem &*fullpostmaster*&
27430 .cindex "callout" "full postmaster check"
27431 This operates like the &%postmaster%& option (see below), but if the check for
27432 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
27433 accordance with the specification in RFC 2821. The RFC states that the
27434 unqualified address &'postmaster'& should be accepted.
27435
27436
27437 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
27438 .cindex "callout" "sender when verifying header"
27439 When verifying addresses in header lines using the &%header_sender%&
27440 verification option, Exim behaves by default as if the addresses are envelope
27441 sender addresses from a message. Callout verification therefore tests to see
27442 whether a bounce message could be delivered, by using an empty address in the
27443 MAIL command. However, it is arguable that these addresses might never be used
27444 as envelope senders, and could therefore justifiably reject bounce messages
27445 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
27446 address to use in the MAIL command. For example:
27447 .code
27448 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
27449 .endd
27450 This parameter is available only for the &%header_sender%& verification option.
27451
27452
27453 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
27454 .cindex "callout" "overall timeout, specifying"
27455 This parameter sets an overall timeout for performing a callout verification.
27456 For example:
27457 .code
27458 verify = sender/callout=5s,maxwait=30s
27459 .endd
27460 This timeout defaults to four times the callout timeout for individual SMTP
27461 commands. The overall timeout applies when there is more than one host that can
27462 be tried. The timeout is checked before trying the next host. This prevents
27463 very long delays if there are a large number of hosts and all are timing out
27464 (for example, when network connections are timing out).
27465
27466
27467 .vitem &*no_cache*&
27468 .cindex "callout" "cache, suppressing"
27469 .cindex "caching callout, suppressing"
27470 When this parameter is given, the callout cache is neither read nor updated.
27471
27472 .vitem &*postmaster*&
27473 .cindex "callout" "postmaster; checking"
27474 When this parameter is set, a successful callout check is followed by a similar
27475 check for the local part &'postmaster'& at the same domain. If this address is
27476 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
27477 the postmaster check is recorded in a cache record; if it is a failure, this is
27478 used to fail subsequent callouts for the domain without a connection being
27479 made, until the cache record expires.
27480
27481 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
27482 The postmaster check uses an empty sender in the MAIL command by default.
27483 You can use this parameter to do a postmaster check using a different address.
27484 For example:
27485 .code
27486 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
27487 .endd
27488 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
27489 one overrides. The &%postmaster%& parameter is equivalent to this example:
27490 .code
27491 require  verify = sender/callout=postmaster_mailfrom=
27492 .endd
27493 &*Warning*&: The caching arrangements for postmaster checking do not take
27494 account of the sender address. It is assumed that either the empty address or
27495 a fixed non-empty address will be used. All that Exim remembers is that the
27496 postmaster check for the domain succeeded or failed.
27497
27498
27499 .vitem &*random*&
27500 .cindex "callout" "&""random""& check"
27501 When this parameter is set, before doing the normal callout check, Exim does a
27502 check for a &"random"& local part at the same domain. The local part is not
27503 really random &-- it is defined by the expansion of the option
27504 &%callout_random_local_part%&, which defaults to
27505 .code
27506 $primary_host_name-$tod_epoch-testing
27507 .endd
27508 The idea here is to try to determine whether the remote host accepts all local
27509 parts without checking. If it does, there is no point in doing callouts for
27510 specific local parts. If the &"random"& check succeeds, the result is saved in
27511 a cache record, and used to force the current and subsequent callout checks to
27512 succeed without a connection being made, until the cache record expires.
27513
27514 .vitem &*use_postmaster*&
27515 .cindex "callout" "sender for recipient check"
27516 This parameter applies to recipient callouts only. For example:
27517 .code
27518 deny  !verify = recipient/callout=use_postmaster
27519 .endd
27520 .vindex "&$qualify_domain$&"
27521 It causes a non-empty postmaster address to be used in the MAIL command when
27522 performing the callout for the recipient, and also for a &"random"& check if
27523 that is configured. The local part of the address is &`postmaster`& and the
27524 domain is the contents of &$qualify_domain$&.
27525
27526 .vitem &*use_sender*&
27527 This option applies to recipient callouts only. For example:
27528 .code
27529 require  verify = recipient/callout=use_sender
27530 .endd
27531 It causes the message's actual sender address to be used in the MAIL
27532 command when performing the callout, instead of an empty address. There is no
27533 need to use this option unless you know that the called hosts make use of the
27534 sender when checking recipients. If used indiscriminately, it reduces the
27535 usefulness of callout caching.
27536 .endlist
27537
27538 If you use any of the parameters that set a non-empty sender for the MAIL
27539 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
27540 &%use_sender%&), you should think about possible loops. Recipient checking is
27541 usually done between two hosts that are under the same management, and the host
27542 that receives the callouts is not normally configured to do callouts itself.
27543 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
27544 these circumstances.
27545
27546 However, if you use a non-empty sender address for a callout to an arbitrary
27547 host, there is the likelihood that the remote host will itself initiate a
27548 callout check back to your host. As it is checking what appears to be a message
27549 sender, it is likely to use an empty address in MAIL, thus avoiding a
27550 callout loop. However, to be on the safe side it would be best to set up your
27551 own ACLs so that they do not do sender verification checks when the recipient
27552 is the address you use for header sender or postmaster callout checking.
27553
27554 Another issue to think about when using non-empty senders for callouts is
27555 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
27556 by the sender/recipient combination; thus, for any given recipient, many more
27557 actual callouts are performed than when an empty sender or postmaster is used.
27558
27559
27560
27561
27562 .section "Callout caching" "SECTcallvercache"
27563 .cindex "hints database" "callout cache"
27564 .cindex "callout" "cache, description of"
27565 .cindex "caching" "callout"
27566 Exim caches the results of callouts in order to reduce the amount of resources
27567 used, unless you specify the &%no_cache%& parameter with the &%callout%&
27568 option. A hints database called &"callout"& is used for the cache. Two
27569 different record types are used: one records the result of a callout check for
27570 a specific address, and the other records information that applies to the
27571 entire domain (for example, that it accepts the local part &'postmaster'&).
27572
27573 When an original callout fails, a detailed SMTP error message is given about
27574 the failure. However, for subsequent failures use the cache data, this message
27575 is not available.
27576
27577 The expiry times for negative and positive address cache records are
27578 independent, and can be set by the global options &%callout_negative_expire%&
27579 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
27580
27581 If a host gives a negative response to an SMTP connection, or rejects any
27582 commands up to and including
27583 .code
27584 MAIL FROM:<>
27585 .endd
27586 (but not including the MAIL command with a non-empty address),
27587 any callout attempt is bound to fail. Exim remembers such failures in a
27588 domain cache record, which it uses to fail callouts for the domain without
27589 making new connections, until the domain record times out. There are two
27590 separate expiry times for domain cache records:
27591 &%callout_domain_negative_expire%& (default 3h) and
27592 &%callout_domain_positive_expire%& (default 7d).
27593
27594 Domain records expire when the negative expiry time is reached if callouts
27595 cannot be made for the domain, or if the postmaster check failed.
27596 Otherwise, they expire when the positive expiry time is reached. This
27597 ensures that, for example, a host that stops accepting &"random"& local parts
27598 will eventually be noticed.
27599
27600 The callout caching mechanism is based on the domain of the address that is
27601 being tested. If the domain routes to several hosts, it is assumed that their
27602 behaviour will be the same.
27603
27604
27605
27606 .section "Sender address verification reporting" "SECTsenaddver"
27607 .cindex "verifying" "suppressing error details"
27608 See section &<<SECTaddressverification>>& for a general discussion of
27609 verification. When sender verification fails in an ACL, the details of the
27610 failure are given as additional output lines before the 550 response to the
27611 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
27612 you might see:
27613 .code
27614 MAIL FROM:<xyz@abc.example>
27615 250 OK
27616 RCPT TO:<pqr@def.example>
27617 550-Verification failed for <xyz@abc.example>
27618 550-Called:   192.168.34.43
27619 550-Sent:     RCPT TO:<xyz@abc.example>
27620 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
27621 550 Sender verification failed
27622 .endd
27623 If more than one RCPT command fails in the same way, the details are given
27624 only for the first of them. However, some administrators do not want to send
27625 out this much information. You can suppress the details by adding
27626 &`/no_details`& to the ACL statement that requests sender verification. For
27627 example:
27628 .code
27629 verify = sender/no_details
27630 .endd
27631
27632 .section "Redirection while verifying" "SECTredirwhilveri"
27633 .cindex "verifying" "redirection while"
27634 .cindex "address redirection" "while verifying"
27635 A dilemma arises when a local address is redirected by aliasing or forwarding
27636 during verification: should the generated addresses themselves be verified,
27637 or should the successful expansion of the original address be enough to verify
27638 it? By default, Exim takes the following pragmatic approach:
27639
27640 .ilist
27641 When an incoming address is redirected to just one child address, verification
27642 continues with the child address, and if that fails to verify, the original
27643 verification also fails.
27644 .next
27645 When an incoming address is redirected to more than one child address,
27646 verification does not continue. A success result is returned.
27647 .endlist
27648
27649 This seems the most reasonable behaviour for the common use of aliasing as a
27650 way of redirecting different local parts to the same mailbox. It means, for
27651 example, that a pair of alias entries of the form
27652 .code
27653 A.Wol:   aw123
27654 aw123:   :fail: Gone away, no forwarding address
27655 .endd
27656 work as expected, with both local parts causing verification failure. When a
27657 redirection generates more than one address, the behaviour is more like a
27658 mailing list, where the existence of the alias itself is sufficient for
27659 verification to succeed.
27660
27661 It is possible, however, to change the default behaviour so that all successful
27662 redirections count as successful verifications, however many new addresses are
27663 generated. This is specified by the &%success_on_redirect%& verification
27664 option. For example:
27665 .code
27666 require verify = recipient/success_on_redirect/callout=10s
27667 .endd
27668 In this example, verification succeeds if a router generates a new address, and
27669 the callout does not occur, because no address was routed to a remote host.
27670
27671 When verification is being tested via the &%-bv%& option, the treatment of
27672 redirections is as just described, unless the &%-v%& or any debugging option is
27673 also specified. In that case, full verification is done for every generated
27674 address and a report is output for each of them.
27675
27676
27677
27678 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
27679 .cindex "CSA" "verifying"
27680 Client SMTP Authorization is a system that allows a site to advertise
27681 which machines are and are not permitted to send email. This is done by placing
27682 special SRV records in the DNS; these are looked up using the client's HELO
27683 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
27684 Authorization checks in Exim are performed by the ACL condition:
27685 .code
27686 verify = csa
27687 .endd
27688 This fails if the client is not authorized. If there is a DNS problem, or if no
27689 valid CSA SRV record is found, or if the client is authorized, the condition
27690 succeeds. These three cases can be distinguished using the expansion variable
27691 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
27692 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
27693 be likely to cause problems for legitimate email.
27694
27695 The error messages produced by the CSA code include slightly more
27696 detail. If &$csa_status$& is &"defer"&, this may be because of problems
27697 looking up the CSA SRV record, or problems looking up the CSA target
27698 address record. There are four reasons for &$csa_status$& being &"fail"&:
27699
27700 .ilist
27701 The client's host name is explicitly not authorized.
27702 .next
27703 The client's IP address does not match any of the CSA target IP addresses.
27704 .next
27705 The client's host name is authorized but it has no valid target IP addresses
27706 (for example, the target's addresses are IPv6 and the client is using IPv4).
27707 .next
27708 The client's host name has no CSA SRV record but a parent domain has asserted
27709 that all subdomains must be explicitly authorized.
27710 .endlist
27711
27712 The &%csa%& verification condition can take an argument which is the domain to
27713 use for the DNS query. The default is:
27714 .code
27715 verify = csa/$sender_helo_name
27716 .endd
27717 This implementation includes an extension to CSA. If the query domain
27718 is an address literal such as [192.0.2.95], or if it is a bare IP
27719 address, Exim searches for CSA SRV records in the reverse DNS as if
27720 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
27721 meaningful to say:
27722 .code
27723 verify = csa/$sender_host_address
27724 .endd
27725 In fact, this is the check that Exim performs if the client does not say HELO.
27726 This extension can be turned off by setting the main configuration option
27727 &%dns_csa_use_reverse%& to be false.
27728
27729 If a CSA SRV record is not found for the domain itself, a search
27730 is performed through its parent domains for a record which might be
27731 making assertions about subdomains. The maximum depth of this search is limited
27732 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
27733 default. Exim does not look for CSA SRV records in a top level domain, so the
27734 default settings handle HELO domains as long as seven
27735 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
27736 of legitimate HELO domains.
27737
27738 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
27739 direct SRV lookups, this is not sufficient because of the extra parent domain
27740 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
27741 addresses into lookups in the reverse DNS space. The result of a successful
27742 lookup such as:
27743 .code
27744 ${lookup dnsdb {csa=$sender_helo_name}}
27745 .endd
27746 has two space-separated fields: an authorization code and a target host name.
27747 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
27748 authorization required but absent, or &"?"& for unknown.
27749
27750
27751
27752
27753 .section "Bounce address tag validation" "SECTverifyPRVS"
27754 .cindex "BATV, verifying"
27755 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
27756 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
27757 Genuine incoming bounce messages should therefore always be addressed to
27758 recipients that have a valid tag. This scheme is a way of detecting unwanted
27759 bounce messages caused by sender address forgeries (often called &"collateral
27760 spam"&), because the recipients of such messages do not include valid tags.
27761
27762 There are two expansion items to help with the implementation of the BATV
27763 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
27764 the original envelope sender address by using a simple key to add a hash of the
27765 address and some time-based randomizing information. The &%prvs%& expansion
27766 item creates a signed address, and the &%prvscheck%& expansion item checks one.
27767 The syntax of these expansion items is described in section
27768 &<<SECTexpansionitems>>&.
27769
27770 As an example, suppose the secret per-address keys are stored in an MySQL
27771 database. A query to look up the key for an address could be defined as a macro
27772 like this:
27773 .code
27774 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
27775                 WHERE sender='${quote_mysql:$prvscheck_address}'\
27776                 }{$value}}
27777 .endd
27778 Suppose also that the senders who make use of BATV are defined by an address
27779 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
27780 use this:
27781 .code
27782 # Bounces: drop unsigned addresses for BATV senders
27783 deny message = This address does not send an unsigned reverse path
27784      senders = :
27785      recipients = +batv_senders
27786
27787 # Bounces: In case of prvs-signed address, check signature.
27788 deny message = Invalid reverse path signature.
27789      senders = :
27790      condition  = ${prvscheck {$local_part@$domain}\
27791                   {PRVSCHECK_SQL}{1}}
27792      !condition = $prvscheck_result
27793 .endd
27794 The first statement rejects recipients for bounce messages that are addressed
27795 to plain BATV sender addresses, because it is known that BATV senders do not
27796 send out messages with plain sender addresses. The second statement rejects
27797 recipients that are prvs-signed, but with invalid signatures (either because
27798 the key is wrong, or the signature has timed out).
27799
27800 A non-prvs-signed address is not rejected by the second statement, because the
27801 &%prvscheck%& expansion yields an empty string if its first argument is not a
27802 prvs-signed address, thus causing the &%condition%& condition to be false. If
27803 the first argument is a syntactically valid prvs-signed address, the yield is
27804 the third string (in this case &"1"&), whether or not the cryptographic and
27805 timeout checks succeed. The &$prvscheck_result$& variable contains the result
27806 of the checks (empty for failure, &"1"& for success).
27807
27808 There is one more issue you must consider when implementing prvs-signing:
27809 you have to ensure that the routers accept prvs-signed addresses and
27810 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
27811 router to remove the signature with a configuration along these lines:
27812 .code
27813 batv_redirect:
27814   driver = redirect
27815   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
27816 .endd
27817 This works because, if the third argument of &%prvscheck%& is empty, the result
27818 of the expansion of a prvs-signed address is the decoded value of the original
27819 address. This router should probably be the first of your routers that handles
27820 local addresses.
27821
27822 To create BATV-signed addresses in the first place, a transport of this form
27823 can be used:
27824 .code
27825 external_smtp_batv:
27826   driver = smtp
27827   return_path = ${prvs {$return_path} \
27828                        {${lookup mysql{SELECT \
27829                        secret FROM batv_prvs WHERE \
27830                        sender='${quote_mysql:$sender_address}'} \
27831                        {$value}fail}}}
27832 .endd
27833 If no key can be found for the existing return path, no signing takes place.
27834
27835
27836
27837 .section "Using an ACL to control relaying" "SECTrelaycontrol"
27838 .cindex "&ACL;" "relay control"
27839 .cindex "relaying" "control by ACL"
27840 .cindex "policy control" "relay control"
27841 An MTA is said to &'relay'& a message if it receives it from some host and
27842 delivers it directly to another host as a result of a remote address contained
27843 within it. Redirecting a local address via an alias or forward file and then
27844 passing the message on to another host is not relaying,
27845 .cindex "&""percent hack""&"
27846 but a redirection as a result of the &"percent hack"& is.
27847
27848 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
27849 A host which is acting as a gateway or an MX backup is concerned with incoming
27850 relaying from arbitrary hosts to a specific set of domains. On the other hand,
27851 a host which is acting as a smart host for a number of clients is concerned
27852 with outgoing relaying from those clients to the Internet at large. Often the
27853 same host is fulfilling both functions,
27854 . ///
27855 . as illustrated in the diagram below,
27856 . ///
27857 but in principle these two kinds of relaying are entirely independent. What is
27858 not wanted is the transmission of mail from arbitrary remote hosts through your
27859 system to arbitrary domains.
27860
27861
27862 You can implement relay control by means of suitable statements in the ACL that
27863 runs for each RCPT command. For convenience, it is often easiest to use
27864 Exim's named list facility to define the domains and hosts involved. For
27865 example, suppose you want to do the following:
27866
27867 .ilist
27868 Deliver a number of domains to mailboxes on the local host (or process them
27869 locally in some other way). Let's say these are &'my.dom1.example'& and
27870 &'my.dom2.example'&.
27871 .next
27872 Relay mail for a number of other domains for which you are the secondary MX.
27873 These might be &'friend1.example'& and &'friend2.example'&.
27874 .next
27875 Relay mail from the hosts on your local LAN, to whatever domains are involved.
27876 Suppose your LAN is 192.168.45.0/24.
27877 .endlist
27878
27879
27880 In the main part of the configuration, you put the following definitions:
27881 .code
27882 domainlist local_domains = my.dom1.example : my.dom2.example
27883 domainlist relay_domains = friend1.example : friend2.example
27884 hostlist   relay_hosts   = 192.168.45.0/24
27885 .endd
27886 Now you can use these definitions in the ACL that is run for every RCPT
27887 command:
27888 .code
27889 acl_check_rcpt:
27890   accept domains = +local_domains : +relay_domains
27891   accept hosts   = +relay_hosts
27892 .endd
27893 The first statement accepts any RCPT command that contains an address in
27894 the local or relay domains. For any other domain, control passes to the second
27895 statement, which accepts the command only if it comes from one of the relay
27896 hosts. In practice, you will probably want to make your ACL more sophisticated
27897 than this, for example, by including sender and recipient verification. The
27898 default configuration includes a more comprehensive example, which is described
27899 in chapter &<<CHAPdefconfil>>&.
27900
27901
27902
27903 .section "Checking a relay configuration" "SECTcheralcon"
27904 .cindex "relaying" "checking control of"
27905 You can check the relay characteristics of your configuration in the same way
27906 that you can test any ACL behaviour for an incoming SMTP connection, by using
27907 the &%-bh%& option to run a fake SMTP session with which you interact.
27908
27909 For specifically testing for unwanted relaying, the host
27910 &'relay-test.mail-abuse.org'& provides a useful service. If you telnet to this
27911 host from the host on which Exim is running, using the normal telnet port, you
27912 will see a normal telnet connection message and then quite a long delay. Be
27913 patient. The remote host is making an SMTP connection back to your host, and
27914 trying a number of common probes to test for open relay vulnerability. The
27915 results of the tests will eventually appear on your terminal.
27916 .ecindex IIDacl
27917
27918
27919
27920 . ////////////////////////////////////////////////////////////////////////////
27921 . ////////////////////////////////////////////////////////////////////////////
27922
27923 .chapter "Content scanning at ACL time" "CHAPexiscan"
27924 .scindex IIDcosca "content scanning" "at ACL time"
27925 The extension of Exim to include content scanning at ACL time, formerly known
27926 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
27927 was integrated into the main source for Exim release 4.50, and Tom continues to
27928 maintain it. Most of the wording of this chapter is taken from Tom's
27929 specification.
27930
27931 It is also possible to scan the content of messages at other times. The
27932 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
27933 scanning after all the ACLs have run. A transport filter can be used to scan
27934 messages at delivery time (see the &%transport_filter%& option, described in
27935 chapter &<<CHAPtransportgeneric>>&).
27936
27937 If you want to include the ACL-time content-scanning features when you compile
27938 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
27939 &_Local/Makefile_&. When you do that, the Exim binary is built with:
27940
27941 .ilist
27942 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
27943 for all MIME parts for SMTP and non-SMTP messages, respectively.
27944 .next
27945 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
27946 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
27947 run at the end of message reception (the &%acl_smtp_data%& ACL).
27948 .next
27949 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
27950 of messages, or parts of messages, for debugging purposes.
27951 .next
27952 Additional expansion variables that are set in the new ACL and by the new
27953 conditions.
27954 .next
27955 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
27956 .endlist
27957
27958 There is another content-scanning configuration option for &_Local/Makefile_&,
27959 called WITH_OLD_DEMIME. If this is set, the old, deprecated &%demime%& ACL
27960 condition is compiled, in addition to all the other content-scanning features.
27961
27962 Content-scanning is continually evolving, and new features are still being
27963 added. While such features are still unstable and liable to incompatible
27964 changes, they are made available in Exim by setting options whose names begin
27965 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
27966 this manual. You can find out about them by reading the file called
27967 &_doc/experimental.txt_&.
27968
27969 All the content-scanning facilities work on a MBOX copy of the message that is
27970 temporarily created in a file called:
27971 .display
27972 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
27973 .endd
27974 The &_.eml_& extension is a friendly hint to virus scanners that they can
27975 expect an MBOX-like structure inside that file. The file is created when the
27976 first content scanning facility is called. Subsequent calls to content
27977 scanning conditions open the same file again. The directory is recursively
27978 removed when the &%acl_smtp_data%& ACL has finished running, unless
27979 .code
27980 control = no_mbox_unspool
27981 .endd
27982 has been encountered. When the MIME ACL decodes files, they are put into the
27983 same directory by default.
27984
27985
27986
27987 .section "Scanning for viruses" "SECTscanvirus"
27988 .cindex "virus scanning"
27989 .cindex "content scanning" "for viruses"
27990 .cindex "content scanning" "the &%malware%& condition"
27991 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
27992 It supports a &"generic"& interface to scanners called via the shell, and
27993 specialized interfaces for &"daemon"& type virus scanners, which are resident
27994 in memory and thus are much faster.
27995
27996 .oindex "&%av_scanner%&"
27997 You can set the &%av_scanner%& option in first part of the Exim configuration
27998 file to specify which scanner to use, together with any additional options that
27999 are needed. The basic syntax is as follows:
28000 .display
28001 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
28002 .endd
28003 If you do not set &%av_scanner%&, it defaults to
28004 .code
28005 av_scanner = sophie:/var/run/sophie
28006 .endd
28007 If the value of &%av_scanner%& starts with a dollar character, it is expanded
28008 before use. The following scanner types are supported in this release:
28009
28010 .vlist
28011 .vitem &%aveserver%&
28012 .cindex "virus scanners" "Kaspersky"
28013 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
28014 at &url(http://www.kaspersky.com). This scanner type takes one option,
28015 which is the path to the daemon's UNIX socket. The default is shown in this
28016 example:
28017 .code
28018 av_scanner = aveserver:/var/run/aveserver
28019 .endd
28020
28021 .vitem &%clamd%&
28022 .cindex "virus scanners" "clamd"
28023 This daemon-type scanner is GPL and free. You can get it at
28024 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
28025 unpack MIME containers, so it used to be recommended to unpack MIME attachments
28026 in the MIME ACL. This no longer believed to be necessary. One option is
28027 required: either the path and name of a UNIX socket file, or a hostname or IP
28028 number, and a port, separated by space, as in the second of these examples:
28029 .code
28030 av_scanner = clamd:/opt/clamd/socket
28031 av_scanner = clamd:192.0.2.3 1234
28032 av_scanner = clamd:192.0.2.3 1234:local
28033 .endd
28034 If the value of av_scanner points to a UNIX socket file or contains the local
28035 keyword, then the ClamAV interface will pass a filename containing the data
28036 to be scanned, which will should normally result in less I/O happening and be
28037 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
28038 Exim does not assume that there is a common filesystem with the remote host.
28039 There is an option WITH_OLD_CLAMAV_STREAM in &_src/EDITME_& available, should
28040 you be running a version of ClamAV prior to 0.95.
28041 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
28042 contributing the code for this scanner.
28043
28044 .vitem &%cmdline%&
28045 .cindex "virus scanners" "command line interface"
28046 This is the keyword for the generic command line scanner interface. It can be
28047 used to attach virus scanners that are invoked from the shell. This scanner
28048 type takes 3 mandatory options:
28049
28050 .olist
28051 The full path and name of the scanner binary, with all command line options,
28052 and a placeholder (&`%s`&) for the directory to scan.
28053
28054 .next
28055 A regular expression to match against the STDOUT and STDERR output of the
28056 virus scanner. If the expression matches, a virus was found. You must make
28057 absolutely sure that this expression matches on &"virus found"&. This is called
28058 the &"trigger"& expression.
28059
28060 .next
28061 Another regular expression, containing exactly one pair of parentheses, to
28062 match the name of the virus found in the scanners output. This is called the
28063 &"name"& expression.
28064 .endlist olist
28065
28066 For example, Sophos Sweep reports a virus on a line like this:
28067 .code
28068 Virus 'W32/Magistr-B' found in file ./those.bat
28069 .endd
28070 For the trigger expression, we can match the phrase &"found in file"&. For the
28071 name expression, we want to extract the W32/Magistr-B string, so we can match
28072 for the single quotes left and right of it. Altogether, this makes the
28073 configuration setting:
28074 .code
28075 av_scanner = cmdline:\
28076              /path/to/sweep -ss -all -rec -archive %s:\
28077              found in file:'(.+)'
28078 .endd
28079 .vitem &%drweb%&
28080 .cindex "virus scanners" "DrWeb"
28081 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface takes one
28082 argument, either a full path to a UNIX socket, or an IP address and port
28083 separated by white space, as in these examples:
28084 .code
28085 av_scanner = drweb:/var/run/drwebd.sock
28086 av_scanner = drweb:192.168.2.20 31337
28087 .endd
28088 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
28089 is used. Thanks to Alex Miller for contributing the code for this scanner.
28090
28091 .vitem &%fsecure%&
28092 .cindex "virus scanners" "F-Secure"
28093 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
28094 argument which is the path to a UNIX socket. For example:
28095 .code
28096 av_scanner = fsecure:/path/to/.fsav
28097 .endd
28098 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
28099 Thelmen for contributing the code for this scanner.
28100
28101 .vitem &%kavdaemon%&
28102 .cindex "virus scanners" "Kaspersky"
28103 This is the scanner daemon of Kaspersky Version 4. This version of the
28104 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
28105 scanner type takes one option, which is the path to the daemon's UNIX socket.
28106 For example:
28107 .code
28108 av_scanner = kavdaemon:/opt/AVP/AvpCtl
28109 .endd
28110 The default path is &_/var/run/AvpCtl_&.
28111
28112 .vitem &%mksd%&
28113 .cindex "virus scanners" "mksd"
28114 This is a daemon type scanner that is aimed mainly at Polish users, though some
28115 parts of documentation are now available in English. You can get it at
28116 &url(http://linux.mks.com.pl/). The only option for this scanner type is
28117 the maximum number of processes used simultaneously to scan the attachments,
28118 provided that the demime facility is employed and also provided that mksd has
28119 been run with at least the same number of child processes. For example:
28120 .code
28121 av_scanner = mksd:2
28122 .endd
28123 You can safely omit this option (the default value is 1).
28124
28125 .vitem &%sophie%&
28126 .cindex "virus scanners" "Sophos and Sophie"
28127 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
28128 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
28129 for this scanner type is the path to the UNIX socket that Sophie uses for
28130 client communication. For example:
28131 .code
28132 av_scanner = sophie:/tmp/sophie
28133 .endd
28134 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
28135 the option.
28136 .endlist
28137
28138 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
28139 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
28140 ACL.
28141
28142 The &%av_scanner%& option is expanded each time &%malware%& is called. This
28143 makes it possible to use different scanners. See further below for an example.
28144 The &%malware%& condition caches its results, so when you use it multiple times
28145 for the same message, the actual scanning process is only carried out once.
28146 However, using expandable items in &%av_scanner%& disables this caching, in
28147 which case each use of the &%malware%& condition causes a new scan of the
28148 message.
28149
28150 The &%malware%& condition takes a right-hand argument that is expanded before
28151 use. It can then be one of
28152
28153 .ilist
28154 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
28155 The condition succeeds if a virus was found, and fail otherwise. This is the
28156 recommended usage.
28157 .next
28158 &"false"& or &"0"& or an empty string, in which case no scanning is done and
28159 the condition fails immediately.
28160 .next
28161 A regular expression, in which case the message is scanned for viruses. The
28162 condition succeeds if a virus is found and its name matches the regular
28163 expression. This allows you to take special actions on certain types of virus.
28164 .endlist
28165
28166 You can append &`/defer_ok`& to the &%malware%& condition to accept messages
28167 even if there is a problem with the virus scanner. Otherwise, such a problem
28168 causes the ACL to defer.
28169
28170 .vindex "&$malware_name$&"
28171 When a virus is found, the condition sets up an expansion variable called
28172 &$malware_name$& that contains the name of the virus. You can use it in a
28173 &%message%& modifier that specifies the error returned to the sender, and/or in
28174 logging data.
28175
28176 If your virus scanner cannot unpack MIME and TNEF containers itself, you should
28177 use the &%demime%& condition (see section &<<SECTdemimecond>>&) before the
28178 &%malware%& condition.
28179
28180 .new
28181 Beware the interaction of Exim's &%message_size_limit%& with any size limits
28182 imposed by your anti-virus scanner.
28183 .wen
28184
28185 Here is a very simple scanning example:
28186 .code
28187 deny message = This message contains malware ($malware_name)
28188      demime = *
28189      malware = *
28190 .endd
28191 The next example accepts messages when there is a problem with the scanner:
28192 .code
28193 deny message = This message contains malware ($malware_name)
28194      demime = *
28195      malware = */defer_ok
28196 .endd
28197 The next example shows how to use an ACL variable to scan with both sophie and
28198 aveserver. It assumes you have set:
28199 .code
28200 av_scanner = $acl_m0
28201 .endd
28202 in the main Exim configuration.
28203 .code
28204 deny message = This message contains malware ($malware_name)
28205      set acl_m0 = sophie
28206      malware = *
28207
28208 deny message = This message contains malware ($malware_name)
28209      set acl_m0 = aveserver
28210      malware = *
28211 .endd
28212
28213
28214 .section "Scanning with SpamAssassin" "SECTscanspamass"
28215 .cindex "content scanning" "for spam"
28216 .cindex "spam scanning"
28217 .cindex "SpamAssassin"
28218 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
28219 score and a report for the message. You can get SpamAssassin at
28220 &url(http://www.spamassassin.org), or, if you have a working Perl
28221 installation, you can use CPAN by running:
28222 .code
28223 perl -MCPAN -e 'install Mail::SpamAssassin'
28224 .endd
28225 SpamAssassin has its own set of configuration files. Please review its
28226 documentation to see how you can tweak it. The default installation should work
28227 nicely, however.
28228
28229 .oindex "&%spamd_address%&"
28230 After having installed and configured SpamAssassin, start the &%spamd%& daemon.
28231 By default, it listens on 127.0.0.1, TCP port 783. If you use another host or
28232 port for &%spamd%&, you must set the &%spamd_address%& option in the global
28233 part of the Exim configuration as follows (example):
28234 .code
28235 spamd_address = 192.168.99.45 387
28236 .endd
28237 You do not need to set this option if you use the default. As of version 2.60,
28238 &%spamd%& also supports communication over UNIX sockets. If you want to use
28239 these, supply &%spamd_address%& with an absolute file name instead of a
28240 address/port pair:
28241 .code
28242 spamd_address = /var/run/spamd_socket
28243 .endd
28244 You can have multiple &%spamd%& servers to improve scalability. These can
28245 reside on other hardware reachable over the network. To specify multiple
28246 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
28247 option, separated with colons:
28248 .code
28249 spamd_address = 192.168.2.10 783 : \
28250                 192.168.2.11 783 : \
28251                 192.168.2.12 783
28252 .endd
28253 Up to 32 &%spamd%& servers are supported. The servers are queried in a random
28254 fashion. When a server fails to respond to the connection attempt, all other
28255 servers are tried until one succeeds. If no server responds, the &%spam%&
28256 condition defers.
28257
28258 &*Warning*&: It is not possible to use the UNIX socket connection method with
28259 multiple &%spamd%& servers.
28260
28261 The &%spamd_address%& variable is expanded before use if it starts with
28262 a dollar sign. In this case, the expansion may return a string that is
28263 used as the list so that multiple spamd servers can be the result of an
28264 expansion.
28265
28266 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
28267 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
28268 .code
28269 deny message = This message was classified as SPAM
28270      spam = joe
28271 .endd
28272 The right-hand side of the &%spam%& condition specifies a name. This is
28273 relevant if you have set up multiple SpamAssassin profiles. If you do not want
28274 to scan using a specific profile, but rather use the SpamAssassin system-wide
28275 default profile, you can scan for an unknown name, or simply use &"nobody"&.
28276 However, you must put something on the right-hand side.
28277
28278 The name allows you to use per-domain or per-user antispam profiles in
28279 principle, but this is not straightforward in practice, because a message may
28280 have multiple recipients, not necessarily all in the same domain. Because the
28281 &%spam%& condition has to be called from a DATA ACL in order to be able to
28282 read the contents of the message, the variables &$local_part$& and &$domain$&
28283 are not set.
28284
28285 The right-hand side of the &%spam%& condition is expanded before being used, so
28286 you can put lookups or conditions there. When the right-hand side evaluates to
28287 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
28288
28289
28290 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
28291 large ones may cause significant performance degradation. As most spam messages
28292 are quite small, it is recommended that you do not scan the big ones. For
28293 example:
28294 .code
28295 deny message = This message was classified as SPAM
28296      condition = ${if < {$message_size}{10K}}
28297      spam = nobody
28298 .endd
28299
28300 The &%spam%& condition returns true if the threshold specified in the user's
28301 SpamAssassin profile has been matched or exceeded. If you want to use the
28302 &%spam%& condition for its side effects (see the variables below), you can make
28303 it always return &"true"& by appending &`:true`& to the username.
28304
28305 .new
28306 .cindex "spam scanning" "returned variables"
28307 When the &%spam%& condition is run, it sets up a number of expansion
28308 variables. These variables are saved with the received message, thus they are
28309 available for use at delivery time.
28310 .wen
28311
28312 .vlist
28313 .vitem &$spam_score$&
28314 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
28315 for inclusion in log or reject messages.
28316
28317 .vitem &$spam_score_int$&
28318 The spam score of the message, multiplied by ten, as an integer value. For
28319 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
28320 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
28321 The integer value is useful for numeric comparisons in conditions.
28322
28323
28324 .vitem &$spam_bar$&
28325 A string consisting of a number of &"+"& or &"-"& characters, representing the
28326 integer part of the spam score value. A spam score of 4.4 would have a
28327 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
28328 headers, since MUAs can match on such strings.
28329
28330 .vitem &$spam_report$&
28331 A multiline text table, containing the full SpamAssassin report for the
28332 message. Useful for inclusion in headers or reject messages.
28333 .endlist
28334
28335 The &%spam%& condition caches its results unless expansion in
28336 spamd_address was used. If you call it again with the same user name, it
28337 does not scan again, but rather returns the same values as before.
28338
28339 The &%spam%& condition returns DEFER if there is any error while running
28340 the message through SpamAssassin or if the expansion of spamd_address
28341 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
28342 statement block), append &`/defer_ok`& to the right-hand side of the
28343 spam condition, like this:
28344 .code
28345 deny message = This message was classified as SPAM
28346      spam    = joe/defer_ok
28347 .endd
28348 This causes messages to be accepted even if there is a problem with &%spamd%&.
28349
28350 Here is a longer, commented example of the use of the &%spam%&
28351 condition:
28352 .code
28353 # put headers in all messages (no matter if spam or not)
28354 warn  spam = nobody:true
28355       add_header = X-Spam-Score: $spam_score ($spam_bar)
28356       add_header = X-Spam-Report: $spam_report
28357
28358 # add second subject line with *SPAM* marker when message
28359 # is over threshold
28360 warn  spam = nobody
28361       add_header = Subject: *SPAM* $h_Subject:
28362
28363 # reject spam at high scores (> 12)
28364 deny  message = This message scored $spam_score spam points.
28365       spam = nobody:true
28366       condition = ${if >{$spam_score_int}{120}{1}{0}}
28367 .endd
28368
28369
28370
28371 .section "Scanning MIME parts" "SECTscanmimepart"
28372 .cindex "content scanning" "MIME parts"
28373 .cindex "MIME content scanning"
28374 .oindex "&%acl_smtp_mime%&"
28375 .oindex "&%acl_not_smtp_mime%&"
28376 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
28377 each MIME part of an SMTP message, including multipart types, in the sequence
28378 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
28379 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
28380 options may both refer to the same ACL if you want the same processing in both
28381 cases.
28382
28383 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
28384 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
28385 the case of a non-SMTP message. However, a MIME ACL is called only if the
28386 message contains a &'Content-Type:'& header line. When a call to a MIME
28387 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
28388 result code is sent to the client. In the case of an SMTP message, the
28389 &%acl_smtp_data%& ACL is not called when this happens.
28390
28391 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
28392 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
28393 condition to match against the raw MIME part. You can also use the
28394 &%mime_regex%& condition to match against the decoded MIME part (see section
28395 &<<SECTscanregex>>&).
28396
28397 At the start of a MIME ACL, a number of variables are set from the header
28398 information for the relevant MIME part. These are described below. The contents
28399 of the MIME part are not by default decoded into a disk file except for MIME
28400 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
28401 part into a disk file, you can use the &%decode%& condition. The general
28402 syntax is:
28403 .display
28404 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
28405 .endd
28406 The right hand side is expanded before use. After expansion,
28407 the value can be:
28408
28409 .olist
28410 &"0"& or &"false"&, in which case no decoding is done.
28411 .next
28412 The string &"default"&. In that case, the file is put in the temporary
28413 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
28414 a sequential file name consisting of the message id and a sequence number. The
28415 full path and name is available in &$mime_decoded_filename$& after decoding.
28416 .next
28417 A full path name starting with a slash. If the full name is an existing
28418 directory, it is used as a replacement for the default directory. The filename
28419 is then sequentially assigned. If the path does not exist, it is used as
28420 the full path and file name.
28421 .next
28422 If the string does not start with a slash, it is used as the
28423 filename, and the default path is then used.
28424 .endlist
28425 The &%decode%& condition normally succeeds. It is only false for syntax
28426 errors or unusual circumstances such as memory shortages. You can easily decode
28427 a file with its original, proposed filename using
28428 .code
28429 decode = $mime_filename
28430 .endd
28431 However, you should keep in mind that &$mime_filename$& might contain
28432 anything. If you place files outside of the default path, they are not
28433 automatically unlinked.
28434
28435 For RFC822 attachments (these are messages attached to messages, with a
28436 content-type of &"message/rfc822"&), the ACL is called again in the same manner
28437 as for the primary message, only that the &$mime_is_rfc822$& expansion
28438 variable is set (see below). Attached messages are always decoded to disk
28439 before being checked, and the files are unlinked once the check is done.
28440
28441 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
28442 used to match regular expressions against raw and decoded MIME parts,
28443 respectively. They are described in section &<<SECTscanregex>>&.
28444
28445 .cindex "MIME content scanning" "returned variables"
28446 The following list describes all expansion variables that are
28447 available in the MIME ACL:
28448
28449 .vlist
28450 .vitem &$mime_boundary$&
28451 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
28452 have a boundary string, which is stored in this variable. If the current part
28453 has no boundary parameter in the &'Content-Type:'& header, this variable
28454 contains the empty string.
28455
28456 .vitem &$mime_charset$&
28457 This variable contains the character set identifier, if one was found in the
28458 &'Content-Type:'& header. Examples for charset identifiers are:
28459 .code
28460 us-ascii
28461 gb2312 (Chinese)
28462 iso-8859-1
28463 .endd
28464 Please note that this value is not normalized, so you should do matches
28465 case-insensitively.
28466
28467 .vitem &$mime_content_description$&
28468 This variable contains the normalized content of the &'Content-Description:'&
28469 header. It can contain a human-readable description of the parts content. Some
28470 implementations repeat the filename for attachments here, but they are usually
28471 only used for display purposes.
28472
28473 .vitem &$mime_content_disposition$&
28474 This variable contains the normalized content of the &'Content-Disposition:'&
28475 header. You can expect strings like &"attachment"& or &"inline"& here.
28476
28477 .vitem &$mime_content_id$&
28478 This variable contains the normalized content of the &'Content-ID:'& header.
28479 This is a unique ID that can be used to reference a part from another part.
28480
28481 .vitem &$mime_content_size$&
28482 This variable is set only after the &%decode%& modifier (see above) has been
28483 successfully run. It contains the size of the decoded part in kilobytes. The
28484 size is always rounded up to full kilobytes, so only a completely empty part
28485 has a &$mime_content_size$& of zero.
28486
28487 .vitem &$mime_content_transfer_encoding$&
28488 This variable contains the normalized content of the
28489 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
28490 type. Typical values are &"base64"& and &"quoted-printable"&.
28491
28492 .vitem &$mime_content_type$&
28493 If the MIME part has a &'Content-Type:'& header, this variable contains its
28494 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
28495 are some examples of popular MIME types, as they may appear in this variable:
28496 .code
28497 text/plain
28498 text/html
28499 application/octet-stream
28500 image/jpeg
28501 audio/midi
28502 .endd
28503 If the MIME part has no &'Content-Type:'& header, this variable contains the
28504 empty string.
28505
28506 .vitem &$mime_decoded_filename$&
28507 This variable is set only after the &%decode%& modifier (see above) has been
28508 successfully run. It contains the full path and file name of the file
28509 containing the decoded data.
28510 .endlist
28511
28512 .cindex "RFC 2047"
28513 .vlist
28514 .vitem &$mime_filename$&
28515 This is perhaps the most important of the MIME variables. It contains a
28516 proposed filename for an attachment, if one was found in either the
28517 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
28518 RFC2047 decoded, but no additional sanity checks are done. If no filename was
28519 found, this variable contains the empty string.
28520
28521 .vitem &$mime_is_coverletter$&
28522 This variable attempts to differentiate the &"cover letter"& of an e-mail from
28523 attached data. It can be used to clamp down on flashy or unnecessarily encoded
28524 content in the cover letter, while not restricting attachments at all.
28525
28526 The variable contains 1 (true) for a MIME part believed to be part of the
28527 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
28528 follows:
28529
28530 .olist
28531 The outermost MIME part of a message is always a cover letter.
28532
28533 .next
28534 If a multipart/alternative or multipart/related MIME part is a cover letter,
28535 so are all MIME subparts within that multipart.
28536
28537 .next
28538 If any other multipart is a cover letter, the first subpart is a cover letter,
28539 and the rest are attachments.
28540
28541 .next
28542 All parts contained within an attachment multipart are attachments.
28543 .endlist olist
28544
28545 As an example, the following will ban &"HTML mail"& (including that sent with
28546 alternative plain text), while allowing HTML files to be attached. HTML
28547 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
28548 .code
28549 deny message = HTML mail is not accepted here
28550 !condition = $mime_is_rfc822
28551 condition = $mime_is_coverletter
28552 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
28553 .endd
28554 .vitem &$mime_is_multipart$&
28555 This variable has the value 1 (true) when the current part has the main type
28556 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
28557 Since multipart entities only serve as containers for other parts, you may not
28558 want to carry out specific actions on them.
28559
28560 .vitem &$mime_is_rfc822$&
28561 This variable has the value 1 (true) if the current part is not a part of the
28562 checked message itself, but part of an attached message. Attached message
28563 decoding is fully recursive.
28564
28565 .vitem &$mime_part_count$&
28566 This variable is a counter that is raised for each processed MIME part. It
28567 starts at zero for the very first part (which is usually a multipart). The
28568 counter is per-message, so it is reset when processing RFC822 attachments (see
28569 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
28570 complete, so you can use it in the DATA ACL to determine the number of MIME
28571 parts of a message. For non-MIME messages, this variable contains the value -1.
28572 .endlist
28573
28574
28575
28576 .section "Scanning with regular expressions" "SECTscanregex"
28577 .cindex "content scanning" "with regular expressions"
28578 .cindex "regular expressions" "content scanning with"
28579 You can specify your own custom regular expression matches on the full body of
28580 the message, or on individual MIME parts.
28581
28582 The &%regex%& condition takes one or more regular expressions as arguments and
28583 matches them against the full message (when called in the DATA ACL) or a raw
28584 MIME part (when called in the MIME ACL). The &%regex%& condition matches
28585 linewise, with a maximum line length of 32K characters. That means you cannot
28586 have multiline matches with the &%regex%& condition.
28587
28588 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
28589 to 32K of decoded content (the whole content at once, not linewise). If the
28590 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
28591 is decoded automatically when &%mime_regex%& is executed (using default path
28592 and filename values). If the decoded data is larger than  32K, only the first
28593 32K characters are checked.
28594
28595 The regular expressions are passed as a colon-separated list. To include a
28596 literal colon, you must double it. Since the whole right-hand side string is
28597 expanded before being used, you must also escape dollar signs and backslashes
28598 with more backslashes, or use the &`\N`& facility to disable expansion.
28599 Here is a simple example that contains two regular expressions:
28600 .code
28601 deny message = contains blacklisted regex ($regex_match_string)
28602      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
28603 .endd
28604 The conditions returns true if any one of the regular expressions matches. The
28605 &$regex_match_string$& expansion variable is then set up and contains the
28606 matching regular expression.
28607
28608 &*Warning*&: With large messages, these conditions can be fairly
28609 CPU-intensive.
28610
28611
28612
28613
28614 .section "The demime condition" "SECTdemimecond"
28615 .cindex "content scanning" "MIME checking"
28616 .cindex "MIME content scanning"
28617 The &%demime%& ACL condition provides MIME unpacking, sanity checking and file
28618 extension blocking. It is usable only in the DATA and non-SMTP ACLs. The
28619 &%demime%& condition uses a simpler interface to MIME decoding than the MIME
28620 ACL functionality, but provides no additional facilities. Please note that this
28621 condition is deprecated and kept only for backward compatibility. You must set
28622 the WITH_OLD_DEMIME option in &_Local/Makefile_& at build time to be able to
28623 use the &%demime%& condition.
28624
28625 The &%demime%& condition unpacks MIME containers in the message. It detects
28626 errors in MIME containers and can match file extensions found in the message
28627 against a list. Using this facility produces files containing the unpacked MIME
28628 parts of the message in the temporary scan directory. If you do antivirus
28629 scanning, it is recommended that you use the &%demime%& condition before the
28630 antivirus (&%malware%&) condition.
28631
28632 On the right-hand side of the &%demime%& condition you can pass a
28633 colon-separated list of file extensions that it should match against. For
28634 example:
28635 .code
28636 deny message = Found blacklisted file attachment
28637      demime  = vbs:com:bat:pif:prf:lnk
28638 .endd
28639 If one of the file extensions is found, the condition is true, otherwise it is
28640 false. If there is a temporary error while demimeing (for example, &"disk
28641 full"&), the condition defers, and the message is temporarily rejected (unless
28642 the condition is on a &%warn%& verb).
28643
28644 The right-hand side is expanded before being treated as a list, so you can have
28645 conditions and lookups there. If it expands to an empty string, &"false"&, or
28646 zero (&"0"&), no demimeing is done and the condition is false.
28647
28648 The &%demime%& condition set the following variables:
28649
28650 .vlist
28651 .vitem &$demime_errorlevel$&
28652 .vindex "&$demime_errorlevel$&"
28653 When an error is detected in a MIME container, this variable contains the
28654 severity of the error, as an integer number. The higher the value, the more
28655 severe the error (the current maximum value is 3). If this variable is unset or
28656 zero, no error occurred.
28657
28658 .vitem &$demime_reason$&
28659 .vindex "&$demime_reason$&"
28660 When &$demime_errorlevel$& is greater than zero, this variable contains a
28661 human-readable text string describing the MIME error that occurred.
28662 .endlist
28663
28664 .vlist
28665 .vitem &$found_extension$&
28666 .vindex "&$found_extension$&"
28667 When the &%demime%& condition is true, this variable contains the file
28668 extension it found.
28669 .endlist
28670
28671 Both &$demime_errorlevel$& and &$demime_reason$& are set by the first call of
28672 the &%demime%& condition, and are not changed on subsequent calls.
28673
28674 If you do not want to check for file extensions, but rather use the &%demime%&
28675 condition for unpacking or error checking purposes, pass &"*"& as the
28676 right-hand side value. Here is a more elaborate example of how to use this
28677 facility:
28678 .code
28679 # Reject messages with serious MIME container errors
28680 deny  message = Found MIME error ($demime_reason).
28681       demime = *
28682       condition = ${if >{$demime_errorlevel}{2}{1}{0}}
28683
28684 # Reject known virus spreading file extensions.
28685 # Accepting these is pretty much braindead.
28686 deny  message = contains $found_extension file (blacklisted).
28687       demime  = com:vbs:bat:pif:scr
28688
28689 # Freeze .exe and .doc files. Postmaster can
28690 # examine them and eventually thaw them.
28691 deny  log_message = Another $found_extension file.
28692       demime = exe:doc
28693       control = freeze
28694 .endd
28695 .ecindex IIDcosca
28696
28697
28698
28699
28700 . ////////////////////////////////////////////////////////////////////////////
28701 . ////////////////////////////////////////////////////////////////////////////
28702
28703 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
28704          "Local scan function"
28705 .scindex IIDlosca "&[local_scan()]& function" "description of"
28706 .cindex "customizing" "input scan using C function"
28707 .cindex "policy control" "by local scan function"
28708 In these days of email worms, viruses, and ever-increasing spam, some sites
28709 want to apply a lot of checking to messages before accepting them.
28710
28711 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
28712 passing messages to external virus and spam scanning software. You can also do
28713 a certain amount in Exim itself through string expansions and the &%condition%&
28714 condition in the ACL that runs after the SMTP DATA command or the ACL for
28715 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
28716
28717 To allow for further customization to a site's own requirements, there is the
28718 possibility of linking Exim with a private message scanning function, written
28719 in C. If you want to run code that is written in something other than C, you
28720 can of course use a little C stub to call it.
28721
28722 The local scan function is run once for every incoming message, at the point
28723 when Exim is just about to accept the message.
28724 It can therefore be used to control non-SMTP messages from local processes as
28725 well as messages arriving via SMTP.
28726
28727 Exim applies a timeout to calls of the local scan function, and there is an
28728 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
28729 Zero means &"no timeout"&.
28730 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
28731 before calling the local scan function, so that the most common types of crash
28732 are caught. If the timeout is exceeded or one of those signals is caught, the
28733 incoming message is rejected with a temporary error if it is an SMTP message.
28734 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
28735 code. The incident is logged on the main and reject logs.
28736
28737
28738
28739 .section "Building Exim to use a local scan function" "SECID207"
28740 .cindex "&[local_scan()]& function" "building Exim to use"
28741 To make use of the local scan function feature, you must tell Exim where your
28742 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
28743 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
28744 directory, so you might set
28745 .code
28746 LOCAL_SCAN_SOURCE=Local/local_scan.c
28747 .endd
28748 for example. The function must be called &[local_scan()]&. It is called by
28749 Exim after it has received a message, when the success return code is about to
28750 be sent. This is after all the ACLs have been run. The return code from your
28751 function controls whether the message is actually accepted or not. There is a
28752 commented template function (that just accepts the message) in the file
28753 _src/local_scan.c_.
28754
28755 If you want to make use of Exim's run time configuration file to set options
28756 for your &[local_scan()]& function, you must also set
28757 .code
28758 LOCAL_SCAN_HAS_OPTIONS=yes
28759 .endd
28760 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
28761
28762
28763
28764
28765 .section "API for local_scan()" "SECTapiforloc"
28766 .cindex "&[local_scan()]& function" "API description"
28767 You must include this line near the start of your code:
28768 .code
28769 #include "local_scan.h"
28770 .endd
28771 This header file defines a number of variables and other values, and the
28772 prototype for the function itself. Exim is coded to use unsigned char values
28773 almost exclusively, and one of the things this header defines is a shorthand
28774 for &`unsigned char`& called &`uschar`&.
28775 It also contains the following macro definitions, to simplify casting character
28776 strings and pointers to character strings:
28777 .code
28778 #define CS   (char *)
28779 #define CCS  (const char *)
28780 #define CSS  (char **)
28781 #define US   (unsigned char *)
28782 #define CUS  (const unsigned char *)
28783 #define USS  (unsigned char **)
28784 .endd
28785 The function prototype for &[local_scan()]& is:
28786 .code
28787 extern int local_scan(int fd, uschar **return_text);
28788 .endd
28789 The arguments are as follows:
28790
28791 .ilist
28792 &%fd%& is a file descriptor for the file that contains the body of the message
28793 (the -D file). The file is open for reading and writing, but updating it is not
28794 recommended. &*Warning*&: You must &'not'& close this file descriptor.
28795
28796 The descriptor is positioned at character 19 of the file, which is the first
28797 character of the body itself, because the first 19 characters are the message
28798 id followed by &`-D`& and a newline. If you rewind the file, you should use the
28799 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
28800 case this changes in some future version.
28801 .next
28802 &%return_text%& is an address which you can use to return a pointer to a text
28803 string at the end of the function. The value it points to on entry is NULL.
28804 .endlist
28805
28806 The function must return an &%int%& value which is one of the following macros:
28807
28808 .vlist
28809 .vitem &`LOCAL_SCAN_ACCEPT`&
28810 .vindex "&$local_scan_data$&"
28811 The message is accepted. If you pass back a string of text, it is saved with
28812 the message, and made available in the variable &$local_scan_data$&. No
28813 newlines are permitted (if there are any, they are turned into spaces) and the
28814 maximum length of text is 1000 characters.
28815
28816 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
28817 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
28818 queued without immediate delivery, and is frozen.
28819
28820 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
28821 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
28822 queued without immediate delivery.
28823
28824 .vitem &`LOCAL_SCAN_REJECT`&
28825 The message is rejected; the returned text is used as an error message which is
28826 passed back to the sender and which is also logged. Newlines are permitted &--
28827 they cause a multiline response for SMTP rejections, but are converted to
28828 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
28829 used.
28830
28831 .vitem &`LOCAL_SCAN_TEMPREJECT`&
28832 The message is temporarily rejected; the returned text is used as an error
28833 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
28834 problem"& is used.
28835
28836 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
28837 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
28838 message is not written to the reject log. It has the effect of unsetting the
28839 &%rejected_header%& log selector for just this rejection. If
28840 &%rejected_header%& is already unset (see the discussion of the
28841 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
28842 same as LOCAL_SCAN_REJECT.
28843
28844 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
28845 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
28846 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
28847 .endlist
28848
28849 If the message is not being received by interactive SMTP, rejections are
28850 reported by writing to &%stderr%& or by sending an email, as configured by the
28851 &%-oe%& command line options.
28852
28853
28854
28855 .section "Configuration options for local_scan()" "SECTconoptloc"
28856 .cindex "&[local_scan()]& function" "configuration options"
28857 It is possible to have option settings in the main configuration file
28858 that set values in static variables in the &[local_scan()]& module. If you
28859 want to do this, you must have the line
28860 .code
28861 LOCAL_SCAN_HAS_OPTIONS=yes
28862 .endd
28863 in your &_Local/Makefile_& when you build Exim. (This line is in
28864 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
28865 file, you must define static variables to hold the option values, and a table
28866 to define them.
28867
28868 The table must be a vector called &%local_scan_options%&, of type
28869 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
28870 and a pointer to the variable that holds the value. The entries must appear in
28871 alphabetical order. Following &%local_scan_options%& you must also define a
28872 variable called &%local_scan_options_count%& that contains the number of
28873 entries in the table. Here is a short example, showing two kinds of option:
28874 .code
28875 static int my_integer_option = 42;
28876 static uschar *my_string_option = US"a default string";
28877
28878 optionlist local_scan_options[] = {
28879   { "my_integer", opt_int,       &my_integer_option },
28880   { "my_string",  opt_stringptr, &my_string_option }
28881 };
28882
28883 int local_scan_options_count =
28884   sizeof(local_scan_options)/sizeof(optionlist);
28885 .endd
28886 The values of the variables can now be changed from Exim's runtime
28887 configuration file by including a local scan section as in this example:
28888 .code
28889 begin local_scan
28890 my_integer = 99
28891 my_string = some string of text...
28892 .endd
28893 The available types of option data are as follows:
28894
28895 .vlist
28896 .vitem &*opt_bool*&
28897 This specifies a boolean (true/false) option. The address should point to a
28898 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
28899 that are defined as &"1"& and &"0"&, respectively. If you want to detect
28900 whether such a variable has been set at all, you can initialize it to
28901 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
28902 values.)
28903
28904 .vitem &*opt_fixed*&
28905 This specifies a fixed point number, such as is used for load averages.
28906 The address should point to a variable of type &`int`&. The value is stored
28907 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
28908
28909 .vitem &*opt_int*&
28910 This specifies an integer; the address should point to a variable of type
28911 &`int`&. The value may be specified in any of the integer formats accepted by
28912 Exim.
28913
28914 .vitem &*opt_mkint*&
28915 This is the same as &%opt_int%&, except that when such a value is output in a
28916 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
28917 printed with the suffix K or M.
28918
28919 .vitem &*opt_octint*&
28920 This also specifies an integer, but the value is always interpreted as an
28921 octal integer, whether or not it starts with the digit zero, and it is
28922 always output in octal.
28923
28924 .vitem &*opt_stringptr*&
28925 This specifies a string value; the address must be a pointer to a
28926 variable that points to a string (for example, of type &`uschar *`&).
28927
28928 .vitem &*opt_time*&
28929 This specifies a time interval value. The address must point to a variable of
28930 type &`int`&. The value that is placed there is a number of seconds.
28931 .endlist
28932
28933 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
28934 out the values of all the &[local_scan()]& options.
28935
28936
28937
28938 .section "Available Exim variables" "SECID208"
28939 .cindex "&[local_scan()]& function" "available Exim variables"
28940 The header &_local_scan.h_& gives you access to a number of C variables. These
28941 are the only ones that are guaranteed to be maintained from release to release.
28942 Note, however, that you can obtain the value of any Exim expansion variable,
28943 including &$recipients$&, by calling &'expand_string()'&. The exported
28944 C variables are as follows:
28945
28946 .vlist
28947 .vitem &*int&~body_linecount*&
28948 This variable contains the number of lines in the message's body.
28949
28950 .vitem &*int&~body_zerocount*&
28951 This variable contains the number of binary zero bytes in the message's body.
28952
28953 .vitem &*unsigned&~int&~debug_selector*&
28954 This variable is set to zero when no debugging is taking place. Otherwise, it
28955 is a bitmap of debugging selectors. Two bits are identified for use in
28956 &[local_scan()]&; they are defined as macros:
28957
28958 .ilist
28959 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
28960 testing option that is not privileged &-- any caller may set it. All the
28961 other selector bits can be set only by admin users.
28962
28963 .next
28964 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
28965 by the &`+local_scan`& debug selector. It is not included in the default set
28966 of debugging bits.
28967 .endlist ilist
28968
28969 Thus, to write to the debugging output only when &`+local_scan`& has been
28970 selected, you should use code like this:
28971 .code
28972 if ((debug_selector & D_local_scan) != 0)
28973   debug_printf("xxx", ...);
28974 .endd
28975 .vitem &*uschar&~*expand_string_message*&
28976 After a failing call to &'expand_string()'& (returned value NULL), the
28977 variable &%expand_string_message%& contains the error message, zero-terminated.
28978
28979 .vitem &*header_line&~*header_list*&
28980 A pointer to a chain of header lines. The &%header_line%& structure is
28981 discussed below.
28982
28983 .vitem &*header_line&~*header_last*&
28984 A pointer to the last of the header lines.
28985
28986 .vitem &*uschar&~*headers_charset*&
28987 The value of the &%headers_charset%& configuration option.
28988
28989 .vitem &*BOOL&~host_checking*&
28990 This variable is TRUE during a host checking session that is initiated by the
28991 &%-bh%& command line option.
28992
28993 .vitem &*uschar&~*interface_address*&
28994 The IP address of the interface that received the message, as a string. This
28995 is NULL for locally submitted messages.
28996
28997 .vitem &*int&~interface_port*&
28998 The port on which this message was received. When testing with the &%-bh%&
28999 command line option, the value of this variable is -1 unless a port has been
29000 specified via the &%-oMi%& option.
29001
29002 .vitem &*uschar&~*message_id*&
29003 This variable contains Exim's message id for the incoming message (the value of
29004 &$message_exim_id$&) as a zero-terminated string.
29005
29006 .vitem &*uschar&~*received_protocol*&
29007 The name of the protocol by which the message was received.
29008
29009 .vitem &*int&~recipients_count*&
29010 The number of accepted recipients.
29011
29012 .vitem &*recipient_item&~*recipients_list*&
29013 .cindex "recipient" "adding in local scan"
29014 .cindex "recipient" "removing in local scan"
29015 The list of accepted recipients, held in a vector of length
29016 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
29017 can add additional recipients by calling &'receive_add_recipient()'& (see
29018 below). You can delete recipients by removing them from the vector and
29019 adjusting the value in &%recipients_count%&. In particular, by setting
29020 &%recipients_count%& to zero you remove all recipients. If you then return the
29021 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
29022 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
29023 and then call &'receive_add_recipient()'& as often as needed.
29024
29025 .vitem &*uschar&~*sender_address*&
29026 The envelope sender address. For bounce messages this is the empty string.
29027
29028 .vitem &*uschar&~*sender_host_address*&
29029 The IP address of the sending host, as a string. This is NULL for
29030 locally-submitted messages.
29031
29032 .vitem &*uschar&~*sender_host_authenticated*&
29033 The name of the authentication mechanism that was used, or NULL if the message
29034 was not received over an authenticated SMTP connection.
29035
29036 .vitem &*uschar&~*sender_host_name*&
29037 The name of the sending host, if known.
29038
29039 .vitem &*int&~sender_host_port*&
29040 The port on the sending host.
29041
29042 .vitem &*BOOL&~smtp_input*&
29043 This variable is TRUE for all SMTP input, including BSMTP.
29044
29045 .vitem &*BOOL&~smtp_batched_input*&
29046 This variable is TRUE for BSMTP input.
29047
29048 .vitem &*int&~store_pool*&
29049 The contents of this variable control which pool of memory is used for new
29050 requests. See section &<<SECTmemhanloc>>& for details.
29051 .endlist
29052
29053
29054 .section "Structure of header lines" "SECID209"
29055 The &%header_line%& structure contains the members listed below.
29056 You can add additional header lines by calling the &'header_add()'& function
29057 (see below). You can cause header lines to be ignored (deleted) by setting
29058 their type to *.
29059
29060
29061 .vlist
29062 .vitem &*struct&~header_line&~*next*&
29063 A pointer to the next header line, or NULL for the last line.
29064
29065 .vitem &*int&~type*&
29066 A code identifying certain headers that Exim recognizes. The codes are printing
29067 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
29068 Notice in particular that any header line whose type is * is not transmitted
29069 with the message. This flagging is used for header lines that have been
29070 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
29071 lines.) Effectively, * means &"deleted"&.
29072
29073 .vitem &*int&~slen*&
29074 The number of characters in the header line, including the terminating and any
29075 internal newlines.
29076
29077 .vitem &*uschar&~*text*&
29078 A pointer to the text of the header. It always ends with a newline, followed by
29079 a zero byte. Internal newlines are preserved.
29080 .endlist
29081
29082
29083
29084 .section "Structure of recipient items" "SECID210"
29085 The &%recipient_item%& structure contains these members:
29086
29087 .vlist
29088 .vitem &*uschar&~*address*&
29089 This is a pointer to the recipient address as it was received.
29090
29091 .vitem &*int&~pno*&
29092 This is used in later Exim processing when top level addresses are created by
29093 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
29094 and must always contain -1 at this stage.
29095
29096 .vitem &*uschar&~*errors_to*&
29097 If this value is not NULL, bounce messages caused by failing to deliver to the
29098 recipient are sent to the address it contains. In other words, it overrides the
29099 envelope sender for this one recipient. (Compare the &%errors_to%& generic
29100 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
29101 an unqualified address, Exim qualifies it using the domain from
29102 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
29103 is NULL for all recipients.
29104 .endlist
29105
29106
29107
29108 .section "Available Exim functions" "SECID211"
29109 .cindex "&[local_scan()]& function" "available Exim functions"
29110 The header &_local_scan.h_& gives you access to a number of Exim functions.
29111 These are the only ones that are guaranteed to be maintained from release to
29112 release:
29113
29114 .vlist
29115 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
29116        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
29117
29118 This function creates a child process that runs the command specified by
29119 &%argv%&. The environment for the process is specified by &%envp%&, which can
29120 be NULL if no environment variables are to be passed. A new umask is supplied
29121 for the process in &%newumask%&.
29122
29123 Pipes to the standard input and output of the new process are set up
29124 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
29125 standard error is cloned to the standard output. If there are any file
29126 descriptors &"in the way"& in the new process, they are closed. If the final
29127 argument is TRUE, the new process is made into a process group leader.
29128
29129 The function returns the pid of the new process, or -1 if things go wrong.
29130
29131 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
29132 This function waits for a child process to terminate, or for a timeout (in
29133 seconds) to expire. A timeout value of zero means wait as long as it takes. The
29134 return value is as follows:
29135
29136 .ilist
29137 >= 0
29138
29139 The process terminated by a normal exit and the value is the process
29140 ending status.
29141
29142 .next
29143 < 0 and > &--256
29144
29145 The process was terminated by a signal and the value is the negation of the
29146 signal number.
29147
29148 .next
29149 &--256
29150
29151 The process timed out.
29152 .next
29153 &--257
29154
29155 The was some other error in wait(); &%errno%& is still set.
29156 .endlist
29157
29158 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
29159 This function provide you with a means of submitting a new message to
29160 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
29161 want, but this packages it all up for you.) The function creates a pipe,
29162 forks a subprocess that is running
29163 .code
29164 exim -t -oem -oi -f <>
29165 .endd
29166 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
29167 that is connected to the standard input. The yield of the function is the PID
29168 of the subprocess. You can then write a message to the file descriptor, with
29169 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
29170
29171 When you have finished, call &'child_close()'& to wait for the process to
29172 finish and to collect its ending status. A timeout value of zero is usually
29173 fine in this circumstance. Unless you have made a mistake with the recipient
29174 addresses, you should get a return code of zero.
29175
29176
29177 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
29178        *sender_authentication)*&
29179 This function is a more sophisticated version of &'child_open()'&. The command
29180 that it runs is:
29181 .display
29182 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
29183 .endd
29184 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
29185
29186
29187 .vitem &*void&~debug_printf(char&~*,&~...)*&
29188 This is Exim's debugging function, with arguments as for &'(printf()'&. The
29189 output is written to the standard error stream. If no debugging is selected,
29190 calls to &'debug_printf()'& have no effect. Normally, you should make calls
29191 conditional on the &`local_scan`& debug selector by coding like this:
29192 .code
29193 if ((debug_selector & D_local_scan) != 0)
29194   debug_printf("xxx", ...);
29195 .endd
29196
29197 .vitem &*uschar&~*expand_string(uschar&~*string)*&
29198 This is an interface to Exim's string expansion code. The return value is the
29199 expanded string, or NULL if there was an expansion failure.
29200 The C variable &%expand_string_message%& contains an error message after an
29201 expansion failure. If expansion does not change the string, the return value is
29202 the pointer to the input string. Otherwise, the return value points to a new
29203 block of memory that was obtained by a call to &'store_get()'&. See section
29204 &<<SECTmemhanloc>>& below for a discussion of memory handling.
29205
29206 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
29207 This function allows you to an add additional header line at the end of the
29208 existing ones. The first argument is the type, and should normally be a space
29209 character. The second argument is a format string and any number of
29210 substitution arguments as for &[sprintf()]&. You may include internal newlines
29211 if you want, and you must ensure that the string ends with a newline.
29212
29213 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
29214         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
29215 This function adds a new header line at a specified point in the header
29216 chain. The header itself is specified as for &'header_add()'&.
29217
29218 If &%name%& is NULL, the new header is added at the end of the chain if
29219 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
29220 NULL, the header lines are searched for the first non-deleted header that
29221 matches the name. If one is found, the new header is added before it if
29222 &%after%& is false. If &%after%& is true, the new header is added after the
29223 found header and any adjacent subsequent ones with the same name (even if
29224 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
29225 option controls where the header is added. If it is true, addition is at the
29226 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
29227 headers, or at the top if there are no &'Received:'& headers, you could use
29228 .code
29229 header_add_at_position(TRUE, US"Received", TRUE,
29230   ' ', "X-xxx: ...");
29231 .endd
29232 Normally, there is always at least one non-deleted &'Received:'& header, but
29233 there may not be if &%received_header_text%& expands to an empty string.
29234
29235
29236 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
29237 This function removes header lines. If &%occurrence%& is zero or negative, all
29238 occurrences of the header are removed. If occurrence is greater than zero, that
29239 particular instance of the header is removed. If no header(s) can be found that
29240 match the specification, the function does nothing.
29241
29242
29243 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
29244         int&~length,&~BOOL&~notdel)*&"
29245 This function tests whether the given header has the given name. It is not just
29246 a string comparison, because white space is permitted between the name and the
29247 colon. If the &%notdel%& argument is true, a false return is forced for all
29248 &"deleted"& headers; otherwise they are not treated specially. For example:
29249 .code
29250 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
29251 .endd
29252 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
29253 .cindex "base64 encoding" "functions for &[local_scan()]& use"
29254 This function base64-encodes a string, which is passed by address and length.
29255 The text may contain bytes of any value, including zero. The result is passed
29256 back in dynamic memory that is obtained by calling &'store_get()'&. It is
29257 zero-terminated.
29258
29259 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
29260 This function decodes a base64-encoded string. Its arguments are a
29261 zero-terminated base64-encoded string and the address of a variable that is set
29262 to point to the result, which is in dynamic memory. The length of the decoded
29263 string is the yield of the function. If the input is invalid base64 data, the
29264 yield is -1. A zero byte is added to the end of the output string to make it
29265 easy to interpret as a C string (assuming it contains no zeros of its own). The
29266 added zero byte is not included in the returned count.
29267
29268 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
29269 This function checks for a match in a domain list. Domains are always
29270 matched caselessly. The return value is one of the following:
29271 .display
29272 &`OK     `& match succeeded
29273 &`FAIL   `& match failed
29274 &`DEFER  `& match deferred
29275 .endd
29276 DEFER is usually caused by some kind of lookup defer, such as the
29277 inability to contact a database.
29278
29279 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
29280         BOOL&~caseless)*&"
29281 This function checks for a match in a local part list. The third argument
29282 controls case-sensitivity. The return values are as for
29283 &'lss_match_domain()'&.
29284
29285 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
29286         BOOL&~caseless)*&"
29287 This function checks for a match in an address list. The third argument
29288 controls the case-sensitivity of the local part match. The domain is always
29289 matched caselessly. The return values are as for &'lss_match_domain()'&.
29290
29291 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
29292         uschar&~*list)*&"
29293 This function checks for a match in a host list. The most common usage is
29294 expected to be
29295 .code
29296 lss_match_host(sender_host_name, sender_host_address, ...)
29297 .endd
29298 .vindex "&$sender_host_address$&"
29299 An empty address field matches an empty item in the host list. If the host name
29300 is NULL, the name corresponding to &$sender_host_address$& is automatically
29301 looked up if a host name is required to match an item in the list. The return
29302 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
29303 returns ERROR in the case when it had to look up a host name, but the lookup
29304 failed.
29305
29306 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
29307         *format,&~...)*&"
29308 This function writes to Exim's log files. The first argument should be zero (it
29309 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
29310 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
29311 them. It specifies to which log or logs the message is written. The remaining
29312 arguments are a format and relevant insertion arguments. The string should not
29313 contain any newlines, not even at the end.
29314
29315
29316 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
29317 This function adds an additional recipient to the message. The first argument
29318 is the recipient address. If it is unqualified (has no domain), it is qualified
29319 with the &%qualify_recipient%& domain. The second argument must always be -1.
29320
29321 This function does not allow you to specify a private &%errors_to%& address (as
29322 described with the structure of &%recipient_item%& above), because it pre-dates
29323 the addition of that field to the structure. However, it is easy to add such a
29324 value afterwards. For example:
29325 .code
29326  receive_add_recipient(US"monitor@mydom.example", -1);
29327  recipients_list[recipients_count-1].errors_to =
29328    US"postmaster@mydom.example";
29329 .endd
29330
29331 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
29332 This is a convenience function to remove a named recipient from the list of
29333 recipients. It returns true if a recipient was removed, and false if no
29334 matching recipient could be found. The argument must be a complete email
29335 address.
29336 .endlist
29337
29338
29339 .cindex "RFC 2047"
29340 .vlist
29341 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
29342   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
29343 This function decodes strings that are encoded according to RFC 2047. Typically
29344 these are the contents of header lines. First, each &"encoded word"& is decoded
29345 from the Q or B encoding into a byte-string. Then, if provided with the name of
29346 a charset encoding, and if the &[iconv()]& function is available, an attempt is
29347 made  to translate the result to the named character set. If this fails, the
29348 binary string is returned with an error message.
29349
29350 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
29351 maximum MIME word length is enforced. The third argument is the target
29352 encoding, or NULL if no translation is wanted.
29353
29354 .cindex "binary zero" "in RFC 2047 decoding"
29355 .cindex "RFC 2047" "binary zero in"
29356 If a binary zero is encountered in the decoded string, it is replaced by the
29357 contents of the &%zeroval%& argument. For use with Exim headers, the value must
29358 not be 0 because header lines are handled as zero-terminated strings.
29359
29360 The function returns the result of processing the string, zero-terminated; if
29361 &%lenptr%& is not NULL, the length of the result is set in the variable to
29362 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
29363
29364 If an error is encountered, the function returns NULL and uses the &%error%&
29365 argument to return an error message. The variable pointed to by &%error%& is
29366 set to NULL if there is no error; it may be set non-NULL even when the function
29367 returns a non-NULL value if decoding was successful, but there was a problem
29368 with translation.
29369
29370
29371 .vitem &*int&~smtp_fflush(void)*&
29372 This function is used in conjunction with &'smtp_printf()'&, as described
29373 below.
29374
29375 .vitem &*void&~smtp_printf(char&~*,&~...)*&
29376 The arguments of this function are like &[printf()]&; it writes to the SMTP
29377 output stream. You should use this function only when there is an SMTP output
29378 stream, that is, when the incoming message is being received via interactive
29379 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
29380 is FALSE. If you want to test for an incoming message from another host (as
29381 opposed to a local process that used the &%-bs%& command line option), you can
29382 test the value of &%sender_host_address%&, which is non-NULL when a remote host
29383 is involved.
29384
29385 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
29386 output function, so it can be used for all forms of SMTP connection.
29387
29388 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
29389 must start with an appropriate response code: 550 if you are going to return
29390 LOCAL_SCAN_REJECT, 451 if you are going to return
29391 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
29392 initial lines of a multi-line response, the code must be followed by a hyphen
29393 to indicate that the line is not the final response line. You must also ensure
29394 that the lines you write terminate with CRLF. For example:
29395 .code
29396 smtp_printf("550-this is some extra info\r\n");
29397 return LOCAL_SCAN_REJECT;
29398 .endd
29399 Note that you can also create multi-line responses by including newlines in
29400 the data returned via the &%return_text%& argument. The added value of using
29401 &'smtp_printf()'& is that, for instance, you could introduce delays between
29402 multiple output lines.
29403
29404 The &'smtp_printf()'& function does not return any error indication, because it
29405 does not automatically flush pending output, and therefore does not test
29406 the state of the stream. (In the main code of Exim, flushing and error
29407 detection is done when Exim is ready for the next SMTP input command.) If
29408 you want to flush the output and check for an error (for example, the
29409 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
29410 arguments. It flushes the output stream, and returns a non-zero value if there
29411 is an error.
29412
29413 .vitem &*void&~*store_get(int)*&
29414 This function accesses Exim's internal store (memory) manager. It gets a new
29415 chunk of memory whose size is given by the argument. Exim bombs out if it ever
29416 runs out of memory. See the next section for a discussion of memory handling.
29417
29418 .vitem &*void&~*store_get_perm(int)*&
29419 This function is like &'store_get()'&, but it always gets memory from the
29420 permanent pool. See the next section for a discussion of memory handling.
29421
29422 .vitem &*uschar&~*string_copy(uschar&~*string)*&
29423 See below.
29424
29425 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
29426 See below.
29427
29428 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
29429 These three functions create strings using Exim's dynamic memory facilities.
29430 The first makes a copy of an entire string. The second copies up to a maximum
29431 number of characters, indicated by the second argument. The third uses a format
29432 and insertion arguments to create a new string. In each case, the result is a
29433 pointer to a new string in the current memory pool. See the next section for
29434 more discussion.
29435 .endlist
29436
29437
29438
29439 .section "More about Exim's memory handling" "SECTmemhanloc"
29440 .cindex "&[local_scan()]& function" "memory handling"
29441 No function is provided for freeing memory, because that is never needed.
29442 The dynamic memory that Exim uses when receiving a message is automatically
29443 recycled if another message is received by the same process (this applies only
29444 to incoming SMTP connections &-- other input methods can supply only one
29445 message at a time). After receiving the last message, a reception process
29446 terminates.
29447
29448 Because it is recycled, the normal dynamic memory cannot be used for holding
29449 data that must be preserved over a number of incoming messages on the same SMTP
29450 connection. However, Exim in fact uses two pools of dynamic memory; the second
29451 one is not recycled, and can be used for this purpose.
29452
29453 If you want to allocate memory that remains available for subsequent messages
29454 in the same SMTP connection, you should set
29455 .code
29456 store_pool = POOL_PERM
29457 .endd
29458 before calling the function that does the allocation. There is no need to
29459 restore the value if you do not need to; however, if you do want to revert to
29460 the normal pool, you can either restore the previous value of &%store_pool%& or
29461 set it explicitly to POOL_MAIN.
29462
29463 The pool setting applies to all functions that get dynamic memory, including
29464 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
29465 There is also a convenience function called &'store_get_perm()'& that gets a
29466 block of memory from the permanent pool while preserving the value of
29467 &%store_pool%&.
29468 .ecindex IIDlosca
29469
29470
29471
29472
29473 . ////////////////////////////////////////////////////////////////////////////
29474 . ////////////////////////////////////////////////////////////////////////////
29475
29476 .chapter "System-wide message filtering" "CHAPsystemfilter"
29477 .scindex IIDsysfil1 "filter" "system filter"
29478 .scindex IIDsysfil2 "filtering all mail"
29479 .scindex IIDsysfil3 "system filter"
29480 The previous chapters (on ACLs and the local scan function) describe checks
29481 that can be applied to messages before they are accepted by a host. There is
29482 also a mechanism for checking messages once they have been received, but before
29483 they are delivered. This is called the &'system filter'&.
29484
29485 The system filter operates in a similar manner to users' filter files, but it
29486 is run just once per message (however many recipients the message has).
29487 It should not normally be used as a substitute for routing, because &%deliver%&
29488 commands in a system router provide new envelope recipient addresses.
29489 The system filter must be an Exim filter. It cannot be a Sieve filter.
29490
29491 The system filter is run at the start of a delivery attempt, before any routing
29492 is done. If a message fails to be completely delivered at the first attempt,
29493 the system filter is run again at the start of every retry.
29494 If you want your filter to do something only once per message, you can make use
29495 of the &%first_delivery%& condition in an &%if%& command in the filter to
29496 prevent it happening on retries.
29497
29498 .vindex "&$domain$&"
29499 .vindex "&$local_part$&"
29500 &*Warning*&: Because the system filter runs just once, variables that are
29501 specific to individual recipient addresses, such as &$local_part$& and
29502 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
29503 you want to run a centrally-specified filter for each recipient address
29504 independently, you can do so by setting up a suitable &(redirect)& router, as
29505 described in section &<<SECTperaddfil>>& below.
29506
29507
29508 .section "Specifying a system filter" "SECID212"
29509 .cindex "uid (user id)" "system filter"
29510 .cindex "gid (group id)" "system filter"
29511 The name of the file that contains the system filter must be specified by
29512 setting &%system_filter%&. If you want the filter to run under a uid and gid
29513 other than root, you must also set &%system_filter_user%& and
29514 &%system_filter_group%& as appropriate. For example:
29515 .code
29516 system_filter = /etc/mail/exim.filter
29517 system_filter_user = exim
29518 .endd
29519 If a system filter generates any deliveries directly to files or pipes (via the
29520 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
29521 specified by setting &%system_filter_file_transport%& and
29522 &%system_filter_pipe_transport%&, respectively. Similarly,
29523 &%system_filter_reply_transport%& must be set to handle any messages generated
29524 by the &%reply%& command.
29525
29526
29527 .section "Testing a system filter" "SECID213"
29528 You can run simple tests of a system filter in the same way as for a user
29529 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
29530 are permitted only in system filters are recognized.
29531
29532 If you want to test the combined effect of a system filter and a user filter,
29533 you can use both &%-bF%& and &%-bf%& on the same command line.
29534
29535
29536
29537 .section "Contents of a system filter" "SECID214"
29538 The language used to specify system filters is the same as for users' filter
29539 files. It is described in the separate end-user document &'Exim's interface to
29540 mail filtering'&. However, there are some additional features that are
29541 available only in system filters; these are described in subsequent sections.
29542 If they are encountered in a user's filter file or when testing with &%-bf%&,
29543 they cause errors.
29544
29545 .cindex "frozen messages" "manual thaw; testing in filter"
29546 There are two special conditions which, though available in users' filter
29547 files, are designed for use in system filters. The condition &%first_delivery%&
29548 is true only for the first attempt at delivering a message, and
29549 &%manually_thawed%& is true only if the message has been frozen, and
29550 subsequently thawed by an admin user. An explicit forced delivery counts as a
29551 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
29552
29553 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
29554 specify an &"unseen"& (non-significant) delivery, and that delivery does not
29555 succeed, it will not be tried again.
29556 If you want Exim to retry an unseen delivery until it succeeds, you should
29557 arrange to set it up every time the filter runs.
29558
29559 When a system filter finishes running, the values of the variables &$n0$& &--
29560 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
29561 users' filter files. Thus a system filter can, for example, set up &"scores"&
29562 to which users' filter files can refer.
29563
29564
29565
29566 .section "Additional variable for system filters" "SECID215"
29567 .vindex "&$recipients$&"
29568 The expansion variable &$recipients$&, containing a list of all the recipients
29569 of the message (separated by commas and white space), is available in system
29570 filters. It is not available in users' filters for privacy reasons.
29571
29572
29573
29574 .section "Defer, freeze, and fail commands for system filters" "SECID216"
29575 .cindex "freezing messages"
29576 .cindex "message" "freezing"
29577 .cindex "message" "forced failure"
29578 .cindex "&%fail%&" "in system filter"
29579 .cindex "&%freeze%& in system filter"
29580 .cindex "&%defer%& in system filter"
29581 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
29582 always available in system filters, but are not normally enabled in users'
29583 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
29584 for the &(redirect)& router.) These commands can optionally be followed by the
29585 word &%text%& and a string containing an error message, for example:
29586 .code
29587 fail text "this message looks like spam to me"
29588 .endd
29589 The keyword &%text%& is optional if the next character is a double quote.
29590
29591 The &%defer%& command defers delivery of the original recipients of the
29592 message. The &%fail%& command causes all the original recipients to be failed,
29593 and a bounce message to be created. The &%freeze%& command suspends all
29594 delivery attempts for the original recipients. In all cases, any new deliveries
29595 that are specified by the filter are attempted as normal after the filter has
29596 run.
29597
29598 The &%freeze%& command is ignored if the message has been manually unfrozen and
29599 not manually frozen since. This means that automatic freezing by a system
29600 filter can be used as a way of checking out suspicious messages. If a message
29601 is found to be all right, manually unfreezing it allows it to be delivered.
29602
29603 .cindex "log" "&%fail%& command log line"
29604 .cindex "&%fail%&" "log line; reducing"
29605 The text given with a fail command is used as part of the bounce message as
29606 well as being written to the log. If the message is quite long, this can fill
29607 up a lot of log space when such failures are common. To reduce the size of the
29608 log message, Exim interprets the text in a special way if it starts with the
29609 two characters &`<<`& and contains &`>>`& later. The text between these two
29610 strings is written to the log, and the rest of the text is used in the bounce
29611 message. For example:
29612 .code
29613 fail "<<filter test 1>>Your message is rejected \
29614      because it contains attachments that we are \
29615      not prepared to receive."
29616 .endd
29617
29618 .cindex "loop" "caused by &%fail%&"
29619 Take great care with the &%fail%& command when basing the decision to fail on
29620 the contents of the message, because the bounce message will of course include
29621 the contents of the original message and will therefore trigger the &%fail%&
29622 command again (causing a mail loop) unless steps are taken to prevent this.
29623 Testing the &%error_message%& condition is one way to prevent this. You could
29624 use, for example
29625 .code
29626 if $message_body contains "this is spam" and not error_message
29627 then fail text "spam is not wanted here" endif
29628 .endd
29629 though of course that might let through unwanted bounce messages. The
29630 alternative is clever checking of the body and/or headers to detect bounces
29631 generated by the filter.
29632
29633 The interpretation of a system filter file ceases after a
29634 &%defer%&,
29635 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
29636 set up earlier in the filter file are honoured, so you can use a sequence such
29637 as
29638 .code
29639 mail ...
29640 freeze
29641 .endd
29642 to send a specified message when the system filter is freezing (or deferring or
29643 failing) a message. The normal deliveries for the message do not, of course,
29644 take place.
29645
29646
29647
29648 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
29649 .cindex "header lines" "adding; in system filter"
29650 .cindex "header lines" "removing; in system filter"
29651 .cindex "filter" "header lines; adding/removing"
29652 Two filter commands that are available only in system filters are:
29653 .code
29654 headers add <string>
29655 headers remove <string>
29656 .endd
29657 The argument for the &%headers add%& is a string that is expanded and then
29658 added to the end of the message's headers. It is the responsibility of the
29659 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
29660 space is ignored, and if the string is otherwise empty, or if the expansion is
29661 forced to fail, the command has no effect.
29662
29663 You can use &"\n"& within the string, followed by white space, to specify
29664 continued header lines. More than one header may be added in one command by
29665 including &"\n"& within the string without any following white space. For
29666 example:
29667 .code
29668 headers add "X-header-1: ....\n  \
29669              continuation of X-header-1 ...\n\
29670              X-header-2: ...."
29671 .endd
29672 Note that the header line continuation white space after the first newline must
29673 be placed before the backslash that continues the input string, because white
29674 space after input continuations is ignored.
29675
29676 The argument for &%headers remove%& is a colon-separated list of header names.
29677 This command applies only to those headers that are stored with the message;
29678 those that are added at delivery time (such as &'Envelope-To:'& and
29679 &'Return-Path:'&) cannot be removed by this means. If there is more than one
29680 header with the same name, they are all removed.
29681
29682 The &%headers%& command in a system filter makes an immediate change to the set
29683 of header lines that was received with the message (with possible additions
29684 from ACL processing). Subsequent commands in the system filter operate on the
29685 modified set, which also forms the basis for subsequent message delivery.
29686 Unless further modified during routing or transporting, this set of headers is
29687 used for all recipients of the message.
29688
29689 During routing and transporting, the variables that refer to the contents of
29690 header lines refer only to those lines that are in this set. Thus, header lines
29691 that are added by a system filter are visible to users' filter files and to all
29692 routers and transports. This contrasts with the manipulation of header lines by
29693 routers and transports, which is not immediate, but which instead is saved up
29694 until the message is actually being written (see section
29695 &<<SECTheadersaddrem>>&).
29696
29697 If the message is not delivered at the first attempt, header lines that were
29698 added by the system filter are stored with the message, and so are still
29699 present at the next delivery attempt. Header lines that were removed are still
29700 present, but marked &"deleted"& so that they are not transported with the
29701 message. For this reason, it is usual to make the &%headers%& command
29702 conditional on &%first_delivery%& so that the set of header lines is not
29703 modified more than once.
29704
29705 Because header modification in a system filter acts immediately, you have to
29706 use an indirect approach if you want to modify the contents of a header line.
29707 For example:
29708 .code
29709 headers add "Old-Subject: $h_subject:"
29710 headers remove "Subject"
29711 headers add "Subject: new subject (was: $h_old-subject:)"
29712 headers remove "Old-Subject"
29713 .endd
29714
29715
29716
29717 .section "Setting an errors address in a system filter" "SECID217"
29718 .cindex "envelope sender"
29719 In a system filter, if a &%deliver%& command is followed by
29720 .code
29721 errors_to <some address>
29722 .endd
29723 in order to change the envelope sender (and hence the error reporting) for that
29724 delivery, any address may be specified. (In a user filter, only the current
29725 user's address can be set.) For example, if some mail is being monitored, you
29726 might use
29727 .code
29728 unseen deliver monitor@spying.example errors_to root@local.example
29729 .endd
29730 to take a copy which would not be sent back to the normal error reporting
29731 address if its delivery failed.
29732
29733
29734
29735 .section "Per-address filtering" "SECTperaddfil"
29736 .vindex "&$domain$&"
29737 .vindex "&$local_part$&"
29738 In contrast to the system filter, which is run just once per message for each
29739 delivery attempt, it is also possible to set up a system-wide filtering
29740 operation that runs once for each recipient address. In this case, variables
29741 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
29742 filter file could be made dependent on them. This is an example of a router
29743 which implements such a filter:
29744 .code
29745 central_filter:
29746   check_local_user
29747   driver = redirect
29748   domains = +local_domains
29749   file = /central/filters/$local_part
29750   no_verify
29751   allow_filter
29752   allow_freeze
29753 .endd
29754 The filter is run in a separate process under its own uid. Therefore, either
29755 &%check_local_user%& must be set (as above), in which case the filter is run as
29756 the local user, or the &%user%& option must be used to specify which user to
29757 use. If both are set, &%user%& overrides.
29758
29759 Care should be taken to ensure that none of the commands in the filter file
29760 specify a significant delivery if the message is to go on to be delivered to
29761 its intended recipient. The router will not then claim to have dealt with the
29762 address, so it will be passed on to subsequent routers to be delivered in the
29763 normal way.
29764 .ecindex IIDsysfil1
29765 .ecindex IIDsysfil2
29766 .ecindex IIDsysfil3
29767
29768
29769
29770
29771
29772
29773 . ////////////////////////////////////////////////////////////////////////////
29774 . ////////////////////////////////////////////////////////////////////////////
29775
29776 .chapter "Message processing" "CHAPmsgproc"
29777 .scindex IIDmesproc "message" "general processing"
29778 Exim performs various transformations on the sender and recipient addresses of
29779 all messages that it handles, and also on the messages' header lines. Some of
29780 these are optional and configurable, while others always take place. All of
29781 this processing, except rewriting as a result of routing, and the addition or
29782 removal of header lines while delivering, happens when a message is received,
29783 before it is placed on Exim's queue.
29784
29785 Some of the automatic processing takes place by default only for
29786 &"locally-originated"& messages. This adjective is used to describe messages
29787 that are not received over TCP/IP, but instead are passed to an Exim process on
29788 its standard input. This includes the interactive &"local SMTP"& case that is
29789 set up by the &%-bs%& command line option.
29790
29791 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
29792 or ::1) are not considered to be locally-originated. Exim does not treat the
29793 loopback interface specially in any way.
29794
29795 If you want the loopback interface to be treated specially, you must ensure
29796 that there are appropriate entries in your ACLs.
29797
29798
29799
29800
29801 .section "Submission mode for non-local messages" "SECTsubmodnon"
29802 .cindex "message" "submission"
29803 .cindex "submission mode"
29804 Processing that happens automatically for locally-originated messages (unless
29805 &%suppress_local_fixups%& is set) can also be requested for messages that are
29806 received over TCP/IP. The term &"submission mode"& is used to describe this
29807 state. Submission mode is set by the modifier
29808 .code
29809 control = submission
29810 .endd
29811 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
29812 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
29813 a local submission, and is normally used when the source of the message is
29814 known to be an MUA running on a client host (as opposed to an MTA). For
29815 example, to set submission mode for messages originating on the IPv4 loopback
29816 interface, you could include the following in the MAIL ACL:
29817 .code
29818 warn  hosts = 127.0.0.1
29819       control = submission
29820 .endd
29821 .cindex "&%sender_retain%& submission option"
29822 There are some options that can be used when setting submission mode. A slash
29823 is used to separate options. For example:
29824 .code
29825 control = submission/sender_retain
29826 .endd
29827 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
29828 true and &%local_from_check%& false for the current incoming message. The first
29829 of these allows an existing &'Sender:'& header in the message to remain, and
29830 the second suppresses the check to ensure that &'From:'& matches the
29831 authenticated sender. With this setting, Exim still fixes up messages by adding
29832 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
29833 attempt to check sender authenticity in header lines.
29834
29835 When &%sender_retain%& is not set, a submission mode setting may specify a
29836 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
29837 example:
29838 .code
29839 control = submission/domain=some.domain
29840 .endd
29841 The domain may be empty. How this value is used is described in sections
29842 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
29843 that allows you to specify the user's full name for inclusion in a created
29844 &'Sender:'& or &'From:'& header line. For example:
29845 .code
29846 accept authenticated = *
29847        control = submission/domain=wonderland.example/\
29848                             name=${lookup {$authenticated_id} \
29849                                    lsearch {/etc/exim/namelist}}
29850 .endd
29851 Because the name may contain any characters, including slashes, the &%name%&
29852 option must be given last. The remainder of the string is used as the name. For
29853 the example above, if &_/etc/exim/namelist_& contains:
29854 .code
29855 bigegg:  Humpty Dumpty
29856 .endd
29857 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
29858 line would be:
29859 .code
29860 Sender: Humpty Dumpty <bigegg@wonderland.example>
29861 .endd
29862 .cindex "return path" "in submission mode"
29863 By default, submission mode forces the return path to the same address as is
29864 used to create the &'Sender:'& header. However, if &%sender_retain%& is
29865 specified, the return path is also left unchanged.
29866
29867 &*Note*&: The changes caused by submission mode take effect after the predata
29868 ACL. This means that any sender checks performed before the fix-ups use the
29869 untrusted sender address specified by the user, not the trusted sender address
29870 specified by submission mode. Although this might be slightly unexpected, it
29871 does mean that you can configure ACL checks to spot that a user is trying to
29872 spoof another's address.
29873
29874 .section "Line endings" "SECTlineendings"
29875 .cindex "line endings"
29876 .cindex "carriage return"
29877 .cindex "linefeed"
29878 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
29879 linefeed) is the line ending for messages transmitted over the Internet using
29880 SMTP over TCP/IP. However, within individual operating systems, different
29881 conventions are used. For example, Unix-like systems use just LF, but others
29882 use CRLF or just CR.
29883
29884 Exim was designed for Unix-like systems, and internally, it stores messages
29885 using the system's convention of a single LF as a line terminator. When
29886 receiving a message, all line endings are translated to this standard format.
29887 Originally, it was thought that programs that passed messages directly to an
29888 MTA within an operating system would use that system's convention. Experience
29889 has shown that this is not the case; for example, there are Unix applications
29890 that use CRLF in this circumstance. For this reason, and for compatibility with
29891 other MTAs, the way Exim handles line endings for all messages is now as
29892 follows:
29893
29894 .ilist
29895 LF not preceded by CR is treated as a line ending.
29896 .next
29897 CR is treated as a line ending; if it is immediately followed by LF, the LF
29898 is ignored.
29899 .next
29900 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
29901 nor a local message in the state where a line containing only a dot is a
29902 terminator.
29903 .next
29904 If a bare CR is encountered within a header line, an extra space is added after
29905 the line terminator so as not to end the header line. The reasoning behind this
29906 is that bare CRs in header lines are most likely either to be mistakes, or
29907 people trying to play silly games.
29908 .next
29909 If the first header line received in a message ends with CRLF, a subsequent
29910 bare LF in a header line is treated in the same way as a bare CR in a header
29911 line.
29912 .endlist
29913
29914
29915
29916
29917
29918 .section "Unqualified addresses" "SECID218"
29919 .cindex "unqualified addresses"
29920 .cindex "address" "qualification"
29921 By default, Exim expects every envelope address it receives from an external
29922 host to be fully qualified. Unqualified addresses cause negative responses to
29923 SMTP commands. However, because SMTP is used as a means of transporting
29924 messages from MUAs running on personal workstations, there is sometimes a
29925 requirement to accept unqualified addresses from specific hosts or IP networks.
29926
29927 Exim has two options that separately control which hosts may send unqualified
29928 sender or recipient addresses in SMTP commands, namely
29929 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
29930 cases, if an unqualified address is accepted, it is qualified by adding the
29931 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
29932
29933 .oindex "&%qualify_domain%&"
29934 .oindex "&%qualify_recipient%&"
29935 Unqualified addresses in header lines are automatically qualified for messages
29936 that are locally originated, unless the &%-bnq%& option is given on the command
29937 line. For messages received over SMTP, unqualified addresses in header lines
29938 are qualified only if unqualified addresses are permitted in SMTP commands. In
29939 other words, such qualification is also controlled by
29940 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
29941
29942
29943
29944
29945 .section "The UUCP From line" "SECID219"
29946 .cindex "&""From""& line"
29947 .cindex "UUCP" "&""From""& line"
29948 .cindex "sender" "address"
29949 .oindex "&%uucp_from_pattern%&"
29950 .oindex "&%uucp_from_sender%&"
29951 .cindex "envelope sender"
29952 .cindex "Sendmail compatibility" "&""From""& line"
29953 Messages that have come from UUCP (and some other applications) often begin
29954 with a line containing the envelope sender and a timestamp, following the word
29955 &"From"&. Examples of two common formats are:
29956 .code
29957 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
29958 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
29959 .endd
29960 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
29961 Exim recognizes such lines at the start of messages that are submitted to it
29962 via the command line (that is, on the standard input). It does not recognize
29963 such lines in incoming SMTP messages, unless the sending host matches
29964 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
29965 and &%ignore_fromline_local%& is set. The recognition is controlled by a
29966 regular expression that is defined by the &%uucp_from_pattern%& option, whose
29967 default value matches the two common cases shown above and puts the address
29968 that follows &"From"& into &$1$&.
29969
29970 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
29971 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
29972 a trusted user, the message's sender address is constructed by expanding the
29973 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
29974 then parsed as an RFC 2822 address. If there is no domain, the local part is
29975 qualified with &%qualify_domain%& unless it is the empty string. However, if
29976 the command line &%-f%& option is used, it overrides the &"From"& line.
29977
29978 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
29979 sender address is not changed. This is also the case for incoming SMTP messages
29980 that are permitted to contain &"From"& lines.
29981
29982 Only one &"From"& line is recognized. If there is more than one, the second is
29983 treated as a data line that starts the body of the message, as it is not valid
29984 as a header line. This also happens if a &"From"& line is present in an
29985 incoming SMTP message from a source that is not permitted to send them.
29986
29987
29988
29989 .section "Resent- header lines" "SECID220"
29990 .cindex "&%Resent-%& header lines"
29991 RFC 2822 makes provision for sets of header lines starting with the string
29992 &`Resent-`& to be added to a message when it is resent by the original
29993 recipient to somebody else. These headers are &'Resent-Date:'&,
29994 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
29995 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
29996
29997 .blockquote
29998 &'Resent fields are strictly informational. They MUST NOT be used in the normal
29999 processing of replies or other such automatic actions on messages.'&
30000 .endblockquote
30001
30002 This leaves things a bit vague as far as other processing actions such as
30003 address rewriting are concerned. Exim treats &%Resent-%& header lines as
30004 follows:
30005
30006 .ilist
30007 A &'Resent-From:'& line that just contains the login id of the submitting user
30008 is automatically rewritten in the same way as &'From:'& (see below).
30009 .next
30010 If there's a rewriting rule for a particular header line, it is also applied to
30011 &%Resent-%& header lines of the same type. For example, a rule that rewrites
30012 &'From:'& also rewrites &'Resent-From:'&.
30013 .next
30014 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
30015 also removed.
30016 .next
30017 For a locally-submitted message,
30018 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
30019 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
30020 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
30021 included in log lines in this case.
30022 .next
30023 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
30024 &%Resent-%& header lines are present.
30025 .endlist
30026
30027
30028
30029
30030 .section "The Auto-Submitted: header line" "SECID221"
30031 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
30032 includes the header line:
30033 .code
30034 Auto-Submitted: auto-replied
30035 .endd
30036
30037 .section "The Bcc: header line" "SECID222"
30038 .cindex "&'Bcc:'& header line"
30039 If Exim is called with the &%-t%& option, to take recipient addresses from a
30040 message's header, it removes any &'Bcc:'& header line that may exist (after
30041 extracting its addresses). If &%-t%& is not present on the command line, any
30042 existing &'Bcc:'& is not removed.
30043
30044
30045 .section "The Date: header line" "SECID223"
30046 .cindex "&'Date:'& header line"
30047 If a locally-generated or submission-mode message has no &'Date:'& header line,
30048 Exim adds one, using the current date and time, unless the
30049 &%suppress_local_fixups%& control has been specified.
30050
30051 .section "The Delivery-date: header line" "SECID224"
30052 .cindex "&'Delivery-date:'& header line"
30053 .oindex "&%delivery_date_remove%&"
30054 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
30055 set. Exim can be configured to add them to the final delivery of messages. (See
30056 the generic &%delivery_date_add%& transport option.) They should not be present
30057 in messages in transit. If the &%delivery_date_remove%& configuration option is
30058 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
30059 messages.
30060
30061
30062 .section "The Envelope-to: header line" "SECID225"
30063 .cindex "&'Envelope-to:'& header line"
30064 .oindex "&%envelope_to_remove%&"
30065 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
30066 Exim can be configured to add them to the final delivery of messages. (See the
30067 generic &%envelope_to_add%& transport option.) They should not be present in
30068 messages in transit. If the &%envelope_to_remove%& configuration option is set
30069 (the default), Exim removes &'Envelope-to:'& header lines from incoming
30070 messages.
30071
30072
30073 .section "The From: header line" "SECTthefrohea"
30074 .cindex "&'From:'& header line"
30075 .cindex "Sendmail compatibility" "&""From""& line"
30076 .cindex "message" "submission"
30077 .cindex "submission mode"
30078 If a submission-mode message does not contain a &'From:'& header line, Exim
30079 adds one if either of the following conditions is true:
30080
30081 .ilist
30082 The envelope sender address is not empty (that is, this is not a bounce
30083 message). The added header line copies the envelope sender address.
30084 .next
30085 .vindex "&$authenticated_id$&"
30086 The SMTP session is authenticated and &$authenticated_id$& is not empty.
30087 .olist
30088 .vindex "&$qualify_domain$&"
30089 If no domain is specified by the submission control, the local part is
30090 &$authenticated_id$& and the domain is &$qualify_domain$&.
30091 .next
30092 If a non-empty domain is specified by the submission control, the local
30093 part is &$authenticated_id$&, and the domain is the specified domain.
30094 .next
30095 If an empty domain is specified by the submission control,
30096 &$authenticated_id$& is assumed to be the complete address.
30097 .endlist
30098 .endlist
30099
30100 A non-empty envelope sender takes precedence.
30101
30102 If a locally-generated incoming message does not contain a &'From:'& header
30103 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
30104 containing the sender's address. The calling user's login name and full name
30105 are used to construct the address, as described in section &<<SECTconstr>>&.
30106 They are obtained from the password data by calling &[getpwuid()]& (but see the
30107 &%unknown_login%& configuration option). The address is qualified with
30108 &%qualify_domain%&.
30109
30110 For compatibility with Sendmail, if an incoming, non-SMTP message has a
30111 &'From:'& header line containing just the unqualified login name of the calling
30112 user, this is replaced by an address containing the user's login name and full
30113 name as described in section &<<SECTconstr>>&.
30114
30115
30116 .section "The Message-ID: header line" "SECID226"
30117 .cindex "&'Message-ID:'& header line"
30118 .cindex "message" "submission"
30119 .oindex "&%message_id_header_text%&"
30120 If a locally-generated or submission-mode incoming message does not contain a
30121 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
30122 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
30123 to the message. If there are any &'Resent-:'& headers in the message, it
30124 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
30125 message id, preceded by the letter E to ensure it starts with a letter, and
30126 followed by @ and the primary host name. Additional information can be included
30127 in this header line by setting the &%message_id_header_text%& and/or
30128 &%message_id_header_domain%& options.
30129
30130
30131 .section "The Received: header line" "SECID227"
30132 .cindex "&'Received:'& header line"
30133 A &'Received:'& header line is added at the start of every message. The
30134 contents are defined by the &%received_header_text%& configuration option, and
30135 Exim automatically adds a semicolon and a timestamp to the configured string.
30136
30137 The &'Received:'& header is generated as soon as the message's header lines
30138 have been received. At this stage, the timestamp in the &'Received:'& header
30139 line is the time that the message started to be received. This is the value
30140 that is seen by the DATA ACL and by the &[local_scan()]& function.
30141
30142 Once a message is accepted, the timestamp in the &'Received:'& header line is
30143 changed to the time of acceptance, which is (apart from a small delay while the
30144 -H spool file is written) the earliest time at which delivery could start.
30145
30146
30147 .section "The References: header line" "SECID228"
30148 .cindex "&'References:'& header line"
30149 Messages created by the &(autoreply)& transport include a &'References:'&
30150 header line. This is constructed according to the rules that are described in
30151 section 3.64 of RFC 2822 (which states that replies should contain such a
30152 header line), and section 3.14 of RFC 3834 (which states that automatic
30153 responses are not different in this respect). However, because some mail
30154 processing software does not cope well with very long header lines, no more
30155 than 12 message IDs are copied from the &'References:'& header line in the
30156 incoming message. If there are more than 12, the first one and then the final
30157 11 are copied, before adding the message ID of the incoming message.
30158
30159
30160
30161 .section "The Return-path: header line" "SECID229"
30162 .cindex "&'Return-path:'& header line"
30163 .oindex "&%return_path_remove%&"
30164 &'Return-path:'& header lines are defined as something an MTA may insert when
30165 it does the final delivery of messages. (See the generic &%return_path_add%&
30166 transport option.) Therefore, they should not be present in messages in
30167 transit. If the &%return_path_remove%& configuration option is set (the
30168 default), Exim removes &'Return-path:'& header lines from incoming messages.
30169
30170
30171
30172 .section "The Sender: header line" "SECTthesenhea"
30173 .cindex "&'Sender:'& header line"
30174 .cindex "message" "submission"
30175 For a locally-originated message from an untrusted user, Exim may remove an
30176 existing &'Sender:'& header line, and it may add a new one. You can modify
30177 these actions by setting the &%local_sender_retain%& option true, the
30178 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
30179 control setting.
30180
30181 When a local message is received from an untrusted user and
30182 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
30183 control has not been set, a check is made to see if the address given in the
30184 &'From:'& header line is the correct (local) sender of the message. The address
30185 that is expected has the login name as the local part and the value of
30186 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
30187 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
30188 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
30189 line is added to the message.
30190
30191 If you set &%local_from_check%& false, this checking does not occur. However,
30192 the removal of an existing &'Sender:'& line still happens, unless you also set
30193 &%local_sender_retain%& to be true. It is not possible to set both of these
30194 options true at the same time.
30195
30196 .cindex "submission mode"
30197 By default, no processing of &'Sender:'& header lines is done for messages
30198 received over TCP/IP or for messages submitted by trusted users. However, when
30199 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
30200 not specified on the submission control, the following processing takes place:
30201
30202 .vindex "&$authenticated_id$&"
30203 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
30204 authenticated, and &$authenticated_id$& is not empty, a sender address is
30205 created as follows:
30206
30207 .ilist
30208 .vindex "&$qualify_domain$&"
30209 If no domain is specified by the submission control, the local part is
30210 &$authenticated_id$& and the domain is &$qualify_domain$&.
30211 .next
30212 If a non-empty domain is specified by the submission control, the local part
30213 is &$authenticated_id$&, and the domain is the specified domain.
30214 .next
30215 If an empty domain is specified by the submission control,
30216 &$authenticated_id$& is assumed to be the complete address.
30217 .endlist
30218
30219 This address is compared with the address in the &'From:'& header line. If they
30220 are different, a &'Sender:'& header line containing the created address is
30221 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
30222 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
30223
30224 .cindex "return path" "created from &'Sender:'&"
30225 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
30226 the message (the envelope sender address) is changed to be the same address,
30227 except in the case of submission mode when &%sender_retain%& is specified.
30228
30229
30230
30231 .section "Adding and removing header lines in routers and transports" &&&
30232          "SECTheadersaddrem"
30233 .cindex "header lines" "adding; in router or transport"
30234 .cindex "header lines" "removing; in router or transport"
30235 When a message is delivered, the addition and removal of header lines can be
30236 specified in a system filter, or on any of the routers and transports that
30237 process the message. Section &<<SECTaddremheasys>>& contains details about
30238 modifying headers in a system filter. Header lines can also be added in an ACL
30239 as a message is received (see section &<<SECTaddheadacl>>&).
30240
30241 In contrast to what happens in a system filter, header modifications that are
30242 specified on routers and transports apply only to the particular recipient
30243 addresses that are being processed by those routers and transports. These
30244 changes do not actually take place until a copy of the message is being
30245 transported. Therefore, they do not affect the basic set of header lines, and
30246 they do not affect the values of the variables that refer to header lines.
30247
30248 &*Note*&: In particular, this means that any expansions in the configuration of
30249 the transport cannot refer to the modified header lines, because such
30250 expansions all occur before the message is actually transported.
30251
30252 For both routers and transports, the result of expanding a &%headers_add%&
30253 option must be in the form of one or more RFC 2822 header lines, separated by
30254 newlines (coded as &"\n"&). For example:
30255 .code
30256 headers_add = X-added-header: added by $primary_hostname\n\
30257               X-added-second: another added header line
30258 .endd
30259 Exim does not check the syntax of these added header lines.
30260
30261 The result of expanding &%headers_remove%& must consist of a colon-separated
30262 list of header names. This is confusing, because header names themselves are
30263 often terminated by colons. In this case, the colons are the list separators,
30264 not part of the names. For example:
30265 .code
30266 headers_remove = return-receipt-to:acknowledge-to
30267 .endd
30268 When &%headers_add%& or &%headers_remove%& is specified on a router, its value
30269 is expanded at routing time, and then associated with all addresses that are
30270 accepted by that router, and also with any new addresses that it generates. If
30271 an address passes through several routers as a result of aliasing or
30272 forwarding, the changes are cumulative.
30273
30274 .oindex "&%unseen%&"
30275 However, this does not apply to multiple routers that result from the use of
30276 the &%unseen%& option. Any header modifications that were specified by the
30277 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
30278
30279 Addresses that end up with different &%headers_add%& or &%headers_remove%&
30280 settings cannot be delivered together in a batch, so a transport is always
30281 dealing with a set of addresses that have the same header-processing
30282 requirements.
30283
30284 The transport starts by writing the original set of header lines that arrived
30285 with the message, possibly modified by the system filter. As it writes out
30286 these lines, it consults the list of header names that were attached to the
30287 recipient address(es) by &%headers_remove%& options in routers, and it also
30288 consults the transport's own &%headers_remove%& option. Header lines whose
30289 names are on either of these lists are not written out. If there are multiple
30290 instances of any listed header, they are all skipped.
30291
30292 After the remaining original header lines have been written, new header
30293 lines that were specified by routers' &%headers_add%& options are written, in
30294 the order in which they were attached to the address. These are followed by any
30295 header lines specified by the transport's &%headers_add%& option.
30296
30297 This way of handling header line modifications in routers and transports has
30298 the following consequences:
30299
30300 .ilist
30301 The original set of header lines, possibly modified by the system filter,
30302 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
30303 to it, at all times.
30304 .next
30305 Header lines that are added by a router's
30306 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
30307 expansion syntax in subsequent routers or the transport.
30308 .next
30309 Conversely, header lines that are specified for removal by &%headers_remove%&
30310 in a router remain visible to subsequent routers and the transport.
30311 .next
30312 Headers added to an address by &%headers_add%& in a router cannot be removed by
30313 a later router or by a transport.
30314 .next
30315 An added header can refer to the contents of an original header that is to be
30316 removed, even it has the same name as the added header. For example:
30317 .code
30318 headers_remove = subject
30319 headers_add = Subject: new subject (was: $h_subject:)
30320 .endd
30321 .endlist
30322
30323 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
30324 for a &(redirect)& router that has the &%one_time%& option set.
30325
30326
30327
30328
30329
30330 .section "Constructed addresses" "SECTconstr"
30331 .cindex "address" "constructed"
30332 .cindex "constructed address"
30333 When Exim constructs a sender address for a locally-generated message, it uses
30334 the form
30335 .display
30336 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
30337 .endd
30338 For example:
30339 .code
30340 Zaphod Beeblebrox <zaphod@end.univ.example>
30341 .endd
30342 The user name is obtained from the &%-F%& command line option if set, or
30343 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
30344 &"gecos"& field from the password entry. If the &"gecos"& field contains an
30345 ampersand character, this is replaced by the login name with the first letter
30346 upper cased, as is conventional in a number of operating systems. See the
30347 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
30348 The &%unknown_username%& option can be used to specify user names in cases when
30349 there is no password file entry.
30350
30351 .cindex "RFC 2047"
30352 In all cases, the user name is made to conform to RFC 2822 by quoting all or
30353 parts of it if necessary. In addition, if it contains any non-printing
30354 characters, it is encoded as described in RFC 2047, which defines a way of
30355 including non-ASCII characters in header lines. The value of the
30356 &%headers_charset%& option specifies the name of the encoding that is used (the
30357 characters are assumed to be in this encoding). The setting of
30358 &%print_topbitchars%& controls whether characters with the top bit set (that
30359 is, with codes greater than 127) count as printing characters or not.
30360
30361
30362
30363 .section "Case of local parts" "SECID230"
30364 .cindex "case of local parts"
30365 .cindex "local part" "case of"
30366 RFC 2822 states that the case of letters in the local parts of addresses cannot
30367 be assumed to be non-significant. Exim preserves the case of local parts of
30368 addresses, but by default it uses a lower-cased form when it is routing,
30369 because on most Unix systems, usernames are in lower case and case-insensitive
30370 routing is required. However, any particular router can be made to use the
30371 original case for local parts by setting the &%caseful_local_part%& generic
30372 router option.
30373
30374 .cindex "mixed-case login names"
30375 If you must have mixed-case user names on your system, the best way to proceed,
30376 assuming you want case-independent handling of incoming email, is to set up
30377 your first router to convert incoming local parts in your domains to the
30378 correct case by means of a file lookup. For example:
30379 .code
30380 correct_case:
30381   driver = redirect
30382   domains = +local_domains
30383   data = ${lookup{$local_part}cdb\
30384               {/etc/usercased.cdb}{$value}fail}\
30385               @$domain
30386 .endd
30387 For this router, the local part is forced to lower case by the default action
30388 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
30389 up a new local part in the correct case. If you then set &%caseful_local_part%&
30390 on any subsequent routers which process your domains, they will operate on
30391 local parts with the correct case in a case-sensitive manner.
30392
30393
30394
30395 .section "Dots in local parts" "SECID231"
30396 .cindex "dot" "in local part"
30397 .cindex "local part" "dots in"
30398 RFC 2822 forbids empty components in local parts. That is, an unquoted local
30399 part may not begin or end with a dot, nor have two consecutive dots in the
30400 middle. However, it seems that many MTAs do not enforce this, so Exim permits
30401 empty components for compatibility.
30402
30403
30404
30405 .section "Rewriting addresses" "SECID232"
30406 .cindex "rewriting" "addresses"
30407 Rewriting of sender and recipient addresses, and addresses in headers, can
30408 happen automatically, or as the result of configuration options, as described
30409 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
30410 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
30411
30412 Automatic rewriting includes qualification, as mentioned above. The other case
30413 in which it can happen is when an incomplete non-local domain is given. The
30414 routing process may cause this to be expanded into the full domain name. For
30415 example, a header such as
30416 .code
30417 To: hare@teaparty
30418 .endd
30419 might get rewritten as
30420 .code
30421 To: hare@teaparty.wonderland.fict.example
30422 .endd
30423 Rewriting as a result of routing is the one kind of message processing that
30424 does not happen at input time, as it cannot be done until the address has
30425 been routed.
30426
30427 Strictly, one should not do &'any'& deliveries of a message until all its
30428 addresses have been routed, in case any of the headers get changed as a
30429 result of routing. However, doing this in practice would hold up many
30430 deliveries for unreasonable amounts of time, just because one address could not
30431 immediately be routed. Exim therefore does not delay other deliveries when
30432 routing of one or more addresses is deferred.
30433 .ecindex IIDmesproc
30434
30435
30436
30437 . ////////////////////////////////////////////////////////////////////////////
30438 . ////////////////////////////////////////////////////////////////////////////
30439
30440 .chapter "SMTP processing" "CHAPSMTP"
30441 .scindex IIDsmtpproc1 "SMTP" "processing details"
30442 .scindex IIDsmtpproc2 "LMTP" "processing details"
30443 Exim supports a number of different ways of using the SMTP protocol, and its
30444 LMTP variant, which is an interactive protocol for transferring messages into a
30445 closed mail store application. This chapter contains details of how SMTP is
30446 processed. For incoming mail, the following are available:
30447
30448 .ilist
30449 SMTP over TCP/IP (Exim daemon or &'inetd'&);
30450 .next
30451 SMTP over the standard input and output (the &%-bs%& option);
30452 .next
30453 Batched SMTP on the standard input (the &%-bS%& option).
30454 .endlist
30455
30456 For mail delivery, the following are available:
30457
30458 .ilist
30459 SMTP over TCP/IP (the &(smtp)& transport);
30460 .next
30461 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
30462 &"lmtp"&);
30463 .next
30464 LMTP over a pipe to a process running in the local host (the &(lmtp)&
30465 transport);
30466 .next
30467 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
30468 the &%use_bsmtp%& option set).
30469 .endlist
30470
30471 &'Batched SMTP'& is the name for a process in which batches of messages are
30472 stored in or read from files (or pipes), in a format in which SMTP commands are
30473 used to contain the envelope information.
30474
30475
30476
30477 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
30478 .cindex "SMTP" "outgoing over TCP/IP"
30479 .cindex "outgoing SMTP over TCP/IP"
30480 .cindex "LMTP" "over TCP/IP"
30481 .cindex "outgoing LMTP over TCP/IP"
30482 .cindex "EHLO"
30483 .cindex "HELO"
30484 .cindex "SIZE option on MAIL command"
30485 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
30486 The &%protocol%& option selects which protocol is to be used, but the actual
30487 processing is the same in both cases.
30488
30489 If, in response to its EHLO command, Exim is told that the SIZE
30490 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
30491 command. The value of <&'n'&> is the message size plus the value of the
30492 &%size_addition%& option (default 1024) to allow for additions to the message
30493 such as per-transport header lines, or changes made in a
30494 .cindex "transport" "filter"
30495 .cindex "filter" "transport filter"
30496 transport filter. If &%size_addition%& is set negative, the use of SIZE is
30497 suppressed.
30498
30499 If the remote server advertises support for PIPELINING, Exim uses the
30500 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
30501 required for the transaction.
30502
30503 If the remote server advertises support for the STARTTLS command, and Exim
30504 was built to support TLS encryption, it tries to start a TLS session unless the
30505 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
30506
30507 If the remote server advertises support for the AUTH command, Exim scans
30508 the authenticators configuration for any suitable client settings, as described
30509 in chapter &<<CHAPSMTPAUTH>>&.
30510
30511 .cindex "carriage return"
30512 .cindex "linefeed"
30513 Responses from the remote host are supposed to be terminated by CR followed by
30514 LF. However, there are known to be hosts that do not send CR characters, so in
30515 order to be able to interwork with such hosts, Exim treats LF on its own as a
30516 line terminator.
30517
30518 If a message contains a number of different addresses, all those with the same
30519 characteristics (for example, the same envelope sender) that resolve to the
30520 same set of hosts, in the same order, are sent in a single SMTP transaction,
30521 even if they are for different domains, unless there are more than the setting
30522 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
30523 they are split into groups containing no more than &%max_rcpt%&s addresses
30524 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
30525 in parallel sessions. The order of hosts with identical MX values is not
30526 significant when checking whether addresses can be batched in this way.
30527
30528 When the &(smtp)& transport suffers a temporary failure that is not
30529 message-related, Exim updates its transport-specific database, which contains
30530 records indexed by host name that remember which messages are waiting for each
30531 particular host. It also updates the retry database with new retry times.
30532
30533 .cindex "hints database" "retry keys"
30534 Exim's retry hints are based on host name plus IP address, so if one address of
30535 a multi-homed host is broken, it will soon be skipped most of the time.
30536 See the next section for more detail about error handling.
30537
30538 .cindex "SMTP" "passed connection"
30539 .cindex "SMTP" "batching over TCP/IP"
30540 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
30541 looks in the hints database for the transport to see if there are any queued
30542 messages waiting for the host to which it is connected. If it finds one, it
30543 creates a new Exim process using the &%-MC%& option (which can only be used by
30544 a process running as root or the Exim user) and passes the TCP/IP socket to it
30545 so that it can deliver another message using the same socket. The new process
30546 does only those deliveries that are routed to the connected host, and may in
30547 turn pass the socket on to a third process, and so on.
30548
30549 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
30550 limit the number of messages sent down a single TCP/IP connection.
30551
30552 .cindex "asterisk" "after IP address"
30553 The second and subsequent messages delivered down an existing connection are
30554 identified in the main log by the addition of an asterisk after the closing
30555 square bracket of the IP address.
30556
30557
30558
30559
30560 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
30561 .cindex "error" "in outgoing SMTP"
30562 .cindex "SMTP" "errors in outgoing"
30563 .cindex "host" "error"
30564 Three different kinds of error are recognized for outgoing SMTP: host errors,
30565 message errors, and recipient errors.
30566
30567 .vlist
30568 .vitem "&*Host errors*&"
30569 A host error is not associated with a particular message or with a
30570 particular recipient of a message. The host errors are:
30571
30572 .ilist
30573 Connection refused or timed out,
30574 .next
30575 Any error response code on connection,
30576 .next
30577 Any error response code to EHLO or HELO,
30578 .next
30579 Loss of connection at any time, except after &"."&,
30580 .next
30581 I/O errors at any time,
30582 .next
30583 Timeouts during the session, other than in response to MAIL, RCPT or
30584 the &"."& at the end of the data.
30585 .endlist ilist
30586
30587 For a host error, a permanent error response on connection, or in response to
30588 EHLO, causes all addresses routed to the host to be failed. Any other host
30589 error causes all addresses to be deferred, and retry data to be created for the
30590 host. It is not tried again, for any message, until its retry time arrives. If
30591 the current set of addresses are not all delivered in this run (to some
30592 alternative host), the message is added to the list of those waiting for this
30593 host, so if it is still undelivered when a subsequent successful delivery is
30594 made to the host, it will be sent down the same SMTP connection.
30595
30596 .vitem "&*Message errors*&"
30597 .cindex "message" "error"
30598 A message error is associated with a particular message when sent to a
30599 particular host, but not with a particular recipient of the message. The
30600 message errors are:
30601
30602 .ilist
30603 Any error response code to MAIL, DATA, or the &"."& that terminates
30604 the data,
30605 .next
30606 Timeout after MAIL,
30607 .next
30608 Timeout or loss of connection after the &"."& that terminates the data. A
30609 timeout after the DATA command itself is treated as a host error, as is loss of
30610 connection at any other time.
30611 .endlist ilist
30612
30613 For a message error, a permanent error response (5&'xx'&) causes all addresses
30614 to be failed, and a delivery error report to be returned to the sender. A
30615 temporary error response (4&'xx'&), or one of the timeouts, causes all
30616 addresses to be deferred. Retry data is not created for the host, but instead,
30617 a retry record for the combination of host plus message id is created. The
30618 message is not added to the list of those waiting for this host. This ensures
30619 that the failing message will not be sent to this host again until the retry
30620 time arrives. However, other messages that are routed to the host are not
30621 affected, so if it is some property of the message that is causing the error,
30622 it will not stop the delivery of other mail.
30623
30624 If the remote host specified support for the SIZE parameter in its response
30625 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
30626 over-large message will cause a message error because the error arrives as a
30627 response to MAIL.
30628
30629 .vitem "&*Recipient errors*&"
30630 .cindex "recipient" "error"
30631 A recipient error is associated with a particular recipient of a message. The
30632 recipient errors are:
30633
30634 .ilist
30635 Any error response to RCPT,
30636 .next
30637 Timeout after RCPT.
30638 .endlist
30639
30640 For a recipient error, a permanent error response (5&'xx'&) causes the
30641 recipient address to be failed, and a bounce message to be returned to the
30642 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
30643 address to be deferred, and routing retry data to be created for it. This is
30644 used to delay processing of the address in subsequent queue runs, until its
30645 routing retry time arrives. This applies to all messages, but because it
30646 operates only in queue runs, one attempt will be made to deliver a new message
30647 to the failing address before the delay starts to operate. This ensures that,
30648 if the failure is really related to the message rather than the recipient
30649 (&"message too big for this recipient"& is a possible example), other messages
30650 have a chance of getting delivered. If a delivery to the address does succeed,
30651 the retry information gets cleared, so all stuck messages get tried again, and
30652 the retry clock is reset.
30653
30654 The message is not added to the list of those waiting for this host. Use of the
30655 host for other messages is unaffected, and except in the case of a timeout,
30656 other recipients are processed independently, and may be successfully delivered
30657 in the current SMTP session. After a timeout it is of course impossible to
30658 proceed with the session, so all addresses get deferred. However, those other
30659 than the one that failed do not suffer any subsequent retry delays. Therefore,
30660 if one recipient is causing trouble, the others have a chance of getting
30661 through when a subsequent delivery attempt occurs before the failing
30662 recipient's retry time.
30663 .endlist
30664
30665 In all cases, if there are other hosts (or IP addresses) available for the
30666 current set of addresses (for example, from multiple MX records), they are
30667 tried in this run for any undelivered addresses, subject of course to their
30668 own retry data. In other words, recipient error retry data does not take effect
30669 until the next delivery attempt.
30670
30671 Some hosts have been observed to give temporary error responses to every
30672 MAIL command at certain times (&"insufficient space"& has been seen). It
30673 would be nice if such circumstances could be recognized, and defer data for the
30674 host itself created, but this is not possible within the current Exim design.
30675 What actually happens is that retry data for every (host, message) combination
30676 is created.
30677
30678 The reason that timeouts after MAIL and RCPT are treated specially is that
30679 these can sometimes arise as a result of the remote host's verification
30680 procedures. Exim makes this assumption, and treats them as if a temporary error
30681 response had been received. A timeout after &"."& is treated specially because
30682 it is known that some broken implementations fail to recognize the end of the
30683 message if the last character of the last line is a binary zero. Thus, it is
30684 helpful to treat this case as a message error.
30685
30686 Timeouts at other times are treated as host errors, assuming a problem with the
30687 host, or the connection to it. If a timeout after MAIL, RCPT,
30688 or &"."& is really a connection problem, the assumption is that at the next try
30689 the timeout is likely to occur at some other point in the dialogue, causing it
30690 then to be treated as a host error.
30691
30692 There is experimental evidence that some MTAs drop the connection after the
30693 terminating &"."& if they do not like the contents of the message for some
30694 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
30695 should be given. That is why Exim treats this case as a message rather than a
30696 host error, in order not to delay other messages to the same host.
30697
30698
30699
30700
30701 .section "Incoming SMTP messages over TCP/IP" "SECID233"
30702 .cindex "SMTP" "incoming over TCP/IP"
30703 .cindex "incoming SMTP over TCP/IP"
30704 .cindex "inetd"
30705 .cindex "daemon"
30706 Incoming SMTP messages can be accepted in one of two ways: by running a
30707 listening daemon, or by using &'inetd'&. In the latter case, the entry in
30708 &_/etc/inetd.conf_& should be like this:
30709 .code
30710 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
30711 .endd
30712 Exim distinguishes between this case and the case of a locally running user
30713 agent using the &%-bs%& option by checking whether or not the standard input is
30714 a socket. When it is, either the port must be privileged (less than 1024), or
30715 the caller must be root or the Exim user. If any other user passes a socket
30716 with an unprivileged port number, Exim prints a message on the standard error
30717 stream and exits with an error code.
30718
30719 By default, Exim does not make a log entry when a remote host connects or
30720 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
30721 unexpected. It can be made to write such log entries by setting the
30722 &%smtp_connection%& log selector.
30723
30724 .cindex "carriage return"
30725 .cindex "linefeed"
30726 Commands from the remote host are supposed to be terminated by CR followed by
30727 LF. However, there are known to be hosts that do not send CR characters. In
30728 order to be able to interwork with such hosts, Exim treats LF on its own as a
30729 line terminator.
30730 Furthermore, because common code is used for receiving messages from all
30731 sources, a CR on its own is also interpreted as a line terminator. However, the
30732 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
30733
30734 .cindex "EHLO" "invalid data"
30735 .cindex "HELO" "invalid data"
30736 One area that sometimes gives rise to problems concerns the EHLO or
30737 HELO commands. Some clients send syntactically invalid versions of these
30738 commands, which Exim rejects by default. (This is nothing to do with verifying
30739 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
30740 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
30741 match the broken hosts that send invalid commands.
30742
30743 .cindex "SIZE option on MAIL command"
30744 .cindex "MAIL" "SIZE option"
30745 The amount of disk space available is checked whenever SIZE is received on
30746 a MAIL command, independently of whether &%message_size_limit%& or
30747 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
30748 false. A temporary error is given if there is not enough space. If
30749 &%check_spool_space%& is set, the check is for that amount of space plus the
30750 value given with SIZE, that is, it checks that the addition of the incoming
30751 message will not reduce the space below the threshold.
30752
30753 When a message is successfully received, Exim includes the local message id in
30754 its response to the final &"."& that terminates the data. If the remote host
30755 logs this text it can help with tracing what has happened to a message.
30756
30757 The Exim daemon can limit the number of simultaneous incoming connections it is
30758 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
30759 number of simultaneous incoming connections from a single remote host (see the
30760 &%smtp_accept_max_per_host%& option). Additional connection attempts are
30761 rejected using the SMTP temporary error code 421.
30762
30763 The Exim daemon does not rely on the SIGCHLD signal to detect when a
30764 subprocess has finished, as this can get lost at busy times. Instead, it looks
30765 for completed subprocesses every time it wakes up. Provided there are other
30766 things happening (new incoming calls, starts of queue runs), completed
30767 processes will be noticed and tidied away. On very quiet systems you may
30768 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
30769 it will be noticed when the daemon next wakes up.
30770
30771 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
30772 and can also be set up to reject SMTP calls from non-reserved hosts at times of
30773 high system load &-- for details see the &%smtp_accept_reserve%&,
30774 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
30775 applies in both the daemon and &'inetd'& cases.
30776
30777 Exim normally starts a delivery process for each message received, though this
30778 can be varied by means of the &%-odq%& command line option and the
30779 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
30780 number of simultaneously running delivery processes started in this way from
30781 SMTP input can be limited by the &%smtp_accept_queue%& and
30782 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
30783 subsequently received messages are just put on the input queue without starting
30784 a delivery process.
30785
30786 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
30787 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
30788 started up from the &'inetd'& daemon, because in that case each connection is
30789 handled by an entirely independent Exim process. Control by load average is,
30790 however, available with &'inetd'&.
30791
30792 Exim can be configured to verify addresses in incoming SMTP commands as they
30793 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
30794 to rewrite addresses at this time &-- before any syntax checking is done. See
30795 section &<<SECTrewriteS>>&.
30796
30797 Exim can also be configured to limit the rate at which a client host submits
30798 MAIL and RCPT commands in a single SMTP session. See the
30799 &%smtp_ratelimit_hosts%& option.
30800
30801
30802
30803 .section "Unrecognized SMTP commands" "SECID234"
30804 .cindex "SMTP" "unrecognized commands"
30805 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
30806 commands during a single SMTP connection, it drops the connection after sending
30807 the error response to the last command. The default value for
30808 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
30809 abuse that subvert web servers into making connections to SMTP ports; in these
30810 circumstances, a number of non-SMTP lines are sent first.
30811
30812
30813 .section "Syntax and protocol errors in SMTP commands" "SECID235"
30814 .cindex "SMTP" "syntax errors"
30815 .cindex "SMTP" "protocol errors"
30816 A syntax error is detected if an SMTP command is recognized, but there is
30817 something syntactically wrong with its data, for example, a malformed email
30818 address in a RCPT command. Protocol errors include invalid command
30819 sequencing such as RCPT before MAIL. If Exim receives more than
30820 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
30821 drops the connection after sending the error response to the last command. The
30822 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
30823 broken clients that loop sending bad commands (yes, it has been seen).
30824
30825
30826
30827 .section "Use of non-mail SMTP commands" "SECID236"
30828 .cindex "SMTP" "non-mail commands"
30829 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
30830 DATA. Exim counts such commands, and drops the connection if there are too
30831 many of them in a single SMTP session. This action catches some
30832 denial-of-service attempts and things like repeated failing AUTHs, or a mad
30833 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
30834 defines what &"too many"& means. Its default value is 10.
30835
30836 When a new message is expected, one occurrence of RSET is not counted. This
30837 allows a client to send one RSET between messages (this is not necessary,
30838 but some clients do it). Exim also allows one uncounted occurrence of HELO
30839 or EHLO, and one occurrence of STARTTLS between messages. After
30840 starting up a TLS session, another EHLO is expected, and so it too is not
30841 counted.
30842
30843 The first occurrence of AUTH in a connection, or immediately following
30844 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
30845 RCPT, DATA, and QUIT are counted.
30846
30847 You can control which hosts are subject to the limit set by
30848 &%smtp_accept_max_nonmail%& by setting
30849 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
30850 the limit apply to all hosts. This option means that you can exclude any
30851 specific badly-behaved hosts that you have to live with.
30852
30853
30854
30855
30856 .section "The VRFY and EXPN commands" "SECID237"
30857 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
30858 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
30859 appropriate) in order to decide whether the command should be accepted or not.
30860 If no ACL is defined, the command is rejected.
30861
30862 .cindex "VRFY" "processing"
30863 When VRFY is accepted, it runs exactly the same code as when Exim is
30864 called with the &%-bv%& option.
30865
30866 .cindex "EXPN" "processing"
30867 When EXPN is accepted, a single-level expansion of the address is done.
30868 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
30869 than a verification (the &%-bv%& option). If an unqualified local part is given
30870 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
30871 of VRFY and EXPN commands are logged on the main and reject logs, and
30872 VRFY verification failures are logged on the main log for consistency with
30873 RCPT failures.
30874
30875
30876
30877 .section "The ETRN command" "SECTETRN"
30878 .cindex "ETRN" "processing"
30879 RFC 1985 describes an SMTP command called ETRN that is designed to
30880 overcome the security problems of the TURN command (which has fallen into
30881 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
30882 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
30883 should be accepted or not. If no ACL is defined, the command is rejected.
30884
30885 The ETRN command is concerned with &"releasing"& messages that are awaiting
30886 delivery to certain hosts. As Exim does not organize its message queue by host,
30887 the only form of ETRN that is supported by default is the one where the
30888 text starts with the &"#"& prefix, in which case the remainder of the text is
30889 specific to the SMTP server. A valid ETRN command causes a run of Exim with
30890 the &%-R%& option to happen, with the remainder of the ETRN text as its
30891 argument. For example,
30892 .code
30893 ETRN #brigadoon
30894 .endd
30895 runs the command
30896 .code
30897 exim -R brigadoon
30898 .endd
30899 which causes a delivery attempt on all messages with undelivered addresses
30900 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
30901 default), Exim prevents the simultaneous execution of more than one queue run
30902 for the same argument string as a result of an ETRN command. This stops
30903 a misbehaving client from starting more than one queue runner at once.
30904
30905 .cindex "hints database" "ETRN serialization"
30906 Exim implements the serialization by means of a hints database in which a
30907 record is written whenever a process is started by ETRN, and deleted when
30908 the process completes. However, Exim does not keep the SMTP session waiting for
30909 the ETRN process to complete. Once ETRN is accepted, the client is sent
30910 a &"success"& return code. Obviously there is scope for hints records to get
30911 left lying around if there is a system or program crash. To guard against this,
30912 Exim ignores any records that are more than six hours old.
30913
30914 .oindex "&%smtp_etrn_command%&"
30915 For more control over what ETRN does, the &%smtp_etrn_command%& option can
30916 used. This specifies a command that is run whenever ETRN is received,
30917 whatever the form of its argument. For
30918 example:
30919 .code
30920 smtp_etrn_command = /etc/etrn_command $domain \
30921                     $sender_host_address
30922 .endd
30923 .vindex "&$domain$&"
30924 The string is split up into arguments which are independently expanded. The
30925 expansion variable &$domain$& is set to the argument of the ETRN command,
30926 and no syntax checking is done on the contents of this argument. Exim does not
30927 wait for the command to complete, so its status code is not checked. Exim runs
30928 under its own uid and gid when receiving incoming SMTP, so it is not possible
30929 for it to change them before running the command.
30930
30931
30932
30933 .section "Incoming local SMTP" "SECID238"
30934 .cindex "SMTP" "local incoming"
30935 Some user agents use SMTP to pass messages to their local MTA using the
30936 standard input and output, as opposed to passing the envelope on the command
30937 line and writing the message to the standard input. This is supported by the
30938 &%-bs%& option. This form of SMTP is handled in the same way as incoming
30939 messages over TCP/IP (including the use of ACLs), except that the envelope
30940 sender given in a MAIL command is ignored unless the caller is trusted. In
30941 an ACL you can detect this form of SMTP input by testing for an empty host
30942 identification. It is common to have this as the first line in the ACL that
30943 runs for RCPT commands:
30944 .code
30945 accept hosts = :
30946 .endd
30947 This accepts SMTP messages from local processes without doing any other tests.
30948
30949
30950
30951 .section "Outgoing batched SMTP" "SECTbatchSMTP"
30952 .cindex "SMTP" "batched outgoing"
30953 .cindex "batched SMTP output"
30954 Both the &(appendfile)& and &(pipe)& transports can be used for handling
30955 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
30956 be output in BSMTP format. No SMTP responses are possible for this form of
30957 delivery. All it is doing is using SMTP commands as a way of transmitting the
30958 envelope along with the message.
30959
30960 The message is written to the file or pipe preceded by the SMTP commands
30961 MAIL and RCPT, and followed by a line containing a single dot. Lines in
30962 the message that start with a dot have an extra dot added. The SMTP command
30963 HELO is not normally used. If it is required, the &%message_prefix%& option
30964 can be used to specify it.
30965
30966 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
30967 one recipient address at a time by default. However, you can arrange for them
30968 to handle several addresses at once by setting the &%batch_max%& option. When
30969 this is done for BSMTP, messages may contain multiple RCPT commands. See
30970 chapter &<<CHAPbatching>>& for more details.
30971
30972 .vindex "&$host$&"
30973 When one or more addresses are routed to a BSMTP transport by a router that
30974 sets up a host list, the name of the first host on the list is available to the
30975 transport in the variable &$host$&. Here is an example of such a transport and
30976 router:
30977 .code
30978 begin routers
30979 route_append:
30980   driver = manualroute
30981   transport = smtp_appendfile
30982   route_list = domain.example  batch.host.example
30983
30984 begin transports
30985 smtp_appendfile:
30986   driver = appendfile
30987   directory = /var/bsmtp/$host
30988   batch_max = 1000
30989   use_bsmtp
30990   user = exim
30991 .endd
30992 This causes messages addressed to &'domain.example'& to be written in BSMTP
30993 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
30994 message (unless there are more than 1000 recipients).
30995
30996
30997
30998 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
30999 .cindex "SMTP" "batched incoming"
31000 .cindex "batched SMTP input"
31001 The &%-bS%& command line option causes Exim to accept one or more messages by
31002 reading SMTP on the standard input, but to generate no responses. If the caller
31003 is trusted, the senders in the MAIL commands are believed; otherwise the
31004 sender is always the caller of Exim. Unqualified senders and receivers are not
31005 rejected (there seems little point) but instead just get qualified. HELO
31006 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
31007 as NOOP; QUIT quits.
31008
31009 No policy checking is done for BSMTP input. That is, no ACL is run at anytime.
31010 In this respect it is like non-SMTP local input.
31011
31012 If an error is detected while reading a message, including a missing &"."& at
31013 the end, Exim gives up immediately. It writes details of the error to the
31014 standard output in a stylized way that the calling program should be able to
31015 make some use of automatically, for example:
31016 .code
31017 554 Unexpected end of file
31018 Transaction started in line 10
31019 Error detected in line 14
31020 .endd
31021 It writes a more verbose version, for human consumption, to the standard error
31022 file, for example:
31023 .code
31024 An error was detected while processing a file of BSMTP input.
31025 The error message was:
31026
31027 501 '>' missing at end of address
31028
31029 The SMTP transaction started in line 10.
31030 The error was detected in line 12.
31031 The SMTP command at fault was:
31032
31033 rcpt to:<malformed@in.com.plete
31034
31035 1 previous message was successfully processed.
31036 The rest of the batch was abandoned.
31037 .endd
31038 The return code from Exim is zero only if there were no errors. It is 1 if some
31039 messages were accepted before an error was detected, and 2 if no messages were
31040 accepted.
31041 .ecindex IIDsmtpproc1
31042 .ecindex IIDsmtpproc2
31043
31044
31045
31046 . ////////////////////////////////////////////////////////////////////////////
31047 . ////////////////////////////////////////////////////////////////////////////
31048
31049 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
31050          "Customizing messages"
31051 When a message fails to be delivered, or remains on the queue for more than a
31052 configured amount of time, Exim sends a message to the original sender, or
31053 to an alternative configured address. The text of these messages is built into
31054 the code of Exim, but it is possible to change it, either by adding a single
31055 string, or by replacing each of the paragraphs by text supplied in a file.
31056
31057 The &'From:'& and &'To:'& header lines are automatically generated; you can
31058 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
31059 option. Exim also adds the line
31060 .code
31061 Auto-Submitted: auto-generated
31062 .endd
31063 to all warning and bounce messages,
31064
31065
31066 .section "Customizing bounce messages" "SECID239"
31067 .cindex "customizing" "bounce message"
31068 .cindex "bounce message" "customizing"
31069 If &%bounce_message_text%& is set, its contents are included in the default
31070 message immediately after &"This message was created automatically by mail
31071 delivery software."& The string is not expanded. It is not used if
31072 &%bounce_message_file%& is set.
31073
31074 When &%bounce_message_file%& is set, it must point to a template file for
31075 constructing error messages. The file consists of a series of text items,
31076 separated by lines consisting of exactly four asterisks. If the file cannot be
31077 opened, default text is used and a message is written to the main and panic
31078 logs. If any text item in the file is empty, default text is used for that
31079 item.
31080
31081 .vindex "&$bounce_recipient$&"
31082 .vindex "&$bounce_return_size_limit$&"
31083 Each item of text that is read from the file is expanded, and there are two
31084 expansion variables which can be of use here: &$bounce_recipient$& is set to
31085 the recipient of an error message while it is being created, and
31086 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
31087 option, rounded to a whole number.
31088
31089 The items must appear in the file in the following order:
31090
31091 .ilist
31092 The first item is included in the headers, and should include at least a
31093 &'Subject:'& header. Exim does not check the syntax of these headers.
31094 .next
31095 The second item forms the start of the error message. After it, Exim lists the
31096 failing addresses with their error messages.
31097 .next
31098 The third item is used to introduce any text from pipe transports that is to be
31099 returned to the sender. It is omitted if there is no such text.
31100 .next
31101 The fourth item is used to introduce the copy of the message that is returned
31102 as part of the error report.
31103 .next
31104 The fifth item is added after the fourth one if the returned message is
31105 truncated because it is bigger than &%return_size_limit%&.
31106 .next
31107 The sixth item is added after the copy of the original message.
31108 .endlist
31109
31110 The default state (&%bounce_message_file%& unset) is equivalent to the
31111 following file, in which the sixth item is empty. The &'Subject:'& and some
31112 other lines have been split in order to fit them on the page:
31113 .code
31114 Subject: Mail delivery failed
31115   ${if eq{$sender_address}{$bounce_recipient}
31116   {: returning message to sender}}
31117 ****
31118 This message was created automatically by mail delivery software.
31119
31120 A message ${if eq{$sender_address}{$bounce_recipient}
31121   {that you sent }{sent by
31122
31123 <$sender_address>
31124
31125 }}could not be delivered to all of its recipients.
31126 This is a permanent error. The following address(es) failed:
31127 ****
31128 The following text was generated during the delivery attempt(s):
31129 ****
31130 ------ This is a copy of the message, including all the headers.
31131   ------
31132 ****
31133 ------ The body of the message is $message_size characters long;
31134   only the first
31135 ------ $bounce_return_size_limit or so are included here.
31136 ****
31137 .endd
31138 .section "Customizing warning messages" "SECTcustwarn"
31139 .cindex "customizing" "warning message"
31140 .cindex "warning of delay" "customizing the message"
31141 The option &%warn_message_file%& can be pointed at a template file for use when
31142 warnings about message delays are created. In this case there are only three
31143 text sections:
31144
31145 .ilist
31146 The first item is included in the headers, and should include at least a
31147 &'Subject:'& header. Exim does not check the syntax of these headers.
31148 .next
31149 The second item forms the start of the warning message. After it, Exim lists
31150 the delayed addresses.
31151 .next
31152 The third item then ends the message.
31153 .endlist
31154
31155 The default state is equivalent to the following file, except that some lines
31156 have been split here, in order to fit them on the page:
31157 .code
31158 Subject: Warning: message $message_exim_id delayed
31159   $warn_message_delay
31160 ****
31161 This message was created automatically by mail delivery software.
31162
31163 A message ${if eq{$sender_address}{$warn_message_recipients}
31164 {that you sent }{sent by
31165
31166 <$sender_address>
31167
31168 }}has not been delivered to all of its recipients after
31169 more than $warn_message_delay on the queue on $primary_hostname.
31170
31171 The message identifier is:     $message_exim_id
31172 The subject of the message is: $h_subject
31173 The date of the message is:    $h_date
31174
31175 The following address(es) have not yet been delivered:
31176 ****
31177 No action is required on your part. Delivery attempts will
31178 continue for some time, and this warning may be repeated at
31179 intervals if the message remains undelivered. Eventually the
31180 mail delivery software will give up, and when that happens,
31181 the message will be returned to you.
31182 .endd
31183 .vindex "&$warn_message_delay$&"
31184 .vindex "&$warn_message_recipients$&"
31185 However, in the default state the subject and date lines are omitted if no
31186 appropriate headers exist. During the expansion of this file,
31187 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
31188 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
31189 of recipients for the warning message. There may be more than one if there are
31190 multiple addresses with different &%errors_to%& settings on the routers that
31191 handled them.
31192
31193
31194
31195
31196 . ////////////////////////////////////////////////////////////////////////////
31197 . ////////////////////////////////////////////////////////////////////////////
31198
31199 .chapter "Some common configuration settings" "CHAPcomconreq"
31200 This chapter discusses some configuration settings that seem to be fairly
31201 common. More examples and discussion can be found in the Exim book.
31202
31203
31204
31205 .section "Sending mail to a smart host" "SECID240"
31206 .cindex "smart host" "example router"
31207 If you want to send all mail for non-local domains to a &"smart host"&, you
31208 should replace the default &(dnslookup)& router with a router which does the
31209 routing explicitly:
31210 .code
31211 send_to_smart_host:
31212   driver = manualroute
31213   route_list = !+local_domains smart.host.name
31214   transport = remote_smtp
31215 .endd
31216 You can use the smart host's IP address instead of the name if you wish.
31217 If you are using Exim only to submit messages to a smart host, and not for
31218 receiving incoming messages, you can arrange for it to do the submission
31219 synchronously by setting the &%mua_wrapper%& option (see chapter
31220 &<<CHAPnonqueueing>>&).
31221
31222
31223
31224
31225 .section "Using Exim to handle mailing lists" "SECTmailinglists"
31226 .cindex "mailing lists"
31227 Exim can be used to run simple mailing lists, but for large and/or complicated
31228 requirements, the use of additional specialized mailing list software such as
31229 Majordomo or Mailman is recommended.
31230
31231 The &(redirect)& router can be used to handle mailing lists where each list
31232 is maintained in a separate file, which can therefore be managed by an
31233 independent manager. The &%domains%& router option can be used to run these
31234 lists in a separate domain from normal mail. For example:
31235 .code
31236 lists:
31237   driver = redirect
31238   domains = lists.example
31239   file = /usr/lists/$local_part
31240   forbid_pipe
31241   forbid_file
31242   errors_to = $local_part-request@lists.example
31243   no_more
31244 .endd
31245 This router is skipped for domains other than &'lists.example'&. For addresses
31246 in that domain, it looks for a file that matches the local part. If there is no
31247 such file, the router declines, but because &%no_more%& is set, no subsequent
31248 routers are tried, and so the whole delivery fails.
31249
31250 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
31251 expanded into a file name or a pipe delivery, which is usually inappropriate in
31252 a mailing list.
31253
31254 .oindex "&%errors_to%&"
31255 The &%errors_to%& option specifies that any delivery errors caused by addresses
31256 taken from a mailing list are to be sent to the given address rather than the
31257 original sender of the message. However, before acting on this, Exim verifies
31258 the error address, and ignores it if verification fails.
31259
31260 For example, using the configuration above, mail sent to
31261 &'dicts@lists.example'& is passed on to those addresses contained in
31262 &_/usr/lists/dicts_&, with error reports directed to
31263 &'dicts-request@lists.example'&, provided that this address can be verified.
31264 There could be a file called &_/usr/lists/dicts-request_& containing
31265 the address(es) of this particular list's manager(s), but other approaches,
31266 such as setting up an earlier router (possibly using the &%local_part_prefix%&
31267 or &%local_part_suffix%& options) to handle addresses of the form
31268 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
31269
31270
31271
31272 .section "Syntax errors in mailing lists" "SECID241"
31273 .cindex "mailing lists" "syntax errors in"
31274 If an entry in redirection data contains a syntax error, Exim normally defers
31275 delivery of the original address. That means that a syntax error in a mailing
31276 list holds up all deliveries to the list. This may not be appropriate when a
31277 list is being maintained automatically from data supplied by users, and the
31278 addresses are not rigorously checked.
31279
31280 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
31281 entries that fail to parse, noting the incident in the log. If in addition
31282 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
31283 whenever a broken address is skipped. It is usually appropriate to set
31284 &%syntax_errors_to%& to the same address as &%errors_to%&.
31285
31286
31287
31288 .section "Re-expansion of mailing lists" "SECID242"
31289 .cindex "mailing lists" "re-expansion of"
31290 Exim remembers every individual address to which a message has been delivered,
31291 in order to avoid duplication, but it normally stores only the original
31292 recipient addresses with a message. If all the deliveries to a mailing list
31293 cannot be done at the first attempt, the mailing list is re-expanded when the
31294 delivery is next tried. This means that alterations to the list are taken into
31295 account at each delivery attempt, so addresses that have been added to
31296 the list since the message arrived will therefore receive a copy of the
31297 message, even though it pre-dates their subscription.
31298
31299 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
31300 on the &(redirect)& router. If this is done, any addresses generated by the
31301 router that fail to deliver at the first attempt are added to the message as
31302 &"top level"& addresses, and the parent address that generated them is marked
31303 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
31304 subsequent delivery attempts. The disadvantage of this is that if any of the
31305 failing addresses are incorrect, correcting them in the file has no effect on
31306 pre-existing messages.
31307
31308 The original top-level address is remembered with each of the generated
31309 addresses, and is output in any log messages. However, any intermediate parent
31310 addresses are not recorded. This makes a difference to the log only if the
31311 &%all_parents%& selector is set, but for mailing lists there is normally only
31312 one level of expansion anyway.
31313
31314
31315
31316 .section "Closed mailing lists" "SECID243"
31317 .cindex "mailing lists" "closed"
31318 The examples so far have assumed open mailing lists, to which anybody may
31319 send mail. It is also possible to set up closed lists, where mail is accepted
31320 from specified senders only. This is done by making use of the generic
31321 &%senders%& option to restrict the router that handles the list.
31322
31323 The following example uses the same file as a list of recipients and as a list
31324 of permitted senders. It requires three routers:
31325 .code
31326 lists_request:
31327   driver = redirect
31328   domains = lists.example
31329   local_part_suffix = -request
31330   file = /usr/lists/$local_part$local_part_suffix
31331   no_more
31332
31333 lists_post:
31334   driver = redirect
31335   domains = lists.example
31336   senders = ${if exists {/usr/lists/$local_part}\
31337              {lsearch;/usr/lists/$local_part}{*}}
31338   file = /usr/lists/$local_part
31339   forbid_pipe
31340   forbid_file
31341   errors_to = $local_part-request@lists.example
31342   no_more
31343
31344 lists_closed:
31345   driver = redirect
31346   domains = lists.example
31347   allow_fail
31348   data = :fail: $local_part@lists.example is a closed mailing list
31349 .endd
31350 All three routers have the same &%domains%& setting, so for any other domains,
31351 they are all skipped. The first router runs only if the local part ends in
31352 &%-request%&. It handles messages to the list manager(s) by means of an open
31353 mailing list.
31354
31355 The second router runs only if the &%senders%& precondition is satisfied. It
31356 checks for the existence of a list that corresponds to the local part, and then
31357 checks that the sender is on the list by means of a linear search. It is
31358 necessary to check for the existence of the file before trying to search it,
31359 because otherwise Exim thinks there is a configuration error. If the file does
31360 not exist, the expansion of &%senders%& is *, which matches all senders. This
31361 means that the router runs, but because there is no list, declines, and
31362 &%no_more%& ensures that no further routers are run. The address fails with an
31363 &"unrouteable address"& error.
31364
31365 The third router runs only if the second router is skipped, which happens when
31366 a mailing list exists, but the sender is not on it. This router forcibly fails
31367 the address, giving a suitable error message.
31368
31369
31370
31371
31372 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
31373 .cindex "VERP"
31374 .cindex "Variable Envelope Return Paths"
31375 .cindex "envelope sender"
31376 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
31377 are a way of helping mailing list administrators discover which subscription
31378 address is the cause of a particular delivery failure. The idea is to encode
31379 the original recipient address in the outgoing envelope sender address, so that
31380 if the message is forwarded by another host and then subsequently bounces, the
31381 original recipient can be extracted from the recipient address of the bounce.
31382
31383 .oindex &%errors_to%&
31384 .oindex &%return_path%&
31385 Envelope sender addresses can be modified by Exim using two different
31386 facilities: the &%errors_to%& option on a router (as shown in previous mailing
31387 list examples), or the &%return_path%& option on a transport. The second of
31388 these is effective only if the message is successfully delivered to another
31389 host; it is not used for errors detected on the local host (see the description
31390 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
31391 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
31392 .code
31393 verp_smtp:
31394   driver = smtp
31395   max_rcpt = 1
31396   return_path = \
31397     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
31398       {$1-request+$local_part=$domain@your.dom.example}fail}
31399 .endd
31400 This has the effect of rewriting the return path (envelope sender) on outgoing
31401 SMTP messages, if the local part of the original return path ends in
31402 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
31403 local part and domain of the recipient into the return path. Suppose, for
31404 example, that a message whose return path has been set to
31405 &'somelist-request@your.dom.example'& is sent to
31406 &'subscriber@other.dom.example'&. In the transport, the return path is
31407 rewritten as
31408 .code
31409 somelist-request+subscriber=other.dom.example@your.dom.example
31410 .endd
31411 .vindex "&$local_part$&"
31412 For this to work, you must tell Exim to send multiple copies of messages that
31413 have more than one recipient, so that each copy has just one recipient. This is
31414 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
31415 might be sent to several different recipients in the same domain, in which case
31416 &$local_part$& is not available in the transport, because it is not unique.
31417
31418 Unless your host is doing nothing but mailing list deliveries, you should
31419 probably use a separate transport for the VERP deliveries, so as not to use
31420 extra resources in making one-per-recipient copies for other deliveries. This
31421 can easily be done by expanding the &%transport%& option in the router:
31422 .code
31423 dnslookup:
31424   driver = dnslookup
31425   domains = ! +local_domains
31426   transport = \
31427     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
31428       {verp_smtp}{remote_smtp}}
31429   no_more
31430 .endd
31431 If you want to change the return path using &%errors_to%& in a router instead
31432 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
31433 routers that handle mailing list addresses. This will ensure that all delivery
31434 errors, including those detected on the local host, are sent to the VERP
31435 address.
31436
31437 On a host that does no local deliveries and has no manual routing, only the
31438 &(dnslookup)& router needs to be changed. A special transport is not needed for
31439 SMTP deliveries. Every mailing list recipient has its own return path value,
31440 and so Exim must hand them to the transport one at a time. Here is an example
31441 of a &(dnslookup)& router that implements VERP:
31442 .code
31443 verp_dnslookup:
31444   driver = dnslookup
31445   domains = ! +local_domains
31446   transport = remote_smtp
31447   errors_to = \
31448     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
31449      {$1-request+$local_part=$domain@your.dom.example}fail}
31450   no_more
31451 .endd
31452 Before you start sending out messages with VERPed return paths, you must also
31453 configure Exim to accept the bounce messages that come back to those paths.
31454 Typically this is done by setting a &%local_part_suffix%& option for a
31455 router, and using this to route the messages to wherever you want to handle
31456 them.
31457
31458 The overhead incurred in using VERP depends very much on the size of the
31459 message, the number of recipient addresses that resolve to the same remote
31460 host, and the speed of the connection over which the message is being sent. If
31461 a lot of addresses resolve to the same host and the connection is slow, sending
31462 a separate copy of the message for each address may take substantially longer
31463 than sending a single copy with many recipients (for which VERP cannot be
31464 used).
31465
31466
31467
31468
31469
31470
31471 .section "Virtual domains" "SECTvirtualdomains"
31472 .cindex "virtual domains"
31473 .cindex "domain" "virtual"
31474 The phrase &'virtual domain'& is unfortunately used with two rather different
31475 meanings:
31476
31477 .ilist
31478 A domain for which there are no real mailboxes; all valid local parts are
31479 aliases for other email addresses. Common examples are organizational
31480 top-level domains and &"vanity"& domains.
31481 .next
31482 One of a number of independent domains that are all handled by the same host,
31483 with mailboxes on that host, but where the mailbox owners do not necessarily
31484 have login accounts on that host.
31485 .endlist
31486
31487 The first usage is probably more common, and does seem more &"virtual"& than
31488 the second. This kind of domain can be handled in Exim with a straightforward
31489 aliasing router. One approach is to create a separate alias file for each
31490 virtual domain. Exim can test for the existence of the alias file to determine
31491 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
31492 to a router of this form:
31493 .code
31494 virtual:
31495   driver = redirect
31496   domains = dsearch;/etc/mail/virtual
31497   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
31498   no_more
31499 .endd
31500 The &%domains%& option specifies that the router is to be skipped, unless there
31501 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
31502 domain that is being processed. When the router runs, it looks up the local
31503 part in the file to find a new address (or list of addresses). The &%no_more%&
31504 setting ensures that if the lookup fails (leading to &%data%& being an empty
31505 string), Exim gives up on the address without trying any subsequent routers.
31506
31507 This one router can handle all the virtual domains because the alias file names
31508 follow a fixed pattern. Permissions can be arranged so that appropriate people
31509 can edit the different alias files. A successful aliasing operation results in
31510 a new envelope recipient address, which is then routed from scratch.
31511
31512 The other kind of &"virtual"& domain can also be handled in a straightforward
31513 way. One approach is to create a file for each domain containing a list of
31514 valid local parts, and use it in a router like this:
31515 .code
31516 my_domains:
31517   driver = accept
31518   domains = dsearch;/etc/mail/domains
31519   local_parts = lsearch;/etc/mail/domains/$domain
31520   transport = my_mailboxes
31521 .endd
31522 The address is accepted if there is a file for the domain, and the local part
31523 can be found in the file. The &%domains%& option is used to check for the
31524 file's existence because &%domains%& is tested before the &%local_parts%&
31525 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
31526 because that option is tested after &%local_parts%&. The transport is as
31527 follows:
31528 .code
31529 my_mailboxes:
31530   driver = appendfile
31531   file = /var/mail/$domain/$local_part
31532   user = mail
31533 .endd
31534 This uses a directory of mailboxes for each domain. The &%user%& setting is
31535 required, to specify which uid is to be used for writing to the mailboxes.
31536
31537 The configuration shown here is just one example of how you might support this
31538 requirement. There are many other ways this kind of configuration can be set
31539 up, for example, by using a database instead of separate files to hold all the
31540 information about the domains.
31541
31542
31543
31544 .section "Multiple user mailboxes" "SECTmulbox"
31545 .cindex "multiple mailboxes"
31546 .cindex "mailbox" "multiple"
31547 .cindex "local part" "prefix"
31548 .cindex "local part" "suffix"
31549 Heavy email users often want to operate with multiple mailboxes, into which
31550 incoming mail is automatically sorted. A popular way of handling this is to
31551 allow users to use multiple sender addresses, so that replies can easily be
31552 identified. Users are permitted to add prefixes or suffixes to their local
31553 parts for this purpose. The wildcard facility of the generic router options
31554 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
31555 example, consider this router:
31556 .code
31557 userforward:
31558   driver = redirect
31559   check_local_user
31560   file = $home/.forward
31561   local_part_suffix = -*
31562   local_part_suffix_optional
31563   allow_filter
31564 .endd
31565 .vindex "&$local_part_suffix$&"
31566 It runs a user's &_.forward_& file for all local parts of the form
31567 &'username-*'&. Within the filter file the user can distinguish different
31568 cases by testing the variable &$local_part_suffix$&. For example:
31569 .code
31570 if $local_part_suffix contains -special then
31571 save /home/$local_part/Mail/special
31572 endif
31573 .endd
31574 If the filter file does not exist, or does not deal with such addresses, they
31575 fall through to subsequent routers, and, assuming no subsequent use of the
31576 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
31577 control over which suffixes are valid.
31578
31579 Alternatively, a suffix can be used to trigger the use of a different
31580 &_.forward_& file &-- which is the way a similar facility is implemented in
31581 another MTA:
31582 .code
31583 userforward:
31584   driver = redirect
31585   check_local_user
31586   file = $home/.forward$local_part_suffix
31587   local_part_suffix = -*
31588   local_part_suffix_optional
31589   allow_filter
31590 .endd
31591 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
31592 example, &_.forward-special_& is used. Once again, if the appropriate file
31593 does not exist, or does not deal with the address, it is passed on to
31594 subsequent routers, which could, if required, look for an unqualified
31595 &_.forward_& file to use as a default.
31596
31597
31598
31599 .section "Simplified vacation processing" "SECID244"
31600 .cindex "vacation processing"
31601 The traditional way of running the &'vacation'& program is for a user to set up
31602 a pipe command in a &_.forward_& file
31603 (see section &<<SECTspecitredli>>& for syntax details).
31604 This is prone to error by inexperienced users. There are two features of Exim
31605 that can be used to make this process simpler for users:
31606
31607 .ilist
31608 A local part prefix such as &"vacation-"& can be specified on a router which
31609 can cause the message to be delivered directly to the &'vacation'& program, or
31610 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
31611 &_.forward_& file are then much simpler. For example:
31612 .code
31613 spqr, vacation-spqr
31614 .endd
31615 .next
31616 The &%require_files%& generic router option can be used to trigger a
31617 vacation delivery by checking for the existence of a certain file in the
31618 user's home directory. The &%unseen%& generic option should also be used, to
31619 ensure that the original delivery also proceeds. In this case, all the user has
31620 to do is to create a file called, say, &_.vacation_&, containing a vacation
31621 message.
31622 .endlist
31623
31624 Another advantage of both these methods is that they both work even when the
31625 use of arbitrary pipes by users is locked out.
31626
31627
31628
31629 .section "Taking copies of mail" "SECID245"
31630 .cindex "message" "copying every"
31631 Some installations have policies that require archive copies of all messages to
31632 be made. A single copy of each message can easily be taken by an appropriate
31633 command in a system filter, which could, for example, use a different file for
31634 each day's messages.
31635
31636 There is also a shadow transport mechanism that can be used to take copies of
31637 messages that are successfully delivered by local transports, one copy per
31638 delivery. This could be used, &'inter alia'&, to implement automatic
31639 notification of delivery by sites that insist on doing such things.
31640
31641
31642
31643 .section "Intermittently connected hosts" "SECID246"
31644 .cindex "intermittently connected hosts"
31645 It has become quite common (because it is cheaper) for hosts to connect to the
31646 Internet periodically rather than remain connected all the time. The normal
31647 arrangement is that mail for such hosts accumulates on a system that is
31648 permanently connected.
31649
31650 Exim was designed for use on permanently connected hosts, and so it is not
31651 particularly well-suited to use in an intermittently connected environment.
31652 Nevertheless there are some features that can be used.
31653
31654
31655 .section "Exim on the upstream server host" "SECID247"
31656 It is tempting to arrange for incoming mail for the intermittently connected
31657 host to remain on Exim's queue until the client connects. However, this
31658 approach does not scale very well. Two different kinds of waiting message are
31659 being mixed up in the same queue &-- those that cannot be delivered because of
31660 some temporary problem, and those that are waiting for their destination host
31661 to connect. This makes it hard to manage the queue, as well as wasting
31662 resources, because each queue runner scans the entire queue.
31663
31664 A better approach is to separate off those messages that are waiting for an
31665 intermittently connected host. This can be done by delivering these messages
31666 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
31667 format, from where they are transmitted by other software when their
31668 destination connects. This makes it easy to collect all the mail for one host
31669 in a single directory, and to apply local timeout rules on a per-message basis
31670 if required.
31671
31672 On a very small scale, leaving the mail on Exim's queue can be made to work. If
31673 you are doing this, you should configure Exim with a long retry period for the
31674 intermittent host. For example:
31675 .code
31676 cheshire.wonderland.fict.example    *   F,5d,24h
31677 .endd
31678 This stops a lot of failed delivery attempts from occurring, but Exim remembers
31679 which messages it has queued up for that host. Once the intermittent host comes
31680 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
31681 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
31682 causes all the queued up messages to be delivered, often down a single SMTP
31683 connection. While the host remains connected, any new messages get delivered
31684 immediately.
31685
31686 If the connecting hosts do not have fixed IP addresses, that is, if a host is
31687 issued with a different IP address each time it connects, Exim's retry
31688 mechanisms on the holding host get confused, because the IP address is normally
31689 used as part of the key string for holding retry information. This can be
31690 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
31691 Since this has disadvantages for permanently connected hosts, it is best to
31692 arrange a separate transport for the intermittently connected ones.
31693
31694
31695
31696 .section "Exim on the intermittently connected client host" "SECID248"
31697 The value of &%smtp_accept_queue_per_connection%& should probably be
31698 increased, or even set to zero (that is, disabled) on the intermittently
31699 connected host, so that all incoming messages down a single connection get
31700 delivered immediately.
31701
31702 .cindex "SMTP" "passed connection"
31703 .cindex "SMTP" "multiple deliveries"
31704 .cindex "multiple SMTP deliveries"
31705 Mail waiting to be sent from an intermittently connected host will probably
31706 not have been routed, because without a connection DNS lookups are not
31707 possible. This means that if a normal queue run is done at connection time,
31708 each message is likely to be sent in a separate SMTP session. This can be
31709 avoided by starting the queue run with a command line option beginning with
31710 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
31711 first pass, routing is done but no deliveries take place. The second pass is a
31712 normal queue run; since all the messages have been previously routed, those
31713 destined for the same host are likely to get sent as multiple deliveries in a
31714 single SMTP connection.
31715
31716
31717
31718 . ////////////////////////////////////////////////////////////////////////////
31719 . ////////////////////////////////////////////////////////////////////////////
31720
31721 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
31722          "Exim as a non-queueing client"
31723 .cindex "client, non-queueing"
31724 .cindex "smart host" "suppressing queueing"
31725 On a personal computer, it is a common requirement for all
31726 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
31727 configured to operate that way, for all the popular operating systems.
31728 However, there are some MUAs for Unix-like systems that cannot be so
31729 configured: they submit messages using the command line interface of
31730 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
31731 messages this way.
31732
31733 If the personal computer runs continuously, there is no problem, because it can
31734 run a conventional MTA that handles delivery to the smart host, and deal with
31735 any delays via its queueing mechanism. However, if the computer does not run
31736 continuously or runs different operating systems at different times, queueing
31737 email is not desirable.
31738
31739 There is therefore a requirement for something that can provide the
31740 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
31741 any queueing or retrying facilities. Furthermore, the delivery to the smart
31742 host should be synchronous, so that if it fails, the sending MUA is immediately
31743 informed. In other words, we want something that extends an MUA that submits
31744 to a local MTA via the command line so that it behaves like one that submits
31745 to a remote smart host using TCP/SMTP.
31746
31747 There are a number of applications (for example, there is one called &'ssmtp'&)
31748 that do this job. However, people have found them to be lacking in various
31749 ways. For instance, you might want to allow aliasing and forwarding to be done
31750 before sending a message to the smart host.
31751
31752 Exim already had the necessary infrastructure for doing this job. Just a few
31753 tweaks were needed to make it behave as required, though it is somewhat of an
31754 overkill to use a fully-featured MTA for this purpose.
31755
31756 .oindex "&%mua_wrapper%&"
31757 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
31758 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
31759 assumes that it is being used to &"wrap"& a command-line MUA in the manner
31760 just described. As well as setting &%mua_wrapper%&, you also need to provide a
31761 compatible router and transport configuration. Typically there will be just one
31762 router and one transport, sending everything to a smart host.
31763
31764 When run in MUA wrapping mode, the behaviour of Exim changes in the
31765 following ways:
31766
31767 .ilist
31768 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
31769 In other words, the only way to submit messages is via the command line.
31770 .next
31771 Each message is synchronously delivered as soon as it is received (&%-odi%& is
31772 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
31773 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
31774 does not finish until the delivery attempt is complete. If the delivery is
31775 successful, a zero return code is given.
31776 .next
31777 Address redirection is permitted, but the final routing for all addresses must
31778 be to the same remote transport, and to the same list of hosts. Furthermore,
31779 the return address (envelope sender) must be the same for all recipients, as
31780 must any added or deleted header lines. In other words, it must be possible to
31781 deliver the message in a single SMTP transaction, however many recipients there
31782 are.
31783 .next
31784 If these conditions are not met, or if routing any address results in a
31785 failure or defer status, or if Exim is unable to deliver all the recipients
31786 successfully to one of the smart hosts, delivery of the entire message fails.
31787 .next
31788 Because no queueing is allowed, all failures are treated as permanent; there
31789 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
31790 smart host. Furthermore, because only a single yes/no response can be given to
31791 the caller, it is not possible to deliver to some recipients and not others. If
31792 there is an error (temporary or permanent) for any recipient, all are failed.
31793 .next
31794 If more than one smart host is listed, Exim will try another host after a
31795 connection failure or a timeout, in the normal way. However, if this kind of
31796 failure happens for all the hosts, the delivery fails.
31797 .next
31798 When delivery fails, an error message is written to the standard error stream
31799 (as well as to Exim's log), and Exim exits to the caller with a return code
31800 value 1. The message is expunged from Exim's spool files. No bounce messages
31801 are ever generated.
31802 .next
31803 No retry data is maintained, and any retry rules are ignored.
31804 .next
31805 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
31806 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
31807 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
31808 .endlist
31809
31810 The overall effect is that Exim makes a single synchronous attempt to deliver
31811 the message, failing if there is any kind of problem. Because no local
31812 deliveries are done and no daemon can be run, Exim does not need root
31813 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
31814 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
31815 the advantages and disadvantages of running without root privilege.
31816
31817
31818
31819
31820 . ////////////////////////////////////////////////////////////////////////////
31821 . ////////////////////////////////////////////////////////////////////////////
31822
31823 .chapter "Log files" "CHAPlog"
31824 .scindex IIDloggen "log" "general description"
31825 .cindex "log" "types of"
31826 Exim writes three different logs, referred to as the main log, the reject log,
31827 and the panic log:
31828
31829 .ilist
31830 .cindex "main log"
31831 The main log records the arrival of each message and each delivery in a single
31832 line in each case. The format is as compact as possible, in an attempt to keep
31833 down the size of log files. Two-character flag sequences make it easy to pick
31834 out these lines. A number of other events are recorded in the main log. Some of
31835 them are optional, in which case the &%log_selector%& option controls whether
31836 they are included or not. A Perl script called &'eximstats'&, which does simple
31837 analysis of main log files, is provided in the Exim distribution (see section
31838 &<<SECTmailstat>>&).
31839 .next
31840 .cindex "reject log"
31841 The reject log records information from messages that are rejected as a result
31842 of a configuration option (that is, for policy reasons).
31843 The first line of each rejection is a copy of the line that is also written to
31844 the main log. Then, if the message's header has been read at the time the log
31845 is written, its contents are written to this log. Only the original header
31846 lines are available; header lines added by ACLs are not logged. You can use the
31847 reject log to check that your policy controls are working correctly; on a busy
31848 host this may be easier than scanning the main log for rejection messages. You
31849 can suppress the writing of the reject log by setting &%write_rejectlog%&
31850 false.
31851 .next
31852 .cindex "panic log"
31853 .cindex "system log"
31854 When certain serious errors occur, Exim writes entries to its panic log. If the
31855 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
31856 are usually written to the main log as well, but can get lost amid the mass of
31857 other entries. The panic log should be empty under normal circumstances. It is
31858 therefore a good idea to check it (or to have a &'cron'& script check it)
31859 regularly, in order to become aware of any problems. When Exim cannot open its
31860 panic log, it tries as a last resort to write to the system log (syslog). This
31861 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
31862 message itself is written at priority LOG_CRIT.
31863 .endlist
31864
31865 Every log line starts with a timestamp, in the format shown in the following
31866 example. Note that many of the examples shown in this chapter are line-wrapped.
31867 In the log file, this would be all on one line:
31868 .code
31869 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
31870   by QUIT
31871 .endd
31872 By default, the timestamps are in the local timezone. There are two
31873 ways of changing this:
31874
31875 .ilist
31876 You can set the &%timezone%& option to a different time zone; in particular, if
31877 you set
31878 .code
31879 timezone = UTC
31880 .endd
31881 the timestamps will be in UTC (aka GMT).
31882 .next
31883 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
31884 example:
31885 .code
31886 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
31887 .endd
31888 .endlist
31889
31890 .cindex "log" "process ids in"
31891 .cindex "pid (process id)" "in log lines"
31892 Exim does not include its process id in log lines by default, but you can
31893 request that it does so by specifying the &`pid`& log selector (see section
31894 &<<SECTlogselector>>&). When this is set, the process id is output, in square
31895 brackets, immediately after the time and date.
31896
31897
31898
31899
31900 .section "Where the logs are written" "SECTwhelogwri"
31901 .cindex "log" "destination"
31902 .cindex "log" "to file"
31903 .cindex "log" "to syslog"
31904 .cindex "syslog"
31905 The logs may be written to local files, or to syslog, or both. However, it
31906 should be noted that many syslog implementations use UDP as a transport, and
31907 are therefore unreliable in the sense that messages are not guaranteed to
31908 arrive at the loghost, nor is the ordering of messages necessarily maintained.
31909 It has also been reported that on large log files (tens of megabytes) you may
31910 need to tweak syslog to prevent it syncing the file with each write &-- on
31911 Linux this has been seen to make syslog take 90% plus of CPU time.
31912
31913 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
31914 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
31915 configuration. This latter string is expanded, so it can contain, for example,
31916 references to the host name:
31917 .code
31918 log_file_path = /var/log/$primary_hostname/exim_%slog
31919 .endd
31920 It is generally advisable, however, to set the string in &_Local/Makefile_&
31921 rather than at run time, because then the setting is available right from the
31922 start of Exim's execution. Otherwise, if there's something it wants to log
31923 before it has read the configuration file (for example, an error in the
31924 configuration file) it will not use the path you want, and may not be able to
31925 log at all.
31926
31927 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
31928 list, currently limited to at most two items. This is one option where the
31929 facility for changing a list separator may not be used. The list must always be
31930 colon-separated. If an item in the list is &"syslog"& then syslog is used;
31931 otherwise the item must either be an absolute path, containing &`%s`& at the
31932 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
31933 implying the use of a default path.
31934
31935 When Exim encounters an empty item in the list, it searches the list defined by
31936 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
31937 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
31938 mean &"use the path specified at build time"&. It no such item exists, log
31939 files are written in the &_log_& subdirectory of the spool directory. This is
31940 equivalent to the setting:
31941 .code
31942 log_file_path = $spool_directory/log/%slog
31943 .endd
31944 If you do not specify anything at build time or run time, that is where the
31945 logs are written.
31946
31947 A log file path may also contain &`%D`& if datestamped log file names are in
31948 use &-- see section &<<SECTdatlogfil>>& below.
31949
31950 Here are some examples of possible settings:
31951 .display
31952 &`LOG_FILE_PATH=syslog                    `& syslog only
31953 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
31954 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
31955 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
31956 .endd
31957 If there are more than two paths in the list, the first is used and a panic
31958 error is logged.
31959
31960
31961
31962 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
31963 .cindex "log" "cycling local files"
31964 .cindex "cycling logs"
31965 .cindex "&'exicyclog'&"
31966 .cindex "log" "local files; writing to"
31967 Some operating systems provide centralized and standardized methods for cycling
31968 log files. For those that do not, a utility script called &'exicyclog'& is
31969 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
31970 main and reject logs each time it is called. The maximum number of old logs to
31971 keep can be set. It is suggested this script is run as a daily &'cron'& job.
31972
31973 An Exim delivery process opens the main log when it first needs to write to it,
31974 and it keeps the file open in case subsequent entries are required &-- for
31975 example, if a number of different deliveries are being done for the same
31976 message. However, remote SMTP deliveries can take a long time, and this means
31977 that the file may be kept open long after it is renamed if &'exicyclog'& or
31978 something similar is being used to rename log files on a regular basis. To
31979 ensure that a switch of log files is noticed as soon as possible, Exim calls
31980 &[stat()]& on the main log's name before reusing an open file, and if the file
31981 does not exist, or its inode has changed, the old file is closed and Exim
31982 tries to open the main log from scratch. Thus, an old log file may remain open
31983 for quite some time, but no Exim processes should write to it once it has been
31984 renamed.
31985
31986
31987
31988 .section "Datestamped log files" "SECTdatlogfil"
31989 .cindex "log" "datestamped files"
31990 Instead of cycling the main and reject log files by renaming them
31991 periodically, some sites like to use files whose names contain a datestamp,
31992 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_&.
31993 Exim has support for this way of working. It is enabled by setting the
31994 &%log_file_path%& option to a path that includes &`%D`& at the point where the
31995 datestamp is required. For example:
31996 .code
31997 log_file_path = /var/spool/exim/log/%slog-%D
31998 log_file_path = /var/log/exim-%s-%D.log
31999 log_file_path = /var/spool/exim/log/%D-%slog
32000 .endd
32001 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
32002 examples of names generated by the above examples:
32003 .code
32004 /var/spool/exim/log/mainlog-20021225
32005 /var/log/exim-reject-20021225.log
32006 /var/spool/exim/log/20021225-mainlog
32007 .endd
32008 When this form of log file is specified, Exim automatically switches to new
32009 files at midnight. It does not make any attempt to compress old logs; you
32010 will need to write your own script if you require this. You should not
32011 run &'exicyclog'& with this form of logging.
32012
32013 The location of the panic log is also determined by &%log_file_path%&, but it
32014 is not datestamped, because rotation of the panic log does not make sense.
32015 When generating the name of the panic log, &`%D`& is removed from the string.
32016 In addition, if it immediately follows a slash, a following non-alphanumeric
32017 character is removed; otherwise a preceding non-alphanumeric character is
32018 removed. Thus, the three examples above would give these panic log names:
32019 .code
32020 /var/spool/exim/log/paniclog
32021 /var/log/exim-panic.log
32022 /var/spool/exim/log/paniclog
32023 .endd
32024
32025
32026 .section "Logging to syslog" "SECID249"
32027 .cindex "log" "syslog; writing to"
32028 The use of syslog does not change what Exim logs or the format of its messages,
32029 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
32030 Exim's log lines are omitted when these lines are sent to syslog. Apart from
32031 that, the same strings are written to syslog as to log files. The syslog
32032 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
32033 by default, but you can change these by setting the &%syslog_facility%& and
32034 &%syslog_processname%& options, respectively. If Exim was compiled with
32035 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
32036 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
32037 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
32038 the time and host name to each line.
32039 The three log streams are mapped onto syslog priorities as follows:
32040
32041 .ilist
32042 &'mainlog'& is mapped to LOG_INFO
32043 .next
32044 &'rejectlog'& is mapped to LOG_NOTICE
32045 .next
32046 &'paniclog'& is mapped to LOG_ALERT
32047 .endlist
32048
32049 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
32050 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
32051 these are routed by syslog to the same place. You can suppress this duplication
32052 by setting &%syslog_duplication%& false.
32053
32054 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
32055 entries contain multiple lines when headers are included. To cope with both
32056 these cases, entries written to syslog are split into separate &[syslog()]&
32057 calls at each internal newline, and also after a maximum of
32058 870 data characters. (This allows for a total syslog line length of 1024, when
32059 additions such as timestamps are added.) If you are running a syslog
32060 replacement that can handle lines longer than the 1024 characters allowed by
32061 RFC 3164, you should set
32062 .code
32063 SYSLOG_LONG_LINES=yes
32064 .endd
32065 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
32066 lines, but it still splits at internal newlines in &'reject'& log entries.
32067
32068 To make it easy to re-assemble split lines later, each component of a split
32069 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
32070 where <&'n'&> is the component number and <&'m'&> is the total number of
32071 components in the entry. The / delimiter is used when the line was split
32072 because it was too long; if it was split because of an internal newline, the \
32073 delimiter is used. For example, supposing the length limit to be 50 instead of
32074 870, the following would be the result of a typical rejection message to
32075 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
32076 name, and pid as added by syslog:
32077 .code
32078 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
32079 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
32080 [3/5]  when scanning for sender: missing or malformed lo
32081 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
32082 [5/5] mple>)
32083 .endd
32084 The same error might cause the following lines to be written to &"rejectlog"&
32085 (LOG_NOTICE):
32086 .code
32087 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
32088 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
32089 [3/18] er when scanning for sender: missing or malformed
32090 [4/18]  local part in "<>" (envelope sender is <ph10@cam
32091 [5\18] .example>)
32092 [6\18] Recipients: ph10@some.domain.cam.example
32093 [7\18] P Received: from [127.0.0.1] (ident=ph10)
32094 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
32095 [9\18]        id 16RdAL-0006pc-00
32096 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
32097 [11\18] 09:43 +0100
32098 [12\18] F From: <>
32099 [13\18]   Subject: this is a test header
32100 [18\18]   X-something: this is another header
32101 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
32102 [16\18] le>
32103 [17\18] B Bcc:
32104 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
32105 .endd
32106 Log lines that are neither too long nor contain newlines are written to syslog
32107 without modification.
32108
32109 If only syslog is being used, the Exim monitor is unable to provide a log tail
32110 display, unless syslog is routing &'mainlog'& to a file on the local host and
32111 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
32112 where it is.
32113
32114
32115
32116 .section "Log line flags" "SECID250"
32117 One line is written to the main log for each message received, and for each
32118 successful, unsuccessful, and delayed delivery. These lines can readily be
32119 picked out by the distinctive two-character flags that immediately follow the
32120 timestamp. The flags are:
32121 .display
32122 &`<=`&     message arrival
32123 &`=>`&     normal message delivery
32124 &`->`&     additional address in same delivery
32125 &`*>`&     delivery suppressed by &%-N%&
32126 &`**`&     delivery failed; address bounced
32127 &`==`&     delivery deferred; temporary problem
32128 .endd
32129
32130
32131 .section "Logging message reception" "SECID251"
32132 .cindex "log" "reception line"
32133 The format of the single-line entry in the main log that is written for every
32134 message received is shown in the basic example below, which is split over
32135 several lines in order to fit it on the page:
32136 .code
32137 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
32138   H=mailer.fict.example [192.168.123.123] U=exim
32139   P=smtp S=5678 id=<incoming message id>
32140 .endd
32141 The address immediately following &"<="& is the envelope sender address. A
32142 bounce message is shown with the sender address &"<>"&, and if it is locally
32143 generated, this is followed by an item of the form
32144 .code
32145 R=<message id>
32146 .endd
32147 which is a reference to the message that caused the bounce to be sent.
32148
32149 .cindex "HELO"
32150 .cindex "EHLO"
32151 For messages from other hosts, the H and U fields identify the remote host and
32152 record the RFC 1413 identity of the user that sent the message, if one was
32153 received. The number given in square brackets is the IP address of the sending
32154 host. If there is a single, unparenthesized  host name in the H field, as
32155 above, it has been verified to correspond to the IP address (see the
32156 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
32157 by the remote host in the SMTP HELO or EHLO command, and has not been
32158 verified. If verification yields a different name to that given for HELO or
32159 EHLO, the verified name appears first, followed by the HELO or EHLO
32160 name in parentheses.
32161
32162 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
32163 without brackets, in the HELO or EHLO command, leading to entries in
32164 the log containing text like these examples:
32165 .code
32166 H=(10.21.32.43) [192.168.8.34]
32167 H=([10.21.32.43]) [192.168.8.34]
32168 .endd
32169 This can be confusing. Only the final address in square brackets can be relied
32170 on.
32171
32172 For locally generated messages (that is, messages not received over TCP/IP),
32173 the H field is omitted, and the U field contains the login name of the caller
32174 of Exim.
32175
32176 .cindex "authentication" "logging"
32177 .cindex "AUTH" "logging"
32178 For all messages, the P field specifies the protocol used to receive the
32179 message. This is the value that is stored in &$received_protocol$&. In the case
32180 of incoming SMTP messages, the value indicates whether or not any SMTP
32181 extensions (ESMTP), encryption, or authentication were used. If the SMTP
32182 session was encrypted, there is an additional X field that records the cipher
32183 suite that was used.
32184
32185 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
32186 hosts that have authenticated themselves using the SMTP AUTH command. The first
32187 value is used when the SMTP connection was encrypted (&"secure"&). In this case
32188 there is an additional item A= followed by the name of the authenticator that
32189 was used. If an authenticated identification was set up by the authenticator's
32190 &%server_set_id%& option, this is logged too, separated by a colon from the
32191 authenticator name.
32192
32193 .cindex "size" "of message"
32194 The id field records the existing message id, if present. The size of the
32195 received message is given by the S field. When the message is delivered,
32196 headers may be removed or added, so that the size of delivered copies of the
32197 message may not correspond with this value (and indeed may be different to each
32198 other).
32199
32200 The &%log_selector%& option can be used to request the logging of additional
32201 data when a message is received. See section &<<SECTlogselector>>& below.
32202
32203
32204
32205 .section "Logging deliveries" "SECID252"
32206 .cindex "log" "delivery line"
32207 The format of the single-line entry in the main log that is written for every
32208 delivery is shown in one of the examples below, for local and remote
32209 deliveries, respectively. Each example has been split into two lines in order
32210 to fit it on the page:
32211 .code
32212 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
32213   <marv@hitch.fict.example> R=localuser T=local_delivery
32214 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
32215   monk@holistic.fict.example R=dnslookup T=remote_smtp
32216   H=holistic.fict.example [192.168.234.234]
32217 .endd
32218 For ordinary local deliveries, the original address is given in angle brackets
32219 after the final delivery address, which might be a pipe or a file. If
32220 intermediate address(es) exist between the original and the final address, the
32221 last of these is given in parentheses after the final address. The R and T
32222 fields record the router and transport that were used to process the address.
32223
32224 If a shadow transport was run after a successful local delivery, the log line
32225 for the successful delivery has an item added on the end, of the form
32226 .display
32227 &`ST=<`&&'shadow transport name'&&`>`&
32228 .endd
32229 If the shadow transport did not succeed, the error message is put in
32230 parentheses afterwards.
32231
32232 .cindex "asterisk" "after IP address"
32233 When more than one address is included in a single delivery (for example, two
32234 SMTP RCPT commands in one transaction) the second and subsequent addresses are
32235 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
32236 down a single SMTP connection, an asterisk follows the IP address in the log
32237 lines for the second and subsequent messages.
32238
32239 The generation of a reply message by a filter file gets logged as a
32240 &"delivery"& to the addressee, preceded by &">"&.
32241
32242 The &%log_selector%& option can be used to request the logging of additional
32243 data when a message is delivered. See section &<<SECTlogselector>>& below.
32244
32245
32246 .section "Discarded deliveries" "SECID253"
32247 .cindex "discarded messages"
32248 .cindex "message" "discarded"
32249 .cindex "delivery" "discarded; logging"
32250 When a message is discarded as a result of the command &"seen finish"& being
32251 obeyed in a filter file which generates no deliveries, a log entry of the form
32252 .code
32253 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
32254   <low.club@bridge.example> R=userforward
32255 .endd
32256 is written, to record why no deliveries are logged. When a message is discarded
32257 because it is aliased to &":blackhole:"& the log line is like this:
32258 .code
32259 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
32260   <hole@nowhere.example> R=blackhole_router
32261 .endd
32262
32263
32264 .section "Deferred deliveries" "SECID254"
32265 When a delivery is deferred, a line of the following form is logged:
32266 .code
32267 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
32268   R=dnslookup T=smtp defer (146): Connection refused
32269 .endd
32270 In the case of remote deliveries, the error is the one that was given for the
32271 last IP address that was tried. Details of individual SMTP failures are also
32272 written to the log, so the above line would be preceded by something like
32273 .code
32274 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
32275   mail1.endrest.example [192.168.239.239]: Connection refused
32276 .endd
32277 When a deferred address is skipped because its retry time has not been reached,
32278 a message is written to the log, but this can be suppressed by setting an
32279 appropriate value in &%log_selector%&.
32280
32281
32282
32283 .section "Delivery failures" "SECID255"
32284 .cindex "delivery" "failure; logging"
32285 If a delivery fails because an address cannot be routed, a line of the
32286 following form is logged:
32287 .code
32288 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
32289   <jim@trek99.example>: unknown mail domain
32290 .endd
32291 If a delivery fails at transport time, the router and transport are shown, and
32292 the response from the remote host is included, as in this example:
32293 .code
32294 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
32295   R=dnslookup T=remote_smtp: SMTP error from remote mailer
32296   after pipelined RCPT TO:<ace400@pb.example>: host
32297   pbmail3.py.example [192.168.63.111]: 553 5.3.0
32298   <ace400@pb.example>...Addressee unknown
32299 .endd
32300 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
32301 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
32302 disabling PIPELINING. The log lines for all forms of delivery failure are
32303 flagged with &`**`&.
32304
32305
32306
32307 .section "Fake deliveries" "SECID256"
32308 .cindex "delivery" "fake; logging"
32309 If a delivery does not actually take place because the &%-N%& option has been
32310 used to suppress it, a normal delivery line is written to the log, except that
32311 &"=>"& is replaced by &"*>"&.
32312
32313
32314
32315 .section "Completion" "SECID257"
32316 A line of the form
32317 .code
32318 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
32319 .endd
32320 is written to the main log when a message is about to be removed from the spool
32321 at the end of its processing.
32322
32323
32324
32325
32326 .section "Summary of Fields in Log Lines" "SECID258"
32327 .cindex "log" "summary of fields"
32328 A summary of the field identifiers that are used in log lines is shown in
32329 the following table:
32330 .display
32331 &`A   `&        authenticator name (and optional id)
32332 &`C   `&        SMTP confirmation on delivery
32333 &`    `&        command list for &"no mail in SMTP session"&
32334 &`CV  `&        certificate verification status
32335 &`D   `&        duration of &"no mail in SMTP session"&
32336 &`DN  `&        distinguished name from peer certificate
32337 &`DT  `&        on &`=>`& lines: time taken for a delivery
32338 &`F   `&        sender address (on delivery lines)
32339 &`H   `&        host name and IP address
32340 &`I   `&        local interface used
32341 &`id  `&        message id for incoming message
32342 &`P   `&        on &`<=`& lines: protocol used
32343 &`    `&        on &`=>`& and &`**`& lines: return path
32344 &`QT  `&        on &`=>`& lines: time spent on queue so far
32345 &`    `&        on &"Completed"& lines: time spent on queue
32346 &`R   `&        on &`<=`& lines: reference for local bounce
32347 &`    `&        on &`=>`&  &`**`& and &`==`& lines: router name
32348 &`S   `&        size of message
32349 &`ST  `&        shadow transport name
32350 &`T   `&        on &`<=`& lines: message subject (topic)
32351 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
32352 &`U   `&        local user or RFC 1413 identity
32353 &`X   `&        TLS cipher suite
32354 .endd
32355
32356
32357 .section "Other log entries" "SECID259"
32358 Various other types of log entry are written from time to time. Most should be
32359 self-explanatory. Among the more common are:
32360
32361 .ilist
32362 .cindex "retry" "time not reached"
32363 &'retry time not reached'&&~&~An address previously suffered a temporary error
32364 during routing or local delivery, and the time to retry has not yet arrived.
32365 This message is not written to an individual message log file unless it happens
32366 during the first delivery attempt.
32367 .next
32368 &'retry time not reached for any host'&&~&~An address previously suffered
32369 temporary errors during remote delivery, and the retry time has not yet arrived
32370 for any of the hosts to which it is routed.
32371 .next
32372 .cindex "spool directory" "file locked"
32373 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
32374 some other Exim process is already working on the message. This can be quite
32375 common if queue running processes are started at frequent intervals. The
32376 &'exiwhat'& utility script can be used to find out what Exim processes are
32377 doing.
32378 .next
32379 .cindex "error" "ignored"
32380 &'error ignored'&&~&~There are several circumstances that give rise to this
32381 message:
32382 .olist
32383 Exim failed to deliver a bounce message whose age was greater than
32384 &%ignore_bounce_errors_after%&. The bounce was discarded.
32385 .next
32386 A filter file set up a delivery using the &"noerror"& option, and the delivery
32387 failed. The delivery was discarded.
32388 .next
32389 A delivery set up by a router configured with
32390 . ==== As this is a nested list, any displays it contains must be indented
32391 . ==== as otherwise they are too far to the left.
32392 .code
32393     errors_to = <>
32394 .endd
32395 failed. The delivery was discarded.
32396 .endlist olist
32397 .endlist ilist
32398
32399
32400
32401
32402
32403 .section "Reducing or increasing what is logged" "SECTlogselector"
32404 .cindex "log" "selectors"
32405 By setting the &%log_selector%& global option, you can disable some of Exim's
32406 default logging, or you can request additional logging. The value of
32407 &%log_selector%& is made up of names preceded by plus or minus characters. For
32408 example:
32409 .code
32410 log_selector = +arguments -retry_defer
32411 .endd
32412 The list of optional log items is in the following table, with the default
32413 selection marked by asterisks:
32414 .display
32415 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
32416 &` address_rewrite            `&  address rewriting
32417 &` all_parents                `&  all parents in => lines
32418 &` arguments                  `&  command line arguments
32419 &`*connection_reject          `&  connection rejections
32420 &`*delay_delivery             `&  immediate delivery delayed
32421 &` deliver_time               `&  time taken to perform delivery
32422 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
32423 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
32424 &`*etrn                       `&  ETRN commands
32425 &`*host_lookup_failed         `&  as it says
32426 &` ident_timeout              `&  timeout for ident connection
32427 &` incoming_interface         `&  incoming interface on <= lines
32428 &` incoming_port              `&  incoming port on <= lines
32429 &`*lost_incoming_connection   `&  as it says (includes timeouts)
32430 &` outgoing_port              `&  add remote port to => lines
32431 &`*queue_run                  `&  start and end queue runs
32432 &` queue_time                 `&  time on queue for one recipient
32433 &` queue_time_overall         `&  time on queue for whole message
32434 &` pid                        `&  Exim process id
32435 &` received_recipients        `&  recipients on <= lines
32436 &` received_sender            `&  sender on <= lines
32437 &`*rejected_header            `&  header contents on reject log
32438 &`*retry_defer                `&  &"retry time not reached"&
32439 &` return_path_on_delivery    `&  put return path on => and ** lines
32440 &` sender_on_delivery         `&  add sender to => lines
32441 &`*sender_verify_fail         `&  sender verification failures
32442 &`*size_reject                `&  rejection because too big
32443 &`*skip_delivery              `&  delivery skipped in a queue run
32444 &` smtp_confirmation          `&  SMTP confirmation on => lines
32445 &` smtp_connection            `&  SMTP connections
32446 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
32447 &` smtp_no_mail               `&  session with no MAIL commands
32448 &` smtp_protocol_error        `&  SMTP protocol errors
32449 &` smtp_syntax_error          `&  SMTP syntax errors
32450 &` subject                    `&  contents of &'Subject:'& on <= lines
32451 &` tls_certificate_verified   `&  certificate verification status
32452 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
32453 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
32454 &` unknown_in_list            `&  DNS lookup failed in list match
32455
32456 &` all                        `&  all of the above
32457 .endd
32458 More details on each of these items follows:
32459
32460 .ilist
32461 .cindex "&%warn%& ACL verb" "log when skipping"
32462 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
32463 its conditions cannot be evaluated, a log line to this effect is written if
32464 this log selector is set.
32465 .next
32466 .cindex "log" "rewriting"
32467 .cindex "rewriting" "logging"
32468 &%address_rewrite%&: This applies both to global rewrites and per-transport
32469 rewrites, but not to rewrites in filters run as an unprivileged user (because
32470 such users cannot access the log).
32471 .next
32472 .cindex "log" "full parentage"
32473 &%all_parents%&: Normally only the original and final addresses are logged on
32474 delivery lines; with this selector, intermediate parents are given in
32475 parentheses between them.
32476 .next
32477 .cindex "log" "Exim arguments"
32478 .cindex "Exim arguments, logging"
32479 &%arguments%&: This causes Exim to write the arguments with which it was called
32480 to the main log, preceded by the current working directory. This is a debugging
32481 feature, added to make it easier to find out how certain MUAs call
32482 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
32483 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
32484 that are empty or that contain white space are quoted. Non-printing characters
32485 are shown as escape sequences. This facility cannot log unrecognized arguments,
32486 because the arguments are checked before the configuration file is read. The
32487 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
32488 between the caller and Exim.
32489 .next
32490 .cindex "log" "connection rejections"
32491 &%connection_reject%&: A log entry is written whenever an incoming SMTP
32492 connection is rejected, for whatever reason.
32493 .next
32494 .cindex "log" "delayed delivery"
32495 .cindex "delayed delivery, logging"
32496 &%delay_delivery%&: A log entry is written whenever a delivery process is not
32497 started for an incoming message because the load is too high or too many
32498 messages were received on one connection. Logging does not occur if no delivery
32499 process is started because &%queue_only%& is set or &%-odq%& was used.
32500 .next
32501 .cindex "log" "delivery duration"
32502 &%deliver_time%&: For each delivery, the amount of real time it has taken to
32503 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
32504 .next
32505 .cindex "log" "message size on delivery"
32506 .cindex "size" "of message"
32507 &%delivery_size%&: For each delivery, the size of message delivered is added to
32508 the &"=>"& line, tagged with S=.
32509 .next
32510 .cindex "log" "dnslist defer"
32511 .cindex "DNS list" "logging defer"
32512 .cindex "black list (DNS)"
32513 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
32514 DNS black list suffers a temporary error.
32515 .next
32516 .cindex "log" "ETRN commands"
32517 .cindex "ETRN" "logging"
32518 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
32519 is run to determine whether or not it is actually accepted. An invalid ETRN
32520 command, or one received within a message transaction is not logged by this
32521 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
32522 .next
32523 .cindex "log" "host lookup failure"
32524 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
32525 any addresses, or when a lookup of an IP address fails to find a host name, a
32526 log line is written. This logging does not apply to direct DNS lookups when
32527 routing email addresses, but it does apply to &"byname"& lookups.
32528 .next
32529 .cindex "log" "ident timeout"
32530 .cindex "RFC 1413" "logging timeout"
32531 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
32532 client's ident port times out.
32533 .next
32534 .cindex "log" "incoming interface"
32535 .cindex "interface" "logging"
32536 &%incoming_interface%&: The interface on which a message was received is added
32537 to the &"<="& line as an IP address in square brackets, tagged by I= and
32538 followed by a colon and the port number. The local interface and port are also
32539 added to other SMTP log lines, for example &"SMTP connection from"&, and to
32540 rejection lines.
32541 .next
32542 .cindex "log" "incoming remote port"
32543 .cindex "port" "logging remote"
32544 .cindex "TCP/IP" "logging incoming remote port"
32545 .vindex "&$sender_fullhost$&"
32546 .vindex "&$sender_rcvhost$&"
32547 &%incoming_port%&: The remote port number from which a message was received is
32548 added to log entries and &'Received:'& header lines, following the IP address
32549 in square brackets, and separated from it by a colon. This is implemented by
32550 changing the value that is put in the &$sender_fullhost$& and
32551 &$sender_rcvhost$& variables. Recording the remote port number has become more
32552 important with the widening use of NAT (see RFC 2505).
32553 .next
32554 .cindex "log" "dropped connection"
32555 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
32556 connection is unexpectedly dropped.
32557 .next
32558 .cindex "log" "outgoing remote port"
32559 .cindex "port" "logging outgoint remote"
32560 .cindex "TCP/IP" "logging ougtoing remote port"
32561 &%outgoing_port%&: The remote port number is added to delivery log lines (those
32562 containing => tags) following the IP address. This option is not included in
32563 the default setting, because for most ordinary configurations, the remote port
32564 number is always 25 (the SMTP port).
32565 .next
32566 .cindex "log" "process ids in"
32567 .cindex "pid (process id)" "in log lines"
32568 &%pid%&: The current process id is added to every log line, in square brackets,
32569 immediately after the time and date.
32570 .next
32571 .cindex "log" "queue run"
32572 .cindex "queue runner" "logging"
32573 &%queue_run%&: The start and end of every queue run are logged.
32574 .next
32575 .cindex "log" "queue time"
32576 &%queue_time%&: The amount of time the message has been in the queue on the
32577 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
32578 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
32579 includes reception time as well as the delivery time for the current address.
32580 This means that it may be longer than the difference between the arrival and
32581 delivery log line times, because the arrival log line is not written until the
32582 message has been successfully received.
32583 .next
32584 &%queue_time_overall%&: The amount of time the message has been in the queue on
32585 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
32586 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
32587 message, so it includes reception time as well as the total delivery time.
32588 .next
32589 .cindex "log" "recipients"
32590 &%received_recipients%&: The recipients of a message are listed in the main log
32591 as soon as the message is received. The list appears at the end of the log line
32592 that is written when a message is received, preceded by the word &"for"&. The
32593 addresses are listed after they have been qualified, but before any rewriting
32594 has taken place.
32595 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
32596 in the list.
32597 .next
32598 .cindex "log" "sender reception"
32599 &%received_sender%&: The unrewritten original sender of a message is added to
32600 the end of the log line that records the message's arrival, after the word
32601 &"from"& (before the recipients if &%received_recipients%& is also set).
32602 .next
32603 .cindex "log" "header lines for rejection"
32604 &%rejected_header%&: If a message's header has been received at the time a
32605 rejection is written to the reject log, the complete header is added to the
32606 log. Header logging can be turned off individually for messages that are
32607 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
32608 .next
32609 .cindex "log" "retry defer"
32610 &%retry_defer%&: A log line is written if a delivery is deferred because a
32611 retry time has not yet been reached. However, this &"retry time not reached"&
32612 message is always omitted from individual message logs after the first delivery
32613 attempt.
32614 .next
32615 .cindex "log" "return path"
32616 &%return_path_on_delivery%&: The return path that is being transmitted with
32617 the message is included in delivery and bounce lines, using the tag P=.
32618 This is omitted if no delivery actually happens, for example, if routing fails,
32619 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
32620 .next
32621 .cindex "log" "sender on delivery"
32622 &%sender_on_delivery%&: The message's sender address is added to every delivery
32623 and bounce line, tagged by F= (for &"from"&).
32624 This is the original sender that was received with the message; it is not
32625 necessarily the same as the outgoing return path.
32626 .next
32627 .cindex "log" "sender verify failure"
32628 &%sender_verify_fail%&: If this selector is unset, the separate log line that
32629 gives details of a sender verification failure is not written. Log lines for
32630 the rejection of SMTP commands contain just &"sender verify failed"&, so some
32631 detail is lost.
32632 .next
32633 .cindex "log" "size rejection"
32634 &%size_reject%&: A log line is written whenever a message is rejected because
32635 it is too big.
32636 .next
32637 .cindex "log" "frozen messages; skipped"
32638 .cindex "frozen messages" "logging skipping"
32639 &%skip_delivery%&: A log line is written whenever a message is skipped during a
32640 queue run because it is frozen or because another process is already delivering
32641 it.
32642 .cindex "&""spool file is locked""&"
32643 The message that is written is &"spool file is locked"&.
32644 .next
32645 .cindex "log" "smtp confirmation"
32646 .cindex "SMTP" "logging confirmation"
32647 &%smtp_confirmation%&: The response to the final &"."& in the SMTP dialogue for
32648 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
32649 A number of MTAs (including Exim) return an identifying string in this
32650 response.
32651 .next
32652 .cindex "log" "SMTP connections"
32653 .cindex "SMTP" "logging connections"
32654 &%smtp_connection%&: A log line is written whenever an SMTP connection is
32655 established or closed, unless the connection is from a host that matches
32656 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
32657 only when the closure is unexpected.) This applies to connections from local
32658 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
32659 dropped in the middle of a message, a log line is always written, whether or
32660 not this selector is set, but otherwise nothing is written at the start and end
32661 of connections unless this selector is enabled.
32662
32663 For TCP/IP connections to an Exim daemon, the current number of connections is
32664 included in the log message for each new connection, but note that the count is
32665 reset if the daemon is restarted.
32666 Also, because connections are closed (and the closure is logged) in
32667 subprocesses, the count may not include connections that have been closed but
32668 whose termination the daemon has not yet noticed. Thus, while it is possible to
32669 match up the opening and closing of connections in the log, the value of the
32670 logged counts may not be entirely accurate.
32671 .next
32672 .cindex "log" "SMTP transaction; incomplete"
32673 .cindex "SMTP" "logging incomplete transactions"
32674 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
32675 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
32676 and the message sender plus any accepted recipients are included in the log
32677 line. This can provide evidence of dictionary attacks.
32678 .next
32679 .cindex "log" "non-MAIL SMTP sessions"
32680 .cindex "MAIL" "logging session without"
32681 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
32682 connection terminates without having issued a MAIL command. This includes both
32683 the case when the connection is dropped, and the case when QUIT is used. It
32684 does not include cases where the connection is rejected right at the start (by
32685 an ACL, or because there are too many connections, or whatever). These cases
32686 already have their own log lines.
32687
32688 The log line that is written contains the identity of the client in the usual
32689 way, followed by D= and a time, which records the duration of the connection.
32690 If the connection was authenticated, this fact is logged exactly as it is for
32691 an incoming message, with an A= item. If the connection was encrypted, CV=,
32692 DN=, and X= items may appear as they do for an incoming message, controlled by
32693 the same logging options.
32694
32695 Finally, if any SMTP commands were issued during the connection, a C= item
32696 is added to the line, listing the commands that were used. For example,
32697 .code
32698 C=EHLO,QUIT
32699 .endd
32700 shows that the client issued QUIT straight after EHLO. If there were fewer
32701 than 20 commands, they are all listed. If there were more than 20 commands,
32702 the last 20 are listed, preceded by &"..."&. However, with the default
32703 setting of 10 for &%smtp_accep_max_nonmail%&, the connection will in any case
32704 have been aborted before 20 non-mail commands are processed.
32705 .next
32706 .cindex "log" "SMTP protocol error"
32707 .cindex "SMTP" "logging protocol error"
32708 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
32709 encountered. Exim does not have perfect detection of all protocol errors
32710 because of transmission delays and the use of pipelining. If PIPELINING has
32711 been advertised to a client, an Exim server assumes that the client will use
32712 it, and therefore it does not count &"expected"& errors (for example, RCPT
32713 received after rejecting MAIL) as protocol errors.
32714 .next
32715 .cindex "SMTP" "logging syntax errors"
32716 .cindex "SMTP" "syntax errors; logging"
32717 .cindex "SMTP" "unknown command; logging"
32718 .cindex "log" "unknown SMTP command"
32719 .cindex "log" "SMTP syntax error"
32720 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
32721 encountered. An unrecognized command is treated as a syntax error. For an
32722 external connection, the host identity is given; for an internal connection
32723 using &%-bs%& the sender identification (normally the calling user) is given.
32724 .next
32725 .cindex "log" "subject"
32726 .cindex "subject, logging"
32727 &%subject%&: The subject of the message is added to the arrival log line,
32728 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
32729 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
32730 specifies whether characters with values greater than 127 should be logged
32731 unchanged, or whether they should be rendered as escape sequences.
32732 .next
32733 .cindex "log" "certificate verification"
32734 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
32735 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
32736 verified, and &`CV=no`& if not.
32737 .next
32738 .cindex "log" "TLS cipher"
32739 .cindex "TLS" "logging cipher"
32740 &%tls_cipher%&: When a message is sent or received over an encrypted
32741 connection, the cipher suite used is added to the log line, preceded by X=.
32742 .next
32743 .cindex "log" "TLS peer DN"
32744 .cindex "TLS" "logging peer DN"
32745 &%tls_peerdn%&: When a message is sent or received over an encrypted
32746 connection, and a certificate is supplied by the remote host, the peer DN is
32747 added to the log line, preceded by DN=.
32748 .next
32749 .cindex "log" "DNS failure in list"
32750 &%unknown_in_list%&: This setting causes a log entry to be written when the
32751 result of a list match is failure because a DNS lookup failed.
32752 .endlist
32753
32754
32755 .section "Message log" "SECID260"
32756 .cindex "message" "log file for"
32757 .cindex "log" "message log; description of"
32758 .cindex "&_msglog_& directory"
32759 .oindex "&%preserve_message_logs%&"
32760 In addition to the general log files, Exim writes a log file for each message
32761 that it handles. The names of these per-message logs are the message ids, and
32762 they are kept in the &_msglog_& sub-directory of the spool directory. Each
32763 message log contains copies of the log lines that apply to the message. This
32764 makes it easier to inspect the status of an individual message without having
32765 to search the main log. A message log is deleted when processing of the message
32766 is complete, unless &%preserve_message_logs%& is set, but this should be used
32767 only with great care because they can fill up your disk very quickly.
32768
32769 On a heavily loaded system, it may be desirable to disable the use of
32770 per-message logs, in order to reduce disk I/O. This can be done by setting the
32771 &%message_logs%& option false.
32772 .ecindex IIDloggen
32773
32774
32775
32776
32777 . ////////////////////////////////////////////////////////////////////////////
32778 . ////////////////////////////////////////////////////////////////////////////
32779
32780 .chapter "Exim utilities" "CHAPutils"
32781 .scindex IIDutils "utilities"
32782 A number of utility scripts and programs are supplied with Exim and are
32783 described in this chapter. There is also the Exim Monitor, which is covered in
32784 the next chapter. The utilities described here are:
32785
32786 .itable none 0 0 3  7* left  15* left  40* left
32787 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
32788   "list what Exim processes are doing"
32789 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
32790 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
32791 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
32792 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
32793                                                 various criteria"
32794 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
32795 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
32796   "extract statistics from the log"
32797 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
32798   "check address acceptance from given IP"
32799 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
32800 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
32801 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
32802 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
32803 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
32804 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
32805 .endtable
32806
32807 Another utility that might be of use to sites with many MTAs is Tom Kistner's
32808 &'exilog'&. It provides log visualizations across multiple Exim servers. See
32809 &url(http://duncanthrax.net/exilog/) for details.
32810
32811
32812
32813
32814 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
32815 .cindex "&'exiwhat'&"
32816 .cindex "process, querying"
32817 .cindex "SIGUSR1"
32818 On operating systems that can restart a system call after receiving a signal
32819 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
32820 a line describing what it is doing to the file &_exim-process.info_& in the
32821 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
32822 processes it can find, having first emptied the file. It then waits for one
32823 second to allow the Exim processes to react before displaying the results. In
32824 order to run &'exiwhat'& successfully you have to have sufficient privilege to
32825 send the signal to the Exim processes, so it is normally run as root.
32826
32827 &*Warning*&: This is not an efficient process. It is intended for occasional
32828 use by system administrators. It is not sensible, for example, to set up a
32829 script that sends SIGUSR1 signals to Exim processes at short intervals.
32830
32831
32832 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
32833 varies in different operating systems. Not only are different options used,
32834 but the format of the output is different. For this reason, there are some
32835 system configuration options that configure exactly how &'exiwhat'& works. If
32836 it doesn't seem to be working for you, check the following compile-time
32837 options:
32838 .display
32839 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
32840 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
32841 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
32842 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
32843 .endd
32844 An example of typical output from &'exiwhat'& is
32845 .code
32846 164 daemon: -q1h, listening on port 25
32847 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
32848 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
32849   [10.19.42.42] (editor@ref.example)
32850 10592 handling incoming call from [192.168.243.242]
32851 10628 accepting a local non-SMTP message
32852 .endd
32853 The first number in the output line is the process number. The third line has
32854 been split here, in order to fit it on the page.
32855
32856
32857
32858 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
32859 .cindex "&'exiqgrep'&"
32860 .cindex "queue" "grepping"
32861 This utility is a Perl script contributed by Matt Hubbard. It runs
32862 .code
32863 exim -bpu
32864 .endd
32865 to obtain a queue listing with undelivered recipients only, and then greps the
32866 output to select messages that match given criteria. The following selection
32867 options are available:
32868
32869 .vlist
32870 .vitem &*-f*&&~<&'regex'&>
32871 Match the sender address. The field that is tested is enclosed in angle
32872 brackets, so you can test for bounce messages with
32873 .code
32874 exiqgrep -f '^<>$'
32875 .endd
32876 .vitem &*-r*&&~<&'regex'&>
32877 Match a recipient address. The field that is tested is not enclosed in angle
32878 brackets.
32879
32880 .vitem &*-s*&&~<&'regex'&>
32881 Match against the size field.
32882
32883 .vitem &*-y*&&~<&'seconds'&>
32884 Match messages that are younger than the given time.
32885
32886 .vitem &*-o*&&~<&'seconds'&>
32887 Match messages that are older than the given time.
32888
32889 .vitem &*-z*&
32890 Match only frozen messages.
32891
32892 .vitem &*-x*&
32893 Match only non-frozen messages.
32894 .endlist
32895
32896 The following options control the format of the output:
32897
32898 .vlist
32899 .vitem &*-c*&
32900 Display only the count of matching messages.
32901
32902 .vitem &*-l*&
32903 Long format &-- display the full message information as output by Exim. This is
32904 the default.
32905
32906 .vitem &*-i*&
32907 Display message ids only.
32908
32909 .vitem &*-b*&
32910 Brief format &-- one line per message.
32911
32912 .vitem &*-R*&
32913 Display messages in reverse order.
32914 .endlist
32915
32916 There is one more option, &%-h%&, which outputs a list of options.
32917
32918
32919
32920 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
32921 .cindex "&'exiqsumm'&"
32922 .cindex "queue" "summary"
32923 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
32924 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
32925 running a command such as
32926 .code
32927 exim -bp | exiqsumm
32928 .endd
32929 The output consists of one line for each domain that has messages waiting for
32930 it, as in the following example:
32931 .code
32932 3   2322   74m   66m  msn.com.example
32933 .endd
32934 Each line lists the number of pending deliveries for a domain, their total
32935 volume, and the length of time that the oldest and the newest messages have
32936 been waiting. Note that the number of pending deliveries is greater than the
32937 number of messages when messages have more than one recipient.
32938
32939 A summary line is output at the end. By default the output is sorted on the
32940 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
32941 the output to be sorted by oldest message and by count of messages,
32942 respectively. There are also three options that split the messages for each
32943 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
32944 separates frozen messages, and &%-s%& separates messages according to their
32945 sender.
32946
32947 The output of &'exim -bp'& contains the original addresses in the message, so
32948 this also applies to the output from &'exiqsumm'&. No domains from addresses
32949 generated by aliasing or forwarding are included (unless the &%one_time%&
32950 option of the &(redirect)& router has been used to convert them into &"top
32951 level"& addresses).
32952
32953
32954
32955
32956 .section "Extracting specific information from the log (exigrep)" &&&
32957          "SECTextspeinf"
32958 .cindex "&'exigrep'&"
32959 .cindex "log" "extracts; grepping for"
32960 The &'exigrep'& utility is a Perl script that searches one or more main log
32961 files for entries that match a given pattern. When it finds a match, it
32962 extracts all the log entries for the relevant message, not just those that
32963 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
32964 given message, or all mail for a given user, or for a given host, for example.
32965 The input files can be in Exim log format or syslog format.
32966 If a matching log line is not associated with a specific message, it is
32967 included in &'exigrep'&'s output without any additional lines. The usage is:
32968 .display
32969 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
32970 .endd
32971 If no log file names are given on the command line, the standard input is read.
32972
32973 The &%-t%& argument specifies a number of seconds. It adds an additional
32974 condition for message selection. Messages that are complete are shown only if
32975 they spent more than <&'n'&> seconds on the queue.
32976
32977 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
32978 makes it case-sensitive. This may give a performance improvement when searching
32979 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
32980 option; with &%-I%& they do not. In both cases it is possible to change the
32981 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
32982
32983 The &%-l%& option means &"literal"&, that is, treat all characters in the
32984 pattern as standing for themselves. Otherwise the pattern must be a Perl
32985 regular expression.
32986
32987 The &%-v%& option inverts the matching condition. That is, a line is selected
32988 if it does &'not'& match the pattern.
32989
32990 If the location of a &'zcat'& command is known from the definition of
32991 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
32992 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
32993
32994
32995 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
32996 .cindex "&'exipick'&"
32997 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
32998 lists messages from the queue according to a variety of criteria. For details
32999 of &'exipick'&'s facilities, visit the web page at
33000 &url(http://www.exim.org/eximwiki/ToolExipickManPage) or run &'exipick'& with
33001 the &%--help%& option.
33002
33003
33004 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
33005 .cindex "log" "cycling local files"
33006 .cindex "cycling logs"
33007 .cindex "&'exicyclog'&"
33008 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
33009 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
33010 you are using log files with datestamps in their names (see section
33011 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
33012 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
33013 There are two command line options for &'exicyclog'&:
33014 .ilist
33015 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
33016 default that is set when Exim is built. The default default is 10.
33017 .next
33018 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
33019 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
33020 overriding the script's default, which is to find the setting from Exim's
33021 configuration.
33022 .endlist
33023
33024 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
33025 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
33026 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
33027 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
33028 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
33029 logs are handled similarly.
33030
33031 If the limit is greater than 99, the script uses 3-digit numbers such as
33032 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
33033 to one that is greater, or &'vice versa'&, you will have to fix the names of
33034 any existing log files.
33035
33036 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
33037 the end are deleted. All files with numbers greater than 01 are compressed,
33038 using a compression command which is configured by the COMPRESS_COMMAND
33039 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
33040 root &%crontab%& entry of the form
33041 .code
33042 1 0 * * * su exim -c /usr/exim/bin/exicyclog
33043 .endd
33044 assuming you have used the name &"exim"& for the Exim user. You can run
33045 &'exicyclog'& as root if you wish, but there is no need.
33046
33047
33048
33049 .section "Mail statistics (eximstats)" "SECTmailstat"
33050 .cindex "statistics"
33051 .cindex "&'eximstats'&"
33052 A Perl script called &'eximstats'& is provided for extracting statistical
33053 information from log files. The output is either plain text, or HTML.
33054 Exim log files are also supported by the &'Lire'& system produced by the
33055 LogReport Foundation &url(http://www.logreport.org).
33056
33057 The &'eximstats'& script has been hacked about quite a bit over time. The
33058 latest version is the result of some extensive revision by Steve Campbell. A
33059 lot of information is given by default, but there are options for suppressing
33060 various parts of it. Following any options, the arguments to the script are a
33061 list of files, which should be main log files. For example:
33062 .code
33063 eximstats -nr /var/spool/exim/log/mainlog.01
33064 .endd
33065 By default, &'eximstats'& extracts information about the number and volume of
33066 messages received from or delivered to various hosts. The information is sorted
33067 both by message count and by volume, and the top fifty hosts in each category
33068 are listed on the standard output. Similar information, based on email
33069 addresses or domains instead of hosts can be requested by means of various
33070 options. For messages delivered and received locally, similar statistics are
33071 also produced per user.
33072
33073 The output also includes total counts and statistics about delivery errors, and
33074 histograms showing the number of messages received and deliveries made in each
33075 hour of the day. A delivery with more than one address in its envelope (for
33076 example, an SMTP transaction with more than one RCPT command) is counted
33077 as a single delivery by &'eximstats'&.
33078
33079 Though normally more deliveries than receipts are reported (as messages may
33080 have multiple recipients), it is possible for &'eximstats'& to report more
33081 messages received than delivered, even though the queue is empty at the start
33082 and end of the period in question. If an incoming message contains no valid
33083 recipients, no deliveries are recorded for it. A bounce message is handled as
33084 an entirely separate message.
33085
33086 &'eximstats'& always outputs a grand total summary giving the volume and number
33087 of messages received and deliveries made, and the number of hosts involved in
33088 each case. It also outputs the number of messages that were delayed (that is,
33089 not completely delivered at the first attempt), and the number that had at
33090 least one address that failed.
33091
33092 The remainder of the output is in sections that can be independently disabled
33093 or modified by various options. It consists of a summary of deliveries by
33094 transport, histograms of messages received and delivered per time interval
33095 (default per hour), information about the time messages spent on the queue,
33096 a list of relayed messages, lists of the top fifty sending hosts, local
33097 senders, destination hosts, and destination local users by count and by volume,
33098 and a list of delivery errors that occurred.
33099
33100 The relay information lists messages that were actually relayed, that is, they
33101 came from a remote host and were directly delivered to some other remote host,
33102 without being processed (for example, for aliasing or forwarding) locally.
33103
33104 There are quite a few options for &'eximstats'& to control exactly what it
33105 outputs. These are documented in the Perl script itself, and can be extracted
33106 by running the command &(perldoc)& on the script. For example:
33107 .code
33108 perldoc /usr/exim/bin/eximstats
33109 .endd
33110
33111 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
33112 .cindex "&'exim_checkaccess'&"
33113 .cindex "policy control" "checking access"
33114 .cindex "checking access"
33115 The &%-bh%& command line argument allows you to run a fake SMTP session with
33116 debugging output, in order to check what Exim is doing when it is applying
33117 policy controls to incoming SMTP mail. However, not everybody is sufficiently
33118 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
33119 sometimes you just want to answer the question &"Does this address have
33120 access?"& without bothering with any further details.
33121
33122 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
33123 two arguments, an IP address and an email address:
33124 .code
33125 exim_checkaccess 10.9.8.7 A.User@a.domain.example
33126 .endd
33127 The utility runs a call to Exim with the &%-bh%& option, to test whether the
33128 given email address would be accepted in a RCPT command in a TCP/IP
33129 connection from the host with the given IP address. The output of the utility
33130 is either the word &"accepted"&, or the SMTP error response, for example:
33131 .code
33132 Rejected:
33133 550 Relay not permitted
33134 .endd
33135 When running this test, the utility uses &`<>`& as the envelope sender address
33136 for the MAIL command, but you can change this by providing additional
33137 options. These are passed directly to the Exim command. For example, to specify
33138 that the test is to be run with the sender address &'himself@there.example'&
33139 you can use:
33140 .code
33141 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
33142                  -f himself@there.example
33143 .endd
33144 Note that these additional Exim command line items must be given after the two
33145 mandatory arguments.
33146
33147 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
33148 while running its checks. You can run checks that include callouts by using
33149 &%-bhc%&, but this is not yet available in a &"packaged"& form.
33150
33151
33152
33153 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
33154 .cindex "DBM" "building dbm files"
33155 .cindex "building DBM files"
33156 .cindex "&'exim_dbmbuild'&"
33157 .cindex "lower casing"
33158 .cindex "binary zero" "in lookup key"
33159 The &'exim_dbmbuild'& program reads an input file containing keys and data in
33160 the format used by the &(lsearch)& lookup (see section
33161 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
33162 names as keys and the remainder of the information as data. The lower-casing
33163 can be prevented by calling the program with the &%-nolc%& option.
33164
33165 A terminating zero is included as part of the key string. This is expected by
33166 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
33167 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
33168 strings or the data strings. The &(dbmnz)& lookup type can be used with such
33169 files.
33170
33171 The program requires two arguments: the name of the input file (which can be a
33172 single hyphen to indicate the standard input), and the name of the output file.
33173 It creates the output under a temporary name, and then renames it if all went
33174 well.
33175
33176 .cindex "USE_DB"
33177 If the native DB interface is in use (USE_DB is set in a compile-time
33178 configuration file &-- this is common in free versions of Unix) the two file
33179 names must be different, because in this mode the Berkeley DB functions create
33180 a single output file using exactly the name given. For example,
33181 .code
33182 exim_dbmbuild /etc/aliases /etc/aliases.db
33183 .endd
33184 reads the system alias file and creates a DBM version of it in
33185 &_/etc/aliases.db_&.
33186
33187 In systems that use the &'ndbm'& routines (mostly proprietary versions of
33188 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
33189 environment, the suffixes are added to the second argument of
33190 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
33191 when the Berkeley functions are used in compatibility mode (though this is not
33192 recommended), because in that case it adds a &_.db_& suffix to the file name.
33193
33194 If a duplicate key is encountered, the program outputs a warning, and when it
33195 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
33196 option is used. By default, only the first of a set of duplicates is used &--
33197 this makes it compatible with &(lsearch)& lookups. There is an option
33198 &%-lastdup%& which causes it to use the data for the last duplicate instead.
33199 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
33200 &%stderr%&. For other errors, where it doesn't actually make a new file, the
33201 return code is 2.
33202
33203
33204
33205
33206 .section "Finding individual retry times (exinext)" "SECTfinindret"
33207 .cindex "retry" "times"
33208 .cindex "&'exinext'&"
33209 A utility called &'exinext'& (mostly a Perl script) provides the ability to
33210 fish specific information out of the retry database. Given a mail domain (or a
33211 complete address), it looks up the hosts for that domain, and outputs any retry
33212 information for the hosts or for the domain. At present, the retry information
33213 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
33214 output. For example:
33215 .code
33216 $ exinext piglet@milne.fict.example
33217 kanga.milne.example:192.168.8.1 error 146: Connection refused
33218   first failed: 21-Feb-1996 14:57:34
33219   last tried:   21-Feb-1996 14:57:34
33220   next try at:  21-Feb-1996 15:02:34
33221 roo.milne.example:192.168.8.3 error 146: Connection refused
33222   first failed: 20-Jan-1996 13:12:08
33223   last tried:   21-Feb-1996 11:42:03
33224   next try at:  21-Feb-1996 19:42:03
33225   past final cutoff time
33226 .endd
33227 You can also give &'exinext'& a local part, without a domain, and it
33228 will give any retry information for that local part in your default domain.
33229 A message id can be used to obtain retry information pertaining to a specific
33230 message. This exists only when an attempt to deliver a message to a remote host
33231 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
33232 &'exinext'& is not particularly efficient, but then it is not expected to be
33233 run very often.
33234
33235 The &'exinext'& utility calls Exim to find out information such as the location
33236 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
33237 passed on to the &'exim'& commands. The first specifies an alternate Exim
33238 configuration file, and the second sets macros for use within the configuration
33239 file. These features are mainly to help in testing, but might also be useful in
33240 environments where more than one configuration file is in use.
33241
33242
33243
33244 .section "Hints database maintenance" "SECThindatmai"
33245 .cindex "hints database" "maintenance"
33246 .cindex "maintaining Exim's hints database"
33247 Three utility programs are provided for maintaining the DBM files that Exim
33248 uses to contain its delivery hint information. Each program requires two
33249 arguments. The first specifies the name of Exim's spool directory, and the
33250 second is the name of the database it is to operate on. These are as follows:
33251
33252 .ilist
33253 &'retry'&: the database of retry information
33254 .next
33255 &'wait-'&<&'transport name'&>: databases of information about messages waiting
33256 for remote hosts
33257 .next
33258 &'callout'&: the callout cache
33259 .next
33260 &'ratelimit'&: the data for implementing the ratelimit ACL condition
33261 .next
33262 &'misc'&: other hints data
33263 .endlist
33264
33265 The &'misc'& database is used for
33266
33267 .ilist
33268 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
33269 .next
33270 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
33271 &(smtp)& transport)
33272 .endlist
33273
33274
33275
33276 .section "exim_dumpdb" "SECID261"
33277 .cindex "&'exim_dumpdb'&"
33278 The entire contents of a database are written to the standard output by the
33279 &'exim_dumpdb'& program, which has no options or arguments other than the
33280 spool and database names. For example, to dump the retry database:
33281 .code
33282 exim_dumpdb /var/spool/exim retry
33283 .endd
33284 Two lines of output are produced for each entry:
33285 .code
33286 T:mail.ref.example:192.168.242.242 146 77 Connection refused
33287 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
33288 .endd
33289 The first item on the first line is the key of the record. It starts with one
33290 of the letters R, or T, depending on whether it refers to a routing or
33291 transport retry. For a local delivery, the next part is the local address; for
33292 a remote delivery it is the name of the remote host, followed by its failing IP
33293 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
33294 transport). If the remote port is not the standard one (port 25), it is added
33295 to the IP address. Then there follows an error code, an additional error code,
33296 and a textual description of the error.
33297
33298 The three times on the second line are the time of first failure, the time of
33299 the last delivery attempt, and the computed time for the next attempt. The line
33300 ends with an asterisk if the cutoff time for the last retry rule has been
33301 exceeded.
33302
33303 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
33304 consists of a host name followed by a list of ids for messages that are or were
33305 waiting to be delivered to that host. If there are a very large number for any
33306 one host, continuation records, with a sequence number added to the host name,
33307 may be seen. The data in these records is often out of date, because a message
33308 may be routed to several alternative hosts, and Exim makes no effort to keep
33309 cross-references.
33310
33311
33312
33313 .section "exim_tidydb" "SECID262"
33314 .cindex "&'exim_tidydb'&"
33315 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
33316 database. If run with no options, it removes all records that are more than 30
33317 days old. The age is calculated from the date and time that the record was last
33318 updated. Note that, in the case of the retry database, it is &'not'& the time
33319 since the first delivery failure. Information about a host that has been down
33320 for more than 30 days will remain in the database, provided that the record is
33321 updated sufficiently often.
33322
33323 The cutoff date can be altered by means of the &%-t%& option, which must be
33324 followed by a time. For example, to remove all records older than a week from
33325 the retry database:
33326 .code
33327 exim_tidydb -t 7d /var/spool/exim retry
33328 .endd
33329 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
33330 message ids. In the former these appear as data in records keyed by host &--
33331 they were messages that were waiting for that host &-- and in the latter they
33332 are the keys for retry information for messages that have suffered certain
33333 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
33334 message ids in database records are those of messages that are still on the
33335 queue. Message ids for messages that no longer exist are removed from
33336 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
33337 For the &'retry'& database, records whose keys are non-existent message ids are
33338 removed. The &'exim_tidydb'& utility outputs comments on the standard output
33339 whenever it removes information from the database.
33340
33341 Certain records are automatically removed by Exim when they are no longer
33342 needed, but others are not. For example, if all the MX hosts for a domain are
33343 down, a retry record is created for each one. If the primary MX host comes back
33344 first, its record is removed when Exim successfully delivers to it, but the
33345 records for the others remain because Exim has not tried to use those hosts.
33346
33347 It is important, therefore, to run &'exim_tidydb'& periodically on all the
33348 hints databases. You should do this at a quiet time of day, because it requires
33349 a database to be locked (and therefore inaccessible to Exim) while it does its
33350 work. Removing records from a DBM file does not normally make the file smaller,
33351 but all the common DBM libraries are able to re-use the space that is released.
33352 After an initial phase of increasing in size, the databases normally reach a
33353 point at which they no longer get any bigger, as long as they are regularly
33354 tidied.
33355
33356 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
33357 databases is likely to keep on increasing.
33358
33359
33360
33361
33362 .section "exim_fixdb" "SECID263"
33363 .cindex "&'exim_fixdb'&"
33364 The &'exim_fixdb'& program is a utility for interactively modifying databases.
33365 Its main use is for testing Exim, but it might also be occasionally useful for
33366 getting round problems in a live system. It has no options, and its interface
33367 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
33368 key of a database record can then be entered, and the data for that record is
33369 displayed.
33370
33371 If &"d"& is typed at the next prompt, the entire record is deleted. For all
33372 except the &'retry'& database, that is the only operation that can be carried
33373 out. For the &'retry'& database, each field is output preceded by a number, and
33374 data for individual fields can be changed by typing the field number followed
33375 by new data, for example:
33376 .code
33377 > 4 951102:1000
33378 .endd
33379 resets the time of the next delivery attempt. Time values are given as a
33380 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
33381 used as optional separators.
33382
33383
33384
33385
33386 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
33387 .cindex "mailbox" "maintenance"
33388 .cindex "&'exim_lock'&"
33389 .cindex "locking mailboxes"
33390 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
33391 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
33392 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
33393 a user agent while investigating a problem. The utility requires the name of
33394 the file as its first argument. If the locking is successful, the second
33395 argument is run as a command (using C's &[system()]& function); if there is no
33396 second argument, the value of the SHELL environment variable is used; if this
33397 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
33398 is unlocked and the utility ends. The following options are available:
33399
33400 .vlist
33401 .vitem &%-fcntl%&
33402 Use &[fcntl()]& locking on the open mailbox.
33403
33404 .vitem &%-flock%&
33405 Use &[flock()]& locking on the open mailbox, provided the operating system
33406 supports it.
33407
33408 .vitem &%-interval%&
33409 This must be followed by a number, which is a number of seconds; it sets the
33410 interval to sleep between retries (default 3).
33411
33412 .vitem &%-lockfile%&
33413 Create a lock file before opening the mailbox.
33414
33415 .vitem &%-mbx%&
33416 Lock the mailbox using MBX rules.
33417
33418 .vitem &%-q%&
33419 Suppress verification output.
33420
33421 .vitem &%-retries%&
33422 This must be followed by a number; it sets the number of times to try to get
33423 the lock (default 10).
33424
33425 .vitem &%-restore_time%&
33426 This option causes &%exim_lock%& to restore the modified and read times to the
33427 locked file before exiting. This allows you to access a locked mailbox (for
33428 example, to take a backup copy) without disturbing the times that the user
33429 subsequently sees.
33430
33431 .vitem &%-timeout%&
33432 This must be followed by a number, which is a number of seconds; it sets a
33433 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
33434 default), a non-blocking call is used.
33435
33436 .vitem &%-v%&
33437 Generate verbose output.
33438 .endlist
33439
33440 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
33441 default is to create a lock file and also to use &[fcntl()]& locking on the
33442 mailbox, which is the same as Exim's default. The use of &%-flock%& or
33443 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
33444 requires that the directory containing the file be writeable. Locking by lock
33445 file does not last for ever; Exim assumes that a lock file is expired if it is
33446 more than 30 minutes old.
33447
33448 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
33449 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
33450 to be taken out on the open mailbox, and an exclusive lock on the file
33451 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
33452 number of the mailbox file. When the locking is released, if an exclusive lock
33453 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
33454
33455 The default output contains verification of the locking that takes place. The
33456 &%-v%& option causes some additional information to be given. The &%-q%& option
33457 suppresses all output except error messages.
33458
33459 A command such as
33460 .code
33461 exim_lock /var/spool/mail/spqr
33462 .endd
33463 runs an interactive shell while the file is locked, whereas
33464 .display
33465 &`exim_lock -q /var/spool/mail/spqr <<End`&
33466 <&'some commands'&>
33467 &`End`&
33468 .endd
33469 runs a specific non-interactive sequence of commands while the file is locked,
33470 suppressing all verification output. A single command can be run by a command
33471 such as
33472 .code
33473 exim_lock -q /var/spool/mail/spqr \
33474   "cp /var/spool/mail/spqr /some/where"
33475 .endd
33476 Note that if a command is supplied, it must be entirely contained within the
33477 second argument &-- hence the quotes.
33478 .ecindex IIDutils
33479
33480
33481 . ////////////////////////////////////////////////////////////////////////////
33482 . ////////////////////////////////////////////////////////////////////////////
33483
33484 .chapter "The Exim monitor" "CHAPeximon"
33485 .scindex IIDeximon "Exim monitor" "description"
33486 .cindex "X-windows"
33487 .cindex "&'eximon'&"
33488 .cindex "Local/eximon.conf"
33489 .cindex "&_exim_monitor/EDITME_&"
33490 The Exim monitor is an application which displays in an X window information
33491 about the state of Exim's queue and what Exim is doing. An admin user can
33492 perform certain operations on messages from this GUI interface; however all
33493 such facilities are also available from the command line, and indeed, the
33494 monitor itself makes use of the command line to perform any actions requested.
33495
33496
33497
33498 .section "Running the monitor" "SECID264"
33499 The monitor is started by running the script called &'eximon'&. This is a shell
33500 script that sets up a number of environment variables, and then runs the
33501 binary called &_eximon.bin_&. The default appearance of the monitor window can
33502 be changed by editing the &_Local/eximon.conf_& file created by editing
33503 &_exim_monitor/EDITME_&. Comments in that file describe what the various
33504 parameters are for.
33505
33506 The parameters that get built into the &'eximon'& script can be overridden for
33507 a particular invocation by setting up environment variables of the same names,
33508 preceded by &`EXIMON_`&. For example, a shell command such as
33509 .code
33510 EXIMON_LOG_DEPTH=400 eximon
33511 .endd
33512 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
33513 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
33514 overrides the Exim log file configuration. This makes it possible to have
33515 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
33516 syslog messages are routed to a file on the local host.
33517
33518 X resources can be used to change the appearance of the window in the normal
33519 way. For example, a resource setting of the form
33520 .code
33521 Eximon*background: gray94
33522 .endd
33523 changes the colour of the background to light grey rather than white. The
33524 stripcharts are drawn with both the data lines and the reference lines in
33525 black. This means that the reference lines are not visible when on top of the
33526 data. However, their colour can be changed by setting a resource called
33527 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
33528 For example, if your X server is running Unix, you could set up lighter
33529 reference lines in the stripcharts by obeying
33530 .code
33531 xrdb -merge <<End
33532 Eximon*highlight: gray
33533 End
33534 .endd
33535 .cindex "admin user"
33536 In order to see the contents of messages on the queue, and to operate on them,
33537 &'eximon'& must either be run as root or by an admin user.
33538
33539 The monitor's window is divided into three parts. The first contains one or
33540 more stripcharts and two action buttons, the second contains a &"tail"& of the
33541 main log file, and the third is a display of the queue of messages awaiting
33542 delivery, with two more action buttons. The following sections describe these
33543 different parts of the display.
33544
33545
33546
33547
33548 .section "The stripcharts" "SECID265"
33549 .cindex "stripchart"
33550 The first stripchart is always a count of messages on the queue. Its name can
33551 be configured by setting QUEUE_STRIPCHART_NAME in the
33552 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
33553 configuration script by regular expression matches on log file entries, making
33554 it possible to display, for example, counts of messages delivered to certain
33555 hosts or using certain transports. The supplied defaults display counts of
33556 received and delivered messages, and of local and SMTP deliveries. The default
33557 period between stripchart updates is one minute; this can be adjusted by a
33558 parameter in the &_Local/eximon.conf_& file.
33559
33560 The stripchart displays rescale themselves automatically as the value they are
33561 displaying changes. There are always 10 horizontal lines in each chart; the
33562 title string indicates the value of each division when it is greater than one.
33563 For example, &"x2"& means that each division represents a value of 2.
33564
33565 It is also possible to have a stripchart which shows the percentage fullness of
33566 a particular disk partition, which is useful when local deliveries are confined
33567 to a single partition.
33568
33569 .cindex "&%statvfs%& function"
33570 This relies on the availability of the &[statvfs()]& function or equivalent in
33571 the operating system. Most, but not all versions of Unix that support Exim have
33572 this. For this particular stripchart, the top of the chart always represents
33573 100%, and the scale is given as &"x10%"&. This chart is configured by setting
33574 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
33575 &_Local/eximon.conf_& file.
33576
33577
33578
33579
33580 .section "Main action buttons" "SECID266"
33581 .cindex "size" "of monitor window"
33582 .cindex "Exim monitor" "window size"
33583 .cindex "window size"
33584 Below the stripcharts there is an action button for quitting the monitor. Next
33585 to this is another button marked &"Size"&. They are placed here so that
33586 shrinking the window to its default minimum size leaves just the queue count
33587 stripchart and these two buttons visible. Pressing the &"Size"& button causes
33588 the window to expand to its maximum size, unless it is already at the maximum,
33589 in which case it is reduced to its minimum.
33590
33591 When expanding to the maximum, if the window cannot be fully seen where it
33592 currently is, it is moved back to where it was the last time it was at full
33593 size. When it is expanding from its minimum size, the old position is
33594 remembered, and next time it is reduced to the minimum it is moved back there.
33595
33596 The idea is that you can keep a reduced window just showing one or two
33597 stripcharts at a convenient place on your screen, easily expand it to show
33598 the full window when required, and just as easily put it back to what it was.
33599 The idea is copied from what the &'twm'& window manager does for its
33600 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
33601 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
33602
33603 Normally, the monitor starts up with the window at its full size, but it can be
33604 built so that it starts up with the window at its smallest size, by setting
33605 START_SMALL=yes in &_Local/eximon.conf_&.
33606
33607
33608
33609 .section "The log display" "SECID267"
33610 .cindex "log" "tail of; in monitor"
33611 The second section of the window is an area in which a display of the tail of
33612 the main log is maintained.
33613 To save space on the screen, the timestamp on each log line is shortened by
33614 removing the date and, if &%log_timezone%& is set, the timezone.
33615 The log tail is not available when the only destination for logging data is
33616 syslog, unless the syslog lines are routed to a local file whose name is passed
33617 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
33618
33619 The log sub-window has a scroll bar at its lefthand side which can be used to
33620 move back to look at earlier text, and the up and down arrow keys also have a
33621 scrolling effect. The amount of log that is kept depends on the setting of
33622 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
33623 to use. When this is full, the earlier 50% of data is discarded &-- this is
33624 much more efficient than throwing it away line by line. The sub-window also has
33625 a horizontal scroll bar for accessing the ends of long log lines. This is the
33626 only means of horizontal scrolling; the right and left arrow keys are not
33627 available. Text can be cut from this part of the window using the mouse in the
33628 normal way. The size of this subwindow is controlled by parameters in the
33629 configuration file &_Local/eximon.conf_&.
33630
33631 Searches of the text in the log window can be carried out by means of the ^R
33632 and ^S keystrokes, which default to a reverse and a forward search,
33633 respectively. The search covers only the text that is displayed in the window.
33634 It cannot go further back up the log.
33635
33636 The point from which the search starts is indicated by a caret marker. This is
33637 normally at the end of the text in the window, but can be positioned explicitly
33638 by pointing and clicking with the left mouse button, and is moved automatically
33639 by a successful search. If new text arrives in the window when it is scrolled
33640 back, the caret remains where it is, but if the window is not scrolled back,
33641 the caret is moved to the end of the new text.
33642
33643 Pressing ^R or ^S pops up a window into which the search text can be typed.
33644 There are buttons for selecting forward or reverse searching, for carrying out
33645 the search, and for cancelling. If the &"Search"& button is pressed, the search
33646 happens and the window remains so that further searches can be done. If the
33647 &"Return"& key is pressed, a single search is done and the window is closed. If
33648 ^C is typed the search is cancelled.
33649
33650 The searching facility is implemented using the facilities of the Athena text
33651 widget. By default this pops up a window containing both &"search"& and
33652 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
33653 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
33654 However, the linkers in BSDI and HP-UX seem unable to handle an externally
33655 provided version of &%TextPop%& when the remaining parts of the text widget
33656 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
33657 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
33658 on these systems, at the expense of having unwanted items in the search popup
33659 window.
33660
33661
33662
33663 .section "The queue display" "SECID268"
33664 .cindex "queue" "display in monitor"
33665 The bottom section of the monitor window contains a list of all messages that
33666 are on the queue, which includes those currently being received or delivered,
33667 as well as those awaiting delivery. The size of this subwindow is controlled by
33668 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
33669 at which it is updated is controlled by another parameter in the same file &--
33670 the default is 5 minutes, since queue scans can be quite expensive. However,
33671 there is an &"Update"& action button just above the display which can be used
33672 to force an update of the queue display at any time.
33673
33674 When a host is down for some time, a lot of pending mail can build up for it,
33675 and this can make it hard to deal with other messages on the queue. To help
33676 with this situation there is a button next to &"Update"& called &"Hide"&. If
33677 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
33678 type anything in here and press &"Return"&, the text is added to a chain of
33679 such texts, and if every undelivered address in a message matches at least one
33680 of the texts, the message is not displayed.
33681
33682 If there is an address that does not match any of the texts, all the addresses
33683 are displayed as normal. The matching happens on the ends of addresses so, for
33684 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
33685 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
33686 has been set up, a button called &"Unhide"& is displayed. If pressed, it
33687 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
33688 a hide request is automatically cancelled after one hour.
33689
33690 While the dialogue box is displayed, you can't press any buttons or do anything
33691 else to the monitor window. For this reason, if you want to cut text from the
33692 queue display to use in the dialogue box, you have to do the cutting before
33693 pressing the &"Hide"& button.
33694
33695 The queue display contains, for each unhidden queued message, the length of
33696 time it has been on the queue, the size of the message, the message id, the
33697 message sender, and the first undelivered recipient, all on one line. If it is
33698 a bounce message, the sender is shown as &"<>"&. If there is more than one
33699 recipient to which the message has not yet been delivered, subsequent ones are
33700 listed on additional lines, up to a maximum configured number, following which
33701 an ellipsis is displayed. Recipients that have already received the message are
33702 not shown.
33703
33704 .cindex "frozen messages" "display"
33705 If a message is frozen, an asterisk is displayed at the left-hand side.
33706
33707 The queue display has a vertical scroll bar, and can also be scrolled by means
33708 of the arrow keys. Text can be cut from it using the mouse in the normal way.
33709 The text searching facilities, as described above for the log window, are also
33710 available, but the caret is always moved to the end of the text when the queue
33711 display is updated.
33712
33713
33714
33715 .section "The queue menu" "SECID269"
33716 .cindex "queue" "menu in monitor"
33717 If the &%shift%& key is held down and the left button is clicked when the mouse
33718 pointer is over the text for any message, an action menu pops up, and the first
33719 line of the queue display for the message is highlighted. This does not affect
33720 any selected text.
33721
33722 If you want to use some other event for popping up the menu, you can set the
33723 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
33724 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
33725 value set in this parameter is a standard X event description. For example, to
33726 run eximon using &%ctrl%& rather than &%shift%& you could use
33727 .code
33728 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
33729 .endd
33730 The title of the menu is the message id, and it contains entries which act as
33731 follows:
33732
33733 .ilist
33734 &'message log'&: The contents of the message log for the message are displayed
33735 in a new text window.
33736 .next
33737 &'headers'&: Information from the spool file that contains the envelope
33738 information and headers is displayed in a new text window. See chapter
33739 &<<CHAPspool>>& for a description of the format of spool files.
33740 .next
33741 &'body'&: The contents of the spool file containing the body of the message are
33742 displayed in a new text window. There is a default limit of 20,000 bytes to the
33743 amount of data displayed. This can be changed by setting the BODY_MAX
33744 option at compile time, or the EXIMON_BODY_MAX option at run time.
33745 .next
33746 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
33747 delivery of the message. This causes an automatic thaw if the message is
33748 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
33749 a new text window. The delivery is run in a separate process, to avoid holding
33750 up the monitor while the delivery proceeds.
33751 .next
33752 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
33753 that the message be frozen.
33754 .next
33755 .cindex "thawing messages"
33756 .cindex "unfreezing messages"
33757 .cindex "frozen messages" "thawing"
33758 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
33759 that the message be thawed.
33760 .next
33761 .cindex "delivery" "forcing failure"
33762 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
33763 that Exim gives up trying to deliver the message. A bounce message is generated
33764 for any remaining undelivered addresses.
33765 .next
33766 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
33767 that the message be deleted from the system without generating a bounce
33768 message.
33769 .next
33770 &'add recipient'&: A dialog box is displayed into which a recipient address can
33771 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
33772 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
33773 Otherwise it must be entered as a fully qualified address. Pressing RETURN
33774 causes a call to Exim to be made using the &%-Mar%& option to request that an
33775 additional recipient be added to the message, unless the entry box is empty, in
33776 which case no action is taken.
33777 .next
33778 &'mark delivered'&: A dialog box is displayed into which a recipient address
33779 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
33780 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
33781 Otherwise it must be entered as a fully qualified address. Pressing RETURN
33782 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
33783 recipient address as already delivered, unless the entry box is empty, in which
33784 case no action is taken.
33785 .next
33786 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
33787 mark all recipient addresses as already delivered.
33788 .next
33789 &'edit sender'&: A dialog box is displayed initialized with the current
33790 sender's address. Pressing RETURN causes a call to Exim to be made using the
33791 &%-Mes%& option to replace the sender address, unless the entry box is empty,
33792 in which case no action is taken. If you want to set an empty sender (as in
33793 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
33794 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
33795 the address is qualified with that domain.
33796 .endlist
33797
33798 When a delivery is forced, a window showing the &%-v%& output is displayed. In
33799 other cases when a call to Exim is made, if there is any output from Exim (in
33800 particular, if the command fails) a window containing the command and the
33801 output is displayed. Otherwise, the results of the action are normally apparent
33802 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
33803 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
33804 if no output is generated.
33805
33806 The queue display is automatically updated for actions such as freezing and
33807 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
33808 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
33809 force an update of the display after one of these actions.
33810
33811 In any text window that is displayed as result of a menu action, the normal
33812 cut-and-paste facility is available, and searching can be carried out using ^R
33813 and ^S, as described above for the log tail window.
33814 .ecindex IIDeximon
33815
33816
33817
33818
33819
33820 . ////////////////////////////////////////////////////////////////////////////
33821 . ////////////////////////////////////////////////////////////////////////////
33822
33823 .chapter "Security considerations" "CHAPsecurity"
33824 .scindex IIDsecurcon "security" "discussion of"
33825 This chapter discusses a number of issues concerned with security, some of
33826 which are also covered in other parts of this manual.
33827
33828 For reasons that this author does not understand, some people have promoted
33829 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
33830 existence of this chapter in the documentation. However, the intent of the
33831 chapter is simply to describe the way Exim works in relation to certain
33832 security concerns, not to make any specific claims about the effectiveness of
33833 its security as compared with other MTAs.
33834
33835 What follows is a description of the way Exim is supposed to be. Best efforts
33836 have been made to try to ensure that the code agrees with the theory, but an
33837 absence of bugs can never be guaranteed. Any that are reported will get fixed
33838 as soon as possible.
33839
33840
33841 .section "Building a more &""hardened""& Exim" "SECID286"
33842 .cindex "security" "build-time features"
33843 There are a number of build-time options that can be set in &_Local/Makefile_&
33844 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
33845 Exim administrator who does not have the root password, or by someone who has
33846 penetrated the Exim (but not the root) account. These options are as follows:
33847
33848 .ilist
33849 ALT_CONFIG_PREFIX can be set to a string that is required to match the
33850 start of any file names used with the &%-C%& option. When it is set, these file
33851 names are also not allowed to contain the sequence &"/../"&. (However, if the
33852 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
33853 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
33854 default setting for &%ALT_CONFIG_PREFIX%&.
33855
33856 If the permitted configuration files are confined to a directory to
33857 which only root has access, this guards against someone who has broken
33858 into the Exim account from running a privileged Exim with an arbitrary
33859 configuration file, and using it to break into other accounts.
33860 .next
33861 .new
33862 If a non-trusted configuration file (i.e. not the default configuration file
33863 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
33864 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
33865 the next item), then root privilege is retained only if the caller of Exim is
33866 root. This locks out the possibility of testing a configuration using &%-C%&
33867 right through message reception and delivery, even if the caller is root. The
33868 reception works, but by that time, Exim is running as the Exim user, so when
33869 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
33870 privilege to be lost. However, root can test reception and delivery using two
33871 separate commands.
33872 .wen
33873 .next
33874 The WHITELIST_D_MACROS build option declares some macros to be safe to override
33875 with &%-D%& if the real uid is one of root, the Exim run-time user or the
33876 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
33877 requiring the run-time value supplied to &%-D%& to match a regex that errs on
33878 the restrictive side.  Requiring build-time selection of safe macros is onerous
33879 but this option is intended solely as a transition mechanism to permit
33880 previously-working configurations to continue to work after release 4.73.
33881 .next
33882 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
33883 is disabled.
33884 .next
33885 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
33886 never to be used for any deliveries. This is like the &%never_users%& runtime
33887 option, but it cannot be overridden; the runtime option adds additional users
33888 to the list. The default setting is &"root"&; this prevents a non-root user who
33889 is permitted to modify the runtime file from using Exim as a way to get root.
33890 .endlist
33891
33892
33893
33894
33895 .section "Root privilege" "SECID270"
33896 .cindex "setuid"
33897 .cindex "root privilege"
33898 The Exim binary is normally setuid to root, which means that it gains root
33899 privilege (runs as root) when it starts execution. In some special cases (for
33900 example, when the daemon is not in use and there are no local deliveries), it
33901 may be possible to run Exim setuid to some user other than root. This is
33902 discussed in the next section. However, in most installations, root privilege
33903 is required for two things:
33904
33905 .ilist
33906 To set up a socket connected to the standard SMTP port (25) when initialising
33907 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
33908 not required.
33909 .next
33910 To be able to change uid and gid in order to read users' &_.forward_& files and
33911 perform local deliveries as the receiving user or as specified in the
33912 configuration.
33913 .endlist
33914
33915 It is not necessary to be root to do any of the other things Exim does, such as
33916 receiving messages and delivering them externally over SMTP, and it is
33917 obviously more secure if Exim does not run as root except when necessary.
33918 For this reason, a user and group for Exim to use must be defined in
33919 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
33920 group"&. Their values can be changed by the run time configuration, though this
33921 is not recommended. Often a user called &'exim'& is used, but some sites use
33922 &'mail'& or another user name altogether.
33923
33924 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
33925 abdication; the process cannot regain root afterwards. Prior to release 4.00,
33926 &[seteuid()]& was used in some circumstances, but this is no longer the case.
33927
33928 After a new Exim process has interpreted its command line options, it changes
33929 uid and gid in the following cases:
33930
33931 .ilist
33932 .oindex "&%-C%&"
33933 .oindex "&%-D%&"
33934 If the &%-C%& option is used to specify an alternate configuration file, or if
33935 the &%-D%& option is used to define macro values for the configuration, and the
33936 calling process is not running as root, the uid and gid are changed to those of
33937 the calling process.
33938 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
33939 option may not be used at all.
33940 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
33941 can be supplied if the calling process is running as root, the Exim run-time
33942 user or CONFIGURE_OWNER, if defined.
33943 .next
33944 .oindex "&%-be%&"
33945 .oindex "&%-bf%&"
33946 .oindex "&%-bF%&"
33947 If the expansion test option (&%-be%&) or one of the filter testing options
33948 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
33949 calling process.
33950 .next
33951 If the process is not a daemon process or a queue runner process or a delivery
33952 process or a process for testing address routing (started with &%-bt%&), the
33953 uid and gid are changed to the Exim user and group. This means that Exim always
33954 runs under its own uid and gid when receiving messages. This also applies when
33955 testing address verification
33956 .oindex "&%-bv%&"
33957 .oindex "&%-bh%&"
33958 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
33959 option).
33960 .next
33961 For a daemon, queue runner, delivery, or address testing process, the uid
33962 remains as root at this stage, but the gid is changed to the Exim group.
33963 .endlist
33964
33965 The processes that initially retain root privilege behave as follows:
33966
33967 .ilist
33968 A daemon process changes the gid to the Exim group and the uid to the Exim
33969 user after setting up one or more listening sockets. The &[initgroups()]&
33970 function is called, so that if the Exim user is in any additional groups, they
33971 will be used during message reception.
33972 .next
33973 A queue runner process retains root privilege throughout its execution. Its
33974 job is to fork a controlled sequence of delivery processes.
33975 .next
33976 A delivery process retains root privilege throughout most of its execution,
33977 but any actual deliveries (that is, the transports themselves) are run in
33978 subprocesses which always change to a non-root uid and gid. For local
33979 deliveries this is typically the uid and gid of the owner of the mailbox; for
33980 remote deliveries, the Exim uid and gid are used. Once all the delivery
33981 subprocesses have been run, a delivery process changes to the Exim uid and gid
33982 while doing post-delivery tidying up such as updating the retry database and
33983 generating bounce and warning messages.
33984
33985 While the recipient addresses in a message are being routed, the delivery
33986 process runs as root. However, if a user's filter file has to be processed,
33987 this is done in a subprocess that runs under the individual user's uid and
33988 gid. A system filter is run as root unless &%system_filter_user%& is set.
33989 .next
33990 A process that is testing addresses (the &%-bt%& option) runs as root so that
33991 the routing is done in the same environment as a message delivery.
33992 .endlist
33993
33994
33995
33996
33997 .section "Running Exim without privilege" "SECTrunexiwitpri"
33998 .cindex "privilege, running without"
33999 .cindex "unprivileged running"
34000 .cindex "root privilege" "running without"
34001 Some installations like to run Exim in an unprivileged state for more of its
34002 operation, for added security. Support for this mode of operation is provided
34003 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
34004 gid are changed to the Exim user and group at the start of a delivery process
34005 (and also queue runner and address testing processes). This means that address
34006 routing is no longer run as root, and the deliveries themselves cannot change
34007 to any other uid.
34008
34009 .cindex SIGHUP
34010 .cindex "daemon" "restarting"
34011 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
34012 that the daemon can still be started in the usual way, and it can respond
34013 correctly to SIGHUP because the re-invocation regains root privilege.
34014
34015 An alternative approach is to make Exim setuid to the Exim user and also setgid
34016 to the Exim group. If you do this, the daemon must be started from a root
34017 process. (Calling Exim from a root process makes it behave in the way it does
34018 when it is setuid root.) However, the daemon cannot restart itself after a
34019 SIGHUP signal because it cannot regain privilege.
34020
34021 It is still useful to set &%deliver_drop_privilege%& in this case, because it
34022 stops Exim from trying to re-invoke itself to do a delivery after a message has
34023 been received. Such a re-invocation is a waste of resources because it has no
34024 effect.
34025
34026 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
34027 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
34028 to the Exim user seems a clean approach, but there is one complication:
34029
34030 In this style of operation, Exim is running with the real uid and gid set to
34031 those of the calling process, and the effective uid/gid set to Exim's values.
34032 Ideally, any association with the calling process' uid/gid should be dropped,
34033 that is, the real uid/gid should be reset to the effective values so as to
34034 discard any privileges that the caller may have. While some operating systems
34035 have a function that permits this action for a non-root effective uid, quite a
34036 number of them do not. Because of this lack of standardization, Exim does not
34037 address this problem at this time.
34038
34039 For this reason, the recommended approach for &"mostly unprivileged"& running
34040 is to keep the Exim binary setuid to root, and to set
34041 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
34042 be used in the most straightforward way.
34043
34044 If you configure Exim not to run delivery processes as root, there are a
34045 number of restrictions on what you can do:
34046
34047 .ilist
34048 You can deliver only as the Exim user/group. You should  explicitly use the
34049 &%user%& and &%group%& options to override routers or local transports that
34050 normally deliver as the recipient. This makes sure that configurations that
34051 work in this mode function the same way in normal mode. Any implicit or
34052 explicit specification of another user causes an error.
34053 .next
34054 Use of &_.forward_& files is severely restricted, such that it is usually
34055 not worthwhile to include them in the configuration.
34056 .next
34057 Users who wish to use &_.forward_& would have to make their home directory and
34058 the file itself accessible to the Exim user. Pipe and append-to-file entries,
34059 and their equivalents in Exim filters, cannot be used. While they could be
34060 enabled in the Exim user's name, that would be insecure and not very useful.
34061 .next
34062 Unless the local user mailboxes are all owned by the Exim user (possible in
34063 some POP3 or IMAP-only environments):
34064
34065 .olist
34066 They must be owned by the Exim group and be writeable by that group. This
34067 implies you must set &%mode%& in the appendfile configuration, as well as the
34068 mode of the mailbox files themselves.
34069 .next
34070 You must set &%no_check_owner%&, since most or all of the files will not be
34071 owned by the Exim user.
34072 .next
34073 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
34074 on a newly created mailbox when unprivileged. This also implies that new
34075 mailboxes need to be created manually.
34076 .endlist olist
34077 .endlist ilist
34078
34079
34080 These restrictions severely restrict what can be done in local deliveries.
34081 However, there are no restrictions on remote deliveries. If you are running a
34082 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
34083 gives more security at essentially no cost.
34084
34085 If you are using the &%mua_wrapper%& facility (see chapter
34086 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
34087
34088
34089
34090
34091 .section "Delivering to local files" "SECID271"
34092 Full details of the checks applied by &(appendfile)& before it writes to a file
34093 are given in chapter &<<CHAPappendfile>>&.
34094
34095
34096
34097 .section "IPv4 source routing" "SECID272"
34098 .cindex "source routing" "in IP packets"
34099 .cindex "IP source routing"
34100 Many operating systems suppress IP source-routed packets in the kernel, but
34101 some cannot be made to do this, so Exim does its own check. It logs incoming
34102 IPv4 source-routed TCP calls, and then drops them. Things are all different in
34103 IPv6. No special checking is currently done.
34104
34105
34106
34107 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
34108 Support for these SMTP commands is disabled by default. If required, they can
34109 be enabled by defining suitable ACLs.
34110
34111
34112
34113
34114 .section "Privileged users" "SECID274"
34115 .cindex "trusted users"
34116 .cindex "admin user"
34117 .cindex "privileged user"
34118 .cindex "user" "trusted"
34119 .cindex "user" "admin"
34120 Exim recognizes two sets of users with special privileges. Trusted users are
34121 able to submit new messages to Exim locally, but supply their own sender
34122 addresses and information about a sending host. For other users submitting
34123 local messages, Exim sets up the sender address from the uid, and doesn't
34124 permit a remote host to be specified.
34125
34126 .oindex "&%-f%&"
34127 However, an untrusted user is permitted to use the &%-f%& command line option
34128 in the special form &%-f <>%& to indicate that a delivery failure for the
34129 message should not cause an error report. This affects the message's envelope,
34130 but it does not affect the &'Sender:'& header. Untrusted users may also be
34131 permitted to use specific forms of address with the &%-f%& option by setting
34132 the &%untrusted_set_sender%& option.
34133
34134 Trusted users are used to run processes that receive mail messages from some
34135 other mail domain and pass them on to Exim for delivery either locally, or over
34136 the Internet. Exim trusts a caller that is running as root, as the Exim user,
34137 as any user listed in the &%trusted_users%& configuration option, or under any
34138 group listed in the &%trusted_groups%& option.
34139
34140 Admin users are permitted to do things to the messages on Exim's queue. They
34141 can freeze or thaw messages, cause them to be returned to their senders, remove
34142 them entirely, or modify them in various ways. In addition, admin users can run
34143 the Exim monitor and see all the information it is capable of providing, which
34144 includes the contents of files on the spool.
34145
34146 .oindex "&%-M%&"
34147 .oindex "&%-q%&"
34148 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
34149 delivery of messages on its queue is restricted to admin users. This
34150 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
34151 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
34152 queue is also restricted to admin users. This restriction can be relaxed by
34153 setting &%no_queue_list_requires_admin%&.
34154
34155 Exim recognizes an admin user if the calling process is running as root or as
34156 the Exim user or if any of the groups associated with the calling process is
34157 the Exim group. It is not necessary actually to be running under the Exim
34158 group. However, if admin users who are not root or the Exim user are to access
34159 the contents of files on the spool via the Exim monitor (which runs
34160 unprivileged), Exim must be built to allow group read access to its spool
34161 files.
34162
34163
34164
34165 .section "Spool files" "SECID275"
34166 .cindex "spool directory" "files"
34167 Exim's spool directory and everything it contains is owned by the Exim user and
34168 set to the Exim group. The mode for spool files is defined in the
34169 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
34170 any user who is a member of the Exim group can access these files.
34171
34172
34173
34174 .section "Use of argv[0]" "SECID276"
34175 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
34176 of specific strings, Exim assumes certain options. For example, calling Exim
34177 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
34178 to calling it with the option &%-bS%&. There are no security implications in
34179 this.
34180
34181
34182
34183 .section "Use of %f formatting" "SECID277"
34184 The only use made of &"%f"& by Exim is in formatting load average values. These
34185 are actually stored in integer variables as 1000 times the load average.
34186 Consequently, their range is limited and so therefore is the length of the
34187 converted output.
34188
34189
34190
34191 .section "Embedded Exim path" "SECID278"
34192 Exim uses its own path name, which is embedded in the code, only when it needs
34193 to re-exec in order to regain root privilege. Therefore, it is not root when it
34194 does so. If some bug allowed the path to get overwritten, it would lead to an
34195 arbitrary program's being run as exim, not as root.
34196
34197
34198
34199 .section "Use of sprintf()" "SECID279"
34200 .cindex "&[sprintf()]&"
34201 A large number of occurrences of &"sprintf"& in the code are actually calls to
34202 &'string_sprintf()'&, a function that returns the result in malloc'd store.
34203 The intermediate formatting is done into a large fixed buffer by a function
34204 that runs through the format string itself, and checks the length of each
34205 conversion before performing it, thus preventing buffer overruns.
34206
34207 The remaining uses of &[sprintf()]& happen in controlled circumstances where
34208 the output buffer is known to be sufficiently long to contain the converted
34209 string.
34210
34211
34212
34213 .section "Use of debug_printf() and log_write()" "SECID280"
34214 Arbitrary strings are passed to both these functions, but they do their
34215 formatting by calling the function &'string_vformat()'&, which runs through
34216 the format string itself, and checks the length of each conversion.
34217
34218
34219
34220 .section "Use of strcat() and strcpy()" "SECID281"
34221 These are used only in cases where the output buffer is known to be large
34222 enough to hold the result.
34223 .ecindex IIDsecurcon
34224
34225
34226
34227
34228 . ////////////////////////////////////////////////////////////////////////////
34229 . ////////////////////////////////////////////////////////////////////////////
34230
34231 .chapter "Format of spool files" "CHAPspool"
34232 .scindex IIDforspo1 "format" "spool files"
34233 .scindex IIDforspo2 "spool directory" "format of files"
34234 .scindex IIDforspo3 "spool files" "format of"
34235 .cindex "spool files" "editing"
34236 A message on Exim's queue consists of two files, whose names are the message id
34237 followed by -D and -H, respectively. The data portion of the message is kept in
34238 the -D file on its own. The message's envelope, status, and headers are all
34239 kept in the -H file, whose format is described in this chapter. Each of these
34240 two files contains the final component of its own name as its first line. This
34241 is insurance against disk crashes where the directory is lost but the files
34242 themselves are recoverable.
34243
34244 Some people are tempted into editing -D files in order to modify messages. You
34245 need to be extremely careful if you do this; it is not recommended and you are
34246 on your own if you do it. Here are some of the pitfalls:
34247
34248 .ilist
34249 You must ensure that Exim does not try to deliver the message while you are
34250 fiddling with it. The safest way is to take out a write lock on the -D file,
34251 which is what Exim itself does, using &[fcntl()]&. If you update the file in
34252 place, the lock will be retained. If you write a new file and rename it, the
34253 lock will be lost at the instant of rename.
34254 .next
34255 .vindex "&$body_linecount$&"
34256 If you change the number of lines in the file, the value of
34257 &$body_linecount$&, which is stored in the -H file, will be incorrect. At
34258 present, this value is not used by Exim, but there is no guarantee that this
34259 will always be the case.
34260 .next
34261 If the message is in MIME format, you must take care not to break it.
34262 .next
34263 If the message is cryptographically signed, any change will invalidate the
34264 signature.
34265 .endlist
34266 All in all, modifying -D files is fraught with danger.
34267
34268 Files whose names end with -J may also be seen in the &_input_& directory (or
34269 its subdirectories when &%split_spool_directory%& is set). These are journal
34270 files, used to record addresses to which the message has been delivered during
34271 the course of a delivery attempt. If there are still undelivered recipients at
34272 the end, the -H file is updated, and the -J file is deleted. If, however, there
34273 is some kind of crash (for example, a power outage) before this happens, the -J
34274 file remains in existence. When Exim next processes the message, it notices the
34275 -J file and uses it to update the -H file before starting the next delivery
34276 attempt.
34277
34278 .section "Format of the -H file" "SECID282"
34279 .cindex "uid (user id)" "in spool file"
34280 .cindex "gid (group id)" "in spool file"
34281 The second line of the -H file contains the login name for the uid of the
34282 process that called Exim to read the message, followed by the numerical uid and
34283 gid. For a locally generated message, this is normally the user who sent the
34284 message. For a message received over TCP/IP via the daemon, it is
34285 normally the Exim user.
34286
34287 The third line of the file contains the address of the message's sender as
34288 transmitted in the envelope, contained in angle brackets. The sender address is
34289 empty for bounce messages. For incoming SMTP mail, the sender address is given
34290 in the MAIL command. For locally generated mail, the sender address is
34291 created by Exim from the login name of the current user and the configured
34292 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
34293 leading &"From&~"& line if the caller is trusted, or if the supplied address is
34294 &"<>"& or an address that matches &%untrusted_set_senders%&.
34295
34296 The fourth line contains two numbers. The first is the time that the message
34297 was received, in the conventional Unix form &-- the number of seconds since the
34298 start of the epoch. The second number is a count of the number of messages
34299 warning of delayed delivery that have been sent to the sender.
34300
34301 There follow a number of lines starting with a hyphen. These can appear in any
34302 order, and are omitted when not relevant:
34303
34304 .vlist
34305 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
34306 This item is obsolete, and is not generated from Exim release 4.61 onwards;
34307 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
34308 recognized, to provide backward compatibility. In the old format, a line of
34309 this form is present for every ACL variable that is not empty. The number
34310 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
34311 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
34312 the data string for the variable. The string itself starts at the beginning of
34313 the next line, and is followed by a newline character. It may contain internal
34314 newlines.
34315
34316 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
34317 A line of this form is present for every ACL connection variable that is
34318 defined. Note that there is a space between &%-aclc%& and the rest of the name.
34319 The length is the length of the data string for the variable. The string itself
34320 starts at the beginning of the next line, and is followed by a newline
34321 character. It may contain internal newlines.
34322
34323 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
34324 A line of this form is present for every ACL message variable that is defined.
34325 Note that there is a space between &%-aclm%& and the rest of the name. The
34326 length is the length of the data string for the variable. The string itself
34327 starts at the beginning of the next line, and is followed by a newline
34328 character. It may contain internal newlines.
34329
34330 .vitem "&%-active_hostname%&&~<&'hostname'&>"
34331 This is present if, when the message was received over SMTP, the value of
34332 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
34333
34334 .vitem &%-allow_unqualified_recipient%&
34335 This is present if unqualified recipient addresses are permitted in header
34336 lines (to stop such addresses from being qualified if rewriting occurs at
34337 transport time). Local messages that were input using &%-bnq%& and remote
34338 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
34339
34340 .vitem &%-allow_unqualified_sender%&
34341 This is present if unqualified sender addresses are permitted in header lines
34342 (to stop such addresses from being qualified if rewriting occurs at transport
34343 time). Local messages that were input using &%-bnq%& and remote messages from
34344 hosts that match &%sender_unqualified_hosts%& set this flag.
34345
34346 .vitem "&%-auth_id%&&~<&'text'&>"
34347 The id information for a message received on an authenticated SMTP connection
34348 &-- the value of the &$authenticated_id$& variable.
34349
34350 .vitem "&%-auth_sender%&&~<&'address'&>"
34351 The address of an authenticated sender &-- the value of the
34352 &$authenticated_sender$& variable.
34353
34354 .vitem "&%-body_linecount%&&~<&'number'&>"
34355 This records the number of lines in the body of the message, and is always
34356 present.
34357
34358 .vitem "&%-body_zerocount%&&~<&'number'&>"
34359 This records the number of binary zero bytes in the body of the message, and is
34360 present if the number is greater than zero.
34361
34362 .vitem &%-deliver_firsttime%&
34363 This is written when a new message is first added to the spool. When the spool
34364 file is updated after a deferral, it is omitted.
34365
34366 .vitem "&%-frozen%&&~<&'time'&>"
34367 .cindex "frozen messages" "spool data"
34368 The message is frozen, and the freezing happened at <&'time'&>.
34369
34370 .vitem "&%-helo_name%&&~<&'text'&>"
34371 This records the host name as specified by a remote host in a HELO or EHLO
34372 command.
34373
34374 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
34375 This records the IP address of the host from which the message was received and
34376 the remote port number that was used. It is omitted for locally generated
34377 messages.
34378
34379 .vitem "&%-host_auth%&&~<&'text'&>"
34380 If the message was received on an authenticated SMTP connection, this records
34381 the name of the authenticator &-- the value of the
34382 &$sender_host_authenticated$& variable.
34383
34384 .vitem &%-host_lookup_failed%&
34385 This is present if an attempt to look up the sending host's name from its IP
34386 address failed. It corresponds to the &$host_lookup_failed$& variable.
34387
34388 .vitem "&%-host_name%&&~<&'text'&>"
34389 .cindex "reverse DNS lookup"
34390 .cindex "DNS" "reverse lookup"
34391 This records the name of the remote host from which the message was received,
34392 if the host name was looked up from the IP address when the message was being
34393 received. It is not present if no reverse lookup was done.
34394
34395 .vitem "&%-ident%&&~<&'text'&>"
34396 For locally submitted messages, this records the login of the originating user,
34397 unless it was a trusted user and the &%-oMt%& option was used to specify an
34398 ident value. For messages received over TCP/IP, this records the ident string
34399 supplied by the remote host, if any.
34400
34401 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
34402 This records the IP address of the local interface and the port number through
34403 which a message was received from a remote host. It is omitted for locally
34404 generated messages.
34405
34406 .vitem &%-local%&
34407 The message is from a local sender.
34408
34409 .vitem &%-localerror%&
34410 The message is a locally-generated bounce message.
34411
34412 .vitem "&%-local_scan%&&~<&'string'&>"
34413 This records the data string that was returned by the &[local_scan()]& function
34414 when the message was received &-- the value of the &$local_scan_data$&
34415 variable. It is omitted if no data was returned.
34416
34417 .vitem &%-manual_thaw%&
34418 The message was frozen but has been thawed manually, that is, by an explicit
34419 Exim command rather than via the auto-thaw process.
34420
34421 .vitem &%-N%&
34422 A testing delivery process was started using the &%-N%& option to suppress any
34423 actual deliveries, but delivery was deferred. At any further delivery attempts,
34424 &%-N%& is assumed.
34425
34426 .vitem &%-received_protocol%&
34427 This records the value of the &$received_protocol$& variable, which contains
34428 the name of the protocol by which the message was received.
34429
34430 .vitem &%-sender_set_untrusted%&
34431 The envelope sender of this message was set by an untrusted local caller (used
34432 to ensure that the caller is displayed in queue listings).
34433
34434 .vitem "&%-spam_score_int%&&~<&'number'&>"
34435 If a message was scanned by SpamAssassin, this is present. It records the value
34436 of &$spam_score_int$&.
34437
34438 .vitem &%-tls_certificate_verified%&
34439 A TLS certificate was received from the client that sent this message, and the
34440 certificate was verified by the server.
34441
34442 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
34443 When the message was received over an encrypted connection, this records the
34444 name of the cipher suite that was used.
34445
34446 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
34447 When the message was received over an encrypted connection, and a certificate
34448 was received from the client, this records the Distinguished Name from that
34449 certificate.
34450 .endlist
34451
34452 Following the options there is a list of those addresses to which the message
34453 is not to be delivered. This set of addresses is initialized from the command
34454 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
34455 is set; otherwise it starts out empty. Whenever a successful delivery is made,
34456 the address is added to this set. The addresses are kept internally as a
34457 balanced binary tree, and it is a representation of that tree which is written
34458 to the spool file. If an address is expanded via an alias or forward file, the
34459 original address is added to the tree when deliveries to all its child
34460 addresses are complete.
34461
34462 If the tree is empty, there is a single line in the spool file containing just
34463 the text &"XX"&. Otherwise, each line consists of two letters, which are either
34464 Y or N, followed by an address. The address is the value for the node of the
34465 tree, and the letters indicate whether the node has a left branch and/or a
34466 right branch attached to it, respectively. If branches exist, they immediately
34467 follow. Here is an example of a three-node tree:
34468 .code
34469 YY darcy@austen.fict.example
34470 NN alice@wonderland.fict.example
34471 NN editor@thesaurus.ref.example
34472 .endd
34473 After the non-recipients tree, there is a list of the message's recipients.
34474 This is a simple list, preceded by a count. It includes all the original
34475 recipients of the message, including those to whom the message has already been
34476 delivered. In the simplest case, the list contains one address per line. For
34477 example:
34478 .code
34479 4
34480 editor@thesaurus.ref.example
34481 darcy@austen.fict.example
34482 rdo@foundation
34483 alice@wonderland.fict.example
34484 .endd
34485 However, when a child address has been added to the top-level addresses as a
34486 result of the use of the &%one_time%& option on a &(redirect)& router, each
34487 line is of the following form:
34488 .display
34489 <&'top-level address'&> <&'errors_to address'&> &&&
34490   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
34491 .endd
34492 The 01 flag bit indicates the presence of the three other fields that follow
34493 the top-level address. Other bits may be used in future to support additional
34494 fields. The <&'parent number'&> is the offset in the recipients list of the
34495 original parent of the &"one time"& address. The first two fields are the
34496 envelope sender that is associated with this address and its length. If the
34497 length is zero, there is no special envelope sender (there are then two space
34498 characters in the line). A non-empty field can arise from a &(redirect)& router
34499 that has an &%errors_to%& setting.
34500
34501
34502 A blank line separates the envelope and status information from the headers
34503 which follow. A header may occupy several lines of the file, and to save effort
34504 when reading it in, each header is preceded by a number and an identifying
34505 character. The number is the number of characters in the header, including any
34506 embedded newlines and the terminating newline. The character is one of the
34507 following:
34508
34509 .table2 50pt
34510 .row <&'blank'&>         "header in which Exim has no special interest"
34511 .row &`B`&               "&'Bcc:'& header"
34512 .row &`C`&               "&'Cc:'& header"
34513 .row &`F`&               "&'From:'& header"
34514 .row &`I`&               "&'Message-id:'& header"
34515 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
34516 .row &`R`&               "&'Reply-To:'& header"
34517 .row &`S`&               "&'Sender:'& header"
34518 .row &`T`&               "&'To:'& header"
34519 .row &`*`&               "replaced or deleted header"
34520 .endtable
34521
34522 Deleted or replaced (rewritten) headers remain in the spool file for debugging
34523 purposes. They are not transmitted when the message is delivered. Here is a
34524 typical set of headers:
34525 .code
34526 111P Received: by hobbit.fict.example with local (Exim 4.00)
34527 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
34528 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
34529 038* X-rewrote-sender: bb@hobbit.fict.example
34530 042* From: Bilbo Baggins <bb@hobbit.fict.example>
34531 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
34532 099* To: alice@wonderland.fict.example, rdo@foundation,
34533 darcy@austen.fict.example, editor@thesaurus.ref.example
34534 104T To: alice@wonderland.fict.example, rdo@foundation.example,
34535 darcy@austen.fict.example, editor@thesaurus.ref.example
34536 038  Date: Fri, 11 May 2001 10:28:59 +0100
34537 .endd
34538 The asterisked headers indicate that the envelope sender, &'From:'& header, and
34539 &'To:'& header have been rewritten, the last one because routing expanded the
34540 unqualified domain &'foundation'&.
34541 .ecindex IIDforspo1
34542 .ecindex IIDforspo2
34543 .ecindex IIDforspo3
34544
34545 . ////////////////////////////////////////////////////////////////////////////
34546 . ////////////////////////////////////////////////////////////////////////////
34547
34548 .chapter "Support for DKIM (DomainKeys Identified Mail) - RFC4871" "CHID12" &&&
34549          "DKIM Support"
34550 .cindex "DKIM"
34551
34552 Since version 4.70, DKIM support is compiled into Exim by default. It can be
34553 disabled by setting DISABLE_DKIM=yes in Local/Makefile.
34554
34555 Exim's DKIM implementation allows to
34556 .olist
34557 Sign outgoing messages: This function is implemented in the SMTP transport.
34558 It can co-exist with all other Exim features, including transport filters.
34559 .next
34560 Verify signatures in incoming messages: This is implemented by an additional
34561 ACL (acl_smtp_dkim), which can be called several times per message, with
34562 different signature contexts.
34563 .endlist
34564
34565 In typical Exim style, the verification implementation does not include any
34566 default "policy". Instead it enables you to build your own policy using
34567 Exim's standard controls.
34568
34569 Please note that verification of DKIM signatures in incoming mail is turned
34570 on by default for logging purposes. For each signature in incoming email,
34571 exim will log a line displaying the most important signature details, and the
34572 signature status. Here is an example:
34573 .code
34574 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]
34575 .endd
34576 You might want to turn off DKIM verification processing entirely for internal
34577 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
34578 control modifier. This should typically be done in the RCPT ACL, at points
34579 where you accept mail from relay sources (internal hosts or authenticated
34580 senders).
34581
34582
34583 .section "Signing outgoing messages" "SECID513"
34584 .cindex "DKIM" "signing"
34585
34586 Signing is implemented by setting private options on the SMTP transport.
34587 These options take (expandable) strings as arguments.
34588
34589 .option dkim_domain smtp string&!! unset
34590 MANDATORY:
34591 The domain you want to sign with. The result of this expanded
34592 option is put into the &%$dkim_domain%& expansion variable.
34593
34594 .option dkim_selector smtp string&!! unset
34595 MANDATORY:
34596 This sets the key selector string. You can use the &%$dkim_domain%& expansion
34597 variable to look up a matching selector. The result is put in the expansion
34598 variable &%$dkim_selector%& which should be used in the &%dkim_private_key%&
34599 option along with &%$dkim_domain%&.
34600
34601 .option dkim_private_key smtp string&!! unset
34602 MANDATORY:
34603 This sets the private key to use. You can use the &%$dkim_domain%& and
34604 &%$dkim_selector%& expansion variables to determine the private key to use.
34605 The result can either
34606 .ilist
34607 be a valid RSA private key in ASCII armor, including line breaks.
34608 .next
34609 start with a slash, in which case it is treated as a file that contains
34610 the private key.
34611 .next
34612 be "0", "false" or the empty string, in which case the message will not
34613 be signed. This case will not result in an error, even if &%dkim_strict%&
34614 is set.
34615 .endlist
34616
34617 .option dkim_canon smtp string&!! unset
34618 OPTIONAL:
34619 This option sets the canonicalization method used when signing a message.
34620 The DKIM RFC currently supports two methods: "simple" and "relaxed".
34621 The option defaults to "relaxed" when unset. Note: the current implementation
34622 only supports using the same canonicalization method for both headers and body.
34623
34624 .option dkim_strict smtp string&!! unset
34625 OPTIONAL:
34626 This  option  defines  how  Exim  behaves  when  signing a message that
34627 should be signed fails for some reason.  When the expansion evaluates to
34628 either "1" or "true", Exim will defer. Otherwise Exim will send the message
34629 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
34630 variables here.
34631
34632 .option dkim_sign_headers smtp string&!! unset
34633 OPTIONAL:
34634 When set, this option must expand to (or be specified as) a colon-separated
34635 list of header names. Headers with these names will be included in the message
34636 signature. When unspecified, the header names recommended in RFC4871 will be
34637 used.
34638
34639
34640 .section "Verifying DKIM signatures in incoming mail" "SECID514"
34641 .cindex "DKIM" "verification"
34642
34643 Verification of DKIM signatures in incoming email is implemented via the
34644 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
34645 syntactically(!) correct signature in the incoming message.
34646
34647 To evaluate the signature in the ACL a large number of expansion variables
34648 containing the signature status and its details are set up during the
34649 runtime of the ACL.
34650
34651 Calling the ACL only for existing signatures is not sufficient to build
34652 more advanced policies. For that reason, the global option
34653 &%dkim_verify_signers%&, and a global expansion variable
34654 &%$dkim_signers%& exist.
34655
34656 The global option &%dkim_verify_signers%& can be set to a colon-separated
34657 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
34658 called. It is expanded when the message has been received. At this point,
34659 the expansion variable &%$dkim_signers%& already contains a colon-separated
34660 list of signer domains and identities for the message. When
34661 &%dkim_verify_signers%& is not specified in the main configuration,
34662 it defaults as:
34663 .code
34664 dkim_verify_signers = $dkim_signers
34665 .endd
34666 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
34667 DKIM signature in the message. Current DKIM verifiers may want to explicitly
34668 call the ACL for known domains or identities. This would be achieved as follows:
34669 .code
34670 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
34671 .endd
34672 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
34673 and "ebay.com", plus all domains and identities that have signatures in the message.
34674 You can also be more creative in constructing your policy. For example:
34675 .code
34676 dkim_verify_signers = $sender_address_domain:$dkim_signers
34677 .endd
34678
34679 If a domain or identity is listed several times in the (expanded) value of
34680 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
34681
34682
34683 Inside the &%acl_smtp_dkim%&, the following expansion variables are
34684 available (from most to least important):
34685
34686 .vlist
34687 .vitem &%$dkim_cur_signer%&
34688 The signer that is being evaluated in this ACL run. This can be a domain or
34689 an identity. This is one of the list items from the expanded main option
34690 &%dkim_verify_signers%& (see above).
34691 .vitem &%$dkim_verify_status%&
34692 A string describing the general status of the signature. One of
34693 .ilist
34694 &%none%&: There is no signature in the message for the current domain or
34695 identity (as reflected by &%$dkim_cur_signer%&).
34696 .next
34697 &%invalid%&: The signature could not be verified due to a processing error.
34698 More detail is available in &%$dkim_verify_reason%&.
34699 .next
34700 &%fail%&: Verification of the signature failed.  More detail is
34701 available in &%$dkim_verify_reason%&.
34702 .next
34703 &%pass%&: The signature passed verification. It is valid.
34704 .endlist
34705 .vitem &%$dkim_verify_reason%&
34706 A string giving a litte bit more detail when &%$dkim_verify_status%& is either
34707 "fail" or "invalid". One of
34708 .ilist
34709 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
34710 key for the domain could not be retrieved. This may be a temporary problem.
34711 .next
34712 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
34713 record for the domain is syntactically invalid.
34714 .next
34715 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
34716 body hash does not match the one specified in the signature header. This
34717 means that the message body was modified in transit.
34718 .next
34719 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
34720 could not be verified. This may mean that headers were modified,
34721 re-written or otherwise changed in a way which is incompatible with
34722 DKIM verification. It may of course also mean that the signature is forged.
34723 .endlist
34724 .vitem &%$dkim_domain%&
34725 The signing domain. IMPORTANT: This variable is only populated if there is
34726 an actual signature in the message for the current domain or identity (as
34727 reflected by &%$dkim_cur_signer%&).
34728 .vitem &%$dkim_identity%&
34729 The signing identity, if present. IMPORTANT: This variable is only populated
34730 if there is an actual signature in the message for the current domain or
34731 identity (as reflected by &%$dkim_cur_signer%&).
34732 .vitem &%$dkim_selector%&
34733 The key record selector string.
34734 .vitem &%$dkim_algo%&
34735 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
34736 .vitem &%$dkim_canon_body%&
34737 The body canonicalization method. One of 'relaxed' or 'simple'.
34738 .vitem &%dkim_canon_headers%&
34739 The header canonicalization method. One of 'relaxed' or 'simple'.
34740 .vitem &%$dkim_copiedheaders%&
34741 A transcript of headers and their values which are included in the signature
34742 (copied from the 'z=' tag of the signature).
34743 .vitem &%$dkim_bodylength%&
34744 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
34745 limit was set by the signer, "9999999999999" is returned. This makes sure
34746 that this variable always expands to an integer value.
34747 .vitem &%$dkim_created%&
34748 UNIX timestamp reflecting the date and time when the signature was created.
34749 When this was not specified by the signer, "0" is returned.
34750 .vitem &%$dkim_expires%&
34751 UNIX timestamp reflecting the date and time when the signer wants the
34752 signature to be treated as "expired". When this was not specified by the
34753 signer, "9999999999999" is returned. This makes it possible to do useful
34754 integer size comparisons against this value.
34755 .vitem &%$dkim_headernames%&
34756 A colon-separated list of names of headers included in the signature.
34757 .vitem &%$dkim_key_testing%&
34758 "1" if the key record has the "testing" flag set, "0" if not.
34759 .vitem &%$dkim_key_nosubdomaining%&
34760 "1" if the key record forbids subdomaining, "0" otherwise.
34761 .vitem &%$dkim_key_srvtype%&
34762 Service type (tag s=) from the key record. Defaults to "*" if not specified
34763 in the key record.
34764 .vitem &%$dkim_key_granularity%&
34765 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
34766 in the key record.
34767 .vitem &%$dkim_key_notes%&
34768 Notes from the key record (tag n=).
34769 .endlist
34770
34771 In addition, two ACL conditions are provided:
34772
34773 .vlist
34774 .vitem &%dkim_signers%&
34775 ACL condition that checks a colon-separated list of domains or identities
34776 for a match against the domain or identity that the ACL is currently verifying
34777 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
34778 verb to a group of domains or identities. For example:
34779
34780 .code
34781 # Warn when message apparently from GMail has no signature at all
34782 warn log_message = GMail sender without DKIM signature
34783      sender_domains = gmail.com
34784      dkim_signers = gmail.com
34785      dkim_status = none
34786 .endd
34787
34788 .vitem &%dkim_status%&
34789 ACL condition that checks a colon-separated list of possible DKIM verification
34790 results agains the actual result of verification. This is typically used
34791 to restrict an ACL verb to a list of verification outcomes, like:
34792
34793 .code
34794 deny message = Message from Paypal with invalid or missing signature
34795      sender_domains = paypal.com:paypal.de
34796      dkim_signers = paypal.com:paypal.de
34797      dkim_status = none:invalid:fail
34798 .endd
34799
34800 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
34801 see the documentation of the &%$dkim_verify_status%& expansion variable above
34802 for more information of what they mean.
34803 .endlist
34804
34805 . ////////////////////////////////////////////////////////////////////////////
34806 . ////////////////////////////////////////////////////////////////////////////
34807
34808 .chapter "Adding new drivers or lookup types" "CHID13" &&&
34809          "Adding drivers or lookups"
34810 .cindex "adding drivers"
34811 .cindex "new drivers, adding"
34812 .cindex "drivers" "adding new"
34813 The following actions have to be taken in order to add a new router, transport,
34814 authenticator, or lookup type to Exim:
34815
34816 .olist
34817 Choose a name for the driver or lookup type that does not conflict with any
34818 existing name; I will use &"newdriver"& in what follows.
34819 .next
34820 Add to &_src/EDITME_& the line:
34821 .display
34822 <&'type'&>&`_NEWDRIVER=yes`&
34823 .endd
34824 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
34825 code is not to be included in the binary by default, comment this line out. You
34826 should also add any relevant comments about the driver or lookup type.
34827 .next
34828 Add to &_src/config.h.defaults_& the line:
34829 .code
34830 #define <type>_NEWDRIVER
34831 .endd
34832 .next
34833 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
34834 and create a table entry as is done for all the other drivers and lookup types.
34835 .next
34836 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
34837 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
34838 driver or lookup type and add it to the definition of OBJ.
34839 .next
34840 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
34841 &_src_&.
34842 .next
34843 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
34844 as for other drivers and lookups.
34845 .endlist
34846
34847 Then all you need to do is write the code! A good way to start is to make a
34848 proforma by copying an existing module of the same type, globally changing all
34849 occurrences of the name, and cutting out most of the code. Note that any
34850 options you create must be listed in alphabetical order, because the tables are
34851 searched using a binary chop procedure.
34852
34853 There is a &_README_& file in each of the sub-directories of &_src_& describing
34854 the interface that is expected.
34855
34856
34857
34858
34859 . ////////////////////////////////////////////////////////////////////////////
34860 . ////////////////////////////////////////////////////////////////////////////
34861
34862 . /////////////////////////////////////////////////////////////////////////////
34863 . These lines are processing instructions for the Simple DocBook Processor that
34864 . Philip Hazel has developed as a less cumbersome way of making PostScript and
34865 . PDFs than using xmlto and fop. They will be ignored by all other XML
34866 . processors.
34867 . /////////////////////////////////////////////////////////////////////////////
34868
34869 .literal xml
34870 <?sdop
34871   format="newpage"
34872   foot_right_recto="&chaptertitle;"
34873   foot_right_verso="&chaptertitle;"
34874 ?>
34875 .literal off
34876
34877 .makeindex "Options index"   "option"
34878 .makeindex "Variables index" "variable"
34879 .makeindex "Concept index"   "concept"
34880
34881
34882 . /////////////////////////////////////////////////////////////////////////////
34883 . /////////////////////////////////////////////////////////////////////////////