22815a9d1da606578a0ee846fc52d44f55d711d0
[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.71"
51 .set version "4.72"
52
53 .set ACL "access control lists (ACLs)"
54 .set I   "&nbsp;&nbsp;&nbsp;&nbsp;"
55
56
57 . /////////////////////////////////////////////////////////////////////////////
58 . Additional xfpt markup used by this document, over and above the default
59 . provided in the xfpt library.
60 . /////////////////////////////////////////////////////////////////////////////
61
62 . --- Override the &$ flag to automatically insert a $ with the variable name
63
64 .flag &$  $&   "<varname>$"  "</varname>"
65
66 . --- Short flags for daggers in option headings. They will always be inside
67 . --- an italic string, but we want the daggers to be roman.
68
69 .flag &!!      "</emphasis>&dagger;<emphasis>"
70 .flag &!?      "</emphasis>&Dagger;<emphasis>"
71
72 . --- A macro for an Exim option definition heading, generating a one-line
73 . --- table with four columns. For cases when the option name is given with
74 . --- a space, so that it can be split, a fifth argument is used for the
75 . --- index entry.
76
77 .macro option
78 .arg 5
79 .oindex "&%$5%&"
80 .endarg
81 .arg -5
82 .oindex "&%$1%&"
83 .endarg
84 .itable all 0 0 4 8* left 6* center 6* center 6* right
85 .row "&%$1%&" "Use: &'$2'&" "Type: &'$3'&" "Default: &'$4'&"
86 .endtable
87 .endmacro
88
89 . --- A macro for the common 2-column tables. The width of the first column
90 . --- is suitable for the many tables at the start of the main options chapter;
91 . --- the small number of other 2-column tables override it.
92
93 .macro table2 196pt 254pt
94 .itable none 0 0 2 $1 left $2 left
95 .endmacro
96
97 . --- A macro that generates .row, but puts &I; at the start of the first
98 . --- argument, thus indenting it. Assume a minimum of two arguments, and
99 . --- allow up to four arguments, which is as many as we'll ever need.
100
101 .macro irow
102 .arg 4
103 .row "&I;$1" "$2" "$3" "$4"
104 .endarg
105 .arg -4
106 .arg 3
107 .row "&I;$1" "$2" "$3"
108 .endarg
109 .arg -3
110 .row "&I;$1" "$2"
111 .endarg
112 .endarg
113 .endmacro
114
115 . --- Macros for option, variable, and concept index entries. For a "range"
116 . --- style of entry, use .scindex for the start and .ecindex for the end. The
117 . --- first argument of .scindex and the only argument of .ecindex must be the
118 . --- ID that ties them together.
119
120 .macro cindex
121 &<indexterm role="concept">&
122 &<primary>&$1&</primary>&
123 .arg 2
124 &<secondary>&$2&</secondary>&
125 .endarg
126 &</indexterm>&
127 .endmacro
128
129 .macro scindex
130 &<indexterm role="concept" id="$1" class="startofrange">&
131 &<primary>&$2&</primary>&
132 .arg 3
133 &<secondary>&$3&</secondary>&
134 .endarg
135 &</indexterm>&
136 .endmacro
137
138 .macro ecindex
139 &<indexterm role="concept" startref="$1" class="endofrange"/>&
140 .endmacro
141
142 .macro oindex
143 &<indexterm role="option">&
144 &<primary>&$1&</primary>&
145 .arg 2
146 &<secondary>&$2&</secondary>&
147 .endarg
148 &</indexterm>&
149 .endmacro
150
151 .macro vindex
152 &<indexterm role="variable">&
153 &<primary>&$1&</primary>&
154 .arg 2
155 &<secondary>&$2&</secondary>&
156 .endarg
157 &</indexterm>&
158 .endmacro
159
160 .macro index
161 .echo "** Don't use .index; use .cindex or .oindex or .vindex"
162 .endmacro
163 . ////////////////////////////////////////////////////////////////////////////
164
165
166 . ////////////////////////////////////////////////////////////////////////////
167 . The <bookinfo> element is removed from the XML before processing for Ascii
168 . output formats.
169 . ////////////////////////////////////////////////////////////////////////////
170
171 .literal xml
172 <bookinfo>
173 <title>Specification of the Exim Mail Transfer Agent</title>
174 <titleabbrev>The Exim MTA</titleabbrev>
175 <date>29 May 2010</date>
176 <author><firstname>Exim</firstname><surname>Maintainers</surname></author>
177 <authorinitials>EM</authorinitials>
178 <revhistory><revision>
179   <revnumber>4.72</revnumber>
180   <date>29 May 2010</date>
181   <authorinitials>EM</authorinitials>
182 </revision></revhistory>
183 <copyright><year>2009</year><holder>University of Cambridge</holder></copyright>
184 </bookinfo>
185 .literal off
186
187
188 . /////////////////////////////////////////////////////////////////////////////
189 . This chunk of literal XML implements index entries of the form "x, see y" and
190 . "x, see also y". However, the DocBook DTD doesn't allow <indexterm> entries
191 . at the top level, so we have to put the .chapter directive first.
192 . /////////////////////////////////////////////////////////////////////////////
193
194 .chapter "Introduction" "CHID1"
195 .literal xml
196
197 <indexterm role="variable">
198   <primary>$1, $2, etc.</primary>
199   <see><emphasis>numerical variables</emphasis></see>
200 </indexterm>
201 <indexterm role="concept">
202   <primary>address</primary>
203   <secondary>rewriting</secondary>
204   <see><emphasis>rewriting</emphasis></see>
205 </indexterm>
206 <indexterm role="concept">
207   <primary>Bounce Address Tag Validation</primary>
208   <see><emphasis>BATV</emphasis></see>
209 </indexterm>
210 <indexterm role="concept">
211   <primary>Client SMTP Authorization</primary>
212   <see><emphasis>CSA</emphasis></see>
213 </indexterm>
214 <indexterm role="concept">
215   <primary>CR character</primary>
216   <see><emphasis>carriage return</emphasis></see>
217 </indexterm>
218 <indexterm role="concept">
219   <primary>CRL</primary>
220   <see><emphasis>certificate revocation list</emphasis></see>
221 </indexterm>
222 <indexterm role="concept">
223   <primary>delivery</primary>
224   <secondary>failure report</secondary>
225   <see><emphasis>bounce message</emphasis></see>
226 </indexterm>
227 <indexterm role="concept">
228   <primary>dialup</primary>
229   <see><emphasis>intermittently connected hosts</emphasis></see>
230 </indexterm>
231 <indexterm role="concept">
232   <primary>exiscan</primary>
233   <see><emphasis>content scanning</emphasis></see>
234 </indexterm>
235 <indexterm role="concept">
236   <primary>failover</primary>
237   <see><emphasis>fallback</emphasis></see>
238 </indexterm>
239 <indexterm role="concept">
240   <primary>fallover</primary>
241   <see><emphasis>fallback</emphasis></see>
242 </indexterm>
243 <indexterm role="concept">
244   <primary>filter</primary>
245   <secondary>Sieve</secondary>
246   <see><emphasis>Sieve filter</emphasis></see>
247 </indexterm>
248 <indexterm role="concept">
249   <primary>ident</primary>
250   <see><emphasis>RFC 1413</emphasis></see>
251 </indexterm>
252 <indexterm role="concept">
253   <primary>LF character</primary>
254   <see><emphasis>linefeed</emphasis></see>
255 </indexterm>
256 <indexterm role="concept">
257   <primary>maximum</primary>
258   <seealso><emphasis>limit</emphasis></seealso>
259 </indexterm>
260 <indexterm role="concept">
261   <primary>monitor</primary>
262   <see><emphasis>Exim monitor</emphasis></see>
263 </indexterm>
264 <indexterm role="concept">
265   <primary>no_<emphasis>xxx</emphasis></primary>
266   <see>entry for xxx</see>
267 </indexterm>
268 <indexterm role="concept">
269   <primary>NUL</primary>
270   <see><emphasis>binary zero</emphasis></see>
271 </indexterm>
272 <indexterm role="concept">
273   <primary>passwd file</primary>
274   <see><emphasis>/etc/passwd</emphasis></see>
275 </indexterm>
276 <indexterm role="concept">
277   <primary>process id</primary>
278   <see><emphasis>pid</emphasis></see>
279 </indexterm>
280 <indexterm role="concept">
281   <primary>RBL</primary>
282   <see><emphasis>DNS list</emphasis></see>
283 </indexterm>
284 <indexterm role="concept">
285   <primary>redirection</primary>
286   <see><emphasis>address redirection</emphasis></see>
287 </indexterm>
288 <indexterm role="concept">
289   <primary>return path</primary>
290   <seealso><emphasis>envelope sender</emphasis></seealso>
291 </indexterm>
292 <indexterm role="concept">
293   <primary>scanning</primary>
294   <see><emphasis>content scanning</emphasis></see>
295 </indexterm>
296 <indexterm role="concept">
297   <primary>SSL</primary>
298   <see><emphasis>TLS</emphasis></see>
299 </indexterm>
300 <indexterm role="concept">
301   <primary>string</primary>
302   <secondary>expansion</secondary>
303   <see><emphasis>expansion</emphasis></see>
304 </indexterm>
305 <indexterm role="concept">
306   <primary>top bit</primary>
307   <see><emphasis>8-bit characters</emphasis></see>
308 </indexterm>
309 <indexterm role="concept">
310   <primary>variables</primary>
311   <see><emphasis>expansion, variables</emphasis></see>
312 </indexterm>
313 <indexterm role="concept">
314   <primary>zero, binary</primary>
315   <see><emphasis>binary zero</emphasis></see>
316 </indexterm>
317
318 .literal off
319
320
321 . /////////////////////////////////////////////////////////////////////////////
322 . This is the real start of the first chapter. See the comment above as to why
323 . we can't have the .chapter line here.
324 . chapter "Introduction"
325 . /////////////////////////////////////////////////////////////////////////////
326
327 Exim is a mail transfer agent (MTA) for hosts that are running Unix or
328 Unix-like operating systems. It was designed on the assumption that it would be
329 run on hosts that are permanently connected to the Internet. However, it can be
330 used on intermittently connected hosts with suitable configuration adjustments.
331
332 Configuration files currently exist for the following operating systems: AIX,
333 BSD/OS (aka BSDI), Darwin (Mac OS X), DGUX, Dragonfly, FreeBSD, GNU/Hurd,
334 GNU/Linux, HI-OSF (Hitachi), HI-UX, HP-UX, IRIX, MIPS RISCOS, NetBSD, OpenBSD,
335 OpenUNIX, QNX, SCO, SCO SVR4.2 (aka UNIX-SV), Solaris (aka SunOS5), SunOS4,
336 Tru64-Unix (formerly Digital UNIX, formerly DEC-OSF1), Ultrix, and Unixware.
337 Some of these operating systems are no longer current and cannot easily be
338 tested, so the configuration files may no longer work in practice.
339
340 There are also configuration files for compiling Exim in the Cygwin environment
341 that can be installed on systems running Windows. However, this document does
342 not contain any information about running Exim in the Cygwin environment.
343
344 The terms and conditions for the use and distribution of Exim are contained in
345 the file &_NOTICE_&. Exim is distributed under the terms of the GNU General
346 Public Licence, a copy of which may be found in the file &_LICENCE_&.
347
348 The use, supply or promotion of Exim for the purpose of sending bulk,
349 unsolicited electronic mail is incompatible with the basic aims of the program,
350 which revolve around the free provision of a service that enhances the quality
351 of personal communications. The author of Exim regards indiscriminate
352 mass-mailing as an antisocial, irresponsible abuse of the Internet.
353
354 Exim owes a great deal to Smail 3 and its author, Ron Karr. Without the
355 experience of running and working on the Smail 3 code, I could never have
356 contemplated starting to write a new MTA. Many of the ideas and user interfaces
357 were originally taken from Smail 3, though the actual code of Exim is entirely
358 new, and has developed far beyond the initial concept.
359
360 Many people, both in Cambridge and around the world, have contributed to the
361 development and the testing of Exim, and to porting it to various operating
362 systems. I am grateful to them all. The distribution now contains a file called
363 &_ACKNOWLEDGMENTS_&, in which I have started recording the names of
364 contributors.
365
366
367 .section "Exim documentation" "SECID1"
368 . Keep this example change bar when updating the documentation!
369 .new
370 .cindex "documentation"
371 This edition of the Exim specification applies to version &version; of Exim.
372 Substantive changes from the &previousversion; edition are marked in some
373 renditions of the document; this paragraph is so marked if the rendition is
374 capable of showing a change indicator.
375 .wen
376
377 This document is very much a reference manual; it is not a tutorial. The reader
378 is expected to have some familiarity with the SMTP mail transfer protocol and
379 with general Unix system administration. Although there are some discussions
380 and examples in places, the information is mostly organized in a way that makes
381 it easy to look up, rather than in a natural order for sequential reading.
382 Furthermore, the manual aims to cover every aspect of Exim in detail, including
383 a number of rarely-used, special-purpose features that are unlikely to be of
384 very wide interest.
385
386 .cindex "books about Exim"
387 An &"easier"& discussion of Exim which provides more in-depth explanatory,
388 introductory, and tutorial material can be found in a book entitled &'The Exim
389 SMTP Mail Server'& (second edition, 2007), published by UIT Cambridge
390 (&url(http://www.uit.co.uk/exim-book/)).
391
392 This book also contains a chapter that gives a general introduction to SMTP and
393 Internet mail. Inevitably, however, the book is unlikely to be fully up-to-date
394 with the latest release of Exim. (Note that the earlier book about Exim,
395 published by O'Reilly, covers Exim 3, and many things have changed in Exim 4.)
396
397 .cindex "Debian" "information sources"
398 If you are using a Debian distribution of Exim, you will find information about
399 Debian-specific features in the file
400 &_/usr/share/doc/exim4-base/README.Debian_&.
401 The command &(man update-exim.conf)& is another source of Debian-specific
402 information.
403
404 .cindex "&_doc/NewStuff_&"
405 .cindex "&_doc/ChangeLog_&"
406 .cindex "change log"
407 As the program develops, there may be features in newer versions that have not
408 yet made it into this document, which is updated only when the most significant
409 digit of the fractional part of the version number changes. Specifications of
410 new features that are not yet in this manual are placed in the file
411 &_doc/NewStuff_& in the Exim distribution.
412
413 Some features may be classified as &"experimental"&. These may change
414 incompatibly while they are developing, or even be withdrawn. For this reason,
415 they are not documented in this manual. Information about experimental features
416 can be found in the file &_doc/experimental.txt_&.
417
418 All changes to the program (whether new features, bug fixes, or other kinds of
419 change) are noted briefly in the file called &_doc/ChangeLog_&.
420
421 .cindex "&_doc/spec.txt_&"
422 This specification itself is available as an ASCII file in &_doc/spec.txt_& so
423 that it can easily be searched with a text editor. Other files in the &_doc_&
424 directory are:
425
426 .table2 100pt
427 .row &_OptionLists.txt_&     "list of all options in alphabetical order"
428 .row &_dbm.discuss.txt_&     "discussion about DBM libraries"
429 .row &_exim.8_&              "a man page of Exim's command line options"
430 .row &_experimental.txt_&    "documentation of experimental features"
431 .row &_filter.txt_&          "specification of the filter language"
432 .row &_Exim3.upgrade_&       "upgrade notes from release 2 to release 3"
433 .row &_Exim4.upgrade_&       "upgrade notes from release 3 to release 4"
434 .endtable
435
436 The main specification and the specification of the filtering language are also
437 available in other formats (HTML, PostScript, PDF, and Texinfo). Section
438 &<<SECTavail>>& below tells you how to get hold of these.
439
440
441
442 .section "FTP and web sites" "SECID2"
443 .cindex "web site"
444 .cindex "FTP site"
445 The primary site for Exim source distributions is currently the University of
446 Cambridge's FTP site, whose contents are described in &'Where to find the Exim
447 distribution'& below. In addition, there is a web site and an FTP site at
448 &%exim.org%&. These are now also hosted at the University of Cambridge. The
449 &%exim.org%& site was previously hosted for a number of years by Energis
450 Squared, formerly Planet Online Ltd, whose support I gratefully acknowledge.
451
452 .cindex "wiki"
453 .cindex "FAQ"
454 As well as Exim distribution tar files, the Exim web site contains a number of
455 differently formatted versions of the documentation. A recent addition to the
456 online information is the Exim wiki (&url(http://wiki.exim.org)),
457 which contains what used to be a separate FAQ, as well as various other
458 examples, tips, and know-how that have been contributed by Exim users.
459
460 .cindex Bugzilla
461 An Exim Bugzilla exists at &url(http://bugs.exim.org). You can use
462 this to report bugs, and also to add items to the wish list. Please search
463 first to check that you are not duplicating a previous entry.
464
465
466
467 .section "Mailing lists" "SECID3"
468 .cindex "mailing lists" "for Exim users"
469 The following Exim mailing lists exist:
470
471 .table2 140pt
472 .row &'exim-users@exim.org'&      "General discussion list"
473 .row &'exim-dev@exim.org'&        "Discussion of bugs, enhancements, etc."
474 .row &'exim-announce@exim.org'&   "Moderated, low volume announcements list"
475 .row &'exim-future@exim.org'&     "Discussion of long-term development"
476 .endtable
477
478 You can subscribe to these lists, change your existing subscriptions, and view
479 or search the archives via the mailing lists link on the Exim home page.
480 .cindex "Debian" "mailing list for"
481 If you are using a Debian distribution of Exim, you may wish to subscribe to
482 the Debian-specific mailing list &'pkg-exim4-users@lists.alioth.debian.org'&
483 via this web page:
484 .display
485 &url(http://lists.alioth.debian.org/mailman/listinfo/pkg-exim4-users)
486 .endd
487 Please ask Debian-specific questions on this list and not on the general Exim
488 lists.
489
490 .section "Exim training" "SECID4"
491 .cindex "training courses"
492 Training courses in Cambridge (UK) used to be run annually by the author of
493 Exim, before he retired. At the time of writing, there are no plans to run
494 further Exim courses in Cambridge. However, if that changes, relevant
495 information will be posted at &url(http://www-tus.csx.cam.ac.uk/courses/exim/).
496
497 .section "Bug reports" "SECID5"
498 .cindex "bug reports"
499 .cindex "reporting bugs"
500 Reports of obvious bugs can be emailed to &'bugs@exim.org'& or reported
501 via the Bugzilla (&url(http://bugs.exim.org)). However, if you are unsure
502 whether some behaviour is a bug or not, the best thing to do is to post a
503 message to the &'exim-dev'& mailing list and have it discussed.
504
505
506
507 .section "Where to find the Exim distribution" "SECTavail"
508 .cindex "FTP site"
509 .cindex "distribution" "ftp site"
510 The master ftp site for the Exim distribution is
511 .display
512 &*ftp://ftp.csx.cam.ac.uk/pub/software/email/exim*&
513 .endd
514 This is mirrored by
515 .display
516 &*ftp://ftp.exim.org/pub/exim*&
517 .endd
518 The file references that follow are relative to the &_exim_& directories at
519 these sites. There are now quite a number of independent mirror sites around
520 the world. Those that I know about are listed in the file called &_Mirrors_&.
521
522 Within the &_exim_& directory there are subdirectories called &_exim3_& (for
523 previous Exim 3 distributions), &_exim4_& (for the latest Exim 4
524 distributions), and &_Testing_& for testing versions. In the &_exim4_&
525 subdirectory, the current release can always be found in files called
526 .display
527 &_exim-n.nn.tar.gz_&
528 &_exim-n.nn.tar.bz2_&
529 .endd
530 where &'n.nn'& is the highest such version number in the directory. The two
531 files contain identical data; the only difference is the type of compression.
532 The &_.bz2_& file is usually a lot smaller than the &_.gz_& file.
533
534 .cindex "distribution" "signing details"
535 .cindex "distribution" "public key"
536 .cindex "public key for signed distribution"
537 The distributions are currently signed with Nigel Metheringham's GPG key. The
538 corresponding public key is available from a number of keyservers, and there is
539 also a copy in the file &_nigel-pubkey.asc_&. The signatures for the tar bundles are
540 in:
541 .display
542 &_exim-n.nn.tar.gz.asc_&
543 &_exim-n.nn.tar.bz2.asc_&
544 .endd
545 For each released version, the log of changes is made separately available in a
546 separate file in the directory &_ChangeLogs_& so that it is possible to
547 find out what has changed without having to download the entire distribution.
548
549 .cindex "documentation" "available formats"
550 The main distribution contains ASCII versions of this specification and other
551 documentation; other formats of the documents are available in separate files
552 inside the &_exim4_& directory of the FTP site:
553 .display
554 &_exim-html-n.nn.tar.gz_&
555 &_exim-pdf-n.nn.tar.gz_&
556 &_exim-postscript-n.nn.tar.gz_&
557 &_exim-texinfo-n.nn.tar.gz_&
558 .endd
559 These tar files contain only the &_doc_& directory, not the complete
560 distribution, and are also available in &_.bz2_& as well as &_.gz_& forms.
561
562
563 .section "Limitations" "SECID6"
564 .ilist
565 .cindex "limitations of Exim"
566 .cindex "bang paths" "not handled by Exim"
567 Exim is designed for use as an Internet MTA, and therefore handles addresses in
568 RFC 2822 domain format only. It cannot handle UUCP &"bang paths"&, though
569 simple two-component bang paths can be converted by a straightforward rewriting
570 configuration. This restriction does not prevent Exim from being interfaced to
571 UUCP as a transport mechanism, provided that domain addresses are used.
572 .next
573 .cindex "domainless addresses"
574 .cindex "address" "without domain"
575 Exim insists that every address it handles has a domain attached. For incoming
576 local messages, domainless addresses are automatically qualified with a
577 configured domain value. Configuration options specify from which remote
578 systems unqualified addresses are acceptable. These are then qualified on
579 arrival.
580 .next
581 .cindex "transport" "external"
582 .cindex "external transports"
583 The only external transport mechanisms that are currently implemented are SMTP
584 and LMTP over a TCP/IP network (including support for IPv6). However, a pipe
585 transport is available, and there are facilities for writing messages to files
586 and pipes, optionally in &'batched SMTP'& format; these facilities can be used
587 to send messages to other transport mechanisms such as UUCP, provided they can
588 handle domain-style addresses. Batched SMTP input is also catered for.
589 .next
590 Exim is not designed for storing mail for dial-in hosts. When the volumes of
591 such mail are large, it is better to get the messages &"delivered"& into files
592 (that is, off Exim's queue) and subsequently passed on to the dial-in hosts by
593 other means.
594 .next
595 Although Exim does have basic facilities for scanning incoming messages, these
596 are not comprehensive enough to do full virus or spam scanning. Such operations
597 are best carried out using additional specialized software packages. If you
598 compile Exim with the content-scanning extension, straightforward interfaces to
599 a number of common scanners are provided.
600 .endlist
601
602
603 .section "Run time configuration" "SECID7"
604 Exim's run time configuration is held in a single text file that is divided
605 into a number of sections. The entries in this file consist of keywords and
606 values, in the style of Smail 3 configuration files. A default configuration
607 file which is suitable for simple online installations is provided in the
608 distribution, and is described in chapter &<<CHAPdefconfil>>& below.
609
610
611 .section "Calling interface" "SECID8"
612 .cindex "Sendmail compatibility" "command line interface"
613 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
614 can be a straight replacement for &_/usr/lib/sendmail_& or
615 &_/usr/sbin/sendmail_& when sending mail, but you do not need to know anything
616 about Sendmail in order to run Exim. For actions other than sending messages,
617 Sendmail-compatible options also exist, but those that produce output (for
618 example, &%-bp%&, which lists the messages on the queue) do so in Exim's own
619 format. There are also some additional options that are compatible with Smail
620 3, and some further options that are new to Exim. Chapter &<<CHAPcommandline>>&
621 documents all Exim's command line options. This information is automatically
622 made into the man page that forms part of the Exim distribution.
623
624 Control of messages on the queue can be done via certain privileged command
625 line options. There is also an optional monitor program called &'eximon'&,
626 which displays current information in an X window, and which contains a menu
627 interface to Exim's command line administration options.
628
629
630
631 .section "Terminology" "SECID9"
632 .cindex "terminology definitions"
633 .cindex "body of message" "definition of"
634 The &'body'& of a message is the actual data that the sender wants to transmit.
635 It is the last part of a message, and is separated from the &'header'& (see
636 below) by a blank line.
637
638 .cindex "bounce message" "definition of"
639 When a message cannot be delivered, it is normally returned to the sender in a
640 delivery failure message or a &"non-delivery report"& (NDR). The term
641 &'bounce'& is commonly used for this action, and the error reports are often
642 called &'bounce messages'&. This is a convenient shorthand for &"delivery
643 failure error report"&. Such messages have an empty sender address in the
644 message's &'envelope'& (see below) to ensure that they cannot themselves give
645 rise to further bounce messages.
646
647 The term &'default'& appears frequently in this manual. It is used to qualify a
648 value which is used in the absence of any setting in the configuration. It may
649 also qualify an action which is taken unless a configuration setting specifies
650 otherwise.
651
652 The term &'defer'& is used when the delivery of a message to a specific
653 destination cannot immediately take place for some reason (a remote host may be
654 down, or a user's local mailbox may be full). Such deliveries are &'deferred'&
655 until a later time.
656
657 The word &'domain'& is sometimes used to mean all but the first component of a
658 host's name. It is &'not'& used in that sense here, where it normally refers to
659 the part of an email address following the @ sign.
660
661 .cindex "envelope, definition of"
662 .cindex "sender" "definition of"
663 A message in transit has an associated &'envelope'&, as well as a header and a
664 body. The envelope contains a sender address (to which bounce messages should
665 be delivered), and any number of recipient addresses. References to the
666 sender or the recipients of a message usually mean the addresses in the
667 envelope. An MTA uses these addresses for delivery, and for returning bounce
668 messages, not the addresses that appear in the header lines.
669
670 .cindex "message" "header, definition of"
671 .cindex "header section" "definition of"
672 The &'header'& of a message is the first part of a message's text, consisting
673 of a number of lines, each of which has a name such as &'From:'&, &'To:'&,
674 &'Subject:'&, etc. Long header lines can be split over several text lines by
675 indenting the continuations. The header is separated from the body by a blank
676 line.
677
678 .cindex "local part" "definition of"
679 .cindex "domain" "definition of"
680 The term &'local part'&, which is taken from RFC 2822, is used to refer to that
681 part of an email address that precedes the @ sign. The part that follows the
682 @ sign is called the &'domain'& or &'mail domain'&.
683
684 .cindex "local delivery" "definition of"
685 .cindex "remote delivery, definition of"
686 The terms &'local delivery'& and &'remote delivery'& are used to distinguish
687 delivery to a file or a pipe on the local host from delivery by SMTP over
688 TCP/IP to another host. As far as Exim is concerned, all hosts other than the
689 host it is running on are &'remote'&.
690
691 .cindex "return path" "definition of"
692 &'Return path'& is another name that is used for the sender address in a
693 message's envelope.
694
695 .cindex "queue" "definition of"
696 The term &'queue'& is used to refer to the set of messages awaiting delivery,
697 because this term is in widespread use in the context of MTAs. However, in
698 Exim's case the reality is more like a pool than a queue, because there is
699 normally no ordering of waiting messages.
700
701 .cindex "queue runner" "definition of"
702 The term &'queue runner'& is used to describe a process that scans the queue
703 and attempts to deliver those messages whose retry times have come. This term
704 is used by other MTAs, and also relates to the command &%runq%&, but in Exim
705 the waiting messages are normally processed in an unpredictable order.
706
707 .cindex "spool directory" "definition of"
708 The term &'spool directory'& is used for a directory in which Exim keeps the
709 messages on its queue &-- that is, those that it is in the process of
710 delivering. This should not be confused with the directory in which local
711 mailboxes are stored, which is called a &"spool directory"& by some people. In
712 the Exim documentation, &"spool"& is always used in the first sense.
713
714
715
716
717
718
719 . ////////////////////////////////////////////////////////////////////////////
720 . ////////////////////////////////////////////////////////////////////////////
721
722 .chapter "Incorporated code" "CHID2"
723 .cindex "incorporated code"
724 .cindex "regular expressions" "library"
725 .cindex "PCRE"
726 A number of pieces of external code are included in the Exim distribution.
727
728 .ilist
729 Regular expressions are supported in the main Exim program and in the
730 Exim monitor using the freely-distributable PCRE library, copyright
731 &copy; University of Cambridge. The source to PCRE is no longer shipped with
732 Exim, so you will need to use the version of PCRE shipped with your system,
733 or obtain and install the full version of the library from
734 &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre).
735 .next
736 .cindex "cdb" "acknowledgment"
737 Support for the cdb (Constant DataBase) lookup method is provided by code
738 contributed by Nigel Metheringham of (at the time he contributed it) Planet
739 Online Ltd. The implementation is completely contained within the code of Exim.
740 It does not link against an external cdb library. The code contains the
741 following statements:
742
743 .blockquote
744 Copyright &copy; 1998 Nigel Metheringham, Planet Online Ltd
745
746 This program is free software; you can redistribute it and/or modify it under
747 the terms of the GNU General Public License as published by the Free Software
748 Foundation; either version 2 of the License, or (at your option) any later
749 version.
750 This code implements Dan Bernstein's Constant DataBase (cdb) spec. Information,
751 the spec and sample code for cdb can be obtained from
752 &url(http://www.pobox.com/~djb/cdb.html). This implementation borrows
753 some code from Dan Bernstein's implementation (which has no license
754 restrictions applied to it).
755 .endblockquote
756 .next
757 .cindex "SPA authentication"
758 .cindex "Samba project"
759 .cindex "Microsoft Secure Password Authentication"
760 Client support for Microsoft's &'Secure Password Authentication'& is provided
761 by code contributed by Marc Prud'hommeaux. Server support was contributed by
762 Tom Kistner. This includes code taken from the Samba project, which is released
763 under the Gnu GPL.
764 .next
765 .cindex "Cyrus"
766 .cindex "&'pwcheck'& daemon"
767 .cindex "&'pwauthd'& daemon"
768 Support for calling the Cyrus &'pwcheck'& and &'saslauthd'& daemons is provided
769 by code taken from the Cyrus-SASL library and adapted by Alexander S.
770 Sabourenkov. The permission notice appears below, in accordance with the
771 conditions expressed therein.
772
773 .blockquote
774 Copyright &copy; 2001 Carnegie Mellon University.  All rights reserved.
775
776 Redistribution and use in source and binary forms, with or without
777 modification, are permitted provided that the following conditions
778 are met:
779
780 .olist
781 Redistributions of source code must retain the above copyright
782 notice, this list of conditions and the following disclaimer.
783 .next
784 Redistributions in binary form must reproduce the above copyright
785 notice, this list of conditions and the following disclaimer in
786 the documentation and/or other materials provided with the
787 distribution.
788 .next
789 The name &"Carnegie Mellon University"& must not be used to
790 endorse or promote products derived from this software without
791 prior written permission. For permission or any other legal
792 details, please contact
793 .display
794               Office of Technology Transfer
795               Carnegie Mellon University
796               5000 Forbes Avenue
797               Pittsburgh, PA  15213-3890
798               (412) 268-4387, fax: (412) 268-7395
799               tech-transfer@andrew.cmu.edu
800 .endd
801 .next
802 Redistributions of any form whatsoever must retain the following
803 acknowledgment:
804
805 &"This product includes software developed by Computing Services
806 at Carnegie Mellon University (&url(http://www.cmu.edu/computing/)."&
807
808 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
809 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
810 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
811 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
812 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
813 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
814 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
815 .endlist
816 .endblockquote
817
818 .next
819 .cindex "Exim monitor" "acknowledgment"
820 .cindex "X-windows"
821 .cindex "Athena"
822 The Exim Monitor program, which is an X-Window application, includes
823 modified versions of the Athena StripChart and TextPop widgets.
824 This code is copyright by DEC and MIT, and their permission notice appears
825 below, in accordance with the conditions expressed therein.
826
827 .blockquote
828 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
829 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
830
831 All Rights Reserved
832
833 Permission to use, copy, modify, and distribute this software and its
834 documentation for any purpose and without fee is hereby granted,
835 provided that the above copyright notice appear in all copies and that
836 both that copyright notice and this permission notice appear in
837 supporting documentation, and that the names of Digital or MIT not be
838 used in advertising or publicity pertaining to distribution of the
839 software without specific, written prior permission.
840
841 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
842 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
843 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
844 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
845 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
846 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
847 SOFTWARE.
848 .endblockquote
849
850 .next
851 Many people have contributed code fragments, some large, some small, that were
852 not covered by any specific licence requirements. It is assumed that the
853 contributors are happy to see their code incorporated into Exim under the GPL.
854 .endlist
855
856
857
858
859
860 . ////////////////////////////////////////////////////////////////////////////
861 . ////////////////////////////////////////////////////////////////////////////
862
863 .chapter "How Exim receives and delivers mail" "CHID11" &&&
864          "Receiving and delivering mail"
865
866
867 .section "Overall philosophy" "SECID10"
868 .cindex "design philosophy"
869 Exim is designed to work efficiently on systems that are permanently connected
870 to the Internet and are handling a general mix of mail. In such circumstances,
871 most messages can be delivered immediately. Consequently, Exim does not
872 maintain independent queues of messages for specific domains or hosts, though
873 it does try to send several messages in a single SMTP connection after a host
874 has been down, and it also maintains per-host retry information.
875
876
877 .section "Policy control" "SECID11"
878 .cindex "policy control" "overview"
879 Policy controls are now an important feature of MTAs that are connected to the
880 Internet. Perhaps their most important job is to stop MTAs being abused as
881 &"open relays"& by misguided individuals who send out vast amounts of
882 unsolicited junk, and want to disguise its source. Exim provides flexible
883 facilities for specifying policy controls on incoming mail:
884
885 .ilist
886 .cindex "&ACL;" "introduction"
887 Exim 4 (unlike previous versions of Exim) implements policy controls on
888 incoming mail by means of &'Access Control Lists'& (ACLs). Each list is a
889 series of statements that may either grant or deny access. ACLs can be used at
890 several places in the SMTP dialogue while receiving a message from a remote
891 host. However, the most common places are after each RCPT command, and at the
892 very end of the message. The sysadmin can specify conditions for accepting or
893 rejecting individual recipients or the entire message, respectively, at these
894 two points (see chapter &<<CHAPACL>>&). Denial of access results in an SMTP
895 error code.
896 .next
897 An ACL is also available for locally generated, non-SMTP messages. In this
898 case, the only available actions are to accept or deny the entire message.
899 .next
900 When Exim is compiled with the content-scanning extension, facilities are
901 provided in the ACL mechanism for passing the message to external virus and/or
902 spam scanning software. The result of such a scan is passed back to the ACL,
903 which can then use it to decide what to do with the message.
904 .next
905 When a message has been received, either from a remote host or from the local
906 host, but before the final acknowledgment has been sent, a locally supplied C
907 function called &[local_scan()]& can be run to inspect the message and decide
908 whether to accept it or not (see chapter &<<CHAPlocalscan>>&). If the message
909 is accepted, the list of recipients can be modified by the function.
910 .next
911 Using the &[local_scan()]& mechanism is another way of calling external scanner
912 software. The &%SA-Exim%& add-on package works this way. It does not require
913 Exim to be compiled with the content-scanning extension.
914 .next
915 After a message has been accepted, a further checking mechanism is available in
916 the form of the &'system filter'& (see chapter &<<CHAPsystemfilter>>&). This
917 runs at the start of every delivery process.
918 .endlist
919
920
921
922 .section "User filters" "SECID12"
923 .cindex "filter" "introduction"
924 .cindex "Sieve filter"
925 In a conventional Exim configuration, users are able to run private filters by
926 setting up appropriate &_.forward_& files in their home directories. See
927 chapter &<<CHAPredirect>>& (about the &(redirect)& router) for the
928 configuration needed to support this, and the separate document entitled
929 &'Exim's interfaces to mail filtering'& for user details. Two different kinds
930 of filtering are available:
931
932 .ilist
933 Sieve filters are written in the standard filtering language that is defined
934 by RFC 3028.
935 .next
936 Exim filters are written in a syntax that is unique to Exim, but which is more
937 powerful than Sieve, which it pre-dates.
938 .endlist
939
940 User filters are run as part of the routing process, described below.
941
942
943
944 .section "Message identification" "SECTmessiden"
945 .cindex "message ids" "details of format"
946 .cindex "format" "of message id"
947 .cindex "id of message"
948 .cindex "base62"
949 .cindex "base36"
950 .cindex "Darwin"
951 .cindex "Cygwin"
952 Every message handled by Exim is given a &'message id'& which is sixteen
953 characters long. It is divided into three parts, separated by hyphens, for
954 example &`16VDhn-0001bo-D3`&. Each part is a sequence of letters and digits,
955 normally encoding numbers in base 62. However, in the Darwin operating
956 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
957 (avoiding the use of lower case letters) is used instead, because the message
958 id is used to construct file names, and the names of files in those systems are
959 not always case-sensitive.
960
961 .cindex "pid (process id)" "re-use of"
962 The detail of the contents of the message id have changed as Exim has evolved.
963 Earlier versions relied on the operating system not re-using a process id (pid)
964 within one second. On modern operating systems, this assumption can no longer
965 be made, so the algorithm had to be changed. To retain backward compatibility,
966 the format of the message id was retained, which is why the following rules are
967 somewhat eccentric:
968
969 .ilist
970 The first six characters of the message id are the time at which the message
971 started to be received, to a granularity of one second. That is, this field
972 contains the number of seconds since the start of the epoch (the normal Unix
973 way of representing the date and time of day).
974 .next
975 After the first hyphen, the next six characters are the id of the process that
976 received the message.
977 .next
978 There are two different possibilities for the final two characters:
979 .olist
980 .oindex "&%localhost_number%&"
981 If &%localhost_number%& is not set, this value is the fractional part of the
982 time of reception, normally in units of 1/2000 of a second, but for systems
983 that must use base 36 instead of base 62 (because of case-insensitive file
984 systems), the units are 1/1000 of a second.
985 .next
986 If &%localhost_number%& is set, it is multiplied by 200 (100) and added to
987 the fractional part of the time, which in this case is in units of 1/200
988 (1/100) of a second.
989 .endlist
990 .endlist
991
992 After a message has been received, Exim waits for the clock to tick at the
993 appropriate resolution before proceeding, so that if another message is
994 received by the same process, or by another process with the same (re-used)
995 pid, it is guaranteed that the time will be different. In most cases, the clock
996 will already have ticked while the message was being received.
997
998
999 .section "Receiving mail" "SECID13"
1000 .cindex "receiving mail"
1001 .cindex "message" "reception"
1002 The only way Exim can receive mail from another host is using SMTP over
1003 TCP/IP, in which case the sender and recipient addresses are transferred using
1004 SMTP commands. However, from a locally running process (such as a user's MUA),
1005 there are several possibilities:
1006
1007 .ilist
1008 If the process runs Exim with the &%-bm%& option, the message is read
1009 non-interactively (usually via a pipe), with the recipients taken from the
1010 command line, or from the body of the message if &%-t%& is also used.
1011 .next
1012 If the process runs Exim with the &%-bS%& option, the message is also read
1013 non-interactively, but in this case the recipients are listed at the start of
1014 the message in a series of SMTP RCPT commands, terminated by a DATA
1015 command. This is so-called &"batch SMTP"& format,
1016 but it isn't really SMTP. The SMTP commands are just another way of passing
1017 envelope addresses in a non-interactive submission.
1018 .next
1019 If the process runs Exim with the &%-bs%& option, the message is read
1020 interactively, using the SMTP protocol. A two-way pipe is normally used for
1021 passing data between the local process and the Exim process.
1022 This is &"real"& SMTP and is handled in the same way as SMTP over TCP/IP. For
1023 example, the ACLs for SMTP commands are used for this form of submission.
1024 .next
1025 A local process may also make a TCP/IP call to the host's loopback address
1026 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1027 does not treat the loopback address specially. It treats all such connections
1028 in the same way as connections from other hosts.
1029 .endlist
1030
1031
1032 .cindex "message sender, constructed by Exim"
1033 .cindex "sender" "constructed by Exim"
1034 In the three cases that do not involve TCP/IP, the sender address is
1035 constructed from the login name of the user that called Exim and a default
1036 qualification domain (which can be set by the &%qualify_domain%& configuration
1037 option). For local or batch SMTP, a sender address that is passed using the
1038 SMTP MAIL command is ignored. However, the system administrator may allow
1039 certain users (&"trusted users"&) to specify a different sender address
1040 unconditionally, or all users to specify certain forms of different sender
1041 address. The &%-f%& option or the SMTP MAIL command is used to specify these
1042 different addresses. See section &<<SECTtrustedadmin>>& for details of trusted
1043 users, and the &%untrusted_set_sender%& option for a way of allowing untrusted
1044 users to change sender addresses.
1045
1046 Messages received by either of the non-interactive mechanisms are subject to
1047 checking by the non-SMTP ACL, if one is defined. Messages received using SMTP
1048 (either over TCP/IP, or interacting with a local process) can be checked by a
1049 number of ACLs that operate at different times during the SMTP session. Either
1050 individual recipients, or the entire message, can be rejected if local policy
1051 requirements are not met. The &[local_scan()]& function (see chapter
1052 &<<CHAPlocalscan>>&) is run for all incoming messages.
1053
1054 Exim can be configured not to start a delivery process when a message is
1055 received; this can be unconditional, or depend on the number of incoming SMTP
1056 connections or the system load. In these situations, new messages wait on the
1057 queue until a queue runner process picks them up. However, in standard
1058 configurations under normal conditions, delivery is started as soon as a
1059 message is received.
1060
1061
1062
1063
1064
1065 .section "Handling an incoming message" "SECID14"
1066 .cindex "spool directory" "files that hold a message"
1067 .cindex "file" "how a message is held"
1068 When Exim accepts a message, it writes two files in its spool directory. The
1069 first contains the envelope information, the current status of the message, and
1070 the header lines, and the second contains the body of the message. The names of
1071 the two spool files consist of the message id, followed by &`-H`& for the
1072 file containing the envelope and header, and &`-D`& for the data file.
1073
1074 .cindex "spool directory" "&_input_& sub-directory"
1075 By default all these message files are held in a single directory called
1076 &_input_& inside the general Exim spool directory. Some operating systems do
1077 not perform very well if the number of files in a directory gets large; to
1078 improve performance in such cases, the &%split_spool_directory%& option can be
1079 used. This causes Exim to split up the input files into 62 sub-directories
1080 whose names are single letters or digits. When this is done, the queue is
1081 processed one sub-directory at a time instead of all at once, which can improve
1082 overall performance even when there are not enough files in each directory to
1083 affect file system performance.
1084
1085 The envelope information consists of the address of the message's sender and
1086 the addresses of the recipients. This information is entirely separate from
1087 any addresses contained in the header lines. The status of the message includes
1088 a list of recipients who have already received the message. The format of the
1089 first spool file is described in chapter &<<CHAPspool>>&.
1090
1091 .cindex "rewriting" "addresses"
1092 Address rewriting that is specified in the rewrite section of the configuration
1093 (see chapter &<<CHAPrewrite>>&) is done once and for all on incoming addresses,
1094 both in the header lines and the envelope, at the time the message is accepted.
1095 If during the course of delivery additional addresses are generated (for
1096 example, via aliasing), these new addresses are rewritten as soon as they are
1097 generated. At the time a message is actually delivered (transported) further
1098 rewriting can take place; because this is a transport option, it can be
1099 different for different forms of delivery. It is also possible to specify the
1100 addition or removal of certain header lines at the time the message is
1101 delivered (see chapters &<<CHAProutergeneric>>& and
1102 &<<CHAPtransportgeneric>>&).
1103
1104
1105
1106 .section "Life of a message" "SECID15"
1107 .cindex "message" "life of"
1108 .cindex "message" "frozen"
1109 A message remains in the spool directory until it is completely delivered to
1110 its recipients or to an error address, or until it is deleted by an
1111 administrator or by the user who originally created it. In cases when delivery
1112 cannot proceed &-- for example, when a message can neither be delivered to its
1113 recipients nor returned to its sender, the message is marked &"frozen"& on the
1114 spool, and no more deliveries are attempted.
1115
1116 .cindex "frozen messages" "thawing"
1117 .cindex "message" "thawing frozen"
1118 An administrator can &"thaw"& such messages when the problem has been
1119 corrected, and can also freeze individual messages by hand if necessary. In
1120 addition, an administrator can force a delivery error, causing a bounce message
1121 to be sent.
1122
1123 .oindex "&%timeout_frozen_after%&"
1124 .oindex "&%ignore_bounce_errors_after%&"
1125 There are options called &%ignore_bounce_errors_after%& and
1126 &%timeout_frozen_after%&, which discard frozen messages after a certain time.
1127 The first applies only to frozen bounces, the second to any frozen messages.
1128
1129 .cindex "message" "log file for"
1130 .cindex "log" "file for each message"
1131 While Exim is working on a message, it writes information about each delivery
1132 attempt to its main log file. This includes successful, unsuccessful, and
1133 delayed deliveries for each recipient (see chapter &<<CHAPlog>>&). The log
1134 lines are also written to a separate &'message log'& file for each message.
1135 These logs are solely for the benefit of the administrator, and are normally
1136 deleted along with the spool files when processing of a message is complete.
1137 The use of individual message logs can be disabled by setting
1138 &%no_message_logs%&; this might give an improvement in performance on very busy
1139 systems.
1140
1141 .cindex "journal file"
1142 .cindex "file" "journal"
1143 All the information Exim itself needs to set up a delivery is kept in the first
1144 spool file, along with the header lines. When a successful delivery occurs, the
1145 address is immediately written at the end of a journal file, whose name is the
1146 message id followed by &`-J`&. At the end of a delivery run, if there are some
1147 addresses left to be tried again later, the first spool file (the &`-H`& file)
1148 is updated to indicate which these are, and the journal file is then deleted.
1149 Updating the spool file is done by writing a new file and renaming it, to
1150 minimize the possibility of data loss.
1151
1152 Should the system or the program crash after a successful delivery but before
1153 the spool file has been updated, the journal is left lying around. The next
1154 time Exim attempts to deliver the message, it reads the journal file and
1155 updates the spool file before proceeding. This minimizes the chances of double
1156 deliveries caused by crashes.
1157
1158
1159
1160 .section "Processing an address for delivery" "SECTprocaddress"
1161 .cindex "drivers" "definition of"
1162 .cindex "router" "definition of"
1163 .cindex "transport" "definition of"
1164 The main delivery processing elements of Exim are called &'routers'& and
1165 &'transports'&, and collectively these are known as &'drivers'&. Code for a
1166 number of them is provided in the source distribution, and compile-time options
1167 specify which ones are included in the binary. Run time options specify which
1168 ones are actually used for delivering messages.
1169
1170 .cindex "drivers" "instance definition"
1171 Each driver that is specified in the run time configuration is an &'instance'&
1172 of that particular driver type. Multiple instances are allowed; for example,
1173 you can set up several different &(smtp)& transports, each with different
1174 option values that might specify different ports or different timeouts. Each
1175 instance has its own identifying name. In what follows we will normally use the
1176 instance name when discussing one particular instance (that is, one specific
1177 configuration of the driver), and the generic driver name when discussing
1178 the driver's features in general.
1179
1180 A &'router'& is a driver that operates on an address, either determining how
1181 its delivery should happen, by assigning it to a specific transport, or
1182 converting the address into one or more new addresses (for example, via an
1183 alias file). A router may also explicitly choose to fail an address, causing it
1184 to be bounced.
1185
1186 A &'transport'& is a driver that transmits a copy of the message from Exim's
1187 spool to some destination. There are two kinds of transport: for a &'local'&
1188 transport, the destination is a file or a pipe on the local host, whereas for a
1189 &'remote'& transport the destination is some other host. A message is passed
1190 to a specific transport as a result of successful routing. If a message has
1191 several recipients, it may be passed to a number of different transports.
1192
1193 .cindex "preconditions" "definition of"
1194 An address is processed by passing it to each configured router instance in
1195 turn, subject to certain preconditions, until a router accepts the address or
1196 specifies that it should be bounced. We will describe this process in more
1197 detail shortly. First, as a simple example, we consider how each recipient
1198 address in a message is processed in a small configuration of three routers.
1199
1200 To make this a more concrete example, it is described in terms of some actual
1201 routers, but remember, this is only an example. You can configure Exim's
1202 routers in many different ways, and there may be any number of routers in a
1203 configuration.
1204
1205 The first router that is specified in a configuration is often one that handles
1206 addresses in domains that are not recognized specially by the local host. These
1207 are typically addresses for arbitrary domains on the Internet. A precondition
1208 is set up which looks for the special domains known to the host (for example,
1209 its own domain name), and the router is run for addresses that do &'not'&
1210 match. Typically, this is a router that looks up domains in the DNS in order to
1211 find the hosts to which this address routes. If it succeeds, the address is
1212 assigned to a suitable SMTP transport; if it does not succeed, the router is
1213 configured to fail the address.
1214
1215 The second router is reached only when the domain is recognized as one that
1216 &"belongs"& to the local host. This router does redirection &-- also known as
1217 aliasing and forwarding. When it generates one or more new addresses from the
1218 original, each of them is routed independently from the start. Otherwise, the
1219 router may cause an address to fail, or it may simply decline to handle the
1220 address, in which case the address is passed to the next router.
1221
1222 The final router in many configurations is one that checks to see if the
1223 address belongs to a local mailbox. The precondition may involve a check to
1224 see if the local part is the name of a login account, or it may look up the
1225 local part in a file or a database. If its preconditions are not met, or if
1226 the router declines, we have reached the end of the routers. When this happens,
1227 the address is bounced.
1228
1229
1230
1231 .section "Processing an address for verification" "SECID16"
1232 .cindex "router" "for verification"
1233 .cindex "verifying address" "overview"
1234 As well as being used to decide how to deliver to an address, Exim's routers
1235 are also used for &'address verification'&. Verification can be requested as
1236 one of the checks to be performed in an ACL for incoming messages, on both
1237 sender and recipient addresses, and it can be tested using the &%-bv%& and
1238 &%-bvs%& command line options.
1239
1240 When an address is being verified, the routers are run in &"verify mode"&. This
1241 does not affect the way the routers work, but it is a state that can be
1242 detected. By this means, a router can be skipped or made to behave differently
1243 when verifying. A common example is a configuration in which the first router
1244 sends all messages to a message-scanning program, unless they have been
1245 previously scanned. Thus, the first router accepts all addresses without any
1246 checking, making it useless for verifying. Normally, the &%no_verify%& option
1247 would be set for such a router, causing it to be skipped in verify mode.
1248
1249
1250
1251
1252 .section "Running an individual router" "SECTrunindrou"
1253 .cindex "router" "running details"
1254 .cindex "preconditions" "checking"
1255 .cindex "router" "result of running"
1256 As explained in the example above, a number of preconditions are checked before
1257 running a router. If any are not met, the router is skipped, and the address is
1258 passed to the next router. When all the preconditions on a router &'are'& met,
1259 the router is run. What happens next depends on the outcome, which is one of
1260 the following:
1261
1262 .ilist
1263 &'accept'&: The router accepts the address, and either assigns it to a
1264 transport, or generates one or more &"child"& addresses. Processing the
1265 original address ceases,
1266 .oindex "&%unseen%&"
1267 unless the &%unseen%& option is set on the router. This option
1268 can be used to set up multiple deliveries with different routing (for example,
1269 for keeping archive copies of messages). When &%unseen%& is set, the address is
1270 passed to the next router. Normally, however, an &'accept'& return marks the
1271 end of routing.
1272
1273 Any child addresses generated by the router are processed independently,
1274 starting with the first router by default. It is possible to change this by
1275 setting the &%redirect_router%& option to specify which router to start at for
1276 child addresses. Unlike &%pass_router%& (see below) the router specified by
1277 &%redirect_router%& may be anywhere in the router configuration.
1278 .next
1279 &'pass'&: The router recognizes the address, but cannot handle it itself. It
1280 requests that the address be passed to another router. By default the address
1281 is passed to the next router, but this can be changed by setting the
1282 &%pass_router%& option. However, (unlike &%redirect_router%&) the named router
1283 must be below the current router (to avoid loops).
1284 .next
1285 &'decline'&: The router declines to accept the address because it does not
1286 recognize it at all. By default, the address is passed to the next router, but
1287 this can be prevented by setting the &%no_more%& option. When &%no_more%& is
1288 set, all the remaining routers are skipped. In effect, &%no_more%& converts
1289 &'decline'& into &'fail'&.
1290 .next
1291 &'fail'&: The router determines that the address should fail, and queues it for
1292 the generation of a bounce message. There is no further processing of the
1293 original address unless &%unseen%& is set on the router.
1294 .next
1295 &'defer'&: The router cannot handle the address at the present time. (A
1296 database may be offline, or a DNS lookup may have timed out.) No further
1297 processing of the address happens in this delivery attempt. It is tried again
1298 next time the message is considered for delivery.
1299 .next
1300 &'error'&: There is some error in the router (for example, a syntax error in
1301 its configuration). The action is as for defer.
1302 .endlist
1303
1304 If an address reaches the end of the routers without having been accepted by
1305 any of them, it is bounced as unrouteable. The default error message in this
1306 situation is &"unrouteable address"&, but you can set your own message by
1307 making use of the &%cannot_route_message%& option. This can be set for any
1308 router; the value from the last router that &"saw"& the address is used.
1309
1310 Sometimes while routing you want to fail a delivery when some conditions are
1311 met but others are not, instead of passing the address on for further routing.
1312 You can do this by having a second router that explicitly fails the delivery
1313 when the relevant conditions are met. The &(redirect)& router has a &"fail"&
1314 facility for this purpose.
1315
1316
1317 .section "Duplicate addresses" "SECID17"
1318 .cindex "case of local parts"
1319 .cindex "address duplicate, discarding"
1320 .cindex "duplicate addresses"
1321 Once routing is complete, Exim scans the addresses that are assigned to local
1322 and remote transports, and discards any duplicates that it finds. During this
1323 check, local parts are treated as case-sensitive. This happens only when
1324 actually delivering a message; when testing routers with &%-bt%&, all the
1325 routed addresses are shown.
1326
1327
1328
1329 .section "Router preconditions" "SECTrouprecon"
1330 .cindex "router" "preconditions, order of processing"
1331 .cindex "preconditions" "order of processing"
1332 The preconditions that are tested for each router are listed below, in the
1333 order in which they are tested. The individual configuration options are
1334 described in more detail in chapter &<<CHAProutergeneric>>&.
1335
1336 .ilist
1337 The &%local_part_prefix%& and &%local_part_suffix%& options can specify that
1338 the local parts handled by the router may or must have certain prefixes and/or
1339 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1340 skipped. These conditions are tested first. When an affix is present, it is
1341 removed from the local part before further processing, including the evaluation
1342 of any other conditions.
1343 .next
1344 Routers can be designated for use only when not verifying an address, that is,
1345 only when routing it for delivery (or testing its delivery routing). If the
1346 &%verify%& option is set false, the router is skipped when Exim is verifying an
1347 address.
1348 Setting the &%verify%& option actually sets two options, &%verify_sender%& and
1349 &%verify_recipient%&, which independently control the use of the router for
1350 sender and recipient verification. You can set these options directly if
1351 you want a router to be used for only one type of verification.
1352 .next
1353 If the &%address_test%& option is set false, the router is skipped when Exim is
1354 run with the &%-bt%& option to test an address routing. This can be helpful
1355 when the first router sends all new messages to a scanner of some sort; it
1356 makes it possible to use &%-bt%& to test subsequent delivery routing without
1357 having to simulate the effect of the scanner.
1358 .next
1359 Routers can be designated for use only when verifying an address, as
1360 opposed to routing it for delivery. The &%verify_only%& option controls this.
1361 .next
1362 Individual routers can be explicitly skipped when running the routers to
1363 check an address given in the SMTP EXPN command (see the &%expn%& option).
1364 .next
1365 If the &%domains%& option is set, the domain of the address must be in the set
1366 of domains that it defines.
1367 .next
1368 .vindex "&$local_part_prefix$&"
1369 .vindex "&$local_part$&"
1370 .vindex "&$local_part_suffix$&"
1371 If the &%local_parts%& option is set, the local part of the address must be in
1372 the set of local parts that it defines. If &%local_part_prefix%& or
1373 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1374 part before this check. If you want to do precondition tests on local parts
1375 that include affixes, you can do so by using a &%condition%& option (see below)
1376 that uses the variables &$local_part$&, &$local_part_prefix$&, and
1377 &$local_part_suffix$& as necessary.
1378 .next
1379 .vindex "&$local_user_uid$&"
1380 .vindex "&$local_user_gid$&"
1381 .vindex "&$home$&"
1382 If the &%check_local_user%& option is set, the local part must be the name of
1383 an account on the local host. If this check succeeds, the uid and gid of the
1384 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1385 user's home directory is placed in &$home$&; these values can be used in the
1386 remaining preconditions.
1387 .next
1388 If the &%router_home_directory%& option is set, it is expanded at this point,
1389 because it overrides the value of &$home$&. If this expansion were left till
1390 later, the value of &$home$& as set by &%check_local_user%& would be used in
1391 subsequent tests. Having two different values of &$home$& in the same router
1392 could lead to confusion.
1393 .next
1394 If the &%senders%& option is set, the envelope sender address must be in the
1395 set of addresses that it defines.
1396 .next
1397 If the &%require_files%& option is set, the existence or non-existence of
1398 specified files is tested.
1399 .next
1400 .cindex "customizing" "precondition"
1401 If the &%condition%& option is set, it is evaluated and tested. This option
1402 uses an expanded string to allow you to set up your own custom preconditions.
1403 Expanded strings are described in chapter &<<CHAPexpand>>&.
1404 .endlist
1405
1406
1407 Note that &%require_files%& comes near the end of the list, so you cannot use
1408 it to check for the existence of a file in which to lookup up a domain, local
1409 part, or sender. However, as these options are all expanded, you can use the
1410 &%exists%& expansion condition to make such tests within each condition. The
1411 &%require_files%& option is intended for checking files that the router may be
1412 going to use internally, or which are needed by a specific transport (for
1413 example, &_.procmailrc_&).
1414
1415
1416
1417 .section "Delivery in detail" "SECID18"
1418 .cindex "delivery" "in detail"
1419 When a message is to be delivered, the sequence of events is as follows:
1420
1421 .ilist
1422 If a system-wide filter file is specified, the message is passed to it. The
1423 filter may add recipients to the message, replace the recipients, discard the
1424 message, cause a new message to be generated, or cause the message delivery to
1425 fail. The format of the system filter file is the same as for Exim user filter
1426 files, described in the separate document entitled &'Exim's interfaces to mail
1427 filtering'&.
1428 .cindex "Sieve filter" "not available for system filter"
1429 (&*Note*&: Sieve cannot be used for system filter files.)
1430
1431 Some additional features are available in system filters &-- see chapter
1432 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1433 filter only once per delivery attempt, however many recipients it has. However,
1434 if there are several delivery attempts because one or more addresses could not
1435 be immediately delivered, the system filter is run each time. The filter
1436 condition &%first_delivery%& can be used to detect the first run of the system
1437 filter.
1438 .next
1439 Each recipient address is offered to each configured router in turn, subject to
1440 its preconditions, until one is able to handle it. If no router can handle the
1441 address, that is, if they all decline, the address is failed. Because routers
1442 can be targeted at particular domains, several locally handled domains can be
1443 processed entirely independently of each other.
1444 .next
1445 .cindex "routing" "loops in"
1446 .cindex "loop" "while routing"
1447 A router that accepts an address may assign it to a local or a remote
1448 transport. However, the transport is not run at this time. Instead, the address
1449 is placed on a list for the particular transport, which will be run later.
1450 Alternatively, the router may generate one or more new addresses (typically
1451 from alias, forward, or filter files). New addresses are fed back into this
1452 process from the top, but in order to avoid loops, a router ignores any address
1453 which has an identically-named ancestor that was processed by itself.
1454 .next
1455 When all the routing has been done, addresses that have been successfully
1456 handled are passed to their assigned transports. When local transports are
1457 doing real local deliveries, they handle only one address at a time, but if a
1458 local transport is being used as a pseudo-remote transport (for example, to
1459 collect batched SMTP messages for transmission by some other means) multiple
1460 addresses can be handled. Remote transports can always handle more than one
1461 address at a time, but can be configured not to do so, or to restrict multiple
1462 addresses to the same domain.
1463 .next
1464 Each local delivery to a file or a pipe runs in a separate process under a
1465 non-privileged uid, and these deliveries are run one at a time. Remote
1466 deliveries also run in separate processes, normally under a uid that is private
1467 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1468 run in parallel. The maximum number of simultaneous remote deliveries for any
1469 one message is set by the &%remote_max_parallel%& option.
1470 The order in which deliveries are done is not defined, except that all local
1471 deliveries happen before any remote deliveries.
1472 .next
1473 .cindex "queue runner"
1474 When it encounters a local delivery during a queue run, Exim checks its retry
1475 database to see if there has been a previous temporary delivery failure for the
1476 address before running the local transport. If there was a previous failure,
1477 Exim does not attempt a new delivery until the retry time for the address is
1478 reached. However, this happens only for delivery attempts that are part of a
1479 queue run. Local deliveries are always attempted when delivery immediately
1480 follows message reception, even if retry times are set for them. This makes for
1481 better behaviour if one particular message is causing problems (for example,
1482 causing quota overflow, or provoking an error in a filter file).
1483 .next
1484 .cindex "delivery" "retry in remote transports"
1485 Remote transports do their own retry handling, since an address may be
1486 deliverable to one of a number of hosts, each of which may have a different
1487 retry time. If there have been previous temporary failures and no host has
1488 reached its retry time, no delivery is attempted, whether in a queue run or
1489 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1490 .next
1491 If there were any permanent errors, a bounce message is returned to an
1492 appropriate address (the sender in the common case), with details of the error
1493 for each failing address. Exim can be configured to send copies of bounce
1494 messages to other addresses.
1495 .next
1496 .cindex "delivery" "deferral"
1497 If one or more addresses suffered a temporary failure, the message is left on
1498 the queue, to be tried again later. Delivery of these addresses is said to be
1499 &'deferred'&.
1500 .next
1501 When all the recipient addresses have either been delivered or bounced,
1502 handling of the message is complete. The spool files and message log are
1503 deleted, though the message log can optionally be preserved if required.
1504 .endlist
1505
1506
1507
1508
1509 .section "Retry mechanism" "SECID19"
1510 .cindex "delivery" "retry mechanism"
1511 .cindex "retry" "description of mechanism"
1512 .cindex "queue runner"
1513 Exim's mechanism for retrying messages that fail to get delivered at the first
1514 attempt is the queue runner process. You must either run an Exim daemon that
1515 uses the &%-q%& option with a time interval to start queue runners at regular
1516 intervals, or use some other means (such as &'cron'&) to start them. If you do
1517 not arrange for queue runners to be run, messages that fail temporarily at the
1518 first attempt will remain on your queue for ever. A queue runner process works
1519 its way through the queue, one message at a time, trying each delivery that has
1520 passed its retry time.
1521 You can run several queue runners at once.
1522
1523 Exim uses a set of configured rules to determine when next to retry the failing
1524 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1525 should give up trying to deliver to the address, at which point it generates a
1526 bounce message. If no retry rules are set for a particular host, address, and
1527 error combination, no retries are attempted, and temporary errors are treated
1528 as permanent.
1529
1530
1531
1532 .section "Temporary delivery failure" "SECID20"
1533 .cindex "delivery" "temporary failure"
1534 There are many reasons why a message may not be immediately deliverable to a
1535 particular address. Failure to connect to a remote machine (because it, or the
1536 connection to it, is down) is one of the most common. Temporary failures may be
1537 detected during routing as well as during the transport stage of delivery.
1538 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1539 is on a file system where the user is over quota. Exim can be configured to
1540 impose its own quotas on local mailboxes; where system quotas are set they will
1541 also apply.
1542
1543 If a host is unreachable for a period of time, a number of messages may be
1544 waiting for it by the time it recovers, and sending them in a single SMTP
1545 connection is clearly beneficial. Whenever a delivery to a remote host is
1546 deferred,
1547
1548 .cindex "hints database"
1549 Exim makes a note in its hints database, and whenever a successful
1550 SMTP delivery has happened, it looks to see if any other messages are waiting
1551 for the same host. If any are found, they are sent over the same SMTP
1552 connection, subject to a configuration limit as to the maximum number in any
1553 one connection.
1554
1555
1556
1557
1558 .section "Permanent delivery failure" "SECID21"
1559 .cindex "delivery" "permanent failure"
1560 .cindex "bounce message" "when generated"
1561 When a message cannot be delivered to some or all of its intended recipients, a
1562 bounce message is generated. Temporary delivery failures turn into permanent
1563 errors when their timeout expires. All the addresses that fail in a given
1564 delivery attempt are listed in a single message. If the original message has
1565 many recipients, it is possible for some addresses to fail in one delivery
1566 attempt and others to fail subsequently, giving rise to more than one bounce
1567 message. The wording of bounce messages can be customized by the administrator.
1568 See chapter &<<CHAPemsgcust>>& for details.
1569
1570 .cindex "&'X-Failed-Recipients:'& header line"
1571 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1572 failed addresses, for the benefit of programs that try to analyse such messages
1573 automatically.
1574
1575 .cindex "bounce message" "recipient of"
1576 A bounce message is normally sent to the sender of the original message, as
1577 obtained from the message's envelope. For incoming SMTP messages, this is the
1578 address given in the MAIL command. However, when an address is expanded via a
1579 forward or alias file, an alternative address can be specified for delivery
1580 failures of the generated addresses. For a mailing list expansion (see section
1581 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1582 of the list.
1583
1584
1585
1586 .section "Failures to deliver bounce messages" "SECID22"
1587 .cindex "bounce message" "failure to deliver"
1588 If a bounce message (either locally generated or received from a remote host)
1589 itself suffers a permanent delivery failure, the message is left on the queue,
1590 but it is frozen, awaiting the attention of an administrator. There are options
1591 that can be used to make Exim discard such failed messages, or to keep them
1592 for only a short time (see &%timeout_frozen_after%& and
1593 &%ignore_bounce_errors_after%&).
1594
1595
1596
1597
1598
1599 . ////////////////////////////////////////////////////////////////////////////
1600 . ////////////////////////////////////////////////////////////////////////////
1601
1602 .chapter "Building and installing Exim" "CHID3"
1603 .scindex IIDbuex "building Exim"
1604
1605 .section "Unpacking" "SECID23"
1606 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1607 creates a directory with the name of the current release (for example,
1608 &_exim-&version;_&) into which the following files are placed:
1609
1610 .table2 140pt
1611 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1612 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1613   documented"
1614 .irow &_LICENCE_&         "the GNU General Public Licence"
1615 .irow &_Makefile_&        "top-level make file"
1616 .irow &_NOTICE_&          "conditions for the use of Exim"
1617 .irow &_README_&          "list of files, directories and simple build &&&
1618   instructions"
1619 .endtable
1620
1621 Other files whose names begin with &_README_& may also be present. The
1622 following subdirectories are created:
1623
1624 .table2 140pt
1625 .irow &_Local_&           "an empty directory for local configuration files"
1626 .irow &_OS_&              "OS-specific files"
1627 .irow &_doc_&             "documentation files"
1628 .irow &_exim_monitor_&    "source files for the Exim monitor"
1629 .irow &_scripts_&         "scripts used in the build process"
1630 .irow &_src_&             "remaining source files"
1631 .irow &_util_&            "independent utilities"
1632 .endtable
1633
1634 The main utility programs are contained in the &_src_& directory, and are built
1635 with the Exim binary. The &_util_& directory contains a few optional scripts
1636 that may be useful to some sites.
1637
1638
1639 .section "Multiple machine architectures and operating systems" "SECID24"
1640 .cindex "building Exim" "multiple OS/architectures"
1641 The building process for Exim is arranged to make it easy to build binaries for
1642 a number of different architectures and operating systems from the same set of
1643 source files. Compilation does not take place in the &_src_& directory.
1644 Instead, a &'build directory'& is created for each architecture and operating
1645 system.
1646 .cindex "symbolic link" "to build directory"
1647 Symbolic links to the sources are installed in this directory, which is where
1648 the actual building takes place. In most cases, Exim can discover the machine
1649 architecture and operating system for itself, but the defaults can be
1650 overridden if necessary.
1651
1652
1653 .section "PCRE library" "SECTpcre"
1654 .cindex "PCRE library"
1655 Exim no longer has an embedded PCRE library as the vast majority of
1656 modern systems include PCRE as a system library, although you may need
1657 to install the PCRE or PCRE development package for your operating
1658 system. If your system has a normal PCRE installation the Exim build
1659 process will need no further configuration. If the library or the
1660 headers are in an unusual location you will need to set the PCRE_LIBS
1661 and INCLUDE directives appropriately. If your operating system has no
1662 PCRE support then you will need to obtain and build the current PCRE
1663 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1664
1665 .section "DBM libraries" "SECTdb"
1666 .cindex "DBM libraries" "discussion of"
1667 .cindex "hints database" "DBM files used for"
1668 Even if you do not use any DBM files in your configuration, Exim still needs a
1669 DBM library in order to operate, because it uses indexed files for its hints
1670 databases. Unfortunately, there are a number of DBM libraries in existence, and
1671 different operating systems often have different ones installed.
1672
1673 .cindex "Solaris" "DBM library for"
1674 .cindex "IRIX, DBM library for"
1675 .cindex "BSD, DBM library for"
1676 .cindex "Linux, DBM library for"
1677 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1678 Linux distribution, the DBM configuration should happen automatically, and you
1679 may be able to ignore this section. Otherwise, you may have to learn more than
1680 you would like about DBM libraries from what follows.
1681
1682 .cindex "&'ndbm'& DBM library"
1683 Licensed versions of Unix normally contain a library of DBM functions operating
1684 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1685 versions of Unix seem to vary in what they contain as standard. In particular,
1686 some early versions of Linux have no default DBM library, and different
1687 distributors have chosen to bundle different libraries with their packaged
1688 versions. However, the more recent releases seem to have standardized on the
1689 Berkeley DB library.
1690
1691 Different DBM libraries have different conventions for naming the files they
1692 use. When a program opens a file called &_dbmfile_&, there are several
1693 possibilities:
1694
1695 .olist
1696 A traditional &'ndbm'& implementation, such as that supplied as part of
1697 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1698 .next
1699 .cindex "&'gdbm'& DBM library"
1700 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1701 compatibility interface it makes two different hard links to it with names
1702 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1703 file name is used unmodified.
1704 .next
1705 .cindex "Berkeley DB library"
1706 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1707 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1708 programmer exactly the same as the traditional &'ndbm'& implementation.
1709 .next
1710 If the Berkeley package is used in its native mode, it operates on a single
1711 file called &_dbmfile_&; the programmer's interface is somewhat different to
1712 the traditional &'ndbm'& interface.
1713 .next
1714 To complicate things further, there are several very different versions of the
1715 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1716 2.&'x'& and 3.&'x'& were current for a while, but the latest versions are now
1717 numbered 4.&'x'&. Maintenance of some of the earlier releases has ceased. All
1718 versions of Berkeley DB can be obtained from
1719 &url(http://www.sleepycat.com/).
1720 .next
1721 .cindex "&'tdb'& DBM library"
1722 Yet another DBM library, called &'tdb'&, is available from
1723 &url(http://download.sourceforge.net/tdb). It has its own interface, and also
1724 operates on a single file.
1725 .endlist
1726
1727 .cindex "USE_DB"
1728 .cindex "DBM libraries" "configuration for building"
1729 Exim and its utilities can be compiled to use any of these interfaces. In order
1730 to use any version of the Berkeley DB package in native mode, you must set
1731 USE_DB in an appropriate configuration file (typically
1732 &_Local/Makefile_&). For example:
1733 .code
1734 USE_DB=yes
1735 .endd
1736 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1737 error is diagnosed if you set more than one of these.
1738
1739 At the lowest level, the build-time configuration sets none of these options,
1740 thereby assuming an interface of type (1). However, some operating system
1741 configuration files (for example, those for the BSD operating systems and
1742 Linux) assume type (4) by setting USE_DB as their default, and the
1743 configuration files for Cygwin set USE_GDBM. Anything you set in
1744 &_Local/Makefile_&, however, overrides these system defaults.
1745
1746 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1747 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1748 in one of these lines:
1749 .code
1750 DBMLIB = -ldb
1751 DBMLIB = -ltdb
1752 .endd
1753 Settings like that will work if the DBM library is installed in the standard
1754 place. Sometimes it is not, and the library's header file may also not be in
1755 the default path. You may need to set INCLUDE to specify where the header
1756 file is, and to specify the path to the library more fully in DBMLIB, as in
1757 this example:
1758 .code
1759 INCLUDE=-I/usr/local/include/db-4.1
1760 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1761 .endd
1762 There is further detailed discussion about the various DBM libraries in the
1763 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1764
1765
1766
1767 .section "Pre-building configuration" "SECID25"
1768 .cindex "building Exim" "pre-building configuration"
1769 .cindex "configuration for building Exim"
1770 .cindex "&_Local/Makefile_&"
1771 .cindex "&_src/EDITME_&"
1772 Before building Exim, a local configuration file that specifies options
1773 independent of any operating system has to be created with the name
1774 &_Local/Makefile_&. A template for this file is supplied as the file
1775 &_src/EDITME_&, and it contains full descriptions of all the option settings
1776 therein. These descriptions are therefore not repeated here. If you are
1777 building Exim for the first time, the simplest thing to do is to copy
1778 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1779
1780 There are three settings that you must supply, because Exim will not build
1781 without them. They are the location of the run time configuration file
1782 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1783 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1784 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1785 a colon-separated list of file names; Exim uses the first of them that exists.
1786
1787 There are a few other parameters that can be specified either at build time or
1788 at run time, to enable the same binary to be used on a number of different
1789 machines. However, if the locations of Exim's spool directory and log file
1790 directory (if not within the spool directory) are fixed, it is recommended that
1791 you specify them in &_Local/Makefile_& instead of at run time, so that errors
1792 detected early in Exim's execution (such as a malformed configuration file) can
1793 be logged.
1794
1795 .cindex "content scanning" "specifying at build time"
1796 Exim's interfaces for calling virus and spam scanning software directly from
1797 access control lists are not compiled by default. If you want to include these
1798 facilities, you need to set
1799 .code
1800 WITH_CONTENT_SCAN=yes
1801 .endd
1802 in your &_Local/Makefile_&. For details of the facilities themselves, see
1803 chapter &<<CHAPexiscan>>&.
1804
1805
1806 .cindex "&_Local/eximon.conf_&"
1807 .cindex "&_exim_monitor/EDITME_&"
1808 If you are going to build the Exim monitor, a similar configuration process is
1809 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1810 your installation and saved under the name &_Local/eximon.conf_&. If you are
1811 happy with the default settings described in &_exim_monitor/EDITME_&,
1812 &_Local/eximon.conf_& can be empty, but it must exist.
1813
1814 This is all the configuration that is needed in straightforward cases for known
1815 operating systems. However, the building process is set up so that it is easy
1816 to override options that are set by default or by operating-system-specific
1817 configuration files, for example to change the name of the C compiler, which
1818 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1819 do this.
1820
1821
1822
1823 .section "Support for iconv()" "SECID26"
1824 .cindex "&[iconv()]& support"
1825 .cindex "RFC 2047"
1826 The contents of header lines in messages may be encoded according to the rules
1827 described RFC 2047. This makes it possible to transmit characters that are not
1828 in the ASCII character set, and to label them as being in a particular
1829 character set. When Exim is inspecting header lines by means of the &%$h_%&
1830 mechanism, it decodes them, and translates them into a specified character set
1831 (default ISO-8859-1). The translation is possible only if the operating system
1832 supports the &[iconv()]& function.
1833
1834 However, some of the operating systems that supply &[iconv()]& do not support
1835 very many conversions. The GNU &%libiconv%& library (available from
1836 &url(http://www.gnu.org/software/libiconv/)) can be installed on such
1837 systems to remedy this deficiency, as well as on systems that do not supply
1838 &[iconv()]& at all. After installing &%libiconv%&, you should add
1839 .code
1840 HAVE_ICONV=yes
1841 .endd
1842 to your &_Local/Makefile_& and rebuild Exim.
1843
1844
1845
1846 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1847 .cindex "TLS" "including support for TLS"
1848 .cindex "encryption" "including support for"
1849 .cindex "SUPPORT_TLS"
1850 .cindex "OpenSSL" "building Exim with"
1851 .cindex "GnuTLS" "building Exim with"
1852 Exim can be built to support encrypted SMTP connections, using the STARTTLS
1853 command as per RFC 2487. It can also support legacy clients that expect to
1854 start a TLS session immediately on connection to a non-standard port (see the
1855 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1856 line option).
1857
1858 If you want to build Exim with TLS support, you must first install either the
1859 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1860 implementing SSL.
1861
1862 If OpenSSL is installed, you should set
1863 .code
1864 SUPPORT_TLS=yes
1865 TLS_LIBS=-lssl -lcrypto
1866 .endd
1867 in &_Local/Makefile_&. You may also need to specify the locations of the
1868 OpenSSL library and include files. For example:
1869 .code
1870 SUPPORT_TLS=yes
1871 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1872 TLS_INCLUDE=-I/usr/local/openssl/include/
1873 .endd
1874 .cindex "USE_GNUTLS"
1875 If GnuTLS is installed, you should set
1876 .code
1877 SUPPORT_TLS=yes
1878 USE_GNUTLS=yes
1879 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1880 .endd
1881 in &_Local/Makefile_&, and again you may need to specify the locations of the
1882 library and include files. For example:
1883 .code
1884 SUPPORT_TLS=yes
1885 USE_GNUTLS=yes
1886 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1887 TLS_INCLUDE=-I/usr/gnu/include
1888 .endd
1889 You do not need to set TLS_INCLUDE if the relevant directory is already
1890 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1891 given in chapter &<<CHAPTLS>>&.
1892
1893
1894
1895
1896 .section "Use of tcpwrappers" "SECID27"
1897 .cindex "tcpwrappers, building Exim to support"
1898 .cindex "USE_TCP_WRAPPERS"
1899 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1900 .cindex "tcp_wrappers_daemon_name"
1901 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1902 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1903 alternative to Exim's own checking facilities for installations that are
1904 already making use of &'tcpwrappers'& for other purposes. To do this, you
1905 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1906 &_tcpd.h_& to be available at compile time, and also ensure that the library
1907 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1908 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1909 you might have
1910 .code
1911 USE_TCP_WRAPPERS=yes
1912 CFLAGS=-O -I/usr/local/include
1913 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1914 .endd
1915 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1916 files is &"exim"&. For example, the line
1917 .code
1918 exim : LOCAL  192.168.1.  .friendly.domain.example
1919 .endd
1920 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1921 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1922 All other connections are denied. The daemon name used by &'tcpwrappers'&
1923 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
1924 in &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
1925 configure file. Consult the &'tcpwrappers'& documentation for
1926 further details.
1927
1928
1929
1930 .section "Including support for IPv6" "SECID28"
1931 .cindex "IPv6" "including support for"
1932 Exim contains code for use on systems that have IPv6 support. Setting
1933 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
1934 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
1935 where the IPv6 support is not fully integrated into the normal include and
1936 library files.
1937
1938 Two different types of DNS record for handling IPv6 addresses have been
1939 defined. AAAA records (analogous to A records for IPv4) are in use, and are
1940 currently seen as the mainstream. Another record type called A6 was proposed
1941 as better than AAAA because it had more flexibility. However, it was felt to be
1942 over-complex, and its status was reduced to &"experimental"&. It is not known
1943 if anyone is actually using A6 records. Exim has support for A6 records, but
1944 this is included only if you set &`SUPPORT_A6=YES`& in &_Local/Makefile_&. The
1945 support has not been tested for some time.
1946
1947
1948
1949 .section "The building process" "SECID29"
1950 .cindex "build directory"
1951 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
1952 created, run &'make'& at the top level. It determines the architecture and
1953 operating system types, and creates a build directory if one does not exist.
1954 For example, on a Sun system running Solaris 8, the directory
1955 &_build-SunOS5-5.8-sparc_& is created.
1956 .cindex "symbolic link" "to source files"
1957 Symbolic links to relevant source files are installed in the build directory.
1958
1959 &*Warning*&: The &%-j%& (parallel) flag must not be used with &'make'&; the
1960 building process fails if it is set.
1961
1962 If this is the first time &'make'& has been run, it calls a script that builds
1963 a make file inside the build directory, using the configuration files from the
1964 &_Local_& directory. The new make file is then passed to another instance of
1965 &'make'&. This does the real work, building a number of utility scripts, and
1966 then compiling and linking the binaries for the Exim monitor (if configured), a
1967 number of utility programs, and finally Exim itself. The command &`make
1968 makefile`& can be used to force a rebuild of the make file in the build
1969 directory, should this ever be necessary.
1970
1971 If you have problems building Exim, check for any comments there may be in the
1972 &_README_& file concerning your operating system, and also take a look at the
1973 FAQ, where some common problems are covered.
1974
1975
1976
1977 .section 'Output from &"make"&' "SECID283"
1978 The output produced by the &'make'& process for compile lines is often very
1979 unreadable, because these lines can be very long. For this reason, the normal
1980 output is suppressed by default, and instead output similar to that which
1981 appears when compiling the 2.6 Linux kernel is generated: just a short line for
1982 each module that is being compiled or linked. However, it is still possible to
1983 get the full output, by calling &'make'& like this:
1984 .code
1985 FULLECHO='' make -e
1986 .endd
1987 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
1988 command reflection in &'make'&. When you ask for the full output, it is
1989 given in addition to the short output.
1990
1991
1992
1993 .section "Overriding build-time options for Exim" "SECToverride"
1994 .cindex "build-time options, overriding"
1995 The main make file that is created at the beginning of the building process
1996 consists of the concatenation of a number of files which set configuration
1997 values, followed by a fixed set of &'make'& instructions. If a value is set
1998 more than once, the last setting overrides any previous ones. This provides a
1999 convenient way of overriding defaults. The files that are concatenated are, in
2000 order:
2001 .display
2002 &_OS/Makefile-Default_&
2003 &_OS/Makefile-_&<&'ostype'&>
2004 &_Local/Makefile_&
2005 &_Local/Makefile-_&<&'ostype'&>
2006 &_Local/Makefile-_&<&'archtype'&>
2007 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2008 &_OS/Makefile-Base_&
2009 .endd
2010 .cindex "&_Local/Makefile_&"
2011 .cindex "building Exim" "operating system type"
2012 .cindex "building Exim" "architecture type"
2013 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2014 architecture type. &_Local/Makefile_& is required to exist, and the building
2015 process fails if it is absent. The other three &_Local_& files are optional,
2016 and are often not needed.
2017
2018 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2019 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2020 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2021 values are used, thereby providing a means of forcing particular settings.
2022 Otherwise, the scripts try to get values from the &%uname%& command. If this
2023 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2024 of &'ad hoc'& transformations are then applied, to produce the standard names
2025 that Exim expects. You can run these scripts directly from the shell in order
2026 to find out what values are being used on your system.
2027
2028
2029 &_OS/Makefile-Default_& contains comments about the variables that are set
2030 therein. Some (but not all) are mentioned below. If there is something that
2031 needs changing, review the contents of this file and the contents of the make
2032 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2033 default values are.
2034
2035
2036 .cindex "building Exim" "overriding default settings"
2037 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2038 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2039 need to change the original files. Instead, you should make the changes by
2040 putting the new values in an appropriate &_Local_& file. For example,
2041 .cindex "Tru64-Unix build-time settings"
2042 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2043 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2044 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2045 called with the option &%-std1%&, to make it recognize some of the features of
2046 Standard C that Exim uses. (Most other compilers recognize Standard C by
2047 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2048 containing the lines
2049 .code
2050 CC=cc
2051 CFLAGS=-std1
2052 .endd
2053 If you are compiling for just one operating system, it may be easier to put
2054 these lines directly into &_Local/Makefile_&.
2055
2056 Keeping all your local configuration settings separate from the distributed
2057 files makes it easy to transfer them to new versions of Exim simply by copying
2058 the contents of the &_Local_& directory.
2059
2060
2061 .cindex "NIS lookup type" "including support for"
2062 .cindex "NIS+ lookup type" "including support for"
2063 .cindex "LDAP" "including support for"
2064 .cindex "lookup" "inclusion in binary"
2065 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2066 lookup, but not all systems have these components installed, so the default is
2067 not to include the relevant code in the binary. All the different kinds of file
2068 and database lookup that Exim supports are implemented as separate code modules
2069 which are included only if the relevant compile-time options are set. In the
2070 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2071 .code
2072 LOOKUP_LDAP=yes
2073 LOOKUP_NIS=yes
2074 LOOKUP_NISPLUS=yes
2075 .endd
2076 and similar settings apply to the other lookup types. They are all listed in
2077 &_src/EDITME_&. In many cases the relevant include files and interface
2078 libraries need to be installed before compiling Exim.
2079 .cindex "cdb" "including support for"
2080 However, there are some optional lookup types (such as cdb) for which
2081 the code is entirely contained within Exim, and no external include
2082 files or libraries are required. When a lookup type is not included in the
2083 binary, attempts to configure Exim to use it cause run time configuration
2084 errors.
2085
2086 .cindex "Perl" "including support for"
2087 Exim can be linked with an embedded Perl interpreter, allowing Perl
2088 subroutines to be called during string expansion. To enable this facility,
2089 .code
2090 EXIM_PERL=perl.o
2091 .endd
2092 must be defined in &_Local/Makefile_&. Details of this facility are given in
2093 chapter &<<CHAPperl>>&.
2094
2095 .cindex "X11 libraries, location of"
2096 The location of the X11 libraries is something that varies a lot between
2097 operating systems, and there may be different versions of X11 to cope
2098 with. Exim itself makes no use of X11, but if you are compiling the Exim
2099 monitor, the X11 libraries must be available.
2100 The following three variables are set in &_OS/Makefile-Default_&:
2101 .code
2102 X11=/usr/X11R6
2103 XINCLUDE=-I$(X11)/include
2104 XLFLAGS=-L$(X11)/lib
2105 .endd
2106 These are overridden in some of the operating-system configuration files. For
2107 example, in &_OS/Makefile-SunOS5_& there is
2108 .code
2109 X11=/usr/openwin
2110 XINCLUDE=-I$(X11)/include
2111 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2112 .endd
2113 If you need to override the default setting for your operating system, place a
2114 definition of all three of these variables into your
2115 &_Local/Makefile-<ostype>_& file.
2116
2117 .cindex "EXTRALIBS"
2118 If you need to add any extra libraries to the link steps, these can be put in a
2119 variable called EXTRALIBS, which appears in all the link commands, but by
2120 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2121 command for linking the main Exim binary, and not for any associated utilities.
2122
2123 .cindex "DBM libraries" "configuration for building"
2124 There is also DBMLIB, which appears in the link commands for binaries that
2125 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2126 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2127 binary, and which can be used, for example, to include additional X11
2128 libraries.
2129
2130 .cindex "configuration file" "editing"
2131 The make file copes with rebuilding Exim correctly if any of the configuration
2132 files are edited. However, if an optional configuration file is deleted, it is
2133 necessary to touch the associated non-optional file (that is,
2134 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2135
2136
2137 .section "OS-specific header files" "SECID30"
2138 .cindex "&_os.h_&"
2139 .cindex "building Exim" "OS-specific C header files"
2140 The &_OS_& directory contains a number of files with names of the form
2141 &_os.h-<ostype>_&. These are system-specific C header files that should not
2142 normally need to be changed. There is a list of macro settings that are
2143 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2144 are porting Exim to a new operating system.
2145
2146
2147
2148 .section "Overriding build-time options for the monitor" "SECID31"
2149 .cindex "building Eximon"
2150 A similar process is used for overriding things when building the Exim monitor,
2151 where the files that are involved are
2152 .display
2153 &_OS/eximon.conf-Default_&
2154 &_OS/eximon.conf-_&<&'ostype'&>
2155 &_Local/eximon.conf_&
2156 &_Local/eximon.conf-_&<&'ostype'&>
2157 &_Local/eximon.conf-_&<&'archtype'&>
2158 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2159 .endd
2160 .cindex "&_Local/eximon.conf_&"
2161 As with Exim itself, the final three files need not exist, and in this case the
2162 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2163 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2164 variables of the same name, preceded by EXIMON_. For example, setting
2165 EXIMON_LOG_DEPTH in the environment overrides the value of
2166 LOG_DEPTH at run time.
2167 .ecindex IIDbuex
2168
2169
2170 .section "Installing Exim binaries and scripts" "SECID32"
2171 .cindex "installing Exim"
2172 .cindex "BIN_DIRECTORY"
2173 The command &`make install`& runs the &(exim_install)& script with no
2174 arguments. The script copies binaries and utility scripts into the directory
2175 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2176 .cindex "setuid" "installing Exim with"
2177 The install script copies files only if they are newer than the files they are
2178 going to replace. The Exim binary is required to be owned by root and have the
2179 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2180 install`& as root so that it can set up the Exim binary in this way. However, in
2181 some special situations (for example, if a host is doing no local deliveries)
2182 it may be possible to run Exim without making the binary setuid root (see
2183 chapter &<<CHAPsecurity>>& for details).
2184
2185 .cindex "CONFIGURE_FILE"
2186 Exim's run time configuration file is named by the CONFIGURE_FILE setting
2187 in &_Local/Makefile_&. If this names a single file, and the file does not
2188 exist, the default configuration file &_src/configure.default_& is copied there
2189 by the installation script. If a run time configuration file already exists, it
2190 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2191 alternative files, no default is installed.
2192
2193 .cindex "system aliases file"
2194 .cindex "&_/etc/aliases_&"
2195 One change is made to the default configuration file when it is installed: the
2196 default configuration contains a router that references a system aliases file.
2197 The path to this file is set to the value specified by
2198 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2199 If the system aliases file does not exist, the installation script creates it,
2200 and outputs a comment to the user.
2201
2202 The created file contains no aliases, but it does contain comments about the
2203 aliases a site should normally have. Mail aliases have traditionally been
2204 kept in &_/etc/aliases_&. However, some operating systems are now using
2205 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2206 Exim's configuration if necessary.
2207
2208 The default configuration uses the local host's name as the only local domain,
2209 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2210 running as the local user. System aliases and &_.forward_& files in users' home
2211 directories are supported, but no NIS or NIS+ support is configured. Domains
2212 other than the name of the local host are routed using the DNS, with delivery
2213 over SMTP.
2214
2215 It is possible to install Exim for special purposes (such as building a binary
2216 distribution) in a private part of the file system. You can do this by a
2217 command such as
2218 .code
2219 make DESTDIR=/some/directory/ install
2220 .endd
2221 This has the effect of pre-pending the specified directory to all the file
2222 paths, except the name of the system aliases file that appears in the default
2223 configuration. (If a default alias file is created, its name &'is'& modified.)
2224 For backwards compatibility, ROOT is used if DESTDIR is not set,
2225 but this usage is deprecated.
2226
2227 .cindex "installing Exim" "what is not installed"
2228 Running &'make install'& does not copy the Exim 4 conversion script
2229 &'convert4r4'&. You will probably run this only once if you are
2230 upgrading from Exim 3. None of the documentation files in the &_doc_&
2231 directory are copied, except for the info files when you have set
2232 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2233
2234 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2235 to their names. The Exim binary itself, however, is handled differently. It is
2236 installed under a name that includes the version number and the compile number,
2237 for example &_exim-&version;-1_&. The script then arranges for a symbolic link
2238 called &_exim_& to point to the binary. If you are updating a previous version
2239 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2240 from the directory (as seen by other processes).
2241
2242 .cindex "installing Exim" "testing the script"
2243 If you want to see what the &'make install'& will do before running it for
2244 real, you can pass the &%-n%& option to the installation script by this
2245 command:
2246 .code
2247 make INSTALL_ARG=-n install
2248 .endd
2249 The contents of the variable INSTALL_ARG are passed to the installation
2250 script. You do not need to be root to run this test. Alternatively, you can run
2251 the installation script directly, but this must be from within the build
2252 directory. For example, from the top-level Exim directory you could use this
2253 command:
2254 .code
2255 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2256 .endd
2257 .cindex "installing Exim" "install script options"
2258 There are two other options that can be supplied to the installation script.
2259
2260 .ilist
2261 &%-no_chown%& bypasses the call to change the owner of the installed binary
2262 to root, and the call to make it a setuid binary.
2263 .next
2264 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2265 installed binary.
2266 .endlist
2267
2268 INSTALL_ARG can be used to pass these options to the script. For example:
2269 .code
2270 make INSTALL_ARG=-no_symlink install
2271 .endd
2272 The installation script can also be given arguments specifying which files are
2273 to be copied. For example, to install just the Exim binary, and nothing else,
2274 without creating the symbolic link, you could use:
2275 .code
2276 make INSTALL_ARG='-no_symlink exim' install
2277 .endd
2278
2279
2280
2281 .section "Installing info documentation" "SECTinsinfdoc"
2282 .cindex "installing Exim" "&'info'& documentation"
2283 Not all systems use the GNU &'info'& system for documentation, and for this
2284 reason, the Texinfo source of Exim's documentation is not included in the main
2285 distribution. Instead it is available separately from the ftp site (see section
2286 &<<SECTavail>>&).
2287
2288 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2289 source of the documentation is found in the source tree, running &`make
2290 install`& automatically builds the info files and installs them.
2291
2292
2293
2294 .section "Setting up the spool directory" "SECID33"
2295 .cindex "spool directory" "creating"
2296 When it starts up, Exim tries to create its spool directory if it does not
2297 exist. The Exim uid and gid are used for the owner and group of the spool
2298 directory. Sub-directories are automatically created in the spool directory as
2299 necessary.
2300
2301
2302
2303
2304 .section "Testing" "SECID34"
2305 .cindex "testing" "installation"
2306 Having installed Exim, you can check that the run time configuration file is
2307 syntactically valid by running the following command, which assumes that the
2308 Exim binary directory is within your PATH environment variable:
2309 .code
2310 exim -bV
2311 .endd
2312 If there are any errors in the configuration file, Exim outputs error messages.
2313 Otherwise it outputs the version number and build date,
2314 the DBM library that is being used, and information about which drivers and
2315 other optional code modules are included in the binary.
2316 Some simple routing tests can be done by using the address testing option. For
2317 example,
2318 .display
2319 &`exim -bt`& <&'local username'&>
2320 .endd
2321 should verify that it recognizes a local mailbox, and
2322 .display
2323 &`exim -bt`& <&'remote address'&>
2324 .endd
2325 a remote one. Then try getting it to deliver mail, both locally and remotely.
2326 This can be done by passing messages directly to Exim, without going through a
2327 user agent. For example:
2328 .code
2329 exim -v postmaster@your.domain.example
2330 From: user@your.domain.example
2331 To: postmaster@your.domain.example
2332 Subject: Testing Exim
2333
2334 This is a test message.
2335 ^D
2336 .endd
2337 The &%-v%& option causes Exim to output some verification of what it is doing.
2338 In this case you should see copies of three log lines, one for the message's
2339 arrival, one for its delivery, and one containing &"Completed"&.
2340
2341 .cindex "delivery" "problems with"
2342 If you encounter problems, look at Exim's log files (&'mainlog'& and
2343 &'paniclog'&) to see if there is any relevant information there. Another source
2344 of information is running Exim with debugging turned on, by specifying the
2345 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2346 with debugging turned on by a command of the form
2347 .display
2348 &`exim -d -M`& <&'exim-message-id'&>
2349 .endd
2350 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2351 produces rather a lot of output, but you can cut this down to specific areas.
2352 For example, if you use &%-d-all+route%& only the debugging information
2353 relevant to routing is included. (See the &%-d%& option in chapter
2354 &<<CHAPcommandline>>& for more details.)
2355
2356 .cindex '&"sticky"& bit'
2357 .cindex "lock files"
2358 One specific problem that has shown up on some sites is the inability to do
2359 local deliveries into a shared mailbox directory, because it does not have the
2360 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2361 writing to a mailbox file, and if it cannot create the lock file, the delivery
2362 is deferred. You can get round this either by setting the &"sticky bit"& on the
2363 directory, or by setting a specific group for local deliveries and allowing
2364 that group to create files in the directory (see the comments above the
2365 &(local_delivery)& transport in the default configuration file). Another
2366 approach is to configure Exim not to use lock files, but just to rely on
2367 &[fcntl()]& locking instead. However, you should do this only if all user
2368 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2369 see chapter &<<CHAPappendfile>>&.
2370
2371 One thing that cannot be tested on a system that is already running an MTA is
2372 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2373 &%-oX%& option can be used to run an Exim daemon that listens on some other
2374 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2375 &'exim_checkaccess'& utility can be used to check out policy controls on
2376 incoming SMTP mail.
2377
2378 Testing a new version on a system that is already running Exim can most easily
2379 be done by building a binary with a different CONFIGURE_FILE setting. From
2380 within the run time configuration, all other file and directory names
2381 that Exim uses can be altered, in order to keep it entirely clear of the
2382 production version.
2383
2384
2385 .section "Replacing another MTA with Exim" "SECID35"
2386 .cindex "replacing another MTA"
2387 Building and installing Exim for the first time does not of itself put it in
2388 general use. The name by which the system's MTA is called by mail user agents
2389 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2390 operating system), and it is necessary to make this name point to the &'exim'&
2391 binary in order to get the user agents to pass messages to Exim. This is
2392 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2393 or &_/usr/lib/sendmail_&
2394 .cindex "symbolic link" "to &'exim'& binary"
2395 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2396 privilege and executable status from the old MTA. It is then necessary to stop
2397 and restart the mailer daemon, if one is running.
2398
2399 .cindex "FreeBSD, MTA indirection"
2400 .cindex "&_/etc/mail/mailer.conf_&"
2401 Some operating systems have introduced alternative ways of switching MTAs. For
2402 example, if you are running FreeBSD, you need to edit the file
2403 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2404 described. A typical example of the contents of this file for running Exim is
2405 as follows:
2406 .code
2407 sendmail            /usr/exim/bin/exim
2408 send-mail           /usr/exim/bin/exim
2409 mailq               /usr/exim/bin/exim -bp
2410 newaliases          /usr/bin/true
2411 .endd
2412 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2413 your Exim installation is &"live"&. Check it by sending a message from your
2414 favourite user agent.
2415
2416 You should consider what to tell your users about the change of MTA. Exim may
2417 have different capabilities to what was previously running, and there are
2418 various operational differences such as the text of messages produced by
2419 command line options and in bounce messages. If you allow your users to make
2420 use of Exim's filtering capabilities, you should make the document entitled
2421 &'Exim's interface to mail filtering'& available to them.
2422
2423
2424
2425 .section "Upgrading Exim" "SECID36"
2426 .cindex "upgrading Exim"
2427 If you are already running Exim on your host, building and installing a new
2428 version automatically makes it available to MUAs, or any other programs that
2429 call the MTA directly. However, if you are running an Exim daemon, you do need
2430 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2431 new binary. You do not need to stop processing mail in order to install a new
2432 version of Exim. The install script does not modify an existing runtime
2433 configuration file.
2434
2435
2436
2437
2438 .section "Stopping the Exim daemon on Solaris" "SECID37"
2439 .cindex "Solaris" "stopping Exim on"
2440 The standard command for stopping the mailer daemon on Solaris is
2441 .code
2442 /etc/init.d/sendmail stop
2443 .endd
2444 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2445 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2446 for the text &"sendmail"&; this is not present because the actual program name
2447 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2448 solution is to replace the line that finds the process id with something like
2449 .code
2450 pid=`cat /var/spool/exim/exim-daemon.pid`
2451 .endd
2452 to obtain the daemon's pid directly from the file that Exim saves it in.
2453
2454 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2455 still be received from local processes, and if automatic delivery is configured
2456 (the normal case), deliveries will still occur.
2457
2458
2459
2460
2461 . ////////////////////////////////////////////////////////////////////////////
2462 . ////////////////////////////////////////////////////////////////////////////
2463
2464 .chapter "The Exim command line" "CHAPcommandline"
2465 .scindex IIDclo1 "command line" "options"
2466 .scindex IIDclo2 "options" "command line"
2467 Exim's command line takes the standard Unix form of a sequence of options,
2468 each starting with a hyphen character, followed by a number of arguments. The
2469 options are compatible with the main options of Sendmail, and there are also
2470 some additional options, some of which are compatible with Smail 3. Certain
2471 combinations of options do not make sense, and provoke an error if used.
2472 The form of the arguments depends on which options are set.
2473
2474
2475 .section "Setting options by program name" "SECID38"
2476 .cindex "&'mailq'&"
2477 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2478 were present before any other options.
2479 The &%-bp%& option requests a listing of the contents of the mail queue on the
2480 standard output.
2481 This feature is for compatibility with some systems that contain a command of
2482 that name in one of the standard libraries, symbolically linked to
2483 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2484
2485 .cindex "&'rsmtp'&"
2486 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2487 were present before any other options, for compatibility with Smail. The
2488 &%-bS%& option is used for reading in a number of messages in batched SMTP
2489 format.
2490
2491 .cindex "&'rmail'&"
2492 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2493 &%-oee%& options were present before any other options, for compatibility with
2494 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2495
2496 .cindex "&'runq'&"
2497 .cindex "queue runner"
2498 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2499 were present before any other options, for compatibility with Smail. The &%-q%&
2500 option causes a single queue runner process to be started.
2501
2502 .cindex "&'newaliases'&"
2503 .cindex "alias file" "building"
2504 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2505 If Exim is called under the name &'newaliases'& it behaves as if the option
2506 &%-bi%& were present before any other options, for compatibility with Sendmail.
2507 This option is used for rebuilding Sendmail's alias file. Exim does not have
2508 the concept of a single alias file, but can be configured to run a given
2509 command if called with the &%-bi%& option.
2510
2511
2512 .section "Trusted and admin users" "SECTtrustedadmin"
2513 Some Exim options are available only to &'trusted users'& and others are
2514 available only to &'admin users'&. In the description below, the phrases &"Exim
2515 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2516 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2517 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2518
2519 .ilist
2520 .cindex "trusted users" "definition of"
2521 .cindex "user" "trusted definition of"
2522 The trusted users are root, the Exim user, any user listed in the
2523 &%trusted_users%& configuration option, and any user whose current group or any
2524 supplementary group is one of those listed in the &%trusted_groups%&
2525 configuration option. Note that the Exim group is not automatically trusted.
2526
2527 .cindex '&"From"& line'
2528 .cindex "envelope sender"
2529 Trusted users are always permitted to use the &%-f%& option or a leading
2530 &"From&~"& line to specify the envelope sender of a message that is passed to
2531 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2532 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2533 users to set envelope senders.
2534
2535 .cindex "&'From:'& header line"
2536 .cindex "&'Sender:'& header line"
2537 For a trusted user, there is never any check on the contents of the &'From:'&
2538 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2539 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2540
2541 Trusted users may also specify a host name, host address, interface address,
2542 protocol name, ident value, and authentication data when submitting a message
2543 locally. Thus, they are able to insert messages into Exim's queue locally that
2544 have the characteristics of messages received from a remote host. Untrusted
2545 users may in some circumstances use &%-f%&, but can never set the other values
2546 that are available to trusted users.
2547 .next
2548 .cindex "user" "admin definition of"
2549 .cindex "admin user" "definition of"
2550 The admin users are root, the Exim user, and any user that is a member of the
2551 Exim group or of any group listed in the &%admin_groups%& configuration option.
2552 The current group does not have to be one of these groups.
2553
2554 Admin users are permitted to list the queue, and to carry out certain
2555 operations on messages, for example, to force delivery failures. It is also
2556 necessary to be an admin user in order to see the full information provided by
2557 the Exim monitor, and full debugging output.
2558
2559 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2560 Exim to attempt delivery of messages on its queue is restricted to admin users.
2561 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2562 option false (that is, specifying &%no_prod_requires_admin%&).
2563
2564 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2565 is restricted to admin users unless &%queue_list_requires_admin%& is set
2566 false.
2567 .endlist
2568
2569
2570 &*Warning*&: If you configure your system so that admin users are able to
2571 edit Exim's configuration file, you are giving those users an easy way of
2572 getting root. There is further discussion of this issue at the start of chapter
2573 &<<CHAPconf>>&.
2574
2575
2576
2577
2578 .section "Command line options" "SECID39"
2579 Exim's command line options are described in alphabetical order below. If none
2580 of the options that specifies a specific action (such as starting the daemon or
2581 a queue runner, or testing an address, or receiving a message in a specific
2582 format, or listing the queue) are present, and there is at least one argument
2583 on the command line, &%-bm%& (accept a local message on the standard input,
2584 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2585 outputs a brief message about itself and exits.
2586
2587 . ////////////////////////////////////////////////////////////////////////////
2588 . Insert a stylized XML comment here, to identify the start of the command line
2589 . options. This is for the benefit of the Perl script that automatically
2590 . creates a man page for the options.
2591 . ////////////////////////////////////////////////////////////////////////////
2592
2593 .literal xml
2594 <!-- === Start of command line options === -->
2595 .literal off
2596
2597
2598 .vlist
2599 .vitem &%--%&
2600 .oindex "--"
2601 .cindex "options" "command line; terminating"
2602 This is a pseudo-option whose only purpose is to terminate the options and
2603 therefore to cause subsequent command line items to be treated as arguments
2604 rather than options, even if they begin with hyphens.
2605
2606 .vitem &%--help%&
2607 .oindex "&%--help%&"
2608 This option causes Exim to output a few sentences stating what it is.
2609 The same output is generated if the Exim binary is called with no options and
2610 no arguments.
2611
2612 .vitem &%--version%&
2613 .oindex "&%--version%&"
2614 This option is an alias for &%-bV%& and causes version information to be
2615 displayed.
2616
2617 .vitem &%-B%&<&'type'&>
2618 .oindex "&%-B%&"
2619 .cindex "8-bit characters"
2620 .cindex "Sendmail compatibility" "8-bit characters"
2621 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2622 clean; it ignores this option.
2623
2624 .vitem &%-bd%&
2625 .oindex "&%-bd%&"
2626 .cindex "daemon"
2627 .cindex "SMTP" "listener"
2628 .cindex "queue runner"
2629 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2630 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2631 that the daemon should also initiate periodic queue runs.
2632
2633 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2634 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2635 disconnect from the controlling terminal. When running this way, it can be
2636 stopped by pressing ctrl-C.
2637
2638 By default, Exim listens for incoming connections to the standard SMTP port on
2639 all the host's running interfaces. However, it is possible to listen on other
2640 ports, on multiple ports, and only on specific interfaces. Chapter
2641 &<<CHAPinterfaces>>& contains a description of the options that control this.
2642
2643 When a listening daemon
2644 .cindex "daemon" "process id (pid)"
2645 .cindex "pid (process id)" "of daemon"
2646 is started without the use of &%-oX%& (that is, without overriding the normal
2647 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2648 in Exim's spool directory. This location can be overridden by setting
2649 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2650 running as root.
2651
2652 When &%-oX%& is used on the command line to start a listening daemon, the
2653 process id is not written to the normal pid file path. However, &%-oP%& can be
2654 used to specify a path on the command line if a pid file is required.
2655
2656 The SIGHUP signal
2657 .cindex "SIGHUP"
2658 .cindex "daemon" "restarting"
2659 can be used to cause the daemon to re-execute itself. This should be done
2660 whenever Exim's configuration file, or any file that is incorporated into it by
2661 means of the &%.include%& facility, is changed, and also whenever a new version
2662 of Exim is installed. It is not necessary to do this when other files that are
2663 referenced from the configuration (for example, alias files) are changed,
2664 because these are reread each time they are used.
2665
2666 .vitem &%-bdf%&
2667 .oindex "&%-bdf%&"
2668 This option has the same effect as &%-bd%& except that it never disconnects
2669 from the controlling terminal, even when no debugging is specified.
2670
2671 .vitem &%-be%&
2672 .oindex "&%-be%&"
2673 .cindex "testing" "string expansion"
2674 .cindex "expansion" "testing"
2675 Run Exim in expansion testing mode. Exim discards its root privilege, to
2676 prevent ordinary users from using this mode to read otherwise inaccessible
2677 files. If no arguments are given, Exim runs interactively, prompting for lines
2678 of data. Otherwise, it processes each argument in turn.
2679
2680 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2681 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2682 used without command line arguments. If successful, it uses the &[readline()]&
2683 function, which provides extensive line-editing facilities, for reading the
2684 test data. A line history is supported.
2685
2686 Long expansion expressions can be split over several lines by using backslash
2687 continuations. As in Exim's run time configuration, white space at the start of
2688 continuation lines is ignored. Each argument or data line is passed through the
2689 string expansion mechanism, and the result is output. Variable values from the
2690 configuration file (for example, &$qualify_domain$&) are available, but no
2691 message-specific values (such as &$sender_domain$&) are set, because no message
2692 is being processed (but see &%-bem%& and &%-Mset%&).
2693
2694 &*Note*&: If you use this mechanism to test lookups, and you change the data
2695 files or databases you are using, you must exit and restart Exim before trying
2696 the same lookup again. Otherwise, because each Exim process caches the results
2697 of lookups, you will just get the same result as before.
2698
2699 .vitem &%-bem%&&~<&'filename'&>
2700 .oindex "&%-bem%&"
2701 .cindex "testing" "string expansion"
2702 .cindex "expansion" "testing"
2703 This option operates like &%-be%& except that it must be followed by the name
2704 of a file. For example:
2705 .code
2706 exim -bem /tmp/testmessage
2707 .endd
2708 The file is read as a message (as if receiving a locally-submitted non-SMTP
2709 message) before any of the test expansions are done. Thus, message-specific
2710 variables such as &$message_size$& and &$header_from:$& are available. However,
2711 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2712 recipients are read from the headers in the normal way, and are shown in the
2713 &$recipients$& variable. Note that recipients cannot be given on the command
2714 line, because further arguments are taken as strings to expand (just like
2715 &%-be%&).
2716
2717 .vitem &%-bF%&&~<&'filename'&>
2718 .oindex "&%-bF%&"
2719 .cindex "system filter" "testing"
2720 .cindex "testing" "system filter"
2721 This option is the same as &%-bf%& except that it assumes that the filter being
2722 tested is a system filter. The additional commands that are available only in
2723 system filters are recognized.
2724
2725 .vitem &%-bf%&&~<&'filename'&>
2726 .oindex "&%-bf%&"
2727 .cindex "filter" "testing"
2728 .cindex "testing" "filter file"
2729 .cindex "forward file" "testing"
2730 .cindex "testing" "forward file"
2731 .cindex "Sieve filter" "testing"
2732 This option runs Exim in user filter testing mode; the file is the filter file
2733 to be tested, and a test message must be supplied on the standard input. If
2734 there are no message-dependent tests in the filter, an empty file can be
2735 supplied.
2736
2737 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2738 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2739 filter and a user filter in the same run. For example:
2740 .code
2741 exim -bF /system/filter -bf /user/filter </test/message
2742 .endd
2743 This is helpful when the system filter adds header lines or sets filter
2744 variables that are used by the user filter.
2745
2746 If the test filter file does not begin with one of the special lines
2747 .code
2748 # Exim filter
2749 # Sieve filter
2750 .endd
2751 it is taken to be a normal &_.forward_& file, and is tested for validity under
2752 that interpretation. See sections &<<SECTitenonfilred>>& to
2753 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2754 redirection lists.
2755
2756 The result of an Exim command that uses &%-bf%&, provided no errors are
2757 detected, is a list of the actions that Exim would try to take if presented
2758 with the message for real. More details of filter testing are given in the
2759 separate document entitled &'Exim's interfaces to mail filtering'&.
2760
2761 When testing a filter file,
2762 .cindex "&""From""& line"
2763 .cindex "envelope sender"
2764 .oindex "&%-f%&" "for filter testing"
2765 the envelope sender can be set by the &%-f%& option,
2766 or by a &"From&~"& line at the start of the test message. Various parameters
2767 that would normally be taken from the envelope recipient address of the message
2768 can be set by means of additional command line options (see the next four
2769 options).
2770
2771 .vitem &%-bfd%&&~<&'domain'&>
2772 .oindex "&%-bfd%&"
2773 .vindex "&$qualify_domain$&"
2774 This sets the domain of the recipient address when a filter file is being
2775 tested by means of the &%-bf%& option. The default is the value of
2776 &$qualify_domain$&.
2777
2778 .vitem &%-bfl%&&~<&'local&~part'&>
2779 .oindex "&%-bfl%&"
2780 This sets the local part of the recipient address when a filter file is being
2781 tested by means of the &%-bf%& option. The default is the username of the
2782 process that calls Exim. A local part should be specified with any prefix or
2783 suffix stripped, because that is how it appears to the filter when a message is
2784 actually being delivered.
2785
2786 .vitem &%-bfp%&&~<&'prefix'&>
2787 .oindex "&%-bfp%&"
2788 This sets the prefix of the local part of the recipient address when a filter
2789 file is being tested by means of the &%-bf%& option. The default is an empty
2790 prefix.
2791
2792 .vitem &%-bfs%&&~<&'suffix'&>
2793 .oindex "&%-bfs%&"
2794 This sets the suffix of the local part of the recipient address when a filter
2795 file is being tested by means of the &%-bf%& option. The default is an empty
2796 suffix.
2797
2798 .vitem &%-bh%&&~<&'IP&~address'&>
2799 .oindex "&%-bh%&"
2800 .cindex "testing" "incoming SMTP"
2801 .cindex "SMTP" "testing incoming"
2802 .cindex "testing" "relay control"
2803 .cindex "relaying" "testing configuration"
2804 .cindex "policy control" "testing"
2805 .cindex "debugging" "&%-bh%& option"
2806 This option runs a fake SMTP session as if from the given IP address, using the
2807 standard input and output. The IP address may include a port number at the end,
2808 after a full stop. For example:
2809 .code
2810 exim -bh 10.9.8.7.1234
2811 exim -bh fe80::a00:20ff:fe86:a061.5678
2812 .endd
2813 When an IPv6 address is given, it is converted into canonical form. In the case
2814 of the second example above, the value of &$sender_host_address$& after
2815 conversion to the canonical form is
2816 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2817
2818 Comments as to what is going on are written to the standard error file. These
2819 include lines beginning with &"LOG"& for anything that would have been logged.
2820 This facility is provided for testing configuration options for incoming
2821 messages, to make sure they implement the required policy. For example, you can
2822 test your relay controls using &%-bh%&.
2823
2824 &*Warning 1*&:
2825 .cindex "RFC 1413"
2826 You can test features of the configuration that rely on ident (RFC 1413)
2827 information by using the &%-oMt%& option. However, Exim cannot actually perform
2828 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2829 connection.
2830
2831 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2832 are also skipped when testing using &%-bh%&. If you want these callouts to
2833 occur, use &%-bhc%& instead.
2834
2835 Messages supplied during the testing session are discarded, and nothing is
2836 written to any of the real log files. There may be pauses when DNS (and other)
2837 lookups are taking place, and of course these may time out. The &%-oMi%& option
2838 can be used to specify a specific IP interface and port if this is important,
2839 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2840 session were authenticated.
2841
2842 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2843 output just states whether a given recipient address from a given host is
2844 acceptable or not. See section &<<SECTcheckaccess>>&.
2845
2846 Features such as authentication and encryption, where the client input is not
2847 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2848 specialized SMTP test program such as
2849 &url(http://jetmore.org/john/code/#swaks,swaks).
2850
2851 .vitem &%-bhc%&&~<&'IP&~address'&>
2852 .oindex "&%-bhc%&"
2853 This option operates in the same way as &%-bh%&, except that address
2854 verification callouts are performed if required. This includes consulting and
2855 updating the callout cache database.
2856
2857 .vitem &%-bi%&
2858 .oindex "&%-bi%&"
2859 .cindex "alias file" "building"
2860 .cindex "building alias file"
2861 .cindex "Sendmail compatibility" "&%-bi%& option"
2862 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2863 Exim does not have the concept of a single alias file, and so it cannot mimic
2864 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2865 tend to appear in various scripts such as NIS make files, so the option must be
2866 recognized.
2867
2868 If &%-bi%& is encountered, the command specified by the &%bi_command%&
2869 configuration option is run, under the uid and gid of the caller of Exim. If
2870 the &%-oA%& option is used, its value is passed to the command as an argument.
2871 The command set by &%bi_command%& may not contain arguments. The command can
2872 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
2873 if this is required. If the &%bi_command%& option is not set, calling Exim with
2874 &%-bi%& is a no-op.
2875
2876 .vitem &%-bm%&
2877 .oindex "&%-bm%&"
2878 .cindex "local message reception"
2879 This option runs an Exim receiving process that accepts an incoming,
2880 locally-generated message on the current input. The recipients are given as the
2881 command arguments (except when &%-t%& is also present &-- see below). Each
2882 argument can be a comma-separated list of RFC 2822 addresses. This is the
2883 default option for selecting the overall action of an Exim call; it is assumed
2884 if no other conflicting option is present.
2885
2886 If any addresses in the message are unqualified (have no domain), they are
2887 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
2888 options, as appropriate. The &%-bnq%& option (see below) provides a way of
2889 suppressing this for special cases.
2890
2891 Policy checks on the contents of local messages can be enforced by means of
2892 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
2893
2894 .cindex "return code" "for &%-bm%&"
2895 The return code is zero if the message is successfully accepted. Otherwise, the
2896 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
2897
2898 The format
2899 .cindex "message" "format"
2900 .cindex "format" "message"
2901 .cindex "&""From""& line"
2902 .cindex "UUCP" "&""From""& line"
2903 .cindex "Sendmail compatibility" "&""From""& line"
2904 of the message must be as defined in RFC 2822, except that, for
2905 compatibility with Sendmail and Smail, a line in one of the forms
2906 .code
2907 From sender Fri Jan  5 12:55 GMT 1997
2908 From sender Fri, 5 Jan 97 12:55:01
2909 .endd
2910 (with the weekday optional, and possibly with additional text after the date)
2911 is permitted to appear at the start of the message. There appears to be no
2912 authoritative specification of the format of this line. Exim recognizes it by
2913 matching against the regular expression defined by the &%uucp_from_pattern%&
2914 option, which can be changed if necessary.
2915
2916 .oindex "&%-f%&" "overriding &""From""& line"
2917 The specified sender is treated as if it were given as the argument to the
2918 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
2919 preference to the address taken from the message. The caller of Exim must be a
2920 trusted user for the sender of a message to be set in this way.
2921
2922 .vitem &%-bnq%&
2923 .oindex "&%-bnq%&"
2924 .cindex "address qualification, suppressing"
2925 By default, Exim automatically qualifies unqualified addresses (those
2926 without domains) that appear in messages that are submitted locally (that
2927 is, not over TCP/IP). This qualification applies both to addresses in
2928 envelopes, and addresses in header lines. Sender addresses are qualified using
2929 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
2930 defaults to the value of &%qualify_domain%&).
2931
2932 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
2933 being used to re-submit messages that originally came from remote hosts after
2934 content scanning, you probably do not want to qualify unqualified addresses in
2935 header lines. (Such lines will be present only if you have not enabled a header
2936 syntax check in the appropriate ACL.)
2937
2938 The &%-bnq%& option suppresses all qualification of unqualified addresses in
2939 messages that originate on the local host. When this is used, unqualified
2940 addresses in the envelope provoke errors (causing message rejection) and
2941 unqualified addresses in header lines are left alone.
2942
2943
2944 .vitem &%-bP%&
2945 .oindex "&%-bP%&"
2946 .cindex "configuration options" "extracting"
2947 .cindex "options" "configuration &-- extracting"
2948 If this option is given with no arguments, it causes the values of all Exim's
2949 main configuration options to be written to the standard output. The values
2950 of one or more specific options can be requested by giving their names as
2951 arguments, for example:
2952 .code
2953 exim -bP qualify_domain hold_domains
2954 .endd
2955 .cindex "hiding configuration option values"
2956 .cindex "configuration options" "hiding value of"
2957 .cindex "options" "hiding value of"
2958 However, any option setting that is preceded by the word &"hide"& in the
2959 configuration file is not shown in full, except to an admin user. For other
2960 users, the output is as in this example:
2961 .code
2962 mysql_servers = <value not displayable>
2963 .endd
2964 If &%configure_file%& is given as an argument, the name of the run time
2965 configuration file is output.
2966 If a list of configuration files was supplied, the value that is output here
2967 is the name of the file that was actually used.
2968
2969 .cindex "daemon" "process id (pid)"
2970 .cindex "pid (process id)" "of daemon"
2971 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
2972 directories where log files and daemon pid files are written are output,
2973 respectively. If these values are unset, log files are written in a
2974 sub-directory of the spool directory called &%log%&, and the pid file is
2975 written directly into the spool directory.
2976
2977 If &%-bP%& is followed by a name preceded by &`+`&, for example,
2978 .code
2979 exim -bP +local_domains
2980 .endd
2981 it searches for a matching named list of any type (domain, host, address, or
2982 local part) and outputs what it finds.
2983
2984 .cindex "options" "router &-- extracting"
2985 .cindex "options" "transport &-- extracting"
2986 .cindex "options" "authenticator &-- extracting"
2987 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
2988 followed by the name of an appropriate driver instance, the option settings for
2989 that driver are output. For example:
2990 .code
2991 exim -bP transport local_delivery
2992 .endd
2993 The generic driver options are output first, followed by the driver's private
2994 options. A list of the names of drivers of a particular type can be obtained by
2995 using one of the words &%router_list%&, &%transport_list%&, or
2996 &%authenticator_list%&, and a complete list of all drivers with their option
2997 settings can be obtained by using &%routers%&, &%transports%&, or
2998 &%authenticators%&.
2999
3000 .cindex "options" "macro &-- extracting"
3001 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3002 are available, similarly to the drivers.  Because macros are sometimes used
3003 for storing passwords, this option is restricted.
3004 The output format is one item per line.
3005
3006 .vitem &%-bp%&
3007 .oindex "&%-bp%&"
3008 .cindex "queue" "listing messages on"
3009 .cindex "listing" "messages on the queue"
3010 This option requests a listing of the contents of the mail queue on the
3011 standard output. If the &%-bp%& option is followed by a list of message ids,
3012 just those messages are listed. By default, this option can be used only by an
3013 admin user. However, the &%queue_list_requires_admin%& option can be set false
3014 to allow any user to see the queue.
3015
3016 Each message on the queue is displayed as in the following example:
3017 .code
3018 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3019           red.king@looking-glass.fict.example
3020           <other addresses>
3021 .endd
3022 .cindex "message" "size in queue listing"
3023 .cindex "size" "of message"
3024 The first line contains the length of time the message has been on the queue
3025 (in this case 25 minutes), the size of the message (2.9K), the unique local
3026 identifier for the message, and the message sender, as contained in the
3027 envelope. For bounce messages, the sender address is empty, and appears as
3028 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3029 the default sender address, the user's login name is shown in parentheses
3030 before the sender address.
3031
3032 .cindex "frozen messages" "in queue listing"
3033 If the message is frozen (attempts to deliver it are suspended) then the text
3034 &"*** frozen ***"& is displayed at the end of this line.
3035
3036 The recipients of the message (taken from the envelope, not the headers) are
3037 displayed on subsequent lines. Those addresses to which the message has already
3038 been delivered are marked with the letter D. If an original address gets
3039 expanded into several addresses via an alias or forward file, the original is
3040 displayed with a D only when deliveries for all of its child addresses are
3041 complete.
3042
3043
3044 .vitem &%-bpa%&
3045 .oindex "&%-bpa%&"
3046 This option operates like &%-bp%&, but in addition it shows delivered addresses
3047 that were generated from the original top level address(es) in each message by
3048 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3049 of just &"D"&.
3050
3051
3052 .vitem &%-bpc%&
3053 .oindex "&%-bpc%&"
3054 .cindex "queue" "count of messages on"
3055 This option counts the number of messages on the queue, and writes the total
3056 to the standard output. It is restricted to admin users, unless
3057 &%queue_list_requires_admin%& is set false.
3058
3059
3060 .vitem &%-bpr%&
3061 .oindex "&%-bpr%&"
3062 This option operates like &%-bp%&, but the output is not sorted into
3063 chronological order of message arrival. This can speed it up when there are
3064 lots of messages on the queue, and is particularly useful if the output is
3065 going to be post-processed in a way that doesn't need the sorting.
3066
3067 .vitem &%-bpra%&
3068 .oindex "&%-bpra%&"
3069 This option is a combination of &%-bpr%& and &%-bpa%&.
3070
3071 .vitem &%-bpru%&
3072 .oindex "&%-bpru%&"
3073 This option is a combination of &%-bpr%& and &%-bpu%&.
3074
3075
3076 .vitem &%-bpu%&
3077 .oindex "&%-bpu%&"
3078 This option operates like &%-bp%& but shows only undelivered top-level
3079 addresses for each message displayed. Addresses generated by aliasing or
3080 forwarding are not shown, unless the message was deferred after processing by a
3081 router with the &%one_time%& option set.
3082
3083
3084 .vitem &%-brt%&
3085 .oindex "&%-brt%&"
3086 .cindex "testing" "retry configuration"
3087 .cindex "retry" "configuration testing"
3088 This option is for testing retry rules, and it must be followed by up to three
3089 arguments. It causes Exim to look for a retry rule that matches the values
3090 and to write it to the standard output. For example:
3091 .code
3092 exim -brt bach.comp.mus.example
3093 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3094 .endd
3095 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3096 argument, which is required, can be a complete address in the form
3097 &'local_part@domain'&, or it can be just a domain name. If the second argument
3098 contains a dot, it is interpreted as an optional second domain name; if no
3099 retry rule is found for the first argument, the second is tried. This ties in
3100 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3101 rule is found that matches the host, one that matches the mail domain is
3102 sought. Finally, an argument that is the name of a specific delivery error, as
3103 used in setting up retry rules, can be given. For example:
3104 .code
3105 exim -brt haydn.comp.mus.example quota_3d
3106 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3107 .endd
3108
3109 .vitem &%-brw%&
3110 .oindex "&%-brw%&"
3111 .cindex "testing" "rewriting"
3112 .cindex "rewriting" "testing"
3113 This option is for testing address rewriting rules, and it must be followed by
3114 a single argument, consisting of either a local part without a domain, or a
3115 complete address with a fully qualified domain. Exim outputs how this address
3116 would be rewritten for each possible place it might appear. See chapter
3117 &<<CHAPrewrite>>& for further details.
3118
3119 .vitem &%-bS%&
3120 .oindex "&%-bS%&"
3121 .cindex "SMTP" "batched incoming"
3122 .cindex "batched SMTP input"
3123 This option is used for batched SMTP input, which is an alternative interface
3124 for non-interactive local message submission. A number of messages can be
3125 submitted in a single run. However, despite its name, this is not really SMTP
3126 input. Exim reads each message's envelope from SMTP commands on the standard
3127 input, but generates no responses. If the caller is trusted, or
3128 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3129 believed; otherwise the sender is always the caller of Exim.
3130
3131 The message itself is read from the standard input, in SMTP format (leading
3132 dots doubled), terminated by a line containing just a single dot. An error is
3133 provoked if the terminating dot is missing. A further message may then follow.
3134
3135 As for other local message submissions, the contents of incoming batch SMTP
3136 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3137 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3138 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3139
3140 Some other SMTP commands are recognized in the input. HELO and EHLO act
3141 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3142 QUIT quits, ignoring the rest of the standard input.
3143
3144 .cindex "return code" "for &%-bS%&"
3145 If any error is encountered, reports are written to the standard output and
3146 error streams, and Exim gives up immediately. The return code is 0 if no error
3147 was detected; it is 1 if one or more messages were accepted before the error
3148 was detected; otherwise it is 2.
3149
3150 More details of input using batched SMTP are given in section
3151 &<<SECTincomingbatchedSMTP>>&.
3152
3153 .vitem &%-bs%&
3154 .oindex "&%-bs%&"
3155 .cindex "SMTP" "local input"
3156 .cindex "local SMTP input"
3157 This option causes Exim to accept one or more messages by reading SMTP commands
3158 on the standard input, and producing SMTP replies on the standard output. SMTP
3159 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3160 Some user agents use this interface as a way of passing locally-generated
3161 messages to the MTA.
3162
3163 In
3164 .cindex "sender" "source of"
3165 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3166 set, the senders of messages are taken from the SMTP MAIL commands.
3167 Otherwise the content of these commands is ignored and the sender is set up as
3168 the calling user. Unqualified addresses are automatically qualified using
3169 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3170 &%-bnq%& option is used.
3171
3172 .cindex "inetd"
3173 The
3174 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3175 using a listening daemon. Exim can distinguish the two cases by checking
3176 whether the standard input is a TCP/IP socket. When Exim is called from
3177 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3178 above concerning senders and qualification do not apply. In this situation,
3179 Exim behaves in exactly the same way as it does when receiving a message via
3180 the listening daemon.
3181
3182 .vitem &%-bmalware%&&~<&'filename'&>
3183 .oindex "&%-bmalware%&"
3184 .cindex "testing", "malware"
3185 .cindex "malware scan test"
3186 This debugging option causes Exim to scan the given file,
3187 using the malware scanning framework.  The option of &%av_scanner%& influences
3188 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3189 the expansion should have defaults which apply to this invocation.  ACLs are
3190 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3191 will never be populated and &%-bmalware%& will fail.
3192
3193 Exim will have changed working directory before resolving the filename, so
3194 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3195 user when it tries to open the file, rather than as the invoking user.
3196 This option requires admin privileges.
3197
3198 The &%-bmalware%& option will not be extended to be more generally useful,
3199 there are better tools for file-scanning.  This option exists to help
3200 administrators verify their Exim and AV scanner configuration.
3201
3202 .vitem &%-bt%&
3203 .oindex "&%-bt%&"
3204 .cindex "testing" "addresses"
3205 .cindex "address" "testing"
3206 This option runs Exim in address testing mode, in which each argument is taken
3207 as a recipient address to be tested for deliverability. The results are
3208 written to the standard output. If a test fails, and the caller is not an admin
3209 user, no details of the failure are output, because these might contain
3210 sensitive information such as usernames and passwords for database lookups.
3211
3212 If no arguments are given, Exim runs in an interactive manner, prompting with a
3213 right angle bracket for addresses to be tested.
3214
3215 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3216 &[readline()]& function, because it is running as &'root'& and there are
3217 security issues.
3218
3219 Each address is handled as if it were the recipient address of a message
3220 (compare the &%-bv%& option). It is passed to the routers and the result is
3221 written to the standard output. However, any router that has
3222 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3223 genuine routing tests if your first router passes everything to a scanner
3224 program.
3225
3226 .cindex "return code" "for &%-bt%&"
3227 The return code is 2 if any address failed outright; it is 1 if no address
3228 failed outright but at least one could not be resolved for some reason. Return
3229 code 0 is given only when all addresses succeed.
3230
3231 .cindex "duplicate addresses"
3232 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3233 addresses after routing is complete, so that only one delivery takes place.
3234 This does not happen when testing with &%-bt%&; the full results of routing are
3235 always shown.
3236
3237 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3238 routers in the configuration makes any tests on the sender address of a
3239 message,
3240 .oindex "&%-f%&" "for address testing"
3241 you can use the &%-f%& option to set an appropriate sender when running
3242 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3243 default qualifying domain. However, if you have set up (for example) routers
3244 whose behaviour depends on the contents of an incoming message, you cannot test
3245 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3246 doing such tests.
3247
3248 .vitem &%-bV%&
3249 .oindex "&%-bV%&"
3250 .cindex "version number of Exim"
3251 This option causes Exim to write the current version number, compilation
3252 number, and compilation date of the &'exim'& binary to the standard output.
3253 It also lists the DBM library this is being used, the optional modules (such as
3254 specific lookup types), the drivers that are included in the binary, and the
3255 name of the run time configuration file that is in use.
3256
3257 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3258 configuration file. However, this is a static check only. It cannot check
3259 values that are to be expanded. For example, although a misspelt ACL verb is
3260 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3261 alone to discover (for example) all the typos in the configuration; some
3262 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3263 dynamic testing facilities.
3264
3265 .vitem &%-bv%&
3266 .oindex "&%-bv%&"
3267 .cindex "verifying address" "using &%-bv%&"
3268 .cindex "address" "verification"
3269 This option runs Exim in address verification mode, in which each argument is
3270 taken as a recipient address to be verified by the routers. (This does
3271 not involve any verification callouts). During normal operation, verification
3272 happens mostly as a consequence processing a &%verify%& condition in an ACL
3273 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3274 including callouts, see the &%-bh%& and &%-bhc%& options.
3275
3276 If verification fails, and the caller is not an admin user, no details of the
3277 failure are output, because these might contain sensitive information such as
3278 usernames and passwords for database lookups.
3279
3280 If no arguments are given, Exim runs in an interactive manner, prompting with a
3281 right angle bracket for addresses to be verified.
3282
3283 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3284 &[readline()]& function, because it is running as &'exim'& and there are
3285 security issues.
3286
3287 Verification differs from address testing (the &%-bt%& option) in that routers
3288 that have &%no_verify%& set are skipped, and if the address is accepted by a
3289 router that has &%fail_verify%& set, verification fails. The address is
3290 verified as a recipient if &%-bv%& is used; to test verification for a sender
3291 address, &%-bvs%& should be used.
3292
3293 If the &%-v%& option is not set, the output consists of a single line for each
3294 address, stating whether it was verified or not, and giving a reason in the
3295 latter case. Without &%-v%&, generating more than one address by redirection
3296 causes verification to end successfully, without considering the generated
3297 addresses. However, if just one address is generated, processing continues,
3298 and the generated address must verify successfully for the overall verification
3299 to succeed.
3300
3301 When &%-v%& is set, more details are given of how the address has been handled,
3302 and in the case of address redirection, all the generated addresses are also
3303 considered. Verification may succeed for some and fail for others.
3304
3305 The
3306 .cindex "return code" "for &%-bv%&"
3307 return code is 2 if any address failed outright; it is 1 if no address
3308 failed outright but at least one could not be resolved for some reason. Return
3309 code 0 is given only when all addresses succeed.
3310
3311 If any of the routers in the configuration makes any tests on the sender
3312 address of a message, you should use the &%-f%& option to set an appropriate
3313 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3314 calling user at the default qualifying domain.
3315
3316 .vitem &%-bvs%&
3317 .oindex "&%-bvs%&"
3318 This option acts like &%-bv%&, but verifies the address as a sender rather
3319 than a recipient address. This affects any rewriting and qualification that
3320 might happen.
3321
3322 .vitem &%-C%&&~<&'filelist'&>
3323 .oindex "&%-C%&"
3324 .cindex "configuration file" "alternate"
3325 .cindex "CONFIGURE_FILE"
3326 .cindex "alternate configuration file"
3327 This option causes Exim to find the run time configuration file from the given
3328 list instead of from the list specified by the CONFIGURE_FILE
3329 compile-time setting. Usually, the list will consist of just a single file
3330 name, but it can be a colon-separated list of names. In this case, the first
3331 file that exists is used. Failure to open an existing file stops Exim from
3332 proceeding any further along the list, and an error is generated.
3333
3334 When this option is used by a caller other than root, and the list is different
3335 from the compiled-in list, Exim gives up its root privilege immediately, and
3336 runs with the real and effective uid and gid set to those of the caller.
3337 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, root
3338 privilege is retained for any configuration file which is listed in that file
3339 as long as the caller is the Exim user (or the user specified in the
3340 CONFIGURE_OWNER option, if any).
3341
3342 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3343 configuration using &%-C%& right through message reception and delivery,
3344 even if the caller is root. The reception works, but by that time, Exim is
3345 running as the Exim user, so when it re-executes to regain privilege for the
3346 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3347 test reception and delivery using two separate commands (one to put a message
3348 on the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3349
3350 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3351 prefix string with which any file named in a &%-C%& command line option
3352 must start. In addition, the file name must not contain the sequence &`/../`&.
3353 However, if the value of the &%-C%& option is identical to the value of
3354 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3355 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3356 unset, any file name can be used with &%-C%&.
3357
3358 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3359 to a directory to which only root has access. This prevents someone who has
3360 broken into the Exim account from running a privileged Exim with an arbitrary
3361 configuration file.
3362
3363 The &%-C%& facility is useful for ensuring that configuration files are
3364 syntactically correct, but cannot be used for test deliveries, unless the
3365 caller is privileged, or unless it is an exotic configuration that does not
3366 require privilege. No check is made on the owner or group of the files
3367 specified by this option.
3368
3369 .vitem &%-D%&<&'macro'&>=<&'value'&>
3370 .oindex "&%-D%&"
3371 .cindex "macro" "setting on command line"
3372 This option can be used to override macro definitions in the configuration file
3373 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3374 unprivileged caller, it causes Exim to give up its root privilege.
3375 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3376 completely disabled, and its use causes an immediate error exit.
3377
3378 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3379 colon-separated list of macros which are considered safe and, if &%-D%& only
3380 supplies macros from this list, and the values are acceptable, then Exim will
3381 not give up root privilege if the caller is root, the Exim run-time user, or
3382 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3383 to be removed in the future.  Acceptable values for the macros satisfy the
3384 regexp: &`^[A-Za-z0-9_/.-]*$`&
3385
3386 The entire option (including equals sign if present) must all be within one
3387 command line item. &%-D%& can be used to set the value of a macro to the empty
3388 string, in which case the equals sign is optional. These two commands are
3389 synonymous:
3390 .code
3391 exim -DABC  ...
3392 exim -DABC= ...
3393 .endd
3394 To include spaces in a macro definition item, quotes must be used. If you use
3395 quotes, spaces are permitted around the macro name and the equals sign. For
3396 example:
3397 .code
3398 exim '-D ABC = something' ...
3399 .endd
3400 &%-D%& may be repeated up to 10 times on a command line.
3401
3402 .vitem &%-d%&<&'debug&~options'&>
3403 .oindex "&%-d%&"
3404 .cindex "debugging" "list of selectors"
3405 .cindex "debugging" "&%-d%& option"
3406 This option causes debugging information to be written to the standard
3407 error stream. It is restricted to admin users because debugging output may show
3408 database queries that contain password information. Also, the details of users'
3409 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3410 writes an error message to the standard error stream and exits with a non-zero
3411 return code.
3412
3413 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3414 standard debugging data is output. This can be reduced, or increased to include
3415 some more rarely needed information, by directly following &%-d%& with a string
3416 made up of names preceded by plus or minus characters. These add or remove sets
3417 of debugging data, respectively. For example, &%-d+filter%& adds filter
3418 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3419 no spaces are allowed in the debug setting. The available debugging categories
3420 are:
3421 .display
3422 &`acl            `& ACL interpretation
3423 &`auth           `& authenticators
3424 &`deliver        `& general delivery logic
3425 &`dns            `& DNS lookups (see also resolver)
3426 &`dnsbl          `& DNS black list (aka RBL) code
3427 &`exec           `& arguments for &[execv()]& calls
3428 &`expand         `& detailed debugging for string expansions
3429 &`filter         `& filter handling
3430 &`hints_lookup   `& hints data lookups
3431 &`host_lookup    `& all types of name-to-IP address handling
3432 &`ident          `& ident lookup
3433 &`interface      `& lists of local interfaces
3434 &`lists          `& matching things in lists
3435 &`load           `& system load checks
3436 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3437                     &<<CHAPlocalscan>>&)
3438 &`lookup         `& general lookup code and all lookups
3439 &`memory         `& memory handling
3440 &`pid            `& add pid to debug output lines
3441 &`process_info   `& setting info for the process log
3442 &`queue_run      `& queue runs
3443 &`receive        `& general message reception logic
3444 &`resolver       `& turn on the DNS resolver's debugging output
3445 &`retry          `& retry handling
3446 &`rewrite        `& address rewriting
3447 &`route          `& address routing
3448 &`timestamp      `& add timestamp to debug output lines
3449 &`tls            `& TLS logic
3450 &`transport      `& transports
3451 &`uid            `& changes of uid/gid and looking up uid/gid
3452 &`verify         `& address verification logic
3453 &`all            `& almost all of the above (see below), and also &%-v%&
3454 .endd
3455 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3456 for &`-all`&. The reason for this is that &`+all`& is something that people
3457 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3458 is included, an awful lot of output that is very rarely of interest is
3459 generated, so it now has to be explicitly requested. However, &`-all`& does
3460 turn everything off.
3461
3462 .cindex "resolver, debugging output"
3463 .cindex "DNS resolver, debugging output"
3464 The &`resolver`& option produces output only if the DNS resolver was compiled
3465 with DEBUG enabled. This is not the case in some operating systems. Also,
3466 unfortunately, debugging output from the DNS resolver is written to stdout
3467 rather than stderr.
3468
3469 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3470 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3471 However, the &`pid`& selector is forced when debugging is turned on for a
3472 daemon, which then passes it on to any re-executed Exims. Exim also
3473 automatically adds the pid to debug lines when several remote deliveries are
3474 run in parallel.
3475
3476 The &`timestamp`& selector causes the current time to be inserted at the start
3477 of all debug output lines. This can be useful when trying to track down delays
3478 in processing.
3479
3480 If the &%debug_print%& option is set in any driver, it produces output whenever
3481 any debugging is selected, or if &%-v%& is used.
3482
3483 .vitem &%-dd%&<&'debug&~options'&>
3484 .oindex "&%-dd%&"
3485 This option behaves exactly like &%-d%& except when used on a command that
3486 starts a daemon process. In that case, debugging is turned off for the
3487 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3488 behaviour of the daemon without creating as much output as full debugging does.
3489
3490 .vitem &%-dropcr%&
3491 .oindex "&%-dropcr%&"
3492 This is an obsolete option that is now a no-op. It used to affect the way Exim
3493 handled CR and LF characters in incoming messages. What happens now is
3494 described in section &<<SECTlineendings>>&.
3495
3496 .vitem &%-E%&
3497 .oindex "&%-E%&"
3498 .cindex "bounce message" "generating"
3499 This option specifies that an incoming message is a locally-generated delivery
3500 failure report. It is used internally by Exim when handling delivery failures
3501 and is not intended for external use. Its only effect is to stop Exim
3502 generating certain messages to the postmaster, as otherwise message cascades
3503 could occur in some situations. As part of the same option, a message id may
3504 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3505 new message contains the id, following &"R="&, as a cross-reference.
3506
3507 .vitem &%-e%&&'x'&
3508 .oindex "&%-e%&&'x'&"
3509 There are a number of Sendmail options starting with &%-oe%& which seem to be
3510 called by various programs without the leading &%o%& in the option. For
3511 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3512 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3513
3514 .vitem &%-F%&&~<&'string'&>
3515 .oindex "&%-F%&"
3516 .cindex "sender" "name"
3517 .cindex "name" "of sender"
3518 This option sets the sender's full name for use when a locally-generated
3519 message is being accepted. In the absence of this option, the user's &'gecos'&
3520 entry from the password data is used. As users are generally permitted to alter
3521 their &'gecos'& entries, no security considerations are involved. White space
3522 between &%-F%& and the <&'string'&> is optional.
3523
3524 .vitem &%-f%&&~<&'address'&>
3525 .oindex "&%-f%&"
3526 .cindex "sender" "address"
3527 .cindex "address" "sender"
3528 .cindex "trusted users"
3529 .cindex "envelope sender"
3530 .cindex "user" "trusted"
3531 This option sets the address of the envelope sender of a locally-generated
3532 message (also known as the return path). The option can normally be used only
3533 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3534 users to use it.
3535
3536 Processes running as root or the Exim user are always trusted. Other
3537 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3538 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3539 of a local message is set to the caller's login name at the default qualify
3540 domain.
3541
3542 There is one exception to the restriction on the use of &%-f%&: an empty sender
3543 can be specified by any user, trusted or not, to create a message that can
3544 never provoke a bounce. An empty sender can be specified either as an empty
3545 string, or as a pair of angle brackets with nothing between them, as in these
3546 examples of shell commands:
3547 .code
3548 exim -f '<>' user@domain
3549 exim -f "" user@domain
3550 .endd
3551 In addition, the use of &%-f%& is not restricted when testing a filter file
3552 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3553 &%-bv%& options.
3554
3555 Allowing untrusted users to change the sender address does not of itself make
3556 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3557 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3558 though this can be overridden by setting &%no_local_from_check%&.
3559
3560 White
3561 .cindex "&""From""& line"
3562 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3563 given as two arguments or one combined argument). The sender of a
3564 locally-generated message can also be set (when permitted) by an initial
3565 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3566 if &%-f%& is also present, it overrides &"From&~"&.
3567
3568 .vitem &%-G%&
3569 .oindex "&%-G%&"
3570 .cindex "Sendmail compatibility" "&%-G%& option ignored"
3571 This is a Sendmail option which is ignored by Exim.
3572
3573 .vitem &%-h%&&~<&'number'&>
3574 .oindex "&%-h%&"
3575 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3576 This option is accepted for compatibility with Sendmail, but has no effect. (In
3577 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3578 headers.)
3579
3580 .vitem &%-i%&
3581 .oindex "&%-i%&"
3582 .cindex "Solaris" "&'mail'& command"
3583 .cindex "dot" "in incoming non-SMTP message"
3584 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3585 line by itself should not terminate an incoming, non-SMTP message. I can find
3586 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3587 command in Solaris 2.4 uses it. See also &%-ti%&.
3588
3589 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3590 .oindex "&%-M%&"
3591 .cindex "forcing delivery"
3592 .cindex "delivery" "forcing attempt"
3593 .cindex "frozen messages" "forcing delivery"
3594 This option requests Exim to run a delivery attempt on each message in turn. If
3595 any of the messages are frozen, they are automatically thawed before the
3596 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3597 and &%hold_domains%& are ignored.
3598
3599 Retry
3600 .cindex "hints database" "overriding retry hints"
3601 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3602 the normal retry time has not yet been reached. This option requires the caller
3603 to be an admin user. However, there is an option called &%prod_requires_admin%&
3604 which can be set false to relax this restriction (and also the same requirement
3605 for the &%-q%&, &%-R%&, and &%-S%& options).
3606
3607 The deliveries happen synchronously, that is, the original Exim process does
3608 not terminate until all the delivery attempts have finished. No output is
3609 produced unless there is a serious error. If you want to see what is happening,
3610 use the &%-v%& option as well, or inspect Exim's main log.
3611
3612 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3613 .oindex "&%-Mar%&"
3614 .cindex "message" "adding recipients"
3615 .cindex "recipient" "adding"
3616 This option requests Exim to add the addresses to the list of recipients of the
3617 message (&"ar"& for &"add recipients"&). The first argument must be a message
3618 id, and the remaining ones must be email addresses. However, if the message is
3619 active (in the middle of a delivery attempt), it is not altered. This option
3620 can be used only by an admin user.
3621
3622 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3623         &~<&'message&~id'&>"
3624 .oindex "&%-MC%&"
3625 .cindex "SMTP" "passed connection"
3626 .cindex "SMTP" "multiple deliveries"
3627 .cindex "multiple SMTP deliveries"
3628 This option is not intended for use by external callers. It is used internally
3629 by Exim to invoke another instance of itself to deliver a waiting message using
3630 an existing SMTP connection, which is passed as the standard input. Details are
3631 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3632 must be root or the Exim user in order to use it.
3633
3634 .vitem &%-MCA%&
3635 .oindex "&%-MCA%&"
3636 This option is not intended for use by external callers. It is used internally
3637 by Exim in conjunction with the &%-MC%& option. It signifies that the
3638 connection to the remote host has been authenticated.
3639
3640 .vitem &%-MCP%&
3641 .oindex "&%-MCP%&"
3642 This option is not intended for use by external callers. It is used internally
3643 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3644 which Exim is connected supports pipelining.
3645
3646 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3647 .oindex "&%-MCQ%&"
3648 This option is not intended for use by external callers. It is used internally
3649 by Exim in conjunction with the &%-MC%& option when the original delivery was
3650 started by a queue runner. It passes on the process id of the queue runner,
3651 together with the file descriptor number of an open pipe. Closure of the pipe
3652 signals the final completion of the sequence of processes that are passing
3653 messages through the same SMTP connection.
3654
3655 .vitem &%-MCS%&
3656 .oindex "&%-MCS%&"
3657 This option is not intended for use by external callers. It is used internally
3658 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3659 SMTP SIZE option should be used on messages delivered down the existing
3660 connection.
3661
3662 .vitem &%-MCT%&
3663 .oindex "&%-MCT%&"
3664 This option is not intended for use by external callers. It is used internally
3665 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3666 host to which Exim is connected supports TLS encryption.
3667
3668 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3669 .oindex "&%-Mc%&"
3670 .cindex "hints database" "not overridden by &%-Mc%&"
3671 .cindex "delivery" "manually started &-- not forced"
3672 This option requests Exim to run a delivery attempt on each message in turn,
3673 but unlike the &%-M%& option, it does check for retry hints, and respects any
3674 that are found. This option is not very useful to external callers. It is
3675 provided mainly for internal use by Exim when it needs to re-invoke itself in
3676 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3677 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3678 respects retry times and other options such as &%hold_domains%& that are
3679 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3680 If you want to run a specific delivery as if in a queue run, you should use
3681 &%-q%& with a message id argument. A distinction between queue run deliveries
3682 and other deliveries is made in one or two places.
3683
3684 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3685 .oindex "&%-Mes%&"
3686 .cindex "message" "changing sender"
3687 .cindex "sender" "changing"
3688 This option requests Exim to change the sender address in the message to the
3689 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3690 &"edit sender"&). There must be exactly two arguments. The first argument must
3691 be a message id, and the second one an email address. However, if the message
3692 is active (in the middle of a delivery attempt), its status is not altered.
3693 This option can be used only by an admin user.
3694
3695 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3696 .oindex "&%-Mf%&"
3697 .cindex "freezing messages"
3698 .cindex "message" "manually freezing"
3699 This option requests Exim to mark each listed message as &"frozen"&. This
3700 prevents any delivery attempts taking place until the message is &"thawed"&,
3701 either manually or as a result of the &%auto_thaw%& configuration option.
3702 However, if any of the messages are active (in the middle of a delivery
3703 attempt), their status is not altered. This option can be used only by an admin
3704 user.
3705
3706 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3707 .oindex "&%-Mg%&"
3708 .cindex "giving up on messages"
3709 .cindex "message" "abandoning delivery attempts"
3710 .cindex "delivery" "abandoning further attempts"
3711 This option requests Exim to give up trying to deliver the listed messages,
3712 including any that are frozen. However, if any of the messages are active,
3713 their status is not altered. For non-bounce messages, a delivery error message
3714 is sent to the sender, containing the text &"cancelled by administrator"&.
3715 Bounce messages are just discarded. This option can be used only by an admin
3716 user.
3717
3718 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3719 .oindex "&%-Mmad%&"
3720 .cindex "delivery" "cancelling all"
3721 This option requests Exim to mark all the recipient addresses in the messages
3722 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3723 message is active (in the middle of a delivery attempt), its status is not
3724 altered. This option can be used only by an admin user.
3725
3726 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3727 .oindex "&%-Mmd%&"
3728 .cindex "delivery" "cancelling by address"
3729 .cindex "recipient" "removing"
3730 .cindex "removing recipients"
3731 This option requests Exim to mark the given addresses as already delivered
3732 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3733 the remaining ones must be email addresses. These are matched to recipient
3734 addresses in the message in a case-sensitive manner. If the message is active
3735 (in the middle of a delivery attempt), its status is not altered. This option
3736 can be used only by an admin user.
3737
3738 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3739 .oindex "&%-Mrm%&"
3740 .cindex "removing messages"
3741 .cindex "abandoning mail"
3742 .cindex "message" "manually discarding"
3743 This option requests Exim to remove the given messages from the queue. No
3744 bounce messages are sent; each message is simply forgotten. However, if any of
3745 the messages are active, their status is not altered. This option can be used
3746 only by an admin user or by the user who originally caused the message to be
3747 placed on the queue.
3748
3749 .vitem &%-Mset%&&~<&'message&~id'&>
3750 .oindex "&%-Mset%&
3751 .cindex "testing" "string expansion"
3752 .cindex "expansion" "testing"
3753 This option is useful only in conjunction with &%-be%& (that is, when testing
3754 string expansions). Exim loads the given message from its spool before doing
3755 the test expansions, thus setting message-specific variables such as
3756 &$message_size$& and the header variables. The &$recipients$& variable is made
3757 available. This feature is provided to make it easier to test expansions that
3758 make use of these variables. However, this option can be used only by an admin
3759 user. See also &%-bem%&.
3760
3761 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3762 .oindex "&%-Mt%&"
3763 .cindex "thawing messages"
3764 .cindex "unfreezing messages"
3765 .cindex "frozen messages" "thawing"
3766 .cindex "message" "thawing frozen"
3767 This option requests Exim to &"thaw"& any of the listed messages that are
3768 &"frozen"&, so that delivery attempts can resume. However, if any of the
3769 messages are active, their status is not altered. This option can be used only
3770 by an admin user.
3771
3772 .vitem &%-Mvb%&&~<&'message&~id'&>
3773 .oindex "&%-Mvb%&"
3774 .cindex "listing" "message body"
3775 .cindex "message" "listing body of"
3776 This option causes the contents of the message body (-D) spool file to be
3777 written to the standard output. This option can be used only by an admin user.
3778
3779 .vitem &%-Mvc%&&~<&'message&~id'&>
3780 .oindex "&%-Mvc%&"
3781 .cindex "message" "listing in RFC 2822 format"
3782 .cindex "listing" "message in RFC 2822 format"
3783 This option causes a copy of the complete message (header lines plus body) to
3784 be written to the standard output in RFC 2822 format. This option can be used
3785 only by an admin user.
3786
3787 .vitem &%-Mvh%&&~<&'message&~id'&>
3788 .oindex "&%-Mvh%&"
3789 .cindex "listing" "message headers"
3790 .cindex "header lines" "listing"
3791 .cindex "message" "listing header lines"
3792 This option causes the contents of the message headers (-H) spool file to be
3793 written to the standard output. This option can be used only by an admin user.
3794
3795 .vitem &%-Mvl%&&~<&'message&~id'&>
3796 .oindex "&%-Mvl%&"
3797 .cindex "listing" "message log"
3798 .cindex "message" "listing message log"
3799 This option causes the contents of the message log spool file to be written to
3800 the standard output. This option can be used only by an admin user.
3801
3802 .vitem &%-m%&
3803 .oindex "&%-m%&"
3804 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
3805 treats it that way too.
3806
3807 .vitem &%-N%&
3808 .oindex "&%-N%&"
3809 .cindex "debugging" "&%-N%& option"
3810 .cindex "debugging" "suppressing delivery"
3811 This is a debugging option that inhibits delivery of a message at the transport
3812 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
3813 it just doesn't actually transport the message, but instead behaves as if it
3814 had successfully done so. However, it does not make any updates to the retry
3815 database, and the log entries for deliveries are flagged with &"*>"& rather
3816 than &"=>"&.
3817
3818 Because &%-N%& discards any message to which it applies, only root or the Exim
3819 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
3820 words, an ordinary user can use it only when supplying an incoming message to
3821 which it will apply. Although transportation never fails when &%-N%& is set, an
3822 address may be deferred because of a configuration problem on a transport, or a
3823 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
3824 the message, and applies to any subsequent delivery attempts that may happen
3825 for that message.
3826
3827 .vitem &%-n%&
3828 .oindex "&%-n%&"
3829 .cindex "Sendmail compatibility" "&%-n%& option ignored"
3830 This option is interpreted by Sendmail to mean &"no aliasing"&. It is ignored
3831 by Exim.
3832
3833 .vitem &%-O%&&~<&'data'&>
3834 .oindex "&%-O%&"
3835 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
3836 Exim.
3837
3838 .vitem &%-oA%&&~<&'file&~name'&>
3839 .oindex "&%-oA%&"
3840 .cindex "Sendmail compatibility" "&%-oA%& option"
3841 This option is used by Sendmail in conjunction with &%-bi%& to specify an
3842 alternative alias file name. Exim handles &%-bi%& differently; see the
3843 description above.
3844
3845 .vitem &%-oB%&&~<&'n'&>
3846 .oindex "&%-oB%&"
3847 .cindex "SMTP" "passed connection"
3848 .cindex "SMTP" "multiple deliveries"
3849 .cindex "multiple SMTP deliveries"
3850 This is a debugging option which limits the maximum number of messages that can
3851 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
3852 transport. If <&'n'&> is omitted, the limit is set to 1.
3853
3854 .vitem &%-odb%&
3855 .oindex "&%-odb%&"
3856 .cindex "background delivery"
3857 .cindex "delivery" "in the background"
3858 This option applies to all modes in which Exim accepts incoming messages,
3859 including the listening daemon. It requests &"background"& delivery of such
3860 messages, which means that the accepting process automatically starts a
3861 delivery process for each message received, but does not wait for the delivery
3862 processes to finish.
3863
3864 When all the messages have been received, the reception process exits,
3865 leaving the delivery processes to finish in their own time. The standard output
3866 and error streams are closed at the start of each delivery process.
3867 This is the default action if none of the &%-od%& options are present.
3868
3869 If one of the queueing options in the configuration file
3870 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
3871 overrides it if &%queue_only_override%& is set true, which is the default
3872 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
3873
3874 .vitem &%-odf%&
3875 .oindex "&%-odf%&"
3876 .cindex "foreground delivery"
3877 .cindex "delivery" "in the foreground"
3878 This option requests &"foreground"& (synchronous) delivery when Exim has
3879 accepted a locally-generated message. (For the daemon it is exactly the same as
3880 &%-odb%&.) A delivery process is automatically started to deliver the message,
3881 and Exim waits for it to complete before proceeding.
3882
3883 The original Exim reception process does not finish until the delivery
3884 process for the final message has ended. The standard error stream is left open
3885 during deliveries.
3886
3887 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
3888 false and one of the queueing options in the configuration file is in effect.
3889
3890 If there is a temporary delivery error during foreground delivery, the
3891 message is left on the queue for later delivery, and the original reception
3892 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
3893 restricted configuration that never queues messages.
3894
3895
3896 .vitem &%-odi%&
3897 .oindex "&%-odi%&"
3898 This option is synonymous with &%-odf%&. It is provided for compatibility with
3899 Sendmail.
3900
3901 .vitem &%-odq%&
3902 .oindex "&%-odq%&"
3903 .cindex "non-immediate delivery"
3904 .cindex "delivery" "suppressing immediate"
3905 .cindex "queueing incoming messages"
3906 This option applies to all modes in which Exim accepts incoming messages,
3907 including the listening daemon. It specifies that the accepting process should
3908 not automatically start a delivery process for each message received. Messages
3909 are placed on the queue, and remain there until a subsequent queue runner
3910 process encounters them. There are several configuration options (such as
3911 &%queue_only%&) that can be used to queue incoming messages under certain
3912 conditions. This option overrides all of them and also &%-odqs%&. It always
3913 forces queueing.
3914
3915 .vitem &%-odqs%&
3916 .oindex "&%-odqs%&"
3917 .cindex "SMTP" "delaying delivery"
3918 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
3919 However, like &%-odb%& and &%-odi%&, this option has no effect if
3920 &%queue_only_override%& is false and one of the queueing options in the
3921 configuration file is in effect.
3922
3923 When &%-odqs%& does operate, a delivery process is started for each incoming
3924 message, in the background by default, but in the foreground if &%-odi%& is
3925 also present. The recipient addresses are routed, and local deliveries are done
3926 in the normal way. However, if any SMTP deliveries are required, they are not
3927 done at this time, so the message remains on the queue until a subsequent queue
3928 runner process encounters it. Because routing was done, Exim knows which
3929 messages are waiting for which hosts, and so a number of messages for the same
3930 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
3931 configuration option has the same effect for specific domains. See also the
3932 &%-qq%& option.
3933
3934 .vitem &%-oee%&
3935 .oindex "&%-oee%&"
3936 .cindex "error" "reporting"
3937 If an error is detected while a non-SMTP message is being received (for
3938 example, a malformed address), the error is reported to the sender in a mail
3939 message.
3940
3941 .cindex "return code" "for &%-oee%&"
3942 Provided
3943 this error message is successfully sent, the Exim receiving process
3944 exits with a return code of zero. If not, the return code is 2 if the problem
3945 is that the original message has no recipients, or 1 any other error. This is
3946 the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
3947
3948 .vitem &%-oem%&
3949 .oindex "&%-oem%&"
3950 .cindex "error" "reporting"
3951 .cindex "return code" "for &%-oem%&"
3952 This is the same as &%-oee%&, except that Exim always exits with a non-zero
3953 return code, whether or not the error message was successfully sent.
3954 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
3955
3956 .vitem &%-oep%&
3957 .oindex "&%-oep%&"
3958 .cindex "error" "reporting"
3959 If an error is detected while a non-SMTP message is being received, the
3960 error is reported by writing a message to the standard error file (stderr).
3961 .cindex "return code" "for &%-oep%&"
3962 The return code is 1 for all errors.
3963
3964 .vitem &%-oeq%&
3965 .oindex "&%-oeq%&"
3966 .cindex "error" "reporting"
3967 This option is supported for compatibility with Sendmail, but has the same
3968 effect as &%-oep%&.
3969
3970 .vitem &%-oew%&
3971 .oindex "&%-oew%&"
3972 .cindex "error" "reporting"
3973 This option is supported for compatibility with Sendmail, but has the same
3974 effect as &%-oem%&.
3975
3976 .vitem &%-oi%&
3977 .oindex "&%-oi%&"
3978 .cindex "dot" "in incoming non-SMTP message"
3979 This option, which has the same effect as &%-i%&, specifies that a dot on a
3980 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
3981 single dot does terminate, though Exim does no special processing for other
3982 lines that start with a dot. This option is set by default if Exim is called as
3983 &'rmail'&. See also &%-ti%&.
3984
3985 .vitem &%-oitrue%&
3986 .oindex "&%-oitrue%&"
3987 This option is treated as synonymous with &%-oi%&.
3988
3989 .vitem &%-oMa%&&~<&'host&~address'&>
3990 .oindex "&%-oMa%&"
3991 .cindex "sender" "host address, specifying for local message"
3992 A number of options starting with &%-oM%& can be used to set values associated
3993 with remote hosts on locally-submitted messages (that is, messages not received
3994 over TCP/IP). These options can be used by any caller in conjunction with the
3995 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
3996 other circumstances, they are ignored unless the caller is trusted.
3997
3998 The &%-oMa%& option sets the sender host address. This may include a port
3999 number at the end, after a full stop (period). For example:
4000 .code
4001 exim -bs -oMa 10.9.8.7.1234
4002 .endd
4003 An alternative syntax is to enclose the IP address in square brackets,
4004 followed by a colon and the port number:
4005 .code
4006 exim -bs -oMa [10.9.8.7]:1234
4007 .endd
4008 The IP address is placed in the &$sender_host_address$& variable, and the
4009 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4010 are present on the command line, the sender host IP address is taken from
4011 whichever one is last.
4012
4013 .vitem &%-oMaa%&&~<&'name'&>
4014 .oindex "&%-oMaa%&"
4015 .cindex "authentication" "name, specifying for local message"
4016 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4017 option sets the value of &$sender_host_authenticated$& (the authenticator
4018 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4019 This option can be used with &%-bh%& and &%-bs%& to set up an
4020 authenticated SMTP session without actually using the SMTP AUTH command.
4021
4022 .vitem &%-oMai%&&~<&'string'&>
4023 .oindex "&%-oMai%&"
4024 .cindex "authentication" "id, specifying for local message"
4025 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4026 option sets the value of &$authenticated_id$& (the id that was authenticated).
4027 This overrides the default value (the caller's login id, except with &%-bh%&,
4028 where there is no default) for messages from local sources. See chapter
4029 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4030
4031 .vitem &%-oMas%&&~<&'address'&>
4032 .oindex "&%-oMas%&"
4033 .cindex "authentication" "sender, specifying for local message"
4034 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4035 option sets the authenticated sender value in &$authenticated_sender$&. It
4036 overrides the sender address that is created from the caller's login id for
4037 messages from local sources, except when &%-bh%& is used, when there is no
4038 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4039 specified on a MAIL command overrides this value. See chapter
4040 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4041
4042 .vitem &%-oMi%&&~<&'interface&~address'&>
4043 .oindex "&%-oMi%&"
4044 .cindex "interface" "address, specifying for local message"
4045 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4046 option sets the IP interface address value. A port number may be included,
4047 using the same syntax as for &%-oMa%&. The interface address is placed in
4048 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4049
4050 .vitem &%-oMr%&&~<&'protocol&~name'&>
4051 .oindex "&%-oMr%&"
4052 .cindex "protocol, specifying for local message"
4053 .vindex "&$received_protocol$&"
4054 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4055 option sets the received protocol value that is stored in
4056 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4057 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4058 SMTP protocol names (see the description of &$received_protocol$& in section
4059 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4060 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4061 be set by &%-oMr%&.
4062
4063 .vitem &%-oMs%&&~<&'host&~name'&>
4064 .oindex "&%-oMs%&"
4065 .cindex "sender" "host name, specifying for local message"
4066 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4067 option sets the sender host name in &$sender_host_name$&. When this option is
4068 present, Exim does not attempt to look up a host name from an IP address; it
4069 uses the name it is given.
4070
4071 .vitem &%-oMt%&&~<&'ident&~string'&>
4072 .oindex "&%-oMt%&"
4073 .cindex "sender" "ident string, specifying for local message"
4074 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4075 option sets the sender ident value in &$sender_ident$&. The default setting for
4076 local callers is the login id of the calling process, except when &%-bh%& is
4077 used, when there is no default.
4078
4079 .vitem &%-om%&
4080 .oindex "&%-om%&"
4081 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4082 In Sendmail, this option means &"me too"&, indicating that the sender of a
4083 message should receive a copy of the message if the sender appears in an alias
4084 expansion. Exim always does this, so the option does nothing.
4085
4086 .vitem &%-oo%&
4087 .oindex "&%-oo%&"
4088 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4089 This option is ignored. In Sendmail it specifies &"old style headers"&,
4090 whatever that means.
4091
4092 .vitem &%-oP%&&~<&'path'&>
4093 .oindex "&%-oP%&"
4094 .cindex "pid (process id)" "of daemon"
4095 .cindex "daemon" "process id (pid)"
4096 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4097 value. The option specifies the file to which the process id of the daemon is
4098 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4099 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4100 because in those cases, the normal pid file is not used.
4101
4102 .vitem &%-or%&&~<&'time'&>
4103 .oindex "&%-or%&"
4104 .cindex "timeout" "for non-SMTP input"
4105 This option sets a timeout value for incoming non-SMTP messages. If it is not
4106 set, Exim will wait forever for the standard input. The value can also be set
4107 by the &%receive_timeout%& option. The format used for specifying times is
4108 described in section &<<SECTtimeformat>>&.
4109
4110 .vitem &%-os%&&~<&'time'&>
4111 .oindex "&%-os%&"
4112 .cindex "timeout" "for SMTP input"
4113 .cindex "SMTP" "input timeout"
4114 This option sets a timeout value for incoming SMTP messages. The timeout
4115 applies to each SMTP command and block of data. The value can also be set by
4116 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4117 for specifying times is described in section &<<SECTtimeformat>>&.
4118
4119 .vitem &%-ov%&
4120 .oindex "&%-ov%&"
4121 This option has exactly the same effect as &%-v%&.
4122
4123 .vitem &%-oX%&&~<&'number&~or&~string'&>
4124 .oindex "&%-oX%&"
4125 .cindex "TCP/IP" "setting listening ports"
4126 .cindex "TCP/IP" "setting listening interfaces"
4127 .cindex "port" "receiving TCP/IP"
4128 This option is relevant only when the &%-bd%& (start listening daemon) option
4129 is also given. It controls which ports and interfaces the daemon uses. Details
4130 of the syntax, and how it interacts with configuration file options, are given
4131 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4132 file is written unless &%-oP%& is also present to specify a pid file name.
4133
4134 .vitem &%-pd%&
4135 .oindex "&%-pd%&"
4136 .cindex "Perl" "starting the interpreter"
4137 This option applies when an embedded Perl interpreter is linked with Exim (see
4138 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4139 option, forcing the starting of the interpreter to be delayed until it is
4140 needed.
4141
4142 .vitem &%-ps%&
4143 .oindex "&%-ps%&"
4144 .cindex "Perl" "starting the interpreter"
4145 This option applies when an embedded Perl interpreter is linked with Exim (see
4146 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4147 option, forcing the starting of the interpreter to occur as soon as Exim is
4148 started.
4149
4150 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4151 .oindex "&%-p%&"
4152 For compatibility with Sendmail, this option is equivalent to
4153 .display
4154 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4155 .endd
4156 It sets the incoming protocol and host name (for trusted callers). The
4157 host name and its colon can be omitted when only the protocol is to be set.
4158 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4159 to embedded Perl. It is therefore impossible to set a protocol value of &`p`&
4160 or &`s`& using this option (but that does not seem a real limitation).
4161
4162 .vitem &%-q%&
4163 .oindex "&%-q%&"
4164 .cindex "queue runner" "starting manually"
4165 This option is normally restricted to admin users. However, there is a
4166 configuration option called &%prod_requires_admin%& which can be set false to
4167 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4168 and &%-S%& options).
4169
4170 .cindex "queue runner" "description of operation"
4171 The &%-q%& option starts one queue runner process. This scans the queue of
4172 waiting messages, and runs a delivery process for each one in turn. It waits
4173 for each delivery process to finish before starting the next one. A delivery
4174 process may not actually do any deliveries if the retry times for the addresses
4175 have not been reached. Use &%-qf%& (see below) if you want to override this.
4176
4177 If
4178 .cindex "SMTP" "passed connection"
4179 .cindex "SMTP" "multiple deliveries"
4180 .cindex "multiple SMTP deliveries"
4181 the delivery process spawns other processes to deliver other messages down
4182 passed SMTP connections, the queue runner waits for these to finish before
4183 proceeding.
4184
4185 When all the queued messages have been considered, the original queue runner
4186 process terminates. In other words, a single pass is made over the waiting
4187 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4188 this to be repeated periodically.
4189
4190 Exim processes the waiting messages in an unpredictable order. It isn't very
4191 random, but it is likely to be different each time, which is all that matters.
4192 If one particular message screws up a remote MTA, other messages to the same
4193 MTA have a chance of getting through if they get tried first.
4194
4195 It is possible to cause the messages to be processed in lexical message id
4196 order, which is essentially the order in which they arrived, by setting the
4197 &%queue_run_in_order%& option, but this is not recommended for normal use.
4198
4199 .vitem &%-q%&<&'qflags'&>
4200 The &%-q%& option may be followed by one or more flag letters that change its
4201 behaviour. They are all optional, but if more than one is present, they must
4202 appear in the correct order. Each flag is described in a separate item below.
4203
4204 .vitem &%-qq...%&
4205 .oindex "&%-qq%&"
4206 .cindex "queue" "double scanning"
4207 .cindex "queue" "routing"
4208 .cindex "routing" "whole queue before delivery"
4209 An option starting with &%-qq%& requests a two-stage queue run. In the first
4210 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4211 every domain. Addresses are routed, local deliveries happen, but no remote
4212 transports are run.
4213
4214 .cindex "hints database" "remembering routing"
4215 The hints database that remembers which messages are waiting for specific hosts
4216 is updated, as if delivery to those hosts had been deferred. After this is
4217 complete, a second, normal queue scan happens, with routing and delivery taking
4218 place as normal. Messages that are routed to the same host should mostly be
4219 delivered down a single SMTP
4220 .cindex "SMTP" "passed connection"
4221 .cindex "SMTP" "multiple deliveries"
4222 .cindex "multiple SMTP deliveries"
4223 connection because of the hints that were set up during the first queue scan.
4224 This option may be useful for hosts that are connected to the Internet
4225 intermittently.
4226
4227 .vitem &%-q[q]i...%&
4228 .oindex "&%-qi%&"
4229 .cindex "queue" "initial delivery"
4230 If the &'i'& flag is present, the queue runner runs delivery processes only for
4231 those messages that haven't previously been tried. (&'i'& stands for &"initial
4232 delivery"&.) This can be helpful if you are putting messages on the queue using
4233 &%-odq%& and want a queue runner just to process the new messages.
4234
4235 .vitem &%-q[q][i]f...%&
4236 .oindex "&%-qf%&"
4237 .cindex "queue" "forcing delivery"
4238 .cindex "delivery" "forcing in queue run"
4239 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4240 message, whereas without &'f'& only those non-frozen addresses that have passed
4241 their retry times are tried.
4242
4243 .vitem &%-q[q][i]ff...%&
4244 .oindex "&%-qff%&"
4245 .cindex "frozen messages" "forcing delivery"
4246 If &'ff'& is present, a delivery attempt is forced for every message, whether
4247 frozen or not.
4248
4249 .vitem &%-q[q][i][f[f]]l%&
4250 .oindex "&%-ql%&"
4251 .cindex "queue" "local deliveries only"
4252 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4253 be done. If a message requires any remote deliveries, it remains on the queue
4254 for later delivery.
4255
4256 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4257 .cindex "queue" "delivering specific messages"
4258 When scanning the queue, Exim can be made to skip over messages whose ids are
4259 lexically less than a given value by following the &%-q%& option with a
4260 starting message id. For example:
4261 .code
4262 exim -q 0t5C6f-0000c8-00
4263 .endd
4264 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4265 second message id is given, messages whose ids are lexically greater than it
4266 are also skipped. If the same id is given twice, for example,
4267 .code
4268 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4269 .endd
4270 just one delivery process is started, for that message. This differs from
4271 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4272 that it counts as a delivery from a queue run. Note that the selection
4273 mechanism does not affect the order in which the messages are scanned. There
4274 are also other ways of selecting specific sets of messages for delivery in a
4275 queue run &-- see &%-R%& and &%-S%&.
4276
4277 .vitem &%-q%&<&'qflags'&><&'time'&>
4278 .cindex "queue runner" "starting periodically"
4279 .cindex "periodic queue running"
4280 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4281 starting a queue runner process at intervals specified by the given time value
4282 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4283 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4284 single daemon process handles both functions. A common way of starting up a
4285 combined daemon at system boot time is to use a command such as
4286 .code
4287 /usr/exim/bin/exim -bd -q30m
4288 .endd
4289 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4290 process every 30 minutes.
4291
4292 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4293 pid file is written unless one is explicitly requested by the &%-oP%& option.
4294
4295 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4296 .oindex "&%-qR%&"
4297 This option is synonymous with &%-R%&. It is provided for Sendmail
4298 compatibility.
4299
4300 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4301 .oindex "&%-qS%&"
4302 This option is synonymous with &%-S%&.
4303
4304 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4305 .oindex "&%-R%&"
4306 .cindex "queue runner" "for specific recipients"
4307 .cindex "delivery" "to given domain"
4308 .cindex "domain" "delivery to"
4309 The <&'rsflags'&> may be empty, in which case the white space before the string
4310 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4311 which are the possible values for <&'rsflags'&>. White space is required if
4312 <&'rsflags'&> is not empty.
4313
4314 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4315 perform a single queue run, except that, when scanning the messages on the
4316 queue, Exim processes only those that have at least one undelivered recipient
4317 address containing the given string, which is checked in a case-independent
4318 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4319 regular expression; otherwise it is a literal string.
4320
4321 If you want to do periodic queue runs for messages with specific recipients,
4322 you can combine &%-R%& with &%-q%& and a time value. For example:
4323 .code
4324 exim -q25m -R @special.domain.example
4325 .endd
4326 This example does a queue run for messages with recipients in the given domain
4327 every 25 minutes. Any additional flags that are specified with &%-q%& are
4328 applied to each queue run.
4329
4330 Once a message is selected for delivery by this mechanism, all its addresses
4331 are processed. For the first selected message, Exim overrides any retry
4332 information and forces a delivery attempt for each undelivered address. This
4333 means that if delivery of any address in the first message is successful, any
4334 existing retry information is deleted, and so delivery attempts for that
4335 address in subsequently selected messages (which are processed without forcing)
4336 will run. However, if delivery of any address does not succeed, the retry
4337 information is updated, and in subsequently selected messages, the failing
4338 address will be skipped.
4339
4340 .cindex "frozen messages" "forcing delivery"
4341 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4342 all selected messages, not just the first; frozen messages are included when
4343 &'ff'& is present.
4344
4345 The &%-R%& option makes it straightforward to initiate delivery of all messages
4346 to a given domain after a host has been down for some time. When the SMTP
4347 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4348 effect is to run Exim with the &%-R%& option, but it can be configured to run
4349 an arbitrary command instead.
4350
4351 .vitem &%-r%&
4352 .oindex "&%-r%&"
4353 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4354
4355 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4356 .oindex "&%-S%&"
4357 .cindex "delivery" "from given sender"
4358 .cindex "queue runner" "for specific senders"
4359 This option acts like &%-R%& except that it checks the string against each
4360 message's sender instead of against the recipients. If &%-R%& is also set, both
4361 conditions must be met for a message to be selected. If either of the options
4362 has &'f'& or &'ff'& in its flags, the associated action is taken.
4363
4364 .vitem &%-Tqt%&&~<&'times'&>
4365 .oindex "&%-Tqt%&"
4366 This an option that is exclusively for use by the Exim testing suite. It is not
4367 recognized when Exim is run normally. It allows for the setting up of explicit
4368 &"queue times"& so that various warning/retry features can be tested.
4369
4370 .vitem &%-t%&
4371 .oindex "&%-t%&"
4372 .cindex "recipient" "extracting from header lines"
4373 .cindex "&'Bcc:'& header line"
4374 .cindex "&'Cc:'& header line"
4375 .cindex "&'To:'& header line"
4376 When Exim is receiving a locally-generated, non-SMTP message on its standard
4377 input, the &%-t%& option causes the recipients of the message to be obtained
4378 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4379 from the command arguments. The addresses are extracted before any rewriting
4380 takes place and the &'Bcc:'& header line, if present, is then removed.
4381
4382 .cindex "Sendmail compatibility" "&%-t%& option"
4383 If the command has any arguments, they specify addresses to which the message
4384 is &'not'& to be delivered. That is, the argument addresses are removed from
4385 the recipients list obtained from the headers. This is compatible with Smail 3
4386 and in accordance with the documented behaviour of several versions of
4387 Sendmail, as described in man pages on a number of operating systems (e.g.
4388 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4389 argument addresses to those obtained from the headers, and the O'Reilly
4390 Sendmail book documents it that way. Exim can be made to add argument addresses
4391 instead of subtracting them by setting the option
4392 &%extract_addresses_remove_arguments%& false.
4393
4394 .cindex "&%Resent-%& header lines" "with &%-t%&"
4395 If there are any &%Resent-%& header lines in the message, Exim extracts
4396 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4397 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4398 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4399 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4400
4401 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4402 message is resent several times). The RFC also specifies that they should be
4403 added at the front of the message, and separated by &'Received:'& lines. It is
4404 not at all clear how &%-t%& should operate in the present of multiple sets,
4405 nor indeed exactly what constitutes a &"set"&.
4406 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4407 are often added at the end of the header, and if a message is resent more than
4408 once, it is common for the original set of &%Resent-%& headers to be renamed as
4409 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4410
4411 .vitem &%-ti%&
4412 .oindex "&%-ti%&"
4413 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4414 compatibility with Sendmail.
4415
4416 .vitem &%-tls-on-connect%&
4417 .oindex "&%-tls-on-connect%&"
4418 .cindex "TLS" "use without STARTTLS"
4419 .cindex "TLS" "automatic start"
4420 This option is available when Exim is compiled with TLS support. It forces all
4421 incoming SMTP connections to behave as if the incoming port is listed in the
4422 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4423 &<<CHAPTLS>>& for further details.
4424
4425
4426 .vitem &%-U%&
4427 .oindex "&%-U%&"
4428 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4429 Sendmail uses this option for &"initial message submission"&, and its
4430 documentation states that in future releases, it may complain about
4431 syntactically invalid messages rather than fixing them when this flag is not
4432 set. Exim ignores this option.
4433
4434 .vitem &%-v%&
4435 .oindex "&%-v%&"
4436 This option causes Exim to write information to the standard error stream,
4437 describing what it is doing. In particular, it shows the log lines for
4438 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4439 dialogue is shown. Some of the log lines shown may not actually be written to
4440 the log if the setting of &%log_selector%& discards them. Any relevant
4441 selectors are shown with each log line. If none are shown, the logging is
4442 unconditional.
4443
4444 .vitem &%-x%&
4445 .oindex "&%-x%&"
4446 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4447 National Language Support extended characters in the body of the mail item"&).
4448 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4449 this option.
4450 .endlist
4451
4452 .ecindex IIDclo1
4453 .ecindex IIDclo2
4454
4455
4456 . ////////////////////////////////////////////////////////////////////////////
4457 . Insert a stylized DocBook comment here, to identify the end of the command
4458 . line options. This is for the benefit of the Perl script that automatically
4459 . creates a man page for the options.
4460 . ////////////////////////////////////////////////////////////////////////////
4461
4462 .literal xml
4463 <!-- === End of command line options === -->
4464 .literal off
4465
4466
4467
4468
4469
4470 . ////////////////////////////////////////////////////////////////////////////
4471 . ////////////////////////////////////////////////////////////////////////////
4472
4473
4474 .chapter "The Exim run time configuration file" "CHAPconf" &&&
4475          "The runtime configuration file"
4476
4477 .cindex "run time configuration"
4478 .cindex "configuration file" "general description"
4479 .cindex "CONFIGURE_FILE"
4480 .cindex "configuration file" "errors in"
4481 .cindex "error" "in configuration file"
4482 .cindex "return code" "for bad configuration"
4483 Exim uses a single run time configuration file that is read whenever an Exim
4484 binary is executed. Note that in normal operation, this happens frequently,
4485 because Exim is designed to operate in a distributed manner, without central
4486 control.
4487
4488 If a syntax error is detected while reading the configuration file, Exim
4489 writes a message on the standard error, and exits with a non-zero return code.
4490 The message is also written to the panic log. &*Note*&: Only simple syntax
4491 errors can be detected at this time. The values of any expanded options are
4492 not checked until the expansion happens, even when the expansion does not
4493 actually alter the string.
4494
4495 The name of the configuration file is compiled into the binary for security
4496 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4497 most configurations, this specifies a single file. However, it is permitted to
4498 give a colon-separated list of file names, in which case Exim uses the first
4499 existing file in the list.
4500
4501 .cindex "EXIM_USER"
4502 .cindex "EXIM_GROUP"
4503 .cindex "CONFIGURE_OWNER"
4504 .cindex "CONFIGURE_GROUP"
4505 .cindex "configuration file" "ownership"
4506 .cindex "ownership" "configuration file"
4507 The run time configuration file must be owned by root or by the user that is
4508 specified at compile time by the CONFIGURE_OWNER option (if set). The
4509 configuration file must not be world-writeable, or group-writeable unless its
4510 group is the root group or the one specified at compile time by the
4511 CONFIGURE_GROUP option.
4512
4513 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4514 to root, anybody who is able to edit the run time configuration file has an
4515 easy way to run commands as root. If you specify a user or group in the
4516 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4517 who are members of that group will trivially be able to obtain root privileges.
4518
4519 Up to Exim version 4.72, the run time configuration file was also permitted to
4520 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4521 since it offered a simple privilege escalation for any attacker who managed to
4522 compromise the Exim user account.
4523
4524 A default configuration file, which will work correctly in simple situations,
4525 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4526 defines just one file name, the installation process copies the default
4527 configuration to a new file of that name if it did not previously exist. If
4528 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4529 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4530 configuration.
4531
4532
4533
4534 .section "Using a different configuration file" "SECID40"
4535 .cindex "configuration file" "alternate"
4536 A one-off alternate configuration can be specified by the &%-C%& command line
4537 option, which may specify a single file or a list of files. However, when
4538 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4539 unless the argument for &%-C%& is identical to the built-in value from
4540 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4541 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4542 is useful mainly for checking the syntax of configuration files before
4543 installing them. No owner or group checks are done on a configuration file
4544 specified by &%-C%&, if root privilege has been dropped.
4545
4546 Even the Exim user is not trusted to specify an arbitrary configuration file
4547 with the &%-C%& option to be used with root privileges, unless that file is
4548 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4549 testing a configuration using &%-C%& right through message reception and
4550 delivery, even if the caller is root. The reception works, but by that time,
4551 Exim is running as the Exim user, so when it re-execs to regain privilege for
4552 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4553 can test reception and delivery using two separate commands (one to put a
4554 message on the queue, using &%-odq%&, and another to do the delivery, using
4555 &%-M%&).
4556
4557 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4558 prefix string with which any file named in a &%-C%& command line option must
4559 start. In addition, the file name must not contain the sequence &"&`/../`&"&.
4560 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any file
4561 name can be used with &%-C%&.
4562
4563 One-off changes to a configuration can be specified by the &%-D%& command line
4564 option, which defines and overrides values for macros used inside the
4565 configuration file. However, like &%-C%&, the use of this option by a
4566 non-privileged user causes Exim to discard its root privilege.
4567 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4568 completely disabled, and its use causes an immediate error exit.
4569
4570 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4571 to declare certain macro names trusted, such that root privilege will not
4572 necessarily be discarded.
4573 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4574 considered safe and, if &%-D%& only supplies macros from this list, and the
4575 values are acceptable, then Exim will not give up root privilege if the caller
4576 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4577 transition mechanism and is expected to be removed in the future.  Acceptable
4578 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4579
4580 Some sites may wish to use the same Exim binary on different machines that
4581 share a file system, but to use different configuration files on each machine.
4582 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4583 looks for a file whose name is the configuration file name followed by a dot
4584 and the machine's node name, as obtained from the &[uname()]& function. If this
4585 file does not exist, the standard name is tried. This processing occurs for
4586 each file name in the list given by CONFIGURE_FILE or &%-C%&.
4587
4588 In some esoteric situations different versions of Exim may be run under
4589 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4590 help with this. See the comments in &_src/EDITME_& for details.
4591
4592
4593
4594 .section "Configuration file format" "SECTconffilfor"
4595 .cindex "configuration file" "format of"
4596 .cindex "format" "configuration file"
4597 Exim's configuration file is divided into a number of different parts. General
4598 option settings must always appear at the start of the file. The other parts
4599 are all optional, and may appear in any order. Each part other than the first
4600 is introduced by the word &"begin"& followed by the name of the part. The
4601 optional parts are:
4602
4603 .ilist
4604 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4605 &<<CHAPACL>>&).
4606 .next
4607 .cindex "AUTH" "configuration"
4608 &'authenticators'&: Configuration settings for the authenticator drivers. These
4609 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4610 .next
4611 &'routers'&: Configuration settings for the router drivers. Routers process
4612 addresses and determine how the message is to be delivered (see chapters
4613 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4614 .next
4615 &'transports'&: Configuration settings for the transport drivers. Transports
4616 define mechanisms for copying messages to destinations (see chapters
4617 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4618 .next
4619 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4620 If there is no retry section, or if it is empty (that is, no retry rules are
4621 defined), Exim will not retry deliveries. In this situation, temporary errors
4622 are treated the same as permanent errors. Retry rules are discussed in chapter
4623 &<<CHAPretry>>&.
4624 .next
4625 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4626 when new addresses are generated during delivery. Rewriting is discussed in
4627 chapter &<<CHAPrewrite>>&.
4628 .next
4629 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4630 want to use this feature, you must set
4631 .code
4632 LOCAL_SCAN_HAS_OPTIONS=yes
4633 .endd
4634 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4635 facility are given in chapter &<<CHAPlocalscan>>&.
4636 .endlist
4637
4638 .cindex "configuration file" "leading white space in"
4639 .cindex "configuration file" "trailing white space in"
4640 .cindex "white space" "in configuration file"
4641 Leading and trailing white space in configuration lines is always ignored.
4642
4643 Blank lines in the file, and lines starting with a # character (ignoring
4644 leading white space) are treated as comments and are ignored. &*Note*&: A
4645 # character other than at the beginning of a line is not treated specially,
4646 and does not introduce a comment.
4647
4648 Any non-comment line can be continued by ending it with a backslash. Note that
4649 the general rule for white space means that trailing white space after the
4650 backslash and leading white space at the start of continuation
4651 lines is ignored. Comment lines beginning with # (but not empty lines) may
4652 appear in the middle of a sequence of continuation lines.
4653
4654 A convenient way to create a configuration file is to start from the
4655 default, which is supplied in &_src/configure.default_&, and add, delete, or
4656 change settings as required.
4657
4658 The ACLs, retry rules, and rewriting rules have their own syntax which is
4659 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4660 respectively. The other parts of the configuration file have some syntactic
4661 items in common, and these are described below, from section &<<SECTcos>>&
4662 onwards. Before that, the inclusion, macro, and conditional facilities are
4663 described.
4664
4665
4666
4667 .section "File inclusions in the configuration file" "SECID41"
4668 .cindex "inclusions in configuration file"
4669 .cindex "configuration file" "including other files"
4670 .cindex "&`.include`& in configuration file"
4671 .cindex "&`.include_if_exists`& in configuration file"
4672 You can include other files inside Exim's run time configuration file by
4673 using this syntax:
4674 .display
4675 &`.include`& <&'file name'&>
4676 &`.include_if_exists`& <&'file name'&>
4677 .endd
4678 on a line by itself. Double quotes round the file name are optional. If you use
4679 the first form, a configuration error occurs if the file does not exist; the
4680 second form does nothing for non-existent files. In all cases, an absolute file
4681 name is required.
4682
4683 Includes may be nested to any depth, but remember that Exim reads its
4684 configuration file often, so it is a good idea to keep them to a minimum.
4685 If you change the contents of an included file, you must HUP the daemon,
4686 because an included file is read only when the configuration itself is read.
4687
4688 The processing of inclusions happens early, at a physical line level, so, like
4689 comment lines, an inclusion can be used in the middle of an option setting,
4690 for example:
4691 .code
4692 hosts_lookup = a.b.c \
4693                .include /some/file
4694 .endd
4695 Include processing happens after macro processing (see below). Its effect is to
4696 process the lines of the included file as if they occurred inline where the
4697 inclusion appears.
4698
4699
4700
4701 .section "Macros in the configuration file" "SECTmacrodefs"
4702 .cindex "macro" "description of"
4703 .cindex "configuration file" "macros"
4704 If a line in the main part of the configuration (that is, before the first
4705 &"begin"& line) begins with an upper case letter, it is taken as a macro
4706 definition, and must be of the form
4707 .display
4708 <&'name'&> = <&'rest of line'&>
4709 .endd
4710 The name must consist of letters, digits, and underscores, and need not all be
4711 in upper case, though that is recommended. The rest of the line, including any
4712 continuations, is the replacement text, and has leading and trailing white
4713 space removed. Quotes are not removed. The replacement text can never end with
4714 a backslash character, but this doesn't seem to be a serious limitation.
4715
4716 Macros may also be defined between router, transport, authenticator, or ACL
4717 definitions. They may not, however, be defined within an individual driver or
4718 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
4719
4720 .section "Macro substitution" "SECID42"
4721 Once a macro is defined, all subsequent lines in the file (and any included
4722 files) are scanned for the macro name; if there are several macros, the line is
4723 scanned for each in turn, in the order in which the macros are defined. The
4724 replacement text is not re-scanned for the current macro, though it is scanned
4725 for subsequently defined macros. For this reason, a macro name may not contain
4726 the name of a previously defined macro as a substring. You could, for example,
4727 define
4728 .display
4729 &`ABCD_XYZ = `&<&'something'&>
4730 &`ABCD = `&<&'something else'&>
4731 .endd
4732 but putting the definitions in the opposite order would provoke a configuration
4733 error. Macro expansion is applied to individual physical lines from the file,
4734 before checking for line continuation or file inclusion (see above). If a line
4735 consists solely of a macro name, and the expansion of the macro is empty, the
4736 line is ignored. A macro at the start of a line may turn the line into a
4737 comment line or a &`.include`& line.
4738
4739
4740 .section "Redefining macros" "SECID43"
4741 Once defined, the value of a macro can be redefined later in the configuration
4742 (or in an included file). Redefinition is specified by using &'=='& instead of
4743 &'='&. For example:
4744 .code
4745 MAC =  initial value
4746 ...
4747 MAC == updated value
4748 .endd
4749 Redefinition does not alter the order in which the macros are applied to the
4750 subsequent lines of the configuration file. It is still the same order in which
4751 the macros were originally defined. All that changes is the macro's value.
4752 Redefinition makes it possible to accumulate values. For example:
4753 .code
4754 MAC =  initial value
4755 ...
4756 MAC == MAC and something added
4757 .endd
4758 This can be helpful in situations where the configuration file is built
4759 from a number of other files.
4760
4761 .section "Overriding macro values" "SECID44"
4762 The values set for macros in the configuration file can be overridden by the
4763 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
4764 used, unless called by root or the Exim user. A definition on the command line
4765 using the &%-D%& option causes all definitions and redefinitions within the
4766 file to be ignored.
4767
4768
4769
4770 .section "Example of macro usage" "SECID45"
4771 As an example of macro usage, consider a configuration where aliases are looked
4772 up in a MySQL database. It helps to keep the file less cluttered if long
4773 strings such as SQL statements are defined separately as macros, for example:
4774 .code
4775 ALIAS_QUERY = select mailbox from user where \
4776               login='${quote_mysql:$local_part}';
4777 .endd
4778 This can then be used in a &(redirect)& router setting like this:
4779 .code
4780 data = ${lookup mysql{ALIAS_QUERY}}
4781 .endd
4782 In earlier versions of Exim macros were sometimes used for domain, host, or
4783 address lists. In Exim 4 these are handled better by named lists &-- see
4784 section &<<SECTnamedlists>>&.
4785
4786
4787 .section "Conditional skips in the configuration file" "SECID46"
4788 .cindex "configuration file" "conditional skips"
4789 .cindex "&`.ifdef`&"
4790 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
4791 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
4792 portions of the configuration file. The processing happens whenever the file is
4793 read (that is, when an Exim binary starts to run).
4794
4795 The implementation is very simple. Instances of the first four directives must
4796 be followed by text that includes the names of one or macros. The condition
4797 that is tested is whether or not any macro substitution has taken place in the
4798 line. Thus:
4799 .code
4800 .ifdef AAA
4801 message_size_limit = 50M
4802 .else
4803 message_size_limit = 100M
4804 .endif
4805 .endd
4806 sets a message size limit of 50M if the macro &`AAA`& is defined, and 100M
4807 otherwise. If there is more than one macro named on the line, the condition
4808 is true if any of them are defined. That is, it is an &"or"& condition. To
4809 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
4810
4811 Although you can use a macro expansion to generate one of these directives,
4812 it is not very useful, because the condition &"there was a macro substitution
4813 in this line"& will always be true.
4814
4815 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
4816 to clarify complicated nestings.
4817
4818
4819
4820 .section "Common option syntax" "SECTcos"
4821 .cindex "common option syntax"
4822 .cindex "syntax of common options"
4823 .cindex "configuration file" "common option syntax"
4824 For the main set of options, driver options, and &[local_scan()]& options,
4825 each setting is on a line by itself, and starts with a name consisting of
4826 lower-case letters and underscores. Many options require a data value, and in
4827 these cases the name must be followed by an equals sign (with optional white
4828 space) and then the value. For example:
4829 .code
4830 qualify_domain = mydomain.example.com
4831 .endd
4832 .cindex "hiding configuration option values"
4833 .cindex "configuration options" "hiding value of"
4834 .cindex "options" "hiding value of"
4835 Some option settings may contain sensitive data, for example, passwords for
4836 accessing databases. To stop non-admin users from using the &%-bP%& command
4837 line option to read these values, you can precede the option settings with the
4838 word &"hide"&. For example:
4839 .code
4840 hide mysql_servers = localhost/users/admin/secret-password
4841 .endd
4842 For non-admin users, such options are displayed like this:
4843 .code
4844 mysql_servers = <value not displayable>
4845 .endd
4846 If &"hide"& is used on a driver option, it hides the value of that option on
4847 all instances of the same driver.
4848
4849 The following sections describe the syntax used for the different data types
4850 that are found in option settings.
4851
4852
4853 .section "Boolean options" "SECID47"
4854 .cindex "format" "boolean"
4855 .cindex "boolean configuration values"
4856 .oindex "&%no_%&&'xxx'&"
4857 .oindex "&%not_%&&'xxx'&"
4858 Options whose type is given as boolean are on/off switches. There are two
4859 different ways of specifying such options: with and without a data value. If
4860 the option name is specified on its own without data, the switch is turned on;
4861 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
4862 boolean options may be followed by an equals sign and one of the words
4863 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
4864 the following two settings have exactly the same effect:
4865 .code
4866 queue_only
4867 queue_only = true
4868 .endd
4869 The following two lines also have the same (opposite) effect:
4870 .code
4871 no_queue_only
4872 queue_only = false
4873 .endd
4874 You can use whichever syntax you prefer.
4875
4876
4877
4878
4879 .section "Integer values" "SECID48"
4880 .cindex "integer configuration values"
4881 .cindex "format" "integer"
4882 If an option's type is given as &"integer"&, the value can be given in decimal,
4883 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
4884 number is assumed. Otherwise, it is treated as an octal number unless it starts
4885 with the characters &"0x"&, in which case the remainder is interpreted as a
4886 hexadecimal number.
4887
4888 If an integer value is followed by the letter K, it is multiplied by 1024; if
4889 it is followed by the letter M, it is multiplied by 1024x1024. When the values
4890 of integer option settings are output, values which are an exact multiple of
4891 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
4892 and M. The printing style is independent of the actual input format that was
4893 used.
4894
4895
4896 .section "Octal integer values" "SECID49"
4897 .cindex "integer format"
4898 .cindex "format" "octal integer"
4899 If an option's type is given as &"octal integer"&, its value is always
4900 interpreted as an octal number, whether or not it starts with the digit zero.
4901 Such options are always output in octal.
4902
4903
4904 .section "Fixed point numbers" "SECID50"
4905 .cindex "fixed point configuration values"
4906 .cindex "format" "fixed point"
4907 If an option's type is given as &"fixed-point"&, its value must be a decimal
4908 integer, optionally followed by a decimal point and up to three further digits.
4909
4910
4911
4912 .section "Time intervals" "SECTtimeformat"
4913 .cindex "time interval" "specifying in configuration"
4914 .cindex "format" "time interval"
4915 A time interval is specified as a sequence of numbers, each followed by one of
4916 the following letters, with no intervening white space:
4917
4918 .table2 30pt
4919 .irow &%s%& seconds
4920 .irow &%m%& minutes
4921 .irow &%h%& hours
4922 .irow &%d%& days
4923 .irow &%w%& weeks
4924 .endtable
4925
4926 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
4927 intervals are output in the same format. Exim does not restrict the values; it
4928 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
4929
4930
4931
4932 .section "String values" "SECTstrings"
4933 .cindex "string" "format of configuration values"
4934 .cindex "format" "string"
4935 If an option's type is specified as &"string"&, the value can be specified with
4936 or without double-quotes. If it does not start with a double-quote, the value
4937 consists of the remainder of the line plus any continuation lines, starting at
4938 the first character after any leading white space, with trailing white space
4939 removed, and with no interpretation of the characters in the string. Because
4940 Exim removes comment lines (those beginning with #) at an early stage, they can
4941 appear in the middle of a multi-line string. The following two settings are
4942 therefore equivalent:
4943 .code
4944 trusted_users = uucp:mail
4945 trusted_users = uucp:\
4946                 # This comment line is ignored
4947                 mail
4948 .endd
4949 .cindex "string" "quoted"
4950 .cindex "escape characters in quoted strings"
4951 If a string does start with a double-quote, it must end with a closing
4952 double-quote, and any backslash characters other than those used for line
4953 continuation are interpreted as escape characters, as follows:
4954
4955 .table2 100pt
4956 .irow &`\\`&                     "single backslash"
4957 .irow &`\n`&                     "newline"
4958 .irow &`\r`&                     "carriage return"
4959 .irow &`\t`&                     "tab"
4960 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
4961 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
4962                                    character"
4963 .endtable
4964
4965 If a backslash is followed by some other character, including a double-quote
4966 character, that character replaces the pair.
4967
4968 Quoting is necessary only if you want to make use of the backslash escapes to
4969 insert special characters, or if you need to specify a value with leading or
4970 trailing spaces. These cases are rare, so quoting is almost never needed in
4971 current versions of Exim. In versions of Exim before 3.14, quoting was required
4972 in order to continue lines, so you may come across older configuration files
4973 and examples that apparently quote unnecessarily.
4974
4975
4976 .section "Expanded strings" "SECID51"
4977 .cindex "expansion" "definition of"
4978 Some strings in the configuration file are subjected to &'string expansion'&,
4979 by which means various parts of the string may be changed according to the
4980 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
4981 is as just described; in particular, the handling of backslashes in quoted
4982 strings is done as part of the input process, before expansion takes place.
4983 However, backslash is also an escape character for the expander, so any
4984 backslashes that are required for that reason must be doubled if they are
4985 within a quoted configuration string.
4986
4987
4988 .section "User and group names" "SECID52"
4989 .cindex "user name" "format of"
4990 .cindex "format" "user name"
4991 .cindex "groups" "name format"
4992 .cindex "format" "group name"
4993 User and group names are specified as strings, using the syntax described
4994 above, but the strings are interpreted specially. A user or group name must
4995 either consist entirely of digits, or be a name that can be looked up using the
4996 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
4997
4998
4999 .section "List construction" "SECTlistconstruct"
5000 .cindex "list" "syntax of in configuration"
5001 .cindex "format" "list item in configuration"
5002 .cindex "string" "list, definition of"
5003 The data for some configuration options is a list of items, with colon as the
5004 default separator. Many of these options are shown with type &"string list"& in
5005 the descriptions later in this document. Others are listed as &"domain list"&,
5006 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5007 are all the same; however, those other than &"string list"& are subject to
5008 particular kinds of interpretation, as described in chapter
5009 &<<CHAPdomhosaddlists>>&.
5010
5011 In all these cases, the entire list is treated as a single string as far as the
5012 input syntax is concerned. The &%trusted_users%& setting in section
5013 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5014 in a list, it must be entered as two colons. Leading and trailing white space
5015 on each item in a list is ignored. This makes it possible to include items that
5016 start with a colon, and in particular, certain forms of IPv6 address. For
5017 example, the list
5018 .code
5019 local_interfaces = 127.0.0.1 : ::::1
5020 .endd
5021 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5022
5023 &*Note*&: Although leading and trailing white space is ignored in individual
5024 list items, it is not ignored when parsing the list. The space after the first
5025 colon in the example above is necessary. If it were not there, the list would
5026 be interpreted as the two items 127.0.0.1:: and 1.
5027
5028 .section "Changing list separators" "SECID53"
5029 .cindex "list separator" "changing"
5030 .cindex "IPv6" "addresses in lists"
5031 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5032 introduced to allow the separator character to be changed. If a list begins
5033 with a left angle bracket, followed by any punctuation character, that
5034 character is used instead of colon as the list separator. For example, the list
5035 above can be rewritten to use a semicolon separator like this:
5036 .code
5037 local_interfaces = <; 127.0.0.1 ; ::1
5038 .endd
5039 This facility applies to all lists, with the exception of the list in
5040 &%log_file_path%&. It is recommended that the use of non-colon separators be
5041 confined to circumstances where they really are needed.
5042
5043 .cindex "list separator" "newline as"
5044 .cindex "newline" "as list separator"
5045 It is also possible to use newline and other control characters (those with
5046 code values less than 32, plus DEL) as separators in lists. Such separators
5047 must be provided literally at the time the list is processed. For options that
5048 are string-expanded, you can write the separator using a normal escape
5049 sequence. This will be processed by the expander before the string is
5050 interpreted as a list. For example, if a newline-separated list of domains is
5051 generated by a lookup, you can process it directly by a line such as this:
5052 .code
5053 domains = <\n ${lookup mysql{.....}}
5054 .endd
5055 This avoids having to change the list separator in such data. You are unlikely
5056 to want to use a control character as a separator in an option that is not
5057 expanded, because the value is literal text. However, it can be done by giving
5058 the value in quotes. For example:
5059 .code
5060 local_interfaces = "<\n 127.0.0.1 \n ::1"
5061 .endd
5062 Unlike printing character separators, which can be included in list items by
5063 doubling, it is not possible to include a control character as data when it is
5064 set as the separator. Two such characters in succession are interpreted as
5065 enclosing an empty list item.
5066
5067
5068
5069 .section "Empty items in lists" "SECTempitelis"
5070 .cindex "list" "empty item in"
5071 An empty item at the end of a list is always ignored. In other words, trailing
5072 separator characters are ignored. Thus, the list in
5073 .code
5074 senders = user@domain :
5075 .endd
5076 contains only a single item. If you want to include an empty string as one item
5077 in a list, it must not be the last item. For example, this list contains three
5078 items, the second of which is empty:
5079 .code
5080 senders = user1@domain : : user2@domain
5081 .endd
5082 &*Note*&: There must be white space between the two colons, as otherwise they
5083 are interpreted as representing a single colon data character (and the list
5084 would then contain just one item). If you want to specify a list that contains
5085 just one, empty item, you can do it as in this example:
5086 .code
5087 senders = :
5088 .endd
5089 In this case, the first item is empty, and the second is discarded because it
5090 is at the end of the list.
5091
5092
5093
5094
5095 .section "Format of driver configurations" "SECTfordricon"
5096 .cindex "drivers" "configuration format"
5097 There are separate parts in the configuration for defining routers, transports,
5098 and authenticators. In each part, you are defining a number of driver
5099 instances, each with its own set of options. Each driver instance is defined by
5100 a sequence of lines like this:
5101 .display
5102 <&'instance name'&>:
5103   <&'option'&>
5104   ...
5105   <&'option'&>
5106 .endd
5107 In the following example, the instance name is &(localuser)&, and it is
5108 followed by three options settings:
5109 .code
5110 localuser:
5111   driver = accept
5112   check_local_user
5113   transport = local_delivery
5114 .endd
5115 For each driver instance, you specify which Exim code module it uses &-- by the
5116 setting of the &%driver%& option &-- and (optionally) some configuration
5117 settings. For example, in the case of transports, if you want a transport to
5118 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5119 a local file you would use the &(appendfile)& driver. Each of the drivers is
5120 described in detail in its own separate chapter later in this manual.
5121
5122 You can have several routers, transports, or authenticators that are based on
5123 the same underlying driver (each must have a different instance name).
5124
5125 The order in which routers are defined is important, because addresses are
5126 passed to individual routers one by one, in order. The order in which
5127 transports are defined does not matter at all. The order in which
5128 authenticators are defined is used only when Exim, as a client, is searching
5129 them to find one that matches an authentication mechanism offered by the
5130 server.
5131
5132 .cindex "generic options"
5133 .cindex "options" "generic &-- definition of"
5134 Within a driver instance definition, there are two kinds of option: &'generic'&
5135 and &'private'&. The generic options are those that apply to all drivers of the
5136 same type (that is, all routers, all transports or all authenticators). The
5137 &%driver%& option is a generic option that must appear in every definition.
5138 .cindex "private options"
5139 The private options are special for each driver, and none need appear, because
5140 they all have default values.
5141
5142 The options may appear in any order, except that the &%driver%& option must
5143 precede any private options, since these depend on the particular driver. For
5144 this reason, it is recommended that &%driver%& always be the first option.
5145
5146 Driver instance names, which are used for reference in log entries and
5147 elsewhere, can be any sequence of letters, digits, and underscores (starting
5148 with a letter) and must be unique among drivers of the same type. A router and
5149 a transport (for example) can each have the same name, but no two router
5150 instances can have the same name. The name of a driver instance should not be
5151 confused with the name of the underlying driver module. For example, the
5152 configuration lines:
5153 .code
5154 remote_smtp:
5155   driver = smtp
5156 .endd
5157 create an instance of the &(smtp)& transport driver whose name is
5158 &(remote_smtp)&. The same driver code can be used more than once, with
5159 different instance names and different option settings each time. A second
5160 instance of the &(smtp)& transport, with different options, might be defined
5161 thus:
5162 .code
5163 special_smtp:
5164   driver = smtp
5165   port = 1234
5166   command_timeout = 10s
5167 .endd
5168 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5169 these transport instances from routers, and these names would appear in log
5170 lines.
5171
5172 Comment lines may be present in the middle of driver specifications. The full
5173 list of option settings for any particular driver instance, including all the
5174 defaulted values, can be extracted by making use of the &%-bP%& command line
5175 option.
5176
5177
5178
5179
5180
5181
5182 . ////////////////////////////////////////////////////////////////////////////
5183 . ////////////////////////////////////////////////////////////////////////////
5184
5185 .chapter "The default configuration file" "CHAPdefconfil"
5186 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5187 .cindex "default" "configuration file &""walk through""&"
5188 The default configuration file supplied with Exim as &_src/configure.default_&
5189 is sufficient for a host with simple mail requirements. As an introduction to
5190 the way Exim is configured, this chapter &"walks through"& the default
5191 configuration, giving brief explanations of the settings. Detailed descriptions
5192 of the options are given in subsequent chapters. The default configuration file
5193 itself contains extensive comments about ways you might want to modify the
5194 initial settings. However, note that there are many options that are not
5195 mentioned at all in the default configuration.
5196
5197
5198
5199 .section "Main configuration settings" "SECTdefconfmain"
5200 The main (global) configuration option settings must always come first in the
5201 file. The first thing you'll see in the file, after some initial comments, is
5202 the line
5203 .code
5204 # primary_hostname =
5205 .endd
5206 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5207 to know the official, fully qualified name of your host, and this is where you
5208 can specify it. However, in most cases you do not need to set this option. When
5209 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5210
5211 The first three non-comment configuration lines are as follows:
5212 .code
5213 domainlist local_domains = @
5214 domainlist relay_to_domains =
5215 hostlist   relay_from_hosts = 127.0.0.1
5216 .endd
5217 These are not, in fact, option settings. They are definitions of two named
5218 domain lists and one named host list. Exim allows you to give names to lists of
5219 domains, hosts, and email addresses, in order to make it easier to manage the
5220 configuration file (see section &<<SECTnamedlists>>&).
5221
5222 The first line defines a domain list called &'local_domains'&; this is used
5223 later in the configuration to identify domains that are to be delivered
5224 on the local host.
5225
5226 .cindex "@ in a domain list"
5227 There is just one item in this list, the string &"@"&. This is a special form
5228 of entry which means &"the name of the local host"&. Thus, if the local host is
5229 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5230 be delivered locally. Because the local host's name is referenced indirectly,
5231 the same configuration file can be used on different hosts.
5232
5233 The second line defines a domain list called &'relay_to_domains'&, but the
5234 list itself is empty. Later in the configuration we will come to the part that
5235 controls mail relaying through the local host; it allows relaying to any
5236 domains in this list. By default, therefore, no relaying on the basis of a mail
5237 domain is permitted.
5238
5239 The third line defines a host list called &'relay_from_hosts'&. This list is
5240 used later in the configuration to permit relaying from any host or IP address
5241 that matches the list. The default contains just the IP address of the IPv4
5242 loopback interface, which means that processes on the local host are able to
5243 submit mail for relaying by sending it over TCP/IP to that interface. No other
5244 hosts are permitted to submit messages for relaying.
5245
5246 Just to be sure there's no misunderstanding: at this point in the configuration
5247 we aren't actually setting up any controls. We are just defining some domains
5248 and hosts that will be used in the controls that are specified later.
5249
5250 The next two configuration lines are genuine option settings:
5251 .code
5252 acl_smtp_rcpt = acl_check_rcpt
5253 acl_smtp_data = acl_check_data
5254 .endd
5255 These options specify &'Access Control Lists'& (ACLs) that are to be used
5256 during an incoming SMTP session for every recipient of a message (every RCPT
5257 command), and after the contents of the message have been received,
5258 respectively. The names of the lists are &'acl_check_rcpt'& and
5259 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5260 section of the configuration. The RCPT ACL controls which recipients are
5261 accepted for an incoming message &-- if a configuration does not provide an ACL
5262 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5263 contents of a message to be checked.
5264
5265 Two commented-out option settings are next:
5266 .code
5267 # av_scanner = clamd:/tmp/clamd
5268 # spamd_address = 127.0.0.1 783
5269 .endd
5270 These are example settings that can be used when Exim is compiled with the
5271 content-scanning extension. The first specifies the interface to the virus
5272 scanner, and the second specifies the interface to SpamAssassin. Further
5273 details are given in chapter &<<CHAPexiscan>>&.
5274
5275 Three more commented-out option settings follow:
5276 .code
5277 # tls_advertise_hosts = *
5278 # tls_certificate = /etc/ssl/exim.crt
5279 # tls_privatekey = /etc/ssl/exim.pem
5280 .endd
5281 These are example settings that can be used when Exim is compiled with
5282 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5283 first one specifies the list of clients that are allowed to use TLS when
5284 connecting to this server; in this case the wildcard means all clients. The
5285 other options specify where Exim should find its TLS certificate and private
5286 key, which together prove the server's identity to any clients that connect.
5287 More details are given in chapter &<<CHAPTLS>>&.
5288
5289 Another two commented-out option settings follow:
5290 .code
5291 # daemon_smtp_ports = 25 : 465 : 587
5292 # tls_on_connect_ports = 465
5293 .endd
5294 .cindex "port" "465 and 587"
5295 .cindex "port" "for message submission"
5296 .cindex "message" "submission, ports for"
5297 .cindex "ssmtp protocol"
5298 .cindex "smtps protocol"
5299 .cindex "SMTP" "ssmtp protocol"
5300 .cindex "SMTP" "smtps protocol"
5301 These options provide better support for roaming users who wish to use this
5302 server for message submission. They are not much use unless you have turned on
5303 TLS (as described in the previous paragraph) and authentication (about which
5304 more in section &<<SECTdefconfauth>>&). The usual SMTP port 25 is often blocked
5305 on end-user networks, so RFC 4409 specifies that message submission should use
5306 port 587 instead. However some software (notably Microsoft Outlook) cannot be
5307 configured to use port 587 correctly, so these settings also enable the
5308 non-standard &"smtps"& (aka &"ssmtp"&) port 465 (see section
5309 &<<SECTsupobssmt>>&).
5310
5311 Two more commented-out options settings follow:
5312 .code
5313 # qualify_domain =
5314 # qualify_recipient =
5315 .endd
5316 The first of these specifies a domain that Exim uses when it constructs a
5317 complete email address from a local login name. This is often needed when Exim
5318 receives a message from a local process. If you do not set &%qualify_domain%&,
5319 the value of &%primary_hostname%& is used. If you set both of these options,
5320 you can have different qualification domains for sender and recipient
5321 addresses. If you set only the first one, its value is used in both cases.
5322
5323 .cindex "domain literal" "recognizing format"
5324 The following line must be uncommented if you want Exim to recognize
5325 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5326 (an IP address within square brackets) instead of a named domain.
5327 .code
5328 # allow_domain_literals
5329 .endd
5330 The RFCs still require this form, but many people think that in the modern
5331 Internet it makes little sense to permit mail to be sent to specific hosts by
5332 quoting their IP addresses. This ancient format has been used by people who
5333 try to abuse hosts by using them for unwanted relaying. However, some
5334 people believe there are circumstances (for example, messages addressed to
5335 &'postmaster'&) where domain literals are still useful.
5336
5337 The next configuration line is a kind of trigger guard:
5338 .code
5339 never_users = root
5340 .endd
5341 It specifies that no delivery must ever be run as the root user. The normal
5342 convention is to set up &'root'& as an alias for the system administrator. This
5343 setting is a guard against slips in the configuration.
5344 The list of users specified by &%never_users%& is not, however, the complete
5345 list; the build-time configuration in &_Local/Makefile_& has an option called
5346 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5347 contents of &%never_users%& are added to this list. By default
5348 FIXED_NEVER_USERS also specifies root.
5349
5350 When a remote host connects to Exim in order to send mail, the only information
5351 Exim has about the host's identity is its IP address. The next configuration
5352 line,
5353 .code
5354 host_lookup = *
5355 .endd
5356 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5357 in order to get a host name. This improves the quality of the logging
5358 information, but if you feel it is too expensive, you can remove it entirely,
5359 or restrict the lookup to hosts on &"nearby"& networks.
5360 Note that it is not always possible to find a host name from an IP address,
5361 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5362 unreachable.
5363
5364 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5365 1413 (hence their names):
5366 .code
5367 rfc1413_hosts = *
5368 rfc1413_query_timeout = 5s
5369 .endd
5370 These settings cause Exim to make ident callbacks for all incoming SMTP calls.
5371 You can limit the hosts to which these calls are made, or change the timeout
5372 that is used. If you set the timeout to zero, all ident calls are disabled.
5373 Although they are cheap and can provide useful information for tracing problem
5374 messages, some hosts and firewalls have problems with ident calls. This can
5375 result in a timeout instead of an immediate refused connection, leading to
5376 delays on starting up an incoming SMTP session.
5377
5378 When Exim receives messages over SMTP connections, it expects all addresses to
5379 be fully qualified with a domain, as required by the SMTP definition. However,
5380 if you are running a server to which simple clients submit messages, you may
5381 find that they send unqualified addresses. The two commented-out options:
5382 .code
5383 # sender_unqualified_hosts =
5384 # recipient_unqualified_hosts =
5385 .endd
5386 show how you can specify hosts that are permitted to send unqualified sender
5387 and recipient addresses, respectively.
5388
5389 The &%percent_hack_domains%& option is also commented out:
5390 .code
5391 # percent_hack_domains =
5392 .endd
5393 It provides a list of domains for which the &"percent hack"& is to operate.
5394 This is an almost obsolete form of explicit email routing. If you do not know
5395 anything about it, you can safely ignore this topic.
5396
5397 The last two settings in the main part of the default configuration are
5398 concerned with messages that have been &"frozen"& on Exim's queue. When a
5399 message is frozen, Exim no longer continues to try to deliver it. Freezing
5400 occurs when a bounce message encounters a permanent failure because the sender
5401 address of the original message that caused the bounce is invalid, so the
5402 bounce cannot be delivered. This is probably the most common case, but there
5403 are also other conditions that cause freezing, and frozen messages are not
5404 always bounce messages.
5405 .code
5406 ignore_bounce_errors_after = 2d
5407 timeout_frozen_after = 7d
5408 .endd
5409 The first of these options specifies that failing bounce messages are to be
5410 discarded after 2 days on the queue. The second specifies that any frozen
5411 message (whether a bounce message or not) is to be timed out (and discarded)
5412 after a week. In this configuration, the first setting ensures that no failing
5413 bounce message ever lasts a week.
5414
5415
5416
5417 .section "ACL configuration" "SECID54"
5418 .cindex "default" "ACLs"
5419 .cindex "&ACL;" "default configuration"
5420 In the default configuration, the ACL section follows the main configuration.
5421 It starts with the line
5422 .code
5423 begin acl
5424 .endd
5425 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5426 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5427 and &%acl_smtp_data%& above.
5428
5429 .cindex "RCPT" "ACL for"
5430 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5431 RCPT command specifies one of the message's recipients. The ACL statements
5432 are considered in order, until the recipient address is either accepted or
5433 rejected. The RCPT command is then accepted or rejected, according to the
5434 result of the ACL processing.
5435 .code
5436 acl_check_rcpt:
5437 .endd
5438 This line, consisting of a name terminated by a colon, marks the start of the
5439 ACL, and names it.
5440 .code
5441 accept  hosts = :
5442 .endd
5443 This ACL statement accepts the recipient if the sending host matches the list.
5444 But what does that strange list mean? It doesn't actually contain any host
5445 names or IP addresses. The presence of the colon puts an empty item in the
5446 list; Exim matches this only if the incoming message did not come from a remote
5447 host, because in that case, the remote hostname is empty. The colon is
5448 important. Without it, the list itself is empty, and can never match anything.
5449
5450 What this statement is doing is to accept unconditionally all recipients in
5451 messages that are submitted by SMTP from local processes using the standard
5452 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5453 manner.
5454 .code
5455 deny    message       = Restricted characters in address
5456         domains       = +local_domains
5457         local_parts   = ^[.] : ^.*[@%!/|]
5458
5459 deny    message       = Restricted characters in address
5460         domains       = !+local_domains
5461         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5462 .endd
5463 These statements are concerned with local parts that contain any of the
5464 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5465 Although these characters are entirely legal in local parts (in the case of
5466 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5467 in Internet mail addresses.
5468
5469 The first three have in the past been associated with explicitly routed
5470 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5471 option). Addresses containing these characters are regularly tried by spammers
5472 in an attempt to bypass relaying restrictions, and also by open relay testing
5473 programs. Unless you really need them it is safest to reject these characters
5474 at this early stage. This configuration is heavy-handed in rejecting these
5475 characters for all messages it accepts from remote hosts. This is a deliberate
5476 policy of being as safe as possible.
5477
5478 The first rule above is stricter, and is applied to messages that are addressed
5479 to one of the local domains handled by this host. This is implemented by the
5480 first condition, which restricts it to domains that are listed in the
5481 &'local_domains'& domain list. The &"+"& character is used to indicate a
5482 reference to a named list. In this configuration, there is just one domain in
5483 &'local_domains'&, but in general there may be many.
5484
5485 The second condition on the first statement uses two regular expressions to
5486 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5487 or &"|"&. If you have local accounts that include these characters, you will
5488 have to modify this rule.
5489
5490 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5491 allows them because they have been encountered in practice. (Consider the
5492 common convention of local parts constructed as
5493 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5494 the author of Exim, who has no second initial.) However, a local part starting
5495 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5496 file name (for example, for a mailing list). This is also true for local parts
5497 that contain slashes. A pipe symbol can also be troublesome if the local part
5498 is incorporated unthinkingly into a shell command line.
5499
5500 The second rule above applies to all other domains, and is less strict. This
5501 allows your own users to send outgoing messages to sites that use slashes
5502 and vertical bars in their local parts. It blocks local parts that begin
5503 with a dot, slash, or vertical bar, but allows these characters within the
5504 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5505 and &"!"& is blocked, as before. The motivation here is to prevent your users
5506 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5507 .code
5508 accept  local_parts   = postmaster
5509         domains       = +local_domains
5510 .endd
5511 This statement, which has two conditions, accepts an incoming address if the
5512 local part is &'postmaster'& and the domain is one of those listed in the
5513 &'local_domains'& domain list. The &"+"& character is used to indicate a
5514 reference to a named list. In this configuration, there is just one domain in
5515 &'local_domains'&, but in general there may be many.
5516
5517 The presence of this statement means that mail to postmaster is never blocked
5518 by any of the subsequent tests. This can be helpful while sorting out problems
5519 in cases where the subsequent tests are incorrectly denying access.
5520 .code
5521 require verify        = sender
5522 .endd
5523 This statement requires the sender address to be verified before any subsequent
5524 ACL statement can be used. If verification fails, the incoming recipient
5525 address is refused. Verification consists of trying to route the address, to
5526 see if a bounce message could be delivered to it. In the case of remote
5527 addresses, basic verification checks only the domain, but &'callouts'& can be
5528 used for more verification if required. Section &<<SECTaddressverification>>&
5529 discusses the details of address verification.
5530 .code
5531 accept  hosts         = +relay_from_hosts
5532         control       = submission
5533 .endd
5534 This statement accepts the address if the message is coming from one of the
5535 hosts that are defined as being allowed to relay through this host. Recipient
5536 verification is omitted here, because in many cases the clients are dumb MUAs
5537 that do not cope well with SMTP error responses. For the same reason, the
5538 second line specifies &"submission mode"& for messages that are accepted. This
5539 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5540 messages that are deficient in some way, for example, because they lack a
5541 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5542 probably add recipient verification here, and disable submission mode.
5543 .code
5544 accept  authenticated = *
5545         control       = submission
5546 .endd
5547 This statement accepts the address if the client host has authenticated itself.
5548 Submission mode is again specified, on the grounds that such messages are most
5549 likely to come from MUAs. The default configuration does not define any
5550 authenticators, though it does include some nearly complete commented-out
5551 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5552 fact authenticate until you complete the authenticator definitions.
5553 .code
5554 require message = relay not permitted
5555         domains = +local_domains : +relay_domains
5556 .endd
5557 This statement rejects the address if its domain is neither a local domain nor
5558 one of the domains for which this host is a relay.
5559 .code
5560 require verify = recipient
5561 .endd
5562 This statement requires the recipient address to be verified; if verification
5563 fails, the address is rejected.
5564 .code
5565 # deny    message     = rejected because $sender_host_address \
5566 #                       is in a black list at $dnslist_domain\n\
5567 #                       $dnslist_text
5568 #         dnslists    = black.list.example
5569 #
5570 # warn    dnslists    = black.list.example
5571 #         add_header  = X-Warning: $sender_host_address is in \
5572 #                       a black list at $dnslist_domain
5573 #         log_message = found in $dnslist_domain
5574 .endd
5575 These commented-out lines are examples of how you could configure Exim to check
5576 sending hosts against a DNS black list. The first statement rejects messages
5577 from blacklisted hosts, whereas the second just inserts a warning header
5578 line.
5579 .code
5580 # require verify = csa
5581 .endd
5582 This commented-out line is an example of how you could turn on client SMTP
5583 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5584 records.
5585 .code
5586 accept
5587 .endd
5588 The final statement in the first ACL unconditionally accepts any recipient
5589 address that has successfully passed all the previous tests.
5590 .code
5591 acl_check_data:
5592 .endd
5593 This line marks the start of the second ACL, and names it. Most of the contents
5594 of this ACL are commented out:
5595 .code
5596 # deny    malware   = *
5597 #         message   = This message contains a virus \
5598 #                     ($malware_name).
5599 .endd
5600 These lines are examples of how to arrange for messages to be scanned for
5601 viruses when Exim has been compiled with the content-scanning extension, and a
5602 suitable virus scanner is installed. If the message is found to contain a
5603 virus, it is rejected with the given custom error message.
5604 .code
5605 # warn    spam      = nobody
5606 #         message   = X-Spam_score: $spam_score\n\
5607 #                     X-Spam_score_int: $spam_score_int\n\
5608 #                     X-Spam_bar: $spam_bar\n\
5609 #                     X-Spam_report: $spam_report
5610 .endd
5611 These lines are an example of how to arrange for messages to be scanned by
5612 SpamAssassin when Exim has been compiled with the content-scanning extension,
5613 and SpamAssassin has been installed. The SpamAssassin check is run with
5614 &`nobody`& as its user parameter, and the results are added to the message as a
5615 series of extra header line. In this case, the message is not rejected,
5616 whatever the spam score.
5617 .code
5618 accept
5619 .endd
5620 This final line in the DATA ACL accepts the message unconditionally.
5621
5622
5623 .section "Router configuration" "SECID55"
5624 .cindex "default" "routers"
5625 .cindex "routers" "default"
5626 The router configuration comes next in the default configuration, introduced
5627 by the line
5628 .code
5629 begin routers
5630 .endd
5631 Routers are the modules in Exim that make decisions about where to send
5632 messages. An address is passed to each router in turn, until it is either
5633 accepted, or failed. This means that the order in which you define the routers
5634 matters. Each router is fully described in its own chapter later in this
5635 manual. Here we give only brief overviews.
5636 .code
5637 # domain_literal:
5638 #   driver = ipliteral
5639 #   domains = !+local_domains
5640 #   transport = remote_smtp
5641 .endd
5642 .cindex "domain literal" "default router"
5643 This router is commented out because the majority of sites do not want to
5644 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
5645 you uncomment this router, you also need to uncomment the setting of
5646 &%allow_domain_literals%& in the main part of the configuration.
5647 .code
5648 dnslookup:
5649   driver = dnslookup
5650   domains = ! +local_domains
5651   transport = remote_smtp
5652   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
5653   no_more
5654 .endd
5655 The first uncommented router handles addresses that do not involve any local
5656 domains. This is specified by the line
5657 .code
5658 domains = ! +local_domains
5659 .endd
5660 The &%domains%& option lists the domains to which this router applies, but the
5661 exclamation mark is a negation sign, so the router is used only for domains
5662 that are not in the domain list called &'local_domains'& (which was defined at
5663 the start of the configuration). The plus sign before &'local_domains'&
5664 indicates that it is referring to a named list. Addresses in other domains are
5665 passed on to the following routers.
5666
5667 The name of the router driver is &(dnslookup)&,
5668 and is specified by the &%driver%& option. Do not be confused by the fact that
5669 the name of this router instance is the same as the name of the driver. The
5670 instance name is arbitrary, but the name set in the &%driver%& option must be
5671 one of the driver modules that is in the Exim binary.
5672
5673 The &(dnslookup)& router routes addresses by looking up their domains in the
5674 DNS in order to obtain a list of hosts to which the address is routed. If the
5675 router succeeds, the address is queued for the &(remote_smtp)& transport, as
5676 specified by the &%transport%& option. If the router does not find the domain
5677 in the DNS, no further routers are tried because of the &%no_more%& setting, so
5678 the address fails and is bounced.
5679
5680 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
5681 be entirely ignored. This option is present because a number of cases have been
5682 encountered where MX records in the DNS point to host names
5683 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
5684 Completely ignoring these IP addresses causes Exim to fail to route the
5685 email address, so it bounces. Otherwise, Exim would log a routing problem, and
5686 continue to try to deliver the message periodically until the address timed
5687 out.
5688 .code
5689 system_aliases:
5690   driver = redirect
5691   allow_fail
5692   allow_defer
5693   data = ${lookup{$local_part}lsearch{/etc/aliases}}
5694 # user = exim
5695   file_transport = address_file
5696   pipe_transport = address_pipe
5697 .endd
5698 Control reaches this and subsequent routers only for addresses in the local
5699 domains. This router checks to see whether the local part is defined as an
5700 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
5701 data that it looks up from that file. If no data is found for the local part,
5702 the value of the &%data%& option is empty, causing the address to be passed to
5703 the next router.
5704
5705 &_/etc/aliases_& is a conventional name for the system aliases file that is
5706 often used. That is why it is referenced by from the default configuration
5707 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
5708 &_Local/Makefile_& before building Exim.
5709 .code
5710 userforward:
5711   driver = redirect
5712   check_local_user
5713 # local_part_suffix = +* : -*
5714 # local_part_suffix_optional
5715   file = $home/.forward
5716 # allow_filter
5717   no_verify
5718   no_expn
5719   check_ancestor
5720   file_transport = address_file
5721   pipe_transport = address_pipe
5722   reply_transport = address_reply
5723 .endd
5724 This is the most complicated router in the default configuration. It is another
5725 redirection router, but this time it is looking for forwarding data set up by
5726 individual users. The &%check_local_user%& setting specifies a check that the
5727 local part of the address is the login name of a local user. If it is not, the
5728 router is skipped. The two commented options that follow &%check_local_user%&,
5729 namely:
5730 .code
5731 # local_part_suffix = +* : -*
5732 # local_part_suffix_optional
5733 .endd
5734 .vindex "&$local_part_suffix$&"
5735 show how you can specify the recognition of local part suffixes. If the first
5736 is uncommented, a suffix beginning with either a plus or a minus sign, followed
5737 by any sequence of characters, is removed from the local part and placed in the
5738 variable &$local_part_suffix$&. The second suffix option specifies that the
5739 presence of a suffix in the local part is optional. When a suffix is present,
5740 the check for a local login uses the local part with the suffix removed.
5741
5742 When a local user account is found, the file called &_.forward_& in the user's
5743 home directory is consulted. If it does not exist, or is empty, the router
5744 declines. Otherwise, the contents of &_.forward_& are interpreted as
5745 redirection data (see chapter &<<CHAPredirect>>& for more details).
5746
5747 .cindex "Sieve filter" "enabling in default router"
5748 Traditional &_.forward_& files contain just a list of addresses, pipes, or
5749 files. Exim supports this by default. However, if &%allow_filter%& is set (it
5750 is commented out by default), the contents of the file are interpreted as a set
5751 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
5752 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
5753 separate document entitled &'Exim's interfaces to mail filtering'&.
5754
5755 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
5756 verifying addresses, or when running as a consequence of an SMTP EXPN command.
5757 There are two reasons for doing this:
5758
5759 .olist
5760 Whether or not a local user has a &_.forward_& file is not really relevant when
5761 checking an address for validity; it makes sense not to waste resources doing
5762 unnecessary work.
5763 .next
5764 More importantly, when Exim is verifying addresses or handling an EXPN
5765 command during an SMTP session, it is running as the Exim user, not as root.
5766 The group is the Exim group, and no additional groups are set up.
5767 It may therefore not be possible for Exim to read users' &_.forward_& files at
5768 this time.
5769 .endlist
5770
5771 The setting of &%check_ancestor%& prevents the router from generating a new
5772 address that is the same as any previous address that was redirected. (This
5773 works round a problem concerning a bad interaction between aliasing and
5774 forwarding &-- see section &<<SECTredlocmai>>&).
5775
5776 The final three option settings specify the transports that are to be used when
5777 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
5778 auto-reply, respectively. For example, if a &_.forward_& file contains
5779 .code
5780 a.nother@elsewhere.example, /home/spqr/archive
5781 .endd
5782 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
5783 transport.
5784 .code
5785 localuser:
5786   driver = accept
5787   check_local_user
5788 # local_part_suffix = +* : -*
5789 # local_part_suffix_optional
5790   transport = local_delivery
5791 .endd
5792 The final router sets up delivery into local mailboxes, provided that the local
5793 part is the name of a local login, by accepting the address and assigning it to
5794 the &(local_delivery)& transport. Otherwise, we have reached the end of the
5795 routers, so the address is bounced. The commented suffix settings fulfil the
5796 same purpose as they do for the &(userforward)& router.
5797
5798
5799 .section "Transport configuration" "SECID56"
5800 .cindex "default" "transports"
5801 .cindex "transports" "default"
5802 Transports define mechanisms for actually delivering messages. They operate
5803 only when referenced from routers, so the order in which they are defined does
5804 not matter. The transports section of the configuration starts with
5805 .code
5806 begin transports
5807 .endd
5808 One remote transport and four local transports are defined.
5809 .code
5810 remote_smtp:
5811   driver = smtp
5812 .endd
5813 This transport is used for delivering messages over SMTP connections. All its
5814 options are defaulted. The list of remote hosts comes from the router.
5815 .code
5816 local_delivery:
5817   driver = appendfile
5818   file = /var/mail/$local_part
5819   delivery_date_add
5820   envelope_to_add
5821   return_path_add
5822 # group = mail
5823 # mode = 0660
5824 .endd
5825 This &(appendfile)& transport is used for local delivery to user mailboxes in
5826 traditional BSD mailbox format. By default it runs under the uid and gid of the
5827 local user, which requires the sticky bit to be set on the &_/var/mail_&
5828 directory. Some systems use the alternative approach of running mail deliveries
5829 under a particular group instead of using the sticky bit. The commented options
5830 show how this can be done.
5831
5832 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
5833 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
5834 similarly-named options above.
5835 .code
5836 address_pipe:
5837   driver = pipe
5838   return_output
5839 .endd
5840 This transport is used for handling deliveries to pipes that are generated by
5841 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
5842 option specifies that any output generated by the pipe is to be returned to the
5843 sender.
5844 .code
5845 address_file:
5846   driver = appendfile
5847   delivery_date_add
5848   envelope_to_add
5849   return_path_add
5850 .endd
5851 This transport is used for handling deliveries to files that are generated by
5852 redirection. The name of the file is not specified in this instance of
5853 &(appendfile)&, because it comes from the &(redirect)& router.
5854 .code
5855 address_reply:
5856   driver = autoreply
5857 .endd
5858 This transport is used for handling automatic replies generated by users'
5859 filter files.
5860
5861
5862
5863 .section "Default retry rule" "SECID57"
5864 .cindex "retry" "default rule"
5865 .cindex "default" "retry rule"
5866 The retry section of the configuration file contains rules which affect the way
5867 Exim retries deliveries that cannot be completed at the first attempt. It is
5868 introduced by the line
5869 .code
5870 begin retry
5871 .endd
5872 In the default configuration, there is just one rule, which applies to all
5873 errors:
5874 .code
5875 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
5876 .endd
5877 This causes any temporarily failing address to be retried every 15 minutes for
5878 2 hours, then at intervals starting at one hour and increasing by a factor of
5879 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
5880 is not delivered after 4 days of temporary failure, it is bounced.
5881
5882 If the retry section is removed from the configuration, or is empty (that is,
5883 if no retry rules are defined), Exim will not retry deliveries. This turns
5884 temporary errors into permanent errors.
5885
5886
5887 .section "Rewriting configuration" "SECID58"
5888 The rewriting section of the configuration, introduced by
5889 .code
5890 begin rewrite
5891 .endd
5892 contains rules for rewriting addresses in messages as they arrive. There are no
5893 rewriting rules in the default configuration file.
5894
5895
5896
5897 .section "Authenticators configuration" "SECTdefconfauth"
5898 .cindex "AUTH" "configuration"
5899 The authenticators section of the configuration, introduced by
5900 .code
5901 begin authenticators
5902 .endd
5903 defines mechanisms for the use of the SMTP AUTH command. The default
5904 configuration file contains two commented-out example authenticators
5905 which support plaintext username/password authentication using the
5906 standard PLAIN mechanism and the traditional but non-standard LOGIN
5907 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
5908 to support most MUA software.
5909
5910 The example PLAIN authenticator looks like this:
5911 .code
5912 #PLAIN:
5913 #  driver                  = plaintext
5914 #  server_set_id           = $auth2
5915 #  server_prompts          = :
5916 #  server_condition        = Authentication is not yet configured
5917 #  server_advertise_condition = ${if def:tls_cipher }
5918 .endd
5919 And the example LOGIN authenticator looks like this:
5920 .code
5921 #LOGIN:
5922 #  driver                  = plaintext
5923 #  server_set_id           = $auth1
5924 #  server_prompts          = <| Username: | Password:
5925 #  server_condition        = Authentication is not yet configured
5926 #  server_advertise_condition = ${if def:tls_cipher }
5927 .endd
5928
5929 The &%server_set_id%& option makes Exim remember the authenticated username
5930 in &$authenticated_id$&, which can be used later in ACLs or routers. The
5931 &%server_prompts%& option configures the &(plaintext)& authenticator so
5932 that it implements the details of the specific authentication mechanism,
5933 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
5934 when Exim offers authentication to clients; in the examples, this is only
5935 when TLS or SSL has been started, so to enable the authenticators you also
5936 need to add support for TLS as described in &<<SECTdefconfmain>>&.
5937
5938 The &%server_condition%& setting defines how to verify that the username and
5939 password are correct. In the examples it just produces an error message.
5940 To make the authenticators work, you can use a string expansion
5941 expression like one of the examples in &<<CHAPplaintext>>&.
5942
5943 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
5944 usercode and password are in different positions.  &<<CHAPplaintext>>&
5945 covers both.
5946
5947 .ecindex IIDconfiwal
5948
5949
5950
5951 . ////////////////////////////////////////////////////////////////////////////
5952 . ////////////////////////////////////////////////////////////////////////////
5953
5954 .chapter "Regular expressions" "CHAPregexp"
5955
5956 .cindex "regular expressions" "library"
5957 .cindex "PCRE"
5958 Exim supports the use of regular expressions in many of its options. It
5959 uses the PCRE regular expression library; this provides regular expression
5960 matching that is compatible with Perl 5. The syntax and semantics of
5961 regular expressions is discussed in many Perl reference books, and also in
5962 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
5963 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
5964
5965 The documentation for the syntax and semantics of the regular expressions that
5966 are supported by PCRE is included in the PCRE distribution, and no further
5967 description is included here. The PCRE functions are called from Exim using
5968 the default option settings (that is, with no PCRE options set), except that
5969 the PCRE_CASELESS option is set when the matching is required to be
5970 case-insensitive.
5971
5972 In most cases, when a regular expression is required in an Exim configuration,
5973 it has to start with a circumflex, in order to distinguish it from plain text
5974 or an &"ends with"& wildcard. In this example of a configuration setting, the
5975 second item in the colon-separated list is a regular expression.
5976 .code
5977 domains = a.b.c : ^\\d{3} : *.y.z : ...
5978 .endd
5979 The doubling of the backslash is required because of string expansion that
5980 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
5981 of this issue, and a way of avoiding the need for doubling backslashes. The
5982 regular expression that is eventually used in this example contains just one
5983 backslash. The circumflex is included in the regular expression, and has the
5984 normal effect of &"anchoring"& it to the start of the string that is being
5985 matched.
5986
5987 There are, however, two cases where a circumflex is not required for the
5988 recognition of a regular expression: these are the &%match%& condition in a
5989 string expansion, and the &%matches%& condition in an Exim filter file. In
5990 these cases, the relevant string is always treated as a regular expression; if
5991 it does not start with a circumflex, the expression is not anchored, and can
5992 match anywhere in the subject string.
5993
5994 In all cases, if you want a regular expression to match at the end of a string,
5995 you must code the $ metacharacter to indicate this. For example:
5996 .code
5997 domains = ^\\d{3}\\.example
5998 .endd
5999 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6000 You need to use:
6001 .code
6002 domains = ^\\d{3}\\.example\$
6003 .endd
6004 if you want &'example'& to be the top-level domain. The backslash before the
6005 $ is needed because string expansion also interprets dollar characters.
6006
6007
6008
6009 . ////////////////////////////////////////////////////////////////////////////
6010 . ////////////////////////////////////////////////////////////////////////////
6011
6012 .chapter "File and database lookups" "CHAPfdlookup"
6013 .scindex IIDfidalo1 "file" "lookups"
6014 .scindex IIDfidalo2 "database" "lookups"
6015 .cindex "lookup" "description of"
6016 Exim can be configured to look up data in files or databases as it processes
6017 messages. Two different kinds of syntax are used:
6018
6019 .olist
6020 A string that is to be expanded may contain explicit lookup requests. These
6021 cause parts of the string to be replaced by data that is obtained from the
6022 lookup. Lookups of this type are conditional expansion items. Different results
6023 can be defined for the cases of lookup success and failure. See chapter
6024 &<<CHAPexpand>>&, where string expansions are described in detail.
6025 .next
6026 Lists of domains, hosts, and email addresses can contain lookup requests as a
6027 way of avoiding excessively long linear lists. In this case, the data that is
6028 returned by the lookup is often (but not always) discarded; whether the lookup
6029 succeeds or fails is what really counts. These kinds of list are described in
6030 chapter &<<CHAPdomhosaddlists>>&.
6031 .endlist
6032
6033 String expansions, lists, and lookups interact with each other in such a way
6034 that there is no order in which to describe any one of them that does not
6035 involve references to the others. Each of these three chapters makes more sense
6036 if you have read the other two first. If you are reading this for the first
6037 time, be aware that some of it will make a lot more sense after you have read
6038 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6039
6040 .section "Examples of different lookup syntax" "SECID60"
6041 It is easy to confuse the two different kinds of lookup, especially as the
6042 lists that may contain the second kind are always expanded before being
6043 processed as lists. Therefore, they may also contain lookups of the first kind.
6044 Be careful to distinguish between the following two examples:
6045 .code
6046 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6047 domains = lsearch;/some/file
6048 .endd
6049 The first uses a string expansion, the result of which must be a domain list.
6050 No strings have been specified for a successful or a failing lookup; the
6051 defaults in this case are the looked-up data and an empty string, respectively.
6052 The expansion takes place before the string is processed as a list, and the
6053 file that is searched could contain lines like this:
6054 .code
6055 192.168.3.4: domain1:domain2:...
6056 192.168.1.9: domain3:domain4:...
6057 .endd
6058 When the lookup succeeds, the result of the expansion is a list of domains (and
6059 possibly other types of item that are allowed in domain lists).
6060
6061 In the second example, the lookup is a single item in a domain list. It causes
6062 Exim to use a lookup to see if the domain that is being processed can be found
6063 in the file. The file could contains lines like this:
6064 .code
6065 domain1:
6066 domain2:
6067 .endd
6068 Any data that follows the keys is not relevant when checking that the domain
6069 matches the list item.
6070
6071 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6072 Consider a file containing lines like this:
6073 .code
6074 192.168.5.6: lsearch;/another/file
6075 .endd
6076 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6077 first &%domains%& setting above generates the second setting, which therefore
6078 causes a second lookup to occur.
6079
6080 The rest of this chapter describes the different lookup types that are
6081 available. Any of them can be used in any part of the configuration where a
6082 lookup is permitted.
6083
6084
6085 .section "Lookup types" "SECID61"
6086 .cindex "lookup" "types of"
6087 .cindex "single-key lookup" "definition of"
6088 Two different types of data lookup are implemented:
6089
6090 .ilist
6091 The &'single-key'& type requires the specification of a file in which to look,
6092 and a single key to search for. The key must be a non-empty string for the
6093 lookup to succeed. The lookup type determines how the file is searched.
6094 .next
6095 .cindex "query-style lookup" "definition of"
6096 The &'query-style'& type accepts a generalized database query. No particular
6097 key value is assumed by Exim for query-style lookups. You can use whichever
6098 Exim variables you need to construct the database query.
6099 .endlist
6100
6101 The code for each lookup type is in a separate source file that is included in
6102 the binary of Exim only if the corresponding compile-time option is set. The
6103 default settings in &_src/EDITME_& are:
6104 .code
6105 LOOKUP_DBM=yes
6106 LOOKUP_LSEARCH=yes
6107 .endd
6108 which means that only linear searching and DBM lookups are included by default.
6109 For some types of lookup (e.g. SQL databases), you need to install appropriate
6110 libraries and header files before building Exim.
6111
6112
6113
6114
6115 .section "Single-key lookup types" "SECTsinglekeylookups"
6116 .cindex "lookup" "single-key types"
6117 .cindex "single-key lookup" "list of types"
6118 The following single-key lookup types are implemented:
6119
6120 .ilist
6121 .cindex "cdb" "description of"
6122 .cindex "lookup" "cdb"
6123 .cindex "binary zero" "in lookup key"
6124 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6125 string without a terminating binary zero. The cdb format is designed for
6126 indexed files that are read frequently and never updated, except by total
6127 re-creation. As such, it is particularly suitable for large files containing
6128 aliases or other indexed data referenced by an MTA. Information about cdb can
6129 be found in several places:
6130 .display
6131 &url(http://www.pobox.com/~djb/cdb.html)
6132 &url(ftp://ftp.corpit.ru/pub/tinycdb/)
6133 &url(http://packages.debian.org/stable/utils/freecdb.html)
6134 .endd
6135 A cdb distribution is not needed in order to build Exim with cdb support,
6136 because the code for reading cdb files is included directly in Exim itself.
6137 However, no means of building or testing cdb files is provided with Exim, so
6138 you need to obtain a cdb distribution in order to do this.
6139 .next
6140 .cindex "DBM" "lookup type"
6141 .cindex "lookup" "dbm"
6142 .cindex "binary zero" "in lookup key"
6143 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6144 DBM file by looking up the record with the given key. A terminating binary
6145 zero is included in the key that is passed to the DBM library. See section
6146 &<<SECTdb>>& for a discussion of DBM libraries.
6147
6148 .cindex "Berkeley DB library" "file format"
6149 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6150 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6151 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6152 the DB_UNKNOWN option. This enables it to handle any of the types of database
6153 that the library supports, and can be useful for accessing DBM files created by
6154 other applications. (For earlier DB versions, DB_HASH is always used.)
6155 .next
6156 .cindex "lookup" "dbmnz"
6157 .cindex "lookup" "dbm &-- terminating zero"
6158 .cindex "binary zero" "in lookup key"
6159 .cindex "Courier"
6160 .cindex "&_/etc/userdbshadow.dat_&"
6161 .cindex "dmbnz lookup type"
6162 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6163 is not included in the key that is passed to the DBM library. You may need this
6164 if you want to look up data in files that are created by or shared with some
6165 other application that does not use terminating zeros. For example, you need to
6166 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6167 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6168 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6169 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6170 .next
6171 .cindex "lookup" "dsearch"
6172 .cindex "dsearch lookup type"
6173 &(dsearch)&: The given file must be a directory; this is searched for an entry
6174 whose name is the key by calling the &[lstat()]& function. The key may not
6175 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6176 the lookup is the name of the entry, which may be a file, directory,
6177 symbolic link, or any other kind of directory entry. An example of how this
6178 lookup can be used to support virtual domains is given in section
6179 &<<SECTvirtualdomains>>&.
6180 .next
6181 .cindex "lookup" "iplsearch"
6182 .cindex "iplsearch lookup type"
6183 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6184 terminated by a colon or white space or the end of the line. The keys in the
6185 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6186 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6187 being interpreted as a key terminator. For example:
6188 .code
6189 1.2.3.4:           data for 1.2.3.4
6190 192.168.0.0/16:    data for 192.168.0.0/16
6191 "abcd::cdab":      data for abcd::cdab
6192 "abcd:abcd::/32"   data for abcd:abcd::/32
6193 .endd
6194 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6195 file is searched linearly, using the CIDR masks where present, until a matching
6196 key is found. The first key that matches is used; there is no attempt to find a
6197 &"best"& match. Apart from the way the keys are matched, the processing for
6198 &(iplsearch)& is the same as for &(lsearch)&.
6199
6200 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6201 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6202 lookup types support only literal keys.
6203
6204 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6205 the implicit key is the host's IP address rather than its name (see section
6206 &<<SECThoslispatsikey>>&).
6207 .next
6208 .cindex "linear search"
6209 .cindex "lookup" "lsearch"
6210 .cindex "lsearch lookup type"
6211 .cindex "case sensitivity" "in lsearch lookup"
6212 &(lsearch)&: The given file is a text file that is searched linearly for a
6213 line beginning with the search key, terminated by a colon or white space or the
6214 end of the line. The search is case-insensitive; that is, upper and lower case
6215 letters are treated as the same. The first occurrence of the key that is found
6216 in the file is used.
6217
6218 White space between the key and the colon is permitted. The remainder of the
6219 line, with leading and trailing white space removed, is the data. This can be
6220 continued onto subsequent lines by starting them with any amount of white
6221 space, but only a single space character is included in the data at such a
6222 junction. If the data begins with a colon, the key must be terminated by a
6223 colon, for example:
6224 .code
6225 baduser:  :fail:
6226 .endd
6227 Empty lines and lines beginning with # are ignored, even if they occur in the
6228 middle of an item. This is the traditional textual format of alias files. Note
6229 that the keys in an &(lsearch)& file are literal strings. There is no
6230 wildcarding of any kind.
6231
6232 .cindex "lookup" "lsearch &-- colons in keys"
6233 .cindex "white space" "in lsearch key"
6234 In most &(lsearch)& files, keys are not required to contain colons or #
6235 characters, or white space. However, if you need this feature, it is available.
6236 If a key begins with a doublequote character, it is terminated only by a
6237 matching quote (or end of line), and the normal escaping rules apply to its
6238 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6239 quoted keys (exactly as for unquoted keys). There is no special handling of
6240 quotes for the data part of an &(lsearch)& line.
6241
6242 .next
6243 .cindex "NIS lookup type"
6244 .cindex "lookup" "NIS"
6245 .cindex "binary zero" "in lookup key"
6246 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6247 the given key, without a terminating binary zero. There is a variant called
6248 &(nis0)& which does include the terminating binary zero in the key. This is
6249 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6250 aliases; the full map names must be used.
6251
6252 .next
6253 .cindex "wildlsearch lookup type"
6254 .cindex "lookup" "wildlsearch"
6255 .cindex "nwildlsearch lookup type"
6256 .cindex "lookup" "nwildlsearch"
6257 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6258 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6259 the file may be wildcarded. The difference between these two lookup types is
6260 that for &(wildlsearch)&, each key in the file is string-expanded before being
6261 used, whereas for &(nwildlsearch)&, no expansion takes place.
6262
6263 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6264 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6265 file that are regular expressions can be made case-sensitive by the use of
6266 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6267
6268 . ==== As this is a nested list, any displays it contains must be indented
6269 . ==== as otherwise they are too far to the left.
6270
6271 .olist
6272 The string may begin with an asterisk to mean &"ends with"&. For example:
6273 .code
6274     *.a.b.c       data for anything.a.b.c
6275     *fish         data for anythingfish
6276 .endd
6277 .next
6278 The string may begin with a circumflex to indicate a regular expression. For
6279 example, for &(wildlsearch)&:
6280 .code
6281     ^\N\d+\.a\.b\N    data for <digits>.a.b
6282 .endd
6283 Note the use of &`\N`& to disable expansion of the contents of the regular
6284 expression. If you are using &(nwildlsearch)&, where the keys are not
6285 string-expanded, the equivalent entry is:
6286 .code
6287     ^\d+\.a\.b        data for <digits>.a.b
6288 .endd
6289 The case-insensitive flag is set at the start of compiling the regular
6290 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6291 For example, to make the entire pattern case-sensitive:
6292 .code
6293     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6294 .endd
6295
6296 If the regular expression contains white space or colon characters, you must
6297 either quote it (see &(lsearch)& above), or represent these characters in other
6298 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6299 colon. This may be easier than quoting, because if you quote, you have to
6300 escape all the backslashes inside the quotes.
6301
6302 &*Note*&: It is not possible to capture substrings in a regular expression
6303 match for later use, because the results of all lookups are cached. If a lookup
6304 is repeated, the result is taken from the cache, and no actual pattern matching
6305 takes place. The values of all the numeric variables are unset after a
6306 &((n)wildlsearch)& match.
6307
6308 .next
6309 Although I cannot see it being of much use, the general matching function that
6310 is used to implement &((n)wildlsearch)& means that the string may begin with a
6311 lookup name terminated by a semicolon, and followed by lookup data. For
6312 example:
6313 .code
6314     cdb;/some/file  data for keys that match the file
6315 .endd
6316 The data that is obtained from the nested lookup is discarded.
6317 .endlist olist
6318
6319 Keys that do not match any of these patterns are interpreted literally. The
6320 continuation rules for the data are the same as for &(lsearch)&, and keys may
6321 be followed by optional colons.
6322
6323 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6324 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6325 lookup types support only literal keys.
6326 .endlist ilist
6327
6328
6329 .section "Query-style lookup types" "SECID62"
6330 .cindex "lookup" "query-style types"
6331 .cindex "query-style lookup" "list of types"
6332 The supported query-style lookup types are listed below. Further details about
6333 many of them are given in later sections.
6334
6335 .ilist
6336 .cindex "DNS" "as a lookup type"
6337 .cindex "lookup" "DNS"
6338 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6339 are given in the supplied query. The resulting data is the contents of the
6340 records. See section &<<SECTdnsdb>>&.
6341 .next
6342 .cindex "InterBase lookup type"
6343 .cindex "lookup" "InterBase"
6344 &(ibase)&: This does a lookup in an InterBase database.
6345 .next
6346 .cindex "LDAP" "lookup type"
6347 .cindex "lookup" "LDAP"
6348 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6349 returns attributes from a single entry. There is a variant called &(ldapm)&
6350 that permits values from multiple entries to be returned. A third variant
6351 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6352 any attribute values. See section &<<SECTldap>>&.
6353 .next
6354 .cindex "MySQL" "lookup type"
6355 .cindex "lookup" "MySQL"
6356 &(mysql)&: The format of the query is an SQL statement that is passed to a
6357 MySQL database. See section &<<SECTsql>>&.
6358 .next
6359 .cindex "NIS+ lookup type"
6360 .cindex "lookup" "NIS+"
6361 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6362 the field to be returned. See section &<<SECTnisplus>>&.
6363 .next
6364 .cindex "Oracle" "lookup type"
6365 .cindex "lookup" "Oracle"
6366 &(oracle)&: The format of the query is an SQL statement that is passed to an
6367 Oracle database. See section &<<SECTsql>>&.
6368 .next
6369 .cindex "lookup" "passwd"
6370 .cindex "passwd lookup type"
6371 .cindex "&_/etc/passwd_&"
6372 &(passwd)& is a query-style lookup with queries that are just user names. The
6373 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6374 success, the result string is the same as you would get from an &(lsearch)&
6375 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6376 password value. For example:
6377 .code
6378 *:42:42:King Rat:/home/kr:/bin/bash
6379 .endd
6380 .next
6381 .cindex "PostgreSQL lookup type"
6382 .cindex "lookup" "PostgreSQL"
6383 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6384 PostgreSQL database. See section &<<SECTsql>>&.
6385
6386 .next
6387 .cindex "sqlite lookup type"
6388 .cindex "lookup" "sqlite"
6389 &(sqlite)&: The format of the query is a file name followed by an SQL statement
6390 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6391
6392 .next
6393 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6394 not likely to be useful in normal operation.
6395 .next
6396 .cindex "whoson lookup type"
6397 .cindex "lookup" "whoson"
6398 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6399 allows a server to check whether a particular (dynamically allocated) IP
6400 address is currently allocated to a known (trusted) user and, optionally, to
6401 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6402 at one time for &"POP before SMTP"& authentication, but that approach has been
6403 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6404 &"POP before SMTP"& checking using ACL statements such as
6405 .code
6406 require condition = \
6407   ${lookup whoson {$sender_host_address}{yes}{no}}
6408 .endd
6409 The query consists of a single IP address. The value returned is the name of
6410 the authenticated user, which is stored in the variable &$value$&. However, in
6411 this example, the data in &$value$& is not used; the result of the lookup is
6412 one of the fixed strings &"yes"& or &"no"&.
6413 .endlist
6414
6415
6416
6417 .section "Temporary errors in lookups" "SECID63"
6418 .cindex "lookup" "temporary error in"
6419 Lookup functions can return temporary error codes if the lookup cannot be
6420 completed. For example, an SQL or LDAP database might be unavailable. For this
6421 reason, it is not advisable to use a lookup that might do this for critical
6422 options such as a list of local domains.
6423
6424 When a lookup cannot be completed in a router or transport, delivery
6425 of the message (to the relevant address) is deferred, as for any other
6426 temporary error. In other circumstances Exim may assume the lookup has failed,
6427 or may give up altogether.
6428
6429
6430
6431 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
6432 .cindex "wildcard lookups"
6433 .cindex "lookup" "default values"
6434 .cindex "lookup" "wildcard"
6435 .cindex "lookup" "* added to type"
6436 .cindex "default" "in single-key lookups"
6437 In this context, a &"default value"& is a value specified by the administrator
6438 that is to be used if a lookup fails.
6439
6440 &*Note:*& This section applies only to single-key lookups. For query-style
6441 lookups, the facilities of the query language must be used. An attempt to
6442 specify a default for a query-style lookup provokes an error.
6443
6444 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
6445 and the initial lookup fails, the key &"*"& is looked up in the file to
6446 provide a default value. See also the section on partial matching below.
6447
6448 .cindex "*@ with single-key lookup"
6449 .cindex "lookup" "*@ added to type"
6450 .cindex "alias file" "per-domain default"
6451 Alternatively, if &"*@"& is added to a single-key lookup type (for example
6452 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
6453 character, a second lookup is done with everything before the last @ replaced
6454 by *. This makes it possible to provide per-domain defaults in alias files
6455 that include the domains in the keys. If the second lookup fails (or doesn't
6456 take place because there is no @ in the key), &"*"& is looked up.
6457 For example, a &(redirect)& router might contain:
6458 .code
6459 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
6460 .endd
6461 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
6462 looks up these keys, in this order:
6463 .code
6464 jane@eyre.example
6465 *@eyre.example
6466 *
6467 .endd
6468 The data is taken from whichever key it finds first. &*Note*&: In an
6469 &(lsearch)& file, this does not mean the first of these keys in the file. A
6470 complete scan is done for each key, and only if it is not found at all does
6471 Exim move on to try the next key.
6472
6473
6474
6475 .section "Partial matching in single-key lookups" "SECTpartiallookup"
6476 .cindex "partial matching"
6477 .cindex "wildcard lookups"
6478 .cindex "lookup" "partial matching"
6479 .cindex "lookup" "wildcard"
6480 .cindex "asterisk" "in search type"
6481 The normal operation of a single-key lookup is to search the file for an exact
6482 match with the given key. However, in a number of situations where domains are
6483 being looked up, it is useful to be able to do partial matching. In this case,
6484 information in the file that has a key starting with &"*."& is matched by any
6485 domain that ends with the components that follow the full stop. For example, if
6486 a key in a DBM file is
6487 .code
6488 *.dates.fict.example
6489 .endd
6490 then when partial matching is enabled this is matched by (amongst others)
6491 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
6492 by &'dates.fict.example'&, if that does not appear as a separate key in the
6493 file.
6494
6495 &*Note*&: Partial matching is not available for query-style lookups. It is
6496 also not available for any lookup items in address lists (see section
6497 &<<SECTaddresslist>>&).
6498
6499 Partial matching is implemented by doing a series of separate lookups using
6500 keys constructed by modifying the original subject key. This means that it can
6501 be used with any of the single-key lookup types, provided that
6502 partial matching keys
6503 beginning with a special prefix (default &"*."&) are included in the data file.
6504 Keys in the file that do not begin with the prefix are matched only by
6505 unmodified subject keys when partial matching is in use.
6506
6507 Partial matching is requested by adding the string &"partial-"& to the front of
6508 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
6509 is done, the subject key is first looked up unmodified; if that fails, &"*."&
6510 is added at the start of the subject key, and it is looked up again. If that
6511 fails, further lookups are tried with dot-separated components removed from the
6512 start of the subject key, one-by-one, and &"*."& added on the front of what
6513 remains.
6514
6515 A minimum number of two non-* components are required. This can be adjusted
6516 by including a number before the hyphen in the search type. For example,
6517 &%partial3-lsearch%& specifies a minimum of three non-* components in the
6518 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
6519 subject key is &'2250.dates.fict.example'& then the following keys are looked
6520 up when the minimum number of non-* components is two:
6521 .code
6522 2250.dates.fict.example
6523 *.2250.dates.fict.example
6524 *.dates.fict.example
6525 *.fict.example
6526 .endd
6527 As soon as one key in the sequence is successfully looked up, the lookup
6528 finishes.
6529
6530 .cindex "lookup" "partial matching &-- changing prefix"
6531 .cindex "prefix" "for partial matching"
6532 The use of &"*."& as the partial matching prefix is a default that can be
6533 changed. The motivation for this feature is to allow Exim to operate with file
6534 formats that are used by other MTAs. A different prefix can be supplied in
6535 parentheses instead of the hyphen after &"partial"&. For example:
6536 .code
6537 domains = partial(.)lsearch;/some/file
6538 .endd
6539 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
6540 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
6541 components is unchanged). The prefix may consist of any punctuation characters
6542 other than a closing parenthesis. It may be empty, for example:
6543 .code
6544 domains = partial1()cdb;/some/file
6545 .endd
6546 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
6547 &`a.b.c`&, &`b.c`&, and &`c`&.
6548
6549 If &"partial0"& is specified, what happens at the end (when the lookup with
6550 just one non-wild component has failed, and the original key is shortened right
6551 down to the null string) depends on the prefix:
6552
6553 .ilist
6554 If the prefix has zero length, the whole lookup fails.
6555 .next
6556 If the prefix has length 1, a lookup for just the prefix is done. For
6557 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
6558 .next
6559 Otherwise, if the prefix ends in a dot, the dot is removed, and the
6560 remainder is looked up. With the default prefix, therefore, the final lookup is
6561 for &"*"& on its own.
6562 .next
6563 Otherwise, the whole prefix is looked up.
6564 .endlist
6565
6566
6567 If the search type ends in &"*"& or &"*@"& (see section
6568 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
6569 this implies happens after all partial lookups have failed. If &"partial0"& is
6570 specified, adding &"*"& to the search type has no effect with the default
6571 prefix, because the &"*"& key is already included in the sequence of partial
6572 lookups. However, there might be a use for lookup types such as
6573 &"partial0(.)lsearch*"&.
6574
6575 The use of &"*"& in lookup partial matching differs from its use as a wildcard
6576 in domain lists and the like. Partial matching works only in terms of
6577 dot-separated components; a key such as &`*fict.example`&
6578 in a database file is useless, because the asterisk in a partial matching
6579 subject key is always followed by a dot.
6580
6581
6582
6583
6584 .section "Lookup caching" "SECID64"
6585 .cindex "lookup" "caching"
6586 .cindex "caching" "lookup data"
6587 Exim caches all lookup results in order to avoid needless repetition of
6588 lookups. However, because (apart from the daemon) Exim operates as a collection
6589 of independent, short-lived processes, this caching applies only within a
6590 single Exim process. There is no inter-process lookup caching facility.
6591
6592 For single-key lookups, Exim keeps the relevant files open in case there is
6593 another lookup that needs them. In some types of configuration this can lead to
6594 many files being kept open for messages with many recipients. To avoid hitting
6595 the operating system limit on the number of simultaneously open files, Exim
6596 closes the least recently used file when it needs to open more files than its
6597 own internal limit, which can be changed via the &%lookup_open_max%& option.
6598
6599 The single-key lookup files are closed and the lookup caches are flushed at
6600 strategic points during delivery &-- for example, after all routing is
6601 complete.
6602
6603
6604
6605
6606 .section "Quoting lookup data" "SECID65"
6607 .cindex "lookup" "quoting"
6608 .cindex "quoting" "in lookups"
6609 When data from an incoming message is included in a query-style lookup, there
6610 is the possibility of special characters in the data messing up the syntax of
6611 the query. For example, a NIS+ query that contains
6612 .code
6613 [name=$local_part]
6614 .endd
6615 will be broken if the local part happens to contain a closing square bracket.
6616 For NIS+, data can be enclosed in double quotes like this:
6617 .code
6618 [name="$local_part"]
6619 .endd
6620 but this still leaves the problem of a double quote in the data. The rule for
6621 NIS+ is that double quotes must be doubled. Other lookup types have different
6622 rules, and to cope with the differing requirements, an expansion operator
6623 of the following form is provided:
6624 .code
6625 ${quote_<lookup-type>:<string>}
6626 .endd
6627 For example, the safest way to write the NIS+ query is
6628 .code
6629 [name="${quote_nisplus:$local_part}"]
6630 .endd
6631 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
6632 operator can be used for all lookup types, but has no effect for single-key
6633 lookups, since no quoting is ever needed in their key strings.
6634
6635
6636
6637
6638 .section "More about dnsdb" "SECTdnsdb"
6639 .cindex "dnsdb lookup"
6640 .cindex "lookup" "dnsdb"
6641 .cindex "DNS" "as a lookup type"
6642 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
6643 of a record type and a domain name, separated by an equals sign. For example,
6644 an expansion string could contain:
6645 .code
6646 ${lookup dnsdb{mx=a.b.example}{$value}fail}
6647 .endd
6648 If the lookup succeeds, the result is placed in &$value$&, which in this case
6649 is used on its own as the result. If the lookup does not succeed, the
6650 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
6651 &<<SECTforexpfai>>& for an explanation of what this means.
6652
6653 The supported DNS record types are A, CNAME, MX, NS, PTR, SRV, and TXT, and,
6654 when Exim is compiled with IPv6 support, AAAA (and A6 if that is also
6655 configured). If no type is given, TXT is assumed. When the type is PTR,
6656 the data can be an IP address, written as normal; inversion and the addition of
6657 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
6658 .code
6659 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
6660 .endd
6661 If the data for a PTR record is not a syntactically valid IP address, it is not
6662 altered and nothing is added.
6663
6664 .cindex "MX record" "in &(dnsdb)& lookup"
6665 .cindex "SRV record" "in &(dnsdb)& lookup"
6666 For an MX lookup, both the preference value and the host name are returned for
6667 each record, separated by a space. For an SRV lookup, the priority, weight,
6668 port, and host name are returned for each record, separated by spaces.
6669
6670 For any record type, if multiple records are found (or, for A6 lookups, if a
6671 single record leads to multiple addresses), the data is returned as a
6672 concatenation, with newline as the default separator. The order, of course,
6673 depends on the DNS resolver. You can specify a different separator character
6674 between multiple records by putting a right angle-bracket followed immediately
6675 by the new separator at the start of the query. For example:
6676 .code
6677 ${lookup dnsdb{>: a=host1.example}}
6678 .endd
6679 It is permitted to specify a space as the separator character. Further
6680 white space is ignored.
6681
6682 .new
6683 .cindex "TXT record" "in &(dnsdb)& lookup"
6684 For TXT records with multiple items of data, only the first item is returned,
6685 unless a separator for them is specified using a comma after the separator
6686 character followed immediately by the TXT record item separator. To concatenate
6687 items without a separator, use a semicolon instead.
6688 .code
6689 ${lookup dnsdb{>\n,: txt=a.b.example}}
6690 ${lookup dnsdb{>\n; txt=a.b.example}}
6691 .endd
6692 It is permitted to specify a space as the separator character. Further
6693 white space is ignored.
6694 .wen
6695
6696 .section "Pseudo dnsdb record types" "SECID66"
6697 .cindex "MX record" "in &(dnsdb)& lookup"
6698 By default, both the preference value and the host name are returned for
6699 each MX record, separated by a space. If you want only host names, you can use
6700 the pseudo-type MXH:
6701 .code
6702 ${lookup dnsdb{mxh=a.b.example}}
6703 .endd
6704 In this case, the preference values are omitted, and just the host names are
6705 returned.
6706
6707 .cindex "name server for enclosing domain"
6708 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
6709 records on the given domain, but if none are found, it removes the first
6710 component of the domain name, and tries again. This process continues until NS
6711 records are found or there are no more components left (or there is a DNS
6712 error). In other words, it may return the name servers for a top-level domain,
6713 but it never returns the root name servers. If there are no NS records for the
6714 top-level domain, the lookup fails. Consider these examples:
6715 .code
6716 ${lookup dnsdb{zns=xxx.quercite.com}}
6717 ${lookup dnsdb{zns=xxx.edu}}
6718 .endd
6719 Assuming that in each case there are no NS records for the full domain name,
6720 the first returns the name servers for &%quercite.com%&, and the second returns
6721 the name servers for &%edu%&.
6722
6723 You should be careful about how you use this lookup because, unless the
6724 top-level domain does not exist, the lookup always returns some host names. The
6725 sort of use to which this might be put is for seeing if the name servers for a
6726 given domain are on a blacklist. You can probably assume that the name servers
6727 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
6728 such a list.
6729
6730 .cindex "CSA" "in &(dnsdb)& lookup"
6731 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
6732 records according to the CSA rules, which are described in section
6733 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
6734 not sufficient because of the extra parent domain search behaviour of CSA. The
6735 result of a successful lookup such as:
6736 .code
6737 ${lookup dnsdb {csa=$sender_helo_name}}
6738 .endd
6739 has two space-separated fields: an authorization code and a target host name.
6740 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
6741 authorization required but absent, or &"?"& for unknown.
6742
6743
6744 .section "Multiple dnsdb lookups" "SECID67"
6745 In the previous sections, &(dnsdb)& lookups for a single domain are described.
6746 However, you can specify a list of domains or IP addresses in a single
6747 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
6748 the default separator, but with the ability to change this. For example:
6749 .code
6750 ${lookup dnsdb{one.domain.com:two.domain.com}}
6751 ${lookup dnsdb{a=one.host.com:two.host.com}}
6752 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
6753 .endd
6754 In order to retain backwards compatibility, there is one special case: if
6755 the lookup type is PTR and no change of separator is specified, Exim looks
6756 to see if the rest of the string is precisely one IPv6 address. In this
6757 case, it does not treat it as a list.
6758
6759 The data from each lookup is concatenated, with newline separators by default,
6760 in the same way that multiple DNS records for a single item are handled. A
6761 different separator can be specified, as described above.
6762
6763 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
6764 temporary DNS error for any of them, the behaviour is controlled by
6765 an optional keyword followed by a comma that may appear before the record
6766 type. The possible keywords are &"defer_strict"&, &"defer_never"&, and
6767 &"defer_lax"&. With &"strict"& behaviour, any temporary DNS error causes the
6768 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
6769 ignored, and the behaviour is as if the DNS lookup failed to find anything.
6770 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
6771 error causes the whole lookup to defer only if none of the other lookups
6772 succeed. The default is &"lax"&, so the following lookups are equivalent:
6773 .code
6774 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
6775 ${lookup dnsdb{a=one.host.com:two.host.com}}
6776 .endd
6777 Thus, in the default case, as long as at least one of the DNS lookups
6778 yields some data, the lookup succeeds.
6779
6780
6781
6782
6783 .section "More about LDAP" "SECTldap"
6784 .cindex "LDAP" "lookup, more about"
6785 .cindex "lookup" "LDAP"
6786 .cindex "Solaris" "LDAP"
6787 The original LDAP implementation came from the University of Michigan; this has
6788 become &"Open LDAP"&, and there are now two different releases. Another
6789 implementation comes from Netscape, and Solaris 7 and subsequent releases
6790 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
6791 the lookup function level, their error handling is different. For this reason
6792 it is necessary to set a compile-time variable when building Exim with LDAP, to
6793 indicate which LDAP library is in use. One of the following should appear in
6794 your &_Local/Makefile_&:
6795 .code
6796 LDAP_LIB_TYPE=UMICHIGAN
6797 LDAP_LIB_TYPE=OPENLDAP1
6798 LDAP_LIB_TYPE=OPENLDAP2
6799 LDAP_LIB_TYPE=NETSCAPE
6800 LDAP_LIB_TYPE=SOLARIS
6801 .endd
6802 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
6803 same interface as the University of Michigan version.
6804
6805 There are three LDAP lookup types in Exim. These behave slightly differently in
6806 the way they handle the results of a query:
6807
6808 .ilist
6809 &(ldap)& requires the result to contain just one entry; if there are more, it
6810 gives an error.
6811 .next
6812 &(ldapdn)& also requires the result to contain just one entry, but it is the
6813 Distinguished Name that is returned rather than any attribute values.
6814 .next
6815 &(ldapm)& permits the result to contain more than one entry; the attributes
6816 from all of them are returned.
6817 .endlist
6818
6819
6820 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
6821 Exim behaves as if the entry did not exist, and the lookup fails. The format of
6822 the data returned by a successful lookup is described in the next section.
6823 First we explain how LDAP queries are coded.
6824
6825
6826 .section "Format of LDAP queries" "SECTforldaque"
6827 .cindex "LDAP" "query format"
6828 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
6829 the configuration of a &(redirect)& router one might have this setting:
6830 .code
6831 data = ${lookup ldap \
6832   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
6833   c=UK?mailbox?base?}}
6834 .endd
6835 .cindex "LDAP" "with TLS"
6836 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
6837 secure (encrypted) LDAP connections. The second of these ensures that an
6838 encrypted TLS connection is used.
6839
6840
6841 .section "LDAP quoting" "SECID68"
6842 .cindex "LDAP" "quoting"
6843 Two levels of quoting are required in LDAP queries, the first for LDAP itself
6844 and the second because the LDAP query is represented as a URL. Furthermore,
6845 within an LDAP query, two different kinds of quoting are required. For this
6846 reason, there are two different LDAP-specific quoting operators.
6847
6848 The &%quote_ldap%& operator is designed for use on strings that are part of
6849 filter specifications. Conceptually, it first does the following conversions on
6850 the string:
6851 .code
6852 *   =>   \2A
6853 (   =>   \28
6854 )   =>   \29
6855 \   =>   \5C
6856 .endd
6857 in accordance with RFC 2254. The resulting string is then quoted according
6858 to the rules for URLs, that is, all non-alphanumeric characters except
6859 .code
6860 ! $ ' - . _ ( ) * +
6861 .endd
6862 are converted to their hex values, preceded by a percent sign. For example:
6863 .code
6864 ${quote_ldap: a(bc)*, a<yz>; }
6865 .endd
6866 yields
6867 .code
6868 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
6869 .endd
6870 Removing the URL quoting, this is (with a leading and a trailing space):
6871 .code
6872 a\28bc\29\2A, a<yz>;
6873 .endd
6874 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
6875 base DN specifications in queries. Conceptually, it first converts the string
6876 by inserting a backslash in front of any of the following characters:
6877 .code
6878 , + " \ < > ;
6879 .endd
6880 It also inserts a backslash before any leading spaces or # characters, and
6881 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
6882 is then quoted according to the rules for URLs. For example:
6883 .code
6884 ${quote_ldap_dn: a(bc)*, a<yz>; }
6885 .endd
6886 yields
6887 .code
6888 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
6889 .endd
6890 Removing the URL quoting, this is (with a trailing space):
6891 .code
6892 \ a(bc)*\, a\<yz\>\;\
6893 .endd
6894 There are some further comments about quoting in the section on LDAP
6895 authentication below.
6896
6897
6898 .section "LDAP connections" "SECID69"
6899 .cindex "LDAP" "connections"
6900 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
6901 is in use, via a Unix domain socket. The example given above does not specify
6902 an LDAP server. A server that is reached by TCP/IP can be specified in a query
6903 by starting it with
6904 .code
6905 ldap://<hostname>:<port>/...
6906 .endd
6907 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
6908 used. When no server is specified in a query, a list of default servers is
6909 taken from the &%ldap_default_servers%& configuration option. This supplies a
6910 colon-separated list of servers which are tried in turn until one successfully
6911 handles a query, or there is a serious error. Successful handling either
6912 returns the requested data, or indicates that it does not exist. Serious errors
6913 are syntactical, or multiple values when only a single value is expected.
6914 Errors which cause the next server to be tried are connection failures, bind
6915 failures, and timeouts.
6916
6917 For each server name in the list, a port number can be given. The standard way
6918 of specifying a host and port is to use a colon separator (RFC 1738). Because
6919 &%ldap_default_servers%& is a colon-separated list, such colons have to be
6920 doubled. For example
6921 .code
6922 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
6923 .endd
6924 If &%ldap_default_servers%& is unset, a URL with no server name is passed
6925 to the LDAP library with no server name, and the library's default (normally
6926 the local host) is used.
6927
6928 If you are using the OpenLDAP library, you can connect to an LDAP server using
6929 a Unix domain socket instead of a TCP/IP connection. This is specified by using
6930 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
6931 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
6932 not available.
6933
6934 For this type of connection, instead of a host name for the server, a pathname
6935 for the socket is required, and the port number is not relevant. The pathname
6936 can be specified either as an item in &%ldap_default_servers%&, or inline in
6937 the query. In the former case, you can have settings such as
6938 .code
6939 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
6940 .endd
6941 When the pathname is given in the query, you have to escape the slashes as
6942 &`%2F`& to fit in with the LDAP URL syntax. For example:
6943 .code
6944 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
6945 .endd
6946 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
6947 a pathname, it uses the Unix domain socket code, even if the query actually
6948 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
6949 socket connection. This behaviour means that you can use a setting of
6950 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
6951 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
6952 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
6953 backup host.
6954
6955 If an explicit &`ldapi`& type is given in a query when a host name is
6956 specified, an error is diagnosed. However, if there are more items in
6957 &%ldap_default_servers%&, they are tried. In other words:
6958
6959 .ilist
6960 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
6961 interface.
6962 .next
6963 Using &`ldapi`& with a host name causes an error.
6964 .endlist
6965
6966
6967 Using &`ldapi`& with no host or path in the query, and no setting of
6968 &%ldap_default_servers%&, does whatever the library does by default.
6969
6970
6971
6972 .section "LDAP authentication and control information" "SECID70"
6973 .cindex "LDAP" "authentication"
6974 The LDAP URL syntax provides no way of passing authentication and other control
6975 information to the server. To make this possible, the URL in an LDAP query may
6976 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
6977 spaces. If a value contains spaces it must be enclosed in double quotes, and
6978 when double quotes are used, backslash is interpreted in the usual way inside
6979 them. The following names are recognized:
6980 .display
6981 &`DEREFERENCE`&  set the dereferencing parameter
6982 &`NETTIME    `&  set a timeout for a network operation
6983 &`USER       `&  set the DN, for authenticating the LDAP bind
6984 &`PASS       `&  set the password, likewise
6985 &`REFERRALS  `&  set the referrals parameter
6986 &`SIZE       `&  set the limit for the number of entries returned
6987 &`TIME       `&  set the maximum waiting time for a query
6988 .endd
6989 The value of the DEREFERENCE parameter must be one of the words &"never"&,
6990 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
6991 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
6992 library from trying to follow referrals issued by the LDAP server.
6993
6994 The name CONNECT is an obsolete name for NETTIME, retained for
6995 backwards compatibility. This timeout (specified as a number of seconds) is
6996 enforced from the client end for operations that can be carried out over a
6997 network. Specifically, it applies to network connections and calls to the
6998 &'ldap_result()'& function. If the value is greater than zero, it is used if
6999 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7000 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7001 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7002 Netscape SDK; for OpenLDAP no action is taken.
7003
7004 The TIME parameter (also a number of seconds) is passed to the server to
7005 set a server-side limit on the time taken to complete a search.
7006
7007
7008 Here is an example of an LDAP query in an Exim lookup that uses some of these
7009 values. This is a single line, folded to fit on the page:
7010 .code
7011 ${lookup ldap
7012   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7013   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7014   {$value}fail}
7015 .endd
7016 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7017 any of the auxiliary data. Exim configuration settings that include lookups
7018 which contain password information should be preceded by &"hide"& to prevent
7019 non-admin users from using the &%-bP%& option to see their values.
7020
7021 The auxiliary data items may be given in any order. The default is no
7022 connection timeout (the system timeout is used), no user or password, no limit
7023 on the number of entries returned, and no time limit on queries.
7024
7025 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7026 removes any URL quoting that it may contain before passing it LDAP. Apparently
7027 some libraries do this for themselves, but some do not. Removing the URL
7028 quoting has two advantages:
7029
7030 .ilist
7031 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7032 DNs as with DNs inside actual queries.
7033 .next
7034 It permits spaces inside USER= DNs.
7035 .endlist
7036
7037 For example, a setting such as
7038 .code
7039 USER=cn=${quote_ldap_dn:$1}
7040 .endd
7041 should work even if &$1$& contains spaces.
7042
7043 Expanded data for the PASS= value should be quoted using the &%quote%&
7044 expansion operator, rather than the LDAP quote operators. The only reason this
7045 field needs quoting is to ensure that it conforms to the Exim syntax, which
7046 does not allow unquoted spaces. For example:
7047 .code
7048 PASS=${quote:$3}
7049 .endd
7050 The LDAP authentication mechanism can be used to check passwords as part of
7051 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7052 &<<CHAPexpand>>&.
7053
7054
7055
7056 .section "Format of data returned by LDAP" "SECID71"
7057 .cindex "LDAP" "returned data formats"
7058 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7059 as a sequence of values, for example
7060 .code
7061 cn=manager, o=University of Cambridge, c=UK
7062 .endd
7063 The &(ldap)& lookup type generates an error if more than one entry matches the
7064 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7065 the result between the data from different entries. It is possible for multiple
7066 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7067 you know that whatever values are returned all came from a single entry in the
7068 directory.
7069
7070 In the common case where you specify a single attribute in your LDAP query, the
7071 result is not quoted, and does not contain the attribute name. If the attribute
7072 has multiple values, they are separated by commas.
7073
7074 If you specify multiple attributes, the result contains space-separated, quoted
7075 strings, each preceded by the attribute name and an equals sign. Within the
7076 quotes, the quote character, backslash, and newline are escaped with
7077 backslashes, and commas are used to separate multiple values for the attribute.
7078 Apart from the escaping, the string within quotes takes the same form as the
7079 output when a single attribute is requested. Specifying no attributes is the
7080 same as specifying all of an entry's attributes.
7081
7082 Here are some examples of the output format. The first line of each pair is an
7083 LDAP query, and the second is the data that is returned. The attribute called
7084 &%attr1%& has two values, whereas &%attr2%& has only one value:
7085 .code
7086 ldap:///o=base?attr1?sub?(uid=fred)
7087 value1.1, value1.2
7088
7089 ldap:///o=base?attr2?sub?(uid=fred)
7090 value two
7091
7092 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7093 attr1="value1.1, value1.2" attr2="value two"
7094
7095 ldap:///o=base??sub?(uid=fred)
7096 objectClass="top" attr1="value1.1, value1.2" attr2="value two"
7097 .endd
7098 The &%extract%& operator in string expansions can be used to pick out
7099 individual fields from data that consists of &'key'&=&'value'& pairs. You can
7100 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7101 results of LDAP lookups.
7102
7103
7104
7105
7106 .section "More about NIS+" "SECTnisplus"
7107 .cindex "NIS+ lookup type"
7108 .cindex "lookup" "NIS+"
7109 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7110 and field name. If this is given, the result of a successful query is the
7111 contents of the named field; otherwise the result consists of a concatenation
7112 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7113 values containing spaces are quoted. For example, the query
7114 .code
7115 [name=mg1456],passwd.org_dir
7116 .endd
7117 might return the string
7118 .code
7119 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7120 home=/home/mg1456 shell=/bin/bash shadow=""
7121 .endd
7122 (split over two lines here to fit on the page), whereas
7123 .code
7124 [name=mg1456],passwd.org_dir:gcos
7125 .endd
7126 would just return
7127 .code
7128 Martin Guerre
7129 .endd
7130 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7131 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7132 operator is to double any quote characters within the text.
7133
7134
7135
7136 .section "SQL lookups" "SECTsql"
7137 .cindex "SQL lookup types"
7138 .cindex "MySQL" "lookup type"
7139 .cindex "PostgreSQL lookup type"
7140 .cindex "lookup" "MySQL"
7141 .cindex "lookup" "PostgreSQL"
7142 .cindex "Oracle" "lookup type"
7143 .cindex "lookup" "Oracle"
7144 .cindex "InterBase lookup type"
7145 .cindex "lookup" "InterBase"
7146 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, and SQLite
7147 databases. Queries for these databases contain SQL statements, so an example
7148 might be
7149 .code
7150 ${lookup mysql{select mailbox from users where id='userx'}\
7151   {$value}fail}
7152 .endd
7153 If the result of the query contains more than one field, the data for each
7154 field in the row is returned, preceded by its name, so the result of
7155 .code
7156 ${lookup pgsql{select home,name from users where id='userx'}\
7157   {$value}}
7158 .endd
7159 might be
7160 .code
7161 home=/home/userx name="Mister X"
7162 .endd
7163 Empty values and values containing spaces are double quoted, with embedded
7164 quotes escaped by a backslash. If the result of the query contains just one
7165 field, the value is passed back verbatim, without a field name, for example:
7166 .code
7167 Mister X
7168 .endd
7169 If the result of the query yields more than one row, it is all concatenated,
7170 with a newline between the data for each row.
7171
7172
7173 .section "More about MySQL, PostgreSQL, Oracle, and InterBase" "SECID72"
7174 .cindex "MySQL" "lookup type"
7175 .cindex "PostgreSQL lookup type"
7176 .cindex "lookup" "MySQL"
7177 .cindex "lookup" "PostgreSQL"
7178 .cindex "Oracle" "lookup type"
7179 .cindex "lookup" "Oracle"
7180 .cindex "InterBase lookup type"
7181 .cindex "lookup" "InterBase"
7182 If any MySQL, PostgreSQL, Oracle, or InterBase lookups are used, the
7183 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, or &%ibase_servers%&
7184 option (as appropriate) must be set to a colon-separated list of server
7185 information.
7186 (For MySQL and PostgreSQL only, the global option need not be set if all
7187 queries contain their own server information &-- see section
7188 &<<SECTspeserque>>&.) Each item in the list is a slash-separated list of four
7189 items: host name, database name, user name, and password. In the case of
7190 Oracle, the host name field is used for the &"service name"&, and the database
7191 name field is not used and should be empty. For example:
7192 .code
7193 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7194 .endd
7195 Because password data is sensitive, you should always precede the setting with
7196 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7197 option. Here is an example where two MySQL servers are listed:
7198 .code
7199 hide mysql_servers = localhost/users/root/secret:\
7200                      otherhost/users/root/othersecret
7201 .endd
7202 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7203 because this is a colon-separated list, the colon has to be doubled. For each
7204 query, these parameter groups are tried in order until a connection is made and
7205 a query is successfully processed. The result of a query may be that no data is
7206 found, but that is still a successful query. In other words, the list of
7207 servers provides a backup facility, not a list of different places to look.
7208
7209 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7210 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7211 respectively, and the characters single-quote, double-quote, and backslash
7212 itself are escaped with backslashes. The &%quote_pgsql%& expansion operator, in
7213 addition, escapes the percent and underscore characters. This cannot be done
7214 for MySQL because these escapes are not recognized in contexts where these
7215 characters are not special.
7216
7217 .section "Specifying the server in the query" "SECTspeserque"
7218 For MySQL and PostgreSQL lookups (but not currently for Oracle and InterBase),
7219 it is possible to specify a list of servers with an individual query. This is
7220 done by starting the query with
7221 .display
7222 &`servers=`&&'server1:server2:server3:...'&&`;`&
7223 .endd
7224 Each item in the list may take one of two forms:
7225 .olist
7226 If it contains no slashes it is assumed to be just a host name. The appropriate
7227 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7228 of the same name, and the remaining parameters (database, user, password) are
7229 taken from there.
7230 .next
7231 If it contains any slashes, it is taken as a complete parameter set.
7232 .endlist
7233 The list of servers is used in exactly the same way as the global list.
7234 Once a connection to a server has happened and a query has been
7235 successfully executed, processing of the lookup ceases.
7236
7237 This feature is intended for use in master/slave situations where updates
7238 are occurring and you want to update the master rather than a slave. If the
7239 master is in the list as a backup for reading, you might have a global setting
7240 like this:
7241 .code
7242 mysql_servers = slave1/db/name/pw:\
7243                 slave2/db/name/pw:\
7244                 master/db/name/pw
7245 .endd
7246 In an updating lookup, you could then write:
7247 .code
7248 ${lookup mysql{servers=master; UPDATE ...} }
7249 .endd
7250 That query would then be sent only to the master server. If, on the other hand,
7251 the master is not to be used for reading, and so is not present in the global
7252 option, you can still update it by a query of this form:
7253 .code
7254 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7255 .endd
7256
7257
7258 .section "Special MySQL features" "SECID73"
7259 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7260 causes a connection to the server on the local host by means of a Unix domain
7261 socket. An alternate socket can be specified in parentheses. The full syntax of
7262 each item in &%mysql_servers%& is:
7263 .display
7264 <&'hostname'&>::<&'port'&>(<&'socket name'&>)/<&'database'&>/&&&
7265   <&'user'&>/<&'password'&>
7266 .endd
7267 Any of the three sub-parts of the first field can be omitted. For normal use on
7268 the local host it can be left blank or set to just &"localhost"&.
7269
7270 No database need be supplied &-- but if it is absent here, it must be given in
7271 the queries.
7272
7273 If a MySQL query is issued that does not request any data (an insert, update,
7274 or delete command), the result of the lookup is the number of rows affected.
7275
7276 &*Warning*&: This can be misleading. If an update does not actually change
7277 anything (for example, setting a field to the value it already has), the result
7278 is zero because no rows are affected.
7279
7280
7281 .section "Special PostgreSQL features" "SECID74"
7282 PostgreSQL lookups can also use Unix domain socket connections to the database.
7283 This is usually faster and costs less CPU time than a TCP/IP connection.
7284 However it can be used only if the mail server runs on the same machine as the
7285 database server. A configuration line for PostgreSQL via Unix domain sockets
7286 looks like this:
7287 .code
7288 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7289 .endd
7290 In other words, instead of supplying a host name, a path to the socket is
7291 given. The path name is enclosed in parentheses so that its slashes aren't
7292 visually confused with the delimiters for the other server parameters.
7293
7294 If a PostgreSQL query is issued that does not request any data (an insert,
7295 update, or delete command), the result of the lookup is the number of rows
7296 affected.
7297
7298 .section "More about SQLite" "SECTsqlite"
7299 .cindex "lookup" "SQLite"
7300 .cindex "sqlite lookup type"
7301 SQLite is different to the other SQL lookups because a file name is required in
7302 addition to the SQL query. An SQLite database is a single file, and there is no
7303 daemon as in the other SQL databases. The interface to Exim requires the name
7304 of the file, as an absolute path, to be given at the start of the query. It is
7305 separated from the query by white space. This means that the path name cannot
7306 contain white space. Here is a lookup expansion example:
7307 .code
7308 ${lookup sqlite {/some/thing/sqlitedb \
7309   select name from aliases where id='userx';}}
7310 .endd
7311 In a list, the syntax is similar. For example:
7312 .code
7313 domainlist relay_domains = sqlite;/some/thing/sqlitedb \
7314    select * from relays where ip='$sender_host_address';
7315 .endd
7316 The only character affected by the &%quote_sqlite%& operator is a single
7317 quote, which it doubles.
7318
7319 The SQLite library handles multiple simultaneous accesses to the database
7320 internally. Multiple readers are permitted, but only one process can
7321 update at once. Attempts to access the database while it is being updated
7322 are rejected after a timeout period, during which the SQLite library
7323 waits for the lock to be released. In Exim, the default timeout is set
7324 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7325 option.
7326 .ecindex IIDfidalo1
7327 .ecindex IIDfidalo2
7328
7329
7330 . ////////////////////////////////////////////////////////////////////////////
7331 . ////////////////////////////////////////////////////////////////////////////
7332
7333 .chapter "Domain, host, address, and local part lists" &&&
7334          "CHAPdomhosaddlists" &&&
7335          "Domain, host, and address lists"
7336 .scindex IIDdohoadli "lists of domains; hosts; etc."
7337 A number of Exim configuration options contain lists of domains, hosts,
7338 email addresses, or local parts. For example, the &%hold_domains%& option
7339 contains a list of domains whose delivery is currently suspended. These lists
7340 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7341 arguments to expansion conditions such as &%match_domain%&.
7342
7343 Each item in one of these lists is a pattern to be matched against a domain,
7344 host, email address, or local part, respectively. In the sections below, the
7345 different types of pattern for each case are described, but first we cover some
7346 general facilities that apply to all four kinds of list.
7347
7348
7349
7350 .section "Expansion of lists" "SECID75"
7351 .cindex "expansion" "of lists"
7352 Each list is expanded as a single string before it is used. The result of
7353 expansion must be a list, possibly containing empty items, which is split up
7354 into separate items for matching. By default, colon is the separator character,
7355 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7356 &<<SECTempitelis>>& for details of the list syntax; the second of these
7357 discusses the way to specify empty list items.
7358
7359
7360 If the string expansion is forced to fail, Exim behaves as if the item it is
7361 testing (domain, host, address, or local part) is not in the list. Other
7362 expansion failures cause temporary errors.
7363
7364 If an item in a list is a regular expression, backslashes, dollars and possibly
7365 other special characters in the expression must be protected against
7366 misinterpretation by the string expander. The easiest way to do this is to use
7367 the &`\N`& expansion feature to indicate that the contents of the regular
7368 expression should not be expanded. For example, in an ACL you might have:
7369 .code
7370 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7371                ${lookup{$domain}lsearch{/badsenders/bydomain}}
7372 .endd
7373 The first item is a regular expression that is protected from expansion by
7374 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7375 senders based on the receiving domain.
7376
7377
7378
7379
7380 .section "Negated items in lists" "SECID76"
7381 .cindex "list" "negation"
7382 .cindex "negation" "in lists"
7383 Items in a list may be positive or negative. Negative items are indicated by a
7384 leading exclamation mark, which may be followed by optional white space. A list
7385 defines a set of items (domains, etc). When Exim processes one of these lists,
7386 it is trying to find out whether a domain, host, address, or local part
7387 (respectively) is in the set that is defined by the list. It works like this:
7388
7389 The list is scanned from left to right. If a positive item is matched, the
7390 subject that is being checked is in the set; if a negative item is matched, the
7391 subject is not in the set. If the end of the list is reached without the
7392 subject having matched any of the patterns, it is in the set if the last item
7393 was a negative one, but not if it was a positive one. For example, the list in
7394 .code
7395 domainlist relay_domains = !a.b.c : *.b.c
7396 .endd
7397 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7398 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7399 list is positive. However, if the setting were
7400 .code
7401 domainlist relay_domains = !a.b.c
7402 .endd
7403 then all domains other than &'a.b.c'& would match because the last item in the
7404 list is negative. In other words, a list that ends with a negative item behaves
7405 as if it had an extra item &`:*`& on the end.
7406
7407 Another way of thinking about positive and negative items in lists is to read
7408 the connector as &"or"& after a positive item and as &"and"& after a negative
7409 item.
7410
7411
7412
7413 .section "File names in lists" "SECTfilnamlis"
7414 .cindex "list" "file name in"
7415 If an item in a domain, host, address, or local part list is an absolute file
7416 name (beginning with a slash character), each line of the file is read and
7417 processed as if it were an independent item in the list, except that further
7418 file names are not allowed,
7419 and no expansion of the data from the file takes place.
7420 Empty lines in the file are ignored, and the file may also contain comment
7421 lines:
7422
7423 .ilist
7424 For domain and host lists, if a # character appears anywhere in a line of the
7425 file, it and all following characters are ignored.
7426 .next
7427 Because local parts may legitimately contain # characters, a comment in an
7428 address list or local part list file is recognized only if # is preceded by
7429 white space or the start of the line. For example:
7430 .code
7431 not#comment@x.y.z   # but this is a comment
7432 .endd
7433 .endlist
7434
7435 Putting a file name in a list has the same effect as inserting each line of the
7436 file as an item in the list (blank lines and comments excepted). However, there
7437 is one important difference: the file is read each time the list is processed,
7438 so if its contents vary over time, Exim's behaviour changes.
7439
7440 If a file name is preceded by an exclamation mark, the sense of any match
7441 within the file is inverted. For example, if
7442 .code
7443 hold_domains = !/etc/nohold-domains
7444 .endd
7445 and the file contains the lines
7446 .code
7447 !a.b.c
7448 *.b.c
7449 .endd
7450 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
7451 any domain matching &`*.b.c`& is not.
7452
7453
7454
7455 .section "An lsearch file is not an out-of-line list" "SECID77"
7456 As will be described in the sections that follow, lookups can be used in lists
7457 to provide indexed methods of checking list membership. There has been some
7458 confusion about the way &(lsearch)& lookups work in lists. Because
7459 an &(lsearch)& file contains plain text and is scanned sequentially, it is
7460 sometimes thought that it is allowed to contain wild cards and other kinds of
7461 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
7462 always fixed strings, just as for any other single-key lookup type.
7463
7464 If you want to use a file to contain wild-card patterns that form part of a
7465 list, just give the file name on its own, without a search type, as described
7466 in the previous section. You could also use the &(wildlsearch)& or
7467 &(nwildlsearch)&, but there is no advantage in doing this.
7468
7469
7470
7471
7472 .section "Named lists" "SECTnamedlists"
7473 .cindex "named lists"
7474 .cindex "list" "named"
7475 A list of domains, hosts, email addresses, or local parts can be given a name
7476 which is then used to refer to the list elsewhere in the configuration. This is
7477 particularly convenient if the same list is required in several different
7478 places. It also allows lists to be given meaningful names, which can improve
7479 the readability of the configuration. For example, it is conventional to define
7480 a domain list called &'local_domains'& for all the domains that are handled
7481 locally on a host, using a configuration line such as
7482 .code
7483 domainlist local_domains = localhost:my.dom.example
7484 .endd
7485 Named lists are referenced by giving their name preceded by a plus sign, so,
7486 for example, a router that is intended to handle local domains would be
7487 configured with the line
7488 .code
7489 domains = +local_domains
7490 .endd
7491 The first router in a configuration is often one that handles all domains
7492 except the local ones, using a configuration with a negated item like this:
7493 .code
7494 dnslookup:
7495   driver = dnslookup
7496   domains = ! +local_domains
7497   transport = remote_smtp
7498   no_more
7499 .endd
7500 The four kinds of named list are created by configuration lines starting with
7501 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
7502 respectively. Then there follows the name that you are defining, followed by an
7503 equals sign and the list itself. For example:
7504 .code
7505 hostlist    relay_hosts = 192.168.23.0/24 : my.friend.example
7506 addresslist bad_senders = cdb;/etc/badsenders
7507 .endd
7508 A named list may refer to other named lists:
7509 .code
7510 domainlist  dom1 = first.example : second.example
7511 domainlist  dom2 = +dom1 : third.example
7512 domainlist  dom3 = fourth.example : +dom2 : fifth.example
7513 .endd
7514 &*Warning*&: If the last item in a referenced list is a negative one, the
7515 effect may not be what you intended, because the negation does not propagate
7516 out to the higher level. For example, consider:
7517 .code
7518 domainlist  dom1 = !a.b
7519 domainlist  dom2 = +dom1 : *.b
7520 .endd
7521 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
7522 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
7523 means it matches the second list as well. The effect is not the same as
7524 .code
7525 domainlist  dom2 = !a.b : *.b
7526 .endd
7527 where &'x.y'& does not match. It's best to avoid negation altogether in
7528 referenced lists if you can.
7529
7530 Named lists may have a performance advantage. When Exim is routing an
7531 address or checking an incoming message, it caches the result of tests on named
7532 lists. So, if you have a setting such as
7533 .code
7534 domains = +local_domains
7535 .endd
7536 on several of your routers
7537 or in several ACL statements,
7538 the actual test is done only for the first one. However, the caching works only
7539 if there are no expansions within the list itself or any sublists that it
7540 references. In other words, caching happens only for lists that are known to be
7541 the same each time they are referenced.
7542
7543 By default, there may be up to 16 named lists of each type. This limit can be
7544 extended by changing a compile-time variable. The use of domain and host lists
7545 is recommended for concepts such as local domains, relay domains, and relay
7546 hosts. The default configuration is set up like this.
7547
7548
7549
7550 .section "Named lists compared with macros" "SECID78"
7551 .cindex "list" "named compared with macro"
7552 .cindex "macro" "compared with named list"
7553 At first sight, named lists might seem to be no different from macros in the
7554 configuration file. However, macros are just textual substitutions. If you
7555 write
7556 .code
7557 ALIST = host1 : host2
7558 auth_advertise_hosts = !ALIST
7559 .endd
7560 it probably won't do what you want, because that is exactly the same as
7561 .code
7562 auth_advertise_hosts = !host1 : host2
7563 .endd
7564 Notice that the second host name is not negated. However, if you use a host
7565 list, and write
7566 .code
7567 hostlist alist = host1 : host2
7568 auth_advertise_hosts = ! +alist
7569 .endd
7570 the negation applies to the whole list, and so that is equivalent to
7571 .code
7572 auth_advertise_hosts = !host1 : !host2
7573 .endd
7574
7575
7576 .section "Named list caching" "SECID79"
7577 .cindex "list" "caching of named"
7578 .cindex "caching" "named lists"
7579 While processing a message, Exim caches the result of checking a named list if
7580 it is sure that the list is the same each time. In practice, this means that
7581 the cache operates only if the list contains no $ characters, which guarantees
7582 that it will not change when it is expanded. Sometimes, however, you may have
7583 an expanded list that you know will be the same each time within a given
7584 message. For example:
7585 .code
7586 domainlist special_domains = \
7587            ${lookup{$sender_host_address}cdb{/some/file}}
7588 .endd
7589 This provides a list of domains that depends only on the sending host's IP
7590 address. If this domain list is referenced a number of times (for example,
7591 in several ACL lines, or in several routers) the result of the check is not
7592 cached by default, because Exim does not know that it is going to be the
7593 same list each time.
7594
7595 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
7596 cache the result anyway. For example:
7597 .code
7598 domainlist_cache special_domains = ${lookup{...
7599 .endd
7600 If you do this, you should be absolutely sure that caching is going to do
7601 the right thing in all cases. When in doubt, leave it out.
7602
7603
7604
7605 .section "Domain lists" "SECTdomainlist"
7606 .cindex "domain list" "patterns for"
7607 .cindex "list" "domain list"
7608 Domain lists contain patterns that are to be matched against a mail domain.
7609 The following types of item may appear in domain lists:
7610
7611 .ilist
7612 .cindex "primary host name"
7613 .cindex "host name" "matched in domain list"
7614 .oindex "&%primary_hostname%&"
7615 .cindex "domain list" "matching primary host name"
7616 .cindex "@ in a domain list"
7617 If a pattern consists of a single @ character, it matches the local host name,
7618 as set by the &%primary_hostname%& option (or defaulted). This makes it
7619 possible to use the same configuration file on several different hosts that
7620 differ only in their names.
7621 .next
7622 .cindex "@[] in a domain list"
7623 .cindex "domain list" "matching local IP interfaces"
7624 .cindex "domain literal"
7625 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
7626 in square brackets (as in an email address that contains a domain literal), but
7627 only if that IP address is recognized as local for email routing purposes. The
7628 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
7629 control which of a host's several IP addresses are treated as local.
7630 In today's Internet, the use of domain literals is controversial.
7631 .next
7632 .cindex "@mx_any"
7633 .cindex "@mx_primary"
7634 .cindex "@mx_secondary"
7635 .cindex "domain list" "matching MX pointers to local host"
7636 If a pattern consists of the string &`@mx_any`& it matches any domain that
7637 has an MX record pointing to the local host or to any host that is listed in
7638 .oindex "&%hosts_treat_as_local%&"
7639 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
7640 are similar, except that the first matches only when a primary MX target is the
7641 local host, and the second only when no primary MX target is the local host,
7642 but a secondary MX target is. &"Primary"& means an MX record with the lowest
7643 preference value &-- there may of course be more than one of them.
7644
7645 The MX lookup that takes place when matching a pattern of this type is
7646 performed with the resolver options for widening names turned off. Thus, for
7647 example, a single-component domain will &'not'& be expanded by adding the
7648 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
7649 options of the &(dnslookup)& router for a discussion of domain widening.
7650
7651 Sometimes you may want to ignore certain IP addresses when using one of these
7652 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
7653 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
7654 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
7655 on a router). For example:
7656 .code
7657 domains = @mx_any/ignore=127.0.0.1
7658 .endd
7659 This example matches any domain that has an MX record pointing to one of
7660 the local host's IP addresses other than 127.0.0.1.
7661
7662 The list of IP addresses is in fact processed by the same code that processes
7663 host lists, so it may contain CIDR-coded network specifications and it may also
7664 contain negative items.
7665
7666 Because the list of IP addresses is a sublist within a domain list, you have to
7667 be careful about delimiters if there is more than one address. Like any other
7668 list, the default delimiter can be changed. Thus, you might have:
7669 .code
7670 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
7671           an.other.domain : ...
7672 .endd
7673 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
7674 involved, it is easiest to change the delimiter for the main list as well:
7675 .code
7676 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
7677           an.other.domain ? ...
7678 .endd
7679 .next
7680 .cindex "asterisk" "in domain list"
7681 .cindex "domain list" "asterisk in"
7682 .cindex "domain list" "matching &""ends with""&"
7683 If a pattern starts with an asterisk, the remaining characters of the pattern
7684 are compared with the terminating characters of the domain. The use of &"*"& in
7685 domain lists differs from its use in partial matching lookups. In a domain
7686 list, the character following the asterisk need not be a dot, whereas partial
7687 matching works only in terms of dot-separated components. For example, a domain
7688 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
7689 &'cipher.key.ex'&.
7690
7691 .next
7692 .cindex "regular expressions" "in domain list"
7693 .cindex "domain list" "matching regular expression"
7694 If a pattern starts with a circumflex character, it is treated as a regular
7695 expression, and matched against the domain using a regular expression matching
7696 function. The circumflex is treated as part of the regular expression.
7697 Email domains are case-independent, so this regular expression match is by
7698 default case-independent, but you can make it case-dependent by starting it
7699 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
7700 are given in chapter &<<CHAPregexp>>&.
7701
7702 &*Warning*&: Because domain lists are expanded before being processed, you
7703 must escape any backslash and dollar characters in the regular expression, or
7704 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
7705 it is not to be expanded (unless you really do want to build a regular
7706 expression by expansion, of course).
7707 .next
7708 .cindex "lookup" "in domain list"
7709 .cindex "domain list" "matching by lookup"
7710 If a pattern starts with the name of a single-key lookup type followed by a
7711 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
7712 must be a file name in a suitable format for the lookup type. For example, for
7713 &"cdb;"& it must be an absolute path:
7714 .code
7715 domains = cdb;/etc/mail/local_domains.cdb
7716 .endd
7717 The appropriate type of lookup is done on the file using the domain name as the
7718 key. In most cases, the data that is looked up is not used; Exim is interested
7719 only in whether or not the key is present in the file. However, when a lookup
7720 is used for the &%domains%& option on a router
7721 or a &%domains%& condition in an ACL statement, the data is preserved in the
7722 &$domain_data$& variable and can be referred to in other router options or
7723 other statements in the same ACL.
7724
7725 .next
7726 Any of the single-key lookup type names may be preceded by
7727 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
7728 .code
7729 domains = partial-dbm;/partial/domains
7730 .endd
7731 This causes partial matching logic to be invoked; a description of how this
7732 works is given in section &<<SECTpartiallookup>>&.
7733
7734 .next
7735 .cindex "asterisk" "in lookup type"
7736 Any of the single-key lookup types may be followed by an asterisk. This causes
7737 a default lookup for a key consisting of a single asterisk to be done if the
7738 original lookup fails. This is not a useful feature when using a domain list to
7739 select particular domains (because any domain would match), but it might have
7740 value if the result of the lookup is being used via the &$domain_data$&
7741 expansion variable.
7742 .next
7743 If the pattern starts with the name of a query-style lookup type followed by a
7744 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
7745 pattern must be an appropriate query for the lookup type, as described in
7746 chapter &<<CHAPfdlookup>>&. For example:
7747 .code
7748 hold_domains = mysql;select domain from holdlist \
7749   where domain = '$domain';
7750 .endd
7751 In most cases, the data that is looked up is not used (so for an SQL query, for
7752 example, it doesn't matter what field you select). Exim is interested only in
7753 whether or not the query succeeds. However, when a lookup is used for the
7754 &%domains%& option on a router, the data is preserved in the &$domain_data$&
7755 variable and can be referred to in other options.
7756 .next
7757 .cindex "domain list" "matching literal domain name"
7758 If none of the above cases apply, a caseless textual comparison is made
7759 between the pattern and the domain.
7760 .endlist
7761
7762 Here is an example that uses several different kinds of pattern:
7763 .code
7764 domainlist funny_domains = \
7765   @ : \
7766   lib.unseen.edu : \
7767   *.foundation.fict.example : \
7768   \N^[1-2]\d{3}\.fict\.example$\N : \
7769   partial-dbm;/opt/data/penguin/book : \
7770   nis;domains.byname : \
7771   nisplus;[name=$domain,status=local],domains.org_dir
7772 .endd
7773 There are obvious processing trade-offs among the various matching modes. Using
7774 an asterisk is faster than a regular expression, and listing a few names
7775 explicitly probably is too. The use of a file or database lookup is expensive,
7776 but may be the only option if hundreds of names are required. Because the
7777 patterns are tested in order, it makes sense to put the most commonly matched
7778 patterns earlier.
7779
7780
7781
7782 .section "Host lists" "SECThostlist"
7783 .cindex "host list" "patterns in"
7784 .cindex "list" "host list"
7785 Host lists are used to control what remote hosts are allowed to do. For
7786 example, some hosts may be allowed to use the local host as a relay, and some
7787 may be permitted to use the SMTP ETRN command. Hosts can be identified in
7788 two different ways, by name or by IP address. In a host list, some types of
7789 pattern are matched to a host name, and some are matched to an IP address.
7790 You need to be particularly careful with this when single-key lookups are
7791 involved, to ensure that the right value is being used as the key.
7792
7793
7794 .section "Special host list patterns" "SECID80"
7795 .cindex "empty item in hosts list"
7796 .cindex "host list" "empty string in"
7797 If a host list item is the empty string, it matches only when no remote host is
7798 involved. This is the case when a message is being received from a local
7799 process using SMTP on the standard input, that is, when a TCP/IP connection is
7800 not used.
7801
7802 .cindex "asterisk" "in host list"
7803 The special pattern &"*"& in a host list matches any host or no host. Neither
7804 the IP address nor the name is actually inspected.
7805
7806
7807
7808 .section "Host list patterns that match by IP address" "SECThoslispatip"
7809 .cindex "host list" "matching IP addresses"
7810 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
7811 the incoming address actually appears in the IPv6 host as
7812 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
7813 list, it is converted into a traditional IPv4 address first. (Not all operating
7814 systems accept IPv4 calls on IPv6 sockets, as there have been some security
7815 concerns.)
7816
7817 The following types of pattern in a host list check the remote host by
7818 inspecting its IP address:
7819
7820 .ilist
7821 If the pattern is a plain domain name (not a regular expression, not starting
7822 with *, not a lookup of any kind), Exim calls the operating system function
7823 to find the associated IP address(es). Exim uses the newer
7824 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
7825 This typically causes a forward DNS lookup of the name. The result is compared
7826 with the IP address of the subject host.
7827
7828 If there is a temporary problem (such as a DNS timeout) with the host name
7829 lookup, a temporary error occurs. For example, if the list is being used in an
7830 ACL condition, the ACL gives a &"defer"& response, usually leading to a
7831 temporary SMTP error code. If no IP address can be found for the host name,
7832 what happens is described in section &<<SECTbehipnot>>& below.
7833
7834 .next
7835 .cindex "@ in a host list"
7836 If the pattern is &"@"&, the primary host name is substituted and used as a
7837 domain name, as just described.
7838
7839 .next
7840 If the pattern is an IP address, it is matched against the IP address of the
7841 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
7842 IPv6 addresses can be given in colon-separated format, but the colons have to
7843 be doubled so as not to be taken as item separators when the default list
7844 separator is used. IPv6 addresses are recognized even when Exim is compiled
7845 without IPv6 support. This means that if they appear in a host list on an
7846 IPv4-only host, Exim will not treat them as host names. They are just addresses
7847 that can never match a client host.
7848
7849 .next
7850 .cindex "@[] in a host list"
7851 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
7852 the local host. For example, if the local host is an IPv4 host with one
7853 interface address 10.45.23.56, these two ACL statements have the same effect:
7854 .code
7855 accept hosts = 127.0.0.1 : 10.45.23.56
7856 accept hosts = @[]
7857 .endd
7858 .next
7859 .cindex "CIDR notation"
7860 If the pattern is an IP address followed by a slash and a mask length (for
7861 example 10.11.42.0/24), it is matched against the IP address of the subject
7862 host under the given mask. This allows, an entire network of hosts to be
7863 included (or excluded) by a single item. The mask uses CIDR notation; it
7864 specifies the number of address bits that must match, starting from the most
7865 significant end of the address.
7866
7867 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
7868 of a range of addresses. It is the number of bits in the network portion of the
7869 address. The above example specifies a 24-bit netmask, so it matches all 256
7870 addresses in the 10.11.42.0 network. An item such as
7871 .code
7872 192.168.23.236/31
7873 .endd
7874 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
7875 32 for an IPv4 address is the same as no mask at all; just a single address
7876 matches.
7877
7878 Here is another example which shows an IPv4 and an IPv6 network:
7879 .code
7880 recipient_unqualified_hosts = 192.168.0.0/16: \
7881                               3ffe::ffff::836f::::/48
7882 .endd
7883 The doubling of list separator characters applies only when these items
7884 appear inline in a host list. It is not required when indirecting via a file.
7885 For example:
7886 .code
7887 recipient_unqualified_hosts = /opt/exim/unqualnets
7888 .endd
7889 could make use of a file containing
7890 .code
7891 172.16.0.0/12
7892 3ffe:ffff:836f::/48
7893 .endd
7894 to have exactly the same effect as the previous example. When listing IPv6
7895 addresses inline, it is usually more convenient to use the facility for
7896 changing separator characters. This list contains the same two networks:
7897 .code
7898 recipient_unqualified_hosts = <; 172.16.0.0/12; \
7899                                  3ffe:ffff:836f::/48
7900 .endd
7901 The separator is changed to semicolon by the leading &"<;"& at the start of the
7902 list.
7903 .endlist
7904
7905
7906
7907 .section "Host list patterns for single-key lookups by host address" &&&
7908          "SECThoslispatsikey"
7909 .cindex "host list" "lookup of IP address"
7910 When a host is to be identified by a single-key lookup of its complete IP
7911 address, the pattern takes this form:
7912 .display
7913 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
7914 .endd
7915 For example:
7916 .code
7917 hosts_lookup = net-cdb;/hosts-by-ip.db
7918 .endd
7919 The text form of the IP address of the subject host is used as the lookup key.
7920 IPv6 addresses are converted to an unabbreviated form, using lower case
7921 letters, with dots as separators because colon is the key terminator in
7922 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
7923 quoting the keys, but this is a facility that was added later.] The data
7924 returned by the lookup is not used.
7925
7926 .cindex "IP address" "masking"
7927 .cindex "host list" "masked IP address"
7928 Single-key lookups can also be performed using masked IP addresses, using
7929 patterns of this form:
7930 .display
7931 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
7932 .endd
7933 For example:
7934 .code
7935 net24-dbm;/networks.db
7936 .endd
7937 The IP address of the subject host is masked using <&'number'&> as the mask
7938 length. A textual string is constructed from the masked value, followed by the
7939 mask, and this is used as the lookup key. For example, if the host's IP address
7940 is 192.168.34.6, the key that is looked up for the above example is
7941 &"192.168.34.0/24"&.
7942
7943 When an IPv6 address is converted to a string, dots are normally used instead
7944 of colons, so that keys in &(lsearch)& files need not contain colons (which
7945 terminate &(lsearch)& keys). This was implemented some time before the ability
7946 to quote keys was made available in &(lsearch)& files. However, the more
7947 recently implemented &(iplsearch)& files do require colons in IPv6 keys
7948 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
7949 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
7950 converted using colons and not dots. In all cases, full, unabbreviated IPv6
7951 addresses are always used.
7952
7953 Ideally, it would be nice to tidy up this anomalous situation by changing to
7954 colons in all cases, given that quoting is now available for &(lsearch)&.
7955 However, this would be an incompatible change that might break some existing
7956 configurations.
7957
7958 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
7959 IPv6 address) is not the same as specifying just &%net-%& without a number. In
7960 the former case the key strings include the mask value, whereas in the latter
7961 case the IP address is used on its own.
7962
7963
7964
7965 .section "Host list patterns that match by host name" "SECThoslispatnam"
7966 .cindex "host" "lookup failures"
7967 .cindex "unknown host name"
7968 .cindex "host list" "matching host name"
7969 There are several types of pattern that require Exim to know the name of the
7970 remote host. These are either wildcard patterns or lookups by name. (If a
7971 complete hostname is given without any wildcarding, it is used to find an IP
7972 address to match against, as described in the section &<<SECThoslispatip>>&
7973 above.)
7974
7975 If the remote host name is not already known when Exim encounters one of these
7976 patterns, it has to be found from the IP address.
7977 Although many sites on the Internet are conscientious about maintaining reverse
7978 DNS data for their hosts, there are also many that do not do this.
7979 Consequently, a name cannot always be found, and this may lead to unwanted
7980 effects. Take care when configuring host lists with wildcarded name patterns.
7981 Consider what will happen if a name cannot be found.
7982
7983 Because of the problems of determining host names from IP addresses, matching
7984 against host names is not as common as matching against IP addresses.
7985
7986 By default, in order to find a host name, Exim first does a reverse DNS lookup;
7987 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
7988 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
7989 are done can be changed by setting the &%host_lookup_order%& option. For
7990 security, once Exim has found one or more names, it looks up the IP addresses
7991 for these names and compares them with the IP address that it started with.
7992 Only those names whose IP addresses match are accepted. Any other names are
7993 discarded. If no names are left, Exim behaves as if the host name cannot be
7994 found. In the most common case there is only one name and one IP address.
7995
7996 There are some options that control what happens if a host name cannot be
7997 found. These are described in section &<<SECTbehipnot>>& below.
7998
7999 .cindex "host" "alias for"
8000 .cindex "alias for host"
8001 As a result of aliasing, hosts may have more than one name. When processing any
8002 of the following types of pattern, all the host's names are checked:
8003
8004 .ilist
8005 .cindex "asterisk" "in host list"
8006 If a pattern starts with &"*"& the remainder of the item must match the end of
8007 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8008 &'.b.c'&. This special simple form is provided because this is a very common
8009 requirement. Other kinds of wildcarding require the use of a regular
8010 expression.
8011 .next
8012 .cindex "regular expressions" "in host list"
8013 .cindex "host list" "regular expression in"
8014 If the item starts with &"^"& it is taken to be a regular expression which is
8015 matched against the host name. Host names are case-independent, so this regular
8016 expression match is by default case-independent, but you can make it
8017 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8018 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8019 example,
8020 .code
8021 ^(a|b)\.c\.d$
8022 .endd
8023 is a regular expression that matches either of the two hosts &'a.c.d'& or
8024 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8025 that backslash and dollar characters are not misinterpreted as part of the
8026 string expansion. The simplest way to do this is to use &`\N`& to mark that
8027 part of the string as non-expandable. For example:
8028 .code
8029 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8030 .endd
8031 &*Warning*&: If you want to match a complete host name, you must include the
8032 &`$`& terminating metacharacter in the regular expression, as in the above
8033 example. Without it, a match at the start of the host name is all that is
8034 required.
8035 .endlist
8036
8037
8038
8039
8040 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8041 .cindex "host" "lookup failures, permanent"
8042 While processing a host list, Exim may need to look up an IP address from a
8043 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8044 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8045 behaviour when it fails to find the information it is seeking is the same.
8046
8047 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8048 apply to temporary DNS errors, whose handling is described in the next section.
8049
8050 .cindex "&`+include_unknown`&"
8051 .cindex "&`+ignore_unknown`&"
8052 By default, Exim behaves as if the host does not match the list. This may not
8053 always be what you want to happen. To change Exim's behaviour, the special
8054 items &`+include_unknown`& or &`+ignore_unknown`& may appear in the list (at
8055 top level &-- they are not recognized in an indirected file).
8056
8057 .ilist
8058 If any item that follows &`+include_unknown`& requires information that
8059 cannot found, Exim behaves as if the host does match the list. For example,
8060 .code
8061 host_reject_connection = +include_unknown:*.enemy.ex
8062 .endd
8063 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8064 any hosts whose name it cannot find.
8065
8066 .next
8067 If any item that follows &`+ignore_unknown`& requires information that cannot
8068 be found, Exim ignores that item and proceeds to the rest of the list. For
8069 example:
8070 .code
8071 accept hosts = +ignore_unknown : friend.example : \
8072                192.168.4.5
8073 .endd
8074 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8075 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8076 name can be found for 192.168.4.5, it is rejected.
8077 .endlist
8078
8079 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8080 list. The effect of each one lasts until the next, or until the end of the
8081 list.
8082
8083
8084 .section "Temporary DNS errors when looking up host information" &&&
8085          "SECTtemdnserr"
8086 .cindex "host" "lookup failures, temporary"
8087 .cindex "&`+include_defer`&"
8088 .cindex "&`+ignore_defer`&"
8089 A temporary DNS lookup failure normally causes a defer action (except when
8090 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8091 host lists can include &`+ignore_defer`& and &`+include_defer`&, analagous to
8092 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8093 section. These options should be used with care, probably only in non-critical
8094 host lists such as whitelists.
8095
8096
8097
8098 .section "Host list patterns for single-key lookups by host name" &&&
8099          "SECThoslispatnamsk"
8100 .cindex "unknown host name"
8101 .cindex "host list" "matching host name"
8102 If a pattern is of the form
8103 .display
8104 <&'single-key-search-type'&>;<&'search-data'&>
8105 .endd
8106 for example
8107 .code
8108 dbm;/host/accept/list
8109 .endd
8110 a single-key lookup is performed, using the host name as its key. If the
8111 lookup succeeds, the host matches the item. The actual data that is looked up
8112 is not used.
8113
8114 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8115 keys in the file, not IP addresses. If you want to do lookups based on IP
8116 addresses, you must precede the search type with &"net-"& (see section
8117 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8118 two items in the same list, one doing an address lookup and one doing a name
8119 lookup, both using the same file.
8120
8121
8122
8123 .section "Host list patterns for query-style lookups" "SECID81"
8124 If a pattern is of the form
8125 .display
8126 <&'query-style-search-type'&>;<&'query'&>
8127 .endd
8128 the query is obeyed, and if it succeeds, the host matches the item. The actual
8129 data that is looked up is not used. The variables &$sender_host_address$& and
8130 &$sender_host_name$& can be used in the query. For example:
8131 .code
8132 hosts_lookup = pgsql;\
8133   select ip from hostlist where ip='$sender_host_address'
8134 .endd
8135 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8136 can use the &%sg%& expansion item to change this if you need to. If you want to
8137 use masked IP addresses in database queries, you can use the &%mask%& expansion
8138 operator.
8139
8140 If the query contains a reference to &$sender_host_name$&, Exim automatically
8141 looks up the host name if has not already done so. (See section
8142 &<<SECThoslispatnam>>& for comments on finding host names.)
8143
8144 Historical note: prior to release 4.30, Exim would always attempt to find a
8145 host name before running the query, unless the search type was preceded by
8146 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8147 still recognized for query-style lookups, but its presence or absence has no
8148 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8149 See section &<<SECThoslispatsikey>>&.)
8150
8151
8152
8153 .section "Mixing wildcarded host names and addresses in host lists" &&&
8154          "SECTmixwilhos"
8155 .cindex "host list" "mixing names and addresses in"
8156 If you have name lookups or wildcarded host names and IP addresses in the same
8157 host list, you should normally put the IP addresses first. For example, in an
8158 ACL you could have:
8159 .code
8160 accept hosts = 10.9.8.7 : *.friend.example
8161 .endd
8162 The reason for this lies in the left-to-right way that Exim processes lists.
8163 It can test IP addresses without doing any DNS lookups, but when it reaches an
8164 item that requires a host name, it fails if it cannot find a host name to
8165 compare with the pattern. If the above list is given in the opposite order, the
8166 &%accept%& statement fails for a host whose name cannot be found, even if its
8167 IP address is 10.9.8.7.
8168
8169 If you really do want to do the name check first, and still recognize the IP
8170 address, you can rewrite the ACL like this:
8171 .code
8172 accept hosts = *.friend.example
8173 accept hosts = 10.9.8.7
8174 .endd
8175 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8176 &<<CHAPACL>>& for details of ACLs.
8177
8178
8179
8180
8181
8182 .section "Address lists" "SECTaddresslist"
8183 .cindex "list" "address list"
8184 .cindex "address list" "empty item"
8185 .cindex "address list" "patterns"
8186 Address lists contain patterns that are matched against mail addresses. There
8187 is one special case to be considered: the sender address of a bounce message is
8188 always empty. You can test for this by providing an empty item in an address
8189 list. For example, you can set up a router to process bounce messages by
8190 using this option setting:
8191 .code
8192 senders = :
8193 .endd
8194 The presence of the colon creates an empty item. If you do not provide any
8195 data, the list is empty and matches nothing. The empty sender can also be
8196 detected by a regular expression that matches an empty string,
8197 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8198
8199 Non-empty items in an address list can be straightforward email addresses. For
8200 example:
8201 .code
8202 senders = jbc@askone.example : hs@anacreon.example
8203 .endd
8204 A certain amount of wildcarding is permitted. If a pattern contains an @
8205 character, but is not a regular expression and does not begin with a
8206 semicolon-terminated lookup type (described below), the local part of the
8207 subject address is compared with the local part of the pattern, which may start
8208 with an asterisk. If the local parts match, the domain is checked in exactly
8209 the same way as for a pattern in a domain list. For example, the domain can be
8210 wildcarded, refer to a named list, or be a lookup:
8211 .code
8212 deny senders = *@*.spamming.site:\
8213                *@+hostile_domains:\
8214                bozo@partial-lsearch;/list/of/dodgy/sites:\
8215                *@dbm;/bad/domains.db
8216 .endd
8217 .cindex "local part" "starting with !"
8218 .cindex "address list" "local part starting with !"
8219 If a local part that begins with an exclamation mark is required, it has to be
8220 specified using a regular expression, because otherwise the exclamation mark is
8221 treated as a sign of negation, as is standard in lists.
8222
8223 If a non-empty pattern that is not a regular expression or a lookup does not
8224 contain an @ character, it is matched against the domain part of the subject
8225 address. The only two formats that are recognized this way are a literal
8226 domain, or a domain pattern that starts with *. In both these cases, the effect
8227 is the same as if &`*@`& preceded the pattern. For example:
8228 .code
8229 deny senders = enemy.domain : *.enemy.domain
8230 .endd
8231
8232 The following kinds of more complicated address list pattern can match any
8233 address, including the empty address that is characteristic of bounce message
8234 senders:
8235
8236 .ilist
8237 .cindex "regular expressions" "in address list"
8238 .cindex "address list" "regular expression in"
8239 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8240 done against the complete address, with the pattern as the regular expression.
8241 You must take care that backslash and dollar characters are not misinterpreted
8242 as part of the string expansion. The simplest way to do this is to use &`\N`&
8243 to mark that part of the string as non-expandable. For example:
8244 .code
8245 deny senders = \N^.*this.*@example\.com$\N : \
8246                \N^\d{8}.+@spamhaus.example$\N : ...
8247 .endd
8248 The &`\N`& sequences are removed by the expansion, so these items do indeed
8249 start with &"^"& by the time they are being interpreted as address patterns.
8250
8251 .next
8252 .cindex "address list" "lookup for complete address"
8253 Complete addresses can be looked up by using a pattern that starts with a
8254 lookup type terminated by a semicolon, followed by the data for the lookup. For
8255 example:
8256 .code
8257 deny senders = cdb;/etc/blocked.senders : \
8258   mysql;select address from blocked where \
8259   address='${quote_mysql:$sender_address}'
8260 .endd
8261 Both query-style and single-key lookup types can be used. For a single-key
8262 lookup type, Exim uses the complete address as the key. However, empty keys are
8263 not supported for single-key lookups, so a match against the empty address
8264 always fails. This restriction does not apply to query-style lookups.
8265
8266 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8267 cannot be used, and is ignored if specified, with an entry being written to the
8268 panic log.
8269 .cindex "*@ with single-key lookup"
8270 However, you can configure lookup defaults, as described in section
8271 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8272 default. For example, with this lookup:
8273 .code
8274 accept senders = lsearch*@;/some/file
8275 .endd
8276 the file could contains lines like this:
8277 .code
8278 user1@domain1.example
8279 *@domain2.example
8280 .endd
8281 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8282 that are tried is:
8283 .code
8284 nimrod@jaeger.example
8285 *@jaeger.example
8286 *
8287 .endd
8288 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8289 would mean that every address matches, thus rendering the test useless.
8290
8291 &*Warning 2*&: Do not confuse these two kinds of item:
8292 .code
8293 deny recipients = dbm*@;/some/file
8294 deny recipients = *@dbm;/some/file
8295 .endd
8296 The first does a whole address lookup, with defaulting, as just described,
8297 because it starts with a lookup type. The second matches the local part and
8298 domain independently, as described in a bullet point below.
8299 .endlist
8300
8301
8302 The following kinds of address list pattern can match only non-empty addresses.
8303 If the subject address is empty, a match against any of these pattern types
8304 always fails.
8305
8306
8307 .ilist
8308 .cindex "@@ with single-key lookup"
8309 .cindex "address list" "@@ lookup type"
8310 .cindex "address list" "split local part and domain"
8311 If a pattern starts with &"@@"& followed by a single-key lookup item
8312 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8313 split into a local part and a domain. The domain is looked up in the file. If
8314 it is not found, there is no match. If it is found, the data that is looked up
8315 from the file is treated as a colon-separated list of local part patterns, each
8316 of which is matched against the subject local part in turn.
8317
8318 .cindex "asterisk" "in address list"
8319 The lookup may be a partial one, and/or one involving a search for a default
8320 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8321 patterns that are looked up can be regular expressions or begin with &"*"&, or
8322 even be further lookups. They may also be independently negated. For example,
8323 with
8324 .code
8325 deny senders = @@dbm;/etc/reject-by-domain
8326 .endd
8327 the data from which the DBM file is built could contain lines like
8328 .code
8329 baddomain.com:  !postmaster : *
8330 .endd
8331 to reject all senders except &%postmaster%& from that domain.
8332
8333 .cindex "local part" "starting with !"
8334 If a local part that actually begins with an exclamation mark is required, it
8335 has to be specified using a regular expression. In &(lsearch)& files, an entry
8336 may be split over several lines by indenting the second and subsequent lines,
8337 but the separating colon must still be included at line breaks. White space
8338 surrounding the colons is ignored. For example:
8339 .code
8340 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
8341 spammer3 : spammer4
8342 .endd
8343 As in all colon-separated lists in Exim, a colon can be included in an item by
8344 doubling.
8345
8346 If the last item in the list starts with a right angle-bracket, the remainder
8347 of the item is taken as a new key to look up in order to obtain a continuation
8348 list of local parts. The new key can be any sequence of characters. Thus one
8349 might have entries like
8350 .code
8351 aol.com: spammer1 : spammer 2 : >*
8352 xyz.com: spammer3 : >*
8353 *:       ^\d{8}$
8354 .endd
8355 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8356 local parts for all domains, in addition to the specific local parts listed for
8357 each domain. Of course, using this feature costs another lookup each time a
8358 chain is followed, but the effort needed to maintain the data is reduced.
8359
8360 .cindex "loop" "in lookups"
8361 It is possible to construct loops using this facility, and in order to catch
8362 them, the chains may be no more than fifty items long.
8363
8364 .next
8365 The @@<&'lookup'&> style of item can also be used with a query-style
8366 lookup, but in this case, the chaining facility is not available. The lookup
8367 can only return a single list of local parts.
8368 .endlist
8369
8370 &*Warning*&: There is an important difference between the address list items
8371 in these two examples:
8372 .code
8373 senders = +my_list
8374 senders = *@+my_list
8375 .endd
8376 In the first one, &`my_list`& is a named address list, whereas in the second
8377 example it is a named domain list.
8378
8379
8380
8381
8382 .section "Case of letters in address lists" "SECTcasletadd"
8383 .cindex "case of local parts"
8384 .cindex "address list" "case forcing"
8385 .cindex "case forcing in address lists"
8386 Domains in email addresses are always handled caselessly, but for local parts
8387 case may be significant on some systems (see &%caseful_local_part%& for how
8388 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8389 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8390 blocking lists should be done in a case-independent manner. Since most address
8391 lists in Exim are used for this kind of control, Exim attempts to do this by
8392 default.
8393
8394 The domain portion of an address is always lowercased before matching it to an
8395 address list. The local part is lowercased by default, and any string
8396 comparisons that take place are done caselessly. This means that the data in
8397 the address list itself, in files included as plain file names, and in any file
8398 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8399 keys in files that are looked up by a search type other than &(lsearch)& (which
8400 works caselessly) must be in lower case, because these lookups are not
8401 case-independent.
8402
8403 .cindex "&`+caseful`&"
8404 To allow for the possibility of caseful address list matching, if an item in
8405 an address list is the string &"+caseful"&, the original case of the local
8406 part is restored for any comparisons that follow, and string comparisons are no
8407 longer case-independent. This does not affect the domain, which remains in
8408 lower case. However, although independent matches on the domain alone are still
8409 performed caselessly, regular expressions that match against an entire address
8410 become case-sensitive after &"+caseful"& has been seen.
8411
8412
8413
8414 .section "Local part lists" "SECTlocparlis"
8415 .cindex "list" "local part list"
8416 .cindex "local part" "list"
8417 Case-sensitivity in local part lists is handled in the same way as for address
8418 lists, as just described. The &"+caseful"& item can be used if required. In a
8419 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
8420 set false, the subject is lowercased and the matching is initially
8421 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
8422 matching in the local part list, but not elsewhere in the router. If
8423 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
8424 option is case-sensitive from the start.
8425
8426 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
8427 comments are handled in the same way as address lists &-- they are recognized
8428 only if the # is preceded by white space or the start of the line.
8429 Otherwise, local part lists are matched in the same way as domain lists, except
8430 that the special items that refer to the local host (&`@`&, &`@[]`&,
8431 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
8432 Refer to section &<<SECTdomainlist>>& for details of the other available item
8433 types.
8434 .ecindex IIDdohoadli
8435
8436
8437
8438
8439 . ////////////////////////////////////////////////////////////////////////////
8440 . ////////////////////////////////////////////////////////////////////////////
8441
8442 .chapter "String expansions" "CHAPexpand"
8443 .scindex IIDstrexp "expansion" "of strings"
8444 Many strings in Exim's run time configuration are expanded before use. Some of
8445 them are expanded every time they are used; others are expanded only once.
8446
8447 When a string is being expanded it is copied verbatim from left to right except
8448 when a dollar or backslash character is encountered. A dollar specifies the
8449 start of a portion of the string that is interpreted and replaced as described
8450 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
8451 escape character, as described in the following section.
8452
8453
8454
8455 .section "Literal text in expanded strings" "SECTlittext"
8456 .cindex "expansion" "including literal text"
8457 An uninterpreted dollar can be included in an expanded string by putting a
8458 backslash in front of it. A backslash can be used to prevent any special
8459 character being treated specially in an expansion, including backslash itself.
8460 If the string appears in quotes in the configuration file, two backslashes are
8461 required because the quotes themselves cause interpretation of backslashes when
8462 the string is read in (see section &<<SECTstrings>>&).
8463
8464 .cindex "expansion" "non-expandable substrings"
8465 A portion of the string can specified as non-expandable by placing it between
8466 two occurrences of &`\N`&. This is particularly useful for protecting regular
8467 expressions, which often contain backslashes and dollar signs. For example:
8468 .code
8469 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
8470 .endd
8471 On encountering the first &`\N`&, the expander copies subsequent characters
8472 without interpretation until it reaches the next &`\N`& or the end of the
8473 string.
8474
8475
8476
8477 .section "Character escape sequences in expanded strings" "SECID82"
8478 .cindex "expansion" "escape sequences"
8479 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
8480 expanded string is recognized as an escape sequence for the character newline,
8481 carriage return, or tab, respectively. A backslash followed by up to three
8482 octal digits is recognized as an octal encoding for a single character, and a
8483 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
8484 encoding.
8485
8486 These escape sequences are also recognized in quoted strings when they are read
8487 in. Their interpretation in expansions as well is useful for unquoted strings,
8488 and for other cases such as looked-up strings that are then expanded.
8489
8490
8491 .section "Testing string expansions" "SECID83"
8492 .cindex "expansion" "testing"
8493 .cindex "testing" "string expansion"
8494 .oindex "&%-be%&"
8495 Many expansions can be tested by calling Exim with the &%-be%& option. This
8496 takes the command arguments, or lines from the standard input if there are no
8497 arguments, runs them through the string expansion code, and writes the results
8498 to the standard output. Variables based on configuration values are set up, but
8499 since no message is being processed, variables such as &$local_part$& have no
8500 value. Nevertheless the &%-be%& option can be useful for checking out file and
8501 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
8502 and &%nhash%&.
8503
8504 Exim gives up its root privilege when it is called with the &%-be%& option, and
8505 instead runs under the uid and gid it was called with, to prevent users from
8506 using &%-be%& for reading files to which they do not have access.
8507
8508 .oindex "&%-bem%&"
8509 If you want to test expansions that include variables whose values are taken
8510 from a message, there are two other options that can be used. The &%-bem%&
8511 option is like &%-be%& except that it is followed by a file name. The file is
8512 read as a message before doing the test expansions. For example:
8513 .code
8514 exim -bem /tmp/test.message '$h_subject:'
8515 .endd
8516 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
8517 Exim message identifier. For example:
8518 .code
8519 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
8520 .endd
8521 This loads the message from Exim's spool before doing the test expansions, and
8522 is therefore restricted to admin users.
8523
8524
8525 .section "Forced expansion failure" "SECTforexpfai"
8526 .cindex "expansion" "forced failure"
8527 A number of expansions that are described in the following section have
8528 alternative &"true"& and &"false"& substrings, enclosed in brace characters
8529 (which are sometimes called &"curly brackets"&). Which of the two strings is
8530 used depends on some condition that is evaluated as part of the expansion. If,
8531 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
8532 the entire string expansion fails in a way that can be detected by the code
8533 that requested the expansion. This is called &"forced expansion failure"&, and
8534 its consequences depend on the circumstances. In some cases it is no different
8535 from any other expansion failure, but in others a different action may be
8536 taken. Such variations are mentioned in the documentation of the option that is
8537 being expanded.
8538
8539
8540
8541
8542 .section "Expansion items" "SECTexpansionitems"
8543 The following items are recognized in expanded strings. White space may be used
8544 between sub-items that are keywords or substrings enclosed in braces inside an
8545 outer set of braces, to improve readability. &*Warning*&: Within braces,
8546 white space is significant.
8547
8548 .vlist
8549 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
8550 .cindex "expansion" "variables"
8551 Substitute the contents of the named variable, for example:
8552 .code
8553 $local_part
8554 ${domain}
8555 .endd
8556 The second form can be used to separate the name from subsequent alphanumeric
8557 characters. This form (using braces) is available only for variables; it does
8558 &'not'& apply to message headers. The names of the variables are given in
8559 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
8560 given, the expansion fails.
8561
8562 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
8563 .cindex "expansion" "operators"
8564 The string is first itself expanded, and then the operation specified by
8565 <&'op'&> is applied to it. For example:
8566 .code
8567 ${lc:$local_part}
8568 .endd
8569 The string starts with the first character after the colon, which may be
8570 leading white space. A list of operators is given in section &<<SECTexpop>>&
8571 below. The operator notation is used for simple expansion items that have just
8572 one argument, because it reduces the number of braces and therefore makes the
8573 string easier to understand.
8574
8575 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
8576 This item inserts &"basic"& header lines. It is described with the &%header%&
8577 expansion item below.
8578
8579 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
8580        {*&<&'arg'&>&*}...}*&"
8581 .cindex &%dlfunc%&
8582 This expansion dynamically loads and then calls a locally-written C function.
8583 This functionality is available only if Exim is compiled with
8584 .code
8585 EXPAND_DLFUNC=yes
8586 .endd
8587 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
8588 object so that it doesn't reload the same object file in the same Exim process
8589 (but of course Exim does start new processes frequently).
8590
8591 There may be from zero to eight arguments to the function. When compiling
8592 a local function that is to be called in this way, &_local_scan.h_& should be
8593 included. The Exim variables and functions that are defined by that API
8594 are also available for dynamically loaded functions. The function itself
8595 must have the following type:
8596 .code
8597 int dlfunction(uschar **yield, int argc, uschar *argv[])
8598 .endd
8599 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
8600 function should return one of the following values:
8601
8602 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
8603 into the expanded string that is being built.
8604
8605 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
8606 from &'yield'&, if it is set.
8607
8608 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
8609 taken from &'yield'& if it is set.
8610
8611 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
8612
8613 When compiling a function that is to be used in this way with gcc,
8614 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
8615 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
8616
8617 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
8618        {*&<&'string3'&>&*}}*&"
8619 .cindex "expansion" "extracting substrings by key"
8620 .cindex "&%extract%&" "substrings by key"
8621 The key and <&'string1'&> are first expanded separately. Leading and trailing
8622 white space is removed from the key (but not from any of the strings). The key
8623 must not consist entirely of digits. The expanded <&'string1'&> must be of the
8624 form:
8625 .display
8626 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
8627 .endd
8628 .vindex "&$value$&"
8629 where the equals signs and spaces (but not both) are optional. If any of the
8630 values contain white space, they must be enclosed in double quotes, and any
8631 values that are enclosed in double quotes are subject to escape processing as
8632 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
8633 for the value that corresponds to the key. The search is case-insensitive. If
8634 the key is found, <&'string2'&> is expanded, and replaces the whole item;
8635 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
8636 variable &$value$& contains the value that has been extracted. Afterwards, it
8637 is restored to any previous value it might have had.
8638
8639 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
8640 key is not found. If {<&'string2'&>} is also omitted, the value that was
8641 extracted is used. Thus, for example, these two expansions are identical, and
8642 yield &"2001"&:
8643 .code
8644 ${extract{gid}{uid=1984 gid=2001}}
8645 ${extract{gid}{uid=1984 gid=2001}{$value}}
8646 .endd
8647 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
8648 appear, for example:
8649 .code
8650 ${extract{Z}{A=... B=...}{$value} fail }
8651 .endd
8652 This forces an expansion failure (see section &<<SECTforexpfai>>&);
8653 {<&'string2'&>} must be present for &"fail"& to be recognized.
8654
8655
8656 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
8657         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
8658 .cindex "expansion" "extracting substrings by number"
8659 .cindex "&%extract%&" "substrings by number"
8660 The <&'number'&> argument must consist entirely of decimal digits,
8661 apart from leading and trailing white space, which is ignored.
8662 This is what distinguishes this form of &%extract%& from the previous kind. It
8663 behaves in the same way, except that, instead of extracting a named field, it
8664 extracts from <&'string1'&> the field whose number is given as the first
8665 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
8666 <&'string3'&> as before.
8667
8668 The fields in the string are separated by any one of the characters in the
8669 separator string. These may include space or tab characters.
8670 The first field is numbered one. If the number is negative, the fields are
8671 counted from the end of the string, with the rightmost one numbered -1. If the
8672 number given is zero, the entire string is returned. If the modulus of the
8673 number is greater than the number of fields in the string, the result is the
8674 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
8675 provided. For example:
8676 .code
8677 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
8678 .endd
8679 yields &"42"&, and
8680 .code
8681 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
8682 .endd
8683 yields &"99"&. Two successive separators mean that the field between them is
8684 empty (for example, the fifth field above).
8685
8686
8687 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
8688 .cindex "list" "selecting by condition"
8689 .cindex "expansion" "selecting from list by condition"
8690 .vindex "&$item$&"
8691 After expansion, <&'string'&> is interpreted as a list, colon-separated by
8692 default, but the separator can be changed in the usual way. For each item
8693 in this list, its value is place in &$item$&, and then the condition is
8694 evaluated. If the condition is true, &$item$& is added to the output as an
8695 item in a new list; if the condition is false, the item is discarded. The
8696 separator used for the output list is the same as the one used for the
8697 input, but a separator setting is not included in the output. For example:
8698 .code
8699 ${filter{a:b:c}{!eq{$item}{b}}
8700 .endd
8701 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
8702 to what it was before. See also the &*map*& and &*reduce*& expansion items.
8703
8704
8705 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
8706 .cindex "hash function" "textual"
8707 .cindex "expansion" "textual hash"
8708 This is a textual hashing function, and was the first to be implemented in
8709 early versions of Exim. In current releases, there are other hashing functions
8710 (numeric, MD5, and SHA-1), which are described below.
8711
8712 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
8713 <&'n'&>. If you are using fixed values for these numbers, that is, if
8714 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
8715 use the simpler operator notation that avoids some of the braces:
8716 .code
8717 ${hash_<n>_<m>:<string>}
8718 .endd
8719 The second number is optional (in both notations). If <&'n'&> is greater than
8720 or equal to the length of the string, the expansion item returns the string.
8721 Otherwise it computes a new string of length <&'n'&> by applying a hashing
8722 function to the string. The new string consists of characters taken from the
8723 first <&'m'&> characters of the string
8724 .code
8725 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
8726 .endd
8727 If <&'m'&> is not present the value 26 is used, so that only lower case
8728 letters appear. For example:
8729 .display
8730 &`$hash{3}{monty}}           `&   yields  &`jmg`&
8731 &`$hash{5}{monty}}           `&   yields  &`monty`&
8732 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
8733 .endd
8734
8735 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
8736         &*$h_*&<&'header&~name'&>&*:*&" &&&
8737        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
8738         &*$bh_*&<&'header&~name'&>&*:*&" &&&
8739        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
8740         &*$rh_*&<&'header&~name'&>&*:*&"
8741 .cindex "expansion" "header insertion"
8742 .vindex "&$header_$&"
8743 .vindex "&$bheader_$&"
8744 .vindex "&$rheader_$&"
8745 .cindex "header lines" "in expansion strings"
8746 .cindex "header lines" "character sets"
8747 .cindex "header lines" "decoding"
8748 Substitute the contents of the named message header line, for example
8749 .code
8750 $header_reply-to:
8751 .endd
8752 The newline that terminates a header line is not included in the expansion, but
8753 internal newlines (caused by splitting the header line over several physical
8754 lines) may be present.
8755
8756 The difference between &%rheader%&, &%bheader%&, and &%header%& is in the way
8757 the data in the header line is interpreted.
8758
8759 .ilist
8760 .cindex "white space" "in header lines"
8761 &%rheader%& gives the original &"raw"& content of the header line, with no
8762 processing at all, and without the removal of leading and trailing white space.
8763
8764 .next
8765 .cindex "base64 encoding" "in header lines"
8766 &%bheader%& removes leading and trailing white space, and then decodes base64
8767 or quoted-printable MIME &"words"& within the header text, but does no
8768 character set translation. If decoding of what looks superficially like a MIME
8769 &"word"& fails, the raw string is returned. If decoding
8770 .cindex "binary zero" "in header line"
8771 produces a binary zero character, it is replaced by a question mark &-- this is
8772 what Exim does for binary zeros that are actually received in header lines.
8773
8774 .next
8775 &%header%& tries to translate the string as decoded by &%bheader%& to a
8776 standard character set. This is an attempt to produce the same string as would
8777 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
8778 returned. Translation is attempted only on operating systems that support the
8779 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
8780 a system Makefile or in &_Local/Makefile_&.
8781 .endlist ilist
8782
8783 In a filter file, the target character set for &%header%& can be specified by a
8784 command of the following form:
8785 .code
8786 headers charset "UTF-8"
8787 .endd
8788 This command affects all references to &$h_$& (or &$header_$&) expansions in
8789 subsequently obeyed filter commands. In the absence of this command, the target
8790 character set in a filter is taken from the setting of the &%headers_charset%&
8791 option in the runtime configuration. The value of this option defaults to the
8792 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
8793 ISO-8859-1.
8794
8795 Header names follow the syntax of RFC 2822, which states that they may contain
8796 any printing characters except space and colon. Consequently, curly brackets
8797 &'do not'& terminate header names, and should not be used to enclose them as
8798 if they were variables. Attempting to do so causes a syntax error.
8799
8800 Only header lines that are common to all copies of a message are visible to
8801 this mechanism. These are the original header lines that are received with the
8802 message, and any that are added by an ACL statement or by a system
8803 filter. Header lines that are added to a particular copy of a message by a
8804 router or transport are not accessible.
8805
8806 For incoming SMTP messages, no header lines are visible in ACLs that are obeyed
8807 before the DATA ACL, because the header structure is not set up until the
8808 message is received. Header lines that are added in a RCPT ACL (for example)
8809 are saved until the message's incoming header lines are available, at which
8810 point they are added. When a DATA ACL is running, however, header lines added
8811 by earlier ACLs are visible.
8812
8813 Upper case and lower case letters are synonymous in header names. If the
8814 following character is white space, the terminating colon may be omitted, but
8815 this is not recommended, because you may then forget it when it is needed. When
8816 white space terminates the header name, it is included in the expanded string.
8817 If the message does not contain the given header, the expansion item is
8818 replaced by an empty string. (See the &%def%& condition in section
8819 &<<SECTexpcond>>& for a means of testing for the existence of a header.)
8820
8821 If there is more than one header with the same name, they are all concatenated
8822 to form the substitution string, up to a maximum length of 64K. Unless
8823 &%rheader%& is being used, leading and trailing white space is removed from
8824 each header before concatenation, and a completely empty header is ignored. A
8825 newline character is then inserted between non-empty headers, but there is no
8826 newline at the very end. For the &%header%& and &%bheader%& expansion, for
8827 those headers that contain lists of addresses, a comma is also inserted at the
8828 junctions between headers. This does not happen for the &%rheader%& expansion.
8829
8830
8831 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
8832 .cindex "expansion" "hmac hashing"
8833 .cindex &%hmac%&
8834 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
8835 shared secret and some text into a message authentication code, as specified in
8836 RFC 2104. This differs from &`${md5:secret_text...}`& or
8837 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
8838 cryptographic hash, allowing for authentication that is not possible with MD5
8839 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
8840 present. For example:
8841 .code
8842 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
8843 .endd
8844 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
8845 produces:
8846 .code
8847 dd97e3ba5d1a61b5006108f8c8252953
8848 .endd
8849 As an example of how this might be used, you might put in the main part of
8850 an Exim configuration:
8851 .code
8852 SPAMSCAN_SECRET=cohgheeLei2thahw
8853 .endd
8854 In a router or a transport you could then have:
8855 .code
8856 headers_add = \
8857   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
8858   ${hmac{md5}{SPAMSCAN_SECRET}\
8859   {${primary_hostname},${message_exim_id},$h_message-id:}}
8860 .endd
8861 Then given a message, you can check where it was scanned by looking at the
8862 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
8863 this header line is authentic by recomputing the authentication code from the
8864 host name, message ID and the &'Message-id:'& header line. This can be done
8865 using Exim's &%-be%& option, or by other means, for example by using the
8866 &'hmac_md5_hex()'& function in Perl.
8867
8868
8869 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
8870 .cindex "expansion" "conditional"
8871 .cindex "&%if%&, expansion item"
8872 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
8873 item; otherwise <&'string2'&> is used. The available conditions are described
8874 in section &<<SECTexpcond>>& below. For example:
8875 .code
8876 ${if eq {$local_part}{postmaster} {yes}{no} }
8877 .endd
8878 The second string need not be present; if it is not and the condition is not
8879 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
8880 be present instead of the second string (without any curly brackets). In this
8881 case, the expansion is forced to fail if the condition is not true (see section
8882 &<<SECTforexpfai>>&).
8883
8884 If both strings are omitted, the result is the string &`true`& if the condition
8885 is true, and the empty string if the condition is false. This makes it less
8886 cumbersome to write custom ACL and router conditions. For example, instead of
8887 .code
8888 condition = ${if >{$acl_m4}{3}{true}{false}}
8889 .endd
8890 you can use
8891 .code
8892 condition = ${if >{$acl_m4}{3}}
8893 .endd
8894
8895 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
8896 .cindex "expansion" "string truncation"
8897 .cindex "&%length%& expansion item"
8898 The &%length%& item is used to extract the initial portion of a string. Both
8899 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
8900 you are using a fixed value for the number, that is, if <&'string1'&> does not
8901 change when expanded, you can use the simpler operator notation that avoids
8902 some of the braces:
8903 .code
8904 ${length_<n>:<string>}
8905 .endd
8906 The result of this item is either the first <&'n'&> characters or the whole
8907 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
8908 &%strlen%&, which gives the length of a string.
8909
8910
8911 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
8912         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
8913 This is the first of one of two different types of lookup item, which are both
8914 described in the next item.
8915
8916 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
8917         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
8918 .cindex "expansion" "lookup in"
8919 .cindex "file" "lookups"
8920 .cindex "lookup" "in expanded string"
8921 The two forms of lookup item specify data lookups in files and databases, as
8922 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
8923 lookups, and the second is used for query-style lookups. The <&'key'&>,
8924 <&'file'&>, and <&'query'&> strings are expanded before use.
8925
8926 If there is any white space in a lookup item which is part of a filter command,
8927 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
8928 other place where white space is significant, the lookup item must be enclosed
8929 in double quotes. The use of data lookups in users' filter files may be locked
8930 out by the system administrator.
8931
8932 .vindex "&$value$&"
8933 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
8934 During its expansion, the variable &$value$& contains the data returned by the
8935 lookup. Afterwards it reverts to the value it had previously (at the outer
8936 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
8937 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
8938 string on failure. If <&'string2'&> is provided, it can itself be a nested
8939 lookup, thus providing a mechanism for looking up a default value when the
8940 original lookup fails.
8941
8942 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
8943 data for the outer lookup while the parameters of the second lookup are
8944 expanded, and also while <&'string2'&> of the second lookup is expanded, should
8945 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
8946 appear, and in this case, if the lookup fails, the entire expansion is forced
8947 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
8948 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
8949 successful lookup, and nothing in the case of failure.
8950
8951 For single-key lookups, the string &"partial"& is permitted to precede the
8952 search type in order to do partial matching, and * or *@ may follow a search
8953 type to request default lookups if the key does not match (see sections
8954 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
8955
8956 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
8957 If a partial search is used, the variables &$1$& and &$2$& contain the wild
8958 and non-wild parts of the key during the expansion of the replacement text.
8959 They return to their previous values at the end of the lookup item.
8960
8961 This example looks up the postmaster alias in the conventional alias file:
8962 .code
8963 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
8964 .endd
8965 This example uses NIS+ to look up the full name of the user corresponding to
8966 the local part of an address, forcing the expansion to fail if it is not found:
8967 .code
8968 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
8969   {$value}fail}
8970 .endd
8971
8972
8973 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
8974 .cindex "expansion" "list creation"
8975 .vindex "&$item$&"
8976 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
8977 default, but the separator can be changed in the usual way. For each item
8978 in this list, its value is place in &$item$&, and then <&'string2'&> is
8979 expanded and added to the output as an item in a new list. The separator used
8980 for the output list is the same as the one used for the input, but a separator
8981 setting is not included in the output. For example:
8982 .code
8983 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
8984 .endd
8985 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
8986 value of &$item$& is restored to what it was before. See also the &*filter*&
8987 and &*reduce*& expansion items.
8988
8989 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
8990 .cindex "expansion" "numeric hash"
8991 .cindex "hash function" "numeric"
8992 The three strings are expanded; the first two must yield numbers. Call them
8993 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
8994 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
8995 can use the simpler operator notation that avoids some of the braces:
8996 .code
8997 ${nhash_<n>_<m>:<string>}
8998 .endd
8999 The second number is optional (in both notations). If there is only one number,
9000 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
9001 processed by a div/mod hash function that returns two numbers, separated by a
9002 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
9003 example,
9004 .code
9005 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
9006 .endd
9007 returns the string &"6/33"&.
9008
9009
9010
9011 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
9012 .cindex "Perl" "use in expanded string"
9013 .cindex "expansion" "calling Perl from"
9014 This item is available only if Exim has been built to include an embedded Perl
9015 interpreter. The subroutine name and the arguments are first separately
9016 expanded, and then the Perl subroutine is called with those arguments. No
9017 additional arguments need be given; the maximum number permitted, including the
9018 name of the subroutine, is nine.
9019
9020 The return value of the subroutine is inserted into the expanded string, unless
9021 the return value is &%undef%&. In that case, the expansion fails in the same
9022 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
9023 Whatever you return is evaluated in a scalar context. For example, if you
9024 return the name of a Perl vector, the return value is the size of the vector,
9025 not its contents.
9026
9027 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
9028 with the error message that was passed to &%die%&. More details of the embedded
9029 Perl facility are given in chapter &<<CHAPperl>>&.
9030
9031 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
9032 out the use of this expansion item in filter files.
9033
9034
9035 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9036 .cindex "&%prvs%& expansion item"
9037 The first argument is a complete email address and the second is secret
9038 keystring. The third argument, specifying a key number, is optional. If absent,
9039 it defaults to 0. The result of the expansion is a prvs-signed email address,
9040 to be typically used with the &%return_path%& option on an &(smtp)& transport
9041 as part of a bounce address tag validation (BATV) scheme. For more discussion
9042 and an example, see section &<<SECTverifyPRVS>>&.
9043
9044 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
9045         {*&<&'string'&>&*}}*&"
9046 .cindex "&%prvscheck%& expansion item"
9047 This expansion item is the complement of the &%prvs%& item. It is used for
9048 checking prvs-signed addresses. If the expansion of the first argument does not
9049 yield a syntactically valid prvs-signed address, the whole item expands to the
9050 empty string. When the first argument does expand to a syntactically valid
9051 prvs-signed address, the second argument is expanded, with the prvs-decoded
9052 version of the address and the key number extracted from the address in the
9053 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9054
9055 These two variables can be used in the expansion of the second argument to
9056 retrieve the secret. The validity of the prvs-signed address is then checked
9057 against the secret. The result is stored in the variable &$prvscheck_result$&,
9058 which is empty for failure or &"1"& for success.
9059
9060 The third argument is optional; if it is missing, it defaults to an empty
9061 string. This argument is now expanded. If the result is an empty string, the
9062 result of the expansion is the decoded version of the address. This is the case
9063 whether or not the signature was valid. Otherwise, the result of the expansion
9064 is the expansion of the third argument.
9065
9066 All three variables can be used in the expansion of the third argument.
9067 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9068 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9069
9070 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9071 .cindex "expansion" "inserting an entire file"
9072 .cindex "file" "inserting into expansion"
9073 .cindex "&%readfile%& expansion item"
9074 The file name and end-of-line string are first expanded separately. The file is
9075 then read, and its contents replace the entire item. All newline characters in
9076 the file are replaced by the end-of-line string if it is present. Otherwise,
9077 newlines are left in the string.
9078 String expansion is not applied to the contents of the file. If you want this,
9079 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9080 the string expansion fails.
9081
9082 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9083 locks out the use of this expansion item in filter files.
9084
9085
9086
9087 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9088         {*&<&'timeout'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9089 .cindex "expansion" "inserting from a socket"
9090 .cindex "socket, use of in expansion"
9091 .cindex "&%readsocket%& expansion item"
9092 This item inserts data from a Unix domain or Internet socket into the expanded
9093 string. The minimal way of using it uses just two arguments, as in these
9094 examples:
9095 .code
9096 ${readsocket{/socket/name}{request string}}
9097 ${readsocket{inet:some.host:1234}{request string}}
9098 .endd
9099 For a Unix domain socket, the first substring must be the path to the socket.
9100 For an Internet socket, the first substring must contain &`inet:`& followed by
9101 a host name or IP address, followed by a colon and a port, which can be a
9102 number or the name of a TCP port in &_/etc/services_&. An IP address may
9103 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9104 example:
9105 .code
9106 ${readsocket{inet:[::1]:1234}{request string}}
9107 .endd
9108 Only a single host name may be given, but if looking it up yields more than
9109 one IP address, they are each tried in turn until a connection is made. For
9110 both kinds of socket, Exim makes a connection, writes the request string
9111 (unless it is an empty string) and reads from the socket until an end-of-file
9112 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9113 extend what can be done. Firstly, you can vary the timeout. For example:
9114 .code
9115 ${readsocket{/socket/name}{request string}{3s}}
9116 .endd
9117 A fourth argument allows you to change any newlines that are in the data
9118 that is read, in the same way as for &%readfile%& (see above). This example
9119 turns them into spaces:
9120 .code
9121 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9122 .endd
9123 As with all expansions, the substrings are expanded before the processing
9124 happens. Errors in these sub-expansions cause the expansion to fail. In
9125 addition, the following errors can occur:
9126
9127 .ilist
9128 Failure to create a socket file descriptor;
9129 .next
9130 Failure to connect the socket;
9131 .next
9132 Failure to write the request string;
9133 .next
9134 Timeout on reading from the socket.
9135 .endlist
9136
9137 By default, any of these errors causes the expansion to fail. However, if
9138 you supply a fifth substring, it is expanded and used when any of the above
9139 errors occurs. For example:
9140 .code
9141 ${readsocket{/socket/name}{request string}{3s}{\n}\
9142   {socket failure}}
9143 .endd
9144 You can test for the existence of a Unix domain socket by wrapping this
9145 expansion in &`${if exists`&, but there is a race condition between that test
9146 and the actual opening of the socket, so it is safer to use the fifth argument
9147 if you want to be absolutely sure of avoiding an expansion error for a
9148 non-existent Unix domain socket, or a failure to connect to an Internet socket.
9149
9150 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
9151 locks out the use of this expansion item in filter files.
9152
9153
9154 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9155 .cindex "expansion" "reducing a list to a scalar"
9156 .cindex "list" "reducing to a scalar"
9157 .vindex "&$value$&"
9158 .vindex "&$item$&"
9159 This operation reduces a list to a single, scalar string. After expansion,
9160 <&'string1'&> is interpreted as a list, colon-separated by default, but the
9161 separator can be changed in the usual way. Then <&'string2'&> is expanded and
9162 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
9163 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
9164 them. The result of that expansion is assigned to &$value$& before the next
9165 iteration. When the end of the list is reached, the final value of &$value$& is
9166 added to the expansion output. The &*reduce*& expansion item can be used in a
9167 number of ways. For example, to add up a list of numbers:
9168 .code
9169 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
9170 .endd
9171 The result of that expansion would be &`6`&. The maximum of a list of numbers
9172 can be found:
9173 .code
9174 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
9175 .endd
9176 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
9177 restored to what they were before. See also the &*filter*& and &*map*&
9178 expansion items.
9179
9180 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
9181 This item inserts &"raw"& header lines. It is described with the &%header%&
9182 expansion item above.
9183
9184 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
9185         {*&<&'string2'&>&*}}*&"
9186 .cindex "expansion" "running a command"
9187 .cindex "&%run%& expansion item"
9188 The command and its arguments are first expanded separately, and then the
9189 command is run in a separate process, but under the same uid and gid. As in
9190 other command executions from Exim, a shell is not used by default. If you want
9191 a shell, you must explicitly code it.
9192
9193 The standard input for the command exists, but is empty. The standard output
9194 and standard error are set to the same file descriptor.
9195 .cindex "return code" "from &%run%& expansion"
9196 .vindex "&$value$&"
9197 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
9198 and replaces the entire item; during this expansion, the standard output/error
9199 from the command is in the variable &$value$&. If the command fails,
9200 <&'string2'&>, if present, is expanded and used. Once again, during the
9201 expansion, the standard output/error from the command is in the variable
9202 &$value$&.
9203
9204 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
9205 can be the word &"fail"& (not in braces) to force expansion failure if the
9206 command does not succeed. If both strings are omitted, the result is contents
9207 of the standard output/error on success, and nothing on failure.
9208
9209 .vindex "&$runrc$&"
9210 The return code from the command is put in the variable &$runrc$&, and this
9211 remains set afterwards, so in a filter file you can do things like this:
9212 .code
9213 if "${run{x y z}{}}$runrc" is 1 then ...
9214   elif $runrc is 2 then ...
9215   ...
9216 endif
9217 .endd
9218 If execution of the command fails (for example, the command does not exist),
9219 the return code is 127 &-- the same code that shells use for non-existent
9220 commands.
9221
9222 &*Warning*&: In a router or transport, you cannot assume the order in which
9223 option values are expanded, except for those preconditions whose order of
9224 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
9225 by the expansion of one option, and use it in another.
9226
9227 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
9228 out the use of this expansion item in filter files.
9229
9230
9231 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
9232 .cindex "expansion" "string substitution"
9233 .cindex "&%sg%& expansion item"
9234 This item works like Perl's substitution operator (s) with the global (/g)
9235 option; hence its name. However, unlike the Perl equivalent, Exim does not
9236 modify the subject string; instead it returns the modified string for insertion
9237 into the overall expansion. The item takes three arguments: the subject string,
9238 a regular expression, and a substitution string. For example:
9239 .code
9240 ${sg{abcdefabcdef}{abc}{xyz}}
9241 .endd
9242 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
9243 if any $ or \ characters are required in the regular expression or in the
9244 substitution string, they have to be escaped. For example:
9245 .code
9246 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
9247 .endd
9248 yields &"defabc"&, and
9249 .code
9250 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
9251 .endd
9252 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
9253 the regular expression from string expansion.
9254
9255
9256
9257 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9258 .cindex "&%substr%& expansion item"
9259 .cindex "substring extraction"
9260 .cindex "expansion" "substring extraction"
9261 The three strings are expanded; the first two must yield numbers. Call them
9262 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9263 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9264 can use the simpler operator notation that avoids some of the braces:
9265 .code
9266 ${substr_<n>_<m>:<string>}
9267 .endd
9268 The second number is optional (in both notations).
9269 If it is absent in the simpler format, the preceding underscore must also be
9270 omitted.
9271
9272 The &%substr%& item can be used to extract more general substrings than
9273 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
9274 length required. For example
9275 .code
9276 ${substr{3}{2}{$local_part}}
9277 .endd
9278 If the starting offset is greater than the string length the result is the
9279 null string; if the length plus starting offset is greater than the string
9280 length, the result is the right-hand part of the string, starting from the
9281 given offset. The first character in the string has offset zero.
9282
9283 The &%substr%& expansion item can take negative offset values to count
9284 from the right-hand end of its operand. The last character is offset -1, the
9285 second-last is offset -2, and so on. Thus, for example,
9286 .code
9287 ${substr{-5}{2}{1234567}}
9288 .endd
9289 yields &"34"&. If the absolute value of a negative offset is greater than the
9290 length of the string, the substring starts at the beginning of the string, and
9291 the length is reduced by the amount of overshoot. Thus, for example,
9292 .code
9293 ${substr{-5}{2}{12}}
9294 .endd
9295 yields an empty string, but
9296 .code
9297 ${substr{-3}{2}{12}}
9298 .endd
9299 yields &"1"&.
9300
9301 When the second number is omitted from &%substr%&, the remainder of the string
9302 is taken if the offset is positive. If it is negative, all characters in the
9303 string preceding the offset point are taken. For example, an offset of -1 and
9304 no length, as in these semantically identical examples:
9305 .code
9306 ${substr_-1:abcde}
9307 ${substr{-1}{abcde}}
9308 .endd
9309 yields all but the last character of the string, that is, &"abcd"&.
9310
9311
9312
9313 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
9314         {*&<&'replacements'&>&*}}*&"
9315 .cindex "expansion" "character translation"
9316 .cindex "&%tr%& expansion item"
9317 This item does single-character translation on its subject string. The second
9318 argument is a list of characters to be translated in the subject string. Each
9319 matching character is replaced by the corresponding character from the
9320 replacement list. For example
9321 .code
9322 ${tr{abcdea}{ac}{13}}
9323 .endd
9324 yields &`1b3de1`&. If there are duplicates in the second character string, the
9325 last occurrence is used. If the third string is shorter than the second, its
9326 last character is replicated. However, if it is empty, no translation takes
9327 place.
9328 .endlist
9329
9330
9331
9332 .section "Expansion operators" "SECTexpop"
9333 .cindex "expansion" "operators"
9334 For expansion items that perform transformations on a single argument string,
9335 the &"operator"& notation is used because it is simpler and uses fewer braces.
9336 The substring is first expanded before the operation is applied to it. The
9337 following operations can be performed:
9338
9339 .vlist
9340 .vitem &*${address:*&<&'string'&>&*}*&
9341 .cindex "expansion" "RFC 2822 address handling"
9342 .cindex "&%address%& expansion item"
9343 The string is interpreted as an RFC 2822 address, as it might appear in a
9344 header line, and the effective address is extracted from it. If the string does
9345 not parse successfully, the result is empty.
9346
9347
9348 .vitem &*${addresses:*&<&'string'&>&*}*&
9349 .cindex "expansion" "RFC 2822 address handling"
9350 .cindex "&%addresses%& expansion item"
9351 The string (after expansion) is interpreted as a list of addresses in RFC
9352 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
9353 operative address (&'local-part@domain'&) is extracted from each item, and the
9354 result of the expansion is a colon-separated list, with appropriate
9355 doubling of colons should any happen to be present in the email addresses.
9356 Syntactically invalid RFC2822 address items are omitted from the output.
9357
9358 It is possible to specify a character other than colon for the output
9359 separator by starting the string with > followed by the new separator
9360 character. For example:
9361 .code
9362 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
9363 .endd
9364 expands to &`ceo@up.stairs&&sec@base.ment`&. Compare the &*address*& (singular)
9365 expansion item, which extracts the working address from a single RFC2822
9366 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
9367 processing lists.
9368
9369
9370 .vitem &*${base62:*&<&'digits'&>&*}*&
9371 .cindex "&%base62%& expansion item"
9372 .cindex "expansion" "conversion to base 62"
9373 The string must consist entirely of decimal digits. The number is converted to
9374 base 62 and output as a string of six characters, including leading zeros. In
9375 the few operating environments where Exim uses base 36 instead of base 62 for
9376 its message identifiers (because those systems do not have case-sensitive file
9377 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
9378 be absolutely clear: this is &'not'& base64 encoding.
9379
9380 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
9381 .cindex "&%base62d%& expansion item"
9382 .cindex "expansion" "conversion to base 62"
9383 The string must consist entirely of base-62 digits, or, in operating
9384 environments where Exim uses base 36 instead of base 62 for its message
9385 identifiers, base-36 digits. The number is converted to decimal and output as a
9386 string.
9387
9388 .vitem &*${domain:*&<&'string'&>&*}*&
9389 .cindex "domain" "extraction"
9390 .cindex "expansion" "domain extraction"
9391 The string is interpreted as an RFC 2822 address and the domain is extracted
9392 from it. If the string does not parse successfully, the result is empty.
9393
9394
9395 .vitem &*${escape:*&<&'string'&>&*}*&
9396 .cindex "expansion" "escaping non-printing characters"
9397 .cindex "&%escape%& expansion item"
9398 If the string contains any non-printing characters, they are converted to
9399 escape sequences starting with a backslash. Whether characters with the most
9400 significant bit set (so-called &"8-bit characters"&) count as printing or not
9401 is controlled by the &%print_topbitchars%& option.
9402
9403
9404 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
9405 .cindex "expansion" "expression evaluation"
9406 .cindex "expansion" "arithmetic expression"
9407 .cindex "&%eval%& expansion item"
9408 These items supports simple arithmetic and bitwise logical operations in
9409 expansion strings. The string (after expansion) must be a conventional
9410 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
9411 logical operators, and parentheses. All operations are carried out using
9412 integer arithmetic. The operator priorities are as follows (the same as in the
9413 C programming language):
9414 .table2 70pt 300pt
9415 .irow &'highest:'& "not (~), negate (-)"
9416 .irow ""   "multiply (*), divide (/), remainder (%)"
9417 .irow ""   "plus (+), minus (-)"
9418 .irow ""   "shift-left (<<), shift-right (>>)"
9419 .irow ""   "and (&&)"
9420 .irow ""   "xor (^)"
9421 .irow &'lowest:'&  "or (|)"
9422 .endtable
9423 Binary operators with the same priority are evaluated from left to right. White
9424 space is permitted before or after operators.
9425
9426 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
9427 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
9428 decimal, even if they start with a leading zero; hexadecimal numbers are not
9429 permitted. This can be useful when processing numbers extracted from dates or
9430 times, which often do have leading zeros.
9431
9432 A number may be followed by &"K"& or &"M"& to multiply it by 1024 or 1024*1024,
9433 respectively. Negative numbers are supported. The result of the computation is
9434 a decimal representation of the answer (without &"K"& or &"M"&). For example:
9435
9436 .display
9437 &`${eval:1+1}            `&  yields 2
9438 &`${eval:1+2*3}          `&  yields 7
9439 &`${eval:(1+2)*3}        `&  yields 9
9440 &`${eval:2+42%5}         `&  yields 4
9441 &`${eval:0xc&amp;5}          `&  yields 4
9442 &`${eval:0xc|5}          `&  yields 13
9443 &`${eval:0xc^5}          `&  yields 9
9444 &`${eval:0xc>>1}         `&  yields 6
9445 &`${eval:0xc<<1}         `&  yields 24
9446 &`${eval:~255&amp;0x1234}    `&  yields 4608
9447 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
9448 .endd
9449
9450 As a more realistic example, in an ACL you might have
9451 .code
9452 deny   message = Too many bad recipients
9453        condition =                    \
9454          ${if and {                   \
9455            {>{$rcpt_count}{10}}       \
9456            {                          \
9457            <                          \
9458              {$recipients_count}      \
9459              {${eval:$rcpt_count/2}}  \
9460            }                          \
9461          }{yes}{no}}
9462 .endd
9463 The condition is true if there have been more than 10 RCPT commands and
9464 fewer than half of them have resulted in a valid recipient.
9465
9466
9467 .vitem &*${expand:*&<&'string'&>&*}*&
9468 .cindex "expansion" "re-expansion of substring"
9469 The &%expand%& operator causes a string to be expanded for a second time. For
9470 example,
9471 .code
9472 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
9473 .endd
9474 first looks up a string in a file while expanding the operand for &%expand%&,
9475 and then re-expands what it has found.
9476
9477
9478 .vitem &*${from_utf8:*&<&'string'&>&*}*&
9479 .cindex "Unicode"
9480 .cindex "UTF-8" "conversion from"
9481 .cindex "expansion" "UTF-8 conversion"
9482 .cindex "&%from_utf8%& expansion item"
9483 The world is slowly moving towards Unicode, although there are no standards for
9484 email yet. However, other applications (including some databases) are starting
9485 to store data in Unicode, using UTF-8 encoding. This operator converts from a
9486 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
9487 converted to underscores. The input must be a valid UTF-8 string. If it is not,
9488 the result is an undefined sequence of bytes.
9489
9490 Unicode code points with values less than 256 are compatible with ASCII and
9491 ISO-8859-1 (also known as Latin-1).
9492 For example, character 169 is the copyright symbol in both cases, though the
9493 way it is encoded is different. In UTF-8, more than one byte is needed for
9494 characters with code values greater than 127, whereas ISO-8859-1 is a
9495 single-byte encoding (but thereby limited to 256 characters). This makes
9496 translation from UTF-8 to ISO-8859-1 straightforward.
9497
9498
9499 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
9500 .cindex "hash function" "textual"
9501 .cindex "expansion" "textual hash"
9502 The &%hash%& operator is a simpler interface to the hashing function that can
9503 be used when the two parameters are fixed numbers (as opposed to strings that
9504 change when expanded). The effect is the same as
9505 .code
9506 ${hash{<n>}{<m>}{<string>}}
9507 .endd
9508 See the description of the general &%hash%& item above for details. The
9509 abbreviation &%h%& can be used when &%hash%& is used as an operator.
9510
9511
9512
9513 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
9514 .cindex "base64 encoding" "conversion from hex"
9515 .cindex "expansion" "hex to base64"
9516 .cindex "&%hex2b64%& expansion item"
9517 This operator converts a hex string into one that is base64 encoded. This can
9518 be useful for processing the output of the MD5 and SHA-1 hashing functions.
9519
9520
9521 .vitem &*${lc:*&<&'string'&>&*}*&
9522 .cindex "case forcing in strings"
9523 .cindex "string" "case forcing"
9524 .cindex "lower casing"
9525 .cindex "expansion" "case forcing"
9526 .cindex "&%lc%& expansion item"
9527 This forces the letters in the string into lower-case, for example:
9528 .code
9529 ${lc:$local_part}
9530 .endd
9531
9532 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
9533 .cindex "expansion" "string truncation"
9534 .cindex "&%length%& expansion item"
9535 The &%length%& operator is a simpler interface to the &%length%& function that
9536 can be used when the parameter is a fixed number (as opposed to a string that
9537 changes when expanded). The effect is the same as
9538 .code
9539 ${length{<number>}{<string>}}
9540 .endd
9541 See the description of the general &%length%& item above for details. Note that
9542 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
9543 when &%length%& is used as an operator.
9544
9545
9546 .vitem &*${local_part:*&<&'string'&>&*}*&
9547 .cindex "expansion" "local part extraction"
9548 .cindex "&%local_part%& expansion item"
9549 The string is interpreted as an RFC 2822 address and the local part is
9550 extracted from it. If the string does not parse successfully, the result is
9551 empty.
9552
9553
9554 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
9555 .cindex "masked IP address"
9556 .cindex "IP address" "masking"
9557 .cindex "CIDR notation"
9558 .cindex "expansion" "IP address masking"
9559 .cindex "&%mask%& expansion item"
9560 If the form of the string to be operated on is not an IP address followed by a
9561 slash and an integer (that is, a network address in CIDR notation), the
9562 expansion fails. Otherwise, this operator converts the IP address to binary,
9563 masks off the least significant bits according to the bit count, and converts
9564 the result back to text, with mask appended. For example,
9565 .code
9566 ${mask:10.111.131.206/28}
9567 .endd
9568 returns the string &"10.111.131.192/28"&. Since this operation is expected to
9569 be mostly used for looking up masked addresses in files, the result for an IPv6
9570 address uses dots to separate components instead of colons, because colon
9571 terminates a key string in lsearch files. So, for example,
9572 .code
9573 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
9574 .endd
9575 returns the string
9576 .code
9577 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
9578 .endd
9579 Letters in IPv6 addresses are always output in lower case.
9580
9581
9582 .vitem &*${md5:*&<&'string'&>&*}*&
9583 .cindex "MD5 hash"
9584 .cindex "expansion" "MD5 hash"
9585 .cindex "&%md5%& expansion item"
9586 The &%md5%& operator computes the MD5 hash value of the string, and returns it
9587 as a 32-digit hexadecimal number, in which any letters are in lower case.
9588
9589
9590 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
9591 .cindex "expansion" "numeric hash"
9592 .cindex "hash function" "numeric"
9593 The &%nhash%& operator is a simpler interface to the numeric hashing function
9594 that can be used when the two parameters are fixed numbers (as opposed to
9595 strings that change when expanded). The effect is the same as
9596 .code
9597 ${nhash{<n>}{<m>}{<string>}}
9598 .endd
9599 See the description of the general &%nhash%& item above for details.
9600
9601
9602 .vitem &*${quote:*&<&'string'&>&*}*&
9603 .cindex "quoting" "in string expansions"
9604 .cindex "expansion" "quoting"
9605 .cindex "&%quote%& expansion item"
9606 The &%quote%& operator puts its argument into double quotes if it
9607 is an empty string or
9608 contains anything other than letters, digits, underscores, dots, and hyphens.
9609 Any occurrences of double quotes and backslashes are escaped with a backslash.
9610 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
9611 respectively For example,
9612 .code
9613 ${quote:ab"*"cd}
9614 .endd
9615 becomes
9616 .code
9617 "ab\"*\"cd"
9618 .endd
9619 The place where this is useful is when the argument is a substitution from a
9620 variable or a message header.
9621
9622 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
9623 .cindex "&%quote_local_part%& expansion item"
9624 This operator is like &%quote%&, except that it quotes the string only if
9625 required to do so by the rules of RFC 2822 for quoting local parts. For
9626 example, a plus sign would not cause quoting (but it would for &%quote%&).
9627 If you are creating a new email address from the contents of &$local_part$&
9628 (or any other unknown data), you should always use this operator.
9629
9630
9631 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
9632 .cindex "quoting" "lookup-specific"
9633 This operator applies lookup-specific quoting rules to the string. Each
9634 query-style lookup type has its own quoting rules which are described with
9635 the lookups in chapter &<<CHAPfdlookup>>&. For example,
9636 .code
9637 ${quote_ldap:two * two}
9638 .endd
9639 returns
9640 .code
9641 two%20%5C2A%20two
9642 .endd
9643 For single-key lookup types, no quoting is ever necessary and this operator
9644 yields an unchanged string.
9645
9646
9647 .vitem &*${randint:*&<&'n'&>&*}*&
9648 .cindex "random number"
9649 This operator returns a somewhat random number which is less than the
9650 supplied number and is at least 0.  The quality of this randomness depends
9651 on how Exim was built; the values are not suitable for keying material.
9652 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
9653 Otherwise, the implementation may be arc4random(), random() seeded by
9654 srandomdev() or srandom(), or a custom implementation even weaker than
9655 random().
9656
9657
9658 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
9659 .cindex "expansion" "IP address"
9660 This operator reverses an IP address; for IPv4 addresses, the result is in
9661 dotted-quad decimal form, while for IPv6 addreses the result is in
9662 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
9663 for DNS.  For example,
9664 .code
9665 ${reverse_ip:192.0.2.4} and ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.3}
9666 .endd
9667 returns
9668 .code
9669 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
9670 .endd
9671
9672
9673 .vitem &*${rfc2047:*&<&'string'&>&*}*&
9674 .cindex "expansion" "RFC 2047"
9675 .cindex "RFC 2047" "expansion operator"
9676 .cindex "&%rfc2047%& expansion item"
9677 This operator encodes text according to the rules of RFC 2047. This is an
9678 encoding that is used in header lines to encode non-ASCII characters. It is
9679 assumed that the input string is in the encoding specified by the
9680 &%headers_charset%& option, which defaults to ISO-8859-1. If the string
9681 contains only characters in the range 33&--126, and no instances of the
9682 characters
9683 .code
9684 ? = ( ) < > @ , ; : \ " . [ ] _
9685 .endd
9686 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
9687 string, using as many &"encoded words"& as necessary to encode all the
9688 characters.
9689
9690
9691 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
9692 .cindex "expansion" "RFC 2047"
9693 .cindex "RFC 2047" "decoding"
9694 .cindex "&%rfc2047d%& expansion item"
9695 This operator decodes strings that are encoded as per RFC 2047. Binary zero
9696 bytes are replaced by question marks. Characters are converted into the
9697 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
9698 not recognized unless &%check_rfc2047_length%& is set false.
9699
9700 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
9701 access a header line, RFC 2047 decoding is done automatically. You do not need
9702 to use this operator as well.
9703
9704
9705
9706 .vitem &*${rxquote:*&<&'string'&>&*}*&
9707 .cindex "quoting" "in regular expressions"
9708 .cindex "regular expressions" "quoting"
9709 .cindex "&%rxquote%& expansion item"
9710 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
9711 characters in its argument. This is useful when substituting the values of
9712 variables or headers inside regular expressions.
9713
9714
9715 .vitem &*${sha1:*&<&'string'&>&*}*&
9716 .cindex "SHA-1 hash"
9717 .cindex "expansion" "SHA-1 hashing"
9718 .cindex "&%sha2%& expansion item"
9719 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
9720 it as a 40-digit hexadecimal number, in which any letters are in upper case.
9721
9722
9723 .vitem &*${stat:*&<&'string'&>&*}*&
9724 .cindex "expansion" "statting a file"
9725 .cindex "file" "extracting characteristics"
9726 .cindex "&%stat%& expansion item"
9727 The string, after expansion, must be a file path. A call to the &[stat()]&
9728 function is made for this path. If &[stat()]& fails, an error occurs and the
9729 expansion fails. If it succeeds, the data from the stat replaces the item, as a
9730 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
9731 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
9732 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
9733 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
9734 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
9735 can extract individual fields using the &%extract%& expansion item.
9736
9737 The use of the &%stat%& expansion in users' filter files can be locked out by
9738 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
9739 systems for files larger than 2GB.
9740
9741 .vitem &*${str2b64:*&<&'string'&>&*}*&
9742 .cindex "expansion" "base64 encoding"
9743 .cindex "base64 encoding" "in string expansion"
9744 .cindex "&%str2b64%& expansion item"
9745 This operator converts a string into one that is base64 encoded.
9746
9747
9748
9749 .vitem &*${strlen:*&<&'string'&>&*}*&
9750 .cindex "expansion" "string length"
9751 .cindex "string" "length in expansion"
9752 .cindex "&%strlen%& expansion item"
9753 The item is replace by the length of the expanded string, expressed as a
9754 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
9755
9756
9757 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
9758 .cindex "&%substr%& expansion item"
9759 .cindex "substring extraction"
9760 .cindex "expansion" "substring expansion"
9761 The &%substr%& operator is a simpler interface to the &%substr%& function that
9762 can be used when the two parameters are fixed numbers (as opposed to strings
9763 that change when expanded). The effect is the same as
9764 .code
9765 ${substr{<start>}{<length>}{<string>}}
9766 .endd
9767 See the description of the general &%substr%& item above for details. The
9768 abbreviation &%s%& can be used when &%substr%& is used as an operator.
9769
9770 .vitem &*${time_eval:*&<&'string'&>&*}*&
9771 .cindex "&%time_eval%& expansion item"
9772 .cindex "time interval" "decoding"
9773 This item converts an Exim time interval such as &`2d4h5m`& into a number of
9774 seconds.
9775
9776 .vitem &*${time_interval:*&<&'string'&>&*}*&
9777 .cindex "&%time_interval%& expansion item"
9778 .cindex "time interval" "formatting"
9779 The argument (after sub-expansion) must be a sequence of decimal digits that
9780 represents an interval of time as a number of seconds. It is converted into a
9781 number of larger units and output in Exim's normal time format, for example,
9782 &`1w3d4h2m6s`&.
9783
9784 .vitem &*${uc:*&<&'string'&>&*}*&
9785 .cindex "case forcing in strings"
9786 .cindex "string" "case forcing"
9787 .cindex "upper casing"
9788 .cindex "expansion" "case forcing"
9789 .cindex "&%uc%& expansion item"
9790 This forces the letters in the string into upper-case.
9791 .endlist
9792
9793
9794
9795
9796
9797
9798 .section "Expansion conditions" "SECTexpcond"
9799 .scindex IIDexpcond "expansion" "conditions"
9800 The following conditions are available for testing by the &%${if%& construct
9801 while expanding strings:
9802
9803 .vlist
9804 .vitem &*!*&<&'condition'&>
9805 .cindex "expansion" "negating a condition"
9806 .cindex "negation" "in expansion condition"
9807 Preceding any condition with an exclamation mark negates the result of the
9808 condition.
9809
9810 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
9811 .cindex "numeric comparison"
9812 .cindex "expansion" "numeric comparison"
9813 There are a number of symbolic operators for doing numeric comparisons. They
9814 are:
9815 .display
9816 &`=   `&   equal
9817 &`==  `&   equal
9818 &`>   `&   greater
9819 &`>=  `&   greater or equal
9820 &`<   `&   less
9821 &`<=  `&   less or equal
9822 .endd
9823 For example:
9824 .code
9825 ${if >{$message_size}{10M} ...
9826 .endd
9827 Note that the general negation operator provides for inequality testing. The
9828 two strings must take the form of optionally signed decimal integers,
9829 optionally followed by one of the letters &"K"& or &"M"& (in either upper or
9830 lower case), signifying multiplication by 1024 or 1024*1024, respectively.
9831 As a special case, the numerical value of an empty string is taken as
9832 zero.
9833
9834 .vitem &*bool&~{*&<&'string'&>&*}*&
9835 .cindex "expansion" "boolean parsing"
9836 .cindex "&%bool%& expansion condition"
9837 This condition turns a string holding a true or false representation into
9838 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
9839 (case-insensitively); also positive integer numbers map to true if non-zero,
9840 false if zero.  Leading and trailing whitespace is ignored.
9841 All other string values will result in expansion failure.
9842
9843 When combined with ACL variables, this expansion condition will let you
9844 make decisions in one place and act on those decisions in another place.
9845 For example:
9846 .code
9847 ${if bool{$acl_m_privileged_sender} ...
9848 .endd
9849
9850 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
9851 .cindex "expansion" "boolean parsing"
9852 .cindex "&%bool_lax%& expansion condition"
9853 Like &%bool%&, this condition turns a string into a boolean state.  But
9854 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
9855 loose definition that the Router &%condition%& option uses.  The empty string
9856 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
9857 true.  Leading and trailing whitespace is ignored.
9858
9859 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
9860
9861 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
9862 .cindex "expansion" "encrypted comparison"
9863 .cindex "encrypted strings, comparing"
9864 .cindex "&%crypteq%& expansion condition"
9865 This condition is included in the Exim binary if it is built to support any
9866 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
9867 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
9868 included in the binary.
9869
9870 The &%crypteq%& condition has two arguments. The first is encrypted and
9871 compared against the second, which is already encrypted. The second string may
9872 be in the LDAP form for storing encrypted strings, which starts with the
9873 encryption type in curly brackets, followed by the data. If the second string
9874 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
9875 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
9876 Typically this will be a field from a password file. An example of an encrypted
9877 string in LDAP form is:
9878 .code
9879 {md5}CY9rzUYh03PK3k6DJie09g==
9880 .endd
9881 If such a string appears directly in an expansion, the curly brackets have to
9882 be quoted, because they are part of the expansion syntax. For example:
9883 .code
9884 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
9885 .endd
9886 The following encryption types (whose names are matched case-independently) are
9887 supported:
9888
9889 .ilist
9890 .cindex "MD5 hash"
9891 .cindex "base64 encoding" "in encrypted password"
9892 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
9893 printable characters to compare with the remainder of the second string. If the
9894 length of the comparison string is 24, Exim assumes that it is base64 encoded
9895 (as in the above example). If the length is 32, Exim assumes that it is a
9896 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
9897 comparison fails.
9898
9899 .next
9900 .cindex "SHA-1 hash"
9901 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
9902 printable characters to compare with the remainder of the second string. If the
9903 length of the comparison string is 28, Exim assumes that it is base64 encoded.
9904 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
9905 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
9906
9907 .next
9908 .cindex "&[crypt()]&"
9909 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
9910 only the first eight characters of the password. However, in modern operating
9911 systems this is no longer true, and in many cases the entire password is used,
9912 whatever its length.
9913
9914 .next
9915 .cindex "&[crypt16()]&"
9916 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
9917 use up to 16 characters of the password in some operating systems. Again, in
9918 modern operating systems, more characters may be used.
9919 .endlist
9920 Exim has its own version of &[crypt16()]&, which is just a double call to
9921 &[crypt()]&. For operating systems that have their own version, setting
9922 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
9923 operating system version instead of its own. This option is set by default in
9924 the OS-dependent &_Makefile_& for those operating systems that are known to
9925 support &[crypt16()]&.
9926
9927 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
9928 it was not using the same algorithm as some operating systems' versions. It
9929 turns out that as well as &[crypt16()]& there is a function called
9930 &[bigcrypt()]& in some operating systems. This may or may not use the same
9931 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
9932
9933 However, since there is now a move away from the traditional &[crypt()]&
9934 functions towards using SHA1 and other algorithms, tidying up this area of
9935 Exim is seen as very low priority.
9936
9937 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
9938 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
9939 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
9940 default is &`{crypt}`&. Whatever the default, you can always use either
9941 function by specifying it explicitly in curly brackets.
9942
9943 .vitem &*def:*&<&'variable&~name'&>
9944 .cindex "expansion" "checking for empty variable"
9945 .cindex "&%def%& expansion condition"
9946 The &%def%& condition must be followed by the name of one of the expansion
9947 variables defined in section &<<SECTexpvar>>&. The condition is true if the
9948 variable does not contain the empty string. For example:
9949 .code
9950 ${if def:sender_ident {from $sender_ident}}
9951 .endd
9952 Note that the variable name is given without a leading &%$%& character. If the
9953 variable does not exist, the expansion fails.
9954
9955 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
9956         &~&*def:h_*&<&'header&~name'&>&*:*&"
9957 .cindex "expansion" "checking header line existence"
9958 This condition is true if a message is being processed and the named header
9959 exists in the message. For example,
9960 .code
9961 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
9962 .endd
9963 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
9964 the header name must be terminated by a colon if white space does not follow.
9965
9966 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
9967        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
9968 .cindex "string" "comparison"
9969 .cindex "expansion" "string comparison"
9970 .cindex "&%eq%& expansion condition"
9971 .cindex "&%eqi%& expansion condition"
9972 The two substrings are first expanded. The condition is true if the two
9973 resulting strings are identical. For &%eq%& the comparison includes the case of
9974 letters, whereas for &%eqi%& the comparison is case-independent.
9975
9976 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
9977 .cindex "expansion" "file existence test"
9978 .cindex "file" "existence test"
9979 .cindex "&%exists%&, expansion condition"
9980 The substring is first expanded and then interpreted as an absolute path. The
9981 condition is true if the named file (or directory) exists. The existence test
9982 is done by calling the &[stat()]& function. The use of the &%exists%& test in
9983 users' filter files may be locked out by the system administrator.
9984
9985 .vitem &*first_delivery*&
9986 .cindex "delivery" "first"
9987 .cindex "first delivery"
9988 .cindex "expansion" "first delivery test"
9989 .cindex "&%first_delivery%& expansion condition"
9990 This condition, which has no data, is true during a message's first delivery
9991 attempt. It is false during any subsequent delivery attempts.
9992
9993
9994 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
9995        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
9996 .cindex "list" "iterative conditions"
9997 .cindex "expansion" "&*forall*& condition"
9998 .cindex "expansion" "&*forany*& condition"
9999 .vindex "&$item$&"
10000 These conditions iterate over a list. The first argument is expanded to form
10001 the list. By default, the list separator is a colon, but it can be changed by
10002 the normal method. The second argument is interpreted as a condition that is to
10003 be applied to each item in the list in turn. During the interpretation of the
10004 condition, the current list item is placed in a variable called &$item$&.
10005 .ilist
10006 For &*forany*&, interpretation stops if the condition is true for any item, and
10007 the result of the whole condition is true. If the condition is false for all
10008 items in the list, the overall condition is false.
10009 .next
10010 For &*forall*&, interpretation stops if the condition is false for any item,
10011 and the result of the whole condition is false. If the condition is true for
10012 all items in the list, the overall condition is true.
10013 .endlist
10014 Note that negation of &*forany*& means that the condition must be false for all
10015 items for the overall condition to succeed, and negation of &*forall*& means
10016 that the condition must be false for at least one item. In this example, the
10017 list separator is changed to a comma:
10018 .code
10019 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
10020 .endd
10021 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
10022 being processed, to enable these expansion items to be nested.
10023
10024
10025 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10026        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10027 .cindex "string" "comparison"
10028 .cindex "expansion" "string comparison"
10029 .cindex "&%ge%& expansion condition"
10030 .cindex "&%gei%& expansion condition"
10031 The two substrings are first expanded. The condition is true if the first
10032 string is lexically greater than or equal to the second string. For &%ge%& the
10033 comparison includes the case of letters, whereas for &%gei%& the comparison is
10034 case-independent.
10035
10036 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10037        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10038 .cindex "string" "comparison"
10039 .cindex "expansion" "string comparison"
10040 .cindex "&%gt%& expansion condition"
10041 .cindex "&%gti%& expansion condition"
10042 The two substrings are first expanded. The condition is true if the first
10043 string is lexically greater than the second string. For &%gt%& the comparison
10044 includes the case of letters, whereas for &%gti%& the comparison is
10045 case-independent.
10046
10047 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
10048        &*isip4&~{*&<&'string'&>&*}*& &&&
10049        &*isip6&~{*&<&'string'&>&*}*&
10050 .cindex "IP address" "testing string format"
10051 .cindex "string" "testing for IP address"
10052 .cindex "&%isip%& expansion condition"
10053 .cindex "&%isip4%& expansion condition"
10054 .cindex "&%isip6%& expansion condition"
10055 The substring is first expanded, and then tested to see if it has the form of
10056 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
10057 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
10058
10059 For an IPv4 address, the test is for four dot-separated components, each of
10060 which consists of from one to three digits. For an IPv6 address, up to eight
10061 colon-separated components are permitted, each containing from one to four
10062 hexadecimal digits. There may be fewer than eight components if an empty
10063 component (adjacent colons) is present. Only one empty component is permitted.
10064
10065 &*Note*&: The checks are just on the form of the address; actual numerical
10066 values are not considered. Thus, for example, 999.999.999.999 passes the IPv4
10067 check. The main use of these tests is to distinguish between IP addresses and
10068 host names, or between IPv4 and IPv6 addresses. For example, you could use
10069 .code
10070 ${if isip4{$sender_host_address}...
10071 .endd
10072 to test which IP version an incoming SMTP connection is using.
10073
10074 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
10075 .cindex "LDAP" "use for authentication"
10076 .cindex "expansion" "LDAP authentication test"
10077 .cindex "&%ldapauth%& expansion condition"
10078 This condition supports user authentication using LDAP. See section
10079 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
10080 queries. For this use, the query must contain a user name and password. The
10081 query itself is not used, and can be empty. The condition is true if the
10082 password is not empty, and the user name and password are accepted by the LDAP
10083 server. An empty password is rejected without calling LDAP because LDAP binds
10084 with an empty password are considered anonymous regardless of the username, and
10085 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
10086 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
10087 this can be used.
10088
10089
10090 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10091        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10092 .cindex "string" "comparison"
10093 .cindex "expansion" "string comparison"
10094 .cindex "&%le%& expansion condition"
10095 .cindex "&%lei%& expansion condition"
10096 The two substrings are first expanded. The condition is true if the first
10097 string is lexically less than or equal to the second string. For &%le%& the
10098 comparison includes the case of letters, whereas for &%lei%& the comparison is
10099 case-independent.
10100
10101 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10102        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10103 .cindex "string" "comparison"
10104 .cindex "expansion" "string comparison"
10105 .cindex "&%lt%& expansion condition"
10106 .cindex "&%lti%& expansion condition"
10107 The two substrings are first expanded. The condition is true if the first
10108 string is lexically less than the second string. For &%lt%& the comparison
10109 includes the case of letters, whereas for &%lti%& the comparison is
10110 case-independent.
10111
10112
10113 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10114 .cindex "expansion" "regular expression comparison"
10115 .cindex "regular expressions" "match in expanded string"
10116 .cindex "&%match%& expansion condition"
10117 The two substrings are first expanded. The second is then treated as a regular
10118 expression and applied to the first. Because of the pre-expansion, if the
10119 regular expression contains dollar, or backslash characters, they must be
10120 escaped. Care must also be taken if the regular expression contains braces
10121 (curly brackets). A closing brace must be escaped so that it is not taken as a
10122 premature termination of <&'string2'&>. The easiest approach is to use the
10123 &`\N`& feature to disable expansion of the regular expression.
10124 For example,
10125 .code
10126 ${if match {$local_part}{\N^\d{3}\N} ...
10127 .endd
10128 If the whole expansion string is in double quotes, further escaping of
10129 backslashes is also required.
10130
10131 The condition is true if the regular expression match succeeds.
10132 The regular expression is not required to begin with a circumflex
10133 metacharacter, but if there is no circumflex, the expression is not anchored,
10134 and it may match anywhere in the subject, not just at the start. If you want
10135 the pattern to match at the end of the subject, you must include the &`$`&
10136 metacharacter at an appropriate point.
10137
10138 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
10139 At the start of an &%if%& expansion the values of the numeric variable
10140 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
10141 succeeds causes them to be reset to the substrings of that condition and they
10142 will have these values during the expansion of the success string. At the end
10143 of the &%if%& expansion, the previous values are restored. After testing a
10144 combination of conditions using &%or%&, the subsequent values of the numeric
10145 variables are those of the condition that succeeded.
10146
10147 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10148 .cindex "&%match_address%& expansion condition"
10149 See &*match_local_part*&.
10150
10151 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10152 .cindex "&%match_domain%& expansion condition"
10153 See &*match_local_part*&.
10154
10155 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10156 .cindex "&%match_ip%& expansion condition"
10157 This condition matches an IP address to a list of IP address patterns. It must
10158 be followed by two argument strings. The first (after expansion) must be an IP
10159 address or an empty string. The second (after expansion) is a restricted host
10160 list that can match only an IP address, not a host name. For example:
10161 .code
10162 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
10163 .endd
10164 The specific types of host list item that are permitted in the list are:
10165
10166 .ilist
10167 An IP address, optionally with a CIDR mask.
10168 .next
10169 A single asterisk, which matches any IP address.
10170 .next
10171 An empty item, which matches only if the IP address is empty. This could be
10172 useful for testing for a locally submitted message or one from specific hosts
10173 in a single test such as
10174 . ==== As this is a nested list, any displays it contains must be indented
10175 . ==== as otherwise they are too far to the left. This comment applies to
10176 . ==== the use of xmlto plus fop. There's no problem when formatting with
10177 . ==== sdop, with or without the extra indent.
10178 .code
10179   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
10180 .endd
10181 where the first item in the list is the empty string.
10182 .next
10183 The item @[] matches any of the local host's interface addresses.
10184 .next
10185 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
10186 even if &`net-`& is not specified. There is never any attempt to turn the IP
10187 address into a host name. The most common type of linear search for
10188 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
10189 masks. For example:
10190 .code
10191   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
10192 .endd
10193 It is of course possible to use other kinds of lookup, and in such a case, you
10194 do need to specify the &`net-`& prefix if you want to specify a specific
10195 address mask, for example:
10196 .code
10197   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
10198 .endd
10199 However, unless you are combining a &%match_ip%& condition with others, it is
10200 just as easy to use the fact that a lookup is itself a condition, and write:
10201 .code
10202   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
10203 .endd
10204 .endlist ilist
10205
10206 Consult section &<<SECThoslispatip>>& for further details of these patterns.
10207
10208 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10209 .cindex "domain list" "in expansion condition"
10210 .cindex "address list" "in expansion condition"
10211 .cindex "local part" "list, in expansion condition"
10212 .cindex "&%match_local_part%& expansion condition"
10213 This condition, together with &%match_address%& and &%match_domain%&, make it
10214 possible to test domain, address, and local part lists within expansions. Each
10215 condition requires two arguments: an item and a list to match. A trivial
10216 example is:
10217 .code
10218 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
10219 .endd
10220 In each case, the second argument may contain any of the allowable items for a
10221 list of the appropriate type. Also, because the second argument (after
10222 expansion) is a standard form of list, it is possible to refer to a named list.
10223 Thus, you can use conditions like this:
10224 .code
10225 ${if match_domain{$domain}{+local_domains}{...
10226 .endd
10227 .cindex "&`+caseful`&"
10228 For address lists, the matching starts off caselessly, but the &`+caseful`&
10229 item can be used, as in all address lists, to cause subsequent items to
10230 have their local parts matched casefully. Domains are always matched
10231 caselessly.
10232
10233 &*Note*&: Host lists are &'not'& supported in this way. This is because
10234 hosts have two identities: a name and an IP address, and it is not clear
10235 how to specify cleanly how such a test would work. However, IP addresses can be
10236 matched using &%match_ip%&.
10237
10238 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
10239 .cindex "PAM authentication"
10240 .cindex "AUTH" "with PAM"
10241 .cindex "Solaris" "PAM support"
10242 .cindex "expansion" "PAM authentication test"
10243 .cindex "&%pam%& expansion condition"
10244 &'Pluggable Authentication Modules'&
10245 (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is
10246 available in the latest releases of Solaris and in some GNU/Linux
10247 distributions. The Exim support, which is intended for use in conjunction with
10248 the SMTP AUTH command, is available only if Exim is compiled with
10249 .code
10250 SUPPORT_PAM=yes
10251 .endd
10252 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
10253 in some releases of GNU/Linux &%-ldl%& is also needed.
10254
10255 The argument string is first expanded, and the result must be a
10256 colon-separated list of strings. Leading and trailing white space is ignored.
10257 The PAM module is initialized with the service name &"exim"& and the user name
10258 taken from the first item in the colon-separated data string (<&'string1'&>).
10259 The remaining items in the data string are passed over in response to requests
10260 from the authentication function. In the simple case there will only be one
10261 request, for a password, so the data consists of just two strings.
10262
10263 There can be problems if any of the strings are permitted to contain colon
10264 characters. In the usual way, these have to be doubled to avoid being taken as
10265 separators. If the data is being inserted from a variable, the &%sg%& expansion
10266 item can be used to double any existing colons. For example, the configuration
10267 of a LOGIN authenticator might contain this setting:
10268 .code
10269 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
10270 .endd
10271 For a PLAIN authenticator you could use:
10272 .code
10273 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
10274 .endd
10275 In some operating systems, PAM authentication can be done only from a process
10276 running as root. Since Exim is running as the Exim user when receiving
10277 messages, this means that PAM cannot be used directly in those systems.
10278 A patched version of the &'pam_unix'& module that comes with the
10279 Linux PAM package is available from &url(http://www.e-admin.de/pam_exim/).
10280 The patched module allows one special uid/gid combination, in addition to root,
10281 to authenticate. If you build the patched module to allow the Exim user and
10282 group, PAM can then be used from an Exim authenticator.
10283
10284
10285 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
10286 .cindex "&'pwcheck'& daemon"
10287 .cindex "Cyrus"
10288 .cindex "expansion" "&'pwcheck'& authentication test"
10289 .cindex "&%pwcheck%& expansion condition"
10290 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
10291 This is one way of making it possible for passwords to be checked by a process
10292 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
10293 deprecated. Its replacement is &'saslauthd'& (see below).
10294
10295 The pwcheck support is not included in Exim by default. You need to specify
10296 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
10297 building Exim. For example:
10298 .code
10299 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
10300 .endd
10301 You do not need to install the full Cyrus software suite in order to use
10302 the pwcheck daemon. You can compile and install just the daemon alone
10303 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
10304 access to the &_/var/pwcheck_& directory.
10305
10306 The &%pwcheck%& condition takes one argument, which must be the user name and
10307 password, separated by a colon. For example, in a LOGIN authenticator
10308 configuration, you might have this:
10309 .code
10310 server_condition = ${if pwcheck{$auth1:$auth2}}
10311 .endd
10312 Again, for a PLAIN authenticator configuration, this would be:
10313 .code
10314 server_condition = ${if pwcheck{$auth2:$auth3}}
10315 .endd
10316 .vitem &*queue_running*&
10317 .cindex "queue runner" "detecting when delivering from"
10318 .cindex "expansion" "queue runner test"
10319 .cindex "&%queue_running%& expansion condition"
10320 This condition, which has no data, is true during delivery attempts that are
10321 initiated by queue runner processes, and false otherwise.
10322
10323
10324 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
10325 .cindex "Radius"
10326 .cindex "expansion" "Radius authentication"
10327 .cindex "&%radius%& expansion condition"
10328 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
10329 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
10330 the Radius client configuration file in order to build Exim with Radius
10331 support.
10332
10333 With just that one setting, Exim expects to be linked with the &%radiusclient%&
10334 library, using the original API. If you are using release 0.4.0 or later of
10335 this library, you need to set
10336 .code
10337 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
10338 .endd
10339 in &_Local/Makefile_& when building Exim. You can also link Exim with the
10340 &%libradius%& library that comes with FreeBSD. To do this, set
10341 .code
10342 RADIUS_LIB_TYPE=RADLIB
10343 .endd
10344 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
10345 You may also have to supply a suitable setting in EXTRALIBS so that the
10346 Radius library can be found when Exim is linked.
10347
10348 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
10349 Radius client library, which calls the Radius server. The condition is true if
10350 the authentication is successful. For example:
10351 .code
10352 server_condition = ${if radius{<arguments>}}
10353 .endd
10354
10355
10356 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
10357         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
10358 .cindex "&'saslauthd'& daemon"
10359 .cindex "Cyrus"
10360 .cindex "expansion" "&'saslauthd'& authentication test"
10361 .cindex "&%saslauthd%& expansion condition"
10362 This condition supports user authentication using the Cyrus &'saslauthd'&
10363 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
10364 Using this daemon is one way of making it possible for passwords to be checked
10365 by a process that is not running as root.
10366
10367 The saslauthd support is not included in Exim by default. You need to specify
10368 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
10369 building Exim. For example:
10370 .code
10371 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
10372 .endd
10373 You do not need to install the full Cyrus software suite in order to use
10374 the saslauthd daemon. You can compile and install just the daemon alone
10375 from the Cyrus SASL library.
10376
10377 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
10378 two are mandatory. For example:
10379 .code
10380 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
10381 .endd
10382 The service and the realm are optional (which is why the arguments are enclosed
10383 in their own set of braces). For details of the meaning of the service and
10384 realm, and how to run the daemon, consult the Cyrus documentation.
10385 .endlist vlist
10386
10387
10388
10389 .section "Combining expansion conditions" "SECID84"
10390 .cindex "expansion" "combining conditions"
10391 Several conditions can be tested at once by combining them using the &%and%&
10392 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
10393 conditions on their own, and precede their lists of sub-conditions. Each
10394 sub-condition must be enclosed in braces within the overall braces that contain
10395 the list. No repetition of &%if%& is used.
10396
10397
10398 .vlist
10399 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
10400 .cindex "&""or""& expansion condition"
10401 .cindex "expansion" "&""or""& of conditions"
10402 The sub-conditions are evaluated from left to right. The condition is true if
10403 any one of the sub-conditions is true.
10404 For example,
10405 .code
10406 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
10407 .endd
10408 When a true sub-condition is found, the following ones are parsed but not
10409 evaluated. If there are several &"match"& sub-conditions the values of the
10410 numeric variables afterwards are taken from the first one that succeeds.
10411
10412 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
10413 .cindex "&""and""& expansion condition"
10414 .cindex "expansion" "&""and""& of conditions"
10415 The sub-conditions are evaluated from left to right. The condition is true if
10416 all of the sub-conditions are true. If there are several &"match"&
10417 sub-conditions, the values of the numeric variables afterwards are taken from
10418 the last one. When a false sub-condition is found, the following ones are
10419 parsed but not evaluated.
10420 .endlist
10421 .ecindex IIDexpcond
10422
10423
10424
10425
10426 .section "Expansion variables" "SECTexpvar"
10427 .cindex "expansion" "variables, list of"
10428 This section contains an alphabetical list of all the expansion variables. Some
10429 of them are available only when Exim is compiled with specific options such as
10430 support for TLS or the content scanning extension.
10431
10432 .vlist
10433 .vitem "&$0$&, &$1$&, etc"
10434 .cindex "numerical variables (&$1$& &$2$& etc)"
10435 When a &%match%& expansion condition succeeds, these variables contain the
10436 captured substrings identified by the regular expression during subsequent
10437 processing of the success string of the containing &%if%& expansion item.
10438 However, they do not retain their values afterwards; in fact, their previous
10439 values are restored at the end of processing an &%if%& item. The numerical
10440 variables may also be set externally by some other matching process which
10441 precedes the expansion of the string. For example, the commands available in
10442 Exim filter files include an &%if%& command with its own regular expression
10443 matching condition.
10444
10445 .vitem "&$acl_c...$&"
10446 Values can be placed in these variables by the &%set%& modifier in an ACL. They
10447 can be given any name that starts with &$acl_c$& and is at least six characters
10448 long, but the sixth character must be either a digit or an underscore. For
10449 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
10450 variables persist throughout the lifetime of an SMTP connection. They can be
10451 used to pass information between ACLs and between different invocations of the
10452 same ACL. When a message is received, the values of these variables are saved
10453 with the message, and can be accessed by filters, routers, and transports
10454 during subsequent delivery.
10455
10456 .vitem "&$acl_m...$&"
10457 These variables are like the &$acl_c...$& variables, except that their values
10458 are reset after a message has been received. Thus, if several messages are
10459 received in one SMTP connection, &$acl_m...$& values are not passed on from one
10460 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
10461 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
10462 message is received, the values of these variables are saved with the message,
10463 and can be accessed by filters, routers, and transports during subsequent
10464 delivery.
10465
10466 .vitem &$acl_verify_message$&
10467 .vindex "&$acl_verify_message$&"
10468 After an address verification has failed, this variable contains the failure
10469 message. It retains its value for use in subsequent modifiers. The message can
10470 be preserved by coding like this:
10471 .code
10472 warn !verify = sender
10473      set acl_m0 = $acl_verify_message
10474 .endd
10475 You can use &$acl_verify_message$& during the expansion of the &%message%& or
10476 &%log_message%& modifiers, to include information about the verification
10477 failure.
10478
10479 .vitem &$address_data$&
10480 .vindex "&$address_data$&"
10481 This variable is set by means of the &%address_data%& option in routers. The
10482 value then remains with the address while it is processed by subsequent routers
10483 and eventually a transport. If the transport is handling multiple addresses,
10484 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
10485 for more details. &*Note*&: The contents of &$address_data$& are visible in
10486 user filter files.
10487
10488 If &$address_data$& is set when the routers are called from an ACL to verify
10489 a recipient address, the final value is still in the variable for subsequent
10490 conditions and modifiers of the ACL statement. If routing the address caused it
10491 to be redirected to just one address, the child address is also routed as part
10492 of the verification, and in this case the final value of &$address_data$& is
10493 from the child's routing.
10494
10495 If &$address_data$& is set when the routers are called from an ACL to verify a
10496 sender address, the final value is also preserved, but this time in
10497 &$sender_address_data$&, to distinguish it from data from a recipient
10498 address.
10499
10500 In both cases (recipient and sender verification), the value does not persist
10501 after the end of the current ACL statement. If you want to preserve
10502 these values for longer, you can save them in ACL variables.
10503
10504 .vitem &$address_file$&
10505 .vindex "&$address_file$&"
10506 When, as a result of aliasing, forwarding, or filtering, a message is directed
10507 to a specific file, this variable holds the name of the file when the transport
10508 is running. At other times, the variable is empty. For example, using the
10509 default configuration, if user &%r2d2%& has a &_.forward_& file containing
10510 .code
10511 /home/r2d2/savemail
10512 .endd
10513 then when the &(address_file)& transport is running, &$address_file$&
10514 contains the text string &`/home/r2d2/savemail`&.
10515 .cindex "Sieve filter" "value of &$address_file$&"
10516 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
10517 then up to the transport configuration to generate an appropriate absolute path
10518 to the relevant file.
10519
10520 .vitem &$address_pipe$&
10521 .vindex "&$address_pipe$&"
10522 When, as a result of aliasing or forwarding, a message is directed to a pipe,
10523 this variable holds the pipe command when the transport is running.
10524
10525 .vitem "&$auth1$& &-- &$auth3$&"
10526 .vindex "&$auth1$&, &$auth2$&, etc"
10527 These variables are used in SMTP authenticators (see chapters
10528 &<<CHAPplaintext>>&&--&<<CHAPspa>>&). Elsewhere, they are empty.
10529
10530 .vitem &$authenticated_id$&
10531 .cindex "authentication" "id"
10532 .vindex "&$authenticated_id$&"
10533 When a server successfully authenticates a client it may be configured to
10534 preserve some of the authentication information in the variable
10535 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
10536 user/password authenticator configuration might preserve the user name for use
10537 in the routers. Note that this is not the same information that is saved in
10538 &$sender_host_authenticated$&.
10539 When a message is submitted locally (that is, not over a TCP connection)
10540 the value of &$authenticated_id$& is normally the login name of the calling
10541 process. However, a trusted user can override this by means of the &%-oMai%&
10542 command line option.
10543
10544
10545
10546
10547 .vitem &$authenticated_sender$&
10548 .cindex "sender" "authenticated"
10549 .cindex "authentication" "sender"
10550 .cindex "AUTH" "on MAIL command"
10551 .vindex "&$authenticated_sender$&"
10552 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
10553 SMTP MAIL command if it believes the sender is sufficiently trusted, as
10554 described in section &<<SECTauthparamail>>&. Unless the data is the string
10555 &"<>"&, it is set as the authenticated sender of the message, and the value is
10556 available during delivery in the &$authenticated_sender$& variable. If the
10557 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
10558
10559 .vindex "&$qualify_domain$&"
10560 When a message is submitted locally (that is, not over a TCP connection), the
10561 value of &$authenticated_sender$& is an address constructed from the login
10562 name of the calling process and &$qualify_domain$&, except that a trusted user
10563 can override this by means of the &%-oMas%& command line option.
10564
10565
10566 .vitem &$authentication_failed$&
10567 .cindex "authentication" "failure"
10568 .vindex "&$authentication_failed$&"
10569 This variable is set to &"1"& in an Exim server if a client issues an AUTH
10570 command that does not succeed. Otherwise it is set to &"0"&. This makes it
10571 possible to distinguish between &"did not try to authenticate"&
10572 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
10573 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
10574 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
10575 negative response to an AUTH command, including (for example) an attempt to use
10576 an undefined mechanism.
10577
10578 .vitem &$body_linecount$&
10579 .cindex "message body" "line count"
10580 .cindex "body of message" "line count"
10581 .vindex "&$body_linecount$&"
10582 When a message is being received or delivered, this variable contains the
10583 number of lines in the message's body. See also &$message_linecount$&.
10584
10585 .vitem &$body_zerocount$&
10586 .cindex "message body" "binary zero count"
10587 .cindex "body of message" "binary zero count"
10588 .cindex "binary zero" "in message body"
10589 .vindex "&$body_zerocount$&"
10590 When a message is being received or delivered, this variable contains the
10591 number of binary zero bytes in the message's body.
10592
10593 .vitem &$bounce_recipient$&
10594 .vindex "&$bounce_recipient$&"
10595 This is set to the recipient address of a bounce message while Exim is creating
10596 it. It is useful if a customized bounce message text file is in use (see
10597 chapter &<<CHAPemsgcust>>&).
10598
10599 .vitem &$bounce_return_size_limit$&
10600 .vindex "&$bounce_return_size_limit$&"
10601 This contains the value set in the &%bounce_return_size_limit%& option, rounded
10602 up to a multiple of 1000. It is useful when a customized error message text
10603 file is in use (see chapter &<<CHAPemsgcust>>&).
10604
10605 .vitem &$caller_gid$&
10606 .cindex "gid (group id)" "caller"
10607 .vindex "&$caller_gid$&"
10608 The real group id under which the process that called Exim was running. This is
10609 not the same as the group id of the originator of a message (see
10610 &$originator_gid$&). If Exim re-execs itself, this variable in the new
10611 incarnation normally contains the Exim gid.
10612
10613 .vitem &$caller_uid$&
10614 .cindex "uid (user id)" "caller"
10615 .vindex "&$caller_uid$&"
10616 The real user id under which the process that called Exim was running. This is
10617 not the same as the user id of the originator of a message (see
10618 &$originator_uid$&). If Exim re-execs itself, this variable in the new
10619 incarnation normally contains the Exim uid.
10620
10621 .vitem &$compile_date$&
10622 .vindex "&$compile_date$&"
10623 The date on which the Exim binary was compiled.
10624
10625 .vitem &$compile_number$&
10626 .vindex "&$compile_number$&"
10627 The building process for Exim keeps a count of the number
10628 of times it has been compiled. This serves to distinguish different
10629 compilations of the same version of the program.
10630
10631 .vitem &$demime_errorlevel$&
10632 .vindex "&$demime_errorlevel$&"
10633 This variable is available when Exim is compiled with
10634 the content-scanning extension and the obsolete &%demime%& condition. For
10635 details, see section &<<SECTdemimecond>>&.
10636
10637 .vitem &$demime_reason$&
10638 .vindex "&$demime_reason$&"
10639 This variable is available when Exim is compiled with the
10640 content-scanning extension and the obsolete &%demime%& condition. For details,
10641 see section &<<SECTdemimecond>>&.
10642
10643 .vitem &$dnslist_domain$& &&&
10644        &$dnslist_matched$& &&&
10645        &$dnslist_text$& &&&
10646        &$dnslist_value$&
10647 .vindex "&$dnslist_domain$&"
10648 .vindex "&$dnslist_matched$&"
10649 .vindex "&$dnslist_text$&"
10650 .vindex "&$dnslist_value$&"
10651 .cindex "black list (DNS)"
10652 When a DNS (black) list lookup succeeds, these variables are set to contain
10653 the following data from the lookup: the list's domain name, the key that was
10654 looked up, the contents of any associated TXT record, and the value from the
10655 main A record. See section &<<SECID204>>& for more details.
10656
10657 .vitem &$domain$&
10658 .vindex "&$domain$&"
10659 When an address is being routed, or delivered on its own, this variable
10660 contains the domain. Uppercase letters in the domain are converted into lower
10661 case for &$domain$&.
10662
10663 Global address rewriting happens when a message is received, so the value of
10664 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
10665 is set during user filtering, but not during system filtering, because a
10666 message may have many recipients and the system filter is called just once.
10667
10668 When more than one address is being delivered at once (for example, several
10669 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
10670 have the same domain. Transports can be restricted to handling only one domain
10671 at a time if the value of &$domain$& is required at transport time &-- this is
10672 the default for local transports. For further details of the environment in
10673 which local transports are run, see chapter &<<CHAPenvironment>>&.
10674
10675 .oindex "&%delay_warning_condition%&"
10676 At the end of a delivery, if all deferred addresses have the same domain, it is
10677 set in &$domain$& during the expansion of &%delay_warning_condition%&.
10678
10679 The &$domain$& variable is also used in some other circumstances:
10680
10681 .ilist
10682 When an ACL is running for a RCPT command, &$domain$& contains the domain of
10683 the recipient address. The domain of the &'sender'& address is in
10684 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
10685 normally set during the running of the MAIL ACL. However, if the sender address
10686 is verified with a callout during the MAIL ACL, the sender domain is placed in
10687 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
10688 the &(smtp)& transport.
10689
10690 .next
10691 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
10692 &$domain$& contains the domain portion of the address that is being rewritten;
10693 it can be used in the expansion of the replacement address, for example, to
10694 rewrite domains by file lookup.
10695
10696 .next
10697 With one important exception, whenever a domain list is being scanned,
10698 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
10699 a &%sender_domains%& condition in an ACL is being processed, the subject domain
10700 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
10701 that, in a RCPT ACL, the sender domain list can be dependent on the
10702 recipient domain (which is what is in &$domain$& at this time).
10703
10704 .next
10705 .cindex "ETRN" "value of &$domain$&"
10706 .oindex "&%smtp_etrn_command%&"
10707 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
10708 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
10709 .endlist
10710
10711
10712 .vitem &$domain_data$&
10713 .vindex "&$domain_data$&"
10714 When the &%domains%& option on a router matches a domain by
10715 means of a lookup, the data read by the lookup is available during the running
10716 of the router as &$domain_data$&. In addition, if the driver routes the
10717 address to a transport, the value is available in that transport. If the
10718 transport is handling multiple addresses, the value from the first address is
10719 used.
10720
10721 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
10722 domain by means of a lookup. The data read by the lookup is available during
10723 the rest of the ACL statement. In all other situations, this variable expands
10724 to nothing.
10725
10726 .vitem &$exim_gid$&
10727 .vindex "&$exim_gid$&"
10728 This variable contains the numerical value of the Exim group id.
10729
10730 .vitem &$exim_path$&
10731 .vindex "&$exim_path$&"
10732 This variable contains the path to the Exim binary.
10733
10734 .vitem &$exim_uid$&
10735 .vindex "&$exim_uid$&"
10736 This variable contains the numerical value of the Exim user id.
10737
10738 .vitem &$found_extension$&
10739 .vindex "&$found_extension$&"
10740 This variable is available when Exim is compiled with the
10741 content-scanning extension and the obsolete &%demime%& condition. For details,
10742 see section &<<SECTdemimecond>>&.
10743
10744 .vitem &$header_$&<&'name'&>
10745 This is not strictly an expansion variable. It is expansion syntax for
10746 inserting the message header line with the given name. Note that the name must
10747 be terminated by colon or white space, because it may contain a wide variety of
10748 characters. Note also that braces must &'not'& be used.
10749
10750 .vitem &$home$&
10751 .vindex "&$home$&"
10752 When the &%check_local_user%& option is set for a router, the user's home
10753 directory is placed in &$home$& when the check succeeds. In particular, this
10754 means it is set during the running of users' filter files. A router may also
10755 explicitly set a home directory for use by a transport; this can be overridden
10756 by a setting on the transport itself.
10757
10758 When running a filter test via the &%-bf%& option, &$home$& is set to the value
10759 of the environment variable HOME.
10760
10761 .vitem &$host$&
10762 .vindex "&$host$&"
10763 If a router assigns an address to a transport (any transport), and passes a
10764 list of hosts with the address, the value of &$host$& when the transport starts
10765 to run is the name of the first host on the list. Note that this applies both
10766 to local and remote transports.
10767
10768 .cindex "transport" "filter"
10769 .cindex "filter" "transport filter"
10770 For the &(smtp)& transport, if there is more than one host, the value of
10771 &$host$& changes as the transport works its way through the list. In
10772 particular, when the &(smtp)& transport is expanding its options for encryption
10773 using TLS, or for specifying a transport filter (see chapter
10774 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
10775 is connected.
10776
10777 When used in the client part of an authenticator configuration (see chapter
10778 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
10779 client is connected.
10780
10781
10782 .vitem &$host_address$&
10783 .vindex "&$host_address$&"
10784 This variable is set to the remote host's IP address whenever &$host$& is set
10785 for a remote connection. It is also set to the IP address that is being checked
10786 when the &%ignore_target_hosts%& option is being processed.
10787
10788 .vitem &$host_data$&
10789 .vindex "&$host_data$&"
10790 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
10791 result of the lookup is made available in the &$host_data$& variable. This
10792 allows you, for example, to do things like this:
10793 .code
10794 deny  hosts = net-lsearch;/some/file
10795 message = $host_data
10796 .endd
10797 .vitem &$host_lookup_deferred$&
10798 .cindex "host name" "lookup, failure of"
10799 .vindex "&$host_lookup_deferred$&"
10800 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
10801 message comes from a remote host and there is an attempt to look up the host's
10802 name from its IP address, and the attempt is not successful, one of these
10803 variables is set to &"1"&.
10804
10805 .ilist
10806 If the lookup receives a definite negative response (for example, a DNS lookup
10807 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
10808
10809 .next
10810 If there is any kind of problem during the lookup, such that Exim cannot
10811 tell whether or not the host name is defined (for example, a timeout for a DNS
10812 lookup), &$host_lookup_deferred$& is set to &"1"&.
10813 .endlist ilist
10814
10815 Looking up a host's name from its IP address consists of more than just a
10816 single reverse lookup. Exim checks that a forward lookup of at least one of the
10817 names it receives from a reverse lookup yields the original IP address. If this
10818 is not the case, Exim does not accept the looked up name(s), and
10819 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
10820 IP address (for example, the existence of a PTR record in the DNS) is not
10821 sufficient on its own for the success of a host name lookup. If the reverse
10822 lookup succeeds, but there is a lookup problem such as a timeout when checking
10823 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
10824 &"1"&. See also &$sender_host_name$&.
10825
10826 .vitem &$host_lookup_failed$&
10827 .vindex "&$host_lookup_failed$&"
10828 See &$host_lookup_deferred$&.
10829
10830
10831 .vitem &$inode$&
10832 .vindex "&$inode$&"
10833 The only time this variable is set is while expanding the &%directory_file%&
10834 option in the &(appendfile)& transport. The variable contains the inode number
10835 of the temporary file which is about to be renamed. It can be used to construct
10836 a unique name for the file.
10837
10838 .vitem &$interface_address$&
10839 .vindex "&$interface_address$&"
10840 This is an obsolete name for &$received_ip_address$&.
10841
10842 .vitem &$interface_port$&
10843 .vindex "&$interface_port$&"
10844 This is an obsolete name for &$received_port$&.
10845
10846 .vitem &$item$&
10847 .vindex "&$item$&"
10848 This variable is used during the expansion of &*forall*& and &*forany*&
10849 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
10850 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
10851 empty.
10852
10853 .vitem &$ldap_dn$&
10854 .vindex "&$ldap_dn$&"
10855 This variable, which is available only when Exim is compiled with LDAP support,
10856 contains the DN from the last entry in the most recently successful LDAP
10857 lookup.
10858
10859 .vitem &$load_average$&
10860 .vindex "&$load_average$&"
10861 This variable contains the system load average, multiplied by 1000 so that it
10862 is an integer. For example, if the load average is 0.21, the value of the
10863 variable is 210. The value is recomputed every time the variable is referenced.
10864
10865 .vitem &$local_part$&
10866 .vindex "&$local_part$&"
10867 When an address is being routed, or delivered on its own, this
10868 variable contains the local part. When a number of addresses are being
10869 delivered together (for example, multiple RCPT commands in an SMTP
10870 session), &$local_part$& is not set.
10871
10872 Global address rewriting happens when a message is received, so the value of
10873 &$local_part$& during routing and delivery is the value after rewriting.
10874 &$local_part$& is set during user filtering, but not during system filtering,
10875 because a message may have many recipients and the system filter is called just
10876 once.
10877
10878 .vindex "&$local_part_prefix$&"
10879 .vindex "&$local_part_suffix$&"
10880 If a local part prefix or suffix has been recognized, it is not included in the
10881 value of &$local_part$& during routing and subsequent delivery. The values of
10882 any prefix or suffix are in &$local_part_prefix$& and
10883 &$local_part_suffix$&, respectively.
10884
10885 When a message is being delivered to a file, pipe, or autoreply transport as a
10886 result of aliasing or forwarding, &$local_part$& is set to the local part of
10887 the parent address, not to the file name or command (see &$address_file$& and
10888 &$address_pipe$&).
10889
10890 When an ACL is running for a RCPT command, &$local_part$& contains the
10891 local part of the recipient address.
10892
10893 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
10894 &$local_part$& contains the local part of the address that is being rewritten;
10895 it can be used in the expansion of the replacement address, for example.
10896
10897 In all cases, all quoting is removed from the local part. For example, for both
10898 the addresses
10899 .code
10900 "abc:xyz"@test.example
10901 abc\:xyz@test.example
10902 .endd
10903 the value of &$local_part$& is
10904 .code
10905 abc:xyz
10906 .endd
10907 If you use &$local_part$& to create another address, you should always wrap it
10908 inside a quoting operator. For example, in a &(redirect)& router you could
10909 have:
10910 .code
10911 data = ${quote_local_part:$local_part}@new.domain.example
10912 .endd
10913 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
10914 to process local parts in a case-dependent manner in a router, you can set the
10915 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
10916
10917 .vitem &$local_part_data$&
10918 .vindex "&$local_part_data$&"
10919 When the &%local_parts%& option on a router matches a local part by means of a
10920 lookup, the data read by the lookup is available during the running of the
10921 router as &$local_part_data$&. In addition, if the driver routes the address
10922 to a transport, the value is available in that transport. If the transport is
10923 handling multiple addresses, the value from the first address is used.
10924
10925 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
10926 matches a local part by means of a lookup. The data read by the lookup is
10927 available during the rest of the ACL statement. In all other situations, this
10928 variable expands to nothing.
10929
10930 .vitem &$local_part_prefix$&
10931 .vindex "&$local_part_prefix$&"
10932 When an address is being routed or delivered, and a
10933 specific prefix for the local part was recognized, it is available in this
10934 variable, having been removed from &$local_part$&.
10935
10936 .vitem &$local_part_suffix$&
10937 .vindex "&$local_part_suffix$&"
10938 When an address is being routed or delivered, and a
10939 specific suffix for the local part was recognized, it is available in this
10940 variable, having been removed from &$local_part$&.
10941
10942 .vitem &$local_scan_data$&
10943 .vindex "&$local_scan_data$&"
10944 This variable contains the text returned by the &[local_scan()]& function when
10945 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
10946
10947 .vitem &$local_user_gid$&
10948 .vindex "&$local_user_gid$&"
10949 See &$local_user_uid$&.
10950
10951 .vitem &$local_user_uid$&
10952 .vindex "&$local_user_uid$&"
10953 This variable and &$local_user_gid$& are set to the uid and gid after the
10954 &%check_local_user%& router precondition succeeds. This means that their values
10955 are available for the remaining preconditions (&%senders%&, &%require_files%&,
10956 and &%condition%&), for the &%address_data%& expansion, and for any
10957 router-specific expansions. At all other times, the values in these variables
10958 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
10959
10960 .vitem &$localhost_number$&
10961 .vindex "&$localhost_number$&"
10962 This contains the expanded value of the
10963 &%localhost_number%& option. The expansion happens after the main options have
10964 been read.
10965
10966 .vitem &$log_inodes$&
10967 .vindex "&$log_inodes$&"
10968 The number of free inodes in the disk partition where Exim's
10969 log files are being written. The value is recalculated whenever the variable is
10970 referenced. If the relevant file system does not have the concept of inodes,
10971 the value of is -1. See also the &%check_log_inodes%& option.
10972
10973 .vitem &$log_space$&
10974 .vindex "&$log_space$&"
10975 The amount of free space (as a number of kilobytes) in the disk
10976 partition where Exim's log files are being written. The value is recalculated
10977 whenever the variable is referenced. If the operating system does not have the
10978 ability to find the amount of free space (only true for experimental systems),
10979 the space value is -1. See also the &%check_log_space%& option.
10980
10981
10982 .vitem &$mailstore_basename$&
10983 .vindex "&$mailstore_basename$&"
10984 This variable is set only when doing deliveries in &"mailstore"& format in the
10985 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
10986 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
10987 contains the basename of the files that are being written, that is, the name
10988 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
10989 variable is empty.
10990
10991 .vitem &$malware_name$&
10992 .vindex "&$malware_name$&"
10993 This variable is available when Exim is compiled with the
10994 content-scanning extension. It is set to the name of the virus that was found
10995 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
10996
10997 .vitem &$max_received_linelength$&
10998 .vindex "&$max_received_linelength$&"
10999 .cindex "maximum" "line length"
11000 .cindex "line length" "maximum"
11001 This variable contains the number of bytes in the longest line that was
11002 received as part of the message, not counting the line termination
11003 character(s).
11004
11005 .vitem &$message_age$&
11006 .cindex "message" "age of"
11007 .vindex "&$message_age$&"
11008 This variable is set at the start of a delivery attempt to contain the number
11009 of seconds since the message was received. It does not change during a single
11010 delivery attempt.
11011
11012 .vitem &$message_body$&
11013 .cindex "body of message" "expansion variable"
11014 .cindex "message body" "in expansion"
11015 .cindex "binary zero" "in message body"
11016 .vindex "&$message_body$&"
11017 .oindex "&%message_body_visible%&"
11018 This variable contains the initial portion of a message's body while it is
11019 being delivered, and is intended mainly for use in filter files. The maximum
11020 number of characters of the body that are put into the variable is set by the
11021 &%message_body_visible%& configuration option; the default is 500.
11022
11023 .oindex "&%message_body_newlines%&"
11024 By default, newlines are converted into spaces in &$message_body$&, to make it
11025 easier to search for phrases that might be split over a line break. However,
11026 this can be disabled by setting &%message_body_newlines%& to be true. Binary
11027 zeros are always converted into spaces.
11028
11029 .vitem &$message_body_end$&
11030 .cindex "body of message" "expansion variable"
11031 .cindex "message body" "in expansion"
11032 .vindex "&$message_body_end$&"
11033 This variable contains the final portion of a message's
11034 body while it is being delivered. The format and maximum size are as for
11035 &$message_body$&.
11036
11037 .vitem &$message_body_size$&
11038 .cindex "body of message" "size"
11039 .cindex "message body" "size"
11040 .vindex "&$message_body_size$&"
11041 When a message is being delivered, this variable contains the size of the body
11042 in bytes. The count starts from the character after the blank line that
11043 separates the body from the header. Newlines are included in the count. See
11044 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
11045
11046 .vitem &$message_exim_id$&
11047 .vindex "&$message_exim_id$&"
11048 When a message is being received or delivered, this variable contains the
11049 unique message id that is generated and used by Exim to identify the message.
11050 An id is not created for a message until after its header has been successfully
11051 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
11052 line; it is the local id that Exim assigns to the message, for example:
11053 &`1BXTIK-0001yO-VA`&.
11054
11055 .vitem &$message_headers$&
11056 .vindex &$message_headers$&
11057 This variable contains a concatenation of all the header lines when a message
11058 is being processed, except for lines added by routers or transports. The header
11059 lines are separated by newline characters. Their contents are decoded in the
11060 same way as a header line that is inserted by &%bheader%&.
11061
11062 .vitem &$message_headers_raw$&
11063 .vindex &$message_headers_raw$&
11064 This variable is like &$message_headers$& except that no processing of the
11065 contents of header lines is done.
11066
11067 .vitem &$message_id$&
11068 This is an old name for &$message_exim_id$&, which is now deprecated.
11069
11070 .vitem &$message_linecount$&
11071 .vindex "&$message_linecount$&"
11072 This variable contains the total number of lines in the header and body of the
11073 message. Compare &$body_linecount$&, which is the count for the body only.
11074 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
11075 number of lines received. Before delivery happens (that is, before filters,
11076 routers, and transports run) the count is increased to include the
11077 &'Received:'& header line that Exim standardly adds, and also any other header
11078 lines that are added by ACLs. The blank line that separates the message header
11079 from the body is not counted. Here is an example of the use of this variable in
11080 a DATA ACL:
11081 .code
11082 deny message   = Too many lines in message header
11083      condition = \
11084       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
11085 .endd
11086 In the MAIL and RCPT ACLs, the value is zero because at that stage the
11087 message has not yet been received.
11088
11089 .vitem &$message_size$&
11090 .cindex "size" "of message"
11091 .cindex "message" "size"
11092 .vindex "&$message_size$&"
11093 When a message is being processed, this variable contains its size in bytes. In
11094 most cases, the size includes those headers that were received with the
11095 message, but not those (such as &'Envelope-to:'&) that are added to individual
11096 deliveries as they are written. However, there is one special case: during the
11097 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
11098 doing a delivery in maildir format, the value of &$message_size$& is the
11099 precise size of the file that has been written. See also
11100 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
11101
11102 .cindex "RCPT" "value of &$message_size$&"
11103 While running a per message ACL (mail/rcpt/predata), &$message_size$&
11104 contains the size supplied on the MAIL command, or -1 if no size was given. The
11105 value may not, of course, be truthful.
11106
11107 .vitem &$mime_$&&'xxx'&
11108 A number of variables whose names start with &$mime$& are
11109 available when Exim is compiled with the content-scanning extension. For
11110 details, see section &<<SECTscanmimepart>>&.
11111
11112 .vitem "&$n0$& &-- &$n9$&"
11113 These variables are counters that can be incremented by means
11114 of the &%add%& command in filter files.
11115
11116 .vitem &$original_domain$&
11117 .vindex "&$domain$&"
11118 .vindex "&$original_domain$&"
11119 When a top-level address is being processed for delivery, this contains the
11120 same value as &$domain$&. However, if a &"child"& address (for example,
11121 generated by an alias, forward, or filter file) is being processed, this
11122 variable contains the domain of the original address (lower cased). This
11123 differs from &$parent_domain$& only when there is more than one level of
11124 aliasing or forwarding. When more than one address is being delivered in a
11125 single transport run, &$original_domain$& is not set.
11126
11127 If a new address is created by means of a &%deliver%& command in a system
11128 filter, it is set up with an artificial &"parent"& address. This has the local
11129 part &'system-filter'& and the default qualify domain.
11130
11131 .vitem &$original_local_part$&
11132 .vindex "&$local_part$&"
11133 .vindex "&$original_local_part$&"
11134 When a top-level address is being processed for delivery, this contains the
11135 same value as &$local_part$&, unless a prefix or suffix was removed from the
11136 local part, because &$original_local_part$& always contains the full local
11137 part. When a &"child"& address (for example, generated by an alias, forward, or
11138 filter file) is being processed, this variable contains the full local part of
11139 the original address.
11140
11141 If the router that did the redirection processed the local part
11142 case-insensitively, the value in &$original_local_part$& is in lower case.
11143 This variable differs from &$parent_local_part$& only when there is more than
11144 one level of aliasing or forwarding. When more than one address is being
11145 delivered in a single transport run, &$original_local_part$& is not set.
11146
11147 If a new address is created by means of a &%deliver%& command in a system
11148 filter, it is set up with an artificial &"parent"& address. This has the local
11149 part &'system-filter'& and the default qualify domain.
11150
11151 .vitem &$originator_gid$&
11152 .cindex "gid (group id)" "of originating user"
11153 .cindex "sender" "gid"
11154 .vindex "&$caller_gid$&"
11155 .vindex "&$originator_gid$&"
11156 This variable contains the value of &$caller_gid$& that was set when the
11157 message was received. For messages received via the command line, this is the
11158 gid of the sending user. For messages received by SMTP over TCP/IP, this is
11159 normally the gid of the Exim user.
11160
11161 .vitem &$originator_uid$&
11162 .cindex "uid (user id)" "of originating user"
11163 .cindex "sender" "uid"
11164 .vindex "&$caller_uid$&"
11165 .vindex "&$originaltor_uid$&"
11166 The value of &$caller_uid$& that was set when the message was received. For
11167 messages received via the command line, this is the uid of the sending user.
11168 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
11169 user.
11170
11171 .vitem &$parent_domain$&
11172 .vindex "&$parent_domain$&"
11173 This variable is similar to &$original_domain$& (see
11174 above), except that it refers to the immediately preceding parent address.
11175
11176 .vitem &$parent_local_part$&
11177 .vindex "&$parent_local_part$&"
11178 This variable is similar to &$original_local_part$&
11179 (see above), except that it refers to the immediately preceding parent address.
11180
11181 .vitem &$pid$&
11182 .cindex "pid (process id)" "of current process"
11183 .vindex "&$pid$&"
11184 This variable contains the current process id.
11185
11186 .vitem &$pipe_addresses$&
11187 .cindex "filter" "transport filter"
11188 .cindex "transport" "filter"
11189 .vindex "&$pipe_addresses$&"
11190 This is not an expansion variable, but is mentioned here because the string
11191 &`$pipe_addresses`& is handled specially in the command specification for the
11192 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
11193 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
11194 It cannot be used in general expansion strings, and provokes an &"unknown
11195 variable"& error if encountered.
11196
11197 .vitem &$primary_hostname$&
11198 .vindex "&$primary_hostname$&"
11199 This variable contains the value set by &%primary_hostname%& in the
11200 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
11201 a single-component name, Exim calls &[gethostbyname()]& (or
11202 &[getipnodebyname()]& where available) in an attempt to acquire a fully
11203 qualified host name. See also &$smtp_active_hostname$&.
11204
11205
11206 .vitem &$prvscheck_address$&
11207 This variable is used in conjunction with the &%prvscheck%& expansion item,
11208 which is described in sections &<<SECTexpansionitems>>& and
11209 &<<SECTverifyPRVS>>&.
11210
11211 .vitem &$prvscheck_keynum$&
11212 This variable is used in conjunction with the &%prvscheck%& expansion item,
11213 which is described in sections &<<SECTexpansionitems>>& and
11214 &<<SECTverifyPRVS>>&.
11215
11216 .vitem &$prvscheck_result$&
11217 This variable is used in conjunction with the &%prvscheck%& expansion item,
11218 which is described in sections &<<SECTexpansionitems>>& and
11219 &<<SECTverifyPRVS>>&.
11220
11221 .vitem &$qualify_domain$&
11222 .vindex "&$qualify_domain$&"
11223 The value set for the &%qualify_domain%& option in the configuration file.
11224
11225 .vitem &$qualify_recipient$&
11226 .vindex "&$qualify_recipient$&"
11227 The value set for the &%qualify_recipient%& option in the configuration file,
11228 or if not set, the value of &$qualify_domain$&.
11229
11230 .vitem &$rcpt_count$&
11231 .vindex "&$rcpt_count$&"
11232 When a message is being received by SMTP, this variable contains the number of
11233 RCPT commands received for the current message. If this variable is used in a
11234 RCPT ACL, its value includes the current command.
11235
11236 .vitem &$rcpt_defer_count$&
11237 .vindex "&$rcpt_defer_count$&"
11238 .cindex "4&'xx'& responses" "count of"
11239 When a message is being received by SMTP, this variable contains the number of
11240 RCPT commands in the current message that have previously been rejected with a
11241 temporary (4&'xx'&) response.
11242
11243 .vitem &$rcpt_fail_count$&
11244 .vindex "&$rcpt_fail_count$&"
11245 When a message is being received by SMTP, this variable contains the number of
11246 RCPT commands in the current message that have previously been rejected with a
11247 permanent (5&'xx'&) response.
11248
11249 .vitem &$received_count$&
11250 .vindex "&$received_count$&"
11251 This variable contains the number of &'Received:'& header lines in the message,
11252 including the one added by Exim (so its value is always greater than zero). It
11253 is available in the DATA ACL, the non-SMTP ACL, and while routing and
11254 delivering.
11255
11256 .vitem &$received_for$&
11257 .vindex "&$received_for$&"
11258 If there is only a single recipient address in an incoming message, this
11259 variable contains that address when the &'Received:'& header line is being
11260 built. The value is copied after recipient rewriting has happened, but before
11261 the &[local_scan()]& function is run.
11262
11263 .vitem &$received_ip_address$&
11264 .vindex "&$received_ip_address$&"
11265 As soon as an Exim server starts processing an incoming TCP/IP connection, this
11266 variable is set to the address of the local IP interface, and &$received_port$&
11267 is set to the local port number. (The remote IP address and port are in
11268 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
11269 the port value is -1 unless it has been set using the &%-oMi%& command line
11270 option.
11271
11272 As well as being useful in ACLs (including the &"connect"& ACL), these variable
11273 could be used, for example, to make the file name for a TLS certificate depend
11274 on which interface and/or port is being used for the incoming connection. The
11275 values of &$received_ip_address$& and &$received_port$& are saved with any
11276 messages that are received, thus making these variables available at delivery
11277 time.
11278
11279 &*Note:*& There are no equivalent variables for outgoing connections, because
11280 the values are unknown (unless they are explicitly set by options of the
11281 &(smtp)& transport).
11282
11283 .vitem &$received_port$&
11284 .vindex "&$received_port$&"
11285 See &$received_ip_address$&.
11286
11287 .vitem &$received_protocol$&
11288 .vindex "&$received_protocol$&"
11289 When a message is being processed, this variable contains the name of the
11290 protocol by which it was received. Most of the names used by Exim are defined
11291 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
11292 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
11293 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
11294 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
11295 connection and the client was successfully authenticated.
11296
11297 Exim uses the protocol name &"smtps"& for the case when encryption is
11298 automatically set up on connection without the use of STARTTLS (see
11299 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
11300 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
11301 where the client initially uses EHLO, sets up an encrypted connection using
11302 STARTTLS, and then uses HELO afterwards.
11303
11304 The &%-oMr%& option provides a way of specifying a custom protocol name for
11305 messages that are injected locally by trusted callers. This is commonly used to
11306 identify messages that are being re-injected after some kind of scanning.
11307
11308 .vitem &$received_time$&
11309 .vindex "&$received_time$&"
11310 This variable contains the date and time when the current message was received,
11311 as a number of seconds since the start of the Unix epoch.
11312
11313 .vitem &$recipient_data$&
11314 .vindex "&$recipient_data$&"
11315 This variable is set after an indexing lookup success in an ACL &%recipients%&
11316 condition. It contains the data from the lookup, and the value remains set
11317 until the next &%recipients%& test. Thus, you can do things like this:
11318 .display
11319 &`require recipients  = cdb*@;/some/file`&
11320 &`deny    `&&'some further test involving'& &`$recipient_data`&
11321 .endd
11322 &*Warning*&: This variable is set only when a lookup is used as an indexing
11323 method in the address list, using the semicolon syntax as in the example above.
11324 The variable is not set for a lookup that is used as part of the string
11325 expansion that all such lists undergo before being interpreted.
11326
11327 .vitem &$recipient_verify_failure$&
11328 .vindex "&$recipient_verify_failure$&"
11329 In an ACL, when a recipient verification fails, this variable contains
11330 information about the failure. It is set to one of the following words:
11331
11332 .ilist
11333 &"qualify"&: The address was unqualified (no domain), and the message
11334 was neither local nor came from an exempted host.
11335
11336 .next
11337 &"route"&: Routing failed.
11338
11339 .next
11340 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
11341 or before the MAIL command (that is, on initial connection, HELO, or
11342 MAIL).
11343
11344 .next
11345 &"recipient"&: The RCPT command in a callout was rejected.
11346 .next
11347
11348 &"postmaster"&: The postmaster check in a callout was rejected.
11349 .endlist
11350
11351 The main use of this variable is expected to be to distinguish between
11352 rejections of MAIL and rejections of RCPT.
11353
11354 .vitem &$recipients$&
11355 .vindex "&$recipients$&"
11356 This variable contains a list of envelope recipients for a message. A comma and
11357 a space separate the addresses in the replacement text. However, the variable
11358 is not generally available, to prevent exposure of Bcc recipients in
11359 unprivileged users' filter files. You can use &$recipients$& only in these
11360 cases:
11361
11362 .olist
11363 In a system filter file.
11364 .next
11365 In the ACLs associated with the DATA command and with non-SMTP messages, that
11366 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
11367 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
11368 &%acl_not_smtp_mime%&.
11369 .next
11370 From within a &[local_scan()]& function.
11371 .endlist
11372
11373
11374 .vitem &$recipients_count$&
11375 .vindex "&$recipients_count$&"
11376 When a message is being processed, this variable contains the number of
11377 envelope recipients that came with the message. Duplicates are not excluded
11378 from the count. While a message is being received over SMTP, the number
11379 increases for each accepted recipient. It can be referenced in an ACL.
11380
11381
11382 .vitem &$regex_match_string$&
11383 .vindex "&$regex_match_string$&"
11384 This variable is set to contain the matching regular expression after a
11385 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
11386
11387
11388 .vitem &$reply_address$&
11389 .vindex "&$reply_address$&"
11390 When a message is being processed, this variable contains the contents of the
11391 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
11392 contents of the &'From:'& header line. Apart from the removal of leading
11393 white space, the value is not processed in any way. In particular, no RFC 2047
11394 decoding or character code translation takes place.
11395
11396 .vitem &$return_path$&
11397 .vindex "&$return_path$&"
11398 When a message is being delivered, this variable contains the return path &--
11399 the sender field that will be sent as part of the envelope. It is not enclosed
11400 in <> characters. At the start of routing an address, &$return_path$& has the
11401 same value as &$sender_address$&, but if, for example, an incoming message to a
11402 mailing list has been expanded by a router which specifies a different address
11403 for bounce messages, &$return_path$& subsequently contains the new bounce
11404 address, whereas &$sender_address$& always contains the original sender address
11405 that was received with the message. In other words, &$sender_address$& contains
11406 the incoming envelope sender, and &$return_path$& contains the outgoing
11407 envelope sender.
11408
11409 .vitem &$return_size_limit$&
11410 .vindex "&$return_size_limit$&"
11411 This is an obsolete name for &$bounce_return_size_limit$&.
11412
11413 .vitem &$runrc$&
11414 .cindex "return code" "from &%run%& expansion"
11415 .vindex "&$runrc$&"
11416 This variable contains the return code from a command that is run by the
11417 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
11418 assume the order in which option values are expanded, except for those
11419 preconditions whose order of testing is documented. Therefore, you cannot
11420 reliably expect to set &$runrc$& by the expansion of one option, and use it in
11421 another.
11422
11423 .vitem &$self_hostname$&
11424 .oindex "&%self%&" "value of host name"
11425 .vindex "&$self_hostname$&"
11426 When an address is routed to a supposedly remote host that turns out to be the
11427 local host, what happens is controlled by the &%self%& generic router option.
11428 One of its values causes the address to be passed to another router. When this
11429 happens, &$self_hostname$& is set to the name of the local host that the
11430 original router encountered. In other circumstances its contents are null.
11431
11432 .vitem &$sender_address$&
11433 .vindex "&$sender_address$&"
11434 When a message is being processed, this variable contains the sender's address
11435 that was received in the message's envelope. The case of letters in the address
11436 is retained, in both the local part and the domain. For bounce messages, the
11437 value of this variable is the empty string. See also &$return_path$&.
11438
11439 .vitem &$sender_address_data$&
11440 .vindex "&$address_data$&"
11441 .vindex "&$sender_address_data$&"
11442 If &$address_data$& is set when the routers are called from an ACL to verify a
11443 sender address, the final value is preserved in &$sender_address_data$&, to
11444 distinguish it from data from a recipient address. The value does not persist
11445 after the end of the current ACL statement. If you want to preserve it for
11446 longer, you can save it in an ACL variable.
11447
11448 .vitem &$sender_address_domain$&
11449 .vindex "&$sender_address_domain$&"
11450 The domain portion of &$sender_address$&.
11451
11452 .vitem &$sender_address_local_part$&
11453 .vindex "&$sender_address_local_part$&"
11454 The local part portion of &$sender_address$&.
11455
11456 .vitem &$sender_data$&
11457 .vindex "&$sender_data$&"
11458 This variable is set after a lookup success in an ACL &%senders%& condition or
11459 in a router &%senders%& option. It contains the data from the lookup, and the
11460 value remains set until the next &%senders%& test. Thus, you can do things like
11461 this:
11462 .display
11463 &`require senders      = cdb*@;/some/file`&
11464 &`deny    `&&'some further test involving'& &`$sender_data`&
11465 .endd
11466 &*Warning*&: This variable is set only when a lookup is used as an indexing
11467 method in the address list, using the semicolon syntax as in the example above.
11468 The variable is not set for a lookup that is used as part of the string
11469 expansion that all such lists undergo before being interpreted.
11470
11471 .vitem &$sender_fullhost$&
11472 .vindex "&$sender_fullhost$&"
11473 When a message is received from a remote host, this variable contains the host
11474 name and IP address in a single string. It ends with the IP address in square
11475 brackets, followed by a colon and a port number if the logging of ports is
11476 enabled. The format of the rest of the string depends on whether the host
11477 issued a HELO or EHLO SMTP command, and whether the host name was verified by
11478 looking up its IP address. (Looking up the IP address can be forced by the
11479 &%host_lookup%& option, independent of verification.) A plain host name at the
11480 start of the string is a verified host name; if this is not present,
11481 verification either failed or was not requested. A host name in parentheses is
11482 the argument of a HELO or EHLO command. This is omitted if it is identical to
11483 the verified host name or to the host's IP address in square brackets.
11484
11485 .vitem &$sender_helo_name$&
11486 .vindex "&$sender_helo_name$&"
11487 When a message is received from a remote host that has issued a HELO or EHLO
11488 command, the argument of that command is placed in this variable. It is also
11489 set if HELO or EHLO is used when a message is received using SMTP locally via
11490 the &%-bs%& or &%-bS%& options.
11491
11492 .vitem &$sender_host_address$&
11493 .vindex "&$sender_host_address$&"
11494 When a message is received from a remote host, this variable contains that
11495 host's IP address. For locally submitted messages, it is empty.
11496
11497 .vitem &$sender_host_authenticated$&
11498 .vindex "&$sender_host_authenticated$&"
11499 This variable contains the name (not the public name) of the authenticator
11500 driver that successfully authenticated the client from which the message was
11501 received. It is empty if there was no successful authentication. See also
11502 &$authenticated_id$&.
11503
11504 .vitem &$sender_host_name$&
11505 .vindex "&$sender_host_name$&"
11506 When a message is received from a remote host, this variable contains the
11507 host's name as obtained by looking up its IP address. For messages received by
11508 other means, this variable is empty.
11509
11510 .vindex "&$host_lookup_failed$&"
11511 If the host name has not previously been looked up, a reference to
11512 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
11513 A looked up name is accepted only if it leads back to the original IP address
11514 via a forward lookup. If either the reverse or the forward lookup fails to find
11515 any data, or if the forward lookup does not yield the original IP address,
11516 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
11517
11518 .vindex "&$host_lookup_deferred$&"
11519 However, if either of the lookups cannot be completed (for example, there is a
11520 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
11521 &$host_lookup_failed$& remains set to &"0"&.
11522
11523 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
11524 host name again if there is a subsequent reference to &$sender_host_name$&
11525 in the same Exim process, but it does try again if &$host_lookup_deferred$&
11526 is set to &"1"&.
11527
11528 Exim does not automatically look up every calling host's name. If you want
11529 maximum efficiency, you should arrange your configuration so that it avoids
11530 these lookups altogether. The lookup happens only if one or more of the
11531 following are true:
11532
11533 .ilist
11534 A string containing &$sender_host_name$& is expanded.
11535 .next
11536 The calling host matches the list in &%host_lookup%&. In the default
11537 configuration, this option is set to *, so it must be changed if lookups are
11538 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
11539 .next
11540 Exim needs the host name in order to test an item in a host list. The items
11541 that require this are described in sections &<<SECThoslispatnam>>& and
11542 &<<SECThoslispatnamsk>>&.
11543 .next
11544 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
11545 In this case, the host name is required to compare with the name quoted in any
11546 EHLO or HELO commands that the client issues.
11547 .next
11548 The remote host issues a EHLO or HELO command that quotes one of the
11549 domains in &%helo_lookup_domains%&. The default value of this option is
11550 . ==== As this is a nested list, any displays it contains must be indented
11551 . ==== as otherwise they are too far to the left.
11552 .code
11553   helo_lookup_domains = @ : @[]
11554 .endd
11555 which causes a lookup if a remote host (incorrectly) gives the server's name or
11556 IP address in an EHLO or HELO command.
11557 .endlist
11558
11559
11560 .vitem &$sender_host_port$&
11561 .vindex "&$sender_host_port$&"
11562 When a message is received from a remote host, this variable contains the port
11563 number that was used on the remote host.
11564
11565 .vitem &$sender_ident$&
11566 .vindex "&$sender_ident$&"
11567 When a message is received from a remote host, this variable contains the
11568 identification received in response to an RFC 1413 request. When a message has
11569 been received locally, this variable contains the login name of the user that
11570 called Exim.
11571
11572 .vitem &$sender_rate_$&&'xxx'&
11573 A number of variables whose names begin &$sender_rate_$& are set as part of the
11574 &%ratelimit%& ACL condition. Details are given in section
11575 &<<SECTratelimiting>>&.
11576
11577 .vitem &$sender_rcvhost$&
11578 .cindex "DNS" "reverse lookup"
11579 .cindex "reverse DNS lookup"
11580 .vindex "&$sender_rcvhost$&"
11581 This is provided specifically for use in &'Received:'& headers. It starts with
11582 either the verified host name (as obtained from a reverse DNS lookup) or, if
11583 there is no verified host name, the IP address in square brackets. After that
11584 there may be text in parentheses. When the first item is a verified host name,
11585 the first thing in the parentheses is the IP address in square brackets,
11586 followed by a colon and a port number if port logging is enabled. When the
11587 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
11588 the parentheses.
11589
11590 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
11591 was used and its argument was not identical to the real host name or IP
11592 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
11593 all three items are present in the parentheses, a newline and tab are inserted
11594 into the string, to improve the formatting of the &'Received:'& header.
11595
11596 .vitem &$sender_verify_failure$&
11597 .vindex "&$sender_verify_failure$&"
11598 In an ACL, when a sender verification fails, this variable contains information
11599 about the failure. The details are the same as for
11600 &$recipient_verify_failure$&.
11601
11602 .vitem &$sending_ip_address$&
11603 .vindex "&$sending_ip_address$&"
11604 This variable is set whenever an outgoing SMTP connection to another host has
11605 been set up. It contains the IP address of the local interface that is being
11606 used. This is useful if a host that has more than one IP address wants to take
11607 on different personalities depending on which one is being used. For incoming
11608 connections, see &$received_ip_address$&.
11609
11610 .vitem &$sending_port$&
11611 .vindex "&$sending_port$&"
11612 This variable is set whenever an outgoing SMTP connection to another host has
11613 been set up. It contains the local port that is being used. For incoming
11614 connections, see &$received_port$&.
11615
11616 .vitem &$smtp_active_hostname$&
11617 .vindex "&$smtp_active_hostname$&"
11618 During an incoming SMTP session, this variable contains the value of the active
11619 host name, as specified by the &%smtp_active_hostname%& option. The value of
11620 &$smtp_active_hostname$& is saved with any message that is received, so its
11621 value can be consulted during routing and delivery.
11622
11623 .vitem &$smtp_command$&
11624 .vindex "&$smtp_command$&"
11625 During the processing of an incoming SMTP command, this variable contains the
11626 entire command. This makes it possible to distinguish between HELO and EHLO in
11627 the HELO ACL, and also to distinguish between commands such as these:
11628 .code
11629 MAIL FROM:<>
11630 MAIL FROM: <>
11631 .endd
11632 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
11633 command, the address in &$smtp_command$& is the original address before any
11634 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
11635 the address after SMTP-time rewriting.
11636
11637 .vitem &$smtp_command_argument$&
11638 .cindex "SMTP" "command, argument for"
11639 .vindex "&$smtp_command_argument$&"
11640 While an ACL is running to check an SMTP command, this variable contains the
11641 argument, that is, the text that follows the command name, with leading white
11642 space removed. Following the introduction of &$smtp_command$&, this variable is
11643 somewhat redundant, but is retained for backwards compatibility.
11644
11645 .vitem &$smtp_count_at_connection_start$&
11646 .vindex "&$smtp_count_at_connection_start$&"
11647 This variable is set greater than zero only in processes spawned by the Exim
11648 daemon for handling incoming SMTP connections. The name is deliberately long,
11649 in order to emphasize what the contents are. When the daemon accepts a new
11650 connection, it increments this variable. A copy of the variable is passed to
11651 the child process that handles the connection, but its value is fixed, and
11652 never changes. It is only an approximation of how many incoming connections
11653 there actually are, because many other connections may come and go while a
11654 single connection is being processed. When a child process terminates, the
11655 daemon decrements its copy of the variable.
11656
11657 .vitem "&$sn0$& &-- &$sn9$&"
11658 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
11659 that were current at the end of the system filter file. This allows a system
11660 filter file to set values that can be tested in users' filter files. For
11661 example, a system filter could set a value indicating how likely it is that a
11662 message is junk mail.
11663
11664 .vitem &$spam_$&&'xxx'&
11665 A number of variables whose names start with &$spam$& are available when Exim
11666 is compiled with the content-scanning extension. For details, see section
11667 &<<SECTscanspamass>>&.
11668
11669
11670 .vitem &$spool_directory$&
11671 .vindex "&$spool_directory$&"
11672 The name of Exim's spool directory.
11673
11674 .vitem &$spool_inodes$&
11675 .vindex "&$spool_inodes$&"
11676 The number of free inodes in the disk partition where Exim's spool files are
11677 being written. The value is recalculated whenever the variable is referenced.
11678 If the relevant file system does not have the concept of inodes, the value of
11679 is -1. See also the &%check_spool_inodes%& option.
11680
11681 .vitem &$spool_space$&
11682 .vindex "&$spool_space$&"
11683 The amount of free space (as a number of kilobytes) in the disk partition where
11684 Exim's spool files are being written. The value is recalculated whenever the
11685 variable is referenced. If the operating system does not have the ability to
11686 find the amount of free space (only true for experimental systems), the space
11687 value is -1. For example, to check in an ACL that there is at least 50
11688 megabytes free on the spool, you could write:
11689 .code
11690 condition = ${if > {$spool_space}{50000}}
11691 .endd
11692 See also the &%check_spool_space%& option.
11693
11694
11695 .vitem &$thisaddress$&
11696 .vindex "&$thisaddress$&"
11697 This variable is set only during the processing of the &%foranyaddress%&
11698 command in a filter file. Its use is explained in the description of that
11699 command, which can be found in the separate document entitled &'Exim's
11700 interfaces to mail filtering'&.
11701
11702 .vitem &$tls_certificate_verified$&
11703 .vindex "&$tls_certificate_verified$&"
11704 This variable is set to &"1"& if a TLS certificate was verified when the
11705 message was received, and &"0"& otherwise.
11706
11707 .vitem &$tls_cipher$&
11708 .vindex "&$tls_cipher$&"
11709 When a message is received from a remote host over an encrypted SMTP
11710 connection, this variable is set to the cipher suite that was negotiated, for
11711 example DES-CBC3-SHA. In other circumstances, in particular, for message
11712 received over unencrypted connections, the variable is empty. Testing
11713 &$tls_cipher$& for emptiness is one way of distinguishing between encrypted and
11714 non-encrypted connections during ACL processing.
11715
11716 The &$tls_cipher$& variable retains its value during message delivery, except
11717 when an outward SMTP delivery takes place via the &(smtp)& transport. In this
11718 case, &$tls_cipher$& is cleared before any outgoing SMTP connection is made,
11719 and then set to the outgoing cipher suite if one is negotiated. See chapter
11720 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
11721 details of the &(smtp)& transport.
11722
11723 .vitem &$tls_peerdn$&
11724 .vindex "&$tls_peerdn$&"
11725 When a message is received from a remote host over an encrypted SMTP
11726 connection, and Exim is configured to request a certificate from the client,
11727 the value of the Distinguished Name of the certificate is made available in the
11728 &$tls_peerdn$& during subsequent processing. Like &$tls_cipher$&, the
11729 value is retained during message delivery, except during outbound SMTP
11730 deliveries.
11731
11732 .vitem &$tod_bsdinbox$&
11733 .vindex "&$tod_bsdinbox$&"
11734 The time of day and the date, in the format required for BSD-style mailbox
11735 files, for example: Thu Oct 17 17:14:09 1995.
11736
11737 .vitem &$tod_epoch$&
11738 .vindex "&$tod_epoch$&"
11739 The time and date as a number of seconds since the start of the Unix epoch.
11740
11741 .vitem &$tod_full$&
11742 .vindex "&$tod_full$&"
11743 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
11744 +0100. The timezone is always given as a numerical offset from UTC, with
11745 positive values used for timezones that are ahead (east) of UTC, and negative
11746 values for those that are behind (west).
11747
11748 .vitem &$tod_log$&
11749 .vindex "&$tod_log$&"
11750 The time and date in the format used for writing Exim's log files, for example:
11751 1995-10-12 15:32:29, but without a timezone.
11752
11753 .vitem &$tod_logfile$&
11754 .vindex "&$tod_logfile$&"
11755 This variable contains the date in the format yyyymmdd. This is the format that
11756 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
11757 flag.
11758
11759 .vitem &$tod_zone$&
11760 .vindex "&$tod_zone$&"
11761 This variable contains the numerical value of the local timezone, for example:
11762 -0500.
11763
11764 .vitem &$tod_zulu$&
11765 .vindex "&$tod_zulu$&"
11766 This variable contains the UTC date and time in &"Zulu"& format, as specified
11767 by ISO 8601, for example: 20030221154023Z.
11768
11769 .vitem &$value$&
11770 .vindex "&$value$&"
11771 This variable contains the result of an expansion lookup, extraction operation,
11772 or external command, as described above. It is also used during a
11773 &*reduce*& expansion.
11774
11775 .vitem &$version_number$&
11776 .vindex "&$version_number$&"
11777 The version number of Exim.
11778
11779 .vitem &$warn_message_delay$&
11780 .vindex "&$warn_message_delay$&"
11781 This variable is set only during the creation of a message warning about a
11782 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
11783
11784 .vitem &$warn_message_recipients$&
11785 .vindex "&$warn_message_recipients$&"
11786 This variable is set only during the creation of a message warning about a
11787 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
11788 .endlist
11789 .ecindex IIDstrexp
11790
11791
11792
11793 . ////////////////////////////////////////////////////////////////////////////
11794 . ////////////////////////////////////////////////////////////////////////////
11795
11796 .chapter "Embedded Perl" "CHAPperl"
11797 .scindex IIDperl "Perl" "calling from Exim"
11798 Exim can be built to include an embedded Perl interpreter. When this is done,
11799 Perl subroutines can be called as part of the string expansion process. To make
11800 use of the Perl support, you need version 5.004 or later of Perl installed on
11801 your system. To include the embedded interpreter in the Exim binary, include
11802 the line
11803 .code
11804 EXIM_PERL = perl.o
11805 .endd
11806 in your &_Local/Makefile_& and then build Exim in the normal way.
11807
11808
11809 .section "Setting up so Perl can be used" "SECID85"
11810 .oindex "&%perl_startup%&"
11811 Access to Perl subroutines is via a global configuration option called
11812 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
11813 no &%perl_startup%& option in the Exim configuration file then no Perl
11814 interpreter is started and there is almost no overhead for Exim (since none of
11815 the Perl library will be paged in unless used). If there is a &%perl_startup%&
11816 option then the associated value is taken to be Perl code which is executed in
11817 a newly created Perl interpreter.
11818
11819 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
11820 need backslashes before any characters to escape special meanings. The option
11821 should usually be something like
11822 .code
11823 perl_startup = do '/etc/exim.pl'
11824 .endd
11825 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
11826 use from Exim. Exim can be configured either to start up a Perl interpreter as
11827 soon as it is entered, or to wait until the first time it is needed. Starting
11828 the interpreter at the beginning ensures that it is done while Exim still has
11829 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
11830 fact used in a particular run. Also, note that this does not mean that Exim is
11831 necessarily running as root when Perl is called at a later time. By default,
11832 the interpreter is started only when it is needed, but this can be changed in
11833 two ways:
11834
11835 .ilist
11836 .oindex "&%perl_at_start%&"
11837 Setting &%perl_at_start%& (a boolean option) in the configuration requests
11838 a startup when Exim is entered.
11839 .next
11840 The command line option &%-ps%& also requests a startup when Exim is entered,
11841 overriding the setting of &%perl_at_start%&.
11842 .endlist
11843
11844 There is also a command line option &%-pd%& (for delay) which suppresses the
11845 initial startup, even if &%perl_at_start%& is set.
11846
11847
11848 .section "Calling Perl subroutines" "SECID86"
11849 When the configuration file includes a &%perl_startup%& option you can make use
11850 of the string expansion item to call the Perl subroutines that are defined
11851 by the &%perl_startup%& code. The operator is used in any of the following
11852 forms:
11853 .code
11854 ${perl{foo}}
11855 ${perl{foo}{argument}}
11856 ${perl{foo}{argument1}{argument2} ... }
11857 .endd
11858 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
11859 arguments may be passed. Passing more than this results in an expansion failure
11860 with an error message of the form
11861 .code
11862 Too many arguments passed to Perl subroutine "foo" (max is 8)
11863 .endd
11864 The return value of the Perl subroutine is evaluated in a scalar context before
11865 it is passed back to Exim to be inserted into the expanded string. If the
11866 return value is &'undef'&, the expansion is forced to fail in the same way as
11867 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
11868 by obeying Perl's &%die%& function, the expansion fails with the error message
11869 that was passed to &%die%&.
11870
11871
11872 .section "Calling Exim functions from Perl" "SECID87"
11873 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
11874 is available to call back into Exim's string expansion function. For example,
11875 the Perl code
11876 .code
11877 my $lp = Exim::expand_string('$local_part');
11878 .endd
11879 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
11880 Note those are single quotes and not double quotes to protect against
11881 &$local_part$& being interpolated as a Perl variable.
11882
11883 If the string expansion is forced to fail by a &"fail"& item, the result of
11884 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
11885 expansion string, the Perl call from the original expansion string fails with
11886 an appropriate error message, in the same way as if &%die%& were used.
11887
11888 .cindex "debugging" "from embedded Perl"
11889 .cindex "log" "writing from embedded Perl"
11890 Two other Exim functions are available for use from within Perl code.
11891 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
11892 debugging is enabled. If you want a newline at the end, you must supply it.
11893 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
11894 timestamp. In this case, you should not supply a terminating newline.
11895
11896
11897 .section "Use of standard output and error by Perl" "SECID88"
11898 .cindex "Perl" "standard output and error"
11899 You should not write to the standard error or output streams from within your
11900 Perl code, as it is not defined how these are set up. In versions of Exim
11901 before 4.50, it is possible for the standard output or error to refer to the
11902 SMTP connection during message reception via the daemon. Writing to this stream
11903 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
11904 error streams are connected to &_/dev/null_& in the daemon. The chaos is
11905 avoided, but the output is lost.
11906
11907 .cindex "Perl" "use of &%warn%&"
11908 The Perl &%warn%& statement writes to the standard error stream by default.
11909 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
11910 you have no control. When Exim starts up the Perl interpreter, it arranges for
11911 output from the &%warn%& statement to be written to the Exim main log. You can
11912 change this by including appropriate Perl magic somewhere in your Perl code.
11913 For example, to discard &%warn%& output completely, you need this:
11914 .code
11915 $SIG{__WARN__} = sub { };
11916 .endd
11917 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
11918 example, the code for the subroutine is empty, so it does nothing, but you can
11919 include any Perl code that you like. The text of the &%warn%& message is passed
11920 as the first subroutine argument.
11921 .ecindex IIDperl
11922
11923
11924 . ////////////////////////////////////////////////////////////////////////////
11925 . ////////////////////////////////////////////////////////////////////////////
11926
11927 .chapter "Starting the daemon and the use of network interfaces" &&&
11928          "CHAPinterfaces" &&&
11929          "Starting the daemon"
11930 .cindex "daemon" "starting"
11931 .cindex "interface" "listening"
11932 .cindex "network interface"
11933 .cindex "interface" "network"
11934 .cindex "IP address" "for listening"
11935 .cindex "daemon" "listening IP addresses"
11936 .cindex "TCP/IP" "setting listening interfaces"
11937 .cindex "TCP/IP" "setting listening ports"
11938 A host that is connected to a TCP/IP network may have one or more physical
11939 hardware network interfaces. Each of these interfaces may be configured as one
11940 or more &"logical"& interfaces, which are the entities that a program actually
11941 works with. Each of these logical interfaces is associated with an IP address.
11942 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
11943 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
11944 knowledge about the host's interfaces for use in three different circumstances:
11945
11946 .olist
11947 When a listening daemon is started, Exim needs to know which interfaces
11948 and ports to listen on.
11949 .next
11950 When Exim is routing an address, it needs to know which IP addresses
11951 are associated with local interfaces. This is required for the correct
11952 processing of MX lists by removing the local host and others with the
11953 same or higher priority values. Also, Exim needs to detect cases
11954 when an address is routed to an IP address that in fact belongs to the
11955 local host. Unless the &%self%& router option or the &%allow_localhost%&
11956 option of the smtp transport is set (as appropriate), this is treated
11957 as an error situation.
11958 .next
11959 When Exim connects to a remote host, it may need to know which interface to use
11960 for the outgoing connection.
11961 .endlist
11962
11963
11964 Exim's default behaviour is likely to be appropriate in the vast majority
11965 of cases. If your host has only one interface, and you want all its IP
11966 addresses to be treated in the same way, and you are using only the
11967 standard SMTP port, you should not need to take any special action. The
11968 rest of this chapter does not apply to you.
11969
11970 In a more complicated situation you may want to listen only on certain
11971 interfaces, or on different ports, and for this reason there are a number of
11972 options that can be used to influence Exim's behaviour. The rest of this
11973 chapter describes how they operate.
11974
11975 When a message is received over TCP/IP, the interface and port that were
11976 actually used are set in &$received_ip_address$& and &$received_port$&.
11977
11978
11979
11980 .section "Starting a listening daemon" "SECID89"
11981 When a listening daemon is started (by means of the &%-bd%& command line
11982 option), the interfaces and ports on which it listens are controlled by the
11983 following options:
11984
11985 .ilist
11986 &%daemon_smtp_ports%& contains a list of default ports. (For backward
11987 compatibility, this option can also be specified in the singular.)
11988 .next
11989 &%local_interfaces%& contains list of interface IP addresses on which to
11990 listen. Each item may optionally also specify a port.
11991 .endlist
11992
11993 The default list separator in both cases is a colon, but this can be changed as
11994 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
11995 it is usually best to change the separator to avoid having to double all the
11996 colons. For example:
11997 .code
11998 local_interfaces = <; 127.0.0.1 ; \
11999                       192.168.23.65 ; \
12000                       ::1 ; \
12001                       3ffe:ffff:836f::fe86:a061
12002 .endd
12003 There are two different formats for specifying a port along with an IP address
12004 in &%local_interfaces%&:
12005
12006 .olist
12007 The port is added onto the address with a dot separator. For example, to listen
12008 on port 1234 on two different IP addresses:
12009 .code
12010 local_interfaces = <; 192.168.23.65.1234 ; \
12011                       3ffe:ffff:836f::fe86:a061.1234
12012 .endd
12013 .next
12014 The IP address is enclosed in square brackets, and the port is added
12015 with a colon separator, for example:
12016 .code
12017 local_interfaces = <; [192.168.23.65]:1234 ; \
12018                       [3ffe:ffff:836f::fe86:a061]:1234
12019 .endd
12020 .endlist
12021
12022 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
12023 default setting contains just one port:
12024 .code
12025 daemon_smtp_ports = smtp
12026 .endd
12027 If more than one port is listed, each interface that does not have its own port
12028 specified listens on all of them. Ports that are listed in
12029 &%daemon_smtp_ports%& can be identified either by name (defined in
12030 &_/etc/services_&) or by number. However, when ports are given with individual
12031 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
12032
12033
12034
12035 .section "Special IP listening addresses" "SECID90"
12036 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
12037 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
12038 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
12039 instead of setting up separate listening sockets for each interface. The
12040 default value of &%local_interfaces%& is
12041 .code
12042 local_interfaces = 0.0.0.0
12043 .endd
12044 when Exim is built without IPv6 support; otherwise it is:
12045 .code
12046 local_interfaces = <; ::0 ; 0.0.0.0
12047 .endd
12048 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
12049
12050
12051
12052 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
12053 The &%-oX%& command line option can be used to override the values of
12054 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
12055 instance. Another way of doing this would be to use macros and the &%-D%&
12056 option. However, &%-oX%& can be used by any admin user, whereas modification of
12057 the runtime configuration by &%-D%& is allowed only when the caller is root or
12058 exim.
12059
12060 The value of &%-oX%& is a list of items. The default colon separator can be
12061 changed in the usual way if required. If there are any items that do not
12062 contain dots or colons (that is, are not IP addresses), the value of
12063 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
12064 items that do contain dots or colons, the value of &%local_interfaces%& is
12065 replaced by those items. Thus, for example,
12066 .code
12067 -oX 1225
12068 .endd
12069 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
12070 whereas
12071 .code
12072 -oX 192.168.34.5.1125
12073 .endd
12074 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
12075 (However, since &%local_interfaces%& now contains no items without ports, the
12076 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
12077
12078
12079
12080 .section "Support for the obsolete SSMTP (or SMTPS) protocol" "SECTsupobssmt"
12081 .cindex "ssmtp protocol"
12082 .cindex "smtps protocol"
12083 .cindex "SMTP" "ssmtp protocol"
12084 .cindex "SMTP" "smtps protocol"
12085 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
12086 before the STARTTLS command was standardized for SMTP. Some legacy clients
12087 still use this protocol. If the &%tls_on_connect_ports%& option is set to a
12088 list of port numbers, connections to those ports must use SSMTP. The most
12089 common use of this option is expected to be
12090 .code
12091 tls_on_connect_ports = 465
12092 .endd
12093 because 465 is the usual port number used by the legacy clients. There is also
12094 a command line option &%-tls-on-connect%&, which forces all ports to behave in
12095 this way when a daemon is started.
12096
12097 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
12098 daemon to listen on those ports. You must still specify them in
12099 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
12100 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
12101 connections via the daemon.)
12102
12103
12104
12105
12106 .section "IPv6 address scopes" "SECID92"
12107 .cindex "IPv6" "address scopes"
12108 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
12109 can, in principle, have the same link-local IPv6 address on different
12110 interfaces. Thus, additional information is needed, over and above the IP
12111 address, to distinguish individual interfaces. A convention of using a
12112 percent sign followed by something (often the interface name) has been
12113 adopted in some cases, leading to addresses like this:
12114 .code
12115 fe80::202:b3ff:fe03:45c1%eth0
12116 .endd
12117 To accommodate this usage, a percent sign followed by an arbitrary string is
12118 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
12119 to convert a textual IPv6 address for actual use. This function recognizes the
12120 percent convention in operating systems that support it, and it processes the
12121 address appropriately. Unfortunately, some older libraries have problems with
12122 &[getaddrinfo()]&. If
12123 .code
12124 IPV6_USE_INET_PTON=yes
12125 .endd
12126 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
12127 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
12128 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
12129 function.) Of course, this means that the additional functionality of
12130 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
12131
12132 .section "Disabling IPv6" "SECID93"
12133 .cindex "IPv6" "disabling"
12134 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
12135 run on a host whose kernel does not support IPv6. The binary will fall back to
12136 using IPv4, but it may waste resources looking up AAAA records, and trying to
12137 connect to IPv6 addresses, causing delays to mail delivery. If you set the
12138 .oindex "&%disable_ipv6%&"
12139 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
12140 activities take place. AAAA records are never looked up, and any IPv6 addresses
12141 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
12142 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
12143 to handle IPv6 literal addresses.
12144
12145 On the other hand, when IPv6 is in use, there may be times when you want to
12146 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
12147 option to globally suppress the lookup of AAAA records for specified domains,
12148 and you can use the &%ignore_target_hosts%& generic router option to ignore
12149 IPv6 addresses in an individual router.
12150
12151
12152
12153 .section "Examples of starting a listening daemon" "SECID94"
12154 The default case in an IPv6 environment is
12155 .code
12156 daemon_smtp_ports = smtp
12157 local_interfaces = <; ::0 ; 0.0.0.0
12158 .endd
12159 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
12160 Either one or two sockets may be used, depending on the characteristics of
12161 the TCP/IP stack. (This is complicated and messy; for more information,
12162 read the comments in the &_daemon.c_& source file.)
12163
12164 To specify listening on ports 25 and 26 on all interfaces:
12165 .code
12166 daemon_smtp_ports = 25 : 26
12167 .endd
12168 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
12169 .code
12170 local_interfaces = <; ::0.25     ; ::0.26 \
12171                       0.0.0.0.25 ; 0.0.0.0.26
12172 .endd
12173 To listen on the default port on all IPv4 interfaces, and on port 26 on the
12174 IPv4 loopback address only:
12175 .code
12176 local_interfaces = 0.0.0.0 : 127.0.0.1.26
12177 .endd
12178 To specify listening on the default port on specific interfaces only:
12179 .code
12180 local_interfaces = 192.168.34.67 : 192.168.34.67
12181 .endd
12182 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
12183
12184
12185
12186 .section "Recognizing the local host" "SECTreclocipadd"
12187 The &%local_interfaces%& option is also used when Exim needs to determine
12188 whether or not an IP address refers to the local host. That is, the IP
12189 addresses of all the interfaces on which a daemon is listening are always
12190 treated as local.
12191
12192 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
12193 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
12194 available interfaces from the operating system, and extracts the relevant
12195 (that is, IPv4 or IPv6) addresses to use for checking.
12196
12197 Some systems set up large numbers of virtual interfaces in order to provide
12198 many virtual web servers. In this situation, you may want to listen for
12199 email on only a few of the available interfaces, but nevertheless treat all
12200 interfaces as local when routing. You can do this by setting
12201 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
12202 &"all"& wildcard values. These addresses are recognized as local, but are not
12203 used for listening. Consider this example:
12204 .code
12205 local_interfaces = <; 127.0.0.1 ; ::1 ; \
12206                       192.168.53.235 ; \
12207                       3ffe:2101:12:1:a00:20ff:fe86:a061
12208
12209 extra_local_interfaces = <; ::0 ; 0.0.0.0
12210 .endd
12211 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
12212 address, but all available interface addresses are treated as local when
12213 Exim is routing.
12214
12215 In some environments the local host name may be in an MX list, but with an IP
12216 address that is not assigned to any local interface. In other cases it may be
12217 desirable to treat other host names as if they referred to the local host. Both
12218 these cases can be handled by setting the &%hosts_treat_as_local%& option.
12219 This contains host names rather than IP addresses. When a host is referenced
12220 during routing, either via an MX record or directly, it is treated as the local
12221 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
12222 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
12223
12224
12225
12226 .section "Delivering to a remote host" "SECID95"
12227 Delivery to a remote host is handled by the smtp transport. By default, it
12228 allows the system's TCP/IP functions to choose which interface to use (if
12229 there is more than one) when connecting to a remote host. However, the
12230 &%interface%& option can be set to specify which interface is used. See the
12231 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
12232 details.
12233
12234
12235
12236
12237 . ////////////////////////////////////////////////////////////////////////////
12238 . ////////////////////////////////////////////////////////////////////////////
12239
12240 .chapter "Main configuration" "CHAPmainconfig"
12241 .scindex IIDconfima "configuration file" "main section"
12242 .scindex IIDmaiconf "main configuration"
12243 The first part of the run time configuration file contains three types of item:
12244
12245 .ilist
12246 Macro definitions: These lines start with an upper case letter. See section
12247 &<<SECTmacrodefs>>& for details of macro processing.
12248 .next
12249 Named list definitions: These lines start with one of the words &"domainlist"&,
12250 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
12251 section &<<SECTnamedlists>>&.
12252 .next
12253 Main configuration settings: Each setting occupies one line of the file
12254 (with possible continuations). If any setting is preceded by the word
12255 &"hide"&, the &%-bP%& command line option displays its value to admin users
12256 only. See section &<<SECTcos>>& for a description of the syntax of these option
12257 settings.
12258 .endlist
12259
12260 This chapter specifies all the main configuration options, along with their
12261 types and default values. For ease of finding a particular option, they appear
12262 in alphabetical order in section &<<SECTalomo>>& below. However, because there
12263 are now so many options, they are first listed briefly in functional groups, as
12264 an aid to finding the name of the option you are looking for. Some options are
12265 listed in more than one group.
12266
12267 .section "Miscellaneous" "SECID96"
12268 .table2
12269 .row &%bi_command%&                  "to run for &%-bi%& command line option"
12270 .row &%disable_ipv6%&                "do no IPv6 processing"
12271 .row &%keep_malformed%&              "for broken files &-- should not happen"
12272 .row &%localhost_number%&            "for unique message ids in clusters"
12273 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
12274 .row &%message_body_visible%&        "how much to show in &$message_body$&"
12275 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
12276 .row &%print_topbitchars%&           "top-bit characters are printing"
12277 .row &%timezone%&                    "force time zone"
12278 .endtable
12279
12280
12281 .section "Exim parameters" "SECID97"
12282 .table2
12283 .row &%exim_group%&                  "override compiled-in value"
12284 .row &%exim_path%&                   "override compiled-in value"
12285 .row &%exim_user%&                   "override compiled-in value"
12286 .row &%primary_hostname%&            "default from &[uname()]&"
12287 .row &%split_spool_directory%&       "use multiple directories"
12288 .row &%spool_directory%&             "override compiled-in value"
12289 .endtable
12290
12291
12292
12293 .section "Privilege controls" "SECID98"
12294 .table2
12295 .row &%admin_groups%&                "groups that are Exim admin users"
12296 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
12297 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
12298 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
12299 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
12300 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
12301 .row &%never_users%&                 "do not run deliveries as these"
12302 .row &%prod_requires_admin%&         "forced delivery requires admin user"
12303 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
12304 .row &%trusted_groups%&              "groups that are trusted"
12305 .row &%trusted_users%&               "users that are trusted"
12306 .endtable
12307
12308
12309
12310 .section "Logging" "SECID99"
12311 .table2
12312 .row &%hosts_connection_nolog%&      "exemption from connect logging"
12313 .row &%log_file_path%&               "override compiled-in value"
12314 .row &%log_selector%&                "set/unset optional logging"
12315 .row &%log_timezone%&                "add timezone to log lines"
12316 .row &%message_logs%&                "create per-message logs"
12317 .row &%preserve_message_logs%&       "after message completion"
12318 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
12319 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
12320 .row &%syslog_facility%&             "set syslog &""facility""& field"
12321 .row &%syslog_processname%&          "set syslog &""ident""& field"
12322 .row &%syslog_timestamp%&            "timestamp syslog lines"
12323 .row &%write_rejectlog%&             "control use of message log"
12324 .endtable
12325
12326
12327
12328 .section "Frozen messages" "SECID100"
12329 .table2
12330 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
12331 .row &%freeze_tell%&                 "send message when freezing"
12332 .row &%move_frozen_messages%&        "to another directory"
12333 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
12334 .endtable
12335
12336
12337
12338 .section "Data lookups" "SECID101"
12339 .table2
12340 .row &%ibase_servers%&               "InterBase servers"
12341 .row &%ldap_default_servers%&        "used if no server in query"
12342 .row &%ldap_version%&                "set protocol version"
12343 .row &%lookup_open_max%&             "lookup files held open"
12344 .row &%mysql_servers%&               "default MySQL servers"
12345 .row &%oracle_servers%&              "Oracle servers"
12346 .row &%pgsql_servers%&               "default PostgreSQL servers"
12347 .row &%sqlite_lock_timeout%&         "as it says"
12348 .endtable
12349
12350
12351
12352 .section "Message ids" "SECID102"
12353 .table2
12354 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
12355 .row &%message_id_header_text%&      "ditto"
12356 .endtable
12357
12358
12359
12360 .section "Embedded Perl Startup" "SECID103"
12361 .table2
12362 .row &%perl_at_start%&               "always start the interpreter"
12363 .row &%perl_startup%&                "code to obey when starting Perl"
12364 .endtable
12365
12366
12367
12368 .section "Daemon" "SECID104"
12369 .table2
12370 .row &%daemon_smtp_ports%&           "default ports"
12371 .row &%daemon_startup_retries%&      "number of times to retry"
12372 .row &%daemon_startup_sleep%&        "time to sleep between tries"
12373 .row &%extra_local_interfaces%&      "not necessarily listened on"
12374 .row &%local_interfaces%&            "on which to listen, with optional ports"
12375 .row &%pid_file_path%&               "override compiled-in value"
12376 .row &%queue_run_max%&               "maximum simultaneous queue runners"
12377 .endtable
12378
12379
12380
12381 .section "Resource control" "SECID105"
12382 .table2
12383 .row &%check_log_inodes%&            "before accepting a message"
12384 .row &%check_log_space%&             "before accepting a message"
12385 .row &%check_spool_inodes%&          "before accepting a message"
12386 .row &%check_spool_space%&           "before accepting a message"
12387 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
12388 .row &%queue_only_load%&             "queue incoming if load high"
12389 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
12390 .row &%queue_run_max%&               "maximum simultaneous queue runners"
12391 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
12392 .row &%smtp_accept_max%&             "simultaneous incoming connections"
12393 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
12394 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
12395 .row &%smtp_accept_max_per_connection%& "messages per connection"
12396 .row &%smtp_accept_max_per_host%&    "connections from one host"
12397 .row &%smtp_accept_queue%&           "queue mail if more connections"
12398 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
12399                                            connection"
12400 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
12401 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
12402 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
12403 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
12404 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
12405 .endtable
12406
12407
12408
12409 .section "Policy controls" "SECID106"
12410 .table2
12411 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
12412 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
12413 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
12414 .row &%acl_smtp_auth%&               "ACL for AUTH"
12415 .row &%acl_smtp_connect%&            "ACL for connection"
12416 .row &%acl_smtp_data%&               "ACL for DATA"
12417 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
12418 .row &%acl_smtp_etrn%&               "ACL for ETRN"
12419 .row &%acl_smtp_expn%&               "ACL for EXPN"
12420 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
12421 .row &%acl_smtp_mail%&               "ACL for MAIL"
12422 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
12423 .row &%acl_smtp_mime%&               "ACL for MIME parts"
12424 .row &%acl_smtp_predata%&            "ACL for start of data"
12425 .row &%acl_smtp_quit%&               "ACL for QUIT"
12426 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
12427 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
12428 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
12429 .row &%av_scanner%&                  "specify virus scanner"
12430 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
12431                                       words""&"
12432 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
12433 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
12434 .row &%header_maxsize%&              "total size of message header"
12435 .row &%header_line_maxsize%&         "individual header line limit"
12436 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
12437 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
12438 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
12439 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
12440 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
12441 .row &%host_lookup%&                 "host name looked up for these hosts"
12442 .row &%host_lookup_order%&           "order of DNS and local name lookups"
12443 .row &%host_reject_connection%&      "reject connection from these hosts"
12444 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
12445 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
12446 .row &%message_size_limit%&          "for all messages"
12447 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
12448 .row &%spamd_address%&               "set interface to SpamAssassin"
12449 .row &%strict_acl_vars%&             "object to unset ACL variables"
12450 .endtable
12451
12452
12453
12454 .section "Callout cache" "SECID107"
12455 .table2
12456 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
12457                                          item"
12458 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
12459                                          item"
12460 .row &%callout_negative_expire%&     "timeout for negative address cache item"
12461 .row &%callout_positive_expire%&     "timeout for positive address cache item"
12462 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
12463 .endtable
12464
12465
12466
12467 .section "TLS" "SECID108"
12468 .table2
12469 .row &%gnutls_require_kx%&           "control GnuTLS key exchanges"
12470 .row &%gnutls_require_mac%&          "control GnuTLS MAC algorithms"
12471 .row &%gnutls_require_protocols%&    "control GnuTLS protocols"
12472 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
12473 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
12474 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
12475 .row &%tls_certificate%&             "location of server certificate"
12476 .row &%tls_crl%&                     "certificate revocation list"
12477 .row &%tls_dhparam%&                 "DH parameters for server"
12478 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
12479 .row &%tls_privatekey%&              "location of server private key"
12480 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
12481 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
12482 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
12483 .row &%tls_verify_certificates%&     "expected client certificates"
12484 .row &%tls_verify_hosts%&            "insist on client certificate verify"
12485 .endtable
12486
12487
12488
12489 .section "Local user handling" "SECID109"
12490 .table2
12491 .row &%finduser_retries%&            "useful in NIS environments"
12492 .row &%gecos_name%&                  "used when creating &'Sender:'&"
12493 .row &%gecos_pattern%&               "ditto"
12494 .row &%max_username_length%&         "for systems that truncate"
12495 .row &%unknown_login%&               "used when no login name found"
12496 .row &%unknown_username%&            "ditto"
12497 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
12498 .row &%uucp_from_sender%&            "ditto"
12499 .endtable
12500
12501
12502
12503 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
12504 .table2
12505 .row &%header_maxsize%&              "total size of message header"
12506 .row &%header_line_maxsize%&         "individual header line limit"
12507 .row &%message_size_limit%&          "applies to all messages"
12508 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
12509 .row &%received_header_text%&        "expanded to make &'Received:'&"
12510 .row &%received_headers_max%&        "for mail loop detection"
12511 .row &%recipients_max%&              "limit per message"
12512 .row &%recipients_max_reject%&       "permanently reject excess recipients"
12513 .endtable
12514
12515
12516
12517
12518 .section "Non-SMTP incoming messages" "SECID111"
12519 .table2
12520 .row &%receive_timeout%&             "for non-SMTP messages"
12521 .endtable
12522
12523
12524
12525
12526
12527 .section "Incoming SMTP messages" "SECID112"
12528 See also the &'Policy controls'& section above.
12529
12530 .table2
12531 .row &%host_lookup%&                 "host name looked up for these hosts"
12532 .row &%host_lookup_order%&           "order of DNS and local name lookups"
12533 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
12534 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
12535 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
12536 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
12537 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
12538 .row &%smtp_accept_max%&             "simultaneous incoming connections"
12539 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
12540 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
12541 .row &%smtp_accept_max_per_connection%& "messages per connection"
12542 .row &%smtp_accept_max_per_host%&    "connections from one host"
12543 .row &%smtp_accept_queue%&           "queue mail if more connections"
12544 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
12545                                            connection"
12546 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
12547 .row &%smtp_active_hostname%&        "host name to use in messages"
12548 .row &%smtp_banner%&                 "text for welcome banner"
12549 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
12550 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
12551 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
12552 .row &%smtp_etrn_command%&           "what to run for ETRN"
12553 .row &%smtp_etrn_serialize%&         "only one at once"
12554 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
12555 .row &%smtp_max_unknown_commands%&   "before dropping connection"
12556 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
12557 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
12558 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
12559 .row &%smtp_receive_timeout%&        "per command or data line"
12560 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
12561 .row &%smtp_return_error_details%&   "give detail on rejections"
12562 .endtable
12563
12564
12565
12566 .section "SMTP extensions" "SECID113"
12567 .table2
12568 .row &%accept_8bitmime%&             "advertise 8BITMIME"
12569 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
12570 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
12571 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
12572 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
12573 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
12574 .endtable
12575
12576
12577
12578 .section "Processing messages" "SECID114"
12579 .table2
12580 .row &%allow_domain_literals%&       "recognize domain literal syntax"
12581 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
12582 .row &%allow_utf8_domains%&          "in addresses"
12583 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
12584                                       words""&"
12585 .row &%delivery_date_remove%&        "from incoming messages"
12586 .row &%envelope_to_remove%&          "from incoming messages"
12587 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
12588 .row &%headers_charset%&             "default for translations"
12589 .row &%qualify_domain%&              "default for senders"
12590 .row &%qualify_recipient%&           "default for recipients"
12591 .row &%return_path_remove%&          "from incoming messages"
12592 .row &%strip_excess_angle_brackets%& "in addresses"
12593 .row &%strip_trailing_dot%&          "at end of addresses"
12594 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
12595 .endtable
12596
12597
12598
12599 .section "System filter" "SECID115"
12600 .table2
12601 .row &%system_filter%&               "locate system filter"
12602 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
12603                                             directory"
12604 .row &%system_filter_file_transport%& "transport for delivery to a file"
12605 .row &%system_filter_group%&         "group for filter running"
12606 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
12607 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
12608 .row &%system_filter_user%&          "user for filter running"
12609 .endtable
12610
12611
12612
12613 .section "Routing and delivery" "SECID116"
12614 .table2
12615 .row &%disable_ipv6%&                "do no IPv6 processing"
12616 .row &%dns_again_means_nonexist%&    "for broken domains"
12617 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
12618 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
12619 .row &%dns_retrans%&                 "parameter for resolver"
12620 .row &%dns_retry%&                   "parameter for resolver"
12621 .row &%hold_domains%&                "hold delivery for these domains"
12622 .row &%local_interfaces%&            "for routing checks"
12623 .row &%queue_domains%&               "no immediate delivery for these"
12624 .row &%queue_only%&                  "no immediate delivery at all"
12625 .row &%queue_only_file%&             "no immediate delivery if file exists"
12626 .row &%queue_only_load%&             "no immediate delivery if load is high"
12627 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
12628 .row &%queue_only_override%&         "allow command line to override"
12629 .row &%queue_run_in_order%&          "order of arrival"
12630 .row &%queue_run_max%&               "of simultaneous queue runners"
12631 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
12632 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
12633 .row &%remote_sort_domains%&         "order of remote deliveries"
12634 .row &%retry_data_expire%&           "timeout for retry data"
12635 .row &%retry_interval_max%&          "safety net for retry rules"
12636 .endtable
12637
12638
12639
12640 .section "Bounce and warning messages" "SECID117"
12641 .table2
12642 .row &%bounce_message_file%&         "content of bounce"
12643 .row &%bounce_message_text%&         "content of bounce"
12644 .row &%bounce_return_body%&          "include body if returning message"
12645 .row &%bounce_return_message%&       "include original message in bounce"
12646 .row &%bounce_return_size_limit%&    "limit on returned message"
12647 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
12648 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
12649 .row &%errors_copy%&                 "copy bounce messages"
12650 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
12651 .row &%delay_warning%&               "time schedule"
12652 .row &%delay_warning_condition%&     "condition for warning messages"
12653 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
12654 .row &%smtp_return_error_details%&   "give detail on rejections"
12655 .row &%warn_message_file%&           "content of warning message"
12656 .endtable
12657
12658
12659
12660 .section "Alphabetical list of main options" "SECTalomo"
12661 Those options that undergo string expansion before use are marked with
12662 &dagger;.
12663
12664 .option accept_8bitmime main boolean false
12665 .cindex "8BITMIME"
12666 .cindex "8-bit characters"
12667 This option causes Exim to send 8BITMIME in its response to an SMTP
12668 EHLO command, and to accept the BODY= parameter on MAIL commands.
12669 However, though Exim is 8-bit clean, it is not a protocol converter, and it
12670 takes no steps to do anything special with messages received by this route.
12671 Consequently, this option is turned off by default.
12672
12673 .option acl_not_smtp main string&!! unset
12674 .cindex "&ACL;" "for non-SMTP messages"
12675 .cindex "non-SMTP messages" "ACLs for"
12676 This option defines the ACL that is run when a non-SMTP message has been
12677 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
12678 further details.
12679
12680 .option acl_not_smtp_mime main string&!! unset
12681 This option defines the ACL that is run for individual MIME parts of non-SMTP
12682 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
12683 SMTP messages.
12684
12685 .option acl_not_smtp_start main string&!! unset
12686 .cindex "&ACL;" "at start of non-SMTP message"
12687 .cindex "non-SMTP messages" "ACLs for"
12688 This option defines the ACL that is run before Exim starts reading a
12689 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
12690
12691 .option acl_smtp_auth main string&!! unset
12692 .cindex "&ACL;" "setting up for SMTP commands"
12693 .cindex "AUTH" "ACL for"
12694 This option defines the ACL that is run when an SMTP AUTH command is
12695 received. See chapter &<<CHAPACL>>& for further details.
12696
12697 .option acl_smtp_connect main string&!! unset
12698 .cindex "&ACL;" "on SMTP connection"
12699 This option defines the ACL that is run when an SMTP connection is received.
12700 See chapter &<<CHAPACL>>& for further details.
12701
12702 .option acl_smtp_data main string&!! unset
12703 .cindex "DATA" "ACL for"
12704 This option defines the ACL that is run after an SMTP DATA command has been
12705 processed and the message itself has been received, but before the final
12706 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
12707
12708 .option acl_smtp_etrn main string&!! unset
12709 .cindex "ETRN" "ACL for"
12710 This option defines the ACL that is run when an SMTP ETRN command is
12711 received. See chapter &<<CHAPACL>>& for further details.
12712
12713 .option acl_smtp_expn main string&!! unset
12714 .cindex "EXPN" "ACL for"
12715 This option defines the ACL that is run when an SMTP EXPN command is
12716 received. See chapter &<<CHAPACL>>& for further details.
12717
12718 .option acl_smtp_helo main string&!! unset
12719 .cindex "EHLO" "ACL for"
12720 .cindex "HELO" "ACL for"
12721 This option defines the ACL that is run when an SMTP EHLO or HELO
12722 command is received. See chapter &<<CHAPACL>>& for further details.
12723
12724
12725 .option acl_smtp_mail main string&!! unset
12726 .cindex "MAIL" "ACL for"
12727 This option defines the ACL that is run when an SMTP MAIL command is
12728 received. See chapter &<<CHAPACL>>& for further details.
12729
12730 .option acl_smtp_mailauth main string&!! unset
12731 .cindex "AUTH" "on MAIL command"
12732 This option defines the ACL that is run when there is an AUTH parameter on
12733 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
12734 &<<CHAPSMTPAUTH>>& for details of authentication.
12735
12736 .option acl_smtp_mime main string&!! unset
12737 .cindex "MIME content scanning" "ACL for"
12738 This option is available when Exim is built with the content-scanning
12739 extension. It defines the ACL that is run for each MIME part in a message. See
12740 section &<<SECTscanmimepart>>& for details.
12741
12742 .option acl_smtp_predata main string&!! unset
12743 This option defines the ACL that is run when an SMTP DATA command is
12744 received, before the message itself is received. See chapter &<<CHAPACL>>& for
12745 further details.
12746
12747 .option acl_smtp_quit main string&!! unset
12748 .cindex "QUIT, ACL for"
12749 This option defines the ACL that is run when an SMTP QUIT command is
12750 received. See chapter &<<CHAPACL>>& for further details.
12751
12752 .option acl_smtp_rcpt main string&!! unset
12753 .cindex "RCPT" "ACL for"
12754 This option defines the ACL that is run when an SMTP RCPT command is
12755 received. See chapter &<<CHAPACL>>& for further details.
12756
12757 .option acl_smtp_starttls main string&!! unset
12758 .cindex "STARTTLS, ACL for"
12759 This option defines the ACL that is run when an SMTP STARTTLS command is
12760 received. See chapter &<<CHAPACL>>& for further details.
12761
12762 .option acl_smtp_vrfy main string&!! unset
12763 .cindex "VRFY" "ACL for"
12764 This option defines the ACL that is run when an SMTP VRFY command is
12765 received. See chapter &<<CHAPACL>>& for further details.
12766
12767 .option admin_groups main "string list&!!" unset
12768 .cindex "admin user"
12769 This option is expanded just once, at the start of Exim's processing. If the
12770 current group or any of the supplementary groups of an Exim caller is in this
12771 colon-separated list, the caller has admin privileges. If all your system
12772 programmers are in a specific group, for example, you can give them all Exim
12773 admin privileges by putting that group in &%admin_groups%&. However, this does
12774 not permit them to read Exim's spool files (whose group owner is the Exim gid).
12775 To permit this, you have to add individuals to the Exim group.
12776
12777 .option allow_domain_literals main boolean false
12778 .cindex "domain literal"
12779 If this option is set, the RFC 2822 domain literal format is permitted in
12780 email addresses. The option is not set by default, because the domain literal
12781 format is not normally required these days, and few people know about it. It
12782 has, however, been exploited by mail abusers.
12783
12784 Unfortunately, it seems that some DNS black list maintainers are using this
12785 format to report black listing to postmasters. If you want to accept messages
12786 addressed to your hosts by IP address, you need to set
12787 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
12788 domains (defined in the named domain list &%local_domains%& in the default
12789 configuration). This &"magic string"& matches the domain literal form of all
12790 the local host's IP addresses.
12791
12792
12793 .option allow_mx_to_ip main boolean false
12794 .cindex "MX record" "pointing to IP address"
12795 It appears that more and more DNS zone administrators are breaking the rules
12796 and putting domain names that look like IP addresses on the right hand side of
12797 MX records. Exim follows the rules and rejects this, giving an error message
12798 that explains the mis-configuration. However, some other MTAs support this
12799 practice, so to avoid &"Why can't Exim do this?"& complaints,
12800 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
12801 recommended, except when you have no other choice.
12802
12803 .option allow_utf8_domains main boolean false
12804 .cindex "domain" "UTF-8 characters in"
12805 .cindex "UTF-8" "in domain name"
12806 Lots of discussion is going on about internationalized domain names. One
12807 camp is strongly in favour of just using UTF-8 characters, and it seems
12808 that at least two other MTAs permit this. This option allows Exim users to
12809 experiment if they wish.
12810
12811 If it is set true, Exim's domain parsing function allows valid
12812 UTF-8 multicharacters to appear in domain name components, in addition to
12813 letters, digits, and hyphens. However, just setting this option is not
12814 enough; if you want to look up these domain names in the DNS, you must also
12815 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
12816 suitable setting is:
12817 .code
12818 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
12819   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
12820 .endd
12821 Alternatively, you can just disable this feature by setting
12822 .code
12823 dns_check_names_pattern =
12824 .endd
12825 That is, set the option to an empty string so that no check is done.
12826
12827
12828 .option auth_advertise_hosts main "host list&!!" *
12829 .cindex "authentication" "advertising"
12830 .cindex "AUTH" "advertising"
12831 If any server authentication mechanisms are configured, Exim advertises them in
12832 response to an EHLO command only if the calling host matches this list.
12833 Otherwise, Exim does not advertise AUTH.
12834 Exim does not accept AUTH commands from clients to which it has not
12835 advertised the availability of AUTH. The advertising of individual
12836 authentication mechanisms can be controlled by the use of the
12837 &%server_advertise_condition%& generic authenticator option on the individual
12838 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
12839
12840 Certain mail clients (for example, Netscape) require the user to provide a name
12841 and password for authentication if AUTH is advertised, even though it may
12842 not be needed (the host may accept messages from hosts on its local LAN without
12843 authentication, for example). The &%auth_advertise_hosts%& option can be used
12844 to make these clients more friendly by excluding them from the set of hosts to
12845 which Exim advertises AUTH.
12846
12847 .cindex "AUTH" "advertising when encrypted"
12848 If you want to advertise the availability of AUTH only when the connection
12849 is encrypted using TLS, you can make use of the fact that the value of this
12850 option is expanded, with a setting like this:
12851 .code
12852 auth_advertise_hosts = ${if eq{$tls_cipher}{}{}{*}}
12853 .endd
12854 .vindex "&$tls_cipher$&"
12855 If &$tls_cipher$& is empty, the session is not encrypted, and the result of
12856 the expansion is empty, thus matching no hosts. Otherwise, the result of the
12857 expansion is *, which matches all hosts.
12858
12859
12860 .option auto_thaw main time 0s
12861 .cindex "thawing messages"
12862 .cindex "unfreezing messages"
12863 If this option is set to a time greater than zero, a queue runner will try a
12864 new delivery attempt on any frozen message, other than a bounce message, if
12865 this much time has passed since it was frozen. This may result in the message
12866 being re-frozen if nothing has changed since the last attempt. It is a way of
12867 saying &"keep on trying, even though there are big problems"&.
12868
12869 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
12870 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
12871 thought to be very useful any more, and its use should probably be avoided.
12872
12873 .option av_scanner main string "see below"
12874 This option is available if Exim is built with the content-scanning extension.
12875 It specifies which anti-virus scanner to use. The default value is:
12876 .code
12877 sophie:/var/run/sophie
12878 .endd
12879 If the value of &%av_scanner%& starts with a dollar character, it is expanded
12880 before use. See section &<<SECTscanvirus>>& for further details.
12881
12882
12883
12884 .option bi_command main string unset
12885 .oindex "&%-bi%&"
12886 This option supplies the name of a command that is run when Exim is called with
12887 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
12888 just the command name, it is not a complete command line. If an argument is
12889 required, it must come from the &%-oA%& command line option.
12890
12891
12892 .option bounce_message_file main string unset
12893 .cindex "bounce message" "customizing"
12894 .cindex "customizing" "bounce message"
12895 This option defines a template file containing paragraphs of text to be used
12896 for constructing bounce messages.  Details of the file's contents are given in
12897 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
12898
12899
12900 .option bounce_message_text main string unset
12901 When this option is set, its contents are included in the default bounce
12902 message immediately after &"This message was created automatically by mail
12903 delivery software."& It is not used if &%bounce_message_file%& is set.
12904
12905 .option bounce_return_body main boolean true
12906 .cindex "bounce message" "including body"
12907 This option controls whether the body of an incoming message is included in a
12908 bounce message when &%bounce_return_message%& is true. The default setting
12909 causes the entire message, both header and body, to be returned (subject to the
12910 value of &%bounce_return_size_limit%&). If this option is false, only the
12911 message header is included. In the case of a non-SMTP message containing an
12912 error that is detected during reception, only those header lines preceding the
12913 point at which the error was detected are returned.
12914 .cindex "bounce message" "including original"
12915
12916 .option bounce_return_message main boolean true
12917 If this option is set false, none of the original message is included in
12918 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
12919 &%bounce_return_body%&.
12920
12921
12922 .option bounce_return_size_limit main integer 100K
12923 .cindex "size" "of bounce, limit"
12924 .cindex "bounce message" "size limit"
12925 .cindex "limit" "bounce message size"
12926 This option sets a limit in bytes on the size of messages that are returned to
12927 senders as part of bounce messages when &%bounce_return_message%& is true. The
12928 limit should be less than the value of the global &%message_size_limit%& and of
12929 any &%message_size_limit%& settings on transports, to allow for the bounce text
12930 that Exim generates. If this option is set to zero there is no limit.
12931
12932 When the body of any message that is to be included in a bounce message is
12933 greater than the limit, it is truncated, and a comment pointing this out is
12934 added at the top. The actual cutoff may be greater than the value given, owing
12935 to the use of buffering for transferring the message in chunks (typically 8K in
12936 size). The idea is to save bandwidth on those undeliverable 15-megabyte
12937 messages.
12938
12939 .option bounce_sender_authentication main string unset
12940 .cindex "bounce message" "sender authentication"
12941 .cindex "authentication" "bounce message"
12942 .cindex "AUTH" "on bounce message"
12943 This option provides an authenticated sender address that is sent with any
12944 bounce messages generated by Exim that are sent over an authenticated SMTP
12945 connection. A typical setting might be:
12946 .code
12947 bounce_sender_authentication = mailer-daemon@my.domain.example
12948 .endd
12949 which would cause bounce messages to be sent using the SMTP command:
12950 .code
12951 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
12952 .endd
12953 The value of &%bounce_sender_authentication%& must always be a complete email
12954 address.
12955
12956 .option callout_domain_negative_expire main time 3h
12957 .cindex "caching" "callout timeouts"
12958 .cindex "callout" "caching timeouts"
12959 This option specifies the expiry time for negative callout cache data for a
12960 domain. See section &<<SECTcallver>>& for details of callout verification, and
12961 section &<<SECTcallvercache>>& for details of the caching.
12962
12963
12964 .option callout_domain_positive_expire main time 7d
12965 This option specifies the expiry time for positive callout cache data for a
12966 domain. See section &<<SECTcallver>>& for details of callout verification, and
12967 section &<<SECTcallvercache>>& for details of the caching.
12968
12969
12970 .option callout_negative_expire main time 2h
12971 This option specifies the expiry time for negative callout cache data for an
12972 address. See section &<<SECTcallver>>& for details of callout verification, and
12973 section &<<SECTcallvercache>>& for details of the caching.
12974
12975
12976 .option callout_positive_expire main time 24h
12977 This option specifies the expiry time for positive callout cache data for an
12978 address. See section &<<SECTcallver>>& for details of callout verification, and
12979 section &<<SECTcallvercache>>& for details of the caching.
12980
12981
12982 .option callout_random_local_part main string&!! "see below"
12983 This option defines the &"random"& local part that can be used as part of
12984 callout verification. The default value is
12985 .code
12986 $primary_host_name-$tod_epoch-testing
12987 .endd
12988 See section &<<CALLaddparcall>>& for details of how this value is used.
12989
12990
12991 .option check_log_inodes main integer 0
12992 See &%check_spool_space%& below.
12993
12994
12995 .option check_log_space main integer 0
12996 See &%check_spool_space%& below.
12997
12998 .oindex "&%check_rfc2047_length%&"
12999 .cindex "RFC 2047" "disabling length check"
13000 .option check_rfc2047_length main boolean true
13001 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
13002 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
13003 word; strings to be encoded that exceed this length are supposed to use
13004 multiple encoded words. By default, Exim does not recognize encoded words that
13005 exceed the maximum length. However, it seems that some software, in violation
13006 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
13007 set false, Exim recognizes encoded words of any length.
13008
13009
13010 .option check_spool_inodes main integer 0
13011 See &%check_spool_space%& below.
13012
13013
13014 .option check_spool_space main integer 0
13015 .cindex "checking disk space"
13016 .cindex "disk space, checking"
13017 .cindex "spool directory" "checking space"
13018 The four &%check_...%& options allow for checking of disk resources before a
13019 message is accepted.
13020
13021 .vindex "&$log_inodes$&"
13022 .vindex "&$log_space$&"
13023 .vindex "&$spool_inodes$&"
13024 .vindex "&$spool_space$&"
13025 When any of these options are set, they apply to all incoming messages. If you
13026 want to apply different checks to different kinds of message, you can do so by
13027 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
13028 &$spool_space$& in an ACL with appropriate additional conditions.
13029
13030
13031 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
13032 either value is greater than zero, for example:
13033 .code
13034 check_spool_space = 10M
13035 check_spool_inodes = 100
13036 .endd
13037 The spool partition is the one that contains the directory defined by
13038 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
13039 transit.
13040
13041 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
13042 files are written if either is greater than zero. These should be set only if
13043 &%log_file_path%& and &%spool_directory%& refer to different partitions.
13044
13045 If there is less space or fewer inodes than requested, Exim refuses to accept
13046 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
13047 error response to the MAIL command. If ESMTP is in use and there was a
13048 SIZE parameter on the MAIL command, its value is added to the
13049 &%check_spool_space%& value, and the check is performed even if
13050 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
13051
13052 The values for &%check_spool_space%& and &%check_log_space%& are held as a
13053 number of kilobytes. If a non-multiple of 1024 is specified, it is rounded up.
13054
13055 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
13056 failure a message is written to stderr and Exim exits with a non-zero code, as
13057 it obviously cannot send an error message of any kind.
13058
13059 .option daemon_smtp_ports main string &`smtp`&
13060 .cindex "port" "for daemon"
13061 .cindex "TCP/IP" "setting listening ports"
13062 This option specifies one or more default SMTP ports on which the Exim daemon
13063 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
13064 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
13065
13066 .option daemon_startup_retries main integer 9
13067 .cindex "daemon startup, retrying"
13068 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
13069 the daemon at startup when it cannot immediately bind a listening socket
13070 (typically because the socket is already in use): &%daemon_startup_retries%&
13071 defines the number of retries after the first failure, and
13072 &%daemon_startup_sleep%& defines the length of time to wait between retries.
13073
13074 .option daemon_startup_sleep main time 30s
13075 See &%daemon_startup_retries%&.
13076
13077 .option delay_warning main "time list" 24h
13078 .cindex "warning of delay"
13079 .cindex "delay warning, specifying"
13080 When a message is delayed, Exim sends a warning message to the sender at
13081 intervals specified by this option. The data is a colon-separated list of times
13082 after which to send warning messages. If the value of the option is an empty
13083 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
13084 message has been on the queue for longer than the last time, the last interval
13085 between the times is used to compute subsequent warning times. For example,
13086 with
13087 .code
13088 delay_warning = 4h:8h:24h
13089 .endd
13090 the first message is sent after 4 hours, the second after 8 hours, and
13091 the third one after 24 hours. After that, messages are sent every 16 hours,
13092 because that is the interval between the last two times on the list. If you set
13093 just one time, it specifies the repeat interval. For example, with:
13094 .code
13095 delay_warning = 6h
13096 .endd
13097 messages are repeated every six hours. To stop warnings after a given time, set
13098 a very large time at the end of the list. For example:
13099 .code
13100 delay_warning = 2h:12h:99d
13101 .endd
13102
13103 .option delay_warning_condition main string&!! "see below"
13104 .vindex "&$domain$&"
13105 The string is expanded at the time a warning message might be sent. If all the
13106 deferred addresses have the same domain, it is set in &$domain$& during the
13107 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
13108 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
13109 &"false"& (the comparison being done caselessly) then the warning message is
13110 not sent. The default is:
13111 .code
13112 delay_warning_condition = ${if or {\
13113   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
13114   { match{$h_precedence:}{(?i)bulk|list|junk} }\
13115   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
13116   } {no}{yes}}
13117 .endd
13118 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
13119 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
13120 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
13121 &"auto-replied"& in an &'Auto-Submitted:'& header.
13122
13123 .option deliver_drop_privilege main boolean false
13124 .cindex "unprivileged delivery"
13125 .cindex "delivery" "unprivileged"
13126 If this option is set true, Exim drops its root privilege at the start of a
13127 delivery process, and runs as the Exim user throughout. This severely restricts
13128 the kinds of local delivery that are possible, but is viable in certain types
13129 of configuration. There is a discussion about the use of root privilege in
13130 chapter &<<CHAPsecurity>>&.
13131
13132 .option deliver_queue_load_max main fixed-point unset
13133 .cindex "load average"
13134 .cindex "queue runner" "abandoning"
13135 When this option is set, a queue run is abandoned if the system load average
13136 becomes greater than the value of the option. The option has no effect on
13137 ancient operating systems on which Exim cannot determine the load average.
13138 See also &%queue_only_load%& and &%smtp_load_reserve%&.
13139
13140
13141 .option delivery_date_remove main boolean true
13142 .cindex "&'Delivery-date:'& header line"
13143 Exim's transports have an option for adding a &'Delivery-date:'& header to a
13144 message when it is delivered, in exactly the same way as &'Return-path:'& is
13145 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
13146 should not be present in incoming messages, and this option causes them to be
13147 removed at the time the message is received, to avoid any problems that might
13148 occur when a delivered message is subsequently sent on to some other recipient.
13149
13150 .option disable_fsync main boolean false
13151 .cindex "&[fsync()]&, disabling"
13152 This option is available only if Exim was built with the compile-time option
13153 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
13154 a runtime configuration generates an &"unknown option"& error. You should not
13155 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
13156 really, really, really understand what you are doing. &'No pre-compiled
13157 distributions of Exim should ever make this option available.'&
13158
13159 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
13160 updated files' data to be written to disc before continuing. Unexpected events
13161 such as crashes and power outages may cause data to be lost or scrambled.
13162 Here be Dragons. &*Beware.*&
13163
13164
13165 .option disable_ipv6 main boolean false
13166 .cindex "IPv6" "disabling"
13167 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
13168 activities take place. AAAA records are never looked up, and any IPv6 addresses
13169 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
13170 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13171 to handle IPv6 literal addresses.
13172
13173
13174 .option dns_again_means_nonexist main "domain list&!!" unset
13175 .cindex "DNS" "&""try again""& response; overriding"
13176 DNS lookups give a &"try again"& response for the DNS errors
13177 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
13178 keep trying to deliver a message, or to give repeated temporary errors to
13179 incoming mail. Sometimes the effect is caused by a badly set up name server and
13180 may persist for a long time. If a domain which exhibits this problem matches
13181 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
13182 This option should be used with care. You can make it apply to reverse lookups
13183 by a setting such as this:
13184 .code
13185 dns_again_means_nonexist = *.in-addr.arpa
13186 .endd
13187 This option applies to all DNS lookups that Exim does. It also applies when the
13188 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
13189 since these are most likely to be caused by DNS lookup problems. The
13190 &(dnslookup)& router has some options of its own for controlling what happens
13191 when lookups for MX or SRV records give temporary errors. These more specific
13192 options are applied after this global option.
13193
13194 .option dns_check_names_pattern main string "see below"
13195 .cindex "DNS" "pre-check of name syntax"
13196 When this option is set to a non-empty string, it causes Exim to check domain
13197 names for characters that are not allowed in host names before handing them to
13198 the DNS resolver, because some resolvers give temporary errors for names that
13199 contain unusual characters. If a domain name contains any unwanted characters,
13200 a &"not found"& result is forced, and the resolver is not called. The check is
13201 done by matching the domain name against a regular expression, which is the
13202 value of this option. The default pattern is
13203 .code
13204 dns_check_names_pattern = \
13205   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
13206 .endd
13207 which permits only letters, digits, slashes, and hyphens in components, but
13208 they must start and end with a letter or digit. Slashes are not, in fact,
13209 permitted in host names, but they are found in certain NS records (which can be
13210 accessed in Exim by using a &%dnsdb%& lookup). If you set
13211 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
13212 empty string.
13213
13214 .option dns_csa_search_limit main integer 5
13215 This option controls the depth of parental searching for CSA SRV records in the
13216 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
13217
13218 .option dns_csa_use_reverse main boolean true
13219 This option controls whether or not an IP address, given as a CSA domain, is
13220 reversed and looked up in the reverse DNS, as described in more detail in
13221 section &<<SECTverifyCSA>>&.
13222
13223 .option dns_ipv4_lookup main "domain list&!!" unset
13224 .cindex "IPv6" "DNS lookup for AAAA records"
13225 .cindex "DNS" "IPv6 lookup for AAAA records"
13226 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
13227 looks for IPv6 address records (AAAA records) as well as IPv4 address records
13228 (A records) when trying to find IP addresses for hosts, unless the host's
13229 domain matches this list.
13230
13231 This is a fudge to help with name servers that give big delays or otherwise do
13232 not work for the AAAA record type. In due course, when the world's name
13233 servers have all been upgraded, there should be no need for this option.
13234
13235
13236 .option dns_retrans main time 0s
13237 .cindex "DNS" "resolver options"
13238 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
13239 retransmission and retry parameters for DNS lookups. Values of zero (the
13240 defaults) leave the system default settings unchanged. The first value is the
13241 time between retries, and the second is the number of retries. It isn't
13242 totally clear exactly how these settings affect the total time a DNS lookup may
13243 take. I haven't found any documentation about timeouts on DNS lookups; these
13244 parameter values are available in the external resolver interface structure,
13245 but nowhere does it seem to describe how they are used or what you might want
13246 to set in them.
13247
13248
13249 .option dns_retry main integer 0
13250 See &%dns_retrans%& above.
13251
13252
13253 .option drop_cr main boolean false
13254 This is an obsolete option that is now a no-op. It used to affect the way Exim
13255 handled CR and LF characters in incoming messages. What happens now is
13256 described in section &<<SECTlineendings>>&.
13257
13258 .option dsn_from main "string&!!" "see below"
13259 .cindex "&'From:'& header line" "in bounces"
13260 .cindex "bounce messages" "&'From:'& line, specifying"
13261 This option can be used to vary the contents of &'From:'& header lines in
13262 bounces and other automatically generated messages (&"Delivery Status
13263 Notifications"& &-- hence the name of the option). The default setting is:
13264 .code
13265 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
13266 .endd
13267 The value is expanded every time it is needed. If the expansion fails, a
13268 panic is logged, and the default value is used.
13269
13270 .option envelope_to_remove main boolean true
13271 .cindex "&'Envelope-to:'& header line"
13272 Exim's transports have an option for adding an &'Envelope-to:'& header to a
13273 message when it is delivered, in exactly the same way as &'Return-path:'& is
13274 handled. &'Envelope-to:'& records the original recipient address from the
13275 messages's envelope that caused the delivery to happen. Such headers should not
13276 be present in incoming messages, and this option causes them to be removed at
13277 the time the message is received, to avoid any problems that might occur when a
13278 delivered message is subsequently sent on to some other recipient.
13279
13280
13281 .option errors_copy main "string list&!!" unset
13282 .cindex "bounce message" "copy to other address"
13283 .cindex "copy of bounce message"
13284 Setting this option causes Exim to send bcc copies of bounce messages that it
13285 generates to other addresses. &*Note*&: This does not apply to bounce messages
13286 coming from elsewhere. The value of the option is a colon-separated list of
13287 items. Each item consists of a pattern, terminated by white space, followed by
13288 a comma-separated list of email addresses. If a pattern contains spaces, it
13289 must be enclosed in double quotes.
13290
13291 Each pattern is processed in the same way as a single item in an address list
13292 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
13293 the bounce message, the message is copied to the addresses on the list. The
13294 items are scanned in order, and once a matching one is found, no further items
13295 are examined. For example:
13296 .code
13297 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
13298               rqps@mydomain   hostmaster@mydomain.example,\
13299                               postmaster@mydomain.example
13300 .endd
13301 .vindex "&$domain$&"
13302 .vindex "&$local_part$&"
13303 The address list is expanded before use. The expansion variables &$local_part$&
13304 and &$domain$& are set from the original recipient of the error message, and if
13305 there was any wildcard matching in the pattern, the expansion
13306 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
13307 variables &$0$&, &$1$&, etc. are set in the normal way.
13308
13309
13310 .option errors_reply_to main string unset
13311 .cindex "bounce message" "&'Reply-to:'& in"
13312 By default, Exim's bounce and delivery warning messages contain the header line
13313 .display
13314 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
13315 .endd
13316 .oindex &%quota_warn_message%&
13317 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
13318 A warning message that is generated by the &%quota_warn_message%& option in an
13319 &(appendfile)& transport may contain its own &'From:'& header line that
13320 overrides the default.
13321
13322 Experience shows that people reply to bounce messages. If the
13323 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
13324 and warning messages. For example:
13325 .code
13326 errors_reply_to = postmaster@my.domain.example
13327 .endd
13328 The value of the option is not expanded. It must specify a valid RFC 2822
13329 address. However, if a warning message that is generated by the
13330 &%quota_warn_message%& option in an &(appendfile)& transport contain its
13331 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
13332 not used.
13333
13334
13335 .option exim_group main string "compile-time configured"
13336 .cindex "gid (group id)" "Exim's own"
13337 .cindex "Exim group"
13338 This option changes the gid under which Exim runs when it gives up root
13339 privilege. The default value is compiled into the binary. The value of this
13340 option is used only when &%exim_user%& is also set. Unless it consists entirely
13341 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
13342 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
13343 security issues.
13344
13345
13346 .option exim_path main string "see below"
13347 .cindex "Exim binary, path name"
13348 This option specifies the path name of the Exim binary, which is used when Exim
13349 needs to re-exec itself. The default is set up to point to the file &'exim'& in
13350 the directory configured at compile time by the BIN_DIRECTORY setting. It
13351 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
13352 other place.
13353 &*Warning*&: Do not use a macro to define the value of this option, because
13354 you will break those Exim utilities that scan the configuration file to find
13355 where the binary is. (They then use the &%-bP%& option to extract option
13356 settings such as the value of &%spool_directory%&.)
13357
13358
13359 .option exim_user main string "compile-time configured"
13360 .cindex "uid (user id)" "Exim's own"
13361 .cindex "Exim user"
13362 This option changes the uid under which Exim runs when it gives up root
13363 privilege. The default value is compiled into the binary. Ownership of the run
13364 time configuration file and the use of the &%-C%& and &%-D%& command line
13365 options is checked against the values in the binary, not what is set here.
13366
13367 Unless it consists entirely of digits, the string is looked up using
13368 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
13369 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
13370 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
13371
13372
13373 .option extra_local_interfaces main "string list" unset
13374 This option defines network interfaces that are to be considered local when
13375 routing, but which are not used for listening by the daemon. See section
13376 &<<SECTreclocipadd>>& for details.
13377
13378
13379 . Allow this long option name to split; give it unsplit as a fifth argument
13380 . for the automatic .oindex that is generated by .option.
13381
13382 .option "extract_addresses_remove_ &~&~arguments" main boolean true &&&
13383          extract_addresses_remove_arguments
13384 .oindex "&%-t%&"
13385 .cindex "command line" "addresses with &%-t%&"
13386 .cindex "Sendmail compatibility" "&%-t%& option"
13387 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
13388 are present on the command line when the &%-t%& option is used to build an
13389 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
13390 line addresses are removed from the recipients list. This is also how Smail
13391 behaves. However, other Sendmail documentation (the O'Reilly book) states that
13392 command line addresses are added to those obtained from the header lines. When
13393 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
13394 argument headers. If it is set false, Exim adds rather than removes argument
13395 addresses.
13396
13397
13398 .option finduser_retries main integer 0
13399 .cindex "NIS, retrying user lookups"
13400 On systems running NIS or other schemes in which user and group information is
13401 distributed from a remote system, there can be times when &[getpwnam()]& and
13402 related functions fail, even when given valid data, because things time out.
13403 Unfortunately these failures cannot be distinguished from genuine &"not found"&
13404 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
13405 many extra times to find a user or a group, waiting for one second between
13406 retries.
13407
13408 .cindex "&_/etc/passwd_&" "multiple reading of"
13409 You should not set this option greater than zero if your user information is in
13410 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
13411 search the file multiple times for non-existent users, and also cause delay.
13412
13413
13414
13415 .option freeze_tell main "string list, comma separated" unset
13416 .cindex "freezing messages" "sending a message when freezing"
13417 On encountering certain errors, or when configured to do so in a system filter,
13418 ACL, or special router, Exim freezes a message. This means that no further
13419 delivery attempts take place until an administrator thaws the message, or the
13420 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
13421 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
13422 warning message whenever it freezes something, unless the message it is
13423 freezing is a locally-generated bounce message. (Without this exception there
13424 is the possibility of looping.) The warning message is sent to the addresses
13425 supplied as the comma-separated value of this option. If several of the
13426 message's addresses cause freezing, only a single message is sent. If the
13427 freezing was automatic, the reason(s) for freezing can be found in the message
13428 log. If you configure freezing in a filter or ACL, you must arrange for any
13429 logging that you require.
13430
13431
13432 .option gecos_name main string&!! unset
13433 .cindex "HP-UX"
13434 .cindex "&""gecos""& field, parsing"
13435 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
13436 password file to hold other information in addition to users' real names. Exim
13437 looks up this field for use when it is creating &'Sender:'& or &'From:'&
13438 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
13439 of the field are used unchanged, except that, if an ampersand is encountered,
13440 it is replaced by the user's login name with the first character forced to
13441 upper case, since this is a convention that is observed on many systems.
13442
13443 When these options are set, &%gecos_pattern%& is treated as a regular
13444 expression that is to be applied to the field (again with && replaced by the
13445 login name), and if it matches, &%gecos_name%& is expanded and used as the
13446 user's name.
13447
13448 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
13449 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
13450 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
13451 name terminates at the first comma, the following can be used:
13452 .code
13453 gecos_pattern = ([^,]*)
13454 gecos_name = $1
13455 .endd
13456
13457 .option gecos_pattern main string unset
13458 See &%gecos_name%& above.
13459
13460
13461 .option gnutls_require_kx main string unset
13462 This option controls the key exchange mechanisms when GnuTLS is used in an Exim
13463 server. For details, see section &<<SECTreqciphgnu>>&.
13464
13465 .option gnutls_require_mac main string unset
13466 This option controls the MAC algorithms when GnuTLS is used in an Exim
13467 server. For details, see section &<<SECTreqciphgnu>>&.
13468
13469 .option gnutls_require_protocols main string unset
13470 This option controls the protocols when GnuTLS is used in an Exim
13471 server. For details, see section &<<SECTreqciphgnu>>&.
13472
13473 .option gnutls_compat_mode main boolean unset
13474 This option controls whether GnuTLS is used in compatibility mode in an Exim
13475 server. This reduces security slightly, but improves interworking with older
13476 implementations of TLS.
13477
13478 .option headers_charset main string "see below"
13479 This option sets a default character set for translating from encoded MIME
13480 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
13481 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
13482 ultimate default is ISO-8859-1. For more details see the description of header
13483 insertions in section &<<SECTexpansionitems>>&.
13484
13485
13486
13487 .option header_maxsize main integer "see below"
13488 .cindex "header section" "maximum size of"
13489 .cindex "limit" "size of message header section"
13490 This option controls the overall maximum size of a message's header
13491 section. The default is the value of HEADER_MAXSIZE in
13492 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
13493 sections are rejected.
13494
13495
13496 .option header_line_maxsize main integer 0
13497 .cindex "header lines" "maximum size of"
13498 .cindex "limit" "size of one header line"
13499 This option limits the length of any individual header line in a message, after
13500 all the continuations have been joined together. Messages with individual
13501 header lines that are longer than the limit are rejected. The default value of
13502 zero means &"no limit"&.
13503
13504
13505
13506
13507 .option helo_accept_junk_hosts main "host list&!!" unset
13508 .cindex "HELO" "accepting junk data"
13509 .cindex "EHLO" "accepting junk data"
13510 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
13511 mail, and gives an error response for invalid data. Unfortunately, there are
13512 some SMTP clients that send syntactic junk. They can be accommodated by setting
13513 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
13514 if you want to do semantic checking.
13515 See also &%helo_allow_chars%& for a way of extending the permitted character
13516 set.
13517
13518
13519 .option helo_allow_chars main string unset
13520 .cindex "HELO" "underscores in"
13521 .cindex "EHLO" "underscores in"
13522 .cindex "underscore in EHLO/HELO"
13523 This option can be set to a string of rogue characters that are permitted in
13524 all EHLO and HELO names in addition to the standard letters, digits,
13525 hyphens, and dots. If you really must allow underscores, you can set
13526 .code
13527 helo_allow_chars = _
13528 .endd
13529 Note that the value is one string, not a list.
13530
13531
13532 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
13533 .cindex "HELO" "forcing reverse lookup"
13534 .cindex "EHLO" "forcing reverse lookup"
13535 If the domain given by a client in a HELO or EHLO command matches this
13536 list, a reverse lookup is done in order to establish the host's true name. The
13537 default forces a lookup if the client host gives the server's name or any of
13538 its IP addresses (in brackets), something that broken clients have been seen to
13539 do.
13540
13541
13542 .option helo_try_verify_hosts main "host list&!!" unset
13543 .cindex "HELO verifying" "optional"
13544 .cindex "EHLO" "verifying, optional"
13545 By default, Exim just checks the syntax of HELO and EHLO commands (see
13546 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
13547 to do more extensive checking of the data supplied by these commands. The ACL
13548 condition &`verify = helo`& is provided to make this possible.
13549 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
13550 to force the check to occur. From release 4.53 onwards, this is no longer
13551 necessary. If the check has not been done before &`verify = helo`& is
13552 encountered, it is done at that time. Consequently, this option is obsolete.
13553 Its specification is retained here for backwards compatibility.
13554
13555 When an EHLO or HELO command is received, if the calling host matches
13556 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
13557 EHLO command either:
13558
13559 .ilist
13560 is an IP literal matching the calling address of the host, or
13561 .next
13562 .cindex "DNS" "reverse lookup"
13563 .cindex "reverse DNS lookup"
13564 matches the host name that Exim obtains by doing a reverse lookup of the
13565 calling host address, or
13566 .next
13567 when looked up using &[gethostbyname()]& (or &[getipnodebyname()]& when
13568 available) yields the calling host address.
13569 .endlist
13570
13571 However, the EHLO or HELO command is not rejected if any of the checks
13572 fail. Processing continues, but the result of the check is remembered, and can
13573 be detected later in an ACL by the &`verify = helo`& condition.
13574
13575 .option helo_verify_hosts main "host list&!!" unset
13576 .cindex "HELO verifying" "mandatory"
13577 .cindex "EHLO" "verifying, mandatory"
13578 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
13579 backwards compatibility. For hosts that match this option, Exim checks the host
13580 name given in the HELO or EHLO in the same way as for
13581 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
13582 rejected with a 550 error, and entries are written to the main and reject logs.
13583 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
13584 error.
13585
13586 .option hold_domains main "domain list&!!" unset
13587 .cindex "domain" "delaying delivery"
13588 .cindex "delivery" "delaying certain domains"
13589 This option allows mail for particular domains to be held on the queue
13590 manually. The option is overridden if a message delivery is forced with the
13591 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
13592 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
13593 item in &%hold_domains%&, no routing or delivery for that address is done, and
13594 it is deferred every time the message is looked at.
13595
13596 This option is intended as a temporary operational measure for delaying the
13597 delivery of mail while some problem is being sorted out, or some new
13598 configuration tested. If you just want to delay the processing of some
13599 domains until a queue run occurs, you should use &%queue_domains%& or
13600 &%queue_smtp_domains%&, not &%hold_domains%&.
13601
13602 A setting of &%hold_domains%& does not override Exim's code for removing
13603 messages from the queue if they have been there longer than the longest retry
13604 time in any retry rule. If you want to hold messages for longer than the normal
13605 retry times, insert a dummy retry rule with a long retry time.
13606
13607
13608 .option host_lookup main "host list&!!" unset
13609 .cindex "host name" "lookup, forcing"
13610 Exim does not look up the name of a calling host from its IP address unless it
13611 is required to compare against some host list, or the host matches
13612 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
13613 option (which normally contains IP addresses rather than host names). The
13614 default configuration file contains
13615 .code
13616 host_lookup = *
13617 .endd
13618 which causes a lookup to happen for all hosts. If the expense of these lookups
13619 is felt to be too great, the setting can be changed or removed.
13620
13621 After a successful reverse lookup, Exim does a forward lookup on the name it
13622 has obtained, to verify that it yields the IP address that it started with. If
13623 this check fails, Exim behaves as if the name lookup failed.
13624
13625 .vindex "&$host_lookup_failed$&"
13626 .vindex "&$sender_host_name$&"
13627 After any kind of failure, the host name (in &$sender_host_name$&) remains
13628 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
13629 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
13630 &`verify = reverse_host_lookup`& in ACLs.
13631
13632
13633 .option host_lookup_order main "string list" &`bydns:byaddr`&
13634 This option specifies the order of different lookup methods when Exim is trying
13635 to find a host name from an IP address. The default is to do a DNS lookup
13636 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
13637 if that fails. You can change the order of these lookups, or omit one entirely,
13638 if you want.
13639
13640 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
13641 multiple PTR records in the DNS and the IP address is not listed in
13642 &_/etc/hosts_&. Different operating systems give different results in this
13643 case. That is why the default tries a DNS lookup first.
13644
13645
13646
13647 .option host_reject_connection main "host list&!!" unset
13648 .cindex "host" "rejecting connections from"
13649 If this option is set, incoming SMTP calls from the hosts listed are rejected
13650 as soon as the connection is made.
13651 This option is obsolete, and retained only for backward compatibility, because
13652 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
13653 connections immediately.
13654
13655 The ability to give an immediate rejection (either by this option or using an
13656 ACL) is provided for use in unusual cases. Many hosts will just try again,
13657 sometimes without much delay. Normally, it is better to use an ACL to reject
13658 incoming messages at a later stage, such as after RCPT commands. See
13659 chapter &<<CHAPACL>>&.
13660
13661
13662 .option hosts_connection_nolog main "host list&!!" unset
13663 .cindex "host" "not logging connections from"
13664 This option defines a list of hosts for which connection logging does not
13665 happen, even though the &%smtp_connection%& log selector is set. For example,
13666 you might want not to log SMTP connections from local processes, or from
13667 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
13668 the daemon; you should therefore strive to restrict its value to a short inline
13669 list of IP addresses and networks. To disable logging SMTP connections from
13670 local processes, you must create a host list with an empty item. For example:
13671 .code
13672 hosts_connection_nolog = :
13673 .endd
13674 If the &%smtp_connection%& log selector is not set, this option has no effect.
13675
13676
13677
13678 .option hosts_treat_as_local main "domain list&!!" unset
13679 .cindex "local host" "domains treated as"
13680 .cindex "host" "treated as local"
13681 If this option is set, any host names that match the domain list are treated as
13682 if they were the local host when Exim is scanning host lists obtained from MX
13683 records
13684 or other sources. Note that the value of this option is a domain list, not a
13685 host list, because it is always used to check host names, not IP addresses.
13686
13687 This option also applies when Exim is matching the special items
13688 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
13689 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
13690 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
13691 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
13692 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
13693 interfaces and recognizing the local host.
13694
13695
13696 .option ibase_servers main "string list" unset
13697 .cindex "InterBase" "server list"
13698 This option provides a list of InterBase servers and associated connection data,
13699 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
13700 The option is available only if Exim has been built with InterBase support.
13701
13702
13703
13704 .option ignore_bounce_errors_after main time 10w
13705 .cindex "bounce message" "discarding"
13706 .cindex "discarding bounce message"
13707 This option affects the processing of bounce messages that cannot be delivered,
13708 that is, those that suffer a permanent delivery failure. (Bounce messages that
13709 suffer temporary delivery failures are of course retried in the usual way.)
13710
13711 After a permanent delivery failure, bounce messages are frozen,
13712 because there is no sender to whom they can be returned. When a frozen bounce
13713 message has been on the queue for more than the given time, it is unfrozen at
13714 the next queue run, and a further delivery is attempted. If delivery fails
13715 again, the bounce message is discarded. This makes it possible to keep failed
13716 bounce messages around for a shorter time than the normal maximum retry time
13717 for frozen messages. For example,
13718 .code
13719 ignore_bounce_errors_after = 12h
13720 .endd
13721 retries failed bounce message deliveries after 12 hours, discarding any further
13722 failures. If the value of this option is set to a zero time period, bounce
13723 failures are discarded immediately. Setting a very long time (as in the default
13724 value) has the effect of disabling this option. For ways of automatically
13725 dealing with other kinds of frozen message, see &%auto_thaw%& and
13726 &%timeout_frozen_after%&.
13727
13728
13729 .option ignore_fromline_hosts main "host list&!!" unset
13730 .cindex "&""From""& line"
13731 .cindex "UUCP" "&""From""& line"
13732 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
13733 the headers of a message. By default this is treated as the start of the
13734 message's body, which means that any following headers are not recognized as
13735 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
13736 match those hosts that insist on sending it. If the sender is actually a local
13737 process rather than a remote host, and is using &%-bs%& to inject the messages,
13738 &%ignore_fromline_local%& must be set to achieve this effect.
13739
13740
13741 .option ignore_fromline_local main boolean false
13742 See &%ignore_fromline_hosts%& above.
13743
13744
13745 .option keep_malformed main time 4d
13746 This option specifies the length of time to keep messages whose spool files
13747 have been corrupted in some way. This should, of course, never happen. At the
13748 next attempt to deliver such a message, it gets removed. The incident is
13749 logged.
13750
13751
13752 .option ldap_default_servers main "string list" unset
13753 .cindex "LDAP" "default servers"
13754 This option provides a list of LDAP servers which are tried in turn when an
13755 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
13756 details of LDAP queries. This option is available only when Exim has been built
13757 with LDAP support.
13758
13759
13760 .option ldap_version main integer unset
13761 .cindex "LDAP" "protocol version, forcing"
13762 This option can be used to force Exim to set a specific protocol version for
13763 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
13764 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
13765 the LDAP headers; otherwise it is 2. This option is available only when Exim
13766 has been built with LDAP support.
13767
13768
13769
13770 .option local_from_check main boolean true
13771 .cindex "&'Sender:'& header line" "disabling addition of"
13772 .cindex "&'From:'& header line" "disabling checking of"
13773 When a message is submitted locally (that is, not over a TCP/IP connection) by
13774 an untrusted user, Exim removes any existing &'Sender:'& header line, and
13775 checks that the &'From:'& header line matches the login of the calling user and
13776 the domain specified by &%qualify_domain%&.
13777
13778 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
13779 locally submitted message is automatically qualified by Exim, unless the
13780 &%-bnq%& command line option is used.
13781
13782 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
13783 on the local part. If the &'From:'& header line does not match, Exim adds a
13784 &'Sender:'& header with an address constructed from the calling user's login
13785 and the default qualify domain.
13786
13787 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
13788 and no &'Sender:'& header is ever added. If, in addition, you want to retain
13789 &'Sender:'& header lines supplied by untrusted users, you must also set
13790 &%local_sender_retain%& to be true.
13791
13792 .cindex "envelope sender"
13793 These options affect only the header lines in the message. The envelope sender
13794 is still forced to be the login id at the qualify domain unless
13795 &%untrusted_set_sender%& permits the user to supply an envelope sender.
13796
13797 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
13798 request similar header line checking. See section &<<SECTthesenhea>>&, which
13799 has more details about &'Sender:'& processing.
13800
13801
13802
13803
13804 .option local_from_prefix main string unset
13805 When Exim checks the &'From:'& header line of locally submitted messages for
13806 matching the login id (see &%local_from_check%& above), it can be configured to
13807 ignore certain prefixes and suffixes in the local part of the address. This is
13808 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
13809 appropriate lists, in the same form as the &%local_part_prefix%& and
13810 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
13811 example, if
13812 .code
13813 local_from_prefix = *-
13814 .endd
13815 is set, a &'From:'& line containing
13816 .code
13817 From: anything-user@your.domain.example
13818 .endd
13819 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
13820 matches the actual sender address that is constructed from the login name and
13821 qualify domain.
13822
13823
13824 .option local_from_suffix main string unset
13825 See &%local_from_prefix%& above.
13826
13827
13828 .option local_interfaces main "string list" "see below"
13829 This option controls which network interfaces are used by the daemon for
13830 listening; they are also used to identify the local host when routing. Chapter
13831 &<<CHAPinterfaces>>& contains a full description of this option and the related
13832 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
13833 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
13834 &%local_interfaces%& is
13835 .code
13836 local_interfaces = 0.0.0.0
13837 .endd
13838 when Exim is built without IPv6 support; otherwise it is
13839 .code
13840 local_interfaces = <; ::0 ; 0.0.0.0
13841 .endd
13842
13843 .option local_scan_timeout main time 5m
13844 .cindex "timeout" "for &[local_scan()]& function"
13845 .cindex "&[local_scan()]& function" "timeout"
13846 This timeout applies to the &[local_scan()]& function (see chapter
13847 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
13848 the incoming message is rejected with a temporary error if it is an SMTP
13849 message. For a non-SMTP message, the message is dropped and Exim ends with a
13850 non-zero code. The incident is logged on the main and reject logs.
13851
13852
13853
13854 .option local_sender_retain main boolean false
13855 .cindex "&'Sender:'& header line" "retaining from local submission"
13856 When a message is submitted locally (that is, not over a TCP/IP connection) by
13857 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
13858 do not want this to happen, you must set &%local_sender_retain%&, and you must
13859 also set &%local_from_check%& to be false (Exim will complain if you do not).
13860 See also the ACL modifier &`control = suppress_local_fixups`&. Section
13861 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
13862
13863
13864
13865
13866 .option localhost_number main string&!! unset
13867 .cindex "host" "locally unique number for"
13868 .cindex "message ids" "with multiple hosts"
13869 .vindex "&$localhost_number$&"
13870 Exim's message ids are normally unique only within the local host. If
13871 uniqueness among a set of hosts is required, each host must set a different
13872 value for the &%localhost_number%& option. The string is expanded immediately
13873 after reading the configuration file (so that a number can be computed from the
13874 host name, for example) and the result of the expansion must be a number in the
13875 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
13876 systems). This is available in subsequent string expansions via the variable
13877 &$localhost_number$&. When &%localhost_number is set%&, the final two
13878 characters of the message id, instead of just being a fractional part of the
13879 time, are computed from the time and the local host number as described in
13880 section &<<SECTmessiden>>&.
13881
13882
13883
13884 .option log_file_path main "string list&!!" "set at compile time"
13885 .cindex "log" "file path for"
13886 This option sets the path which is used to determine the names of Exim's log
13887 files, or indicates that logging is to be to syslog, or both. It is expanded
13888 when Exim is entered, so it can, for example, contain a reference to the host
13889 name. If no specific path is set for the log files at compile or run time, they
13890 are written in a sub-directory called &_log_& in Exim's spool directory.
13891 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
13892 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
13893 used. If this string is fixed at your installation (contains no expansion
13894 variables) it is recommended that you do not set this option in the
13895 configuration file, but instead supply the path using LOG_FILE_PATH in
13896 &_Local/Makefile_& so that it is available to Exim for logging errors detected
13897 early on &-- in particular, failure to read the configuration file.
13898
13899
13900 .option log_selector main string unset
13901 .cindex "log" "selectors"
13902 This option can be used to reduce or increase the number of things that Exim
13903 writes to its log files. Its argument is made up of names preceded by plus or
13904 minus characters. For example:
13905 .code
13906 log_selector = +arguments -retry_defer
13907 .endd
13908 A list of possible names and what they control is given in the chapter on
13909 logging, in section &<<SECTlogselector>>&.
13910
13911
13912 .option log_timezone main boolean false
13913 .cindex "log" "timezone for entries"
13914 .vindex "&$tod_log$&"
13915 .vindex "&$tod_zone$&"
13916 By default, the timestamps on log lines are in local time without the
13917 timezone. This means that if your timezone changes twice a year, the timestamps
13918 in log lines are ambiguous for an hour when the clocks go back. One way of
13919 avoiding this problem is to set the timezone to UTC. An alternative is to set
13920 &%log_timezone%& true. This turns on the addition of the timezone offset to
13921 timestamps in log lines. Turning on this option can add quite a lot to the size
13922 of log files because each line is extended by 6 characters. Note that the
13923 &$tod_log$& variable contains the log timestamp without the zone, but there is
13924 another variable called &$tod_zone$& that contains just the timezone offset.
13925
13926
13927 .option lookup_open_max main integer 25
13928 .cindex "too many open files"
13929 .cindex "open files, too many"
13930 .cindex "file" "too many open"
13931 .cindex "lookup" "maximum open files"
13932 .cindex "limit" "open files for lookups"
13933 This option limits the number of simultaneously open files for single-key
13934 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
13935 Exim normally keeps these files open during routing, because often the same
13936 file is required several times. If the limit is reached, Exim closes the least
13937 recently used file. Note that if you are using the &'ndbm'& library, it
13938 actually opens two files for each logical DBM database, though it still counts
13939 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
13940 open files"& errors with NDBM, you need to reduce the value of
13941 &%lookup_open_max%&.
13942
13943
13944 .option max_username_length main integer 0
13945 .cindex "length of login name"
13946 .cindex "user name" "maximum length"
13947 .cindex "limit" "user name length"
13948 Some operating systems are broken in that they truncate long arguments to
13949 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
13950 this option is set greater than zero, any attempt to call &[getpwnam()]& with
13951 an argument that is longer behaves as if &[getpwnam()]& failed.
13952
13953
13954 .option message_body_newlines main bool false
13955 .cindex "message body" "newlines in variables"
13956 .cindex "newline" "in message body variables"
13957 .vindex "&$message_body$&"
13958 .vindex "&$message_body_end$&"
13959 By default, newlines in the message body are replaced by spaces when setting
13960 the &$message_body$& and &$message_body_end$& expansion variables. If this
13961 option is set true, this no longer happens.
13962
13963
13964 .option message_body_visible main integer 500
13965 .cindex "body of message" "visible size"
13966 .cindex "message body" "visible size"
13967 .vindex "&$message_body$&"
13968 .vindex "&$message_body_end$&"
13969 This option specifies how much of a message's body is to be included in the
13970 &$message_body$& and &$message_body_end$& expansion variables.
13971
13972
13973 .option message_id_header_domain main string&!! unset
13974 .cindex "&'Message-ID:'& header line"
13975 If this option is set, the string is expanded and used as the right hand side
13976 (domain) of the &'Message-ID:'& header that Exim creates if a
13977 locally-originated incoming message does not have one. &"Locally-originated"&
13978 means &"not received over TCP/IP."&
13979 Otherwise, the primary host name is used.
13980 Only letters, digits, dot and hyphen are accepted; any other characters are
13981 replaced by hyphens. If the expansion is forced to fail, or if the result is an
13982 empty string, the option is ignored.
13983
13984
13985 .option message_id_header_text main string&!! unset
13986 If this variable is set, the string is expanded and used to augment the text of
13987 the &'Message-id:'& header that Exim creates if a locally-originated incoming
13988 message does not have one. The text of this header is required by RFC 2822 to
13989 take the form of an address. By default, Exim uses its internal message id as
13990 the local part, and the primary host name as the domain. If this option is set,
13991 it is expanded, and provided the expansion is not forced to fail, and does not
13992 yield an empty string, the result is inserted into the header immediately
13993 before the @, separated from the internal message id by a dot. Any characters
13994 that are illegal in an address are automatically converted into hyphens. This
13995 means that variables such as &$tod_log$& can be used, because the spaces and
13996 colons will become hyphens.
13997
13998
13999 .option message_logs main boolean true
14000 .cindex "message logs" "disabling"
14001 .cindex "log" "message log; disabling"
14002 If this option is turned off, per-message log files are not created in the
14003 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
14004 Exim, by reducing the number of files involved in handling a message from a
14005 minimum of four (header spool file, body spool file, delivery journal, and
14006 per-message log) to three. The other major I/O activity is Exim's main log,
14007 which is not affected by this option.
14008
14009
14010 .option message_size_limit main string&!! 50M
14011 .cindex "message" "size limit"
14012 .cindex "limit" "message size"
14013 .cindex "size" "of message, limit"
14014 This option limits the maximum size of message that Exim will process. The
14015 value is expanded for each incoming connection so, for example, it can be made
14016 to depend on the IP address of the remote host for messages arriving via
14017 TCP/IP. After expansion, the value must be a sequence of decimal digits,
14018 optionally followed by K or M.
14019
14020 &*Note*&: This limit cannot be made to depend on a message's sender or any
14021 other properties of an individual message, because it has to be advertised in
14022 the server's response to EHLO. String expansion failure causes a temporary
14023 error. A value of zero means no limit, but its use is not recommended. See also
14024 &%bounce_return_size_limit%&.
14025
14026 Incoming SMTP messages are failed with a 552 error if the limit is
14027 exceeded; locally-generated messages either get a stderr message or a delivery
14028 failure message to the sender, depending on the &%-oe%& setting. Rejection of
14029 an oversized message is logged in both the main and the reject logs. See also
14030 the generic transport option &%message_size_limit%&, which limits the size of
14031 message that an individual transport can process.
14032
14033 If you use a virus-scanner and set this option to to a value larger than the
14034 maximum size that your virus-scanner is configured to support, you may get
14035 failures triggered by large mails.  The right size to configure for the
14036 virus-scanner depends upon what data is passed and the options in use but it's
14037 probably safest to just set it to a little larger than this value.  Eg, with a
14038 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
14039 some problems may result.
14040
14041
14042 .option move_frozen_messages main boolean false
14043 .cindex "frozen messages" "moving"
14044 This option, which is available only if Exim has been built with the setting
14045 .code
14046 SUPPORT_MOVE_FROZEN_MESSAGES=yes
14047 .endd
14048 in &_Local/Makefile_&, causes frozen messages and their message logs to be
14049 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
14050 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
14051 standard utilities for handling such moved messages, and they do not show up in
14052 lists generated by &%-bp%& or by the Exim monitor.
14053
14054
14055 .option mua_wrapper main boolean false
14056 Setting this option true causes Exim to run in a very restrictive mode in which
14057 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
14058 contains a full description of this facility.
14059
14060
14061
14062 .option mysql_servers main "string list" unset
14063 .cindex "MySQL" "server list"
14064 This option provides a list of MySQL servers and associated connection data, to
14065 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
14066 option is available only if Exim has been built with MySQL support.
14067
14068
14069 .option never_users main "string list&!!" unset
14070 This option is expanded just once, at the start of Exim's processing. Local
14071 message deliveries are normally run in processes that are setuid to the
14072 recipient, and remote deliveries are normally run under Exim's own uid and gid.
14073 It is usually desirable to prevent any deliveries from running as root, as a
14074 safety precaution.
14075
14076 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
14077 list of users that must not be used for local deliveries. This list is fixed in
14078 the binary and cannot be overridden by the configuration file. By default, it
14079 contains just the single user name &"root"&. The &%never_users%& runtime option
14080 can be used to add more users to the fixed list.
14081
14082 If a message is to be delivered as one of the users on the fixed list or the
14083 &%never_users%& list, an error occurs, and delivery is deferred. A common
14084 example is
14085 .code
14086 never_users = root:daemon:bin
14087 .endd
14088 Including root is redundant if it is also on the fixed list, but it does no
14089 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
14090 transport driver.
14091
14092
14093 .option openssl_options main "string list" +dont_insert_empty_fragments
14094 .cindex "OpenSSL "compatibility options"
14095 This option allows an administrator to adjust the SSL options applied
14096 by OpenSSL to connections.  It is given as a space-separated list of items,
14097 each one to be +added or -subtracted from the current value.  The default
14098 value is one option which happens to have been set historically.  You can
14099 remove all options with:
14100 .code
14101 openssl_options = -all
14102 .endd
14103 This option is only available if Exim is built against OpenSSL.  The values
14104 available for this option vary according to the age of your OpenSSL install.
14105 The &"all"& value controls a subset of flags which are available, typically
14106 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
14107 list the values known on your system and Exim should support all the
14108 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
14109 names lose the leading &"SSL_OP_"& and are lower-cased.
14110
14111 Note that adjusting the options can have severe impact upon the security of
14112 SSL as used by Exim.  It is possible to disable safety checks and shoot
14113 yourself in the foot in various unpleasant ways.  This option should not be
14114 adjusted lightly.  An unrecognised item will be detected at by invoking Exim
14115 with the &%-bV%& flag.
14116
14117 An example:
14118 .code
14119 openssl_options = -all +microsoft_big_sslv3_buffer
14120 .endd
14121
14122
14123 .option oracle_servers main "string list" unset
14124 .cindex "Oracle" "server list"
14125 This option provides a list of Oracle servers and associated connection data,
14126 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
14127 The option is available only if Exim has been built with Oracle support.
14128
14129
14130 .option percent_hack_domains main "domain list&!!" unset
14131 .cindex "&""percent hack""&"
14132 .cindex "source routing" "in email address"
14133 .cindex "address" "source-routed"
14134 The &"percent hack"& is the convention whereby a local part containing a
14135 percent sign is re-interpreted as a new email address, with the percent
14136 replaced by @. This is sometimes called &"source routing"&, though that term is
14137 also applied to RFC 2822 addresses that begin with an @ character. If this
14138 option is set, Exim implements the percent facility for those domains listed,
14139 but no others. This happens before an incoming SMTP address is tested against
14140 an ACL.
14141
14142 &*Warning*&: The &"percent hack"& has often been abused by people who are
14143 trying to get round relaying restrictions. For this reason, it is best avoided
14144 if at all possible. Unfortunately, a number of less security-conscious MTAs
14145 implement it unconditionally. If you are running Exim on a gateway host, and
14146 routing mail through to internal MTAs without processing the local parts, it is
14147 a good idea to reject recipient addresses with percent characters in their
14148 local parts. Exim's default configuration does this.
14149
14150
14151 .option perl_at_start main boolean false
14152 This option is available only when Exim is built with an embedded Perl
14153 interpreter. See chapter &<<CHAPperl>>& for details of its use.
14154
14155
14156 .option perl_startup main string unset
14157 This option is available only when Exim is built with an embedded Perl
14158 interpreter. See chapter &<<CHAPperl>>& for details of its use.
14159
14160
14161 .option pgsql_servers main "string list" unset
14162 .cindex "PostgreSQL lookup type" "server list"
14163 This option provides a list of PostgreSQL servers and associated connection
14164 data, to be used in conjunction with &(pgsql)& lookups (see section
14165 &<<SECID72>>&). The option is available only if Exim has been built with
14166 PostgreSQL support.
14167
14168
14169 .option pid_file_path main string&!! "set at compile time"
14170 .cindex "daemon" "pid file path"
14171 .cindex "pid file, path for"
14172 This option sets the name of the file to which the Exim daemon writes its
14173 process id. The string is expanded, so it can contain, for example, references
14174 to the host name:
14175 .code
14176 pid_file_path = /var/log/$primary_hostname/exim.pid
14177 .endd
14178 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
14179 spool directory.
14180 The value set by the option can be overridden by the &%-oP%& command line
14181 option. A pid file is not written if a &"non-standard"& daemon is run by means
14182 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
14183
14184
14185 .option pipelining_advertise_hosts main "host list&!!" *
14186 .cindex "PIPELINING" "suppressing advertising"
14187 This option can be used to suppress the advertisement of the SMTP
14188 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
14189 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
14190 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
14191 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
14192 that clients will use it; &"out of order"& commands that are &"expected"& do
14193 not count as protocol errors (see &%smtp_max_synprot_errors%&).
14194
14195
14196 .option preserve_message_logs main boolean false
14197 .cindex "message logs" "preserving"
14198 If this option is set, message log files are not deleted when messages are
14199 completed. Instead, they are moved to a sub-directory of the spool directory
14200 called &_msglog.OLD_&, where they remain available for statistical or debugging
14201 purposes. This is a dangerous option to set on systems with any appreciable
14202 volume of mail. Use with care!
14203
14204
14205 .option primary_hostname main string "see below"
14206 .cindex "name" "of local host"
14207 .cindex "host" "name of local"
14208 .cindex "local host" "name of"
14209 .vindex "&$primary_hostname$&"
14210 This specifies the name of the current host. It is used in the default EHLO or
14211 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
14212 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
14213 The value is also used by default in some SMTP response messages from an Exim
14214 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
14215
14216 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
14217 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
14218 contains only one component, Exim passes it to &[gethostbyname()]& (or
14219 &[getipnodebyname()]& when available) in order to obtain the fully qualified
14220 version. The variable &$primary_hostname$& contains the host name, whether set
14221 explicitly by this option, or defaulted.
14222
14223
14224 .option print_topbitchars main boolean false
14225 .cindex "printing characters"
14226 .cindex "8-bit characters"
14227 By default, Exim considers only those characters whose codes lie in the range
14228 32&--126 to be printing characters. In a number of circumstances (for example,
14229 when writing log entries) non-printing characters are converted into escape
14230 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
14231 is set, code values of 128 and above are also considered to be printing
14232 characters.
14233
14234 This option also affects the header syntax checks performed by the
14235 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
14236 the user's full name when constructing From: and Sender: addresses (as
14237 described in section &<<SECTconstr>>&). Setting this option can cause
14238 Exim to generate eight bit message headers that do not conform to the
14239 standards.
14240
14241
14242 .option process_log_path main string unset
14243 .cindex "process log path"
14244 .cindex "log" "process log"
14245 .cindex "&'exiwhat'&"
14246 This option sets the name of the file to which an Exim process writes its
14247 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
14248 utility script. If this option is unset, the file called &_exim-process.info_&
14249 in Exim's spool directory is used. The ability to specify the name explicitly
14250 can be useful in environments where two different Exims are running, using
14251 different spool directories.
14252
14253
14254 .option prod_requires_admin main boolean true
14255 .oindex "&%-M%&"
14256 .oindex "&%-R%&"
14257 .oindex "&%-q%&"
14258 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
14259 admin user unless &%prod_requires_admin%& is set false. See also
14260 &%queue_list_requires_admin%&.
14261
14262
14263 .option qualify_domain main string "see below"
14264 .cindex "domain" "for qualifying addresses"
14265 .cindex "address" "qualification"
14266 This option specifies the domain name that is added to any envelope sender
14267 addresses that do not have a domain qualification. It also applies to
14268 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
14269 are accepted by default only for locally-generated messages. Qualification is
14270 also applied to addresses in header lines such as &'From:'& and &'To:'& for
14271 locally-generated messages, unless the &%-bnq%& command line option is used.
14272
14273 Messages from external sources must always contain fully qualified addresses,
14274 unless the sending host matches &%sender_unqualified_hosts%& or
14275 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
14276 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
14277 necessary. Internally, Exim always works with fully qualified envelope
14278 addresses. If &%qualify_domain%& is not set, it defaults to the
14279 &%primary_hostname%& value.
14280
14281
14282 .option qualify_recipient main string "see below"
14283 This option allows you to specify a different domain for qualifying recipient
14284 addresses to the one that is used for senders. See &%qualify_domain%& above.
14285
14286
14287
14288 .option queue_domains main "domain list&!!" unset
14289 .cindex "domain" "specifying non-immediate delivery"
14290 .cindex "queueing incoming messages"
14291 .cindex "message" "queueing certain domains"
14292 This option lists domains for which immediate delivery is not required.
14293 A delivery process is started whenever a message is received, but only those
14294 domains that do not match are processed. All other deliveries wait until the
14295 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
14296
14297
14298 .option queue_list_requires_admin main boolean true
14299 .oindex "&%-bp%&"
14300 The &%-bp%& command-line option, which lists the messages that are on the
14301 queue, requires the caller to be an admin user unless
14302 &%queue_list_requires_admin%& is set false. See also &%prod_requires_admin%&.
14303
14304
14305 .option queue_only main boolean false
14306 .cindex "queueing incoming messages"
14307 .cindex "message" "queueing unconditionally"
14308 If &%queue_only%& is set, a delivery process is not automatically started
14309 whenever a message is received. Instead, the message waits on the queue for the
14310 next queue run. Even if &%queue_only%& is false, incoming messages may not get
14311 delivered immediately when certain conditions (such as heavy load) occur.
14312
14313 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
14314 and &%-odi%& command line options override &%queue_only%& unless
14315 &%queue_only_override%& is set false. See also &%queue_only_file%&,
14316 &%queue_only_load%&, and &%smtp_accept_queue%&.
14317
14318
14319 .option queue_only_file main string unset
14320 .cindex "queueing incoming messages"
14321 .cindex "message" "queueing by file existence"
14322 This option can be set to a colon-separated list of absolute path names, each
14323 one optionally preceded by &"smtp"&. When Exim is receiving a message,
14324 it tests for the existence of each listed path using a call to &[stat()]&. For
14325 each path that exists, the corresponding queueing option is set.
14326 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
14327 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
14328 .code
14329 queue_only_file = smtp/some/file
14330 .endd
14331 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
14332 &_/some/file_& exists.
14333
14334
14335 .option queue_only_load main fixed-point unset
14336 .cindex "load average"
14337 .cindex "queueing incoming messages"
14338 .cindex "message" "queueing by load"
14339 If the system load average is higher than this value, incoming messages from
14340 all sources are queued, and no automatic deliveries are started. If this
14341 happens during local or remote SMTP input, all subsequent messages received on
14342 the same SMTP connection are queued by default, whatever happens to the load in
14343 the meantime, but this can be changed by setting &%queue_only_load_latch%&
14344 false.
14345
14346 Deliveries will subsequently be performed by queue runner processes. This
14347 option has no effect on ancient operating systems on which Exim cannot
14348 determine the load average. See also &%deliver_queue_load_max%& and
14349 &%smtp_load_reserve%&.
14350
14351
14352 .option queue_only_load_latch main boolean true
14353 .cindex "load average" "re-evaluating per message"
14354 When this option is true (the default), once one message has been queued
14355 because the load average is higher than the value set by &%queue_only_load%&,
14356 all subsequent messages received on the same SMTP connection are also queued.
14357 This is a deliberate choice; even though the load average may fall below the
14358 threshold, it doesn't seem right to deliver later messages on the same
14359 connection when not delivering earlier ones. However, there are special
14360 circumstances such as very long-lived connections from scanning appliances
14361 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
14362 should be set false. This causes the value of the load average to be
14363 re-evaluated for each message.
14364
14365
14366 .option queue_only_override main boolean true
14367 .cindex "queueing incoming messages"
14368 When this option is true, the &%-od%&&'x'& command line options override the
14369 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
14370 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
14371 to override; they are accepted, but ignored.
14372
14373
14374 .option queue_run_in_order main boolean false
14375 .cindex "queue runner" "processing messages in order"
14376 If this option is set, queue runs happen in order of message arrival instead of
14377 in an arbitrary order. For this to happen, a complete list of the entire queue
14378 must be set up before the deliveries start. When the queue is all held in a
14379 single directory (the default), a single list is created for both the ordered
14380 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
14381 single list is not created when &%queue_run_in_order%& is false. In this case,
14382 the sub-directories are processed one at a time (in a random order), and this
14383 avoids setting up one huge list for the whole queue. Thus, setting
14384 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
14385 when the queue is large, because of the extra work in setting up the single,
14386 large list. In most situations, &%queue_run_in_order%& should not be set.
14387
14388
14389
14390 .option queue_run_max main integer 5
14391 .cindex "queue runner" "maximum number of"
14392 This controls the maximum number of queue runner processes that an Exim daemon
14393 can run simultaneously. This does not mean that it starts them all at once,
14394 but rather that if the maximum number are still running when the time comes to
14395 start another one, it refrains from starting another one. This can happen with
14396 very large queues and/or very sluggish deliveries. This option does not,
14397 however, interlock with other processes, so additional queue runners can be
14398 started by other means, or by killing and restarting the daemon.
14399
14400 Setting this option to zero does not suppress queue runs; rather, it disables
14401 the limit, allowing any number of simultaneous queue runner processes to be
14402 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
14403 the daemon's command line.
14404
14405 .option queue_smtp_domains main "domain list&!!" unset
14406 .cindex "queueing incoming messages"
14407 .cindex "message" "queueing remote deliveries"
14408 When this option is set, a delivery process is started whenever a message is
14409 received, routing is performed, and local deliveries take place.
14410 However, if any SMTP deliveries are required for domains that match
14411 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
14412 message waits on the queue for the next queue run. Since routing of the message
14413 has taken place, Exim knows to which remote hosts it must be delivered, and so
14414 when the queue run happens, multiple messages for the same host are delivered
14415 over a single SMTP connection. The &%-odqs%& command line option causes all
14416 SMTP deliveries to be queued in this way, and is equivalent to setting
14417 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
14418 &%queue_domains%&.
14419
14420
14421 .option receive_timeout main time 0s
14422 .cindex "timeout" "for non-SMTP input"
14423 This option sets the timeout for accepting a non-SMTP message, that is, the
14424 maximum time that Exim waits when reading a message on the standard input. If
14425 the value is zero, it will wait for ever. This setting is overridden by the
14426 &%-or%& command line option. The timeout for incoming SMTP messages is
14427 controlled by &%smtp_receive_timeout%&.
14428
14429 .option received_header_text main string&!! "see below"
14430 .cindex "customizing" "&'Received:'& header"
14431 .cindex "&'Received:'& header line" "customizing"
14432 This string defines the contents of the &'Received:'& message header that is
14433 added to each message, except for the timestamp, which is automatically added
14434 on at the end (preceded by a semicolon). The string is expanded each time it is
14435 used. If the expansion yields an empty string, no &'Received:'& header line is
14436 added to the message. Otherwise, the string should start with the text
14437 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
14438 header lines. The default setting is:
14439
14440 .code
14441 received_header_text = Received: \
14442   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
14443   {${if def:sender_ident \
14444   {from ${quote_local_part:$sender_ident} }}\
14445   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
14446   by $primary_hostname \
14447   ${if def:received_protocol {with $received_protocol}} \
14448   ${if def:tls_cipher {($tls_cipher)\n\t}}\
14449   (Exim $version_number)\n\t\
14450   ${if def:sender_address \
14451   {(envelope-from <$sender_address>)\n\t}}\
14452   id $message_exim_id\
14453   ${if def:received_for {\n\tfor $received_for}}
14454 .endd
14455
14456 The reference to the TLS cipher is omitted when Exim is built without TLS
14457 support. The use of conditional expansions ensures that this works for both
14458 locally generated messages and messages received from remote hosts, giving
14459 header lines such as the following:
14460 .code
14461 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
14462 by marley.carol.example with esmtp (Exim 4.00)
14463 (envelope-from <bob@carol.example>)
14464 id 16IOWa-00019l-00
14465 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
14466 Received: by scrooge.carol.example with local (Exim 4.00)
14467 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
14468 .endd
14469 Until the body of the message has been received, the timestamp is the time when
14470 the message started to be received. Once the body has arrived, and all policy
14471 checks have taken place, the timestamp is updated to the time at which the
14472 message was accepted.
14473
14474
14475 .option received_headers_max main integer 30
14476 .cindex "loop" "prevention"
14477 .cindex "mail loop prevention"
14478 .cindex "&'Received:'& header line" "counting"
14479 When a message is to be delivered, the number of &'Received:'& headers is
14480 counted, and if it is greater than this parameter, a mail loop is assumed to
14481 have occurred, the delivery is abandoned, and an error message is generated.
14482 This applies to both local and remote deliveries.
14483
14484
14485 .option recipient_unqualified_hosts main "host list&!!" unset
14486 .cindex "unqualified addresses"
14487 .cindex "host" "unqualified addresses from"
14488 This option lists those hosts from which Exim is prepared to accept unqualified
14489 recipient addresses in message envelopes. The addresses are made fully
14490 qualified by the addition of the &%qualify_recipient%& value. This option also
14491 affects message header lines. Exim does not reject unqualified recipient
14492 addresses in headers, but it qualifies them only if the message came from a
14493 host that matches &%recipient_unqualified_hosts%&,
14494 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
14495 option was not set.
14496
14497
14498 .option recipients_max main integer 0
14499 .cindex "limit" "number of recipients"
14500 .cindex "recipient" "maximum number"
14501 If this option is set greater than zero, it specifies the maximum number of
14502 original recipients for any message. Additional recipients that are generated
14503 by aliasing or forwarding do not count. SMTP messages get a 452 response for
14504 all recipients over the limit; earlier recipients are delivered as normal.
14505 Non-SMTP messages with too many recipients are failed, and no deliveries are
14506 done.
14507
14508 .cindex "RCPT" "maximum number of incoming"
14509 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
14510 RCPT commands in a single message.
14511
14512
14513 .option recipients_max_reject main boolean false
14514 If this option is set true, Exim rejects SMTP messages containing too many
14515 recipients by giving 552 errors to the surplus RCPT commands, and a 554
14516 error to the eventual DATA command. Otherwise (the default) it gives a 452
14517 error to the surplus RCPT commands and accepts the message on behalf of the
14518 initial set of recipients. The remote server should then re-send the message
14519 for the remaining recipients at a later time.
14520
14521
14522 .option remote_max_parallel main integer 2
14523 .cindex "delivery" "parallelism for remote"
14524 This option controls parallel delivery of one message to a number of remote
14525 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
14526 does all the remote deliveries for a message one by one. Otherwise, if a single
14527 message has to be delivered to more than one remote host, or if several copies
14528 have to be sent to the same remote host, up to &%remote_max_parallel%&
14529 deliveries are done simultaneously. If more than &%remote_max_parallel%&
14530 deliveries are required, the maximum number of processes are started, and as
14531 each one finishes, another is begun. The order of starting processes is the
14532 same as if sequential delivery were being done, and can be controlled by the
14533 &%remote_sort_domains%& option. If parallel delivery takes place while running
14534 with debugging turned on, the debugging output from each delivery process is
14535 tagged with its process id.
14536
14537 This option controls only the maximum number of parallel deliveries for one
14538 message in one Exim delivery process. Because Exim has no central queue
14539 manager, there is no way of controlling the total number of simultaneous
14540 deliveries if the configuration allows a delivery attempt as soon as a message
14541 is received.
14542
14543 .cindex "number of deliveries"
14544 .cindex "delivery" "maximum number of"
14545 If you want to control the total number of deliveries on the system, you
14546 need to set the &%queue_only%& option. This ensures that all incoming messages
14547 are added to the queue without starting a delivery process. Then set up an Exim
14548 daemon to start queue runner processes at appropriate intervals (probably
14549 fairly often, for example, every minute), and limit the total number of queue
14550 runners by setting the &%queue_run_max%& parameter. Because each queue runner
14551 delivers only one message at a time, the maximum number of deliveries that can
14552 then take place at once is &%queue_run_max%& multiplied by
14553 &%remote_max_parallel%&.
14554
14555 If it is purely remote deliveries you want to control, use
14556 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
14557 doing the SMTP routing before queueing, so that several messages for the same
14558 host will eventually get delivered down the same connection.
14559
14560
14561 .option remote_sort_domains main "domain list&!!" unset
14562 .cindex "sorting remote deliveries"
14563 .cindex "delivery" "sorting remote"
14564 When there are a number of remote deliveries for a message, they are sorted by
14565 domain into the order given by this list. For example,
14566 .code
14567 remote_sort_domains = *.cam.ac.uk:*.uk
14568 .endd
14569 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
14570 then to those in the &%uk%& domain, then to any others.
14571
14572
14573 .option retry_data_expire main time 7d
14574 .cindex "hints database" "data expiry"
14575 This option sets a &"use before"& time on retry information in Exim's hints
14576 database. Any older retry data is ignored. This means that, for example, once a
14577 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
14578 past failures.
14579
14580
14581 .option retry_interval_max main time 24h
14582 .cindex "retry" "limit on interval"
14583 .cindex "limit" "on retry interval"
14584 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
14585 intervals between delivery attempts for messages that cannot be delivered
14586 straight away. This option sets an overall limit to the length of time between
14587 retries. It cannot be set greater than 24 hours; any attempt to do so forces
14588 the default value.
14589
14590
14591 .option return_path_remove main boolean true
14592 .cindex "&'Return-path:'& header line" "removing"
14593 RFC 2821, section 4.4, states that an SMTP server must insert a
14594 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
14595 The &'Return-path:'& header preserves the sender address as received in the
14596 MAIL command. This description implies that this header should not be present
14597 in an incoming message. If &%return_path_remove%& is true, any existing
14598 &'Return-path:'& headers are removed from messages at the time they are
14599 received. Exim's transports have options for adding &'Return-path:'& headers at
14600 the time of delivery. They are normally used only for final local deliveries.
14601
14602
14603 .option return_size_limit main integer 100K
14604 This option is an obsolete synonym for &%bounce_return_size_limit%&.
14605
14606
14607 .option rfc1413_hosts main "host list&!!" *
14608 .cindex "RFC 1413"
14609 .cindex "host" "for RFC 1413 calls"
14610 RFC 1413 identification calls are made to any client host which matches an item
14611 in the list.
14612
14613 .option rfc1413_query_timeout main time 5s
14614 .cindex "RFC 1413" "query timeout"
14615 .cindex "timeout" "for RFC 1413 call"
14616 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
14617 no RFC 1413 calls are ever made.
14618
14619
14620 .option sender_unqualified_hosts main "host list&!!" unset
14621 .cindex "unqualified addresses"
14622 .cindex "host" "unqualified addresses from"
14623 This option lists those hosts from which Exim is prepared to accept unqualified
14624 sender addresses. The addresses are made fully qualified by the addition of
14625 &%qualify_domain%&. This option also affects message header lines. Exim does
14626 not reject unqualified addresses in headers that contain sender addresses, but
14627 it qualifies them only if the message came from a host that matches
14628 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
14629 using TCP/IP), and the &%-bnq%& option was not set.
14630
14631
14632 .option smtp_accept_keepalive main boolean true
14633 .cindex "keepalive" "on incoming connection"
14634 This option controls the setting of the SO_KEEPALIVE option on incoming
14635 TCP/IP socket connections. When set, it causes the kernel to probe idle
14636 connections periodically, by sending packets with &"old"& sequence numbers. The
14637 other end of the connection should send an acknowledgment if the connection is
14638 still okay or a reset if the connection has been aborted. The reason for doing
14639 this is that it has the beneficial effect of freeing up certain types of
14640 connection that can get stuck when the remote host is disconnected without
14641 tidying up the TCP/IP call properly. The keepalive mechanism takes several
14642 hours to detect unreachable hosts.
14643
14644
14645
14646 .option smtp_accept_max main integer 20
14647 .cindex "limit" "incoming SMTP connections"
14648 .cindex "SMTP" "incoming connection count"
14649 .cindex "inetd"
14650 This option specifies the maximum number of simultaneous incoming SMTP calls
14651 that Exim will accept. It applies only to the listening daemon; there is no
14652 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
14653 value is set to zero, no limit is applied. However, it is required to be
14654 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
14655 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
14656
14657 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
14658 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
14659 that limit has not been reached for the client host, &%smtp_accept_reserve%&
14660 and &%smtp_load_reserve%& are then checked before accepting the connection.
14661
14662
14663 .option smtp_accept_max_nonmail main integer 10
14664 .cindex "limit" "non-mail SMTP commands"
14665 .cindex "SMTP" "limiting non-mail commands"
14666 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
14667 the connection if there are too many. This option defines &"too many"&. The
14668 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
14669 client looping sending EHLO, for example. The check is applied only if the
14670 client host matches &%smtp_accept_max_nonmail_hosts%&.
14671
14672 When a new message is expected, one occurrence of RSET is not counted. This
14673 allows a client to send one RSET between messages (this is not necessary,
14674 but some clients do it). Exim also allows one uncounted occurrence of HELO
14675 or EHLO, and one occurrence of STARTTLS between messages. After
14676 starting up a TLS session, another EHLO is expected, and so it too is not
14677 counted. The first occurrence of AUTH in a connection, or immediately
14678 following STARTTLS is not counted. Otherwise, all commands other than
14679 MAIL, RCPT, DATA, and QUIT are counted.
14680
14681
14682 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
14683 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
14684 check by setting this option. The default value makes it apply to all hosts. By
14685 changing the value, you can exclude any badly-behaved hosts that you have to
14686 live with.
14687
14688
14689 . Allow this long option name to split; give it unsplit as a fifth argument
14690 . for the automatic .oindex that is generated by .option.
14691
14692 .option "smtp_accept_max_per_ &~&~connection" main integer 1000 &&&
14693          smtp_accept_max_per_connection
14694 .cindex "SMTP" "limiting incoming message count"
14695 .cindex "limit" "messages per SMTP connection"
14696 The value of this option limits the number of MAIL commands that Exim is
14697 prepared to accept over a single SMTP connection, whether or not each command
14698 results in the transfer of a message. After the limit is reached, a 421
14699 response is given to subsequent MAIL commands. This limit is a safety
14700 precaution against a client that goes mad (incidents of this type have been
14701 seen).
14702
14703
14704 .option smtp_accept_max_per_host main string&!! unset
14705 .cindex "limit" "SMTP connections from one host"
14706 .cindex "host" "limiting SMTP connections from"
14707 This option restricts the number of simultaneous IP connections from a single
14708 host (strictly, from a single IP address) to the Exim daemon. The option is
14709 expanded, to enable different limits to be applied to different hosts by
14710 reference to &$sender_host_address$&. Once the limit is reached, additional
14711 connection attempts from the same host are rejected with error code 421. This
14712 is entirely independent of &%smtp_accept_reserve%&. The option's default value
14713 of zero imposes no limit. If this option is set greater than zero, it is
14714 required that &%smtp_accept_max%& be non-zero.
14715
14716 &*Warning*&: When setting this option you should not use any expansion
14717 constructions that take an appreciable amount of time. The expansion and test
14718 happen in the main daemon loop, in order to reject additional connections
14719 without forking additional processes (otherwise a denial-of-service attack
14720 could cause a vast number or processes to be created). While the daemon is
14721 doing this processing, it cannot accept any other incoming connections.
14722
14723
14724
14725 .option smtp_accept_queue main integer 0
14726 .cindex "SMTP" "incoming connection count"
14727 .cindex "queueing incoming messages"
14728 .cindex "message" "queueing by SMTP connection count"
14729 If the number of simultaneous incoming SMTP connections being handled via the
14730 listening daemon exceeds this value, messages received by SMTP are just placed
14731 on the queue; no delivery processes are started automatically. The count is
14732 fixed at the start of an SMTP connection. It cannot be updated in the
14733 subprocess that receives messages, and so the queueing or not queueing applies
14734 to all messages received in the same connection.
14735
14736 A value of zero implies no limit, and clearly any non-zero value is useful only
14737 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
14738 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
14739 various &%-od%&&'x'& command line options.
14740
14741
14742 . Allow this long option name to split; give it unsplit as a fifth argument
14743 . for the automatic .oindex that is generated by .option.
14744
14745 .option "smtp_accept_queue_per_ &~&~connection" main integer 10 &&&
14746          smtp_accept_queue_per_connection
14747 .cindex "queueing incoming messages"
14748 .cindex "message" "queueing by message count"
14749 This option limits the number of delivery processes that Exim starts
14750 automatically when receiving messages via SMTP, whether via the daemon or by
14751 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
14752 and the number of messages received in a single SMTP session exceeds this
14753 number, subsequent messages are placed on the queue, but no delivery processes
14754 are started. This helps to limit the number of Exim processes when a server
14755 restarts after downtime and there is a lot of mail waiting for it on other
14756 systems. On large systems, the default should probably be increased, and on
14757 dial-in client systems it should probably be set to zero (that is, disabled).
14758
14759
14760 .option smtp_accept_reserve main integer 0
14761 .cindex "SMTP" "incoming call count"
14762 .cindex "host" "reserved"
14763 When &%smtp_accept_max%& is set greater than zero, this option specifies a
14764 number of SMTP connections that are reserved for connections from the hosts
14765 that are specified in &%smtp_reserve_hosts%&. The value set in
14766 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
14767 restricted to this number of connections; the option specifies a minimum number
14768 of connection slots for them, not a maximum. It is a guarantee that this group
14769 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
14770 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
14771 individual host.
14772
14773 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
14774 set to 5, once there are 45 active connections (from any hosts), new
14775 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
14776 provided the other criteria for acceptance are met.
14777
14778
14779 .option smtp_active_hostname main string&!! unset
14780 .cindex "host" "name in SMTP responses"
14781 .cindex "SMTP" "host name in responses"
14782 .vindex "&$primary_hostname$&"
14783 This option is provided for multi-homed servers that want to masquerade as
14784 several different hosts. At the start of an incoming SMTP connection, its value
14785 is expanded and used instead of the value of &$primary_hostname$& in SMTP
14786 responses. For example, it is used as domain name in the response to an
14787 incoming HELO or EHLO command.
14788
14789 .vindex "&$smtp_active_hostname$&"
14790 The active hostname is placed in the &$smtp_active_hostname$& variable, which
14791 is saved with any messages that are received. It is therefore available for use
14792 in routers and transports when the message is later delivered.
14793
14794 If this option is unset, or if its expansion is forced to fail, or if the
14795 expansion results in an empty string, the value of &$primary_hostname$& is
14796 used. Other expansion failures cause a message to be written to the main and
14797 panic logs, and the SMTP command receives a temporary error. Typically, the
14798 value of &%smtp_active_hostname%& depends on the incoming interface address.
14799 For example:
14800 .code
14801 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
14802   {cox.mydomain}{box.mydomain}}
14803 .endd
14804
14805 Although &$smtp_active_hostname$& is primarily concerned with incoming
14806 messages, it is also used as the default for HELO commands in callout
14807 verification if there is no remote transport from which to obtain a
14808 &%helo_data%& value.
14809
14810 .option smtp_banner main string&!! "see below"
14811 .cindex "SMTP" "welcome banner"
14812 .cindex "banner for SMTP"
14813 .cindex "welcome banner for SMTP"
14814 .cindex "customizing" "SMTP banner"
14815 This string, which is expanded every time it is used, is output as the initial
14816 positive response to an SMTP connection. The default setting is:
14817 .code
14818 smtp_banner = $smtp_active_hostname ESMTP Exim \
14819   $version_number $tod_full
14820 .endd
14821 Failure to expand the string causes a panic error. If you want to create a
14822 multiline response to the initial SMTP connection, use &"\n"& in the string at
14823 appropriate points, but not at the end. Note that the 220 code is not included
14824 in this string. Exim adds it automatically (several times in the case of a
14825 multiline response).
14826
14827
14828 .option smtp_check_spool_space main boolean true
14829 .cindex "checking disk space"
14830 .cindex "disk space, checking"
14831 .cindex "spool directory" "checking space"
14832 When this option is set, if an incoming SMTP session encounters the SIZE
14833 option on a MAIL command, it checks that there is enough space in the
14834 spool directory's partition to accept a message of that size, while still
14835 leaving free the amount specified by &%check_spool_space%& (even if that value
14836 is zero). If there isn't enough space, a temporary error code is returned.
14837
14838
14839 .option smtp_connect_backlog main integer 20
14840 .cindex "connection backlog"
14841 .cindex "SMTP" "connection backlog"
14842 .cindex "backlog of connections"
14843 This option specifies a maximum number of waiting SMTP connections. Exim passes
14844 this value to the TCP/IP system when it sets up its listener. Once this number
14845 of connections are waiting for the daemon's attention, subsequent connection
14846 attempts are refused at the TCP/IP level. At least, that is what the manuals
14847 say; in some circumstances such connection attempts have been observed to time
14848 out instead. For large systems it is probably a good idea to increase the
14849 value (to 50, say). It also gives some protection against denial-of-service
14850 attacks by SYN flooding.
14851
14852
14853 .option smtp_enforce_sync main boolean true
14854 .cindex "SMTP" "synchronization checking"
14855 .cindex "synchronization checking in SMTP"
14856 The SMTP protocol specification requires the client to wait for a response from
14857 the server at certain points in the dialogue. Without PIPELINING these
14858 synchronization points are after every command; with PIPELINING they are
14859 fewer, but they still exist.
14860
14861 Some spamming sites send out a complete set of SMTP commands without waiting
14862 for any response. Exim protects against this by rejecting a message if the
14863 client has sent further input when it should not have. The error response &"554
14864 SMTP synchronization error"& is sent, and the connection is dropped. Testing
14865 for this error cannot be perfect because of transmission delays (unexpected
14866 input may be on its way but not yet received when Exim checks). However, it
14867 does detect many instances.
14868
14869 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
14870 If you want to disable the check selectively (for example, only for certain
14871 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
14872 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
14873
14874
14875
14876 .option smtp_etrn_command main string&!! unset
14877 .cindex "ETRN" "command to be run"
14878 .vindex "&$domain$&"
14879 If this option is set, the given command is run whenever an SMTP ETRN
14880 command is received from a host that is permitted to issue such commands (see
14881 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
14882 are independently expanded. The expansion variable &$domain$& is set to the
14883 argument of the ETRN command, and no syntax checking is done on it. For
14884 example:
14885 .code
14886 smtp_etrn_command = /etc/etrn_command $domain \
14887                     $sender_host_address
14888 .endd
14889 A new process is created to run the command, but Exim does not wait for it to
14890 complete. Consequently, its status cannot be checked. If the command cannot be
14891 run, a line is written to the panic log, but the ETRN caller still receives
14892 a 250 success response. Exim is normally running under its own uid when
14893 receiving SMTP, so it is not possible for it to change the uid before running
14894 the command.
14895
14896
14897 .option smtp_etrn_serialize main boolean true
14898 .cindex "ETRN" "serializing"
14899 When this option is set, it prevents the simultaneous execution of more than
14900 one identical command as a result of ETRN in an SMTP connection. See
14901 section &<<SECTETRN>>& for details.
14902
14903
14904 .option smtp_load_reserve main fixed-point unset
14905 .cindex "load average"
14906 If the system load average ever gets higher than this, incoming SMTP calls are
14907 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
14908 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
14909 the load is over the limit. The option has no effect on ancient operating
14910 systems on which Exim cannot determine the load average. See also
14911 &%deliver_queue_load_max%& and &%queue_only_load%&.
14912
14913
14914
14915 .option smtp_max_synprot_errors main integer 3
14916 .cindex "SMTP" "limiting syntax and protocol errors"
14917 .cindex "limit" "SMTP syntax and protocol errors"
14918 Exim rejects SMTP commands that contain syntax or protocol errors. In
14919 particular, a syntactically invalid email address, as in this command:
14920 .code
14921 RCPT TO:<abc xyz@a.b.c>
14922 .endd
14923 causes immediate rejection of the command, before any other tests are done.
14924 (The ACL cannot be run if there is no valid address to set up for it.) An
14925 example of a protocol error is receiving RCPT before MAIL. If there are
14926 too many syntax or protocol errors in one SMTP session, the connection is
14927 dropped. The limit is set by this option.
14928
14929 .cindex "PIPELINING" "expected errors"
14930 When the PIPELINING extension to SMTP is in use, some protocol errors are
14931 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
14932 Exim assumes that PIPELINING will be used if it advertises it (see
14933 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
14934 not count towards the limit.
14935
14936
14937
14938 .option smtp_max_unknown_commands main integer 3
14939 .cindex "SMTP" "limiting unknown commands"
14940 .cindex "limit" "unknown SMTP commands"
14941 If there are too many unrecognized commands in an incoming SMTP session, an
14942 Exim server drops the connection. This is a defence against some kinds of abuse
14943 that subvert web
14944 clients
14945 into making connections to SMTP ports; in these circumstances, a number of
14946 non-SMTP command lines are sent first.
14947
14948
14949
14950 .option smtp_ratelimit_hosts main "host list&!!" unset
14951 .cindex "SMTP" "rate limiting"
14952 .cindex "limit" "rate of message arrival"
14953 .cindex "RCPT" "rate limiting"
14954 Some sites find it helpful to be able to limit the rate at which certain hosts
14955 can send them messages, and the rate at which an individual message can specify
14956 recipients.
14957
14958 Exim has two rate-limiting facilities. This section describes the older
14959 facility, which can limit rates within a single connection. The newer
14960 &%ratelimit%& ACL condition can limit rates across all connections. See section
14961 &<<SECTratelimiting>>& for details of the newer facility.
14962
14963 When a host matches &%smtp_ratelimit_hosts%&, the values of
14964 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
14965 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
14966 respectively. Each option, if set, must contain a set of four comma-separated
14967 values:
14968
14969 .ilist
14970 A threshold, before which there is no rate limiting.
14971 .next
14972 An initial time delay. Unlike other times in Exim, numbers with decimal
14973 fractional parts are allowed here.
14974 .next
14975 A factor by which to increase the delay each time.
14976 .next
14977 A maximum value for the delay. This should normally be less than 5 minutes,
14978 because after that time, the client is liable to timeout the SMTP command.
14979 .endlist
14980
14981 For example, these settings have been used successfully at the site which
14982 first suggested this feature, for controlling mail from their customers:
14983 .code
14984 smtp_ratelimit_mail = 2,0.5s,1.05,4m
14985 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
14986 .endd
14987 The first setting specifies delays that are applied to MAIL commands after
14988 two have been received over a single connection. The initial delay is 0.5
14989 seconds, increasing by a factor of 1.05 each time. The second setting applies
14990 delays to RCPT commands when more than four occur in a single message.
14991
14992
14993 .option smtp_ratelimit_mail main string unset
14994 See &%smtp_ratelimit_hosts%& above.
14995
14996
14997 .option smtp_ratelimit_rcpt main string unset
14998 See &%smtp_ratelimit_hosts%& above.
14999
15000
15001 .option smtp_receive_timeout main time 5m
15002 .cindex "timeout" "for SMTP input"
15003 .cindex "SMTP" "input timeout"
15004 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
15005 input, including batch SMTP. If a line of input (either an SMTP command or a
15006 data line) is not received within this time, the SMTP connection is dropped and
15007 the message is abandoned.
15008 A line is written to the log containing one of the following messages:
15009 .code
15010 SMTP command timeout on connection from...
15011 SMTP data timeout on connection from...
15012 .endd
15013 The former means that Exim was expecting to read an SMTP command; the latter
15014 means that it was in the DATA phase, reading the contents of a message.
15015
15016
15017 .oindex "&%-os%&"
15018 The value set by this option can be overridden by the
15019 &%-os%& command-line option. A setting of zero time disables the timeout, but
15020 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
15021 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
15022 timeout is controlled by &%receive_timeout%& and &%-or%&.
15023
15024
15025 .option smtp_reserve_hosts main "host list&!!" unset
15026 This option defines hosts for which SMTP connections are reserved; see
15027 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
15028
15029
15030 .option smtp_return_error_details main boolean false
15031 .cindex "SMTP" "details policy failures"
15032 .cindex "policy control" "rejection, returning details"
15033 In the default state, Exim uses bland messages such as
15034 &"Administrative prohibition"& when it rejects SMTP commands for policy
15035 reasons. Many sysadmins like this because it gives away little information
15036 to spammers. However, some other sysadmins who are applying strict checking
15037 policies want to give out much fuller information about failures. Setting
15038 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
15039 example, instead of &"Administrative prohibition"&, it might give:
15040 .code
15041 550-Rejected after DATA: '>' missing at end of address:
15042 550 failing address in "From" header is: <user@dom.ain
15043 .endd
15044
15045 .option spamd_address main string "see below"
15046 This option is available when Exim is compiled with the content-scanning
15047 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
15048 The default value is
15049 .code
15050 127.0.0.1 783
15051 .endd
15052 See section &<<SECTscanspamass>>& for more details.
15053
15054
15055
15056 .option split_spool_directory main boolean false
15057 .cindex "multiple spool directories"
15058 .cindex "spool directory" "split"
15059 .cindex "directories, multiple"
15060 If this option is set, it causes Exim to split its input directory into 62
15061 subdirectories, each with a single alphanumeric character as its name. The
15062 sixth character of the message id is used to allocate messages to
15063 subdirectories; this is the least significant base-62 digit of the time of
15064 arrival of the message.
15065
15066 Splitting up the spool in this way may provide better performance on systems
15067 where there are long mail queues, by reducing the number of files in any one
15068 directory. The msglog directory is also split up in a similar way to the input
15069 directory; however, if &%preserve_message_logs%& is set, all old msglog files
15070 are still placed in the single directory &_msglog.OLD_&.
15071
15072 It is not necessary to take any special action for existing messages when
15073 changing &%split_spool_directory%&. Exim notices messages that are in the
15074 &"wrong"& place, and continues to process them. If the option is turned off
15075 after a period of being on, the subdirectories will eventually empty and be
15076 automatically deleted.
15077
15078 When &%split_spool_directory%& is set, the behaviour of queue runner processes
15079 changes. Instead of creating a list of all messages in the queue, and then
15080 trying to deliver each one in turn, it constructs a list of those in one
15081 sub-directory and tries to deliver them, before moving on to the next
15082 sub-directory. The sub-directories are processed in a random order. This
15083 spreads out the scanning of the input directories, and uses less memory. It is
15084 particularly beneficial when there are lots of messages on the queue. However,
15085 if &%queue_run_in_order%& is set, none of this new processing happens. The
15086 entire queue has to be scanned and sorted before any deliveries can start.
15087
15088
15089 .option spool_directory main string&!! "set at compile time"
15090 .cindex "spool directory" "path to"
15091 This defines the directory in which Exim keeps its spool, that is, the messages
15092 it is waiting to deliver. The default value is taken from the compile-time
15093 configuration setting, if there is one. If not, this option must be set. The
15094 string is expanded, so it can contain, for example, a reference to
15095 &$primary_hostname$&.
15096
15097 If the spool directory name is fixed on your installation, it is recommended
15098 that you set it at build time rather than from this option, particularly if the
15099 log files are being written to the spool directory (see &%log_file_path%&).
15100 Otherwise log files cannot be used for errors that are detected early on, such
15101 as failures in the configuration file.
15102
15103 By using this option to override the compiled-in path, it is possible to run
15104 tests of Exim without using the standard spool.
15105
15106 .option sqlite_lock_timeout main time 5s
15107 .cindex "sqlite lookup type" "lock timeout"
15108 This option controls the timeout that the &(sqlite)& lookup uses when trying to
15109 access an SQLite database. See section &<<SECTsqlite>>& for more details.
15110
15111 .option strict_acl_vars main boolean false
15112 .cindex "&ACL;" "variables, handling unset"
15113 This option controls what happens if a syntactically valid but undefined ACL
15114 variable is referenced. If it is false (the default), an empty string
15115 is substituted; if it is true, an error is generated. See section
15116 &<<SECTaclvariables>>& for details of ACL variables.
15117
15118 .option strip_excess_angle_brackets main boolean false
15119 .cindex "angle brackets, excess"
15120 If this option is set, redundant pairs of angle brackets round &"route-addr"&
15121 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
15122 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
15123 passed on to another MTA, the excess angle brackets are not passed on. If this
15124 option is not set, multiple pairs of angle brackets cause a syntax error.
15125
15126
15127 .option strip_trailing_dot main boolean false
15128 .cindex "trailing dot on domain"
15129 .cindex "dot" "trailing on domain"
15130 If this option is set, a trailing dot at the end of a domain in an address is
15131 ignored. If this is in the envelope and the message is passed on to another
15132 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
15133 domain causes a syntax error.
15134 However, addresses in header lines are checked only when an ACL requests header
15135 syntax checking.
15136
15137
15138 .option syslog_duplication main boolean true
15139 .cindex "syslog" "duplicate log lines; suppressing"
15140 When Exim is logging to syslog, it writes the log lines for its three
15141 separate logs at different syslog priorities so that they can in principle
15142 be separated on the logging hosts. Some installations do not require this
15143 separation, and in those cases, the duplication of certain log lines is a
15144 nuisance. If &%syslog_duplication%& is set false, only one copy of any
15145 particular log line is written to syslog. For lines that normally go to
15146 both the main log and the reject log, the reject log version (possibly
15147 containing message header lines) is written, at LOG_NOTICE priority.
15148 Lines that normally go to both the main and the panic log are written at
15149 the LOG_ALERT priority.
15150
15151
15152 .option syslog_facility main string unset
15153 .cindex "syslog" "facility; setting"
15154 This option sets the syslog &"facility"& name, used when Exim is logging to
15155 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
15156 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
15157 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
15158 details of Exim's logging.
15159
15160
15161
15162 .option syslog_processname main string &`exim`&
15163 .cindex "syslog" "process name; setting"
15164 This option sets the syslog &"ident"& name, used when Exim is logging to
15165 syslog. The value must be no longer than 32 characters. See chapter
15166 &<<CHAPlog>>& for details of Exim's logging.
15167
15168
15169
15170 .option syslog_timestamp main boolean true
15171 .cindex "syslog" "timestamps"
15172 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
15173 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
15174 details of Exim's logging.
15175
15176
15177 .option system_filter main string&!! unset
15178 .cindex "filter" "system filter"
15179 .cindex "system filter" "specifying"
15180 .cindex "Sieve filter" "not available for system filter"
15181 This option specifies an Exim filter file that is applied to all messages at
15182 the start of each delivery attempt, before any routing is done. System filters
15183 must be Exim filters; they cannot be Sieve filters. If the system filter
15184 generates any deliveries to files or pipes, or any new mail messages, the
15185 appropriate &%system_filter_..._transport%& option(s) must be set, to define
15186 which transports are to be used. Details of this facility are given in chapter
15187 &<<CHAPsystemfilter>>&.
15188
15189
15190 .option system_filter_directory_transport main string&!! unset
15191 .vindex "&$address_file$&"
15192 This sets the name of the transport driver that is to be used when the
15193 &%save%& command in a system message filter specifies a path ending in &"/"&,
15194 implying delivery of each message into a separate file in some directory.
15195 During the delivery, the variable &$address_file$& contains the path name.
15196
15197
15198 .option system_filter_file_transport main string&!! unset
15199 .cindex "file" "transport for system filter"
15200 This sets the name of the transport driver that is to be used when the &%save%&
15201 command in a system message filter specifies a path not ending in &"/"&. During
15202 the delivery, the variable &$address_file$& contains the path name.
15203
15204 .option system_filter_group main string unset
15205 .cindex "gid (group id)" "system filter"
15206 This option is used only when &%system_filter_user%& is also set. It sets the
15207 gid under which the system filter is run, overriding any gid that is associated
15208 with the user. The value may be numerical or symbolic.
15209
15210 .option system_filter_pipe_transport main string&!! unset
15211 .cindex "&(pipe)& transport" "for system filter"
15212 .vindex "&$address_pipe$&"
15213 This specifies the transport driver that is to be used when a &%pipe%& command
15214 is used in a system filter. During the delivery, the variable &$address_pipe$&
15215 contains the pipe command.
15216
15217
15218 .option system_filter_reply_transport main string&!! unset
15219 .cindex "&(autoreply)& transport" "for system filter"
15220 This specifies the transport driver that is to be used when a &%mail%& command
15221 is used in a system filter.
15222
15223 .option system_filter_user main string unset
15224 .cindex "uid (user id)" "system filter"
15225 If this option is set to root, the system filter is run in the main Exim
15226 delivery process, as root.  Otherwise, the system filter runs in a separate
15227 process, as the given user, defaulting to the Exim run-time user.
15228 Unless the string consists entirely of digits, it
15229 is looked up in the password data. Failure to find the named user causes a
15230 configuration error. The gid is either taken from the password data, or
15231 specified by &%system_filter_group%&. When the uid is specified numerically,
15232 &%system_filter_group%& is required to be set.
15233
15234 If the system filter generates any pipe, file, or reply deliveries, the uid
15235 under which the filter is run is used when transporting them, unless a
15236 transport option overrides.
15237
15238
15239 .option tcp_nodelay main boolean true
15240 .cindex "daemon" "TCP_NODELAY on sockets"
15241 .cindex "Nagle algorithm"
15242 .cindex "TCP_NODELAY on listening sockets"
15243 If this option is set false, it stops the Exim daemon setting the
15244 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
15245 turns off the &"Nagle algorithm"&, which is a way of improving network
15246 performance in interactive (character-by-character) situations. Turning it off
15247 should improve Exim's performance a bit, so that is what happens by default.
15248 However, it appears that some broken clients cannot cope, and time out. Hence
15249 this option. It affects only those sockets that are set up for listening by the
15250 daemon. Sockets created by the smtp transport for delivering mail always set
15251 TCP_NODELAY.
15252
15253
15254 .option timeout_frozen_after main time 0s
15255 .cindex "frozen messages" "timing out"
15256 .cindex "timeout" "frozen messages"
15257 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
15258 message of any kind that has been on the queue for longer than the given time
15259 is automatically cancelled at the next queue run. If the frozen message is a
15260 bounce message, it is just discarded; otherwise, a bounce is sent to the
15261 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
15262 If you want to timeout frozen bounce messages earlier than other kinds of
15263 frozen message, see &%ignore_bounce_errors_after%&.
15264
15265 &*Note:*& the default value of zero means no timeouts; with this setting,
15266 frozen messages remain on the queue forever (except for any frozen bounce
15267 messages that are released by &%ignore_bounce_errors_after%&).
15268
15269
15270 .option timezone main string unset
15271 .cindex "timezone, setting"
15272 The value of &%timezone%& is used to set the environment variable TZ while
15273 running Exim (if it is different on entry). This ensures that all timestamps
15274 created by Exim are in the required timezone. If you want all your timestamps
15275 to be in UTC (aka GMT) you should set
15276 .code
15277 timezone = UTC
15278 .endd
15279 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
15280 or, if that is not set, from the value of the TZ environment variable when Exim
15281 is built. If &%timezone%& is set to the empty string, either at build or run
15282 time, any existing TZ variable is removed from the environment when Exim
15283 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
15284 unfortunately not all, operating systems.
15285
15286
15287 .option tls_advertise_hosts main "host list&!!" unset
15288 .cindex "TLS" "advertising"
15289 .cindex "encryption" "on SMTP connection"
15290 .cindex "SMTP" "encrypted connection"
15291 When Exim is built with support for TLS encrypted connections, the availability
15292 of the STARTTLS command to set up an encrypted session is advertised in
15293 response to EHLO only to those client hosts that match this option. See
15294 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
15295
15296
15297 .option tls_certificate main string&!! unset
15298 .cindex "TLS" "server certificate; location of"
15299 .cindex "certificate" "server, location of"
15300 The value of this option is expanded, and must then be the absolute path to a
15301 file which contains the server's certificates. The server's private key is also
15302 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
15303 &<<CHAPTLS>>& for further details.
15304
15305 &*Note*&: The certificates defined by this option are used only when Exim is
15306 receiving incoming messages as a server. If you want to supply certificates for
15307 use when sending messages as a client, you must set the &%tls_certificate%&
15308 option in the relevant &(smtp)& transport.
15309
15310
15311 .option tls_crl main string&!! unset
15312 .cindex "TLS" "server certificate revocation list"
15313 .cindex "certificate" "revocation list for server"
15314 This option specifies a certificate revocation list. The expanded value must
15315 be the name of a file that contains a CRL in PEM format.
15316
15317
15318 .option tls_dhparam main string&!! unset
15319 .cindex "TLS" "D-H parameters for server"
15320 The value of this option is expanded, and must then be the absolute path to
15321 a file which contains the server's DH parameter values.
15322 This is used only for OpenSSL. When Exim is linked with GnuTLS, this option is
15323 ignored. See section &<<SECTopenvsgnu>>& for further details.
15324
15325
15326 .option tls_on_connect_ports main "string list" unset
15327 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
15328 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
15329 set up without waiting for the client to issue a STARTTLS command. For
15330 further details, see section &<<SECTsupobssmt>>&.
15331
15332
15333
15334 .option tls_privatekey main string&!! unset
15335 .cindex "TLS" "server private key; location of"
15336 The value of this option is expanded, and must then be the absolute path to a
15337 file which contains the server's private key. If this option is unset, or if
15338 the expansion is forced to fail, or the result is an empty string, the private
15339 key is assumed to be in the same file as the server's certificates. See chapter
15340 &<<CHAPTLS>>& for further details.
15341
15342
15343 .option tls_remember_esmtp main boolean false
15344 .cindex "TLS" "esmtp state; remembering"
15345 .cindex "TLS" "broken clients"
15346 If this option is set true, Exim violates the RFCs by remembering that it is in
15347 &"esmtp"& state after successfully negotiating a TLS session. This provides
15348 support for broken clients that fail to send a new EHLO after starting a
15349 TLS session.
15350
15351
15352 .option tls_require_ciphers main string&!! unset
15353 .cindex "TLS" "requiring specific ciphers"
15354 .cindex "cipher" "requiring specific"
15355 This option controls which ciphers can be used for incoming TLS connections.
15356 The &(smtp)& transport has an option of the same name for controlling outgoing
15357 connections. This option is expanded for each connection, so can be varied for
15358 different clients if required. The value of this option must be a list of
15359 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
15360 in somewhat different ways. If GnuTLS is being used, the client controls the
15361 preference order of the available ciphers. Details are given in sections
15362 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
15363
15364
15365 .option tls_try_verify_hosts main "host list&!!" unset
15366 .cindex "TLS" "client certificate verification"
15367 .cindex "certificate" "verification of client"
15368 See &%tls_verify_hosts%& below.
15369
15370
15371 .option tls_verify_certificates main string&!! unset
15372 .cindex "TLS" "client certificate verification"
15373 .cindex "certificate" "verification of client"
15374 The value of this option is expanded, and must then be the absolute path to
15375 a file containing permitted certificates for clients that
15376 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&. Alternatively, if you
15377 are using OpenSSL, you can set &%tls_verify_certificates%& to the name of a
15378 directory containing certificate files. This does not work with GnuTLS; the
15379 option must be set to the name of a single file if you are using GnuTLS.
15380
15381
15382 .option tls_verify_hosts main "host list&!!" unset
15383 .cindex "TLS" "client certificate verification"
15384 .cindex "certificate" "verification of client"
15385 This option, along with &%tls_try_verify_hosts%&, controls the checking of
15386 certificates from clients. The expected certificates are defined by
15387 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
15388 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
15389 &%tls_verify_certificates%& is not set.
15390
15391 Any client that matches &%tls_verify_hosts%& is constrained by
15392 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
15393 present one of the listed certificates. If it does not, the connection is
15394 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
15395 the host to use TLS. It can still send SMTP commands through unencrypted
15396 connections. Forcing a client to use TLS has to be done separately using an
15397 ACL to reject inappropriate commands when the connection is not encrypted.
15398
15399 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
15400 matches this option (but not &%tls_verify_hosts%&), Exim requests a
15401 certificate and checks it against &%tls_verify_certificates%&, but does not
15402 abort the connection if there is no certificate or if it does not match. This
15403 state can be detected in an ACL, which makes it possible to implement policies
15404 such as &"accept for relay only if a verified certificate has been received,
15405 but accept for local delivery if encrypted, even without a verified
15406 certificate"&.
15407
15408 Client hosts that match neither of these lists are not asked to present
15409 certificates.
15410
15411
15412 .option trusted_groups main "string list&!!" unset
15413 .cindex "trusted groups"
15414 .cindex "groups" "trusted"
15415 This option is expanded just once, at the start of Exim's processing. If this
15416 option is set, any process that is running in one of the listed groups, or
15417 which has one of them as a supplementary group, is trusted. The groups can be
15418 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
15419 details of what trusted callers are permitted to do. If neither
15420 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
15421 are trusted.
15422
15423 .option trusted_users main "string list&!!" unset
15424 .cindex "trusted users"
15425 .cindex "user" "trusted"
15426 This option is expanded just once, at the start of Exim's processing. If this
15427 option is set, any process that is running as one of the listed users is
15428 trusted. The users can be specified numerically or by name. See section
15429 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
15430 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
15431 Exim user are trusted.
15432
15433 .option unknown_login main string&!! unset
15434 .cindex "uid (user id)" "unknown caller"
15435 .vindex "&$caller_uid$&"
15436 This is a specialized feature for use in unusual configurations. By default, if
15437 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
15438 gives up. The &%unknown_login%& option can be used to set a login name to be
15439 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
15440 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
15441 is used for the user's real name (gecos field), unless this has been set by the
15442 &%-F%& option.
15443
15444 .option unknown_username main string unset
15445 See &%unknown_login%&.
15446
15447 .option untrusted_set_sender main "address list&!!" unset
15448 .cindex "trusted users"
15449 .cindex "sender" "setting by untrusted user"
15450 .cindex "untrusted user setting sender"
15451 .cindex "user" "untrusted setting sender"
15452 .cindex "envelope sender"
15453 When an untrusted user submits a message to Exim using the standard input, Exim
15454 normally creates an envelope sender address from the user's login and the
15455 default qualification domain. Data from the &%-f%& option (for setting envelope
15456 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
15457 is used) is ignored.
15458
15459 However, untrusted users are permitted to set an empty envelope sender address,
15460 to declare that a message should never generate any bounces. For example:
15461 .code
15462 exim -f '<>' user@domain.example
15463 .endd
15464 .vindex "&$sender_ident$&"
15465 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
15466 other envelope sender addresses in a controlled way. When it is set, untrusted
15467 users are allowed to set envelope sender addresses that match any of the
15468 patterns in the list. Like all address lists, the string is expanded. The
15469 identity of the user is in &$sender_ident$&, so you can, for example, restrict
15470 users to setting senders that start with their login ids
15471 followed by a hyphen
15472 by a setting like this:
15473 .code
15474 untrusted_set_sender = ^$sender_ident-
15475 .endd
15476 If you want to allow untrusted users to set envelope sender addresses without
15477 restriction, you can use
15478 .code
15479 untrusted_set_sender = *
15480 .endd
15481 The &%untrusted_set_sender%& option applies to all forms of local input, but
15482 only to the setting of the envelope sender. It does not permit untrusted users
15483 to use the other options which trusted user can use to override message
15484 parameters. Furthermore, it does not stop Exim from removing an existing
15485 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
15486 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
15487 overriding these actions. The handling of the &'Sender:'& header is also
15488 described in section &<<SECTthesenhea>>&.
15489
15490 The log line for a message's arrival shows the envelope sender following
15491 &"<="&. For local messages, the user's login always follows, after &"U="&. In
15492 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
15493 envelope sender address, the user's login is shown in parentheses after the
15494 sender address.
15495
15496
15497 .option uucp_from_pattern main string "see below"
15498 .cindex "&""From""& line"
15499 .cindex "UUCP" "&""From""& line"
15500 Some applications that pass messages to an MTA via a command line interface use
15501 an initial line starting with &"From&~"& to pass the envelope sender. In
15502 particular, this is used by UUCP software. Exim recognizes such a line by means
15503 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
15504 matches, the sender address is constructed by expanding the contents of
15505 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
15506 default pattern recognizes lines in the following two forms:
15507 .code
15508 From ph10 Fri Jan  5 12:35 GMT 1996
15509 From ph10 Fri, 7 Jan 97 14:00:00 GMT
15510 .endd
15511 The pattern can be seen by running
15512 .code
15513 exim -bP uucp_from_pattern
15514 .endd
15515 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
15516 year in the second case. The first word after &"From&~"& is matched in the
15517 regular expression by a parenthesized subpattern. The default value for
15518 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
15519 (&"ph10"& in the example above) as the message's sender. See also
15520 &%ignore_fromline_hosts%&.
15521
15522
15523 .option uucp_from_sender main string&!! &`$1`&
15524 See &%uucp_from_pattern%& above.
15525
15526
15527 .option warn_message_file main string unset
15528 .cindex "warning of delay" "customizing the message"
15529 .cindex "customizing" "warning message"
15530 This option defines a template file containing paragraphs of text to be used
15531 for constructing the warning message which is sent by Exim when a message has
15532 been on the queue for a specified amount of time, as specified by
15533 &%delay_warning%&. Details of the file's contents are given in chapter
15534 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
15535
15536
15537 .option write_rejectlog main boolean true
15538 .cindex "reject log" "disabling"
15539 If this option is set false, Exim no longer writes anything to the reject log.
15540 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
15541 .ecindex IIDconfima
15542 .ecindex IIDmaiconf
15543
15544
15545
15546
15547 . ////////////////////////////////////////////////////////////////////////////
15548 . ////////////////////////////////////////////////////////////////////////////
15549
15550 .chapter "Generic options for routers" "CHAProutergeneric"
15551 .scindex IIDgenoprou1 "options" "generic; for routers"
15552 .scindex IIDgenoprou2 "generic options" "router"
15553 This chapter describes the generic options that apply to all routers.
15554 Those that are preconditions are marked with &Dagger; in the &"use"& field.
15555
15556 For a general description of how a router operates, see sections
15557 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
15558 which the preconditions are tested. The order of expansion of the options that
15559 provide data for a transport is: &%errors_to%&, &%headers_add%&,
15560 &%headers_remove%&, &%transport%&.
15561
15562
15563
15564 .option address_data routers string&!! unset
15565 .cindex "router" "data attached to address"
15566 The string is expanded just before the router is run, that is, after all the
15567 precondition tests have succeeded. If the expansion is forced to fail, the
15568 router declines, the value of &%address_data%& remains unchanged, and the
15569 &%more%& option controls what happens next. Other expansion failures cause
15570 delivery of the address to be deferred.
15571
15572 .vindex "&$address_data$&"
15573 When the expansion succeeds, the value is retained with the address, and can be
15574 accessed using the variable &$address_data$& in the current router, subsequent
15575 routers, and the eventual transport.
15576
15577 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
15578 that runs a user's filter file, the contents of &$address_data$& are accessible
15579 in the filter. This is not normally a problem, because such data is usually
15580 either not confidential or it &"belongs"& to the current user, but if you do
15581 put confidential data into &$address_data$& you need to remember this point.
15582
15583 Even if the router declines or passes, the value of &$address_data$& remains
15584 with the address, though it can be changed by another &%address_data%& setting
15585 on a subsequent router. If a router generates child addresses, the value of
15586 &$address_data$& propagates to them. This also applies to the special kind of
15587 &"child"& that is generated by a router with the &%unseen%& option.
15588
15589 The idea of &%address_data%& is that you can use it to look up a lot of data
15590 for the address once, and then pick out parts of the data later. For example,
15591 you could use a single LDAP lookup to return a string of the form
15592 .code
15593 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
15594 .endd
15595 In the transport you could pick out the mailbox by a setting such as
15596 .code
15597 file = ${extract{mailbox}{$address_data}}
15598 .endd
15599 This makes the configuration file less messy, and also reduces the number of
15600 lookups (though Exim does cache lookups).
15601
15602 .vindex "&$sender_address_data$&"
15603 .vindex "&$address_data$&"
15604 The &%address_data%& facility is also useful as a means of passing information
15605 from one router to another, and from a router to a transport. In addition, if
15606 &$address_data$& is set by a router when verifying a recipient address from an
15607 ACL, it remains available for use in the rest of the ACL statement. After
15608 verifying a sender, the value is transferred to &$sender_address_data$&.
15609
15610
15611
15612 .option address_test routers&!? boolean true
15613 .oindex "&%-bt%&"
15614 .cindex "router" "skipping when address testing"
15615 If this option is set false, the router is skipped when routing is being tested
15616 by means of the &%-bt%& command line option. This can be a convenience when
15617 your first router sends messages to an external scanner, because it saves you
15618 having to set the &"already scanned"& indicator when testing real address
15619 routing.
15620
15621
15622
15623 .option cannot_route_message routers string&!! unset
15624 .cindex "router" "customizing &""cannot route""& message"
15625 .cindex "customizing" "&""cannot route""& message"
15626 This option specifies a text message that is used when an address cannot be
15627 routed because Exim has run out of routers. The default message is
15628 &"Unrouteable address"&. This option is useful only on routers that have
15629 &%more%& set false, or on the very last router in a configuration, because the
15630 value that is used is taken from the last router that is considered. This
15631 includes a router that is skipped because its preconditions are not met, as
15632 well as a router that declines. For example, using the default configuration,
15633 you could put:
15634 .code
15635 cannot_route_message = Remote domain not found in DNS
15636 .endd
15637 on the first router, which is a &(dnslookup)& router with &%more%& set false,
15638 and
15639 .code
15640 cannot_route_message = Unknown local user
15641 .endd
15642 on the final router that checks for local users. If string expansion fails for
15643 this option, the default message is used. Unless the expansion failure was
15644 explicitly forced, a message about the failure is written to the main and panic
15645 logs, in addition to the normal message about the routing failure.
15646
15647
15648 .option caseful_local_part routers boolean false
15649 .cindex "case of local parts"
15650 .cindex "router" "case of local parts"
15651 By default, routers handle the local parts of addresses in a case-insensitive
15652 manner, though the actual case is preserved for transmission with the message.
15653 If you want the case of letters to be significant in a router, you must set
15654 this option true. For individual router options that contain address or local
15655 part lists (for example, &%local_parts%&), case-sensitive matching can be
15656 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
15657 more details.
15658
15659 .vindex "&$local_part$&"
15660 .vindex "&$original_local_part$&"
15661 .vindex "&$parent_local_part$&"
15662 The value of the &$local_part$& variable is forced to lower case while a
15663 router is running unless &%caseful_local_part%& is set. When a router assigns
15664 an address to a transport, the value of &$local_part$& when the transport runs
15665 is the same as it was in the router. Similarly, when a router generates child
15666 addresses by aliasing or forwarding, the values of &$original_local_part$&
15667 and &$parent_local_part$& are those that were used by the redirecting router.
15668
15669 This option applies to the processing of an address by a router. When a
15670 recipient address is being processed in an ACL, there is a separate &%control%&
15671 modifier that can be used to specify case-sensitive processing within the ACL
15672 (see section &<<SECTcontrols>>&).
15673
15674
15675
15676 .option check_local_user routers&!? boolean false
15677 .cindex "local user, checking in router"
15678 .cindex "router" "checking for local user"
15679 .cindex "&_/etc/passwd_&"
15680 .vindex "&$home$&"
15681 When this option is true, Exim checks that the local part of the recipient
15682 address (with affixes removed if relevant) is the name of an account on the
15683 local system. The check is done by calling the &[getpwnam()]& function rather
15684 than trying to read &_/etc/passwd_& directly. This means that other methods of
15685 holding password data (such as NIS) are supported. If the local part is a local
15686 user, &$home$& is set from the password data, and can be tested in other
15687 preconditions that are evaluated after this one (the order of evaluation is
15688 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
15689 overridden by &%router_home_directory%&. If the local part is not a local user,
15690 the router is skipped.
15691
15692 If you want to check that the local part is either the name of a local user
15693 or matches something else, you cannot combine &%check_local_user%& with a
15694 setting of &%local_parts%&, because that specifies the logical &'and'& of the
15695 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
15696 setting to achieve this. For example:
15697 .code
15698 local_parts = passwd;$local_part : lsearch;/etc/other/users
15699 .endd
15700 Note, however, that the side effects of &%check_local_user%& (such as setting
15701 up a home directory) do not occur when a &(passwd)& lookup is used in a
15702 &%local_parts%& (or any other) precondition.
15703
15704
15705
15706 .option condition routers&!? string&!! unset
15707 .cindex "router" "customized precondition"
15708 This option specifies a general precondition test that has to succeed for the
15709 router to be called. The &%condition%& option is the last precondition to be
15710 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
15711 result is a forced failure, or an empty string, or one of the strings &"0"& or
15712 &"no"& or &"false"& (checked without regard to the case of the letters), the
15713 router is skipped, and the address is offered to the next one.
15714
15715 If the result is any other value, the router is run (as this is the last
15716 precondition to be evaluated, all the other preconditions must be true).
15717
15718 This option is unique in that multiple &%condition%& options may be present.
15719 All &%condition%& options must succeed.
15720
15721 The &%condition%& option provides a means of applying custom conditions to the
15722 running of routers. Note that in the case of a simple conditional expansion,
15723 the default expansion values are exactly what is wanted. For example:
15724 .code
15725 condition = ${if >{$message_age}{600}}
15726 .endd
15727 Because of the default behaviour of the string expansion, this is equivalent to
15728 .code
15729 condition = ${if >{$message_age}{600}{true}{}}
15730 .endd
15731 A multiple condition example, which succeeds:
15732 .code
15733 condition = ${if >{$message_age}{600}}
15734 condition = ${if !eq{${lc:$local_part}}{postmaster}}
15735 condition = foobar
15736 .endd
15737 If the expansion fails (other than forced failure) delivery is deferred. Some
15738 of the other precondition options are common special cases that could in fact
15739 be specified using &%condition%&.
15740
15741
15742
15743 .option debug_print routers string&!! unset
15744 .cindex "testing" "variables in drivers"
15745 If this option is set and debugging is enabled (see the &%-d%& command line
15746 option), the string is expanded and included in the debugging output.
15747 If expansion of the string fails, the error message is written to the debugging
15748 output, and Exim carries on processing.
15749 This option is provided to help with checking out the values of variables and
15750 so on when debugging router configurations. For example, if a &%condition%&
15751 option appears not to be working, &%debug_print%& can be used to output the
15752 variables it references. The output happens after checks for &%domains%&,
15753 &%local_parts%&, and &%check_local_user%& but before any other preconditions
15754 are tested. A newline is added to the text if it does not end with one.
15755
15756
15757
15758 .option disable_logging routers boolean false
15759 If this option is set true, nothing is logged for any routing errors
15760 or for any deliveries caused by this router. You should not set this option
15761 unless you really, really know what you are doing. See also the generic
15762 transport option of the same name.
15763
15764
15765 .option domains routers&!? "domain list&!!" unset
15766 .cindex "router" "restricting to specific domains"
15767 .vindex "&$domain_data$&"
15768 If this option is set, the router is skipped unless the current domain matches
15769 the list. If the match is achieved by means of a file lookup, the data that the
15770 lookup returned for the domain is placed in &$domain_data$& for use in string
15771 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
15772 a list of the order in which preconditions are evaluated.
15773
15774
15775
15776 .option driver routers string unset
15777 This option must always be set. It specifies which of the available routers is
15778 to be used.
15779
15780
15781
15782 .option errors_to routers string&!! unset
15783 .cindex "envelope sender"
15784 .cindex "router" "changing address for errors"
15785 If a router successfully handles an address, it may assign the address to a
15786 transport for delivery or it may generate child addresses. In both cases, if
15787 there is a delivery problem during later processing, the resulting bounce
15788 message is sent to the address that results from expanding this string,
15789 provided that the address verifies successfully. The &%errors_to%& option is
15790 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
15791
15792 The &%errors_to%& setting associated with an address can be overridden if it
15793 subsequently passes through other routers that have their own &%errors_to%&
15794 settings, or if the message is delivered by a transport with a &%return_path%&
15795 setting.
15796
15797 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
15798 the expansion fails to verify, the errors address associated with the incoming
15799 address is used. At top level, this is the envelope sender. A non-forced
15800 expansion failure causes delivery to be deferred.
15801
15802 If an address for which &%errors_to%& has been set ends up being delivered over
15803 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
15804 any bounces that are generated by other MTAs on the delivery route are also
15805 sent there. You can set &%errors_to%& to the empty string by either of these
15806 settings:
15807 .code
15808 errors_to =
15809 errors_to = ""
15810 .endd
15811 An expansion item that yields an empty string has the same effect. If you do
15812 this, a locally detected delivery error for addresses processed by this router
15813 no longer gives rise to a bounce message; the error is discarded. If the
15814 address is delivered to a remote host, the return path is set to &`<>`&, unless
15815 overridden by the &%return_path%& option on the transport.
15816
15817 .vindex "&$address_data$&"
15818 If for some reason you want to discard local errors, but use a non-empty
15819 MAIL command for remote delivery, you can preserve the original return
15820 path in &$address_data$& in the router, and reinstate it in the transport by
15821 setting &%return_path%&.
15822
15823 The most common use of &%errors_to%& is to direct mailing list bounces to the
15824 manager of the list, as described in section &<<SECTmailinglists>>&, or to
15825 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
15826
15827
15828
15829 .option expn routers&!? boolean true
15830 .cindex "address" "testing"
15831 .cindex "testing" "addresses"
15832 .cindex "EXPN" "router skipping"
15833 .cindex "router" "skipping for EXPN"
15834 If this option is turned off, the router is skipped when testing an address
15835 as a result of processing an SMTP EXPN command. You might, for example,
15836 want to turn it off on a router for users' &_.forward_& files, while leaving it
15837 on for the system alias file.
15838 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
15839 are evaluated.
15840
15841 The use of the SMTP EXPN command is controlled by an ACL (see chapter
15842 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
15843 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
15844
15845
15846
15847 .option fail_verify routers boolean false
15848 .cindex "router" "forcing verification failure"
15849 Setting this option has the effect of setting both &%fail_verify_sender%& and
15850 &%fail_verify_recipient%& to the same value.
15851
15852
15853
15854 .option fail_verify_recipient routers boolean false
15855 If this option is true and an address is accepted by this router when
15856 verifying a recipient, verification fails.
15857
15858
15859
15860 .option fail_verify_sender routers boolean false
15861 If this option is true and an address is accepted by this router when
15862 verifying a sender, verification fails.
15863
15864
15865
15866 .option fallback_hosts routers "string list" unset
15867 .cindex "router" "fallback hosts"
15868 .cindex "fallback" "hosts specified on router"
15869 String expansion is not applied to this option. The argument must be a
15870 colon-separated list of host names or IP addresses. The list separator can be
15871 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
15872 each name or address. In fact, the format of each item is exactly the same as
15873 defined for the list of hosts in a &(manualroute)& router (see section
15874 &<<SECTformatonehostitem>>&).
15875
15876 If a router queues an address for a remote transport, this host list is
15877 associated with the address, and used instead of the transport's fallback host
15878 list. If &%hosts_randomize%& is set on the transport, the order of the list is
15879 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
15880 transport for further details.
15881
15882
15883 .option group routers string&!! "see below"
15884 .cindex "gid (group id)" "local delivery"
15885 .cindex "local transports" "uid and gid"
15886 .cindex "transport" "local"
15887 .cindex "router" "setting group"
15888 When a router queues an address for a transport, and the transport does not
15889 specify a group, the group given here is used when running the delivery
15890 process.
15891 The group may be specified numerically or by name. If expansion fails, the
15892 error is logged and delivery is deferred.
15893 The default is unset, unless &%check_local_user%& is set, when the default
15894 is taken from the password information. See also &%initgroups%& and &%user%&
15895 and the discussion in chapter &<<CHAPenvironment>>&.
15896
15897
15898
15899 .option headers_add routers string&!! unset
15900 .cindex "header lines" "adding"
15901 .cindex "router" "adding header lines"
15902 This option specifies a string of text that is expanded at routing time, and
15903 associated with any addresses that are accepted by the router. However, this
15904 option has no effect when an address is just being verified. The way in which
15905 the text is used to add header lines at transport time is described in section
15906 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
15907 message is in the process of being transported. This means that references to
15908 header lines in string expansions in the transport's configuration do not
15909 &"see"& the added header lines.
15910
15911 The &%headers_add%& option is expanded after &%errors_to%&, but before
15912 &%headers_remove%& and &%transport%&. If the expanded string is empty, or if
15913 the expansion is forced to fail, the option has no effect. Other expansion
15914 failures are treated as configuration errors.
15915
15916 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
15917 router that has the &%one_time%& option set.
15918
15919 .cindex "duplicate addresses"
15920 .oindex "&%unseen%&"
15921 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
15922 additions are deleted when the address is passed on to subsequent routers.
15923 For a &%redirect%& router, if a generated address is the same as the incoming
15924 address, this can lead to duplicate addresses with different header
15925 modifications. Exim does not do duplicate deliveries (except, in certain
15926 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
15927 which of the duplicates is discarded, so this ambiguous situation should be
15928 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
15929
15930
15931
15932 .option headers_remove routers string&!! unset
15933 .cindex "header lines" "removing"
15934 .cindex "router" "removing header lines"
15935 This option specifies a string of text that is expanded at routing time, and
15936 associated with any addresses that are accepted by the router. However, this
15937 option has no effect when an address is just being verified. The way in which
15938 the text is used to remove header lines at transport time is described in
15939 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
15940 the message is in the process of being transported. This means that references
15941 to header lines in string expansions in the transport's configuration still
15942 &"see"& the original header lines.
15943
15944 The &%headers_remove%& option is expanded after &%errors_to%& and
15945 &%headers_add%&, but before &%transport%&. If the expansion is forced to fail,
15946 the option has no effect. Other expansion failures are treated as configuration
15947 errors.
15948
15949 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
15950 router that has the &%one_time%& option set.
15951
15952 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
15953 removal requests are deleted when the address is passed on to subsequent
15954 routers, and this can lead to problems with duplicates -- see the similar
15955 warning for &%headers_add%& above.
15956
15957
15958 .option ignore_target_hosts routers "host list&!!" unset
15959 .cindex "IP address" "discarding"
15960 .cindex "router" "discarding IP addresses"
15961 Although this option is a host list, it should normally contain IP address
15962 entries rather than names. If any host that is looked up by the router has an
15963 IP address that matches an item in this list, Exim behaves as if that IP
15964 address did not exist. This option allows you to cope with rogue DNS entries
15965 like
15966 .code
15967 remote.domain.example.  A  127.0.0.1
15968 .endd
15969 by setting
15970 .code
15971 ignore_target_hosts = 127.0.0.1
15972 .endd
15973 on the relevant router. If all the hosts found by a &(dnslookup)& router are
15974 discarded in this way, the router declines. In a conventional configuration, an
15975 attempt to mail to such a domain would normally provoke the &"unrouteable
15976 domain"& error, and an attempt to verify an address in the domain would fail.
15977 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
15978 router declines if presented with one of the listed addresses.
15979
15980 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
15981 means of the first or the second of the following settings, respectively:
15982 .code
15983 ignore_target_hosts = 0.0.0.0/0
15984 ignore_target_hosts = <; 0::0/0
15985 .endd
15986 The pattern in the first line matches all IPv4 addresses, whereas the pattern
15987 in the second line matches all IPv6 addresses.
15988
15989 This option may also be useful for ignoring link-local and site-local IPv6
15990 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
15991 is expanded before use as a list, it is possible to make it dependent on the
15992 domain that is being routed.
15993
15994 .vindex "&$host_address$&"
15995 During its expansion, &$host_address$& is set to the IP address that is being
15996 checked.
15997
15998 .option initgroups routers boolean false
15999 .cindex "additional groups"
16000 .cindex "groups" "additional"
16001 .cindex "local transports" "uid and gid"
16002 .cindex "transport" "local"
16003 If the router queues an address for a transport, and this option is true, and
16004 the uid supplied by the router is not overridden by the transport, the
16005 &[initgroups()]& function is called when running the transport to ensure that
16006 any additional groups associated with the uid are set up. See also &%group%&
16007 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
16008
16009
16010
16011 .option local_part_prefix routers&!? "string list" unset
16012 .cindex "router" "prefix for local part"
16013 .cindex "prefix" "for local part, used in router"
16014 If this option is set, the router is skipped unless the local part starts with
16015 one of the given strings, or &%local_part_prefix_optional%& is true. See
16016 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
16017 evaluated.
16018
16019 The list is scanned from left to right, and the first prefix that matches is
16020 used. A limited form of wildcard is available; if the prefix begins with an
16021 asterisk, it matches the longest possible sequence of arbitrary characters at
16022 the start of the local part. An asterisk should therefore always be followed by
16023 some character that does not occur in normal local parts.
16024 .cindex "multiple mailboxes"
16025 .cindex "mailbox" "multiple"
16026 Wildcarding can be used to set up multiple user mailboxes, as described in
16027 section &<<SECTmulbox>>&.
16028
16029 .vindex "&$local_part$&"
16030 .vindex "&$local_part_prefix$&"
16031 During the testing of the &%local_parts%& option, and while the router is
16032 running, the prefix is removed from the local part, and is available in the
16033 expansion variable &$local_part_prefix$&. When a message is being delivered, if
16034 the router accepts the address, this remains true during subsequent delivery by
16035 a transport. In particular, the local part that is transmitted in the RCPT
16036 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
16037 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
16038 the relevant transport.
16039
16040 When an address is being verified, &%local_part_prefix%& affects only the
16041 behaviour of the router. If the callout feature of verification is in use, this
16042 means that the full address, including the prefix, will be used during the
16043 callout.
16044
16045 The prefix facility is commonly used to handle local parts of the form
16046 &%owner-something%&. Another common use is to support local parts of the form
16047 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
16048 to tell a user their forwarding is broken &-- by placing a router like this one
16049 immediately before the router that handles &_.forward_& files:
16050 .code
16051 real_localuser:
16052   driver = accept
16053   local_part_prefix = real-
16054   check_local_user
16055   transport = local_delivery
16056 .endd
16057 For security, it would probably be a good idea to restrict the use of this
16058 router to locally-generated messages, using a condition such as this:
16059 .code
16060   condition = ${if match {$sender_host_address}\
16061                          {\N^(|127\.0\.0\.1)$\N}}
16062 .endd
16063
16064 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
16065 both conditions must be met if not optional. Care must be taken if wildcards
16066 are used in both a prefix and a suffix on the same router. Different
16067 separator characters must be used to avoid ambiguity.
16068
16069
16070 .option local_part_prefix_optional routers boolean false
16071 See &%local_part_prefix%& above.
16072
16073
16074
16075 .option local_part_suffix routers&!? "string list" unset
16076 .cindex "router" "suffix for local part"
16077 .cindex "suffix for local part" "used in router"
16078 This option operates in the same way as &%local_part_prefix%&, except that the
16079 local part must end (rather than start) with the given string, the
16080 &%local_part_suffix_optional%& option determines whether the suffix is
16081 mandatory, and the wildcard * character, if present, must be the last
16082 character of the suffix. This option facility is commonly used to handle local
16083 parts of the form &%something-request%& and multiple user mailboxes of the form
16084 &%username-foo%&.
16085
16086
16087 .option local_part_suffix_optional routers boolean false
16088 See &%local_part_suffix%& above.
16089
16090
16091
16092 .option local_parts routers&!? "local part list&!!" unset
16093 .cindex "router" "restricting to specific local parts"
16094 .cindex "local part" "checking in router"
16095 The router is run only if the local part of the address matches the list.
16096 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16097 are evaluated, and
16098 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
16099 string is expanded, it is possible to make it depend on the domain, for
16100 example:
16101 .code
16102 local_parts = dbm;/usr/local/specials/$domain
16103 .endd
16104 .vindex "&$local_part_data$&"
16105 If the match is achieved by a lookup, the data that the lookup returned
16106 for the local part is placed in the variable &$local_part_data$& for use in
16107 expansions of the router's private options. You might use this option, for
16108 example, if you have a large number of local virtual domains, and you want to
16109 send all postmaster mail to the same place without having to set up an alias in
16110 each virtual domain:
16111 .code
16112 postmaster:
16113   driver = redirect
16114   local_parts = postmaster
16115   data = postmaster@real.domain.example
16116 .endd
16117
16118
16119 .option log_as_local routers boolean "see below"
16120 .cindex "log" "delivery line"
16121 .cindex "delivery" "log line format"
16122 Exim has two logging styles for delivery, the idea being to make local
16123 deliveries stand out more visibly from remote ones. In the &"local"& style, the
16124 recipient address is given just as the local part, without a domain. The use of
16125 this style is controlled by this option. It defaults to true for the &(accept)&
16126 router, and false for all the others. This option applies only when a
16127 router assigns an address to a transport. It has no effect on routers that
16128 redirect addresses.
16129
16130
16131
16132 .option more routers boolean&!! true
16133 The result of string expansion for this option must be a valid boolean value,
16134 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
16135 result causes an error, and delivery is deferred. If the expansion is forced to
16136 fail, the default value for the option (true) is used. Other failures cause
16137 delivery to be deferred.
16138
16139 If this option is set false, and the router declines to handle the address, no
16140 further routers are tried, routing fails, and the address is bounced.
16141 .oindex "&%self%&"
16142 However, if the router explicitly passes an address to the following router by
16143 means of the setting
16144 .code
16145 self = pass
16146 .endd
16147 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
16148 does not affect the behaviour if one of the precondition tests fails. In that
16149 case, the address is always passed to the next router.
16150
16151 Note that &%address_data%& is not considered to be a precondition. If its
16152 expansion is forced to fail, the router declines, and the value of &%more%&
16153 controls what happens next.
16154
16155
16156 .option pass_on_timeout routers boolean false
16157 .cindex "timeout" "of router"
16158 .cindex "router" "timeout"
16159 If a router times out during a host lookup, it normally causes deferral of the
16160 address. If &%pass_on_timeout%& is set, the address is passed on to the next
16161 router, overriding &%no_more%&. This may be helpful for systems that are
16162 intermittently connected to the Internet, or those that want to pass to a smart
16163 host any messages that cannot immediately be delivered.
16164
16165 There are occasional other temporary errors that can occur while doing DNS
16166 lookups. They are treated in the same way as a timeout, and this option
16167 applies to all of them.
16168
16169
16170
16171 .option pass_router routers string unset
16172 .cindex "router" "go to after &""pass""&"
16173 Routers that recognize the generic &%self%& option (&(dnslookup)&,
16174 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
16175 routing to continue, and overriding a false setting of &%more%&. When one of
16176 these routers returns &"pass"&, the address is normally handed on to the next
16177 router in sequence. This can be changed by setting &%pass_router%& to the name
16178 of another router. However (unlike &%redirect_router%&) the named router must
16179 be below the current router, to avoid loops. Note that this option applies only
16180 to the special case of &"pass"&. It does not apply when a router returns
16181 &"decline"& because it cannot handle an address.
16182
16183
16184
16185 .option redirect_router routers string unset
16186 .cindex "router" "start at after redirection"
16187 Sometimes an administrator knows that it is pointless to reprocess addresses
16188 generated from alias or forward files with the same router again. For
16189 example, if an alias file translates real names into login ids there is no
16190 point searching the alias file a second time, especially if it is a large file.
16191
16192 The &%redirect_router%& option can be set to the name of any router instance.
16193 It causes the routing of any generated addresses to start at the named router
16194 instead of at the first router. This option has no effect if the router in
16195 which it is set does not generate new addresses.
16196
16197
16198
16199 .option require_files routers&!? "string list&!!" unset
16200 .cindex "file" "requiring for router"
16201 .cindex "router" "requiring file existence"
16202 This option provides a general mechanism for predicating the running of a
16203 router on the existence or non-existence of certain files or directories.
16204 Before running a router, as one of its precondition tests, Exim works its way
16205 through the &%require_files%& list, expanding each item separately.
16206
16207 Because the list is split before expansion, any colons in expansion items must
16208 be doubled, or the facility for using a different list separator must be used.
16209 If any expansion is forced to fail, the item is ignored. Other expansion
16210 failures cause routing of the address to be deferred.
16211
16212 If any expanded string is empty, it is ignored. Otherwise, except as described
16213 below, each string must be a fully qualified file path, optionally preceded by
16214 &"!"&. The paths are passed to the &[stat()]& function to test for the
16215 existence of the files or directories. The router is skipped if any paths not
16216 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
16217
16218 .cindex "NFS"
16219 If &[stat()]& cannot determine whether a file exists or not, delivery of
16220 the message is deferred. This can happen when NFS-mounted filesystems are
16221 unavailable.
16222
16223 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
16224 options, so you cannot use it to check for the existence of a file in which to
16225 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
16226 full list of the order in which preconditions are evaluated.) However, as
16227 these options are all expanded, you can use the &%exists%& expansion condition
16228 to make such tests. The &%require_files%& option is intended for checking files
16229 that the router may be going to use internally, or which are needed by a
16230 transport (for example &_.procmailrc_&).
16231
16232 During delivery, the &[stat()]& function is run as root, but there is a
16233 facility for some checking of the accessibility of a file by another user.
16234 This is not a proper permissions check, but just a &"rough"& check that
16235 operates as follows:
16236
16237 If an item in a &%require_files%& list does not contain any forward slash
16238 characters, it is taken to be the user (and optional group, separated by a
16239 comma) to be checked for subsequent files in the list. If no group is specified
16240 but the user is specified symbolically, the gid associated with the uid is
16241 used. For example:
16242 .code
16243 require_files = mail:/some/file
16244 require_files = $local_part:$home/.procmailrc
16245 .endd
16246 If a user or group name in a &%require_files%& list does not exist, the
16247 &%require_files%& condition fails.
16248
16249 Exim performs the check by scanning along the components of the file path, and
16250 checking the access for the given uid and gid. It checks for &"x"& access on
16251 directories, and &"r"& access on the final file. Note that this means that file
16252 access control lists, if the operating system has them, are ignored.
16253
16254 &*Warning 1*&: When the router is being run to verify addresses for an
16255 incoming SMTP message, Exim is not running as root, but under its own uid. This
16256 may affect the result of a &%require_files%& check. In particular, &[stat()]&
16257 may yield the error EACCES (&"Permission denied"&). This means that the Exim
16258 user is not permitted to read one of the directories on the file's path.
16259
16260 &*Warning 2*&: Even when Exim is running as root while delivering a message,
16261 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
16262 without root access. In this case, if a check for access by a particular user
16263 is requested, Exim creates a subprocess that runs as that user, and tries the
16264 check again in that process.
16265
16266 The default action for handling an unresolved EACCES is to consider it to
16267 be caused by a configuration error, and routing is deferred because the
16268 existence or non-existence of the file cannot be determined. However, in some
16269 circumstances it may be desirable to treat this condition as if the file did
16270 not exist. If the file name (or the exclamation mark that precedes the file
16271 name for non-existence) is preceded by a plus sign, the EACCES error is treated
16272 as if the file did not exist. For example:
16273 .code
16274 require_files = +/some/file
16275 .endd
16276 If the router is not an essential part of verification (for example, it
16277 handles users' &_.forward_& files), another solution is to set the &%verify%&
16278 option false so that the router is skipped when verifying.
16279
16280
16281
16282 .option retry_use_local_part routers boolean "see below"
16283 .cindex "hints database" "retry keys"
16284 .cindex "local part" "in retry keys"
16285 When a delivery suffers a temporary routing failure, a retry record is created
16286 in Exim's hints database. For addresses whose routing depends only on the
16287 domain, the key for the retry record should not involve the local part, but for
16288 other addresses, both the domain and the local part should be included.
16289 Usually, remote routing is of the former kind, and local routing is of the
16290 latter kind.
16291
16292 This option controls whether the local part is used to form the key for retry
16293 hints for addresses that suffer temporary errors while being handled by this
16294 router. The default value is true for any router that has &%check_local_user%&
16295 set, and false otherwise. Note that this option does not apply to hints keys
16296 for transport delays; they are controlled by a generic transport option of the
16297 same name.
16298
16299 The setting of &%retry_use_local_part%& applies only to the router on which it
16300 appears. If the router generates child addresses, they are routed
16301 independently; this setting does not become attached to them.
16302
16303
16304
16305 .option router_home_directory routers string&!! unset
16306 .cindex "router" "home directory for"
16307 .cindex "home directory" "for router"
16308 .vindex "&$home$&"
16309 This option sets a home directory for use while the router is running. (Compare
16310 &%transport_home_directory%&, which sets a home directory for later
16311 transporting.) In particular, if used on a &(redirect)& router, this option
16312 sets a value for &$home$& while a filter is running. The value is expanded;
16313 forced expansion failure causes the option to be ignored &-- other failures
16314 cause the router to defer.
16315
16316 Expansion of &%router_home_directory%& happens immediately after the
16317 &%check_local_user%& test (if configured), before any further expansions take
16318 place.
16319 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16320 are evaluated.)
16321 While the router is running, &%router_home_directory%& overrides the value of
16322 &$home$& that came from &%check_local_user%&.
16323
16324 When a router accepts an address and assigns it to a local transport (including
16325 the cases when a &(redirect)& router generates a pipe, file, or autoreply
16326 delivery), the home directory setting for the transport is taken from the first
16327 of these values that is set:
16328
16329 .ilist
16330 The &%home_directory%& option on the transport;
16331 .next
16332 The &%transport_home_directory%& option on the router;
16333 .next
16334 The password data if &%check_local_user%& is set on the router;
16335 .next
16336 The &%router_home_directory%& option on the router.
16337 .endlist
16338
16339 In other words, &%router_home_directory%& overrides the password data for the
16340 router, but not for the transport.
16341
16342
16343
16344 .option self routers string freeze
16345 .cindex "MX record" "pointing to local host"
16346 .cindex "local host" "MX pointing to"
16347 This option applies to those routers that use a recipient address to find a
16348 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
16349 and &(manualroute)& routers.
16350 Certain configurations of the &(queryprogram)& router can also specify a list
16351 of remote hosts.
16352 Usually such routers are configured to send the message to a remote host via an
16353 &(smtp)& transport. The &%self%& option specifies what happens when the first
16354 host on the list turns out to be the local host.
16355 The way in which Exim checks for the local host is described in section
16356 &<<SECTreclocipadd>>&.
16357
16358 Normally this situation indicates either an error in Exim's configuration (for
16359 example, the router should be configured not to process this domain), or an
16360 error in the DNS (for example, the MX should not point to this host). For this
16361 reason, the default action is to log the incident, defer the address, and
16362 freeze the message. The following alternatives are provided for use in special
16363 cases:
16364
16365 .vlist
16366 .vitem &%defer%&
16367 Delivery of the message is tried again later, but the message is not frozen.
16368
16369 .vitem "&%reroute%&: <&'domain'&>"
16370 The domain is changed to the given domain, and the address is passed back to
16371 be reprocessed by the routers. No rewriting of headers takes place. This
16372 behaviour is essentially a redirection.
16373
16374 .vitem "&%reroute: rewrite:%& <&'domain'&>"
16375 The domain is changed to the given domain, and the address is passed back to be
16376 reprocessed by the routers. Any headers that contain the original domain are
16377 rewritten.
16378
16379 .vitem &%pass%&
16380 .oindex "&%more%&"
16381 .vindex "&$self_hostname$&"
16382 The router passes the address to the next router, or to the router named in the
16383 &%pass_router%& option if it is set. This overrides &%no_more%&. During
16384 subsequent routing and delivery, the variable &$self_hostname$& contains the
16385 name of the local host that the router encountered. This can be used to
16386 distinguish between different cases for hosts with multiple names. The
16387 combination
16388 .code
16389 self = pass
16390 no_more
16391 .endd
16392 ensures that only those addresses that routed to the local host are passed on.
16393 Without &%no_more%&, addresses that were declined for other reasons would also
16394 be passed to the next router.
16395
16396 .vitem &%fail%&
16397 Delivery fails and an error report is generated.
16398
16399 .vitem &%send%&
16400 .cindex "local host" "sending to"
16401 The anomaly is ignored and the address is queued for the transport. This
16402 setting should be used with extreme caution. For an &(smtp)& transport, it
16403 makes sense only in cases where the program that is listening on the SMTP port
16404 is not this version of Exim. That is, it must be some other MTA, or Exim with a
16405 different configuration file that handles the domain in another way.
16406 .endlist
16407
16408
16409
16410 .option senders routers&!? "address list&!!" unset
16411 .cindex "router" "checking senders"
16412 If this option is set, the router is skipped unless the message's sender
16413 address matches something on the list.
16414 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16415 are evaluated.
16416
16417 There are issues concerning verification when the running of routers is
16418 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
16419 setting, it sets the sender to the null string. When using the &%-bt%& option
16420 to check a configuration file, it is necessary also to use the &%-f%& option to
16421 set an appropriate sender. For incoming mail, the sender is unset when
16422 verifying the sender, but is available when verifying any recipients. If the
16423 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
16424 matters.
16425
16426
16427 .option translate_ip_address routers string&!! unset
16428 .cindex "IP address" "translating"
16429 .cindex "packet radio"
16430 .cindex "router" "IP address translation"
16431 There exist some rare networking situations (for example, packet radio) where
16432 it is helpful to be able to translate IP addresses generated by normal routing
16433 mechanisms into other IP addresses, thus performing a kind of manual IP
16434 routing. This should be done only if the normal IP routing of the TCP/IP stack
16435 is inadequate or broken. Because this is an extremely uncommon requirement, the
16436 code to support this option is not included in the Exim binary unless
16437 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
16438
16439 .vindex "&$host_address$&"
16440 The &%translate_ip_address%& string is expanded for every IP address generated
16441 by the router, with the generated address set in &$host_address$&. If the
16442 expansion is forced to fail, no action is taken.
16443 For any other expansion error, delivery of the message is deferred.
16444 If the result of the expansion is an IP address, that replaces the original
16445 address; otherwise the result is assumed to be a host name &-- this is looked
16446 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
16447 produce one or more replacement IP addresses. For example, to subvert all IP
16448 addresses in some specific networks, this could be added to a router:
16449 .code
16450 translate_ip_address = \
16451   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
16452     {$value}fail}}
16453 .endd
16454 The file would contain lines like
16455 .code
16456 10.2.3.128/26    some.host
16457 10.8.4.34/26     10.44.8.15
16458 .endd
16459 You should not make use of this facility unless you really understand what you
16460 are doing.
16461
16462
16463
16464 .option transport routers string&!! unset
16465 This option specifies the transport to be used when a router accepts an address
16466 and sets it up for delivery. A transport is never needed if a router is used
16467 only for verification. The value of the option is expanded at routing time,
16468 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
16469 and result must be the name of one of the configured transports. If it is not,
16470 delivery is deferred.
16471
16472 The &%transport%& option is not used by the &(redirect)& router, but it does
16473 have some private options that set up transports for pipe and file deliveries
16474 (see chapter &<<CHAPredirect>>&).
16475
16476
16477
16478 .option transport_current_directory routers string&!! unset
16479 .cindex "current directory for local transport"
16480 This option associates a current directory with any address that is routed
16481 to a local transport. This can happen either because a transport is
16482 explicitly configured for the router, or because it generates a delivery to a
16483 file or a pipe. During the delivery process (that is, at transport time), this
16484 option string is expanded and is set as the current directory, unless
16485 overridden by a setting on the transport.
16486 If the expansion fails for any reason, including forced failure, an error is
16487 logged, and delivery is deferred.
16488 See chapter &<<CHAPenvironment>>& for details of the local delivery
16489 environment.
16490
16491
16492
16493
16494 .option transport_home_directory routers string&!! "see below"
16495 .cindex "home directory" "for local transport"
16496 This option associates a home directory with any address that is routed to a
16497 local transport. This can happen either because a transport is explicitly
16498 configured for the router, or because it generates a delivery to a file or a
16499 pipe. During the delivery process (that is, at transport time), the option
16500 string is expanded and is set as the home directory, unless overridden by a
16501 setting of &%home_directory%& on the transport.
16502 If the expansion fails for any reason, including forced failure, an error is
16503 logged, and delivery is deferred.
16504
16505 If the transport does not specify a home directory, and
16506 &%transport_home_directory%& is not set for the router, the home directory for
16507 the transport is taken from the password data if &%check_local_user%& is set for
16508 the router. Otherwise it is taken from &%router_home_directory%& if that option
16509 is set; if not, no home directory is set for the transport.
16510
16511 See chapter &<<CHAPenvironment>>& for further details of the local delivery
16512 environment.
16513
16514
16515
16516
16517 .option unseen routers boolean&!! false
16518 .cindex "router" "carrying on after success"
16519 The result of string expansion for this option must be a valid boolean value,
16520 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
16521 result causes an error, and delivery is deferred. If the expansion is forced to
16522 fail, the default value for the option (false) is used. Other failures cause
16523 delivery to be deferred.
16524
16525 When this option is set true, routing does not cease if the router accepts the
16526 address. Instead, a copy of the incoming address is passed to the next router,
16527 overriding a false setting of &%more%&. There is little point in setting
16528 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
16529 the value of &%unseen%& contains expansion items (and therefore, presumably, is
16530 sometimes true and sometimes false).
16531
16532 .cindex "copy of message (&%unseen%& option)"
16533 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
16534 qualifier in filter files. It can be used to cause copies of messages to be
16535 delivered to some other destination, while also carrying out a normal delivery.
16536 In effect, the current address is made into a &"parent"& that has two children
16537 &-- one that is delivered as specified by this router, and a clone that goes on
16538 to be routed further. For this reason, &%unseen%& may not be combined with the
16539 &%one_time%& option in a &(redirect)& router.
16540
16541 &*Warning*&: Header lines added to the address (or specified for removal) by
16542 this router or by previous routers affect the &"unseen"& copy of the message
16543 only. The clone that continues to be processed by further routers starts with
16544 no added headers and none specified for removal. For a &%redirect%& router, if
16545 a generated address is the same as the incoming address, this can lead to
16546 duplicate addresses with different header modifications. Exim does not do
16547 duplicate deliveries (except, in certain circumstances, to pipes -- see section
16548 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
16549 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
16550 &%redirect%& router may be of help.
16551
16552 Unlike the handling of header modifications, any data that was set by the
16553 &%address_data%& option in the current or previous routers &'is'& passed on to
16554 subsequent routers.
16555
16556
16557 .option user routers string&!! "see below"
16558 .cindex "uid (user id)" "local delivery"
16559 .cindex "local transports" "uid and gid"
16560 .cindex "transport" "local"
16561 .cindex "router" "user for filter processing"
16562 .cindex "filter" "user for processing"
16563 When a router queues an address for a transport, and the transport does not
16564 specify a user, the user given here is used when running the delivery process.
16565 The user may be specified numerically or by name. If expansion fails, the
16566 error is logged and delivery is deferred.
16567 This user is also used by the &(redirect)& router when running a filter file.
16568 The default is unset, except when &%check_local_user%& is set. In this case,
16569 the default is taken from the password information. If the user is specified as
16570 a name, and &%group%& is not set, the group associated with the user is used.
16571 See also &%initgroups%& and &%group%& and the discussion in chapter
16572 &<<CHAPenvironment>>&.
16573
16574
16575
16576 .option verify routers&!? boolean true
16577 Setting this option has the effect of setting &%verify_sender%& and
16578 &%verify_recipient%& to the same value.
16579
16580
16581 .option verify_only routers&!? boolean false
16582 .cindex "EXPN" "with &%verify_only%&"
16583 .oindex "&%-bv%&"
16584 .cindex "router" "used only when verifying"
16585 If this option is set, the router is used only when verifying an address or
16586 testing with the &%-bv%& option, not when actually doing a delivery, testing
16587 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
16588 restricted to verifying only senders or recipients by means of
16589 &%verify_sender%& and &%verify_recipient%&.
16590
16591 &*Warning*&: When the router is being run to verify addresses for an incoming
16592 SMTP message, Exim is not running as root, but under its own uid. If the router
16593 accesses any files, you need to make sure that they are accessible to the Exim
16594 user or group.
16595
16596
16597 .option verify_recipient routers&!? boolean true
16598 If this option is false, the router is skipped when verifying recipient
16599 addresses
16600 or testing recipient verification using &%-bv%&.
16601 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16602 are evaluated.
16603
16604
16605 .option verify_sender routers&!? boolean true
16606 If this option is false, the router is skipped when verifying sender addresses
16607 or testing sender verification using &%-bvs%&.
16608 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16609 are evaluated.
16610 .ecindex IIDgenoprou1
16611 .ecindex IIDgenoprou2
16612
16613
16614
16615
16616
16617
16618 . ////////////////////////////////////////////////////////////////////////////
16619 . ////////////////////////////////////////////////////////////////////////////
16620
16621 .chapter "The accept router" "CHID4"
16622 .cindex "&(accept)& router"
16623 .cindex "routers" "&(accept)&"
16624 The &(accept)& router has no private options of its own. Unless it is being
16625 used purely for verification (see &%verify_only%&) a transport is required to
16626 be defined by the generic &%transport%& option. If the preconditions that are
16627 specified by generic options are met, the router accepts the address and queues
16628 it for the given transport. The most common use of this router is for setting
16629 up deliveries to local mailboxes. For example:
16630 .code
16631 localusers:
16632   driver = accept
16633   domains = mydomain.example
16634   check_local_user
16635   transport = local_delivery
16636 .endd
16637 The &%domains%& condition in this example checks the domain of the address, and
16638 &%check_local_user%& checks that the local part is the login of a local user.
16639 When both preconditions are met, the &(accept)& router runs, and queues the
16640 address for the &(local_delivery)& transport.
16641
16642
16643
16644
16645
16646
16647 . ////////////////////////////////////////////////////////////////////////////
16648 . ////////////////////////////////////////////////////////////////////////////
16649
16650 .chapter "The dnslookup router" "CHAPdnslookup"
16651 .scindex IIDdnsrou1 "&(dnslookup)& router"
16652 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
16653 The &(dnslookup)& router looks up the hosts that handle mail for the
16654 recipient's domain in the DNS. A transport must always be set for this router,
16655 unless &%verify_only%& is set.
16656
16657 If SRV support is configured (see &%check_srv%& below), Exim first searches for
16658 SRV records. If none are found, or if SRV support is not configured,
16659 MX records are looked up. If no MX records exist, address records are sought.
16660 However, &%mx_domains%& can be set to disable the direct use of address
16661 records.
16662
16663 MX records of equal priority are sorted by Exim into a random order. Exim then
16664 looks for address records for the host names obtained from MX or SRV records.
16665 When a host has more than one IP address, they are sorted into a random order,
16666 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
16667 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
16668 generic option, the router declines.
16669
16670 Unless they have the highest priority (lowest MX value), MX records that point
16671 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
16672 are discarded, together with any other MX records of equal or lower priority.
16673
16674 .cindex "MX record" "pointing to local host"
16675 .cindex "local host" "MX pointing to"
16676 .oindex "&%self%&" "in &(dnslookup)& router"
16677 If the host pointed to by the highest priority MX record, or looked up as an
16678 address record, is the local host, or matches &%hosts_treat_as_local%&, what
16679 happens is controlled by the generic &%self%& option.
16680
16681
16682 .section "Problems with DNS lookups" "SECTprowitdnsloo"
16683 There have been problems with DNS servers when SRV records are looked up.
16684 Some mis-behaving servers return a DNS error or timeout when a non-existent
16685 SRV record is sought. Similar problems have in the past been reported for
16686 MX records. The global &%dns_again_means_nonexist%& option can help with this
16687 problem, but it is heavy-handed because it is a global option.
16688
16689 For this reason, there are two options, &%srv_fail_domains%& and
16690 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
16691 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
16692 an attempt to look up an SRV or MX record causes one of these results, and the
16693 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
16694 such record"&. In the case of an SRV lookup, this means that the router
16695 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
16696 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
16697 case routing fails.
16698
16699
16700
16701
16702 .section "Private options for dnslookup" "SECID118"
16703 .cindex "options" "&(dnslookup)& router"
16704 The private options for the &(dnslookup)& router are as follows:
16705
16706 .option check_secondary_mx dnslookup boolean false
16707 .cindex "MX record" "checking for secondary"
16708 If this option is set, the router declines unless the local host is found in
16709 (and removed from) the list of hosts obtained by MX lookup. This can be used to
16710 process domains for which the local host is a secondary mail exchanger
16711 differently to other domains. The way in which Exim decides whether a host is
16712 the local host is described in section &<<SECTreclocipadd>>&.
16713
16714
16715 .option check_srv dnslookup string&!! unset
16716 .cindex "SRV record" "enabling use of"
16717 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
16718 addition to MX and address records. The support is disabled by default. To
16719 enable SRV support, set the &%check_srv%& option to the name of the service
16720 required. For example,
16721 .code
16722 check_srv = smtp
16723 .endd
16724 looks for SRV records that refer to the normal smtp service. The option is
16725 expanded, so the service name can vary from message to message or address
16726 to address. This might be helpful if SRV records are being used for a
16727 submission service. If the expansion is forced to fail, the &%check_srv%&
16728 option is ignored, and the router proceeds to look for MX records in the
16729 normal way.
16730
16731 When the expansion succeeds, the router searches first for SRV records for
16732 the given service (it assumes TCP protocol). A single SRV record with a
16733 host name that consists of just a single dot indicates &"no such service for
16734 this domain"&; if this is encountered, the router declines. If other kinds of
16735 SRV record are found, they are used to construct a host list for delivery
16736 according to the rules of RFC 2782. MX records are not sought in this case.
16737
16738 When no SRV records are found, MX records (and address records) are sought in
16739 the traditional way. In other words, SRV records take precedence over MX
16740 records, just as MX records take precedence over address records. Note that
16741 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
16742 defined it. It is apparently believed that MX records are sufficient for email
16743 and that SRV records should not be used for this purpose. However, SRV records
16744 have an additional &"weight"& feature which some people might find useful when
16745 trying to split an SMTP load between hosts of different power.
16746
16747 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
16748 when there is a DNS lookup error.
16749
16750
16751
16752 .option mx_domains dnslookup "domain list&!!" unset
16753 .cindex "MX record" "required to exist"
16754 .cindex "SRV record" "required to exist"
16755 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
16756 record in order to be recognized. (The name of this option could be improved.)
16757 For example, if all the mail hosts in &'fict.example'& are known to have MX
16758 records, except for those in &'discworld.fict.example'&, you could use this
16759 setting:
16760 .code
16761 mx_domains = ! *.discworld.fict.example : *.fict.example
16762 .endd
16763 This specifies that messages addressed to a domain that matches the list but
16764 has no MX record should be bounced immediately instead of being routed using
16765 the address record.
16766
16767
16768 .option mx_fail_domains dnslookup "domain list&!!" unset
16769 If the DNS lookup for MX records for one of the domains in this list causes a
16770 DNS lookup error, Exim behaves as if no MX records were found. See section
16771 &<<SECTprowitdnsloo>>& for more discussion.
16772
16773
16774
16775
16776 .option qualify_single dnslookup boolean true
16777 .cindex "DNS" "resolver options"
16778 .cindex "DNS" "qualifying single-component names"
16779 When this option is true, the resolver option RES_DEFNAMES is set for DNS
16780 lookups. Typically, but not standardly, this causes the resolver to qualify
16781 single-component names with the default domain. For example, on a machine
16782 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
16783 &'thesaurus.ref.example'& inside the resolver. For details of what your
16784 resolver actually does, consult your man pages for &'resolver'& and
16785 &'resolv.conf'&.
16786
16787
16788
16789 .option rewrite_headers dnslookup boolean true
16790 .cindex "rewriting" "header lines"
16791 .cindex "header lines" "rewriting"
16792 If the domain name in the address that is being processed is not fully
16793 qualified, it may be expanded to its full form by a DNS lookup. For example, if
16794 an address is specified as &'dormouse@teaparty'&, the domain might be
16795 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
16796 occur as a result of setting the &%widen_domains%& option. If
16797 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
16798 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
16799 header lines of the message are rewritten with the full domain name.
16800
16801 This option should be turned off only when it is known that no message is
16802 ever going to be sent outside an environment where the abbreviation makes
16803 sense.
16804
16805 When an MX record is looked up in the DNS and matches a wildcard record, name
16806 servers normally return a record containing the name that has been looked up,
16807 making it impossible to detect whether a wildcard was present or not. However,
16808 some name servers have recently been seen to return the wildcard entry. If the
16809 name returned by a DNS lookup begins with an asterisk, it is not used for
16810 header rewriting.
16811
16812
16813 .option same_domain_copy_routing dnslookup boolean false
16814 .cindex "address" "copying routing"
16815 Addresses with the same domain are normally routed by the &(dnslookup)& router
16816 to the same list of hosts. However, this cannot be presumed, because the router
16817 options and preconditions may refer to the local part of the address. By
16818 default, therefore, Exim routes each address in a message independently. DNS
16819 servers run caches, so repeated DNS lookups are not normally expensive, and in
16820 any case, personal messages rarely have more than a few recipients.
16821
16822 If you are running mailing lists with large numbers of subscribers at the same
16823 domain, and you are using a &(dnslookup)& router which is independent of the
16824 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
16825 lookups for identical domains in one message. In this case, when &(dnslookup)&
16826 routes an address to a remote transport, any other unrouted addresses in the
16827 message that have the same domain are automatically given the same routing
16828 without processing them independently,
16829 provided the following conditions are met:
16830
16831 .ilist
16832 No router that processed the address specified &%headers_add%& or
16833 &%headers_remove%&.
16834 .next
16835 The router did not change the address in any way, for example, by &"widening"&
16836 the domain.
16837 .endlist
16838
16839
16840
16841
16842 .option search_parents dnslookup boolean false
16843 .cindex "DNS" "resolver options"
16844 When this option is true, the resolver option RES_DNSRCH is set for DNS
16845 lookups. This is different from the &%qualify_single%& option in that it
16846 applies to domains containing dots. Typically, but not standardly, it causes
16847 the resolver to search for the name in the current domain and in parent
16848 domains. For example, on a machine in the &'fict.example'& domain, if looking
16849 up &'teaparty.wonderland'& failed, the resolver would try
16850 &'teaparty.wonderland.fict.example'&. For details of what your resolver
16851 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
16852
16853 Setting this option true can cause problems in domains that have a wildcard MX
16854 record, because any domain that does not have its own MX record matches the
16855 local wildcard.
16856
16857
16858
16859 .option srv_fail_domains dnslookup "domain list&!!" unset
16860 If the DNS lookup for SRV records for one of the domains in this list causes a
16861 DNS lookup error, Exim behaves as if no SRV records were found. See section
16862 &<<SECTprowitdnsloo>>& for more discussion.
16863
16864
16865
16866
16867 .option widen_domains dnslookup "string list" unset
16868 .cindex "domain" "partial; widening"
16869 If a DNS lookup fails and this option is set, each of its strings in turn is
16870 added onto the end of the domain, and the lookup is tried again. For example,
16871 if
16872 .code
16873 widen_domains = fict.example:ref.example
16874 .endd
16875 is set and a lookup of &'klingon.dictionary'& fails,
16876 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
16877 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
16878 and &%search_parents%& options can cause some widening to be undertaken inside
16879 the DNS resolver. &%widen_domains%& is not applied to sender addresses
16880 when verifying, unless &%rewrite_headers%& is false (not the default).
16881
16882
16883 .section "Effect of qualify_single and search_parents" "SECID119"
16884 When a domain from an envelope recipient is changed by the resolver as a result
16885 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
16886 corresponding address in the message's header lines unless &%rewrite_headers%&
16887 is set false. Exim then re-routes the address, using the full domain.
16888
16889 These two options affect only the DNS lookup that takes place inside the router
16890 for the domain of the address that is being routed. They do not affect lookups
16891 such as that implied by
16892 .code
16893 domains = @mx_any
16894 .endd
16895 that may happen while processing a router precondition before the router is
16896 entered. No widening ever takes place for these lookups.
16897 .ecindex IIDdnsrou1
16898 .ecindex IIDdnsrou2
16899
16900
16901
16902
16903
16904
16905
16906
16907
16908 . ////////////////////////////////////////////////////////////////////////////
16909 . ////////////////////////////////////////////////////////////////////////////
16910
16911 .chapter "The ipliteral router" "CHID5"
16912 .cindex "&(ipliteral)& router"
16913 .cindex "domain literal" "routing"
16914 .cindex "routers" "&(ipliteral)&"
16915 This router has no private options. Unless it is being used purely for
16916 verification (see &%verify_only%&) a transport is required to be defined by the
16917 generic &%transport%& option. The router accepts the address if its domain part
16918 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
16919 router handles the address
16920 .code
16921 root@[192.168.1.1]
16922 .endd
16923 by setting up delivery to the host with that IP address. IPv4 domain literals
16924 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
16925 are similar, but the address is preceded by &`ipv6:`&. For example:
16926 .code
16927 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
16928 .endd
16929 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
16930 grounds that sooner or later somebody will try it.
16931
16932 .oindex "&%self%&" "in &(ipliteral)& router"
16933 If the IP address matches something in &%ignore_target_hosts%&, the router
16934 declines. If an IP literal turns out to refer to the local host, the generic
16935 &%self%& option determines what happens.
16936
16937 The RFCs require support for domain literals; however, their use is
16938 controversial in today's Internet. If you want to use this router, you must
16939 also set the main configuration option &%allow_domain_literals%&. Otherwise,
16940 Exim will not recognize the domain literal syntax in addresses.
16941
16942
16943
16944 . ////////////////////////////////////////////////////////////////////////////
16945 . ////////////////////////////////////////////////////////////////////////////
16946
16947 .chapter "The iplookup router" "CHID6"
16948 .cindex "&(iplookup)& router"
16949 .cindex "routers" "&(iplookup)&"
16950 The &(iplookup)& router was written to fulfil a specific requirement in
16951 Cambridge University (which in fact no longer exists). For this reason, it is
16952 not included in the binary of Exim by default. If you want to include it, you
16953 must set
16954 .code
16955 ROUTER_IPLOOKUP=yes
16956 .endd
16957 in your &_Local/Makefile_& configuration file.
16958
16959 The &(iplookup)& router routes an address by sending it over a TCP or UDP
16960 connection to one or more specific hosts. The host can then return the same or
16961 a different address &-- in effect rewriting the recipient address in the
16962 message's envelope. The new address is then passed on to subsequent routers. If
16963 this process fails, the address can be passed on to other routers, or delivery
16964 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
16965 must not be specified for it.
16966
16967 .cindex "options" "&(iplookup)& router"
16968 .option hosts iplookup string unset
16969 This option must be supplied. Its value is a colon-separated list of host
16970 names. The hosts are looked up using &[gethostbyname()]&
16971 (or &[getipnodebyname()]& when available)
16972 and are tried in order until one responds to the query. If none respond, what
16973 happens is controlled by &%optional%&.
16974
16975
16976 .option optional iplookup boolean false
16977 If &%optional%& is true, if no response is obtained from any host, the address
16978 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
16979 delivery to the address is deferred.
16980
16981
16982 .option port iplookup integer 0
16983 .cindex "port" "&(iplookup)& router"
16984 This option must be supplied. It specifies the port number for the TCP or UDP
16985 call.
16986
16987
16988 .option protocol iplookup string udp
16989 This option can be set to &"udp"& or &"tcp"& to specify which of the two
16990 protocols is to be used.
16991
16992
16993 .option query iplookup string&!! "see below"
16994 This defines the content of the query that is sent to the remote hosts. The
16995 default value is:
16996 .code
16997 $local_part@$domain $local_part@$domain
16998 .endd
16999 The repetition serves as a way of checking that a response is to the correct
17000 query in the default case (see &%response_pattern%& below).
17001
17002
17003 .option reroute iplookup string&!! unset
17004 If this option is not set, the rerouted address is precisely the byte string
17005 returned by the remote host, up to the first white space, if any. If set, the
17006 string is expanded to form the rerouted address. It can include parts matched
17007 in the response by &%response_pattern%& by means of numeric variables such as
17008 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
17009 whether or not a pattern is in use. In all cases, the rerouted address must end
17010 up in the form &'local_part@domain'&.
17011
17012
17013 .option response_pattern iplookup string unset
17014 This option can be set to a regular expression that is applied to the string
17015 returned from the remote host. If the pattern does not match the response, the
17016 router declines. If &%response_pattern%& is not set, no checking of the
17017 response is done, unless the query was defaulted, in which case there is a
17018 check that the text returned after the first white space is the original
17019 address. This checks that the answer that has been received is in response to
17020 the correct question. For example, if the response is just a new domain, the
17021 following could be used:
17022 .code
17023 response_pattern = ^([^@]+)$
17024 reroute = $local_part@$1
17025 .endd
17026
17027 .option timeout iplookup time 5s
17028 This specifies the amount of time to wait for a response from the remote
17029 machine. The same timeout is used for the &[connect()]& function for a TCP
17030 call. It does not apply to UDP.
17031
17032
17033
17034
17035 . ////////////////////////////////////////////////////////////////////////////
17036 . ////////////////////////////////////////////////////////////////////////////
17037
17038 .chapter "The manualroute router" "CHID7"
17039 .scindex IIDmanrou1 "&(manualroute)& router"
17040 .scindex IIDmanrou2 "routers" "&(manualroute)&"
17041 .cindex "domain" "manually routing"
17042 The &(manualroute)& router is so-called because it provides a way of manually
17043 routing an address according to its domain. It is mainly used when you want to
17044 route addresses to remote hosts according to your own rules, bypassing the
17045 normal DNS routing that looks up MX records. However, &(manualroute)& can also
17046 route to local transports, a facility that may be useful if you want to save
17047 messages for dial-in hosts in local files.
17048
17049 The &(manualroute)& router compares a list of domain patterns with the domain
17050 it is trying to route. If there is no match, the router declines. Each pattern
17051 has associated with it a list of hosts and some other optional data, which may
17052 include a transport. The combination of a pattern and its data is called a
17053 &"routing rule"&. For patterns that do not have an associated transport, the
17054 generic &%transport%& option must specify a transport, unless the router is
17055 being used purely for verification (see &%verify_only%&).
17056
17057 .vindex "&$host$&"
17058 In the case of verification, matching the domain pattern is sufficient for the
17059 router to accept the address. When actually routing an address for delivery,
17060 an address that matches a domain pattern is queued for the associated
17061 transport. If the transport is not a local one, a host list must be associated
17062 with the pattern; IP addresses are looked up for the hosts, and these are
17063 passed to the transport along with the mail address. For local transports, a
17064 host list is optional. If it is present, it is passed in &$host$& as a single
17065 text string.
17066
17067 The list of routing rules can be provided as an inline string in
17068 &%route_list%&, or the data can be obtained by looking up the domain in a file
17069 or database by setting &%route_data%&. Only one of these settings may appear in
17070 any one instance of &(manualroute)&. The format of routing rules is described
17071 below, following the list of private options.
17072
17073
17074 .section "Private options for manualroute" "SECTprioptman"
17075
17076 .cindex "options" "&(manualroute)& router"
17077 The private options for the &(manualroute)& router are as follows:
17078
17079 .option host_all_ignored manualroute string defer
17080 See &%host_find_failed%&.
17081
17082 .option host_find_failed manualroute string freeze
17083 This option controls what happens when &(manualroute)& tries to find an IP
17084 address for a host, and the host does not exist. The option can be set to one
17085 of the following values:
17086 .code
17087 decline
17088 defer
17089 fail
17090 freeze
17091 ignore
17092 pass
17093 .endd
17094 The default (&"freeze"&) assumes that this state is a serious configuration
17095 error. The difference between &"pass"& and &"decline"& is that the former
17096 forces the address to be passed to the next router (or the router defined by
17097 &%pass_router%&),
17098 .oindex "&%more%&"
17099 overriding &%no_more%&, whereas the latter passes the address to the next
17100 router only if &%more%& is true.
17101
17102 The value &"ignore"& causes Exim to completely ignore a host whose IP address
17103 cannot be found. If all the hosts in the list are ignored, the behaviour is
17104 controlled by the &%host_all_ignored%& option. This takes the same values
17105 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
17106
17107 The &%host_find_failed%& option applies only to a definite &"does not exist"&
17108 state; if a host lookup gets a temporary error, delivery is deferred unless the
17109 generic &%pass_on_timeout%& option is set.
17110
17111
17112 .option hosts_randomize manualroute boolean false
17113 .cindex "randomized host list"
17114 .cindex "host" "list of; randomized"
17115 If this option is set, the order of the items in a host list in a routing rule
17116 is randomized each time the list is used, unless an option in the routing rule
17117 overrides (see below). Randomizing the order of a host list can be used to do
17118 crude load sharing. However, if more than one mail address is routed by the
17119 same router to the same host list, the host lists are considered to be the same
17120 (even though they may be randomized into different orders) for the purpose of
17121 deciding whether to batch the deliveries into a single SMTP transaction.
17122
17123 When &%hosts_randomize%& is true, a host list may be split
17124 into groups whose order is separately randomized. This makes it possible to
17125 set up MX-like behaviour. The boundaries between groups are indicated by an
17126 item that is just &`+`& in the host list. For example:
17127 .code
17128 route_list = * host1:host2:host3:+:host4:host5
17129 .endd
17130 The order of the first three hosts and the order of the last two hosts is
17131 randomized for each use, but the first three always end up before the last two.
17132 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
17133 randomized host list is passed to an &(smtp)& transport that also has
17134 &%hosts_randomize set%&, the list is not re-randomized.
17135
17136
17137 .option route_data manualroute string&!! unset
17138 If this option is set, it must expand to yield the data part of a routing rule.
17139 Typically, the expansion string includes a lookup based on the domain. For
17140 example:
17141 .code
17142 route_data = ${lookup{$domain}dbm{/etc/routes}}
17143 .endd
17144 If the expansion is forced to fail, or the result is an empty string, the
17145 router declines. Other kinds of expansion failure cause delivery to be
17146 deferred.
17147
17148
17149 .option route_list manualroute "string list" unset
17150 This string is a list of routing rules, in the form defined below. Note that,
17151 unlike most string lists, the items are separated by semicolons. This is so
17152 that they may contain colon-separated host lists.
17153
17154
17155 .option same_domain_copy_routing manualroute boolean false
17156 .cindex "address" "copying routing"
17157 Addresses with the same domain are normally routed by the &(manualroute)&
17158 router to the same list of hosts. However, this cannot be presumed, because the
17159 router options and preconditions may refer to the local part of the address. By
17160 default, therefore, Exim routes each address in a message independently. DNS
17161 servers run caches, so repeated DNS lookups are not normally expensive, and in
17162 any case, personal messages rarely have more than a few recipients.
17163
17164 If you are running mailing lists with large numbers of subscribers at the same
17165 domain, and you are using a &(manualroute)& router which is independent of the
17166 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
17167 lookups for identical domains in one message. In this case, when
17168 &(manualroute)& routes an address to a remote transport, any other unrouted
17169 addresses in the message that have the same domain are automatically given the
17170 same routing without processing them independently. However, this is only done
17171 if &%headers_add%& and &%headers_remove%& are unset.
17172
17173
17174
17175
17176 .section "Routing rules in route_list" "SECID120"
17177 The value of &%route_list%& is a string consisting of a sequence of routing
17178 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
17179 entered as two semicolons. Alternatively, the list separator can be changed as
17180 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
17181 Empty rules are ignored. The format of each rule is
17182 .display
17183 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
17184 .endd
17185 The following example contains two rules, each with a simple domain pattern and
17186 no options:
17187 .code
17188 route_list = \
17189   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
17190   thes.ref.example  mail-3.ref.example:mail-4.ref.example
17191 .endd
17192 The three parts of a rule are separated by white space. The pattern and the
17193 list of hosts can be enclosed in quotes if necessary, and if they are, the
17194 usual quoting rules apply. Each rule in a &%route_list%& must start with a
17195 single domain pattern, which is the only mandatory item in the rule. The
17196 pattern is in the same format as one item in a domain list (see section
17197 &<<SECTdomainlist>>&),
17198 except that it may not be the name of an interpolated file.
17199 That is, it may be wildcarded, or a regular expression, or a file or database
17200 lookup (with semicolons doubled, because of the use of semicolon as a separator
17201 in a &%route_list%&).
17202
17203 The rules in &%route_list%& are searched in order until one of the patterns
17204 matches the domain that is being routed. The list of hosts and then options are
17205 then used as described below. If there is no match, the router declines. When
17206 &%route_list%& is set, &%route_data%& must not be set.
17207
17208
17209
17210 .section "Routing rules in route_data" "SECID121"
17211 The use of &%route_list%& is convenient when there are only a small number of
17212 routing rules. For larger numbers, it is easier to use a file or database to
17213 hold the routing information, and use the &%route_data%& option instead.
17214 The value of &%route_data%& is a list of hosts, followed by (optional) options.
17215 Most commonly, &%route_data%& is set as a string that contains an
17216 expansion lookup. For example, suppose we place two routing rules in a file
17217 like this:
17218 .code
17219 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
17220 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
17221 .endd
17222 This data can be accessed by setting
17223 .code
17224 route_data = ${lookup{$domain}lsearch{/the/file/name}}
17225 .endd
17226 Failure of the lookup results in an empty string, causing the router to
17227 decline. However, you do not have to use a lookup in &%route_data%&. The only
17228 requirement is that the result of expanding the string is a list of hosts,
17229 possibly followed by options, separated by white space. The list of hosts must
17230 be enclosed in quotes if it contains white space.
17231
17232
17233
17234
17235 .section "Format of the list of hosts" "SECID122"
17236 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
17237 always separately expanded before use. If the expansion fails, the router
17238 declines. The result of the expansion must be a colon-separated list of names
17239 and/or IP addresses, optionally also including ports. The format of each item
17240 in the list is described in the next section. The list separator can be changed
17241 as described in section &<<SECTlistconstruct>>&.
17242
17243 If the list of hosts was obtained from a &%route_list%& item, the following
17244 variables are set during its expansion:
17245
17246 .ilist
17247 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
17248 If the domain was matched against a regular expression, the numeric variables
17249 &$1$&, &$2$&, etc. may be set. For example:
17250 .code
17251 route_list = ^domain(\d+)   host-$1.text.example
17252 .endd
17253 .next
17254 &$0$& is always set to the entire domain.
17255 .next
17256 &$1$& is also set when partial matching is done in a file lookup.
17257
17258 .next
17259 .vindex "&$value$&"
17260 If the pattern that matched the domain was a lookup item, the data that was
17261 looked up is available in the expansion variable &$value$&. For example:
17262 .code
17263 route_list = lsearch;;/some/file.routes  $value
17264 .endd
17265 .endlist
17266
17267 Note the doubling of the semicolon in the pattern that is necessary because
17268 semicolon is the default route list separator.
17269
17270
17271
17272 .section "Format of one host item" "SECTformatonehostitem"
17273 Each item in the list of hosts is either a host name or an IP address,
17274 optionally with an attached port number. When no port is given, an IP address
17275 is not enclosed in brackets. When a port is specified, it overrides the port
17276 specification on the transport. The port is separated from the name or address
17277 by a colon. This leads to some complications:
17278
17279 .ilist
17280 Because colon is the default separator for the list of hosts, either
17281 the colon that specifies a port must be doubled, or the list separator must
17282 be changed. The following two examples have the same effect:
17283 .code
17284 route_list = * "host1.tld::1225 : host2.tld::1226"
17285 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
17286 .endd
17287 .next
17288 When IPv6 addresses are involved, it gets worse, because they contain
17289 colons of their own. To make this case easier, it is permitted to
17290 enclose an IP address (either v4 or v6) in square brackets if a port
17291 number follows. For example:
17292 .code
17293 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
17294 .endd
17295 .endlist
17296
17297 .section "How the list of hosts is used" "SECThostshowused"
17298 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
17299 the hosts is tried, in the order specified, when carrying out the SMTP
17300 delivery. However, the order can be changed by setting the &%hosts_randomize%&
17301 option, either on the router (see section &<<SECTprioptman>>& above), or on the
17302 transport.
17303
17304 Hosts may be listed by name or by IP address. An unadorned name in the list of
17305 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
17306 interpreted as an indirection to a sublist of hosts obtained by looking up MX
17307 records in the DNS. For example:
17308 .code
17309 route_list = *  x.y.z:p.q.r/MX:e.f.g
17310 .endd
17311 If this feature is used with a port specifier, the port must come last. For
17312 example:
17313 .code
17314 route_list = *  dom1.tld/mx::1225
17315 .endd
17316 If the &%hosts_randomize%& option is set, the order of the items in the list is
17317 randomized before any lookups are done. Exim then scans the list; for any name
17318 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
17319 be an interface on the local host and the item is not the first in the list,
17320 Exim discards it and any subsequent items. If it is the first item, what
17321 happens is controlled by the
17322 .oindex "&%self%&" "in &(manualroute)& router"
17323 &%self%& option of the router.
17324
17325 A name on the list that is followed by &`/MX`& is replaced with the list of
17326 hosts obtained by looking up MX records for the name. This is always a DNS
17327 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
17328 below) are not relevant here. The order of these hosts is determined by the
17329 preference values in the MX records, according to the usual rules. Because
17330 randomizing happens before the MX lookup, it does not affect the order that is
17331 defined by MX preferences.
17332
17333 If the local host is present in the sublist obtained from MX records, but is
17334 not the most preferred host in that list, it and any equally or less
17335 preferred hosts are removed before the sublist is inserted into the main list.
17336
17337 If the local host is the most preferred host in the MX list, what happens
17338 depends on where in the original list of hosts the &`/MX`& item appears. If it
17339 is not the first item (that is, there are previous hosts in the main list),
17340 Exim discards this name and any subsequent items in the main list.
17341
17342 If the MX item is first in the list of hosts, and the local host is the
17343 most preferred host, what happens is controlled by the &%self%& option of the
17344 router.
17345
17346 DNS failures when lookup up the MX records are treated in the same way as DNS
17347 failures when looking up IP addresses: &%pass_on_timeout%& and
17348 &%host_find_failed%& are used when relevant.
17349
17350 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
17351 whether obtained from an MX lookup or not.
17352
17353
17354
17355 .section "How the options are used" "SECThowoptused"
17356 The options are a sequence of words; in practice no more than three are ever
17357 present. One of the words can be the name of a transport; this overrides the
17358 &%transport%& option on the router for this particular routing rule only. The
17359 other words (if present) control randomization of the list of hosts on a
17360 per-rule basis, and how the IP addresses of the hosts are to be found when
17361 routing to a remote transport. These options are as follows:
17362
17363 .ilist
17364 &%randomize%&: randomize the order of the hosts in this list, overriding the
17365 setting of &%hosts_randomize%& for this routing rule only.
17366 .next
17367 &%no_randomize%&: do not randomize the order of the hosts in this list,
17368 overriding the setting of &%hosts_randomize%& for this routing rule only.
17369 .next
17370 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
17371 find IP addresses. This function may ultimately cause a DNS lookup, but it may
17372 also look in &_/etc/hosts_& or other sources of information.
17373 .next
17374 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
17375 no address records are found. If there is a temporary DNS error (such as a
17376 timeout), delivery is deferred.
17377 .endlist
17378
17379 For example:
17380 .code
17381 route_list = domain1  host1:host2:host3  randomize bydns;\
17382              domain2  host4:host5
17383 .endd
17384 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
17385 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
17386 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
17387 or &[gethostbyname()]&, and the result of the lookup is the result of that
17388 call.
17389
17390 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
17391 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
17392 instead of TRY_AGAIN. That is why the default action is to try a DNS
17393 lookup first. Only if that gives a definite &"no such host"& is the local
17394 function called.
17395
17396
17397
17398 If no IP address for a host can be found, what happens is controlled by the
17399 &%host_find_failed%& option.
17400
17401 .vindex "&$host$&"
17402 When an address is routed to a local transport, IP addresses are not looked up.
17403 The host list is passed to the transport in the &$host$& variable.
17404
17405
17406
17407 .section "Manualroute examples" "SECID123"
17408 In some of the examples that follow, the presence of the &%remote_smtp%&
17409 transport, as defined in the default configuration file, is assumed:
17410
17411 .ilist
17412 .cindex "smart host" "example router"
17413 The &(manualroute)& router can be used to forward all external mail to a
17414 &'smart host'&. If you have set up, in the main part of the configuration, a
17415 named domain list that contains your local domains, for example:
17416 .code
17417 domainlist local_domains = my.domain.example
17418 .endd
17419 You can arrange for all other domains to be routed to a smart host by making
17420 your first router something like this:
17421 .code
17422 smart_route:
17423   driver = manualroute
17424   domains = !+local_domains
17425   transport = remote_smtp
17426   route_list = * smarthost.ref.example
17427 .endd
17428 This causes all non-local addresses to be sent to the single host
17429 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
17430 they are tried in order
17431 (but you can use &%hosts_randomize%& to vary the order each time).
17432 Another way of configuring the same thing is this:
17433 .code
17434 smart_route:
17435   driver = manualroute
17436   transport = remote_smtp
17437   route_list = !+local_domains  smarthost.ref.example
17438 .endd
17439 There is no difference in behaviour between these two routers as they stand.
17440 However, they behave differently if &%no_more%& is added to them. In the first
17441 example, the router is skipped if the domain does not match the &%domains%&
17442 precondition; the following router is always tried. If the router runs, it
17443 always matches the domain and so can never decline. Therefore, &%no_more%&
17444 would have no effect. In the second case, the router is never skipped; it
17445 always runs. However, if it doesn't match the domain, it declines. In this case
17446 &%no_more%& would prevent subsequent routers from running.
17447
17448 .next
17449 .cindex "mail hub example"
17450 A &'mail hub'& is a host which receives mail for a number of domains via MX
17451 records in the DNS and delivers it via its own private routing mechanism. Often
17452 the final destinations are behind a firewall, with the mail hub being the one
17453 machine that can connect to machines both inside and outside the firewall. The
17454 &(manualroute)& router is usually used on a mail hub to route incoming messages
17455 to the correct hosts. For a small number of domains, the routing can be inline,
17456 using the &%route_list%& option, but for a larger number a file or database
17457 lookup is easier to manage.
17458
17459 If the domain names are in fact the names of the machines to which the mail is
17460 to be sent by the mail hub, the configuration can be quite simple. For
17461 example:
17462 .code
17463 hub_route:
17464   driver = manualroute
17465   transport = remote_smtp
17466   route_list = *.rhodes.tvs.example  $domain
17467 .endd
17468 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
17469 whose names are the same as the mail domains. A similar approach can be taken
17470 if the host name can be obtained from the domain name by a string manipulation
17471 that the expansion facilities can handle. Otherwise, a lookup based on the
17472 domain can be used to find the host:
17473 .code
17474 through_firewall:
17475   driver = manualroute
17476   transport = remote_smtp
17477   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
17478 .endd
17479 The result of the lookup must be the name or IP address of the host (or
17480 hosts) to which the address is to be routed. If the lookup fails, the route
17481 data is empty, causing the router to decline. The address then passes to the
17482 next router.
17483
17484 .next
17485 .cindex "batched SMTP output example"
17486 .cindex "SMTP" "batched outgoing; example"
17487 You can use &(manualroute)& to deliver messages to pipes or files in batched
17488 SMTP format for onward transportation by some other means. This is one way of
17489 storing mail for a dial-up host when it is not connected. The route list entry
17490 can be as simple as a single domain name in a configuration like this:
17491 .code
17492 save_in_file:
17493   driver = manualroute
17494   transport = batchsmtp_appendfile
17495   route_list = saved.domain.example
17496 .endd
17497 though often a pattern is used to pick up more than one domain. If there are
17498 several domains or groups of domains with different transport requirements,
17499 different transports can be listed in the routing information:
17500 .code
17501 save_in_file:
17502   driver = manualroute
17503   route_list = \
17504     *.saved.domain1.example  $domain  batch_appendfile; \
17505     *.saved.domain2.example  \
17506       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
17507       batch_pipe
17508 .endd
17509 .vindex "&$domain$&"
17510 .vindex "&$host$&"
17511 The first of these just passes the domain in the &$host$& variable, which
17512 doesn't achieve much (since it is also in &$domain$&), but the second does a
17513 file lookup to find a value to pass, causing the router to decline to handle
17514 the address if the lookup fails.
17515
17516 .next
17517 .cindex "UUCP" "example of router for"
17518 Routing mail directly to UUCP software is a specific case of the use of
17519 &(manualroute)& in a gateway to another mail environment. This is an example of
17520 one way it can be done:
17521 .code
17522 # Transport
17523 uucp:
17524   driver = pipe
17525   user = nobody
17526   command = /usr/local/bin/uux -r - \
17527     ${substr_-5:$host}!rmail ${local_part}
17528   return_fail_output = true
17529
17530 # Router
17531 uucphost:
17532   transport = uucp
17533   driver = manualroute
17534   route_data = \
17535     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
17536 .endd
17537 The file &_/usr/local/exim/uucphosts_& contains entries like
17538 .code
17539 darksite.ethereal.example:           darksite.UUCP
17540 .endd
17541 It can be set up more simply without adding and removing &".UUCP"& but this way
17542 makes clear the distinction between the domain name
17543 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
17544 .endlist
17545 .ecindex IIDmanrou1
17546 .ecindex IIDmanrou2
17547
17548
17549
17550
17551
17552
17553
17554
17555 . ////////////////////////////////////////////////////////////////////////////
17556 . ////////////////////////////////////////////////////////////////////////////
17557
17558 .chapter "The queryprogram router" "CHAPdriverlast"
17559 .scindex IIDquerou1 "&(queryprogram)& router"
17560 .scindex IIDquerou2 "routers" "&(queryprogram)&"
17561 .cindex "routing" "by external program"
17562 The &(queryprogram)& router routes an address by running an external command
17563 and acting on its output. This is an expensive way to route, and is intended
17564 mainly for use in lightly-loaded systems, or for performing experiments.
17565 However, if it is possible to use the precondition options (&%domains%&,
17566 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
17567 be used in special cases, even on a busy host. There are the following private
17568 options:
17569 .cindex "options" "&(queryprogram)& router"
17570
17571 .option command queryprogram string&!! unset
17572 This option must be set. It specifies the command that is to be run. The
17573 command is split up into a command name and arguments, and then each is
17574 expanded separately (exactly as for a &(pipe)& transport, described in chapter
17575 &<<CHAPpipetransport>>&).
17576
17577
17578 .option command_group queryprogram string unset
17579 .cindex "gid (group id)" "in &(queryprogram)& router"
17580 This option specifies a gid to be set when running the command while routing an
17581 address for deliver. It must be set if &%command_user%& specifies a numerical
17582 uid. If it begins with a digit, it is interpreted as the numerical value of the
17583 gid. Otherwise it is looked up using &[getgrnam()]&.
17584
17585
17586 .option command_user queryprogram string unset
17587 .cindex "uid (user id)" "for &(queryprogram)&"
17588 This option must be set. It specifies the uid which is set when running the
17589 command while routing an address for delivery. If the value begins with a digit,
17590 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
17591 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
17592 not set, a value for the gid also.
17593
17594 &*Warning:*& Changing uid and gid is possible only when Exim is running as
17595 root, which it does during a normal delivery in a conventional configuration.
17596 However, when an address is being verified during message reception, Exim is
17597 usually running as the Exim user, not as root. If the &(queryprogram)& router
17598 is called from a non-root process, Exim cannot change uid or gid before running
17599 the command. In this circumstance the command runs under the current uid and
17600 gid.
17601
17602
17603 .option current_directory queryprogram string /
17604 This option specifies an absolute path which is made the current directory
17605 before running the command.
17606
17607
17608 .option timeout queryprogram time 1h
17609 If the command does not complete within the timeout period, its process group
17610 is killed and the message is frozen. A value of zero time specifies no
17611 timeout.
17612
17613
17614 The standard output of the command is connected to a pipe, which is read when
17615 the command terminates. It should consist of a single line of output,
17616 containing up to five fields, separated by white space. The maximum length of
17617 the line is 1023 characters. Longer lines are silently truncated. The first
17618 field is one of the following words (case-insensitive):
17619
17620 .ilist
17621 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
17622 below).
17623 .next
17624 &'Decline'&: the router declines; pass the address to the next router, unless
17625 &%no_more%& is set.
17626 .next
17627 &'Fail'&: routing failed; do not pass the address to any more routers. Any
17628 subsequent text on the line is an error message. If the router is run as part
17629 of address verification during an incoming SMTP message, the message is
17630 included in the SMTP response.
17631 .next
17632 &'Defer'&: routing could not be completed at this time; try again later. Any
17633 subsequent text on the line is an error message which is logged. It is not
17634 included in any SMTP response.
17635 .next
17636 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
17637 .next
17638 &'Pass'&: pass the address to the next router (or the router specified by
17639 &%pass_router%&), overriding &%no_more%&.
17640 .next
17641 &'Redirect'&: the message is redirected. The remainder of the line is a list of
17642 new addresses, which are routed independently, starting with the first router,
17643 or the router specified by &%redirect_router%&, if set.
17644 .endlist
17645
17646 When the first word is &'accept'&, the remainder of the line consists of a
17647 number of keyed data values, as follows (split into two lines here, to fit on
17648 the page):
17649 .code
17650 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
17651 LOOKUP=byname|bydns DATA=<text>
17652 .endd
17653 The data items can be given in any order, and all are optional. If no transport
17654 is included, the transport specified by the generic &%transport%& option is
17655 used. The list of hosts and the lookup type are needed only if the transport is
17656 an &(smtp)& transport that does not itself supply a list of hosts.
17657
17658 The format of the list of hosts is the same as for the &(manualroute)& router.
17659 As well as host names and IP addresses with optional port numbers, as described
17660 in section &<<SECTformatonehostitem>>&, it may contain names followed by
17661 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
17662 (see section &<<SECThostshowused>>&).
17663
17664 If the lookup type is not specified, Exim behaves as follows when trying to
17665 find an IP address for each host: First, a DNS lookup is done. If this yields
17666 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
17667 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
17668 result of the lookup is the result of that call.
17669
17670 .vindex "&$address_data$&"
17671 If the DATA field is set, its value is placed in the &$address_data$&
17672 variable. For example, this return line
17673 .code
17674 accept hosts=x1.y.example:x2.y.example data="rule1"
17675 .endd
17676 routes the address to the default transport, passing a list of two hosts. When
17677 the transport runs, the string &"rule1"& is in &$address_data$&.
17678 .ecindex IIDquerou1
17679 .ecindex IIDquerou2
17680
17681
17682
17683
17684 . ////////////////////////////////////////////////////////////////////////////
17685 . ////////////////////////////////////////////////////////////////////////////
17686
17687 .chapter "The redirect router" "CHAPredirect"
17688 .scindex IIDredrou1 "&(redirect)& router"
17689 .scindex IIDredrou2 "routers" "&(redirect)&"
17690 .cindex "alias file" "in a &(redirect)& router"
17691 .cindex "address redirection" "&(redirect)& router"
17692 The &(redirect)& router handles several kinds of address redirection. Its most
17693 common uses are for resolving local part aliases from a central alias file
17694 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
17695 files, but it has many other potential uses. The incoming address can be
17696 redirected in several different ways:
17697
17698 .ilist
17699 It can be replaced by one or more new addresses which are themselves routed
17700 independently.
17701 .next
17702 It can be routed to be delivered to a given file or directory.
17703 .next
17704 It can be routed to be delivered to a specified pipe command.
17705 .next
17706 It can cause an automatic reply to be generated.
17707 .next
17708 It can be forced to fail, optionally with a custom error message.
17709 .next
17710 It can be temporarily deferred, optionally with a custom message.
17711 .next
17712 It can be discarded.
17713 .endlist
17714
17715 The generic &%transport%& option must not be set for &(redirect)& routers.
17716 However, there are some private options which define transports for delivery to
17717 files and pipes, and for generating autoreplies. See the &%file_transport%&,
17718 &%pipe_transport%& and &%reply_transport%& descriptions below.
17719
17720
17721
17722 .section "Redirection data" "SECID124"
17723 The router operates by interpreting a text string which it obtains either by
17724 expanding the contents of the &%data%& option, or by reading the entire
17725 contents of a file whose name is given in the &%file%& option. These two
17726 options are mutually exclusive. The first is commonly used for handling system
17727 aliases, in a configuration like this:
17728 .code
17729 system_aliases:
17730   driver = redirect
17731   data = ${lookup{$local_part}lsearch{/etc/aliases}}
17732 .endd
17733 If the lookup fails, the expanded string in this example is empty. When the
17734 expansion of &%data%& results in an empty string, the router declines. A forced
17735 expansion failure also causes the router to decline; other expansion failures
17736 cause delivery to be deferred.
17737
17738 A configuration using &%file%& is commonly used for handling users'
17739 &_.forward_& files, like this:
17740 .code
17741 userforward:
17742   driver = redirect
17743   check_local_user
17744   file = $home/.forward
17745   no_verify
17746 .endd
17747 If the file does not exist, or causes no action to be taken (for example, it is
17748 empty or consists only of comments), the router declines. &*Warning*&: This
17749 is not the case when the file contains syntactically valid items that happen to
17750 yield empty addresses, for example, items containing only RFC 2822 address
17751 comments.
17752
17753
17754
17755 .section "Forward files and address verification" "SECID125"
17756 .cindex "address redirection" "while verifying"
17757 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
17758 &_.forward_& files, as in the example above. There are two reasons for this:
17759
17760 .ilist
17761 When Exim is receiving an incoming SMTP message from a remote host, it is
17762 running under the Exim uid, not as root. Exim is unable to change uid to read
17763 the file as the user, and it may not be able to read it as the Exim user. So in
17764 practice the router may not be able to operate.
17765 .next
17766 However, even when the router can operate, the existence of a &_.forward_& file
17767 is unimportant when verifying an address. What should be checked is whether the
17768 local part is a valid user name or not. Cutting out the redirection processing
17769 saves some resources.
17770 .endlist
17771
17772
17773
17774
17775
17776
17777 .section "Interpreting redirection data" "SECID126"
17778 .cindex "Sieve filter" "specifying in redirection data"
17779 .cindex "filter" "specifying in redirection data"
17780 The contents of the data string, whether obtained from &%data%& or &%file%&,
17781 can be interpreted in two different ways:
17782
17783 .ilist
17784 If the &%allow_filter%& option is set true, and the data begins with the text
17785 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
17786 &'filtering'& instructions in the form of an Exim or Sieve filter file,
17787 respectively. Details of the syntax and semantics of filter files are described
17788 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
17789 document is intended for use by end users.
17790 .next
17791 Otherwise, the data must be a comma-separated list of redirection items, as
17792 described in the next section.
17793 .endlist
17794
17795 When a message is redirected to a file (a &"mail folder"&), the file name given
17796 in a non-filter redirection list must always be an absolute path. A filter may
17797 generate a relative path &-- how this is handled depends on the transport's
17798 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
17799 for the &(appendfile)& transport.
17800
17801
17802
17803 .section "Items in a non-filter redirection list" "SECTitenonfilred"
17804 .cindex "address redirection" "non-filter list items"
17805 When the redirection data is not an Exim or Sieve filter, for example, if it
17806 comes from a conventional alias or forward file, it consists of a list of
17807 addresses, file names, pipe commands, or certain special items (see section
17808 &<<SECTspecitredli>>& below). The special items can be individually enabled or
17809 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
17810 depending on their default values. The items in the list are separated by
17811 commas or newlines.
17812 If a comma is required in an item, the entire item must be enclosed in double
17813 quotes.
17814
17815 Lines starting with a # character are comments, and are ignored, and # may
17816 also appear following a comma, in which case everything between the # and the
17817 next newline character is ignored.
17818
17819 If an item is entirely enclosed in double quotes, these are removed. Otherwise
17820 double quotes are retained because some forms of mail address require their use
17821 (but never to enclose the entire address). In the following description,
17822 &"item"& refers to what remains after any surrounding double quotes have been
17823 removed.
17824
17825 .vindex "&$local_part$&"
17826 &*Warning*&: If you use an Exim expansion to construct a redirection address,
17827 and the expansion contains a reference to &$local_part$&, you should make use
17828 of the &%quote_local_part%& expansion operator, in case the local part contains
17829 special characters. For example, to redirect all mail for the domain
17830 &'obsolete.example'&, retaining the existing local part, you could use this
17831 setting:
17832 .code
17833 data = ${quote_local_part:$local_part}@newdomain.example
17834 .endd
17835
17836
17837 .section "Redirecting to a local mailbox" "SECTredlocmai"
17838 .cindex "routing" "loops in"
17839 .cindex "loop" "while routing, avoidance of"
17840 .cindex "address redirection" "to local mailbox"
17841 A redirection item may safely be the same as the address currently under
17842 consideration. This does not cause a routing loop, because a router is
17843 automatically skipped if any ancestor of the address that is being processed
17844 is the same as the current address and was processed by the current router.
17845 Such an address is therefore passed to the following routers, so it is handled
17846 as if there were no redirection. When making this loop-avoidance test, the
17847 complete local part, including any prefix or suffix, is used.
17848
17849 .cindex "address redirection" "local part without domain"
17850 Specifying the same local part without a domain is a common usage in personal
17851 filter files when the user wants to have messages delivered to the local
17852 mailbox and also forwarded elsewhere. For example, the user whose login is
17853 &'cleo'& might have a &_.forward_& file containing this:
17854 .code
17855 cleo, cleopatra@egypt.example
17856 .endd
17857 .cindex "backslash in alias file"
17858 .cindex "alias file" "backslash in"
17859 For compatibility with other MTAs, such unqualified local parts may be
17860 preceded by &"\"&, but this is not a requirement for loop prevention. However,
17861 it does make a difference if more than one domain is being handled
17862 synonymously.
17863
17864 If an item begins with &"\"& and the rest of the item parses as a valid RFC
17865 2822 address that does not include a domain, the item is qualified using the
17866 domain of the incoming address. In the absence of a leading &"\"&, unqualified
17867 addresses are qualified using the value in &%qualify_recipient%&, but you can
17868 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
17869
17870 Care must be taken if there are alias names for local users.
17871 Consider an MTA handling a single local domain where the system alias file
17872 contains:
17873 .code
17874 Sam.Reman: spqr
17875 .endd
17876 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
17877 messages in the local mailbox, and also forward copies elsewhere. He creates
17878 this forward file:
17879 .code
17880 Sam.Reman, spqr@reme.elsewhere.example
17881 .endd
17882 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
17883 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
17884 second time round, because it has previously routed it,
17885 and the following routers presumably cannot handle the alias. The forward file
17886 should really contain
17887 .code
17888 spqr, spqr@reme.elsewhere.example
17889 .endd
17890 but because this is such a common error, the &%check_ancestor%& option (see
17891 below) exists to provide a way to get round it. This is normally set on a
17892 &(redirect)& router that is handling users' &_.forward_& files.
17893
17894
17895
17896 .section "Special items in redirection lists" "SECTspecitredli"
17897 In addition to addresses, the following types of item may appear in redirection
17898 lists (that is, in non-filter redirection data):
17899
17900 .ilist
17901 .cindex "pipe" "in redirection list"
17902 .cindex "address redirection" "to pipe"
17903 An item is treated as a pipe command if it begins with &"|"& and does not parse
17904 as a valid RFC 2822 address that includes a domain. A transport for running the
17905 command must be specified by the &%pipe_transport%& option.
17906 Normally, either the router or the transport specifies a user and a group under
17907 which to run the delivery. The default is to use the Exim user and group.
17908
17909 Single or double quotes can be used for enclosing the individual arguments of
17910 the pipe command; no interpretation of escapes is done for single quotes. If
17911 the command contains a comma character, it is necessary to put the whole item
17912 in double quotes, for example:
17913 .code
17914 "|/some/command ready,steady,go"
17915 .endd
17916 since items in redirection lists are terminated by commas. Do not, however,
17917 quote just the command. An item such as
17918 .code
17919 |"/some/command ready,steady,go"
17920 .endd
17921 is interpreted as a pipe with a rather strange command name, and no arguments.
17922
17923 .next
17924 .cindex "file" "in redirection list"
17925 .cindex "address redirection" "to file"
17926 An item is interpreted as a path name if it begins with &"/"& and does not
17927 parse as a valid RFC 2822 address that includes a domain. For example,
17928 .code
17929 /home/world/minbari
17930 .endd
17931 is treated as a file name, but
17932 .code
17933 /s=molari/o=babylon/@x400gate.way
17934 .endd
17935 is treated as an address. For a file name, a transport must be specified using
17936 the &%file_transport%& option. However, if the generated path name ends with a
17937 forward slash character, it is interpreted as a directory name rather than a
17938 file name, and &%directory_transport%& is used instead.
17939
17940 Normally, either the router or the transport specifies a user and a group under
17941 which to run the delivery. The default is to use the Exim user and group.
17942
17943 .cindex "&_/dev/null_&"
17944 However, if a redirection item is the path &_/dev/null_&, delivery to it is
17945 bypassed at a high level, and the log entry shows &"**bypassed**"&
17946 instead of a transport name. In this case the user and group are not used.
17947
17948 .next
17949 .cindex "included address list"
17950 .cindex "address redirection" "included external list"
17951 If an item is of the form
17952 .code
17953 :include:<path name>
17954 .endd
17955 a list of further items is taken from the given file and included at that
17956 point. &*Note*&: Such a file can not be a filter file; it is just an
17957 out-of-line addition to the list. The items in the included list are separated
17958 by commas or newlines and are not subject to expansion. If this is the first
17959 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
17960 the alias name. This example is incorrect:
17961 .code
17962 list1    :include:/opt/lists/list1
17963 .endd
17964 It must be given as
17965 .code
17966 list1:   :include:/opt/lists/list1
17967 .endd
17968 .next
17969 .cindex "address redirection" "to black hole"
17970 Sometimes you want to throw away mail to a particular local part. Making the
17971 &%data%& option expand to an empty string does not work, because that causes
17972 the router to decline. Instead, the alias item
17973 .cindex "black hole"
17974 .cindex "abandoning mail"
17975 &':blackhole:'& can be used. It does what its name implies. No delivery is
17976 done, and no error message is generated. This has the same effect as specifing
17977 &_/dev/null_& as a destination, but it can be independently disabled.
17978
17979 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
17980 delivery is done for the original local part, even if other redirection items
17981 are present. If you are generating a multi-item list (for example, by reading a
17982 database) and need the ability to provide a no-op item, you must use
17983 &_/dev/null_&.
17984
17985 .next
17986 .cindex "delivery" "forcing failure"
17987 .cindex "delivery" "forcing deferral"
17988 .cindex "failing delivery" "forcing"
17989 .cindex "deferred delivery, forcing"
17990 .cindex "customizing" "failure message"
17991 An attempt to deliver a particular address can be deferred or forced to fail by
17992 redirection items of the form
17993 .code
17994 :defer:
17995 :fail:
17996 .endd
17997 respectively. When a redirection list contains such an item, it applies
17998 to the entire redirection; any other items in the list are ignored. Any
17999 text following &':fail:'& or &':defer:'& is placed in the error text
18000 associated with the failure. For example, an alias file might contain:
18001 .code
18002 X.Employee:  :fail: Gone away, no forwarding address
18003 .endd
18004 In the case of an address that is being verified from an ACL or as the subject
18005 of a
18006 .cindex "VRFY" "error text, display of"
18007 VRFY command, the text is included in the SMTP error response by
18008 default.
18009 .cindex "EXPN" "error text, display of"
18010 The text is not included in the response to an EXPN command. In non-SMTP cases
18011 the text is included in the error message that Exim generates.
18012
18013 .cindex "SMTP" "error codes"
18014 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
18015 &':fail:'&. However, if the message starts with three digits followed by a
18016 space, optionally followed by an extended code of the form &'n.n.n'&, also
18017 followed by a space, and the very first digit is the same as the default error
18018 code, the code from the message is used instead. If the very first digit is
18019 incorrect, a panic error is logged, and the default code is used. You can
18020 suppress the use of the supplied code in a redirect router by setting the
18021 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
18022 ignored.
18023
18024 .vindex "&$acl_verify_message$&"
18025 In an ACL, an explicitly provided message overrides the default, but the
18026 default message is available in the variable &$acl_verify_message$& and can
18027 therefore be included in a custom message if this is desired.
18028
18029 Normally the error text is the rest of the redirection list &-- a comma does
18030 not terminate it &-- but a newline does act as a terminator. Newlines are not
18031 normally present in alias expansions. In &(lsearch)& lookups they are removed
18032 as part of the continuation process, but they may exist in other kinds of
18033 lookup and in &':include:'& files.
18034
18035 During routing for message delivery (as opposed to verification), a redirection
18036 containing &':fail:'& causes an immediate failure of the incoming address,
18037 whereas &':defer:'& causes the message to remain on the queue so that a
18038 subsequent delivery attempt can happen at a later time. If an address is
18039 deferred for too long, it will ultimately fail, because the normal retry
18040 rules still apply.
18041
18042 .next
18043 .cindex "alias file" "exception to default"
18044 Sometimes it is useful to use a single-key search type with a default (see
18045 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
18046 for exceptions to the default. These can be handled by aliasing them to
18047 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
18048 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
18049 results in an empty redirection list has the same effect.
18050 .endlist
18051
18052
18053 .section "Duplicate addresses" "SECTdupaddr"
18054 .cindex "duplicate addresses"
18055 .cindex "address duplicate, discarding"
18056 .cindex "pipe" "duplicated"
18057 Exim removes duplicate addresses from the list to which it is delivering, so as
18058 to deliver just one copy to each address. This does not apply to deliveries
18059 routed to pipes by different immediate parent addresses, but an indirect
18060 aliasing scheme of the type
18061 .code
18062 pipe:       |/some/command $local_part
18063 localpart1: pipe
18064 localpart2: pipe
18065 .endd
18066 does not work with a message that is addressed to both local parts, because
18067 when the second is aliased to the intermediate local part &"pipe"& it gets
18068 discarded as being the same as a previously handled address. However, a scheme
18069 such as
18070 .code
18071 localpart1: |/some/command $local_part
18072 localpart2: |/some/command $local_part
18073 .endd
18074 does result in two different pipe deliveries, because the immediate parents of
18075 the pipes are distinct.
18076
18077
18078
18079 .section "Repeated redirection expansion" "SECID128"
18080 .cindex "repeated redirection expansion"
18081 .cindex "address redirection" "repeated for each delivery attempt"
18082 When a message cannot be delivered to all of its recipients immediately,
18083 leading to two or more delivery attempts, redirection expansion is carried out
18084 afresh each time for those addresses whose children were not all previously
18085 delivered. If redirection is being used as a mailing list, this can lead to new
18086 members of the list receiving copies of old messages. The &%one_time%& option
18087 can be used to avoid this.
18088
18089
18090 .section "Errors in redirection lists" "SECID129"
18091 .cindex "address redirection" "errors"
18092 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
18093 error is skipped, and an entry is written to the main log. This may be useful
18094 for mailing lists that are automatically managed. Otherwise, if an error is
18095 detected while generating the list of new addresses, the original address is
18096 deferred. See also &%syntax_errors_to%&.
18097
18098
18099
18100 .section "Private options for the redirect router" "SECID130"
18101
18102 .cindex "options" "&(redirect)& router"
18103 The private options for the &(redirect)& router are as follows:
18104
18105
18106 .option allow_defer redirect boolean false
18107 Setting this option allows the use of &':defer:'& in non-filter redirection
18108 data, or the &%defer%& command in an Exim filter file.
18109
18110
18111 .option allow_fail redirect boolean false
18112 .cindex "failing delivery" "from filter"
18113 If this option is true, the &':fail:'& item can be used in a redirection list,
18114 and the &%fail%& command may be used in an Exim filter file.
18115
18116
18117 .option allow_filter redirect boolean false
18118 .cindex "filter" "enabling use of"
18119 .cindex "Sieve filter" "enabling use of"
18120 Setting this option allows Exim to interpret redirection data that starts with
18121 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
18122 are some features of Exim filter files that some administrators may wish to
18123 lock out; see the &%forbid_filter_%&&'xxx'& options below.
18124
18125 It is also possible to lock out Exim filters or Sieve filters while allowing
18126 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
18127
18128
18129 The filter is run using the uid and gid set by the generic &%user%& and
18130 &%group%& options. These take their defaults from the password data if
18131 &%check_local_user%& is set, so in the normal case of users' personal filter
18132 files, the filter is run as the relevant user. When &%allow_filter%& is set
18133 true, Exim insists that either &%check_local_user%& or &%user%& is set.
18134
18135
18136
18137 .option allow_freeze redirect boolean false
18138 .cindex "freezing messages" "allowing in filter"
18139 Setting this option allows the use of the &%freeze%& command in an Exim filter.
18140 This command is more normally encountered in system filters, and is disabled by
18141 default for redirection filters because it isn't something you usually want to
18142 let ordinary users do.
18143
18144
18145
18146 .option check_ancestor redirect boolean false
18147 This option is concerned with handling generated addresses that are the same
18148 as some address in the list of redirection ancestors of the current address.
18149 Although it is turned off by default in the code, it is set in the default
18150 configuration file for handling users' &_.forward_& files. It is recommended
18151 for this use of the &(redirect)& router.
18152
18153 When &%check_ancestor%& is set, if a generated address (including the domain)
18154 is the same as any ancestor of the current address, it is replaced by a copy of
18155 the current address. This helps in the case where local part A is aliased to B,
18156 and B has a &_.forward_& file pointing back to A. For example, within a single
18157 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
18158 &_&~jb/.forward_& contains:
18159 .code
18160 \Joe.Bloggs, <other item(s)>
18161 .endd
18162 Without the &%check_ancestor%& setting, either local part (&"jb"& or
18163 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
18164 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
18165 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
18166 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
18167 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
18168 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
18169 original address. See also the &%repeat_use%& option below.
18170
18171
18172 .option check_group redirect boolean "see below"
18173 When the &%file%& option is used, the group owner of the file is checked only
18174 when this option is set. The permitted groups are those listed in the
18175 &%owngroups%& option, together with the user's default group if
18176 &%check_local_user%& is set. If the file has the wrong group, routing is
18177 deferred. The default setting for this option is true if &%check_local_user%&
18178 is set and the &%modemask%& option permits the group write bit, or if the
18179 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
18180
18181
18182
18183 .option check_owner redirect boolean "see below"
18184 When the &%file%& option is used, the owner of the file is checked only when
18185 this option is set. If &%check_local_user%& is set, the local user is
18186 permitted; otherwise the owner must be one of those listed in the &%owners%&
18187 option. The default value for this option is true if &%check_local_user%& or
18188 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
18189
18190
18191 .option data redirect string&!! unset
18192 This option is mutually exclusive with &%file%&. One or other of them must be
18193 set, but not both. The contents of &%data%& are expanded, and then used as the
18194 list of forwarding items, or as a set of filtering instructions. If the
18195 expansion is forced to fail, or the result is an empty string or a string that
18196 has no effect (consists entirely of comments), the router declines.
18197
18198 When filtering instructions are used, the string must begin with &"#Exim
18199 filter"&, and all comments in the string, including this initial one, must be
18200 terminated with newline characters. For example:
18201 .code
18202 data = #Exim filter\n\
18203        if $h_to: contains Exim then save $home/mail/exim endif
18204 .endd
18205 If you are reading the data from a database where newlines cannot be included,
18206 you can use the &${sg}$& expansion item to turn the escape string of your
18207 choice into a newline.
18208
18209
18210 .option directory_transport redirect string&!! unset
18211 A &(redirect)& router sets up a direct delivery to a directory when a path name
18212 ending with a slash is specified as a new &"address"&. The transport used is
18213 specified by this option, which, after expansion, must be the name of a
18214 configured transport. This should normally be an &(appendfile)& transport.
18215
18216
18217 .option file redirect string&!! unset
18218 This option specifies the name of a file that contains the redirection data. It
18219 is mutually exclusive with the &%data%& option. The string is expanded before
18220 use; if the expansion is forced to fail, the router declines. Other expansion
18221 failures cause delivery to be deferred. The result of a successful expansion
18222 must be an absolute path. The entire file is read and used as the redirection
18223 data. If the data is an empty string or a string that has no effect (consists
18224 entirely of comments), the router declines.
18225
18226 .cindex "NFS" "checking for file existence"
18227 If the attempt to open the file fails with a &"does not exist"& error, Exim
18228 runs a check on the containing directory,
18229 unless &%ignore_enotdir%& is true (see below).
18230 If the directory does not appear to exist, delivery is deferred. This can
18231 happen when users' &_.forward_& files are in NFS-mounted directories, and there
18232 is a mount problem. If the containing directory does exist, but the file does
18233 not, the router declines.
18234
18235
18236 .option file_transport redirect string&!! unset
18237 .vindex "&$address_file$&"
18238 A &(redirect)& router sets up a direct delivery to a file when a path name not
18239 ending in a slash is specified as a new &"address"&. The transport used is
18240 specified by this option, which, after expansion, must be the name of a
18241 configured transport. This should normally be an &(appendfile)& transport. When
18242 it is running, the file name is in &$address_file$&.
18243
18244
18245 .option filter_prepend_home redirect boolean true
18246 When this option is true, if a &(save)& command in an Exim filter specifies a
18247 relative path, and &$home$& is defined, it is automatically prepended to the
18248 relative path. If this option is set false, this action does not happen. The
18249 relative path is then passed to the transport unmodified.
18250
18251
18252 .option forbid_blackhole redirect boolean false
18253 If this option is true, the &':blackhole:'& item may not appear in a
18254 redirection list.
18255
18256
18257 .option forbid_exim_filter redirect boolean false
18258 If this option is set true, only Sieve filters are permitted when
18259 &%allow_filter%& is true.
18260
18261
18262
18263
18264 .option forbid_file redirect boolean false
18265 .cindex "delivery" "to file; forbidding"
18266 .cindex "Sieve filter" "forbidding delivery to a file"
18267 .cindex "Sieve filter" "&""keep""& facility; disabling"
18268 If this option is true, this router may not generate a new address that
18269 specifies delivery to a local file or directory, either from a filter or from a
18270 conventional forward file. This option is forced to be true if &%one_time%& is
18271 set. It applies to Sieve filters as well as to Exim filters, but if true, it
18272 locks out the Sieve's &"keep"& facility.
18273
18274
18275 .option forbid_filter_dlfunc redirect boolean false
18276 .cindex "filter" "locking out certain features"
18277 If this option is true, string expansions in Exim filters are not allowed to
18278 make use of the &%dlfunc%& expansion facility to run dynamically loaded
18279 functions.
18280
18281 .option forbid_filter_existstest redirect boolean false
18282 .cindex "expansion" "statting a file"
18283 If this option is true, string expansions in Exim filters are not allowed to
18284 make use of the &%exists%& condition or the &%stat%& expansion item.
18285
18286 .option forbid_filter_logwrite redirect boolean false
18287 If this option is true, use of the logging facility in Exim filters is not
18288 permitted. Logging is in any case available only if the filter is being run
18289 under some unprivileged uid (which is normally the case for ordinary users'
18290 &_.forward_& files).
18291
18292
18293 .option forbid_filter_lookup redirect boolean false
18294 If this option is true, string expansions in Exim filter files are not allowed
18295 to make use of &%lookup%& items.
18296
18297
18298 .option forbid_filter_perl redirect boolean false
18299 This option has an effect only if Exim is built with embedded Perl support. If
18300 it is true, string expansions in Exim filter files are not allowed to make use
18301 of the embedded Perl support.
18302
18303
18304 .option forbid_filter_readfile redirect boolean false
18305 If this option is true, string expansions in Exim filter files are not allowed
18306 to make use of &%readfile%& items.
18307
18308
18309 .option forbid_filter_readsocket redirect boolean false
18310 If this option is true, string expansions in Exim filter files are not allowed
18311 to make use of &%readsocket%& items.
18312
18313
18314 .option forbid_filter_reply redirect boolean false
18315 If this option is true, this router may not generate an automatic reply
18316 message. Automatic replies can be generated only from Exim or Sieve filter
18317 files, not from traditional forward files. This option is forced to be true if
18318 &%one_time%& is set.
18319
18320
18321 .option forbid_filter_run redirect boolean false
18322 If this option is true, string expansions in Exim filter files are not allowed
18323 to make use of &%run%& items.
18324
18325
18326 .option forbid_include redirect boolean false
18327 If this option is true, items of the form
18328 .code
18329 :include:<path name>
18330 .endd
18331 are not permitted in non-filter redirection lists.
18332
18333
18334 .option forbid_pipe redirect boolean false
18335 .cindex "delivery" "to pipe; forbidding"
18336 If this option is true, this router may not generate a new address which
18337 specifies delivery to a pipe, either from an Exim filter or from a conventional
18338 forward file. This option is forced to be true if &%one_time%& is set.
18339
18340
18341 .option forbid_sieve_filter redirect boolean false
18342 If this option is set true, only Exim filters are permitted when
18343 &%allow_filter%& is true.
18344
18345
18346 .cindex "SMTP" "error codes"
18347 .option forbid_smtp_code redirect boolean false
18348 If this option is set true, any SMTP error codes that are present at the start
18349 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
18350 the default codes (451 and 550, respectively) are always used.
18351
18352
18353
18354
18355 .option hide_child_in_errmsg redirect boolean false
18356 .cindex "bounce message" "redirection details; suppressing"
18357 If this option is true, it prevents Exim from quoting a child address if it
18358 generates a bounce or delay message for it. Instead it says &"an address
18359 generated from <&'the top level address'&>"&. Of course, this applies only to
18360 bounces generated locally. If a message is forwarded to another host, &'its'&
18361 bounce may well quote the generated address.
18362
18363
18364 .option ignore_eacces redirect boolean false
18365 .cindex "EACCES"
18366 If this option is set and an attempt to open a redirection file yields the
18367 EACCES error (permission denied), the &(redirect)& router behaves as if the
18368 file did not exist.
18369
18370
18371 .option ignore_enotdir redirect boolean false
18372 .cindex "ENOTDIR"
18373 If this option is set and an attempt to open a redirection file yields the
18374 ENOTDIR error (something on the path is not a directory), the &(redirect)&
18375 router behaves as if the file did not exist.
18376
18377 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
18378 router that has the &%file%& option set discovers that the file does not exist
18379 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
18380 against unmounted NFS directories. If the parent can not be statted, delivery
18381 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
18382 is set, because that option tells Exim to ignore &"something on the path is not
18383 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
18384 that some operating systems give ENOENT where others give ENOTDIR.
18385
18386
18387
18388 .option include_directory redirect string unset
18389 If this option is set, the path names of any &':include:'& items in a
18390 redirection list must start with this directory.
18391
18392
18393 .option modemask redirect "octal integer" 022
18394 This specifies mode bits which must not be set for a file specified by the
18395 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
18396
18397
18398 .option one_time redirect boolean false
18399 .cindex "one-time aliasing/forwarding expansion"
18400 .cindex "alias file" "one-time expansion"
18401 .cindex "forward file" "one-time expansion"
18402 .cindex "mailing lists" "one-time expansion"
18403 .cindex "address redirection" "one-time expansion"
18404 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
18405 files each time it tries to deliver a message causes a problem when one or more
18406 of the generated addresses fails be delivered at the first attempt. The problem
18407 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
18408 but of what happens when the redirection list changes during the time that the
18409 message is on Exim's queue. This is particularly true in the case of mailing
18410 lists, where new subscribers might receive copies of messages that were posted
18411 before they subscribed.
18412
18413 If &%one_time%& is set and any addresses generated by the router fail to
18414 deliver at the first attempt, the failing addresses are added to the message as
18415 &"top level"& addresses, and the parent address that generated them is marked
18416 &"delivered"&. Thus, redirection does not happen again at the next delivery
18417 attempt.
18418
18419 &*Warning 1*&: Any header line addition or removal that is specified by this
18420 router would be lost if delivery did not succeed at the first attempt. For this
18421 reason, the &%headers_add%& and &%headers_remove%& generic options are not
18422 permitted when &%one_time%& is set.
18423
18424 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
18425 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
18426 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
18427
18428 &*Warning 3*&: The &%unseen%& generic router option may not be set with
18429 &%one_time%&.
18430
18431 The original top-level address is remembered with each of the generated
18432 addresses, and is output in any log messages. However, any intermediate parent
18433 addresses are not recorded. This makes a difference to the log only if
18434 &%all_parents%& log selector is set. It is expected that &%one_time%& will
18435 typically be used for mailing lists, where there is normally just one level of
18436 expansion.
18437
18438
18439 .option owners redirect "string list" unset
18440 .cindex "ownership" "alias file"
18441 .cindex "ownership" "forward file"
18442 .cindex "alias file" "ownership"
18443 .cindex "forward file" "ownership"
18444 This specifies a list of permitted owners for the file specified by &%file%&.
18445 This list is in addition to the local user when &%check_local_user%& is set.
18446 See &%check_owner%& above.
18447
18448
18449 .option owngroups redirect "string list" unset
18450 This specifies a list of permitted groups for the file specified by &%file%&.
18451 The list is in addition to the local user's primary group when
18452 &%check_local_user%& is set. See &%check_group%& above.
18453
18454
18455 .option pipe_transport redirect string&!! unset
18456 .vindex "&$address_pipe$&"
18457 A &(redirect)& router sets up a direct delivery to a pipe when a string
18458 starting with a vertical bar character is specified as a new &"address"&. The
18459 transport used is specified by this option, which, after expansion, must be the
18460 name of a configured transport. This should normally be a &(pipe)& transport.
18461 When the transport is run, the pipe command is in &$address_pipe$&.
18462
18463
18464 .option qualify_domain redirect string&!! unset
18465 .vindex "&$qualify_recipient$&"
18466 If this option is set, and an unqualified address (one without a domain) is
18467 generated, and that address would normally be qualified by the global setting
18468 in &%qualify_recipient%&, it is instead qualified with the domain specified by
18469 expanding this string. If the expansion fails, the router declines. If you want
18470 to revert to the default, you can have the expansion generate
18471 &$qualify_recipient$&.
18472
18473 This option applies to all unqualified addresses generated by Exim filters,
18474 but for traditional &_.forward_& files, it applies only to addresses that are
18475 not preceded by a backslash. Sieve filters cannot generate unqualified
18476 addresses.
18477
18478 .option qualify_preserve_domain redirect boolean false
18479 .cindex "domain" "in redirection; preserving"
18480 .cindex "preserving domain in redirection"
18481 .cindex "address redirection" "domain; preserving"
18482 If this option is set, the router's local &%qualify_domain%& option must not be
18483 set (a configuration error occurs if it is). If an unqualified address (one
18484 without a domain) is generated, it is qualified with the domain of the parent
18485 address (the immediately preceding ancestor) instead of the global
18486 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
18487 this applies whether or not the address is preceded by a backslash.
18488
18489
18490 .option repeat_use redirect boolean true
18491 If this option is set false, the router is skipped for a child address that has
18492 any ancestor that was routed by this router. This test happens before any of
18493 the other preconditions are tested. Exim's default anti-looping rules skip
18494 only when the ancestor is the same as the current address. See also
18495 &%check_ancestor%& above and the generic &%redirect_router%& option.
18496
18497
18498 .option reply_transport redirect string&!! unset
18499 A &(redirect)& router sets up an automatic reply when a &%mail%& or
18500 &%vacation%& command is used in a filter file. The transport used is specified
18501 by this option, which, after expansion, must be the name of a configured
18502 transport. This should normally be an &(autoreply)& transport. Other transports
18503 are unlikely to do anything sensible or useful.
18504
18505
18506 .option rewrite redirect boolean true
18507 .cindex "address redirection" "disabling rewriting"
18508 If this option is set false, addresses generated by the router are not
18509 subject to address rewriting. Otherwise, they are treated like new addresses
18510 and are rewritten according to the global rewriting rules.
18511
18512
18513 .option sieve_subaddress redirect string&!! unset
18514 The value of this option is passed to a Sieve filter to specify the
18515 :subaddress part of an address.
18516
18517 .option sieve_useraddress redirect string&!! unset
18518 The value of this option is passed to a Sieve filter to specify the :user part
18519 of an address. However, if it is unset, the entire original local part
18520 (including any prefix or suffix) is used for :user.
18521
18522
18523 .option sieve_vacation_directory redirect string&!! unset
18524 .cindex "Sieve filter" "vacation directory"
18525 To enable the &"vacation"& extension for Sieve filters, you must set
18526 &%sieve_vacation_directory%& to the directory where vacation databases are held
18527 (do not put anything else in that directory), and ensure that the
18528 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
18529 needs their own directory; Exim will create it if necessary.
18530
18531
18532
18533 .option skip_syntax_errors redirect boolean false
18534 .cindex "forward file" "broken"
18535 .cindex "address redirection" "broken files"
18536 .cindex "alias file" "broken"
18537 .cindex "broken alias or forward files"
18538 .cindex "ignoring faulty addresses"
18539 .cindex "skipping faulty addresses"
18540 .cindex "error" "skipping bad syntax"
18541 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
18542 non-filter redirection data are skipped, and each failing address is logged. If
18543 &%syntax_errors_to%& is set, a message is sent to the address it defines,
18544 giving details of the failures. If &%syntax_errors_text%& is set, its contents
18545 are expanded and placed at the head of the error message generated by
18546 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
18547 be the same address as the generic &%errors_to%& option. The
18548 &%skip_syntax_errors%& option is often used when handling mailing lists.
18549
18550 If all the addresses in a redirection list are skipped because of syntax
18551 errors, the router declines to handle the original address, and it is passed to
18552 the following routers.
18553
18554 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
18555 error in the filter causes filtering to be abandoned without any action being
18556 taken. The incident is logged, and the router declines to handle the address,
18557 so it is passed to the following routers.
18558
18559 .cindex "Sieve filter" "syntax errors in"
18560 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
18561 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
18562 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
18563
18564 &%skip_syntax_errors%& can be used to specify that errors in users' forward
18565 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
18566 option, used with an address that does not get redirected, can be used to
18567 notify users of these errors, by means of a router like this:
18568 .code
18569 userforward:
18570   driver = redirect
18571   allow_filter
18572   check_local_user
18573   file = $home/.forward
18574   file_transport = address_file
18575   pipe_transport = address_pipe
18576   reply_transport = address_reply
18577   no_verify
18578   skip_syntax_errors
18579   syntax_errors_to = real-$local_part@$domain
18580   syntax_errors_text = \
18581    This is an automatically generated message. An error has\n\
18582    been found in your .forward file. Details of the error are\n\
18583    reported below. While this error persists, you will receive\n\
18584    a copy of this message for every message that is addressed\n\
18585    to you. If your .forward file is a filter file, or if it is\n\
18586    a non-filter file containing no valid forwarding addresses,\n\
18587    a copy of each incoming message will be put in your normal\n\
18588    mailbox. If a non-filter file contains at least one valid\n\
18589    forwarding address, forwarding to the valid addresses will\n\
18590    happen, and those will be the only deliveries that occur.
18591 .endd
18592 You also need a router to ensure that local addresses that are prefixed by
18593 &`real-`& are recognized, but not forwarded or filtered. For example, you could
18594 put this immediately before the &(userforward)& router:
18595 .code
18596 real_localuser:
18597   driver = accept
18598   check_local_user
18599   local_part_prefix = real-
18600   transport = local_delivery
18601 .endd
18602 For security, it would probably be a good idea to restrict the use of this
18603 router to locally-generated messages, using a condition such as this:
18604 .code
18605   condition = ${if match {$sender_host_address}\
18606                          {\N^(|127\.0\.0\.1)$\N}}
18607 .endd
18608
18609
18610 .option syntax_errors_text redirect string&!! unset
18611 See &%skip_syntax_errors%& above.
18612
18613
18614 .option syntax_errors_to redirect string unset
18615 See &%skip_syntax_errors%& above.
18616 .ecindex IIDredrou1
18617 .ecindex IIDredrou2
18618
18619
18620
18621
18622
18623
18624 . ////////////////////////////////////////////////////////////////////////////
18625 . ////////////////////////////////////////////////////////////////////////////
18626
18627 .chapter "Environment for running local transports" "CHAPenvironment" &&&
18628          "Environment for local transports"
18629 .scindex IIDenvlotra1 "local transports" "environment for"
18630 .scindex IIDenvlotra2 "environment for local transports"
18631 .scindex IIDenvlotra3 "transport" "local; environment for"
18632 Local transports handle deliveries to files and pipes. (The &(autoreply)&
18633 transport can be thought of as similar to a pipe.) Exim always runs transports
18634 in subprocesses, under specified uids and gids. Typical deliveries to local
18635 mailboxes run under the uid and gid of the local user.
18636
18637 Exim also sets a specific current directory while running the transport; for
18638 some transports a home directory setting is also relevant. The &(pipe)&
18639 transport is the only one that sets up environment variables; see section
18640 &<<SECTpipeenv>>& for details.
18641
18642 The values used for the uid, gid, and the directories may come from several
18643 different places. In many cases, the router that handles the address associates
18644 settings with that address as a result of its &%check_local_user%&, &%group%&,
18645 or &%user%& options. However, values may also be given in the transport's own
18646 configuration, and these override anything that comes from the router.
18647
18648
18649
18650 .section "Concurrent deliveries" "SECID131"
18651 .cindex "concurrent deliveries"
18652 .cindex "simultaneous deliveries"
18653 If two different messages for the same local recipient arrive more or less
18654 simultaneously, the two delivery processes are likely to run concurrently. When
18655 the &(appendfile)& transport is used to write to a file, Exim applies locking
18656 rules to stop concurrent processes from writing to the same file at the same
18657 time.
18658
18659 However, when you use a &(pipe)& transport, it is up to you to arrange any
18660 locking that is needed. Here is a silly example:
18661 .code
18662 my_transport:
18663   driver = pipe
18664   command = /bin/sh -c 'cat >>/some/file'
18665 .endd
18666 This is supposed to write the message at the end of the file. However, if two
18667 messages arrive at the same time, the file will be scrambled. You can use the
18668 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
18669 file using the same algorithm that Exim itself uses.
18670
18671
18672
18673
18674 .section "Uids and gids" "SECTenvuidgid"
18675 .cindex "local transports" "uid and gid"
18676 .cindex "transport" "local; uid and gid"
18677 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
18678 overrides any group that the router set in the address, even if &%user%& is not
18679 set for the transport. This makes it possible, for example, to run local mail
18680 delivery under the uid of the recipient (set by the router), but in a special
18681 group (set by the transport). For example:
18682 .code
18683 # Routers ...
18684 # User/group are set by check_local_user in this router
18685 local_users:
18686   driver = accept
18687   check_local_user
18688   transport = group_delivery
18689
18690 # Transports ...
18691 # This transport overrides the group
18692 group_delivery:
18693   driver = appendfile
18694   file = /var/spool/mail/$local_part
18695   group = mail
18696 .endd
18697 If &%user%& is set for a transport, its value overrides what is set in the
18698 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
18699 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
18700 set.
18701
18702 .oindex "&%initgroups%&"
18703 When the uid is taken from the transport's configuration, the &[initgroups()]&
18704 function is called for the groups associated with that uid if the
18705 &%initgroups%& option is set for the transport. When the uid is not specified
18706 by the transport, but is associated with the address by a router, the option
18707 for calling &[initgroups()]& is taken from the router configuration.
18708
18709 .cindex "&(pipe)& transport" "uid for"
18710 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
18711 is set and &%user%& is not set, the uid of the process that called Exim to
18712 receive the message is used, and if &%group%& is not set, the corresponding
18713 original gid is also used.
18714
18715 This is the detailed preference order for obtaining a gid; the first of the
18716 following that is set is used:
18717
18718 .ilist
18719 A &%group%& setting of the transport;
18720 .next
18721 A &%group%& setting of the router;
18722 .next
18723 A gid associated with a user setting of the router, either as a result of
18724 &%check_local_user%& or an explicit non-numeric &%user%& setting;
18725 .next
18726 The group associated with a non-numeric &%user%& setting of the transport;
18727 .next
18728 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
18729 the uid is the creator's uid;
18730 .next
18731 The Exim gid if the Exim uid is being used as a default.
18732 .endlist
18733
18734 If, for example, the user is specified numerically on the router and there are
18735 no group settings, no gid is available. In this situation, an error occurs.
18736 This is different for the uid, for which there always is an ultimate default.
18737 The first of the following that is set is used:
18738
18739 .ilist
18740 A &%user%& setting of the transport;
18741 .next
18742 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
18743 .next
18744 A &%user%& setting of the router;
18745 .next
18746 A &%check_local_user%& setting of the router;
18747 .next
18748 The Exim uid.
18749 .endlist
18750
18751 Of course, an error will still occur if the uid that is chosen is on the
18752 &%never_users%& list.
18753
18754
18755
18756
18757
18758 .section "Current and home directories" "SECID132"
18759 .cindex "current directory for local transport"
18760 .cindex "home directory" "for local transport"
18761 .cindex "transport" "local; home directory for"
18762 .cindex "transport" "local; current directory for"
18763 Routers may set current and home directories for local transports by means of
18764 the &%transport_current_directory%& and &%transport_home_directory%& options.
18765 However, if the transport's &%current_directory%& or &%home_directory%& options
18766 are set, they override the router's values. In detail, the home directory
18767 for a local transport is taken from the first of these values that is set:
18768
18769 .ilist
18770 The &%home_directory%& option on the transport;
18771 .next
18772 The &%transport_home_directory%& option on the router;
18773 .next
18774 The password data if &%check_local_user%& is set on the router;
18775 .next
18776 The &%router_home_directory%& option on the router.
18777 .endlist
18778
18779 The current directory is taken from the first of these values that is set:
18780
18781 .ilist
18782 The &%current_directory%& option on the transport;
18783 .next
18784 The &%transport_current_directory%& option on the router.
18785 .endlist
18786
18787
18788 If neither the router nor the transport sets a current directory, Exim uses the
18789 value of the home directory, if it is set. Otherwise it sets the current
18790 directory to &_/_& before running a local transport.
18791
18792
18793
18794 .section "Expansion variables derived from the address" "SECID133"
18795 .vindex "&$domain$&"
18796 .vindex "&$local_part$&"
18797 .vindex "&$original_domain$&"
18798 Normally a local delivery is handling a single address, and in that case the
18799 variables such as &$domain$& and &$local_part$& are set during local
18800 deliveries. However, in some circumstances more than one address may be handled
18801 at once (for example, while writing batch SMTP for onward transmission by some
18802 other means). In this case, the variables associated with the local part are
18803 never set, &$domain$& is set only if all the addresses have the same domain,
18804 and &$original_domain$& is never set.
18805 .ecindex IIDenvlotra1
18806 .ecindex IIDenvlotra2
18807 .ecindex IIDenvlotra3
18808
18809
18810
18811
18812
18813
18814
18815 . ////////////////////////////////////////////////////////////////////////////
18816 . ////////////////////////////////////////////////////////////////////////////
18817
18818 .chapter "Generic options for transports" "CHAPtransportgeneric"
18819 .scindex IIDgenoptra1 "generic options" "transport"
18820 .scindex IIDgenoptra2 "options" "generic; for transports"
18821 .scindex IIDgenoptra3 "transport" "generic options for"
18822 The following generic options apply to all transports:
18823
18824
18825 .option body_only transports boolean false
18826 .cindex "transport" "body only"
18827 .cindex "message" "transporting body only"
18828 .cindex "body of message" "transporting"
18829 If this option is set, the message's headers are not transported. It is
18830 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
18831 or &(pipe)& transports, the settings of &%message_prefix%& and
18832 &%message_suffix%& should be checked, because this option does not
18833 automatically suppress them.
18834
18835
18836 .option current_directory transports string&!! unset
18837 .cindex "transport" "current directory for"
18838 This specifies the current directory that is to be set while running the
18839 transport, overriding any value that may have been set by the router.
18840 If the expansion fails for any reason, including forced failure, an error is
18841 logged, and delivery is deferred.
18842
18843
18844 .option disable_logging transports boolean false
18845 If this option is set true, nothing is logged for any
18846 deliveries by the transport or for any
18847 transport errors. You should not set this option unless you really, really know
18848 what you are doing.
18849
18850
18851 .option debug_print transports string&!! unset
18852 .cindex "testing" "variables in drivers"
18853 If this option is set and debugging is enabled (see the &%-d%& command line
18854 option), the string is expanded and included in the debugging output when the
18855 transport is run.
18856 If expansion of the string fails, the error message is written to the debugging
18857 output, and Exim carries on processing.
18858 This facility is provided to help with checking out the values of variables and
18859 so on when debugging driver configurations. For example, if a &%headers_add%&
18860 option is not working properly, &%debug_print%& could be used to output the
18861 variables it references. A newline is added to the text if it does not end with
18862 one.
18863
18864
18865 .option delivery_date_add transports boolean false
18866 .cindex "&'Delivery-date:'& header line"
18867 If this option is true, a &'Delivery-date:'& header is added to the message.
18868 This gives the actual time the delivery was made. As this is not a standard
18869 header, Exim has a configuration option (&%delivery_date_remove%&) which
18870 requests its removal from incoming messages, so that delivered messages can
18871 safely be resent to other recipients.
18872
18873
18874 .option driver transports string unset
18875 This specifies which of the available transport drivers is to be used.
18876 There is no default, and this option must be set for every transport.
18877
18878
18879 .option envelope_to_add transports boolean false
18880 .cindex "&'Envelope-to:'& header line"
18881 If this option is true, an &'Envelope-to:'& header is added to the message.
18882 This gives the original address(es) in the incoming envelope that caused this
18883 delivery to happen. More than one address may be present if the transport is
18884 configured to handle several addresses at once, or if more than one original
18885 address was redirected to the same final address. As this is not a standard
18886 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
18887 its removal from incoming messages, so that delivered messages can safely be
18888 resent to other recipients.
18889
18890
18891 .option group transports string&!! "Exim group"
18892 .cindex "transport" "group; specifying"
18893 This option specifies a gid for running the transport process, overriding any
18894 value that the router supplies, and also overriding any value associated with
18895 &%user%& (see below).
18896
18897
18898 .option headers_add transports string&!! unset
18899 .cindex "header lines" "adding in transport"
18900 .cindex "transport" "header lines; adding"
18901 This option specifies a string of text that is expanded and added to the header
18902 portion of a message as it is transported, as described in section
18903 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
18904 routers. If the result of the expansion is an empty string, or if the expansion
18905 is forced to fail, no action is taken. Other expansion failures are treated as
18906 errors and cause the delivery to be deferred.
18907
18908
18909
18910 .option headers_only transports boolean false
18911 .cindex "transport" "header lines only"
18912 .cindex "message" "transporting headers only"
18913 .cindex "header lines" "transporting"
18914 If this option is set, the message's body is not transported. It is mutually
18915 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
18916 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
18917 checked, since this option does not automatically suppress them.
18918
18919
18920 .option headers_remove transports string&!! unset
18921 .cindex "header lines" "removing"
18922 .cindex "transport" "header lines; removing"
18923 This option specifies a string that is expanded into a list of header names;
18924 these headers are omitted from the message as it is transported, as described
18925 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
18926 routers. If the result of the expansion is an empty string, or if the expansion
18927 is forced to fail, no action is taken. Other expansion failures are treated as
18928 errors and cause the delivery to be deferred.
18929
18930
18931
18932 .option headers_rewrite transports string unset
18933 .cindex "transport" "header lines; rewriting"
18934 .cindex "rewriting" "at transport time"
18935 This option allows addresses in header lines to be rewritten at transport time,
18936 that is, as the message is being copied to its destination. The contents of the
18937 option are a colon-separated list of rewriting rules. Each rule is in exactly
18938 the same form as one of the general rewriting rules that are applied when a
18939 message is received. These are described in chapter &<<CHAPrewrite>>&. For
18940 example,
18941 .code
18942 headers_rewrite = a@b c@d f : \
18943                   x@y w@z
18944 .endd
18945 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
18946 &'w@z'& in all address-bearing header lines. The rules are applied to the
18947 header lines just before they are written out at transport time, so they affect
18948 only those copies of the message that pass through the transport. However, only
18949 the message's original header lines, and any that were added by a system
18950 filter, are rewritten. If a router or transport adds header lines, they are not
18951 affected by this option. These rewriting rules are &'not'& applied to the
18952 envelope. You can change the return path using &%return_path%&, but you cannot
18953 change envelope recipients at this time.
18954
18955
18956 .option home_directory transports string&!! unset
18957 .cindex "transport" "home directory for"
18958 .vindex "&$home$&"
18959 This option specifies a home directory setting for a local transport,
18960 overriding any value that may be set by the router. The home directory is
18961 placed in &$home$& while expanding the transport's private options. It is also
18962 used as the current directory if no current directory is set by the
18963 &%current_directory%& option on the transport or the
18964 &%transport_current_directory%& option on the router. If the expansion fails
18965 for any reason, including forced failure, an error is logged, and delivery is
18966 deferred.
18967
18968
18969 .option initgroups transports boolean false
18970 .cindex "additional groups"
18971 .cindex "groups" "additional"
18972 .cindex "transport" "group; additional"
18973 If this option is true and the uid for the delivery process is provided by the
18974 transport, the &[initgroups()]& function is called when running the transport
18975 to ensure that any additional groups associated with the uid are set up.
18976
18977
18978 .option message_size_limit transports string&!! 0
18979 .cindex "limit" "message size per transport"
18980 .cindex "size" "of message, limit"
18981 .cindex "transport" "message size; limiting"
18982 This option controls the size of messages passed through the transport. It is
18983 expanded before use; the result of the expansion must be a sequence of decimal
18984 digits, optionally followed by K or M. If the expansion fails for any reason,
18985 including forced failure, or if the result is not of the required form,
18986 delivery is deferred. If the value is greater than zero and the size of a
18987 message exceeds this limit, the address is failed. If there is any chance that
18988 the resulting bounce message could be routed to the same transport, you should
18989 ensure that &%return_size_limit%& is less than the transport's
18990 &%message_size_limit%&, as otherwise the bounce message will fail to get
18991 delivered.
18992
18993
18994
18995 .option rcpt_include_affixes transports boolean false
18996 .cindex "prefix" "for local part, including in envelope"
18997 .cindex "suffix for local part" "including in envelope"
18998 .cindex "local part" "prefix"
18999 .cindex "local part" "suffix"
19000 When this option is false (the default), and an address that has had any
19001 affixes (prefixes or suffixes) removed from the local part is delivered by any
19002 form of SMTP or LMTP, the affixes are not included. For example, if a router
19003 that contains
19004 .code
19005 local_part_prefix = *-
19006 .endd
19007 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
19008 is delivered with
19009 .code
19010 RCPT TO:<xyz@some.domain>
19011 .endd
19012 This is also the case when an ACL-time callout is being used to verify a
19013 recipient address. However, if &%rcpt_include_affixes%& is set true, the
19014 whole local part is included in the RCPT command. This option applies to BSMTP
19015 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
19016 &(lmtp)& and &(smtp)& transports.
19017
19018
19019 .option retry_use_local_part transports boolean "see below"
19020 .cindex "hints database" "retry keys"
19021 When a delivery suffers a temporary failure, a retry record is created
19022 in Exim's hints database. For remote deliveries, the key for the retry record
19023 is based on the name and/or IP address of the failing remote host. For local
19024 deliveries, the key is normally the entire address, including both the local
19025 part and the domain. This is suitable for most common cases of local delivery
19026 temporary failure &-- for example, exceeding a mailbox quota should delay only
19027 deliveries to that mailbox, not to the whole domain.
19028
19029 However, in some special cases you may want to treat a temporary local delivery
19030 as a failure associated with the domain, and not with a particular local part.
19031 (For example, if you are storing all mail for some domain in files.) You can do
19032 this by setting &%retry_use_local_part%& false.
19033
19034 For all the local transports, its default value is true. For remote transports,
19035 the default value is false for tidiness, but changing the value has no effect
19036 on a remote transport in the current implementation.
19037
19038
19039 .option return_path transports string&!! unset
19040 .cindex "envelope sender"
19041 .cindex "transport" "return path; changing"
19042 .cindex "return path" "changing in transport"
19043 If this option is set, the string is expanded at transport time and replaces
19044 the existing return path (envelope sender) value in the copy of the message
19045 that is being delivered. An empty return path is permitted. This feature is
19046 designed for remote deliveries, where the value of this option is used in the
19047 SMTP MAIL command. If you set &%return_path%& for a local transport, the
19048 only effect is to change the address that is placed in the &'Return-path:'&
19049 header line, if one is added to the message (see the next option).
19050
19051 &*Note:*& A changed return path is not logged unless you add
19052 &%return_path_on_delivery%& to the log selector.
19053
19054 .vindex "&$return_path$&"
19055 The expansion can refer to the existing value via &$return_path$&. This is
19056 either the message's envelope sender, or an address set by the
19057 &%errors_to%& option on a router. If the expansion is forced to fail, no
19058 replacement occurs; if it fails for another reason, delivery is deferred. This
19059 option can be used to support VERP (Variable Envelope Return Paths) &-- see
19060 section &<<SECTverp>>&.
19061
19062 &*Note*&: If a delivery error is detected locally, including the case when a
19063 remote server rejects a message at SMTP time, the bounce message is not sent to
19064 the value of this option. It is sent to the previously set errors address.
19065 This defaults to the incoming sender address, but can be changed by setting
19066 &%errors_to%& in a router.
19067
19068
19069
19070 .option return_path_add transports boolean false
19071 .cindex "&'Return-path:'& header line"
19072 If this option is true, a &'Return-path:'& header is added to the message.
19073 Although the return path is normally available in the prefix line of BSD
19074 mailboxes, this is commonly not displayed by MUAs, and so the user does not
19075 have easy access to it.
19076
19077 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
19078 the delivery SMTP server makes the final delivery"&. This implies that this
19079 header should not be present in incoming messages. Exim has a configuration
19080 option, &%return_path_remove%&, which requests removal of this header from
19081 incoming messages, so that delivered messages can safely be resent to other
19082 recipients.
19083
19084
19085 .option shadow_condition transports string&!! unset
19086 See &%shadow_transport%& below.
19087
19088
19089 .option shadow_transport transports string unset
19090 .cindex "shadow transport"
19091 .cindex "transport" "shadow"
19092 A local transport may set the &%shadow_transport%& option to the name of
19093 another local transport. Shadow remote transports are not supported.
19094
19095 Whenever a delivery to the main transport succeeds, and either
19096 &%shadow_condition%& is unset, or its expansion does not result in the empty
19097 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
19098 passed to the shadow transport, with the same delivery address or addresses. If
19099 expansion fails, no action is taken except that non-forced expansion failures
19100 cause a log line to be written.
19101
19102 The result of the shadow transport is discarded and does not affect the
19103 subsequent processing of the message. Only a single level of shadowing is
19104 provided; the &%shadow_transport%& option is ignored on any transport when it
19105 is running as a shadow. Options concerned with output from pipes are also
19106 ignored. The log line for the successful delivery has an item added on the end,
19107 of the form
19108 .code
19109 ST=<shadow transport name>
19110 .endd
19111 If the shadow transport did not succeed, the error message is put in
19112 parentheses afterwards. Shadow transports can be used for a number of different
19113 purposes, including keeping more detailed log information than Exim normally
19114 provides, and implementing automatic acknowledgment policies based on message
19115 headers that some sites insist on.
19116
19117
19118 .option transport_filter transports string&!! unset
19119 .cindex "transport" "filter"
19120 .cindex "filter" "transport filter"
19121 This option sets up a filtering (in the Unix shell sense) process for messages
19122 at transport time. It should not be confused with mail filtering as set up by
19123 individual users or via a system filter.
19124
19125 When the message is about to be written out, the command specified by
19126 &%transport_filter%& is started up in a separate, parallel process, and
19127 the entire message, including the header lines, is passed to it on its standard
19128 input (this in fact is done from a third process, to avoid deadlock). The
19129 command must be specified as an absolute path.
19130
19131 The lines of the message that are written to the transport filter are
19132 terminated by newline (&"\n"&). The message is passed to the filter before any
19133 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
19134 lines beginning with a dot, and also before any processing implied by the
19135 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
19136 &(pipe)& transports.
19137
19138 The standard error for the filter process is set to the same destination as its
19139 standard output; this is read and written to the message's ultimate
19140 destination. The process that writes the message to the filter, the
19141 filter itself, and the original process that reads the result and delivers it
19142 are all run in parallel, like a shell pipeline.
19143
19144 The filter can perform any transformations it likes, but of course should take
19145 care not to break RFC 2822 syntax. Exim does not check the result, except to
19146 test for a final newline when SMTP is in use. All messages transmitted over
19147 SMTP must end with a newline, so Exim supplies one if it is missing.
19148
19149 .cindex "content scanning" "per user"
19150 A transport filter can be used to provide content-scanning on a per-user basis
19151 at delivery time if the only required effect of the scan is to modify the
19152 message. For example, a content scan could insert a new header line containing
19153 a spam score. This could be interpreted by a filter in the user's MUA. It is
19154 not possible to discard a message at this stage.
19155
19156 .cindex "SMTP" "SIZE"
19157 A problem might arise if the filter increases the size of a message that is
19158 being sent down an SMTP connection. If the receiving SMTP server has indicated
19159 support for the SIZE parameter, Exim will have sent the size of the message
19160 at the start of the SMTP session. If what is actually sent is substantially
19161 more, the server might reject the message. This can be worked round by setting
19162 the &%size_addition%& option on the &(smtp)& transport, either to allow for
19163 additions to the message, or to disable the use of SIZE altogether.
19164
19165 .vindex "&$pipe_addresses$&"
19166 The value of the &%transport_filter%& option is the command string for starting
19167 the filter, which is run directly from Exim, not under a shell. The string is
19168 parsed by Exim in the same way as a command string for the &(pipe)& transport:
19169 Exim breaks it up into arguments and then expands each argument separately (see
19170 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
19171 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
19172 of arguments, one for each address that applies to this delivery. (This isn't
19173 an ideal name for this feature here, but as it was already implemented for the
19174 &(pipe)& transport, it seemed sensible not to change it.)
19175
19176 .vindex "&$host$&"
19177 .vindex "&$host_address$&"
19178 The expansion variables &$host$& and &$host_address$& are available when the
19179 transport is a remote one. They contain the name and IP address of the host to
19180 which the message is being sent. For example:
19181 .code
19182 transport_filter = /some/directory/transport-filter.pl \
19183   $host $host_address $sender_address $pipe_addresses
19184 .endd
19185
19186 Two problems arise if you want to use more complicated expansion items to
19187 generate transport filter commands, both of which due to the fact that the
19188 command is split up &'before'& expansion.
19189 .ilist
19190 If an expansion item contains white space, you must quote it, so that it is all
19191 part of the same command item. If the entire option setting is one such
19192 expansion item, you have to take care what kind of quoting you use. For
19193 example:
19194 .code
19195 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
19196 .endd
19197 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
19198 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
19199 stripped by Exim when it read the option's value. When the value is used, if
19200 the single quotes were missing, the line would be split into two items,
19201 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
19202 Exim tried to expand the first one.
19203 .next
19204 Except for the special case of &$pipe_addresses$& that is mentioned above, an
19205 expansion cannot generate multiple arguments, or a command name followed by
19206 arguments. Consider this example:
19207 .code
19208 transport_filter = ${lookup{$host}lsearch{/a/file}\
19209                     {$value}{/bin/cat}}
19210 .endd
19211 The result of the lookup is interpreted as the name of the command, even
19212 if it contains white space. The simplest way round this is to use a shell:
19213 .code
19214 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
19215                                {$value}{/bin/cat}}
19216 .endd
19217 .endlist
19218
19219 The filter process is run under the same uid and gid as the normal delivery.
19220 For remote deliveries this is the Exim uid/gid by default. The command should
19221 normally yield a zero return code. Transport filters are not supposed to fail.
19222 A non-zero code is taken to mean that the transport filter encountered some
19223 serious problem. Delivery of the message is deferred; the message remains on
19224 the queue and is tried again later. It is not possible to cause a message to be
19225 bounced from a transport filter.
19226
19227 If a transport filter is set on an autoreply transport, the original message is
19228 passed through the filter as it is being copied into the newly generated
19229 message, which happens if the &%return_message%& option is set.
19230
19231
19232 .option transport_filter_timeout transports time 5m
19233 .cindex "transport" "filter, timeout"
19234 When Exim is reading the output of a transport filter, it a applies a timeout
19235 that can be set by this option. Exceeding the timeout is normally treated as a
19236 temporary delivery failure. However, if a transport filter is used with a
19237 &(pipe)& transport, a timeout in the transport filter is treated in the same
19238 way as a timeout in the pipe command itself. By default, a timeout is a hard
19239 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
19240 becomes a temporary error.
19241
19242
19243 .option user transports string&!! "Exim user"
19244 .cindex "uid (user id)" "local delivery"
19245 .cindex "transport" "user, specifying"
19246 This option specifies the user under whose uid the delivery process is to be
19247 run, overriding any uid that may have been set by the router. If the user is
19248 given as a name, the uid is looked up from the password data, and the
19249 associated group is taken as the value of the gid to be used if the &%group%&
19250 option is not set.
19251
19252 For deliveries that use local transports, a user and group are normally
19253 specified explicitly or implicitly (for example, as a result of
19254 &%check_local_user%&) by the router or transport.
19255
19256 .cindex "hints database" "access by remote transport"
19257 For remote transports, you should leave this option unset unless you really are
19258 sure you know what you are doing. When a remote transport is running, it needs
19259 to be able to access Exim's hints databases, because each host may have its own
19260 retry data.
19261 .ecindex IIDgenoptra1
19262 .ecindex IIDgenoptra2
19263 .ecindex IIDgenoptra3
19264
19265
19266
19267
19268
19269
19270 . ////////////////////////////////////////////////////////////////////////////
19271 . ////////////////////////////////////////////////////////////////////////////
19272
19273 .chapter "Address batching in local transports" "CHAPbatching" &&&
19274          "Address batching"
19275 .cindex "transport" "local; address batching in"
19276 The only remote transport (&(smtp)&) is normally configured to handle more than
19277 one address at a time, so that when several addresses are routed to the same
19278 remote host, just one copy of the message is sent. Local transports, however,
19279 normally handle one address at a time. That is, a separate instance of the
19280 transport is run for each address that is routed to the transport. A separate
19281 copy of the message is delivered each time.
19282
19283 .cindex "batched local delivery"
19284 .oindex "&%batch_max%&"
19285 .oindex "&%batch_id%&"
19286 In special cases, it may be desirable to handle several addresses at once in a
19287 local transport, for example:
19288
19289 .ilist
19290 In an &(appendfile)& transport, when storing messages in files for later
19291 delivery by some other means, a single copy of the message with multiple
19292 recipients saves space.
19293 .next
19294 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
19295 a single copy saves time, and is the normal way LMTP is expected to work.
19296 .next
19297 In a &(pipe)& transport, when passing the message
19298 to a scanner program or
19299 to some other delivery mechanism such as UUCP, multiple recipients may be
19300 acceptable.
19301 .endlist
19302
19303 These three local transports all have the same options for controlling multiple
19304 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
19305 repeating the information for each transport, these options are described here.
19306
19307 The &%batch_max%& option specifies the maximum number of addresses that can be
19308 delivered together in a single run of the transport. Its default value is one
19309 (no batching). When more than one address is routed to a transport that has a
19310 &%batch_max%& value greater than one, the addresses are delivered in a batch
19311 (that is, in a single run of the transport with multiple recipients), subject
19312 to certain conditions:
19313
19314 .ilist
19315 .vindex "&$local_part$&"
19316 If any of the transport's options contain a reference to &$local_part$&, no
19317 batching is possible.
19318 .next
19319 .vindex "&$domain$&"
19320 If any of the transport's options contain a reference to &$domain$&, only
19321 addresses with the same domain are batched.
19322 .next
19323 .cindex "customizing" "batching condition"
19324 If &%batch_id%& is set, it is expanded for each address, and only those
19325 addresses with the same expanded value are batched. This allows you to specify
19326 customized batching conditions. Failure of the expansion for any reason,
19327 including forced failure, disables batching, but it does not stop the delivery
19328 from taking place.
19329 .next
19330 Batched addresses must also have the same errors address (where to send
19331 delivery errors), the same header additions and removals, the same user and
19332 group for the transport, and if a host list is present, the first host must
19333 be the same.
19334 .endlist
19335
19336 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
19337 both when the file or pipe command is specified in the transport, and when it
19338 is specified by a &(redirect)& router, but all the batched addresses must of
19339 course be routed to the same file or pipe command. These two transports have an
19340 option called &%use_bsmtp%&, which causes them to deliver the message in
19341 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
19342 &%check_string%& and &%escape_string%& options are forced to the values
19343 .code
19344 check_string = "."
19345 escape_string = ".."
19346 .endd
19347 when batched SMTP is in use. A full description of the batch SMTP mechanism is
19348 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
19349 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
19350
19351 .cindex "&'Envelope-to:'& header line"
19352 If the generic &%envelope_to_add%& option is set for a batching transport, the
19353 &'Envelope-to:'& header that is added to the message contains all the addresses
19354 that are being processed together. If you are using a batching &(appendfile)&
19355 transport without &%use_bsmtp%&, the only way to preserve the recipient
19356 addresses is to set the &%envelope_to_add%& option.
19357
19358 .cindex "&(pipe)& transport" "with multiple addresses"
19359 .vindex "&$pipe_addresses$&"
19360 If you are using a &(pipe)& transport without BSMTP, and setting the
19361 transport's &%command%& option, you can include &$pipe_addresses$& as part of
19362 the command. This is not a true variable; it is a bit of magic that causes each
19363 of the recipient addresses to be inserted into the command as a separate
19364 argument. This provides a way of accessing all the addresses that are being
19365 delivered in the batch. &*Note:*& This is not possible for pipe commands that
19366 are specified by a &(redirect)& router.
19367
19368
19369
19370
19371 . ////////////////////////////////////////////////////////////////////////////
19372 . ////////////////////////////////////////////////////////////////////////////
19373
19374 .chapter "The appendfile transport" "CHAPappendfile"
19375 .scindex IIDapptra1 "&(appendfile)& transport"
19376 .scindex IIDapptra2 "transports" "&(appendfile)&"
19377 .cindex "directory creation"
19378 .cindex "creating directories"
19379 The &(appendfile)& transport delivers a message by appending it to an existing
19380 file, or by creating an entirely new file in a specified directory. Single
19381 files to which messages are appended can be in the traditional Unix mailbox
19382 format, or optionally in the MBX format supported by the Pine MUA and
19383 University of Washington IMAP daemon, &'inter alia'&. When each message is
19384 being delivered as a separate file, &"maildir"& format can optionally be used
19385 to give added protection against failures that happen part-way through the
19386 delivery. A third form of separate-file delivery known as &"mailstore"& is also
19387 supported. For all file formats, Exim attempts to create as many levels of
19388 directory as necessary, provided that &%create_directory%& is set.
19389
19390 The code for the optional formats is not included in the Exim binary by
19391 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
19392 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
19393 included.
19394
19395 .cindex "quota" "system"
19396 Exim recognizes system quota errors, and generates an appropriate message. Exim
19397 also supports its own quota control within the transport, for use when the
19398 system facility is unavailable or cannot be used for some reason.
19399
19400 If there is an error while appending to a file (for example, quota exceeded or
19401 partition filled), Exim attempts to reset the file's length and last
19402 modification time back to what they were before. If there is an error while
19403 creating an entirely new file, the new file is removed.
19404
19405 Before appending to a file, a number of security checks are made, and the
19406 file is locked. A detailed description is given below, after the list of
19407 private options.
19408
19409 The &(appendfile)& transport is most commonly used for local deliveries to
19410 users' mailboxes. However, it can also be used as a pseudo-remote transport for
19411 putting messages into files for remote delivery by some means other than Exim.
19412 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
19413 option).
19414
19415
19416
19417 .section "The file and directory options" "SECTfildiropt"
19418 The &%file%& option specifies a single file, to which the message is appended;
19419 the &%directory%& option specifies a directory, in which a new file containing
19420 the message is created. Only one of these two options can be set, and for
19421 normal deliveries to mailboxes, one of them &'must'& be set.
19422
19423 .vindex "&$address_file$&"
19424 .vindex "&$local_part$&"
19425 However, &(appendfile)& is also used for delivering messages to files or
19426 directories whose names (or parts of names) are obtained from alias,
19427 forwarding, or filtering operations (for example, a &%save%& command in a
19428 user's Exim filter). When such a transport is running, &$local_part$& contains
19429 the local part that was aliased or forwarded, and &$address_file$& contains the
19430 name (or partial name) of the file or directory generated by the redirection
19431 operation. There are two cases:
19432
19433 .ilist
19434 If neither &%file%& nor &%directory%& is set, the redirection operation
19435 must specify an absolute path (one that begins with &`/`&). This is the most
19436 common case when users with local accounts use filtering to sort mail into
19437 different folders. See for example, the &(address_file)& transport in the
19438 default configuration. If the path ends with a slash, it is assumed to be the
19439 name of a directory. A delivery to a directory can also be forced by setting
19440 &%maildir_format%& or &%mailstore_format%&.
19441 .next
19442 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
19443 used to determine the file or directory name for the delivery. Normally, the
19444 contents of &$address_file$& are used in some way in the string expansion.
19445 .endlist
19446
19447
19448 .cindex "Sieve filter" "configuring &(appendfile)&"
19449 .cindex "Sieve filter" "relative mailbox path handling"
19450 As an example of the second case, consider an environment where users do not
19451 have home directories. They may be permitted to use Exim filter commands of the
19452 form:
19453 .code
19454 save folder23
19455 .endd
19456 or Sieve filter commands of the form:
19457 .code
19458 require "fileinto";
19459 fileinto "folder23";
19460 .endd
19461 In this situation, the expansion of &%file%& or &%directory%& in the transport
19462 must transform the relative path into an appropriate absolute file name. In the
19463 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
19464 is used as a result of a &"keep"& action in the filter. This example shows one
19465 way of handling this requirement:
19466 .code
19467 file = ${if eq{$address_file}{inbox} \
19468             {/var/mail/$local_part} \
19469             {${if eq{${substr_0_1:$address_file}}{/} \
19470                   {$address_file} \
19471                   {$home/mail/$address_file} \
19472             }} \
19473        }
19474 .endd
19475 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
19476 location, absolute paths are used without change, and other folders are in the
19477 &_mail_& directory within the home directory.
19478
19479 &*Note 1*&: While processing an Exim filter, a relative path such as
19480 &_folder23_& is turned into an absolute path if a home directory is known to
19481 the router. In particular, this is the case if &%check_local_user%& is set. If
19482 you want to prevent this happening at routing time, you can set
19483 &%router_home_directory%& empty. This forces the router to pass the relative
19484 path to the transport.
19485
19486 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
19487 the &%file%& or &%directory%& option is still used if it is set.
19488
19489
19490
19491
19492 .section "Private options for appendfile" "SECID134"
19493 .cindex "options" "&(appendfile)& transport"
19494
19495
19496
19497 .option allow_fifo appendfile boolean false
19498 .cindex "fifo (named pipe)"
19499 .cindex "named pipe (fifo)"
19500 .cindex "pipe" "named (fifo)"
19501 Setting this option permits delivery to named pipes (FIFOs) as well as to
19502 regular files. If no process is reading the named pipe at delivery time, the
19503 delivery is deferred.
19504
19505
19506 .option allow_symlink appendfile boolean false
19507 .cindex "symbolic link" "to mailbox"
19508 .cindex "mailbox" "symbolic link"
19509 By default, &(appendfile)& will not deliver if the path name for the file is
19510 that of a symbolic link. Setting this option relaxes that constraint, but there
19511 are security issues involved in the use of symbolic links. Be sure you know
19512 what you are doing if you set this. Details of exactly what this option affects
19513 are included in the discussion which follows this list of options.
19514
19515
19516 .option batch_id appendfile string&!! unset
19517 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
19518 However, batching is automatically disabled for &(appendfile)& deliveries that
19519 happen as a result of forwarding or aliasing or other redirection directly to a
19520 file.
19521
19522
19523 .option batch_max appendfile integer 1
19524 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
19525
19526
19527 .option check_group appendfile boolean false
19528 When this option is set, the group owner of the file defined by the &%file%&
19529 option is checked to see that it is the same as the group under which the
19530 delivery process is running. The default setting is false because the default
19531 file mode is 0600, which means that the group is irrelevant.
19532
19533
19534 .option check_owner appendfile boolean true
19535 When this option is set, the owner of the file defined by the &%file%& option
19536 is checked to ensure that it is the same as the user under which the delivery
19537 process is running.
19538
19539
19540 .option check_string appendfile string "see below"
19541 .cindex "&""From""& line"
19542 As &(appendfile)& writes the message, the start of each line is tested for
19543 matching &%check_string%&, and if it does, the initial matching characters are
19544 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
19545 a literal string, not a regular expression, and the case of any letters it
19546 contains is significant.
19547
19548 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
19549 are forced to &"."& and &".."& respectively, and any settings in the
19550 configuration are ignored. Otherwise, they default to &"From&~"& and
19551 &">From&~"& when the &%file%& option is set, and unset when any of the
19552 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
19553
19554 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
19555 suitable for traditional &"BSD"& mailboxes, where a line beginning with
19556 &"From&~"& indicates the start of a new message. All four options need changing
19557 if another format is used. For example, to deliver to mailboxes in MMDF format:
19558 .cindex "MMDF format mailbox"
19559 .cindex "mailbox" "MMDF format"
19560 .code
19561 check_string = "\1\1\1\1\n"
19562 escape_string = "\1\1\1\1 \n"
19563 message_prefix = "\1\1\1\1\n"
19564 message_suffix = "\1\1\1\1\n"
19565 .endd
19566 .option create_directory appendfile boolean true
19567 .cindex "directory creation"
19568 When this option is true, Exim attempts to create any missing superior
19569 directories for the file that it is about to write. A created directory's mode
19570 is given by the &%directory_mode%& option.
19571
19572 The group ownership of a newly created directory is highly dependent on the
19573 operating system (and possibly the file system) that is being used. For
19574 example, in Solaris, if the parent directory has the setgid bit set, its group
19575 is propagated to the child; if not, the currently set group is used. However,
19576 in FreeBSD, the parent's group is always used.
19577
19578
19579
19580 .option create_file appendfile string anywhere
19581 This option constrains the location of files and directories that are created
19582 by this transport. It applies to files defined by the &%file%& option and
19583 directories defined by the &%directory%& option. In the case of maildir
19584 delivery, it applies to the top level directory, not the maildir directories
19585 beneath.
19586
19587 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
19588 &"belowhome"&. In the second and third cases, a home directory must have been
19589 set for the transport. This option is not useful when an explicit file name is
19590 given for normal mailbox deliveries. It is intended for the case when file
19591 names are generated from users' &_.forward_& files. These are usually handled
19592 by an &(appendfile)& transport called &%address_file%&. See also
19593 &%file_must_exist%&.
19594
19595
19596 .option directory appendfile string&!! unset
19597 This option is mutually exclusive with the &%file%& option, but one of &%file%&
19598 or &%directory%& must be set, unless the delivery is the direct result of a
19599 redirection (see section &<<SECTfildiropt>>&).
19600
19601 When &%directory%& is set, the string is expanded, and the message is delivered
19602 into a new file or files in or below the given directory, instead of being
19603 appended to a single mailbox file. A number of different formats are provided
19604 (see &%maildir_format%& and &%mailstore_format%&), and see section
19605 &<<SECTopdir>>& for further details of this form of delivery.
19606
19607
19608 .option directory_file appendfile string&!! "see below"
19609 .cindex "base62"
19610 .vindex "&$inode$&"
19611 When &%directory%& is set, but neither &%maildir_format%& nor
19612 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
19613 whose name is obtained by expanding this string. The default value is:
19614 .code
19615 q${base62:$tod_epoch}-$inode
19616 .endd
19617 This generates a unique name from the current time, in base 62 form, and the
19618 inode of the file. The variable &$inode$& is available only when expanding this
19619 option.
19620
19621
19622 .option directory_mode appendfile "octal integer" 0700
19623 If &(appendfile)& creates any directories as a result of the
19624 &%create_directory%& option, their mode is specified by this option.
19625
19626
19627 .option escape_string appendfile string "see description"
19628 See &%check_string%& above.
19629
19630
19631 .option file appendfile string&!! unset
19632 This option is mutually exclusive with the &%directory%& option, but one of
19633 &%file%& or &%directory%& must be set, unless the delivery is the direct result
19634 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
19635 specifies a single file, to which the message is appended. One or more of
19636 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
19637 &%file%&.
19638
19639 .cindex "NFS" "lock file"
19640 .cindex "locking files"
19641 .cindex "lock files"
19642 If you are using more than one host to deliver over NFS into the same
19643 mailboxes, you should always use lock files.
19644
19645 The string value is expanded for each delivery, and must yield an absolute
19646 path. The most common settings of this option are variations on one of these
19647 examples:
19648 .code
19649 file = /var/spool/mail/$local_part
19650 file = /home/$local_part/inbox
19651 file = $home/inbox
19652 .endd
19653 .cindex "&""sticky""& bit"
19654 In the first example, all deliveries are done into the same directory. If Exim
19655 is configured to use lock files (see &%use_lockfile%& below) it must be able to
19656 create a file in the directory, so the &"sticky"& bit must be turned on for
19657 deliveries to be possible, or alternatively the &%group%& option can be used to
19658 run the delivery under a group id which has write access to the directory.
19659
19660
19661
19662 .option file_format appendfile string unset
19663 .cindex "file" "mailbox; checking existing format"
19664 This option requests the transport to check the format of an existing file
19665 before adding to it. The check consists of matching a specific string at the
19666 start of the file. The value of the option consists of an even number of
19667 colon-separated strings. The first of each pair is the test string, and the
19668 second is the name of a transport. If the transport associated with a matched
19669 string is not the current transport, control is passed over to the other
19670 transport. For example, suppose the standard &(local_delivery)& transport has
19671 this added to it:
19672 .code
19673 file_format = "From       : local_delivery :\
19674                \1\1\1\1\n : local_mmdf_delivery"
19675 .endd
19676 Mailboxes that begin with &"From"& are still handled by this transport, but if
19677 a mailbox begins with four binary ones followed by a newline, control is passed
19678 to a transport called &%local_mmdf_delivery%&, which presumably is configured
19679 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
19680 is assumed to match the current transport. If the start of a mailbox doesn't
19681 match any string, or if the transport named for a given string is not defined,
19682 delivery is deferred.
19683
19684
19685 .option file_must_exist appendfile boolean false
19686 If this option is true, the file specified by the &%file%& option must exist.
19687 A temporary error occurs if it does not, causing delivery to be deferred.
19688 If this option is false, the file is created if it does not exist.
19689
19690
19691 .option lock_fcntl_timeout appendfile time 0s
19692 .cindex "timeout" "mailbox locking"
19693 .cindex "mailbox" "locking, blocking and non-blocking"
19694 .cindex "locking files"
19695 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
19696 when locking an open mailbox file. If the call fails, the delivery process
19697 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
19698 Non-blocking calls are used so that the file is not kept open during the wait
19699 for the lock; the reason for this is to make it as safe as possible for
19700 deliveries over NFS in the case when processes might be accessing an NFS
19701 mailbox without using a lock file. This should not be done, but
19702 misunderstandings and hence misconfigurations are not unknown.
19703
19704 On a busy system, however, the performance of a non-blocking lock approach is
19705 not as good as using a blocking lock with a timeout. In this case, the waiting
19706 is done inside the system call, and Exim's delivery process acquires the lock
19707 and can proceed as soon as the previous lock holder releases it.
19708
19709 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
19710 timeout, are used. There may still be some retrying: the maximum number of
19711 retries is
19712 .code
19713 (lock_retries * lock_interval) / lock_fcntl_timeout
19714 .endd
19715 rounded up to the next whole number. In other words, the total time during
19716 which &(appendfile)& is trying to get a lock is roughly the same, unless
19717 &%lock_fcntl_timeout%& is set very large.
19718
19719 You should consider setting this option if you are getting a lot of delayed
19720 local deliveries because of errors of the form
19721 .code
19722 failed to lock mailbox /some/file (fcntl)
19723 .endd
19724
19725 .option lock_flock_timeout appendfile time 0s
19726 This timeout applies to file locking when using &[flock()]& (see
19727 &%use_flock%&); the timeout operates in a similar manner to
19728 &%lock_fcntl_timeout%&.
19729
19730
19731 .option lock_interval appendfile time 3s
19732 This specifies the time to wait between attempts to lock the file. See below
19733 for details of locking.
19734
19735
19736 .option lock_retries appendfile integer 10
19737 This specifies the maximum number of attempts to lock the file. A value of zero
19738 is treated as 1. See below for details of locking.
19739
19740
19741 .option lockfile_mode appendfile "octal integer" 0600
19742 This specifies the mode of the created lock file, when a lock file is being
19743 used (see &%use_lockfile%& and &%use_mbx_lock%&).
19744
19745
19746 .option lockfile_timeout appendfile time 30m
19747 .cindex "timeout" "mailbox locking"
19748 When a lock file is being used (see &%use_lockfile%&), if a lock file already
19749 exists and is older than this value, it is assumed to have been left behind by
19750 accident, and Exim attempts to remove it.
19751
19752
19753 .option mailbox_filecount appendfile string&!! unset
19754 .cindex "mailbox" "specifying size of"
19755 .cindex "size" "of mailbox"
19756 If this option is set, it is expanded, and the result is taken as the current
19757 number of files in the mailbox. It must be a decimal number, optionally
19758 followed by K or M. This provides a way of obtaining this information from an
19759 external source that maintains the data.
19760
19761
19762 .option mailbox_size appendfile string&!! unset
19763 .cindex "mailbox" "specifying size of"
19764 .cindex "size" "of mailbox"
19765 If this option is set, it is expanded, and the result is taken as the current
19766 size the mailbox. It must be a decimal number, optionally followed by K or M.
19767 This provides a way of obtaining this information from an external source that
19768 maintains the data. This is likely to be helpful for maildir deliveries where
19769 it is computationally expensive to compute the size of a mailbox.
19770
19771
19772
19773 .option maildir_format appendfile boolean false
19774 .cindex "maildir format" "specifying"
19775 If this option is set with the &%directory%& option, the delivery is into a new
19776 file, in the &"maildir"& format that is used by other mail software. When the
19777 transport is activated directly from a &(redirect)& router (for example, the
19778 &(address_file)& transport in the default configuration), setting
19779 &%maildir_format%& causes the path received from the router to be treated as a
19780 directory, whether or not it ends with &`/`&. This option is available only if
19781 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
19782 &<<SECTmaildirdelivery>>& below for further details.
19783
19784
19785 .option maildir_quota_directory_regex appendfile string "See below"
19786 .cindex "maildir format" "quota; directories included in"
19787 .cindex "quota" "maildir; directories included in"
19788 This option is relevant only when &%maildir_use_size_file%& is set. It defines
19789 a regular expression for specifying directories, relative to the quota
19790 directory (see &%quota_directory%&), that should be included in the quota
19791 calculation. The default value is:
19792 .code
19793 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
19794 .endd
19795 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
19796 (directories whose names begin with a dot). If you want to exclude the
19797 &_Trash_&
19798 folder from the count (as some sites do), you need to change this setting to
19799 .code
19800 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
19801 .endd
19802 This uses a negative lookahead in the regular expression to exclude the
19803 directory whose name is &_.Trash_&. When a directory is excluded from quota
19804 calculations, quota processing is bypassed for any messages that are delivered
19805 directly into that directory.
19806
19807
19808 .option maildir_retries appendfile integer 10
19809 This option specifies the number of times to retry when writing a file in
19810 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
19811
19812
19813 .option maildir_tag appendfile string&!! unset
19814 This option applies only to deliveries in maildir format, and is described in
19815 section &<<SECTmaildirdelivery>>& below.
19816
19817
19818 .option maildir_use_size_file appendfile boolean false
19819 .cindex "maildir format" "&_maildirsize_& file"
19820 Setting this option true enables support for &_maildirsize_& files. Exim
19821 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
19822 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
19823 value is zero. See &%maildir_quota_directory_regex%& above and section
19824 &<<SECTmaildirdelivery>>& below for further details.
19825
19826 .option maildirfolder_create_regex appendfile string unset
19827 .cindex "maildir format" "&_maildirfolder_& file"
19828 .cindex "&_maildirfolder_&, creating"
19829 The value of this option is a regular expression. If it is unset, it has no
19830 effect. Otherwise, before a maildir delivery takes place, the pattern is
19831 matched against the name of the maildir directory, that is, the directory
19832 containing the &_new_& and &_tmp_& subdirectories that will be used for the
19833 delivery. If there is a match, Exim checks for the existence of a file called
19834 &_maildirfolder_& in the directory, and creates it if it does not exist.
19835 See section &<<SECTmaildirdelivery>>& for more details.
19836
19837
19838 .option mailstore_format appendfile boolean false
19839 .cindex "mailstore format" "specifying"
19840 If this option is set with the &%directory%& option, the delivery is into two
19841 new files in  &"mailstore"& format. The option is available only if
19842 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
19843 below for further details.
19844
19845
19846 .option mailstore_prefix appendfile string&!! unset
19847 This option applies only to deliveries in mailstore format, and is described in
19848 section &<<SECTopdir>>& below.
19849
19850
19851 .option mailstore_suffix appendfile string&!! unset
19852 This option applies only to deliveries in mailstore format, and is described in
19853 section &<<SECTopdir>>& below.
19854
19855
19856 .option mbx_format appendfile boolean false
19857 .cindex "locking files"
19858 .cindex "file" "locking"
19859 .cindex "file" "MBX format"
19860 .cindex "MBX format, specifying"
19861 This option is available only if Exim has been compiled with SUPPORT_MBX
19862 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
19863 the message is appended to the mailbox file in MBX format instead of
19864 traditional Unix format. This format is supported by Pine4 and its associated
19865 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
19866
19867 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
19868 automatically changed by the use of &%mbx_format%&. They should normally be set
19869 empty when using MBX format, so this option almost always appears in this
19870 combination:
19871 .code
19872 mbx_format = true
19873 message_prefix =
19874 message_suffix =
19875 .endd
19876 If none of the locking options are mentioned in the configuration,
19877 &%use_mbx_lock%& is assumed and the other locking options default to false. It
19878 is possible to specify the other kinds of locking with &%mbx_format%&, but
19879 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
19880 interworks with &'c-client'&, providing for shared access to the mailbox. It
19881 should not be used if any program that does not use this form of locking is
19882 going to access the mailbox, nor should it be used if the mailbox file is NFS
19883 mounted, because it works only when the mailbox is accessed from a single host.
19884
19885 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
19886 the standard version of &'c-client'&, because as long as it has a mailbox open
19887 (this means for the whole of a Pine or IMAP session), Exim will not be able to
19888 append messages to it.
19889
19890
19891 .option message_prefix appendfile string&!! "see below"
19892 .cindex "&""From""& line"
19893 The string specified here is expanded and output at the start of every message.
19894 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
19895 in which case it is:
19896 .code
19897 message_prefix = "From ${if def:return_path{$return_path}\
19898   {MAILER-DAEMON}} $tod_bsdinbox\n"
19899 .endd
19900 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
19901 &`\n`& to &`\r\n`& in &%message_prefix%&.
19902
19903 .option message_suffix appendfile string&!! "see below"
19904 The string specified here is expanded and output at the end of every message.
19905 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
19906 in which case it is a single newline character. The suffix can be suppressed by
19907 setting
19908 .code
19909 message_suffix =
19910 .endd
19911 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
19912 &`\n`& to &`\r\n`& in &%message_suffix%&.
19913
19914 .option mode appendfile "octal integer" 0600
19915 If the output file is created, it is given this mode. If it already exists and
19916 has wider permissions, they are reduced to this mode. If it has narrower
19917 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
19918 if the delivery is the result of a &%save%& command in a filter file specifying
19919 a particular mode, the mode of the output file is always forced to take that
19920 value, and this option is ignored.
19921
19922
19923 .option mode_fail_narrower appendfile boolean true
19924 This option applies in the case when an existing mailbox file has a narrower
19925 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
19926 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
19927 continues with the delivery attempt, using the existing mode of the file.
19928
19929
19930 .option notify_comsat appendfile boolean false
19931 If this option is true, the &'comsat'& daemon is notified after every
19932 successful delivery to a user mailbox. This is the daemon that notifies logged
19933 on users about incoming mail.
19934
19935
19936 .option quota appendfile string&!! unset
19937 .cindex "quota" "imposed by Exim"
19938 This option imposes a limit on the size of the file to which Exim is appending,
19939 or to the total space used in the directory tree when the &%directory%& option
19940 is set. In the latter case, computation of the space used is expensive, because
19941 all the files in the directory (and any sub-directories) have to be
19942 individually inspected and their sizes summed. (See &%quota_size_regex%& and
19943 &%maildir_use_size_file%& for ways to avoid this in environments where users
19944 have no shell access to their mailboxes).
19945
19946 As there is no interlock against two simultaneous deliveries into a
19947 multi-file mailbox, it is possible for the quota to be overrun in this case.
19948 For single-file mailboxes, of course, an interlock is a necessity.
19949
19950 A file's size is taken as its &'used'& value. Because of blocking effects, this
19951 may be a lot less than the actual amount of disk space allocated to the file.
19952 If the sizes of a number of files are being added up, the rounding effect can
19953 become quite noticeable, especially on systems that have large block sizes.
19954 Nevertheless, it seems best to stick to the &'used'& figure, because this is
19955 the obvious value which users understand most easily.
19956
19957 The value of the option is expanded, and must then be a numerical value
19958 (decimal point allowed), optionally followed by one of the letters K, M, or G,
19959 for kilobytes, megabytes, or gigabytes. If Exim is running on a system with
19960 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
19961 be handled.
19962
19963 &*Note*&: A value of zero is interpreted as &"no quota"&.
19964
19965 The expansion happens while Exim is running as root, before it changes uid for
19966 the delivery. This means that files that are inaccessible to the end user can
19967 be used to hold quota values that are looked up in the expansion. When delivery
19968 fails because this quota is exceeded, the handling of the error is as for
19969 system quota failures.
19970
19971 By default, Exim's quota checking mimics system quotas, and restricts the
19972 mailbox to the specified maximum size, though the value is not accurate to the
19973 last byte, owing to separator lines and additional headers that may get added
19974 during message delivery. When a mailbox is nearly full, large messages may get
19975 refused even though small ones are accepted, because the size of the current
19976 message is added to the quota when the check is made. This behaviour can be
19977 changed by setting &%quota_is_inclusive%& false. When this is done, the check
19978 for exceeding the quota does not include the current message. Thus, deliveries
19979 continue until the quota has been exceeded; thereafter, no further messages are
19980 delivered. See also &%quota_warn_threshold%&.
19981
19982
19983 .option quota_directory appendfile string&!! unset
19984 This option defines the directory to check for quota purposes when delivering
19985 into individual files. The default is the delivery directory, or, if a file
19986 called &_maildirfolder_& exists in a maildir directory, the parent of the
19987 delivery directory.
19988
19989
19990 .option quota_filecount appendfile string&!! 0
19991 This option applies when the &%directory%& option is set. It limits the total
19992 number of files in the directory (compare the inode limit in system quotas). It
19993 can only be used if &%quota%& is also set. The value is expanded; an expansion
19994 failure causes delivery to be deferred. A value of zero is interpreted as
19995 &"no quota"&.
19996
19997
19998 .option quota_is_inclusive appendfile boolean true
19999 See &%quota%& above.
20000
20001
20002 .option quota_size_regex appendfile string unset
20003 This option applies when one of the delivery modes that writes a separate file
20004 for each message is being used. When Exim wants to find the size of one of
20005 these files in order to test the quota, it first checks &%quota_size_regex%&.
20006 If this is set to a regular expression that matches the file name, and it
20007 captures one string, that string is interpreted as a representation of the
20008 file's size. The value of &%quota_size_regex%& is not expanded.
20009
20010 This feature is useful only when users have no shell access to their mailboxes
20011 &-- otherwise they could defeat the quota simply by renaming the files. This
20012 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
20013 the file length to the file name. For example:
20014 .code
20015 maildir_tag = ,S=$message_size
20016 quota_size_regex = ,S=(\d+)
20017 .endd
20018 An alternative to &$message_size$& is &$message_linecount$&, which contains the
20019 number of lines in the message.
20020
20021 The regular expression should not assume that the length is at the end of the
20022 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
20023 sometimes add other information onto the ends of message file names.
20024
20025
20026
20027 .option quota_warn_message appendfile string&!! "see below"
20028 See below for the use of this option. If it is not set when
20029 &%quota_warn_threshold%& is set, it defaults to
20030 .code
20031 quota_warn_message = "\
20032   To: $local_part@$domain\n\
20033   Subject: Your mailbox\n\n\
20034   This message is automatically created \
20035   by mail delivery software.\n\n\
20036   The size of your mailbox has exceeded \
20037   a warning threshold that is\n\
20038   set by the system administrator.\n"
20039 .endd
20040
20041
20042 .option quota_warn_threshold appendfile string&!! 0
20043 .cindex "quota" "warning threshold"
20044 .cindex "mailbox" "size warning"
20045 .cindex "size" "of mailbox"
20046 This option is expanded in the same way as &%quota%& (see above). If the
20047 resulting value is greater than zero, and delivery of the message causes the
20048 size of the file or total space in the directory tree to cross the given
20049 threshold, a warning message is sent. If &%quota%& is also set, the threshold
20050 may be specified as a percentage of it by following the value with a percent
20051 sign. For example:
20052 .code
20053 quota = 10M
20054 quota_warn_threshold = 75%
20055 .endd
20056 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
20057 percent sign is ignored.
20058
20059 The warning message itself is specified by the &%quota_warn_message%& option,
20060 and it must start with a &'To:'& header line containing the recipient(s) of the
20061 warning message. These do not necessarily have to include the recipient(s) of
20062 the original message. A &'Subject:'& line should also normally be supplied. You
20063 can include any other header lines that you want. If you do not include a
20064 &'From:'& line, the default is:
20065 .code
20066 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
20067 .endd
20068 .oindex &%errors_reply_to%&
20069 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
20070 option.
20071
20072 The &%quota%& option does not have to be set in order to use this option; they
20073 are independent of one another except when the threshold is specified as a
20074 percentage.
20075
20076
20077 .option use_bsmtp appendfile boolean false
20078 .cindex "envelope sender"
20079 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
20080 format, with the envelope sender and recipient(s) included as SMTP commands. If
20081 you want to include a leading HELO command with such messages, you can do
20082 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
20083 for details of batch SMTP.
20084
20085
20086 .option use_crlf appendfile boolean false
20087 .cindex "carriage return"
20088 .cindex "linefeed"
20089 This option causes lines to be terminated with the two-character CRLF sequence
20090 (carriage return, linefeed) instead of just a linefeed character. In the case
20091 of batched SMTP, the byte sequence written to the file is then an exact image
20092 of what would be sent down a real SMTP connection.
20093
20094 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
20095 (which are used to supply the traditional &"From&~"& and blank line separators
20096 in Berkeley-style mailboxes) are written verbatim, so must contain their own
20097 carriage return characters if these are needed. In cases where these options
20098 have non-empty defaults, the values end with a single linefeed, so they must be
20099 changed to end with &`\r\n`& if &%use_crlf%& is set.
20100
20101
20102 .option use_fcntl_lock appendfile boolean "see below"
20103 This option controls the use of the &[fcntl()]& function to lock a file for
20104 exclusive use when a message is being appended. It is set by default unless
20105 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
20106 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
20107 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
20108
20109
20110 .option use_flock_lock appendfile boolean false
20111 This option is provided to support the use of &[flock()]& for file locking, for
20112 the few situations where it is needed. Most modern operating systems support
20113 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
20114 each other. Exim uses &[fcntl()]& locking by default.
20115
20116 This option is required only if you are using an operating system where
20117 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
20118 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
20119 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
20120
20121 .cindex "Solaris" "&[flock()]& support"
20122 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
20123 have it (and some, I think, provide a not quite right version built on top of
20124 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
20125 the ability to use it, and any attempt to do so will cause a configuration
20126 error.
20127
20128 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
20129 is just being mapped onto &[fcntl()]& by the OS).
20130
20131
20132 .option use_lockfile appendfile boolean "see below"
20133 If this option is turned off, Exim does not attempt to create a lock file when
20134 appending to a mailbox file. In this situation, the only locking is by
20135 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
20136 sure that every MUA that is ever going to look at your users' mailboxes uses
20137 &[fcntl()]& rather than a lock file, and even then only when you are not
20138 delivering over NFS from more than one host.
20139
20140 .cindex "NFS" "lock file"
20141 In order to append to an NFS file safely from more than one host, it is
20142 necessary to take out a lock &'before'& opening the file, and the lock file
20143 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
20144 file corruption.
20145
20146 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
20147 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
20148 except when &%mbx_format%& is set.
20149
20150
20151 .option use_mbx_lock appendfile boolean "see below"
20152 This option is available only if Exim has been compiled with SUPPORT_MBX
20153 set in &_Local/Makefile_&. Setting the option specifies that special MBX
20154 locking rules be used. It is set by default if &%mbx_format%& is set and none
20155 of the locking options are mentioned in the configuration. The locking rules
20156 are the same as are used by the &'c-client'& library that underlies Pine and
20157 the IMAP4 and POP daemons that come with it (see the discussion below). The
20158 rules allow for shared access to the mailbox. However, this kind of locking
20159 does not work when the mailbox is NFS mounted.
20160
20161 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
20162 &%use_flock_lock%& to control what kind of locking is used in implementing the
20163 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
20164 without &%use_fcntl_lock%& or &%use_flock_lock%&.
20165
20166
20167
20168
20169 .section "Operational details for appending" "SECTopappend"
20170 .cindex "appending to a file"
20171 .cindex "file" "appending"
20172 Before appending to a file, the following preparations are made:
20173
20174 .ilist
20175 If the name of the file is &_/dev/null_&, no action is taken, and a success
20176 return is given.
20177
20178 .next
20179 .cindex "directory creation"
20180 If any directories on the file's path are missing, Exim creates them if the
20181 &%create_directory%& option is set. A created directory's mode is given by the
20182 &%directory_mode%& option.
20183
20184 .next
20185 If &%file_format%& is set, the format of an existing file is checked. If this
20186 indicates that a different transport should be used, control is passed to that
20187 transport.
20188
20189 .next
20190 .cindex "file" "locking"
20191 .cindex "locking files"
20192 .cindex "NFS" "lock file"
20193 If &%use_lockfile%& is set, a lock file is built in a way that will work
20194 reliably over NFS, as follows:
20195
20196 .olist
20197 Create a &"hitching post"& file whose name is that of the lock file with the
20198 current time, primary host name, and process id added, by opening for writing
20199 as a new file. If this fails with an access error, delivery is deferred.
20200 .next
20201 Close the hitching post file, and hard link it to the lock file name.
20202 .next
20203 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
20204 Unlink the hitching post name.
20205 .next
20206 Otherwise, use &[stat()]& to get information about the hitching post file, and
20207 then unlink hitching post name. If the number of links is exactly two, creation
20208 of the lock file succeeded but something (for example, an NFS server crash and
20209 restart) caused this fact not to be communicated to the &[link()]& call.
20210 .next
20211 If creation of the lock file failed, wait for &%lock_interval%& and try again,
20212 up to &%lock_retries%& times. However, since any program that writes to a
20213 mailbox should complete its task very quickly, it is reasonable to time out old
20214 lock files that are normally the result of user agent and system crashes. If an
20215 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
20216 it before trying again.
20217 .endlist olist
20218
20219 .next
20220 A call is made to &[lstat()]& to discover whether the main file exists, and if
20221 so, what its characteristics are. If &[lstat()]& fails for any reason other
20222 than non-existence, delivery is deferred.
20223
20224 .next
20225 .cindex "symbolic link" "to mailbox"
20226 .cindex "mailbox" "symbolic link"
20227 If the file does exist and is a symbolic link, delivery is deferred, unless the
20228 &%allow_symlink%& option is set, in which case the ownership of the link is
20229 checked, and then &[stat()]& is called to find out about the real file, which
20230 is then subjected to the checks below. The check on the top-level link
20231 ownership prevents one user creating a link for another's mailbox in a sticky
20232 directory, though allowing symbolic links in this case is definitely not a good
20233 idea. If there is a chain of symbolic links, the intermediate ones are not
20234 checked.
20235
20236 .next
20237 If the file already exists but is not a regular file, or if the file's owner
20238 and group (if the group is being checked &-- see &%check_group%& above) are
20239 different from the user and group under which the delivery is running,
20240 delivery is deferred.
20241
20242 .next
20243 If the file's permissions are more generous than specified, they are reduced.
20244 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
20245 is set false, in which case the delivery is tried using the existing
20246 permissions.
20247
20248 .next
20249 The file's inode number is saved, and the file is then opened for appending.
20250 If this fails because the file has vanished, &(appendfile)& behaves as if it
20251 hadn't existed (see below). For any other failures, delivery is deferred.
20252
20253 .next
20254 If the file is opened successfully, check that the inode number hasn't
20255 changed, that it is still a regular file, and that the owner and permissions
20256 have not changed. If anything is wrong, defer delivery and freeze the message.
20257
20258 .next
20259 If the file did not exist originally, defer delivery if the &%file_must_exist%&
20260 option is set. Otherwise, check that the file is being created in a permitted
20261 directory if the &%create_file%& option is set (deferring on failure), and then
20262 open for writing as a new file, with the O_EXCL and O_CREAT options,
20263 except when dealing with a symbolic link (the &%allow_symlink%& option must be
20264 set). In this case, which can happen if the link points to a non-existent file,
20265 the file is opened for writing using O_CREAT but not O_EXCL, because
20266 that prevents link following.
20267
20268 .next
20269 .cindex "loop" "while file testing"
20270 If opening fails because the file exists, obey the tests given above for
20271 existing files. However, to avoid looping in a situation where the file is
20272 being continuously created and destroyed, the exists/not-exists loop is broken
20273 after 10 repetitions, and the message is then frozen.
20274
20275 .next
20276 If opening fails with any other error, defer delivery.
20277
20278 .next
20279 .cindex "file" "locking"
20280 .cindex "locking files"
20281 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
20282 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
20283 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
20284 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
20285 file, and an exclusive lock on the file whose name is
20286 .code
20287 /tmp/.<device-number>.<inode-number>
20288 .endd
20289 using the device and inode numbers of the open mailbox file, in accordance with
20290 the MBX locking rules. This file is created with a mode that is specified by
20291 the &%lockfile_mode%& option.
20292
20293 If Exim fails to lock the file, there are two possible courses of action,
20294 depending on the value of the locking timeout. This is obtained from
20295 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
20296
20297 If the timeout value is zero, the file is closed, Exim waits for
20298 &%lock_interval%&, and then goes back and re-opens the file as above and tries
20299 to lock it again. This happens up to &%lock_retries%& times, after which the
20300 delivery is deferred.
20301
20302 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
20303 &[flock()]& are used (with the given timeout), so there has already been some
20304 waiting involved by the time locking fails. Nevertheless, Exim does not give up
20305 immediately. It retries up to
20306 .code
20307 (lock_retries * lock_interval) / <timeout>
20308 .endd
20309 times (rounded up).
20310 .endlist
20311
20312 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
20313 and/or &[flock()]& locks) and then deletes the lock file if one was created.
20314
20315
20316 .section "Operational details for delivery to a new file" "SECTopdir"
20317 .cindex "delivery" "to single file"
20318 .cindex "&""From""& line"
20319 When the &%directory%& option is set instead of &%file%&, each message is
20320 delivered into a newly-created file or set of files. When &(appendfile)& is
20321 activated directly from a &(redirect)& router, neither &%file%& nor
20322 &%directory%& is normally set, because the path for delivery is supplied by the
20323 router. (See for example, the &(address_file)& transport in the default
20324 configuration.) In this case, delivery is to a new file if either the path name
20325 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
20326
20327 No locking is required while writing the message to a new file, so the various
20328 locking options of the transport are ignored. The &"From"& line that by default
20329 separates messages in a single file is not normally needed, nor is the escaping
20330 of message lines that start with &"From"&, and there is no need to ensure a
20331 newline at the end of each message. Consequently, the default values for
20332 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
20333 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
20334
20335 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
20336 the files in the delivery directory by default. However, you can specify a
20337 different directory by setting &%quota_directory%&. Also, for maildir
20338 deliveries (see below) the &_maildirfolder_& convention is honoured.
20339
20340
20341 .cindex "maildir format"
20342 .cindex "mailstore format"
20343 There are three different ways in which delivery to individual files can be
20344 done, controlled by the settings of the &%maildir_format%& and
20345 &%mailstore_format%& options. Note that code to support maildir or mailstore
20346 formats is not included in the binary unless SUPPORT_MAILDIR or
20347 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
20348
20349 .cindex "directory creation"
20350 In all three cases an attempt is made to create the directory and any necessary
20351 sub-directories if they do not exist, provided that the &%create_directory%&
20352 option is set (the default). The location of a created directory can be
20353 constrained by setting &%create_file%&. A created directory's mode is given by
20354 the &%directory_mode%& option. If creation fails, or if the
20355 &%create_directory%& option is not set when creation is required, delivery is
20356 deferred.
20357
20358
20359
20360 .section "Maildir delivery" "SECTmaildirdelivery"
20361 .cindex "maildir format" "description of"
20362 If the &%maildir_format%& option is true, Exim delivers each message by writing
20363 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
20364 directory that is defined by the &%directory%& option (the &"delivery
20365 directory"&). If the delivery is successful, the file is renamed into the
20366 &_new_& subdirectory.
20367
20368 In the file name, <&'stime'&> is the current time of day in seconds, and
20369 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
20370 Exim checks that the time-of-day clock has moved on by at least one microsecond
20371 before terminating the delivery process. This guarantees uniqueness for the
20372 file name. However, as a precaution, Exim calls &[stat()]& for the file before
20373 opening it. If any response other than ENOENT (does not exist) is given,
20374 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
20375
20376 Before Exim carries out a maildir delivery, it ensures that subdirectories
20377 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
20378 do not exist, Exim tries to create them and any superior directories in their
20379 path, subject to the &%create_directory%& and &%create_file%& options. If the
20380 &%maildirfolder_create_regex%& option is set, and the regular expression it
20381 contains matches the delivery directory, Exim also ensures that a file called
20382 &_maildirfolder_& exists in the delivery directory. If a missing directory or
20383 &_maildirfolder_& file cannot be created, delivery is deferred.
20384
20385 These features make it possible to use Exim to create all the necessary files
20386 and directories in a maildir mailbox, including subdirectories for maildir++
20387 folders. Consider this example:
20388 .code
20389 maildir_format = true
20390 directory = /var/mail/$local_part\
20391            ${if eq{$local_part_suffix}{}{}\
20392            {/.${substr_1:$local_part_suffix}}}
20393 maildirfolder_create_regex = /\.[^/]+$
20394 .endd
20395 If &$local_part_suffix$& is empty (there was no suffix for the local part),
20396 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
20397 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
20398 not match this name, so Exim will not look for or create the file
20399 &_/var/mail/pimbo/maildirfolder_&, though it will create
20400 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
20401
20402 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
20403 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
20404 does match &%maildirfolder_create_regex%&. In this case, Exim will create
20405 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
20406 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
20407
20408 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
20409 not inadvertently match the toplevel maildir directory, because a
20410 &_maildirfolder_& file at top level would completely break quota calculations.
20411
20412 .cindex "quota" "in maildir delivery"
20413 .cindex "maildir++"
20414 If Exim is required to check a &%quota%& setting before a maildir delivery, and
20415 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
20416 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
20417 Exim assumes the directory is a maildir++ folder directory, which is one level
20418 down from the user's top level mailbox directory. This causes it to start at
20419 the parent directory instead of the current directory when calculating the
20420 amount of space used.
20421
20422 One problem with delivering into a multi-file mailbox is that it is
20423 computationally expensive to compute the size of the mailbox for quota
20424 checking. Various approaches have been taken to reduce the amount of work
20425 needed. The next two sections describe two of them. A third alternative is to
20426 use some external process for maintaining the size data, and use the expansion
20427 of the &%mailbox_size%& option as a way of importing it into Exim.
20428
20429
20430
20431
20432 .section "Using tags to record message sizes" "SECID135"
20433 If &%maildir_tag%& is set, the string is expanded for each delivery.
20434 When the maildir file is renamed into the &_new_& sub-directory, the
20435 tag is added to its name. However, if adding the tag takes the length of the
20436 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
20437 the tag is dropped and the maildir file is created with no tag.
20438
20439 .vindex "&$message_size$&"
20440 Tags can be used to encode the size of files in their names; see
20441 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
20442 happens after the message has been written. The value of the &$message_size$&
20443 variable is set to the number of bytes actually written. If the expansion is
20444 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
20445 be deferred. The expanded tag may contain any printing characters except &"/"&.
20446 Non-printing characters in the string are ignored; if the resulting string is
20447 empty, it is ignored. If it starts with an alphanumeric character, a leading
20448 colon is inserted.
20449
20450
20451
20452 .section "Using a maildirsize file" "SECID136"
20453 .cindex "quota" "in maildir delivery"
20454 .cindex "maildir format" "&_maildirsize_& file"
20455 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
20456 storing quota and message size information in a file called &_maildirsize_&
20457 within the toplevel maildir directory. If this file does not exist, Exim
20458 creates it, setting the quota from the &%quota%& option of the transport. If
20459 the maildir directory itself does not exist, it is created before any attempt
20460 to write a &_maildirsize_& file.
20461
20462 The &_maildirsize_& file is used to hold information about the sizes of
20463 messages in the maildir, thus speeding up quota calculations. The quota value
20464 in the file is just a cache; if the quota is changed in the transport, the new
20465 value overrides the cached value when the next message is delivered. The cache
20466 is maintained for the benefit of other programs that access the maildir and
20467 need to know the quota.
20468
20469 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
20470 file is maintained (with a zero quota setting), but no quota is imposed.
20471
20472 A regular expression is available for controlling which directories in the
20473 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
20474 See the description of the &%maildir_quota_directory_regex%& option above for
20475 details.
20476
20477
20478 .section "Mailstore delivery" "SECID137"
20479 .cindex "mailstore format" "description of"
20480 If the &%mailstore_format%& option is true, each message is written as two
20481 files in the given directory. A unique base name is constructed from the
20482 message id and the current delivery process, and the files that are written use
20483 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
20484 contains the message's envelope, and the &_.msg_& file contains the message
20485 itself. The base name is placed in the variable &$mailstore_basename$&.
20486
20487 During delivery, the envelope is first written to a file with the suffix
20488 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
20489 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
20490 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
20491 file before accessing either of them. An alternative approach is to wait for
20492 the absence of a &_.tmp_& file.
20493
20494 The envelope file starts with any text defined by the &%mailstore_prefix%&
20495 option, expanded and terminated by a newline if there isn't one. Then follows
20496 the sender address on one line, then all the recipient addresses, one per line.
20497 There can be more than one recipient only if the &%batch_max%& option is set
20498 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
20499 appended to the file, followed by a newline if it does not end with one.
20500
20501 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
20502 failure, it is ignored. Other expansion errors are treated as serious
20503 configuration errors, and delivery is deferred. The variable
20504 &$mailstore_basename$& is available for use during these expansions.
20505
20506
20507 .section "Non-special new file delivery" "SECID138"
20508 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
20509 file is created directly in the named directory. For example, when delivering
20510 messages into files in batched SMTP format for later delivery to some host (see
20511 section &<<SECTbatchSMTP>>&), a setting such as
20512 .code
20513 directory = /var/bsmtp/$host
20514 .endd
20515 might be used. A message is written to a file with a temporary name, which is
20516 then renamed when the delivery is complete. The final name is obtained by
20517 expanding the contents of the &%directory_file%& option.
20518 .ecindex IIDapptra1
20519 .ecindex IIDapptra2
20520
20521
20522
20523
20524
20525
20526 . ////////////////////////////////////////////////////////////////////////////
20527 . ////////////////////////////////////////////////////////////////////////////
20528
20529 .chapter "The autoreply transport" "CHID8"
20530 .scindex IIDauttra1 "transports" "&(autoreply)&"
20531 .scindex IIDauttra2 "&(autoreply)& transport"
20532 The &(autoreply)& transport is not a true transport in that it does not cause
20533 the message to be transmitted. Instead, it generates a new mail message as an
20534 automatic reply to the incoming message. &'References:'& and
20535 &'Auto-Submitted:'& header lines are included. These are constructed according
20536 to the rules in RFCs 2822 and 3834, respectively.
20537
20538 If the router that passes the message to this transport does not have the
20539 &%unseen%& option set, the original message (for the current recipient) is not
20540 delivered anywhere. However, when the &%unseen%& option is set on the router
20541 that passes the message to this transport, routing of the address continues, so
20542 another router can set up a normal message delivery.
20543
20544
20545 The &(autoreply)& transport is usually run as the result of mail filtering, a
20546 &"vacation"& message being the standard example. However, it can also be run
20547 directly from a router like any other transport. To reduce the possibility of
20548 message cascades, messages created by the &(autoreply)& transport always have
20549 empty envelope sender addresses, like bounce messages.
20550
20551 The parameters of the message to be sent can be specified in the configuration
20552 by options described below. However, these are used only when the address
20553 passed to the transport does not contain its own reply information. When the
20554 transport is run as a consequence of a
20555 &%mail%&
20556 or &%vacation%& command in a filter file, the parameters of the message are
20557 supplied by the filter, and passed with the address. The transport's options
20558 that define the message are then ignored (so they are not usually set in this
20559 case). The message is specified entirely by the filter or by the transport; it
20560 is never built from a mixture of options. However, the &%file_optional%&,
20561 &%mode%&, and &%return_message%& options apply in all cases.
20562
20563 &(Autoreply)& is implemented as a local transport. When used as a result of a
20564 command in a user's filter file, &(autoreply)& normally runs under the uid and
20565 gid of the user, and with appropriate current and home directories (see chapter
20566 &<<CHAPenvironment>>&).
20567
20568 There is a subtle difference between routing a message to a &(pipe)& transport
20569 that generates some text to be returned to the sender, and routing it to an
20570 &(autoreply)& transport. This difference is noticeable only if more than one
20571 address from the same message is so handled. In the case of a pipe, the
20572 separate outputs from the different addresses are gathered up and returned to
20573 the sender in a single message, whereas if &(autoreply)& is used, a separate
20574 message is generated for each address that is passed to it.
20575
20576 Non-printing characters are not permitted in the header lines generated for the
20577 message that &(autoreply)& creates, with the exception of newlines that are
20578 immediately followed by white space. If any non-printing characters are found,
20579 the transport defers.
20580 Whether characters with the top bit set count as printing characters or not is
20581 controlled by the &%print_topbitchars%& global option.
20582
20583 If any of the generic options for manipulating headers (for example,
20584 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
20585 of the original message that is included in the generated message when
20586 &%return_message%& is set. They do not apply to the generated message itself.
20587
20588 .vindex "&$sender_address$&"
20589 If the &(autoreply)& transport receives return code 2 from Exim when it submits
20590 the message, indicating that there were no recipients, it does not treat this
20591 as an error. This means that autoreplies sent to &$sender_address$& when this
20592 is empty (because the incoming message is a bounce message) do not cause
20593 problems. They are just discarded.
20594
20595
20596
20597 .section "Private options for autoreply" "SECID139"
20598 .cindex "options" "&(autoreply)& transport"
20599
20600 .option bcc autoreply string&!! unset
20601 This specifies the addresses that are to receive &"blind carbon copies"& of the
20602 message when the message is specified by the transport.
20603
20604
20605 .option cc autoreply string&!! unset
20606 This specifies recipients of the message and the contents of the &'Cc:'& header
20607 when the message is specified by the transport.
20608
20609
20610 .option file autoreply string&!! unset
20611 The contents of the file are sent as the body of the message when the message
20612 is specified by the transport. If both &%file%& and &%text%& are set, the text
20613 string comes first.
20614
20615
20616 .option file_expand autoreply boolean false
20617 If this is set, the contents of the file named by the &%file%& option are
20618 subjected to string expansion as they are added to the message.
20619
20620
20621 .option file_optional autoreply boolean false
20622 If this option is true, no error is generated if the file named by the &%file%&
20623 option or passed with the address does not exist or cannot be read.
20624
20625
20626 .option from autoreply string&!! unset
20627 This specifies the contents of the &'From:'& header when the message is
20628 specified by the transport.
20629
20630
20631 .option headers autoreply string&!! unset
20632 This specifies additional RFC 2822 headers that are to be added to the message
20633 when the message is specified by the transport. Several can be given by using
20634 &"\n"& to separate them. There is no check on the format.
20635
20636
20637 .option log autoreply string&!! unset
20638 This option names a file in which a record of every message sent is logged when
20639 the message is specified by the transport.
20640
20641
20642 .option mode autoreply "octal integer" 0600
20643 If either the log file or the &"once"& file has to be created, this mode is
20644 used.
20645
20646
20647 .option never_mail autoreply "address list&!!" unset
20648 If any run of the transport creates a message with a recipient that matches any
20649 item in the list, that recipient is quietly discarded. If all recipients are
20650 discarded, no message is created. This applies both when the recipients are
20651 generated by a filter and when they are specified in the transport.
20652
20653
20654
20655 .option once autoreply string&!! unset
20656 This option names a file or DBM database in which a record of each &'To:'&
20657 recipient is kept when the message is specified by the transport. &*Note*&:
20658 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
20659
20660 If &%once%& is unset, or is set to an empty string, the message is always sent.
20661 By default, if &%once%& is set to a non-empty file name, the message
20662 is not sent if a potential recipient is already listed in the database.
20663 However, if the &%once_repeat%& option specifies a time greater than zero, the
20664 message is sent if that much time has elapsed since a message was last sent to
20665 this recipient. A setting of zero time for &%once_repeat%& (the default)
20666 prevents a message from being sent a second time &-- in this case, zero means
20667 infinity.
20668
20669 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
20670 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
20671 greater than zero, it changes the way Exim implements the &%once%& option.
20672 Instead of using a DBM file to record every recipient it sends to, it uses a
20673 regular file, whose size will never get larger than the given value.
20674
20675 In the file, Exim keeps a linear list of recipient addresses and the times at
20676 which they were sent messages. If the file is full when a new address needs to
20677 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
20678 means that a given recipient may receive multiple messages, but at
20679 unpredictable intervals that depend on the rate of turnover of addresses in the
20680 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
20681
20682
20683 .option once_file_size autoreply integer 0
20684 See &%once%& above.
20685
20686
20687 .option once_repeat autoreply time&!! 0s
20688 See &%once%& above.
20689 After expansion, the value of this option must be a valid time value.
20690
20691
20692 .option reply_to autoreply string&!! unset
20693 This specifies the contents of the &'Reply-To:'& header when the message is
20694 specified by the transport.
20695
20696
20697 .option return_message autoreply boolean false
20698 If this is set, a copy of the original message is returned with the new
20699 message, subject to the maximum size set in the &%return_size_limit%& global
20700 configuration option.
20701
20702
20703 .option subject autoreply string&!! unset
20704 This specifies the contents of the &'Subject:'& header when the message is
20705 specified by the transport. It is tempting to quote the original subject in
20706 automatic responses. For example:
20707 .code
20708 subject = Re: $h_subject:
20709 .endd
20710 There is a danger in doing this, however. It may allow a third party to
20711 subscribe your users to an opt-in mailing list, provided that the list accepts
20712 bounce messages as subscription confirmations. Well-managed lists require a
20713 non-bounce message to confirm a subscription, so the danger is relatively
20714 small.
20715
20716
20717
20718 .option text autoreply string&!! unset
20719 This specifies a single string to be used as the body of the message when the
20720 message is specified by the transport. If both &%text%& and &%file%& are set,
20721 the text comes first.
20722
20723
20724 .option to autoreply string&!! unset
20725 This specifies recipients of the message and the contents of the &'To:'& header
20726 when the message is specified by the transport.
20727 .ecindex IIDauttra1
20728 .ecindex IIDauttra2
20729
20730
20731
20732
20733 . ////////////////////////////////////////////////////////////////////////////
20734 . ////////////////////////////////////////////////////////////////////////////
20735
20736 .chapter "The lmtp transport" "CHAPLMTP"
20737 .cindex "transports" "&(lmtp)&"
20738 .cindex "&(lmtp)& transport"
20739 .cindex "LMTP" "over a pipe"
20740 .cindex "LMTP" "over a socket"
20741 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
20742 specified command
20743 or by interacting with a Unix domain socket.
20744 This transport is something of a cross between the &(pipe)& and &(smtp)&
20745 transports. Exim also has support for using LMTP over TCP/IP; this is
20746 implemented as an option for the &(smtp)& transport. Because LMTP is expected
20747 to be of minority interest, the default build-time configure in &_src/EDITME_&
20748 has it commented out. You need to ensure that
20749 .code
20750 TRANSPORT_LMTP=yes
20751 .endd
20752 .cindex "options" "&(lmtp)& transport"
20753 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
20754 included in the Exim binary. The private options of the &(lmtp)& transport are
20755 as follows:
20756
20757 .option batch_id lmtp string&!! unset
20758 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20759
20760
20761 .option batch_max lmtp integer 1
20762 This limits the number of addresses that can be handled in a single delivery.
20763 Most LMTP servers can handle several addresses at once, so it is normally a
20764 good idea to increase this value. See the description of local delivery
20765 batching in chapter &<<CHAPbatching>>&.
20766
20767
20768 .option command lmtp string&!! unset
20769 This option must be set if &%socket%& is not set. The string is a command which
20770 is run in a separate process. It is split up into a command name and list of
20771 arguments, each of which is separately expanded (so expansion cannot change the
20772 number of arguments). The command is run directly, not via a shell. The message
20773 is passed to the new process using the standard input and output to operate the
20774 LMTP protocol.
20775
20776 .option ignore_quota lmtp boolean false
20777 .cindex "LMTP" "ignoring quota errors"
20778 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
20779 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
20780 in its response to the LHLO command.
20781
20782 .option socket lmtp string&!! unset
20783 This option must be set if &%command%& is not set. The result of expansion must
20784 be the name of a Unix domain socket. The transport connects to the socket and
20785 delivers the message to it using the LMTP protocol.
20786
20787
20788 .option timeout lmtp time 5m
20789 The transport is aborted if the created process or Unix domain socket does not
20790 respond to LMTP commands or message input within this timeout. Delivery
20791 is deferred, and will be tried again later. Here is an example of a typical
20792 LMTP transport:
20793 .code
20794 lmtp:
20795   driver = lmtp
20796   command = /some/local/lmtp/delivery/program
20797   batch_max = 20
20798   user = exim
20799 .endd
20800 This delivers up to 20 addresses at a time, in a mixture of domains if
20801 necessary, running as the user &'exim'&.
20802
20803
20804
20805 . ////////////////////////////////////////////////////////////////////////////
20806 . ////////////////////////////////////////////////////////////////////////////
20807
20808 .chapter "The pipe transport" "CHAPpipetransport"
20809 .scindex IIDpiptra1 "transports" "&(pipe)&"
20810 .scindex IIDpiptra2 "&(pipe)& transport"
20811 The &(pipe)& transport is used to deliver messages via a pipe to a command
20812 running in another process. One example is the use of &(pipe)& as a
20813 pseudo-remote transport for passing messages to some other delivery mechanism
20814 (such as UUCP). Another is the use by individual users to automatically process
20815 their incoming messages. The &(pipe)& transport can be used in one of the
20816 following ways:
20817
20818 .ilist
20819 .vindex "&$local_part$&"
20820 A router routes one address to a transport in the normal way, and the
20821 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
20822 contains the local part of the address (as usual), and the command that is run
20823 is specified by the &%command%& option on the transport.
20824 .next
20825 .vindex "&$pipe_addresses$&"
20826 If the &%batch_max%& option is set greater than 1 (the default is 1), the
20827 transport can handle more than one address in a single run. In this case, when
20828 more than one address is routed to the transport, &$local_part$& is not set
20829 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
20830 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
20831 that are routed to the transport.
20832 .next
20833 .vindex "&$address_pipe$&"
20834 A router redirects an address directly to a pipe command (for example, from an
20835 alias or forward file). In this case, &$address_pipe$& contains the text of the
20836 pipe command, and the &%command%& option on the transport is ignored. If only
20837 one address is being transported (&%batch_max%& is not greater than one, or
20838 only one address was redirected to this pipe command), &$local_part$& contains
20839 the local part that was redirected.
20840 .endlist
20841
20842
20843 The &(pipe)& transport is a non-interactive delivery method. Exim can also
20844 deliver messages over pipes using the LMTP interactive protocol. This is
20845 implemented by the &(lmtp)& transport.
20846
20847 In the case when &(pipe)& is run as a consequence of an entry in a local user's
20848 &_.forward_& file, the command runs under the uid and gid of that user. In
20849 other cases, the uid and gid have to be specified explicitly, either on the
20850 transport or on the router that handles the address. Current and &"home"&
20851 directories are also controllable. See chapter &<<CHAPenvironment>>& for
20852 details of the local delivery environment and chapter &<<CHAPbatching>>&
20853 for a discussion of local delivery batching.
20854
20855
20856 .section "Concurrent delivery" "SECID140"
20857 If two messages arrive at almost the same time, and both are routed to a pipe
20858 delivery, the two pipe transports may be run concurrently. You must ensure that
20859 any pipe commands you set up are robust against this happening. If the commands
20860 write to a file, the &%exim_lock%& utility might be of use.
20861
20862
20863
20864
20865 .section "Returned status and data" "SECID141"
20866 .cindex "&(pipe)& transport" "returned data"
20867 If the command exits with a non-zero return code, the delivery is deemed to
20868 have failed, unless either the &%ignore_status%& option is set (in which case
20869 the return code is treated as zero), or the return code is one of those listed
20870 in the &%temp_errors%& option, which are interpreted as meaning &"try again
20871 later"&. In this case, delivery is deferred. Details of a permanent failure are
20872 logged, but are not included in the bounce message, which merely contains
20873 &"local delivery failed"&.
20874
20875 If the return code is greater than 128 and the command being run is a shell
20876 script, it normally means that the script was terminated by a signal whose
20877 value is the return code minus 128.
20878
20879 If Exim is unable to run the command (that is, if &[execve()]& fails), the
20880 return code is set to 127. This is the value that a shell returns if it is
20881 asked to run a non-existent command. The wording for the log line suggests that
20882 a non-existent command may be the problem.
20883
20884 The &%return_output%& option can affect the result of a pipe delivery. If it is
20885 set and the command produces any output on its standard output or standard
20886 error streams, the command is considered to have failed, even if it gave a zero
20887 return code or if &%ignore_status%& is set. The output from the command is
20888 included as part of the bounce message. The &%return_fail_output%& option is
20889 similar, except that output is returned only when the command exits with a
20890 failure return code, that is, a value other than zero or a code that matches
20891 &%temp_errors%&.
20892
20893
20894
20895 .section "How the command is run" "SECThowcommandrun"
20896 .cindex "&(pipe)& transport" "path for command"
20897 The command line is (by default) broken down into a command name and arguments
20898 by the &(pipe)& transport itself. The &%allow_commands%& and
20899 &%restrict_to_path%& options can be used to restrict the commands that may be
20900 run.
20901
20902 .cindex "quoting" "in pipe command"
20903 Unquoted arguments are delimited by white space. If an argument appears in
20904 double quotes, backslash is interpreted as an escape character in the usual
20905 way. If an argument appears in single quotes, no escaping is done.
20906
20907 String expansion is applied to the command line except when it comes from a
20908 traditional &_.forward_& file (commands from a filter file are expanded). The
20909 expansion is applied to each argument in turn rather than to the whole line.
20910 For this reason, any string expansion item that contains white space must be
20911 quoted so as to be contained within a single argument. A setting such as
20912 .code
20913 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
20914 .endd
20915 will not work, because the expansion item gets split between several
20916 arguments. You have to write
20917 .code
20918 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
20919 .endd
20920 to ensure that it is all in one argument. The expansion is done in this way,
20921 argument by argument, so that the number of arguments cannot be changed as a
20922 result of expansion, and quotes or backslashes in inserted variables do not
20923 interact with external quoting. However, this leads to problems if you want to
20924 generate multiple arguments (or the command name plus arguments) from a single
20925 expansion. In this situation, the simplest solution is to use a shell. For
20926 example:
20927 .code
20928 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
20929 .endd
20930
20931 .cindex "transport" "filter"
20932 .cindex "filter" "transport filter"
20933 .vindex "&$pipe_addresses$&"
20934 Special handling takes place when an argument consists of precisely the text
20935 &`$pipe_addresses`&. This is not a general expansion variable; the only
20936 place this string is recognized is when it appears as an argument for a pipe or
20937 transport filter command. It causes each address that is being handled to be
20938 inserted in the argument list at that point &'as a separate argument'&. This
20939 avoids any problems with spaces or shell metacharacters, and is of use when a
20940 &(pipe)& transport is handling groups of addresses in a batch.
20941
20942 After splitting up into arguments and expansion, the resulting command is run
20943 in a subprocess directly from the transport, &'not'& under a shell. The
20944 message that is being delivered is supplied on the standard input, and the
20945 standard output and standard error are both connected to a single pipe that is
20946 read by Exim. The &%max_output%& option controls how much output the command
20947 may produce, and the &%return_output%& and &%return_fail_output%& options
20948 control what is done with it.
20949
20950 Not running the command under a shell (by default) lessens the security risks
20951 in cases when a command from a user's filter file is built out of data that was
20952 taken from an incoming message. If a shell is required, it can of course be
20953 explicitly specified as the command to be run. However, there are circumstances
20954 where existing commands (for example, in &_.forward_& files) expect to be run
20955 under a shell and cannot easily be modified. To allow for these cases, there is
20956 an option called &%use_shell%&, which changes the way the &(pipe)& transport
20957 works. Instead of breaking up the command line as just described, it expands it
20958 as a single string and passes the result to &_/bin/sh_&. The
20959 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
20960 with &%use_shell%&, and the whole mechanism is inherently less secure.
20961
20962
20963
20964 .section "Environment variables" "SECTpipeenv"
20965 .cindex "&(pipe)& transport" "environment for command"
20966 .cindex "environment for pipe transport"
20967 The environment variables listed below are set up when the command is invoked.
20968 This list is a compromise for maximum compatibility with other MTAs. Note that
20969 the &%environment%& option can be used to add additional variables to this
20970 environment.
20971 .display
20972 &`DOMAIN            `&   the domain of the address
20973 &`HOME              `&   the home directory, if set
20974 &`HOST              `&   the host name when called from a router (see below)
20975 &`LOCAL_PART        `&   see below
20976 &`LOCAL_PART_PREFIX `&   see below
20977 &`LOCAL_PART_SUFFIX `&   see below
20978 &`LOGNAME           `&   see below
20979 &`MESSAGE_ID        `&   Exim's local ID for the message
20980 &`PATH              `&   as specified by the &%path%& option below
20981 &`QUALIFY_DOMAIN    `&   the sender qualification domain
20982 &`RECIPIENT         `&   the complete recipient address
20983 &`SENDER            `&   the sender of the message (empty if a bounce)
20984 &`SHELL             `&   &`/bin/sh`&
20985 &`TZ                `&   the value of the &%timezone%& option, if set
20986 &`USER              `&   see below
20987 .endd
20988 When a &(pipe)& transport is called directly from (for example) an &(accept)&
20989 router, LOCAL_PART is set to the local part of the address. When it is
20990 called as a result of a forward or alias expansion, LOCAL_PART is set to
20991 the local part of the address that was expanded. In both cases, any affixes are
20992 removed from the local part, and made available in LOCAL_PART_PREFIX and
20993 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
20994 same value as LOCAL_PART for compatibility with other MTAs.
20995
20996 .cindex "HOST"
20997 HOST is set only when a &(pipe)& transport is called from a router that
20998 associates hosts with an address, typically when using &(pipe)& as a
20999 pseudo-remote transport. HOST is set to the first host name specified by
21000 the router.
21001
21002 .cindex "HOME"
21003 If the transport's generic &%home_directory%& option is set, its value is used
21004 for the HOME environment variable. Otherwise, a home directory may be set
21005 by the router's &%transport_home_directory%& option, which defaults to the
21006 user's home directory if &%check_local_user%& is set.
21007
21008
21009 .section "Private options for pipe" "SECID142"
21010 .cindex "options" "&(pipe)& transport"
21011
21012
21013
21014 .option allow_commands pipe "string list&!!" unset
21015 .cindex "&(pipe)& transport" "permitted commands"
21016 The string is expanded, and is then interpreted as a colon-separated list of
21017 permitted commands. If &%restrict_to_path%& is not set, the only commands
21018 permitted are those in the &%allow_commands%& list. They need not be absolute
21019 paths; the &%path%& option is still used for relative paths. If
21020 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
21021 in the &%allow_commands%& list, or a name without any slashes that is found on
21022 the path. In other words, if neither &%allow_commands%& nor
21023 &%restrict_to_path%& is set, there is no restriction on the command, but
21024 otherwise only commands that are permitted by one or the other are allowed. For
21025 example, if
21026 .code
21027 allow_commands = /usr/bin/vacation
21028 .endd
21029 and &%restrict_to_path%& is not set, the only permitted command is
21030 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
21031 &%use_shell%& is set.
21032
21033
21034 .option batch_id pipe string&!! unset
21035 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21036
21037
21038 .option batch_max pipe integer 1
21039 This limits the number of addresses that can be handled in a single delivery.
21040 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21041
21042
21043 .option check_string pipe string unset
21044 As &(pipe)& writes the message, the start of each line is tested for matching
21045 &%check_string%&, and if it does, the initial matching characters are replaced
21046 by the contents of &%escape_string%&, provided both are set. The value of
21047 &%check_string%& is a literal string, not a regular expression, and the case of
21048 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
21049 of &%check_string%& and &%escape_string%& are forced to values that implement
21050 the SMTP escaping protocol. Any settings made in the configuration file are
21051 ignored.
21052
21053
21054 .option command pipe string&!! unset
21055 This option need not be set when &(pipe)& is being used to deliver to pipes
21056 obtained directly from address redirections. In other cases, the option must be
21057 set, to provide a command to be run. It need not yield an absolute path (see
21058 the &%path%& option below). The command is split up into separate arguments by
21059 Exim, and each argument is separately expanded, as described in section
21060 &<<SECThowcommandrun>>& above.
21061
21062
21063 .option environment pipe string&!! unset
21064 .cindex "&(pipe)& transport" "environment for command"
21065 .cindex "environment for &(pipe)& transport"
21066 This option is used to add additional variables to the environment in which the
21067 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
21068 a string which is expanded, and then interpreted as a colon-separated list of
21069 environment settings of the form <&'name'&>=<&'value'&>.
21070
21071
21072 .option escape_string pipe string unset
21073 See &%check_string%& above.
21074
21075
21076 .option freeze_exec_fail pipe boolean false
21077 .cindex "exec failure"
21078 .cindex "failure of exec"
21079 .cindex "&(pipe)& transport" "failure of exec"
21080 Failure to exec the command in a pipe transport is by default treated like
21081 any other failure while running the command. However, if &%freeze_exec_fail%&
21082 is set, failure to exec is treated specially, and causes the message to be
21083 frozen, whatever the setting of &%ignore_status%&.
21084
21085
21086 .option ignore_status pipe boolean false
21087 If this option is true, the status returned by the subprocess that is set up to
21088 run the command is ignored, and Exim behaves as if zero had been returned.
21089 Otherwise, a non-zero status or termination by signal causes an error return
21090 from the transport unless the status value is one of those listed in
21091 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
21092
21093 &*Note*&: This option does not apply to timeouts, which do not return a status.
21094 See the &%timeout_defer%& option for how timeouts are handled.
21095
21096 .option log_defer_output pipe boolean false
21097 .cindex "&(pipe)& transport" "logging output"
21098 If this option is set, and the status returned by the command is
21099 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
21100 and any output was produced, the first line of it is written to the main log.
21101
21102
21103 .option log_fail_output pipe boolean false
21104 If this option is set, and the command returns any output, and also ends with a
21105 return code that is neither zero nor one of the return codes listed in
21106 &%temp_errors%& (that is, the delivery failed), the first line of output is
21107 written to the main log. This option and &%log_output%& are mutually exclusive.
21108 Only one of them may be set.
21109
21110
21111
21112 .option log_output pipe boolean false
21113 If this option is set and the command returns any output, the first line of
21114 output is written to the main log, whatever the return code. This option and
21115 &%log_fail_output%& are mutually exclusive. Only one of them may be set.
21116
21117
21118
21119 .option max_output pipe integer 20K
21120 This specifies the maximum amount of output that the command may produce on its
21121 standard output and standard error file combined. If the limit is exceeded, the
21122 process running the command is killed. This is intended as a safety measure to
21123 catch runaway processes. The limit is applied independently of the settings of
21124 the options that control what is done with such output (for example,
21125 &%return_output%&). Because of buffering effects, the amount of output may
21126 exceed the limit by a small amount before Exim notices.
21127
21128
21129 .option message_prefix pipe string&!! "see below"
21130 The string specified here is expanded and output at the start of every message.
21131 The default is unset if &%use_bsmtp%& is set. Otherwise it is
21132 .code
21133 message_prefix = \
21134   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
21135   ${tod_bsdinbox}\n
21136 .endd
21137 .cindex "Cyrus"
21138 .cindex "&%tmail%&"
21139 .cindex "&""From""& line"
21140 This is required by the commonly used &_/usr/bin/vacation_& program.
21141 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
21142 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
21143 setting
21144 .code
21145 message_prefix =
21146 .endd
21147 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21148 &`\n`& to &`\r\n`& in &%message_prefix%&.
21149
21150
21151 .option message_suffix pipe string&!! "see below"
21152 The string specified here is expanded and output at the end of every message.
21153 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
21154 The suffix can be suppressed by setting
21155 .code
21156 message_suffix =
21157 .endd
21158 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21159 &`\n`& to &`\r\n`& in &%message_suffix%&.
21160
21161
21162 .option path pipe string "see below"
21163 This option specifies the string that is set up in the PATH environment
21164 variable of the subprocess. The default is:
21165 .code
21166 /bin:/usr/bin
21167 .endd
21168 If the &%command%& option does not yield an absolute path name, the command is
21169 sought in the PATH directories, in the usual way. &*Warning*&: This does not
21170 apply to a command specified as a transport filter.
21171
21172
21173 .option permit_coredump pipe boolean false
21174 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
21175 a core-dump of a pipe command, enable this command.  This enables core-dumps
21176 during delivery and affects both the Exim binary and the pipe command run.
21177 It is recommended that this option remain off unless and until you have a need
21178 for it and that this only be enabled when needed, as the risk of excessive
21179 resource consumption can be quite high.  Note also that Exim is typically
21180 installed as a setuid binary and most operating systems will inhibit coredumps
21181 of these by default, so further OS-specific action may be required.
21182
21183
21184 .option pipe_as_creator pipe boolean false
21185 .cindex "uid (user id)" "local delivery"
21186 If the generic &%user%& option is not set and this option is true, the delivery
21187 process is run under the uid that was in force when Exim was originally called
21188 to accept the message. If the group id is not otherwise set (via the generic
21189 &%group%& option), the gid that was in force when Exim was originally called to
21190 accept the message is used.
21191
21192
21193 .option restrict_to_path pipe boolean false
21194 When this option is set, any command name not listed in &%allow_commands%& must
21195 contain no slashes. The command is searched for only in the directories listed
21196 in the &%path%& option. This option is intended for use in the case when a pipe
21197 command has been generated from a user's &_.forward_& file. This is usually
21198 handled by a &(pipe)& transport called &%address_pipe%&.
21199
21200
21201 .option return_fail_output pipe boolean false
21202 If this option is true, and the command produced any output and ended with a
21203 return code other than zero or one of the codes listed in &%temp_errors%& (that
21204 is, the delivery failed), the output is returned in the bounce message.
21205 However, if the message has a null sender (that is, it is itself a bounce
21206 message), output from the command is discarded. This option and
21207 &%return_output%& are mutually exclusive. Only one of them may be set.
21208
21209
21210
21211 .option return_output pipe boolean false
21212 If this option is true, and the command produced any output, the delivery is
21213 deemed to have failed whatever the return code from the command, and the output
21214 is returned in the bounce message. Otherwise, the output is just discarded.
21215 However, if the message has a null sender (that is, it is a bounce message),
21216 output from the command is always discarded, whatever the setting of this
21217 option. This option and &%return_fail_output%& are mutually exclusive. Only one
21218 of them may be set.
21219
21220
21221
21222 .option temp_errors pipe "string list" "see below"
21223 .cindex "&(pipe)& transport" "temporary failure"
21224 This option contains either a colon-separated list of numbers, or a single
21225 asterisk. If &%ignore_status%& is false
21226 and &%return_output%& is not set,
21227 and the command exits with a non-zero return code, the failure is treated as
21228 temporary and the delivery is deferred if the return code matches one of the
21229 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
21230 codes are treated as permanent errors. The default setting contains the codes
21231 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
21232 compiled on a system that does not define these macros, it assumes values of 75
21233 and 73, respectively.
21234
21235
21236 .option timeout pipe time 1h
21237 If the command fails to complete within this time, it is killed. This normally
21238 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
21239 specifies no timeout. In order to ensure that any subprocesses created by the
21240 command are also killed, Exim makes the initial process a process group leader,
21241 and kills the whole process group on a timeout. However, this can be defeated
21242 if one of the processes starts a new process group.
21243
21244 .option timeout_defer pipe boolean false
21245 A timeout in a &(pipe)& transport, either in the command that the transport
21246 runs, or in a transport filter that is associated with it, is by default
21247 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
21248 is set true, both kinds of timeout become temporary errors, causing the
21249 delivery to be deferred.
21250
21251 .option umask pipe "octal integer" 022
21252 This specifies the umask setting for the subprocess that runs the command.
21253
21254
21255 .option use_bsmtp pipe boolean false
21256 .cindex "envelope sender"
21257 If this option is set true, the &(pipe)& transport writes messages in &"batch
21258 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
21259 commands. If you want to include a leading HELO command with such messages,
21260 you can do so by setting the &%message_prefix%& option. See section
21261 &<<SECTbatchSMTP>>& for details of batch SMTP.
21262
21263 .option use_classresources pipe boolean false
21264 .cindex "class resources (BSD)"
21265 This option is available only when Exim is running on FreeBSD, NetBSD, or
21266 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
21267 resource limits when a &(pipe)& transport is run to perform a delivery. The
21268 limits for the uid under which the pipe is to run are obtained from the login
21269 class database.
21270
21271
21272 .option use_crlf pipe boolean false
21273 .cindex "carriage return"
21274 .cindex "linefeed"
21275 This option causes lines to be terminated with the two-character CRLF sequence
21276 (carriage return, linefeed) instead of just a linefeed character. In the case
21277 of batched SMTP, the byte sequence written to the pipe is then an exact image
21278 of what would be sent down a real SMTP connection.
21279
21280 The contents of the &%message_prefix%& and &%message_suffix%& options are
21281 written verbatim, so must contain their own carriage return characters if these
21282 are needed. When &%use_bsmtp%& is not set, the default values for both
21283 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
21284 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
21285
21286
21287 .option use_shell pipe boolean false
21288 .vindex "&$pipe_addresses$&"
21289 If this option is set, it causes the command to be passed to &_/bin/sh_&
21290 instead of being run directly from the transport, as described in section
21291 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
21292 where the command is expected to be run under a shell and cannot easily be
21293 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
21294 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
21295 command is expanded as a single string, and handed to &_/bin/sh_& as data for
21296 its &%-c%& option.
21297
21298
21299
21300 .section "Using an external local delivery agent" "SECID143"
21301 .cindex "local delivery" "using an external agent"
21302 .cindex "&'procmail'&"
21303 .cindex "external local delivery"
21304 .cindex "delivery" "&'procmail'&"
21305 .cindex "delivery" "by external agent"
21306 The &(pipe)& transport can be used to pass all messages that require local
21307 delivery to a separate local delivery agent such as &%procmail%&. When doing
21308 this, care must be taken to ensure that the pipe is run under an appropriate
21309 uid and gid. In some configurations one wants this to be a uid that is trusted
21310 by the delivery agent to supply the correct sender of the message. It may be
21311 necessary to recompile or reconfigure the delivery agent so that it trusts an
21312 appropriate user. The following is an example transport and router
21313 configuration for &%procmail%&:
21314 .code
21315 # transport
21316 procmail_pipe:
21317   driver = pipe
21318   command = /usr/local/bin/procmail -d $local_part
21319   return_path_add
21320   delivery_date_add
21321   envelope_to_add
21322   check_string = "From "
21323   escape_string = ">From "
21324   umask = 077
21325   user = $local_part
21326   group = mail
21327
21328 # router
21329 procmail:
21330   driver = accept
21331   check_local_user
21332   transport = procmail_pipe
21333 .endd
21334 In this example, the pipe is run as the local user, but with the group set to
21335 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
21336 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
21337 user to supply a correct sender address. If you do not specify either a
21338 &%group%& or a &%user%& option, the pipe command is run as the local user. The
21339 home directory is the user's home directory by default.
21340
21341 &*Note*&: The command that the pipe transport runs does &'not'& begin with
21342 .code
21343 IFS=" "
21344 .endd
21345 as shown in some &%procmail%& documentation, because Exim does not by default
21346 use a shell to run pipe commands.
21347
21348 .cindex "Cyrus"
21349 The next example shows a transport and a router for a system where local
21350 deliveries are handled by the Cyrus IMAP server.
21351 .code
21352 # transport
21353 local_delivery_cyrus:
21354   driver = pipe
21355   command = /usr/cyrus/bin/deliver \
21356             -m ${substr_1:$local_part_suffix} -- $local_part
21357   user = cyrus
21358   group = mail
21359   return_output
21360   log_output
21361   message_prefix =
21362   message_suffix =
21363
21364 # router
21365 local_user_cyrus:
21366   driver = accept
21367   check_local_user
21368   local_part_suffix = .*
21369   transport = local_delivery_cyrus
21370 .endd
21371 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
21372 &%return_output%& to cause any text written by Cyrus to be returned to the
21373 sender.
21374 .ecindex IIDpiptra1
21375 .ecindex IIDpiptra2
21376
21377
21378 . ////////////////////////////////////////////////////////////////////////////
21379 . ////////////////////////////////////////////////////////////////////////////
21380
21381 .chapter "The smtp transport" "CHAPsmtptrans"
21382 .scindex IIDsmttra1 "transports" "&(smtp)&"
21383 .scindex IIDsmttra2 "&(smtp)& transport"
21384 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
21385 or LMTP protocol. The list of hosts to try can either be taken from the address
21386 that is being processed (having been set up by the router), or specified
21387 explicitly for the transport. Timeout and retry processing (see chapter
21388 &<<CHAPretry>>&) is applied to each IP address independently.
21389
21390
21391 .section "Multiple messages on a single connection" "SECID144"
21392 The sending of multiple messages over a single TCP/IP connection can arise in
21393 two ways:
21394
21395 .ilist
21396 If a message contains more than &%max_rcpt%& (see below) addresses that are
21397 routed to the same host, more than one copy of the message has to be sent to
21398 that host. In this situation, multiple copies may be sent in a single run of
21399 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
21400 does when it has too many addresses to send in one message also depends on the
21401 value of the global &%remote_max_parallel%& option. Details are given in
21402 section &<<SECToutSMTPTCP>>&.)
21403 .next
21404 .cindex "hints database" "remembering routing"
21405 When a message has been successfully delivered over a TCP/IP connection, Exim
21406 looks in its hints database to see if there are any other messages awaiting a
21407 connection to the same host. If there are, a new delivery process is started
21408 for one of them, and the current TCP/IP connection is passed on to it. The new
21409 process may in turn send multiple copies and possibly create yet another
21410 process.
21411 .endlist
21412
21413
21414 For each copy sent over the same TCP/IP connection, a sequence counter is
21415 incremented, and if it ever gets to the value of &%connection_max_messages%&,
21416 no further messages are sent over that connection.
21417
21418
21419
21420 .section "Use of the $host and $host_address variables" "SECID145"
21421 .vindex "&$host$&"
21422 .vindex "&$host_address$&"
21423 At the start of a run of the &(smtp)& transport, the values of &$host$& and
21424 &$host_address$& are the name and IP address of the first host on the host list
21425 passed by the router. However, when the transport is about to connect to a
21426 specific host, and while it is connected to that host, &$host$& and
21427 &$host_address$& are set to the values for that host. These are the values
21428 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
21429 &%serialize_hosts%&, and the various TLS options are expanded.
21430
21431
21432 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
21433 .vindex &$tls_cipher$&
21434 .vindex &$tls_peerdn$&
21435 At the start of a run of the &(smtp)& transport, the values of &$tls_cipher$&
21436 and &$tls_peerdn$& are the values that were set when the message was received.
21437 These are the values that are used for options that are expanded before any
21438 SMTP connections are made. Just before each connection is made, these two
21439 variables are emptied. If TLS is subsequently started, they are set to the
21440 appropriate values for the outgoing connection, and these are the values that
21441 are in force when any authenticators are run and when the
21442 &%authenticated_sender%& option is expanded.
21443
21444
21445 .section "Private options for smtp" "SECID146"
21446 .cindex "options" "&(smtp)& transport"
21447 The private options of the &(smtp)& transport are as follows:
21448
21449
21450 .option address_retry_include_sender smtp boolean true
21451 .cindex "4&'xx'& responses" "retrying after"
21452 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
21453 is the combination of sender and recipient that is delayed in subsequent queue
21454 runs until the retry time is reached. You can delay the recipient without
21455 reference to the sender (which is what earlier versions of Exim did), by
21456 setting &%address_retry_include_sender%& false. However, this can lead to
21457 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
21458
21459 .option allow_localhost smtp boolean false
21460 .cindex "local host" "sending to"
21461 .cindex "fallback" "hosts specified on transport"
21462 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
21463 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
21464 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
21465 the delivery anyway. This should be used only in special cases when the
21466 configuration ensures that no looping will result (for example, a differently
21467 configured Exim is listening on the port to which the message is sent).
21468
21469
21470 .option authenticated_sender smtp string&!! unset
21471 .cindex "Cyrus"
21472 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
21473 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
21474 overriding any existing authenticated sender value. If the string expansion is
21475 forced to fail, the option is ignored. Other expansion failures cause delivery
21476 to be deferred. If the result of expansion is an empty string, that is also
21477 ignored.
21478
21479 The expansion happens after the outgoing connection has been made and TLS
21480 started, if required. This means that the &$host$&, &$host_address$&,
21481 &$tls_cipher$&, and &$tls_peerdn$& variables are set according to the
21482 particular connection.
21483
21484 If the SMTP session is not authenticated, the expansion of
21485 &%authenticated_sender%& still happens (and can cause the delivery to be
21486 deferred if it fails), but no AUTH= item is added to MAIL commands
21487 unless &%authenticated_sender_force%& is true.
21488
21489 This option allows you to use the &(smtp)& transport in LMTP mode to
21490 deliver mail to Cyrus IMAP and provide the proper local part as the
21491 &"authenticated sender"&, via a setting such as:
21492 .code
21493 authenticated_sender = $local_part
21494 .endd
21495 This removes the need for IMAP subfolders to be assigned special ACLs to
21496 allow direct delivery to those subfolders.
21497
21498 Because of expected uses such as that just described for Cyrus (when no
21499 domain is involved), there is no checking on the syntax of the provided
21500 value.
21501
21502
21503 .option authenticated_sender_force smtp boolean false
21504 If this option is set true, the &%authenticated_sender%& option's value
21505 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
21506 authenticated as a client.
21507
21508
21509 .option command_timeout smtp time 5m
21510 This sets a timeout for receiving a response to an SMTP command that has been
21511 sent out. It is also used when waiting for the initial banner line from the
21512 remote host. Its value must not be zero.
21513
21514
21515 .option connect_timeout smtp time 5m
21516 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
21517 to a remote host. A setting of zero allows the system timeout (typically
21518 several minutes) to act. To have any effect, the value of this option must be
21519 less than the system timeout. However, it has been observed that on some
21520 systems there is no system timeout, which is why the default value for this
21521 option is 5 minutes, a value recommended by RFC 1123.
21522
21523
21524 .option connection_max_messages smtp integer 500
21525 .cindex "SMTP" "passed connection"
21526 .cindex "SMTP" "multiple deliveries"
21527 .cindex "multiple SMTP deliveries"
21528 This controls the maximum number of separate message deliveries that are sent
21529 over a single TCP/IP connection. If the value is zero, there is no limit.
21530 For testing purposes, this value can be overridden by the &%-oB%& command line
21531 option.
21532
21533
21534 .option data_timeout smtp time 5m
21535 This sets a timeout for the transmission of each block in the data portion of
21536 the message. As a result, the overall timeout for a message depends on the size
21537 of the message. Its value must not be zero. See also &%final_timeout%&.
21538
21539
21540 .option delay_after_cutoff smtp boolean true
21541 This option controls what happens when all remote IP addresses for a given
21542 domain have been inaccessible for so long that they have passed their retry
21543 cutoff times.
21544
21545 In the default state, if the next retry time has not been reached for any of
21546 them, the address is bounced without trying any deliveries. In other words,
21547 Exim delays retrying an IP address after the final cutoff time until a new
21548 retry time is reached, and can therefore bounce an address without ever trying
21549 a delivery, when machines have been down for a long time. Some people are
21550 unhappy at this prospect, so...
21551
21552 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
21553 addresses are past their final cutoff time, Exim tries to deliver to those
21554 IP addresses that have not been tried since the message arrived. If there are
21555 none, of if they all fail, the address is bounced. In other words, it does not
21556 delay when a new message arrives, but immediately tries those expired IP
21557 addresses that haven't been tried since the message arrived. If there is a
21558 continuous stream of messages for the dead hosts, unsetting
21559 &%delay_after_cutoff%& means that there will be many more attempts to deliver
21560 to them.
21561
21562
21563 .option dns_qualify_single smtp boolean true
21564 If the &%hosts%& or &%fallback_hosts%& option is being used,
21565 and the &%gethostbyname%& option is false,
21566 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
21567 in chapter &<<CHAPdnslookup>>& for more details.
21568
21569
21570 .option dns_search_parents smtp boolean false
21571 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
21572 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
21573 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
21574 details.
21575
21576
21577
21578 .option fallback_hosts smtp "string list" unset
21579 .cindex "fallback" "hosts specified on transport"
21580 String expansion is not applied to this option. The argument must be a
21581 colon-separated list of host names or IP addresses, optionally also including
21582 port numbers, though the separator can be changed, as described in section
21583 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
21584 item in a &%route_list%& setting for the &(manualroute)& router, as described
21585 in section &<<SECTformatonehostitem>>&.
21586
21587 Fallback hosts can also be specified on routers, which associate them with the
21588 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
21589 &%fallback_hosts%& specified on the transport is used only if the address does
21590 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
21591 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
21592 However, &%hosts_randomize%& does apply to fallback host lists.
21593
21594 If Exim is unable to deliver to any of the hosts for a particular address, and
21595 the errors are not permanent rejections, the address is put on a separate
21596 transport queue with its host list replaced by the fallback hosts, unless the
21597 address was routed via MX records and the current host was in the original MX
21598 list. In that situation, the fallback host list is not used.
21599
21600 Once normal deliveries are complete, the fallback queue is delivered by
21601 re-running the same transports with the new host lists. If several failing
21602 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
21603 copy of the message is sent.
21604
21605 The resolution of the host names on the fallback list is controlled by the
21606 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
21607 both to cases when the host list comes with the address and when it is taken
21608 from &%hosts%&. This option provides a &"use a smart host only if delivery
21609 fails"& facility.
21610
21611
21612 .option final_timeout smtp time 10m
21613 This is the timeout that applies while waiting for the response to the final
21614 line containing just &"."& that terminates a message. Its value must not be
21615 zero.
21616
21617 .option gethostbyname smtp boolean false
21618 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
21619 being used, names are looked up using &[gethostbyname()]&
21620 (or &[getipnodebyname()]& when available)
21621 instead of using the DNS. Of course, that function may in fact use the DNS, but
21622 it may also consult other sources of information such as &_/etc/hosts_&.
21623
21624 .option gnutls_require_kx smtp string unset
21625 This option controls the key exchange mechanisms when GnuTLS is used in an Exim
21626 client. For details, see section &<<SECTreqciphgnu>>&.
21627
21628 .option gnutls_require_mac smtp string unset
21629 This option controls the MAC algorithms when GnuTLS is used in an Exim
21630 client. For details, see section &<<SECTreqciphgnu>>&.
21631
21632 .option gnutls_require_protocols smtp string unset
21633 This option controls the protocols when GnuTLS is used in an Exim
21634 client. For details, see section &<<SECTreqciphgnu>>&.
21635
21636 .option gnutls_compat_mode smtp boolean unset
21637 This option controls whether GnuTLS is used in compatibility mode in an Exim
21638 server. This reduces security slightly, but improves interworking with older
21639 implementations of TLS.
21640
21641 .option helo_data smtp string&!! "see below"
21642 .cindex "HELO" "argument, setting"
21643 .cindex "EHLO" "argument, setting"
21644 .cindex "LHLO argument setting"
21645 The value of this option is expanded after a connection to a another host has
21646 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
21647 command that starts the outgoing SMTP or LMTP session. The default value of the
21648 option is:
21649 .code
21650 $primary_hostname
21651 .endd
21652 During the expansion, the variables &$host$& and &$host_address$& are set to
21653 the identity of the remote host, and the variables &$sending_ip_address$& and
21654 &$sending_port$& are set to the local IP address and port number that are being
21655 used. These variables can be used to generate different values for different
21656 servers or different local IP addresses. For example, if you want the string
21657 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
21658 interface address, you could use this:
21659 .code
21660 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
21661   {$primary_hostname}}
21662 .endd
21663 The use of &%helo_data%& applies both to sending messages and when doing
21664 callouts.
21665
21666 .option hosts smtp "string list&!!" unset
21667 Hosts are associated with an address by a router such as &(dnslookup)&, which
21668 finds the hosts by looking up the address domain in the DNS, or by
21669 &(manualroute)&, which has lists of hosts in its configuration. However,
21670 email addresses can be passed to the &(smtp)& transport by any router, and not
21671 all of them can provide an associated list of hosts.
21672
21673 The &%hosts%& option specifies a list of hosts to be used if the address being
21674 processed does not have any hosts associated with it. The hosts specified by
21675 &%hosts%& are also used, whether or not the address has its own hosts, if
21676 &%hosts_override%& is set.
21677
21678 The string is first expanded, before being interpreted as a colon-separated
21679 list of host names or IP addresses, possibly including port numbers. The
21680 separator may be changed to something other than colon, as described in section
21681 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
21682 item in a &%route_list%& setting for the &(manualroute)& router, as described
21683 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
21684 of the &(manualroute)& router is not available here.
21685
21686 If the expansion fails, delivery is deferred. Unless the failure was caused by
21687 the inability to complete a lookup, the error is logged to the panic log as
21688 well as the main log. Host names are looked up either by searching directly for
21689 address records in the DNS or by calling &[gethostbyname()]& (or
21690 &[getipnodebyname()]& when available), depending on the setting of the
21691 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
21692 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
21693 address are used.
21694
21695 During delivery, the hosts are tried in order, subject to their retry status,
21696 unless &%hosts_randomize%& is set.
21697
21698
21699 .option hosts_avoid_esmtp smtp "host list&!!" unset
21700 .cindex "ESMTP, avoiding use of"
21701 .cindex "HELO" "forcing use of"
21702 .cindex "EHLO" "avoiding use of"
21703 .cindex "PIPELINING" "avoiding the use of"
21704 This option is for use with broken hosts that announce ESMTP facilities (for
21705 example, PIPELINING) and then fail to implement them properly. When a host
21706 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
21707 start of the SMTP session. This means that it cannot use any of the ESMTP
21708 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
21709
21710
21711 .option hosts_avoid_pipelining smtp "host list&!!" unset
21712 .cindex "PIPELINING" "avoiding the use of"
21713 Exim will not use the SMTP PIPELINING extension when delivering to any host
21714 that matches this list, even if the server host advertises PIPELINING support.
21715
21716
21717 .option hosts_avoid_tls smtp "host list&!!" unset
21718 .cindex "TLS" "avoiding for certain hosts"
21719 Exim will not try to start a TLS session when delivering to any host that
21720 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
21721
21722
21723 .option hosts_max_try smtp integer 5
21724 .cindex "host" "maximum number to try"
21725 .cindex "limit" "number of hosts tried"
21726 .cindex "limit" "number of MX tried"
21727 .cindex "MX record" "maximum tried"
21728 This option limits the number of IP addresses that are tried for any one
21729 delivery in cases where there are temporary delivery errors. Section
21730 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
21731
21732
21733 .option hosts_max_try_hardlimit smtp integer 50
21734 This is an additional check on the maximum number of IP addresses that Exim
21735 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
21736 why it exists.
21737
21738
21739
21740 .option hosts_nopass_tls smtp "host list&!!" unset
21741 .cindex "TLS" "passing connection"
21742 .cindex "multiple SMTP deliveries"
21743 .cindex "TLS" "multiple message deliveries"
21744 For any host that matches this list, a connection on which a TLS session has
21745 been started will not be passed to a new delivery process for sending another
21746 message on the same connection. See section &<<SECTmulmessam>>& for an
21747 explanation of when this might be needed.
21748
21749
21750 .option hosts_override smtp boolean false
21751 If this option is set and the &%hosts%& option is also set, any hosts that are
21752 attached to the address are ignored, and instead the hosts specified by the
21753 &%hosts%& option are always used. This option does not apply to
21754 &%fallback_hosts%&.
21755
21756
21757 .option hosts_randomize smtp boolean false
21758 .cindex "randomized host list"
21759 .cindex "host" "list of; randomized"
21760 .cindex "fallback" "randomized hosts"
21761 If this option is set, and either the list of hosts is taken from the
21762 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
21763 were not obtained from MX records (this includes fallback hosts from the
21764 router), and were not randomized by the router, the order of trying the hosts
21765 is randomized each time the transport runs. Randomizing the order of a host
21766 list can be used to do crude load sharing.
21767
21768 When &%hosts_randomize%& is true, a host list may be split into groups whose
21769 order is separately randomized. This makes it possible to set up MX-like
21770 behaviour. The boundaries between groups are indicated by an item that is just
21771 &`+`& in the host list. For example:
21772 .code
21773 hosts = host1:host2:host3:+:host4:host5
21774 .endd
21775 The order of the first three hosts and the order of the last two hosts is
21776 randomized for each use, but the first three always end up before the last two.
21777 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
21778
21779 .option hosts_require_auth smtp "host list&!!" unset
21780 .cindex "authentication" "required by client"
21781 This option provides a list of servers for which authentication must succeed
21782 before Exim will try to transfer a message. If authentication fails for
21783 servers which are not in this list, Exim tries to send unauthenticated. If
21784 authentication fails for one of these servers, delivery is deferred. This
21785 temporary error is detectable in the retry rules, so it can be turned into a
21786 hard failure if required. See also &%hosts_try_auth%&, and chapter
21787 &<<CHAPSMTPAUTH>>& for details of authentication.
21788
21789
21790 .option hosts_require_tls smtp "host list&!!" unset
21791 .cindex "TLS" "requiring for certain servers"
21792 Exim will insist on using a TLS session when delivering to any host that
21793 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
21794 &*Note*&: This option affects outgoing mail only. To insist on TLS for
21795 incoming messages, use an appropriate ACL.
21796
21797 .option hosts_try_auth smtp "host list&!!" unset
21798 .cindex "authentication" "optional in client"
21799 This option provides a list of servers to which, provided they announce
21800 authentication support, Exim will attempt to authenticate as a client when it
21801 connects. If authentication fails, Exim will try to transfer the message
21802 unauthenticated. See also &%hosts_require_auth%&, and chapter
21803 &<<CHAPSMTPAUTH>>& for details of authentication.
21804
21805 .option interface smtp "string list&!!" unset
21806 .cindex "bind IP address"
21807 .cindex "IP address" "binding"
21808 .vindex "&$host$&"
21809 .vindex "&$host_address$&"
21810 This option specifies which interface to bind to when making an outgoing SMTP
21811 call. The value is an IP address, not an interface name such as
21812 &`eth0`&. Do not confuse this with the interface address that was used when a
21813 message was received, which is in &$received_ip_address$&, formerly known as
21814 &$interface_address$&. The name was changed to minimize confusion with the
21815 outgoing interface address. There is no variable that contains an outgoing
21816 interface address because, unless it is set by this option, its value is
21817 unknown.
21818
21819 During the expansion of the &%interface%& option the variables &$host$& and
21820 &$host_address$& refer to the host to which a connection is about to be made
21821 during the expansion of the string. Forced expansion failure, or an empty
21822 string result causes the option to be ignored. Otherwise, after expansion, the
21823 string must be a list of IP addresses, colon-separated by default, but the
21824 separator can be changed in the usual way. For example:
21825 .code
21826 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
21827 .endd
21828 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
21829 connection. If none of them are the correct type, the option is ignored. If
21830 &%interface%& is not set, or is ignored, the system's IP functions choose which
21831 interface to use if the host has more than one.
21832
21833
21834 .option keepalive smtp boolean true
21835 .cindex "keepalive" "on outgoing connection"
21836 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
21837 connections. When set, it causes the kernel to probe idle connections
21838 periodically, by sending packets with &"old"& sequence numbers. The other end
21839 of the connection should send a acknowledgment if the connection is still okay
21840 or a reset if the connection has been aborted. The reason for doing this is
21841 that it has the beneficial effect of freeing up certain types of connection
21842 that can get stuck when the remote host is disconnected without tidying up the
21843 TCP/IP call properly. The keepalive mechanism takes several hours to detect
21844 unreachable hosts.
21845
21846
21847 .option lmtp_ignore_quota smtp boolean false
21848 .cindex "LMTP" "ignoring quota errors"
21849 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
21850 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
21851 has advertised support for IGNOREQUOTA in its response to the LHLO command.
21852
21853 .option max_rcpt smtp integer 100
21854 .cindex "RCPT" "maximum number of outgoing"
21855 This option limits the number of RCPT commands that are sent in a single
21856 SMTP message transaction. Each set of addresses is treated independently, and
21857 so can cause parallel connections to the same host if &%remote_max_parallel%&
21858 permits this.
21859
21860
21861 .option multi_domain smtp boolean true
21862 .vindex "&$domain$&"
21863 When this option is set, the &(smtp)& transport can handle a number of
21864 addresses containing a mixture of different domains provided they all resolve
21865 to the same list of hosts. Turning the option off restricts the transport to
21866 handling only one domain at a time. This is useful if you want to use
21867 &$domain$& in an expansion for the transport, because it is set only when there
21868 is a single domain involved in a remote delivery.
21869
21870
21871 .option port smtp string&!! "see below"
21872 .cindex "port" "sending TCP/IP"
21873 .cindex "TCP/IP" "setting outgoing port"
21874 This option specifies the TCP/IP port on the server to which Exim connects.
21875 &*Note:*& Do not confuse this with the port that was used when a message was
21876 received, which is in &$received_port$&, formerly known as &$interface_port$&.
21877 The name was changed to minimize confusion with the outgoing port. There is no
21878 variable that contains an outgoing port.
21879
21880 If the value of this option begins with a digit it is taken as a port number;
21881 otherwise it is looked up using &[getservbyname()]&. The default value is
21882 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
21883 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
21884 is deferred.
21885
21886
21887
21888 .option protocol smtp string smtp
21889 .cindex "LMTP" "over TCP/IP"
21890 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
21891 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
21892 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
21893 deliveries into closed message stores. Exim also has support for running LMTP
21894 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
21895
21896
21897 .option retry_include_ip_address smtp boolean true
21898 Exim normally includes both the host name and the IP address in the key it
21899 constructs for indexing retry data after a temporary delivery failure. This
21900 means that when one of several IP addresses for a host is failing, it gets
21901 tried periodically (controlled by the retry rules), but use of the other IP
21902 addresses is not affected.
21903
21904 However, in some dialup environments hosts are assigned a different IP address
21905 each time they connect. In this situation the use of the IP address as part of
21906 the retry key leads to undesirable behaviour. Setting this option false causes
21907 Exim to use only the host name. This should normally be done on a separate
21908 instance of the &(smtp)& transport, set up specially to handle the dialup
21909 hosts.
21910
21911
21912 .option serialize_hosts smtp "host list&!!" unset
21913 .cindex "serializing connections"
21914 .cindex "host" "serializing connections"
21915 Because Exim operates in a distributed manner, if several messages for the same
21916 host arrive at around the same time, more than one simultaneous connection to
21917 the remote host can occur. This is not usually a problem except when there is a
21918 slow link between the hosts. In that situation it may be helpful to restrict
21919 Exim to one connection at a time. This can be done by setting
21920 &%serialize_hosts%& to match the relevant hosts.
21921
21922 .cindex "hints database" "serializing deliveries to a host"
21923 Exim implements serialization by means of a hints database in which a record is
21924 written whenever a process connects to one of the restricted hosts. The record
21925 is deleted when the connection is completed. Obviously there is scope for
21926 records to get left lying around if there is a system or program crash. To
21927 guard against this, Exim ignores any records that are more than six hours old.
21928
21929 If you set up this kind of serialization, you should also arrange to delete the
21930 relevant hints database whenever your system reboots. The names of the files
21931 start with &_misc_& and they are kept in the &_spool/db_& directory. There
21932 may be one or two files, depending on the type of DBM in use. The same files
21933 are used for ETRN serialization.
21934
21935
21936 .option size_addition smtp integer 1024
21937 .cindex "SMTP" "SIZE"
21938 .cindex "message" "size issue for transport filter"
21939 .cindex "size" "of message"
21940 .cindex "transport" "filter"
21941 .cindex "filter" "transport filter"
21942 If a remote SMTP server indicates that it supports the SIZE option of the
21943 MAIL command, Exim uses this to pass over the message size at the start of
21944 an SMTP transaction. It adds the value of &%size_addition%& to the value it
21945 sends, to allow for headers and other text that may be added during delivery by
21946 configuration options or in a transport filter. It may be necessary to increase
21947 this if a lot of text is added to messages.
21948
21949 Alternatively, if the value of &%size_addition%& is set negative, it disables
21950 the use of the SIZE option altogether.
21951
21952
21953 .option tls_certificate smtp string&!! unset
21954 .cindex "TLS" "client certificate, location of"
21955 .cindex "certificate" "client, location of"
21956 .vindex "&$host$&"
21957 .vindex "&$host_address$&"
21958 The value of this option must be the absolute path to a file which contains the
21959 client's certificate, for possible use when sending a message over an encrypted
21960 connection. The values of &$host$& and &$host_address$& are set to the name and
21961 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
21962 details of TLS.
21963
21964 &*Note*&: This option must be set if you want Exim to be able to use a TLS
21965 certificate when sending messages as a client. The global option of the same
21966 name specifies the certificate for Exim as a server; it is not automatically
21967 assumed that the same certificate should be used when Exim is operating as a
21968 client.
21969
21970
21971 .option tls_crl smtp string&!! unset
21972 .cindex "TLS" "client certificate revocation list"
21973 .cindex "certificate" "revocation list for client"
21974 This option specifies a certificate revocation list. The expanded value must
21975 be the name of a file that contains a CRL in PEM format.
21976
21977
21978 .option tls_privatekey smtp string&!! unset
21979 .cindex "TLS" "client private key, location of"
21980 .vindex "&$host$&"
21981 .vindex "&$host_address$&"
21982 The value of this option must be the absolute path to a file which contains the
21983 client's private key. This is used when sending a message over an encrypted
21984 connection using a client certificate. The values of &$host$& and
21985 &$host_address$& are set to the name and address of the server during the
21986 expansion. If this option is unset, or the expansion is forced to fail, or the
21987 result is an empty string, the private key is assumed to be in the same file as
21988 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
21989
21990
21991 .option tls_require_ciphers smtp string&!! unset
21992 .cindex "TLS" "requiring specific ciphers"
21993 .cindex "cipher" "requiring specific"
21994 .vindex "&$host$&"
21995 .vindex "&$host_address$&"
21996 The value of this option must be a list of permitted cipher suites, for use
21997 when setting up an outgoing encrypted connection. (There is a global option of
21998 the same name for controlling incoming connections.) The values of &$host$& and
21999 &$host_address$& are set to the name and address of the server during the
22000 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
22001 is used in different ways by OpenSSL and GnuTLS (see sections
22002 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
22003 ciphers is a preference order.
22004
22005
22006
22007 .option tls_tempfail_tryclear smtp boolean true
22008 .cindex "4&'xx'& responses" "to STARTTLS"
22009 When the server host is not in &%hosts_require_tls%&, and there is a problem in
22010 setting up a TLS session, this option determines whether or not Exim should try
22011 to deliver the message unencrypted. If it is set false, delivery to the
22012 current host is deferred; if there are other hosts, they are tried. If this
22013 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
22014 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
22015 TLS negotiation fails, Exim closes the current connection (because it is in an
22016 unknown state), opens a new one to the same host, and then tries the delivery
22017 in clear.
22018
22019
22020 .option tls_verify_certificates smtp string&!! unset
22021 .cindex "TLS" "server certificate verification"
22022 .cindex "certificate" "verification of server"
22023 .vindex "&$host$&"
22024 .vindex "&$host_address$&"
22025 The value of this option must be the absolute path to a file containing
22026 permitted server certificates, for use when setting up an encrypted connection.
22027 Alternatively, if you are using OpenSSL, you can set
22028 &%tls_verify_certificates%& to the name of a directory containing certificate
22029 files. This does not work with GnuTLS; the option must be set to the name of a
22030 single file if you are using GnuTLS. The values of &$host$& and
22031 &$host_address$& are set to the name and address of the server during the
22032 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
22033
22034
22035
22036
22037 .section "How the limits for the number of hosts to try are used" &&&
22038          "SECTvalhosmax"
22039 .cindex "host" "maximum number to try"
22040 .cindex "limit" "hosts; maximum number tried"
22041 There are two options that are concerned with the number of hosts that are
22042 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
22043 &%hosts_max_try_hardlimit%&.
22044
22045
22046 The &%hosts_max_try%& option limits the number of hosts that are tried
22047 for a single delivery. However, despite the term &"host"& in its name, the
22048 option actually applies to each IP address independently. In other words, a
22049 multihomed host is treated as several independent hosts, just as it is for
22050 retrying.
22051
22052 Many of the larger ISPs have multiple MX records which often point to
22053 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
22054 created as a result of routing one of these domains.
22055
22056 Trying every single IP address on such a long list does not seem sensible; if
22057 several at the top of the list fail, it is reasonable to assume there is some
22058 problem that is likely to affect all of them. Roughly speaking, the value of
22059 &%hosts_max_try%& is the maximum number that are tried before deferring the
22060 delivery. However, the logic cannot be quite that simple.
22061
22062 Firstly, IP addresses that are skipped because their retry times have not
22063 arrived do not count, and in addition, addresses that are past their retry
22064 limits are also not counted, even when they are tried. This means that when
22065 some IP addresses are past their retry limits, more than the value of
22066 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
22067 that all IP addresses are considered before timing out an email address (but
22068 see below for an exception).
22069
22070 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
22071 list to see if there is a subsequent host with a different (higher valued) MX.
22072 If there is, that host is considered next, and the current IP address is used
22073 but not counted. This behaviour helps in the case of a domain with a retry rule
22074 that hardly ever delays any hosts, as is now explained:
22075
22076 Consider the case of a long list of hosts with one MX value, and a few with a
22077 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
22078 hosts at the top of the list are tried at first. With the default retry rule,
22079 which specifies increasing retry times, the higher MX hosts are eventually
22080 tried when those at the top of the list are skipped because they have not
22081 reached their retry times.
22082
22083 However, it is common practice to put a fixed short retry time on domains for
22084 large ISPs, on the grounds that their servers are rarely down for very long.
22085 Unfortunately, these are exactly the domains that tend to resolve to long lists
22086 of hosts. The short retry time means that the lowest MX hosts are tried every
22087 time. The attempts may be in a different order because of random sorting, but
22088 without the special MX check, the higher MX hosts would never be tried until
22089 all the lower MX hosts had timed out (which might be several days), because
22090 there are always some lower MX hosts that have reached their retry times. With
22091 the special check, Exim considers at least one IP address from each MX value at
22092 every delivery attempt, even if the &%hosts_max_try%& limit has already been
22093 reached.
22094
22095 The above logic means that &%hosts_max_try%& is not a hard limit, and in
22096 particular, Exim normally eventually tries all the IP addresses before timing
22097 out an email address. When &%hosts_max_try%& was implemented, this seemed a
22098 reasonable thing to do. Recently, however, some lunatic DNS configurations have
22099 been set up with hundreds of IP addresses for some domains. It can
22100 take a very long time indeed for an address to time out in these cases.
22101
22102 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
22103 Exim never tries more than this number of IP addresses; if it hits this limit
22104 and they are all timed out, the email address is bounced, even though not all
22105 possible IP addresses have been tried.
22106 .ecindex IIDsmttra1
22107 .ecindex IIDsmttra2
22108
22109
22110
22111
22112
22113 . ////////////////////////////////////////////////////////////////////////////
22114 . ////////////////////////////////////////////////////////////////////////////
22115
22116 .chapter "Address rewriting" "CHAPrewrite"
22117 .scindex IIDaddrew "rewriting" "addresses"
22118 There are some circumstances in which Exim automatically rewrites domains in
22119 addresses. The two most common are when an address is given without a domain
22120 (referred to as an &"unqualified address"&) or when an address contains an
22121 abbreviated domain that is expanded by DNS lookup.
22122
22123 Unqualified envelope addresses are accepted only for locally submitted
22124 messages, or for messages that are received from hosts matching
22125 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
22126 appropriate. Unqualified addresses in header lines are qualified if they are in
22127 locally submitted messages, or messages from hosts that are permitted to send
22128 unqualified envelope addresses. Otherwise, unqualified addresses in header
22129 lines are neither qualified nor rewritten.
22130
22131 One situation in which Exim does &'not'& automatically rewrite a domain is
22132 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
22133 such a domain should be rewritten using the &"canonical"& name, and some MTAs
22134 do this. The new RFCs do not contain this suggestion.
22135
22136
22137 .section "Explicitly configured address rewriting" "SECID147"
22138 This chapter describes the rewriting rules that can be used in the
22139 main rewrite section of the configuration file, and also in the generic
22140 &%headers_rewrite%& option that can be set on any transport.
22141
22142 Some people believe that configured address rewriting is a Mortal Sin.
22143 Others believe that life is not possible without it. Exim provides the
22144 facility; you do not have to use it.
22145
22146 The main rewriting rules that appear in the &"rewrite"& section of the
22147 configuration file are applied to addresses in incoming messages, both envelope
22148 addresses and addresses in header lines. Each rule specifies the types of
22149 address to which it applies.
22150
22151 Whether or not addresses in header lines are rewritten depends on the origin of
22152 the headers and the type of rewriting. Global rewriting, that is, rewriting
22153 rules from the rewrite section of the configuration file, is applied only to
22154 those headers that were received with the message. Header lines that are added
22155 by ACLs or by a system filter or by individual routers or transports (which
22156 are specific to individual recipient addresses) are not rewritten by the global
22157 rules.
22158
22159 Rewriting at transport time, by means of the &%headers_rewrite%& option,
22160 applies all headers except those added by routers and transports. That is, as
22161 well as the headers that were received with the message, it also applies to
22162 headers that were added by an ACL or a system filter.
22163
22164
22165 In general, rewriting addresses from your own system or domain has some
22166 legitimacy. Rewriting other addresses should be done only with great care and
22167 in special circumstances. The author of Exim believes that rewriting should be
22168 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
22169 Although it can sometimes be used as a routing tool, this is very strongly
22170 discouraged.
22171
22172 There are two commonly encountered circumstances where rewriting is used, as
22173 illustrated by these examples:
22174
22175 .ilist
22176 The company whose domain is &'hitch.fict.example'& has a number of hosts that
22177 exchange mail with each other behind a firewall, but there is only a single
22178 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
22179 &'hitch.fict.example'& when sending mail off-site.
22180 .next
22181 A host rewrites the local parts of its own users so that, for example,
22182 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
22183 .endlist
22184
22185
22186
22187 .section "When does rewriting happen?" "SECID148"
22188 .cindex "rewriting" "timing of"
22189 .cindex "&ACL;" "rewriting addresses in"
22190 Configured address rewriting can take place at several different stages of a
22191 message's processing.
22192
22193 .vindex "&$sender_address$&"
22194 At the start of an ACL for MAIL, the sender address may have been rewritten
22195 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
22196 ordinary rewrite rules have yet been applied. If, however, the sender address
22197 is verified in the ACL, it is rewritten before verification, and remains
22198 rewritten thereafter. The subsequent value of &$sender_address$& is the
22199 rewritten address. This also applies if sender verification happens in a
22200 RCPT ACL. Otherwise, when the sender address is not verified, it is
22201 rewritten as soon as a message's header lines have been received.
22202
22203 .vindex "&$domain$&"
22204 .vindex "&$local_part$&"
22205 Similarly, at the start of an ACL for RCPT, the current recipient's address
22206 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
22207 rewrite rules have yet been applied to it. However, the behaviour is different
22208 from the sender address when a recipient is verified. The address is rewritten
22209 for the verification, but the rewriting is not remembered at this stage. The
22210 value of &$local_part$& and &$domain$& after verification are always the same
22211 as they were before (that is, they contain the unrewritten &-- except for
22212 SMTP-time rewriting &-- address).
22213
22214 As soon as a message's header lines have been received, all the envelope
22215 recipient addresses are permanently rewritten, and rewriting is also applied to
22216 the addresses in the header lines (if configured). This happens before adding
22217 any header lines that were specified in MAIL or RCPT ACLs, and
22218 .cindex "&[local_scan()]& function" "address rewriting; timing of"
22219 before the DATA ACL and &[local_scan()]& functions are run.
22220
22221 When an address is being routed, either for delivery or for verification,
22222 rewriting is applied immediately to child addresses that are generated by
22223 redirection, unless &%no_rewrite%& is set on the router.
22224
22225 .cindex "envelope sender" "rewriting at transport time"
22226 .cindex "rewriting" "at transport time"
22227 .cindex "header lines" "rewriting at transport time"
22228 At transport time, additional rewriting of addresses in header lines can be
22229 specified by setting the generic &%headers_rewrite%& option on a transport.
22230 This option contains rules that are identical in form to those in the rewrite
22231 section of the configuration file. They are applied to the original message
22232 header lines and any that were added by ACLs or a system filter. They are not
22233 applied to header lines that are added by routers or the transport.
22234
22235 The outgoing envelope sender can be rewritten by means of the &%return_path%&
22236 transport option. However, it is not possible to rewrite envelope recipients at
22237 transport time.
22238
22239
22240
22241
22242 .section "Testing the rewriting rules that apply on input" "SECID149"
22243 .cindex "rewriting" "testing"
22244 .cindex "testing" "rewriting"
22245 Exim's input rewriting configuration appears in a part of the run time
22246 configuration file headed by &"begin rewrite"&. It can be tested by the
22247 &%-brw%& command line option. This takes an address (which can be a full RFC
22248 2822 address) as its argument. The output is a list of how the address would be
22249 transformed by the rewriting rules for each of the different places it might
22250 appear in an incoming message, that is, for each different header and for the
22251 envelope sender and recipient fields. For example,
22252 .code
22253 exim -brw ph10@exim.workshop.example
22254 .endd
22255 might produce the output
22256 .code
22257 sender: Philip.Hazel@exim.workshop.example
22258 from: Philip.Hazel@exim.workshop.example
22259 to: ph10@exim.workshop.example
22260 cc: ph10@exim.workshop.example
22261 bcc: ph10@exim.workshop.example
22262 reply-to: Philip.Hazel@exim.workshop.example
22263 env-from: Philip.Hazel@exim.workshop.example
22264 env-to: ph10@exim.workshop.example
22265 .endd
22266 which shows that rewriting has been set up for that address when used in any of
22267 the source fields, but not when it appears as a recipient address. At the
22268 present time, there is no equivalent way of testing rewriting rules that are
22269 set for a particular transport.
22270
22271
22272 .section "Rewriting rules" "SECID150"
22273 .cindex "rewriting" "rules"
22274 The rewrite section of the configuration file consists of lines of rewriting
22275 rules in the form
22276 .display
22277 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
22278 .endd
22279 Rewriting rules that are specified for the &%headers_rewrite%& generic
22280 transport option are given as a colon-separated list. Each item in the list
22281 takes the same form as a line in the main rewriting configuration (except that
22282 any colons must be doubled, of course).
22283
22284 The formats of source patterns and replacement strings are described below.
22285 Each is terminated by white space, unless enclosed in double quotes, in which
22286 case normal quoting conventions apply inside the quotes. The flags are single
22287 characters which may appear in any order. Spaces and tabs between them are
22288 ignored.
22289
22290 For each address that could potentially be rewritten, the rules are scanned in
22291 order, and replacements for the address from earlier rules can themselves be
22292 replaced by later rules (but see the &"q"& and &"R"& flags).
22293
22294 The order in which addresses are rewritten is undefined, may change between
22295 releases, and must not be relied on, with one exception: when a message is
22296 received, the envelope sender is always rewritten first, before any header
22297 lines are rewritten. For example, the replacement string for a rewrite of an
22298 address in &'To:'& must not assume that the message's address in &'From:'& has
22299 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
22300 that the envelope sender has already been rewritten.
22301
22302 .vindex "&$domain$&"
22303 .vindex "&$local_part$&"
22304 The variables &$local_part$& and &$domain$& can be used in the replacement
22305 string to refer to the address that is being rewritten. Note that lookup-driven
22306 rewriting can be done by a rule of the form
22307 .code
22308 *@*   ${lookup ...
22309 .endd
22310 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
22311 refer to the address that is being rewritten.
22312
22313
22314 .section "Rewriting patterns" "SECID151"
22315 .cindex "rewriting" "patterns"
22316 .cindex "address list" "in a rewriting pattern"
22317 The source pattern in a rewriting rule is any item which may appear in an
22318 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
22319 single-item address list, which means that it is expanded before being tested
22320 against the address. As always, if you use a regular expression as a pattern,
22321 you must take care to escape dollar and backslash characters, or use the &`\N`&
22322 facility to suppress string expansion within the regular expression.
22323
22324 Domains in patterns should be given in lower case. Local parts in patterns are
22325 case-sensitive. If you want to do case-insensitive matching of local parts, you
22326 can use a regular expression that starts with &`^(?i)`&.
22327
22328 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
22329 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
22330 depending on the type of match which occurred. These can be used in the
22331 replacement string to insert portions of the incoming address. &$0$& always
22332 refers to the complete incoming address. When a regular expression is used, the
22333 numerical variables are set from its capturing subexpressions. For other types
22334 of pattern they are set as follows:
22335
22336 .ilist
22337 If a local part or domain starts with an asterisk, the numerical variables
22338 refer to the character strings matched by asterisks, with &$1$& associated with
22339 the first asterisk, and &$2$& with the second, if present. For example, if the
22340 pattern
22341 .code
22342 *queen@*.fict.example
22343 .endd
22344 is matched against the address &'hearts-queen@wonderland.fict.example'& then
22345 .code
22346 $0 = hearts-queen@wonderland.fict.example
22347 $1 = hearts-
22348 $2 = wonderland
22349 .endd
22350 Note that if the local part does not start with an asterisk, but the domain
22351 does, it is &$1$& that contains the wild part of the domain.
22352
22353 .next
22354 If the domain part of the pattern is a partial lookup, the wild and fixed parts
22355 of the domain are placed in the next available numerical variables. Suppose,
22356 for example, that the address &'foo@bar.baz.example'& is processed by a
22357 rewriting rule of the form
22358 .display
22359 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
22360 .endd
22361 and the key in the file that matches the domain is &`*.baz.example`&. Then
22362 .code
22363 $1 = foo
22364 $2 = bar
22365 $3 = baz.example
22366 .endd
22367 If the address &'foo@baz.example'& is looked up, this matches the same
22368 wildcard file entry, and in this case &$2$& is set to the empty string, but
22369 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
22370 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
22371 whole domain. For non-partial domain lookups, no numerical variables are set.
22372 .endlist
22373
22374
22375 .section "Rewriting replacements" "SECID152"
22376 .cindex "rewriting" "replacements"
22377 If the replacement string for a rule is a single asterisk, addresses that
22378 match the pattern and the flags are &'not'& rewritten, and no subsequent
22379 rewriting rules are scanned. For example,
22380 .code
22381 hatta@lookingglass.fict.example  *  f
22382 .endd
22383 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
22384 &'From:'& headers.
22385
22386 .vindex "&$domain$&"
22387 .vindex "&$local_part$&"
22388 If the replacement string is not a single asterisk, it is expanded, and must
22389 yield a fully qualified address. Within the expansion, the variables
22390 &$local_part$& and &$domain$& refer to the address that is being rewritten.
22391 Any letters they contain retain their original case &-- they are not lower
22392 cased. The numerical variables are set up according to the type of pattern that
22393 matched the address, as described above. If the expansion is forced to fail by
22394 the presence of &"fail"& in a conditional or lookup item, rewriting by the
22395 current rule is abandoned, but subsequent rules may take effect. Any other
22396 expansion failure causes the entire rewriting operation to be abandoned, and an
22397 entry written to the panic log.
22398
22399
22400
22401 .section "Rewriting flags" "SECID153"
22402 There are three different kinds of flag that may appear on rewriting rules:
22403
22404 .ilist
22405 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
22406 c, f, h, r, s, t.
22407 .next
22408 A flag that specifies rewriting at SMTP time: S.
22409 .next
22410 Flags that control the rewriting process: Q, q, R, w.
22411 .endlist
22412
22413 For rules that are part of the &%headers_rewrite%& generic transport option,
22414 E, F, T, and S are not permitted.
22415
22416
22417
22418 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
22419          "SECID154"
22420 .cindex "rewriting" "flags"
22421 If none of the following flag letters, nor the &"S"& flag (see section
22422 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
22423 and to both the sender and recipient fields of the envelope, whereas a
22424 transport-time rewriting rule just applies to all headers. Otherwise, the
22425 rewriting rule is skipped unless the relevant addresses are being processed.
22426 .display
22427 &`E`&       rewrite all envelope fields
22428 &`F`&       rewrite the envelope From field
22429 &`T`&       rewrite the envelope To field
22430 &`b`&       rewrite the &'Bcc:'& header
22431 &`c`&       rewrite the &'Cc:'& header
22432 &`f`&       rewrite the &'From:'& header
22433 &`h`&       rewrite all headers
22434 &`r`&       rewrite the &'Reply-To:'& header
22435 &`s`&       rewrite the &'Sender:'& header
22436 &`t`&       rewrite the &'To:'& header
22437 .endd
22438 "All headers" means all of the headers listed above that can be selected
22439 individually, plus their &'Resent-'& versions. It does not include
22440 other headers such as &'Subject:'& etc.
22441
22442 You should be particularly careful about rewriting &'Sender:'& headers, and
22443 restrict this to special known cases in your own domains.
22444
22445
22446 .section "The SMTP-time rewriting flag" "SECTrewriteS"
22447 .cindex "SMTP" "rewriting malformed addresses"
22448 .cindex "RCPT" "rewriting argument of"
22449 .cindex "MAIL" "rewriting argument of"
22450 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
22451 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
22452 before any other processing; even before syntax checking. The pattern is
22453 required to be a regular expression, and it is matched against the whole of the
22454 data for the command, including any surrounding angle brackets.
22455
22456 .vindex "&$domain$&"
22457 .vindex "&$local_part$&"
22458 This form of rewrite rule allows for the handling of addresses that are not
22459 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
22460 input). Because the input is not required to be a syntactically valid address,
22461 the variables &$local_part$& and &$domain$& are not available during the
22462 expansion of the replacement string. The result of rewriting replaces the
22463 original address in the MAIL or RCPT command.
22464
22465
22466 .section "Flags controlling the rewriting process" "SECID155"
22467 There are four flags which control the way the rewriting process works. These
22468 take effect only when a rule is invoked, that is, when the address is of the
22469 correct type (matches the flags) and matches the pattern:
22470
22471 .ilist
22472 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
22473 unqualified local part. It is qualified with &%qualify_recipient%&. In the
22474 absence of &"Q"& the rewritten address must always include a domain.
22475 .next
22476 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
22477 even if no rewriting actually takes place because of a &"fail"& in the
22478 expansion. The &"q"& flag is not effective if the address is of the wrong type
22479 (does not match the flags) or does not match the pattern.
22480 .next
22481 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
22482 address, up to ten times. It can be combined with the &"q"& flag, to stop
22483 rewriting once it fails to match (after at least one successful rewrite).
22484 .next
22485 .cindex "rewriting" "whole addresses"
22486 When an address in a header is rewritten, the rewriting normally applies only
22487 to the working part of the address, with any comments and RFC 2822 &"phrase"&
22488 left unchanged. For example, rewriting might change
22489 .code
22490 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
22491 .endd
22492 into
22493 .code
22494 From: Ford Prefect <prefectf@hitch.fict.example>
22495 .endd
22496 .cindex "RFC 2047"
22497 Sometimes there is a need to replace the whole address item, and this can be
22498 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
22499 causes an address in a header line to be rewritten, the entire address is
22500 replaced, not just the working part. The replacement must be a complete RFC
22501 2822 address, including the angle brackets if necessary. If text outside angle
22502 brackets contains a character whose value is greater than 126 or less than 32
22503 (except for tab), the text is encoded according to RFC 2047. The character set
22504 is taken from &%headers_charset%&, which defaults to ISO-8859-1.
22505
22506 When the &"w"& flag is set on a rule that causes an envelope address to be
22507 rewritten, all but the working part of the replacement address is discarded.
22508 .endlist
22509
22510
22511 .section "Rewriting examples" "SECID156"
22512 Here is an example of the two common rewriting paradigms:
22513 .code
22514 *@*.hitch.fict.example  $1@hitch.fict.example
22515 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
22516                      {$value}fail}@hitch.fict.example bctfrF
22517 .endd
22518 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
22519 the string expansion to fail if the lookup does not succeed. In this context it
22520 has the effect of leaving the original address unchanged, but Exim goes on to
22521 consider subsequent rewriting rules, if any, because the &"q"& flag is not
22522 present in that rule. An alternative to &"fail"& would be to supply &$1$&
22523 explicitly, which would cause the rewritten address to be the same as before,
22524 at the cost of a small bit of processing. Not supplying either of these is an
22525 error, since the rewritten address would then contain no local part.
22526
22527 The first example above replaces the domain with a superior, more general
22528 domain. This may not be desirable for certain local parts. If the rule
22529 .code
22530 root@*.hitch.fict.example  *
22531 .endd
22532 were inserted before the first rule, rewriting would be suppressed for the
22533 local part &'root'& at any domain ending in &'hitch.fict.example'&.
22534
22535 Rewriting can be made conditional on a number of tests, by making use of
22536 &${if$& in the expansion item. For example, to apply a rewriting rule only to
22537 messages that originate outside the local host:
22538 .code
22539 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
22540                          {$1@hitch.fict.example}fail}"
22541 .endd
22542 The replacement string is quoted in this example because it contains white
22543 space.
22544
22545 .cindex "rewriting" "bang paths"
22546 .cindex "bang paths" "rewriting"
22547 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
22548 an address it treats it as an unqualified local part which it qualifies with
22549 the local qualification domain (if the source of the message is local or if the
22550 remote host is permitted to send unqualified addresses). Rewriting can
22551 sometimes be used to handle simple bang paths with a fixed number of
22552 components. For example, the rule
22553 .code
22554 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
22555 .endd
22556 rewrites a two-component bang path &'host.name!user'& as the domain address
22557 &'user@host.name'&. However, there is a security implication in using this as
22558 a global rewriting rule for envelope addresses. It can provide a backdoor
22559 method for using your system as a relay, because the incoming addresses appear
22560 to be local. If the bang path addresses are received via SMTP, it is safer to
22561 use the &"S"& flag to rewrite them as they are received, so that relay checking
22562 can be done on the rewritten addresses.
22563 .ecindex IIDaddrew
22564
22565
22566
22567
22568
22569 . ////////////////////////////////////////////////////////////////////////////
22570 . ////////////////////////////////////////////////////////////////////////////
22571
22572 .chapter "Retry configuration" "CHAPretry"
22573 .scindex IIDretconf1 "retry" "configuration, description of"
22574 .scindex IIDregconf2 "configuration file" "retry section"
22575 The &"retry"& section of the runtime configuration file contains a list of
22576 retry rules that control how often Exim tries to deliver messages that cannot
22577 be delivered at the first attempt. If there are no retry rules (the section is
22578 empty or not present), there are no retries. In this situation, temporary
22579 errors are treated as permanent. The default configuration contains a single,
22580 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
22581 line option can be used to test which retry rule will be used for a given
22582 address, domain and error.
22583
22584 The most common cause of retries is temporary failure to deliver to a remote
22585 host because the host is down, or inaccessible because of a network problem.
22586 Exim's retry processing in this case is applied on a per-host (strictly, per IP
22587 address) basis, not on a per-message basis. Thus, if one message has recently
22588 been delayed, delivery of a new message to the same host is not immediately
22589 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
22590 log selector is set, the message
22591 .cindex "retry" "time not reached"
22592 &"retry time not reached"& is written to the main log whenever a delivery is
22593 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
22594 the handling of errors during remote deliveries.
22595
22596 Retry processing applies to routing as well as to delivering, except as covered
22597 in the next paragraph. The retry rules do not distinguish between these
22598 actions. It is not possible, for example, to specify different behaviour for
22599 failures to route the domain &'snark.fict.example'& and failures to deliver to
22600 the host &'snark.fict.example'&. I didn't think anyone would ever need this
22601 added complication, so did not implement it. However, although they share the
22602 same retry rule, the actual retry times for routing and transporting a given
22603 domain are maintained independently.
22604
22605 When a delivery is not part of a queue run (typically an immediate delivery on
22606 receipt of a message), the routers are always run, and local deliveries are
22607 always attempted, even if retry times are set for them. This makes for better
22608 behaviour if one particular message is causing problems (for example, causing
22609 quota overflow, or provoking an error in a filter file). If such a delivery
22610 suffers a temporary failure, the retry data is updated as normal, and
22611 subsequent delivery attempts from queue runs occur only when the retry time for
22612 the local address is reached.
22613
22614 .section "Changing retry rules" "SECID157"
22615 If you change the retry rules in your configuration, you should consider
22616 whether or not to delete the retry data that is stored in Exim's spool area in
22617 files with names like &_db/retry_&. Deleting any of Exim's hints files is
22618 always safe; that is why they are called &"hints"&.
22619
22620 The hints retry data contains suggested retry times based on the previous
22621 rules. In the case of a long-running problem with a remote host, it might
22622 record the fact that the host has timed out. If your new rules increase the
22623 timeout time for such a host, you should definitely remove the old retry data
22624 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
22625 messages that it should now be retaining.
22626
22627
22628
22629 .section "Format of retry rules" "SECID158"
22630 .cindex "retry" "rules"
22631 Each retry rule occupies one line and consists of three or four parts,
22632 separated by white space: a pattern, an error name, an optional list of sender
22633 addresses, and a list of retry parameters. The pattern and sender lists must be
22634 enclosed in double quotes if they contain white space. The rules are searched
22635 in order until one is found where the pattern, error name, and sender list (if
22636 present) match the failing host or address, the error that occurred, and the
22637 message's sender, respectively.
22638
22639
22640 The pattern is any single item that may appear in an address list (see section
22641 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
22642 which means that it is expanded before being tested against the address that
22643 has been delayed. A negated address list item is permitted. Address
22644 list processing treats a plain domain name as if it were preceded by &"*@"&,
22645 which makes it possible for many retry rules to start with just a domain. For
22646 example,
22647 .code
22648 lookingglass.fict.example        *  F,24h,30m;
22649 .endd
22650 provides a rule for any address in the &'lookingglass.fict.example'& domain,
22651 whereas
22652 .code
22653 alice@lookingglass.fict.example  *  F,24h,30m;
22654 .endd
22655 applies only to temporary failures involving the local part &%alice%&.
22656 In practice, almost all rules start with a domain name pattern without a local
22657 part.
22658
22659 .cindex "regular expressions" "in retry rules"
22660 &*Warning*&: If you use a regular expression in a routing rule pattern, it
22661 must match a complete address, not just a domain, because that is how regular
22662 expressions work in address lists.
22663 .display
22664 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
22665 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
22666 .endd
22667
22668
22669 .section "Choosing which retry rule to use for address errors" "SECID159"
22670 When Exim is looking for a retry rule after a routing attempt has failed (for
22671 example, after a DNS timeout), each line in the retry configuration is tested
22672 against the complete address only if &%retry_use_local_part%& is set for the
22673 router. Otherwise, only the domain is used, except when matching against a
22674 regular expression, when the local part of the address is replaced with &"*"&.
22675 A domain on its own can match a domain pattern, or a pattern that starts with
22676 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
22677 &%check_local_user%& is true, and false for other routers.
22678
22679 Similarly, when Exim is looking for a retry rule after a local delivery has
22680 failed (for example, after a mailbox full error), each line in the retry
22681 configuration is tested against the complete address only if
22682 &%retry_use_local_part%& is set for the transport (it defaults true for all
22683 local transports).
22684
22685 .cindex "4&'xx'& responses" "retry rules for"
22686 However, when Exim is looking for a retry rule after a remote delivery attempt
22687 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
22688 whole address is always used as the key when searching the retry rules. The
22689 rule that is found is used to create a retry time for the combination of the
22690 failing address and the message's sender. It is the combination of sender and
22691 recipient that is delayed in subsequent queue runs until its retry time is
22692 reached. You can delay the recipient without regard to the sender by setting
22693 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
22694 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
22695 commands.
22696
22697
22698
22699 .section "Choosing which retry rule to use for host and message errors" &&&
22700          "SECID160"
22701 For a temporary error that is not related to an individual address (for
22702 example, a connection timeout), each line in the retry configuration is checked
22703 twice. First, the name of the remote host is used as a domain name (preceded by
22704 &"*@"& when matching a regular expression). If this does not match the line,
22705 the domain from the email address is tried in a similar fashion. For example,
22706 suppose the MX records for &'a.b.c.example'& are
22707 .code
22708 a.b.c.example  MX  5  x.y.z.example
22709                MX  6  p.q.r.example
22710                MX  7  m.n.o.example
22711 .endd
22712 and the retry rules are
22713 .code
22714 p.q.r.example    *      F,24h,30m;
22715 a.b.c.example    *      F,4d,45m;
22716 .endd
22717 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
22718 first rule matches neither the host nor the domain, so Exim looks at the second
22719 rule. This does not match the host, but it does match the domain, so it is used
22720 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
22721 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
22722 first retry rule is used, because it matches the host.
22723
22724 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
22725 first rule to determine retry times, but for all the other hosts for the domain
22726 &'a.b.c.example'&, the second rule is used. The second rule is also used if
22727 routing to &'a.b.c.example'& suffers a temporary failure.
22728
22729 &*Note*&: The host name is used when matching the patterns, not its IP address.
22730 However, if a message is routed directly to an IP address without the use of a
22731 host name, for example, if a &(manualroute)& router contains a setting such as:
22732 .code
22733 route_list = *.a.example  192.168.34.23
22734 .endd
22735 then the &"host name"& that is used when searching for a retry rule is the
22736 textual form of the IP address.
22737
22738 .section "Retry rules for specific errors" "SECID161"
22739 .cindex "retry" "specific errors; specifying"
22740 The second field in a retry rule is the name of a particular error, or an
22741 asterisk, which matches any error. The errors that can be tested for are:
22742
22743 .vlist
22744 .vitem &%auth_failed%&
22745 Authentication failed when trying to send to a host in the
22746 &%hosts_require_auth%& list in an &(smtp)& transport.
22747
22748 .vitem &%data_4xx%&
22749 A 4&'xx'& error was received for an outgoing DATA command, either immediately
22750 after the command, or after sending the message's data.
22751
22752 .vitem &%mail_4xx%&
22753 A 4&'xx'& error was received for an outgoing MAIL command.
22754
22755 .vitem &%rcpt_4xx%&
22756 A 4&'xx'& error was received for an outgoing RCPT command.
22757 .endlist
22758
22759 For the three 4&'xx'& errors, either the first or both of the x's can be given
22760 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
22761 recognize 452 errors given to RCPT commands for addresses in a certain domain,
22762 and have retries every ten minutes with a one-hour timeout, you could set up a
22763 retry rule of this form:
22764 .code
22765 the.domain.name  rcpt_452   F,1h,10m
22766 .endd
22767 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
22768 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
22769
22770 .vlist
22771 .vitem &%lost_connection%&
22772 A server unexpectedly closed the SMTP connection. There may, of course,
22773 legitimate reasons for this (host died, network died), but if it repeats a lot
22774 for the same host, it indicates something odd.
22775
22776 .vitem &%refused_MX%&
22777 A connection to a host obtained from an MX record was refused.
22778
22779 .vitem &%refused_A%&
22780 A connection to a host not obtained from an MX record was refused.
22781
22782 .vitem &%refused%&
22783 A connection was refused.
22784
22785 .vitem &%timeout_connect_MX%&
22786 A connection attempt to a host obtained from an MX record timed out.
22787
22788 .vitem &%timeout_connect_A%&
22789 A connection attempt to a host not obtained from an MX record timed out.
22790
22791 .vitem &%timeout_connect%&
22792 A connection attempt timed out.
22793
22794 .vitem &%timeout_MX%&
22795 There was a timeout while connecting or during an SMTP session with a host
22796 obtained from an MX record.
22797
22798 .vitem &%timeout_A%&
22799 There was a timeout while connecting or during an SMTP session with a host not
22800 obtained from an MX record.
22801
22802 .vitem &%timeout%&
22803 There was a timeout while connecting or during an SMTP session.
22804
22805 .vitem &%tls_required%&
22806 The server was required to use TLS (it matched &%hosts_require_tls%& in the
22807 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
22808 to STARTTLS, or there was a problem setting up the TLS connection.
22809
22810 .vitem &%quota%&
22811 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
22812 transport.
22813
22814 .vitem &%quota_%&<&'time'&>
22815 .cindex "quota" "error testing in retry rule"
22816 .cindex "retry" "quota error testing"
22817 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
22818 transport, and the mailbox has not been accessed for <&'time'&>. For example,
22819 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
22820 for four days.
22821 .endlist
22822
22823 .cindex "mailbox" "time of last read"
22824 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
22825 timeouts when the mailbox is full and is not being read by its owner. Ideally,
22826 it should be based on the last time that the user accessed the mailbox.
22827 However, it is not always possible to determine this. Exim uses the following
22828 heuristic rules:
22829
22830 .ilist
22831 If the mailbox is a single file, the time of last access (the &"atime"&) is
22832 used. As no new messages are being delivered (because the mailbox is over
22833 quota), Exim does not access the file, so this is the time of last user access.
22834 .next
22835 .cindex "maildir format" "time of last read"
22836 For a maildir delivery, the time of last modification of the &_new_&
22837 subdirectory is used. As the mailbox is over quota, no new files are created in
22838 the &_new_& subdirectory, because no new messages are being delivered. Any
22839 change to the &_new_& subdirectory is therefore assumed to be the result of an
22840 MUA moving a new message to the &_cur_& directory when it is first read. The
22841 time that is used is therefore the last time that the user read a new message.
22842 .next
22843 For other kinds of multi-file mailbox, the time of last access cannot be
22844 obtained, so a retry rule that uses this type of error field is never matched.
22845 .endlist
22846
22847 The quota errors apply both to system-enforced quotas and to Exim's own quota
22848 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
22849 when a local delivery is deferred because a partition is full (the ENOSPC
22850 error).
22851
22852
22853
22854 .section "Retry rules for specified senders" "SECID162"
22855 .cindex "retry" "rules; sender-specific"
22856 You can specify retry rules that apply only when the failing message has a
22857 specific sender. In particular, this can be used to define retry rules that
22858 apply only to bounce messages. The third item in a retry rule can be of this
22859 form:
22860 .display
22861 &`senders=`&<&'address list'&>
22862 .endd
22863 The retry timings themselves are then the fourth item. For example:
22864 .code
22865 *   rcpt_4xx   senders=:   F,1h,30m
22866 .endd
22867 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
22868 host. If the address list contains white space, it must be enclosed in quotes.
22869 For example:
22870 .code
22871 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
22872 .endd
22873 &*Warning*&: This facility can be unhelpful if it is used for host errors
22874 (which do not depend on the recipient). The reason is that the sender is used
22875 only to match the retry rule. Once the rule has been found for a host error,
22876 its contents are used to set a retry time for the host, and this will apply to
22877 all messages, not just those with specific senders.
22878
22879 When testing retry rules using &%-brt%&, you can supply a sender using the
22880 &%-f%& command line option, like this:
22881 .code
22882 exim -f "" -brt user@dom.ain
22883 .endd
22884 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
22885 list is never matched.
22886
22887
22888
22889
22890
22891 .section "Retry parameters" "SECID163"
22892 .cindex "retry" "parameters in rules"
22893 The third (or fourth, if a senders list is present) field in a retry rule is a
22894 sequence of retry parameter sets, separated by semicolons. Each set consists of
22895 .display
22896 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
22897 .endd
22898 The letter identifies the algorithm for computing a new retry time; the cutoff
22899 time is the time beyond which this algorithm no longer applies, and the
22900 arguments vary the algorithm's action. The cutoff time is measured from the
22901 time that the first failure for the domain (combined with the local part if
22902 relevant) was detected, not from the time the message was received.
22903
22904 .cindex "retry" "algorithms"
22905 .cindex "retry" "fixed intervals"
22906 .cindex "retry" "increasing intervals"
22907 .cindex "retry" "random intervals"
22908 The available algorithms are:
22909
22910 .ilist
22911 &'F'&: retry at fixed intervals. There is a single time parameter specifying
22912 the interval.
22913 .next
22914 &'G'&: retry at geometrically increasing intervals. The first argument
22915 specifies a starting value for the interval, and the second a multiplier, which
22916 is used to increase the size of the interval at each retry.
22917 .next
22918 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
22919 retry, the previous interval is multiplied by the factor in order to get a
22920 maximum for the next interval. The minimum interval is the first argument of
22921 the parameter, and an actual interval is chosen randomly between them. Such a
22922 rule has been found to be helpful in cluster configurations when all the
22923 members of the cluster restart at once, and may therefore synchronize their
22924 queue processing times.
22925 .endlist
22926
22927 When computing the next retry time, the algorithm definitions are scanned in
22928 order until one whose cutoff time has not yet passed is reached. This is then
22929 used to compute a new retry time that is later than the current time. In the
22930 case of fixed interval retries, this simply means adding the interval to the
22931 current time. For geometrically increasing intervals, retry intervals are
22932 computed from the rule's parameters until one that is greater than the previous
22933 interval is found. The main configuration variable
22934 .cindex "limit" "retry interval"
22935 .cindex "retry" "interval, maximum"
22936 .oindex "&%retry_interval_max%&"
22937 &%retry_interval_max%& limits the maximum interval between retries. It
22938 cannot be set greater than &`24h`&, which is its default value.
22939
22940 A single remote domain may have a number of hosts associated with it, and each
22941 host may have more than one IP address. Retry algorithms are selected on the
22942 basis of the domain name, but are applied to each IP address independently. If,
22943 for example, a host has two IP addresses and one is unusable, Exim will
22944 generate retry times for it and will not try to use it until its next retry
22945 time comes. Thus the good IP address is likely to be tried first most of the
22946 time.
22947
22948 .cindex "hints database" "use for retrying"
22949 Retry times are hints rather than promises. Exim does not make any attempt to
22950 run deliveries exactly at the computed times. Instead, a queue runner process
22951 starts delivery processes for delayed messages periodically, and these attempt
22952 new deliveries only for those addresses that have passed their next retry time.
22953 If a new message arrives for a deferred address, an immediate delivery attempt
22954 occurs only if the address has passed its retry time. In the absence of new
22955 messages, the minimum time between retries is the interval between queue runner
22956 processes. There is not much point in setting retry times of five minutes if
22957 your queue runners happen only once an hour, unless there are a significant
22958 number of incoming messages (which might be the case on a system that is
22959 sending everything to a smart host, for example).
22960
22961 The data in the retry hints database can be inspected by using the
22962 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
22963 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
22964 &'exinext'& utility script can be used to find out what the next retry times
22965 are for the hosts associated with a particular mail domain, and also for local
22966 deliveries that have been deferred.
22967
22968
22969 .section "Retry rule examples" "SECID164"
22970 Here are some example retry rules:
22971 .code
22972 alice@wonderland.fict.example quota_5d  F,7d,3h
22973 wonderland.fict.example       quota_5d
22974 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
22975 lookingglass.fict.example     *         F,24h,30m;
22976 *                 refused_A   F,2h,20m;
22977 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
22978 .endd
22979 The first rule sets up special handling for mail to
22980 &'alice@wonderland.fict.example'& when there is an over-quota error and the
22981 mailbox has not been read for at least 5 days. Retries continue every three
22982 hours for 7 days. The second rule handles over-quota errors for all other local
22983 parts at &'wonderland.fict.example'&; the absence of a local part has the same
22984 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
22985 fail are bounced immediately if the mailbox has not been read for at least 5
22986 days.
22987
22988 The third rule handles all other errors at &'wonderland.fict.example'&; retries
22989 happen every 15 minutes for an hour, then with geometrically increasing
22990 intervals until two days have passed since a delivery first failed. After the
22991 first hour there is a delay of one hour, then two hours, then four hours, and
22992 so on (this is a rather extreme example).
22993
22994 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
22995 They happen every 30 minutes for 24 hours only. The remaining two rules handle
22996 all other domains, with special action for connection refusal from hosts that
22997 were not obtained from an MX record.
22998
22999 The final rule in a retry configuration should always have asterisks in the
23000 first two fields so as to provide a general catch-all for any addresses that do
23001 not have their own special handling. This example tries every 15 minutes for 2
23002 hours, then with intervals starting at one hour and increasing by a factor of
23003 1.5 up to 16 hours, then every 8 hours up to 5 days.
23004
23005
23006
23007 .section "Timeout of retry data" "SECID165"
23008 .cindex "timeout" "of retry data"
23009 .oindex "&%retry_data_expire%&"
23010 .cindex "hints database" "data expiry"
23011 .cindex "retry" "timeout of data"
23012 Exim timestamps the data that it writes to its retry hints database. When it
23013 consults the data during a delivery it ignores any that is older than the value
23014 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
23015 been tried for 7 days, Exim will try to deliver to it immediately a message
23016 arrives, and if that fails, it will calculate a retry time as if it were
23017 failing for the first time.
23018
23019 This improves the behaviour for messages routed to rarely-used hosts such as MX
23020 backups. If such a host was down at one time, and happens to be down again when
23021 Exim tries a month later, using the old retry data would imply that it had been
23022 down all the time, which is not a justified assumption.
23023
23024 If a host really is permanently dead, this behaviour causes a burst of retries
23025 every now and again, but only if messages routed to it are rare. If there is a
23026 message at least once every 7 days the retry data never expires.
23027
23028
23029
23030
23031 .section "Long-term failures" "SECID166"
23032 .cindex "delivery failure, long-term"
23033 .cindex "retry" "after long-term failure"
23034 Special processing happens when an email address has been failing for so long
23035 that the cutoff time for the last algorithm is reached. For example, using the
23036 default retry rule:
23037 .code
23038 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
23039 .endd
23040 the cutoff time is four days. Reaching the retry cutoff is independent of how
23041 long any specific message has been failing; it is the length of continuous
23042 failure for the recipient address that counts.
23043
23044 When the cutoff time is reached for a local delivery, or for all the IP
23045 addresses associated with a remote delivery, a subsequent delivery failure
23046 causes Exim to give up on the address, and a bounce message is generated.
23047 In order to cater for new messages that use the failing address, a next retry
23048 time is still computed from the final algorithm, and is used as follows:
23049
23050 For local deliveries, one delivery attempt is always made for any subsequent
23051 messages. If this delivery fails, the address fails immediately. The
23052 post-cutoff retry time is not used.
23053
23054 If the delivery is remote, there are two possibilities, controlled by the
23055 .oindex "&%delay_after_cutoff%&"
23056 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
23057 default. Until the post-cutoff retry time for one of the IP addresses is
23058 reached, the failing email address is bounced immediately, without a delivery
23059 attempt taking place. After that time, one new delivery attempt is made to
23060 those IP addresses that are past their retry times, and if that still fails,
23061 the address is bounced and new retry times are computed.
23062
23063 In other words, when all the hosts for a given email address have been failing
23064 for a long time, Exim bounces rather then defers until one of the hosts' retry
23065 times is reached. Then it tries once, and bounces if that attempt fails. This
23066 behaviour ensures that few resources are wasted in repeatedly trying to deliver
23067 to a broken destination, but if the host does recover, Exim will eventually
23068 notice.
23069
23070 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
23071 addresses are past their final cutoff time, Exim tries to deliver to those IP
23072 addresses that have not been tried since the message arrived. If there are
23073 no suitable IP addresses, or if they all fail, the address is bounced. In other
23074 words, it does not delay when a new message arrives, but tries the expired
23075 addresses immediately, unless they have been tried since the message arrived.
23076 If there is a continuous stream of messages for the failing domains, setting
23077 &%delay_after_cutoff%& false means that there will be many more attempts to
23078 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
23079 true.
23080
23081 .section "Deliveries that work intermittently" "SECID167"
23082 .cindex "retry" "intermittently working deliveries"
23083 Some additional logic is needed to cope with cases where a host is
23084 intermittently available, or when a message has some attribute that prevents
23085 its delivery when others to the same address get through. In this situation,
23086 because some messages are successfully delivered, the &"retry clock"& for the
23087 host or address keeps getting reset by the successful deliveries, and so
23088 failing messages remain on the queue for ever because the cutoff time is never
23089 reached.
23090
23091 Two exceptional actions are applied to prevent this happening. The first
23092 applies to errors that are related to a message rather than a remote host.
23093 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
23094 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
23095 commands, and quota failures. For this type of error, if a message's arrival
23096 time is earlier than the &"first failed"& time for the error, the earlier time
23097 is used when scanning the retry rules to decide when to try next and when to
23098 time out the address.
23099
23100 The exceptional second action applies in all cases. If a message has been on
23101 the queue for longer than the cutoff time of any applicable retry rule for a
23102 given address, a delivery is attempted for that address, even if it is not yet
23103 time, and if this delivery fails, the address is timed out. A new retry time is
23104 not computed in this case, so that other messages for the same address are
23105 considered immediately.
23106 .ecindex IIDretconf1
23107 .ecindex IIDregconf2
23108
23109
23110
23111
23112
23113
23114 . ////////////////////////////////////////////////////////////////////////////
23115 . ////////////////////////////////////////////////////////////////////////////
23116
23117 .chapter "SMTP authentication" "CHAPSMTPAUTH"
23118 .scindex IIDauthconf1 "SMTP" "authentication configuration"
23119 .scindex IIDauthconf2 "authentication"
23120 The &"authenticators"& section of Exim's run time configuration is concerned
23121 with SMTP authentication. This facility is an extension to the SMTP protocol,
23122 described in RFC 2554, which allows a client SMTP host to authenticate itself
23123 to a server. This is a common way for a server to recognize clients that are
23124 permitted to use it as a relay. SMTP authentication is not of relevance to the
23125 transfer of mail between servers that have no managerial connection with each
23126 other.
23127
23128 .cindex "AUTH" "description of"
23129 Very briefly, the way SMTP authentication works is as follows:
23130
23131 .ilist
23132 The server advertises a number of authentication &'mechanisms'& in response to
23133 the client's EHLO command.
23134 .next
23135 The client issues an AUTH command, naming a specific mechanism. The command
23136 may, optionally, contain some authentication data.
23137 .next
23138 The server may issue one or more &'challenges'&, to which the client must send
23139 appropriate responses. In simple authentication mechanisms, the challenges are
23140 just prompts for user names and passwords. The server does not have to issue
23141 any challenges &-- in some mechanisms the relevant data may all be transmitted
23142 with the AUTH command.
23143 .next
23144 The server either accepts or denies authentication.
23145 .next
23146 If authentication succeeds, the client may optionally make use of the AUTH
23147 option on the MAIL command to pass an authenticated sender in subsequent
23148 mail transactions. Authentication lasts for the remainder of the SMTP
23149 connection.
23150 .next
23151 If authentication fails, the client may give up, or it may try a different
23152 authentication mechanism, or it may try transferring mail over the
23153 unauthenticated connection.
23154 .endlist
23155
23156 If you are setting up a client, and want to know which authentication
23157 mechanisms the server supports, you can use Telnet to connect to port 25 (the
23158 SMTP port) on the server, and issue an EHLO command. The response to this
23159 includes the list of supported mechanisms. For example:
23160 .display
23161 &`$ `&&*&`telnet server.example 25`&*&
23162 &`Trying 192.168.34.25...`&
23163 &`Connected to server.example.`&
23164 &`Escape character is &#x0027;^]&#x0027;.`&
23165 &`220 server.example ESMTP Exim 4.20 ...`&
23166 &*&`ehlo client.example`&*&
23167 &`250-server.example Hello client.example [10.8.4.5]`&
23168 &`250-SIZE 52428800`&
23169 &`250-PIPELINING`&
23170 &`250-AUTH PLAIN`&
23171 &`250 HELP`&
23172 .endd
23173 The second-last line of this example output shows that the server supports
23174 authentication using the PLAIN mechanism. In Exim, the different authentication
23175 mechanisms are configured by specifying &'authenticator'& drivers. Like the
23176 routers and transports, which authenticators are included in the binary is
23177 controlled by build-time definitions. The following are currently available,
23178 included by setting
23179 .code
23180 AUTH_CRAM_MD5=yes
23181 AUTH_CYRUS_SASL=yes
23182 AUTH_PLAINTEXT=yes
23183 AUTH_SPA=yes
23184 .endd
23185 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
23186 authentication mechanism (RFC 2195), and the second provides an interface to
23187 the Cyrus SASL authentication library. The third can be configured to support
23188 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
23189 not formally documented, but used by several MUAs. The fourth authenticator
23190 supports Microsoft's &'Secure Password Authentication'& mechanism.
23191
23192 The authenticators are configured using the same syntax as other drivers (see
23193 section &<<SECTfordricon>>&). If no authenticators are required, no
23194 authentication section need be present in the configuration file. Each
23195 authenticator can in principle have both server and client functions. When Exim
23196 is receiving SMTP mail, it is acting as a server; when it is sending out
23197 messages over SMTP, it is acting as a client. Authenticator configuration
23198 options are provided for use in both these circumstances.
23199
23200 To make it clear which options apply to which situation, the prefixes
23201 &%server_%& and &%client_%& are used on option names that are specific to
23202 either the server or the client function, respectively. Server and client
23203 functions are disabled if none of their options are set. If an authenticator is
23204 to be used for both server and client functions, a single definition, using
23205 both sets of options, is required. For example:
23206 .code
23207 cram:
23208   driver = cram_md5
23209   public_name = CRAM-MD5
23210   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
23211   client_name = ph10
23212   client_secret = secret2
23213 .endd
23214 The &%server_%& option is used when Exim is acting as a server, and the
23215 &%client_%& options when it is acting as a client.
23216
23217 Descriptions of the individual authenticators are given in subsequent chapters.
23218 The remainder of this chapter covers the generic options for the
23219 authenticators, followed by general discussion of the way authentication works
23220 in Exim.
23221
23222
23223
23224 .section "Generic options for authenticators" "SECID168"
23225 .cindex "authentication" "generic options"
23226 .cindex "options" "generic; for authenticators"
23227
23228 .option client_condition authenticators string&!! unset
23229 When Exim is authenticating as a client, it skips any authenticator whose
23230 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
23231 used, for example, to skip plain text authenticators when the connection is not
23232 encrypted by a setting such as:
23233 .code
23234 client_condition = ${if !eq{$tls_cipher}{}}
23235 .endd
23236 (Older documentation incorrectly states that &$tls_cipher$& contains the cipher
23237 used for incoming messages. In fact, during SMTP delivery, it contains the
23238 cipher used for the delivery.)
23239
23240
23241 .option driver authenticators string unset
23242 This option must always be set. It specifies which of the available
23243 authenticators is to be used.
23244
23245
23246 .option public_name authenticators string unset
23247 This option specifies the name of the authentication mechanism that the driver
23248 implements, and by which it is known to the outside world. These names should
23249 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
23250 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
23251 defaults to the driver's instance name.
23252
23253
23254 .option server_advertise_condition authenticators string&!! unset
23255 When a server is about to advertise an authentication mechanism, the condition
23256 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
23257 mechanism is not advertised.
23258 If the expansion fails, the mechanism is not advertised. If the failure was not
23259 forced, and was not caused by a lookup defer, the incident is logged.
23260 See section &<<SECTauthexiser>>& below for further discussion.
23261
23262
23263 .option server_condition authenticators string&!! unset
23264 This option must be set for a &%plaintext%& server authenticator, where it
23265 is used directly to control authentication. See section &<<SECTplainserver>>&
23266 for details.
23267
23268 For the other authenticators, &%server_condition%& can be used as an additional
23269 authentication or authorization mechanism that is applied after the other
23270 authenticator conditions succeed. If it is set, it is expanded when the
23271 authenticator would otherwise return a success code. If the expansion is forced
23272 to fail, authentication fails. Any other expansion failure causes a temporary
23273 error code to be returned. If the result of a successful expansion is an empty
23274 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
23275 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
23276 other result, a temporary error code is returned, with the expanded string as
23277 the error text.
23278
23279
23280 .option server_debug_print authenticators string&!! unset
23281 If this option is set and authentication debugging is enabled (see the &%-d%&
23282 command line option), the string is expanded and included in the debugging
23283 output when the authenticator is run as a server. This can help with checking
23284 out the values of variables.
23285 If expansion of the string fails, the error message is written to the debugging
23286 output, and Exim carries on processing.
23287
23288
23289 .option server_set_id authenticators string&!! unset
23290 .vindex "&$authenticated_id$&"
23291 When an Exim server successfully authenticates a client, this string is
23292 expanded using data from the authentication, and preserved for any incoming
23293 messages in the variable &$authenticated_id$&. It is also included in the log
23294 lines for incoming messages. For example, a user/password authenticator
23295 configuration might preserve the user name that was used to authenticate, and
23296 refer to it subsequently during delivery of the message.
23297 If expansion fails, the option is ignored.
23298
23299
23300 .option server_mail_auth_condition authenticators string&!! unset
23301 This option allows a server to discard authenticated sender addresses supplied
23302 as part of MAIL commands in SMTP connections that are authenticated by the
23303 driver on which &%server_mail_auth_condition%& is set. The option is not used
23304 as part of the authentication process; instead its (unexpanded) value is
23305 remembered for later use.
23306 How it is used is described in the following section.
23307
23308
23309
23310
23311
23312 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
23313 .cindex "authentication" "sender; authenticated"
23314 .cindex "AUTH" "on MAIL command"
23315 When a client supplied an AUTH= item on a MAIL command, Exim applies
23316 the following checks before accepting it as the authenticated sender of the
23317 message:
23318
23319 .ilist
23320 If the connection is not using extended SMTP (that is, HELO was used rather
23321 than EHLO), the use of AUTH= is a syntax error.
23322 .next
23323 If the value of the AUTH= parameter is &"<>"&, it is ignored.
23324 .next
23325 .vindex "&$authenticated_sender$&"
23326 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
23327 running, the value of &$authenticated_sender$& is set to the value obtained
23328 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
23329 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
23330 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
23331 given for the MAIL command.
23332 .next
23333 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
23334 is accepted and placed in &$authenticated_sender$& only if the client has
23335 authenticated.
23336 .next
23337 If the AUTH= value was accepted by either of the two previous rules, and
23338 the client has authenticated, and the authenticator has a setting for the
23339 &%server_mail_auth_condition%&, the condition is checked at this point. The
23340 valued that was saved from the authenticator is expanded. If the expansion
23341 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
23342 &$authenticated_sender$& is deleted. If the expansion yields any other value,
23343 the value of &$authenticated_sender$& is retained and passed on with the
23344 message.
23345 .endlist
23346
23347
23348 When &$authenticated_sender$& is set for a message, it is passed on to other
23349 hosts to which Exim authenticates as a client. Do not confuse this value with
23350 &$authenticated_id$&, which is a string obtained from the authentication
23351 process, and which is not usually a complete email address.
23352
23353 .vindex "&$sender_address$&"
23354 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
23355 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
23356 therefore make use of &$authenticated_sender$&. The converse is not true: the
23357 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
23358 ACL is run.
23359
23360
23361
23362 .section "Authentication on an Exim server" "SECTauthexiser"
23363 .cindex "authentication" "on an Exim server"
23364 When Exim receives an EHLO command, it advertises the public names of those
23365 authenticators that are configured as servers, subject to the following
23366 conditions:
23367
23368 .ilist
23369 The client host must match &%auth_advertise_hosts%& (default *).
23370 .next
23371 It the &%server_advertise_condition%& option is set, its expansion must not
23372 yield the empty string, &"0"&, &"no"&, or &"false"&.
23373 .endlist
23374
23375 The order in which the authenticators are defined controls the order in which
23376 the mechanisms are advertised.
23377
23378 Some mail clients (for example, some versions of Netscape) require the user to
23379 provide a name and password for authentication whenever AUTH is advertised,
23380 even though authentication may not in fact be needed (for example, Exim may be
23381 set up to allow unconditional relaying from the client by an IP address check).
23382 You can make such clients more friendly by not advertising AUTH to them.
23383 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
23384 that runs for RCPT) to relay without authentication, you should set
23385 .code
23386 auth_advertise_hosts = ! 10.9.8.0/24
23387 .endd
23388 so that no authentication mechanisms are advertised to them.
23389
23390 The &%server_advertise_condition%& controls the advertisement of individual
23391 authentication mechanisms. For example, it can be used to restrict the
23392 advertisement of a particular mechanism to encrypted connections, by a setting
23393 such as:
23394 .code
23395 server_advertise_condition = ${if eq{$tls_cipher}{}{no}{yes}}
23396 .endd
23397 .vindex "&$tls_cipher$&"
23398 If the session is encrypted, &$tls_cipher$& is not empty, and so the expansion
23399 yields &"yes"&, which allows the advertisement to happen.
23400
23401 When an Exim server receives an AUTH command from a client, it rejects it
23402 immediately if AUTH was not advertised in response to an earlier EHLO
23403 command. This is the case if
23404
23405 .ilist
23406 The client host does not match &%auth_advertise_hosts%&; or
23407 .next
23408 No authenticators are configured with server options; or
23409 .next
23410 Expansion of &%server_advertise_condition%& blocked the advertising of all the
23411 server authenticators.
23412 .endlist
23413
23414
23415 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
23416 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
23417 AUTH is accepted from any client host.
23418
23419 If AUTH is not rejected by the ACL, Exim searches its configuration for a
23420 server authentication mechanism that was advertised in response to EHLO and
23421 that matches the one named in the AUTH command. If it finds one, it runs
23422 the appropriate authentication protocol, and authentication either succeeds or
23423 fails. If there is no matching advertised mechanism, the AUTH command is
23424 rejected with a 504 error.
23425
23426 .vindex "&$received_protocol$&"
23427 .vindex "&$sender_host_authenticated$&"
23428 When a message is received from an authenticated host, the value of
23429 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
23430 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
23431 public name) of the authenticator driver that successfully authenticated the
23432 client from which the message was received. This variable is empty if there was
23433 no successful authentication.
23434
23435
23436
23437
23438 .section "Testing server authentication" "SECID169"
23439 .cindex "authentication" "testing a server"
23440 .cindex "AUTH" "testing a server"
23441 .cindex "base64 encoding" "creating authentication test data"
23442 Exim's &%-bh%& option can be useful for testing server authentication
23443 configurations. The data for the AUTH command has to be sent using base64
23444 encoding. A quick way to produce such data for testing is the following Perl
23445 script:
23446 .code
23447 use MIME::Base64;
23448 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
23449 .endd
23450 .cindex "binary zero" "in authentication data"
23451 This interprets its argument as a Perl string, and then encodes it. The
23452 interpretation as a Perl string allows binary zeros, which are required for
23453 some kinds of authentication, to be included in the data. For example, a
23454 command line to run this script on such data might be
23455 .code
23456 encode '\0user\0password'
23457 .endd
23458 Note the use of single quotes to prevent the shell interpreting the
23459 backslashes, so that they can be interpreted by Perl to specify characters
23460 whose code value is zero.
23461
23462 &*Warning 1*&: If either of the user or password strings starts with an octal
23463 digit, you must use three zeros instead of one after the leading backslash. If
23464 you do not, the octal digit that starts your string will be incorrectly
23465 interpreted as part of the code for the first character.
23466
23467 &*Warning 2*&: If there are characters in the strings that Perl interprets
23468 specially, you must use a Perl escape to prevent them being misinterpreted. For
23469 example, a command such as
23470 .code
23471 encode '\0user@domain.com\0pas$$word'
23472 .endd
23473 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
23474
23475 If you have the &%mimencode%& command installed, another way to do produce
23476 base64-encoded strings is to run the command
23477 .code
23478 echo -e -n `\0user\0password' | mimencode
23479 .endd
23480 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
23481 in the argument, and the &%-n%& option specifies no newline at the end of its
23482 output. However, not all versions of &%echo%& recognize these options, so you
23483 should check your version before relying on this suggestion.
23484
23485
23486
23487 .section "Authentication by an Exim client" "SECID170"
23488 .cindex "authentication" "on an Exim client"
23489 The &(smtp)& transport has two options called &%hosts_require_auth%& and
23490 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
23491 announces support for authentication, and the host matches an entry in either
23492 of these options, Exim (as a client) tries to authenticate as follows:
23493
23494 .ilist
23495 For each authenticator that is configured as a client, in the order in which
23496 they are defined in the configuration, it searches the authentication
23497 mechanisms announced by the server for one whose name matches the public name
23498 of the authenticator.
23499 .next
23500 .vindex "&$host$&"
23501 .vindex "&$host_address$&"
23502 When it finds one that matches, it runs the authenticator's client code. The
23503 variables &$host$& and &$host_address$& are available for any string expansions
23504 that the client might do. They are set to the server's name and IP address. If
23505 any expansion is forced to fail, the authentication attempt is abandoned, and
23506 Exim moves on to the next authenticator. Otherwise an expansion failure causes
23507 delivery to be deferred.
23508 .next
23509 If the result of the authentication attempt is a temporary error or a timeout,
23510 Exim abandons trying to send the message to the host for the moment. It will
23511 try again later. If there are any backup hosts available, they are tried in the
23512 usual way.
23513 .next
23514 If the response to authentication is a permanent error (5&'xx'& code), Exim
23515 carries on searching the list of authenticators and tries another one if
23516 possible. If all authentication attempts give permanent errors, or if there are
23517 no attempts because no mechanisms match (or option expansions force failure),
23518 what happens depends on whether the host matches &%hosts_require_auth%& or
23519 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
23520 delivery is deferred. The error can be detected in the retry rules, and thereby
23521 turned into a permanent error if you wish. In the second case, Exim tries to
23522 deliver the message unauthenticated.
23523 .endlist
23524
23525 .cindex "AUTH" "on MAIL command"
23526 When Exim has authenticated itself to a remote server, it adds the AUTH
23527 parameter to the MAIL commands it sends, if it has an authenticated sender for
23528 the message. If the message came from a remote host, the authenticated sender
23529 is the one that was receiving on an incoming MAIL command, provided that the
23530 incoming connection was authenticated and the &%server_mail_auth%& condition
23531 allowed the authenticated sender to be retained. If a local process calls Exim
23532 to send a message, the sender address that is built from the login name and
23533 &%qualify_domain%& is treated as authenticated. However, if the
23534 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
23535 the authenticated sender that was received with the message.
23536 .ecindex IIDauthconf1
23537 .ecindex IIDauthconf2
23538
23539
23540
23541
23542
23543
23544 . ////////////////////////////////////////////////////////////////////////////
23545 . ////////////////////////////////////////////////////////////////////////////
23546
23547 .chapter "The plaintext authenticator" "CHAPplaintext"
23548 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
23549 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
23550 The &(plaintext)& authenticator can be configured to support the PLAIN and
23551 LOGIN authentication mechanisms, both of which transfer authentication data as
23552 plain (unencrypted) text (though base64 encoded). The use of plain text is a
23553 security risk; you are strongly advised to insist on the use of SMTP encryption
23554 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
23555 use unencrypted plain text, you should not use the same passwords for SMTP
23556 connections as you do for login accounts.
23557
23558 .section "Plaintext options" "SECID171"
23559 .cindex "options" "&(plaintext)& authenticator (server)"
23560 When configured as a server, &(plaintext)& uses the following options:
23561
23562 .option server_condition authenticators string&!! unset
23563 This is actually a global authentication option, but it must be set in order to
23564 configure the &(plaintext)& driver as a server. Its use is described below.
23565
23566 .option server_prompts plaintext string&!! unset
23567 The contents of this option, after expansion, must be a colon-separated list of
23568 prompt strings. If expansion fails, a temporary authentication rejection is
23569 given.
23570
23571 .section "Using plaintext in a server" "SECTplainserver"
23572 .cindex "AUTH" "in &(plaintext)& authenticator"
23573 .cindex "binary zero" "in &(plaintext)& authenticator"
23574 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
23575         "in &(plaintext)& authenticator"
23576 .vindex "&$auth1$&, &$auth2$&, etc"
23577 .cindex "base64 encoding" "in &(plaintext)& authenticator"
23578
23579 When running as a server, &(plaintext)& performs the authentication test by
23580 expanding a string. The data sent by the client with the AUTH command, or in
23581 response to subsequent prompts, is base64 encoded, and so may contain any byte
23582 values when decoded. If any data is supplied with the command, it is treated as
23583 a list of strings, separated by NULs (binary zeros), the first three of which
23584 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
23585 (neither LOGIN nor PLAIN uses more than three strings).
23586
23587 For compatibility with previous releases of Exim, the values are also placed in
23588 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
23589 variables for this purpose is now deprecated, as it can lead to confusion in
23590 string expansions that also use them for other things.
23591
23592 If there are more strings in &%server_prompts%& than the number of strings
23593 supplied with the AUTH command, the remaining prompts are used to obtain more
23594 data. Each response from the client may be a list of NUL-separated strings.
23595
23596 .vindex "&$authenticated_id$&"
23597 Once a sufficient number of data strings have been received,
23598 &%server_condition%& is expanded. If the expansion is forced to fail,
23599 authentication fails. Any other expansion failure causes a temporary error code
23600 to be returned. If the result of a successful expansion is an empty string,
23601 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
23602 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
23603 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
23604 For any other result, a temporary error code is returned, with the expanded
23605 string as the error text.
23606
23607 &*Warning*&: If you use a lookup in the expansion to find the user's
23608 password, be sure to make the authentication fail if the user is unknown.
23609 There are good and bad examples at the end of the next section.
23610
23611
23612
23613 .section "The PLAIN authentication mechanism" "SECID172"
23614 .cindex "PLAIN authentication mechanism"
23615 .cindex "authentication" "PLAIN mechanism"
23616 .cindex "binary zero" "in &(plaintext)& authenticator"
23617 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
23618 sent as one item of data (that is, one combined string containing two NUL
23619 separators). The data is sent either as part of the AUTH command, or
23620 subsequently in response to an empty prompt from the server.
23621
23622 The second and third strings are a user name and a corresponding password.
23623 Using a single fixed user name and password as an example, this could be
23624 configured as follows:
23625 .code
23626 fixed_plain:
23627   driver = plaintext
23628   public_name = PLAIN
23629   server_prompts = :
23630   server_condition = \
23631     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
23632   server_set_id = $auth2
23633 .endd
23634 Note that the default result strings from &%if%& (&"true"& or an empty string)
23635 are exactly what we want here, so they need not be specified. Obviously, if the
23636 password contains expansion-significant characters such as dollar, backslash,
23637 or closing brace, they have to be escaped.
23638
23639 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
23640 the end of a string list are ignored). If all the data comes as part of the
23641 AUTH command, as is commonly the case, the prompt is not used. This
23642 authenticator is advertised in the response to EHLO as
23643 .code
23644 250-AUTH PLAIN
23645 .endd
23646 and a client host can authenticate itself by sending the command
23647 .code
23648 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
23649 .endd
23650 As this contains three strings (more than the number of prompts), no further
23651 data is required from the client. Alternatively, the client may just send
23652 .code
23653 AUTH PLAIN
23654 .endd
23655 to initiate authentication, in which case the server replies with an empty
23656 prompt. The client must respond with the combined data string.
23657
23658 The data string is base64 encoded, as required by the RFC. This example,
23659 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
23660 represents a zero byte. This is split up into three strings, the first of which
23661 is empty. The &%server_condition%& option in the authenticator checks that the
23662 second two are &`username`& and &`mysecret`& respectively.
23663
23664 Having just one fixed user name and password, as in this example, is not very
23665 realistic, though for a small organization with only a handful of
23666 authenticating clients it could make sense.
23667
23668 A more sophisticated instance of this authenticator could use the user name in
23669 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
23670 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
23671 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
23672 This is an incorrect example:
23673 .code
23674 server_condition = \
23675   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
23676 .endd
23677 The expansion uses the user name (&$auth2$&) as the key to look up a password,
23678 which it then compares to the supplied password (&$auth3$&). Why is this example
23679 incorrect? It works fine for existing users, but consider what happens if a
23680 non-existent user name is given. The lookup fails, but as no success/failure
23681 strings are given for the lookup, it yields an empty string. Thus, to defeat
23682 the authentication, all a client has to do is to supply a non-existent user
23683 name and an empty password. The correct way of writing this test is:
23684 .code
23685 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
23686   {${if eq{$value}{$auth3}}} {false}}
23687 .endd
23688 In this case, if the lookup succeeds, the result is checked; if the lookup
23689 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
23690 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
23691 always fails if its second argument is empty. However, the second way of
23692 writing the test makes the logic clearer.
23693
23694
23695 .section "The LOGIN authentication mechanism" "SECID173"
23696 .cindex "LOGIN authentication mechanism"
23697 .cindex "authentication" "LOGIN mechanism"
23698 The LOGIN authentication mechanism is not documented in any RFC, but is in use
23699 in a number of programs. No data is sent with the AUTH command. Instead, a
23700 user name and password are supplied separately, in response to prompts. The
23701 plaintext authenticator can be configured to support this as in this example:
23702 .code
23703 fixed_login:
23704   driver = plaintext
23705   public_name = LOGIN
23706   server_prompts = User Name : Password
23707   server_condition = \
23708     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
23709   server_set_id = $auth1
23710 .endd
23711 Because of the way plaintext operates, this authenticator accepts data supplied
23712 with the AUTH command (in contravention of the specification of LOGIN), but
23713 if the client does not supply it (as is the case for LOGIN clients), the prompt
23714 strings are used to obtain two data items.
23715
23716 Some clients are very particular about the precise text of the prompts. For
23717 example, Outlook Express is reported to recognize only &"Username:"& and
23718 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
23719 strings. It uses the &%ldapauth%& expansion condition to check the user
23720 name and password by binding to an LDAP server:
23721 .code
23722 login:
23723   driver = plaintext
23724   public_name = LOGIN
23725   server_prompts = Username:: : Password::
23726   server_condition = ${if and{{
23727     !eq{}{$auth1} }{ \
23728     ldapauth{user="cn=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
23729              pass=${quote:$auth2} \
23730              ldap://ldap.example.org/} }} }
23731   server_set_id = uid=$auth1,ou=people,o=example.org
23732 .endd
23733 We have to check that the username is not empty before using it, because LDAP
23734 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
23735 operator to correctly quote the DN for authentication. However, the basic
23736 &%quote%& operator, rather than any of the LDAP quoting operators, is the
23737 correct one to use for the password, because quoting is needed only to make
23738 the password conform to the Exim syntax. At the LDAP level, the password is an
23739 uninterpreted string.
23740
23741
23742 .section "Support for different kinds of authentication" "SECID174"
23743 A number of string expansion features are provided for the purpose of
23744 interfacing to different ways of user authentication. These include checking
23745 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
23746 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
23747 &<<SECTexpcond>>&.
23748
23749
23750
23751
23752 .section "Using plaintext in a client" "SECID175"
23753 .cindex "options" "&(plaintext)& authenticator (client)"
23754 The &(plaintext)& authenticator has two client options:
23755
23756 .option client_ignore_invalid_base64 plaintext boolean false
23757 If the client receives a server prompt that is not a valid base64 string,
23758 authentication is abandoned by default. However, if this option is set true,
23759 the error in the challenge is ignored and the client sends the response as
23760 usual.
23761
23762 .option client_send plaintext string&!! unset
23763 The string is a colon-separated list of authentication data strings. Each
23764 string is independently expanded before being sent to the server. The first
23765 string is sent with the AUTH command; any more strings are sent in response
23766 to prompts from the server. Before each string is expanded, the value of the
23767 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
23768 with &$auth1$& for the first prompt. Up to three prompts are stored in this
23769 way. Thus, the prompt that is received in response to sending the first string
23770 (with the AUTH command) can be used in the expansion of the second string, and
23771 so on. If an invalid base64 string is received when
23772 &%client_ignore_invalid_base64%& is set, an empty string is put in the
23773 &$auth$&<&'n'&> variable.
23774
23775 &*Note*&: You cannot use expansion to create multiple strings, because
23776 splitting takes priority and happens first.
23777
23778 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
23779 the data, further processing is applied to each string before it is sent. If
23780 there are any single circumflex characters in the string, they are converted to
23781 NULs. Should an actual circumflex be required as data, it must be doubled in
23782 the string.
23783
23784 This is an example of a client configuration that implements the PLAIN
23785 authentication mechanism with a fixed user name and password:
23786 .code
23787 fixed_plain:
23788   driver = plaintext
23789   public_name = PLAIN
23790   client_send = ^username^mysecret
23791 .endd
23792 The lack of colons means that the entire text is sent with the AUTH
23793 command, with the circumflex characters converted to NULs. A similar example
23794 that uses the LOGIN mechanism is:
23795 .code
23796 fixed_login:
23797   driver = plaintext
23798   public_name = LOGIN
23799   client_send = : username : mysecret
23800 .endd
23801 The initial colon means that the first string is empty, so no data is sent with
23802 the AUTH command itself. The remaining strings are sent in response to
23803 prompts.
23804 .ecindex IIDplaiauth1
23805 .ecindex IIDplaiauth2
23806
23807
23808
23809
23810 . ////////////////////////////////////////////////////////////////////////////
23811 . ////////////////////////////////////////////////////////////////////////////
23812
23813 .chapter "The cram_md5 authenticator" "CHID9"
23814 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
23815 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
23816 .cindex "CRAM-MD5 authentication mechanism"
23817 .cindex "authentication" "CRAM-MD5 mechanism"
23818 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
23819 sends a challenge string to the client, and the response consists of a user
23820 name and the CRAM-MD5 digest of the challenge string combined with a secret
23821 string (password) which is known to both server and client. Thus, the secret
23822 is not sent over the network as plain text, which makes this authenticator more
23823 secure than &(plaintext)&. However, the downside is that the secret has to be
23824 available in plain text at either end.
23825
23826
23827 .section "Using cram_md5 as a server" "SECID176"
23828 .cindex "options" "&(cram_md5)& authenticator (server)"
23829 This authenticator has one server option, which must be set to configure the
23830 authenticator as a server:
23831
23832 .option server_secret cram_md5 string&!! unset
23833 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
23834 When the server receives the client's response, the user name is placed in
23835 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
23836 obtain the password for that user. The server then computes the CRAM-MD5 digest
23837 that the client should have sent, and checks that it received the correct
23838 string. If the expansion of &%server_secret%& is forced to fail, authentication
23839 fails. If the expansion fails for some other reason, a temporary error code is
23840 returned to the client.
23841
23842 For compatibility with previous releases of Exim, the user name is also placed
23843 in &$1$&. However, the use of this variables for this purpose is now
23844 deprecated, as it can lead to confusion in string expansions that also use
23845 numeric variables for other things.
23846
23847 For example, the following authenticator checks that the user name given by the
23848 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
23849 user name, authentication fails.
23850 .code
23851 fixed_cram:
23852   driver = cram_md5
23853   public_name = CRAM-MD5
23854   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
23855   server_set_id = $auth1
23856 .endd
23857 .vindex "&$authenticated_id$&"
23858 If authentication succeeds, the setting of &%server_set_id%& preserves the user
23859 name in &$authenticated_id$&. A more typical configuration might look up the
23860 secret string in a file, using the user name as the key. For example:
23861 .code
23862 lookup_cram:
23863   driver = cram_md5
23864   public_name = CRAM-MD5
23865   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
23866                   {$value}fail}
23867   server_set_id = $auth1
23868 .endd
23869 Note that this expansion explicitly forces failure if the lookup fails
23870 because &$auth1$& contains an unknown user name.
23871
23872
23873 .section "Using cram_md5 as a client" "SECID177"
23874 .cindex "options" "&(cram_md5)& authenticator (client)"
23875 When used as a client, the &(cram_md5)& authenticator has two options:
23876
23877
23878
23879 .option client_name cram_md5 string&!! "the primary host name"
23880 This string is expanded, and the result used as the user name data when
23881 computing the response to the server's challenge.
23882
23883
23884 .option client_secret cram_md5 string&!! unset
23885 This option must be set for the authenticator to work as a client. Its value is
23886 expanded and the result used as the secret string when computing the response.
23887
23888
23889 .vindex "&$host$&"
23890 .vindex "&$host_address$&"
23891 Different user names and secrets can be used for different servers by referring
23892 to &$host$& or &$host_address$& in the options. Forced failure of either
23893 expansion string is treated as an indication that this authenticator is not
23894 prepared to handle this case. Exim moves on to the next configured client
23895 authenticator. Any other expansion failure causes Exim to give up trying to
23896 send the message to the current server.
23897
23898 A simple example configuration of a &(cram_md5)& authenticator, using fixed
23899 strings, is:
23900 .code
23901 fixed_cram:
23902   driver = cram_md5
23903   public_name = CRAM-MD5
23904   client_name = ph10
23905   client_secret = secret
23906 .endd
23907 .ecindex IIDcramauth1
23908 .ecindex IIDcramauth2
23909
23910
23911
23912 . ////////////////////////////////////////////////////////////////////////////
23913 . ////////////////////////////////////////////////////////////////////////////
23914
23915 .chapter "The cyrus_sasl authenticator" "CHID10"
23916 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
23917 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
23918 .cindex "Cyrus" "SASL library"
23919 .cindex "Kerberos"
23920 The code for this authenticator was provided by Matthew Byng-Maddick of A L
23921 Digital Ltd (&url(http://www.aldigital.co.uk)).
23922
23923 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
23924 library implementation of the RFC 2222 (&"Simple Authentication and Security
23925 Layer"&). This library supports a number of authentication mechanisms,
23926 including PLAIN and LOGIN, but also several others that Exim does not support
23927 directly. In particular, there is support for Kerberos authentication.
23928
23929 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
23930 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
23931 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
23932 name of the driver to determine which mechanism to support.
23933
23934 Where access to some kind of secret file is required, for example in GSSAPI
23935 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
23936 user, and that the Cyrus SASL library has no way of escalating privileges
23937 by default. You may also find you need to set environment variables,
23938 depending on the driver you are using.
23939
23940 The application name provided by Exim is &"exim"&, so various SASL options may
23941 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
23942 Kerberos, note that because of limitations in the GSSAPI interface,
23943 changing the server keytab might need to be communicated down to the Kerberos
23944 layer independently. The mechanism for doing so is dependent upon the Kerberos
23945 implementation. For example, for Heimdal, the environment variable KRB5_KTNAME
23946 may be set to point to an alternative keytab file. Exim will pass this
23947 variable through from its own inherited environment when started as root or the
23948 Exim user. The keytab file needs to be readable by the Exim user.
23949
23950
23951 .section "Using cyrus_sasl as a server" "SECID178"
23952 The &(cyrus_sasl)& authenticator has four private options. It puts the username
23953 (on a successful authentication) into &$auth1$&. For compatibility with
23954 previous releases of Exim, the username is also placed in &$1$&. However, the
23955 use of this variable for this purpose is now deprecated, as it can lead to
23956 confusion in string expansions that also use numeric variables for other
23957 things.
23958
23959
23960 .option server_hostname cyrus_sasl string&!! "see below"
23961 This option selects the hostname that is used when communicating with the
23962 library. The default value is &`$primary_hostname`&. It is up to the underlying
23963 SASL plug-in what it does with this data.
23964
23965
23966 .option server_mech cyrus_sasl string "see below"
23967 This option selects the authentication mechanism this driver should use. The
23968 default is the value of the generic &%public_name%& option. This option allows
23969 you to use a different underlying mechanism from the advertised name. For
23970 example:
23971 .code
23972 sasl:
23973   driver = cyrus_sasl
23974   public_name = X-ANYTHING
23975   server_mech = CRAM-MD5
23976   server_set_id = $auth1
23977 .endd
23978
23979 .option server_realm cyrus_sasl string unset
23980 This specifies the SASL realm that the server claims to be in.
23981
23982
23983 .option server_service cyrus_sasl string &`smtp`&
23984 This is the SASL service that the server claims to implement.
23985
23986
23987 For straightforward cases, you do not need to set any of the authenticator's
23988 private options. All you need to do is to specify an appropriate mechanism as
23989 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
23990 PLAIN, you could have two authenticators as follows:
23991 .code
23992 sasl_cram_md5:
23993   driver = cyrus_sasl
23994   public_name = CRAM-MD5
23995   server_set_id = $auth1
23996
23997 sasl_plain:
23998   driver = cyrus_sasl
23999   public_name = PLAIN
24000   server_set_id = $auth2
24001 .endd
24002 Cyrus SASL does implement the LOGIN authentication method, even though it is
24003 not a standard method. It is disabled by default in the source distribution,
24004 but it is present in many binary distributions.
24005 .ecindex IIDcyrauth1
24006 .ecindex IIDcyrauth2
24007
24008
24009
24010
24011 . ////////////////////////////////////////////////////////////////////////////
24012 . ////////////////////////////////////////////////////////////////////////////
24013 .chapter "The dovecot authenticator" "CHAPdovecot"
24014 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
24015 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
24016 This authenticator is an interface to the authentication facility of the
24017 Dovecot POP/IMAP server, which can support a number of authentication methods.
24018 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
24019 to use the same mechanisms for SMTP authentication. This is a server
24020 authenticator only. There is only one option:
24021
24022 .option server_socket dovecot string unset
24023
24024 This option must specify the socket that is the interface to Dovecot
24025 authentication. The &%public_name%& option must specify an authentication
24026 mechanism that Dovecot is configured to support. You can have several
24027 authenticators for different mechanisms. For example:
24028 .code
24029 dovecot_plain:
24030   driver = dovecot
24031   public_name = PLAIN
24032   server_socket = /var/run/dovecot/auth-client
24033   server_set_id = $auth2
24034
24035 dovecot_ntlm:
24036   driver = dovecot
24037   public_name = NTLM
24038   server_socket = /var/run/dovecot/auth-client
24039   server_set_id = $auth1
24040 .endd
24041 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
24042 &$received_ip_address$& (that is, the connection is local), the &"secured"&
24043 option is passed in the Dovecot authentication command. If, for a TLS
24044 connection, a client certificate has been verified, the &"valid-client-cert"&
24045 option is passed. When authentication succeeds, the identity of the user
24046 who authenticated is placed in &$auth1$&.
24047 .ecindex IIDdcotauth1
24048 .ecindex IIDdcotauth2
24049
24050
24051 . ////////////////////////////////////////////////////////////////////////////
24052 . ////////////////////////////////////////////////////////////////////////////
24053
24054 .chapter "The spa authenticator" "CHAPspa"
24055 .scindex IIDspaauth1 "&(spa)& authenticator"
24056 .scindex IIDspaauth2 "authenticators" "&(spa)&"
24057 .cindex "authentication" "Microsoft Secure Password"
24058 .cindex "authentication" "NTLM"
24059 .cindex "Microsoft Secure Password Authentication"
24060 .cindex "NTLM authentication"
24061 The &(spa)& authenticator provides client support for Microsoft's &'Secure
24062 Password Authentication'& mechanism,
24063 which is also sometimes known as NTLM (NT LanMan). The code for client side of
24064 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
24065 taken from the Samba project (&url(http://www.samba.org)). The code for the
24066 server side was subsequently contributed by Tom Kistner. The mechanism works as
24067 follows:
24068
24069 .ilist
24070 After the AUTH command has been accepted, the client sends an SPA
24071 authentication request based on the user name and optional domain.
24072 .next
24073 The server sends back a challenge.
24074 .next
24075 The client builds a challenge response which makes use of the user's password
24076 and sends it to the server, which then accepts or rejects it.
24077 .endlist
24078
24079 Encryption is used to protect the password in transit.
24080
24081
24082
24083 .section "Using spa as a server" "SECID179"
24084 .cindex "options" "&(spa)& authenticator (server)"
24085 The &(spa)& authenticator has just one server option:
24086
24087 .option server_password spa string&!! unset
24088 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
24089 This option is expanded, and the result must be the cleartext password for the
24090 authenticating user, whose name is at this point in &$auth1$&. For
24091 compatibility with previous releases of Exim, the user name is also placed in
24092 &$1$&. However, the use of this variable for this purpose is now deprecated, as
24093 it can lead to confusion in string expansions that also use numeric variables
24094 for other things. For example:
24095 .code
24096 spa:
24097   driver = spa
24098   public_name = NTLM
24099   server_password = \
24100     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
24101 .endd
24102 If the expansion is forced to fail, authentication fails. Any other expansion
24103 failure causes a temporary error code to be returned.
24104
24105
24106
24107
24108
24109 .section "Using spa as a client" "SECID180"
24110 .cindex "options" "&(spa)& authenticator (client)"
24111 The &(spa)& authenticator has the following client options:
24112
24113
24114
24115 .option client_domain spa string&!! unset
24116 This option specifies an optional domain for the authentication.
24117
24118
24119 .option client_password spa string&!! unset
24120 This option specifies the user's password, and must be set.
24121
24122
24123 .option client_username spa string&!! unset
24124 This option specifies the user name, and must be set. Here is an example of a
24125 configuration of this authenticator for use with the mail servers at
24126 &'msn.com'&:
24127 .code
24128 msn:
24129   driver = spa
24130   public_name = MSN
24131   client_username = msn/msn_username
24132   client_password = msn_plaintext_password
24133   client_domain = DOMAIN_OR_UNSET
24134 .endd
24135 .ecindex IIDspaauth1
24136 .ecindex IIDspaauth2
24137
24138
24139
24140
24141
24142 . ////////////////////////////////////////////////////////////////////////////
24143 . ////////////////////////////////////////////////////////////////////////////
24144
24145 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
24146          "Encrypted SMTP connections"
24147 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
24148 .scindex IIDencsmtp2 "SMTP" "encryption"
24149 .cindex "TLS" "on SMTP connection"
24150 .cindex "OpenSSL"
24151 .cindex "GnuTLS"
24152 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
24153 Sockets Layer), is implemented by making use of the OpenSSL library or the
24154 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
24155 cryptographic code in the Exim distribution itself for implementing TLS. In
24156 order to use this feature you must install OpenSSL or GnuTLS, and then build a
24157 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
24158 You also need to understand the basic concepts of encryption at a managerial
24159 level, and in particular, the way that public keys, private keys, and
24160 certificates are used.
24161
24162 RFC 3207 defines how SMTP connections can make use of encryption. Once a
24163 connection is established, the client issues a STARTTLS command. If the
24164 server accepts this, the client and the server negotiate an encryption
24165 mechanism. If the negotiation succeeds, the data that subsequently passes
24166 between them is encrypted.
24167
24168 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
24169 and if so, what cipher suite is in use, whether the client supplied a
24170 certificate, and whether or not that certificate was verified. This makes it
24171 possible for an Exim server to deny or accept certain commands based on the
24172 encryption state.
24173
24174 &*Warning*&: Certain types of firewall and certain anti-virus products can
24175 disrupt TLS connections. You need to turn off SMTP scanning for these products
24176 in order to get TLS to work.
24177
24178
24179
24180 .section "Support for the legacy &""ssmtp""& (aka &""smtps""&) protocol" &&&
24181          "SECID284"
24182 .cindex "ssmtp protocol"
24183 .cindex "smtps protocol"
24184 .cindex "SMTP" "ssmtp protocol"
24185 .cindex "SMTP" "smtps protocol"
24186 Early implementations of encrypted SMTP used a different TCP port from normal
24187 SMTP, and expected an encryption negotiation to start immediately, instead of
24188 waiting for a STARTTLS command from the client using the standard SMTP
24189 port. The protocol was called &"ssmtp"& or &"smtps"&, and port 465 was
24190 allocated for this purpose.
24191
24192 This approach was abandoned when encrypted SMTP was standardized, but there are
24193 still some legacy clients that use it. Exim supports these clients by means of
24194 the &%tls_on_connect_ports%& global option. Its value must be a list of port
24195 numbers; the most common use is expected to be:
24196 .code
24197 tls_on_connect_ports = 465
24198 .endd
24199 The port numbers specified by this option apply to all SMTP connections, both
24200 via the daemon and via &'inetd'&. You still need to specify all the ports that
24201 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
24202 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
24203 an extra port &-- rather, it specifies different behaviour on a port that is
24204 defined elsewhere.
24205
24206 There is also a &%-tls-on-connect%& command line option. This overrides
24207 &%tls_on_connect_ports%&; it forces the legacy behaviour for all ports.
24208
24209
24210
24211
24212
24213
24214 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
24215 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
24216 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
24217 followed later, when the first versions of GnuTLS were released. To build Exim
24218 to use GnuTLS, you need to set
24219 .code
24220 USE_GNUTLS=yes
24221 .endd
24222 in Local/Makefile, in addition to
24223 .code
24224 SUPPORT_TLS=yes
24225 .endd
24226 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
24227 include files and libraries for GnuTLS can be found.
24228
24229 There are some differences in usage when using GnuTLS instead of OpenSSL:
24230
24231 .ilist
24232 The &%tls_verify_certificates%& option must contain the name of a file, not the
24233 name of a directory (for OpenSSL it can be either).
24234 .next
24235 The &%tls_dhparam%& option is ignored, because early versions of GnuTLS had no
24236 facility for varying its Diffie-Hellman parameters. I understand that this has
24237 changed, but Exim has not been updated to provide this facility.
24238 .next
24239 .vindex "&$tls_peerdn$&"
24240 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
24241 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
24242 affects the value of the &$tls_peerdn$& variable.
24243 .next
24244 OpenSSL identifies cipher suites using hyphens as separators, for example:
24245 DES-CBC3-SHA. GnuTLS uses underscores, for example: RSA_ARCFOUR_SHA. What is
24246 more, OpenSSL complains if underscores are present in a cipher list. To make
24247 life simpler, Exim changes underscores to hyphens for OpenSSL and hyphens to
24248 underscores for GnuTLS when processing lists of cipher suites in the
24249 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
24250 option).
24251 .next
24252 The &%tls_require_ciphers%& options operate differently, as described in the
24253 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
24254 .endlist
24255
24256
24257 .section "GnuTLS parameter computation" "SECID181"
24258 GnuTLS uses D-H parameters that may take a substantial amount of time
24259 to compute. It is unreasonable to re-compute them for every TLS session.
24260 Therefore, Exim keeps this data in a file in its spool directory, called
24261 &_gnutls-params_&. The file is owned by the Exim user and is readable only by
24262 its owner. Every Exim process that start up GnuTLS reads the D-H
24263 parameters from this file. If the file does not exist, the first Exim process
24264 that needs it computes the data and writes it to a temporary file which is
24265 renamed once it is complete. It does not matter if several Exim processes do
24266 this simultaneously (apart from wasting a few resources). Once a file is in
24267 place, new Exim processes immediately start using it.
24268
24269 For maximum security, the parameters that are stored in this file should be
24270 recalculated periodically, the frequency depending on your paranoia level.
24271 Arranging this is easy in principle; just delete the file when you want new
24272 values to be computed. However, there may be a problem. The calculation of new
24273 parameters needs random numbers, and these are obtained from &_/dev/random_&.
24274 If the system is not very active, &_/dev/random_& may delay returning data
24275 until enough randomness (entropy) is available. This may cause Exim to hang for
24276 a substantial amount of time, causing timeouts on incoming connections.
24277
24278 The solution is to generate the parameters externally to Exim. They are stored
24279 in &_gnutls-params_& in PEM format, which means that they can be generated
24280 externally using the &(certtool)& command that is part of GnuTLS.
24281
24282 To replace the parameters with new ones, instead of deleting the file
24283 and letting Exim re-create it, you can generate new parameters using
24284 &(certtool)& and, when this has been done, replace Exim's cache file by
24285 renaming. The relevant commands are something like this:
24286 .code
24287 # rm -f new-params
24288 # touch new-params
24289 # chown exim:exim new-params
24290 # chmod 0400 new-params
24291 # certtool --generate-privkey --bits 512 >new-params
24292 # echo "" >>new-params
24293 # certtool --generate-dh-params --bits 1024 >> new-params
24294 # mv new-params gnutls-params
24295 .endd
24296 If Exim never has to generate the parameters itself, the possibility of
24297 stalling is removed.
24298
24299
24300 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
24301 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
24302 .oindex "&%tls_require_ciphers%&" "OpenSSL"
24303 There is a function in the OpenSSL library that can be passed a list of cipher
24304 suites before the cipher negotiation takes place. This specifies which ciphers
24305 are acceptable. The list is colon separated and may contain names like
24306 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
24307 directly to this function call. The following quotation from the OpenSSL
24308 documentation specifies what forms of item are allowed in the cipher string:
24309
24310 .ilist
24311 It can consist of a single cipher suite such as RC4-SHA.
24312 .next
24313 It can represent a list of cipher suites containing a certain algorithm,
24314 or cipher suites of a certain type. For example SHA1 represents all
24315 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
24316 SSL v3 algorithms.
24317 .next
24318 Lists of cipher suites can be combined in a single cipher string using
24319 the + character. This is used as a logical and operation. For example
24320 SHA1+DES represents all cipher suites containing the SHA1 and the DES
24321 algorithms.
24322 .endlist
24323
24324 Each cipher string can be optionally preceded by one of the characters &`!`&,
24325 &`-`& or &`+`&.
24326 .ilist
24327 If &`!`& is used, the ciphers are permanently deleted from the list. The
24328 ciphers deleted can never reappear in the list even if they are explicitly
24329 stated.
24330 .next
24331 If &`-`& is used, the ciphers are deleted from the list, but some or all
24332 of the ciphers can be added again by later options.
24333 .next
24334 If &`+`& is used, the ciphers are moved to the end of the list. This
24335 option does not add any new ciphers; it just moves matching existing ones.
24336 .endlist
24337
24338 If none of these characters is present, the string is interpreted as
24339 a list of ciphers to be appended to the current preference list. If the list
24340 includes any ciphers already present they will be ignored: that is, they will
24341 not be moved to the end of the list.
24342 .endlist
24343
24344
24345
24346 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
24347          "SECTreqciphgnu"
24348 .cindex "GnuTLS" "specifying parameters for"
24349 .cindex "TLS" "specifying ciphers (GnuTLS)"
24350 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
24351 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
24352 .cindex "TLS" "specifying protocols (GnuTLS)"
24353 .oindex "&%tls_require_ciphers%&" "GnuTLS"
24354 The GnuTLS library allows the caller to specify separate lists of permitted key
24355 exchange methods, main cipher algorithms, MAC algorithms, and protocols.
24356 Unfortunately, these lists are numerical, and the library does not have a
24357 function for turning names into numbers. Consequently, lists of recognized
24358 names have to be built into the application. The permitted key exchange
24359 methods, ciphers, and MAC algorithms may be used in any combination to form a
24360 cipher suite. This is unlike OpenSSL, where complete cipher suite names are
24361 passed to its control function.
24362
24363 For compatibility with OpenSSL, the &%tls_require_ciphers%& option can be set
24364 to complete cipher suite names such as RSA_ARCFOUR_SHA, but for GnuTLS this
24365 option controls only the cipher algorithms. Exim searches each item in the
24366 list for the name of an available algorithm. For example, if the list
24367 contains RSA_AES_SHA, then AES is recognized, and the behaviour is exactly
24368 the same as if just AES were given.
24369
24370 .oindex "&%gnutls_require_kx%&"
24371 .oindex "&%gnutls_require_mac%&"
24372 .oindex "&%gnutls_require_protocols%&"
24373 There are additional options called &%gnutls_require_kx%&,
24374 &%gnutls_require_mac%&, and &%gnutls_require_protocols%& that can be used to
24375 restrict the key exchange methods, MAC algorithms, and protocols, respectively.
24376 These options are ignored if OpenSSL is in use.
24377
24378 All four options are available as global options, controlling how Exim
24379 behaves as a server, and also as options of the &(smtp)& transport, controlling
24380 how Exim behaves as a client. All the values are string expanded. After
24381 expansion, the values must be colon-separated lists, though the separator
24382 can be changed in the usual way.
24383
24384 Each of the four lists starts out with a default set of algorithms. If the
24385 first item in a list does &'not'& start with an exclamation mark, all the
24386 default items are deleted. In this case, only those that are explicitly
24387 specified can be used. If the first item in a list &'does'& start with an
24388 exclamation mark, the defaults are left on the list.
24389
24390 Then, any item that starts with an exclamation mark causes the relevant
24391 entry to be removed from the list, and any item that does not start with an
24392 exclamation mark causes a new entry to be added to the list. Unrecognized
24393 items in the list are ignored. Thus:
24394 .code
24395 tls_require_ciphers = !ARCFOUR
24396 .endd
24397 allows all the defaults except ARCFOUR, whereas
24398 .code
24399 tls_require_ciphers = AES : 3DES
24400 .endd
24401 allows only cipher suites that use AES or 3DES.
24402
24403 For &%tls_require_ciphers%& the recognized names are AES_256, AES_128, AES
24404 (both of the preceding), 3DES, ARCFOUR_128, ARCFOUR_40, and ARCFOUR (both of
24405 the preceding). The default list does not contain all of these; it just has
24406 AES_256, AES_128, 3DES, and ARCFOUR_128.
24407
24408 For &%gnutls_require_kx%&, the recognized names are DHE_RSA, RSA (which
24409 includes DHE_RSA), DHE_DSS, and DHE (which includes both DHE_RSA and
24410 DHE_DSS). The default list contains RSA, DHE_DSS, DHE_RSA.
24411
24412 For &%gnutls_require_mac%&, the recognized names are SHA (synonym SHA1), and
24413 MD5. The default list contains SHA, MD5.
24414
24415 For &%gnutls_require_protocols%&, the recognized names are TLS1 and SSL3.
24416 The default list contains TLS1, SSL3.
24417
24418 In a server, the order of items in these lists is unimportant. The server
24419 advertises the availability of all the relevant cipher suites. However, in a
24420 client, the order in the &%tls_require_ciphers%& list specifies a preference
24421 order for the cipher algorithms. The first one in the client's list that is
24422 also advertised by the server is tried first. The default order is as listed
24423 above.
24424
24425
24426
24427 .section "Configuring an Exim server to use TLS" "SECID182"
24428 .cindex "TLS" "configuring an Exim server"
24429 When Exim has been built with TLS support, it advertises the availability of
24430 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
24431 but not to any others. The default value of this option is unset, which means
24432 that STARTTLS is not advertised at all. This default is chosen because you
24433 need to set some other options in order to make TLS available, and also it is
24434 sensible for systems that want to use TLS only as a client.
24435
24436 If a client issues a STARTTLS command and there is some configuration
24437 problem in the server, the command is rejected with a 454 error. If the client
24438 persists in trying to issue SMTP commands, all except QUIT are rejected
24439 with the error
24440 .code
24441 554 Security failure
24442 .endd
24443 If a STARTTLS command is issued within an existing TLS session, it is
24444 rejected with a 554 error code.
24445
24446 To enable TLS operations on a server, you must set &%tls_advertise_hosts%& to
24447 match some hosts. You can, of course, set it to * to match all hosts.
24448 However, this is not all you need to do. TLS sessions to a server won't work
24449 without some further configuration at the server end.
24450
24451 It is rumoured that all existing clients that support TLS/SSL use RSA
24452 encryption. To make this work you need to set, in the server,
24453 .code
24454 tls_certificate = /some/file/name
24455 tls_privatekey = /some/file/name
24456 .endd
24457 These options are, in fact, expanded strings, so you can make them depend on
24458 the identity of the client that is connected if you wish. The first file
24459 contains the server's X509 certificate, and the second contains the private key
24460 that goes with it. These files need to be readable by the Exim user, and must
24461 always be given as full path names. They can be the same file if both the
24462 certificate and the key are contained within it. If &%tls_privatekey%& is not
24463 set, or if its expansion is forced to fail or results in an empty string, this
24464 is assumed to be the case. The certificate file may also contain intermediate
24465 certificates that need to be sent to the client to enable it to authenticate
24466 the server's certificate.
24467
24468 If you do not understand about certificates and keys, please try to find a
24469 source of this background information, which is not Exim-specific. (There are a
24470 few comments below in section &<<SECTcerandall>>&.)
24471
24472 &*Note*&: These options do not apply when Exim is operating as a client &--
24473 they apply only in the case of a server. If you need to use a certificate in an
24474 Exim client, you must set the options of the same names in an &(smtp)&
24475 transport.
24476
24477 With just these options, an Exim server will be able to use TLS. It does not
24478 require the client to have a certificate (but see below for how to insist on
24479 this). There is one other option that may be needed in other situations. If
24480 .code
24481 tls_dhparam = /some/file/name
24482 .endd
24483 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
24484 with the parameters contained in the file. This increases the set of cipher
24485 suites that the server supports. See the command
24486 .code
24487 openssl dhparam
24488 .endd
24489 for a way of generating this data. At present, &%tls_dhparam%& is used only
24490 when Exim is linked with OpenSSL. It is ignored if GnuTLS is being used.
24491
24492 The strings supplied for these three options are expanded every time a client
24493 host connects. It is therefore possible to use different certificates and keys
24494 for different hosts, if you so wish, by making use of the client's IP address
24495 in &$sender_host_address$& to control the expansion. If a string expansion is
24496 forced to fail, Exim behaves as if the option is not set.
24497
24498 .cindex "cipher" "logging"
24499 .cindex "log" "TLS cipher"
24500 .vindex "&$tls_cipher$&"
24501 The variable &$tls_cipher$& is set to the cipher suite that was negotiated for
24502 an incoming TLS connection. It is included in the &'Received:'& header of an
24503 incoming message (by default &-- you can, of course, change this), and it is
24504 also included in the log line that records a message's arrival, keyed by
24505 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
24506 condition can be used to test for specific cipher suites in ACLs.
24507 (For outgoing SMTP deliveries, &$tls_cipher$& is reset &-- see section
24508 &<<SECID185>>&.)
24509
24510 Once TLS has been established, the ACLs that run for subsequent SMTP commands
24511 can check the name of the cipher suite and vary their actions accordingly. The
24512 cipher suite names vary, depending on which TLS library is being used. For
24513 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
24514 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
24515 documentation for more details.
24516
24517
24518 .section "Requesting and verifying client certificates" "SECID183"
24519 .cindex "certificate" "verification of client"
24520 .cindex "TLS" "client certificate verification"
24521 If you want an Exim server to request a certificate when negotiating a TLS
24522 session with a client, you must set either &%tls_verify_hosts%& or
24523 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
24524 apply to all TLS connections. For any host that matches one of these options,
24525 Exim requests a certificate as part of the setup of the TLS session. The
24526 contents of the certificate are verified by comparing it with a list of
24527 expected certificates. These must be available in a file or,
24528 for OpenSSL only (not GnuTLS), a directory, identified by
24529 &%tls_verify_certificates%&.
24530
24531 A file can contain multiple certificates, concatenated end to end. If a
24532 directory is used
24533 (OpenSSL only),
24534 each certificate must be in a separate file, with a name (or a symbolic link)
24535 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
24536 certificate. You can compute the relevant hash by running the command
24537 .code
24538 openssl x509 -hash -noout -in /cert/file
24539 .endd
24540 where &_/cert/file_& contains a single certificate.
24541
24542 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
24543 what happens if the client does not supply a certificate, or if the certificate
24544 does not match any of the certificates in the collection named by
24545 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
24546 attempt to set up a TLS session is aborted, and the incoming connection is
24547 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
24548 session continues. ACLs that run for subsequent SMTP commands can detect the
24549 fact that no certificate was verified, and vary their actions accordingly. For
24550 example, you can insist on a certificate before accepting a message for
24551 relaying, but not when the message is destined for local delivery.
24552
24553 .vindex "&$tls_peerdn$&"
24554 When a client supplies a certificate (whether it verifies or not), the value of
24555 the Distinguished Name of the certificate is made available in the variable
24556 &$tls_peerdn$& during subsequent processing of the message.
24557
24558 .cindex "log" "distinguished name"
24559 Because it is often a long text string, it is not included in the log line or
24560 &'Received:'& header by default. You can arrange for it to be logged, keyed by
24561 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
24562 &%received_header_text%& to change the &'Received:'& header. When no
24563 certificate is supplied, &$tls_peerdn$& is empty.
24564
24565
24566 .section "Revoked certificates" "SECID184"
24567 .cindex "TLS" "revoked certificates"
24568 .cindex "revocation list"
24569 .cindex "certificate" "revocation list"
24570 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
24571 certificates are revoked. If you have such a list, you can pass it to an Exim
24572 server using the global option called &%tls_crl%& and to an Exim client using
24573 an identically named option for the &(smtp)& transport. In each case, the value
24574 of the option is expanded and must then be the name of a file that contains a
24575 CRL in PEM format.
24576
24577
24578 .section "Configuring an Exim client to use TLS" "SECID185"
24579 .cindex "cipher" "logging"
24580 .cindex "log" "TLS cipher"
24581 .cindex "log" "distinguished name"
24582 .cindex "TLS" "configuring an Exim client"
24583 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
24584 deliveries as well as to incoming, the latter one causing logging of the
24585 server certificate's DN. The remaining client configuration for TLS is all
24586 within the &(smtp)& transport.
24587
24588 It is not necessary to set any options to have TLS work in the &(smtp)&
24589 transport. If Exim is built with TLS support, and TLS is advertised by a
24590 server, the &(smtp)& transport always tries to start a TLS session. However,
24591 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
24592 transport) to a list of server hosts for which TLS should not be used.
24593
24594 If you do not want Exim to attempt to send messages unencrypted when an attempt
24595 to set up an encrypted connection fails in any way, you can set
24596 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
24597 those hosts, delivery is always deferred if an encrypted connection cannot be
24598 set up. If there are any other hosts for the address, they are tried in the
24599 usual way.
24600
24601 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
24602 the message unencrypted. It always does this if the response to STARTTLS is
24603 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
24604 session after a success response code, what happens is controlled by the
24605 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
24606 delivery to this host is deferred, and other hosts (if available) are tried. If
24607 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
24608 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
24609 negotiation fails, Exim closes the current connection (because it is in an
24610 unknown state), opens a new one to the same host, and then tries the delivery
24611 unencrypted.
24612
24613 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
24614 transport provide the client with a certificate, which is passed to the server
24615 if it requests it. If the server is Exim, it will request a certificate only if
24616 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
24617
24618 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
24619 must name a file or,
24620 for OpenSSL only (not GnuTLS), a directory, that contains a collection of
24621 expected server certificates. The client verifies the server's certificate
24622 against this collection, taking into account any revoked certificates that are
24623 in the list defined by &%tls_crl%&.
24624
24625 If
24626 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
24627 list of permitted cipher suites. If either of these checks fails, delivery to
24628 the current host is abandoned, and the &(smtp)& transport tries to deliver to
24629 alternative hosts, if any.
24630
24631  &*Note*&:
24632 These options must be set in the &(smtp)& transport for Exim to use TLS when it
24633 is operating as a client. Exim does not assume that a server certificate (set
24634 by the global options of the same name) should also be used when operating as a
24635 client.
24636
24637 .vindex "&$host$&"
24638 .vindex "&$host_address$&"
24639 All the TLS options in the &(smtp)& transport are expanded before use, with
24640 &$host$& and &$host_address$& containing the name and address of the server to
24641 which the client is connected. Forced failure of an expansion causes Exim to
24642 behave as if the relevant option were unset.
24643
24644 .vindex &$tls_cipher$&
24645 .vindex &$tls_peerdn$&
24646 Before an SMTP connection is established, the &$tls_cipher$& and &$tls_peerdn$&
24647 variables are emptied. (Until the first connection, they contain the values
24648 that were set when the message was received.) If STARTTLS is subsequently
24649 successfully obeyed, these variables are set to the relevant values for the
24650 outgoing connection.
24651
24652
24653
24654 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
24655          "SECTmulmessam"
24656 .cindex "multiple SMTP deliveries with TLS"
24657 .cindex "TLS" "multiple message deliveries"
24658 Exim sends multiple messages down the same TCP/IP connection by starting up
24659 an entirely new delivery process for each message, passing the socket from
24660 one process to the next. This implementation does not fit well with the use
24661 of TLS, because there is quite a lot of state information associated with a TLS
24662 connection, not just a socket identification. Passing all the state information
24663 to a new process is not feasible. Consequently, Exim shuts down an existing TLS
24664 session before passing the socket to a new process. The new process may then
24665 try to start a new TLS session, and if successful, may try to re-authenticate
24666 if AUTH is in use, before sending the next message.
24667
24668 The RFC is not clear as to whether or not an SMTP session continues in clear
24669 after TLS has been shut down, or whether TLS may be restarted again later, as
24670 just described. However, if the server is Exim, this shutdown and
24671 reinitialization works. It is not known which (if any) other servers operate
24672 successfully if the client closes a TLS session and continues with unencrypted
24673 SMTP, but there are certainly some that do not work. For such servers, Exim
24674 should not pass the socket to another process, because the failure of the
24675 subsequent attempt to use it would cause Exim to record a temporary host error,
24676 and delay other deliveries to that host.
24677
24678 To test for this case, Exim sends an EHLO command to the server after
24679 closing down the TLS session. If this fails in any way, the connection is
24680 closed instead of being passed to a new delivery process, but no retry
24681 information is recorded.
24682
24683 There is also a manual override; you can set &%hosts_nopass_tls%& on the
24684 &(smtp)& transport to match those hosts for which Exim should not pass
24685 connections to new processes if TLS has been used.
24686
24687
24688
24689
24690 .section "Certificates and all that" "SECTcerandall"
24691 .cindex "certificate" "references to discussion"
24692 In order to understand fully how TLS works, you need to know about
24693 certificates, certificate signing, and certificate authorities. This is not the
24694 place to give a tutorial, especially as I do not know very much about it
24695 myself. Some helpful introduction can be found in the FAQ for the SSL addition
24696 to Apache, currently at
24697 .display
24698 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
24699 .endd
24700 Other parts of the &'modssl'& documentation are also helpful, and have
24701 links to further files.
24702 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
24703 0-201-61598-3), contains both introductory and more in-depth descriptions.
24704 Some sample programs taken from the book are available from
24705 .display
24706 &url(http://www.rtfm.com/openssl-examples/)
24707 .endd
24708
24709
24710 .section "Certificate chains" "SECID186"
24711 The file named by &%tls_certificate%& may contain more than one
24712 certificate. This is useful in the case where the certificate that is being
24713 sent is validated by an intermediate certificate which the other end does
24714 not have. Multiple certificates must be in the correct order in the file.
24715 First the host's certificate itself, then the first intermediate
24716 certificate to validate the issuer of the host certificate, then the next
24717 intermediate certificate to validate the issuer of the first intermediate
24718 certificate, and so on, until finally (optionally) the root certificate.
24719 The root certificate must already be trusted by the recipient for
24720 validation to succeed, of course, but if it's not preinstalled, sending the
24721 root certificate along with the rest makes it available for the user to
24722 install if the receiving end is a client MUA that can interact with a user.
24723
24724
24725 .section "Self-signed certificates" "SECID187"
24726 .cindex "certificate" "self-signed"
24727 You can create a self-signed certificate using the &'req'& command provided
24728 with OpenSSL, like this:
24729 .code
24730 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
24731             -days 9999 -nodes
24732 .endd
24733 &_file1_& and &_file2_& can be the same file; the key and the certificate are
24734 delimited and so can be identified independently. The &%-days%& option
24735 specifies a period for which the certificate is valid. The &%-nodes%& option is
24736 important: if you do not set it, the key is encrypted with a passphrase
24737 that you are prompted for, and any use that is made of the key causes more
24738 prompting for the passphrase. This is not helpful if you are going to use
24739 this certificate and key in an MTA, where prompting is not possible.
24740
24741 A self-signed certificate made in this way is sufficient for testing, and
24742 may be adequate for all your requirements if you are mainly interested in
24743 encrypting transfers, and not in secure identification.
24744
24745 However, many clients require that the certificate presented by the server be a
24746 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
24747 certificate. In this situation, the self-signed certificate described above
24748 must be installed on the client host as a trusted root &'certification
24749 authority'& (CA), and the certificate used by Exim must be a user certificate
24750 signed with that self-signed certificate.
24751
24752 For information on creating self-signed CA certificates and using them to sign
24753 user certificates, see the &'General implementation overview'& chapter of the
24754 Open-source PKI book, available online at
24755 &url(http://ospkibook.sourceforge.net/).
24756 .ecindex IIDencsmtp1
24757 .ecindex IIDencsmtp2
24758
24759
24760
24761 . ////////////////////////////////////////////////////////////////////////////
24762 . ////////////////////////////////////////////////////////////////////////////
24763
24764 .chapter "Access control lists" "CHAPACL"
24765 .scindex IIDacl "&ACL;" "description"
24766 .cindex "control of incoming mail"
24767 .cindex "message" "controlling incoming"
24768 .cindex "policy control" "access control lists"
24769 Access Control Lists (ACLs) are defined in a separate section of the run time
24770 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
24771 name, terminated by a colon. Here is a complete ACL section that contains just
24772 one very small ACL:
24773 .code
24774 begin acl
24775 small_acl:
24776   accept   hosts = one.host.only
24777 .endd
24778 You can have as many lists as you like in the ACL section, and the order in
24779 which they appear does not matter. The lists are self-terminating.
24780
24781 The majority of ACLs are used to control Exim's behaviour when it receives
24782 certain SMTP commands. This applies both to incoming TCP/IP connections, and
24783 when a local process submits a message using SMTP by specifying the &%-bs%&
24784 option. The most common use is for controlling which recipients are accepted
24785 in incoming messages. In addition, you can define an ACL that is used to check
24786 local non-SMTP messages. The default configuration file contains an example of
24787 a realistic ACL for checking RCPT commands. This is discussed in chapter
24788 &<<CHAPdefconfil>>&.
24789
24790
24791 .section "Testing ACLs" "SECID188"
24792 The &%-bh%& command line option provides a way of testing your ACL
24793 configuration locally by running a fake SMTP session with which you interact.
24794 The host &'relay-test.mail-abuse.org'& provides a service for checking your
24795 relaying configuration (see section &<<SECTcheralcon>>& for more details).
24796
24797
24798
24799 .section "Specifying when ACLs are used" "SECID189"
24800 .cindex "&ACL;" "options for specifying"
24801 In order to cause an ACL to be used, you have to name it in one of the relevant
24802 options in the main part of the configuration. These options are:
24803 .cindex "AUTH" "ACL for"
24804 .cindex "DATA" "ACLs for"
24805 .cindex "ETRN" "ACL for"
24806 .cindex "EXPN" "ACL for"
24807 .cindex "HELO" "ACL for"
24808 .cindex "EHLO" "ACL for"
24809 .cindex "MAIL" "ACL for"
24810 .cindex "QUIT, ACL for"
24811 .cindex "RCPT" "ACL for"
24812 .cindex "STARTTLS, ACL for"
24813 .cindex "VRFY" "ACL for"
24814 .cindex "SMTP" "connection, ACL for"
24815 .cindex "non-SMTP messages" "ACLs for"
24816 .cindex "MIME content scanning" "ACL for"
24817
24818 .table2 140pt
24819 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
24820 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
24821 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
24822 .irow &%acl_smtp_auth%&        "ACL for AUTH"
24823 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
24824 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
24825 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
24826 .irow &%acl_smtp_expn%&        "ACL for EXPN"
24827 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
24828 .irow &%acl_smtp_mail%&        "ACL for MAIL"
24829 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
24830 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
24831 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
24832 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
24833 .irow &%acl_smtp_quit%&        "ACL for QUIT"
24834 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
24835 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
24836 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
24837 .endtable
24838
24839 For example, if you set
24840 .code
24841 acl_smtp_rcpt = small_acl
24842 .endd
24843 the little ACL defined above is used whenever Exim receives a RCPT command
24844 in an SMTP dialogue. The majority of policy tests on incoming messages can be
24845 done when RCPT commands arrive. A rejection of RCPT should cause the
24846 sending MTA to give up on the recipient address contained in the RCPT
24847 command, whereas rejection at other times may cause the client MTA to keep on
24848 trying to deliver the message. It is therefore recommended that you do as much
24849 testing as possible at RCPT time.
24850
24851
24852 .section "The non-SMTP ACLs" "SECID190"
24853 .cindex "non-SMTP messages" "ACLs for"
24854 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
24855 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
24856 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
24857 the state of the SMTP connection such as encryption and authentication) are not
24858 relevant and are forbidden in these ACLs. However, the sender and recipients
24859 are known, so the &%senders%& and &%sender_domains%& conditions and the
24860 &$sender_address$& and &$recipients$& variables can be used. Variables such as
24861 &$authenticated_sender$& are also available. You can specify added header lines
24862 in any of these ACLs.
24863
24864 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
24865 non-SMTP message, before any of the message has been read. (This is the
24866 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
24867 batched SMTP input, it runs after the DATA command has been reached. The
24868 result of this ACL is ignored; it cannot be used to reject a message. If you
24869 really need to, you could set a value in an ACL variable here and reject based
24870 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
24871 controls, and in particular, it can be used to set
24872 .code
24873 control = suppress_local_fixups
24874 .endd
24875 This cannot be used in the other non-SMTP ACLs because by the time they are
24876 run, it is too late.
24877
24878 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
24879 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
24880
24881 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
24882 kind of rejection is treated as permanent, because there is no way of sending a
24883 temporary error for these kinds of message.
24884
24885
24886 .section "The SMTP connect ACL" "SECID191"
24887 .cindex "SMTP" "connection, ACL for"
24888 .oindex &%smtp_banner%&
24889 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
24890 session, after the test specified by &%host_reject_connection%& (which is now
24891 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
24892 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
24893 the message override the banner message that is otherwise specified by the
24894 &%smtp_banner%& option.
24895
24896
24897 .section "The EHLO/HELO ACL" "SECID192"
24898 .cindex "EHLO" "ACL for"
24899 .cindex "HELO" "ACL for"
24900 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
24901 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
24902 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
24903 Note that a client may issue more than one EHLO or HELO command in an SMTP
24904 session, and indeed is required to issue a new EHLO or HELO after successfully
24905 setting up encryption following a STARTTLS command.
24906
24907 If the command is accepted by an &%accept%& verb that has a &%message%&
24908 modifier, the message may not contain more than one line (it will be truncated
24909 at the first newline and a panic logged if it does). Such a message cannot
24910 affect the EHLO options that are listed on the second and subsequent lines of
24911 an EHLO response.
24912
24913
24914 .section "The DATA ACLs" "SECID193"
24915 .cindex "DATA" "ACLs for"
24916 Two ACLs are associated with the DATA command, because it is two-stage
24917 command, with two responses being sent to the client.
24918 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
24919 is obeyed. This gives you control after all the RCPT commands, but before
24920 the message itself is received. It offers the opportunity to give a negative
24921 response to the DATA command before the data is transmitted. Header lines
24922 added by MAIL or RCPT ACLs are not visible at this time, but any that
24923 are defined here are visible when the &%acl_smtp_data%& ACL is run.
24924
24925 You cannot test the contents of the message, for example, to verify addresses
24926 in the headers, at RCPT time or when the DATA command is received. Such
24927 tests have to appear in the ACL that is run after the message itself has been
24928 received, before the final response to the DATA command is sent. This is
24929 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
24930 associated with the DATA command.
24931
24932 For both of these ACLs, it is not possible to reject individual recipients. An
24933 error response rejects the entire message. Unfortunately, it is known that some
24934 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
24935 before or after the data) correctly &-- they keep the message on their queues
24936 and try again later, but that is their problem, though it does waste some of
24937 your resources.
24938
24939
24940 .section "The SMTP MIME ACL" "SECID194"
24941 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
24942 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
24943
24944
24945 .section "The QUIT ACL" "SECTQUITACL"
24946 .cindex "QUIT, ACL for"
24947 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
24948 does not affect the response code to QUIT, which is always 221. Thus, the ACL
24949 does not in fact control any access. For this reason, the only verbs that are
24950 permitted are &%accept%& and &%warn%&.
24951
24952 This ACL can be used for tasks such as custom logging at the end of an SMTP
24953 session. For example, you can use ACL variables in other ACLs to count
24954 messages, recipients, etc., and log the totals at QUIT time using one or
24955 more &%logwrite%& modifiers on a &%warn%& verb.
24956
24957 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
24958 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
24959
24960 You do not need to have a final &%accept%&, but if you do, you can use a
24961 &%message%& modifier to specify custom text that is sent as part of the 221
24962 response to QUIT.
24963
24964 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
24965 failure (for example, failure to open a log file, or when Exim is bombing out
24966 because it has detected an unrecoverable error), all SMTP commands from the
24967 client are given temporary error responses until QUIT is received or the
24968 connection is closed. In these special cases, the QUIT ACL does not run.
24969
24970
24971 .section "The not-QUIT ACL" "SECTNOTQUITACL"
24972 .vindex &$acl_smtp_notquit$&
24973 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
24974 an SMTP session ends without sending QUIT. However, when Exim itself is is bad
24975 trouble, such as being unable to write to its log files, this ACL is not run,
24976 because it might try to do things (such as write to log files) that make the
24977 situation even worse.
24978
24979 Like the QUIT ACL, this ACL is provided to make it possible to do customized
24980 logging or to gather statistics, and its outcome is ignored. The &%delay%&
24981 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
24982 and &%warn%&.
24983
24984 .vindex &$smtp_notquit_reason$&
24985 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
24986 to a string that indicates the reason for the termination of the SMTP
24987 connection. The possible values are:
24988 .table2
24989 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
24990 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
24991 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
24992 .irow &`connection-lost`&          "The SMTP connection has been lost"
24993 .irow &`data-timeout`&             "Timeout while reading message data"
24994 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
24995 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
24996 .irow &`signal-exit`&              "SIGTERM or SIGINT"
24997 .irow &`synchronization-error`&    "SMTP synchronization error"
24998 .irow &`tls-failed`&               "TLS failed to start"
24999 .endtable
25000 In most cases when an SMTP connection is closed without having received QUIT,
25001 Exim sends an SMTP response message before actually closing the connection.
25002 With the exception of the &`acl-drop`& case, the default message can be
25003 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
25004 &%drop%& verb in another ACL, it is the message from the other ACL that is
25005 used.
25006
25007
25008 .section "Finding an ACL to use" "SECID195"
25009 .cindex "&ACL;" "finding which to use"
25010 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
25011 you can use different ACLs in different circumstances. For example,
25012 .code
25013 acl_smtp_rcpt = ${if ={25}{$interface_port} \
25014                      {acl_check_rcpt} {acl_check_rcpt_submit} }
25015 .endd
25016 In the default configuration file there are some example settings for
25017 providing an RFC 4409 message submission service on port 587 and a
25018 non-standard &"smtps"& service on port 465. You can use a string
25019 expansion like this to choose an ACL for MUAs on these ports which is
25020 more appropriate for this purpose than the default ACL on port 25.
25021
25022 The expanded string does not have to be the name of an ACL in the
25023 configuration file; there are other possibilities. Having expanded the
25024 string, Exim searches for an ACL as follows:
25025
25026 .ilist
25027 If the string begins with a slash, Exim uses it as a file name, and reads its
25028 contents as an ACL. The lines are processed in the same way as lines in the
25029 Exim configuration file. In particular, continuation lines are supported, blank
25030 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
25031 If the file does not exist or cannot be read, an error occurs (typically
25032 causing a temporary failure of whatever caused the ACL to be run). For example:
25033 .code
25034 acl_smtp_data = /etc/acls/\
25035   ${lookup{$sender_host_address}lsearch\
25036   {/etc/acllist}{$value}{default}}
25037 .endd
25038 This looks up an ACL file to use on the basis of the host's IP address, falling
25039 back to a default if the lookup fails. If an ACL is successfully read from a
25040 file, it is retained in memory for the duration of the Exim process, so that it
25041 can be re-used without having to re-read the file.
25042 .next
25043 If the string does not start with a slash, and does not contain any spaces,
25044 Exim searches the ACL section of the configuration for an ACL whose name
25045 matches the string.
25046 .next
25047 If no named ACL is found, or if the string contains spaces, Exim parses
25048 the string as an inline ACL. This can save typing in cases where you just
25049 want to have something like
25050 .code
25051 acl_smtp_vrfy = accept
25052 .endd
25053 in order to allow free use of the VRFY command. Such a string may contain
25054 newlines; it is processed in the same way as an ACL that is read from a file.
25055 .endlist
25056
25057
25058
25059
25060 .section "ACL return codes" "SECID196"
25061 .cindex "&ACL;" "return codes"
25062 Except for the QUIT ACL, which does not affect the SMTP return code (see
25063 section &<<SECTQUITACL>>& above), the result of running an ACL is either
25064 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
25065 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
25066 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
25067 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
25068 This also causes a 4&'xx'& return code.
25069
25070 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
25071 &"deny"&, because there is no mechanism for passing temporary errors to the
25072 submitters of non-SMTP messages.
25073
25074
25075 ACLs that are relevant to message reception may also return &"discard"&. This
25076 has the effect of &"accept"&, but causes either the entire message or an
25077 individual recipient address to be discarded. In other words, it is a
25078 blackholing facility. Use it with care.
25079
25080 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
25081 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
25082 RCPT ACL is to discard just the one recipient address. If there are no
25083 recipients left when the message's data is received, the DATA ACL is not
25084 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
25085 remaining recipients. The &"discard"& return is not permitted for the
25086 &%acl_smtp_predata%& ACL.
25087
25088
25089 .cindex "&[local_scan()]& function" "when all recipients discarded"
25090 The &[local_scan()]& function is always run, even if there are no remaining
25091 recipients; it may create new recipients.
25092
25093
25094
25095 .section "Unset ACL options" "SECID197"
25096 .cindex "&ACL;" "unset options"
25097 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
25098 all the same. &*Note*&: These defaults apply only when the relevant ACL is
25099 not defined at all. For any defined ACL, the default action when control
25100 reaches the end of the ACL statements is &"deny"&.
25101
25102 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
25103 these two are ACLs that are used only for their side effects. They cannot be
25104 used to accept or reject anything.
25105
25106 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
25107 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
25108 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
25109 when the ACL is not defined is &"accept"&.
25110
25111 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
25112 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
25113 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
25114 messages over an SMTP connection. For an example, see the ACL in the default
25115 configuration file.
25116
25117
25118
25119
25120 .section "Data for message ACLs" "SECID198"
25121 .cindex "&ACL;" "data for message ACL"
25122 .vindex &$domain$&
25123 .vindex &$local_part$&
25124 .vindex &$sender_address$&
25125 .vindex &$sender_host_address$&
25126 .vindex &$smtp_command$&
25127 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
25128 that contain information about the host and the message's sender (for example,
25129 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
25130 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
25131 &$local_part$& are set from the argument address. The entire SMTP command
25132 is available in &$smtp_command$&.
25133
25134 When an ACL for the AUTH parameter of MAIL is running, the variables that
25135 contain information about the host are set, but &$sender_address$& is not yet
25136 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
25137 how it is used.
25138
25139 .vindex "&$message_size$&"
25140 The &$message_size$& variable is set to the value of the SIZE parameter on
25141 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
25142 that parameter is not given. The value is updated to the true message size by
25143 the time the final DATA ACL is run (after the message data has been
25144 received).
25145
25146 .vindex "&$rcpt_count$&"
25147 .vindex "&$recipients_count$&"
25148 The &$rcpt_count$& variable increases by one for each RCPT command received.
25149 The &$recipients_count$& variable increases by one each time a RCPT command is
25150 accepted, so while an ACL for RCPT is being processed, it contains the number
25151 of previously accepted recipients. At DATA time (for both the DATA ACLs),
25152 &$rcpt_count$& contains the total number of RCPT commands, and
25153 &$recipients_count$& contains the total number of accepted recipients.
25154
25155
25156
25157
25158
25159 .section "Data for non-message ACLs" "SECTdatfornon"
25160 .cindex "&ACL;" "data for non-message ACL"
25161 .vindex &$smtp_command_argument$&
25162 .vindex &$smtp_command$&
25163 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
25164 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
25165 and the entire SMTP command is available in &$smtp_command$&.
25166 These variables can be tested using a &%condition%& condition. For example,
25167 here is an ACL for use with AUTH, which insists that either the session is
25168 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
25169 does not permit authentication methods that use cleartext passwords on
25170 unencrypted connections.
25171 .code
25172 acl_check_auth:
25173   accept encrypted = *
25174   accept condition = ${if eq{${uc:$smtp_command_argument}}\
25175                      {CRAM-MD5}}
25176   deny   message   = TLS encryption or CRAM-MD5 required
25177 .endd
25178 (Another way of applying this restriction is to arrange for the authenticators
25179 that use cleartext passwords not to be advertised when the connection is not
25180 encrypted. You can use the generic &%server_advertise_condition%& authenticator
25181 option to do this.)
25182
25183
25184
25185 .section "Format of an ACL" "SECID199"
25186 .cindex "&ACL;" "format of"
25187 .cindex "&ACL;" "verbs, definition of"
25188 An individual ACL consists of a number of statements. Each statement starts
25189 with a verb, optionally followed by a number of conditions and &"modifiers"&.
25190 Modifiers can change the way the verb operates, define error and log messages,
25191 set variables, insert delays, and vary the processing of accepted messages.
25192
25193 If all the conditions are met, the verb is obeyed. The same condition may be
25194 used (with different arguments) more than once in the same statement. This
25195 provides a means of specifying an &"and"& conjunction between conditions. For
25196 example:
25197 .code
25198 deny  dnslists = list1.example
25199 dnslists = list2.example
25200 .endd
25201 If there are no conditions, the verb is always obeyed. Exim stops evaluating
25202 the conditions and modifiers when it reaches a condition that fails. What
25203 happens then depends on the verb (and in one case, on a special modifier). Not
25204 all the conditions make sense at every testing point. For example, you cannot
25205 test a sender address in the ACL that is run for a VRFY command.
25206
25207
25208 .section "ACL verbs" "SECID200"
25209 The ACL verbs are as follows:
25210
25211 .ilist
25212 .cindex "&%accept%& ACL verb"
25213 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
25214 of the conditions are not met, what happens depends on whether &%endpass%&
25215 appears among the conditions (for syntax see below). If the failing condition
25216 is before &%endpass%&, control is passed to the next ACL statement; if it is
25217 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
25218 check a RCPT command:
25219 .code
25220 accept domains = +local_domains
25221 endpass
25222 verify = recipient
25223 .endd
25224 If the recipient domain does not match the &%domains%& condition, control
25225 passes to the next statement. If it does match, the recipient is verified, and
25226 the command is accepted if verification succeeds. However, if verification
25227 fails, the ACL yields &"deny"&, because the failing condition is after
25228 &%endpass%&.
25229
25230 The &%endpass%& feature has turned out to be confusing to many people, so its
25231 use is not recommended nowadays. It is always possible to rewrite an ACL so
25232 that &%endpass%& is not needed, and it is no longer used in the default
25233 configuration.
25234
25235 .cindex "&%message%& ACL modifier" "with &%accept%&"
25236 If a &%message%& modifier appears on an &%accept%& statement, its action
25237 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
25238 (when an &%accept%& verb either accepts or passes control to the next
25239 statement), &%message%& can be used to vary the message that is sent when an
25240 SMTP command is accepted. For example, in a RCPT ACL you could have:
25241 .display
25242 &`accept  `&<&'some conditions'&>
25243 &`        message = OK, I will allow you through today`&
25244 .endd
25245 You can specify an SMTP response code, optionally followed by an &"extended
25246 response code"& at the start of the message, but the first digit must be the
25247 same as would be sent by default, which is 2 for an &%accept%& verb.
25248
25249 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
25250 an error message that is used when access is denied. This behaviour is retained
25251 for backward compatibility, but current &"best practice"& is to avoid the use
25252 of &%endpass%&.
25253
25254
25255 .next
25256 .cindex "&%defer%& ACL verb"
25257 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
25258 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
25259 &%defer%& is the same as &%deny%&, because there is no way of sending a
25260 temporary error. For a RCPT command, &%defer%& is much the same as using a
25261 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
25262 be used in any ACL, and even for a recipient it might be a simpler approach.
25263
25264
25265 .next
25266 .cindex "&%deny%& ACL verb"
25267 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
25268 the conditions are not met, control is passed to the next ACL statement. For
25269 example,
25270 .code
25271 deny dnslists = blackholes.mail-abuse.org
25272 .endd
25273 rejects commands from hosts that are on a DNS black list.
25274
25275
25276 .next
25277 .cindex "&%discard%& ACL verb"
25278 &%discard%&: This verb behaves like &%accept%&, except that it returns
25279 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
25280 that are concerned with receiving messages. When all the conditions are true,
25281 the sending entity receives a &"success"& response. However, &%discard%& causes
25282 recipients to be discarded. If it is used in an ACL for RCPT, just the one
25283 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
25284 message's recipients are discarded. Recipients that are discarded before DATA
25285 do not appear in the log line when the &%received_recipients%& log selector is set.
25286
25287 If the &%log_message%& modifier is set when &%discard%& operates,
25288 its contents are added to the line that is automatically written to the log.
25289 The &%message%& modifier operates exactly as it does for &%accept%&.
25290
25291
25292 .next
25293 .cindex "&%drop%& ACL verb"
25294 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
25295 forcibly closed after the 5&'xx'& error message has been sent. For example:
25296 .code
25297 drop   message   = I don't take more than 20 RCPTs
25298        condition = ${if > {$rcpt_count}{20}}
25299 .endd
25300 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
25301 The connection is always dropped after sending a 550 response.
25302
25303 .next
25304 .cindex "&%require%& ACL verb"
25305 &%require%&: If all the conditions are met, control is passed to the next ACL
25306 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
25307 example, when checking a RCPT command,
25308 .code
25309 require message = Sender did not verify
25310         verify  = sender
25311 .endd
25312 passes control to subsequent statements only if the message's sender can be
25313 verified. Otherwise, it rejects the command. Note the positioning of the
25314 &%message%& modifier, before the &%verify%& condition. The reason for this is
25315 discussed in section &<<SECTcondmodproc>>&.
25316
25317 .next
25318 .cindex "&%warn%& ACL verb"
25319 &%warn%&: If all the conditions are true, a line specified by the
25320 &%log_message%& modifier is written to Exim's main log. Control always passes
25321 to the next ACL statement. If any condition is false, the log line is not
25322 written. If an identical log line is requested several times in the same
25323 message, only one copy is actually written to the log. If you want to force
25324 duplicates to be written, use the &%logwrite%& modifier instead.
25325
25326 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
25327 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
25328 &%logwrite%&, and &%add_header%&) that appear before the first failing
25329 condition. There is more about adding header lines in section
25330 &<<SECTaddheadacl>>&.
25331
25332 If any condition on a &%warn%& statement cannot be completed (that is, there is
25333 some sort of defer), the log line specified by &%log_message%& is not written.
25334 This does not include the case of a forced failure from a lookup, which
25335 is considered to be a successful completion. After a defer, no further
25336 conditions or modifiers in the &%warn%& statement are processed. The incident
25337 is logged, and the ACL continues to be processed, from the next statement
25338 onwards.
25339
25340
25341 .vindex "&$acl_verify_message$&"
25342 When one of the &%warn%& conditions is an address verification that fails, the
25343 text of the verification failure message is in &$acl_verify_message$&. If you
25344 want this logged, you must set it up explicitly. For example:
25345 .code
25346 warn   !verify = sender
25347        log_message = sender verify failed: $acl_verify_message
25348 .endd
25349 .endlist
25350
25351 At the end of each ACL there is an implicit unconditional &%deny%&.
25352
25353 As you can see from the examples above, the conditions and modifiers are
25354 written one to a line, with the first one on the same line as the verb, and
25355 subsequent ones on following lines. If you have a very long condition, you can
25356 continue it onto several physical lines by the usual backslash continuation
25357 mechanism. It is conventional to align the conditions vertically.
25358
25359
25360
25361 .section "ACL variables" "SECTaclvariables"
25362 .cindex "&ACL;" "variables"
25363 There are some special variables that can be set during ACL processing. They
25364 can be used to pass information between different ACLs, different invocations
25365 of the same ACL in the same SMTP connection, and between ACLs and the routers,
25366 transports, and filters that are used to deliver a message. The names of these
25367 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
25368 an underscore, but the remainder of the name can be any sequence of
25369 alphanumeric characters and underscores that you choose. There is no limit on
25370 the number of ACL variables. The two sets act as follows:
25371 .ilist
25372 The values of those variables whose names begin with &$acl_c$& persist
25373 throughout an SMTP connection. They are never reset. Thus, a value that is set
25374 while receiving one message is still available when receiving the next message
25375 on the same SMTP connection.
25376 .next
25377 The values of those variables whose names begin with &$acl_m$& persist only
25378 while a message is being received. They are reset afterwards. They are also
25379 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
25380 .endlist
25381
25382 When a message is accepted, the current values of all the ACL variables are
25383 preserved with the message and are subsequently made available at delivery
25384 time. The ACL variables are set by a modifier called &%set%&. For example:
25385 .code
25386 accept hosts = whatever
25387        set acl_m4 = some value
25388 accept authenticated = *
25389        set acl_c_auth = yes
25390 .endd
25391 &*Note*&: A leading dollar sign is not used when naming a variable that is to
25392 be set. If you want to set a variable without taking any action, you can use a
25393 &%warn%& verb without any other modifiers or conditions.
25394
25395 .oindex &%strict_acl_vars%&
25396 What happens if a syntactically valid but undefined ACL variable is
25397 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
25398 false (the default), an empty string is substituted; if it is true, an
25399 error is generated.
25400
25401 Versions of Exim before 4.64 have a limited set of numbered variables, but
25402 their names are compatible, so there is no problem with upgrading.
25403
25404
25405 .section "Condition and modifier processing" "SECTcondmodproc"
25406 .cindex "&ACL;" "conditions; processing"
25407 .cindex "&ACL;" "modifiers; processing"
25408 An exclamation mark preceding a condition negates its result. For example:
25409 .code
25410 deny   domains = *.dom.example
25411       !verify  = recipient
25412 .endd
25413 causes the ACL to return &"deny"& if the recipient domain ends in
25414 &'dom.example'& and the recipient address cannot be verified. Sometimes
25415 negation can be used on the right-hand side of a condition. For example, these
25416 two statements are equivalent:
25417 .code
25418 deny  hosts = !192.168.3.4
25419 deny !hosts =  192.168.3.4
25420 .endd
25421 However, for many conditions (&%verify%& being a good example), only left-hand
25422 side negation of the whole condition is possible.
25423
25424 The arguments of conditions and modifiers are expanded. A forced failure
25425 of an expansion causes a condition to be ignored, that is, it behaves as if the
25426 condition is true. Consider these two statements:
25427 .code
25428 accept  senders = ${lookup{$host_name}lsearch\
25429                   {/some/file}{$value}fail}
25430 accept  senders = ${lookup{$host_name}lsearch\
25431                   {/some/file}{$value}{}}
25432 .endd
25433 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
25434 the returned list is searched, but if the lookup fails the behaviour is
25435 different in the two cases. The &%fail%& in the first statement causes the
25436 condition to be ignored, leaving no further conditions. The &%accept%& verb
25437 therefore succeeds. The second statement, however, generates an empty list when
25438 the lookup fails. No sender can match an empty list, so the condition fails,
25439 and therefore the &%accept%& also fails.
25440
25441 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
25442 specify actions that are taken as the conditions for a statement are checked;
25443 others specify text for messages that are used when access is denied or a
25444 warning is generated. The &%control%& modifier affects the way an incoming
25445 message is handled.
25446
25447 The positioning of the modifiers in an ACL statement important, because the
25448 processing of a verb ceases as soon as its outcome is known. Only those
25449 modifiers that have already been encountered will take effect. For example,
25450 consider this use of the &%message%& modifier:
25451 .code
25452 require message = Can't verify sender
25453         verify  = sender
25454         message = Can't verify recipient
25455         verify  = recipient
25456         message = This message cannot be used
25457 .endd
25458 If sender verification fails, Exim knows that the result of the statement is
25459 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
25460 so its text is used as the error message. If sender verification succeeds, but
25461 recipient verification fails, the second message is used. If recipient
25462 verification succeeds, the third message becomes &"current"&, but is never used
25463 because there are no more conditions to cause failure.
25464
25465 For the &%deny%& verb, on the other hand, it is always the last &%message%&
25466 modifier that is used, because all the conditions must be true for rejection to
25467 happen. Specifying more than one &%message%& modifier does not make sense, and
25468 the message can even be specified after all the conditions. For example:
25469 .code
25470 deny   hosts = ...
25471       !senders = *@my.domain.example
25472        message = Invalid sender from client host
25473 .endd
25474 The &"deny"& result does not happen until the end of the statement is reached,
25475 by which time Exim has set up the message.
25476
25477
25478
25479 .section "ACL modifiers" "SECTACLmodi"
25480 .cindex "&ACL;" "modifiers; list of"
25481 The ACL modifiers are as follows:
25482
25483 .vlist
25484 .vitem &*add_header*&&~=&~<&'text'&>
25485 This modifier specifies one or more header lines that are to be added to an
25486 incoming message, assuming, of course, that the message is ultimately
25487 accepted. For details, see section &<<SECTaddheadacl>>&.
25488
25489 .vitem &*continue*&&~=&~<&'text'&>
25490 .cindex "&%continue%& ACL modifier"
25491 .cindex "database" "updating in ACL"
25492 This modifier does nothing of itself, and processing of the ACL always
25493 continues with the next condition or modifier. The value of &%continue%& is in
25494 the side effects of expanding its argument. Typically this could be used to
25495 update a database. It is really just a syntactic tidiness, to avoid having to
25496 write rather ugly lines like this:
25497 .display
25498 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
25499 .endd
25500 Instead, all you need is
25501 .display
25502 &`continue = `&<&'some expansion'&>
25503 .endd
25504
25505 .vitem &*control*&&~=&~<&'text'&>
25506 .cindex "&%control%& ACL modifier"
25507 This modifier affects the subsequent processing of the SMTP connection or of an
25508 incoming message that is accepted. The effect of the first type of control
25509 lasts for the duration of the connection, whereas the effect of the second type
25510 lasts only until the current message has been received. The message-specific
25511 controls always apply to the whole message, not to individual recipients,
25512 even if the &%control%& modifier appears in a RCPT ACL.
25513
25514 As there are now quite a few controls that can be applied, they are described
25515 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
25516 in several different ways. For example:
25517
25518 . ==== As this is a nested list, any displays it contains must be indented
25519 . ==== as otherwise they are too far to the left. That comment applies only
25520 . ==== when xmlto and fop are used; formatting with sdop gets it right either
25521 . ==== way.
25522
25523 .ilist
25524 It can be at the end of an &%accept%& statement:
25525 .code
25526     accept  ...some conditions
25527             control = queue_only
25528 .endd
25529 In this case, the control is applied when this statement yields &"accept"&, in
25530 other words, when the conditions are all true.
25531
25532 .next
25533 It can be in the middle of an &%accept%& statement:
25534 .code
25535     accept  ...some conditions...
25536             control = queue_only
25537             ...some more conditions...
25538 .endd
25539 If the first set of conditions are true, the control is applied, even if the
25540 statement does not accept because one of the second set of conditions is false.
25541 In this case, some subsequent statement must yield &"accept"& for the control
25542 to be relevant.
25543
25544 .next
25545 It can be used with &%warn%& to apply the control, leaving the
25546 decision about accepting or denying to a subsequent verb. For
25547 example:
25548 .code
25549     warn    ...some conditions...
25550             control = freeze
25551     accept  ...
25552 .endd
25553 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
25554 &%logwrite%&, so it does not add anything to the message and does not write a
25555 log entry.
25556
25557 .next
25558 If you want to apply a control unconditionally, you can use it with a
25559 &%require%& verb. For example:
25560 .code
25561     require  control = no_multiline_responses
25562 .endd
25563 .endlist
25564
25565 .vitem &*delay*&&~=&~<&'time'&>
25566 .cindex "&%delay%& ACL modifier"
25567 .oindex "&%-bh%&"
25568 This modifier may appear in any ACL. It causes Exim to wait for the time
25569 interval before proceeding. However, when testing Exim using the &%-bh%&
25570 option, the delay is not actually imposed (an appropriate message is output
25571 instead). The time is given in the usual Exim notation, and the delay happens
25572 as soon as the modifier is processed. In an SMTP session, pending output is
25573 flushed before the delay is imposed.
25574
25575 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
25576 example:
25577 .code
25578 deny    ...some conditions...
25579         delay = 30s
25580 .endd
25581 The delay happens if all the conditions are true, before the statement returns
25582 &"deny"&. Compare this with:
25583 .code
25584 deny    delay = 30s
25585         ...some conditions...
25586 .endd
25587 which waits for 30s before processing the conditions. The &%delay%& modifier
25588 can also be used with &%warn%& and together with &%control%&:
25589 .code
25590 warn    ...some conditions...
25591         delay = 2m
25592         control = freeze
25593 accept  ...
25594 .endd
25595
25596 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
25597 responses to several commands are no longer buffered and sent in one packet (as
25598 they would normally be) because all output is flushed before imposing the
25599 delay. This optimization is disabled so that a number of small delays do not
25600 appear to the client as one large aggregated delay that might provoke an
25601 unwanted timeout. You can, however, disable output flushing for &%delay%& by
25602 using a &%control%& modifier to set &%no_delay_flush%&.
25603
25604
25605 .vitem &*endpass*&
25606 .cindex "&%endpass%& ACL modifier"
25607 This modifier, which has no argument, is recognized only in &%accept%& and
25608 &%discard%& statements. It marks the boundary between the conditions whose
25609 failure causes control to pass to the next statement, and the conditions whose
25610 failure causes the ACL to return &"deny"&. This concept has proved to be
25611 confusing to some people, so the use of &%endpass%& is no longer recommended as
25612 &"best practice"&. See the description of &%accept%& above for more details.
25613
25614
25615 .vitem &*log_message*&&~=&~<&'text'&>
25616 .cindex "&%log_message%& ACL modifier"
25617 This modifier sets up a message that is used as part of the log message if the
25618 ACL denies access or a &%warn%& statement's conditions are true. For example:
25619 .code
25620 require log_message = wrong cipher suite $tls_cipher
25621         encrypted   = DES-CBC3-SHA
25622 .endd
25623 &%log_message%& is also used when recipients are discarded by &%discard%&. For
25624 example:
25625 .display
25626 &`discard `&<&'some conditions'&>
25627 &`        log_message = Discarded $local_part@$domain because...`&
25628 .endd
25629 When access is denied, &%log_message%& adds to any underlying error message
25630 that may exist because of a condition failure. For example, while verifying a
25631 recipient address, a &':fail:'& redirection might have already set up a
25632 message.
25633
25634 The message may be defined before the conditions to which it applies, because
25635 the string expansion does not happen until Exim decides that access is to be
25636 denied. This means that any variables that are set by the condition are
25637 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
25638 variables are set after a DNS black list lookup succeeds. If the expansion of
25639 &%log_message%& fails, or if the result is an empty string, the modifier is
25640 ignored.
25641
25642 .vindex "&$acl_verify_message$&"
25643 If you want to use a &%warn%& statement to log the result of an address
25644 verification, you can use &$acl_verify_message$& to include the verification
25645 error message.
25646
25647 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
25648 the start of the logged message. If the same warning log message is requested
25649 more than once while receiving  a single email message, only one copy is
25650 actually logged. If you want to log multiple copies, use &%logwrite%& instead
25651 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
25652 is logged for a successful &%warn%& statement.
25653
25654 If &%log_message%& is not present and there is no underlying error message (for
25655 example, from the failure of address verification), but &%message%& is present,
25656 the &%message%& text is used for logging rejections. However, if any text for
25657 logging contains newlines, only the first line is logged. In the absence of
25658 both &%log_message%& and &%message%&, a default built-in message is used for
25659 logging rejections.
25660
25661
25662 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
25663 .cindex "&%log_reject_target%& ACL modifier"
25664 .cindex "logging in ACL" "specifying which log"
25665 This modifier makes it possible to specify which logs are used for messages
25666 about ACL rejections. Its argument is a colon-separated list of words that can
25667 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
25668 may be empty, in which case a rejection is not logged at all. For example, this
25669 ACL fragment writes no logging information when access is denied:
25670 .display
25671 &`deny `&<&'some conditions'&>
25672 &`     log_reject_target =`&
25673 .endd
25674 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
25675 permanent and temporary rejections. Its effect lasts for the rest of the
25676 current ACL.
25677
25678
25679 .vitem &*logwrite*&&~=&~<&'text'&>
25680 .cindex "&%logwrite%& ACL modifier"
25681 .cindex "logging in ACL" "immediate"
25682 This modifier writes a message to a log file as soon as it is encountered when
25683 processing an ACL. (Compare &%log_message%&, which, except in the case of
25684 &%warn%& and &%discard%&, is used only if the ACL statement denies
25685 access.) The &%logwrite%& modifier can be used to log special incidents in
25686 ACLs. For example:
25687 .display
25688 &`accept `&<&'some special conditions'&>
25689 &`       control  = freeze`&
25690 &`       logwrite = froze message because ...`&
25691 .endd
25692 By default, the message is written to the main log. However, it may begin
25693 with a colon, followed by a comma-separated list of log names, and then
25694 another colon, to specify exactly which logs are to be written. For
25695 example:
25696 .code
25697 logwrite = :main,reject: text for main and reject logs
25698 logwrite = :panic: text for panic log only
25699 .endd
25700
25701
25702 .vitem &*message*&&~=&~<&'text'&>
25703 .cindex "&%message%& ACL modifier"
25704 This modifier sets up a text string that is expanded and used as a response
25705 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
25706 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
25707 there is some complication if &%endpass%& is involved; see the description of
25708 &%accept%& for details.)
25709
25710 The expansion of the message happens at the time Exim decides that the ACL is
25711 to end, not at the time it processes &%message%&. If the expansion fails, or
25712 generates an empty string, the modifier is ignored. Here is an example where
25713 &%message%& must be specified first, because the ACL ends with a rejection if
25714 the &%hosts%& condition fails:
25715 .code
25716 require  message = Host not recognized
25717          hosts = 10.0.0.0/8
25718 .endd
25719 (Once a condition has failed, no further conditions or modifiers are
25720 processed.)
25721
25722 .cindex "SMTP" "error codes"
25723 .oindex "&%smtp_banner%&
25724 For ACLs that are triggered by SMTP commands, the message is returned as part
25725 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
25726 is meaningful only for SMTP, as no message is returned when a non-SMTP message
25727 is accepted. In the case of the connect ACL, accepting with a message modifier
25728 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
25729 accept message may not contain more than one line (otherwise it will be
25730 truncated at the first newline and a panic logged), and it cannot affect the
25731 EHLO options.
25732
25733 When SMTP is involved, the message may begin with an overriding response code,
25734 consisting of three digits optionally followed by an &"extended response code"&
25735 of the form &'n.n.n'&, each code being followed by a space. For example:
25736 .code
25737 deny  message = 599 1.2.3 Host not welcome
25738       hosts = 192.168.34.0/24
25739 .endd
25740 The first digit of the supplied response code must be the same as would be sent
25741 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
25742 access, but for the predata ACL, note that the default success code is 354, not
25743 2&'xx'&.
25744
25745 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
25746 the message modifier cannot override the 221 response code.
25747
25748 The text in a &%message%& modifier is literal; any quotes are taken as
25749 literals, but because the string is expanded, backslash escapes are processed
25750 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
25751 response.
25752
25753 .vindex "&$acl_verify_message$&"
25754 If &%message%& is used on a statement that verifies an address, the message
25755 specified overrides any message that is generated by the verification process.
25756 However, the original message is available in the variable
25757 &$acl_verify_message$&, so you can incorporate it into your message if you
25758 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
25759 routers to be passed back as part of the SMTP response, you should either not
25760 use a &%message%& modifier, or make use of &$acl_verify_message$&.
25761
25762 For compatibility with previous releases of Exim, a &%message%& modifier that
25763 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
25764 modifier, but this usage is now deprecated. However, &%message%& acts only when
25765 all the conditions are true, wherever it appears in an ACL command, whereas
25766 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
25767 &%warn%& in an ACL that is not concerned with receiving a message, it has no
25768 effect.
25769
25770
25771 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
25772 .cindex "&%set%& ACL modifier"
25773 This modifier puts a value into one of the ACL variables (see section
25774 &<<SECTaclvariables>>&).
25775 .endlist
25776
25777
25778
25779
25780
25781 .section "Use of the control modifier" "SECTcontrols"
25782 .cindex "&%control%& ACL modifier"
25783 The &%control%& modifier supports the following settings:
25784
25785 .vlist
25786 .vitem &*control&~=&~allow_auth_unadvertised*&
25787 This modifier allows a client host to use the SMTP AUTH command even when it
25788 has not been advertised in response to EHLO. Furthermore, because there are
25789 apparently some really broken clients that do this, Exim will accept AUTH after
25790 HELO (rather than EHLO) when this control is set. It should be used only if you
25791 really need it, and you should limit its use to those broken clients that do
25792 not work without it. For example:
25793 .code
25794 warn hosts   = 192.168.34.25
25795      control = allow_auth_unadvertised
25796 .endd
25797 Normally, when an Exim server receives an AUTH command, it checks the name of
25798 the authentication mechanism that is given in the command to ensure that it
25799 matches an advertised mechanism. When this control is set, the check that a
25800 mechanism has been advertised is bypassed. Any configured mechanism can be used
25801 by the client. This control is permitted only in the connection and HELO ACLs.
25802
25803
25804 .vitem &*control&~=&~caseful_local_part*& &&&
25805        &*control&~=&~caselower_local_part*&
25806 .cindex "&ACL;" "case of local part in"
25807 .cindex "case of local parts"
25808 .vindex "&$local_part$&"
25809 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
25810 (that is, during RCPT processing). By default, the contents of &$local_part$&
25811 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
25812 any uppercase letters in the original local part are restored in &$local_part$&
25813 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
25814 is encountered.
25815
25816 These controls affect only the current recipient. Moreover, they apply only to
25817 local part handling that takes place directly in the ACL (for example, as a key
25818 in lookups). If a test to verify the recipient is obeyed, the case-related
25819 handling of the local part during the verification is controlled by the router
25820 configuration (see the &%caseful_local_part%& generic router option).
25821
25822 This facility could be used, for example, to add a spam score to local parts
25823 containing upper case letters. For example, using &$acl_m4$& to accumulate the
25824 spam score:
25825 .code
25826 warn  control = caseful_local_part
25827       set acl_m4 = ${eval:\
25828                      $acl_m4 + \
25829                      ${if match{$local_part}{[A-Z]}{1}{0}}\
25830                     }
25831       control = caselower_local_part
25832 .endd
25833 Notice that we put back the lower cased version afterwards, assuming that
25834 is what is wanted for subsequent tests.
25835
25836 .vitem &*control&~=&~debug/*&<&'options'&>
25837 .cindex "&ACL;" "enabling debug logging"
25838 .cindex "debugging" "enabling from an ACL"
25839 This control turns on debug logging, almost as though Exim had been invoked
25840 with &`-d`&, with the output going to a new logfile, by default called
25841 &'debuglog'&.  The filename can be adjusted with the &'tag'& option, which
25842 may access any variables already defined.  The logging may be adjusted with
25843 the &'opts'& option, which takes the same values as the &`-d`& command-line
25844 option.  Some examples (which depend on variables that don't exist in all
25845 contexts):
25846 .code
25847       control = debug
25848       control = debug/tag=.$sender_host_address
25849       control = debug/opts=+expand+acl
25850       control = debug/tag=.$message_exim_id/opts=+expand
25851 .endd
25852
25853 .vitem &*control&~=&~enforce_sync*& &&&
25854        &*control&~=&~no_enforce_sync*&
25855 .cindex "SMTP" "synchronization checking"
25856 .cindex "synchronization checking in SMTP"
25857 These controls make it possible to be selective about when SMTP synchronization
25858 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
25859 state of the switch (it is true by default). See the description of this option
25860 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
25861
25862 The effect of these two controls lasts for the remainder of the SMTP
25863 connection. They can appear in any ACL except the one for the non-SMTP
25864 messages. The most straightforward place to put them is in the ACL defined by
25865 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
25866 before the first synchronization check. The expected use is to turn off the
25867 synchronization checks for badly-behaved hosts that you nevertheless need to
25868 work with.
25869
25870
25871 .vitem &*control&~=&~fakedefer/*&<&'message'&>
25872 .cindex "fake defer"
25873 .cindex "defer, fake"
25874 This control works in exactly the same way as &%fakereject%& (described below)
25875 except that it causes an SMTP 450 response after the message data instead of a
25876 550 response. You must take care when using &%fakedefer%& because it causes the
25877 messages to be duplicated when the sender retries. Therefore, you should not
25878 use &%fakedefer%& if the message is to be delivered normally.
25879
25880 .vitem &*control&~=&~fakereject/*&<&'message'&>
25881 .cindex "fake rejection"
25882 .cindex "rejection, fake"
25883 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
25884 words, only when an SMTP message is being received. If Exim accepts the
25885 message, instead the final 250 response, a 550 rejection message is sent.
25886 However, Exim proceeds to deliver the message as normal. The control applies
25887 only to the current message, not to any subsequent ones that may be received in
25888 the same SMTP connection.
25889
25890 The text for the 550 response is taken from the &%control%& modifier. If no
25891 message is supplied, the following is used:
25892 .code
25893 550-Your message has been rejected but is being
25894 550-kept for evaluation.
25895 550-If it was a legitimate message, it may still be
25896 550 delivered to the target recipient(s).
25897 .endd
25898 This facility should be used with extreme caution.
25899
25900 .vitem &*control&~=&~freeze*&
25901 .cindex "frozen messages" "forcing in ACL"
25902 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
25903 other words, only when a message is being received. If the message is accepted,
25904 it is placed on Exim's queue and frozen. The control applies only to the
25905 current message, not to any subsequent ones that may be received in the same
25906 SMTP connection.
25907
25908 This modifier can optionally be followed by &`/no_tell`&. If the global option
25909 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
25910 is told about the freezing), provided all the &*control=freeze*& modifiers that
25911 are obeyed for the current message have the &`/no_tell`& option.
25912
25913 .vitem &*control&~=&~no_delay_flush*&
25914 .cindex "SMTP" "output flushing, disabling for delay"
25915 Exim normally flushes SMTP output before implementing a delay in an ACL, to
25916 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
25917 use. This control, as long as it is encountered before the &%delay%& modifier,
25918 disables such output flushing.
25919
25920 .vitem &*control&~=&~no_callout_flush*&
25921 .cindex "SMTP" "output flushing, disabling for callout"
25922 Exim normally flushes SMTP output before performing a callout in an ACL, to
25923 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
25924 use. This control, as long as it is encountered before the &%verify%& condition
25925 that causes the callout, disables such output flushing.
25926
25927 .vitem &*control&~=&~no_mbox_unspool*&
25928 This control is available when Exim is compiled with the content scanning
25929 extension. Content scanning may require a copy of the current message, or parts
25930 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
25931 or spam scanner. Normally, such copies are deleted when they are no longer
25932 needed. If this control is set, the copies are not deleted. The control applies
25933 only to the current message, not to any subsequent ones that may be received in
25934 the same SMTP connection. It is provided for debugging purposes and is unlikely
25935 to be useful in production.
25936
25937 .vitem &*control&~=&~no_multiline_responses*&
25938 .cindex "multiline responses, suppressing"
25939 This control is permitted for any ACL except the one for non-SMTP messages.
25940 It seems that there are broken clients in use that cannot handle multiline
25941 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
25942
25943 If this control is set, multiline SMTP responses from ACL rejections are
25944 suppressed. One way of doing this would have been to put out these responses as
25945 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
25946 (&"use multiline responses for more"& it says &-- ha!), and some of the
25947 responses might get close to that. So this facility, which is after all only a
25948 sop to broken clients, is implemented by doing two very easy things:
25949
25950 .ilist
25951 Extra information that is normally output as part of a rejection caused by
25952 sender verification failure is omitted. Only the final line (typically &"sender
25953 verification failed"&) is sent.
25954 .next
25955 If a &%message%& modifier supplies a multiline response, only the first
25956 line is output.
25957 .endlist
25958
25959 The setting of the switch can, of course, be made conditional on the
25960 calling host. Its effect lasts until the end of the SMTP connection.
25961
25962 .vitem &*control&~=&~no_pipelining*&
25963 .cindex "PIPELINING" "suppressing advertising"
25964 This control turns off the advertising of the PIPELINING extension to SMTP in
25965 the current session. To be useful, it must be obeyed before Exim sends its
25966 response to an EHLO command. Therefore, it should normally appear in an ACL
25967 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
25968 &%pipelining_advertise_hosts%&.
25969
25970 .vitem &*control&~=&~queue_only*&
25971 .oindex "&%queue_only%&"
25972 .cindex "queueing incoming messages"
25973 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
25974 other words, only when a message is being received. If the message is accepted,
25975 it is placed on Exim's queue and left there for delivery by a subsequent queue
25976 runner. No immediate delivery process is started. In other words, it has the
25977 effect as the &%queue_only%& global option. However, the control applies only
25978 to the current message, not to any subsequent ones that may be received in the
25979 same SMTP connection.
25980
25981 .vitem &*control&~=&~submission/*&<&'options'&>
25982 .cindex "message" "submission"
25983 .cindex "submission mode"
25984 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
25985 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
25986 the current message is a submission from a local MUA. In this case, Exim
25987 operates in &"submission mode"&, and applies certain fixups to the message if
25988 necessary. For example, it adds a &'Date:'& header line if one is not present.
25989 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
25990 late (the message has already been created).
25991
25992 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
25993 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
25994 submission mode; the available options for this control are described there.
25995 The control applies only to the current message, not to any subsequent ones
25996 that may be received in the same SMTP connection.
25997
25998 .vitem &*control&~=&~suppress_local_fixups*&
25999 .cindex "submission fixups, suppressing"
26000 This control applies to locally submitted (non TCP/IP) messages, and is the
26001 complement of &`control = submission`&. It disables the fixups that are
26002 normally applied to locally-submitted messages. Specifically:
26003
26004 .ilist
26005 Any &'Sender:'& header line is left alone (in this respect, it is a
26006 dynamic version of &%local_sender_retain%&).
26007 .next
26008 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
26009 .next
26010 There is no check that &'From:'& corresponds to the actual sender.
26011 .endlist ilist
26012
26013 This control may be useful when a remotely-originated message is accepted,
26014 passed to some scanning program, and then re-submitted for delivery. It can be
26015 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
26016 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
26017 data is read.
26018
26019 &*Note:*& This control applies only to the current message, not to any others
26020 that are being submitted at the same time using &%-bs%& or &%-bS%&.
26021 .endlist vlist
26022
26023
26024 .section "Summary of message fixup control" "SECTsummesfix"
26025 All four possibilities for message fixups can be specified:
26026
26027 .ilist
26028 Locally submitted, fixups applied: the default.
26029 .next
26030 Locally submitted, no fixups applied: use
26031 &`control = suppress_local_fixups`&.
26032 .next
26033 Remotely submitted, no fixups applied: the default.
26034 .next
26035 Remotely submitted, fixups applied: use &`control = submission`&.
26036 .endlist
26037
26038
26039
26040 .section "Adding header lines in ACLs" "SECTaddheadacl"
26041 .cindex "header lines" "adding in an ACL"
26042 .cindex "header lines" "position of added lines"
26043 .cindex "&%message%& ACL modifier"
26044 The &%add_header%& modifier can be used to add one or more extra header lines
26045 to an incoming message, as in this example:
26046 .code
26047 warn dnslists = sbl.spamhaus.org : \
26048                 dialup.mail-abuse.org
26049      add_header = X-blacklisted-at: $dnslist_domain
26050 .endd
26051 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
26052 MIME, and non-SMTP ACLs (in other words, those that are concerned with
26053 receiving a message). The message must ultimately be accepted for
26054 &%add_header%& to have any significant effect. You can use &%add_header%& with
26055 any ACL verb, including &%deny%& (though this is potentially useful only in a
26056 RCPT ACL).
26057
26058 If the data for the &%add_header%& modifier contains one or more newlines that
26059 are not followed by a space or a tab, it is assumed to contain multiple header
26060 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
26061 front of any line that is not a valid header line.
26062
26063 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
26064 They are added to the message before processing the DATA and MIME ACLs.
26065 However, if an identical header line is requested more than once, only one copy
26066 is actually added to the message. Further header lines may be accumulated
26067 during the DATA and MIME ACLs, after which they are added to the message, again
26068 with duplicates suppressed. Thus, it is possible to add two identical header
26069 lines to an SMTP message, but only if one is added before DATA and one after.
26070 In the case of non-SMTP messages, new headers are accumulated during the
26071 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
26072 message is rejected after DATA or by the non-SMTP ACL, all added header lines
26073 are included in the entry that is written to the reject log.
26074
26075 .cindex "header lines" "added; visibility of"
26076 Header lines are not visible in string expansions until they are added to the
26077 message. It follows that header lines defined in the MAIL, RCPT, and predata
26078 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
26079 header lines that are added by the DATA or MIME ACLs are not visible in those
26080 ACLs. Because of this restriction, you cannot use header lines as a way of
26081 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
26082 this, you can use ACL variables, as described in section
26083 &<<SECTaclvariables>>&.
26084
26085 The &%add_header%& modifier acts immediately it is encountered during the
26086 processing of an ACL. Notice the difference between these two cases:
26087 .display
26088 &`accept add_header = ADDED: some text`&
26089 &`       `&<&'some condition'&>
26090
26091 &`accept `&<&'some condition'&>
26092 &`       add_header = ADDED: some text`&
26093 .endd
26094 In the first case, the header line is always added, whether or not the
26095 condition is true. In the second case, the header line is added only if the
26096 condition is true. Multiple occurrences of &%add_header%& may occur in the same
26097 ACL statement. All those that are encountered before a condition fails are
26098 honoured.
26099
26100 .cindex "&%warn%& ACL verb"
26101 For compatibility with previous versions of Exim, a &%message%& modifier for a
26102 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
26103 effect only if all the conditions are true, even if it appears before some of
26104 them. Furthermore, only the last occurrence of &%message%& is honoured. This
26105 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
26106 are present on a &%warn%& verb, both are processed according to their
26107 specifications.
26108
26109 By default, new header lines are added to a message at the end of the existing
26110 header lines. However, you can specify that any particular header line should
26111 be added right at the start (before all the &'Received:'& lines), immediately
26112 after the first block of &'Received:'& lines, or immediately before any line
26113 that is not a &'Received:'& or &'Resent-something:'& header.
26114
26115 This is done by specifying &":at_start:"&, &":after_received:"&, or
26116 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
26117 header line, respectively. (Header text cannot start with a colon, as there has
26118 to be a header name first.) For example:
26119 .code
26120 warn add_header = \
26121        :after_received:X-My-Header: something or other...
26122 .endd
26123 If more than one header line is supplied in a single &%add_header%& modifier,
26124 each one is treated independently and can therefore be placed differently. If
26125 you add more than one line at the start, or after the Received: block, they end
26126 up in reverse order.
26127
26128 &*Warning*&: This facility currently applies only to header lines that are
26129 added in an ACL. It does NOT work for header lines that are added in a
26130 system filter or in a router or transport.
26131
26132
26133
26134
26135 .section "ACL conditions" "SECTaclconditions"
26136 .cindex "&ACL;" "conditions; list of"
26137 Some of conditions listed in this section are available only when Exim is
26138 compiled with the content-scanning extension. They are included here briefly
26139 for completeness. More detailed descriptions can be found in the discussion on
26140 content scanning in chapter &<<CHAPexiscan>>&.
26141
26142 Not all conditions are relevant in all circumstances. For example, testing
26143 senders and recipients does not make sense in an ACL that is being run as the
26144 result of the arrival of an ETRN command, and checks on message headers can be
26145 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
26146 can use the same condition (with different parameters) more than once in the
26147 same ACL statement. This provides a way of specifying an &"and"& conjunction.
26148 The conditions are as follows:
26149
26150
26151 .vlist
26152 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
26153 .cindex "&ACL;" "nested"
26154 .cindex "&ACL;" "indirect"
26155 .cindex "&%acl%& ACL condition"
26156 The possible values of the argument are the same as for the
26157 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
26158 &"accept"& the condition is true; if it returns &"deny"& the condition is
26159 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
26160 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
26161 condition false. This means that further processing of the &%warn%& verb
26162 ceases, but processing of the ACL continues.
26163
26164 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
26165 the connection is dropped. If it returns &"discard"&, the verb must be
26166 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
26167 conditions are tested.
26168
26169 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
26170 loops. This condition allows you to use different ACLs in different
26171 circumstances. For example, different ACLs can be used to handle RCPT commands
26172 for different local users or different local domains.
26173
26174 .vitem &*authenticated&~=&~*&<&'string&~list'&>
26175 .cindex "&%authenticated%& ACL condition"
26176 .cindex "authentication" "ACL checking"
26177 .cindex "&ACL;" "testing for authentication"
26178 If the SMTP connection is not authenticated, the condition is false. Otherwise,
26179 the name of the authenticator is tested against the list. To test for
26180 authentication by any authenticator, you can set
26181 .code
26182 authenticated = *
26183 .endd
26184
26185 .vitem &*condition&~=&~*&<&'string'&>
26186 .cindex "&%condition%& ACL condition"
26187 .cindex "customizing" "ACL condition"
26188 .cindex "&ACL;" "customized test"
26189 .cindex "&ACL;" "testing, customized"
26190 This feature allows you to make up custom conditions. If the result of
26191 expanding the string is an empty string, the number zero, or one of the strings
26192 &"no"& or &"false"&, the condition is false. If the result is any non-zero
26193 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
26194 any other value, some error is assumed to have occurred, and the ACL returns
26195 &"defer"&. However, if the expansion is forced to fail, the condition is
26196 ignored. The effect is to treat it as true, whether it is positive or
26197 negative.
26198
26199 .vitem &*decode&~=&~*&<&'location'&>
26200 .cindex "&%decode%& ACL condition"
26201 This condition is available only when Exim is compiled with the
26202 content-scanning extension, and it is allowed only in the ACL defined by
26203 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
26204 If all goes well, the condition is true. It is false only if there are
26205 problems such as a syntax error or a memory shortage. For more details, see
26206 chapter &<<CHAPexiscan>>&.
26207
26208 .vitem &*demime&~=&~*&<&'extension&~list'&>
26209 .cindex "&%demime%& ACL condition"
26210 This condition is available only when Exim is compiled with the
26211 content-scanning extension. Its use is described in section
26212 &<<SECTdemimecond>>&.
26213
26214 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
26215 .cindex "&%dnslists%& ACL condition"
26216 .cindex "DNS list" "in ACL"
26217 .cindex "black list (DNS)"
26218 .cindex "&ACL;" "testing a DNS list"
26219 This condition checks for entries in DNS black lists. These are also known as
26220 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
26221 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
26222 different variants of this condition to describe briefly here. See sections
26223 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
26224
26225 .vitem &*domains&~=&~*&<&'domain&~list'&>
26226 .cindex "&%domains%& ACL condition"
26227 .cindex "domain" "ACL checking"
26228 .cindex "&ACL;" "testing a recipient domain"
26229 .vindex "&$domain_data$&"
26230 This condition is relevant only after a RCPT command. It checks that the domain
26231 of the recipient address is in the domain list. If percent-hack processing is
26232 enabled, it is done before this test is done. If the check succeeds with a
26233 lookup, the result of the lookup is placed in &$domain_data$& until the next
26234 &%domains%& test.
26235
26236 &*Note carefully*& (because many people seem to fall foul of this): you cannot
26237 use &%domains%& in a DATA ACL.
26238
26239
26240 .vitem &*encrypted&~=&~*&<&'string&~list'&>
26241 .cindex "&%encrypted%& ACL condition"
26242 .cindex "encryption" "checking in an ACL"
26243 .cindex "&ACL;" "testing for encryption"
26244 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
26245 name of the cipher suite in use is tested against the list. To test for
26246 encryption without testing for any specific cipher suite(s), set
26247 .code
26248 encrypted = *
26249 .endd
26250
26251
26252 .vitem &*hosts&~=&~*&<&'&~host&~list'&>
26253 .cindex "&%hosts%& ACL condition"
26254 .cindex "host" "ACL checking"
26255 .cindex "&ACL;" "testing the client host"
26256 This condition tests that the calling host matches the host list. If you have
26257 name lookups or wildcarded host names and IP addresses in the same host list,
26258 you should normally put the IP addresses first. For example, you could have:
26259 .code
26260 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
26261 .endd
26262 The lookup in this example uses the host name for its key. This is implied by
26263 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
26264 and it wouldn't matter which way round you had these two items.)
26265
26266 The reason for the problem with host names lies in the left-to-right way that
26267 Exim processes lists. It can test IP addresses without doing any DNS lookups,
26268 but when it reaches an item that requires a host name, it fails if it cannot
26269 find a host name to compare with the pattern. If the above list is given in the
26270 opposite order, the &%accept%& statement fails for a host whose name cannot be
26271 found, even if its IP address is 10.9.8.7.
26272
26273 If you really do want to do the name check first, and still recognize the IP
26274 address even if the name lookup fails, you can rewrite the ACL like this:
26275 .code
26276 accept hosts = dbm;/etc/friendly/hosts
26277 accept hosts = 10.9.8.7
26278 .endd
26279 The default action on failing to find the host name is to assume that the host
26280 is not in the list, so the first &%accept%& statement fails. The second
26281 statement can then check the IP address.
26282
26283 .vindex "&$host_data$&"
26284 If a &%hosts%& condition is satisfied by means of a lookup, the result
26285 of the lookup is made available in the &$host_data$& variable. This
26286 allows you, for example, to set up a statement like this:
26287 .code
26288 deny  hosts = net-lsearch;/some/file
26289 message = $host_data
26290 .endd
26291 which gives a custom error message for each denied host.
26292
26293 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
26294 .cindex "&%local_parts%& ACL condition"
26295 .cindex "local part" "ACL checking"
26296 .cindex "&ACL;" "testing a local part"
26297 .vindex "&$local_part_data$&"
26298 This condition is relevant only after a RCPT command. It checks that the local
26299 part of the recipient address is in the list. If percent-hack processing is
26300 enabled, it is done before this test. If the check succeeds with a lookup, the
26301 result of the lookup is placed in &$local_part_data$&, which remains set until
26302 the next &%local_parts%& test.
26303
26304 .vitem &*malware&~=&~*&<&'option'&>
26305 .cindex "&%malware%& ACL condition"
26306 .cindex "&ACL;" "virus scanning"
26307 .cindex "&ACL;" "scanning for viruses"
26308 This condition is available only when Exim is compiled with the
26309 content-scanning extension. It causes the incoming message to be scanned for
26310 viruses. For details, see chapter &<<CHAPexiscan>>&.
26311
26312 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
26313 .cindex "&%mime_regex%& ACL condition"
26314 .cindex "&ACL;" "testing by regex matching"
26315 This condition is available only when Exim is compiled with the
26316 content-scanning extension, and it is allowed only in the ACL defined by
26317 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
26318 with any of the regular expressions. For details, see chapter
26319 &<<CHAPexiscan>>&.
26320
26321 .vitem &*ratelimit&~=&~*&<&'parameters'&>
26322 .cindex "rate limiting"
26323 This condition can be used to limit the rate at which a user or host submits
26324 messages. Details are given in section &<<SECTratelimiting>>&.
26325
26326 .vitem &*recipients&~=&~*&<&'address&~list'&>
26327 .cindex "&%recipients%& ACL condition"
26328 .cindex "recipient" "ACL checking"
26329 .cindex "&ACL;" "testing a recipient"
26330 This condition is relevant only after a RCPT command. It checks the entire
26331 recipient address against a list of recipients.
26332
26333 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
26334 .cindex "&%regex%& ACL condition"
26335 .cindex "&ACL;" "testing by regex matching"
26336 This condition is available only when Exim is compiled with the
26337 content-scanning extension, and is available only in the DATA, MIME, and
26338 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
26339 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
26340
26341 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
26342 .cindex "&%sender_domains%& ACL condition"
26343 .cindex "sender" "ACL checking"
26344 .cindex "&ACL;" "testing a sender domain"
26345 .vindex "&$domain$&"
26346 .vindex "&$sender_address_domain$&"
26347 This condition tests the domain of the sender of the message against the given
26348 domain list. &*Note*&: The domain of the sender address is in
26349 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
26350 of this condition. This is an exception to the general rule for testing domain
26351 lists. It is done this way so that, if this condition is used in an ACL for a
26352 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
26353 influence the sender checking.
26354
26355 &*Warning*&: It is a bad idea to use this condition on its own as a control on
26356 relaying, because sender addresses are easily, and commonly, forged.
26357
26358 .vitem &*senders&~=&~*&<&'address&~list'&>
26359 .cindex "&%senders%& ACL condition"
26360 .cindex "sender" "ACL checking"
26361 .cindex "&ACL;" "testing a sender"
26362 This condition tests the sender of the message against the given list. To test
26363 for a bounce message, which has an empty sender, set
26364 .code
26365 senders = :
26366 .endd
26367 &*Warning*&: It is a bad idea to use this condition on its own as a control on
26368 relaying, because sender addresses are easily, and commonly, forged.
26369
26370 .vitem &*spam&~=&~*&<&'username'&>
26371 .cindex "&%spam%& ACL condition"
26372 .cindex "&ACL;" "scanning for spam"
26373 This condition is available only when Exim is compiled with the
26374 content-scanning extension. It causes the incoming message to be scanned by
26375 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
26376
26377 .vitem &*verify&~=&~certificate*&
26378 .cindex "&%verify%& ACL condition"
26379 .cindex "TLS" "client certificate verification"
26380 .cindex "certificate" "verification of client"
26381 .cindex "&ACL;" "certificate verification"
26382 .cindex "&ACL;" "testing a TLS certificate"
26383 This condition is true in an SMTP session if the session is encrypted, and a
26384 certificate was received from the client, and the certificate was verified. The
26385 server requests a certificate only if the client matches &%tls_verify_hosts%&
26386 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
26387
26388 .vitem &*verify&~=&~csa*&
26389 .cindex "CSA verification"
26390 This condition checks whether the sending host (the client) is authorized to
26391 send email. Details of how this works are given in section
26392 &<<SECTverifyCSA>>&.
26393
26394 .vitem &*verify&~=&~header_sender/*&<&'options'&>
26395 .cindex "&%verify%& ACL condition"
26396 .cindex "&ACL;" "verifying sender in the header"
26397 .cindex "header lines" "verifying the sender in"
26398 .cindex "sender" "verifying in header"
26399 .cindex "verifying" "sender in header"
26400 This condition is relevant only in an ACL that is run after a message has been
26401 received, that is, in an ACL specified by &%acl_smtp_data%& or
26402 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
26403 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
26404 is loosely thought of as a &"sender"& address (hence the name of the test).
26405 However, an address that appears in one of these headers need not be an address
26406 that accepts bounce messages; only sender addresses in envelopes are required
26407 to accept bounces. Therefore, if you use the callout option on this check, you
26408 might want to arrange for a non-empty address in the MAIL command.
26409
26410 Details of address verification and the options are given later, starting at
26411 section &<<SECTaddressverification>>& (callouts are described in section
26412 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
26413 condition to restrict it to bounce messages only:
26414 .code
26415 deny    senders = :
26416         message = A valid sender header is required for bounces
26417        !verify  = header_sender
26418 .endd
26419
26420 .vitem &*verify&~=&~header_syntax*&
26421 .cindex "&%verify%& ACL condition"
26422 .cindex "&ACL;" "verifying header syntax"
26423 .cindex "header lines" "verifying syntax"
26424 .cindex "verifying" "header syntax"
26425 This condition is relevant only in an ACL that is run after a message has been
26426 received, that is, in an ACL specified by &%acl_smtp_data%& or
26427 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
26428 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
26429 and &'Bcc:'&). Unqualified addresses (local parts without domains) are
26430 permitted only in locally generated messages and from hosts that match
26431 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
26432 appropriate.
26433
26434 Note that this condition is a syntax check only. However, a common spamming
26435 ploy used to be to send syntactically invalid headers such as
26436 .code
26437 To: @
26438 .endd
26439 and this condition can be used to reject such messages, though they are not as
26440 common as they used to be.
26441
26442 .vitem &*verify&~=&~helo*&
26443 .cindex "&%verify%& ACL condition"
26444 .cindex "&ACL;" "verifying HELO/EHLO"
26445 .cindex "HELO" "verifying"
26446 .cindex "EHLO" "verifying"
26447 .cindex "verifying" "EHLO"
26448 .cindex "verifying" "HELO"
26449 This condition is true if a HELO or EHLO command has been received from the
26450 client host, and its contents have been verified. If there has been no previous
26451 attempt to verify the HELO/EHLO contents, it is carried out when this
26452 condition is encountered. See the description of the &%helo_verify_hosts%& and
26453 &%helo_try_verify_hosts%& options for details of how to request verification
26454 independently of this condition.
26455
26456 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
26457 option), this condition is always true.
26458
26459
26460 .vitem &*verify&~=&~not_blind*&
26461 .cindex "verifying" "not blind"
26462 .cindex "bcc recipients, verifying none"
26463 This condition checks that there are no blind (bcc) recipients in the message.
26464 Every envelope recipient must appear either in a &'To:'& header line or in a
26465 &'Cc:'& header line for this condition to be true. Local parts are checked
26466 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
26467 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
26468 used only in a DATA or non-SMTP ACL.
26469
26470 There are, of course, many legitimate messages that make use of blind (bcc)
26471 recipients. This check should not be used on its own for blocking messages.
26472
26473
26474 .vitem &*verify&~=&~recipient/*&<&'options'&>
26475 .cindex "&%verify%& ACL condition"
26476 .cindex "&ACL;" "verifying recipient"
26477 .cindex "recipient" "verifying"
26478 .cindex "verifying" "recipient"
26479 .vindex "&$address_data$&"
26480 This condition is relevant only after a RCPT command. It verifies the current
26481 recipient. Details of address verification are given later, starting at section
26482 &<<SECTaddressverification>>&. After a recipient has been verified, the value
26483 of &$address_data$& is the last value that was set while routing the address.
26484 This applies even if the verification fails. When an address that is being
26485 verified is redirected to a single address, verification continues with the new
26486 address, and in that case, the subsequent value of &$address_data$& is the
26487 value for the child address.
26488
26489 .vitem &*verify&~=&~reverse_host_lookup*&
26490 .cindex "&%verify%& ACL condition"
26491 .cindex "&ACL;" "verifying host reverse lookup"
26492 .cindex "host" "verifying reverse lookup"
26493 This condition ensures that a verified host name has been looked up from the IP
26494 address of the client host. (This may have happened already if the host name
26495 was needed for checking a host list, or if the host matched &%host_lookup%&.)
26496 Verification ensures that the host name obtained from a reverse DNS lookup, or
26497 one of its aliases, does, when it is itself looked up in the DNS, yield the
26498 original IP address.
26499
26500 If this condition is used for a locally generated message (that is, when there
26501 is no client host involved), it always succeeds.
26502
26503 .vitem &*verify&~=&~sender/*&<&'options'&>
26504 .cindex "&%verify%& ACL condition"
26505 .cindex "&ACL;" "verifying sender"
26506 .cindex "sender" "verifying"
26507 .cindex "verifying" "sender"
26508 This condition is relevant only after a MAIL or RCPT command, or after a
26509 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
26510 the message's sender is empty (that is, this is a bounce message), the
26511 condition is true. Otherwise, the sender address is verified.
26512
26513 .vindex "&$address_data$&"
26514 .vindex "&$sender_address_data$&"
26515 If there is data in the &$address_data$& variable at the end of routing, its
26516 value is placed in &$sender_address_data$& at the end of verification. This
26517 value can be used in subsequent conditions and modifiers in the same ACL
26518 statement. It does not persist after the end of the current statement. If you
26519 want to preserve the value for longer, you can save it in an ACL variable.
26520
26521 Details of verification are given later, starting at section
26522 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
26523 to avoid doing it more than once per message.
26524
26525 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
26526 .cindex "&%verify%& ACL condition"
26527 This is a variation of the previous option, in which a modified address is
26528 verified as a sender.
26529 .endlist
26530
26531
26532
26533 .section "Using DNS lists" "SECTmorednslists"
26534 .cindex "DNS list" "in ACL"
26535 .cindex "black list (DNS)"
26536 .cindex "&ACL;" "testing a DNS list"
26537 In its simplest form, the &%dnslists%& condition tests whether the calling host
26538 is on at least one of a number of DNS lists by looking up the inverted IP
26539 address in one or more DNS domains. (Note that DNS list domains are not mail
26540 domains, so the &`+`& syntax for named lists doesn't work - it is used for
26541 special options instead.) For example, if the calling host's IP
26542 address is 192.168.62.43, and the ACL statement is
26543 .code
26544 deny dnslists = blackholes.mail-abuse.org : \
26545                 dialups.mail-abuse.org
26546 .endd
26547 the following records are looked up:
26548 .code
26549 43.62.168.192.blackholes.mail-abuse.org
26550 43.62.168.192.dialups.mail-abuse.org
26551 .endd
26552 As soon as Exim finds an existing DNS record, processing of the list stops.
26553 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
26554 to test that a host is on more than one list (an &"and"& conjunction), you can
26555 use two separate conditions:
26556 .code
26557 deny dnslists = blackholes.mail-abuse.org
26558      dnslists = dialups.mail-abuse.org
26559 .endd
26560 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
26561 behaves as if the host does not match the list item, that is, as if the DNS
26562 record does not exist. If there are further items in the DNS list, they are
26563 processed.
26564
26565 This is usually the required action when &%dnslists%& is used with &%deny%&
26566 (which is the most common usage), because it prevents a DNS failure from
26567 blocking mail. However, you can change this behaviour by putting one of the
26568 following special items in the list:
26569 .display
26570 &`+include_unknown `&   behave as if the item is on the list
26571 &`+exclude_unknown `&   behave as if the item is not on the list (default)
26572 &`+defer_unknown   `&   give a temporary error
26573 .endd
26574 .cindex "&`+include_unknown`&"
26575 .cindex "&`+exclude_unknown`&"
26576 .cindex "&`+defer_unknown`&"
26577 Each of these applies to any subsequent items on the list. For example:
26578 .code
26579 deny dnslists = +defer_unknown : foo.bar.example
26580 .endd
26581 Testing the list of domains stops as soon as a match is found. If you want to
26582 warn for one list and block for another, you can use two different statements:
26583 .code
26584 deny  dnslists = blackholes.mail-abuse.org
26585 warn  message  = X-Warn: sending host is on dialups list
26586       dnslists = dialups.mail-abuse.org
26587 .endd
26588 DNS list lookups are cached by Exim for the duration of the SMTP session,
26589 so a lookup based on the IP address is done at most once for any incoming
26590 connection. Exim does not share information between multiple incoming
26591 connections (but your local name server cache should be active).
26592
26593
26594
26595 .section "Specifying the IP address for a DNS list lookup" "SECID201"
26596 .cindex "DNS list" "keyed by explicit IP address"
26597 By default, the IP address that is used in a DNS list lookup is the IP address
26598 of the calling host. However, you can specify another IP address by listing it
26599 after the domain name, introduced by a slash. For example:
26600 .code
26601 deny dnslists = black.list.tld/192.168.1.2
26602 .endd
26603 This feature is not very helpful with explicit IP addresses; it is intended for
26604 use with IP addresses that are looked up, for example, the IP addresses of the
26605 MX hosts or nameservers of an email sender address. For an example, see section
26606 &<<SECTmulkeyfor>>& below.
26607
26608
26609
26610
26611 .section "DNS lists keyed on domain names" "SECID202"
26612 .cindex "DNS list" "keyed by domain name"
26613 There are some lists that are keyed on domain names rather than inverted IP
26614 addresses (see for example the &'domain based zones'& link at
26615 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
26616 with these lists. You can change the name that is looked up in a DNS list by
26617 listing it after the domain name, introduced by a slash. For example,
26618 .code
26619 deny  message  = Sender's domain is listed at $dnslist_domain
26620       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
26621 .endd
26622 This particular example is useful only in ACLs that are obeyed after the
26623 RCPT or DATA commands, when a sender address is available. If (for
26624 example) the message's sender is &'user@tld.example'& the name that is looked
26625 up by this example is
26626 .code
26627 tld.example.dsn.rfc-ignorant.org
26628 .endd
26629 A single &%dnslists%& condition can contain entries for both names and IP
26630 addresses. For example:
26631 .code
26632 deny dnslists = sbl.spamhaus.org : \
26633                 dsn.rfc-ignorant.org/$sender_address_domain
26634 .endd
26635 The first item checks the sending host's IP address; the second checks a domain
26636 name. The whole condition is true if either of the DNS lookups succeeds.
26637
26638
26639
26640
26641 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
26642 .cindex "DNS list" "multiple keys for"
26643 The syntax described above for looking up explicitly-defined values (either
26644 names or IP addresses) in a DNS blacklist is a simplification. After the domain
26645 name for the DNS list, what follows the slash can in fact be a list of items.
26646 As with all lists in Exim, the default separator is a colon. However, because
26647 this is a sublist within the list of DNS blacklist domains, it is necessary
26648 either to double the separators like this:
26649 .code
26650 dnslists = black.list.tld/name.1::name.2
26651 .endd
26652 or to change the separator character, like this:
26653 .code
26654 dnslists = black.list.tld/<;name.1;name.2
26655 .endd
26656 If an item in the list is an IP address, it is inverted before the DNS
26657 blacklist domain is appended. If it is not an IP address, no inversion
26658 occurs. Consider this condition:
26659 .code
26660 dnslists = black.list.tld/<;192.168.1.2;a.domain
26661 .endd
26662 The DNS lookups that occur are:
26663 .code
26664 2.1.168.192.black.list.tld
26665 a.domain.black.list.tld
26666 .endd
26667 Once a DNS record has been found (that matches a specific IP return
26668 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
26669 are done. If there is a temporary DNS error, the rest of the sublist of domains
26670 or IP addresses is tried. A temporary error for the whole dnslists item occurs
26671 only if no other DNS lookup in this sublist succeeds. In other words, a
26672 successful lookup for any of the items in the sublist overrides a temporary
26673 error for a previous item.
26674
26675 The ability to supply a list of items after the slash is in some sense just a
26676 syntactic convenience. These two examples have the same effect:
26677 .code
26678 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
26679 dnslists = black.list.tld/a.domain::b.domain
26680 .endd
26681 However, when the data for the list is obtained from a lookup, the second form
26682 is usually much more convenient. Consider this example:
26683 .code
26684 deny message  = The mail servers for the domain \
26685                 $sender_address_domain \
26686                 are listed at $dnslist_domain ($dnslist_value); \
26687                 see $dnslist_text.
26688      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
26689                                    ${lookup dnsdb {>|mxh=\
26690                                    $sender_address_domain} }} }
26691 .endd
26692 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
26693 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
26694 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
26695 of expanding the condition might be something like this:
26696 .code
26697 dnslists = sbl.spahmaus.org/<|192.168.2.3|192.168.5.6|...
26698 .endd
26699 Thus, this example checks whether or not the IP addresses of the sender
26700 domain's mail servers are on the Spamhaus black list.
26701
26702 The key that was used for a successful DNS list lookup is put into the variable
26703 &$dnslist_matched$& (see section &<<SECID204>>&).
26704
26705
26706
26707
26708 .section "Data returned by DNS lists" "SECID203"
26709 .cindex "DNS list" "data returned from"
26710 DNS lists are constructed using address records in the DNS. The original RBL
26711 just used the address 127.0.0.1 on the right hand side of each record, but the
26712 RBL+ list and some other lists use a number of values with different meanings.
26713 The values used on the RBL+ list are:
26714 .display
26715 127.1.0.1  RBL
26716 127.1.0.2  DUL
26717 127.1.0.3  DUL and RBL
26718 127.1.0.4  RSS
26719 127.1.0.5  RSS and RBL
26720 127.1.0.6  RSS and DUL
26721 127.1.0.7  RSS and DUL and RBL
26722 .endd
26723 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
26724 different values. Some DNS lists may return more than one address record;
26725 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
26726
26727
26728 .section "Variables set from DNS lists" "SECID204"
26729 .cindex "expansion" "variables, set from DNS list"
26730 .cindex "DNS list" "variables set from"
26731 .vindex "&$dnslist_domain$&"
26732 .vindex "&$dnslist_matched$&"
26733 .vindex "&$dnslist_text$&"
26734 .vindex "&$dnslist_value$&"
26735 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
26736 the name of the overall domain that matched (for example,
26737 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
26738 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
26739 the DNS record. When the key is an IP address, it is not reversed in
26740 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
26741 cases, for example:
26742 .code
26743 deny dnslists = spamhaus.example
26744 .endd
26745 the key is also available in another variable (in this case,
26746 &$sender_host_address$&). In more complicated cases, however, this is not true.
26747 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
26748 might generate a dnslists lookup like this:
26749 .code
26750 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
26751 .endd
26752 If this condition succeeds, the value in &$dnslist_matched$& might be
26753 &`192.168.6.7`& (for example).
26754
26755 If more than one address record is returned by the DNS lookup, all the IP
26756 addresses are included in &$dnslist_value$&, separated by commas and spaces.
26757 The variable &$dnslist_text$& contains the contents of any associated TXT
26758 record. For lists such as RBL+ the TXT record for a merged entry is often not
26759 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
26760 information.
26761
26762 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
26763 &-- although these appear before the condition in the ACL, they are not
26764 expanded until after it has failed. For example:
26765 .code
26766 deny    hosts = !+local_networks
26767         message = $sender_host_address is listed \
26768                   at $dnslist_domain
26769         dnslists = rbl-plus.mail-abuse.example
26770 .endd
26771
26772
26773
26774 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
26775 .cindex "DNS list" "matching specific returned data"
26776 You can add an equals sign and an IP address after a &%dnslists%& domain name
26777 in order to restrict its action to DNS records with a matching right hand side.
26778 For example,
26779 .code
26780 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
26781 .endd
26782 rejects only those hosts that yield 127.0.0.2. Without this additional data,
26783 any address record is considered to be a match. For the moment, we assume
26784 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
26785 describes how multiple records are handled.
26786
26787 More than one IP address may be given for checking, using a comma as a
26788 separator. These are alternatives &-- if any one of them matches, the
26789 &%dnslists%& condition is true. For example:
26790 .code
26791 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
26792 .endd
26793 If you want to specify a constraining address list and also specify names or IP
26794 addresses to be looked up, the constraining address list must be specified
26795 first. For example:
26796 .code
26797 deny dnslists = dsn.rfc-ignorant.org\
26798                 =127.0.0.2/$sender_address_domain
26799 .endd
26800
26801 If the character &`&&`& is used instead of &`=`&, the comparison for each
26802 listed IP address is done by a bitwise &"and"& instead of by an equality test.
26803 In other words, the listed addresses are used as bit masks. The comparison is
26804 true if all the bits in the mask are present in the address that is being
26805 tested. For example:
26806 .code
26807 dnslists = a.b.c&0.0.0.3
26808 .endd
26809 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
26810 want to test whether one bit or another bit is present (as opposed to both
26811 being present), you must use multiple values. For example:
26812 .code
26813 dnslists = a.b.c&0.0.0.1,0.0.0.2
26814 .endd
26815 matches if the final component of the address is an odd number or two times
26816 an odd number.
26817
26818
26819
26820 .section "Negated DNS matching conditions" "SECID205"
26821 You can supply a negative list of IP addresses as part of a &%dnslists%&
26822 condition. Whereas
26823 .code
26824 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
26825 .endd
26826 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
26827 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
26828 .code
26829 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
26830 .endd
26831 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
26832 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
26833 words, the result of the test is inverted if an exclamation mark appears before
26834 the &`=`& (or the &`&&`&) sign.
26835
26836 &*Note*&: This kind of negation is not the same as negation in a domain,
26837 host, or address list (which is why the syntax is different).
26838
26839 If you are using just one list, the negation syntax does not gain you much. The
26840 previous example is precisely equivalent to
26841 .code
26842 deny  dnslists = a.b.c
26843      !dnslists = a.b.c=127.0.0.2,127.0.0.3
26844 .endd
26845 However, if you are using multiple lists, the negation syntax is clearer.
26846 Consider this example:
26847 .code
26848 deny  dnslists = sbl.spamhaus.org : \
26849                  list.dsbl.org : \
26850                  dnsbl.njabl.org!=127.0.0.3 : \
26851                  relays.ordb.org
26852 .endd
26853 Using only positive lists, this would have to be:
26854 .code
26855 deny  dnslists = sbl.spamhaus.org : \
26856                  list.dsbl.org
26857 deny  dnslists = dnsbl.njabl.org
26858      !dnslists = dnsbl.njabl.org=127.0.0.3
26859 deny  dnslists = relays.ordb.org
26860 .endd
26861 which is less clear, and harder to maintain.
26862
26863
26864
26865
26866 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
26867 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
26868 thereby providing more than one IP address. When an item in a &%dnslists%& list
26869 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
26870 the match to specific results from the DNS lookup, there are two ways in which
26871 the checking can be handled. For example, consider the condition:
26872 .code
26873 dnslists = a.b.c=127.0.0.1
26874 .endd
26875 What happens if the DNS lookup for the incoming IP address yields both
26876 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
26877 condition true because at least one given value was found, or is it false
26878 because at least one of the found values was not listed? And how does this
26879 affect negated conditions? Both possibilities are provided for with the help of
26880 additional separators &`==`& and &`=&&`&.
26881
26882 .ilist
26883 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
26884 IP addresses matches one of the listed addresses. For the example above, the
26885 condition is true because 127.0.0.1 matches.
26886 .next
26887 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
26888 looked up IP addresses matches one of the listed addresses. If the condition is
26889 changed to:
26890 .code
26891 dnslists = a.b.c==127.0.0.1
26892 .endd
26893 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
26894 false because 127.0.0.2 is not listed. You would need to have:
26895 .code
26896 dnslists = a.b.c==127.0.0.1,127.0.0.2
26897 .endd
26898 for the condition to be true.
26899 .endlist
26900
26901 When &`!`& is used to negate IP address matching, it inverts the result, giving
26902 the precise opposite of the behaviour above. Thus:
26903 .ilist
26904 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
26905 addresses matches one of the listed addresses. Consider:
26906 .code
26907 dnslists = a.b.c!&0.0.0.1
26908 .endd
26909 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
26910 false because 127.0.0.1 matches.
26911 .next
26912 If &`!==`& or &`!=&&`& is used, the condition is true there is at least one
26913 looked up IP address that does not match. Consider:
26914 .code
26915 dnslists = a.b.c!=&0.0.0.1
26916 .endd
26917 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
26918 true, because 127.0.0.2 does not match. You would need to have:
26919 .code
26920 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
26921 .endd
26922 for the condition to be false.
26923 .endlist
26924 When the DNS lookup yields only a single IP address, there is no difference
26925 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
26926
26927
26928
26929
26930 .section "Detailed information from merged DNS lists" "SECTmordetinf"
26931 .cindex "DNS list" "information from merged"
26932 When the facility for restricting the matching IP values in a DNS list is used,
26933 the text from the TXT record that is set in &$dnslist_text$& may not reflect
26934 the true reason for rejection. This happens when lists are merged and the IP
26935 address in the A record is used to distinguish them; unfortunately there is
26936 only one TXT record. One way round this is not to use merged lists, but that
26937 can be inefficient because it requires multiple DNS lookups where one would do
26938 in the vast majority of cases when the host of interest is not on any of the
26939 lists.
26940
26941 A less inefficient way of solving this problem is available. If
26942 two domain names, comma-separated, are given, the second is used first to
26943 do an initial check, making use of any IP value restrictions that are set.
26944 If there is a match, the first domain is used, without any IP value
26945 restrictions, to get the TXT record. As a byproduct of this, there is also
26946 a check that the IP being tested is indeed on the first list. The first
26947 domain is the one that is put in &$dnslist_domain$&. For example:
26948 .code
26949 reject message  = \
26950          rejected because $sender_host_address is blacklisted \
26951          at $dnslist_domain\n$dnslist_text
26952        dnslists = \
26953          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
26954          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
26955 .endd
26956 For the first blacklist item, this starts by doing a lookup in
26957 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
26958 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
26959 value, and as long as something is found, it looks for the corresponding TXT
26960 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
26961 The second blacklist item is processed similarly.
26962
26963 If you are interested in more than one merged list, the same list must be
26964 given several times, but because the results of the DNS lookups are cached,
26965 the DNS calls themselves are not repeated. For example:
26966 .code
26967 reject dnslists = \
26968          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
26969          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
26970          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
26971          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
26972 .endd
26973 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
26974 values matches (or if no record is found), this is the only lookup that is
26975 done. Only if there is a match is one of the more specific lists consulted.
26976
26977
26978
26979 .section "DNS lists and IPv6" "SECTmorednslistslast"
26980 .cindex "IPv6" "DNS black lists"
26981 .cindex "DNS list" "IPv6 usage"
26982 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
26983 nibble by nibble. For example, if the calling host's IP address is
26984 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
26985 .code
26986 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
26987   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
26988 .endd
26989 (split over two lines here to fit on the page). Unfortunately, some of the DNS
26990 lists contain wildcard records, intended for IPv4, that interact badly with
26991 IPv6. For example, the DNS entry
26992 .code
26993 *.3.some.list.example.    A    127.0.0.1
26994 .endd
26995 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
26996 Unfortunately, it also matches the entire 3::/4 IPv6 network.
26997
26998 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
26999 &%condition%& condition, as in this example:
27000 .code
27001 deny   condition = ${if isip4{$sender_host_address}}
27002        dnslists  = some.list.example
27003 .endd
27004
27005 .section "Rate limiting incoming messages" "SECTratelimiting"
27006 .cindex "rate limiting" "client sending"
27007 .cindex "limiting client sending rates"
27008 .oindex "&%smtp_ratelimit_*%&"
27009 The &%ratelimit%& ACL condition can be used to measure and control the rate at
27010 which clients can send email. This is more powerful than the
27011 &%smtp_ratelimit_*%& options, because those options control the rate of
27012 commands in a single SMTP session only, whereas the &%ratelimit%& condition
27013 works across all connections (concurrent and sequential) from the same client
27014 host. The syntax of the &%ratelimit%& condition is:
27015 .display
27016 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
27017 .endd
27018 If the average client sending rate is less than &'m'& messages per time
27019 period &'p'& then the condition is false; otherwise it is true.
27020
27021 As a side-effect, the &%ratelimit%& condition sets the expansion variable
27022 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
27023 configured value of &'m'&, and &$sender_rate_period$& to the configured value
27024 of &'p'&.
27025
27026 The parameter &'p'& is the smoothing time constant, in the form of an Exim
27027 time interval, for example, &`8h`& for eight hours. A larger time constant
27028 means that it takes Exim longer to forget a client's past behaviour. The
27029 parameter &'m'& is the maximum number of messages that a client is permitted to
27030 send in each time interval. It also specifies the number of messages permitted
27031 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
27032 constant, you can allow a client to send more messages in a burst without
27033 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
27034 both small, messages must be sent at an even rate.
27035
27036 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
27037 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
27038 when deploying the &%ratelimit%& ACL condition. The script prints usage
27039 instructions when it is run with no arguments.
27040
27041 The key is used to look up the data for calculating the client's average
27042 sending rate. This data is stored in Exim's spool directory, alongside the
27043 retry and other hints databases. The default key is &$sender_host_address$&,
27044 which means Exim computes the sending rate of each client host IP address.
27045 By changing the key you can change how Exim identifies clients for the purpose
27046 of ratelimiting. For example, to limit the sending rate of each authenticated
27047 user, independent of the computer they are sending from, set the key to
27048 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
27049 example, &$authenticated_id$& is only meaningful if the client has
27050 authenticated (which you can check with the &%authenticated%& ACL condition).
27051
27052 The lookup key does not have to identify clients: If you want to limit the
27053 rate at which a recipient receives messages, you can use the key
27054 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
27055 ACL.
27056
27057 Internally, Exim appends the smoothing constant &'p'& and the options onto the
27058 lookup key because they alter the meaning of the stored data. This is not true
27059 for the limit &'m'&, so you can alter the configured maximum rate and Exim will
27060 still remember clients' past behaviour, but if you alter the other ratelimit
27061 parameters Exim forgets past behaviour.
27062
27063 Each &%ratelimit%& condition can have up to three options. One option
27064 specifies what Exim measures the rate of, and the second specifies how Exim
27065 handles excessively fast clients. The third option can be &`noupdate`&, to
27066 disable updating of the ratelimiting database (see section &<<rearatdat>>&).
27067 The options are separated by a slash, like the other parameters. They may
27068 appear in any order.
27069
27070 .section "Ratelimit options for what is being measured" "ratoptmea"
27071 The &%per_conn%& option limits the client's connection rate.
27072
27073 The &%per_mail%& option limits the client's rate of sending messages. This is
27074 the default if none of the &%per_*%& options is specified.
27075
27076 The &%per_byte%& option limits the sender's email bandwidth. Note that it is
27077 best to use this option in the DATA ACL; if it is used in an earlier ACL it
27078 relies on the SIZE parameter specified by the client in its MAIL command,
27079 which may be inaccurate or completely missing. You can follow the limit &'m'&
27080 in the configuration with K, M, or G to specify limits in kilobytes,
27081 megabytes, or gigabytes, respectively.
27082
27083 The &%per_rcpt%& option causes Exim to limit the rate at which
27084 recipients are accepted. To be effective, it would need to be used in
27085 either the &%acl_smtp_rcpt%& or the &%acl_not_smtp%& ACL. In the
27086 &%acl_smtp_rcpt%& ACL, the number of recipients is incremented by one.
27087 In the case of a locally submitted message in the &%acl_not_smtp%& ACL,
27088 the number of recipients is incremented by the &%$recipients_count%&
27089 for the entire message. Note that in either case the rate limiting
27090 engine will see a message with many recipients as a large high-speed
27091 burst.
27092
27093 The &%per_cmd%& option causes Exim to recompute the rate every time the
27094 condition is processed. This can be used to limit the SMTP command rate.
27095 This command is essentially an alias of &%per_rcpt%& to make it clear
27096 that the effect is to limit the rate at which individual commands,
27097 rather than recipients, are accepted.
27098
27099 .section "Ratelimit options for handling fast clients" "ratophanfas"
27100 If a client's average rate is greater than the maximum, the rate limiting
27101 engine can react in two possible ways, depending on the presence of the
27102 &%strict%& or &%leaky%& options. This is independent of the other
27103 counter-measures (such as rejecting the message) that may be specified by the
27104 rest of the ACL. The default mode is leaky, which avoids a sender's
27105 over-aggressive retry rate preventing it from getting any email through.
27106
27107 The &%strict%& option means that the client's recorded rate is always
27108 updated. The effect of this is that Exim measures the client's average rate
27109 of attempts to send email, which can be much higher than the maximum it is
27110 actually allowed. If the client is over the limit it may be subjected to
27111 counter-measures by the ACL until it slows down below the maximum rate. If
27112 the client stops attempting to send email for the time specified in the &'p'&
27113 parameter then its computed rate will decay exponentially to 37% of its peak
27114 value. You can work out the time (the number of smoothing periods) that a
27115 client is subjected to counter-measures after an over-limit burst with this
27116 formula:
27117 .code
27118         ln(peakrate/maxrate)
27119 .endd
27120 The &%leaky%& (default) option means that the client's recorded rate is not
27121 updated if it is above the limit. The effect of this is that Exim measures the
27122 client's average rate of successfully sent email, which cannot be greater than
27123 the maximum allowed. If the client is over the limit it may suffer some
27124 counter-measures (as specified in the ACL), but it will still be able to send
27125 email at the configured maximum rate, whatever the rate of its attempts. This
27126 is generally the better choice if you have clients that retry automatically.
27127
27128 .section "Using rate limiting" "useratlim"
27129 Exim's other ACL facilities are used to define what counter-measures are taken
27130 when the rate limit is exceeded. This might be anything from logging a warning
27131 (for example, while measuring existing sending rates in order to define
27132 policy), through time delays to slow down fast senders, up to rejecting the
27133 message. For example:
27134 .code
27135 # Log all senders' rates
27136 warn ratelimit = 0 / 1h / strict
27137      log_message = Sender rate $sender_rate / $sender_rate_period
27138
27139 # Slow down fast senders; note the need to truncate $sender_rate
27140 # at the decimal point.
27141 warn ratelimit = 100 / 1h / per_rcpt / strict
27142      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
27143                    $sender_rate_limit }s
27144
27145 # Keep authenticated users under control
27146 deny authenticated = *
27147      ratelimit = 100 / 1d / strict / $authenticated_id
27148
27149 # System-wide rate limit
27150 defer message = Sorry, too busy. Try again later.
27151      ratelimit = 10 / 1s / $primary_hostname
27152
27153 # Restrict incoming rate from each host, with a default
27154 # set using a macro and special cases looked up in a table.
27155 defer message = Sender rate exceeds $sender_rate_limit \
27156                messages per $sender_rate_period
27157      ratelimit = ${lookup {$sender_host_address} \
27158                    cdb {DB/ratelimits.cdb} \
27159                    {$value} {RATELIMIT} }
27160 .endd
27161 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
27162 especially with the &%per_rcpt%& option, you may suffer from a performance
27163 bottleneck caused by locking on the ratelimit hints database. Apart from
27164 making your ACLs less complicated, you can reduce the problem by using a
27165 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
27166 this means that Exim will lose its hints data after a reboot (including retry
27167 hints, the callout cache, and ratelimit data).
27168
27169
27170 .section "Reading ratelimit data without updating" "rearatdat"
27171 .cindex "rate limitint" "reading data without updating"
27172 If the &%noupdate%& option is present on a &%ratelimit%& ACL condition, Exim
27173 computes the rate and checks the limit as normal, but it does not update the
27174 saved data. This means that, in relevant ACLs, it is possible to lookup the
27175 existence of a specified (or auto-generated) ratelimit key without incrementing
27176 the ratelimit counter for that key. In order for this to be useful, another ACL
27177 entry must set the rate for the same key (otherwise it will always be zero).
27178 For example:
27179 .code
27180 acl_check_connect:
27181   deny ratelimit = 100 / 5m / strict / per_cmd / noupdate
27182        log_message = RATE: $sender_rate/$sender_rate_period \
27183                      (max $sender_rate_limit)
27184 .endd
27185 .display
27186 &'... some other logic and tests...'&
27187 .endd
27188 .code
27189 acl_check_mail:
27190   warn ratelimit = 100 / 5m / strict / per_cmd
27191        condition = ${if le{$sender_rate}{$sender_rate_limit}}
27192        logwrite  = RATE UPDATE: $sender_rate/$sender_rate_period \
27193                      (max $sender_rate_limit)
27194 .endd
27195 In this example, the rate is tested and used to deny access (when it is too
27196 high) in the connect ACL, but the actual computation of the remembered rate
27197 happens later, on a per-command basis, in another ACL.
27198
27199
27200
27201 .section "Address verification" "SECTaddressverification"
27202 .cindex "verifying address" "options for"
27203 .cindex "policy control" "address verification"
27204 Several of the &%verify%& conditions described in section
27205 &<<SECTaclconditions>>& cause addresses to be verified. Section
27206 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
27207 The verification conditions can be followed by options that modify the
27208 verification process. The options are separated from the keyword and from each
27209 other by slashes, and some of them contain parameters. For example:
27210 .code
27211 verify = sender/callout
27212 verify = recipient/defer_ok/callout=10s,defer_ok
27213 .endd
27214 The first stage of address verification, which always happens, is to run the
27215 address through the routers, in &"verify mode"&. Routers can detect the
27216 difference between verification and routing for delivery, and their actions can
27217 be varied by a number of generic options such as &%verify%& and &%verify_only%&
27218 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
27219 The available options are as follows:
27220
27221 .ilist
27222 If the &%callout%& option is specified, successful routing to one or more
27223 remote hosts is followed by a &"callout"& to those hosts as an additional
27224 check. Callouts and their sub-options are discussed in the next section.
27225 .next
27226 If there is a defer error while doing verification routing, the ACL
27227 normally returns &"defer"&. However, if you include &%defer_ok%& in the
27228 options, the condition is forced to be true instead. Note that this is a main
27229 verification option as well as a suboption for callouts.
27230 .next
27231 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
27232 discusses the reporting of sender address verification failures.
27233 .next
27234 The &%success_on_redirect%& option causes verification always to succeed
27235 immediately after a successful redirection. By default, if a redirection
27236 generates just one address, that address is also verified. See further
27237 discussion in section &<<SECTredirwhilveri>>&.
27238 .endlist
27239
27240 .cindex "verifying address" "differentiating failures"
27241 .vindex "&$recipient_verify_failure$&"
27242 .vindex "&$sender_verify_failure$&"
27243 .vindex "&$acl_verify_message$&"
27244 After an address verification failure, &$acl_verify_message$& contains the
27245 error message that is associated with the failure. It can be preserved by
27246 coding like this:
27247 .code
27248 warn  !verify = sender
27249        set acl_m0 = $acl_verify_message
27250 .endd
27251 If you are writing your own custom rejection message or log message when
27252 denying access, you can use this variable to include information about the
27253 verification failure.
27254
27255 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
27256 appropriate) contains one of the following words:
27257
27258 .ilist
27259 &%qualify%&: The address was unqualified (no domain), and the message
27260 was neither local nor came from an exempted host.
27261 .next
27262 &%route%&: Routing failed.
27263 .next
27264 &%mail%&: Routing succeeded, and a callout was attempted; rejection
27265 occurred at or before the MAIL command (that is, on initial
27266 connection, HELO, or MAIL).
27267 .next
27268 &%recipient%&: The RCPT command in a callout was rejected.
27269 .next
27270 &%postmaster%&: The postmaster check in a callout was rejected.
27271 .endlist
27272
27273 The main use of these variables is expected to be to distinguish between
27274 rejections of MAIL and rejections of RCPT in callouts.
27275
27276
27277
27278
27279 .section "Callout verification" "SECTcallver"
27280 .cindex "verifying address" "by callout"
27281 .cindex "callout" "verification"
27282 .cindex "SMTP" "callout verification"
27283 For non-local addresses, routing verifies the domain, but is unable to do any
27284 checking of the local part. There are situations where some means of verifying
27285 the local part is desirable. One way this can be done is to make an SMTP
27286 &'callback'& to a delivery host for the sender address or a &'callforward'& to
27287 a subsequent host for a recipient address, to see if the host accepts the
27288 address. We use the term &'callout'& to cover both cases. Note that for a
27289 sender address, the callback is not to the client host that is trying to
27290 deliver the message, but to one of the hosts that accepts incoming mail for the
27291 sender's domain.
27292
27293 Exim does not do callouts by default. If you want them to happen, you must
27294 request them by setting appropriate options on the &%verify%& condition, as
27295 described below. This facility should be used with care, because it can add a
27296 lot of resource usage to the cost of verifying an address. However, Exim does
27297 cache the results of callouts, which helps to reduce the cost. Details of
27298 caching are in section &<<SECTcallvercache>>&.
27299
27300 Recipient callouts are usually used only between hosts that are controlled by
27301 the same administration. For example, a corporate gateway host could use
27302 callouts to check for valid recipients on an internal mailserver. A successful
27303 callout does not guarantee that a real delivery to the address would succeed;
27304 on the other hand, a failing callout does guarantee that a delivery would fail.
27305
27306 If the &%callout%& option is present on a condition that verifies an address, a
27307 second stage of verification occurs if the address is successfully routed to
27308 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
27309 &(manualroute)& router, where the router specifies the hosts. However, if a
27310 router that does not set up hosts routes to an &(smtp)& transport with a
27311 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
27312 &%hosts_override%& set, its hosts are always used, whether or not the router
27313 supplies a host list.
27314
27315 The port that is used is taken from the transport, if it is specified and is a
27316 remote transport. (For routers that do verification only, no transport need be
27317 specified.) Otherwise, the default SMTP port is used. If a remote transport
27318 specifies an outgoing interface, this is used; otherwise the interface is not
27319 specified. Likewise, the text that is used for the HELO command is taken from
27320 the transport's &%helo_data%& option; if there is no transport, the value of
27321 &$smtp_active_hostname$& is used.
27322
27323 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
27324 test whether a bounce message could be delivered to the sender address. The
27325 following SMTP commands are sent:
27326 .display
27327 &`HELO `&<&'local host name'&>
27328 &`MAIL FROM:<>`&
27329 &`RCPT TO:`&<&'the address to be tested'&>
27330 &`QUIT`&
27331 .endd
27332 LHLO is used instead of HELO if the transport's &%protocol%& option is
27333 set to &"lmtp"&.
27334
27335 A recipient callout check is similar. By default, it also uses an empty address
27336 for the sender. This default is chosen because most hosts do not make use of
27337 the sender address when verifying a recipient. Using the same address means
27338 that a single cache entry can be used for each recipient. Some sites, however,
27339 do make use of the sender address when verifying. These are catered for by the
27340 &%use_sender%& and &%use_postmaster%& options, described in the next section.
27341
27342 If the response to the RCPT command is a 2&'xx'& code, the verification
27343 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
27344 Exim tries the next host, if any. If there is a problem with all the remote
27345 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
27346 &%callout%& option is given, in which case the condition is forced to succeed.
27347
27348 .cindex "SMTP" "output flushing, disabling for callout"
27349 A callout may take a little time. For this reason, Exim normally flushes SMTP
27350 output before performing a callout in an ACL, to avoid unexpected timeouts in
27351 clients when the SMTP PIPELINING extension is in use. The flushing can be
27352 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
27353
27354
27355
27356
27357 .section "Additional parameters for callouts" "CALLaddparcall"
27358 .cindex "callout" "additional parameters for"
27359 The &%callout%& option can be followed by an equals sign and a number of
27360 optional parameters, separated by commas. For example:
27361 .code
27362 verify = recipient/callout=10s,defer_ok
27363 .endd
27364 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
27365 separate verify options, is retained for backwards compatibility, but is now
27366 deprecated. The additional parameters for &%callout%& are as follows:
27367
27368
27369 .vlist
27370 .vitem <&'a&~time&~interval'&>
27371 .cindex "callout" "timeout, specifying"
27372 This specifies the timeout that applies for the callout attempt to each host.
27373 For example:
27374 .code
27375 verify = sender/callout=5s
27376 .endd
27377 The default is 30 seconds. The timeout is used for each response from the
27378 remote host. It is also used for the initial connection, unless overridden by
27379 the &%connect%& parameter.
27380
27381
27382 .vitem &*connect&~=&~*&<&'time&~interval'&>
27383 .cindex "callout" "connection timeout, specifying"
27384 This parameter makes it possible to set a different (usually smaller) timeout
27385 for making the SMTP connection. For example:
27386 .code
27387 verify = sender/callout=5s,connect=1s
27388 .endd
27389 If not specified, this timeout defaults to the general timeout value.
27390
27391 .vitem &*defer_ok*&
27392 .cindex "callout" "defer, action on"
27393 When this parameter is present, failure to contact any host, or any other kind
27394 of temporary error, is treated as success by the ACL. However, the cache is not
27395 updated in this circumstance.
27396
27397 .vitem &*fullpostmaster*&
27398 .cindex "callout" "full postmaster check"
27399 This operates like the &%postmaster%& option (see below), but if the check for
27400 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
27401 accordance with the specification in RFC 2821. The RFC states that the
27402 unqualified address &'postmaster'& should be accepted.
27403
27404
27405 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
27406 .cindex "callout" "sender when verifying header"
27407 When verifying addresses in header lines using the &%header_sender%&
27408 verification option, Exim behaves by default as if the addresses are envelope
27409 sender addresses from a message. Callout verification therefore tests to see
27410 whether a bounce message could be delivered, by using an empty address in the
27411 MAIL command. However, it is arguable that these addresses might never be used
27412 as envelope senders, and could therefore justifiably reject bounce messages
27413 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
27414 address to use in the MAIL command. For example:
27415 .code
27416 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
27417 .endd
27418 This parameter is available only for the &%header_sender%& verification option.
27419
27420
27421 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
27422 .cindex "callout" "overall timeout, specifying"
27423 This parameter sets an overall timeout for performing a callout verification.
27424 For example:
27425 .code
27426 verify = sender/callout=5s,maxwait=30s
27427 .endd
27428 This timeout defaults to four times the callout timeout for individual SMTP
27429 commands. The overall timeout applies when there is more than one host that can
27430 be tried. The timeout is checked before trying the next host. This prevents
27431 very long delays if there are a large number of hosts and all are timing out
27432 (for example, when network connections are timing out).
27433
27434
27435 .vitem &*no_cache*&
27436 .cindex "callout" "cache, suppressing"
27437 .cindex "caching callout, suppressing"
27438 When this parameter is given, the callout cache is neither read nor updated.
27439
27440 .vitem &*postmaster*&
27441 .cindex "callout" "postmaster; checking"
27442 When this parameter is set, a successful callout check is followed by a similar
27443 check for the local part &'postmaster'& at the same domain. If this address is
27444 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
27445 the postmaster check is recorded in a cache record; if it is a failure, this is
27446 used to fail subsequent callouts for the domain without a connection being
27447 made, until the cache record expires.
27448
27449 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
27450 The postmaster check uses an empty sender in the MAIL command by default.
27451 You can use this parameter to do a postmaster check using a different address.
27452 For example:
27453 .code
27454 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
27455 .endd
27456 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
27457 one overrides. The &%postmaster%& parameter is equivalent to this example:
27458 .code
27459 require  verify = sender/callout=postmaster_mailfrom=
27460 .endd
27461 &*Warning*&: The caching arrangements for postmaster checking do not take
27462 account of the sender address. It is assumed that either the empty address or
27463 a fixed non-empty address will be used. All that Exim remembers is that the
27464 postmaster check for the domain succeeded or failed.
27465
27466
27467 .vitem &*random*&
27468 .cindex "callout" "&""random""& check"
27469 When this parameter is set, before doing the normal callout check, Exim does a
27470 check for a &"random"& local part at the same domain. The local part is not
27471 really random &-- it is defined by the expansion of the option
27472 &%callout_random_local_part%&, which defaults to
27473 .code
27474 $primary_host_name-$tod_epoch-testing
27475 .endd
27476 The idea here is to try to determine whether the remote host accepts all local
27477 parts without checking. If it does, there is no point in doing callouts for
27478 specific local parts. If the &"random"& check succeeds, the result is saved in
27479 a cache record, and used to force the current and subsequent callout checks to
27480 succeed without a connection being made, until the cache record expires.
27481
27482 .vitem &*use_postmaster*&
27483 .cindex "callout" "sender for recipient check"
27484 This parameter applies to recipient callouts only. For example:
27485 .code
27486 deny  !verify = recipient/callout=use_postmaster
27487 .endd
27488 .vindex "&$qualify_domain$&"
27489 It causes a non-empty postmaster address to be used in the MAIL command when
27490 performing the callout for the recipient, and also for a &"random"& check if
27491 that is configured. The local part of the address is &`postmaster`& and the
27492 domain is the contents of &$qualify_domain$&.
27493
27494 .vitem &*use_sender*&
27495 This option applies to recipient callouts only. For example:
27496 .code
27497 require  verify = recipient/callout=use_sender
27498 .endd
27499 It causes the message's actual sender address to be used in the MAIL
27500 command when performing the callout, instead of an empty address. There is no
27501 need to use this option unless you know that the called hosts make use of the
27502 sender when checking recipients. If used indiscriminately, it reduces the
27503 usefulness of callout caching.
27504 .endlist
27505
27506 If you use any of the parameters that set a non-empty sender for the MAIL
27507 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
27508 &%use_sender%&), you should think about possible loops. Recipient checking is
27509 usually done between two hosts that are under the same management, and the host
27510 that receives the callouts is not normally configured to do callouts itself.
27511 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
27512 these circumstances.
27513
27514 However, if you use a non-empty sender address for a callout to an arbitrary
27515 host, there is the likelihood that the remote host will itself initiate a
27516 callout check back to your host. As it is checking what appears to be a message
27517 sender, it is likely to use an empty address in MAIL, thus avoiding a
27518 callout loop. However, to be on the safe side it would be best to set up your
27519 own ACLs so that they do not do sender verification checks when the recipient
27520 is the address you use for header sender or postmaster callout checking.
27521
27522 Another issue to think about when using non-empty senders for callouts is
27523 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
27524 by the sender/recipient combination; thus, for any given recipient, many more
27525 actual callouts are performed than when an empty sender or postmaster is used.
27526
27527
27528
27529
27530 .section "Callout caching" "SECTcallvercache"
27531 .cindex "hints database" "callout cache"
27532 .cindex "callout" "cache, description of"
27533 .cindex "caching" "callout"
27534 Exim caches the results of callouts in order to reduce the amount of resources
27535 used, unless you specify the &%no_cache%& parameter with the &%callout%&
27536 option. A hints database called &"callout"& is used for the cache. Two
27537 different record types are used: one records the result of a callout check for
27538 a specific address, and the other records information that applies to the
27539 entire domain (for example, that it accepts the local part &'postmaster'&).
27540
27541 When an original callout fails, a detailed SMTP error message is given about
27542 the failure. However, for subsequent failures use the cache data, this message
27543 is not available.
27544
27545 The expiry times for negative and positive address cache records are
27546 independent, and can be set by the global options &%callout_negative_expire%&
27547 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
27548
27549 If a host gives a negative response to an SMTP connection, or rejects any
27550 commands up to and including
27551 .code
27552 MAIL FROM:<>
27553 .endd
27554 (but not including the MAIL command with a non-empty address),
27555 any callout attempt is bound to fail. Exim remembers such failures in a
27556 domain cache record, which it uses to fail callouts for the domain without
27557 making new connections, until the domain record times out. There are two
27558 separate expiry times for domain cache records:
27559 &%callout_domain_negative_expire%& (default 3h) and
27560 &%callout_domain_positive_expire%& (default 7d).
27561
27562 Domain records expire when the negative expiry time is reached if callouts
27563 cannot be made for the domain, or if the postmaster check failed.
27564 Otherwise, they expire when the positive expiry time is reached. This
27565 ensures that, for example, a host that stops accepting &"random"& local parts
27566 will eventually be noticed.
27567
27568 The callout caching mechanism is based on the domain of the address that is
27569 being tested. If the domain routes to several hosts, it is assumed that their
27570 behaviour will be the same.
27571
27572
27573
27574 .section "Sender address verification reporting" "SECTsenaddver"
27575 .cindex "verifying" "suppressing error details"
27576 See section &<<SECTaddressverification>>& for a general discussion of
27577 verification. When sender verification fails in an ACL, the details of the
27578 failure are given as additional output lines before the 550 response to the
27579 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
27580 you might see:
27581 .code
27582 MAIL FROM:<xyz@abc.example>
27583 250 OK
27584 RCPT TO:<pqr@def.example>
27585 550-Verification failed for <xyz@abc.example>
27586 550-Called:   192.168.34.43
27587 550-Sent:     RCPT TO:<xyz@abc.example>
27588 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
27589 550 Sender verification failed
27590 .endd
27591 If more than one RCPT command fails in the same way, the details are given
27592 only for the first of them. However, some administrators do not want to send
27593 out this much information. You can suppress the details by adding
27594 &`/no_details`& to the ACL statement that requests sender verification. For
27595 example:
27596 .code
27597 verify = sender/no_details
27598 .endd
27599
27600 .section "Redirection while verifying" "SECTredirwhilveri"
27601 .cindex "verifying" "redirection while"
27602 .cindex "address redirection" "while verifying"
27603 A dilemma arises when a local address is redirected by aliasing or forwarding
27604 during verification: should the generated addresses themselves be verified,
27605 or should the successful expansion of the original address be enough to verify
27606 it? By default, Exim takes the following pragmatic approach:
27607
27608 .ilist
27609 When an incoming address is redirected to just one child address, verification
27610 continues with the child address, and if that fails to verify, the original
27611 verification also fails.
27612 .next
27613 When an incoming address is redirected to more than one child address,
27614 verification does not continue. A success result is returned.
27615 .endlist
27616
27617 This seems the most reasonable behaviour for the common use of aliasing as a
27618 way of redirecting different local parts to the same mailbox. It means, for
27619 example, that a pair of alias entries of the form
27620 .code
27621 A.Wol:   aw123
27622 aw123:   :fail: Gone away, no forwarding address
27623 .endd
27624 work as expected, with both local parts causing verification failure. When a
27625 redirection generates more than one address, the behaviour is more like a
27626 mailing list, where the existence of the alias itself is sufficient for
27627 verification to succeed.
27628
27629 It is possible, however, to change the default behaviour so that all successful
27630 redirections count as successful verifications, however many new addresses are
27631 generated. This is specified by the &%success_on_redirect%& verification
27632 option. For example:
27633 .code
27634 require verify = recipient/success_on_redirect/callout=10s
27635 .endd
27636 In this example, verification succeeds if a router generates a new address, and
27637 the callout does not occur, because no address was routed to a remote host.
27638
27639 When verification is being tested via the &%-bv%& option, the treatment of
27640 redirections is as just described, unless the &%-v%& or any debugging option is
27641 also specified. In that case, full verification is done for every generated
27642 address and a report is output for each of them.
27643
27644
27645
27646 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
27647 .cindex "CSA" "verifying"
27648 Client SMTP Authorization is a system that allows a site to advertise
27649 which machines are and are not permitted to send email. This is done by placing
27650 special SRV records in the DNS; these are looked up using the client's HELO
27651 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
27652 Authorization checks in Exim are performed by the ACL condition:
27653 .code
27654 verify = csa
27655 .endd
27656 This fails if the client is not authorized. If there is a DNS problem, or if no
27657 valid CSA SRV record is found, or if the client is authorized, the condition
27658 succeeds. These three cases can be distinguished using the expansion variable
27659 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
27660 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
27661 be likely to cause problems for legitimate email.
27662
27663 The error messages produced by the CSA code include slightly more
27664 detail. If &$csa_status$& is &"defer"&, this may be because of problems
27665 looking up the CSA SRV record, or problems looking up the CSA target
27666 address record. There are four reasons for &$csa_status$& being &"fail"&:
27667
27668 .ilist
27669 The client's host name is explicitly not authorized.
27670 .next
27671 The client's IP address does not match any of the CSA target IP addresses.
27672 .next
27673 The client's host name is authorized but it has no valid target IP addresses
27674 (for example, the target's addresses are IPv6 and the client is using IPv4).
27675 .next
27676 The client's host name has no CSA SRV record but a parent domain has asserted
27677 that all subdomains must be explicitly authorized.
27678 .endlist
27679
27680 The &%csa%& verification condition can take an argument which is the domain to
27681 use for the DNS query. The default is:
27682 .code
27683 verify = csa/$sender_helo_name
27684 .endd
27685 This implementation includes an extension to CSA. If the query domain
27686 is an address literal such as [192.0.2.95], or if it is a bare IP
27687 address, Exim searches for CSA SRV records in the reverse DNS as if
27688 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
27689 meaningful to say:
27690 .code
27691 verify = csa/$sender_host_address
27692 .endd
27693 In fact, this is the check that Exim performs if the client does not say HELO.
27694 This extension can be turned off by setting the main configuration option
27695 &%dns_csa_use_reverse%& to be false.
27696
27697 If a CSA SRV record is not found for the domain itself, a search
27698 is performed through its parent domains for a record which might be
27699 making assertions about subdomains. The maximum depth of this search is limited
27700 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
27701 default. Exim does not look for CSA SRV records in a top level domain, so the
27702 default settings handle HELO domains as long as seven
27703 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
27704 of legitimate HELO domains.
27705
27706 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
27707 direct SRV lookups, this is not sufficient because of the extra parent domain
27708 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
27709 addresses into lookups in the reverse DNS space. The result of a successful
27710 lookup such as:
27711 .code
27712 ${lookup dnsdb {csa=$sender_helo_name}}
27713 .endd
27714 has two space-separated fields: an authorization code and a target host name.
27715 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
27716 authorization required but absent, or &"?"& for unknown.
27717
27718
27719
27720
27721 .section "Bounce address tag validation" "SECTverifyPRVS"
27722 .cindex "BATV, verifying"
27723 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
27724 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
27725 Genuine incoming bounce messages should therefore always be addressed to
27726 recipients that have a valid tag. This scheme is a way of detecting unwanted
27727 bounce messages caused by sender address forgeries (often called &"collateral
27728 spam"&), because the recipients of such messages do not include valid tags.
27729
27730 There are two expansion items to help with the implementation of the BATV
27731 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
27732 the original envelope sender address by using a simple key to add a hash of the
27733 address and some time-based randomizing information. The &%prvs%& expansion
27734 item creates a signed address, and the &%prvscheck%& expansion item checks one.
27735 The syntax of these expansion items is described in section
27736 &<<SECTexpansionitems>>&.
27737
27738 As an example, suppose the secret per-address keys are stored in an MySQL
27739 database. A query to look up the key for an address could be defined as a macro
27740 like this:
27741 .code
27742 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
27743                 WHERE sender='${quote_mysql:$prvscheck_address}'\
27744                 }{$value}}
27745 .endd
27746 Suppose also that the senders who make use of BATV are defined by an address
27747 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
27748 use this:
27749 .code
27750 # Bounces: drop unsigned addresses for BATV senders
27751 deny message = This address does not send an unsigned reverse path
27752      senders = :
27753      recipients = +batv_senders
27754
27755 # Bounces: In case of prvs-signed address, check signature.
27756 deny message = Invalid reverse path signature.
27757      senders = :
27758      condition  = ${prvscheck {$local_part@$domain}\
27759                   {PRVSCHECK_SQL}{1}}
27760      !condition = $prvscheck_result
27761 .endd
27762 The first statement rejects recipients for bounce messages that are addressed
27763 to plain BATV sender addresses, because it is known that BATV senders do not
27764 send out messages with plain sender addresses. The second statement rejects
27765 recipients that are prvs-signed, but with invalid signatures (either because
27766 the key is wrong, or the signature has timed out).
27767
27768 A non-prvs-signed address is not rejected by the second statement, because the
27769 &%prvscheck%& expansion yields an empty string if its first argument is not a
27770 prvs-signed address, thus causing the &%condition%& condition to be false. If
27771 the first argument is a syntactically valid prvs-signed address, the yield is
27772 the third string (in this case &"1"&), whether or not the cryptographic and
27773 timeout checks succeed. The &$prvscheck_result$& variable contains the result
27774 of the checks (empty for failure, &"1"& for success).
27775
27776 There is one more issue you must consider when implementing prvs-signing:
27777 you have to ensure that the routers accept prvs-signed addresses and
27778 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
27779 router to remove the signature with a configuration along these lines:
27780 .code
27781 batv_redirect:
27782   driver = redirect
27783   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
27784 .endd
27785 This works because, if the third argument of &%prvscheck%& is empty, the result
27786 of the expansion of a prvs-signed address is the decoded value of the original
27787 address. This router should probably be the first of your routers that handles
27788 local addresses.
27789
27790 To create BATV-signed addresses in the first place, a transport of this form
27791 can be used:
27792 .code
27793 external_smtp_batv:
27794   driver = smtp
27795   return_path = ${prvs {$return_path} \
27796                        {${lookup mysql{SELECT \
27797                        secret FROM batv_prvs WHERE \
27798                        sender='${quote_mysql:$sender_address}'} \
27799                        {$value}fail}}}
27800 .endd
27801 If no key can be found for the existing return path, no signing takes place.
27802
27803
27804
27805 .section "Using an ACL to control relaying" "SECTrelaycontrol"
27806 .cindex "&ACL;" "relay control"
27807 .cindex "relaying" "control by ACL"
27808 .cindex "policy control" "relay control"
27809 An MTA is said to &'relay'& a message if it receives it from some host and
27810 delivers it directly to another host as a result of a remote address contained
27811 within it. Redirecting a local address via an alias or forward file and then
27812 passing the message on to another host is not relaying,
27813 .cindex "&""percent hack""&"
27814 but a redirection as a result of the &"percent hack"& is.
27815
27816 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
27817 A host which is acting as a gateway or an MX backup is concerned with incoming
27818 relaying from arbitrary hosts to a specific set of domains. On the other hand,
27819 a host which is acting as a smart host for a number of clients is concerned
27820 with outgoing relaying from those clients to the Internet at large. Often the
27821 same host is fulfilling both functions,
27822 . ///
27823 . as illustrated in the diagram below,
27824 . ///
27825 but in principle these two kinds of relaying are entirely independent. What is
27826 not wanted is the transmission of mail from arbitrary remote hosts through your
27827 system to arbitrary domains.
27828
27829
27830 You can implement relay control by means of suitable statements in the ACL that
27831 runs for each RCPT command. For convenience, it is often easiest to use
27832 Exim's named list facility to define the domains and hosts involved. For
27833 example, suppose you want to do the following:
27834
27835 .ilist
27836 Deliver a number of domains to mailboxes on the local host (or process them
27837 locally in some other way). Let's say these are &'my.dom1.example'& and
27838 &'my.dom2.example'&.
27839 .next
27840 Relay mail for a number of other domains for which you are the secondary MX.
27841 These might be &'friend1.example'& and &'friend2.example'&.
27842 .next
27843 Relay mail from the hosts on your local LAN, to whatever domains are involved.
27844 Suppose your LAN is 192.168.45.0/24.
27845 .endlist
27846
27847
27848 In the main part of the configuration, you put the following definitions:
27849 .code
27850 domainlist local_domains = my.dom1.example : my.dom2.example
27851 domainlist relay_domains = friend1.example : friend2.example
27852 hostlist   relay_hosts   = 192.168.45.0/24
27853 .endd
27854 Now you can use these definitions in the ACL that is run for every RCPT
27855 command:
27856 .code
27857 acl_check_rcpt:
27858   accept domains = +local_domains : +relay_domains
27859   accept hosts   = +relay_hosts
27860 .endd
27861 The first statement accepts any RCPT command that contains an address in
27862 the local or relay domains. For any other domain, control passes to the second
27863 statement, which accepts the command only if it comes from one of the relay
27864 hosts. In practice, you will probably want to make your ACL more sophisticated
27865 than this, for example, by including sender and recipient verification. The
27866 default configuration includes a more comprehensive example, which is described
27867 in chapter &<<CHAPdefconfil>>&.
27868
27869
27870
27871 .section "Checking a relay configuration" "SECTcheralcon"
27872 .cindex "relaying" "checking control of"
27873 You can check the relay characteristics of your configuration in the same way
27874 that you can test any ACL behaviour for an incoming SMTP connection, by using
27875 the &%-bh%& option to run a fake SMTP session with which you interact.
27876
27877 For specifically testing for unwanted relaying, the host
27878 &'relay-test.mail-abuse.org'& provides a useful service. If you telnet to this
27879 host from the host on which Exim is running, using the normal telnet port, you
27880 will see a normal telnet connection message and then quite a long delay. Be
27881 patient. The remote host is making an SMTP connection back to your host, and
27882 trying a number of common probes to test for open relay vulnerability. The
27883 results of the tests will eventually appear on your terminal.
27884 .ecindex IIDacl
27885
27886
27887
27888 . ////////////////////////////////////////////////////////////////////////////
27889 . ////////////////////////////////////////////////////////////////////////////
27890
27891 .chapter "Content scanning at ACL time" "CHAPexiscan"
27892 .scindex IIDcosca "content scanning" "at ACL time"
27893 The extension of Exim to include content scanning at ACL time, formerly known
27894 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
27895 was integrated into the main source for Exim release 4.50, and Tom continues to
27896 maintain it. Most of the wording of this chapter is taken from Tom's
27897 specification.
27898
27899 It is also possible to scan the content of messages at other times. The
27900 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
27901 scanning after all the ACLs have run. A transport filter can be used to scan
27902 messages at delivery time (see the &%transport_filter%& option, described in
27903 chapter &<<CHAPtransportgeneric>>&).
27904
27905 If you want to include the ACL-time content-scanning features when you compile
27906 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
27907 &_Local/Makefile_&. When you do that, the Exim binary is built with:
27908
27909 .ilist
27910 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
27911 for all MIME parts for SMTP and non-SMTP messages, respectively.
27912 .next
27913 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
27914 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
27915 run at the end of message reception (the &%acl_smtp_data%& ACL).
27916 .next
27917 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
27918 of messages, or parts of messages, for debugging purposes.
27919 .next
27920 Additional expansion variables that are set in the new ACL and by the new
27921 conditions.
27922 .next
27923 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
27924 .endlist
27925
27926 There is another content-scanning configuration option for &_Local/Makefile_&,
27927 called WITH_OLD_DEMIME. If this is set, the old, deprecated &%demime%& ACL
27928 condition is compiled, in addition to all the other content-scanning features.
27929
27930 Content-scanning is continually evolving, and new features are still being
27931 added. While such features are still unstable and liable to incompatible
27932 changes, they are made available in Exim by setting options whose names begin
27933 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
27934 this manual. You can find out about them by reading the file called
27935 &_doc/experimental.txt_&.
27936
27937 All the content-scanning facilities work on a MBOX copy of the message that is
27938 temporarily created in a file called:
27939 .display
27940 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
27941 .endd
27942 The &_.eml_& extension is a friendly hint to virus scanners that they can
27943 expect an MBOX-like structure inside that file. The file is created when the
27944 first content scanning facility is called. Subsequent calls to content
27945 scanning conditions open the same file again. The directory is recursively
27946 removed when the &%acl_smtp_data%& ACL has finished running, unless
27947 .code
27948 control = no_mbox_unspool
27949 .endd
27950 has been encountered. When the MIME ACL decodes files, they are put into the
27951 same directory by default.
27952
27953
27954
27955 .section "Scanning for viruses" "SECTscanvirus"
27956 .cindex "virus scanning"
27957 .cindex "content scanning" "for viruses"
27958 .cindex "content scanning" "the &%malware%& condition"
27959 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
27960 It supports a &"generic"& interface to scanners called via the shell, and
27961 specialized interfaces for &"daemon"& type virus scanners, which are resident
27962 in memory and thus are much faster.
27963
27964 .oindex "&%av_scanner%&"
27965 You can set the &%av_scanner%& option in first part of the Exim configuration
27966 file to specify which scanner to use, together with any additional options that
27967 are needed. The basic syntax is as follows:
27968 .display
27969 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
27970 .endd
27971 If you do not set &%av_scanner%&, it defaults to
27972 .code
27973 av_scanner = sophie:/var/run/sophie
27974 .endd
27975 If the value of &%av_scanner%& starts with a dollar character, it is expanded
27976 before use. The following scanner types are supported in this release:
27977
27978 .vlist
27979 .vitem &%aveserver%&
27980 .cindex "virus scanners" "Kaspersky"
27981 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
27982 at &url(http://www.kaspersky.com). This scanner type takes one option,
27983 which is the path to the daemon's UNIX socket. The default is shown in this
27984 example:
27985 .code
27986 av_scanner = aveserver:/var/run/aveserver
27987 .endd
27988
27989 .vitem &%clamd%&
27990 .cindex "virus scanners" "clamd"
27991 This daemon-type scanner is GPL and free. You can get it at
27992 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
27993 unpack MIME containers, so it used to be recommended to unpack MIME attachments
27994 in the MIME ACL. This no longer believed to be necessary. One option is
27995 required: either the path and name of a UNIX socket file, or a hostname or IP
27996 number, and a port, separated by space, as in the second of these examples:
27997 .code
27998 av_scanner = clamd:/opt/clamd/socket
27999 av_scanner = clamd:192.0.2.3 1234
28000 av_scanner = clamd:192.0.2.3 1234:local
28001 .endd
28002 If the value of av_scanner points to a UNIX socket file or contains the local
28003 keyword, then the ClamAV interface will pass a filename containing the data
28004 to be scanned, which will should normally result in less I/O happening and be
28005 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
28006 Exim does not assume that there is a common filesystem with the remote host.
28007 There is an option WITH_OLD_CLAMAV_STREAM in &_src/EDITME_& available, should
28008 you be running a version of ClamAV prior to 0.95.
28009 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
28010 contributing the code for this scanner.
28011
28012 .vitem &%cmdline%&
28013 .cindex "virus scanners" "command line interface"
28014 This is the keyword for the generic command line scanner interface. It can be
28015 used to attach virus scanners that are invoked from the shell. This scanner
28016 type takes 3 mandatory options:
28017
28018 .olist
28019 The full path and name of the scanner binary, with all command line options,
28020 and a placeholder (&`%s`&) for the directory to scan.
28021
28022 .next
28023 A regular expression to match against the STDOUT and STDERR output of the
28024 virus scanner. If the expression matches, a virus was found. You must make
28025 absolutely sure that this expression matches on &"virus found"&. This is called
28026 the &"trigger"& expression.
28027
28028 .next
28029 Another regular expression, containing exactly one pair of parentheses, to
28030 match the name of the virus found in the scanners output. This is called the
28031 &"name"& expression.
28032 .endlist olist
28033
28034 For example, Sophos Sweep reports a virus on a line like this:
28035 .code
28036 Virus 'W32/Magistr-B' found in file ./those.bat
28037 .endd
28038 For the trigger expression, we can match the phrase &"found in file"&. For the
28039 name expression, we want to extract the W32/Magistr-B string, so we can match
28040 for the single quotes left and right of it. Altogether, this makes the
28041 configuration setting:
28042 .code
28043 av_scanner = cmdline:\
28044              /path/to/sweep -ss -all -rec -archive %s:\
28045              found in file:'(.+)'
28046 .endd
28047 .vitem &%drweb%&
28048 .cindex "virus scanners" "DrWeb"
28049 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface takes one
28050 argument, either a full path to a UNIX socket, or an IP address and port
28051 separated by white space, as in these examples:
28052 .code
28053 av_scanner = drweb:/var/run/drwebd.sock
28054 av_scanner = drweb:192.168.2.20 31337
28055 .endd
28056 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
28057 is used. Thanks to Alex Miller for contributing the code for this scanner.
28058
28059 .vitem &%fsecure%&
28060 .cindex "virus scanners" "F-Secure"
28061 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
28062 argument which is the path to a UNIX socket. For example:
28063 .code
28064 av_scanner = fsecure:/path/to/.fsav
28065 .endd
28066 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
28067 Thelmen for contributing the code for this scanner.
28068
28069 .vitem &%kavdaemon%&
28070 .cindex "virus scanners" "Kaspersky"
28071 This is the scanner daemon of Kaspersky Version 4. This version of the
28072 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
28073 scanner type takes one option, which is the path to the daemon's UNIX socket.
28074 For example:
28075 .code
28076 av_scanner = kavdaemon:/opt/AVP/AvpCtl
28077 .endd
28078 The default path is &_/var/run/AvpCtl_&.
28079
28080 .vitem &%mksd%&
28081 .cindex "virus scanners" "mksd"
28082 This is a daemon type scanner that is aimed mainly at Polish users, though some
28083 parts of documentation are now available in English. You can get it at
28084 &url(http://linux.mks.com.pl/). The only option for this scanner type is
28085 the maximum number of processes used simultaneously to scan the attachments,
28086 provided that the demime facility is employed and also provided that mksd has
28087 been run with at least the same number of child processes. For example:
28088 .code
28089 av_scanner = mksd:2
28090 .endd
28091 You can safely omit this option (the default value is 1).
28092
28093 .vitem &%sophie%&
28094 .cindex "virus scanners" "Sophos and Sophie"
28095 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
28096 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
28097 for this scanner type is the path to the UNIX socket that Sophie uses for
28098 client communication. For example:
28099 .code
28100 av_scanner = sophie:/tmp/sophie
28101 .endd
28102 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
28103 the option.
28104 .endlist
28105
28106 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
28107 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
28108 ACL.
28109
28110 The &%av_scanner%& option is expanded each time &%malware%& is called. This
28111 makes it possible to use different scanners. See further below for an example.
28112 The &%malware%& condition caches its results, so when you use it multiple times
28113 for the same message, the actual scanning process is only carried out once.
28114 However, using expandable items in &%av_scanner%& disables this caching, in
28115 which case each use of the &%malware%& condition causes a new scan of the
28116 message.
28117
28118 The &%malware%& condition takes a right-hand argument that is expanded before
28119 use. It can then be one of
28120
28121 .ilist
28122 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
28123 The condition succeeds if a virus was found, and fail otherwise. This is the
28124 recommended usage.
28125 .next
28126 &"false"& or &"0"& or an empty string, in which case no scanning is done and
28127 the condition fails immediately.
28128 .next
28129 A regular expression, in which case the message is scanned for viruses. The
28130 condition succeeds if a virus is found and its name matches the regular
28131 expression. This allows you to take special actions on certain types of virus.
28132 .endlist
28133
28134 You can append &`/defer_ok`& to the &%malware%& condition to accept messages
28135 even if there is a problem with the virus scanner. Otherwise, such a problem
28136 causes the ACL to defer.
28137
28138 .vindex "&$malware_name$&"
28139 When a virus is found, the condition sets up an expansion variable called
28140 &$malware_name$& that contains the name of the virus. You can use it in a
28141 &%message%& modifier that specifies the error returned to the sender, and/or in
28142 logging data.
28143
28144 If your virus scanner cannot unpack MIME and TNEF containers itself, you should
28145 use the &%demime%& condition (see section &<<SECTdemimecond>>&) before the
28146 &%malware%& condition.
28147
28148 Beware the interaction of Exim's &%message_size_limit%& with any size limits
28149 imposed by your anti-virus scanner.
28150
28151 Here is a very simple scanning example:
28152 .code
28153 deny message = This message contains malware ($malware_name)
28154      demime = *
28155      malware = *
28156 .endd
28157 The next example accepts messages when there is a problem with the scanner:
28158 .code
28159 deny message = This message contains malware ($malware_name)
28160      demime = *
28161      malware = */defer_ok
28162 .endd
28163 The next example shows how to use an ACL variable to scan with both sophie and
28164 aveserver. It assumes you have set:
28165 .code
28166 av_scanner = $acl_m0
28167 .endd
28168 in the main Exim configuration.
28169 .code
28170 deny message = This message contains malware ($malware_name)
28171      set acl_m0 = sophie
28172      malware = *
28173
28174 deny message = This message contains malware ($malware_name)
28175      set acl_m0 = aveserver
28176      malware = *
28177 .endd
28178
28179
28180 .section "Scanning with SpamAssassin" "SECTscanspamass"
28181 .cindex "content scanning" "for spam"
28182 .cindex "spam scanning"
28183 .cindex "SpamAssassin"
28184 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
28185 score and a report for the message. You can get SpamAssassin at
28186 &url(http://www.spamassassin.org), or, if you have a working Perl
28187 installation, you can use CPAN by running:
28188 .code
28189 perl -MCPAN -e 'install Mail::SpamAssassin'
28190 .endd
28191 SpamAssassin has its own set of configuration files. Please review its
28192 documentation to see how you can tweak it. The default installation should work
28193 nicely, however.
28194
28195 .oindex "&%spamd_address%&"
28196 After having installed and configured SpamAssassin, start the &%spamd%& daemon.
28197 By default, it listens on 127.0.0.1, TCP port 783. If you use another host or
28198 port for &%spamd%&, you must set the &%spamd_address%& option in the global
28199 part of the Exim configuration as follows (example):
28200 .code
28201 spamd_address = 192.168.99.45 387
28202 .endd
28203 You do not need to set this option if you use the default. As of version 2.60,
28204 &%spamd%& also supports communication over UNIX sockets. If you want to use
28205 these, supply &%spamd_address%& with an absolute file name instead of a
28206 address/port pair:
28207 .code
28208 spamd_address = /var/run/spamd_socket
28209 .endd
28210 You can have multiple &%spamd%& servers to improve scalability. These can
28211 reside on other hardware reachable over the network. To specify multiple
28212 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
28213 option, separated with colons:
28214 .code
28215 spamd_address = 192.168.2.10 783 : \
28216                 192.168.2.11 783 : \
28217                 192.168.2.12 783
28218 .endd
28219 Up to 32 &%spamd%& servers are supported. The servers are queried in a random
28220 fashion. When a server fails to respond to the connection attempt, all other
28221 servers are tried until one succeeds. If no server responds, the &%spam%&
28222 condition defers.
28223
28224 &*Warning*&: It is not possible to use the UNIX socket connection method with
28225 multiple &%spamd%& servers.
28226
28227 The &%spamd_address%& variable is expanded before use if it starts with
28228 a dollar sign. In this case, the expansion may return a string that is
28229 used as the list so that multiple spamd servers can be the result of an
28230 expansion.
28231
28232 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
28233 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
28234 .code
28235 deny message = This message was classified as SPAM
28236      spam = joe
28237 .endd
28238 The right-hand side of the &%spam%& condition specifies a name. This is
28239 relevant if you have set up multiple SpamAssassin profiles. If you do not want
28240 to scan using a specific profile, but rather use the SpamAssassin system-wide
28241 default profile, you can scan for an unknown name, or simply use &"nobody"&.
28242 However, you must put something on the right-hand side.
28243
28244 The name allows you to use per-domain or per-user antispam profiles in
28245 principle, but this is not straightforward in practice, because a message may
28246 have multiple recipients, not necessarily all in the same domain. Because the
28247 &%spam%& condition has to be called from a DATA ACL in order to be able to
28248 read the contents of the message, the variables &$local_part$& and &$domain$&
28249 are not set.
28250
28251 The right-hand side of the &%spam%& condition is expanded before being used, so
28252 you can put lookups or conditions there. When the right-hand side evaluates to
28253 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
28254
28255
28256 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
28257 large ones may cause significant performance degradation. As most spam messages
28258 are quite small, it is recommended that you do not scan the big ones. For
28259 example:
28260 .code
28261 deny message = This message was classified as SPAM
28262      condition = ${if < {$message_size}{10K}}
28263      spam = nobody
28264 .endd
28265
28266 The &%spam%& condition returns true if the threshold specified in the user's
28267 SpamAssassin profile has been matched or exceeded. If you want to use the
28268 &%spam%& condition for its side effects (see the variables below), you can make
28269 it always return &"true"& by appending &`:true`& to the username.
28270
28271 .cindex "spam scanning" "returned variables"
28272 When the &%spam%& condition is run, it sets up a number of expansion
28273 variables. These variables are saved with the received message, thus they are
28274 available for use at delivery time.
28275
28276 .vlist
28277 .vitem &$spam_score$&
28278 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
28279 for inclusion in log or reject messages.
28280
28281 .vitem &$spam_score_int$&
28282 The spam score of the message, multiplied by ten, as an integer value. For
28283 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
28284 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
28285 The integer value is useful for numeric comparisons in conditions.
28286
28287
28288 .vitem &$spam_bar$&
28289 A string consisting of a number of &"+"& or &"-"& characters, representing the
28290 integer part of the spam score value. A spam score of 4.4 would have a
28291 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
28292 headers, since MUAs can match on such strings.
28293
28294 .vitem &$spam_report$&
28295 A multiline text table, containing the full SpamAssassin report for the
28296 message. Useful for inclusion in headers or reject messages.
28297 .endlist
28298
28299 The &%spam%& condition caches its results unless expansion in
28300 spamd_address was used. If you call it again with the same user name, it
28301 does not scan again, but rather returns the same values as before.
28302
28303 The &%spam%& condition returns DEFER if there is any error while running
28304 the message through SpamAssassin or if the expansion of spamd_address
28305 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
28306 statement block), append &`/defer_ok`& to the right-hand side of the
28307 spam condition, like this:
28308 .code
28309 deny message = This message was classified as SPAM
28310      spam    = joe/defer_ok
28311 .endd
28312 This causes messages to be accepted even if there is a problem with &%spamd%&.
28313
28314 Here is a longer, commented example of the use of the &%spam%&
28315 condition:
28316 .code
28317 # put headers in all messages (no matter if spam or not)
28318 warn  spam = nobody:true
28319       add_header = X-Spam-Score: $spam_score ($spam_bar)
28320       add_header = X-Spam-Report: $spam_report
28321
28322 # add second subject line with *SPAM* marker when message
28323 # is over threshold
28324 warn  spam = nobody
28325       add_header = Subject: *SPAM* $h_Subject:
28326
28327 # reject spam at high scores (> 12)
28328 deny  message = This message scored $spam_score spam points.
28329       spam = nobody:true
28330       condition = ${if >{$spam_score_int}{120}{1}{0}}
28331 .endd
28332
28333
28334
28335 .section "Scanning MIME parts" "SECTscanmimepart"
28336 .cindex "content scanning" "MIME parts"
28337 .cindex "MIME content scanning"
28338 .oindex "&%acl_smtp_mime%&"
28339 .oindex "&%acl_not_smtp_mime%&"
28340 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
28341 each MIME part of an SMTP message, including multipart types, in the sequence
28342 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
28343 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
28344 options may both refer to the same ACL if you want the same processing in both
28345 cases.
28346
28347 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
28348 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
28349 the case of a non-SMTP message. However, a MIME ACL is called only if the
28350 message contains a &'Content-Type:'& header line. When a call to a MIME
28351 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
28352 result code is sent to the client. In the case of an SMTP message, the
28353 &%acl_smtp_data%& ACL is not called when this happens.
28354
28355 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
28356 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
28357 condition to match against the raw MIME part. You can also use the
28358 &%mime_regex%& condition to match against the decoded MIME part (see section
28359 &<<SECTscanregex>>&).
28360
28361 At the start of a MIME ACL, a number of variables are set from the header
28362 information for the relevant MIME part. These are described below. The contents
28363 of the MIME part are not by default decoded into a disk file except for MIME
28364 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
28365 part into a disk file, you can use the &%decode%& condition. The general
28366 syntax is:
28367 .display
28368 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
28369 .endd
28370 The right hand side is expanded before use. After expansion,
28371 the value can be:
28372
28373 .olist
28374 &"0"& or &"false"&, in which case no decoding is done.
28375 .next
28376 The string &"default"&. In that case, the file is put in the temporary
28377 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
28378 a sequential file name consisting of the message id and a sequence number. The
28379 full path and name is available in &$mime_decoded_filename$& after decoding.
28380 .next
28381 A full path name starting with a slash. If the full name is an existing
28382 directory, it is used as a replacement for the default directory. The filename
28383 is then sequentially assigned. If the path does not exist, it is used as
28384 the full path and file name.
28385 .next
28386 If the string does not start with a slash, it is used as the
28387 filename, and the default path is then used.
28388 .endlist
28389 The &%decode%& condition normally succeeds. It is only false for syntax
28390 errors or unusual circumstances such as memory shortages. You can easily decode
28391 a file with its original, proposed filename using
28392 .code
28393 decode = $mime_filename
28394 .endd
28395 However, you should keep in mind that &$mime_filename$& might contain
28396 anything. If you place files outside of the default path, they are not
28397 automatically unlinked.
28398
28399 For RFC822 attachments (these are messages attached to messages, with a
28400 content-type of &"message/rfc822"&), the ACL is called again in the same manner
28401 as for the primary message, only that the &$mime_is_rfc822$& expansion
28402 variable is set (see below). Attached messages are always decoded to disk
28403 before being checked, and the files are unlinked once the check is done.
28404
28405 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
28406 used to match regular expressions against raw and decoded MIME parts,
28407 respectively. They are described in section &<<SECTscanregex>>&.
28408
28409 .cindex "MIME content scanning" "returned variables"
28410 The following list describes all expansion variables that are
28411 available in the MIME ACL:
28412
28413 .vlist
28414 .vitem &$mime_boundary$&
28415 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
28416 have a boundary string, which is stored in this variable. If the current part
28417 has no boundary parameter in the &'Content-Type:'& header, this variable
28418 contains the empty string.
28419
28420 .vitem &$mime_charset$&
28421 This variable contains the character set identifier, if one was found in the
28422 &'Content-Type:'& header. Examples for charset identifiers are:
28423 .code
28424 us-ascii
28425 gb2312 (Chinese)
28426 iso-8859-1
28427 .endd
28428 Please note that this value is not normalized, so you should do matches
28429 case-insensitively.
28430
28431 .vitem &$mime_content_description$&
28432 This variable contains the normalized content of the &'Content-Description:'&
28433 header. It can contain a human-readable description of the parts content. Some
28434 implementations repeat the filename for attachments here, but they are usually
28435 only used for display purposes.
28436
28437 .vitem &$mime_content_disposition$&
28438 This variable contains the normalized content of the &'Content-Disposition:'&
28439 header. You can expect strings like &"attachment"& or &"inline"& here.
28440
28441 .vitem &$mime_content_id$&
28442 This variable contains the normalized content of the &'Content-ID:'& header.
28443 This is a unique ID that can be used to reference a part from another part.
28444
28445 .vitem &$mime_content_size$&
28446 This variable is set only after the &%decode%& modifier (see above) has been
28447 successfully run. It contains the size of the decoded part in kilobytes. The
28448 size is always rounded up to full kilobytes, so only a completely empty part
28449 has a &$mime_content_size$& of zero.
28450
28451 .vitem &$mime_content_transfer_encoding$&
28452 This variable contains the normalized content of the
28453 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
28454 type. Typical values are &"base64"& and &"quoted-printable"&.
28455
28456 .vitem &$mime_content_type$&
28457 If the MIME part has a &'Content-Type:'& header, this variable contains its
28458 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
28459 are some examples of popular MIME types, as they may appear in this variable:
28460 .code
28461 text/plain
28462 text/html
28463 application/octet-stream
28464 image/jpeg
28465 audio/midi
28466 .endd
28467 If the MIME part has no &'Content-Type:'& header, this variable contains the
28468 empty string.
28469
28470 .vitem &$mime_decoded_filename$&
28471 This variable is set only after the &%decode%& modifier (see above) has been
28472 successfully run. It contains the full path and file name of the file
28473 containing the decoded data.
28474 .endlist
28475
28476 .cindex "RFC 2047"
28477 .vlist
28478 .vitem &$mime_filename$&
28479 This is perhaps the most important of the MIME variables. It contains a
28480 proposed filename for an attachment, if one was found in either the
28481 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
28482 RFC2047 decoded, but no additional sanity checks are done. If no filename was
28483 found, this variable contains the empty string.
28484
28485 .vitem &$mime_is_coverletter$&
28486 This variable attempts to differentiate the &"cover letter"& of an e-mail from
28487 attached data. It can be used to clamp down on flashy or unnecessarily encoded
28488 content in the cover letter, while not restricting attachments at all.
28489
28490 The variable contains 1 (true) for a MIME part believed to be part of the
28491 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
28492 follows:
28493
28494 .olist
28495 The outermost MIME part of a message is always a cover letter.
28496
28497 .next
28498 If a multipart/alternative or multipart/related MIME part is a cover letter,
28499 so are all MIME subparts within that multipart.
28500
28501 .next
28502 If any other multipart is a cover letter, the first subpart is a cover letter,
28503 and the rest are attachments.
28504
28505 .next
28506 All parts contained within an attachment multipart are attachments.
28507 .endlist olist
28508
28509 As an example, the following will ban &"HTML mail"& (including that sent with
28510 alternative plain text), while allowing HTML files to be attached. HTML
28511 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
28512 .code
28513 deny message = HTML mail is not accepted here
28514 !condition = $mime_is_rfc822
28515 condition = $mime_is_coverletter
28516 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
28517 .endd
28518 .vitem &$mime_is_multipart$&
28519 This variable has the value 1 (true) when the current part has the main type
28520 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
28521 Since multipart entities only serve as containers for other parts, you may not
28522 want to carry out specific actions on them.
28523
28524 .vitem &$mime_is_rfc822$&
28525 This variable has the value 1 (true) if the current part is not a part of the
28526 checked message itself, but part of an attached message. Attached message
28527 decoding is fully recursive.
28528
28529 .vitem &$mime_part_count$&
28530 This variable is a counter that is raised for each processed MIME part. It
28531 starts at zero for the very first part (which is usually a multipart). The
28532 counter is per-message, so it is reset when processing RFC822 attachments (see
28533 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
28534 complete, so you can use it in the DATA ACL to determine the number of MIME
28535 parts of a message. For non-MIME messages, this variable contains the value -1.
28536 .endlist
28537
28538
28539
28540 .section "Scanning with regular expressions" "SECTscanregex"
28541 .cindex "content scanning" "with regular expressions"
28542 .cindex "regular expressions" "content scanning with"
28543 You can specify your own custom regular expression matches on the full body of
28544 the message, or on individual MIME parts.
28545
28546 The &%regex%& condition takes one or more regular expressions as arguments and
28547 matches them against the full message (when called in the DATA ACL) or a raw
28548 MIME part (when called in the MIME ACL). The &%regex%& condition matches
28549 linewise, with a maximum line length of 32K characters. That means you cannot
28550 have multiline matches with the &%regex%& condition.
28551
28552 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
28553 to 32K of decoded content (the whole content at once, not linewise). If the
28554 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
28555 is decoded automatically when &%mime_regex%& is executed (using default path
28556 and filename values). If the decoded data is larger than  32K, only the first
28557 32K characters are checked.
28558
28559 The regular expressions are passed as a colon-separated list. To include a
28560 literal colon, you must double it. Since the whole right-hand side string is
28561 expanded before being used, you must also escape dollar signs and backslashes
28562 with more backslashes, or use the &`\N`& facility to disable expansion.
28563 Here is a simple example that contains two regular expressions:
28564 .code
28565 deny message = contains blacklisted regex ($regex_match_string)
28566      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
28567 .endd
28568 The conditions returns true if any one of the regular expressions matches. The
28569 &$regex_match_string$& expansion variable is then set up and contains the
28570 matching regular expression.
28571
28572 &*Warning*&: With large messages, these conditions can be fairly
28573 CPU-intensive.
28574
28575
28576
28577
28578 .section "The demime condition" "SECTdemimecond"
28579 .cindex "content scanning" "MIME checking"
28580 .cindex "MIME content scanning"
28581 The &%demime%& ACL condition provides MIME unpacking, sanity checking and file
28582 extension blocking. It is usable only in the DATA and non-SMTP ACLs. The
28583 &%demime%& condition uses a simpler interface to MIME decoding than the MIME
28584 ACL functionality, but provides no additional facilities. Please note that this
28585 condition is deprecated and kept only for backward compatibility. You must set
28586 the WITH_OLD_DEMIME option in &_Local/Makefile_& at build time to be able to
28587 use the &%demime%& condition.
28588
28589 The &%demime%& condition unpacks MIME containers in the message. It detects
28590 errors in MIME containers and can match file extensions found in the message
28591 against a list. Using this facility produces files containing the unpacked MIME
28592 parts of the message in the temporary scan directory. If you do antivirus
28593 scanning, it is recommended that you use the &%demime%& condition before the
28594 antivirus (&%malware%&) condition.
28595
28596 On the right-hand side of the &%demime%& condition you can pass a
28597 colon-separated list of file extensions that it should match against. For
28598 example:
28599 .code
28600 deny message = Found blacklisted file attachment
28601      demime  = vbs:com:bat:pif:prf:lnk
28602 .endd
28603 If one of the file extensions is found, the condition is true, otherwise it is
28604 false. If there is a temporary error while demimeing (for example, &"disk
28605 full"&), the condition defers, and the message is temporarily rejected (unless
28606 the condition is on a &%warn%& verb).
28607
28608 The right-hand side is expanded before being treated as a list, so you can have
28609 conditions and lookups there. If it expands to an empty string, &"false"&, or
28610 zero (&"0"&), no demimeing is done and the condition is false.
28611
28612 The &%demime%& condition set the following variables:
28613
28614 .vlist
28615 .vitem &$demime_errorlevel$&
28616 .vindex "&$demime_errorlevel$&"
28617 When an error is detected in a MIME container, this variable contains the
28618 severity of the error, as an integer number. The higher the value, the more
28619 severe the error (the current maximum value is 3). If this variable is unset or
28620 zero, no error occurred.
28621
28622 .vitem &$demime_reason$&
28623 .vindex "&$demime_reason$&"
28624 When &$demime_errorlevel$& is greater than zero, this variable contains a
28625 human-readable text string describing the MIME error that occurred.
28626 .endlist
28627
28628 .vlist
28629 .vitem &$found_extension$&
28630 .vindex "&$found_extension$&"
28631 When the &%demime%& condition is true, this variable contains the file
28632 extension it found.
28633 .endlist
28634
28635 Both &$demime_errorlevel$& and &$demime_reason$& are set by the first call of
28636 the &%demime%& condition, and are not changed on subsequent calls.
28637
28638 If you do not want to check for file extensions, but rather use the &%demime%&
28639 condition for unpacking or error checking purposes, pass &"*"& as the
28640 right-hand side value. Here is a more elaborate example of how to use this
28641 facility:
28642 .code
28643 # Reject messages with serious MIME container errors
28644 deny  message = Found MIME error ($demime_reason).
28645       demime = *
28646       condition = ${if >{$demime_errorlevel}{2}{1}{0}}
28647
28648 # Reject known virus spreading file extensions.
28649 # Accepting these is pretty much braindead.
28650 deny  message = contains $found_extension file (blacklisted).
28651       demime  = com:vbs:bat:pif:scr
28652
28653 # Freeze .exe and .doc files. Postmaster can
28654 # examine them and eventually thaw them.
28655 deny  log_message = Another $found_extension file.
28656       demime = exe:doc
28657       control = freeze
28658 .endd
28659 .ecindex IIDcosca
28660
28661
28662
28663
28664 . ////////////////////////////////////////////////////////////////////////////
28665 . ////////////////////////////////////////////////////////////////////////////
28666
28667 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
28668          "Local scan function"
28669 .scindex IIDlosca "&[local_scan()]& function" "description of"
28670 .cindex "customizing" "input scan using C function"
28671 .cindex "policy control" "by local scan function"
28672 In these days of email worms, viruses, and ever-increasing spam, some sites
28673 want to apply a lot of checking to messages before accepting them.
28674
28675 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
28676 passing messages to external virus and spam scanning software. You can also do
28677 a certain amount in Exim itself through string expansions and the &%condition%&
28678 condition in the ACL that runs after the SMTP DATA command or the ACL for
28679 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
28680
28681 To allow for further customization to a site's own requirements, there is the
28682 possibility of linking Exim with a private message scanning function, written
28683 in C. If you want to run code that is written in something other than C, you
28684 can of course use a little C stub to call it.
28685
28686 The local scan function is run once for every incoming message, at the point
28687 when Exim is just about to accept the message.
28688 It can therefore be used to control non-SMTP messages from local processes as
28689 well as messages arriving via SMTP.
28690
28691 Exim applies a timeout to calls of the local scan function, and there is an
28692 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
28693 Zero means &"no timeout"&.
28694 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
28695 before calling the local scan function, so that the most common types of crash
28696 are caught. If the timeout is exceeded or one of those signals is caught, the
28697 incoming message is rejected with a temporary error if it is an SMTP message.
28698 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
28699 code. The incident is logged on the main and reject logs.
28700
28701
28702
28703 .section "Building Exim to use a local scan function" "SECID207"
28704 .cindex "&[local_scan()]& function" "building Exim to use"
28705 To make use of the local scan function feature, you must tell Exim where your
28706 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
28707 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
28708 directory, so you might set
28709 .code
28710 LOCAL_SCAN_SOURCE=Local/local_scan.c
28711 .endd
28712 for example. The function must be called &[local_scan()]&. It is called by
28713 Exim after it has received a message, when the success return code is about to
28714 be sent. This is after all the ACLs have been run. The return code from your
28715 function controls whether the message is actually accepted or not. There is a
28716 commented template function (that just accepts the message) in the file
28717 _src/local_scan.c_.
28718
28719 If you want to make use of Exim's run time configuration file to set options
28720 for your &[local_scan()]& function, you must also set
28721 .code
28722 LOCAL_SCAN_HAS_OPTIONS=yes
28723 .endd
28724 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
28725
28726
28727
28728
28729 .section "API for local_scan()" "SECTapiforloc"
28730 .cindex "&[local_scan()]& function" "API description"
28731 You must include this line near the start of your code:
28732 .code
28733 #include "local_scan.h"
28734 .endd
28735 This header file defines a number of variables and other values, and the
28736 prototype for the function itself. Exim is coded to use unsigned char values
28737 almost exclusively, and one of the things this header defines is a shorthand
28738 for &`unsigned char`& called &`uschar`&.
28739 It also contains the following macro definitions, to simplify casting character
28740 strings and pointers to character strings:
28741 .code
28742 #define CS   (char *)
28743 #define CCS  (const char *)
28744 #define CSS  (char **)
28745 #define US   (unsigned char *)
28746 #define CUS  (const unsigned char *)
28747 #define USS  (unsigned char **)
28748 .endd
28749 The function prototype for &[local_scan()]& is:
28750 .code
28751 extern int local_scan(int fd, uschar **return_text);
28752 .endd
28753 The arguments are as follows:
28754
28755 .ilist
28756 &%fd%& is a file descriptor for the file that contains the body of the message
28757 (the -D file). The file is open for reading and writing, but updating it is not
28758 recommended. &*Warning*&: You must &'not'& close this file descriptor.
28759
28760 The descriptor is positioned at character 19 of the file, which is the first
28761 character of the body itself, because the first 19 characters are the message
28762 id followed by &`-D`& and a newline. If you rewind the file, you should use the
28763 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
28764 case this changes in some future version.
28765 .next
28766 &%return_text%& is an address which you can use to return a pointer to a text
28767 string at the end of the function. The value it points to on entry is NULL.
28768 .endlist
28769
28770 The function must return an &%int%& value which is one of the following macros:
28771
28772 .vlist
28773 .vitem &`LOCAL_SCAN_ACCEPT`&
28774 .vindex "&$local_scan_data$&"
28775 The message is accepted. If you pass back a string of text, it is saved with
28776 the message, and made available in the variable &$local_scan_data$&. No
28777 newlines are permitted (if there are any, they are turned into spaces) and the
28778 maximum length of text is 1000 characters.
28779
28780 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
28781 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
28782 queued without immediate delivery, and is frozen.
28783
28784 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
28785 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
28786 queued without immediate delivery.
28787
28788 .vitem &`LOCAL_SCAN_REJECT`&
28789 The message is rejected; the returned text is used as an error message which is
28790 passed back to the sender and which is also logged. Newlines are permitted &--
28791 they cause a multiline response for SMTP rejections, but are converted to
28792 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
28793 used.
28794
28795 .vitem &`LOCAL_SCAN_TEMPREJECT`&
28796 The message is temporarily rejected; the returned text is used as an error
28797 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
28798 problem"& is used.
28799
28800 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
28801 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
28802 message is not written to the reject log. It has the effect of unsetting the
28803 &%rejected_header%& log selector for just this rejection. If
28804 &%rejected_header%& is already unset (see the discussion of the
28805 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
28806 same as LOCAL_SCAN_REJECT.
28807
28808 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
28809 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
28810 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
28811 .endlist
28812
28813 If the message is not being received by interactive SMTP, rejections are
28814 reported by writing to &%stderr%& or by sending an email, as configured by the
28815 &%-oe%& command line options.
28816
28817
28818
28819 .section "Configuration options for local_scan()" "SECTconoptloc"
28820 .cindex "&[local_scan()]& function" "configuration options"
28821 It is possible to have option settings in the main configuration file
28822 that set values in static variables in the &[local_scan()]& module. If you
28823 want to do this, you must have the line
28824 .code
28825 LOCAL_SCAN_HAS_OPTIONS=yes
28826 .endd
28827 in your &_Local/Makefile_& when you build Exim. (This line is in
28828 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
28829 file, you must define static variables to hold the option values, and a table
28830 to define them.
28831
28832 The table must be a vector called &%local_scan_options%&, of type
28833 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
28834 and a pointer to the variable that holds the value. The entries must appear in
28835 alphabetical order. Following &%local_scan_options%& you must also define a
28836 variable called &%local_scan_options_count%& that contains the number of
28837 entries in the table. Here is a short example, showing two kinds of option:
28838 .code
28839 static int my_integer_option = 42;
28840 static uschar *my_string_option = US"a default string";
28841
28842 optionlist local_scan_options[] = {
28843   { "my_integer", opt_int,       &my_integer_option },
28844   { "my_string",  opt_stringptr, &my_string_option }
28845 };
28846
28847 int local_scan_options_count =
28848   sizeof(local_scan_options)/sizeof(optionlist);
28849 .endd
28850 The values of the variables can now be changed from Exim's runtime
28851 configuration file by including a local scan section as in this example:
28852 .code
28853 begin local_scan
28854 my_integer = 99
28855 my_string = some string of text...
28856 .endd
28857 The available types of option data are as follows:
28858
28859 .vlist
28860 .vitem &*opt_bool*&
28861 This specifies a boolean (true/false) option. The address should point to a
28862 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
28863 that are defined as &"1"& and &"0"&, respectively. If you want to detect
28864 whether such a variable has been set at all, you can initialize it to
28865 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
28866 values.)
28867
28868 .vitem &*opt_fixed*&
28869 This specifies a fixed point number, such as is used for load averages.
28870 The address should point to a variable of type &`int`&. The value is stored
28871 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
28872
28873 .vitem &*opt_int*&
28874 This specifies an integer; the address should point to a variable of type
28875 &`int`&. The value may be specified in any of the integer formats accepted by
28876 Exim.
28877
28878 .vitem &*opt_mkint*&
28879 This is the same as &%opt_int%&, except that when such a value is output in a
28880 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
28881 printed with the suffix K or M.
28882
28883 .vitem &*opt_octint*&
28884 This also specifies an integer, but the value is always interpreted as an
28885 octal integer, whether or not it starts with the digit zero, and it is
28886 always output in octal.
28887
28888 .vitem &*opt_stringptr*&
28889 This specifies a string value; the address must be a pointer to a
28890 variable that points to a string (for example, of type &`uschar *`&).
28891
28892 .vitem &*opt_time*&
28893 This specifies a time interval value. The address must point to a variable of
28894 type &`int`&. The value that is placed there is a number of seconds.
28895 .endlist
28896
28897 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
28898 out the values of all the &[local_scan()]& options.
28899
28900
28901
28902 .section "Available Exim variables" "SECID208"
28903 .cindex "&[local_scan()]& function" "available Exim variables"
28904 The header &_local_scan.h_& gives you access to a number of C variables. These
28905 are the only ones that are guaranteed to be maintained from release to release.
28906 Note, however, that you can obtain the value of any Exim expansion variable,
28907 including &$recipients$&, by calling &'expand_string()'&. The exported
28908 C variables are as follows:
28909
28910 .vlist
28911 .vitem &*int&~body_linecount*&
28912 This variable contains the number of lines in the message's body.
28913
28914 .vitem &*int&~body_zerocount*&
28915 This variable contains the number of binary zero bytes in the message's body.
28916
28917 .vitem &*unsigned&~int&~debug_selector*&
28918 This variable is set to zero when no debugging is taking place. Otherwise, it
28919 is a bitmap of debugging selectors. Two bits are identified for use in
28920 &[local_scan()]&; they are defined as macros:
28921
28922 .ilist
28923 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
28924 testing option that is not privileged &-- any caller may set it. All the
28925 other selector bits can be set only by admin users.
28926
28927 .next
28928 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
28929 by the &`+local_scan`& debug selector. It is not included in the default set
28930 of debugging bits.
28931 .endlist ilist
28932
28933 Thus, to write to the debugging output only when &`+local_scan`& has been
28934 selected, you should use code like this:
28935 .code
28936 if ((debug_selector & D_local_scan) != 0)
28937   debug_printf("xxx", ...);
28938 .endd
28939 .vitem &*uschar&~*expand_string_message*&
28940 After a failing call to &'expand_string()'& (returned value NULL), the
28941 variable &%expand_string_message%& contains the error message, zero-terminated.
28942
28943 .vitem &*header_line&~*header_list*&
28944 A pointer to a chain of header lines. The &%header_line%& structure is
28945 discussed below.
28946
28947 .vitem &*header_line&~*header_last*&
28948 A pointer to the last of the header lines.
28949
28950 .vitem &*uschar&~*headers_charset*&
28951 The value of the &%headers_charset%& configuration option.
28952
28953 .vitem &*BOOL&~host_checking*&
28954 This variable is TRUE during a host checking session that is initiated by the
28955 &%-bh%& command line option.
28956
28957 .vitem &*uschar&~*interface_address*&
28958 The IP address of the interface that received the message, as a string. This
28959 is NULL for locally submitted messages.
28960
28961 .vitem &*int&~interface_port*&
28962 The port on which this message was received. When testing with the &%-bh%&
28963 command line option, the value of this variable is -1 unless a port has been
28964 specified via the &%-oMi%& option.
28965
28966 .vitem &*uschar&~*message_id*&
28967 This variable contains Exim's message id for the incoming message (the value of
28968 &$message_exim_id$&) as a zero-terminated string.
28969
28970 .vitem &*uschar&~*received_protocol*&
28971 The name of the protocol by which the message was received.
28972
28973 .vitem &*int&~recipients_count*&
28974 The number of accepted recipients.
28975
28976 .vitem &*recipient_item&~*recipients_list*&
28977 .cindex "recipient" "adding in local scan"
28978 .cindex "recipient" "removing in local scan"
28979 The list of accepted recipients, held in a vector of length
28980 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
28981 can add additional recipients by calling &'receive_add_recipient()'& (see
28982 below). You can delete recipients by removing them from the vector and
28983 adjusting the value in &%recipients_count%&. In particular, by setting
28984 &%recipients_count%& to zero you remove all recipients. If you then return the
28985 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
28986 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
28987 and then call &'receive_add_recipient()'& as often as needed.
28988
28989 .vitem &*uschar&~*sender_address*&
28990 The envelope sender address. For bounce messages this is the empty string.
28991
28992 .vitem &*uschar&~*sender_host_address*&
28993 The IP address of the sending host, as a string. This is NULL for
28994 locally-submitted messages.
28995
28996 .vitem &*uschar&~*sender_host_authenticated*&
28997 The name of the authentication mechanism that was used, or NULL if the message
28998 was not received over an authenticated SMTP connection.
28999
29000 .vitem &*uschar&~*sender_host_name*&
29001 The name of the sending host, if known.
29002
29003 .vitem &*int&~sender_host_port*&
29004 The port on the sending host.
29005
29006 .vitem &*BOOL&~smtp_input*&
29007 This variable is TRUE for all SMTP input, including BSMTP.
29008
29009 .vitem &*BOOL&~smtp_batched_input*&
29010 This variable is TRUE for BSMTP input.
29011
29012 .vitem &*int&~store_pool*&
29013 The contents of this variable control which pool of memory is used for new
29014 requests. See section &<<SECTmemhanloc>>& for details.
29015 .endlist
29016
29017
29018 .section "Structure of header lines" "SECID209"
29019 The &%header_line%& structure contains the members listed below.
29020 You can add additional header lines by calling the &'header_add()'& function
29021 (see below). You can cause header lines to be ignored (deleted) by setting
29022 their type to *.
29023
29024
29025 .vlist
29026 .vitem &*struct&~header_line&~*next*&
29027 A pointer to the next header line, or NULL for the last line.
29028
29029 .vitem &*int&~type*&
29030 A code identifying certain headers that Exim recognizes. The codes are printing
29031 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
29032 Notice in particular that any header line whose type is * is not transmitted
29033 with the message. This flagging is used for header lines that have been
29034 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
29035 lines.) Effectively, * means &"deleted"&.
29036
29037 .vitem &*int&~slen*&
29038 The number of characters in the header line, including the terminating and any
29039 internal newlines.
29040
29041 .vitem &*uschar&~*text*&
29042 A pointer to the text of the header. It always ends with a newline, followed by
29043 a zero byte. Internal newlines are preserved.
29044 .endlist
29045
29046
29047
29048 .section "Structure of recipient items" "SECID210"
29049 The &%recipient_item%& structure contains these members:
29050
29051 .vlist
29052 .vitem &*uschar&~*address*&
29053 This is a pointer to the recipient address as it was received.
29054
29055 .vitem &*int&~pno*&
29056 This is used in later Exim processing when top level addresses are created by
29057 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
29058 and must always contain -1 at this stage.
29059
29060 .vitem &*uschar&~*errors_to*&
29061 If this value is not NULL, bounce messages caused by failing to deliver to the
29062 recipient are sent to the address it contains. In other words, it overrides the
29063 envelope sender for this one recipient. (Compare the &%errors_to%& generic
29064 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
29065 an unqualified address, Exim qualifies it using the domain from
29066 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
29067 is NULL for all recipients.
29068 .endlist
29069
29070
29071
29072 .section "Available Exim functions" "SECID211"
29073 .cindex "&[local_scan()]& function" "available Exim functions"
29074 The header &_local_scan.h_& gives you access to a number of Exim functions.
29075 These are the only ones that are guaranteed to be maintained from release to
29076 release:
29077
29078 .vlist
29079 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
29080        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
29081
29082 This function creates a child process that runs the command specified by
29083 &%argv%&. The environment for the process is specified by &%envp%&, which can
29084 be NULL if no environment variables are to be passed. A new umask is supplied
29085 for the process in &%newumask%&.
29086
29087 Pipes to the standard input and output of the new process are set up
29088 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
29089 standard error is cloned to the standard output. If there are any file
29090 descriptors &"in the way"& in the new process, they are closed. If the final
29091 argument is TRUE, the new process is made into a process group leader.
29092
29093 The function returns the pid of the new process, or -1 if things go wrong.
29094
29095 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
29096 This function waits for a child process to terminate, or for a timeout (in
29097 seconds) to expire. A timeout value of zero means wait as long as it takes. The
29098 return value is as follows:
29099
29100 .ilist
29101 >= 0
29102
29103 The process terminated by a normal exit and the value is the process
29104 ending status.
29105
29106 .next
29107 < 0 and > &--256
29108
29109 The process was terminated by a signal and the value is the negation of the
29110 signal number.
29111
29112 .next
29113 &--256
29114
29115 The process timed out.
29116 .next
29117 &--257
29118
29119 The was some other error in wait(); &%errno%& is still set.
29120 .endlist
29121
29122 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
29123 This function provide you with a means of submitting a new message to
29124 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
29125 want, but this packages it all up for you.) The function creates a pipe,
29126 forks a subprocess that is running
29127 .code
29128 exim -t -oem -oi -f <>
29129 .endd
29130 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
29131 that is connected to the standard input. The yield of the function is the PID
29132 of the subprocess. You can then write a message to the file descriptor, with
29133 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
29134
29135 When you have finished, call &'child_close()'& to wait for the process to
29136 finish and to collect its ending status. A timeout value of zero is usually
29137 fine in this circumstance. Unless you have made a mistake with the recipient
29138 addresses, you should get a return code of zero.
29139
29140
29141 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
29142        *sender_authentication)*&
29143 This function is a more sophisticated version of &'child_open()'&. The command
29144 that it runs is:
29145 .display
29146 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
29147 .endd
29148 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
29149
29150
29151 .vitem &*void&~debug_printf(char&~*,&~...)*&
29152 This is Exim's debugging function, with arguments as for &'(printf()'&. The
29153 output is written to the standard error stream. If no debugging is selected,
29154 calls to &'debug_printf()'& have no effect. Normally, you should make calls
29155 conditional on the &`local_scan`& debug selector by coding like this:
29156 .code
29157 if ((debug_selector & D_local_scan) != 0)
29158   debug_printf("xxx", ...);
29159 .endd
29160
29161 .vitem &*uschar&~*expand_string(uschar&~*string)*&
29162 This is an interface to Exim's string expansion code. The return value is the
29163 expanded string, or NULL if there was an expansion failure.
29164 The C variable &%expand_string_message%& contains an error message after an
29165 expansion failure. If expansion does not change the string, the return value is
29166 the pointer to the input string. Otherwise, the return value points to a new
29167 block of memory that was obtained by a call to &'store_get()'&. See section
29168 &<<SECTmemhanloc>>& below for a discussion of memory handling.
29169
29170 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
29171 This function allows you to an add additional header line at the end of the
29172 existing ones. The first argument is the type, and should normally be a space
29173 character. The second argument is a format string and any number of
29174 substitution arguments as for &[sprintf()]&. You may include internal newlines
29175 if you want, and you must ensure that the string ends with a newline.
29176
29177 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
29178         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
29179 This function adds a new header line at a specified point in the header
29180 chain. The header itself is specified as for &'header_add()'&.
29181
29182 If &%name%& is NULL, the new header is added at the end of the chain if
29183 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
29184 NULL, the header lines are searched for the first non-deleted header that
29185 matches the name. If one is found, the new header is added before it if
29186 &%after%& is false. If &%after%& is true, the new header is added after the
29187 found header and any adjacent subsequent ones with the same name (even if
29188 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
29189 option controls where the header is added. If it is true, addition is at the
29190 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
29191 headers, or at the top if there are no &'Received:'& headers, you could use
29192 .code
29193 header_add_at_position(TRUE, US"Received", TRUE,
29194   ' ', "X-xxx: ...");
29195 .endd
29196 Normally, there is always at least one non-deleted &'Received:'& header, but
29197 there may not be if &%received_header_text%& expands to an empty string.
29198
29199
29200 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
29201 This function removes header lines. If &%occurrence%& is zero or negative, all
29202 occurrences of the header are removed. If occurrence is greater than zero, that
29203 particular instance of the header is removed. If no header(s) can be found that
29204 match the specification, the function does nothing.
29205
29206
29207 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
29208         int&~length,&~BOOL&~notdel)*&"
29209 This function tests whether the given header has the given name. It is not just
29210 a string comparison, because white space is permitted between the name and the
29211 colon. If the &%notdel%& argument is true, a false return is forced for all
29212 &"deleted"& headers; otherwise they are not treated specially. For example:
29213 .code
29214 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
29215 .endd
29216 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
29217 .cindex "base64 encoding" "functions for &[local_scan()]& use"
29218 This function base64-encodes a string, which is passed by address and length.
29219 The text may contain bytes of any value, including zero. The result is passed
29220 back in dynamic memory that is obtained by calling &'store_get()'&. It is
29221 zero-terminated.
29222
29223 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
29224 This function decodes a base64-encoded string. Its arguments are a
29225 zero-terminated base64-encoded string and the address of a variable that is set
29226 to point to the result, which is in dynamic memory. The length of the decoded
29227 string is the yield of the function. If the input is invalid base64 data, the
29228 yield is -1. A zero byte is added to the end of the output string to make it
29229 easy to interpret as a C string (assuming it contains no zeros of its own). The
29230 added zero byte is not included in the returned count.
29231
29232 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
29233 This function checks for a match in a domain list. Domains are always
29234 matched caselessly. The return value is one of the following:
29235 .display
29236 &`OK     `& match succeeded
29237 &`FAIL   `& match failed
29238 &`DEFER  `& match deferred
29239 .endd
29240 DEFER is usually caused by some kind of lookup defer, such as the
29241 inability to contact a database.
29242
29243 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
29244         BOOL&~caseless)*&"
29245 This function checks for a match in a local part list. The third argument
29246 controls case-sensitivity. The return values are as for
29247 &'lss_match_domain()'&.
29248
29249 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
29250         BOOL&~caseless)*&"
29251 This function checks for a match in an address list. The third argument
29252 controls the case-sensitivity of the local part match. The domain is always
29253 matched caselessly. The return values are as for &'lss_match_domain()'&.
29254
29255 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
29256         uschar&~*list)*&"
29257 This function checks for a match in a host list. The most common usage is
29258 expected to be
29259 .code
29260 lss_match_host(sender_host_name, sender_host_address, ...)
29261 .endd
29262 .vindex "&$sender_host_address$&"
29263 An empty address field matches an empty item in the host list. If the host name
29264 is NULL, the name corresponding to &$sender_host_address$& is automatically
29265 looked up if a host name is required to match an item in the list. The return
29266 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
29267 returns ERROR in the case when it had to look up a host name, but the lookup
29268 failed.
29269
29270 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
29271         *format,&~...)*&"
29272 This function writes to Exim's log files. The first argument should be zero (it
29273 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
29274 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
29275 them. It specifies to which log or logs the message is written. The remaining
29276 arguments are a format and relevant insertion arguments. The string should not
29277 contain any newlines, not even at the end.
29278
29279
29280 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
29281 This function adds an additional recipient to the message. The first argument
29282 is the recipient address. If it is unqualified (has no domain), it is qualified
29283 with the &%qualify_recipient%& domain. The second argument must always be -1.
29284
29285 This function does not allow you to specify a private &%errors_to%& address (as
29286 described with the structure of &%recipient_item%& above), because it pre-dates
29287 the addition of that field to the structure. However, it is easy to add such a
29288 value afterwards. For example:
29289 .code
29290  receive_add_recipient(US"monitor@mydom.example", -1);
29291  recipients_list[recipients_count-1].errors_to =
29292    US"postmaster@mydom.example";
29293 .endd
29294
29295 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
29296 This is a convenience function to remove a named recipient from the list of
29297 recipients. It returns true if a recipient was removed, and false if no
29298 matching recipient could be found. The argument must be a complete email
29299 address.
29300 .endlist
29301
29302
29303 .cindex "RFC 2047"
29304 .vlist
29305 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
29306   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
29307 This function decodes strings that are encoded according to RFC 2047. Typically
29308 these are the contents of header lines. First, each &"encoded word"& is decoded
29309 from the Q or B encoding into a byte-string. Then, if provided with the name of
29310 a charset encoding, and if the &[iconv()]& function is available, an attempt is
29311 made  to translate the result to the named character set. If this fails, the
29312 binary string is returned with an error message.
29313
29314 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
29315 maximum MIME word length is enforced. The third argument is the target
29316 encoding, or NULL if no translation is wanted.
29317
29318 .cindex "binary zero" "in RFC 2047 decoding"
29319 .cindex "RFC 2047" "binary zero in"
29320 If a binary zero is encountered in the decoded string, it is replaced by the
29321 contents of the &%zeroval%& argument. For use with Exim headers, the value must
29322 not be 0 because header lines are handled as zero-terminated strings.
29323
29324 The function returns the result of processing the string, zero-terminated; if
29325 &%lenptr%& is not NULL, the length of the result is set in the variable to
29326 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
29327
29328 If an error is encountered, the function returns NULL and uses the &%error%&
29329 argument to return an error message. The variable pointed to by &%error%& is
29330 set to NULL if there is no error; it may be set non-NULL even when the function
29331 returns a non-NULL value if decoding was successful, but there was a problem
29332 with translation.
29333
29334
29335 .vitem &*int&~smtp_fflush(void)*&
29336 This function is used in conjunction with &'smtp_printf()'&, as described
29337 below.
29338
29339 .vitem &*void&~smtp_printf(char&~*,&~...)*&
29340 The arguments of this function are like &[printf()]&; it writes to the SMTP
29341 output stream. You should use this function only when there is an SMTP output
29342 stream, that is, when the incoming message is being received via interactive
29343 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
29344 is FALSE. If you want to test for an incoming message from another host (as
29345 opposed to a local process that used the &%-bs%& command line option), you can
29346 test the value of &%sender_host_address%&, which is non-NULL when a remote host
29347 is involved.
29348
29349 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
29350 output function, so it can be used for all forms of SMTP connection.
29351
29352 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
29353 must start with an appropriate response code: 550 if you are going to return
29354 LOCAL_SCAN_REJECT, 451 if you are going to return
29355 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
29356 initial lines of a multi-line response, the code must be followed by a hyphen
29357 to indicate that the line is not the final response line. You must also ensure
29358 that the lines you write terminate with CRLF. For example:
29359 .code
29360 smtp_printf("550-this is some extra info\r\n");
29361 return LOCAL_SCAN_REJECT;
29362 .endd
29363 Note that you can also create multi-line responses by including newlines in
29364 the data returned via the &%return_text%& argument. The added value of using
29365 &'smtp_printf()'& is that, for instance, you could introduce delays between
29366 multiple output lines.
29367
29368 The &'smtp_printf()'& function does not return any error indication, because it
29369 does not automatically flush pending output, and therefore does not test
29370 the state of the stream. (In the main code of Exim, flushing and error
29371 detection is done when Exim is ready for the next SMTP input command.) If
29372 you want to flush the output and check for an error (for example, the
29373 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
29374 arguments. It flushes the output stream, and returns a non-zero value if there
29375 is an error.
29376
29377 .vitem &*void&~*store_get(int)*&
29378 This function accesses Exim's internal store (memory) manager. It gets a new
29379 chunk of memory whose size is given by the argument. Exim bombs out if it ever
29380 runs out of memory. See the next section for a discussion of memory handling.
29381
29382 .vitem &*void&~*store_get_perm(int)*&
29383 This function is like &'store_get()'&, but it always gets memory from the
29384 permanent pool. See the next section for a discussion of memory handling.
29385
29386 .vitem &*uschar&~*string_copy(uschar&~*string)*&
29387 See below.
29388
29389 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
29390 See below.
29391
29392 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
29393 These three functions create strings using Exim's dynamic memory facilities.
29394 The first makes a copy of an entire string. The second copies up to a maximum
29395 number of characters, indicated by the second argument. The third uses a format
29396 and insertion arguments to create a new string. In each case, the result is a
29397 pointer to a new string in the current memory pool. See the next section for
29398 more discussion.
29399 .endlist
29400
29401
29402
29403 .section "More about Exim's memory handling" "SECTmemhanloc"
29404 .cindex "&[local_scan()]& function" "memory handling"
29405 No function is provided for freeing memory, because that is never needed.
29406 The dynamic memory that Exim uses when receiving a message is automatically
29407 recycled if another message is received by the same process (this applies only
29408 to incoming SMTP connections &-- other input methods can supply only one
29409 message at a time). After receiving the last message, a reception process
29410 terminates.
29411
29412 Because it is recycled, the normal dynamic memory cannot be used for holding
29413 data that must be preserved over a number of incoming messages on the same SMTP
29414 connection. However, Exim in fact uses two pools of dynamic memory; the second
29415 one is not recycled, and can be used for this purpose.
29416
29417 If you want to allocate memory that remains available for subsequent messages
29418 in the same SMTP connection, you should set
29419 .code
29420 store_pool = POOL_PERM
29421 .endd
29422 before calling the function that does the allocation. There is no need to
29423 restore the value if you do not need to; however, if you do want to revert to
29424 the normal pool, you can either restore the previous value of &%store_pool%& or
29425 set it explicitly to POOL_MAIN.
29426
29427 The pool setting applies to all functions that get dynamic memory, including
29428 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
29429 There is also a convenience function called &'store_get_perm()'& that gets a
29430 block of memory from the permanent pool while preserving the value of
29431 &%store_pool%&.
29432 .ecindex IIDlosca
29433
29434
29435
29436
29437 . ////////////////////////////////////////////////////////////////////////////
29438 . ////////////////////////////////////////////////////////////////////////////
29439
29440 .chapter "System-wide message filtering" "CHAPsystemfilter"
29441 .scindex IIDsysfil1 "filter" "system filter"
29442 .scindex IIDsysfil2 "filtering all mail"
29443 .scindex IIDsysfil3 "system filter"
29444 The previous chapters (on ACLs and the local scan function) describe checks
29445 that can be applied to messages before they are accepted by a host. There is
29446 also a mechanism for checking messages once they have been received, but before
29447 they are delivered. This is called the &'system filter'&.
29448
29449 The system filter operates in a similar manner to users' filter files, but it
29450 is run just once per message (however many recipients the message has).
29451 It should not normally be used as a substitute for routing, because &%deliver%&
29452 commands in a system router provide new envelope recipient addresses.
29453 The system filter must be an Exim filter. It cannot be a Sieve filter.
29454
29455 The system filter is run at the start of a delivery attempt, before any routing
29456 is done. If a message fails to be completely delivered at the first attempt,
29457 the system filter is run again at the start of every retry.
29458 If you want your filter to do something only once per message, you can make use
29459 of the &%first_delivery%& condition in an &%if%& command in the filter to
29460 prevent it happening on retries.
29461
29462 .vindex "&$domain$&"
29463 .vindex "&$local_part$&"
29464 &*Warning*&: Because the system filter runs just once, variables that are
29465 specific to individual recipient addresses, such as &$local_part$& and
29466 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
29467 you want to run a centrally-specified filter for each recipient address
29468 independently, you can do so by setting up a suitable &(redirect)& router, as
29469 described in section &<<SECTperaddfil>>& below.
29470
29471
29472 .section "Specifying a system filter" "SECID212"
29473 .cindex "uid (user id)" "system filter"
29474 .cindex "gid (group id)" "system filter"
29475 The name of the file that contains the system filter must be specified by
29476 setting &%system_filter%&. If you want the filter to run under a uid and gid
29477 other than root, you must also set &%system_filter_user%& and
29478 &%system_filter_group%& as appropriate. For example:
29479 .code
29480 system_filter = /etc/mail/exim.filter
29481 system_filter_user = exim
29482 .endd
29483 If a system filter generates any deliveries directly to files or pipes (via the
29484 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
29485 specified by setting &%system_filter_file_transport%& and
29486 &%system_filter_pipe_transport%&, respectively. Similarly,
29487 &%system_filter_reply_transport%& must be set to handle any messages generated
29488 by the &%reply%& command.
29489
29490
29491 .section "Testing a system filter" "SECID213"
29492 You can run simple tests of a system filter in the same way as for a user
29493 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
29494 are permitted only in system filters are recognized.
29495
29496 If you want to test the combined effect of a system filter and a user filter,
29497 you can use both &%-bF%& and &%-bf%& on the same command line.
29498
29499
29500
29501 .section "Contents of a system filter" "SECID214"
29502 The language used to specify system filters is the same as for users' filter
29503 files. It is described in the separate end-user document &'Exim's interface to
29504 mail filtering'&. However, there are some additional features that are
29505 available only in system filters; these are described in subsequent sections.
29506 If they are encountered in a user's filter file or when testing with &%-bf%&,
29507 they cause errors.
29508
29509 .cindex "frozen messages" "manual thaw; testing in filter"
29510 There are two special conditions which, though available in users' filter
29511 files, are designed for use in system filters. The condition &%first_delivery%&
29512 is true only for the first attempt at delivering a message, and
29513 &%manually_thawed%& is true only if the message has been frozen, and
29514 subsequently thawed by an admin user. An explicit forced delivery counts as a
29515 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
29516
29517 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
29518 specify an &"unseen"& (non-significant) delivery, and that delivery does not
29519 succeed, it will not be tried again.
29520 If you want Exim to retry an unseen delivery until it succeeds, you should
29521 arrange to set it up every time the filter runs.
29522
29523 When a system filter finishes running, the values of the variables &$n0$& &--
29524 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
29525 users' filter files. Thus a system filter can, for example, set up &"scores"&
29526 to which users' filter files can refer.
29527
29528
29529
29530 .section "Additional variable for system filters" "SECID215"
29531 .vindex "&$recipients$&"
29532 The expansion variable &$recipients$&, containing a list of all the recipients
29533 of the message (separated by commas and white space), is available in system
29534 filters. It is not available in users' filters for privacy reasons.
29535
29536
29537
29538 .section "Defer, freeze, and fail commands for system filters" "SECID216"
29539 .cindex "freezing messages"
29540 .cindex "message" "freezing"
29541 .cindex "message" "forced failure"
29542 .cindex "&%fail%&" "in system filter"
29543 .cindex "&%freeze%& in system filter"
29544 .cindex "&%defer%& in system filter"
29545 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
29546 always available in system filters, but are not normally enabled in users'
29547 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
29548 for the &(redirect)& router.) These commands can optionally be followed by the
29549 word &%text%& and a string containing an error message, for example:
29550 .code
29551 fail text "this message looks like spam to me"
29552 .endd
29553 The keyword &%text%& is optional if the next character is a double quote.
29554
29555 The &%defer%& command defers delivery of the original recipients of the
29556 message. The &%fail%& command causes all the original recipients to be failed,
29557 and a bounce message to be created. The &%freeze%& command suspends all
29558 delivery attempts for the original recipients. In all cases, any new deliveries
29559 that are specified by the filter are attempted as normal after the filter has
29560 run.
29561
29562 The &%freeze%& command is ignored if the message has been manually unfrozen and
29563 not manually frozen since. This means that automatic freezing by a system
29564 filter can be used as a way of checking out suspicious messages. If a message
29565 is found to be all right, manually unfreezing it allows it to be delivered.
29566
29567 .cindex "log" "&%fail%& command log line"
29568 .cindex "&%fail%&" "log line; reducing"
29569 The text given with a fail command is used as part of the bounce message as
29570 well as being written to the log. If the message is quite long, this can fill
29571 up a lot of log space when such failures are common. To reduce the size of the
29572 log message, Exim interprets the text in a special way if it starts with the
29573 two characters &`<<`& and contains &`>>`& later. The text between these two
29574 strings is written to the log, and the rest of the text is used in the bounce
29575 message. For example:
29576 .code
29577 fail "<<filter test 1>>Your message is rejected \
29578      because it contains attachments that we are \
29579      not prepared to receive."
29580 .endd
29581
29582 .cindex "loop" "caused by &%fail%&"
29583 Take great care with the &%fail%& command when basing the decision to fail on
29584 the contents of the message, because the bounce message will of course include
29585 the contents of the original message and will therefore trigger the &%fail%&
29586 command again (causing a mail loop) unless steps are taken to prevent this.
29587 Testing the &%error_message%& condition is one way to prevent this. You could
29588 use, for example
29589 .code
29590 if $message_body contains "this is spam" and not error_message
29591 then fail text "spam is not wanted here" endif
29592 .endd
29593 though of course that might let through unwanted bounce messages. The
29594 alternative is clever checking of the body and/or headers to detect bounces
29595 generated by the filter.
29596
29597 The interpretation of a system filter file ceases after a
29598 &%defer%&,
29599 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
29600 set up earlier in the filter file are honoured, so you can use a sequence such
29601 as
29602 .code
29603 mail ...
29604 freeze
29605 .endd
29606 to send a specified message when the system filter is freezing (or deferring or
29607 failing) a message. The normal deliveries for the message do not, of course,
29608 take place.
29609
29610
29611
29612 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
29613 .cindex "header lines" "adding; in system filter"
29614 .cindex "header lines" "removing; in system filter"
29615 .cindex "filter" "header lines; adding/removing"
29616 Two filter commands that are available only in system filters are:
29617 .code
29618 headers add <string>
29619 headers remove <string>
29620 .endd
29621 The argument for the &%headers add%& is a string that is expanded and then
29622 added to the end of the message's headers. It is the responsibility of the
29623 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
29624 space is ignored, and if the string is otherwise empty, or if the expansion is
29625 forced to fail, the command has no effect.
29626
29627 You can use &"\n"& within the string, followed by white space, to specify
29628 continued header lines. More than one header may be added in one command by
29629 including &"\n"& within the string without any following white space. For
29630 example:
29631 .code
29632 headers add "X-header-1: ....\n  \
29633              continuation of X-header-1 ...\n\
29634              X-header-2: ...."
29635 .endd
29636 Note that the header line continuation white space after the first newline must
29637 be placed before the backslash that continues the input string, because white
29638 space after input continuations is ignored.
29639
29640 The argument for &%headers remove%& is a colon-separated list of header names.
29641 This command applies only to those headers that are stored with the message;
29642 those that are added at delivery time (such as &'Envelope-To:'& and
29643 &'Return-Path:'&) cannot be removed by this means. If there is more than one
29644 header with the same name, they are all removed.
29645
29646 The &%headers%& command in a system filter makes an immediate change to the set
29647 of header lines that was received with the message (with possible additions
29648 from ACL processing). Subsequent commands in the system filter operate on the
29649 modified set, which also forms the basis for subsequent message delivery.
29650 Unless further modified during routing or transporting, this set of headers is
29651 used for all recipients of the message.
29652
29653 During routing and transporting, the variables that refer to the contents of
29654 header lines refer only to those lines that are in this set. Thus, header lines
29655 that are added by a system filter are visible to users' filter files and to all
29656 routers and transports. This contrasts with the manipulation of header lines by
29657 routers and transports, which is not immediate, but which instead is saved up
29658 until the message is actually being written (see section
29659 &<<SECTheadersaddrem>>&).
29660
29661 If the message is not delivered at the first attempt, header lines that were
29662 added by the system filter are stored with the message, and so are still
29663 present at the next delivery attempt. Header lines that were removed are still
29664 present, but marked &"deleted"& so that they are not transported with the
29665 message. For this reason, it is usual to make the &%headers%& command
29666 conditional on &%first_delivery%& so that the set of header lines is not
29667 modified more than once.
29668
29669 Because header modification in a system filter acts immediately, you have to
29670 use an indirect approach if you want to modify the contents of a header line.
29671 For example:
29672 .code
29673 headers add "Old-Subject: $h_subject:"
29674 headers remove "Subject"
29675 headers add "Subject: new subject (was: $h_old-subject:)"
29676 headers remove "Old-Subject"
29677 .endd
29678
29679
29680
29681 .section "Setting an errors address in a system filter" "SECID217"
29682 .cindex "envelope sender"
29683 In a system filter, if a &%deliver%& command is followed by
29684 .code
29685 errors_to <some address>
29686 .endd
29687 in order to change the envelope sender (and hence the error reporting) for that
29688 delivery, any address may be specified. (In a user filter, only the current
29689 user's address can be set.) For example, if some mail is being monitored, you
29690 might use
29691 .code
29692 unseen deliver monitor@spying.example errors_to root@local.example
29693 .endd
29694 to take a copy which would not be sent back to the normal error reporting
29695 address if its delivery failed.
29696
29697
29698
29699 .section "Per-address filtering" "SECTperaddfil"
29700 .vindex "&$domain$&"
29701 .vindex "&$local_part$&"
29702 In contrast to the system filter, which is run just once per message for each
29703 delivery attempt, it is also possible to set up a system-wide filtering
29704 operation that runs once for each recipient address. In this case, variables
29705 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
29706 filter file could be made dependent on them. This is an example of a router
29707 which implements such a filter:
29708 .code
29709 central_filter:
29710   check_local_user
29711   driver = redirect
29712   domains = +local_domains
29713   file = /central/filters/$local_part
29714   no_verify
29715   allow_filter
29716   allow_freeze
29717 .endd
29718 The filter is run in a separate process under its own uid. Therefore, either
29719 &%check_local_user%& must be set (as above), in which case the filter is run as
29720 the local user, or the &%user%& option must be used to specify which user to
29721 use. If both are set, &%user%& overrides.
29722
29723 Care should be taken to ensure that none of the commands in the filter file
29724 specify a significant delivery if the message is to go on to be delivered to
29725 its intended recipient. The router will not then claim to have dealt with the
29726 address, so it will be passed on to subsequent routers to be delivered in the
29727 normal way.
29728 .ecindex IIDsysfil1
29729 .ecindex IIDsysfil2
29730 .ecindex IIDsysfil3
29731
29732
29733
29734
29735
29736
29737 . ////////////////////////////////////////////////////////////////////////////
29738 . ////////////////////////////////////////////////////////////////////////////
29739
29740 .chapter "Message processing" "CHAPmsgproc"
29741 .scindex IIDmesproc "message" "general processing"
29742 Exim performs various transformations on the sender and recipient addresses of
29743 all messages that it handles, and also on the messages' header lines. Some of
29744 these are optional and configurable, while others always take place. All of
29745 this processing, except rewriting as a result of routing, and the addition or
29746 removal of header lines while delivering, happens when a message is received,
29747 before it is placed on Exim's queue.
29748
29749 Some of the automatic processing takes place by default only for
29750 &"locally-originated"& messages. This adjective is used to describe messages
29751 that are not received over TCP/IP, but instead are passed to an Exim process on
29752 its standard input. This includes the interactive &"local SMTP"& case that is
29753 set up by the &%-bs%& command line option.
29754
29755 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
29756 or ::1) are not considered to be locally-originated. Exim does not treat the
29757 loopback interface specially in any way.
29758
29759 If you want the loopback interface to be treated specially, you must ensure
29760 that there are appropriate entries in your ACLs.
29761
29762
29763
29764
29765 .section "Submission mode for non-local messages" "SECTsubmodnon"
29766 .cindex "message" "submission"
29767 .cindex "submission mode"
29768 Processing that happens automatically for locally-originated messages (unless
29769 &%suppress_local_fixups%& is set) can also be requested for messages that are
29770 received over TCP/IP. The term &"submission mode"& is used to describe this
29771 state. Submission mode is set by the modifier
29772 .code
29773 control = submission
29774 .endd
29775 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
29776 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
29777 a local submission, and is normally used when the source of the message is
29778 known to be an MUA running on a client host (as opposed to an MTA). For
29779 example, to set submission mode for messages originating on the IPv4 loopback
29780 interface, you could include the following in the MAIL ACL:
29781 .code
29782 warn  hosts = 127.0.0.1
29783       control = submission
29784 .endd
29785 .cindex "&%sender_retain%& submission option"
29786 There are some options that can be used when setting submission mode. A slash
29787 is used to separate options. For example:
29788 .code
29789 control = submission/sender_retain
29790 .endd
29791 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
29792 true and &%local_from_check%& false for the current incoming message. The first
29793 of these allows an existing &'Sender:'& header in the message to remain, and
29794 the second suppresses the check to ensure that &'From:'& matches the
29795 authenticated sender. With this setting, Exim still fixes up messages by adding
29796 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
29797 attempt to check sender authenticity in header lines.
29798
29799 When &%sender_retain%& is not set, a submission mode setting may specify a
29800 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
29801 example:
29802 .code
29803 control = submission/domain=some.domain
29804 .endd
29805 The domain may be empty. How this value is used is described in sections
29806 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
29807 that allows you to specify the user's full name for inclusion in a created
29808 &'Sender:'& or &'From:'& header line. For example:
29809 .code
29810 accept authenticated = *
29811        control = submission/domain=wonderland.example/\
29812                             name=${lookup {$authenticated_id} \
29813                                    lsearch {/etc/exim/namelist}}
29814 .endd
29815 Because the name may contain any characters, including slashes, the &%name%&
29816 option must be given last. The remainder of the string is used as the name. For
29817 the example above, if &_/etc/exim/namelist_& contains:
29818 .code
29819 bigegg:  Humpty Dumpty
29820 .endd
29821 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
29822 line would be:
29823 .code
29824 Sender: Humpty Dumpty <bigegg@wonderland.example>
29825 .endd
29826 .cindex "return path" "in submission mode"
29827 By default, submission mode forces the return path to the same address as is
29828 used to create the &'Sender:'& header. However, if &%sender_retain%& is
29829 specified, the return path is also left unchanged.
29830
29831 &*Note*&: The changes caused by submission mode take effect after the predata
29832 ACL. This means that any sender checks performed before the fix-ups use the
29833 untrusted sender address specified by the user, not the trusted sender address
29834 specified by submission mode. Although this might be slightly unexpected, it
29835 does mean that you can configure ACL checks to spot that a user is trying to
29836 spoof another's address.
29837
29838 .section "Line endings" "SECTlineendings"
29839 .cindex "line endings"
29840 .cindex "carriage return"
29841 .cindex "linefeed"
29842 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
29843 linefeed) is the line ending for messages transmitted over the Internet using
29844 SMTP over TCP/IP. However, within individual operating systems, different
29845 conventions are used. For example, Unix-like systems use just LF, but others
29846 use CRLF or just CR.
29847
29848 Exim was designed for Unix-like systems, and internally, it stores messages
29849 using the system's convention of a single LF as a line terminator. When
29850 receiving a message, all line endings are translated to this standard format.
29851 Originally, it was thought that programs that passed messages directly to an
29852 MTA within an operating system would use that system's convention. Experience
29853 has shown that this is not the case; for example, there are Unix applications
29854 that use CRLF in this circumstance. For this reason, and for compatibility with
29855 other MTAs, the way Exim handles line endings for all messages is now as
29856 follows:
29857
29858 .ilist
29859 LF not preceded by CR is treated as a line ending.
29860 .next
29861 CR is treated as a line ending; if it is immediately followed by LF, the LF
29862 is ignored.
29863 .next
29864 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
29865 nor a local message in the state where a line containing only a dot is a
29866 terminator.
29867 .next
29868 If a bare CR is encountered within a header line, an extra space is added after
29869 the line terminator so as not to end the header line. The reasoning behind this
29870 is that bare CRs in header lines are most likely either to be mistakes, or
29871 people trying to play silly games.
29872 .next
29873 If the first header line received in a message ends with CRLF, a subsequent
29874 bare LF in a header line is treated in the same way as a bare CR in a header
29875 line.
29876 .endlist
29877
29878
29879
29880
29881
29882 .section "Unqualified addresses" "SECID218"
29883 .cindex "unqualified addresses"
29884 .cindex "address" "qualification"
29885 By default, Exim expects every envelope address it receives from an external
29886 host to be fully qualified. Unqualified addresses cause negative responses to
29887 SMTP commands. However, because SMTP is used as a means of transporting
29888 messages from MUAs running on personal workstations, there is sometimes a
29889 requirement to accept unqualified addresses from specific hosts or IP networks.
29890
29891 Exim has two options that separately control which hosts may send unqualified
29892 sender or recipient addresses in SMTP commands, namely
29893 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
29894 cases, if an unqualified address is accepted, it is qualified by adding the
29895 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
29896
29897 .oindex "&%qualify_domain%&"
29898 .oindex "&%qualify_recipient%&"
29899 Unqualified addresses in header lines are automatically qualified for messages
29900 that are locally originated, unless the &%-bnq%& option is given on the command
29901 line. For messages received over SMTP, unqualified addresses in header lines
29902 are qualified only if unqualified addresses are permitted in SMTP commands. In
29903 other words, such qualification is also controlled by
29904 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
29905
29906
29907
29908
29909 .section "The UUCP From line" "SECID219"
29910 .cindex "&""From""& line"
29911 .cindex "UUCP" "&""From""& line"
29912 .cindex "sender" "address"
29913 .oindex "&%uucp_from_pattern%&"
29914 .oindex "&%uucp_from_sender%&"
29915 .cindex "envelope sender"
29916 .cindex "Sendmail compatibility" "&""From""& line"
29917 Messages that have come from UUCP (and some other applications) often begin
29918 with a line containing the envelope sender and a timestamp, following the word
29919 &"From"&. Examples of two common formats are:
29920 .code
29921 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
29922 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
29923 .endd
29924 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
29925 Exim recognizes such lines at the start of messages that are submitted to it
29926 via the command line (that is, on the standard input). It does not recognize
29927 such lines in incoming SMTP messages, unless the sending host matches
29928 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
29929 and &%ignore_fromline_local%& is set. The recognition is controlled by a
29930 regular expression that is defined by the &%uucp_from_pattern%& option, whose
29931 default value matches the two common cases shown above and puts the address
29932 that follows &"From"& into &$1$&.
29933
29934 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
29935 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
29936 a trusted user, the message's sender address is constructed by expanding the
29937 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
29938 then parsed as an RFC 2822 address. If there is no domain, the local part is
29939 qualified with &%qualify_domain%& unless it is the empty string. However, if
29940 the command line &%-f%& option is used, it overrides the &"From"& line.
29941
29942 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
29943 sender address is not changed. This is also the case for incoming SMTP messages
29944 that are permitted to contain &"From"& lines.
29945
29946 Only one &"From"& line is recognized. If there is more than one, the second is
29947 treated as a data line that starts the body of the message, as it is not valid
29948 as a header line. This also happens if a &"From"& line is present in an
29949 incoming SMTP message from a source that is not permitted to send them.
29950
29951
29952
29953 .section "Resent- header lines" "SECID220"
29954 .cindex "&%Resent-%& header lines"
29955 RFC 2822 makes provision for sets of header lines starting with the string
29956 &`Resent-`& to be added to a message when it is resent by the original
29957 recipient to somebody else. These headers are &'Resent-Date:'&,
29958 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
29959 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
29960
29961 .blockquote
29962 &'Resent fields are strictly informational. They MUST NOT be used in the normal
29963 processing of replies or other such automatic actions on messages.'&
29964 .endblockquote
29965
29966 This leaves things a bit vague as far as other processing actions such as
29967 address rewriting are concerned. Exim treats &%Resent-%& header lines as
29968 follows:
29969
29970 .ilist
29971 A &'Resent-From:'& line that just contains the login id of the submitting user
29972 is automatically rewritten in the same way as &'From:'& (see below).
29973 .next
29974 If there's a rewriting rule for a particular header line, it is also applied to
29975 &%Resent-%& header lines of the same type. For example, a rule that rewrites
29976 &'From:'& also rewrites &'Resent-From:'&.
29977 .next
29978 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
29979 also removed.
29980 .next
29981 For a locally-submitted message,
29982 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
29983 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
29984 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
29985 included in log lines in this case.
29986 .next
29987 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
29988 &%Resent-%& header lines are present.
29989 .endlist
29990
29991
29992
29993
29994 .section "The Auto-Submitted: header line" "SECID221"
29995 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
29996 includes the header line:
29997 .code
29998 Auto-Submitted: auto-replied
29999 .endd
30000
30001 .section "The Bcc: header line" "SECID222"
30002 .cindex "&'Bcc:'& header line"
30003 If Exim is called with the &%-t%& option, to take recipient addresses from a
30004 message's header, it removes any &'Bcc:'& header line that may exist (after
30005 extracting its addresses). If &%-t%& is not present on the command line, any
30006 existing &'Bcc:'& is not removed.
30007
30008
30009 .section "The Date: header line" "SECID223"
30010 .cindex "&'Date:'& header line"
30011 If a locally-generated or submission-mode message has no &'Date:'& header line,
30012 Exim adds one, using the current date and time, unless the
30013 &%suppress_local_fixups%& control has been specified.
30014
30015 .section "The Delivery-date: header line" "SECID224"
30016 .cindex "&'Delivery-date:'& header line"
30017 .oindex "&%delivery_date_remove%&"
30018 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
30019 set. Exim can be configured to add them to the final delivery of messages. (See
30020 the generic &%delivery_date_add%& transport option.) They should not be present
30021 in messages in transit. If the &%delivery_date_remove%& configuration option is
30022 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
30023 messages.
30024
30025
30026 .section "The Envelope-to: header line" "SECID225"
30027 .cindex "&'Envelope-to:'& header line"
30028 .oindex "&%envelope_to_remove%&"
30029 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
30030 Exim can be configured to add them to the final delivery of messages. (See the
30031 generic &%envelope_to_add%& transport option.) They should not be present in
30032 messages in transit. If the &%envelope_to_remove%& configuration option is set
30033 (the default), Exim removes &'Envelope-to:'& header lines from incoming
30034 messages.
30035
30036
30037 .section "The From: header line" "SECTthefrohea"
30038 .cindex "&'From:'& header line"
30039 .cindex "Sendmail compatibility" "&""From""& line"
30040 .cindex "message" "submission"
30041 .cindex "submission mode"
30042 If a submission-mode message does not contain a &'From:'& header line, Exim
30043 adds one if either of the following conditions is true:
30044
30045 .ilist
30046 The envelope sender address is not empty (that is, this is not a bounce
30047 message). The added header line copies the envelope sender address.
30048 .next
30049 .vindex "&$authenticated_id$&"
30050 The SMTP session is authenticated and &$authenticated_id$& is not empty.
30051 .olist
30052 .vindex "&$qualify_domain$&"
30053 If no domain is specified by the submission control, the local part is
30054 &$authenticated_id$& and the domain is &$qualify_domain$&.
30055 .next
30056 If a non-empty domain is specified by the submission control, the local
30057 part is &$authenticated_id$&, and the domain is the specified domain.
30058 .next
30059 If an empty domain is specified by the submission control,
30060 &$authenticated_id$& is assumed to be the complete address.
30061 .endlist
30062 .endlist
30063
30064 A non-empty envelope sender takes precedence.
30065
30066 If a locally-generated incoming message does not contain a &'From:'& header
30067 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
30068 containing the sender's address. The calling user's login name and full name
30069 are used to construct the address, as described in section &<<SECTconstr>>&.
30070 They are obtained from the password data by calling &[getpwuid()]& (but see the
30071 &%unknown_login%& configuration option). The address is qualified with
30072 &%qualify_domain%&.
30073
30074 For compatibility with Sendmail, if an incoming, non-SMTP message has a
30075 &'From:'& header line containing just the unqualified login name of the calling
30076 user, this is replaced by an address containing the user's login name and full
30077 name as described in section &<<SECTconstr>>&.
30078
30079
30080 .section "The Message-ID: header line" "SECID226"
30081 .cindex "&'Message-ID:'& header line"
30082 .cindex "message" "submission"
30083 .oindex "&%message_id_header_text%&"
30084 If a locally-generated or submission-mode incoming message does not contain a
30085 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
30086 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
30087 to the message. If there are any &'Resent-:'& headers in the message, it
30088 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
30089 message id, preceded by the letter E to ensure it starts with a letter, and
30090 followed by @ and the primary host name. Additional information can be included
30091 in this header line by setting the &%message_id_header_text%& and/or
30092 &%message_id_header_domain%& options.
30093
30094
30095 .section "The Received: header line" "SECID227"
30096 .cindex "&'Received:'& header line"
30097 A &'Received:'& header line is added at the start of every message. The
30098 contents are defined by the &%received_header_text%& configuration option, and
30099 Exim automatically adds a semicolon and a timestamp to the configured string.
30100
30101 The &'Received:'& header is generated as soon as the message's header lines
30102 have been received. At this stage, the timestamp in the &'Received:'& header
30103 line is the time that the message started to be received. This is the value
30104 that is seen by the DATA ACL and by the &[local_scan()]& function.
30105
30106 Once a message is accepted, the timestamp in the &'Received:'& header line is
30107 changed to the time of acceptance, which is (apart from a small delay while the
30108 -H spool file is written) the earliest time at which delivery could start.
30109
30110
30111 .section "The References: header line" "SECID228"
30112 .cindex "&'References:'& header line"
30113 Messages created by the &(autoreply)& transport include a &'References:'&
30114 header line. This is constructed according to the rules that are described in
30115 section 3.64 of RFC 2822 (which states that replies should contain such a
30116 header line), and section 3.14 of RFC 3834 (which states that automatic
30117 responses are not different in this respect). However, because some mail
30118 processing software does not cope well with very long header lines, no more
30119 than 12 message IDs are copied from the &'References:'& header line in the
30120 incoming message. If there are more than 12, the first one and then the final
30121 11 are copied, before adding the message ID of the incoming message.
30122
30123
30124
30125 .section "The Return-path: header line" "SECID229"
30126 .cindex "&'Return-path:'& header line"
30127 .oindex "&%return_path_remove%&"
30128 &'Return-path:'& header lines are defined as something an MTA may insert when
30129 it does the final delivery of messages. (See the generic &%return_path_add%&
30130 transport option.) Therefore, they should not be present in messages in
30131 transit. If the &%return_path_remove%& configuration option is set (the
30132 default), Exim removes &'Return-path:'& header lines from incoming messages.
30133
30134
30135
30136 .section "The Sender: header line" "SECTthesenhea"
30137 .cindex "&'Sender:'& header line"
30138 .cindex "message" "submission"
30139 For a locally-originated message from an untrusted user, Exim may remove an
30140 existing &'Sender:'& header line, and it may add a new one. You can modify
30141 these actions by setting the &%local_sender_retain%& option true, the
30142 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
30143 control setting.
30144
30145 When a local message is received from an untrusted user and
30146 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
30147 control has not been set, a check is made to see if the address given in the
30148 &'From:'& header line is the correct (local) sender of the message. The address
30149 that is expected has the login name as the local part and the value of
30150 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
30151 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
30152 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
30153 line is added to the message.
30154
30155 If you set &%local_from_check%& false, this checking does not occur. However,
30156 the removal of an existing &'Sender:'& line still happens, unless you also set
30157 &%local_sender_retain%& to be true. It is not possible to set both of these
30158 options true at the same time.
30159
30160 .cindex "submission mode"
30161 By default, no processing of &'Sender:'& header lines is done for messages
30162 received over TCP/IP or for messages submitted by trusted users. However, when
30163 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
30164 not specified on the submission control, the following processing takes place:
30165
30166 .vindex "&$authenticated_id$&"
30167 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
30168 authenticated, and &$authenticated_id$& is not empty, a sender address is
30169 created as follows:
30170
30171 .ilist
30172 .vindex "&$qualify_domain$&"
30173 If no domain is specified by the submission control, the local part is
30174 &$authenticated_id$& and the domain is &$qualify_domain$&.
30175 .next
30176 If a non-empty domain is specified by the submission control, the local part
30177 is &$authenticated_id$&, and the domain is the specified domain.
30178 .next
30179 If an empty domain is specified by the submission control,
30180 &$authenticated_id$& is assumed to be the complete address.
30181 .endlist
30182
30183 This address is compared with the address in the &'From:'& header line. If they
30184 are different, a &'Sender:'& header line containing the created address is
30185 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
30186 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
30187
30188 .cindex "return path" "created from &'Sender:'&"
30189 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
30190 the message (the envelope sender address) is changed to be the same address,
30191 except in the case of submission mode when &%sender_retain%& is specified.
30192
30193
30194
30195 .section "Adding and removing header lines in routers and transports" &&&
30196          "SECTheadersaddrem"
30197 .cindex "header lines" "adding; in router or transport"
30198 .cindex "header lines" "removing; in router or transport"
30199 When a message is delivered, the addition and removal of header lines can be
30200 specified in a system filter, or on any of the routers and transports that
30201 process the message. Section &<<SECTaddremheasys>>& contains details about
30202 modifying headers in a system filter. Header lines can also be added in an ACL
30203 as a message is received (see section &<<SECTaddheadacl>>&).
30204
30205 In contrast to what happens in a system filter, header modifications that are
30206 specified on routers and transports apply only to the particular recipient
30207 addresses that are being processed by those routers and transports. These
30208 changes do not actually take place until a copy of the message is being
30209 transported. Therefore, they do not affect the basic set of header lines, and
30210 they do not affect the values of the variables that refer to header lines.
30211
30212 &*Note*&: In particular, this means that any expansions in the configuration of
30213 the transport cannot refer to the modified header lines, because such
30214 expansions all occur before the message is actually transported.
30215
30216 For both routers and transports, the result of expanding a &%headers_add%&
30217 option must be in the form of one or more RFC 2822 header lines, separated by
30218 newlines (coded as &"\n"&). For example:
30219 .code
30220 headers_add = X-added-header: added by $primary_hostname\n\
30221               X-added-second: another added header line
30222 .endd
30223 Exim does not check the syntax of these added header lines.
30224
30225 The result of expanding &%headers_remove%& must consist of a colon-separated
30226 list of header names. This is confusing, because header names themselves are
30227 often terminated by colons. In this case, the colons are the list separators,
30228 not part of the names. For example:
30229 .code
30230 headers_remove = return-receipt-to:acknowledge-to
30231 .endd
30232 When &%headers_add%& or &%headers_remove%& is specified on a router, its value
30233 is expanded at routing time, and then associated with all addresses that are
30234 accepted by that router, and also with any new addresses that it generates. If
30235 an address passes through several routers as a result of aliasing or
30236 forwarding, the changes are cumulative.
30237
30238 .oindex "&%unseen%&"
30239 However, this does not apply to multiple routers that result from the use of
30240 the &%unseen%& option. Any header modifications that were specified by the
30241 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
30242
30243 Addresses that end up with different &%headers_add%& or &%headers_remove%&
30244 settings cannot be delivered together in a batch, so a transport is always
30245 dealing with a set of addresses that have the same header-processing
30246 requirements.
30247
30248 The transport starts by writing the original set of header lines that arrived
30249 with the message, possibly modified by the system filter. As it writes out
30250 these lines, it consults the list of header names that were attached to the
30251 recipient address(es) by &%headers_remove%& options in routers, and it also
30252 consults the transport's own &%headers_remove%& option. Header lines whose
30253 names are on either of these lists are not written out. If there are multiple
30254 instances of any listed header, they are all skipped.
30255
30256 After the remaining original header lines have been written, new header
30257 lines that were specified by routers' &%headers_add%& options are written, in
30258 the order in which they were attached to the address. These are followed by any
30259 header lines specified by the transport's &%headers_add%& option.
30260
30261 This way of handling header line modifications in routers and transports has
30262 the following consequences:
30263
30264 .ilist
30265 The original set of header lines, possibly modified by the system filter,
30266 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
30267 to it, at all times.
30268 .next
30269 Header lines that are added by a router's
30270 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
30271 expansion syntax in subsequent routers or the transport.
30272 .next
30273 Conversely, header lines that are specified for removal by &%headers_remove%&
30274 in a router remain visible to subsequent routers and the transport.
30275 .next
30276 Headers added to an address by &%headers_add%& in a router cannot be removed by
30277 a later router or by a transport.
30278 .next
30279 An added header can refer to the contents of an original header that is to be
30280 removed, even it has the same name as the added header. For example:
30281 .code
30282 headers_remove = subject
30283 headers_add = Subject: new subject (was: $h_subject:)
30284 .endd
30285 .endlist
30286
30287 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
30288 for a &(redirect)& router that has the &%one_time%& option set.
30289
30290
30291
30292
30293
30294 .section "Constructed addresses" "SECTconstr"
30295 .cindex "address" "constructed"
30296 .cindex "constructed address"
30297 When Exim constructs a sender address for a locally-generated message, it uses
30298 the form
30299 .display
30300 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
30301 .endd
30302 For example:
30303 .code
30304 Zaphod Beeblebrox <zaphod@end.univ.example>
30305 .endd
30306 The user name is obtained from the &%-F%& command line option if set, or
30307 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
30308 &"gecos"& field from the password entry. If the &"gecos"& field contains an
30309 ampersand character, this is replaced by the login name with the first letter
30310 upper cased, as is conventional in a number of operating systems. See the
30311 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
30312 The &%unknown_username%& option can be used to specify user names in cases when
30313 there is no password file entry.
30314
30315 .cindex "RFC 2047"
30316 In all cases, the user name is made to conform to RFC 2822 by quoting all or
30317 parts of it if necessary. In addition, if it contains any non-printing
30318 characters, it is encoded as described in RFC 2047, which defines a way of
30319 including non-ASCII characters in header lines. The value of the
30320 &%headers_charset%& option specifies the name of the encoding that is used (the
30321 characters are assumed to be in this encoding). The setting of
30322 &%print_topbitchars%& controls whether characters with the top bit set (that
30323 is, with codes greater than 127) count as printing characters or not.
30324
30325
30326
30327 .section "Case of local parts" "SECID230"
30328 .cindex "case of local parts"
30329 .cindex "local part" "case of"
30330 RFC 2822 states that the case of letters in the local parts of addresses cannot
30331 be assumed to be non-significant. Exim preserves the case of local parts of
30332 addresses, but by default it uses a lower-cased form when it is routing,
30333 because on most Unix systems, usernames are in lower case and case-insensitive
30334 routing is required. However, any particular router can be made to use the
30335 original case for local parts by setting the &%caseful_local_part%& generic
30336 router option.
30337
30338 .cindex "mixed-case login names"
30339 If you must have mixed-case user names on your system, the best way to proceed,
30340 assuming you want case-independent handling of incoming email, is to set up
30341 your first router to convert incoming local parts in your domains to the
30342 correct case by means of a file lookup. For example:
30343 .code
30344 correct_case:
30345   driver = redirect
30346   domains = +local_domains
30347   data = ${lookup{$local_part}cdb\
30348               {/etc/usercased.cdb}{$value}fail}\
30349               @$domain
30350 .endd
30351 For this router, the local part is forced to lower case by the default action
30352 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
30353 up a new local part in the correct case. If you then set &%caseful_local_part%&
30354 on any subsequent routers which process your domains, they will operate on
30355 local parts with the correct case in a case-sensitive manner.
30356
30357
30358
30359 .section "Dots in local parts" "SECID231"
30360 .cindex "dot" "in local part"
30361 .cindex "local part" "dots in"
30362 RFC 2822 forbids empty components in local parts. That is, an unquoted local
30363 part may not begin or end with a dot, nor have two consecutive dots in the
30364 middle. However, it seems that many MTAs do not enforce this, so Exim permits
30365 empty components for compatibility.
30366
30367
30368
30369 .section "Rewriting addresses" "SECID232"
30370 .cindex "rewriting" "addresses"
30371 Rewriting of sender and recipient addresses, and addresses in headers, can
30372 happen automatically, or as the result of configuration options, as described
30373 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
30374 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
30375
30376 Automatic rewriting includes qualification, as mentioned above. The other case
30377 in which it can happen is when an incomplete non-local domain is given. The
30378 routing process may cause this to be expanded into the full domain name. For
30379 example, a header such as
30380 .code
30381 To: hare@teaparty
30382 .endd
30383 might get rewritten as
30384 .code
30385 To: hare@teaparty.wonderland.fict.example
30386 .endd
30387 Rewriting as a result of routing is the one kind of message processing that
30388 does not happen at input time, as it cannot be done until the address has
30389 been routed.
30390
30391 Strictly, one should not do &'any'& deliveries of a message until all its
30392 addresses have been routed, in case any of the headers get changed as a
30393 result of routing. However, doing this in practice would hold up many
30394 deliveries for unreasonable amounts of time, just because one address could not
30395 immediately be routed. Exim therefore does not delay other deliveries when
30396 routing of one or more addresses is deferred.
30397 .ecindex IIDmesproc
30398
30399
30400
30401 . ////////////////////////////////////////////////////////////////////////////
30402 . ////////////////////////////////////////////////////////////////////////////
30403
30404 .chapter "SMTP processing" "CHAPSMTP"
30405 .scindex IIDsmtpproc1 "SMTP" "processing details"
30406 .scindex IIDsmtpproc2 "LMTP" "processing details"
30407 Exim supports a number of different ways of using the SMTP protocol, and its
30408 LMTP variant, which is an interactive protocol for transferring messages into a
30409 closed mail store application. This chapter contains details of how SMTP is
30410 processed. For incoming mail, the following are available:
30411
30412 .ilist
30413 SMTP over TCP/IP (Exim daemon or &'inetd'&);
30414 .next
30415 SMTP over the standard input and output (the &%-bs%& option);
30416 .next
30417 Batched SMTP on the standard input (the &%-bS%& option).
30418 .endlist
30419
30420 For mail delivery, the following are available:
30421
30422 .ilist
30423 SMTP over TCP/IP (the &(smtp)& transport);
30424 .next
30425 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
30426 &"lmtp"&);
30427 .next
30428 LMTP over a pipe to a process running in the local host (the &(lmtp)&
30429 transport);
30430 .next
30431 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
30432 the &%use_bsmtp%& option set).
30433 .endlist
30434
30435 &'Batched SMTP'& is the name for a process in which batches of messages are
30436 stored in or read from files (or pipes), in a format in which SMTP commands are
30437 used to contain the envelope information.
30438
30439
30440
30441 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
30442 .cindex "SMTP" "outgoing over TCP/IP"
30443 .cindex "outgoing SMTP over TCP/IP"
30444 .cindex "LMTP" "over TCP/IP"
30445 .cindex "outgoing LMTP over TCP/IP"
30446 .cindex "EHLO"
30447 .cindex "HELO"
30448 .cindex "SIZE option on MAIL command"
30449 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
30450 The &%protocol%& option selects which protocol is to be used, but the actual
30451 processing is the same in both cases.
30452
30453 If, in response to its EHLO command, Exim is told that the SIZE
30454 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
30455 command. The value of <&'n'&> is the message size plus the value of the
30456 &%size_addition%& option (default 1024) to allow for additions to the message
30457 such as per-transport header lines, or changes made in a
30458 .cindex "transport" "filter"
30459 .cindex "filter" "transport filter"
30460 transport filter. If &%size_addition%& is set negative, the use of SIZE is
30461 suppressed.
30462
30463 If the remote server advertises support for PIPELINING, Exim uses the
30464 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
30465 required for the transaction.
30466
30467 If the remote server advertises support for the STARTTLS command, and Exim
30468 was built to support TLS encryption, it tries to start a TLS session unless the
30469 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
30470
30471 If the remote server advertises support for the AUTH command, Exim scans
30472 the authenticators configuration for any suitable client settings, as described
30473 in chapter &<<CHAPSMTPAUTH>>&.
30474
30475 .cindex "carriage return"
30476 .cindex "linefeed"
30477 Responses from the remote host are supposed to be terminated by CR followed by
30478 LF. However, there are known to be hosts that do not send CR characters, so in
30479 order to be able to interwork with such hosts, Exim treats LF on its own as a
30480 line terminator.
30481
30482 If a message contains a number of different addresses, all those with the same
30483 characteristics (for example, the same envelope sender) that resolve to the
30484 same set of hosts, in the same order, are sent in a single SMTP transaction,
30485 even if they are for different domains, unless there are more than the setting
30486 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
30487 they are split into groups containing no more than &%max_rcpt%&s addresses
30488 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
30489 in parallel sessions. The order of hosts with identical MX values is not
30490 significant when checking whether addresses can be batched in this way.
30491
30492 When the &(smtp)& transport suffers a temporary failure that is not
30493 message-related, Exim updates its transport-specific database, which contains
30494 records indexed by host name that remember which messages are waiting for each
30495 particular host. It also updates the retry database with new retry times.
30496
30497 .cindex "hints database" "retry keys"
30498 Exim's retry hints are based on host name plus IP address, so if one address of
30499 a multi-homed host is broken, it will soon be skipped most of the time.
30500 See the next section for more detail about error handling.
30501
30502 .cindex "SMTP" "passed connection"
30503 .cindex "SMTP" "batching over TCP/IP"
30504 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
30505 looks in the hints database for the transport to see if there are any queued
30506 messages waiting for the host to which it is connected. If it finds one, it
30507 creates a new Exim process using the &%-MC%& option (which can only be used by
30508 a process running as root or the Exim user) and passes the TCP/IP socket to it
30509 so that it can deliver another message using the same socket. The new process
30510 does only those deliveries that are routed to the connected host, and may in
30511 turn pass the socket on to a third process, and so on.
30512
30513 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
30514 limit the number of messages sent down a single TCP/IP connection.
30515
30516 .cindex "asterisk" "after IP address"
30517 The second and subsequent messages delivered down an existing connection are
30518 identified in the main log by the addition of an asterisk after the closing
30519 square bracket of the IP address.
30520
30521
30522
30523
30524 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
30525 .cindex "error" "in outgoing SMTP"
30526 .cindex "SMTP" "errors in outgoing"
30527 .cindex "host" "error"
30528 Three different kinds of error are recognized for outgoing SMTP: host errors,
30529 message errors, and recipient errors.
30530
30531 .vlist
30532 .vitem "&*Host errors*&"
30533 A host error is not associated with a particular message or with a
30534 particular recipient of a message. The host errors are:
30535
30536 .ilist
30537 Connection refused or timed out,
30538 .next
30539 Any error response code on connection,
30540 .next
30541 Any error response code to EHLO or HELO,
30542 .next
30543 Loss of connection at any time, except after &"."&,
30544 .next
30545 I/O errors at any time,
30546 .next
30547 Timeouts during the session, other than in response to MAIL, RCPT or
30548 the &"."& at the end of the data.
30549 .endlist ilist
30550
30551 For a host error, a permanent error response on connection, or in response to
30552 EHLO, causes all addresses routed to the host to be failed. Any other host
30553 error causes all addresses to be deferred, and retry data to be created for the
30554 host. It is not tried again, for any message, until its retry time arrives. If
30555 the current set of addresses are not all delivered in this run (to some
30556 alternative host), the message is added to the list of those waiting for this
30557 host, so if it is still undelivered when a subsequent successful delivery is
30558 made to the host, it will be sent down the same SMTP connection.
30559
30560 .vitem "&*Message errors*&"
30561 .cindex "message" "error"
30562 A message error is associated with a particular message when sent to a
30563 particular host, but not with a particular recipient of the message. The
30564 message errors are:
30565
30566 .ilist
30567 Any error response code to MAIL, DATA, or the &"."& that terminates
30568 the data,
30569 .next
30570 Timeout after MAIL,
30571 .next
30572 Timeout or loss of connection after the &"."& that terminates the data. A
30573 timeout after the DATA command itself is treated as a host error, as is loss of
30574 connection at any other time.
30575 .endlist ilist
30576
30577 For a message error, a permanent error response (5&'xx'&) causes all addresses
30578 to be failed, and a delivery error report to be returned to the sender. A
30579 temporary error response (4&'xx'&), or one of the timeouts, causes all
30580 addresses to be deferred. Retry data is not created for the host, but instead,
30581 a retry record for the combination of host plus message id is created. The
30582 message is not added to the list of those waiting for this host. This ensures
30583 that the failing message will not be sent to this host again until the retry
30584 time arrives. However, other messages that are routed to the host are not
30585 affected, so if it is some property of the message that is causing the error,
30586 it will not stop the delivery of other mail.
30587
30588 If the remote host specified support for the SIZE parameter in its response
30589 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
30590 over-large message will cause a message error because the error arrives as a
30591 response to MAIL.
30592
30593 .vitem "&*Recipient errors*&"
30594 .cindex "recipient" "error"
30595 A recipient error is associated with a particular recipient of a message. The
30596 recipient errors are:
30597
30598 .ilist
30599 Any error response to RCPT,
30600 .next
30601 Timeout after RCPT.
30602 .endlist
30603
30604 For a recipient error, a permanent error response (5&'xx'&) causes the
30605 recipient address to be failed, and a bounce message to be returned to the
30606 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
30607 address to be deferred, and routing retry data to be created for it. This is
30608 used to delay processing of the address in subsequent queue runs, until its
30609 routing retry time arrives. This applies to all messages, but because it
30610 operates only in queue runs, one attempt will be made to deliver a new message
30611 to the failing address before the delay starts to operate. This ensures that,
30612 if the failure is really related to the message rather than the recipient
30613 (&"message too big for this recipient"& is a possible example), other messages
30614 have a chance of getting delivered. If a delivery to the address does succeed,
30615 the retry information gets cleared, so all stuck messages get tried again, and
30616 the retry clock is reset.
30617
30618 The message is not added to the list of those waiting for this host. Use of the
30619 host for other messages is unaffected, and except in the case of a timeout,
30620 other recipients are processed independently, and may be successfully delivered
30621 in the current SMTP session. After a timeout it is of course impossible to
30622 proceed with the session, so all addresses get deferred. However, those other
30623 than the one that failed do not suffer any subsequent retry delays. Therefore,
30624 if one recipient is causing trouble, the others have a chance of getting
30625 through when a subsequent delivery attempt occurs before the failing
30626 recipient's retry time.
30627 .endlist
30628
30629 In all cases, if there are other hosts (or IP addresses) available for the
30630 current set of addresses (for example, from multiple MX records), they are
30631 tried in this run for any undelivered addresses, subject of course to their
30632 own retry data. In other words, recipient error retry data does not take effect
30633 until the next delivery attempt.
30634
30635 Some hosts have been observed to give temporary error responses to every
30636 MAIL command at certain times (&"insufficient space"& has been seen). It
30637 would be nice if such circumstances could be recognized, and defer data for the
30638 host itself created, but this is not possible within the current Exim design.
30639 What actually happens is that retry data for every (host, message) combination
30640 is created.
30641
30642 The reason that timeouts after MAIL and RCPT are treated specially is that
30643 these can sometimes arise as a result of the remote host's verification
30644 procedures. Exim makes this assumption, and treats them as if a temporary error
30645 response had been received. A timeout after &"."& is treated specially because
30646 it is known that some broken implementations fail to recognize the end of the
30647 message if the last character of the last line is a binary zero. Thus, it is
30648 helpful to treat this case as a message error.
30649
30650 Timeouts at other times are treated as host errors, assuming a problem with the
30651 host, or the connection to it. If a timeout after MAIL, RCPT,
30652 or &"."& is really a connection problem, the assumption is that at the next try
30653 the timeout is likely to occur at some other point in the dialogue, causing it
30654 then to be treated as a host error.
30655
30656 There is experimental evidence that some MTAs drop the connection after the
30657 terminating &"."& if they do not like the contents of the message for some
30658 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
30659 should be given. That is why Exim treats this case as a message rather than a
30660 host error, in order not to delay other messages to the same host.
30661
30662
30663
30664
30665 .section "Incoming SMTP messages over TCP/IP" "SECID233"
30666 .cindex "SMTP" "incoming over TCP/IP"
30667 .cindex "incoming SMTP over TCP/IP"
30668 .cindex "inetd"
30669 .cindex "daemon"
30670 Incoming SMTP messages can be accepted in one of two ways: by running a
30671 listening daemon, or by using &'inetd'&. In the latter case, the entry in
30672 &_/etc/inetd.conf_& should be like this:
30673 .code
30674 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
30675 .endd
30676 Exim distinguishes between this case and the case of a locally running user
30677 agent using the &%-bs%& option by checking whether or not the standard input is
30678 a socket. When it is, either the port must be privileged (less than 1024), or
30679 the caller must be root or the Exim user. If any other user passes a socket
30680 with an unprivileged port number, Exim prints a message on the standard error
30681 stream and exits with an error code.
30682
30683 By default, Exim does not make a log entry when a remote host connects or
30684 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
30685 unexpected. It can be made to write such log entries by setting the
30686 &%smtp_connection%& log selector.
30687
30688 .cindex "carriage return"
30689 .cindex "linefeed"
30690 Commands from the remote host are supposed to be terminated by CR followed by
30691 LF. However, there are known to be hosts that do not send CR characters. In
30692 order to be able to interwork with such hosts, Exim treats LF on its own as a
30693 line terminator.
30694 Furthermore, because common code is used for receiving messages from all
30695 sources, a CR on its own is also interpreted as a line terminator. However, the
30696 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
30697
30698 .cindex "EHLO" "invalid data"
30699 .cindex "HELO" "invalid data"
30700 One area that sometimes gives rise to problems concerns the EHLO or
30701 HELO commands. Some clients send syntactically invalid versions of these
30702 commands, which Exim rejects by default. (This is nothing to do with verifying
30703 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
30704 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
30705 match the broken hosts that send invalid commands.
30706
30707 .cindex "SIZE option on MAIL command"
30708 .cindex "MAIL" "SIZE option"
30709 The amount of disk space available is checked whenever SIZE is received on
30710 a MAIL command, independently of whether &%message_size_limit%& or
30711 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
30712 false. A temporary error is given if there is not enough space. If
30713 &%check_spool_space%& is set, the check is for that amount of space plus the
30714 value given with SIZE, that is, it checks that the addition of the incoming
30715 message will not reduce the space below the threshold.
30716
30717 When a message is successfully received, Exim includes the local message id in
30718 its response to the final &"."& that terminates the data. If the remote host
30719 logs this text it can help with tracing what has happened to a message.
30720
30721 The Exim daemon can limit the number of simultaneous incoming connections it is
30722 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
30723 number of simultaneous incoming connections from a single remote host (see the
30724 &%smtp_accept_max_per_host%& option). Additional connection attempts are
30725 rejected using the SMTP temporary error code 421.
30726
30727 The Exim daemon does not rely on the SIGCHLD signal to detect when a
30728 subprocess has finished, as this can get lost at busy times. Instead, it looks
30729 for completed subprocesses every time it wakes up. Provided there are other
30730 things happening (new incoming calls, starts of queue runs), completed
30731 processes will be noticed and tidied away. On very quiet systems you may
30732 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
30733 it will be noticed when the daemon next wakes up.
30734
30735 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
30736 and can also be set up to reject SMTP calls from non-reserved hosts at times of
30737 high system load &-- for details see the &%smtp_accept_reserve%&,
30738 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
30739 applies in both the daemon and &'inetd'& cases.
30740
30741 Exim normally starts a delivery process for each message received, though this
30742 can be varied by means of the &%-odq%& command line option and the
30743 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
30744 number of simultaneously running delivery processes started in this way from
30745 SMTP input can be limited by the &%smtp_accept_queue%& and
30746 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
30747 subsequently received messages are just put on the input queue without starting
30748 a delivery process.
30749
30750 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
30751 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
30752 started up from the &'inetd'& daemon, because in that case each connection is
30753 handled by an entirely independent Exim process. Control by load average is,
30754 however, available with &'inetd'&.
30755
30756 Exim can be configured to verify addresses in incoming SMTP commands as they
30757 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
30758 to rewrite addresses at this time &-- before any syntax checking is done. See
30759 section &<<SECTrewriteS>>&.
30760
30761 Exim can also be configured to limit the rate at which a client host submits
30762 MAIL and RCPT commands in a single SMTP session. See the
30763 &%smtp_ratelimit_hosts%& option.
30764
30765
30766
30767 .section "Unrecognized SMTP commands" "SECID234"
30768 .cindex "SMTP" "unrecognized commands"
30769 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
30770 commands during a single SMTP connection, it drops the connection after sending
30771 the error response to the last command. The default value for
30772 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
30773 abuse that subvert web servers into making connections to SMTP ports; in these
30774 circumstances, a number of non-SMTP lines are sent first.
30775
30776
30777 .section "Syntax and protocol errors in SMTP commands" "SECID235"
30778 .cindex "SMTP" "syntax errors"
30779 .cindex "SMTP" "protocol errors"
30780 A syntax error is detected if an SMTP command is recognized, but there is
30781 something syntactically wrong with its data, for example, a malformed email
30782 address in a RCPT command. Protocol errors include invalid command
30783 sequencing such as RCPT before MAIL. If Exim receives more than
30784 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
30785 drops the connection after sending the error response to the last command. The
30786 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
30787 broken clients that loop sending bad commands (yes, it has been seen).
30788
30789
30790
30791 .section "Use of non-mail SMTP commands" "SECID236"
30792 .cindex "SMTP" "non-mail commands"
30793 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
30794 DATA. Exim counts such commands, and drops the connection if there are too
30795 many of them in a single SMTP session. This action catches some
30796 denial-of-service attempts and things like repeated failing AUTHs, or a mad
30797 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
30798 defines what &"too many"& means. Its default value is 10.
30799
30800 When a new message is expected, one occurrence of RSET is not counted. This
30801 allows a client to send one RSET between messages (this is not necessary,
30802 but some clients do it). Exim also allows one uncounted occurrence of HELO
30803 or EHLO, and one occurrence of STARTTLS between messages. After
30804 starting up a TLS session, another EHLO is expected, and so it too is not
30805 counted.
30806
30807 The first occurrence of AUTH in a connection, or immediately following
30808 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
30809 RCPT, DATA, and QUIT are counted.
30810
30811 You can control which hosts are subject to the limit set by
30812 &%smtp_accept_max_nonmail%& by setting
30813 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
30814 the limit apply to all hosts. This option means that you can exclude any
30815 specific badly-behaved hosts that you have to live with.
30816
30817
30818
30819
30820 .section "The VRFY and EXPN commands" "SECID237"
30821 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
30822 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
30823 appropriate) in order to decide whether the command should be accepted or not.
30824 If no ACL is defined, the command is rejected.
30825
30826 .cindex "VRFY" "processing"
30827 When VRFY is accepted, it runs exactly the same code as when Exim is
30828 called with the &%-bv%& option.
30829
30830 .cindex "EXPN" "processing"
30831 When EXPN is accepted, a single-level expansion of the address is done.
30832 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
30833 than a verification (the &%-bv%& option). If an unqualified local part is given
30834 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
30835 of VRFY and EXPN commands are logged on the main and reject logs, and
30836 VRFY verification failures are logged on the main log for consistency with
30837 RCPT failures.
30838
30839
30840
30841 .section "The ETRN command" "SECTETRN"
30842 .cindex "ETRN" "processing"
30843 RFC 1985 describes an SMTP command called ETRN that is designed to
30844 overcome the security problems of the TURN command (which has fallen into
30845 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
30846 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
30847 should be accepted or not. If no ACL is defined, the command is rejected.
30848
30849 The ETRN command is concerned with &"releasing"& messages that are awaiting
30850 delivery to certain hosts. As Exim does not organize its message queue by host,
30851 the only form of ETRN that is supported by default is the one where the
30852 text starts with the &"#"& prefix, in which case the remainder of the text is
30853 specific to the SMTP server. A valid ETRN command causes a run of Exim with
30854 the &%-R%& option to happen, with the remainder of the ETRN text as its
30855 argument. For example,
30856 .code
30857 ETRN #brigadoon
30858 .endd
30859 runs the command
30860 .code
30861 exim -R brigadoon
30862 .endd
30863 which causes a delivery attempt on all messages with undelivered addresses
30864 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
30865 default), Exim prevents the simultaneous execution of more than one queue run
30866 for the same argument string as a result of an ETRN command. This stops
30867 a misbehaving client from starting more than one queue runner at once.
30868
30869 .cindex "hints database" "ETRN serialization"
30870 Exim implements the serialization by means of a hints database in which a
30871 record is written whenever a process is started by ETRN, and deleted when
30872 the process completes. However, Exim does not keep the SMTP session waiting for
30873 the ETRN process to complete. Once ETRN is accepted, the client is sent
30874 a &"success"& return code. Obviously there is scope for hints records to get
30875 left lying around if there is a system or program crash. To guard against this,
30876 Exim ignores any records that are more than six hours old.
30877
30878 .oindex "&%smtp_etrn_command%&"
30879 For more control over what ETRN does, the &%smtp_etrn_command%& option can
30880 used. This specifies a command that is run whenever ETRN is received,
30881 whatever the form of its argument. For
30882 example:
30883 .code
30884 smtp_etrn_command = /etc/etrn_command $domain \
30885                     $sender_host_address
30886 .endd
30887 .vindex "&$domain$&"
30888 The string is split up into arguments which are independently expanded. The
30889 expansion variable &$domain$& is set to the argument of the ETRN command,
30890 and no syntax checking is done on the contents of this argument. Exim does not
30891 wait for the command to complete, so its status code is not checked. Exim runs
30892 under its own uid and gid when receiving incoming SMTP, so it is not possible
30893 for it to change them before running the command.
30894
30895
30896
30897 .section "Incoming local SMTP" "SECID238"
30898 .cindex "SMTP" "local incoming"
30899 Some user agents use SMTP to pass messages to their local MTA using the
30900 standard input and output, as opposed to passing the envelope on the command
30901 line and writing the message to the standard input. This is supported by the
30902 &%-bs%& option. This form of SMTP is handled in the same way as incoming
30903 messages over TCP/IP (including the use of ACLs), except that the envelope
30904 sender given in a MAIL command is ignored unless the caller is trusted. In
30905 an ACL you can detect this form of SMTP input by testing for an empty host
30906 identification. It is common to have this as the first line in the ACL that
30907 runs for RCPT commands:
30908 .code
30909 accept hosts = :
30910 .endd
30911 This accepts SMTP messages from local processes without doing any other tests.
30912
30913
30914
30915 .section "Outgoing batched SMTP" "SECTbatchSMTP"
30916 .cindex "SMTP" "batched outgoing"
30917 .cindex "batched SMTP output"
30918 Both the &(appendfile)& and &(pipe)& transports can be used for handling
30919 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
30920 be output in BSMTP format. No SMTP responses are possible for this form of
30921 delivery. All it is doing is using SMTP commands as a way of transmitting the
30922 envelope along with the message.
30923
30924 The message is written to the file or pipe preceded by the SMTP commands
30925 MAIL and RCPT, and followed by a line containing a single dot. Lines in
30926 the message that start with a dot have an extra dot added. The SMTP command
30927 HELO is not normally used. If it is required, the &%message_prefix%& option
30928 can be used to specify it.
30929
30930 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
30931 one recipient address at a time by default. However, you can arrange for them
30932 to handle several addresses at once by setting the &%batch_max%& option. When
30933 this is done for BSMTP, messages may contain multiple RCPT commands. See
30934 chapter &<<CHAPbatching>>& for more details.
30935
30936 .vindex "&$host$&"
30937 When one or more addresses are routed to a BSMTP transport by a router that
30938 sets up a host list, the name of the first host on the list is available to the
30939 transport in the variable &$host$&. Here is an example of such a transport and
30940 router:
30941 .code
30942 begin routers
30943 route_append:
30944   driver = manualroute
30945   transport = smtp_appendfile
30946   route_list = domain.example  batch.host.example
30947
30948 begin transports
30949 smtp_appendfile:
30950   driver = appendfile
30951   directory = /var/bsmtp/$host
30952   batch_max = 1000
30953   use_bsmtp
30954   user = exim
30955 .endd
30956 This causes messages addressed to &'domain.example'& to be written in BSMTP
30957 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
30958 message (unless there are more than 1000 recipients).
30959
30960
30961
30962 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
30963 .cindex "SMTP" "batched incoming"
30964 .cindex "batched SMTP input"
30965 The &%-bS%& command line option causes Exim to accept one or more messages by
30966 reading SMTP on the standard input, but to generate no responses. If the caller
30967 is trusted, the senders in the MAIL commands are believed; otherwise the
30968 sender is always the caller of Exim. Unqualified senders and receivers are not
30969 rejected (there seems little point) but instead just get qualified. HELO
30970 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
30971 as NOOP; QUIT quits.
30972
30973 No policy checking is done for BSMTP input. That is, no ACL is run at anytime.
30974 In this respect it is like non-SMTP local input.
30975
30976 If an error is detected while reading a message, including a missing &"."& at
30977 the end, Exim gives up immediately. It writes details of the error to the
30978 standard output in a stylized way that the calling program should be able to
30979 make some use of automatically, for example:
30980 .code
30981 554 Unexpected end of file
30982 Transaction started in line 10
30983 Error detected in line 14
30984 .endd
30985 It writes a more verbose version, for human consumption, to the standard error
30986 file, for example:
30987 .code
30988 An error was detected while processing a file of BSMTP input.
30989 The error message was:
30990
30991 501 '>' missing at end of address
30992
30993 The SMTP transaction started in line 10.
30994 The error was detected in line 12.
30995 The SMTP command at fault was:
30996
30997 rcpt to:<malformed@in.com.plete
30998
30999 1 previous message was successfully processed.
31000 The rest of the batch was abandoned.
31001 .endd
31002 The return code from Exim is zero only if there were no errors. It is 1 if some
31003 messages were accepted before an error was detected, and 2 if no messages were
31004 accepted.
31005 .ecindex IIDsmtpproc1
31006 .ecindex IIDsmtpproc2
31007
31008
31009
31010 . ////////////////////////////////////////////////////////////////////////////
31011 . ////////////////////////////////////////////////////////////////////////////
31012
31013 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
31014          "Customizing messages"
31015 When a message fails to be delivered, or remains on the queue for more than a
31016 configured amount of time, Exim sends a message to the original sender, or
31017 to an alternative configured address. The text of these messages is built into
31018 the code of Exim, but it is possible to change it, either by adding a single
31019 string, or by replacing each of the paragraphs by text supplied in a file.
31020
31021 The &'From:'& and &'To:'& header lines are automatically generated; you can
31022 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
31023 option. Exim also adds the line
31024 .code
31025 Auto-Submitted: auto-generated
31026 .endd
31027 to all warning and bounce messages,
31028
31029
31030 .section "Customizing bounce messages" "SECID239"
31031 .cindex "customizing" "bounce message"
31032 .cindex "bounce message" "customizing"
31033 If &%bounce_message_text%& is set, its contents are included in the default
31034 message immediately after &"This message was created automatically by mail
31035 delivery software."& The string is not expanded. It is not used if
31036 &%bounce_message_file%& is set.
31037
31038 When &%bounce_message_file%& is set, it must point to a template file for
31039 constructing error messages. The file consists of a series of text items,
31040 separated by lines consisting of exactly four asterisks. If the file cannot be
31041 opened, default text is used and a message is written to the main and panic
31042 logs. If any text item in the file is empty, default text is used for that
31043 item.
31044
31045 .vindex "&$bounce_recipient$&"
31046 .vindex "&$bounce_return_size_limit$&"
31047 Each item of text that is read from the file is expanded, and there are two
31048 expansion variables which can be of use here: &$bounce_recipient$& is set to
31049 the recipient of an error message while it is being created, and
31050 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
31051 option, rounded to a whole number.
31052
31053 The items must appear in the file in the following order:
31054
31055 .ilist
31056 The first item is included in the headers, and should include at least a
31057 &'Subject:'& header. Exim does not check the syntax of these headers.
31058 .next
31059 The second item forms the start of the error message. After it, Exim lists the
31060 failing addresses with their error messages.
31061 .next
31062 The third item is used to introduce any text from pipe transports that is to be
31063 returned to the sender. It is omitted if there is no such text.
31064 .next
31065 The fourth item is used to introduce the copy of the message that is returned
31066 as part of the error report.
31067 .next
31068 The fifth item is added after the fourth one if the returned message is
31069 truncated because it is bigger than &%return_size_limit%&.
31070 .next
31071 The sixth item is added after the copy of the original message.
31072 .endlist
31073
31074 The default state (&%bounce_message_file%& unset) is equivalent to the
31075 following file, in which the sixth item is empty. The &'Subject:'& and some
31076 other lines have been split in order to fit them on the page:
31077 .code
31078 Subject: Mail delivery failed
31079   ${if eq{$sender_address}{$bounce_recipient}
31080   {: returning message to sender}}
31081 ****
31082 This message was created automatically by mail delivery software.
31083
31084 A message ${if eq{$sender_address}{$bounce_recipient}
31085   {that you sent }{sent by
31086
31087 <$sender_address>
31088
31089 }}could not be delivered to all of its recipients.
31090 This is a permanent error. The following address(es) failed:
31091 ****
31092 The following text was generated during the delivery attempt(s):
31093 ****
31094 ------ This is a copy of the message, including all the headers.
31095   ------
31096 ****
31097 ------ The body of the message is $message_size characters long;
31098   only the first
31099 ------ $bounce_return_size_limit or so are included here.
31100 ****
31101 .endd
31102 .section "Customizing warning messages" "SECTcustwarn"
31103 .cindex "customizing" "warning message"
31104 .cindex "warning of delay" "customizing the message"
31105 The option &%warn_message_file%& can be pointed at a template file for use when
31106 warnings about message delays are created. In this case there are only three
31107 text sections:
31108
31109 .ilist
31110 The first item is included in the headers, and should include at least a
31111 &'Subject:'& header. Exim does not check the syntax of these headers.
31112 .next
31113 The second item forms the start of the warning message. After it, Exim lists
31114 the delayed addresses.
31115 .next
31116 The third item then ends the message.
31117 .endlist
31118
31119 The default state is equivalent to the following file, except that some lines
31120 have been split here, in order to fit them on the page:
31121 .code
31122 Subject: Warning: message $message_exim_id delayed
31123   $warn_message_delay
31124 ****
31125 This message was created automatically by mail delivery software.
31126
31127 A message ${if eq{$sender_address}{$warn_message_recipients}
31128 {that you sent }{sent by
31129
31130 <$sender_address>
31131
31132 }}has not been delivered to all of its recipients after
31133 more than $warn_message_delay on the queue on $primary_hostname.
31134
31135 The message identifier is:     $message_exim_id
31136 The subject of the message is: $h_subject
31137 The date of the message is:    $h_date
31138
31139 The following address(es) have not yet been delivered:
31140 ****
31141 No action is required on your part. Delivery attempts will
31142 continue for some time, and this warning may be repeated at
31143 intervals if the message remains undelivered. Eventually the
31144 mail delivery software will give up, and when that happens,
31145 the message will be returned to you.
31146 .endd
31147 .vindex "&$warn_message_delay$&"
31148 .vindex "&$warn_message_recipients$&"
31149 However, in the default state the subject and date lines are omitted if no
31150 appropriate headers exist. During the expansion of this file,
31151 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
31152 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
31153 of recipients for the warning message. There may be more than one if there are
31154 multiple addresses with different &%errors_to%& settings on the routers that
31155 handled them.
31156
31157
31158
31159
31160 . ////////////////////////////////////////////////////////////////////////////
31161 . ////////////////////////////////////////////////////////////////////////////
31162
31163 .chapter "Some common configuration settings" "CHAPcomconreq"
31164 This chapter discusses some configuration settings that seem to be fairly
31165 common. More examples and discussion can be found in the Exim book.
31166
31167
31168
31169 .section "Sending mail to a smart host" "SECID240"
31170 .cindex "smart host" "example router"
31171 If you want to send all mail for non-local domains to a &"smart host"&, you
31172 should replace the default &(dnslookup)& router with a router which does the
31173 routing explicitly:
31174 .code
31175 send_to_smart_host:
31176   driver = manualroute
31177   route_list = !+local_domains smart.host.name
31178   transport = remote_smtp
31179 .endd
31180 You can use the smart host's IP address instead of the name if you wish.
31181 If you are using Exim only to submit messages to a smart host, and not for
31182 receiving incoming messages, you can arrange for it to do the submission
31183 synchronously by setting the &%mua_wrapper%& option (see chapter
31184 &<<CHAPnonqueueing>>&).
31185
31186
31187
31188
31189 .section "Using Exim to handle mailing lists" "SECTmailinglists"
31190 .cindex "mailing lists"
31191 Exim can be used to run simple mailing lists, but for large and/or complicated
31192 requirements, the use of additional specialized mailing list software such as
31193 Majordomo or Mailman is recommended.
31194
31195 The &(redirect)& router can be used to handle mailing lists where each list
31196 is maintained in a separate file, which can therefore be managed by an
31197 independent manager. The &%domains%& router option can be used to run these
31198 lists in a separate domain from normal mail. For example:
31199 .code
31200 lists:
31201   driver = redirect
31202   domains = lists.example
31203   file = /usr/lists/$local_part
31204   forbid_pipe
31205   forbid_file
31206   errors_to = $local_part-request@lists.example
31207   no_more
31208 .endd
31209 This router is skipped for domains other than &'lists.example'&. For addresses
31210 in that domain, it looks for a file that matches the local part. If there is no
31211 such file, the router declines, but because &%no_more%& is set, no subsequent
31212 routers are tried, and so the whole delivery fails.
31213
31214 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
31215 expanded into a file name or a pipe delivery, which is usually inappropriate in
31216 a mailing list.
31217
31218 .oindex "&%errors_to%&"
31219 The &%errors_to%& option specifies that any delivery errors caused by addresses
31220 taken from a mailing list are to be sent to the given address rather than the
31221 original sender of the message. However, before acting on this, Exim verifies
31222 the error address, and ignores it if verification fails.
31223
31224 For example, using the configuration above, mail sent to
31225 &'dicts@lists.example'& is passed on to those addresses contained in
31226 &_/usr/lists/dicts_&, with error reports directed to
31227 &'dicts-request@lists.example'&, provided that this address can be verified.
31228 There could be a file called &_/usr/lists/dicts-request_& containing
31229 the address(es) of this particular list's manager(s), but other approaches,
31230 such as setting up an earlier router (possibly using the &%local_part_prefix%&
31231 or &%local_part_suffix%& options) to handle addresses of the form
31232 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
31233
31234
31235
31236 .section "Syntax errors in mailing lists" "SECID241"
31237 .cindex "mailing lists" "syntax errors in"
31238 If an entry in redirection data contains a syntax error, Exim normally defers
31239 delivery of the original address. That means that a syntax error in a mailing
31240 list holds up all deliveries to the list. This may not be appropriate when a
31241 list is being maintained automatically from data supplied by users, and the
31242 addresses are not rigorously checked.
31243
31244 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
31245 entries that fail to parse, noting the incident in the log. If in addition
31246 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
31247 whenever a broken address is skipped. It is usually appropriate to set
31248 &%syntax_errors_to%& to the same address as &%errors_to%&.
31249
31250
31251
31252 .section "Re-expansion of mailing lists" "SECID242"
31253 .cindex "mailing lists" "re-expansion of"
31254 Exim remembers every individual address to which a message has been delivered,
31255 in order to avoid duplication, but it normally stores only the original
31256 recipient addresses with a message. If all the deliveries to a mailing list
31257 cannot be done at the first attempt, the mailing list is re-expanded when the
31258 delivery is next tried. This means that alterations to the list are taken into
31259 account at each delivery attempt, so addresses that have been added to
31260 the list since the message arrived will therefore receive a copy of the
31261 message, even though it pre-dates their subscription.
31262
31263 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
31264 on the &(redirect)& router. If this is done, any addresses generated by the
31265 router that fail to deliver at the first attempt are added to the message as
31266 &"top level"& addresses, and the parent address that generated them is marked
31267 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
31268 subsequent delivery attempts. The disadvantage of this is that if any of the
31269 failing addresses are incorrect, correcting them in the file has no effect on
31270 pre-existing messages.
31271
31272 The original top-level address is remembered with each of the generated
31273 addresses, and is output in any log messages. However, any intermediate parent
31274 addresses are not recorded. This makes a difference to the log only if the
31275 &%all_parents%& selector is set, but for mailing lists there is normally only
31276 one level of expansion anyway.
31277
31278
31279
31280 .section "Closed mailing lists" "SECID243"
31281 .cindex "mailing lists" "closed"
31282 The examples so far have assumed open mailing lists, to which anybody may
31283 send mail. It is also possible to set up closed lists, where mail is accepted
31284 from specified senders only. This is done by making use of the generic
31285 &%senders%& option to restrict the router that handles the list.
31286
31287 The following example uses the same file as a list of recipients and as a list
31288 of permitted senders. It requires three routers:
31289 .code
31290 lists_request:
31291   driver = redirect
31292   domains = lists.example
31293   local_part_suffix = -request
31294   file = /usr/lists/$local_part$local_part_suffix
31295   no_more
31296
31297 lists_post:
31298   driver = redirect
31299   domains = lists.example
31300   senders = ${if exists {/usr/lists/$local_part}\
31301              {lsearch;/usr/lists/$local_part}{*}}
31302   file = /usr/lists/$local_part
31303   forbid_pipe
31304   forbid_file
31305   errors_to = $local_part-request@lists.example
31306   no_more
31307
31308 lists_closed:
31309   driver = redirect
31310   domains = lists.example
31311   allow_fail
31312   data = :fail: $local_part@lists.example is a closed mailing list
31313 .endd
31314 All three routers have the same &%domains%& setting, so for any other domains,
31315 they are all skipped. The first router runs only if the local part ends in
31316 &%-request%&. It handles messages to the list manager(s) by means of an open
31317 mailing list.
31318
31319 The second router runs only if the &%senders%& precondition is satisfied. It
31320 checks for the existence of a list that corresponds to the local part, and then
31321 checks that the sender is on the list by means of a linear search. It is
31322 necessary to check for the existence of the file before trying to search it,
31323 because otherwise Exim thinks there is a configuration error. If the file does
31324 not exist, the expansion of &%senders%& is *, which matches all senders. This
31325 means that the router runs, but because there is no list, declines, and
31326 &%no_more%& ensures that no further routers are run. The address fails with an
31327 &"unrouteable address"& error.
31328
31329 The third router runs only if the second router is skipped, which happens when
31330 a mailing list exists, but the sender is not on it. This router forcibly fails
31331 the address, giving a suitable error message.
31332
31333
31334
31335
31336 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
31337 .cindex "VERP"
31338 .cindex "Variable Envelope Return Paths"
31339 .cindex "envelope sender"
31340 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
31341 are a way of helping mailing list administrators discover which subscription
31342 address is the cause of a particular delivery failure. The idea is to encode
31343 the original recipient address in the outgoing envelope sender address, so that
31344 if the message is forwarded by another host and then subsequently bounces, the
31345 original recipient can be extracted from the recipient address of the bounce.
31346
31347 .oindex &%errors_to%&
31348 .oindex &%return_path%&
31349 Envelope sender addresses can be modified by Exim using two different
31350 facilities: the &%errors_to%& option on a router (as shown in previous mailing
31351 list examples), or the &%return_path%& option on a transport. The second of
31352 these is effective only if the message is successfully delivered to another
31353 host; it is not used for errors detected on the local host (see the description
31354 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
31355 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
31356 .code
31357 verp_smtp:
31358   driver = smtp
31359   max_rcpt = 1
31360   return_path = \
31361     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
31362       {$1-request+$local_part=$domain@your.dom.example}fail}
31363 .endd
31364 This has the effect of rewriting the return path (envelope sender) on outgoing
31365 SMTP messages, if the local part of the original return path ends in
31366 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
31367 local part and domain of the recipient into the return path. Suppose, for
31368 example, that a message whose return path has been set to
31369 &'somelist-request@your.dom.example'& is sent to
31370 &'subscriber@other.dom.example'&. In the transport, the return path is
31371 rewritten as
31372 .code
31373 somelist-request+subscriber=other.dom.example@your.dom.example
31374 .endd
31375 .vindex "&$local_part$&"
31376 For this to work, you must tell Exim to send multiple copies of messages that
31377 have more than one recipient, so that each copy has just one recipient. This is
31378 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
31379 might be sent to several different recipients in the same domain, in which case
31380 &$local_part$& is not available in the transport, because it is not unique.
31381
31382 Unless your host is doing nothing but mailing list deliveries, you should
31383 probably use a separate transport for the VERP deliveries, so as not to use
31384 extra resources in making one-per-recipient copies for other deliveries. This
31385 can easily be done by expanding the &%transport%& option in the router:
31386 .code
31387 dnslookup:
31388   driver = dnslookup
31389   domains = ! +local_domains
31390   transport = \
31391     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
31392       {verp_smtp}{remote_smtp}}
31393   no_more
31394 .endd
31395 If you want to change the return path using &%errors_to%& in a router instead
31396 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
31397 routers that handle mailing list addresses. This will ensure that all delivery
31398 errors, including those detected on the local host, are sent to the VERP
31399 address.
31400
31401 On a host that does no local deliveries and has no manual routing, only the
31402 &(dnslookup)& router needs to be changed. A special transport is not needed for
31403 SMTP deliveries. Every mailing list recipient has its own return path value,
31404 and so Exim must hand them to the transport one at a time. Here is an example
31405 of a &(dnslookup)& router that implements VERP:
31406 .code
31407 verp_dnslookup:
31408   driver = dnslookup
31409   domains = ! +local_domains
31410   transport = remote_smtp
31411   errors_to = \
31412     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
31413      {$1-request+$local_part=$domain@your.dom.example}fail}
31414   no_more
31415 .endd
31416 Before you start sending out messages with VERPed return paths, you must also
31417 configure Exim to accept the bounce messages that come back to those paths.
31418 Typically this is done by setting a &%local_part_suffix%& option for a
31419 router, and using this to route the messages to wherever you want to handle
31420 them.
31421
31422 The overhead incurred in using VERP depends very much on the size of the
31423 message, the number of recipient addresses that resolve to the same remote
31424 host, and the speed of the connection over which the message is being sent. If
31425 a lot of addresses resolve to the same host and the connection is slow, sending
31426 a separate copy of the message for each address may take substantially longer
31427 than sending a single copy with many recipients (for which VERP cannot be
31428 used).
31429
31430
31431
31432
31433
31434
31435 .section "Virtual domains" "SECTvirtualdomains"
31436 .cindex "virtual domains"
31437 .cindex "domain" "virtual"
31438 The phrase &'virtual domain'& is unfortunately used with two rather different
31439 meanings:
31440
31441 .ilist
31442 A domain for which there are no real mailboxes; all valid local parts are
31443 aliases for other email addresses. Common examples are organizational
31444 top-level domains and &"vanity"& domains.
31445 .next
31446 One of a number of independent domains that are all handled by the same host,
31447 with mailboxes on that host, but where the mailbox owners do not necessarily
31448 have login accounts on that host.
31449 .endlist
31450
31451 The first usage is probably more common, and does seem more &"virtual"& than
31452 the second. This kind of domain can be handled in Exim with a straightforward
31453 aliasing router. One approach is to create a separate alias file for each
31454 virtual domain. Exim can test for the existence of the alias file to determine
31455 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
31456 to a router of this form:
31457 .code
31458 virtual:
31459   driver = redirect
31460   domains = dsearch;/etc/mail/virtual
31461   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
31462   no_more
31463 .endd
31464 The &%domains%& option specifies that the router is to be skipped, unless there
31465 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
31466 domain that is being processed. When the router runs, it looks up the local
31467 part in the file to find a new address (or list of addresses). The &%no_more%&
31468 setting ensures that if the lookup fails (leading to &%data%& being an empty
31469 string), Exim gives up on the address without trying any subsequent routers.
31470
31471 This one router can handle all the virtual domains because the alias file names
31472 follow a fixed pattern. Permissions can be arranged so that appropriate people
31473 can edit the different alias files. A successful aliasing operation results in
31474 a new envelope recipient address, which is then routed from scratch.
31475
31476 The other kind of &"virtual"& domain can also be handled in a straightforward
31477 way. One approach is to create a file for each domain containing a list of
31478 valid local parts, and use it in a router like this:
31479 .code
31480 my_domains:
31481   driver = accept
31482   domains = dsearch;/etc/mail/domains
31483   local_parts = lsearch;/etc/mail/domains/$domain
31484   transport = my_mailboxes
31485 .endd
31486 The address is accepted if there is a file for the domain, and the local part
31487 can be found in the file. The &%domains%& option is used to check for the
31488 file's existence because &%domains%& is tested before the &%local_parts%&
31489 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
31490 because that option is tested after &%local_parts%&. The transport is as
31491 follows:
31492 .code
31493 my_mailboxes:
31494   driver = appendfile
31495   file = /var/mail/$domain/$local_part
31496   user = mail
31497 .endd
31498 This uses a directory of mailboxes for each domain. The &%user%& setting is
31499 required, to specify which uid is to be used for writing to the mailboxes.
31500
31501 The configuration shown here is just one example of how you might support this
31502 requirement. There are many other ways this kind of configuration can be set
31503 up, for example, by using a database instead of separate files to hold all the
31504 information about the domains.
31505
31506
31507
31508 .section "Multiple user mailboxes" "SECTmulbox"
31509 .cindex "multiple mailboxes"
31510 .cindex "mailbox" "multiple"
31511 .cindex "local part" "prefix"
31512 .cindex "local part" "suffix"
31513 Heavy email users often want to operate with multiple mailboxes, into which
31514 incoming mail is automatically sorted. A popular way of handling this is to
31515 allow users to use multiple sender addresses, so that replies can easily be
31516 identified. Users are permitted to add prefixes or suffixes to their local
31517 parts for this purpose. The wildcard facility of the generic router options
31518 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
31519 example, consider this router:
31520 .code
31521 userforward:
31522   driver = redirect
31523   check_local_user
31524   file = $home/.forward
31525   local_part_suffix = -*
31526   local_part_suffix_optional
31527   allow_filter
31528 .endd
31529 .vindex "&$local_part_suffix$&"
31530 It runs a user's &_.forward_& file for all local parts of the form
31531 &'username-*'&. Within the filter file the user can distinguish different
31532 cases by testing the variable &$local_part_suffix$&. For example:
31533 .code
31534 if $local_part_suffix contains -special then
31535 save /home/$local_part/Mail/special
31536 endif
31537 .endd
31538 If the filter file does not exist, or does not deal with such addresses, they
31539 fall through to subsequent routers, and, assuming no subsequent use of the
31540 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
31541 control over which suffixes are valid.
31542
31543 Alternatively, a suffix can be used to trigger the use of a different
31544 &_.forward_& file &-- which is the way a similar facility is implemented in
31545 another MTA:
31546 .code
31547 userforward:
31548   driver = redirect
31549   check_local_user
31550   file = $home/.forward$local_part_suffix
31551   local_part_suffix = -*
31552   local_part_suffix_optional
31553   allow_filter
31554 .endd
31555 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
31556 example, &_.forward-special_& is used. Once again, if the appropriate file
31557 does not exist, or does not deal with the address, it is passed on to
31558 subsequent routers, which could, if required, look for an unqualified
31559 &_.forward_& file to use as a default.
31560
31561
31562
31563 .section "Simplified vacation processing" "SECID244"
31564 .cindex "vacation processing"
31565 The traditional way of running the &'vacation'& program is for a user to set up
31566 a pipe command in a &_.forward_& file
31567 (see section &<<SECTspecitredli>>& for syntax details).
31568 This is prone to error by inexperienced users. There are two features of Exim
31569 that can be used to make this process simpler for users:
31570
31571 .ilist
31572 A local part prefix such as &"vacation-"& can be specified on a router which
31573 can cause the message to be delivered directly to the &'vacation'& program, or
31574 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
31575 &_.forward_& file are then much simpler. For example:
31576 .code
31577 spqr, vacation-spqr
31578 .endd
31579 .next
31580 The &%require_files%& generic router option can be used to trigger a
31581 vacation delivery by checking for the existence of a certain file in the
31582 user's home directory. The &%unseen%& generic option should also be used, to
31583 ensure that the original delivery also proceeds. In this case, all the user has
31584 to do is to create a file called, say, &_.vacation_&, containing a vacation
31585 message.
31586 .endlist
31587
31588 Another advantage of both these methods is that they both work even when the
31589 use of arbitrary pipes by users is locked out.
31590
31591
31592
31593 .section "Taking copies of mail" "SECID245"
31594 .cindex "message" "copying every"
31595 Some installations have policies that require archive copies of all messages to
31596 be made. A single copy of each message can easily be taken by an appropriate
31597 command in a system filter, which could, for example, use a different file for
31598 each day's messages.
31599
31600 There is also a shadow transport mechanism that can be used to take copies of
31601 messages that are successfully delivered by local transports, one copy per
31602 delivery. This could be used, &'inter alia'&, to implement automatic
31603 notification of delivery by sites that insist on doing such things.
31604
31605
31606
31607 .section "Intermittently connected hosts" "SECID246"
31608 .cindex "intermittently connected hosts"
31609 It has become quite common (because it is cheaper) for hosts to connect to the
31610 Internet periodically rather than remain connected all the time. The normal
31611 arrangement is that mail for such hosts accumulates on a system that is
31612 permanently connected.
31613
31614 Exim was designed for use on permanently connected hosts, and so it is not
31615 particularly well-suited to use in an intermittently connected environment.
31616 Nevertheless there are some features that can be used.
31617
31618
31619 .section "Exim on the upstream server host" "SECID247"
31620 It is tempting to arrange for incoming mail for the intermittently connected
31621 host to remain on Exim's queue until the client connects. However, this
31622 approach does not scale very well. Two different kinds of waiting message are
31623 being mixed up in the same queue &-- those that cannot be delivered because of
31624 some temporary problem, and those that are waiting for their destination host
31625 to connect. This makes it hard to manage the queue, as well as wasting
31626 resources, because each queue runner scans the entire queue.
31627
31628 A better approach is to separate off those messages that are waiting for an
31629 intermittently connected host. This can be done by delivering these messages
31630 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
31631 format, from where they are transmitted by other software when their
31632 destination connects. This makes it easy to collect all the mail for one host
31633 in a single directory, and to apply local timeout rules on a per-message basis
31634 if required.
31635
31636 On a very small scale, leaving the mail on Exim's queue can be made to work. If
31637 you are doing this, you should configure Exim with a long retry period for the
31638 intermittent host. For example:
31639 .code
31640 cheshire.wonderland.fict.example    *   F,5d,24h
31641 .endd
31642 This stops a lot of failed delivery attempts from occurring, but Exim remembers
31643 which messages it has queued up for that host. Once the intermittent host comes
31644 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
31645 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
31646 causes all the queued up messages to be delivered, often down a single SMTP
31647 connection. While the host remains connected, any new messages get delivered
31648 immediately.
31649
31650 If the connecting hosts do not have fixed IP addresses, that is, if a host is
31651 issued with a different IP address each time it connects, Exim's retry
31652 mechanisms on the holding host get confused, because the IP address is normally
31653 used as part of the key string for holding retry information. This can be
31654 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
31655 Since this has disadvantages for permanently connected hosts, it is best to
31656 arrange a separate transport for the intermittently connected ones.
31657
31658
31659
31660 .section "Exim on the intermittently connected client host" "SECID248"
31661 The value of &%smtp_accept_queue_per_connection%& should probably be
31662 increased, or even set to zero (that is, disabled) on the intermittently
31663 connected host, so that all incoming messages down a single connection get
31664 delivered immediately.
31665
31666 .cindex "SMTP" "passed connection"
31667 .cindex "SMTP" "multiple deliveries"
31668 .cindex "multiple SMTP deliveries"
31669 Mail waiting to be sent from an intermittently connected host will probably
31670 not have been routed, because without a connection DNS lookups are not
31671 possible. This means that if a normal queue run is done at connection time,
31672 each message is likely to be sent in a separate SMTP session. This can be
31673 avoided by starting the queue run with a command line option beginning with
31674 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
31675 first pass, routing is done but no deliveries take place. The second pass is a
31676 normal queue run; since all the messages have been previously routed, those
31677 destined for the same host are likely to get sent as multiple deliveries in a
31678 single SMTP connection.
31679
31680
31681
31682 . ////////////////////////////////////////////////////////////////////////////
31683 . ////////////////////////////////////////////////////////////////////////////
31684
31685 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
31686          "Exim as a non-queueing client"
31687 .cindex "client, non-queueing"
31688 .cindex "smart host" "suppressing queueing"
31689 On a personal computer, it is a common requirement for all
31690 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
31691 configured to operate that way, for all the popular operating systems.
31692 However, there are some MUAs for Unix-like systems that cannot be so
31693 configured: they submit messages using the command line interface of
31694 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
31695 messages this way.
31696
31697 If the personal computer runs continuously, there is no problem, because it can
31698 run a conventional MTA that handles delivery to the smart host, and deal with
31699 any delays via its queueing mechanism. However, if the computer does not run
31700 continuously or runs different operating systems at different times, queueing
31701 email is not desirable.
31702
31703 There is therefore a requirement for something that can provide the
31704 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
31705 any queueing or retrying facilities. Furthermore, the delivery to the smart
31706 host should be synchronous, so that if it fails, the sending MUA is immediately
31707 informed. In other words, we want something that extends an MUA that submits
31708 to a local MTA via the command line so that it behaves like one that submits
31709 to a remote smart host using TCP/SMTP.
31710
31711 There are a number of applications (for example, there is one called &'ssmtp'&)
31712 that do this job. However, people have found them to be lacking in various
31713 ways. For instance, you might want to allow aliasing and forwarding to be done
31714 before sending a message to the smart host.
31715
31716 Exim already had the necessary infrastructure for doing this job. Just a few
31717 tweaks were needed to make it behave as required, though it is somewhat of an
31718 overkill to use a fully-featured MTA for this purpose.
31719
31720 .oindex "&%mua_wrapper%&"
31721 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
31722 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
31723 assumes that it is being used to &"wrap"& a command-line MUA in the manner
31724 just described. As well as setting &%mua_wrapper%&, you also need to provide a
31725 compatible router and transport configuration. Typically there will be just one
31726 router and one transport, sending everything to a smart host.
31727
31728 When run in MUA wrapping mode, the behaviour of Exim changes in the
31729 following ways:
31730
31731 .ilist
31732 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
31733 In other words, the only way to submit messages is via the command line.
31734 .next
31735 Each message is synchronously delivered as soon as it is received (&%-odi%& is
31736 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
31737 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
31738 does not finish until the delivery attempt is complete. If the delivery is
31739 successful, a zero return code is given.
31740 .next
31741 Address redirection is permitted, but the final routing for all addresses must
31742 be to the same remote transport, and to the same list of hosts. Furthermore,
31743 the return address (envelope sender) must be the same for all recipients, as
31744 must any added or deleted header lines. In other words, it must be possible to
31745 deliver the message in a single SMTP transaction, however many recipients there
31746 are.
31747 .next
31748 If these conditions are not met, or if routing any address results in a
31749 failure or defer status, or if Exim is unable to deliver all the recipients
31750 successfully to one of the smart hosts, delivery of the entire message fails.
31751 .next
31752 Because no queueing is allowed, all failures are treated as permanent; there
31753 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
31754 smart host. Furthermore, because only a single yes/no response can be given to
31755 the caller, it is not possible to deliver to some recipients and not others. If
31756 there is an error (temporary or permanent) for any recipient, all are failed.
31757 .next
31758 If more than one smart host is listed, Exim will try another host after a
31759 connection failure or a timeout, in the normal way. However, if this kind of
31760 failure happens for all the hosts, the delivery fails.
31761 .next
31762 When delivery fails, an error message is written to the standard error stream
31763 (as well as to Exim's log), and Exim exits to the caller with a return code
31764 value 1. The message is expunged from Exim's spool files. No bounce messages
31765 are ever generated.
31766 .next
31767 No retry data is maintained, and any retry rules are ignored.
31768 .next
31769 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
31770 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
31771 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
31772 .endlist
31773
31774 The overall effect is that Exim makes a single synchronous attempt to deliver
31775 the message, failing if there is any kind of problem. Because no local
31776 deliveries are done and no daemon can be run, Exim does not need root
31777 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
31778 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
31779 the advantages and disadvantages of running without root privilege.
31780
31781
31782
31783
31784 . ////////////////////////////////////////////////////////////////////////////
31785 . ////////////////////////////////////////////////////////////////////////////
31786
31787 .chapter "Log files" "CHAPlog"
31788 .scindex IIDloggen "log" "general description"
31789 .cindex "log" "types of"
31790 Exim writes three different logs, referred to as the main log, the reject log,
31791 and the panic log:
31792
31793 .ilist
31794 .cindex "main log"
31795 The main log records the arrival of each message and each delivery in a single
31796 line in each case. The format is as compact as possible, in an attempt to keep
31797 down the size of log files. Two-character flag sequences make it easy to pick
31798 out these lines. A number of other events are recorded in the main log. Some of
31799 them are optional, in which case the &%log_selector%& option controls whether
31800 they are included or not. A Perl script called &'eximstats'&, which does simple
31801 analysis of main log files, is provided in the Exim distribution (see section
31802 &<<SECTmailstat>>&).
31803 .next
31804 .cindex "reject log"
31805 The reject log records information from messages that are rejected as a result
31806 of a configuration option (that is, for policy reasons).
31807 The first line of each rejection is a copy of the line that is also written to
31808 the main log. Then, if the message's header has been read at the time the log
31809 is written, its contents are written to this log. Only the original header
31810 lines are available; header lines added by ACLs are not logged. You can use the
31811 reject log to check that your policy controls are working correctly; on a busy
31812 host this may be easier than scanning the main log for rejection messages. You
31813 can suppress the writing of the reject log by setting &%write_rejectlog%&
31814 false.
31815 .next
31816 .cindex "panic log"
31817 .cindex "system log"
31818 When certain serious errors occur, Exim writes entries to its panic log. If the
31819 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
31820 are usually written to the main log as well, but can get lost amid the mass of
31821 other entries. The panic log should be empty under normal circumstances. It is
31822 therefore a good idea to check it (or to have a &'cron'& script check it)
31823 regularly, in order to become aware of any problems. When Exim cannot open its
31824 panic log, it tries as a last resort to write to the system log (syslog). This
31825 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
31826 message itself is written at priority LOG_CRIT.
31827 .endlist
31828
31829 Every log line starts with a timestamp, in the format shown in the following
31830 example. Note that many of the examples shown in this chapter are line-wrapped.
31831 In the log file, this would be all on one line:
31832 .code
31833 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
31834   by QUIT
31835 .endd
31836 By default, the timestamps are in the local timezone. There are two
31837 ways of changing this:
31838
31839 .ilist
31840 You can set the &%timezone%& option to a different time zone; in particular, if
31841 you set
31842 .code
31843 timezone = UTC
31844 .endd
31845 the timestamps will be in UTC (aka GMT).
31846 .next
31847 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
31848 example:
31849 .code
31850 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
31851 .endd
31852 .endlist
31853
31854 .cindex "log" "process ids in"
31855 .cindex "pid (process id)" "in log lines"
31856 Exim does not include its process id in log lines by default, but you can
31857 request that it does so by specifying the &`pid`& log selector (see section
31858 &<<SECTlogselector>>&). When this is set, the process id is output, in square
31859 brackets, immediately after the time and date.
31860
31861
31862
31863
31864 .section "Where the logs are written" "SECTwhelogwri"
31865 .cindex "log" "destination"
31866 .cindex "log" "to file"
31867 .cindex "log" "to syslog"
31868 .cindex "syslog"
31869 The logs may be written to local files, or to syslog, or both. However, it
31870 should be noted that many syslog implementations use UDP as a transport, and
31871 are therefore unreliable in the sense that messages are not guaranteed to
31872 arrive at the loghost, nor is the ordering of messages necessarily maintained.
31873 It has also been reported that on large log files (tens of megabytes) you may
31874 need to tweak syslog to prevent it syncing the file with each write &-- on
31875 Linux this has been seen to make syslog take 90% plus of CPU time.
31876
31877 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
31878 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
31879 configuration. This latter string is expanded, so it can contain, for example,
31880 references to the host name:
31881 .code
31882 log_file_path = /var/log/$primary_hostname/exim_%slog
31883 .endd
31884 It is generally advisable, however, to set the string in &_Local/Makefile_&
31885 rather than at run time, because then the setting is available right from the
31886 start of Exim's execution. Otherwise, if there's something it wants to log
31887 before it has read the configuration file (for example, an error in the
31888 configuration file) it will not use the path you want, and may not be able to
31889 log at all.
31890
31891 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
31892 list, currently limited to at most two items. This is one option where the
31893 facility for changing a list separator may not be used. The list must always be
31894 colon-separated. If an item in the list is &"syslog"& then syslog is used;
31895 otherwise the item must either be an absolute path, containing &`%s`& at the
31896 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
31897 implying the use of a default path.
31898
31899 When Exim encounters an empty item in the list, it searches the list defined by
31900 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
31901 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
31902 mean &"use the path specified at build time"&. It no such item exists, log
31903 files are written in the &_log_& subdirectory of the spool directory. This is
31904 equivalent to the setting:
31905 .code
31906 log_file_path = $spool_directory/log/%slog
31907 .endd
31908 If you do not specify anything at build time or run time, that is where the
31909 logs are written.
31910
31911 A log file path may also contain &`%D`& if datestamped log file names are in
31912 use &-- see section &<<SECTdatlogfil>>& below.
31913
31914 Here are some examples of possible settings:
31915 .display
31916 &`LOG_FILE_PATH=syslog                    `& syslog only
31917 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
31918 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
31919 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
31920 .endd
31921 If there are more than two paths in the list, the first is used and a panic
31922 error is logged.
31923
31924
31925
31926 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
31927 .cindex "log" "cycling local files"
31928 .cindex "cycling logs"
31929 .cindex "&'exicyclog'&"
31930 .cindex "log" "local files; writing to"
31931 Some operating systems provide centralized and standardized methods for cycling
31932 log files. For those that do not, a utility script called &'exicyclog'& is
31933 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
31934 main and reject logs each time it is called. The maximum number of old logs to
31935 keep can be set. It is suggested this script is run as a daily &'cron'& job.
31936
31937 An Exim delivery process opens the main log when it first needs to write to it,
31938 and it keeps the file open in case subsequent entries are required &-- for
31939 example, if a number of different deliveries are being done for the same
31940 message. However, remote SMTP deliveries can take a long time, and this means
31941 that the file may be kept open long after it is renamed if &'exicyclog'& or
31942 something similar is being used to rename log files on a regular basis. To
31943 ensure that a switch of log files is noticed as soon as possible, Exim calls
31944 &[stat()]& on the main log's name before reusing an open file, and if the file
31945 does not exist, or its inode has changed, the old file is closed and Exim
31946 tries to open the main log from scratch. Thus, an old log file may remain open
31947 for quite some time, but no Exim processes should write to it once it has been
31948 renamed.
31949
31950
31951
31952 .section "Datestamped log files" "SECTdatlogfil"
31953 .cindex "log" "datestamped files"
31954 Instead of cycling the main and reject log files by renaming them
31955 periodically, some sites like to use files whose names contain a datestamp,
31956 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_&.
31957 Exim has support for this way of working. It is enabled by setting the
31958 &%log_file_path%& option to a path that includes &`%D`& at the point where the
31959 datestamp is required. For example:
31960 .code
31961 log_file_path = /var/spool/exim/log/%slog-%D
31962 log_file_path = /var/log/exim-%s-%D.log
31963 log_file_path = /var/spool/exim/log/%D-%slog
31964 .endd
31965 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
31966 examples of names generated by the above examples:
31967 .code
31968 /var/spool/exim/log/mainlog-20021225
31969 /var/log/exim-reject-20021225.log
31970 /var/spool/exim/log/20021225-mainlog
31971 .endd
31972 When this form of log file is specified, Exim automatically switches to new
31973 files at midnight. It does not make any attempt to compress old logs; you
31974 will need to write your own script if you require this. You should not
31975 run &'exicyclog'& with this form of logging.
31976
31977 The location of the panic log is also determined by &%log_file_path%&, but it
31978 is not datestamped, because rotation of the panic log does not make sense.
31979 When generating the name of the panic log, &`%D`& is removed from the string.
31980 In addition, if it immediately follows a slash, a following non-alphanumeric
31981 character is removed; otherwise a preceding non-alphanumeric character is
31982 removed. Thus, the three examples above would give these panic log names:
31983 .code
31984 /var/spool/exim/log/paniclog
31985 /var/log/exim-panic.log
31986 /var/spool/exim/log/paniclog
31987 .endd
31988
31989
31990 .section "Logging to syslog" "SECID249"
31991 .cindex "log" "syslog; writing to"
31992 The use of syslog does not change what Exim logs or the format of its messages,
31993 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
31994 Exim's log lines are omitted when these lines are sent to syslog. Apart from
31995 that, the same strings are written to syslog as to log files. The syslog
31996 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
31997 by default, but you can change these by setting the &%syslog_facility%& and
31998 &%syslog_processname%& options, respectively. If Exim was compiled with
31999 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
32000 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
32001 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
32002 the time and host name to each line.
32003 The three log streams are mapped onto syslog priorities as follows:
32004
32005 .ilist
32006 &'mainlog'& is mapped to LOG_INFO
32007 .next
32008 &'rejectlog'& is mapped to LOG_NOTICE
32009 .next
32010 &'paniclog'& is mapped to LOG_ALERT
32011 .endlist
32012
32013 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
32014 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
32015 these are routed by syslog to the same place. You can suppress this duplication
32016 by setting &%syslog_duplication%& false.
32017
32018 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
32019 entries contain multiple lines when headers are included. To cope with both
32020 these cases, entries written to syslog are split into separate &[syslog()]&
32021 calls at each internal newline, and also after a maximum of
32022 870 data characters. (This allows for a total syslog line length of 1024, when
32023 additions such as timestamps are added.) If you are running a syslog
32024 replacement that can handle lines longer than the 1024 characters allowed by
32025 RFC 3164, you should set
32026 .code
32027 SYSLOG_LONG_LINES=yes
32028 .endd
32029 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
32030 lines, but it still splits at internal newlines in &'reject'& log entries.
32031
32032 To make it easy to re-assemble split lines later, each component of a split
32033 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
32034 where <&'n'&> is the component number and <&'m'&> is the total number of
32035 components in the entry. The / delimiter is used when the line was split
32036 because it was too long; if it was split because of an internal newline, the \
32037 delimiter is used. For example, supposing the length limit to be 50 instead of
32038 870, the following would be the result of a typical rejection message to
32039 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
32040 name, and pid as added by syslog:
32041 .code
32042 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
32043 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
32044 [3/5]  when scanning for sender: missing or malformed lo
32045 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
32046 [5/5] mple>)
32047 .endd
32048 The same error might cause the following lines to be written to &"rejectlog"&
32049 (LOG_NOTICE):
32050 .code
32051 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
32052 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
32053 [3/18] er when scanning for sender: missing or malformed
32054 [4/18]  local part in "<>" (envelope sender is <ph10@cam
32055 [5\18] .example>)
32056 [6\18] Recipients: ph10@some.domain.cam.example
32057 [7\18] P Received: from [127.0.0.1] (ident=ph10)
32058 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
32059 [9\18]        id 16RdAL-0006pc-00
32060 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
32061 [11\18] 09:43 +0100
32062 [12\18] F From: <>
32063 [13\18]   Subject: this is a test header
32064 [18\18]   X-something: this is another header
32065 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
32066 [16\18] le>
32067 [17\18] B Bcc:
32068 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
32069 .endd
32070 Log lines that are neither too long nor contain newlines are written to syslog
32071 without modification.
32072
32073 If only syslog is being used, the Exim monitor is unable to provide a log tail
32074 display, unless syslog is routing &'mainlog'& to a file on the local host and
32075 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
32076 where it is.
32077
32078
32079
32080 .section "Log line flags" "SECID250"
32081 One line is written to the main log for each message received, and for each
32082 successful, unsuccessful, and delayed delivery. These lines can readily be
32083 picked out by the distinctive two-character flags that immediately follow the
32084 timestamp. The flags are:
32085 .display
32086 &`<=`&     message arrival
32087 &`=>`&     normal message delivery
32088 &`->`&     additional address in same delivery
32089 &`*>`&     delivery suppressed by &%-N%&
32090 &`**`&     delivery failed; address bounced
32091 &`==`&     delivery deferred; temporary problem
32092 .endd
32093
32094
32095 .section "Logging message reception" "SECID251"
32096 .cindex "log" "reception line"
32097 The format of the single-line entry in the main log that is written for every
32098 message received is shown in the basic example below, which is split over
32099 several lines in order to fit it on the page:
32100 .code
32101 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
32102   H=mailer.fict.example [192.168.123.123] U=exim
32103   P=smtp S=5678 id=<incoming message id>
32104 .endd
32105 The address immediately following &"<="& is the envelope sender address. A
32106 bounce message is shown with the sender address &"<>"&, and if it is locally
32107 generated, this is followed by an item of the form
32108 .code
32109 R=<message id>
32110 .endd
32111 which is a reference to the message that caused the bounce to be sent.
32112
32113 .cindex "HELO"
32114 .cindex "EHLO"
32115 For messages from other hosts, the H and U fields identify the remote host and
32116 record the RFC 1413 identity of the user that sent the message, if one was
32117 received. The number given in square brackets is the IP address of the sending
32118 host. If there is a single, unparenthesized  host name in the H field, as
32119 above, it has been verified to correspond to the IP address (see the
32120 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
32121 by the remote host in the SMTP HELO or EHLO command, and has not been
32122 verified. If verification yields a different name to that given for HELO or
32123 EHLO, the verified name appears first, followed by the HELO or EHLO
32124 name in parentheses.
32125
32126 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
32127 without brackets, in the HELO or EHLO command, leading to entries in
32128 the log containing text like these examples:
32129 .code
32130 H=(10.21.32.43) [192.168.8.34]
32131 H=([10.21.32.43]) [192.168.8.34]
32132 .endd
32133 This can be confusing. Only the final address in square brackets can be relied
32134 on.
32135
32136 For locally generated messages (that is, messages not received over TCP/IP),
32137 the H field is omitted, and the U field contains the login name of the caller
32138 of Exim.
32139
32140 .cindex "authentication" "logging"
32141 .cindex "AUTH" "logging"
32142 For all messages, the P field specifies the protocol used to receive the
32143 message. This is the value that is stored in &$received_protocol$&. In the case
32144 of incoming SMTP messages, the value indicates whether or not any SMTP
32145 extensions (ESMTP), encryption, or authentication were used. If the SMTP
32146 session was encrypted, there is an additional X field that records the cipher
32147 suite that was used.
32148
32149 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
32150 hosts that have authenticated themselves using the SMTP AUTH command. The first
32151 value is used when the SMTP connection was encrypted (&"secure"&). In this case
32152 there is an additional item A= followed by the name of the authenticator that
32153 was used. If an authenticated identification was set up by the authenticator's
32154 &%server_set_id%& option, this is logged too, separated by a colon from the
32155 authenticator name.
32156
32157 .cindex "size" "of message"
32158 The id field records the existing message id, if present. The size of the
32159 received message is given by the S field. When the message is delivered,
32160 headers may be removed or added, so that the size of delivered copies of the
32161 message may not correspond with this value (and indeed may be different to each
32162 other).
32163
32164 The &%log_selector%& option can be used to request the logging of additional
32165 data when a message is received. See section &<<SECTlogselector>>& below.
32166
32167
32168
32169 .section "Logging deliveries" "SECID252"
32170 .cindex "log" "delivery line"
32171 The format of the single-line entry in the main log that is written for every
32172 delivery is shown in one of the examples below, for local and remote
32173 deliveries, respectively. Each example has been split into two lines in order
32174 to fit it on the page:
32175 .code
32176 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
32177   <marv@hitch.fict.example> R=localuser T=local_delivery
32178 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
32179   monk@holistic.fict.example R=dnslookup T=remote_smtp
32180   H=holistic.fict.example [192.168.234.234]
32181 .endd
32182 For ordinary local deliveries, the original address is given in angle brackets
32183 after the final delivery address, which might be a pipe or a file. If
32184 intermediate address(es) exist between the original and the final address, the
32185 last of these is given in parentheses after the final address. The R and T
32186 fields record the router and transport that were used to process the address.
32187
32188 If a shadow transport was run after a successful local delivery, the log line
32189 for the successful delivery has an item added on the end, of the form
32190 .display
32191 &`ST=<`&&'shadow transport name'&&`>`&
32192 .endd
32193 If the shadow transport did not succeed, the error message is put in
32194 parentheses afterwards.
32195
32196 .cindex "asterisk" "after IP address"
32197 When more than one address is included in a single delivery (for example, two
32198 SMTP RCPT commands in one transaction) the second and subsequent addresses are
32199 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
32200 down a single SMTP connection, an asterisk follows the IP address in the log
32201 lines for the second and subsequent messages.
32202
32203 The generation of a reply message by a filter file gets logged as a
32204 &"delivery"& to the addressee, preceded by &">"&.
32205
32206 The &%log_selector%& option can be used to request the logging of additional
32207 data when a message is delivered. See section &<<SECTlogselector>>& below.
32208
32209
32210 .section "Discarded deliveries" "SECID253"
32211 .cindex "discarded messages"
32212 .cindex "message" "discarded"
32213 .cindex "delivery" "discarded; logging"
32214 When a message is discarded as a result of the command &"seen finish"& being
32215 obeyed in a filter file which generates no deliveries, a log entry of the form
32216 .code
32217 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
32218   <low.club@bridge.example> R=userforward
32219 .endd
32220 is written, to record why no deliveries are logged. When a message is discarded
32221 because it is aliased to &":blackhole:"& the log line is like this:
32222 .code
32223 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
32224   <hole@nowhere.example> R=blackhole_router
32225 .endd
32226
32227
32228 .section "Deferred deliveries" "SECID254"
32229 When a delivery is deferred, a line of the following form is logged:
32230 .code
32231 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
32232   R=dnslookup T=smtp defer (146): Connection refused
32233 .endd
32234 In the case of remote deliveries, the error is the one that was given for the
32235 last IP address that was tried. Details of individual SMTP failures are also
32236 written to the log, so the above line would be preceded by something like
32237 .code
32238 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
32239   mail1.endrest.example [192.168.239.239]: Connection refused
32240 .endd
32241 When a deferred address is skipped because its retry time has not been reached,
32242 a message is written to the log, but this can be suppressed by setting an
32243 appropriate value in &%log_selector%&.
32244
32245
32246
32247 .section "Delivery failures" "SECID255"
32248 .cindex "delivery" "failure; logging"
32249 If a delivery fails because an address cannot be routed, a line of the
32250 following form is logged:
32251 .code
32252 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
32253   <jim@trek99.example>: unknown mail domain
32254 .endd
32255 If a delivery fails at transport time, the router and transport are shown, and
32256 the response from the remote host is included, as in this example:
32257 .code
32258 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
32259   R=dnslookup T=remote_smtp: SMTP error from remote mailer
32260   after pipelined RCPT TO:<ace400@pb.example>: host
32261   pbmail3.py.example [192.168.63.111]: 553 5.3.0
32262   <ace400@pb.example>...Addressee unknown
32263 .endd
32264 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
32265 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
32266 disabling PIPELINING. The log lines for all forms of delivery failure are
32267 flagged with &`**`&.
32268
32269
32270
32271 .section "Fake deliveries" "SECID256"
32272 .cindex "delivery" "fake; logging"
32273 If a delivery does not actually take place because the &%-N%& option has been
32274 used to suppress it, a normal delivery line is written to the log, except that
32275 &"=>"& is replaced by &"*>"&.
32276
32277
32278
32279 .section "Completion" "SECID257"
32280 A line of the form
32281 .code
32282 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
32283 .endd
32284 is written to the main log when a message is about to be removed from the spool
32285 at the end of its processing.
32286
32287
32288
32289
32290 .section "Summary of Fields in Log Lines" "SECID258"
32291 .cindex "log" "summary of fields"
32292 A summary of the field identifiers that are used in log lines is shown in
32293 the following table:
32294 .display
32295 &`A   `&        authenticator name (and optional id)
32296 &`C   `&        SMTP confirmation on delivery
32297 &`    `&        command list for &"no mail in SMTP session"&
32298 &`CV  `&        certificate verification status
32299 &`D   `&        duration of &"no mail in SMTP session"&
32300 &`DN  `&        distinguished name from peer certificate
32301 &`DT  `&        on &`=>`& lines: time taken for a delivery
32302 &`F   `&        sender address (on delivery lines)
32303 &`H   `&        host name and IP address
32304 &`I   `&        local interface used
32305 &`id  `&        message id for incoming message
32306 &`P   `&        on &`<=`& lines: protocol used
32307 &`    `&        on &`=>`& and &`**`& lines: return path
32308 &`QT  `&        on &`=>`& lines: time spent on queue so far
32309 &`    `&        on &"Completed"& lines: time spent on queue
32310 &`R   `&        on &`<=`& lines: reference for local bounce
32311 &`    `&        on &`=>`&  &`**`& and &`==`& lines: router name
32312 &`S   `&        size of message
32313 &`ST  `&        shadow transport name
32314 &`T   `&        on &`<=`& lines: message subject (topic)
32315 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
32316 &`U   `&        local user or RFC 1413 identity
32317 &`X   `&        TLS cipher suite
32318 .endd
32319
32320
32321 .section "Other log entries" "SECID259"
32322 Various other types of log entry are written from time to time. Most should be
32323 self-explanatory. Among the more common are:
32324
32325 .ilist
32326 .cindex "retry" "time not reached"
32327 &'retry time not reached'&&~&~An address previously suffered a temporary error
32328 during routing or local delivery, and the time to retry has not yet arrived.
32329 This message is not written to an individual message log file unless it happens
32330 during the first delivery attempt.
32331 .next
32332 &'retry time not reached for any host'&&~&~An address previously suffered
32333 temporary errors during remote delivery, and the retry time has not yet arrived
32334 for any of the hosts to which it is routed.
32335 .next
32336 .cindex "spool directory" "file locked"
32337 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
32338 some other Exim process is already working on the message. This can be quite
32339 common if queue running processes are started at frequent intervals. The
32340 &'exiwhat'& utility script can be used to find out what Exim processes are
32341 doing.
32342 .next
32343 .cindex "error" "ignored"
32344 &'error ignored'&&~&~There are several circumstances that give rise to this
32345 message:
32346 .olist
32347 Exim failed to deliver a bounce message whose age was greater than
32348 &%ignore_bounce_errors_after%&. The bounce was discarded.
32349 .next
32350 A filter file set up a delivery using the &"noerror"& option, and the delivery
32351 failed. The delivery was discarded.
32352 .next
32353 A delivery set up by a router configured with
32354 . ==== As this is a nested list, any displays it contains must be indented
32355 . ==== as otherwise they are too far to the left.
32356 .code
32357     errors_to = <>
32358 .endd
32359 failed. The delivery was discarded.
32360 .endlist olist
32361 .endlist ilist
32362
32363
32364
32365
32366
32367 .section "Reducing or increasing what is logged" "SECTlogselector"
32368 .cindex "log" "selectors"
32369 By setting the &%log_selector%& global option, you can disable some of Exim's
32370 default logging, or you can request additional logging. The value of
32371 &%log_selector%& is made up of names preceded by plus or minus characters. For
32372 example:
32373 .code
32374 log_selector = +arguments -retry_defer
32375 .endd
32376 The list of optional log items is in the following table, with the default
32377 selection marked by asterisks:
32378 .display
32379 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
32380 &` address_rewrite            `&  address rewriting
32381 &` all_parents                `&  all parents in => lines
32382 &` arguments                  `&  command line arguments
32383 &`*connection_reject          `&  connection rejections
32384 &`*delay_delivery             `&  immediate delivery delayed
32385 &` deliver_time               `&  time taken to perform delivery
32386 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
32387 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
32388 &`*etrn                       `&  ETRN commands
32389 &`*host_lookup_failed         `&  as it says
32390 &` ident_timeout              `&  timeout for ident connection
32391 &` incoming_interface         `&  incoming interface on <= lines
32392 &` incoming_port              `&  incoming port on <= lines
32393 &`*lost_incoming_connection   `&  as it says (includes timeouts)
32394 &` outgoing_port              `&  add remote port to => lines
32395 &`*queue_run                  `&  start and end queue runs
32396 &` queue_time                 `&  time on queue for one recipient
32397 &` queue_time_overall         `&  time on queue for whole message
32398 &` pid                        `&  Exim process id
32399 &` received_recipients        `&  recipients on <= lines
32400 &` received_sender            `&  sender on <= lines
32401 &`*rejected_header            `&  header contents on reject log
32402 &`*retry_defer                `&  &"retry time not reached"&
32403 &` return_path_on_delivery    `&  put return path on => and ** lines
32404 &` sender_on_delivery         `&  add sender to => lines
32405 &`*sender_verify_fail         `&  sender verification failures
32406 &`*size_reject                `&  rejection because too big
32407 &`*skip_delivery              `&  delivery skipped in a queue run
32408 &` smtp_confirmation          `&  SMTP confirmation on => lines
32409 &` smtp_connection            `&  SMTP connections
32410 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
32411 &` smtp_no_mail               `&  session with no MAIL commands
32412 &` smtp_protocol_error        `&  SMTP protocol errors
32413 &` smtp_syntax_error          `&  SMTP syntax errors
32414 &` subject                    `&  contents of &'Subject:'& on <= lines
32415 &` tls_certificate_verified   `&  certificate verification status
32416 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
32417 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
32418 &` unknown_in_list            `&  DNS lookup failed in list match
32419
32420 &` all                        `&  all of the above
32421 .endd
32422 More details on each of these items follows:
32423
32424 .ilist
32425 .cindex "&%warn%& ACL verb" "log when skipping"
32426 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
32427 its conditions cannot be evaluated, a log line to this effect is written if
32428 this log selector is set.
32429 .next
32430 .cindex "log" "rewriting"
32431 .cindex "rewriting" "logging"
32432 &%address_rewrite%&: This applies both to global rewrites and per-transport
32433 rewrites, but not to rewrites in filters run as an unprivileged user (because
32434 such users cannot access the log).
32435 .next
32436 .cindex "log" "full parentage"
32437 &%all_parents%&: Normally only the original and final addresses are logged on
32438 delivery lines; with this selector, intermediate parents are given in
32439 parentheses between them.
32440 .next
32441 .cindex "log" "Exim arguments"
32442 .cindex "Exim arguments, logging"
32443 &%arguments%&: This causes Exim to write the arguments with which it was called
32444 to the main log, preceded by the current working directory. This is a debugging
32445 feature, added to make it easier to find out how certain MUAs call
32446 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
32447 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
32448 that are empty or that contain white space are quoted. Non-printing characters
32449 are shown as escape sequences. This facility cannot log unrecognized arguments,
32450 because the arguments are checked before the configuration file is read. The
32451 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
32452 between the caller and Exim.
32453 .next
32454 .cindex "log" "connection rejections"
32455 &%connection_reject%&: A log entry is written whenever an incoming SMTP
32456 connection is rejected, for whatever reason.
32457 .next
32458 .cindex "log" "delayed delivery"
32459 .cindex "delayed delivery, logging"
32460 &%delay_delivery%&: A log entry is written whenever a delivery process is not
32461 started for an incoming message because the load is too high or too many
32462 messages were received on one connection. Logging does not occur if no delivery
32463 process is started because &%queue_only%& is set or &%-odq%& was used.
32464 .next
32465 .cindex "log" "delivery duration"
32466 &%deliver_time%&: For each delivery, the amount of real time it has taken to
32467 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
32468 .next
32469 .cindex "log" "message size on delivery"
32470 .cindex "size" "of message"
32471 &%delivery_size%&: For each delivery, the size of message delivered is added to
32472 the &"=>"& line, tagged with S=.
32473 .next
32474 .cindex "log" "dnslist defer"
32475 .cindex "DNS list" "logging defer"
32476 .cindex "black list (DNS)"
32477 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
32478 DNS black list suffers a temporary error.
32479 .next
32480 .cindex "log" "ETRN commands"
32481 .cindex "ETRN" "logging"
32482 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
32483 is run to determine whether or not it is actually accepted. An invalid ETRN
32484 command, or one received within a message transaction is not logged by this
32485 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
32486 .next
32487 .cindex "log" "host lookup failure"
32488 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
32489 any addresses, or when a lookup of an IP address fails to find a host name, a
32490 log line is written. This logging does not apply to direct DNS lookups when
32491 routing email addresses, but it does apply to &"byname"& lookups.
32492 .next
32493 .cindex "log" "ident timeout"
32494 .cindex "RFC 1413" "logging timeout"
32495 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
32496 client's ident port times out.
32497 .next
32498 .cindex "log" "incoming interface"
32499 .cindex "interface" "logging"
32500 &%incoming_interface%&: The interface on which a message was received is added
32501 to the &"<="& line as an IP address in square brackets, tagged by I= and
32502 followed by a colon and the port number. The local interface and port are also
32503 added to other SMTP log lines, for example &"SMTP connection from"&, and to
32504 rejection lines.
32505 .next
32506 .cindex "log" "incoming remote port"
32507 .cindex "port" "logging remote"
32508 .cindex "TCP/IP" "logging incoming remote port"
32509 .vindex "&$sender_fullhost$&"
32510 .vindex "&$sender_rcvhost$&"
32511 &%incoming_port%&: The remote port number from which a message was received is
32512 added to log entries and &'Received:'& header lines, following the IP address
32513 in square brackets, and separated from it by a colon. This is implemented by
32514 changing the value that is put in the &$sender_fullhost$& and
32515 &$sender_rcvhost$& variables. Recording the remote port number has become more
32516 important with the widening use of NAT (see RFC 2505).
32517 .next
32518 .cindex "log" "dropped connection"
32519 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
32520 connection is unexpectedly dropped.
32521 .next
32522 .cindex "log" "outgoing remote port"
32523 .cindex "port" "logging outgoint remote"
32524 .cindex "TCP/IP" "logging ougtoing remote port"
32525 &%outgoing_port%&: The remote port number is added to delivery log lines (those
32526 containing => tags) following the IP address. This option is not included in
32527 the default setting, because for most ordinary configurations, the remote port
32528 number is always 25 (the SMTP port).
32529 .next
32530 .cindex "log" "process ids in"
32531 .cindex "pid (process id)" "in log lines"
32532 &%pid%&: The current process id is added to every log line, in square brackets,
32533 immediately after the time and date.
32534 .next
32535 .cindex "log" "queue run"
32536 .cindex "queue runner" "logging"
32537 &%queue_run%&: The start and end of every queue run are logged.
32538 .next
32539 .cindex "log" "queue time"
32540 &%queue_time%&: The amount of time the message has been in the queue on the
32541 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
32542 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
32543 includes reception time as well as the delivery time for the current address.
32544 This means that it may be longer than the difference between the arrival and
32545 delivery log line times, because the arrival log line is not written until the
32546 message has been successfully received.
32547 .next
32548 &%queue_time_overall%&: The amount of time the message has been in the queue on
32549 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
32550 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
32551 message, so it includes reception time as well as the total delivery time.
32552 .next
32553 .cindex "log" "recipients"
32554 &%received_recipients%&: The recipients of a message are listed in the main log
32555 as soon as the message is received. The list appears at the end of the log line
32556 that is written when a message is received, preceded by the word &"for"&. The
32557 addresses are listed after they have been qualified, but before any rewriting
32558 has taken place.
32559 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
32560 in the list.
32561 .next
32562 .cindex "log" "sender reception"
32563 &%received_sender%&: The unrewritten original sender of a message is added to
32564 the end of the log line that records the message's arrival, after the word
32565 &"from"& (before the recipients if &%received_recipients%& is also set).
32566 .next
32567 .cindex "log" "header lines for rejection"
32568 &%rejected_header%&: If a message's header has been received at the time a
32569 rejection is written to the reject log, the complete header is added to the
32570 log. Header logging can be turned off individually for messages that are
32571 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
32572 .next
32573 .cindex "log" "retry defer"
32574 &%retry_defer%&: A log line is written if a delivery is deferred because a
32575 retry time has not yet been reached. However, this &"retry time not reached"&
32576 message is always omitted from individual message logs after the first delivery
32577 attempt.
32578 .next
32579 .cindex "log" "return path"
32580 &%return_path_on_delivery%&: The return path that is being transmitted with
32581 the message is included in delivery and bounce lines, using the tag P=.
32582 This is omitted if no delivery actually happens, for example, if routing fails,
32583 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
32584 .next
32585 .cindex "log" "sender on delivery"
32586 &%sender_on_delivery%&: The message's sender address is added to every delivery
32587 and bounce line, tagged by F= (for &"from"&).
32588 This is the original sender that was received with the message; it is not
32589 necessarily the same as the outgoing return path.
32590 .next
32591 .cindex "log" "sender verify failure"
32592 &%sender_verify_fail%&: If this selector is unset, the separate log line that
32593 gives details of a sender verification failure is not written. Log lines for
32594 the rejection of SMTP commands contain just &"sender verify failed"&, so some
32595 detail is lost.
32596 .next
32597 .cindex "log" "size rejection"
32598 &%size_reject%&: A log line is written whenever a message is rejected because
32599 it is too big.
32600 .next
32601 .cindex "log" "frozen messages; skipped"
32602 .cindex "frozen messages" "logging skipping"
32603 &%skip_delivery%&: A log line is written whenever a message is skipped during a
32604 queue run because it is frozen or because another process is already delivering
32605 it.
32606 .cindex "&""spool file is locked""&"
32607 The message that is written is &"spool file is locked"&.
32608 .next
32609 .cindex "log" "smtp confirmation"
32610 .cindex "SMTP" "logging confirmation"
32611 &%smtp_confirmation%&: The response to the final &"."& in the SMTP dialogue for
32612 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
32613 A number of MTAs (including Exim) return an identifying string in this
32614 response.
32615 .next
32616 .cindex "log" "SMTP connections"
32617 .cindex "SMTP" "logging connections"
32618 &%smtp_connection%&: A log line is written whenever an SMTP connection is
32619 established or closed, unless the connection is from a host that matches
32620 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
32621 only when the closure is unexpected.) This applies to connections from local
32622 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
32623 dropped in the middle of a message, a log line is always written, whether or
32624 not this selector is set, but otherwise nothing is written at the start and end
32625 of connections unless this selector is enabled.
32626
32627 For TCP/IP connections to an Exim daemon, the current number of connections is
32628 included in the log message for each new connection, but note that the count is
32629 reset if the daemon is restarted.
32630 Also, because connections are closed (and the closure is logged) in
32631 subprocesses, the count may not include connections that have been closed but
32632 whose termination the daemon has not yet noticed. Thus, while it is possible to
32633 match up the opening and closing of connections in the log, the value of the
32634 logged counts may not be entirely accurate.
32635 .next
32636 .cindex "log" "SMTP transaction; incomplete"
32637 .cindex "SMTP" "logging incomplete transactions"
32638 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
32639 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
32640 and the message sender plus any accepted recipients are included in the log
32641 line. This can provide evidence of dictionary attacks.
32642 .next
32643 .cindex "log" "non-MAIL SMTP sessions"
32644 .cindex "MAIL" "logging session without"
32645 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
32646 connection terminates without having issued a MAIL command. This includes both
32647 the case when the connection is dropped, and the case when QUIT is used. It
32648 does not include cases where the connection is rejected right at the start (by
32649 an ACL, or because there are too many connections, or whatever). These cases
32650 already have their own log lines.
32651
32652 The log line that is written contains the identity of the client in the usual
32653 way, followed by D= and a time, which records the duration of the connection.
32654 If the connection was authenticated, this fact is logged exactly as it is for
32655 an incoming message, with an A= item. If the connection was encrypted, CV=,
32656 DN=, and X= items may appear as they do for an incoming message, controlled by
32657 the same logging options.
32658
32659 Finally, if any SMTP commands were issued during the connection, a C= item
32660 is added to the line, listing the commands that were used. For example,
32661 .code
32662 C=EHLO,QUIT
32663 .endd
32664 shows that the client issued QUIT straight after EHLO. If there were fewer
32665 than 20 commands, they are all listed. If there were more than 20 commands,
32666 the last 20 are listed, preceded by &"..."&. However, with the default
32667 setting of 10 for &%smtp_accep_max_nonmail%&, the connection will in any case
32668 have been aborted before 20 non-mail commands are processed.
32669 .next
32670 .cindex "log" "SMTP protocol error"
32671 .cindex "SMTP" "logging protocol error"
32672 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
32673 encountered. Exim does not have perfect detection of all protocol errors
32674 because of transmission delays and the use of pipelining. If PIPELINING has
32675 been advertised to a client, an Exim server assumes that the client will use
32676 it, and therefore it does not count &"expected"& errors (for example, RCPT
32677 received after rejecting MAIL) as protocol errors.
32678 .next
32679 .cindex "SMTP" "logging syntax errors"
32680 .cindex "SMTP" "syntax errors; logging"
32681 .cindex "SMTP" "unknown command; logging"
32682 .cindex "log" "unknown SMTP command"
32683 .cindex "log" "SMTP syntax error"
32684 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
32685 encountered. An unrecognized command is treated as a syntax error. For an
32686 external connection, the host identity is given; for an internal connection
32687 using &%-bs%& the sender identification (normally the calling user) is given.
32688 .next
32689 .cindex "log" "subject"
32690 .cindex "subject, logging"
32691 &%subject%&: The subject of the message is added to the arrival log line,
32692 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
32693 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
32694 specifies whether characters with values greater than 127 should be logged
32695 unchanged, or whether they should be rendered as escape sequences.
32696 .next
32697 .cindex "log" "certificate verification"
32698 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
32699 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
32700 verified, and &`CV=no`& if not.
32701 .next
32702 .cindex "log" "TLS cipher"
32703 .cindex "TLS" "logging cipher"
32704 &%tls_cipher%&: When a message is sent or received over an encrypted
32705 connection, the cipher suite used is added to the log line, preceded by X=.
32706 .next
32707 .cindex "log" "TLS peer DN"
32708 .cindex "TLS" "logging peer DN"
32709 &%tls_peerdn%&: When a message is sent or received over an encrypted
32710 connection, and a certificate is supplied by the remote host, the peer DN is
32711 added to the log line, preceded by DN=.
32712 .next
32713 .cindex "log" "DNS failure in list"
32714 &%unknown_in_list%&: This setting causes a log entry to be written when the
32715 result of a list match is failure because a DNS lookup failed.
32716 .endlist
32717
32718
32719 .section "Message log" "SECID260"
32720 .cindex "message" "log file for"
32721 .cindex "log" "message log; description of"
32722 .cindex "&_msglog_& directory"
32723 .oindex "&%preserve_message_logs%&"
32724 In addition to the general log files, Exim writes a log file for each message
32725 that it handles. The names of these per-message logs are the message ids, and
32726 they are kept in the &_msglog_& sub-directory of the spool directory. Each
32727 message log contains copies of the log lines that apply to the message. This
32728 makes it easier to inspect the status of an individual message without having
32729 to search the main log. A message log is deleted when processing of the message
32730 is complete, unless &%preserve_message_logs%& is set, but this should be used
32731 only with great care because they can fill up your disk very quickly.
32732
32733 On a heavily loaded system, it may be desirable to disable the use of
32734 per-message logs, in order to reduce disk I/O. This can be done by setting the
32735 &%message_logs%& option false.
32736 .ecindex IIDloggen
32737
32738
32739
32740
32741 . ////////////////////////////////////////////////////////////////////////////
32742 . ////////////////////////////////////////////////////////////////////////////
32743
32744 .chapter "Exim utilities" "CHAPutils"
32745 .scindex IIDutils "utilities"
32746 A number of utility scripts and programs are supplied with Exim and are
32747 described in this chapter. There is also the Exim Monitor, which is covered in
32748 the next chapter. The utilities described here are:
32749
32750 .itable none 0 0 3  7* left  15* left  40* left
32751 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
32752   "list what Exim processes are doing"
32753 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
32754 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
32755 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
32756 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
32757                                                 various criteria"
32758 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
32759 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
32760   "extract statistics from the log"
32761 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
32762   "check address acceptance from given IP"
32763 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
32764 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
32765 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
32766 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
32767 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
32768 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
32769 .endtable
32770
32771 Another utility that might be of use to sites with many MTAs is Tom Kistner's
32772 &'exilog'&. It provides log visualizations across multiple Exim servers. See
32773 &url(http://duncanthrax.net/exilog/) for details.
32774
32775
32776
32777
32778 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
32779 .cindex "&'exiwhat'&"
32780 .cindex "process, querying"
32781 .cindex "SIGUSR1"
32782 On operating systems that can restart a system call after receiving a signal
32783 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
32784 a line describing what it is doing to the file &_exim-process.info_& in the
32785 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
32786 processes it can find, having first emptied the file. It then waits for one
32787 second to allow the Exim processes to react before displaying the results. In
32788 order to run &'exiwhat'& successfully you have to have sufficient privilege to
32789 send the signal to the Exim processes, so it is normally run as root.
32790
32791 &*Warning*&: This is not an efficient process. It is intended for occasional
32792 use by system administrators. It is not sensible, for example, to set up a
32793 script that sends SIGUSR1 signals to Exim processes at short intervals.
32794
32795
32796 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
32797 varies in different operating systems. Not only are different options used,
32798 but the format of the output is different. For this reason, there are some
32799 system configuration options that configure exactly how &'exiwhat'& works. If
32800 it doesn't seem to be working for you, check the following compile-time
32801 options:
32802 .display
32803 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
32804 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
32805 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
32806 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
32807 .endd
32808 An example of typical output from &'exiwhat'& is
32809 .code
32810 164 daemon: -q1h, listening on port 25
32811 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
32812 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
32813   [10.19.42.42] (editor@ref.example)
32814 10592 handling incoming call from [192.168.243.242]
32815 10628 accepting a local non-SMTP message
32816 .endd
32817 The first number in the output line is the process number. The third line has
32818 been split here, in order to fit it on the page.
32819
32820
32821
32822 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
32823 .cindex "&'exiqgrep'&"
32824 .cindex "queue" "grepping"
32825 This utility is a Perl script contributed by Matt Hubbard. It runs
32826 .code
32827 exim -bpu
32828 .endd
32829 to obtain a queue listing with undelivered recipients only, and then greps the
32830 output to select messages that match given criteria. The following selection
32831 options are available:
32832
32833 .vlist
32834 .vitem &*-f*&&~<&'regex'&>
32835 Match the sender address. The field that is tested is enclosed in angle
32836 brackets, so you can test for bounce messages with
32837 .code
32838 exiqgrep -f '^<>$'
32839 .endd
32840 .vitem &*-r*&&~<&'regex'&>
32841 Match a recipient address. The field that is tested is not enclosed in angle
32842 brackets.
32843
32844 .vitem &*-s*&&~<&'regex'&>
32845 Match against the size field.
32846
32847 .vitem &*-y*&&~<&'seconds'&>
32848 Match messages that are younger than the given time.
32849
32850 .vitem &*-o*&&~<&'seconds'&>
32851 Match messages that are older than the given time.
32852
32853 .vitem &*-z*&
32854 Match only frozen messages.
32855
32856 .vitem &*-x*&
32857 Match only non-frozen messages.
32858 .endlist
32859
32860 The following options control the format of the output:
32861
32862 .vlist
32863 .vitem &*-c*&
32864 Display only the count of matching messages.
32865
32866 .vitem &*-l*&
32867 Long format &-- display the full message information as output by Exim. This is
32868 the default.
32869
32870 .vitem &*-i*&
32871 Display message ids only.
32872
32873 .vitem &*-b*&
32874 Brief format &-- one line per message.
32875
32876 .vitem &*-R*&
32877 Display messages in reverse order.
32878 .endlist
32879
32880 There is one more option, &%-h%&, which outputs a list of options.
32881
32882
32883
32884 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
32885 .cindex "&'exiqsumm'&"
32886 .cindex "queue" "summary"
32887 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
32888 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
32889 running a command such as
32890 .code
32891 exim -bp | exiqsumm
32892 .endd
32893 The output consists of one line for each domain that has messages waiting for
32894 it, as in the following example:
32895 .code
32896 3   2322   74m   66m  msn.com.example
32897 .endd
32898 Each line lists the number of pending deliveries for a domain, their total
32899 volume, and the length of time that the oldest and the newest messages have
32900 been waiting. Note that the number of pending deliveries is greater than the
32901 number of messages when messages have more than one recipient.
32902
32903 A summary line is output at the end. By default the output is sorted on the
32904 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
32905 the output to be sorted by oldest message and by count of messages,
32906 respectively. There are also three options that split the messages for each
32907 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
32908 separates frozen messages, and &%-s%& separates messages according to their
32909 sender.
32910
32911 The output of &'exim -bp'& contains the original addresses in the message, so
32912 this also applies to the output from &'exiqsumm'&. No domains from addresses
32913 generated by aliasing or forwarding are included (unless the &%one_time%&
32914 option of the &(redirect)& router has been used to convert them into &"top
32915 level"& addresses).
32916
32917
32918
32919
32920 .section "Extracting specific information from the log (exigrep)" &&&
32921          "SECTextspeinf"
32922 .cindex "&'exigrep'&"
32923 .cindex "log" "extracts; grepping for"
32924 The &'exigrep'& utility is a Perl script that searches one or more main log
32925 files for entries that match a given pattern. When it finds a match, it
32926 extracts all the log entries for the relevant message, not just those that
32927 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
32928 given message, or all mail for a given user, or for a given host, for example.
32929 The input files can be in Exim log format or syslog format.
32930 If a matching log line is not associated with a specific message, it is
32931 included in &'exigrep'&'s output without any additional lines. The usage is:
32932 .display
32933 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
32934 .endd
32935 If no log file names are given on the command line, the standard input is read.
32936
32937 The &%-t%& argument specifies a number of seconds. It adds an additional
32938 condition for message selection. Messages that are complete are shown only if
32939 they spent more than <&'n'&> seconds on the queue.
32940
32941 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
32942 makes it case-sensitive. This may give a performance improvement when searching
32943 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
32944 option; with &%-I%& they do not. In both cases it is possible to change the
32945 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
32946
32947 The &%-l%& option means &"literal"&, that is, treat all characters in the
32948 pattern as standing for themselves. Otherwise the pattern must be a Perl
32949 regular expression.
32950
32951 The &%-v%& option inverts the matching condition. That is, a line is selected
32952 if it does &'not'& match the pattern.
32953
32954 If the location of a &'zcat'& command is known from the definition of
32955 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
32956 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
32957
32958
32959 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
32960 .cindex "&'exipick'&"
32961 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
32962 lists messages from the queue according to a variety of criteria. For details
32963 of &'exipick'&'s facilities, visit the web page at
32964 &url(http://www.exim.org/eximwiki/ToolExipickManPage) or run &'exipick'& with
32965 the &%--help%& option.
32966
32967
32968 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
32969 .cindex "log" "cycling local files"
32970 .cindex "cycling logs"
32971 .cindex "&'exicyclog'&"
32972 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
32973 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
32974 you are using log files with datestamps in their names (see section
32975 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
32976 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
32977 There are two command line options for &'exicyclog'&:
32978 .ilist
32979 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
32980 default that is set when Exim is built. The default default is 10.
32981 .next
32982 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
32983 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
32984 overriding the script's default, which is to find the setting from Exim's
32985 configuration.
32986 .endlist
32987
32988 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
32989 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
32990 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
32991 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
32992 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
32993 logs are handled similarly.
32994
32995 If the limit is greater than 99, the script uses 3-digit numbers such as
32996 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
32997 to one that is greater, or &'vice versa'&, you will have to fix the names of
32998 any existing log files.
32999
33000 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
33001 the end are deleted. All files with numbers greater than 01 are compressed,
33002 using a compression command which is configured by the COMPRESS_COMMAND
33003 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
33004 root &%crontab%& entry of the form
33005 .code
33006 1 0 * * * su exim -c /usr/exim/bin/exicyclog
33007 .endd
33008 assuming you have used the name &"exim"& for the Exim user. You can run
33009 &'exicyclog'& as root if you wish, but there is no need.
33010
33011
33012
33013 .section "Mail statistics (eximstats)" "SECTmailstat"
33014 .cindex "statistics"
33015 .cindex "&'eximstats'&"
33016 A Perl script called &'eximstats'& is provided for extracting statistical
33017 information from log files. The output is either plain text, or HTML.
33018 Exim log files are also supported by the &'Lire'& system produced by the
33019 LogReport Foundation &url(http://www.logreport.org).
33020
33021 The &'eximstats'& script has been hacked about quite a bit over time. The
33022 latest version is the result of some extensive revision by Steve Campbell. A
33023 lot of information is given by default, but there are options for suppressing
33024 various parts of it. Following any options, the arguments to the script are a
33025 list of files, which should be main log files. For example:
33026 .code
33027 eximstats -nr /var/spool/exim/log/mainlog.01
33028 .endd
33029 By default, &'eximstats'& extracts information about the number and volume of
33030 messages received from or delivered to various hosts. The information is sorted
33031 both by message count and by volume, and the top fifty hosts in each category
33032 are listed on the standard output. Similar information, based on email
33033 addresses or domains instead of hosts can be requested by means of various
33034 options. For messages delivered and received locally, similar statistics are
33035 also produced per user.
33036
33037 The output also includes total counts and statistics about delivery errors, and
33038 histograms showing the number of messages received and deliveries made in each
33039 hour of the day. A delivery with more than one address in its envelope (for
33040 example, an SMTP transaction with more than one RCPT command) is counted
33041 as a single delivery by &'eximstats'&.
33042
33043 Though normally more deliveries than receipts are reported (as messages may
33044 have multiple recipients), it is possible for &'eximstats'& to report more
33045 messages received than delivered, even though the queue is empty at the start
33046 and end of the period in question. If an incoming message contains no valid
33047 recipients, no deliveries are recorded for it. A bounce message is handled as
33048 an entirely separate message.
33049
33050 &'eximstats'& always outputs a grand total summary giving the volume and number
33051 of messages received and deliveries made, and the number of hosts involved in
33052 each case. It also outputs the number of messages that were delayed (that is,
33053 not completely delivered at the first attempt), and the number that had at
33054 least one address that failed.
33055
33056 The remainder of the output is in sections that can be independently disabled
33057 or modified by various options. It consists of a summary of deliveries by
33058 transport, histograms of messages received and delivered per time interval
33059 (default per hour), information about the time messages spent on the queue,
33060 a list of relayed messages, lists of the top fifty sending hosts, local
33061 senders, destination hosts, and destination local users by count and by volume,
33062 and a list of delivery errors that occurred.
33063
33064 The relay information lists messages that were actually relayed, that is, they
33065 came from a remote host and were directly delivered to some other remote host,
33066 without being processed (for example, for aliasing or forwarding) locally.
33067
33068 There are quite a few options for &'eximstats'& to control exactly what it
33069 outputs. These are documented in the Perl script itself, and can be extracted
33070 by running the command &(perldoc)& on the script. For example:
33071 .code
33072 perldoc /usr/exim/bin/eximstats
33073 .endd
33074
33075 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
33076 .cindex "&'exim_checkaccess'&"
33077 .cindex "policy control" "checking access"
33078 .cindex "checking access"
33079 The &%-bh%& command line argument allows you to run a fake SMTP session with
33080 debugging output, in order to check what Exim is doing when it is applying
33081 policy controls to incoming SMTP mail. However, not everybody is sufficiently
33082 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
33083 sometimes you just want to answer the question &"Does this address have
33084 access?"& without bothering with any further details.
33085
33086 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
33087 two arguments, an IP address and an email address:
33088 .code
33089 exim_checkaccess 10.9.8.7 A.User@a.domain.example
33090 .endd
33091 The utility runs a call to Exim with the &%-bh%& option, to test whether the
33092 given email address would be accepted in a RCPT command in a TCP/IP
33093 connection from the host with the given IP address. The output of the utility
33094 is either the word &"accepted"&, or the SMTP error response, for example:
33095 .code
33096 Rejected:
33097 550 Relay not permitted
33098 .endd
33099 When running this test, the utility uses &`<>`& as the envelope sender address
33100 for the MAIL command, but you can change this by providing additional
33101 options. These are passed directly to the Exim command. For example, to specify
33102 that the test is to be run with the sender address &'himself@there.example'&
33103 you can use:
33104 .code
33105 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
33106                  -f himself@there.example
33107 .endd
33108 Note that these additional Exim command line items must be given after the two
33109 mandatory arguments.
33110
33111 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
33112 while running its checks. You can run checks that include callouts by using
33113 &%-bhc%&, but this is not yet available in a &"packaged"& form.
33114
33115
33116
33117 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
33118 .cindex "DBM" "building dbm files"
33119 .cindex "building DBM files"
33120 .cindex "&'exim_dbmbuild'&"
33121 .cindex "lower casing"
33122 .cindex "binary zero" "in lookup key"
33123 The &'exim_dbmbuild'& program reads an input file containing keys and data in
33124 the format used by the &(lsearch)& lookup (see section
33125 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
33126 names as keys and the remainder of the information as data. The lower-casing
33127 can be prevented by calling the program with the &%-nolc%& option.
33128
33129 A terminating zero is included as part of the key string. This is expected by
33130 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
33131 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
33132 strings or the data strings. The &(dbmnz)& lookup type can be used with such
33133 files.
33134
33135 The program requires two arguments: the name of the input file (which can be a
33136 single hyphen to indicate the standard input), and the name of the output file.
33137 It creates the output under a temporary name, and then renames it if all went
33138 well.
33139
33140 .cindex "USE_DB"
33141 If the native DB interface is in use (USE_DB is set in a compile-time
33142 configuration file &-- this is common in free versions of Unix) the two file
33143 names must be different, because in this mode the Berkeley DB functions create
33144 a single output file using exactly the name given. For example,
33145 .code
33146 exim_dbmbuild /etc/aliases /etc/aliases.db
33147 .endd
33148 reads the system alias file and creates a DBM version of it in
33149 &_/etc/aliases.db_&.
33150
33151 In systems that use the &'ndbm'& routines (mostly proprietary versions of
33152 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
33153 environment, the suffixes are added to the second argument of
33154 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
33155 when the Berkeley functions are used in compatibility mode (though this is not
33156 recommended), because in that case it adds a &_.db_& suffix to the file name.
33157
33158 If a duplicate key is encountered, the program outputs a warning, and when it
33159 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
33160 option is used. By default, only the first of a set of duplicates is used &--
33161 this makes it compatible with &(lsearch)& lookups. There is an option
33162 &%-lastdup%& which causes it to use the data for the last duplicate instead.
33163 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
33164 &%stderr%&. For other errors, where it doesn't actually make a new file, the
33165 return code is 2.
33166
33167
33168
33169
33170 .section "Finding individual retry times (exinext)" "SECTfinindret"
33171 .cindex "retry" "times"
33172 .cindex "&'exinext'&"
33173 A utility called &'exinext'& (mostly a Perl script) provides the ability to
33174 fish specific information out of the retry database. Given a mail domain (or a
33175 complete address), it looks up the hosts for that domain, and outputs any retry
33176 information for the hosts or for the domain. At present, the retry information
33177 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
33178 output. For example:
33179 .code
33180 $ exinext piglet@milne.fict.example
33181 kanga.milne.example:192.168.8.1 error 146: Connection refused
33182   first failed: 21-Feb-1996 14:57:34
33183   last tried:   21-Feb-1996 14:57:34
33184   next try at:  21-Feb-1996 15:02:34
33185 roo.milne.example:192.168.8.3 error 146: Connection refused
33186   first failed: 20-Jan-1996 13:12:08
33187   last tried:   21-Feb-1996 11:42:03
33188   next try at:  21-Feb-1996 19:42:03
33189   past final cutoff time
33190 .endd
33191 You can also give &'exinext'& a local part, without a domain, and it
33192 will give any retry information for that local part in your default domain.
33193 A message id can be used to obtain retry information pertaining to a specific
33194 message. This exists only when an attempt to deliver a message to a remote host
33195 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
33196 &'exinext'& is not particularly efficient, but then it is not expected to be
33197 run very often.
33198
33199 The &'exinext'& utility calls Exim to find out information such as the location
33200 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
33201 passed on to the &'exim'& commands. The first specifies an alternate Exim
33202 configuration file, and the second sets macros for use within the configuration
33203 file. These features are mainly to help in testing, but might also be useful in
33204 environments where more than one configuration file is in use.
33205
33206
33207
33208 .section "Hints database maintenance" "SECThindatmai"
33209 .cindex "hints database" "maintenance"
33210 .cindex "maintaining Exim's hints database"
33211 Three utility programs are provided for maintaining the DBM files that Exim
33212 uses to contain its delivery hint information. Each program requires two
33213 arguments. The first specifies the name of Exim's spool directory, and the
33214 second is the name of the database it is to operate on. These are as follows:
33215
33216 .ilist
33217 &'retry'&: the database of retry information
33218 .next
33219 &'wait-'&<&'transport name'&>: databases of information about messages waiting
33220 for remote hosts
33221 .next
33222 &'callout'&: the callout cache
33223 .next
33224 &'ratelimit'&: the data for implementing the ratelimit ACL condition
33225 .next
33226 &'misc'&: other hints data
33227 .endlist
33228
33229 The &'misc'& database is used for
33230
33231 .ilist
33232 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
33233 .next
33234 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
33235 &(smtp)& transport)
33236 .endlist
33237
33238
33239
33240 .section "exim_dumpdb" "SECID261"
33241 .cindex "&'exim_dumpdb'&"
33242 The entire contents of a database are written to the standard output by the
33243 &'exim_dumpdb'& program, which has no options or arguments other than the
33244 spool and database names. For example, to dump the retry database:
33245 .code
33246 exim_dumpdb /var/spool/exim retry
33247 .endd
33248 Two lines of output are produced for each entry:
33249 .code
33250 T:mail.ref.example:192.168.242.242 146 77 Connection refused
33251 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
33252 .endd
33253 The first item on the first line is the key of the record. It starts with one
33254 of the letters R, or T, depending on whether it refers to a routing or
33255 transport retry. For a local delivery, the next part is the local address; for
33256 a remote delivery it is the name of the remote host, followed by its failing IP
33257 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
33258 transport). If the remote port is not the standard one (port 25), it is added
33259 to the IP address. Then there follows an error code, an additional error code,
33260 and a textual description of the error.
33261
33262 The three times on the second line are the time of first failure, the time of
33263 the last delivery attempt, and the computed time for the next attempt. The line
33264 ends with an asterisk if the cutoff time for the last retry rule has been
33265 exceeded.
33266
33267 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
33268 consists of a host name followed by a list of ids for messages that are or were
33269 waiting to be delivered to that host. If there are a very large number for any
33270 one host, continuation records, with a sequence number added to the host name,
33271 may be seen. The data in these records is often out of date, because a message
33272 may be routed to several alternative hosts, and Exim makes no effort to keep
33273 cross-references.
33274
33275
33276
33277 .section "exim_tidydb" "SECID262"
33278 .cindex "&'exim_tidydb'&"
33279 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
33280 database. If run with no options, it removes all records that are more than 30
33281 days old. The age is calculated from the date and time that the record was last
33282 updated. Note that, in the case of the retry database, it is &'not'& the time
33283 since the first delivery failure. Information about a host that has been down
33284 for more than 30 days will remain in the database, provided that the record is
33285 updated sufficiently often.
33286
33287 The cutoff date can be altered by means of the &%-t%& option, which must be
33288 followed by a time. For example, to remove all records older than a week from
33289 the retry database:
33290 .code
33291 exim_tidydb -t 7d /var/spool/exim retry
33292 .endd
33293 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
33294 message ids. In the former these appear as data in records keyed by host &--
33295 they were messages that were waiting for that host &-- and in the latter they
33296 are the keys for retry information for messages that have suffered certain
33297 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
33298 message ids in database records are those of messages that are still on the
33299 queue. Message ids for messages that no longer exist are removed from
33300 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
33301 For the &'retry'& database, records whose keys are non-existent message ids are
33302 removed. The &'exim_tidydb'& utility outputs comments on the standard output
33303 whenever it removes information from the database.
33304
33305 Certain records are automatically removed by Exim when they are no longer
33306 needed, but others are not. For example, if all the MX hosts for a domain are
33307 down, a retry record is created for each one. If the primary MX host comes back
33308 first, its record is removed when Exim successfully delivers to it, but the
33309 records for the others remain because Exim has not tried to use those hosts.
33310
33311 It is important, therefore, to run &'exim_tidydb'& periodically on all the
33312 hints databases. You should do this at a quiet time of day, because it requires
33313 a database to be locked (and therefore inaccessible to Exim) while it does its
33314 work. Removing records from a DBM file does not normally make the file smaller,
33315 but all the common DBM libraries are able to re-use the space that is released.
33316 After an initial phase of increasing in size, the databases normally reach a
33317 point at which they no longer get any bigger, as long as they are regularly
33318 tidied.
33319
33320 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
33321 databases is likely to keep on increasing.
33322
33323
33324
33325
33326 .section "exim_fixdb" "SECID263"
33327 .cindex "&'exim_fixdb'&"
33328 The &'exim_fixdb'& program is a utility for interactively modifying databases.
33329 Its main use is for testing Exim, but it might also be occasionally useful for
33330 getting round problems in a live system. It has no options, and its interface
33331 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
33332 key of a database record can then be entered, and the data for that record is
33333 displayed.
33334
33335 If &"d"& is typed at the next prompt, the entire record is deleted. For all
33336 except the &'retry'& database, that is the only operation that can be carried
33337 out. For the &'retry'& database, each field is output preceded by a number, and
33338 data for individual fields can be changed by typing the field number followed
33339 by new data, for example:
33340 .code
33341 > 4 951102:1000
33342 .endd
33343 resets the time of the next delivery attempt. Time values are given as a
33344 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
33345 used as optional separators.
33346
33347
33348
33349
33350 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
33351 .cindex "mailbox" "maintenance"
33352 .cindex "&'exim_lock'&"
33353 .cindex "locking mailboxes"
33354 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
33355 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
33356 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
33357 a user agent while investigating a problem. The utility requires the name of
33358 the file as its first argument. If the locking is successful, the second
33359 argument is run as a command (using C's &[system()]& function); if there is no
33360 second argument, the value of the SHELL environment variable is used; if this
33361 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
33362 is unlocked and the utility ends. The following options are available:
33363
33364 .vlist
33365 .vitem &%-fcntl%&
33366 Use &[fcntl()]& locking on the open mailbox.
33367
33368 .vitem &%-flock%&
33369 Use &[flock()]& locking on the open mailbox, provided the operating system
33370 supports it.
33371
33372 .vitem &%-interval%&
33373 This must be followed by a number, which is a number of seconds; it sets the
33374 interval to sleep between retries (default 3).
33375
33376 .vitem &%-lockfile%&
33377 Create a lock file before opening the mailbox.
33378
33379 .vitem &%-mbx%&
33380 Lock the mailbox using MBX rules.
33381
33382 .vitem &%-q%&
33383 Suppress verification output.
33384
33385 .vitem &%-retries%&
33386 This must be followed by a number; it sets the number of times to try to get
33387 the lock (default 10).
33388
33389 .vitem &%-restore_time%&
33390 This option causes &%exim_lock%& to restore the modified and read times to the
33391 locked file before exiting. This allows you to access a locked mailbox (for
33392 example, to take a backup copy) without disturbing the times that the user
33393 subsequently sees.
33394
33395 .vitem &%-timeout%&
33396 This must be followed by a number, which is a number of seconds; it sets a
33397 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
33398 default), a non-blocking call is used.
33399
33400 .vitem &%-v%&
33401 Generate verbose output.
33402 .endlist
33403
33404 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
33405 default is to create a lock file and also to use &[fcntl()]& locking on the
33406 mailbox, which is the same as Exim's default. The use of &%-flock%& or
33407 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
33408 requires that the directory containing the file be writeable. Locking by lock
33409 file does not last for ever; Exim assumes that a lock file is expired if it is
33410 more than 30 minutes old.
33411
33412 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
33413 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
33414 to be taken out on the open mailbox, and an exclusive lock on the file
33415 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
33416 number of the mailbox file. When the locking is released, if an exclusive lock
33417 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
33418
33419 The default output contains verification of the locking that takes place. The
33420 &%-v%& option causes some additional information to be given. The &%-q%& option
33421 suppresses all output except error messages.
33422
33423 A command such as
33424 .code
33425 exim_lock /var/spool/mail/spqr
33426 .endd
33427 runs an interactive shell while the file is locked, whereas
33428 .display
33429 &`exim_lock -q /var/spool/mail/spqr <<End`&
33430 <&'some commands'&>
33431 &`End`&
33432 .endd
33433 runs a specific non-interactive sequence of commands while the file is locked,
33434 suppressing all verification output. A single command can be run by a command
33435 such as
33436 .code
33437 exim_lock -q /var/spool/mail/spqr \
33438   "cp /var/spool/mail/spqr /some/where"
33439 .endd
33440 Note that if a command is supplied, it must be entirely contained within the
33441 second argument &-- hence the quotes.
33442 .ecindex IIDutils
33443
33444
33445 . ////////////////////////////////////////////////////////////////////////////
33446 . ////////////////////////////////////////////////////////////////////////////
33447
33448 .chapter "The Exim monitor" "CHAPeximon"
33449 .scindex IIDeximon "Exim monitor" "description"
33450 .cindex "X-windows"
33451 .cindex "&'eximon'&"
33452 .cindex "Local/eximon.conf"
33453 .cindex "&_exim_monitor/EDITME_&"
33454 The Exim monitor is an application which displays in an X window information
33455 about the state of Exim's queue and what Exim is doing. An admin user can
33456 perform certain operations on messages from this GUI interface; however all
33457 such facilities are also available from the command line, and indeed, the
33458 monitor itself makes use of the command line to perform any actions requested.
33459
33460
33461
33462 .section "Running the monitor" "SECID264"
33463 The monitor is started by running the script called &'eximon'&. This is a shell
33464 script that sets up a number of environment variables, and then runs the
33465 binary called &_eximon.bin_&. The default appearance of the monitor window can
33466 be changed by editing the &_Local/eximon.conf_& file created by editing
33467 &_exim_monitor/EDITME_&. Comments in that file describe what the various
33468 parameters are for.
33469
33470 The parameters that get built into the &'eximon'& script can be overridden for
33471 a particular invocation by setting up environment variables of the same names,
33472 preceded by &`EXIMON_`&. For example, a shell command such as
33473 .code
33474 EXIMON_LOG_DEPTH=400 eximon
33475 .endd
33476 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
33477 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
33478 overrides the Exim log file configuration. This makes it possible to have
33479 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
33480 syslog messages are routed to a file on the local host.
33481
33482 X resources can be used to change the appearance of the window in the normal
33483 way. For example, a resource setting of the form
33484 .code
33485 Eximon*background: gray94
33486 .endd
33487 changes the colour of the background to light grey rather than white. The
33488 stripcharts are drawn with both the data lines and the reference lines in
33489 black. This means that the reference lines are not visible when on top of the
33490 data. However, their colour can be changed by setting a resource called
33491 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
33492 For example, if your X server is running Unix, you could set up lighter
33493 reference lines in the stripcharts by obeying
33494 .code
33495 xrdb -merge <<End
33496 Eximon*highlight: gray
33497 End
33498 .endd
33499 .cindex "admin user"
33500 In order to see the contents of messages on the queue, and to operate on them,
33501 &'eximon'& must either be run as root or by an admin user.
33502
33503 The monitor's window is divided into three parts. The first contains one or
33504 more stripcharts and two action buttons, the second contains a &"tail"& of the
33505 main log file, and the third is a display of the queue of messages awaiting
33506 delivery, with two more action buttons. The following sections describe these
33507 different parts of the display.
33508
33509
33510
33511
33512 .section "The stripcharts" "SECID265"
33513 .cindex "stripchart"
33514 The first stripchart is always a count of messages on the queue. Its name can
33515 be configured by setting QUEUE_STRIPCHART_NAME in the
33516 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
33517 configuration script by regular expression matches on log file entries, making
33518 it possible to display, for example, counts of messages delivered to certain
33519 hosts or using certain transports. The supplied defaults display counts of
33520 received and delivered messages, and of local and SMTP deliveries. The default
33521 period between stripchart updates is one minute; this can be adjusted by a
33522 parameter in the &_Local/eximon.conf_& file.
33523
33524 The stripchart displays rescale themselves automatically as the value they are
33525 displaying changes. There are always 10 horizontal lines in each chart; the
33526 title string indicates the value of each division when it is greater than one.
33527 For example, &"x2"& means that each division represents a value of 2.
33528
33529 It is also possible to have a stripchart which shows the percentage fullness of
33530 a particular disk partition, which is useful when local deliveries are confined
33531 to a single partition.
33532
33533 .cindex "&%statvfs%& function"
33534 This relies on the availability of the &[statvfs()]& function or equivalent in
33535 the operating system. Most, but not all versions of Unix that support Exim have
33536 this. For this particular stripchart, the top of the chart always represents
33537 100%, and the scale is given as &"x10%"&. This chart is configured by setting
33538 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
33539 &_Local/eximon.conf_& file.
33540
33541
33542
33543
33544 .section "Main action buttons" "SECID266"
33545 .cindex "size" "of monitor window"
33546 .cindex "Exim monitor" "window size"
33547 .cindex "window size"
33548 Below the stripcharts there is an action button for quitting the monitor. Next
33549 to this is another button marked &"Size"&. They are placed here so that
33550 shrinking the window to its default minimum size leaves just the queue count
33551 stripchart and these two buttons visible. Pressing the &"Size"& button causes
33552 the window to expand to its maximum size, unless it is already at the maximum,
33553 in which case it is reduced to its minimum.
33554
33555 When expanding to the maximum, if the window cannot be fully seen where it
33556 currently is, it is moved back to where it was the last time it was at full
33557 size. When it is expanding from its minimum size, the old position is
33558 remembered, and next time it is reduced to the minimum it is moved back there.
33559
33560 The idea is that you can keep a reduced window just showing one or two
33561 stripcharts at a convenient place on your screen, easily expand it to show
33562 the full window when required, and just as easily put it back to what it was.
33563 The idea is copied from what the &'twm'& window manager does for its
33564 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
33565 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
33566
33567 Normally, the monitor starts up with the window at its full size, but it can be
33568 built so that it starts up with the window at its smallest size, by setting
33569 START_SMALL=yes in &_Local/eximon.conf_&.
33570
33571
33572
33573 .section "The log display" "SECID267"
33574 .cindex "log" "tail of; in monitor"
33575 The second section of the window is an area in which a display of the tail of
33576 the main log is maintained.
33577 To save space on the screen, the timestamp on each log line is shortened by
33578 removing the date and, if &%log_timezone%& is set, the timezone.
33579 The log tail is not available when the only destination for logging data is
33580 syslog, unless the syslog lines are routed to a local file whose name is passed
33581 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
33582
33583 The log sub-window has a scroll bar at its lefthand side which can be used to
33584 move back to look at earlier text, and the up and down arrow keys also have a
33585 scrolling effect. The amount of log that is kept depends on the setting of
33586 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
33587 to use. When this is full, the earlier 50% of data is discarded &-- this is
33588 much more efficient than throwing it away line by line. The sub-window also has
33589 a horizontal scroll bar for accessing the ends of long log lines. This is the
33590 only means of horizontal scrolling; the right and left arrow keys are not
33591 available. Text can be cut from this part of the window using the mouse in the
33592 normal way. The size of this subwindow is controlled by parameters in the
33593 configuration file &_Local/eximon.conf_&.
33594
33595 Searches of the text in the log window can be carried out by means of the ^R
33596 and ^S keystrokes, which default to a reverse and a forward search,
33597 respectively. The search covers only the text that is displayed in the window.
33598 It cannot go further back up the log.
33599
33600 The point from which the search starts is indicated by a caret marker. This is
33601 normally at the end of the text in the window, but can be positioned explicitly
33602 by pointing and clicking with the left mouse button, and is moved automatically
33603 by a successful search. If new text arrives in the window when it is scrolled
33604 back, the caret remains where it is, but if the window is not scrolled back,
33605 the caret is moved to the end of the new text.
33606
33607 Pressing ^R or ^S pops up a window into which the search text can be typed.
33608 There are buttons for selecting forward or reverse searching, for carrying out
33609 the search, and for cancelling. If the &"Search"& button is pressed, the search
33610 happens and the window remains so that further searches can be done. If the
33611 &"Return"& key is pressed, a single search is done and the window is closed. If
33612 ^C is typed the search is cancelled.
33613
33614 The searching facility is implemented using the facilities of the Athena text
33615 widget. By default this pops up a window containing both &"search"& and
33616 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
33617 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
33618 However, the linkers in BSDI and HP-UX seem unable to handle an externally
33619 provided version of &%TextPop%& when the remaining parts of the text widget
33620 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
33621 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
33622 on these systems, at the expense of having unwanted items in the search popup
33623 window.
33624
33625
33626
33627 .section "The queue display" "SECID268"
33628 .cindex "queue" "display in monitor"
33629 The bottom section of the monitor window contains a list of all messages that
33630 are on the queue, which includes those currently being received or delivered,
33631 as well as those awaiting delivery. The size of this subwindow is controlled by
33632 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
33633 at which it is updated is controlled by another parameter in the same file &--
33634 the default is 5 minutes, since queue scans can be quite expensive. However,
33635 there is an &"Update"& action button just above the display which can be used
33636 to force an update of the queue display at any time.
33637
33638 When a host is down for some time, a lot of pending mail can build up for it,
33639 and this can make it hard to deal with other messages on the queue. To help
33640 with this situation there is a button next to &"Update"& called &"Hide"&. If
33641 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
33642 type anything in here and press &"Return"&, the text is added to a chain of
33643 such texts, and if every undelivered address in a message matches at least one
33644 of the texts, the message is not displayed.
33645
33646 If there is an address that does not match any of the texts, all the addresses
33647 are displayed as normal. The matching happens on the ends of addresses so, for
33648 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
33649 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
33650 has been set up, a button called &"Unhide"& is displayed. If pressed, it
33651 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
33652 a hide request is automatically cancelled after one hour.
33653
33654 While the dialogue box is displayed, you can't press any buttons or do anything
33655 else to the monitor window. For this reason, if you want to cut text from the
33656 queue display to use in the dialogue box, you have to do the cutting before
33657 pressing the &"Hide"& button.
33658
33659 The queue display contains, for each unhidden queued message, the length of
33660 time it has been on the queue, the size of the message, the message id, the
33661 message sender, and the first undelivered recipient, all on one line. If it is
33662 a bounce message, the sender is shown as &"<>"&. If there is more than one
33663 recipient to which the message has not yet been delivered, subsequent ones are
33664 listed on additional lines, up to a maximum configured number, following which
33665 an ellipsis is displayed. Recipients that have already received the message are
33666 not shown.
33667
33668 .cindex "frozen messages" "display"
33669 If a message is frozen, an asterisk is displayed at the left-hand side.
33670
33671 The queue display has a vertical scroll bar, and can also be scrolled by means
33672 of the arrow keys. Text can be cut from it using the mouse in the normal way.
33673 The text searching facilities, as described above for the log window, are also
33674 available, but the caret is always moved to the end of the text when the queue
33675 display is updated.
33676
33677
33678
33679 .section "The queue menu" "SECID269"
33680 .cindex "queue" "menu in monitor"
33681 If the &%shift%& key is held down and the left button is clicked when the mouse
33682 pointer is over the text for any message, an action menu pops up, and the first
33683 line of the queue display for the message is highlighted. This does not affect
33684 any selected text.
33685
33686 If you want to use some other event for popping up the menu, you can set the
33687 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
33688 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
33689 value set in this parameter is a standard X event description. For example, to
33690 run eximon using &%ctrl%& rather than &%shift%& you could use
33691 .code
33692 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
33693 .endd
33694 The title of the menu is the message id, and it contains entries which act as
33695 follows:
33696
33697 .ilist
33698 &'message log'&: The contents of the message log for the message are displayed
33699 in a new text window.
33700 .next
33701 &'headers'&: Information from the spool file that contains the envelope
33702 information and headers is displayed in a new text window. See chapter
33703 &<<CHAPspool>>& for a description of the format of spool files.
33704 .next
33705 &'body'&: The contents of the spool file containing the body of the message are
33706 displayed in a new text window. There is a default limit of 20,000 bytes to the
33707 amount of data displayed. This can be changed by setting the BODY_MAX
33708 option at compile time, or the EXIMON_BODY_MAX option at run time.
33709 .next
33710 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
33711 delivery of the message. This causes an automatic thaw if the message is
33712 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
33713 a new text window. The delivery is run in a separate process, to avoid holding
33714 up the monitor while the delivery proceeds.
33715 .next
33716 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
33717 that the message be frozen.
33718 .next
33719 .cindex "thawing messages"
33720 .cindex "unfreezing messages"
33721 .cindex "frozen messages" "thawing"
33722 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
33723 that the message be thawed.
33724 .next
33725 .cindex "delivery" "forcing failure"
33726 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
33727 that Exim gives up trying to deliver the message. A bounce message is generated
33728 for any remaining undelivered addresses.
33729 .next
33730 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
33731 that the message be deleted from the system without generating a bounce
33732 message.
33733 .next
33734 &'add recipient'&: A dialog box is displayed into which a recipient address can
33735 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
33736 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
33737 Otherwise it must be entered as a fully qualified address. Pressing RETURN
33738 causes a call to Exim to be made using the &%-Mar%& option to request that an
33739 additional recipient be added to the message, unless the entry box is empty, in
33740 which case no action is taken.
33741 .next
33742 &'mark delivered'&: A dialog box is displayed into which a recipient address
33743 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
33744 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
33745 Otherwise it must be entered as a fully qualified address. Pressing RETURN
33746 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
33747 recipient address as already delivered, unless the entry box is empty, in which
33748 case no action is taken.
33749 .next
33750 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
33751 mark all recipient addresses as already delivered.
33752 .next
33753 &'edit sender'&: A dialog box is displayed initialized with the current
33754 sender's address. Pressing RETURN causes a call to Exim to be made using the
33755 &%-Mes%& option to replace the sender address, unless the entry box is empty,
33756 in which case no action is taken. If you want to set an empty sender (as in
33757 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
33758 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
33759 the address is qualified with that domain.
33760 .endlist
33761
33762 When a delivery is forced, a window showing the &%-v%& output is displayed. In
33763 other cases when a call to Exim is made, if there is any output from Exim (in
33764 particular, if the command fails) a window containing the command and the
33765 output is displayed. Otherwise, the results of the action are normally apparent
33766 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
33767 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
33768 if no output is generated.
33769
33770 The queue display is automatically updated for actions such as freezing and
33771 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
33772 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
33773 force an update of the display after one of these actions.
33774
33775 In any text window that is displayed as result of a menu action, the normal
33776 cut-and-paste facility is available, and searching can be carried out using ^R
33777 and ^S, as described above for the log tail window.
33778 .ecindex IIDeximon
33779
33780
33781
33782
33783
33784 . ////////////////////////////////////////////////////////////////////////////
33785 . ////////////////////////////////////////////////////////////////////////////
33786
33787 .chapter "Security considerations" "CHAPsecurity"
33788 .scindex IIDsecurcon "security" "discussion of"
33789 This chapter discusses a number of issues concerned with security, some of
33790 which are also covered in other parts of this manual.
33791
33792 For reasons that this author does not understand, some people have promoted
33793 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
33794 existence of this chapter in the documentation. However, the intent of the
33795 chapter is simply to describe the way Exim works in relation to certain
33796 security concerns, not to make any specific claims about the effectiveness of
33797 its security as compared with other MTAs.
33798
33799 What follows is a description of the way Exim is supposed to be. Best efforts
33800 have been made to try to ensure that the code agrees with the theory, but an
33801 absence of bugs can never be guaranteed. Any that are reported will get fixed
33802 as soon as possible.
33803
33804
33805 .section "Building a more &""hardened""& Exim" "SECID286"
33806 .cindex "security" "build-time features"
33807 There are a number of build-time options that can be set in &_Local/Makefile_&
33808 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
33809 Exim administrator who does not have the root password, or by someone who has
33810 penetrated the Exim (but not the root) account. These options are as follows:
33811
33812 .ilist
33813 ALT_CONFIG_PREFIX can be set to a string that is required to match the
33814 start of any file names used with the &%-C%& option. When it is set, these file
33815 names are also not allowed to contain the sequence &"/../"&. (However, if the
33816 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
33817 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
33818 default setting for &%ALT_CONFIG_PREFIX%&.
33819
33820 If the permitted configuration files are confined to a directory to
33821 which only root has access, this guards against someone who has broken
33822 into the Exim account from running a privileged Exim with an arbitrary
33823 configuration file, and using it to break into other accounts.
33824 .next
33825 If a non-trusted configuration file (i.e. not the default configuration file
33826 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
33827 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
33828 the next item), then root privilege is retained only if the caller of Exim is
33829 root. This locks out the possibility of testing a configuration using &%-C%&
33830 right through message reception and delivery, even if the caller is root. The
33831 reception works, but by that time, Exim is running as the Exim user, so when
33832 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
33833 privilege to be lost. However, root can test reception and delivery using two
33834 separate commands.
33835 .next
33836 The WHITELIST_D_MACROS build option declares some macros to be safe to override
33837 with &%-D%& if the real uid is one of root, the Exim run-time user or the
33838 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
33839 requiring the run-time value supplied to &%-D%& to match a regex that errs on
33840 the restrictive side.  Requiring build-time selection of safe macros is onerous
33841 but this option is intended solely as a transition mechanism to permit
33842 previously-working configurations to continue to work after release 4.73.
33843 .next
33844 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
33845 is disabled.
33846 .next
33847 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
33848 never to be used for any deliveries. This is like the &%never_users%& runtime
33849 option, but it cannot be overridden; the runtime option adds additional users
33850 to the list. The default setting is &"root"&; this prevents a non-root user who
33851 is permitted to modify the runtime file from using Exim as a way to get root.
33852 .endlist
33853
33854
33855
33856
33857 .section "Root privilege" "SECID270"
33858 .cindex "setuid"
33859 .cindex "root privilege"
33860 The Exim binary is normally setuid to root, which means that it gains root
33861 privilege (runs as root) when it starts execution. In some special cases (for
33862 example, when the daemon is not in use and there are no local deliveries), it
33863 may be possible to run Exim setuid to some user other than root. This is
33864 discussed in the next section. However, in most installations, root privilege
33865 is required for two things:
33866
33867 .ilist
33868 To set up a socket connected to the standard SMTP port (25) when initialising
33869 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
33870 not required.
33871 .next
33872 To be able to change uid and gid in order to read users' &_.forward_& files and
33873 perform local deliveries as the receiving user or as specified in the
33874 configuration.
33875 .endlist
33876
33877 It is not necessary to be root to do any of the other things Exim does, such as
33878 receiving messages and delivering them externally over SMTP, and it is
33879 obviously more secure if Exim does not run as root except when necessary.
33880 For this reason, a user and group for Exim to use must be defined in
33881 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
33882 group"&. Their values can be changed by the run time configuration, though this
33883 is not recommended. Often a user called &'exim'& is used, but some sites use
33884 &'mail'& or another user name altogether.
33885
33886 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
33887 abdication; the process cannot regain root afterwards. Prior to release 4.00,
33888 &[seteuid()]& was used in some circumstances, but this is no longer the case.
33889
33890 After a new Exim process has interpreted its command line options, it changes
33891 uid and gid in the following cases:
33892
33893 .ilist
33894 .oindex "&%-C%&"
33895 .oindex "&%-D%&"
33896 If the &%-C%& option is used to specify an alternate configuration file, or if
33897 the &%-D%& option is used to define macro values for the configuration, and the
33898 calling process is not running as root, the uid and gid are changed to those of
33899 the calling process.
33900 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
33901 option may not be used at all.
33902 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
33903 can be supplied if the calling process is running as root, the Exim run-time
33904 user or CONFIGURE_OWNER, if defined.
33905 .next
33906 .oindex "&%-be%&"
33907 .oindex "&%-bf%&"
33908 .oindex "&%-bF%&"
33909 If the expansion test option (&%-be%&) or one of the filter testing options
33910 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
33911 calling process.
33912 .next
33913 If the process is not a daemon process or a queue runner process or a delivery
33914 process or a process for testing address routing (started with &%-bt%&), the
33915 uid and gid are changed to the Exim user and group. This means that Exim always
33916 runs under its own uid and gid when receiving messages. This also applies when
33917 testing address verification
33918 .oindex "&%-bv%&"
33919 .oindex "&%-bh%&"
33920 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
33921 option).
33922 .next
33923 For a daemon, queue runner, delivery, or address testing process, the uid
33924 remains as root at this stage, but the gid is changed to the Exim group.
33925 .endlist
33926
33927 The processes that initially retain root privilege behave as follows:
33928
33929 .ilist
33930 A daemon process changes the gid to the Exim group and the uid to the Exim
33931 user after setting up one or more listening sockets. The &[initgroups()]&
33932 function is called, so that if the Exim user is in any additional groups, they
33933 will be used during message reception.
33934 .next
33935 A queue runner process retains root privilege throughout its execution. Its
33936 job is to fork a controlled sequence of delivery processes.
33937 .next
33938 A delivery process retains root privilege throughout most of its execution,
33939 but any actual deliveries (that is, the transports themselves) are run in
33940 subprocesses which always change to a non-root uid and gid. For local
33941 deliveries this is typically the uid and gid of the owner of the mailbox; for
33942 remote deliveries, the Exim uid and gid are used. Once all the delivery
33943 subprocesses have been run, a delivery process changes to the Exim uid and gid
33944 while doing post-delivery tidying up such as updating the retry database and
33945 generating bounce and warning messages.
33946
33947 While the recipient addresses in a message are being routed, the delivery
33948 process runs as root. However, if a user's filter file has to be processed,
33949 this is done in a subprocess that runs under the individual user's uid and
33950 gid. A system filter is run as root unless &%system_filter_user%& is set.
33951 .next
33952 A process that is testing addresses (the &%-bt%& option) runs as root so that
33953 the routing is done in the same environment as a message delivery.
33954 .endlist
33955
33956
33957
33958
33959 .section "Running Exim without privilege" "SECTrunexiwitpri"
33960 .cindex "privilege, running without"
33961 .cindex "unprivileged running"
33962 .cindex "root privilege" "running without"
33963 Some installations like to run Exim in an unprivileged state for more of its
33964 operation, for added security. Support for this mode of operation is provided
33965 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
33966 gid are changed to the Exim user and group at the start of a delivery process
33967 (and also queue runner and address testing processes). This means that address
33968 routing is no longer run as root, and the deliveries themselves cannot change
33969 to any other uid.
33970
33971 .cindex SIGHUP
33972 .cindex "daemon" "restarting"
33973 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
33974 that the daemon can still be started in the usual way, and it can respond
33975 correctly to SIGHUP because the re-invocation regains root privilege.
33976
33977 An alternative approach is to make Exim setuid to the Exim user and also setgid
33978 to the Exim group. If you do this, the daemon must be started from a root
33979 process. (Calling Exim from a root process makes it behave in the way it does
33980 when it is setuid root.) However, the daemon cannot restart itself after a
33981 SIGHUP signal because it cannot regain privilege.
33982
33983 It is still useful to set &%deliver_drop_privilege%& in this case, because it
33984 stops Exim from trying to re-invoke itself to do a delivery after a message has
33985 been received. Such a re-invocation is a waste of resources because it has no
33986 effect.
33987
33988 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
33989 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
33990 to the Exim user seems a clean approach, but there is one complication:
33991
33992 In this style of operation, Exim is running with the real uid and gid set to
33993 those of the calling process, and the effective uid/gid set to Exim's values.
33994 Ideally, any association with the calling process' uid/gid should be dropped,
33995 that is, the real uid/gid should be reset to the effective values so as to
33996 discard any privileges that the caller may have. While some operating systems
33997 have a function that permits this action for a non-root effective uid, quite a
33998 number of them do not. Because of this lack of standardization, Exim does not
33999 address this problem at this time.
34000
34001 For this reason, the recommended approach for &"mostly unprivileged"& running
34002 is to keep the Exim binary setuid to root, and to set
34003 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
34004 be used in the most straightforward way.
34005
34006 If you configure Exim not to run delivery processes as root, there are a
34007 number of restrictions on what you can do:
34008
34009 .ilist
34010 You can deliver only as the Exim user/group. You should  explicitly use the
34011 &%user%& and &%group%& options to override routers or local transports that
34012 normally deliver as the recipient. This makes sure that configurations that
34013 work in this mode function the same way in normal mode. Any implicit or
34014 explicit specification of another user causes an error.
34015 .next
34016 Use of &_.forward_& files is severely restricted, such that it is usually
34017 not worthwhile to include them in the configuration.
34018 .next
34019 Users who wish to use &_.forward_& would have to make their home directory and
34020 the file itself accessible to the Exim user. Pipe and append-to-file entries,
34021 and their equivalents in Exim filters, cannot be used. While they could be
34022 enabled in the Exim user's name, that would be insecure and not very useful.
34023 .next
34024 Unless the local user mailboxes are all owned by the Exim user (possible in
34025 some POP3 or IMAP-only environments):
34026
34027 .olist
34028 They must be owned by the Exim group and be writeable by that group. This
34029 implies you must set &%mode%& in the appendfile configuration, as well as the
34030 mode of the mailbox files themselves.
34031 .next
34032 You must set &%no_check_owner%&, since most or all of the files will not be
34033 owned by the Exim user.
34034 .next
34035 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
34036 on a newly created mailbox when unprivileged. This also implies that new
34037 mailboxes need to be created manually.
34038 .endlist olist
34039 .endlist ilist
34040
34041
34042 These restrictions severely restrict what can be done in local deliveries.
34043 However, there are no restrictions on remote deliveries. If you are running a
34044 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
34045 gives more security at essentially no cost.
34046
34047 If you are using the &%mua_wrapper%& facility (see chapter
34048 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
34049
34050
34051
34052
34053 .section "Delivering to local files" "SECID271"
34054 Full details of the checks applied by &(appendfile)& before it writes to a file
34055 are given in chapter &<<CHAPappendfile>>&.
34056
34057
34058
34059 .section "IPv4 source routing" "SECID272"
34060 .cindex "source routing" "in IP packets"
34061 .cindex "IP source routing"
34062 Many operating systems suppress IP source-routed packets in the kernel, but
34063 some cannot be made to do this, so Exim does its own check. It logs incoming
34064 IPv4 source-routed TCP calls, and then drops them. Things are all different in
34065 IPv6. No special checking is currently done.
34066
34067
34068
34069 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
34070 Support for these SMTP commands is disabled by default. If required, they can
34071 be enabled by defining suitable ACLs.
34072
34073
34074
34075
34076 .section "Privileged users" "SECID274"
34077 .cindex "trusted users"
34078 .cindex "admin user"
34079 .cindex "privileged user"
34080 .cindex "user" "trusted"
34081 .cindex "user" "admin"
34082 Exim recognizes two sets of users with special privileges. Trusted users are
34083 able to submit new messages to Exim locally, but supply their own sender
34084 addresses and information about a sending host. For other users submitting
34085 local messages, Exim sets up the sender address from the uid, and doesn't
34086 permit a remote host to be specified.
34087
34088 .oindex "&%-f%&"
34089 However, an untrusted user is permitted to use the &%-f%& command line option
34090 in the special form &%-f <>%& to indicate that a delivery failure for the
34091 message should not cause an error report. This affects the message's envelope,
34092 but it does not affect the &'Sender:'& header. Untrusted users may also be
34093 permitted to use specific forms of address with the &%-f%& option by setting
34094 the &%untrusted_set_sender%& option.
34095
34096 Trusted users are used to run processes that receive mail messages from some
34097 other mail domain and pass them on to Exim for delivery either locally, or over
34098 the Internet. Exim trusts a caller that is running as root, as the Exim user,
34099 as any user listed in the &%trusted_users%& configuration option, or under any
34100 group listed in the &%trusted_groups%& option.
34101
34102 Admin users are permitted to do things to the messages on Exim's queue. They
34103 can freeze or thaw messages, cause them to be returned to their senders, remove
34104 them entirely, or modify them in various ways. In addition, admin users can run
34105 the Exim monitor and see all the information it is capable of providing, which
34106 includes the contents of files on the spool.
34107
34108 .oindex "&%-M%&"
34109 .oindex "&%-q%&"
34110 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
34111 delivery of messages on its queue is restricted to admin users. This
34112 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
34113 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
34114 queue is also restricted to admin users. This restriction can be relaxed by
34115 setting &%no_queue_list_requires_admin%&.
34116
34117 Exim recognizes an admin user if the calling process is running as root or as
34118 the Exim user or if any of the groups associated with the calling process is
34119 the Exim group. It is not necessary actually to be running under the Exim
34120 group. However, if admin users who are not root or the Exim user are to access
34121 the contents of files on the spool via the Exim monitor (which runs
34122 unprivileged), Exim must be built to allow group read access to its spool
34123 files.
34124
34125
34126
34127 .section "Spool files" "SECID275"
34128 .cindex "spool directory" "files"
34129 Exim's spool directory and everything it contains is owned by the Exim user and
34130 set to the Exim group. The mode for spool files is defined in the
34131 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
34132 any user who is a member of the Exim group can access these files.
34133
34134
34135
34136 .section "Use of argv[0]" "SECID276"
34137 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
34138 of specific strings, Exim assumes certain options. For example, calling Exim
34139 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
34140 to calling it with the option &%-bS%&. There are no security implications in
34141 this.
34142
34143
34144
34145 .section "Use of %f formatting" "SECID277"
34146 The only use made of &"%f"& by Exim is in formatting load average values. These
34147 are actually stored in integer variables as 1000 times the load average.
34148 Consequently, their range is limited and so therefore is the length of the
34149 converted output.
34150
34151
34152
34153 .section "Embedded Exim path" "SECID278"
34154 Exim uses its own path name, which is embedded in the code, only when it needs
34155 to re-exec in order to regain root privilege. Therefore, it is not root when it
34156 does so. If some bug allowed the path to get overwritten, it would lead to an
34157 arbitrary program's being run as exim, not as root.
34158
34159
34160
34161 .section "Use of sprintf()" "SECID279"
34162 .cindex "&[sprintf()]&"
34163 A large number of occurrences of &"sprintf"& in the code are actually calls to
34164 &'string_sprintf()'&, a function that returns the result in malloc'd store.
34165 The intermediate formatting is done into a large fixed buffer by a function
34166 that runs through the format string itself, and checks the length of each
34167 conversion before performing it, thus preventing buffer overruns.
34168
34169 The remaining uses of &[sprintf()]& happen in controlled circumstances where
34170 the output buffer is known to be sufficiently long to contain the converted
34171 string.
34172
34173
34174
34175 .section "Use of debug_printf() and log_write()" "SECID280"
34176 Arbitrary strings are passed to both these functions, but they do their
34177 formatting by calling the function &'string_vformat()'&, which runs through
34178 the format string itself, and checks the length of each conversion.
34179
34180
34181
34182 .section "Use of strcat() and strcpy()" "SECID281"
34183 These are used only in cases where the output buffer is known to be large
34184 enough to hold the result.
34185 .ecindex IIDsecurcon
34186
34187
34188
34189
34190 . ////////////////////////////////////////////////////////////////////////////
34191 . ////////////////////////////////////////////////////////////////////////////
34192
34193 .chapter "Format of spool files" "CHAPspool"
34194 .scindex IIDforspo1 "format" "spool files"
34195 .scindex IIDforspo2 "spool directory" "format of files"
34196 .scindex IIDforspo3 "spool files" "format of"
34197 .cindex "spool files" "editing"
34198 A message on Exim's queue consists of two files, whose names are the message id
34199 followed by -D and -H, respectively. The data portion of the message is kept in
34200 the -D file on its own. The message's envelope, status, and headers are all
34201 kept in the -H file, whose format is described in this chapter. Each of these
34202 two files contains the final component of its own name as its first line. This
34203 is insurance against disk crashes where the directory is lost but the files
34204 themselves are recoverable.
34205
34206 Some people are tempted into editing -D files in order to modify messages. You
34207 need to be extremely careful if you do this; it is not recommended and you are
34208 on your own if you do it. Here are some of the pitfalls:
34209
34210 .ilist
34211 You must ensure that Exim does not try to deliver the message while you are
34212 fiddling with it. The safest way is to take out a write lock on the -D file,
34213 which is what Exim itself does, using &[fcntl()]&. If you update the file in
34214 place, the lock will be retained. If you write a new file and rename it, the
34215 lock will be lost at the instant of rename.
34216 .next
34217 .vindex "&$body_linecount$&"
34218 If you change the number of lines in the file, the value of
34219 &$body_linecount$&, which is stored in the -H file, will be incorrect. At
34220 present, this value is not used by Exim, but there is no guarantee that this
34221 will always be the case.
34222 .next
34223 If the message is in MIME format, you must take care not to break it.
34224 .next
34225 If the message is cryptographically signed, any change will invalidate the
34226 signature.
34227 .endlist
34228 All in all, modifying -D files is fraught with danger.
34229
34230 Files whose names end with -J may also be seen in the &_input_& directory (or
34231 its subdirectories when &%split_spool_directory%& is set). These are journal
34232 files, used to record addresses to which the message has been delivered during
34233 the course of a delivery attempt. If there are still undelivered recipients at
34234 the end, the -H file is updated, and the -J file is deleted. If, however, there
34235 is some kind of crash (for example, a power outage) before this happens, the -J
34236 file remains in existence. When Exim next processes the message, it notices the
34237 -J file and uses it to update the -H file before starting the next delivery
34238 attempt.
34239
34240 .section "Format of the -H file" "SECID282"
34241 .cindex "uid (user id)" "in spool file"
34242 .cindex "gid (group id)" "in spool file"
34243 The second line of the -H file contains the login name for the uid of the
34244 process that called Exim to read the message, followed by the numerical uid and
34245 gid. For a locally generated message, this is normally the user who sent the
34246 message. For a message received over TCP/IP via the daemon, it is
34247 normally the Exim user.
34248
34249 The third line of the file contains the address of the message's sender as
34250 transmitted in the envelope, contained in angle brackets. The sender address is
34251 empty for bounce messages. For incoming SMTP mail, the sender address is given
34252 in the MAIL command. For locally generated mail, the sender address is
34253 created by Exim from the login name of the current user and the configured
34254 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
34255 leading &"From&~"& line if the caller is trusted, or if the supplied address is
34256 &"<>"& or an address that matches &%untrusted_set_senders%&.
34257
34258 The fourth line contains two numbers. The first is the time that the message
34259 was received, in the conventional Unix form &-- the number of seconds since the
34260 start of the epoch. The second number is a count of the number of messages
34261 warning of delayed delivery that have been sent to the sender.
34262
34263 There follow a number of lines starting with a hyphen. These can appear in any
34264 order, and are omitted when not relevant:
34265
34266 .vlist
34267 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
34268 This item is obsolete, and is not generated from Exim release 4.61 onwards;
34269 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
34270 recognized, to provide backward compatibility. In the old format, a line of
34271 this form is present for every ACL variable that is not empty. The number
34272 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
34273 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
34274 the data string for the variable. The string itself starts at the beginning of
34275 the next line, and is followed by a newline character. It may contain internal
34276 newlines.
34277
34278 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
34279 A line of this form is present for every ACL connection variable that is
34280 defined. Note that there is a space between &%-aclc%& and the rest of the name.
34281 The length is the length of the data string for the variable. The string itself
34282 starts at the beginning of the next line, and is followed by a newline
34283 character. It may contain internal newlines.
34284
34285 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
34286 A line of this form is present for every ACL message variable that is defined.
34287 Note that there is a space between &%-aclm%& and the rest of the name. The
34288 length is the length of the data string for the variable. The string itself
34289 starts at the beginning of the next line, and is followed by a newline
34290 character. It may contain internal newlines.
34291
34292 .vitem "&%-active_hostname%&&~<&'hostname'&>"
34293 This is present if, when the message was received over SMTP, the value of
34294 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
34295
34296 .vitem &%-allow_unqualified_recipient%&
34297 This is present if unqualified recipient addresses are permitted in header
34298 lines (to stop such addresses from being qualified if rewriting occurs at
34299 transport time). Local messages that were input using &%-bnq%& and remote
34300 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
34301
34302 .vitem &%-allow_unqualified_sender%&
34303 This is present if unqualified sender addresses are permitted in header lines
34304 (to stop such addresses from being qualified if rewriting occurs at transport
34305 time). Local messages that were input using &%-bnq%& and remote messages from
34306 hosts that match &%sender_unqualified_hosts%& set this flag.
34307
34308 .vitem "&%-auth_id%&&~<&'text'&>"
34309 The id information for a message received on an authenticated SMTP connection
34310 &-- the value of the &$authenticated_id$& variable.
34311
34312 .vitem "&%-auth_sender%&&~<&'address'&>"
34313 The address of an authenticated sender &-- the value of the
34314 &$authenticated_sender$& variable.
34315
34316 .vitem "&%-body_linecount%&&~<&'number'&>"
34317 This records the number of lines in the body of the message, and is always
34318 present.
34319
34320 .vitem "&%-body_zerocount%&&~<&'number'&>"
34321 This records the number of binary zero bytes in the body of the message, and is
34322 present if the number is greater than zero.
34323
34324 .vitem &%-deliver_firsttime%&
34325 This is written when a new message is first added to the spool. When the spool
34326 file is updated after a deferral, it is omitted.
34327
34328 .vitem "&%-frozen%&&~<&'time'&>"
34329 .cindex "frozen messages" "spool data"
34330 The message is frozen, and the freezing happened at <&'time'&>.
34331
34332 .vitem "&%-helo_name%&&~<&'text'&>"
34333 This records the host name as specified by a remote host in a HELO or EHLO
34334 command.
34335
34336 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
34337 This records the IP address of the host from which the message was received and
34338 the remote port number that was used. It is omitted for locally generated
34339 messages.
34340
34341 .vitem "&%-host_auth%&&~<&'text'&>"
34342 If the message was received on an authenticated SMTP connection, this records
34343 the name of the authenticator &-- the value of the
34344 &$sender_host_authenticated$& variable.
34345
34346 .vitem &%-host_lookup_failed%&
34347 This is present if an attempt to look up the sending host's name from its IP
34348 address failed. It corresponds to the &$host_lookup_failed$& variable.
34349
34350 .vitem "&%-host_name%&&~<&'text'&>"
34351 .cindex "reverse DNS lookup"
34352 .cindex "DNS" "reverse lookup"
34353 This records the name of the remote host from which the message was received,
34354 if the host name was looked up from the IP address when the message was being
34355 received. It is not present if no reverse lookup was done.
34356
34357 .vitem "&%-ident%&&~<&'text'&>"
34358 For locally submitted messages, this records the login of the originating user,
34359 unless it was a trusted user and the &%-oMt%& option was used to specify an
34360 ident value. For messages received over TCP/IP, this records the ident string
34361 supplied by the remote host, if any.
34362
34363 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
34364 This records the IP address of the local interface and the port number through
34365 which a message was received from a remote host. It is omitted for locally
34366 generated messages.
34367
34368 .vitem &%-local%&
34369 The message is from a local sender.
34370
34371 .vitem &%-localerror%&
34372 The message is a locally-generated bounce message.
34373
34374 .vitem "&%-local_scan%&&~<&'string'&>"
34375 This records the data string that was returned by the &[local_scan()]& function
34376 when the message was received &-- the value of the &$local_scan_data$&
34377 variable. It is omitted if no data was returned.
34378
34379 .vitem &%-manual_thaw%&
34380 The message was frozen but has been thawed manually, that is, by an explicit
34381 Exim command rather than via the auto-thaw process.
34382
34383 .vitem &%-N%&
34384 A testing delivery process was started using the &%-N%& option to suppress any
34385 actual deliveries, but delivery was deferred. At any further delivery attempts,
34386 &%-N%& is assumed.
34387
34388 .vitem &%-received_protocol%&
34389 This records the value of the &$received_protocol$& variable, which contains
34390 the name of the protocol by which the message was received.
34391
34392 .vitem &%-sender_set_untrusted%&
34393 The envelope sender of this message was set by an untrusted local caller (used
34394 to ensure that the caller is displayed in queue listings).
34395
34396 .vitem "&%-spam_score_int%&&~<&'number'&>"
34397 If a message was scanned by SpamAssassin, this is present. It records the value
34398 of &$spam_score_int$&.
34399
34400 .vitem &%-tls_certificate_verified%&
34401 A TLS certificate was received from the client that sent this message, and the
34402 certificate was verified by the server.
34403
34404 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
34405 When the message was received over an encrypted connection, this records the
34406 name of the cipher suite that was used.
34407
34408 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
34409 When the message was received over an encrypted connection, and a certificate
34410 was received from the client, this records the Distinguished Name from that
34411 certificate.
34412 .endlist
34413
34414 Following the options there is a list of those addresses to which the message
34415 is not to be delivered. This set of addresses is initialized from the command
34416 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
34417 is set; otherwise it starts out empty. Whenever a successful delivery is made,
34418 the address is added to this set. The addresses are kept internally as a
34419 balanced binary tree, and it is a representation of that tree which is written
34420 to the spool file. If an address is expanded via an alias or forward file, the
34421 original address is added to the tree when deliveries to all its child
34422 addresses are complete.
34423
34424 If the tree is empty, there is a single line in the spool file containing just
34425 the text &"XX"&. Otherwise, each line consists of two letters, which are either
34426 Y or N, followed by an address. The address is the value for the node of the
34427 tree, and the letters indicate whether the node has a left branch and/or a
34428 right branch attached to it, respectively. If branches exist, they immediately
34429 follow. Here is an example of a three-node tree:
34430 .code
34431 YY darcy@austen.fict.example
34432 NN alice@wonderland.fict.example
34433 NN editor@thesaurus.ref.example
34434 .endd
34435 After the non-recipients tree, there is a list of the message's recipients.
34436 This is a simple list, preceded by a count. It includes all the original
34437 recipients of the message, including those to whom the message has already been
34438 delivered. In the simplest case, the list contains one address per line. For
34439 example:
34440 .code
34441 4
34442 editor@thesaurus.ref.example
34443 darcy@austen.fict.example
34444 rdo@foundation
34445 alice@wonderland.fict.example
34446 .endd
34447 However, when a child address has been added to the top-level addresses as a
34448 result of the use of the &%one_time%& option on a &(redirect)& router, each
34449 line is of the following form:
34450 .display
34451 <&'top-level address'&> <&'errors_to address'&> &&&
34452   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
34453 .endd
34454 The 01 flag bit indicates the presence of the three other fields that follow
34455 the top-level address. Other bits may be used in future to support additional
34456 fields. The <&'parent number'&> is the offset in the recipients list of the
34457 original parent of the &"one time"& address. The first two fields are the
34458 envelope sender that is associated with this address and its length. If the
34459 length is zero, there is no special envelope sender (there are then two space
34460 characters in the line). A non-empty field can arise from a &(redirect)& router
34461 that has an &%errors_to%& setting.
34462
34463
34464 A blank line separates the envelope and status information from the headers
34465 which follow. A header may occupy several lines of the file, and to save effort
34466 when reading it in, each header is preceded by a number and an identifying
34467 character. The number is the number of characters in the header, including any
34468 embedded newlines and the terminating newline. The character is one of the
34469 following:
34470
34471 .table2 50pt
34472 .row <&'blank'&>         "header in which Exim has no special interest"
34473 .row &`B`&               "&'Bcc:'& header"
34474 .row &`C`&               "&'Cc:'& header"
34475 .row &`F`&               "&'From:'& header"
34476 .row &`I`&               "&'Message-id:'& header"
34477 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
34478 .row &`R`&               "&'Reply-To:'& header"
34479 .row &`S`&               "&'Sender:'& header"
34480 .row &`T`&               "&'To:'& header"
34481 .row &`*`&               "replaced or deleted header"
34482 .endtable
34483
34484 Deleted or replaced (rewritten) headers remain in the spool file for debugging
34485 purposes. They are not transmitted when the message is delivered. Here is a
34486 typical set of headers:
34487 .code
34488 111P Received: by hobbit.fict.example with local (Exim 4.00)
34489 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
34490 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
34491 038* X-rewrote-sender: bb@hobbit.fict.example
34492 042* From: Bilbo Baggins <bb@hobbit.fict.example>
34493 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
34494 099* To: alice@wonderland.fict.example, rdo@foundation,
34495 darcy@austen.fict.example, editor@thesaurus.ref.example
34496 104T To: alice@wonderland.fict.example, rdo@foundation.example,
34497 darcy@austen.fict.example, editor@thesaurus.ref.example
34498 038  Date: Fri, 11 May 2001 10:28:59 +0100
34499 .endd
34500 The asterisked headers indicate that the envelope sender, &'From:'& header, and
34501 &'To:'& header have been rewritten, the last one because routing expanded the
34502 unqualified domain &'foundation'&.
34503 .ecindex IIDforspo1
34504 .ecindex IIDforspo2
34505 .ecindex IIDforspo3
34506
34507 . ////////////////////////////////////////////////////////////////////////////
34508 . ////////////////////////////////////////////////////////////////////////////
34509
34510 .chapter "Support for DKIM (DomainKeys Identified Mail) - RFC4871" "CHID12" &&&
34511          "DKIM Support"
34512 .cindex "DKIM"
34513
34514 Since version 4.70, DKIM support is compiled into Exim by default. It can be
34515 disabled by setting DISABLE_DKIM=yes in Local/Makefile.
34516
34517 Exim's DKIM implementation allows to
34518 .olist
34519 Sign outgoing messages: This function is implemented in the SMTP transport.
34520 It can co-exist with all other Exim features, including transport filters.
34521 .next
34522 Verify signatures in incoming messages: This is implemented by an additional
34523 ACL (acl_smtp_dkim), which can be called several times per message, with
34524 different signature contexts.
34525 .endlist
34526
34527 In typical Exim style, the verification implementation does not include any
34528 default "policy". Instead it enables you to build your own policy using
34529 Exim's standard controls.
34530
34531 Please note that verification of DKIM signatures in incoming mail is turned
34532 on by default for logging purposes. For each signature in incoming email,
34533 exim will log a line displaying the most important signature details, and the
34534 signature status. Here is an example:
34535 .code
34536 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]
34537 .endd
34538 You might want to turn off DKIM verification processing entirely for internal
34539 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
34540 control modifier. This should typically be done in the RCPT ACL, at points
34541 where you accept mail from relay sources (internal hosts or authenticated
34542 senders).
34543
34544
34545 .section "Signing outgoing messages" "SECID513"
34546 .cindex "DKIM" "signing"
34547
34548 Signing is implemented by setting private options on the SMTP transport.
34549 These options take (expandable) strings as arguments.
34550
34551 .option dkim_domain smtp string&!! unset
34552 MANDATORY:
34553 The domain you want to sign with. The result of this expanded
34554 option is put into the &%$dkim_domain%& expansion variable.
34555
34556 .option dkim_selector smtp string&!! unset
34557 MANDATORY:
34558 This sets the key selector string. You can use the &%$dkim_domain%& expansion
34559 variable to look up a matching selector. The result is put in the expansion
34560 variable &%$dkim_selector%& which should be used in the &%dkim_private_key%&
34561 option along with &%$dkim_domain%&.
34562
34563 .option dkim_private_key smtp string&!! unset
34564 MANDATORY:
34565 This sets the private key to use. You can use the &%$dkim_domain%& and
34566 &%$dkim_selector%& expansion variables to determine the private key to use.
34567 The result can either
34568 .ilist
34569 be a valid RSA private key in ASCII armor, including line breaks.
34570 .next
34571 start with a slash, in which case it is treated as a file that contains
34572 the private key.
34573 .next
34574 be "0", "false" or the empty string, in which case the message will not
34575 be signed. This case will not result in an error, even if &%dkim_strict%&
34576 is set.
34577 .endlist
34578
34579 .option dkim_canon smtp string&!! unset
34580 OPTIONAL:
34581 This option sets the canonicalization method used when signing a message.
34582 The DKIM RFC currently supports two methods: "simple" and "relaxed".
34583 The option defaults to "relaxed" when unset. Note: the current implementation
34584 only supports using the same canonicalization method for both headers and body.
34585
34586 .option dkim_strict smtp string&!! unset
34587 OPTIONAL:
34588 This  option  defines  how  Exim  behaves  when  signing a message that
34589 should be signed fails for some reason.  When the expansion evaluates to
34590 either "1" or "true", Exim will defer. Otherwise Exim will send the message
34591 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
34592 variables here.
34593
34594 .option dkim_sign_headers smtp string&!! unset
34595 OPTIONAL:
34596 When set, this option must expand to (or be specified as) a colon-separated
34597 list of header names. Headers with these names will be included in the message
34598 signature. When unspecified, the header names recommended in RFC4871 will be
34599 used.
34600
34601
34602 .section "Verifying DKIM signatures in incoming mail" "SECID514"
34603 .cindex "DKIM" "verification"
34604
34605 Verification of DKIM signatures in incoming email is implemented via the
34606 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
34607 syntactically(!) correct signature in the incoming message.
34608
34609 To evaluate the signature in the ACL a large number of expansion variables
34610 containing the signature status and its details are set up during the
34611 runtime of the ACL.
34612
34613 Calling the ACL only for existing signatures is not sufficient to build
34614 more advanced policies. For that reason, the global option
34615 &%dkim_verify_signers%&, and a global expansion variable
34616 &%$dkim_signers%& exist.
34617
34618 The global option &%dkim_verify_signers%& can be set to a colon-separated
34619 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
34620 called. It is expanded when the message has been received. At this point,
34621 the expansion variable &%$dkim_signers%& already contains a colon-separated
34622 list of signer domains and identities for the message. When
34623 &%dkim_verify_signers%& is not specified in the main configuration,
34624 it defaults as:
34625 .code
34626 dkim_verify_signers = $dkim_signers
34627 .endd
34628 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
34629 DKIM signature in the message. Current DKIM verifiers may want to explicitly
34630 call the ACL for known domains or identities. This would be achieved as follows:
34631 .code
34632 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
34633 .endd
34634 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
34635 and "ebay.com", plus all domains and identities that have signatures in the message.
34636 You can also be more creative in constructing your policy. For example:
34637 .code
34638 dkim_verify_signers = $sender_address_domain:$dkim_signers
34639 .endd
34640
34641 If a domain or identity is listed several times in the (expanded) value of
34642 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
34643
34644
34645 Inside the &%acl_smtp_dkim%&, the following expansion variables are
34646 available (from most to least important):
34647
34648 .vlist
34649 .vitem &%$dkim_cur_signer%&
34650 The signer that is being evaluated in this ACL run. This can be a domain or
34651 an identity. This is one of the list items from the expanded main option
34652 &%dkim_verify_signers%& (see above).
34653 .vitem &%$dkim_verify_status%&
34654 A string describing the general status of the signature. One of
34655 .ilist
34656 &%none%&: There is no signature in the message for the current domain or
34657 identity (as reflected by &%$dkim_cur_signer%&).
34658 .next
34659 &%invalid%&: The signature could not be verified due to a processing error.
34660 More detail is available in &%$dkim_verify_reason%&.
34661 .next
34662 &%fail%&: Verification of the signature failed.  More detail is
34663 available in &%$dkim_verify_reason%&.
34664 .next
34665 &%pass%&: The signature passed verification. It is valid.
34666 .endlist
34667 .vitem &%$dkim_verify_reason%&
34668 A string giving a litte bit more detail when &%$dkim_verify_status%& is either
34669 "fail" or "invalid". One of
34670 .ilist
34671 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
34672 key for the domain could not be retrieved. This may be a temporary problem.
34673 .next
34674 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
34675 record for the domain is syntactically invalid.
34676 .next
34677 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
34678 body hash does not match the one specified in the signature header. This
34679 means that the message body was modified in transit.
34680 .next
34681 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
34682 could not be verified. This may mean that headers were modified,
34683 re-written or otherwise changed in a way which is incompatible with
34684 DKIM verification. It may of course also mean that the signature is forged.
34685 .endlist
34686 .vitem &%$dkim_domain%&
34687 The signing domain. IMPORTANT: This variable is only populated if there is
34688 an actual signature in the message for the current domain or identity (as
34689 reflected by &%$dkim_cur_signer%&).
34690 .vitem &%$dkim_identity%&
34691 The signing identity, if present. IMPORTANT: This variable is only populated
34692 if there is an actual signature in the message for the current domain or
34693 identity (as reflected by &%$dkim_cur_signer%&).
34694 .vitem &%$dkim_selector%&
34695 The key record selector string.
34696 .vitem &%$dkim_algo%&
34697 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
34698 .vitem &%$dkim_canon_body%&
34699 The body canonicalization method. One of 'relaxed' or 'simple'.
34700 .vitem &%dkim_canon_headers%&
34701 The header canonicalization method. One of 'relaxed' or 'simple'.
34702 .vitem &%$dkim_copiedheaders%&
34703 A transcript of headers and their values which are included in the signature
34704 (copied from the 'z=' tag of the signature).
34705 .vitem &%$dkim_bodylength%&
34706 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
34707 limit was set by the signer, "9999999999999" is returned. This makes sure
34708 that this variable always expands to an integer value.
34709 .vitem &%$dkim_created%&
34710 UNIX timestamp reflecting the date and time when the signature was created.
34711 When this was not specified by the signer, "0" is returned.
34712 .vitem &%$dkim_expires%&
34713 UNIX timestamp reflecting the date and time when the signer wants the
34714 signature to be treated as "expired". When this was not specified by the
34715 signer, "9999999999999" is returned. This makes it possible to do useful
34716 integer size comparisons against this value.
34717 .vitem &%$dkim_headernames%&
34718 A colon-separated list of names of headers included in the signature.
34719 .vitem &%$dkim_key_testing%&
34720 "1" if the key record has the "testing" flag set, "0" if not.
34721 .vitem &%$dkim_key_nosubdomaining%&
34722 "1" if the key record forbids subdomaining, "0" otherwise.
34723 .vitem &%$dkim_key_srvtype%&
34724 Service type (tag s=) from the key record. Defaults to "*" if not specified
34725 in the key record.
34726 .vitem &%$dkim_key_granularity%&
34727 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
34728 in the key record.
34729 .vitem &%$dkim_key_notes%&
34730 Notes from the key record (tag n=).
34731 .endlist
34732
34733 In addition, two ACL conditions are provided:
34734
34735 .vlist
34736 .vitem &%dkim_signers%&
34737 ACL condition that checks a colon-separated list of domains or identities
34738 for a match against the domain or identity that the ACL is currently verifying
34739 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
34740 verb to a group of domains or identities. For example:
34741
34742 .code
34743 # Warn when message apparently from GMail has no signature at all
34744 warn log_message = GMail sender without DKIM signature
34745      sender_domains = gmail.com
34746      dkim_signers = gmail.com
34747      dkim_status = none
34748 .endd
34749
34750 .vitem &%dkim_status%&
34751 ACL condition that checks a colon-separated list of possible DKIM verification
34752 results agains the actual result of verification. This is typically used
34753 to restrict an ACL verb to a list of verification outcomes, like:
34754
34755 .code
34756 deny message = Message from Paypal with invalid or missing signature
34757      sender_domains = paypal.com:paypal.de
34758      dkim_signers = paypal.com:paypal.de
34759      dkim_status = none:invalid:fail
34760 .endd
34761
34762 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
34763 see the documentation of the &%$dkim_verify_status%& expansion variable above
34764 for more information of what they mean.
34765 .endlist
34766
34767 . ////////////////////////////////////////////////////////////////////////////
34768 . ////////////////////////////////////////////////////////////////////////////
34769
34770 .chapter "Adding new drivers or lookup types" "CHID13" &&&
34771          "Adding drivers or lookups"
34772 .cindex "adding drivers"
34773 .cindex "new drivers, adding"
34774 .cindex "drivers" "adding new"
34775 The following actions have to be taken in order to add a new router, transport,
34776 authenticator, or lookup type to Exim:
34777
34778 .olist
34779 Choose a name for the driver or lookup type that does not conflict with any
34780 existing name; I will use &"newdriver"& in what follows.
34781 .next
34782 Add to &_src/EDITME_& the line:
34783 .display
34784 <&'type'&>&`_NEWDRIVER=yes`&
34785 .endd
34786 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
34787 code is not to be included in the binary by default, comment this line out. You
34788 should also add any relevant comments about the driver or lookup type.
34789 .next
34790 Add to &_src/config.h.defaults_& the line:
34791 .code
34792 #define <type>_NEWDRIVER
34793 .endd
34794 .next
34795 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
34796 and create a table entry as is done for all the other drivers and lookup types.
34797 .next
34798 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
34799 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
34800 driver or lookup type and add it to the definition of OBJ.
34801 .next
34802 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
34803 &_src_&.
34804 .next
34805 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
34806 as for other drivers and lookups.
34807 .endlist
34808
34809 Then all you need to do is write the code! A good way to start is to make a
34810 proforma by copying an existing module of the same type, globally changing all
34811 occurrences of the name, and cutting out most of the code. Note that any
34812 options you create must be listed in alphabetical order, because the tables are
34813 searched using a binary chop procedure.
34814
34815 There is a &_README_& file in each of the sub-directories of &_src_& describing
34816 the interface that is expected.
34817
34818
34819
34820
34821 . ////////////////////////////////////////////////////////////////////////////
34822 . ////////////////////////////////////////////////////////////////////////////
34823
34824 . /////////////////////////////////////////////////////////////////////////////
34825 . These lines are processing instructions for the Simple DocBook Processor that
34826 . Philip Hazel has developed as a less cumbersome way of making PostScript and
34827 . PDFs than using xmlto and fop. They will be ignored by all other XML
34828 . processors.
34829 . /////////////////////////////////////////////////////////////////////////////
34830
34831 .literal xml
34832 <?sdop
34833   format="newpage"
34834   foot_right_recto="&chaptertitle;"
34835   foot_right_verso="&chaptertitle;"
34836 ?>
34837 .literal off
34838
34839 .makeindex "Options index"   "option"
34840 .makeindex "Variables index" "variable"
34841 .makeindex "Concept index"   "concept"
34842
34843
34844 . /////////////////////////////////////////////////////////////////////////////
34845 . /////////////////////////////////////////////////////////////////////////////